Previous Next JavaScript must be enabled to correctly display this content

## Retrieves the child account by parent account number and master ID

get

/service/lma/structure/v1/childAccounts

This endpoint is used to get the child Accounts by parent account number and master id.

### Request

Supported Media Types

- application/json
- application/xml

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`
- limit(optional): integer
  limit is maximum no of records to be fetched
- offset(optional): integer
  offset is starting no of records to be fetched
- parentAccountNumber: string
  Parent Account Number that needs to be fetched
- structureMasterId: string
  Id of the structure master that needs to be fetched
- version(optional): string
  Version of the structure to be fetched

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 200 Response

Returns the child Accounts based on given parent account number and master id.
Body ()
Root Schema : LmmTmStructureDetailsWrapperDTO
Type: `object`
Show Source

- data(optional): array data

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

Nested Schema : data
Type: `array`
Show Source

- Array of: object LmmTmStructureDetailsDTO

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

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