Charges Enquiry
get
/web/v1/chargeEnquiry
This endpoint is used to get the charges enquiry
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
applicationCode: string
-
branchCode(optional): string
-
chargeAccount(optional): string
-
chargeCode(optional): string
-
chargeGroup(optional): string
-
chargeType(optional): string
-
collectionType(optional): string
-
corporate(optional): string
-
creditDebitStatus(optional): string
-
currency(optional): string
-
dateRefBasis(optional): string
-
depositSlipNumber(optional): string
-
event(optional): string
-
fromAmt(optional): number
-
fromDate(optional): string
-
instrumentNumber(optional): string
-
instrumentStatus(optional): string
-
instrumentType(optional): string
-
limit(optional): integer
limit is maximum no of records to be fetched
-
offset(optional): integer
offset is starting no of records to be fetched
-
party(optional): string
-
partyRole(optional): string
-
product(optional): string
-
referenceNumber(optional): string
-
status(optional): string
-
toAmt(optional): number
-
toDate(optional): string
-
txnRefNo(optional): string
Header Parameters
-
appId: string
-
authToken(optional): string
branch code for SMS
-
branchCode: string
-
branchDate(optional): string(date-time)
-
contentType(optional): string
-
tenantId(optional): string
-
userId: string
user id for SMS
Response
Supported Media Types
- application/json
- application/xml
200 Response
Returns the charge maintenance actions based on given id.
Nested Schema : paging
Type:
object
Nested Schema : ChargeEnquiryDetailsModel
Type:
Show Source
object
-
allowOverride(optional):
string
Allow Override
-
allowPrcModify(optional):
string
Allow Prc Modify
-
allowWaive(optional):
string
Allow Waive
-
applicationCode(optional):
string
Application Code
-
autoWaive(optional):
string
Auto Waive
-
baseAmount(optional):
number
Base Amount
-
baseAmountCcy(optional):
string
Base Amount Currency
-
baseCount(optional):
number
Base Count
-
branchCode(optional):
string
Branch Code
-
calcEndDate(optional):
string
Calculate End Date
-
calcFreq(optional):
string
Calculate Frequency
-
calcRefPeriod(optional):
string
Calculate Reference Period
-
calcStartDate(optional):
string
Calculate Start Date
-
calcType(optional):
string
Calculate Type
-
calcUnits(optional):
number
Calculate Units
-
chargeAccount(optional):
string
Charge Account
-
chargeAmt(optional):
number
Charge Amount
-
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
-
chargeType(optional):
string
Charge Type
-
chgCalcDate(optional):
string
Charge Calculate Date
-
chgInTxnCcy(optional):
string
Charge In Transaction Currency
-
chgSharing(optional):
string
Charge Sharing
-
chgSharingPct(optional):
number
Charge Sharing Pct
-
collectionFreq(optional):
string
Collection Frequency
-
collectionRefPeriod(optional):
string
Collection Reference Period
-
collectionType(optional):
string
Collection Type
-
collectionUnits(optional):
number
Collection Units
-
creditDebitStatus(optional):
string
Credit/Debit Status
-
currency(optional):
string
Currency
-
event(optional):
string
Event
-
exchangeRate(optional):
number
Exchange Rate
-
fixedAmt(optional):
number
Fixed Amount
-
fixedPct(optional):
number
Fixed Pct
-
flatCharge(optional):
string
Flat Charge
-
instrumentStatus(optional):
string
Instrument Status
-
instrumentType(optional):
string
Instrument Type
-
maxAmt(optional):
number
Maximum Amount
-
maxPct(optional):
number
Maximum Pct
-
minAmt(optional):
number
Minimum Amount
-
minmaxCriteria(optional):
string
Minimum Maximum Criteria
-
minPct(optional):
number
Minimum Pct
-
modNo(optional):
number
Mod Number
-
parentChgCode(optional):
string
Parent Charge Code
-
parentChgCodeDesc(optional):
string
Parent Charge Code Description
-
party(optional):
string
Party
-
partyId(optional):
string
Party Id
-
partyRole(optional):
string
Party Role
-
postingDate(optional):
string
Posting Date
-
prcCategory(optional):
string
Prc Category
-
prcCcy(optional):
string
Prc Currency
-
priceMethodDesc(optional):
string
Price Method Description
-
priceTemplateId(optional):
string
Price Template Id
-
product(optional):
string
Product
-
referenceEndDate(optional):
string
Reference End Date
-
referenceStartDate(optional):
string
Reference Start Date
-
slabDetails(optional):
array slabDetails
Slab Details
-
txnCcy(optional):
string
Transaction Currency
-
txnRefNo(optional):
string
Transaction Reference Number
Nested Schema : SlabDetails
Type:
Show Source
object
-
amount(optional):
number
Amount needs to be provided when price category is Tier Based Amount or Tier Based Mixed
-
fromSlab(optional):
number
From Slab
-
percentage(optional):
number
Amount needs to be provided when price category is Tier Based Percent or Tier Based Mixed
-
toSlab(optional):
number
To Slab
-
unit(optional):
number
unit specifies the charge amount to be levied per unit
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error