Previous Next JavaScript must be enabled to correctly display this content

## Adds a new structure from external system

post

/structure/createExternal

This endpoint is used to add a new structure from external system.

### Request

Supported Media Types

- application/json
- application/xml

Body ()
Request Body that contains data required for creating a new structure from external system
Root Schema : LmmTmStructureCollection
Type: `object`
Collection of structures.
Show Source

- data(optional): array data
- paging(optional): object PagingDto

    {
        "description":"Collection of structures.",
        "type":"object",
        "properties":{
            "data":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmStructureDTO"
                }
            },
            "paging":{
                "$ref":"#/definitions/PagingDto"
            }
        }
    }

Nested Schema : data
Type: `array`
Show Source

- Array of: object LmmTmStructureDTO

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

Nested Schema : PagingDto
Type: `object`
Show Source

- totalResults(optional): integer

    {
        "type":"object",
        "properties":{
            "totalResults":{
                "type":"integer"
            }
        }
    }

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

- allOf GenericDto
- object LmmTmStructureDTO-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "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":""
                    },
                    "LmmTmStructureDetailsDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/LmmTmStructureDetailsDTO"
                        }
                    },
                    "LmmTmStructureAccountsDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/LmmTmStructureAccountsDTO"
                        },
                        "required":[
                            "id",
                            "structureId"
                        ]
                    }
                }
            }
        ]
    }

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 : LmmTmStructureDTO-allOf[1]
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

    {
        "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":""
            },
            "LmmTmStructureDetailsDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmStructureDetailsDTO"
                }
            },
            "LmmTmStructureAccountsDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmStructureAccountsDTO"
                },
                "required":[
                    "id",
                    "structureId"
                ]
            }
        }
    }

Nested Schema : LmmTmStructureAccountsDTO
Type: `array`
Show Source

- Array of: object LmmTmStructureAccountsDTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/LmmTmStructureAccountsDTO"
        },
        "required":[
            "id",
            "structureId"
        ]
    }

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
  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":""
            }
        }
    }

Nested Schema : LmmTmStructureDetailsDTO
Type: `object`
Show Source

