Jump to

• Request
• Response

Get Credit Limit utilization details for the given Real Customer Number and Line ID

get

/service/lineUtilizationDetails

This endpoint is used to get Credit Limit utilization details for the given Real Customer Number and Line ID.

Request

Supported Media Types

• application/json

Query Parameters

• lineId: string
• realCustomerNo: string

Header Parameters

• sourceCode: string
  Source from which request is initiated

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns message of success or failure

Headers

• Location: string

Body ()

Root Schema : LineUtilizationWrapperDTO

Type: object

Show Source

• data(optional): object LineUtilDetailsDto
• messages(optional): object ResponseDto

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

Nested Schema : LineUtilDetailsDto

Type: object

Show Source

• amtUtilizedToday(optional): number
  Credit limit amount utilized today
• availableAmount(optional): number
  Available credit limit amount
• firstUtilDate(optional): string
  Date of first credit limit utilization
• lastUtilDate(optional): string
  Date of last credit limit utilization
• maxAvailableAmount(optional): number
  Maximum available credit limit amount
• utilizedAmount(optional): number
  Utilized credit limit amount

{
    "type":"object",
    "properties":{
        "utilizedAmount":{
            "type":"number",
            "description":"Utilized credit limit amount"
        },
        "availableAmount":{
            "type":"number",
            "description":"Available credit limit amount"
        },
        "maxAvailableAmount":{
            "type":"number",
            "description":"Maximum available credit limit amount"
        },
        "amtUtilizedToday":{
            "type":"number",
            "description":"Credit limit amount utilized today"
        },
        "firstUtilDate":{
            "type":"string",
            "description":"Date of first credit limit utilization"
        },
        "lastUtilDate":{
            "type":"string",
            "description":"Date of last credit limit utilization"
        }
    }
}

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