Get all valid structure.
get
/api/1.0/service/lma/structure
This endpoint is used to get all valid structure maintenance records.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
accountNumber: string
accountNumber need to be set to fetch structures based on accountNumber
-
authStat: string
authStat need to be set to fetch structures based on authStat
-
branchCode: string
branchCode need to be set to fetch structures based on branchCode both in parent and child
-
customerId: string
Pattern:
[a-zA-Z0-9]{1,20}customerId need to be set to fetch structures for particular customer -
headerAccountNumber: string
headerAccountNumber need to be set to fetch structures for particular customer
-
headerBranchCode: string
headerBranchCode need to be set to fetch structures for particular Branch code
-
includecloseandunauth: boolean
includecloseandunauth need to be set to fetch summary record, defult value is false
-
interestMethod: string
interest method of the structure that need to be fetched
-
isDirty: string
isDirty need to be set to fetch structures based on isDirty
-
isExpired: string
isExpired need to be set to fetch structures based on isExpired
-
isNotClosed: string
This is used to return the open and in progress structures
-
isSimulation: string
isSimulation need to be set to fetch structures related to simulation
-
isSimulationMode: boolean
true for simulation mode and false for restDefault Value:
false -
limit: integer
limit is maximum no of records to be fetched
-
multiBankFlag: string
multiBankFlag structures need to be set to fetch
-
offset: integer
offset is starting no of records to be fetched
-
onceAuth: string
This is used to return the structures at least authorized once
-
onlyLinkedCustomers: string
onlyLinkedCustomers need to be set to fetch structures based on only Linked Customers
-
recordStat: string
recordStat need to be set to fetch structures based on recordStat
-
simulationId: string
Simulation ID
-
source: string
source of the request, either channel or null/internal
-
structureDescription: string
structureDescription need to be set to fetch structures for particular customer
-
structureId: string
Pattern:
[A-Z0-9]{1,30}structureId need to be set to fetch structures for particular customer -
structureStatus: string
structureStatus need to be set to fetch structures based on status
-
structureType: string
structureType need to be set to fetch structures for particular customer
-
summary: string
summary need to be set to fetch structures only from working table with lazy loading
Header Parameters
-
sourceCode(required): string
Source from which request is initiated
Response
Supported Media Types
- application/json
- application/xml
201 Response
Returns message of success or failure
Headers
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
objectDiscriminator:
resource_typeNested Schema : LmmTmStructureServiceDTO-allOf[1]
Type:
Show Source
object-
action:
string
-
allowSweepOnCurrencyHol:
string
Maximum Length:
1Default Value:Y -
backwardTreatment:
string
Maximum Length:
20 -
balanceType:
string
Maximum Length:
1Default Value:VPattern:[B,V] -
batchStatus:
string
-
bodExecution:
string
Maximum Length:
1Pattern:[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:
3The charge funding account Currency from where the charges needs to be collected -
chargeAccountNo:
string
Maximum Length:
35The charge funding account from where the charges needs to be collected -
chargeBranchCode:
string
Maximum Length:
4The charge funding branch Code from where the charges needs to be collected -
considerPostSweepBalance:
string
Maximum Length:
1Pattern:[Y,N] -
crossBorderFlag:
string
Maximum Length:
1Default Value:NPattern:[Y,N] -
crossCurrencyFlag:
string
Maximum Length:
1Default Value:NPattern:[Y,N] -
currencyRateType:
string
Maximum Length:
20 -
customerId:
string
Pattern:
[a-zA-Z0-9]{1,20} -
customerName:
string
Maximum Length:
140 -
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:
1Default Value:NPattern:[Y,N] -
exStrId:
string
Maximum Length:
36 -
fxRatePickup:
string
Maximum Length:
15 -
hasRegulatedDebitAcc:
string
Maximum Length:
1If 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:
1Pattern:[Y,N] -
isSimulation:
string
Maximum Length:
1Pattern:[Y,N] -
isSimulationMode:
boolean
Default Value:
falseTo check for simulation -
isViewMode:
boolean
Default Value:
falseTo 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:
1Pattern:[Y,N] -
revFreqEodExecution:
string
Maximum Length:
1Pattern:[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:
200Pattern:[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:
1Pattern:[Y,N] -
versionNo:
integer
Nested Schema : LmmTmStructureAccountsDTO
Type:
Show Source
object-
accCategory:
string
-
accountBranch:
string
-
accountCurrency:
string
-
accountDescription:
string
-
accountNumber:
string
-
accountType:
string
-
acyAvailableBal:
number
-
bankCode:
string
-
cityId:
string
-
countryId:
string
-
groupCode:
string
Maximum Length:
5 -
id:
string
-
isExternal:
string
-
isNotional:
string
-
isSelected:
string
-
region:
string
-
structureMasterId:
string
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:
36ID -
structureId:
string
Maximum Length:
30Structure ID -
structureMasterId:
string
Maximum Length:
36Structure Master ID -
structurePriority:
integer
Minimum Value:
1Structure 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.
405 Response
Invalid input
500 Response
Internal error