Previous Next JavaScript must be enabled to correctly display this content

## Generate and Get the Interest Optimization Structure ID

get

/service/lmx/interest-optimization/getIOStructureId

This endpoint is used to generate and get the interest optimization structure ID.

### Request

There are no request parameters for this operation.

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 200 Response

Returns the IO structure id.
Body ()
Root Schema : LmxTmIOStructureWrapperDTO
Type: `object`
Show Source

- data(optional): object LmxTmIOStructureMasterDTO

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

Nested Schema : LmxTmIOStructureMasterDTO
Type: `object`
Match All
Show Source

- allOf GenericDto
- object LmxTmIOStructureMasterDTO-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "branchCode":{
                        "type":"string",
                        "description":"",
                        "maxLength":4
                    },
                    "customerId":{
                        "type":"string",
                        "description":"",
                        "pattern":"[a-zA-Z0-9]{1,20}"
                    },
                    "customerName":{
                        "type":"string",
                        "description":""
                    },
                    "prospect":{
                        "type":"string",
                        "description":"",
                        "pattern":"[a-zA-Z0-9]{1,20}"
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":""
                    },
                    "endDate":{
                        "type":"string",
                        "format":"date",
                        "description":""
                    },
                    "interestMethod":{
                        "type":"string",
                        "description":"",
                        "maxLength":25
                    },
                    "isTemp":{
                        "type":"string",
                        "description":"",
                        "maxLength":1
                    },
                    "logCode":{
                        "type":"string",
                        "description":"",
                        "maxLength":20
                    },
                    "nominatedAccBranch":{
                        "type":"string",
                        "description":"",
                        "maxLength":4
                    },
                    "nominatedAccCcy":{
                        "type":"string",
                        "description":"",
                        "maxLength":3
                    },
                    "nominatedAccNo":{
                        "type":"string",
                        "description":"",
                        "maxLength":30
                    },
                    "sourceSystem":{
                        "type":"string",
                        "description":"",
                        "maxLength":35
                    },
                    "pauseStartDate":{
                        "type":"string",
                        "format":"date",
                        "description":""
                    },
                    "pauseEndDate":{
                        "type":"string",
                        "format":"date",
                        "description":""
                    },
                    "structureDescription":{
                        "type":"string",
                        "description":"",
                        "maxLength":200
                    },
                    "structureId":{
                        "type":"string",
                        "description":"",
                        "pattern":"[A-Z0-9]{1,30}"
                    },
                    "simulationId":{
                        "type":"string",
                        "description":"",
                        "pattern":"[A-Z0-9]{1,30}"
                    },
                    "thresholdAmount":{
                        "type":"number",
                        "description":""
                    },
                    "thresholdCurrency":{
                        "type":"string",
                        "description":"",
                        "maxLength":3
                    },
                    "versionNo":{
                        "type":"number",
                        "description":""
                    },
                    "ioRateType":{
                        "type":"string",
                        "description":"",
                        "maxLength":8
                    },
                    "isSimulation":{
                        "type":"boolean",
                        "description":"Denotes whether this is a simulation structure",
                        "default":false
                    },
                    "LmxTmIOStructureDetailDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/LmxTmIOStructureDetailDTO"
                        }
                    },
                    "LmxTmIOCurrencyRateDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/LmxTmIOCurrencyRateDTO"
                        }
                    },
                    "LmxTmIOCurrencyThresholdDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/LmxTmIOCurrencyThresholdDTO"
                        }
                    },
                    "LmxTmStructureAccountsDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/LmxTmStructureAccountsDTO"
                        }
                    },
                    "LmxTmSimAccountVdBalDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/LmxTmSimAccountVdBalDTO"
                        }
                    }
                },
                "required":[
                    "structureId",
                    "structureDescription",
                    "customerId",
                    "effectiveDate",
                    "thresholdCurrency",
                    "thresholdAmount",
                    "LmxTmIOStructureDetailDTO",
                    "LmxTmIOCurrencyRateDTO",
                    "LmxTmIOCurrencyThresholdDTO"
                ]
            }
        ]
    }

