When updating multiple Sleeve Registrations, our batch workflow is faster and more scalable. This allows you to update multiple registrations at once, rather than sending a significant number of calls to our standard sleeves endpoint.
Endpoint Description
This endpoint is used to process a batch of sleeve registrations for trading. The request should be sent as an HTTP POST to {{oc_base_api}}/api/v1/Trading/Sleeve/Registrations/Action/process/batch.
Request Body
The request body should be sent in raw format and should contain an array of objects with the following structure. We recommend a batch of between 50-100 registrations. Multiple batches can run at one time.
| property | description | required |
| accountSleeves | An array of objects representing account sleeves, each with various attributes such as model allocations, sweep asset ID, billing details, minimum cash, and more. | Yes |
| assets | An array of objects representing assets, each with attributes like cost basis, name, account number, ticker, current shares, current value, and more. | No |
| categoryAllocations | An array of objects representing category allocations, each with attributes for category, value, and percent. | Yes |
| mStyle | An object representing management style, with attributes for ID and name. | Yes |
| custodialBilling | An object representing custodial billing details, with attributes for bill fee schedule ID, name, bill master payout schedule ID, name, and recurring adjustments. | No |
| sleeveBilling | An object representing sleeve billing details, with attributes for bill fee schedule ID, name, bill master payout schedule ID, name, and recurring adjustments. | No |
| other attributes | excluded assets, included assets, deleted sleeve targets, client ID, registration ID, and more. | No |
Example (large, scroll to see response details):
curl --location --globoff '{{oc_base_api}}/api/v1/Trading/Sleeve/Registrations/Action/process/batch' \
--header 'Authorization: {{oc_access_token}}' \
--data '[
{
"accountSleeves": [
{
"modelAllocations": null,
"sweepAssetId": 387028,
"custodialBilling": null,
"sleeveBilling": null,
"minimumCash": null,
"replenishMinCash": false,
"substitutes": [],
"hasSMAModel": false,
"modelAggType": 0,
"minimumInvestmentAmount": null,
"createdFromOciProcess": false,
"accountId": 30614,
"sleeveDescription": " 0.0000 Percent",
"targetAllocation": 0,
"currentAllocation": 0,
"currentValue": 0,
"contributionAllocation": 0,
"distributionAllocation": 0,
"corporateActionAllocation": 0,
"toleranceUpper": 0,
"toleranceLower": 0,
"sleeveType": "Custodial account",
"modelAgg": null,
"managementStyle": "Managed Account",
"subAdvisor": null,
"modelType": null,
"registrationId": 31547,
"subAdvisorId": null,
"modelAggId": null,
"managementStyleId": 24,
"createdBy": "orionuser",
"createdDate": "2024-04-25T00:44:04.16-05:00",
"editedBy": "orionuser",
"editedDate": "2024-04-25T00:44:04.16-05:00",
"targetBalanceType": 1,
"doNotTrade": false,
"riskScore": null,
"regValue": 500000,
"isCustomized": false,
"sleeveStrategyDetailId": null,
"sleeveStrategyId": null,
"sleeveStrategy": null,
"sleeveStrategyToleranceUpper": null,
"sleeveStrategyToleranceLower": null,
"businessLine": null,
"unitBalanceScale": "3",
"assets": [
{
"costBasis": 0,
"name": "Custodial Cash",
"accountNumber": "SD_AcctNo20240424_2216",
"ticker": "CUSTODIAL_CASH",
"currentShares": 0,
"currentValue": 0,
"currentPrice": 1,
"isManaged": true,
"assetClass": "CASH",
"productCategory": "Money Market",
"productCategoryAbbreviation": "M",
"isCustodialCash": true,
"secondaryAccountNumber": null,
"productId": 1174473,
"assetLevelStrategyId": null,
"assetLevelStrategy": null,
"status": 0,
"isStrategyOverride": false,
"createdBy": "orionuser",
"createdDate": "2024-04-25T00:41:42.217-05:00",
"editedBy": "orionuser",
"editedDate": "2024-04-25T00:41:42.217-05:00",
"accountId": 30614,
"registrationId": 31547,
"clientId": 29685,
"isActive": true,
"downloadSymbol": 1726872,
"accountType": "Individual",
"fundFamily": "TD Ameritrade",
"custodian": "TD Ameritrade FIX",
"asOfDate": "2024-04-24",
"registrationName": "SD_RegName1",
"managementStyle": null,
"sleeveType": null,
"productType": "Mutual Fund",
"productSubType": null,
"isGlobalExcluded": false,
"isFeeExcluded": false,
"excludeAmountType": null,
"excludeAmount": 0,
"excludePercentOf": null,
"isRebalance": false,
"isAdvisorOnly": false,
"isAdvReportable": false,
"is13FReportable": false,
"mscsFundAccountNumber": null,
"lastReconDate": null,
"isOrionVision": null,
"assetPercentOfAccount": null,
"householdName": null,
"riskCategory": null,
"modelName": null,
"registrationType": "IND",
"accountStatusId": 0,
"id": 387028
},
{
"costBasis": 0,
"name": "TestEQ101.6",
"accountNumber": "SD_AcctNo20240424_2216",
"ticker": "TestEQ101.6",
"currentShares": 0,
"currentValue": 0,
"currentPrice": 101.6,
"isManaged": true,
"assetClass": "Security",
"productCategory": "UnAssigned",
"productCategoryAbbreviation": "UnAssigned",
"isCustodialCash": false,
"secondaryAccountNumber": null,
"productId": 2066358,
"assetLevelStrategyId": null,
"assetLevelStrategy": null,
"status": 1,
"isStrategyOverride": false,
"createdBy": "spimSleeveMaintenance",
"createdDate": "2024-04-25T04:42:36.117-05:00",
"editedBy": "spimSleeveMaintenance",
"editedDate": "2024-04-25T04:42:36.117-05:00",
"accountId": 30614,
"registrationId": 31547,
"clientId": 29685,
"isActive": true,
"downloadSymbol": 2781558,
"accountType": "Individual",
"fundFamily": "TD Ameritrade",
"custodian": "TD Ameritrade FIX",
"asOfDate": null,
"registrationName": "SD_RegName1",
"managementStyle": null,
"sleeveType": null,
"productType": "Stock/ETF",
"productSubType": null,
"isGlobalExcluded": false,
"isFeeExcluded": false,
"excludeAmountType": null,
"excludeAmount": 0,
"excludePercentOf": null,
"isRebalance": false,
"isAdvisorOnly": false,
"isAdvReportable": false,
"is13FReportable": false,
"mscsFundAccountNumber": null,
"lastReconDate": null,
"isOrionVision": null,
"assetPercentOfAccount": null,
"householdName": null,
"riskCategory": null,
"modelName": null,
"registrationType": "IND",
"accountStatusId": 0,
"id": 387041
},
{
"costBasis": 0,
"name": "TestMF65.49",
"accountNumber": "SD_AcctNo20240424_2216",
"ticker": "TestMF65.49",
"currentShares": 0,
"currentValue": 0,
"currentPrice": 65.49,
"isManaged": true,
"assetClass": "Security",
"productCategory": "UnAssigned",
"productCategoryAbbreviation": "UnAssigned",
"isCustodialCash": false,
"secondaryAccountNumber": null,
"productId": 2066294,
"assetLevelStrategyId": null,
"assetLevelStrategy": null,
"status": 1,
"isStrategyOverride": false,
"createdBy": "spimSleeveMaintenance",
"createdDate": "2024-04-25T04:42:36.117-05:00",
"editedBy": "spimSleeveMaintenance",
"editedDate": "2024-04-25T04:42:36.117-05:00",
"accountId": 30614,
"registrationId": 31547,
"clientId": 29685,
"isActive": true,
"downloadSymbol": 2781495,
"accountType": "Individual",
"fundFamily": "TD Ameritrade",
"custodian": "TD Ameritrade FIX",
"asOfDate": null,
"registrationName": "SD_RegName1",
"managementStyle": null,
"sleeveType": null,
"productType": "Mutual Fund",
"productSubType": null,
"isGlobalExcluded": false,
"isFeeExcluded": false,
"excludeAmountType": null,
"excludeAmount": 0,
"excludePercentOf": null,
"isRebalance": false,
"isAdvisorOnly": false,
"isAdvReportable": false,
"is13FReportable": false,
"mscsFundAccountNumber": null,
"lastReconDate": null,
"isOrionVision": null,
"assetPercentOfAccount": null,
"householdName": null,
"riskCategory": null,
"modelName": null,
"registrationType": "IND",
"accountStatusId": 0,
"id": 387042
},
{
"costBasis": 0,
"name": "TestMF100.3",
"accountNumber": "SD_AcctNo20240424_2216",
"ticker": "TestMF100.3",
"currentShares": 0,
"currentValue": 0,
"currentPrice": 100.3,
"isManaged": true,
"assetClass": "Security",
"productCategory": "UnAssigned",
"productCategoryAbbreviation": "UnAssigned",
"isCustodialCash": false,
"secondaryAccountNumber": null,
"productId": 2066307,
"assetLevelStrategyId": null,
"assetLevelStrategy": null,
"status": 1,
"isStrategyOverride": false,
"createdBy": "spimSleeveMaintenance",
"createdDate": "2024-04-25T04:42:36.117-05:00",
"editedBy": "spimSleeveMaintenance",
"editedDate": "2024-04-25T04:42:36.117-05:00",
"accountId": 30614,
"registrationId": 31547,
"clientId": 29685,
"isActive": true,
"downloadSymbol": 2781508,
"accountType": "Individual",
"fundFamily": "TD Ameritrade",
"custodian": "TD Ameritrade FIX",
"asOfDate": null,
"registrationName": "SD_RegName1",
"managementStyle": null,
"sleeveType": null,
"productType": "Mutual Fund",
"productSubType": null,
"isGlobalExcluded": false,
"isFeeExcluded": false,
"excludeAmountType": null,
"excludeAmount": 0,
"excludePercentOf": null,
"isRebalance": false,
"isAdvisorOnly": false,
"isAdvReportable": false,
"is13FReportable": false,
"mscsFundAccountNumber": null,
"lastReconDate": null,
"isOrionVision": null,
"assetPercentOfAccount": null,
"householdName": null,
"riskCategory": null,
"modelName": null,
"registrationType": "IND",
"accountStatusId": 0,
"id": 387043
},
{
"costBasis": 0,
"name": "TestEQ8.55",
"accountNumber": "SD_AcctNo20240424_2216",
"ticker": "TestEQ8.55",
"currentShares": 0,
"currentValue": 0,
"currentPrice": 8.55,
"isManaged": true,
"assetClass": "Equity",
"productCategory": "Equity",
"productCategoryAbbreviation": "E",
"isCustodialCash": false,
"secondaryAccountNumber": null,
"productId": 2066319,
"assetLevelStrategyId": null,
"assetLevelStrategy": null,
"status": 1,
"isStrategyOverride": false,
"createdBy": "spimSleeveMaintenance",
"createdDate": "2024-04-25T04:42:36.117-05:00",
"editedBy": "spimSleeveMaintenance",
"editedDate": "2024-04-25T04:42:36.117-05:00",
"accountId": 30614,
"registrationId": 31547,
"clientId": 29685,
"isActive": true,
"downloadSymbol": 2781520,
"accountType": "Individual",
"fundFamily": "TD Ameritrade",
"custodian": "TD Ameritrade FIX",
"asOfDate": null,
"registrationName": "SD_RegName1",
"managementStyle": null,
"sleeveType": null,
"productType": "Stock/ETF",
"productSubType": null,
"isGlobalExcluded": false,
"isFeeExcluded": false,
"excludeAmountType": null,
"excludeAmount": 0,
"excludePercentOf": null,
"isRebalance": false,
"isAdvisorOnly": false,
"isAdvReportable": false,
"is13FReportable": false,
"mscsFundAccountNumber": null,
"lastReconDate": null,
"isOrionVision": null,
"assetPercentOfAccount": null,
"householdName": null,
"riskCategory": null,
"modelName": null,
"registrationType": "IND",
"accountStatusId": 0,
"id": 387044
},
{
"costBasis": 0,
"name": "TestMF77.11",
"accountNumber": "SD_AcctNo20240424_2216",
"ticker": "TestMF77.11",
"currentShares": 0,
"currentValue": 0,
"currentPrice": 77.11,
"isManaged": true,
"assetClass": "Security",
"productCategory": "UnAssigned",
"productCategoryAbbreviation": "UnAssigned",
"isCustodialCash": false,
"secondaryAccountNumber": null,
"productId": 2066298,
"assetLevelStrategyId": null,
"assetLevelStrategy": null,
"status": 1,
"isStrategyOverride": false,
"createdBy": "spimSleeveMaintenance",
"createdDate": "2024-04-25T04:42:36.117-05:00",
"editedBy": "spimSleeveMaintenance",
"editedDate": "2024-04-25T04:42:36.117-05:00",
"accountId": 30614,
"registrationId": 31547,
"clientId": 29685,
"isActive": true,
"downloadSymbol": 2781499,
"accountType": "Individual",
"fundFamily": "TD Ameritrade",
"custodian": "TD Ameritrade FIX",
"asOfDate": null,
"registrationName": "SD_RegName1",
"managementStyle": null,
"sleeveType": null,
"productType": "Mutual Fund",
"productSubType": null,
"isGlobalExcluded": false,
"isFeeExcluded": false,
"excludeAmountType": null,
"excludeAmount": 0,
"excludePercentOf": null,
"isRebalance": false,
"isAdvisorOnly": false,
"isAdvReportable": false,
"is13FReportable": false,
"mscsFundAccountNumber": null,
"lastReconDate": null,
"isOrionVision": null,
"assetPercentOfAccount": null,
"householdName": null,
"riskCategory": null,
"modelName": null,
"registrationType": "IND",
"accountStatusId": 0,
"id": 387045
},
{
"costBasis": 0,
"name": "TestEQ1.85",
"accountNumber": "SD_AcctNo20240424_2216",
"ticker": "TestEQ1.85",
"currentShares": 0,
"currentValue": 0,
"currentPrice": 1.85,
"isManaged": true,
"assetClass": "Equity",
"productCategory": "Equity",
"productCategoryAbbreviation": "E",
"isCustodialCash": false,
"secondaryAccountNumber": null,
"productId": 2066317,
"assetLevelStrategyId": null,
"assetLevelStrategy": null,
"status": 1,
"isStrategyOverride": false,
"createdBy": "spimSleeveMaintenance",
"createdDate": "2024-04-25T04:42:36.117-05:00",
"editedBy": "spimSleeveMaintenance",
"editedDate": "2024-04-25T04:42:36.117-05:00",
"accountId": 30614,
"registrationId": 31547,
"clientId": 29685,
"isActive": true,
"downloadSymbol": 2781518,
"accountType": "Individual",
"fundFamily": "TD Ameritrade",
"custodian": "TD Ameritrade FIX",
"asOfDate": null,
"registrationName": "SD_RegName1",
"managementStyle": null,
"sleeveType": null,
"productType": "Stock/ETF",
"productSubType": null,
"isGlobalExcluded": false,
"isFeeExcluded": false,
"excludeAmountType": null,
"excludeAmount": 0,
"excludePercentOf": null,
"isRebalance": false,
"isAdvisorOnly": false,
"isAdvReportable": false,
"is13FReportable": false,
"mscsFundAccountNumber": null,
"lastReconDate": null,
"isOrionVision": null,
"assetPercentOfAccount": null,
"householdName": null,
"riskCategory": null,
"modelName": null,
"registrationType": "IND",
"accountStatusId": 0,
"id": 387046
},
{
"costBasis": 0,
"name": "TestMF37.11",
"accountNumber": "SD_AcctNo20240424_2216",
"ticker": "TestMF37.11",
"currentShares": 0,
"currentValue": 0,
"currentPrice": 37.11,
"isManaged": true,
"assetClass": "Security",
"productCategory": "UnAssigned",
"productCategoryAbbreviation": "UnAssigned",
"isCustodialCash": false,
"secondaryAccountNumber": null,
"productId": 2066281,
"assetLevelStrategyId": null,
"assetLevelStrategy": null,
"status": 1,
"isStrategyOverride": false,
"createdBy": "spimSleeveMaintenance",
"createdDate": "2024-04-25T04:42:36.117-05:00",
"editedBy": "spimSleeveMaintenance",
"editedDate": "2024-04-25T04:42:36.117-05:00",
"accountId": 30614,
"registrationId": 31547,
"clientId": 29685,
"isActive": true,
"downloadSymbol": 2781483,
"accountType": "Individual",
"fundFamily": "TD Ameritrade",
"custodian": "TD Ameritrade FIX",
"asOfDate": null,
"registrationName": "SD_RegName1",
"managementStyle": null,
"sleeveType": null,
"productType": "Mutual Fund",
"productSubType": null,
"isGlobalExcluded": false,
"isFeeExcluded": false,
"excludeAmountType": null,
"excludeAmount": 0,
"excludePercentOf": null,
"isRebalance": false,
"isAdvisorOnly": false,
"isAdvReportable": false,
"is13FReportable": false,
"mscsFundAccountNumber": null,
"lastReconDate": null,
"isOrionVision": null,
"assetPercentOfAccount": null,
"householdName": null,
"riskCategory": null,
"modelName": null,
"registrationType": "IND",
"accountStatusId": 0,
"id": 387047
},
{
"costBasis": 0,
"name": "TestEQ1.52",
"accountNumber": "SD_AcctNo20240424_2216",
"ticker": "TestEQ1.52",
"currentShares": 0,
"currentValue": 0,
"currentPrice": 1.52,
"isManaged": true,
"assetClass": "Security",
"productCategory": "UnAssigned",
"productCategoryAbbreviation": "UnAssigned",
"isCustodialCash": false,
"secondaryAccountNumber": null,
"productId": 2066316,
"assetLevelStrategyId": null,
"assetLevelStrategy": null,
"status": 1,
"isStrategyOverride": false,
"createdBy": "spimSleeveMaintenance",
"createdDate": "2024-04-25T04:42:36.117-05:00",
"editedBy": "spimSleeveMaintenance",
"editedDate": "2024-04-25T04:42:36.117-05:00",
"accountId": 30614,
"registrationId": 31547,
"clientId": 29685,
"isActive": true,
"downloadSymbol": 2781517,
"accountType": "Individual",
"fundFamily": "TD Ameritrade",
"custodian": "TD Ameritrade FIX",
"asOfDate": null,
"registrationName": "SD_RegName1",
"managementStyle": null,
"sleeveType": null,
"productType": "Stock/ETF",
"productSubType": null,
"isGlobalExcluded": false,
"isFeeExcluded": false,
"excludeAmountType": null,
"excludeAmount": 0,
"excludePercentOf": null,
"isRebalance": false,
"isAdvisorOnly": false,
"isAdvReportable": false,
"is13FReportable": false,
"mscsFundAccountNumber": null,
"lastReconDate": null,
"isOrionVision": null,
"assetPercentOfAccount": null,
"householdName": null,
"riskCategory": null,
"modelName": null,
"registrationType": "IND",
"accountStatusId": 0,
"id": 387048
},
{
"costBasis": 0,
"name": "TestEQ13.84",
"accountNumber": "SD_AcctNo20240424_2216",
"ticker": "TestEQ13.84",
"currentShares": 0,
"currentValue": 0,
"currentPrice": 13.84,
"isManaged": true,
"assetClass": "Equity",
"productCategory": "Equity",
"productCategoryAbbreviation": "E",
"isCustodialCash": false,
"secondaryAccountNumber": null,
"productId": 2066322,
"assetLevelStrategyId": null,
"assetLevelStrategy": null,
"status": 1,
"isStrategyOverride": false,
"createdBy": "spimSleeveMaintenance",
"createdDate": "2024-04-25T04:42:36.117-05:00",
"editedBy": "spimSleeveMaintenance",
"editedDate": "2024-04-25T04:42:36.117-05:00",
"accountId": 30614,
"registrationId": 31547,
"clientId": 29685,
"isActive": true,
"downloadSymbol": 2781523,
"accountType": "Individual",
"fundFamily": "TD Ameritrade",
"custodian": "TD Ameritrade FIX",
"asOfDate": null,
"registrationName": "SD_RegName1",
"managementStyle": null,
"sleeveType": null,
"productType": "Stock/ETF",
"productSubType": null,
"isGlobalExcluded": false,
"isFeeExcluded": false,
"excludeAmountType": null,
"excludeAmount": 0,
"excludePercentOf": null,
"isRebalance": false,
"isAdvisorOnly": false,
"isAdvReportable": false,
"is13FReportable": false,
"mscsFundAccountNumber": null,
"lastReconDate": null,
"isOrionVision": null,
"assetPercentOfAccount": null,
"householdName": null,
"riskCategory": null,
"modelName": null,
"registrationType": "IND",
"accountStatusId": 0,
"id": 387049
}
],
"categoryAllocations": [
{
"category": "Money Market",
"value": 0,
"percent": null
},
{
"category": "UnAssigned",
"value": 0,
"percent": null
},
{
"category": "Equity",
"value": 0,
"percent": null
}
],
"rowId": 0,
"mStyle": {
"id": 24,
"name": "Managed Account"
},
"managementStyleName": "Managed Account"
},
{
"modelAllocations": null,
"sweepAssetId": 387039,
"custodialBilling": null,
"sleeveBilling": null,
"minimumCash": null,
"replenishMinCash": null,
"substitutes": [],
"hasSMAModel": false,
"modelAggType": 0,
"minimumInvestmentAmount": null,
"createdFromOciProcess": false,
"accountId": 30616,
"sleeveDescription": " 0.0000 Percent",
"targetAllocation": 0,
"currentAllocation": 0,
"currentValue": 0,
"contributionAllocation": 0,
"distributionAllocation": 0,
"corporateActionAllocation": 0,
"toleranceUpper": 0,
"toleranceLower": 0,
"sleeveType": "Contribution sleeve",
"modelAgg": null,
"managementStyle": null,
"subAdvisor": null,
"modelType": null,
"registrationId": 31547,
"subAdvisorId": null,
"modelAggId": null,
"managementStyleId": null,
"createdBy": "orionuser",
"createdDate": "2024-04-25T00:44:04.103-05:00",
"editedBy": "orionuser",
"editedDate": "2024-04-25T00:44:04.103-05:00",
"targetBalanceType": 1,
"doNotTrade": false,
"riskScore": null,
"regValue": 500000,
"isCustomized": false,
"sleeveStrategyDetailId": null,
"sleeveStrategyId": null,
"sleeveStrategy": null,
"sleeveStrategyToleranceUpper": null,
"sleeveStrategyToleranceLower": null,
"businessLine": null,
"unitBalanceScale": "3",
"assets": [
{
"costBasis": 0,
"name": "Custodial Cash",
"accountNumber": "SD_AcctNo20240424_2216_Contribution",
"ticker": "CUSTODIAL_CASH",
"currentShares": 0,
"currentValue": 0,
"currentPrice": 1,
"isManaged": true,
"assetClass": "CASH",
"productCategory": "Money Market",
"productCategoryAbbreviation": "M",
"isCustodialCash": true,
"secondaryAccountNumber": null,
"productId": 1174473,
"assetLevelStrategyId": null,
"assetLevelStrategy": null,
"status": 1,
"isStrategyOverride": false,
"createdBy": "orionuser",
"createdDate": "2024-04-25T00:44:04.103-05:00",
"editedBy": "orionuser",
"editedDate": "2024-04-25T00:44:04.103-05:00",
"accountId": 30616,
"registrationId": 31547,
"clientId": 29685,
"isActive": true,
"downloadSymbol": 10193513,
"accountType": "Individual",
"fundFamily": "TD Ameritrade",
"custodian": "TD Ameritrade FIX",
"asOfDate": null,
"registrationName": "SD_RegName1",
"managementStyle": null,
"sleeveType": null,
"productType": "Mutual Fund",
"productSubType": null,
"isGlobalExcluded": false,
"isFeeExcluded": false,
"excludeAmountType": null,
"excludeAmount": 0,
"excludePercentOf": null,
"isRebalance": false,
"isAdvisorOnly": false,
"isAdvReportable": false,
"is13FReportable": false,
"mscsFundAccountNumber": null,
"lastReconDate": null,
"isOrionVision": null,
"assetPercentOfAccount": null,
"householdName": null,
"riskCategory": null,
"modelName": null,
"registrationType": "IND",
"accountStatusId": 0,
"id": 387039
}
],
"categoryAllocations": [
{
"category": "Money Market",
"value": 0,
"percent": null
}
],
"rowId": 2
},
{
"modelAllocations": null,
"sweepAssetId": 387040,
"custodialBilling": null,
"sleeveBilling": null,
"minimumCash": null,
"replenishMinCash": null,
"substitutes": [],
"hasSMAModel": false,
"modelAggType": 0,
"minimumInvestmentAmount": null,
"createdFromOciProcess": false,
"accountId": 30617,
"sleeveDescription": " 0.0000 Percent",
"targetAllocation": 0,
"currentAllocation": 0,
"currentValue": 0,
"contributionAllocation": 0,
"distributionAllocation": 0,
"corporateActionAllocation": 0,
"toleranceUpper": 0,
"toleranceLower": 0,
"sleeveType": "Distribution sleeve",
"modelAgg": null,
"managementStyle": null,
"subAdvisor": null,
"modelType": null,
"registrationId": 31547,
"subAdvisorId": null,
"modelAggId": null,
"managementStyleId": null,
"createdBy": "orionuser",
"createdDate": "2024-04-25T00:44:04.143-05:00",
"editedBy": "orionuser",
"editedDate": "2024-04-25T00:44:04.143-05:00",
"targetBalanceType": 1,
"doNotTrade": false,
"riskScore": null,
"regValue": 500000,
"isCustomized": false,
"sleeveStrategyDetailId": null,
"sleeveStrategyId": null,
"sleeveStrategy": null,
"sleeveStrategyToleranceUpper": null,
"sleeveStrategyToleranceLower": null,
"businessLine": null,
"unitBalanceScale": "3",
"assets": [
{
"costBasis": 0,
"name": "Custodial Cash",
"accountNumber": "SD_AcctNo20240424_2216_Distribution",
"ticker": "CUSTODIAL_CASH",
"currentShares": 0,
"currentValue": 0,
"currentPrice": 1,
"isManaged": true,
"assetClass": "CASH",
"productCategory": "Money Market",
"productCategoryAbbreviation": "M",
"isCustodialCash": true,
"secondaryAccountNumber": null,
"productId": 1174473,
"assetLevelStrategyId": null,
"assetLevelStrategy": null,
"status": 1,
"isStrategyOverride": false,
"createdBy": "orionuser",
"createdDate": "2024-04-25T00:44:04.143-05:00",
"editedBy": "orionuser",
"editedDate": "2024-04-25T00:44:04.143-05:00",
"accountId": 30617,
"registrationId": 31547,
"clientId": 29685,
"isActive": true,
"downloadSymbol": 10193513,
"accountType": "Individual",
"fundFamily": "TD Ameritrade",
"custodian": "TD Ameritrade FIX",
"asOfDate": null,
"registrationName": "SD_RegName1",
"managementStyle": null,
"sleeveType": null,
"productType": "Mutual Fund",
"productSubType": null,
"isGlobalExcluded": false,
"isFeeExcluded": false,
"excludeAmountType": null,
"excludeAmount": 0,
"excludePercentOf": null,
"isRebalance": false,
"isAdvisorOnly": false,
"isAdvReportable": false,
"is13FReportable": false,
"mscsFundAccountNumber": null,
"lastReconDate": null,
"isOrionVision": null,
"assetPercentOfAccount": null,
"householdName": null,
"riskCategory": null,
"modelName": null,
"registrationType": "IND",
"accountStatusId": 0,
"id": 387040
}
],
"categoryAllocations": [
{
"category": "Money Market",
"value": 0,
"percent": null
}
],
"rowId": 3
},
{
"accountId": 0,
"targetBalanceType": 1,
"sleeveType": "Normal sleeve",
"currentAllocation": 0,
"sleeveStrategyId": null,
"isCustomized": false,
"subAdvisorId": null,
"toleranceUpper": 0,
"toleranceLower": 0,
"modelType": null,
"rowId": 4,
"contributionAllocation": 100,
"distributionAllocation": 100,
"targetAllocation": 20,
"model": {
"id": 36,
"name": "Equity Rebalance II",
"riskScore": null
},
"minimumInvestmentAmount": null,
"modelAggId": 36,
"modelAgg": "Equity Rebalance II"
},
{
"accountId": 0,
"targetBalanceType": 1,
"sleeveType": "Normal sleeve",
"currentAllocation": 0,
"sleeveStrategyId": null,
"isCustomized": false,
"subAdvisorId": null,
"toleranceUpper": 0,
"toleranceLower": 0,
"modelType": null,
"rowId": 5,
"contributionAllocation": 0,
"distributionAllocation": 0,
"targetAllocation": 30,
"model": {
"id": 34,
"name": "MF Baseline Rebalance II",
"riskScore": null
},
"minimumInvestmentAmount": null,
"modelAggId": 34,
"modelAgg": "MF Baseline Rebalance II"
},
{
"accountId": 0,
"targetBalanceType": 1,
"sleeveType": "Normal sleeve",
"currentAllocation": 0,
"sleeveStrategyId": null,
"isCustomized": false,
"subAdvisorId": null,
"toleranceUpper": 0,
"toleranceLower": 0,
"modelType": null,
"rowId": 6,
"contributionAllocation": 0,
"distributionAllocation": 0,
"targetAllocation": 50,
"mStyle": {
"id": 30,
"name": "Global Trade Group A"
},
"editMgmtStyle": true,
"model": {
"id": 30,
"name": "MF Baseline Rebal No Cash",
"riskScore": null
},
"minimumInvestmentAmount": null,
"modelAggId": 30,
"modelAgg": "MF Baseline Rebal No Cash",
"managementStyleId": 30,
"managementStyleName": "Global Trade Group A"
}
],
"custodialBilling": {
"billFeeScheduleId": 4,
"billFeeScheduleName": "UnAssigned",
"billMasterPayoutScheduleId": 1,
"billMasterPayoutScheduleName": "Blankdb",
"recurringAdjustments": []
},
"sleeveBilling": {
"billFeeScheduleId": null,
"billFeeScheduleName": null,
"billMasterPayoutScheduleId": null,
"billMasterPayoutScheduleName": null,
"recurringAdjustments": []
},
"excludedAssets": null,
"includedAssets": null,
"deletedSleeveTargets": null,
"clientId": 29685,
"registrationId": 31547,
"sleeveStrategyAggId": null,
"sleeveStrategyId": null,
"isActive": true,
"isDoNotTrade": false,
"custodialAccountNumber": "SD_AcctNo20240424_2216",
"asOfDate": null,
"eclipseFirmId": null,
"tolerancePercent": null,
"aggregateRiskScore": null,
"registrationRiskTolerance": null,
"contributionAllocationMethod": "Assigned",
"distributionAllocationMethod": "Assigned",
"corporateActionAllocationMethod": "Sleeve Current Percent",
"createdBy": "orionuser",
"createdDate": "2024-04-25T00:44:03.937-05:00",
"editedBy": "orionuser",
"editedDate": "2024-04-25T00:44:06.187-05:00",
"autoRebalFrequency": "None",
"autoRebalMonth": 10,
"autoRebalDay": 1,
"mandate": false,
"needsUpdate": false,
"needsUpdateReason": null,
"normalGroupedSleeves": {
"sleeveStrategyId": null,
"name": null,
"sleeves": []
},
"contributionTotal": 100,
"distributionTotal": 100,
"targetTotal": 100,
"riskScoreTotal": null
}
]'Response
Upon successful execution, the API returns a status code of 200 and the content type is text/plain. The response body contains the Bach ID. This can be used to get batch status updates.
Get Batch Processing Details
{{oc_base_api}}/api/v1/Utility/BatchProcessing/:batchIdThis endpoint makes an HTTP GET request to retrieve the details of a batch processing job by providing the batch ID in the URL.
The response returned by the API is in JSON format and includes the following fields:
| property | description | datatype |
| id | The ID of the batch processing job. | number |
| correlationId | The correlation ID associated with the job. | string |
| alClientName | The name of the client associated with the job. | string |
| status | The status of the batch processing job. | string |
| message | Any message related to the job. | string |
| createdBy | The user who created the job. | string |
| createdDate | The date when the job was created. | string |
| editedDate | The date when the job was last edited. | string |
| elapsed | The elapsed time for the job. | string |
| parentId | The ID of the parent job, if applicable. | number or null |
| isDone | Indicates whether the job is completed. | boolean |
| totalItems | The total number of items in the job. | number |
| itemsCompleted | The number of items completed in the job. | number |
| processingType | The type of processing involved in the job. | string |
| errorCount | The count of errors encountered during processing. | number |
| warningCount | The count of warnings encountered during processing. | number |
| details | Additional details related to the job. | object or null |
Example:
curl --location --globoff '{{oc_base_api}}/api/v1/Utility/BatchProcessing/26140410' \
--header 'Authorization: {{oc_access_token}}'Get Batch Processing Errors
{{oc_base_api}}/api/v1/Utility/BatchProcessing/:batchId/Errors
This endpoint makes an HTTP GET request to retrieve the errors associated with a specific batch processing job. The response is in json format and contains an array of error objects. Below are some examples of the response:
Empty array: []
{ "id": 0, "batchId": 0, "errorMessage": "", "details": "", "severityCode": 0, "severity": "", "createdBy": "", "createdDate": ""}]Example:
curl --location --globoff '{{oc_base_api}}/api/v1/Utility/BatchProcessing/{{batchId}}/Errors' \ --header 'Authorization: {{oc_access_token}}'