Jump to

• Request
• Response

Update an existing internal credit limits

put

/service/internalcreditlimits/{lineId}

This endpoint is used to update an existing internal credit limits.

Request

Supported Media Types

• application/json

Path Parameters

• lineId: string
  virtualAccountNo of the accounts Maintenance

Header Parameters

• sourceCode: string
  Source from which request is initiated

Body ()

Request body contains data required to update an existing account

Root Schema : VamTmInternalCreditLimitServiceDTO

Type: object

Match All

Show Source

• object VamTmInternalCreditLimitServiceDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "resourceId":{
                    "description":"resource id",
                    "type":"string"
                },
                "resourceName":{
                    "description":"resource name",
                    "type":"string"
                },
                "operationType":{
                    "description":"operation type",
                    "type":"string"
                },
                "availStatus":{
                    "type":"string",
                    "description":"Availability Status of the Line"
                },
                "limitAmount":{
                    "type":"number",
                    "description":"Limit Amount"
                },
                "limitExpiryDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":"Date after which Line is inactive"
                },
                "limitStartDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":"Date from which Line is considered"
                },
                "lineCcy":{
                    "type":"string",
                    "description":"Line currency"
                },
                "lineDescription":{
                    "type":"string",
                    "description":"Description for the Line"
                },
                "lineId":{
                    "type":"string",
                    "description":"Line Id",
                    "minLength":3,
                    "maxLength":20,
                    "pattern":"([A-Z0-9\\s]+)?"
                },
                "lineBranch":{
                    "type":"string",
                    "description":"Line Branch"
                },
                "realCustomerName":{
                    "type":"string",
                    "description":""
                },
                "realCustomerNo":{
                    "type":"string",
                    "description":"Real Customer No for which the line is created"
                }
            },
            "required":[
                "limitStartDate",
                "limitExpiryDate",
                "lineCcy",
                "lineId",
                "lineBranch",
                "realCustomerNo",
                "limitAmount"
            ]
        }
    ]
}

Nested Schema : VamTmInternalCreditLimitServiceDTO-allOf[0]

Type: object

Show Source

• availStatus(optional): string
  Availability Status of the Line
• limitAmount: number
  Limit Amount
• limitExpiryDate: string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

  Date after which Line is inactive
• limitStartDate: string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

  Date from which Line is considered
• lineBranch: string
  Line Branch
• lineCcy: string
  Line currency
• lineDescription(optional): string
  Description for the Line
• lineId: string
  Minimum Length: 3

  Maximum Length: 20

  Pattern: ([A-Z0-9\s]+)?

  Line Id
• operationType(optional): string
  operation type
• realCustomerName(optional): string
• realCustomerNo: string
  Real Customer No for which the line is created
• resourceId(optional): string
  resource id
• resourceName(optional): string
  resource name

{
    "type":"object",
    "properties":{
        "resourceId":{
            "description":"resource id",
            "type":"string"
        },
        "resourceName":{
            "description":"resource name",
            "type":"string"
        },
        "operationType":{
            "description":"operation type",
            "type":"string"
        },
        "availStatus":{
            "type":"string",
            "description":"Availability Status of the Line"
        },
        "limitAmount":{
            "type":"number",
            "description":"Limit Amount"
        },
        "limitExpiryDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Date after which Line is inactive"
        },
        "limitStartDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Date from which Line is considered"
        },
        "lineCcy":{
            "type":"string",
            "description":"Line currency"
        },
        "lineDescription":{
            "type":"string",
            "description":"Description for the Line"
        },
        "lineId":{
            "type":"string",
            "description":"Line Id",
            "minLength":3,
            "maxLength":20,
            "pattern":"([A-Z0-9\\s]+)?"
        },
        "lineBranch":{
            "type":"string",
            "description":"Line Branch"
        },
        "realCustomerName":{
            "type":"string",
            "description":""
        },
        "realCustomerNo":{
            "type":"string",
            "description":"Real Customer No for which the line is created"
        }
    },
    "required":[
        "limitStartDate",
        "limitExpiryDate",
        "lineCcy",
        "lineId",
        "lineBranch",
        "realCustomerNo",
        "limitAmount"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns updated accounts

Body ()

Root Schema : VamTmInternalCreditLimitServiceWrapperDTO

Type: object

Show Source

• data(optional): object VamTmInternalCreditLimitServiceDTO
• messages(optional): object VamTmInternalCreditLimitServiceResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/VamTmInternalCreditLimitServiceResponseDto"
        },
        "data":{
            "$ref":"#/definitions/VamTmInternalCreditLimitServiceDTO"
        }
    }
}

