Previous Next JavaScript must be enabled to correctly display this content

## Retrieves the structure by ID

get

/service/lma/structure/v1/{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

- isRejected(optional): boolean
  true to get details for rejected modification/record on a structure and false for rest
  Default Value: `false`
- isSimulationMode(optional): boolean
  true for simulation mode and false for rest
  Default Value: `false`
- version(optional): string
  Modification version that needs to be fetched

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 200 Response

Returns the structure based on given id.
Body ()
Root Schema : LmmTmStructureWrapperDTO
Type: `object`
Show Source

- data(optional): object LmmTmStructureDTO

    {
        "type":"object",
        "properties":{
            "data":{
                "$ref":"#/definitions/LmmTmStructureDTO"
            }
        }
    }

Nested Schema : LmmTmStructureDTO
Type: `object`
Show Source

- 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
- trackIcl(optional): string

    {
        "type":"object",
        "properties":{
            "structureId":{
                "type":"string",
                "description":"",
                "pattern":"[A-Z0-9]{1,30}"
            },
            "structureDescription":{
                "type":"string",
                "description":""
            },
            "customerId":{
                "type":"string",
                "description":"",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "customerName":{
                "type":"string",
                "description":""
            },
            "numberOfAccountsLinked":{
                "type":"integer",
                "description":""
            },
            "structureType":{
                "type":"string",
                "description":""
            },
            "struturePriority":{
                "type":"integer",
                "description":"",
                "minimum":1,
                "maximum":99
            },
            "effectiveDate":{
                "type":"string",
                "description":""
            },
            "endDate":{
                "type":"string",
                "description":""
            },
            "headerAccountNumber":{
                "type":"string",
                "description":""
            },
            "headerBranchCode":{
                "type":"string",
                "description":""
            },
            "headerCurrency":{
                "type":"string",
                "description":""
            },
            "multiBankFlag":{
                "type":"string",
                "description":""
            },
            "crossBorderFlag":{
                "type":"string",
                "description":""
            },
            "crossCurrencyFlag":{
                "type":"string",
                "description":""
            },
            "balanceType":{
                "type":"string",
                "description":""
            },
            "structureFrequency":{
                "type":"string",
                "description":""
            },
            "currencyRateType":{
                "type":"string",
                "description":""
            },
            "allowSweepOnCurrencyHol":{
                "type":"string",
                "description":""
            },
            "interestMethod":{
                "type":"string",
                "description":""
            },
            "ratePickUp":{
                "type":"string",
                "description":""
            },
            "nextRunDate":{
                "type":"string",
                "description":""
            },
            "eodExecution":{
                "type":"string",
                "description":""
            },
            "reverseFrequency":{
                "type":"string",
                "description":""
            },
            "instructionType":{
                "type":"string",
                "description":""
            },
            "reallocationMethod":{
                "type":"string",
                "description":""
            },
            "holidayTreatment":{
                "type":"string",
                "description":""
            },
            "maxBackwardDays":{
                "type":"integer",
                "description":""
            },
            "backwardTreatment":{
                "type":"string",
                "description":""
            },
            "centralAccountNumber":{
                "type":"string",
                "description":""
            },
            "centralAccountBranch":{
                "type":"string",
                "description":""
            },
            "centralAccountCurrency":{
                "type":"string",
                "description":""
            },
            "nextRunDateReverse":{
                "type":"string",
                "description":""
            },
            "prevRunDateReverse":{
                "type":"string",
                "description":""
            },
            "structureStatus":{
                "type":"string",
                "description":""
            },
            "investmentSweep":{
                "type":"string",
                "description":""
            },
            "considerPostSweepBalance":{
                "type":"string",
                "description":""
            },
            "fxRatePickup":{
                "type":"string",
                "description":""
            },
            "limitTrackingFlag":{
                "type":"string",
                "description":""
            },
            "sourceSystem":{
                "type":"string",
                "description":""
            },
            "systemAccountNumber":{
                "type":"string",
                "description":""
            },
            "systemAccountBranch":{
                "type":"string",
                "description":""
            },
            "systemAccountCurrency":{
                "type":"string",
                "description":""
            },
            "pauseStartDate":{
                "type":"string",
                "description":""
            },
            "pauseEndDate":{
                "type":"string",
                "description":""
            },
            "trackIcl":{
                "type":"string",
                "description":""
            },
            "LmmTmStructureDetailsDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmStructureDetailsDTO"
                }
            },
            "LmmTmStructureAccountsDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmStructureAccountsDTO"
                }
            }
        }
    }