Nested Schema : GenericDto
Match All
Show Source

- object GenericDto-allOf[0]
  Discriminator: `resource_type`

    {
        "allOf":[
            {
                "type":"object",
                "discriminator":"resource_type"
            }
        ]
    }

Nested Schema : GenericDto-allOf[0]
Type: `object`
Discriminator: `resource_type`
Nested Schema : LmxTmIOStructureMasterDTO-allOf[1]
Type: `object`
Show Source

- branchCode(optional): string
  Maximum Length: `4`
- customerId: string
  Pattern: `[a-zA-Z0-9]{1,20}`
- customerName(optional): string
- effectiveDate: string(date)
- endDate(optional): string(date)
- interestMethod(optional): string
  Maximum Length: `25`
- ioRateType(optional): string
  Maximum Length: `8`
- isSimulation(optional): boolean
  Default Value: `false`
  Denotes whether this is a simulation structure
- isTemp(optional): string
  Maximum Length: `1`
- LmxTmIOCurrencyRateDTO: array LmxTmIOCurrencyRateDTO
- LmxTmIOCurrencyThresholdDTO: array LmxTmIOCurrencyThresholdDTO
- LmxTmIOStructureDetailDTO: array LmxTmIOStructureDetailDTO
- LmxTmSimAccountVdBalDTO(optional): array LmxTmSimAccountVdBalDTO
- LmxTmStructureAccountsDTO(optional): array LmxTmStructureAccountsDTO
- logCode(optional): string
  Maximum Length: `20`
- nominatedAccBranch(optional): string
  Maximum Length: `4`
- nominatedAccCcy(optional): string
  Maximum Length: `3`
- nominatedAccNo(optional): string
  Maximum Length: `30`
- pauseEndDate(optional): string(date)
- pauseStartDate(optional): string(date)
- prospect(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
- simulationId(optional): string
  Pattern: `[A-Z0-9]{1,30}`
- sourceSystem(optional): string
  Maximum Length: `35`
- structureDescription: string
  Maximum Length: `200`
- structureId: string
  Pattern: `[A-Z0-9]{1,30}`
- thresholdAmount: number
- thresholdCurrency: string
  Maximum Length: `3`
- versionNo(optional): number

    {
        "type":"object",
        "properties":{
            "branchCode":{
                "type":"string",
                "description":"",
                "maxLength":4
            },
            "customerId":{
                "type":"string",
                "description":"",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "customerName":{
                "type":"string",
                "description":""
            },
            "prospect":{
                "type":"string",
                "description":"",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "endDate":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "interestMethod":{
                "type":"string",
                "description":"",
                "maxLength":25
            },
            "isTemp":{
                "type":"string",
                "description":"",
                "maxLength":1
            },
            "logCode":{
                "type":"string",
                "description":"",
                "maxLength":20
            },
            "nominatedAccBranch":{
                "type":"string",
                "description":"",
                "maxLength":4
            },
            "nominatedAccCcy":{
                "type":"string",
                "description":"",
                "maxLength":3
            },
            "nominatedAccNo":{
                "type":"string",
                "description":"",
                "maxLength":30
            },
            "sourceSystem":{
                "type":"string",
                "description":"",
                "maxLength":35
            },
            "pauseStartDate":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "pauseEndDate":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "structureDescription":{
                "type":"string",
                "description":"",
                "maxLength":200
            },
            "structureId":{
                "type":"string",
                "description":"",
                "pattern":"[A-Z0-9]{1,30}"
            },
            "simulationId":{
                "type":"string",
                "description":"",
                "pattern":"[A-Z0-9]{1,30}"
            },
            "thresholdAmount":{
                "type":"number",
                "description":""
            },
            "thresholdCurrency":{
                "type":"string",
                "description":"",
                "maxLength":3
            },
            "versionNo":{
                "type":"number",
                "description":""
            },
            "ioRateType":{
                "type":"string",
                "description":"",
                "maxLength":8
            },
            "isSimulation":{
                "type":"boolean",
                "description":"Denotes whether this is a simulation structure",
                "default":false
            },
            "LmxTmIOStructureDetailDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmxTmIOStructureDetailDTO"
                }
            },
            "LmxTmIOCurrencyRateDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmxTmIOCurrencyRateDTO"
                }
            },
            "LmxTmIOCurrencyThresholdDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmxTmIOCurrencyThresholdDTO"
                }
            },
            "LmxTmStructureAccountsDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmxTmStructureAccountsDTO"
                }
            },
            "LmxTmSimAccountVdBalDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmxTmSimAccountVdBalDTO"
                }
            }
        },
        "required":[
            "structureId",
            "structureDescription",
            "customerId",
            "effectiveDate",
            "thresholdCurrency",
            "thresholdAmount",
            "LmxTmIOStructureDetailDTO",
            "LmxTmIOCurrencyRateDTO",
            "LmxTmIOCurrencyThresholdDTO"
        ]
    }

