Retrieves the Structure Details for Pool for the Given Header Branch Code
get
/service/lma/structure/poolstructure/{headerBranchCode}
This endpoint is used to get the structure details for pool for the given header branch code.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
headerBranchCode(required): string
Header Branch Code
Response
Supported Media Types
- application/json
- application/xml
200 Response
Returns the Structure Master Id details by header Branch Code.
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
object
Discriminator:
resource_type
Nested Schema : LmmTmStructureServiceDTO-allOf[1]
Type:
Show Source
object
-
action:
string
-
allowSweepOnCurrencyHol:
string
Maximum Length:
1
Default Value:Y
-
backwardTreatment:
string
Maximum Length:
20
-
balanceType:
string
Maximum Length:
1
Default Value:V
Pattern:[B,V]
-
batchStatus:
string
-
bodExecution:
string
Maximum Length:
1
Pattern:[Y,N]
-
callFromValidate:
boolean
Default Value:
false
-
centralAccountBranch:
string
Maximum Length:
4
-
centralAccountCurrency:
string
Maximum Length:
3
-
centralAccountNumber:
string
Maximum Length:
30
-
chargeAccountCcy:
string
Maximum Length:
3
The charge funding account Currency from where the charges needs to be collected -
chargeAccountNo:
string
Maximum Length:
35
The charge funding account from where the charges needs to be collected -
chargeBranchCode:
string
Maximum Length:
4
The charge funding branch Code from where the charges needs to be collected -
considerPostSweepBalance:
string
Maximum Length:
1
Pattern:[Y,N]
-
crossBorderFlag:
string
Maximum Length:
1
Default Value:N
Pattern:[Y,N]
-
crossCurrencyFlag:
string
Maximum Length:
1
Default Value:N
Pattern:[Y,N]
-
currencyRateType:
string
Maximum Length:
20
-
customerId:
string
Pattern:
[a-zA-Z0-9]{1,20}
-
customerName:
string
Maximum Length:
105
-
effectiveDate:
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}
-
endDate:
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}
-
eodExecution:
string
Maximum Length:
1
Default Value:N
Pattern:[Y,N]
-
exStrId:
string
Maximum Length:
36
-
fxRatePickup:
string
Maximum Length:
15
-
hasRegulatedDebitAcc:
string
Maximum Length:
1
If regulated debit account exists on structure then Y else N -
headerAccountNumber:
string
Maximum Length:
30
-
headerBranchCode:
string
Maximum Length:
4
-
headerCurrency:
string
Maximum Length:
3
-
holidayTreatment:
string
Maximum Length:
20
-
instructionType:
string
Maximum Length:
20
-
interestMethod:
string
Maximum Length:
40
-
investmentSweep:
string
Maximum Length:
2
-
isDirty:
string
Maximum Length:
1
Pattern:[Y,N]
-
isSimulation:
string
Maximum Length:
1
Pattern:[Y,N]
-
isSimulationMode:
boolean
Default Value:
false
To check for simulation -
isViewMode:
boolean
Default Value:
false
To check for view mode in simulation structure -
lastSuccessfulSweepDate:
string(date)
-
limitTrackingFlag:
string
Maximum Length:
1
-
liquidationOnDelinking:
string
Maximum Length:
50
-
LmmTmStructureAccountsDTO:
array LmmTmStructureAccountsDTO
-
LmmTmStructureDetailsDTO:
array LmmTmStructureDetailsDTO
-
LmmTmTempStructurePriorityDTO:
array LmmTmTempStructurePriorityDTO
-
LmxTmSimAccountVdBalDTO:
array LmxTmSimAccountVdBalDTO
-
maxBackwardDays:
integer
-
multiBankFlag:
string
-
nextRunDate:
string
-
nextRunDateReverse:
string
-
numberOfAccountsLinked:
integer
-
pauseEndDate:
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}
-
pauseStartDate:
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}
-
prevRunDateReverse:
string
-
prospect:
string
Maximum Length:
20
-
ratePickUp:
string
Maximum Length:
40
-
reallocationMethod:
string
Maximum Length:
50
-
reverseFrequency:
string
Maximum Length:
20
-
revFreqBodExecution:
string
Maximum Length:
1
Pattern:[Y,N]
-
revFreqEodExecution:
string
Maximum Length:
1
Pattern:[Y,N]
-
simulationFromDate:
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}
-
simulationId:
string
Maximum Length:
30
-
simulationToDate:
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}
-
sourceSystem:
string
Maximum Length:
35
-
structureDescription:
string
Maximum Length:
200
Pattern:[A-Za-z0-9 ()_+:"',.?/-]{1,200}
-
structureFrequency:
string
Maximum Length:
20
-
structureId(required):
string
Pattern:
[A-Z0-9]{1,30}
-
structureStatus:
string
Maximum Length:
20
-
structureType:
string
Maximum Length:
20
-
struturePriority:
integer
Minimum Value:
1
-
systemAccountBranch:
string
-
systemAccountCurrency:
string
-
systemAccountNumber:
string
-
trackIcl:
string
Maximum Length:
1
Pattern:[Y,N]
-
versionNo:
integer
Nested Schema : LmmTmStructureDetailsDTO
Type:
Show Source
object
-
accountCurrency:
string
-
accountLevel:
integer
-
accountNumber:
string
-
accountType:
string
-
allowReverseSweep:
string
-
bookingAccountBranch:
string
-
bookingAccountCurrency:
string
-
bookingAccountNumber:
string
-
branchCode:
string
-
centralAccountBranch:
string
-
centralAccountCurrency:
string
-
centralAccountNumber:
string
-
eodExecution:
string
-
id:
string
-
instructionPriority:
integer
-
isExternalAccount:
string
-
isHold:
string
-
isNominatedAccount:
string
-
isTwoWay:
string
-
LmmTmStructureInstructionDTO:
array LmmTmStructureInstructionDTO
-
LmmTmStructurePaymentDTO:
array LmmTmStructurePaymentDTO
-
onlineBalanceFetch:
string
-
parentAccountBranch:
string
-
parentAccountCurrency:
string
-
parentAccountNumber:
string
-
partialReverseSweep:
string
-
partialTransferAllowed:
string
- percentageChildShare: integer
- percentageShare: integer
-
ratePickUp:
string
-
rateType:
string
-
reallocationMethod:
string
-
reallocationRequired:
string
-
reverseSweepFrequency:
string
-
structureMasterId(required):
string
-
twowaySweepPriority:
integer
Nested Schema : LmmTmTempStructurePriorityDTO
Type:
Show Source
object
-
id:
string
Maximum Length:
36
ID -
structureId:
string
Maximum Length:
30
Structure ID -
structureMasterId:
string
Maximum Length:
36
Structure Master ID -
structurePriority:
integer
Minimum Value:
1
Structure Priority
Nested Schema : LmxTmSimAccountVdBalDTO
Type:
Show Source
object
-
accountBranch:
string
Maximum Length:
4
-
accountCurrency:
string
Maximum Length:
3
-
accountNumber:
string
Maximum Length:
50
-
accountVdBal:
number
-
id:
string
Maximum Length:
36
-
modNo:
integer
-
structureMasterId:
string
Maximum Length:
36
-
valueDate:
string(date)
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error