Nested Schema : LmmTmStructureAccountsDTO
Type: `array`
Show Source

- Array of: object LmmTmStructureAccountsDTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/LmmTmStructureAccountsDTO"
        }
    }

Nested Schema : LmmTmStructureDetailsDTO
Type: `array`
Show Source

- Array of: object LmmTmStructureDetailsDTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/LmmTmStructureDetailsDTO"
        }
    }

Nested Schema : LmmTmStructureAccountsDTO
Type: `object`
Show Source

- accCategory(optional): string
- accountBranch(optional): string
- accountCurrency(optional): string
- accountNumber(optional): string
- accountType(optional): string
- acyAvailableBal(optional): number
- bankCode(optional): string
- cityId(optional): string
- countryId(optional): string
- id(optional): string
- isExternal(optional): string
- isNotional(optional): string
- isSelected(optional): string
- region(optional): string
- structureMasterId(optional): string

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":""
            },
            "structureMasterId":{
                "type":"string",
                "description":""
            },
            "accountNumber":{
                "type":"string",
                "description":""
            },
            "accountBranch":{
                "type":"string",
                "description":""
            },
            "accountCurrency":{
                "type":"string",
                "description":""
            },
            "isExternal":{
                "type":"string",
                "description":""
            },
            "isNotional":{
                "type":"string",
                "description":""
            },
            "accCategory":{
                "type":"string",
                "description":""
            },
            "accountType":{
                "type":"string",
                "description":""
            },
            "acyAvailableBal":{
                "type":"number",
                "description":""
            },
            "bankCode":{
                "type":"string",
                "description":""
            },
            "countryId":{
                "type":"string",
                "description":""
            },
            "cityId":{
                "type":"string",
                "description":""
            },
            "region":{
                "type":"string",
                "description":""
            },
            "isSelected":{
                "type":"string",
                "description":""
            }
        }
    }

Nested Schema : LmmTmStructureDetailsDTO
Type: `object`
Show Source

