Jump to

• Request
• Response

Fetches Charge Basis for External Charge Calculation

post

/service/externalChgCalculation

This endpoint is used to fetch charge Basis for Charge Calculation.

Request

Supported Media Types

• application/json

Body ()

Request Body that contains data required for fetching chargeBasis

Root Schema : VlcTmChargeBasisMasterDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object VlcTmChargeBasisMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "applicationCode":{
                    "type":"string",
                    "description":"Appication for which this data is used. Possible values VAMCHG/LMCHG"
                },
                "VlcTmChargeBasisDetailDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/VlcTmChargeBasisDetailDTO"
                    }
                }
            },
            "required":[
                "applicationCode"
            ]
        }
    ]
}

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

Type: object

Show Source

• applicationCode: string
  Appication for which this data is used. Possible values VAMCHG/LMCHG
• VlcTmChargeBasisDetailDTO(optional): array VlcTmChargeBasisDetailDTO

{
    "type":"object",
    "properties":{
        "applicationCode":{
            "type":"string",
            "description":"Appication for which this data is used. Possible values VAMCHG/LMCHG"
        },
        "VlcTmChargeBasisDetailDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VlcTmChargeBasisDetailDTO"
            }
        }
    },
    "required":[
        "applicationCode"
    ]
}

Nested Schema : VlcTmChargeBasisDetailDTO

Type: array

Show Source

• Array of: object VlcTmChargeBasisDetailDTO

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

Nested Schema : VlcTmChargeBasisDetailDTO

Type: object

Show Source

• chargeCode(optional): string
• fromDate: string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• realCustomerNo: string
• toDate: string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

{
    "type":"object",
    "properties":{
        "realCustomerNo":{
            "type":"string",
            "description":""
        },
        "fromDate":{
            "type":"string",
            "description":"",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
        },
        "toDate":{
            "type":"string",
            "description":"",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
        },
        "chargeCode":{
            "type":"string",
            "description":""
        }
    },
    "required":[
        "realCustomerNo",
        "fromDate",
        "toDate"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created chargedecision

Body ()

Root Schema : VlcTmChargeBasisCollection

Type: object

Collection of charge basis.

Show Source

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

{
    "description":"Collection of charge basis.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VlcTmChargeBasisResponseDTO"
            }
        },
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object VlcTmChargeBasisResponseDTO
  Collection of charge basis.

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

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 : VlcTmChargeBasisResponseDTO

Type: object

Collection of charge basis.

Show Source

• data(optional): array data
• realCustomerNo(optional): string

{
    "description":"Collection of charge basis.",
    "type":"object",
    "properties":{
        "realCustomerNo":{
            "type":"string"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VlcTmChargeBasisDTO"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object VlcTmChargeBasisDTO

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

Nested Schema : VlcTmChargeBasisDTO

Type: object

Show Source

• calcFreq(optional): string
• chargeCategory(optional): string
• chargeDescription(optional): string
  charge Description
• chgCalcEndDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• chgCalcStartDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• chgCode(optional): string
  Minimum Length: 3

  Maximum Length: 20
• chgCriteria(optional): string
• chgCriteriaValue(optional): number
• chgTypeId(optional): string

{
    "type":"object",
    "properties":{
        "chgTypeId":{
            "type":"string",
            "description":""
        },
        "calcFreq":{
            "type":"string",
            "description":""
        },
        "chgCode":{
            "type":"string",
            "description":"",
            "minLength":3,
            "maxLength":20
        },
        "chargeDescription":{
            "type":"string",
            "description":"charge Description"
        },
        "chgCriteria":{
            "type":"string",
            "description":""
        },
        "chgCriteriaValue":{
            "type":"number",
            "description":""
        },
        "chargeCategory":{
            "type":"string",
            "description":""
        },
        "chgCalcStartDate":{
            "type":"string",
            "description":"",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
        },
        "chgCalcEndDate":{
            "type":"string",
            "description":"",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
        }
    }
}

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