Nested Schema : VamTmInternalCreditLimitServiceDTO

Type: object

Match All

Show Source

• object VamTmInternalCreditLimitServiceDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "resourceId":{
                    "description":"resource id",
                    "type":"string"
                },
                "resourceName":{
                    "description":"resource name",
                    "type":"string"
                },
                "operationType":{
                    "description":"operation type",
                    "type":"string"
                },
                "availStatus":{
                    "type":"string",
                    "description":"Availability Status of the Line"
                },
                "limitAmount":{
                    "type":"number",
                    "description":"Limit Amount"
                },
                "limitExpiryDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":"Date after which Line is inactive"
                },
                "limitStartDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":"Date from which Line is considered"
                },
                "lineCcy":{
                    "type":"string",
                    "description":"Line currency"
                },
                "lineDescription":{
                    "type":"string",
                    "description":"Description for the Line"
                },
                "lineId":{
                    "type":"string",
                    "description":"Line Id",
                    "minLength":3,
                    "maxLength":20,
                    "pattern":"([A-Z0-9\\s]+)?"
                },
                "lineBranch":{
                    "type":"string",
                    "description":"Line Branch"
                },
                "realCustomerName":{
                    "type":"string",
                    "description":""
                },
                "realCustomerNo":{
                    "type":"string",
                    "description":"Real Customer No for which the line is created"
                }
            },
            "required":[
                "limitStartDate",
                "limitExpiryDate",
                "lineCcy",
                "lineId",
                "lineBranch",
                "realCustomerNo",
                "limitAmount"
            ]
        }
    ]
}

Nested Schema : VamTmInternalCreditLimitServiceResponseDto

Type: object

Show Source

• codes(optional): array codes
• status(optional): string

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

Nested Schema : VamTmInternalCreditLimitServiceDTO-allOf[0]

Type: object

Show Source

• availStatus(optional): string
  Availability Status of the Line
• limitAmount: number
  Limit Amount
• limitExpiryDate: string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

  Date after which Line is inactive
• limitStartDate: string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

  Date from which Line is considered
• lineBranch: string
  Line Branch
• lineCcy: string
  Line currency
• lineDescription(optional): string
  Description for the Line
• lineId: string
  Minimum Length: 3

  Maximum Length: 20

  Pattern: ([A-Z0-9\s]+)?

  Line Id
• operationType(optional): string
  operation type
• realCustomerName(optional): string
• realCustomerNo: string
  Real Customer No for which the line is created
• resourceId(optional): string
  resource id
• resourceName(optional): string
  resource name

{
    "type":"object",
    "properties":{
        "resourceId":{
            "description":"resource id",
            "type":"string"
        },
        "resourceName":{
            "description":"resource name",
            "type":"string"
        },
        "operationType":{
            "description":"operation type",
            "type":"string"
        },
        "availStatus":{
            "type":"string",
            "description":"Availability Status of the Line"
        },
        "limitAmount":{
            "type":"number",
            "description":"Limit Amount"
        },
        "limitExpiryDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Date after which Line is inactive"
        },
        "limitStartDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Date from which Line is considered"
        },
        "lineCcy":{
            "type":"string",
            "description":"Line currency"
        },
        "lineDescription":{
            "type":"string",
            "description":"Description for the Line"
        },
        "lineId":{
            "type":"string",
            "description":"Line Id",
            "minLength":3,
            "maxLength":20,
            "pattern":"([A-Z0-9\\s]+)?"
        },
        "lineBranch":{
            "type":"string",
            "description":"Line Branch"
        },
        "realCustomerName":{
            "type":"string",
            "description":""
        },
        "realCustomerNo":{
            "type":"string",
            "description":"Real Customer No for which the line is created"
        }
    },
    "required":[
        "limitStartDate",
        "limitExpiryDate",
        "lineCcy",
        "lineId",
        "lineBranch",
        "realCustomerNo",
        "limitAmount"
    ]
}

Nested Schema : codes

Type: array

Show Source

• Array of: object VamTmInternalCreditLimitServiceResponseCode

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

Nested Schema : VamTmInternalCreditLimitServiceResponseCode

Type: object

Show Source

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

400 Response

Bad request error, the server is unable to process the request

401 Response

Unauthorized request error, invalid credentials

403 Response

Request denied, no permission to access the request.

405 Response

Request denied, invalid input.

500 Response

Internal server error.

Back to Top