- accCategory(optional): string
- accountCurrency(optional): string
- accountLevel(optional): integer
- accountNumber(optional): string
- accountType(optional): string
- acyAvailableBal(optional): number
- allowReverseSweep(optional): string
- bankCode(optional): string
- bookingAccountBranch(optional): string
- bookingAccountCurrency(optional): string
- bookingAccountNumber(optional): string
- branchCode(optional): string
- centralAccountBranch(optional): string
- centralAccountCurrency(optional): string
- centralAccountNumber(optional): string
- cityId(optional): string
- countryId(optional): string
- eodExecution(optional): string
- id(optional): string
- isExternal(optional): string
- isHold(optional): string
- isNominatedAccount(optional): string
- isNotional(optional): string
- isTwoWay(optional): string
- LmmTmStructureAccPriorityDTO(optional): array LmmTmStructureAccPriorityDTO
- LmmTmStructureIclDTO(optional): array LmmTmStructureIclDTO
- LmmTmStructureInstructionDTO(optional): array LmmTmStructureInstructionDTO
- LmmTmStructurePaymentDTO(optional): array LmmTmStructurePaymentDTO
- onlineBalanceFetch(optional): string
- parentAccountBranch(optional): string
- parentAccountCurrency(optional): string
- parentAccountNumber(optional): string
- partialReverseSweep(optional): string
- partialTransferAllowed(optional): string
- percentageChildShare(optional): integer
- percentageShare(optional): integer
- ratePickUp(optional): string
- rateType(optional): string
- reallocationMethod(optional): string
- reallocationRequired(optional): string
- reverseSweepFrequency(optional): string
- structureMasterId(optional): string
- sweepPriority(optional): integer
- twowaySweepPriority(optional): integer

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":""
            },
            "structureMasterId":{
                "type":"string",
                "description":""
            },
            "accountNumber":{
                "type":"string",
                "description":""
            },
            "branchCode":{
                "type":"string",
                "description":""
            },
            "accountCurrency":{
                "type":"string",
                "description":""
            },
            "isExternal":{
                "type":"string",
                "description":""
            },
            "acyAvailableBal":{
                "type":"number",
                "description":""
            },
            "bankCode":{
                "type":"string",
                "description":""
            },
            "countryId":{
                "type":"string",
                "description":""
            },
            "cityId":{
                "type":"string",
                "description":""
            },
            "isNotional":{
                "type":"string",
                "description":""
            },
            "accCategory":{
                "type":"string",
                "description":""
            },
            "parentAccountNumber":{
                "type":"string",
                "description":""
            },
            "parentAccountBranch":{
                "type":"string",
                "description":""
            },
            "parentAccountCurrency":{
                "type":"string",
                "description":""
            },
            "bookingAccountNumber":{
                "type":"string",
                "description":""
            },
            "bookingAccountBranch":{
                "type":"string",
                "description":""
            },
            "bookingAccountCurrency":{
                "type":"string",
                "description":""
            },
            "rateType":{
                "type":"string",
                "description":""
            },
            "accountType":{
                "type":"string",
                "description":""
            },
            "sweepPriority":{
                "type":"integer",
                "description":""
            },
            "isTwoWay":{
                "type":"string",
                "description":""
            },
            "reverseSweepFrequency":{
                "type":"string",
                "description":""
            },
            "twowaySweepPriority":{
                "type":"integer",
                "description":""
            },
            "onlineBalanceFetch":{
                "type":"string",
                "description":""
            },
            "partialReverseSweep":{
                "type":"string",
                "description":""
            },
            "isHold":{
                "type":"string",
                "description":""
            },
            "eodExecution":{
                "type":"string",
                "description":""
            },
            "ratePickUp":{
                "type":"string",
                "description":""
            },
            "reallocationRequired":{
                "type":"string",
                "description":""
            },
            "reallocationMethod":{
                "type":"string",
                "description":""
            },
            "allowReverseSweep":{
                "type":"string",
                "description":""
            },
            "isNominatedAccount":{
                "type":"string",
                "description":""
            },
            "accountLevel":{
                "type":"integer",
                "description":""
            },
            "centralAccountNumber":{
                "type":"string",
                "description":""
            },
            "centralAccountBranch":{
                "type":"string",
                "description":""
            },
            "centralAccountCurrency":{
                "type":"string",
                "description":""
            },
            "percentageShare":{
                "type":"integer",
                "description":""
            },
            "percentageChildShare":{
                "type":"integer",
                "description":""
            },
            "partialTransferAllowed":{
                "type":"string",
                "description":""
            },
            "LmmTmStructureInstructionDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmStructureInstructionDTO"
                }
            },
            "LmmTmStructurePaymentDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmStructurePaymentDTO"
                }
            },
            "LmmTmStructureAccPriorityDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmStructureAccPriorityDTO"
                }
            },
            "LmmTmStructureIclDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmStructureIclDTO"
                }
            }
        }
    }

Nested Schema : LmmTmStructureAccPriorityDTO
Type: `array`
Show Source

- Array of: object LmmTmStructureAccPriorityDTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/LmmTmStructureAccPriorityDTO"
        }
    }

Nested Schema : LmmTmStructureIclDTO
Type: `array`
Show Source

- Array of: object LmmTmStructureIclDTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/LmmTmStructureIclDTO"
        }
    }

Nested Schema : LmmTmStructureInstructionDTO
Type: `array`
Show Source

- Array of: object LmmTmStructureInstructionDTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/LmmTmStructureInstructionDTO"
        }
    }

Nested Schema : LmmTmStructurePaymentDTO
Type: `array`
Show Source

- Array of: object LmmTmStructurePaymentDTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/LmmTmStructurePaymentDTO"
        }
    }

Nested Schema : LmmTmStructureAccPriorityDTO
Type: `object`
Show Source

- accountNumber(optional): string
- id(optional): string
- structureDetailsId(optional): string
- structureId(optional): string
  Pattern: `[A-Z0-9]{1,30}`
- structureMasterId(optional): string
- structurePriority(optional): integer
- versionNo(optional): integer

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":""
            },
            "structureId":{
                "type":"string",
                "description":"",
                "pattern":"[A-Z0-9]{1,30}"
            },
            "accountNumber":{
                "type":"string",
                "description":""
            },
            "structureDetailsId":{
                "type":"string",
                "description":""
            },
            "structureMasterId":{
                "type":"string",
                "description":""
            },
            "structurePriority":{
                "type":"integer",
                "description":""
            },
            "versionNo":{
                "type":"integer",
                "description":""
            }
        }
    }

Nested Schema : LmmTmStructureIclDTO
Type: `object`
Show Source