- 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

    {
        "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":""
            },
            "branchCode":{
                "type":"string",
                "description":"",
                "maxLength":4
            },
            "accountCurrency":{
                "type":"string",
                "description":""
            },
            "isExternal":{
                "type":"string",
                "description":""
            },
            "acyAvailableBal":{
                "type":"number",
                "description":""
            },
            "bankCode":{
                "type":"string",
                "description":""
            },
            "bankDesc":{
                "type":"string",
                "description":""
            },
            "countryId":{
                "type":"string",
                "description":""
            },
            "cityId":{
                "type":"string",
                "description":""
            },
            "region":{
                "type":"string",
                "description":""
            },
            "latitude":{
                "type":"number",
                "description":""
            },
            "longitude":{
                "type":"number",
                "description":""
            },
            "isNotional":{
                "type":"string",
                "description":""
            },
            "accCategory":{
                "type":"string",
                "description":""
            },
            "parentAccountNumber":{
                "type":"string",
                "description":"",
                "maxLength":30
            },
            "parentAccountBranch":{
                "type":"string",
                "description":"",
                "maxLength":4
            },
            "parentAccountCurrency":{
                "type":"string",
                "description":"",
                "maxLength":3
            },
            "bookingAccountNumber":{
                "type":"string",
                "description":"",
                "maxLength":30
            },
            "bookingAccountBranch":{
                "type":"string",
                "description":"",
                "maxLength":4
            },
            "bookingAccountCurrency":{
                "type":"string",
                "description":"",
                "maxLength":3
            },
            "rateType":{
                "type":"string",
                "description":"",
                "maxLength":8
            },
            "accountType":{
                "type":"string",
                "description":"",
                "maxLength":20
            },
            "sweepPriority":{
                "type":"integer",
                "description":""
            },
            "isTwoWay":{
                "type":"string",
                "description":"",
                "maxLength":1,
                "pattern":"[Y,N]",
                "default":"N"
            },
            "reverseSweepFrequency":{
                "type":"string",
                "description":"",
                "maxLength":20
            },
            "twowaySweepPriority":{
                "type":"integer",
                "description":""
            },
            "onlineBalanceFetch":{
                "type":"string",
                "description":"",
                "maxLength":1
            },
            "partialReverseSweep":{
                "type":"string",
                "description":"",
                "maxLength":1,
                "default":"N"
            },
            "isHold":{
                "type":"string",
                "description":"",
                "maxLength":1,
                "pattern":"[Y,N]",
                "default":"N"
            },
            "eodExecution":{
                "type":"string",
                "description":"",
                "maxLength":1
            },
            "ratePickUp":{
                "type":"string",
                "description":"",
                "maxLength":40
            },
            "reallocationRequired":{
                "type":"string",
                "description":"",
                "maxLength":1
            },
            "reallocationMethod":{
                "type":"string",
                "description":"",
                "maxLength":40
            },
            "allowReverseSweep":{
                "type":"string",
                "description":"",
                "maxLength":1,
                "pattern":"[Y,N]",
                "default":"N"
            },
            "isNominatedAccount":{
                "type":"string",
                "description":"",
                "maxLength":1
            },
            "accountLevel":{
                "type":"integer",
                "description":""
            },
            "centralAccountNumber":{
                "type":"string",
                "description":"",
                "maxLength":30
            },
            "centralAccountBranch":{
                "type":"string",
                "description":"",
                "maxLength":4
            },
            "centralAccountCurrency":{
                "type":"string",
                "description":"",
                "maxLength":3
            },
            "percentageShare":{
                "type":"integer",
                "description":""
            },
            "percentageChildShare":{
                "type":"integer",
                "description":""
            },
            "partialTransferAllowed":{
                "type":"string",
                "description":"",
                "maxLength":1
            },
            "holdStartDate":{
                "type":"string",
                "description":"",
                "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
            },
            "holdEndDate":{
                "type":"string",
                "description":"",
                "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
            },
            "isVirtual":{
                "type":"string",
                "description":""
            },
            "oneWayAccountGroup":{
                "type":"string",
                "description":"",
                "maxLength":5
            },
            "twoWayAccountGroup":{
                "type":"string",
                "description":"",
                "maxLength":5
            },
            "isRegulatedDebits":{
                "type":"string",
                "description":""
            },
            "entityID":{
                "type":"string",
                "description":"Entity ID"
            },
            "entityName":{
                "type":"string",
                "description":"Entity Name"
            },
            "iban":{
                "type":"string",
                "description":"IBAN Number"
            },
            "useDefaultPaymntIns":{
                "type":"string",
                "description":"payment ins is defaulted or not",
                "maxLength":1,
                "pattern":"[Y,N]",
                "default":"N"
            },
            "customerName":{
                "type":"string",
                "description":"Customer Name"
            },
            "LmmTmStructureInstructionDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmStructureInstructionDTO"
                }
            },
            "LmmTmStructurePaymentDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmStructurePaymentDTO"
                }
            },
            "LmmTmStructureAccPriorityDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmStructureAccPriorityDTO"
                }
            },
            "LmmTmStrRevSweepDetailsDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmStrRevSweepDetailsDTO"
                }
            },
            "LmmTmStructureIclDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmStructureIclDTO"
                }
            }
        },
        "required":[
            "structureMasterId"
        ]
    }

Nested Schema : LmmTmStrRevSweepDetailsDTO
Type: `array`
Show Source

- Array of: object LmmTmStrRevSweepDetailsDTO

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

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 : LmmTmStrRevSweepDetailsDTO
Type: `object`
Show Source

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

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "structureMasterId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "structureDetailsId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "accountNumber":{
                "type":"string",
                "description":"",
                "maxLength":30
            },
            "accountBranch":{
                "type":"string",
                "description":"",
                "maxLength":4
            },
            "accountCurrency":{
                "type":"string",
                "description":"",
                "maxLength":3
            },
            "reverseSweepFrequency":{
                "type":"string",
                "description":"",
                "maxLength":20
            },
            "eodExecution":{
                "type":"string",
                "description":"",
                "maxLength":1,
                "pattern":"[Y,N]"
            },
            "bodExecution":{
                "type":"string",
                "description":"",
                "maxLength":1,
                "pattern":"[Y,N]"
            },
            "nextRunDate":{
                "type":"string",
                "description":""
            },
            "previousRunDate":{
                "type":"string",
                "description":""
            }
        }
    }

Nested Schema : LmmTmStructureAccPriorityDTO
Type: `object`
Show Source

- 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

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "structureId":{
                "type":"string",
                "description":"",
                "pattern":"[A-Z0-9]{1,30}"
            },
            "structureDescription":{
                "type":"string",
                "description":"",
                "pattern":"[A-Za-z0-9 ()_+:\"',.?/-]{1,200}"
            },
            "structureType":{
                "type":"string",
                "description":""
            },
            "effectiveDate":{
                "type":"string",
                "description":"",
                "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
            },
            "endDate":{
                "type":"string",
                "description":"",
                "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
            },
            "structurePriority":{
                "type":"integer",
                "description":""
            },
            "accountNumber":{
                "type":"string",
                "description":"",
                "maxLength":30
            },
            "structureDetailsId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "structureMasterId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "versionNo":{
                "type":"integer",
                "description":""
            },
            "branchCode":{
                "type":"string",
                "description":"",
                "maxLength":4
            }
        }
    }

