Jump to

• Request
• Response

Fetch all the accounts of a structure by given ID

get

/structure/{id}/accounts

This endpoint is used to fetch all the accounts of a structure by given ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string
  Key of the structure

Query Parameters

• isSimulationMode(optional): boolean
  true for simulation mode and false for rest

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful operation.

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

• accountCurrency(optional): string
• accountLevel(optional): integer
• accountNumber(optional): string
• accountType(optional): string
• allowReverseSweep(optional): string
• bookingAccountBranch(optional): string
• bookingAccountCurrency(optional): string
• bookingAccountNumber(optional): string
• branchCode(optional): string
• centralAccountBranch(optional): string
• centralAccountCurrency(optional): string
• centralAccountNumber(optional): string
• eodExecution(optional): string
• id(optional): string
• instructionPriority(optional): integer
• isExternalAccount(optional): string
• isHold(optional): string
• isNominatedAccount(optional): string
• isTwoWay(optional): string
• LmmTmStructureInstructionDTO(optional): array LmmTmStructureInstructionDTO
• 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: string
• 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":""
        },
        "isExternalAccount":{
            "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":""
        },
        "instructionPriority":{
            "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"
            }
        }
    },
    "required":[
        "structureMasterId"
    ]
}

Nested Schema : LmmTmStructureInstructionDTO

Type: array

Show Source

• Array of: object LmmTmStructureInstructionDTO

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

Nested Schema : LmmTmStructureInstructionDTO

Type: object

Show Source

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

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

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: string

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

Nested Schema : LmmTmStructureInstructionFrequencyDTO

Type: object

Show Source

• frequencyId(optional): string
• id(optional): string
• structureInstructionId: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "structureInstructionId":{
            "type":"string",
            "description":""
        },
        "frequencyId":{
            "type":"string",
            "description":""
        }
    },
    "required":[
        "structureInstructionId"
    ]
}

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