- iclBookingReport(optional): string
- iclReference(optional): string
- iclSettlementReport(optional): string
- id(optional): string
- loanType(optional): string
- structureDetailsId(optional): string
- structureMasterId(optional): string
- trackIcl(optional): string

    {
        "type":"object",
        "properties":{
            "iclBookingReport":{
                "type":"string",
                "description":""
            },
            "iclReference":{
                "type":"string",
                "description":""
            },
            "iclSettlementReport":{
                "type":"string",
                "description":""
            },
            "id":{
                "type":"string",
                "description":""
            },
            "loanType":{
                "type":"string",
                "description":""
            },
            "structureDetailsId":{
                "type":"string",
                "description":""
            },
            "structureMasterId":{
                "type":"string",
                "description":""
            },
            "trackIcl":{
                "type":"string",
                "description":""
            }
        }
    }

Nested Schema : LmmTmStructureInstructionDTO
Type: `object`
Show Source

- id(optional): string
- instrDesc(optional): string
- instructionId(optional): string
- instructionPriority(optional): integer
- LmmTmStructureInstructionDetDTO(optional): array LmmTmStructureInstructionDetDTO
- LmmTmStructureInstructionFrequencyDTO(optional): array LmmTmStructureInstructionFrequencyDTO
- structureDetailsId(optional): string

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":""
            },
            "structureDetailsId":{
                "type":"string",
                "description":""
            },
            "instructionId":{
                "type":"string",
                "description":""
            },
            "instrDesc":{
                "type":"string",
                "description":""
            },
            "instructionPriority":{
                "type":"integer",
                "description":""
            },
            "LmmTmStructureInstructionFrequencyDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmStructureInstructionFrequencyDTO"
                }
            },
            "LmmTmStructureInstructionDetDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmStructureInstructionDetDTO"
                }
            }
        }
    }

Nested Schema : LmmTmStructureInstructionDetDTO
Type: `array`
Show Source

- Array of: object LmmTmStructureInstructionDetDTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/LmmTmStructureInstructionDetDTO"
        }
    }

Nested Schema : LmmTmStructureInstructionFrequencyDTO
Type: `array`
Show Source

- Array of: object LmmTmStructureInstructionFrequencyDTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/LmmTmStructureInstructionFrequencyDTO"
        }
    }

Nested Schema : LmmTmStructureInstructionDetDTO
Type: `object`
Show Source

- id(optional): string
- paramName(optional): string
- paramValue(optional): string
- structureInstructionId(optional): string

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":""
            },
            "structureInstructionId":{
                "type":"string",
                "description":""
            },
            "paramName":{
                "type":"string",
                "description":""
            },
            "paramValue":{
                "type":"string",
                "description":""
            }
        }
    }

Nested Schema : LmmTmStructureInstructionFrequencyDTO
Type: `object`
Show Source

- freqDesc(optional): string
- frequencyId(optional): string
- id(optional): string
- structureInstructionId(optional): string

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":""
            },
            "structureInstructionId":{
                "type":"string",
                "description":""
            },
            "frequencyId":{
                "type":"string",
                "description":""
            },
            "freqDesc":{
                "type":"string",
                "description":""
            }
        }
    }

Nested Schema : LmmTmStructurePaymentDTO
Type: `object`
Show Source

- id(optional): string
- interfaceMasterId(optional): string
- LmmTmStructurePaymentDetailDTO(optional): array LmmTmStructurePaymentDetailDTO
- structureDetailsId(optional): string
- sweepDirection(optional): string

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":""
            },
            "structureDetailsId":{
                "type":"string",
                "description":""
            },
            "sweepDirection":{
                "type":"string",
                "description":""
            },
            "interfaceMasterId":{
                "type":"string",
                "description":""
            },
            "LmmTmStructurePaymentDetailDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmStructurePaymentDetailDTO"
                }
            }
        }
    }

Nested Schema : LmmTmStructurePaymentDetailDTO
Type: `array`
Show Source

- Array of: object LmmTmStructurePaymentDetailDTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/LmmTmStructurePaymentDetailDTO"
        }
    }

Nested Schema : LmmTmStructurePaymentDetailDTO
Type: `object`
Show Source

- id(optional): string
- paramName(optional): string
- paramValue(optional): string
- structurePaymentId(optional): string

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":""
            },
            "structurePaymentId":{
                "type":"string",
                "description":""
            },
            "paramName":{
                "type":"string",
                "description":""
            },
            "paramValue":{
                "type":"string",
                "description":""
            }
        }
    }

#### 400 Response

Malformed syntax.

#### 401 Response

Request does not have sufficient credentials.

#### 403 Response

Request is not authorized.

#### 500 Response

Internal error
Back to Top