Previous Next JavaScript must be enabled to correctly display this content

## Get all Valid Customer

get

/service/icl/customer

This endpoint is used to get all valid customer maintenance records.

### Request

Supported Media Types

- application/json
- application/xml

Query Parameters

- authStat(optional): string
  Maximum Length: `1`
- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
- customerName(optional): string
  Maximum Length: `100`
- includecloseandunauth(optional): boolean
  includecloseandunauth need to be set to fetch summary record, defult value is false
- limit(optional): integer
  limit is maximum no of records to be fetched
- offset(optional): integer
  offset is starting no of records to be fetched
- onlyLinkedCustomers(optional): string
- recordStat(optional): string
  Maximum Length: `1`

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 : IclTmCustomerCollection
Type: `object`
Collection of customer.
Show Source

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

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

Nested Schema : data
Type: `array`
Show Source

- Array of: object IclTmCustomerDTO

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

Nested Schema : PagingDto
Type: `object`
Show Source

- totalResults(optional): integer

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

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

- allOf GenericDto
- object IclTmCustomerDTO-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "borrowCurrency":{
                        "type":"string",
                        "description":"",
                        "maxLength":3
                    },
                    "borrowLimit":{
                        "type":"number",
                        "description":"",
                        "maxLength":23
                    },
                    "borrowLimitUtilized":{
                        "type":"number",
                        "description":"",
                        "maxLength":23
                    },
                    "customerId":{
                        "type":"string",
                        "description":"",
                        "pattern":"[a-zA-Z0-9]{1,20}"
                    },
                    "customerName":{
                        "type":"string",
                        "description":"",
                        "maxLength":100
                    },
                    "lendCurrency":{
                        "type":"string",
                        "description":"",
                        "maxLength":3
                    },
                    "lendLimit":{
                        "type":"number",
                        "description":"",
                        "minimum":0,
                        "maxLength":23
                    },
                    "lendLimitUtilized":{
                        "type":"number",
                        "description":"",
                        "maxLength":23
                    },
                    "parentCustomerId":{
                        "type":"string",
                        "description":"",
                        "maxLength":20
                    },
                    "parentCustomerName":{
                        "type":"string",
                        "description":"",
                        "maxLength":100
                    },
                    "sourceSystem":{
                        "type":"string",
                        "description":"",
                        "maxLength":35
                    },
                    "IclTmLendCustomerDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/IclTmLendCustomerDTO"
                        }
                    },
                    "IclTmBorrowCustomerDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/IclTmBorrowCustomerDTO"
                        }
                    }
                }
            }
        ]
    }

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 : IclTmCustomerDTO-allOf[1]
Type: `object`
Show Source

- borrowCurrency(optional): string
  Maximum Length: `3`
- borrowLimit(optional): number
  Maximum Length: `23`
- borrowLimitUtilized(optional): number
  Maximum Length: `23`
- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
- customerName(optional): string
  Maximum Length: `100`
- IclTmBorrowCustomerDTO(optional): array IclTmBorrowCustomerDTO
- IclTmLendCustomerDTO(optional): array IclTmLendCustomerDTO
- lendCurrency(optional): string
  Maximum Length: `3`
- lendLimit(optional): number
  Minimum Value: `0`
  Maximum Length: `23`
- lendLimitUtilized(optional): number
  Maximum Length: `23`
- parentCustomerId(optional): string
  Maximum Length: `20`
- parentCustomerName(optional): string
  Maximum Length: `100`
- sourceSystem(optional): string
  Maximum Length: `35`

    {
        "type":"object",
        "properties":{
            "borrowCurrency":{
                "type":"string",
                "description":"",
                "maxLength":3
            },
            "borrowLimit":{
                "type":"number",
                "description":"",
                "maxLength":23
            },
            "borrowLimitUtilized":{
                "type":"number",
                "description":"",
                "maxLength":23
            },
            "customerId":{
                "type":"string",
                "description":"",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "customerName":{
                "type":"string",
                "description":"",
                "maxLength":100
            },
            "lendCurrency":{
                "type":"string",
                "description":"",
                "maxLength":3
            },
            "lendLimit":{
                "type":"number",
                "description":"",
                "minimum":0,
                "maxLength":23
            },
            "lendLimitUtilized":{
                "type":"number",
                "description":"",
                "maxLength":23
            },
            "parentCustomerId":{
                "type":"string",
                "description":"",
                "maxLength":20
            },
            "parentCustomerName":{
                "type":"string",
                "description":"",
                "maxLength":100
            },
            "sourceSystem":{
                "type":"string",
                "description":"",
                "maxLength":35
            },
            "IclTmLendCustomerDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/IclTmLendCustomerDTO"
                }
            },
            "IclTmBorrowCustomerDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/IclTmBorrowCustomerDTO"
                }
            }
        }
    }

Nested Schema : IclTmBorrowCustomerDTO
Type: `array`
Show Source

- Array of: object IclTmBorrowCustomerDTO

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

Nested Schema : IclTmLendCustomerDTO
Type: `array`
Show Source

- Array of: object IclTmLendCustomerDTO

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

Nested Schema : IclTmBorrowCustomerDTO
Type: `object`
Show Source

- borrowerId(optional): string
  Maximum Length: `20`
- borrowerName(optional): string
  Maximum Length: `100`
- borrowLimit(optional): number
  Maximum Length: `23`
- borrowLimitUtilized(optional): number
  Maximum Length: `23`
- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
- id(optional): string
  Maximum Length: `36`

    {
        "type":"object",
        "properties":{
            "borrowerId":{
                "type":"string",
                "description":"",
                "maxLength":20
            },
            "borrowerName":{
                "type":"string",
                "description":"",
                "maxLength":100
            },
            "borrowLimit":{
                "type":"number",
                "description":"",
                "maxLength":23
            },
            "borrowLimitUtilized":{
                "type":"number",
                "description":"",
                "maxLength":23
            },
            "customerId":{
                "type":"string",
                "description":"",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "id":{
                "type":"string",
                "description":"",
                "maxLength":36
            }
        }
    }

Nested Schema : IclTmLendCustomerDTO
Type: `object`
Show Source

- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
- id(optional): string
  Maximum Length: `36`
- lenderId(optional): string
  Maximum Length: `20`
- lenderName(optional): string
  Maximum Length: `100`
- lendLimit(optional): number
  Minimum Value: `0`
  Maximum Length: `23`
- lendLimitUtilized(optional): number
  Maximum Length: `23`

    {
        "type":"object",
        "properties":{
            "customerId":{
                "type":"string",
                "description":"",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "id":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "lenderId":{
                "type":"string",
                "description":"",
                "maxLength":20
            },
            "lenderName":{
                "type":"string",
                "description":"",
                "maxLength":100
            },
            "lendLimit":{
                "type":"number",
                "description":"",
                "minimum":0,
                "maxLength":23
            },
            "lendLimitUtilized":{
                "type":"number",
                "description":"",
                "maxLength":23
            }
        }
    }

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