Fetch the pricing templates
post
/service/v1/getChargeDetails
This endpoint is used to fetch the pricing templates based on given filter parameters.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId: string
App Id
-
branchCode: string
Branch code
-
userId: string
User Id
Charge filter parameters
Root Schema : ChargesRequestDto
Type:
Show Source
object
-
applicationCode(optional):
string
Application Code
-
category(optional):
string
Category
-
chargeCodes(optional):
array chargeCodes
Charge Codes
-
txnMap(optional):
object StringStringMap
Additional Properties Allowed: additionalProperties
Response
Supported Media Types
- application/json
- application/xml
200 Response
Best possible record from the pricing methods
Root Schema : ChargeCodeDetailsCollection
Type:
Show Source
object
-
priceMethods(optional):
array priceMethods
Price Methods
Nested Schema : ChargeCodeDetails
Type:
Show Source
object
-
allowOverride(optional):
string
Allow Override
-
allowPrcModify(optional):
string
Allow Price Modify
-
allowWaive(optional):
string
Allow Waive
-
annumBasis(optional):
number
Annum Basis
-
autoWaive(optional):
string
Auto Waive
-
calcFreq(optional):
string
Calculate Frequency
-
calcRefPeriod(optional):
string
Calculate Reference Period
-
calcType(optional):
string
Calculate Type
-
calcUnits(optional):
number
Calculate Units
-
chargeCategory(optional):
string
Charge Category
-
chargeCode(optional):
string
Charge Code
-
chargeCodeDesc(optional):
string
Charge Code Description
-
chargeCriteria(optional):
string
Charge Criteria
-
chargeCriteriaValue(optional):
number
Charge Criteria Value
-
chargeGroup(optional):
string
Charge Group
-
chargeInTxnCcy(optional):
string
Charge In Transaction Currency
-
chargeSharing(optional):
string
Charge Sharing
-
chargeSharingPct(optional):
number
Charge Sharing Pct
-
chargeType(optional):
string
Charge Type
-
collectionFreq(optional):
string
Collection Frequency
-
collectionRefPeriod(optional):
string
Collection Reference Period
-
collectionType(optional):
string
Collection Type
-
collectionUnits(optional):
number
Collection Units
-
exchangeRate(optional):
number
Exchange Rate
-
fixedAmt(optional):
number
Fixed Amount
-
fixedPct(optional):
number
Fixed Pct
-
flatCharge(optional):
string
Flat Charge
-
parentChargeCode(optional):
string
Parent Charge Code
-
partyId(optional):
string
Party Id
-
partyToCharge(optional):
string
Party To Charge
-
priceCcy(optional):
string
Price Currency
-
priceMethod(optional):
string
Price Method
-
priceMethodDesc(optional):
string
Price Method Description
-
priceTemplateId(optional):
string
Price Template Id
-
referenceEndDate(optional):
string
Reference End Date
-
referenceEndDateValue(optional):
string
Reference End Date Value
-
referenceStartDate(optional):
string
Reference Start Date
-
referenceStartDateValue(optional):
string
Reference Start Date Value
-
slabDetails(optional):
array slabDetails
Slab Details
-
tenor(optional):
number
Tenor
-
txnCcy(optional):
string
Transaction Currency
-
txnRefNo(optional):
string
Transaction Reference Number
Nested Schema : SlabDetails
Type:
Show Source
object
-
amount(optional):
number
Amount
-
fromSlab(optional):
number
From Slab
-
percentage(optional):
number
Percentage
-
toSlab(optional):
number
To Slab
-
unit(optional):
number
Unit
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error