Jump to

• Request
• Response

Get all valid system accounts

get

/service/lms/systemAccount

This endpoint is used to get all system account records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• accountNumber(optional): string
  account number
• branchCode(optional): string
  Branch code
• creditDisbursementAccount(optional): string
  borrowing account
• customerId(optional): string
  Pattern: [a-zA-Z0-9]{1,20}

  customer ID (child)
• debitDisbursementAccount(optional): string
  lending account
• fromDate(optional): string
  from account creation date
• id(optional): string
  Record id
• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched
• status(optional): string
  account status
• sweepId(optional): string
  sweep ID
• sweepLogId(optional): string
  sweep log ID
• toDate(optional): string
  to account creation date

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string

Body ()

Root Schema : LmsTbSystemAccountServiceCollection

Type: object

Collection of system accounts.

Show Source

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object LmsTbSystemAccountDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : LmsTbSystemAccountDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmsTbSystemAccountDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "accountGroupCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":5
                },
                "accountNumber":{
                    "type":"string",
                    "description":"",
                    "maxLength":30
                },
                "accountDescription":{
                    "type":"string",
                    "description":"",
                    "maxLength":105
                },
                "branchCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":4
                },
                "creationDate":{
                    "type":"string",
                    "description":"",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
                },
                "creditDisbursementAccount":{
                    "type":"string",
                    "description":"",
                    "maxLength":30
                },
                "currency":{
                    "type":"string",
                    "description":"",
                    "maxLength":3
                },
                "customerId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "debitDisbursementAccount":{
                    "type":"string",
                    "description":"",
                    "maxLength":30
                },
                "id":{
                    "type":"string",
                    "description":"",
                    "maxLength":36
                },
                "interestOs":{
                    "type":"number",
                    "description":""
                },
                "interestPaid":{
                    "type":"number",
                    "description":""
                },
                "isTwoWay":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                },
                "principalOs":{
                    "type":"number",
                    "description":""
                },
                "principalPaid":{
                    "type":"number",
                    "description":""
                },
                "lastReallocationDate":{
                    "type":"string",
                    "description":"",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
                },
                "lastReverseSweepDate":{
                    "type":"string",
                    "description":"",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
                },
                "noOfDaysAccrued":{
                    "type":"number",
                    "description":""
                },
                "status":{
                    "type":"string",
                    "description":""
                },
                "sweepId":{
                    "type":"string",
                    "description":"",
                    "maxLength":36
                },
                "sweepLogId":{
                    "type":"string",
                    "description":"",
                    "maxLength":36
                },
                "trackAsIcl":{
                    "type":"string",
                    "description":"",
                    "maxLength":1
                }
            }
        }
    ]
}

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

Type: object

Show Source

• accountDescription(optional): string
  Maximum Length: 105
• accountGroupCode(optional): string
  Maximum Length: 5
• accountNumber(optional): string
  Maximum Length: 30
• branchCode(optional): string
  Maximum Length: 4
• creationDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• creditDisbursementAccount(optional): string
  Maximum Length: 30
• currency(optional): string
  Maximum Length: 3
• customerId(optional): string
  Pattern: [a-zA-Z0-9]{1,20}
• debitDisbursementAccount(optional): string
  Maximum Length: 30
• id(optional): string
  Maximum Length: 36
• interestOs(optional): number
• interestPaid(optional): number
• isTwoWay(optional): string
  Maximum Length: 1
• lastReallocationDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• lastReverseSweepDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• noOfDaysAccrued(optional): number
• principalOs(optional): number
• principalPaid(optional): number
• status(optional): string
• sweepId(optional): string
  Maximum Length: 36
• sweepLogId(optional): string
  Maximum Length: 36
• trackAsIcl(optional): string
  Maximum Length: 1

{
    "type":"object",
    "properties":{
        "accountGroupCode":{
            "type":"string",
            "description":"",
            "maxLength":5
        },
        "accountNumber":{
            "type":"string",
            "description":"",
            "maxLength":30
        },
        "accountDescription":{
            "type":"string",
            "description":"",
            "maxLength":105
        },
        "branchCode":{
            "type":"string",
            "description":"",
            "maxLength":4
        },
        "creationDate":{
            "type":"string",
            "description":"",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
        },
        "creditDisbursementAccount":{
            "type":"string",
            "description":"",
            "maxLength":30
        },
        "currency":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "debitDisbursementAccount":{
            "type":"string",
            "description":"",
            "maxLength":30
        },
        "id":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "interestOs":{
            "type":"number",
            "description":""
        },
        "interestPaid":{
            "type":"number",
            "description":""
        },
        "isTwoWay":{
            "type":"string",
            "description":"",
            "maxLength":1
        },
        "principalOs":{
            "type":"number",
            "description":""
        },
        "principalPaid":{
            "type":"number",
            "description":""
        },
        "lastReallocationDate":{
            "type":"string",
            "description":"",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
        },
        "lastReverseSweepDate":{
            "type":"string",
            "description":"",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
        },
        "noOfDaysAccrued":{
            "type":"number",
            "description":""
        },
        "status":{
            "type":"string",
            "description":""
        },
        "sweepId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "sweepLogId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "trackAsIcl":{
            "type":"string",
            "description":"",
            "maxLength":1
        }
    }
}

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