Nested Schema : LmxTmIOCurrencyRateDTO
Type: `array`
Show Source

- Array of: object LmxTmIOCurrencyRateDTO

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

Nested Schema : LmxTmIOCurrencyThresholdDTO
Type: `array`
Show Source

- Array of: object LmxTmIOCurrencyThresholdDTO

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

Nested Schema : LmxTmIOStructureDetailDTO
Type: `array`
Show Source

- Array of: object LmxTmIOStructureDetailDTO

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

Nested Schema : LmxTmSimAccountVdBalDTO
Type: `array`
Show Source

- Array of: object LmxTmSimAccountVdBalDTO

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

Nested Schema : LmxTmStructureAccountsDTO
Type: `array`
Show Source

- Array of: object LmxTmStructureAccountsDTO

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

Nested Schema : LmxTmIOCurrencyRateDTO
Type: `object`
Show Source

- currency: string
  Maximum Length: `3`
- enhancementRate: number
- fromAmount: number
- id(optional): string
  Maximum Length: `36`
- rateType: string
  Maximum Length: `5`
- structureMasterId(optional): string
  Maximum Length: `36`
- toAmount: number

    {
        "type":"object",
        "properties":{
            "currency":{
                "type":"string",
                "description":"",
                "maxLength":3
            },
            "enhancementRate":{
                "type":"number",
                "description":""
            },
            "fromAmount":{
                "type":"number",
                "description":""
            },
            "id":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "structureMasterId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "rateType":{
                "type":"string",
                "description":"",
                "maxLength":5
            },
            "toAmount":{
                "type":"number",
                "description":""
            }
        },
        "required":[
            "currency",
            "enhancementRate",
            "fromAmount",
            "toAmount",
            "rateType"
        ]
    }

Nested Schema : LmxTmIOCurrencyThresholdDTO
Type: `object`
Show Source

- amount: number
- currency: string
  Maximum Length: `3`
- enhancementRate(optional): number
- id(optional): string
  Maximum Length: `36`
- structureMasterId(optional): string
  Maximum Length: `36`

    {
        "type":"object",
        "properties":{
            "amount":{
                "type":"number",
                "description":""
            },
            "currency":{
                "type":"string",
                "description":"",
                "maxLength":3
            },
            "enhancementRate":{
                "type":"number",
                "description":""
            },
            "id":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "structureMasterId":{
                "type":"string",
                "description":"",
                "maxLength":36
            }
        },
        "required":[
            "amount",
            "currency"
        ]
    }

Nested Schema : LmxTmIOStructureDetailDTO
Type: `object`
Show Source

- accountNumber: string
  Maximum Length: `30`
