Retrieves the structure by ID
get
/structure/fetch/{id}
This endpoint is used to get the structure by ID.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id: string
Id of the structure that needs to be fetched
Query Parameters
-
isSimulationMode(optional): boolean
true for simulation mode and false for restDefault Value:
false
Response
Supported Media Types
- application/json
- application/xml
200 Response
Returns the structure based on given id.
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 : LmmTmStructureDTO-allOf[1]
Type:
Show Source
object
-
allowSweepOnCurrencyHol(optional):
string
-
backwardTreatment(optional):
string
-
balanceType(optional):
string
-
centralAccountBranch(optional):
string
-
centralAccountCurrency(optional):
string
-
centralAccountNumber(optional):
string
-
considerPostSweepBalance(optional):
string
-
crossBorderFlag(optional):
string
-
crossCurrencyFlag(optional):
string
-
currencyRateType(optional):
string
-
customerId(optional):
string
Pattern:
[a-zA-Z0-9]{1,20}
-
customerName(optional):
string
-
effectiveDate(optional):
string
-
endDate(optional):
string
-
eodExecution(optional):
string
-
fxRatePickup(optional):
string
-
headerAccountNumber(optional):
string
-
headerBranchCode(optional):
string
-
headerCurrency(optional):
string
-
holidayTreatment(optional):
string
-
instructionType(optional):
string
-
interestMethod(optional):
string
-
investmentSweep(optional):
string
-
limitTrackingFlag(optional):
string
-
LmmTmStructureAccountsDTO(optional):
array LmmTmStructureAccountsDTO
-
LmmTmStructureDetailsDTO(optional):
array LmmTmStructureDetailsDTO
-
maxBackwardDays(optional):
integer
-
multiBankFlag(optional):
string
-
nextRunDate(optional):
string
-
nextRunDateReverse(optional):
string
-
numberOfAccountsLinked(optional):
integer
-
pauseEndDate(optional):
string
-
pauseStartDate(optional):
string
-
prevRunDateReverse(optional):
string
-
ratePickUp(optional):
string
-
reallocationMethod(optional):
string
-
reverseFrequency(optional):
string
-
sourceSystem(optional):
string
-
structureDescription(optional):
string
-
structureFrequency(optional):
string
-
structureId(optional):
string
Pattern:
[A-Z0-9]{1,30}
-
structureStatus(optional):
string
-
structureType(optional):
string
-
struturePriority(optional):
integer
Minimum Value:
1
Maximum Value:99
-
systemAccountBranch(optional):
string
-
systemAccountCurrency(optional):
string
-
systemAccountNumber(optional):
string
Nested Schema : LmmTmStructureAccountsDTO
Type:
Show Source
object
-
accCategory(optional):
string
Maximum Length:
10
-
accountBranch(optional):
string
-
accountCurrency(optional):
string
-
accountDescription(optional):
string
Maximum Length:
105
-
accountNumber(optional):
string
Maximum Length:
30
-
accountType(optional):
string
Maximum Length:
20
-
acyAvailableBal(optional):
number
-
bankCode(optional):
string
-
bankDesc(optional):
string
-
cityId(optional):
string
-
countryId(optional):
string
-
customerDesc(optional):
string
Maximum Length:
105
Customer Description -
customerName(optional):
string
Customer Name
-
customerNumber(optional):
string
Maximum Length:
20
Customer number -
entityID(optional):
string
Entity ID
-
entityName(optional):
string
Entity Name
-
groupCode(optional):
string
Maximum Length:
5
-
iban(optional):
string
IBAN Number
-
id(optional):
string
Maximum Length:
36
-
isDebitUnlimited(optional):
string
Maximum Length:
1
-
isExternal(optional):
string
-
isNotional(optional):
string
Maximum Length:
1
Default Value:N
Pattern:[Y,N]
-
isRegulatedDebits(optional):
string
Maximum Length:
1
-
isSelected(optional):
string
Maximum Length:
1
-
region(optional):
string
-
simAccountNumber(optional):
string
-
structureMasterId(optional):
string
Maximum Length:
36
Nested Schema : LmmTmStructureDetailsDTO
Type:
Show Source
object
-
accCategory(optional):
string
-
accountCurrency(optional):
string
-
accountDescription(optional):
string
-
accountLevel(optional):
integer
-
accountNumber(optional):
string
Maximum Length:
30
-
accountType(optional):
string
Maximum Length:
20
-
acyAvailableBal(optional):
number
-
allowReverseSweep(optional):
string
Maximum Length:
1
Default Value:N
Pattern:[Y,N]
-
bankCode(optional):
string
-
bankDesc(optional):
string
-
bookingAccountBranch(optional):
string
Maximum Length:
4
-
bookingAccountCurrency(optional):
string
Maximum Length:
3
-
bookingAccountNumber(optional):
string
Maximum Length:
30
-
branchCode(optional):
string
Maximum Length:
4
-
centralAccountBranch(optional):
string
Maximum Length:
4
-
centralAccountCurrency(optional):
string
Maximum Length:
3
-
centralAccountNumber(optional):
string
Maximum Length:
30
-
cityId(optional):
string
-
countryId(optional):
string
-
customerName(optional):
string
Customer Name
-
entityID(optional):
string
Entity ID
-
entityName(optional):
string
Entity Name
-
eodExecution(optional):
string
Maximum Length:
1
-
holdEndDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}
-
holdStartDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}
-
iban(optional):
string
IBAN Number
-
id(optional):
string
Maximum Length:
36
-
isExternal(optional):
string
-
isHold(optional):
string
Maximum Length:
1
Default Value:N
Pattern:[Y,N]
-
isNominatedAccount(optional):
string
Maximum Length:
1
-
isNotional(optional):
string
-
isRegulatedDebits(optional):
string
-
isTwoWay(optional):
string
Maximum Length:
1
Default Value:N
Pattern:[Y,N]
-
isVirtual(optional):
string
-
latitude(optional):
number
-
LmmTmStrRevSweepDetailsDTO(optional):
array LmmTmStrRevSweepDetailsDTO
-
LmmTmStructureAccPriorityDTO(optional):
array LmmTmStructureAccPriorityDTO
-
LmmTmStructureIclDTO(optional):
array LmmTmStructureIclDTO
-
LmmTmStructureInstructionDTO(optional):
array LmmTmStructureInstructionDTO
-
LmmTmStructurePaymentDTO(optional):
array LmmTmStructurePaymentDTO
-
longitude(optional):
number
-
oneWayAccountGroup(optional):
string
Maximum Length:
5
-
onlineBalanceFetch(optional):
string
Maximum Length:
1
-
parentAccountBranch(optional):
string
Maximum Length:
4
-
parentAccountCurrency(optional):
string
Maximum Length:
3
-
parentAccountNumber(optional):
string
Maximum Length:
30
-
partialReverseSweep(optional):
string
Maximum Length:
1
Default Value:N
-
partialTransferAllowed(optional):
string
Maximum Length:
1
- percentageChildShare(optional): integer
- percentageShare(optional): integer
-
ratePickUp(optional):
string
Maximum Length:
40
-
rateType(optional):
string
Maximum Length:
8
-
reallocationMethod(optional):
string
Maximum Length:
40
-
reallocationRequired(optional):
string
Maximum Length:
1
-
region(optional):
string
-
reverseSweepFrequency(optional):
string
Maximum Length:
20
-
structureMasterId:
string
Maximum Length:
36
-
sweepPriority(optional):
integer
-
twoWayAccountGroup(optional):
string
Maximum Length:
5
-
twowaySweepPriority(optional):
integer
-
useDefaultPaymntIns(optional):
string
Maximum Length:
1
Default Value:N
Pattern:[Y,N]
payment ins is defaulted or not
Nested Schema : LmmTmStrRevSweepDetailsDTO
Type:
Show Source
object
-
accountBranch(optional):
string
Maximum Length:
4
-
accountCurrency(optional):
string
Maximum Length:
3
-
accountNumber(optional):
string
Maximum Length:
30
-
bodExecution(optional):
string
Maximum Length:
1
Pattern:[Y,N]
-
eodExecution(optional):
string
Maximum Length:
1
Pattern:[Y,N]
-
id(optional):
string
Maximum Length:
36
-
nextRunDate(optional):
string
-
previousRunDate(optional):
string
-
reverseSweepFrequency(optional):
string
Maximum Length:
20
-
structureDetailsId(optional):
string
Maximum Length:
36
-
structureMasterId(optional):
string
Maximum Length:
36
Nested Schema : LmmTmStructureAccPriorityDTO
Type:
Show Source
object
-
accountNumber(optional):
string
Maximum Length:
30
-
branchCode(optional):
string
Maximum Length:
4
-
effectiveDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}
-
endDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}
-
id(optional):
string
Maximum Length:
36
-
structureDescription(optional):
string
Pattern:
[A-Za-z0-9 ()_+:"',.?/-]{1,200}
-
structureDetailsId(optional):
string
Maximum Length:
36
-
structureId(optional):
string
Pattern:
[A-Z0-9]{1,30}
-
structureMasterId(optional):
string
Maximum Length:
36
-
structurePriority(optional):
integer
-
structureType(optional):
string
-
versionNo(optional):
integer
Nested Schema : LmmTmStructureIclDTO
Type:
Show Source
object
-
iclBookingReport(optional):
string
Maximum Length:
1
Pattern:[Y,N]
-
iclReference(optional):
string
Maximum Length:
100
-
iclSettlementReport(optional):
string
Maximum Length:
1
Pattern:[Y,N]
-
id(optional):
string
Maximum Length:
36
-
loanType(optional):
string
Maximum Length:
1
-
structureDetailsId(optional):
string
Maximum Length:
36
-
structureMasterId(optional):
string
Maximum Length:
36
-
trackIcl(optional):
string
Maximum Length:
1
Pattern:[Y,N]
Nested Schema : LmmTmStructureInstructionDTO
Type:
Show Source
object
-
id(optional):
string
Maximum Length:
36
-
instrDesc(optional):
string
Maximum Length:
100
-
instructionId(optional):
string
Maximum Length:
15
-
instructionPriority(optional):
integer
-
LmmTmStructureInstructionDetDTO(optional):
array LmmTmStructureInstructionDetDTO
-
LmmTmStructureInstructionFrequencyDTO(optional):
array LmmTmStructureInstructionFrequencyDTO
-
structureDetailsId:
string
Maximum Length:
36
-
suspensionEndDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}
-
suspensionStartDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}
Nested Schema : LmmTmStructureInstructionDetDTO
Type:
Show Source
object
-
id(optional):
string
Maximum Length:
36
-
paramName(optional):
string
Maximum Length:
25
-
paramValue(optional):
string
Maximum Length:
100
-
structureInstructionId:
string
Maximum Length:
36
Nested Schema : LmmTmStructureInstructionFrequencyDTO
Type:
Show Source
object
-
freqDesc(optional):
string
-
frequencyId(optional):
string
Maximum Length:
25
-
id(optional):
string
Maximum Length:
36
-
structureInstructionId:
string
Maximum Length:
36
Nested Schema : LmmTmStructurePaymentDTO
Type:
Show Source
object
-
id(optional):
string
Maximum Length:
150
-
interfaceMasterId(optional):
string
Maximum Length:
36
-
LmmTmStructurePaymentDetailDTO(optional):
array LmmTmStructurePaymentDetailDTO
-
structureDetailsId:
string
Maximum Length:
36
-
sweepDirection(optional):
string
Maximum Length:
10
Nested Schema : LmmTmStructurePaymentDetailDTO
Type:
Show Source
object
-
id(optional):
string
Maximum Length:
36
-
paramName(optional):
string
Maximum Length:
50
-
paramValue(optional):
string
Maximum Length:
100
-
structurePaymentId:
string
Maximum Length:
36
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error