Nested Schema : LmmTmStructureIclDTO
Type: `object`
Show Source

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

    {
        "type":"object",
        "properties":{
            "iclBookingReport":{
                "type":"string",
                "description":"",
                "maxLength":1,
                "pattern":"[Y,N]"
            },
            "iclReference":{
                "type":"string",
                "description":"",
                "maxLength":100
            },
            "iclSettlementReport":{
                "type":"string",
                "description":"",
                "maxLength":1,
                "pattern":"[Y,N]"
            },
            "id":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "loanType":{
                "type":"string",
                "description":"",
                "maxLength":1
            },
            "structureDetailsId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "structureMasterId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "trackIcl":{
                "type":"string",
                "description":"",
                "maxLength":1,
                "pattern":"[Y,N]"
            }
        }
    }

Nested Schema : LmmTmStructureInstructionDTO
Type: `object`
Show Source

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

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "structureDetailsId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "instructionId":{
                "type":"string",
                "description":"",
                "maxLength":15
            },
            "instrDesc":{
                "type":"string",
                "description":"",
                "maxLength":100
            },
            "instructionPriority":{
                "type":"integer",
                "description":""
            },
            "suspensionStartDate":{
                "type":"string",
                "description":"",
                "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
            },
            "suspensionEndDate":{
                "type":"string",
                "description":"",
                "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
            },
            "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
  Maximum Length: `36`
- paramName(optional): string
  Maximum Length: `25`
- paramValue(optional): string
  Maximum Length: `100`
- structureInstructionId: string
  Maximum Length: `36`

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

Nested Schema : LmmTmStructureInstructionFrequencyDTO
Type: `object`
Show Source

- freqDesc(optional): string
- frequencyId(optional): string
  Maximum Length: `25`
- id(optional): string
  Maximum Length: `36`
- structureInstructionId: string
  Maximum Length: `36`

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

Nested Schema : LmmTmStructurePaymentDTO
Type: `object`
Show Source

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

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":"",
                "maxLength":150
            },
            "structureDetailsId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "sweepDirection":{
                "type":"string",
                "description":"",
                "maxLength":10
            },
            "interfaceMasterId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "LmmTmStructurePaymentDetailDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmStructurePaymentDetailDTO"
                }
            }
        },
        "required":[
            "structureDetailsId"
        ]
    }

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
  Maximum Length: `36`
- paramName(optional): string
  Maximum Length: `50`
- paramValue(optional): string
  Maximum Length: `100`
- structurePaymentId: string
  Maximum Length: `36`

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "structurePaymentId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "paramName":{
                "type":"string",
                "description":"",
                "maxLength":50
            },
            "paramValue":{
                "type":"string",
                "description":"",
                "maxLength":100
            }
        },
        "required":[
            "structurePaymentId"
        ]
    }

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 201 Response

Returns message of succes or failure
Headers

- Location: string
  URL of newly created structure from external system

Body ()
Root Schema : ResponseDtoWrapper
Type: `object`
Show Source

- data(optional): object ResponseResourceSupport
- messages(optional): object ResponseDto

    {
        "type":"object",
        "properties":{
            "messages":{
                "$ref":"#/definitions/ResponseDto"
            },
            "data":{
                "$ref":"#/definitions/ResponseResourceSupport"
            }
        }
    }

Nested Schema : ResponseResourceSupport
Type: `object`
Nested Schema : ResponseDto
Type: `object`
Show Source

- codes(optional): array codes
- id(optional): string
- requestId(optional): string
- status(optional): string

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string"
            },
            "status":{
                "type":"string"
            },
            "codes":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ResponseCode"
                }
            },
            "requestId":{
                "type":"string"
            }
        }
    }

Nested Schema : codes
Type: `array`
Show Source

- Array of: object ResponseCode

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

Nested Schema : ResponseCode
Type: `object`
Show Source

- arg(optional): string
- args(optional): array args
- Code(optional): string
- Desc(optional): string
- Language(optional): string
- Type(optional): string

    {
        "type":"object",
        "properties":{
            "Code":{
                "type":"string"
            },
            "Desc":{
                "type":"string"
            },
            "Type":{
                "type":"string"
            },
            "Language":{
                "type":"string"
            },
            "args":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            },
            "arg":{
                "type":"string"
            }
        }
    }

Nested Schema : args
Type: `array`
Show Source

- Array of: object items

    {
        "type":"array",
        "items":{
            "type":"object"
        }
    }

Nested Schema : items
Type: `object`

#### 400 Response

Malformed syntax.

#### 401 Response

Request does not have sufficient credentials.

#### 403 Response

Request is not authorized.

#### 405 Response

Invalid input

#### 500 Response

Internal error
Back to Top