- branchCode: string
  Maximum Length: `4`
- currency: string
  Maximum Length: `3`
- id(optional): string
  Maximum Length: `36`
- structureMasterId(optional): string
  Maximum Length: `36`

    {
        "type":"object",
        "properties":{
            "accountNumber":{
                "type":"string",
                "description":"",
                "maxLength":30
            },
            "branchCode":{
                "type":"string",
                "description":"",
                "maxLength":4
            },
            "currency":{
                "type":"string",
                "description":"",
                "maxLength":3
            },
            "id":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "structureMasterId":{
                "type":"string",
                "description":"",
                "maxLength":36
            }
        },
        "required":[
            "accountNumber",
            "branchCode",
            "currency"
        ]
    }

Nested Schema : LmxTmSimAccountVdBalDTO
Type: `object`
Show Source

- accountBranch(optional): string
  Maximum Length: `4`
- accountCurrency(optional): string
  Maximum Length: `3`
- accountNumber(optional): string
  Maximum Length: `50`
- accountVdBal(optional): number
- id(optional): string
  Maximum Length: `36`
- modNo(optional): integer
- structureMasterId(optional): string
  Maximum Length: `36`
- valueDate(optional): string(date)

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "accountNumber":{
                "type":"string",
                "description":"",
                "maxLength":50
            },
            "accountBranch":{
                "type":"string",
                "description":"",
                "maxLength":4
            },
            "accountCurrency":{
                "type":"string",
                "description":"",
                "maxLength":3
            },
            "accountVdBal":{
                "type":"number",
                "description":""
            },
            "valueDate":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "structureMasterId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "modNo":{
                "type":"integer",
                "description":""
            }
        }
    }

Nested Schema : LmxTmStructureAccountsDTO
Type: `object`
Show Source

- 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`

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "structureMasterId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "accountNumber":{
                "type":"string",
                "description":"",
                "maxLength":30
            },
            "accountDescription":{
                "type":"string",
                "description":"",
                "maxLength":105
            },
            "accountBranch":{
                "type":"string",
                "description":""
            },
            "accountCurrency":{
                "type":"string",
                "description":""
            },
            "isExternal":{
                "type":"string",
                "description":""
            },
            "isNotional":{
                "type":"string",
                "description":"",
                "maxLength":1,
                "pattern":"[Y,N]",
                "default":"N"
            },
            "accCategory":{
                "type":"string",
                "description":"",
                "maxLength":10
            },
            "accountType":{
                "type":"string",
                "description":"",
                "maxLength":20
            },
            "acyAvailableBal":{
                "type":"number",
                "description":""
            },
            "bankCode":{
                "type":"string",
                "description":""
            },
            "bankDesc":{
                "type":"string",
                "description":""
            },
            "countryId":{
                "type":"string",
                "description":""
            },
            "cityId":{
                "type":"string",
                "description":""
            },
            "region":{
                "type":"string",
                "description":""
            },
            "isSelected":{
                "type":"string",
                "description":"",
                "maxLength":1
            },
            "entityID":{
                "type":"string",
                "description":"Entity ID"
            },
            "entityName":{
                "type":"string",
                "description":"Entity Name"
            },
            "iban":{
                "type":"string",
                "description":"IBAN Number"
            },
            "customerName":{
                "type":"string",
                "description":"Customer Name"
            },
            "customerNumber":{
                "type":"string",
                "description":"Customer number",
                "maxLength":20
            },
            "customerDesc":{
                "type":"string",
                "description":"Customer Description",
                "maxLength":105
            },
            "isDebitUnlimited":{
                "type":"string",
                "description":"",
                "maxLength":1
            },
            "isRegulatedDebits":{
                "type":"string",
                "description":"",
                "maxLength":1
            },
            "groupCode":{
                "type":"string",
                "description":"",
                "maxLength":5
            },
            "simAccountNumber":{
                "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