Calculate the online charges for purchase orders
get
/service/v1/poCharges
This endpoint is used to calculate the online charges for purchase orders.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId: string
Application Id
-
applicationCode: string
Application Code
-
branchCode: string
Branch Code
-
event: string
Event
-
tenantId(optional): string
Tenant Id
-
userId: string
User Id
Response
Supported Media Types
- application/json
- application/xml
200 Response
Successful performs the operation
Nested Schema : FinanceTxnDTO
Type:
Show Source
object
-
buyerId(optional):
string
Buyer Id
-
buyerName(optional):
string
Buyer Name
-
eventCode(optional):
string
Event Code
-
financeAmt(optional):
number
Finance Amount
-
financeCcy(optional):
string
Finance Currency
-
financeDueDate(optional):
string
Finance Due Date
-
financeStartDate(optional):
string
Finance Start Date
-
outdtandingAmt(optional):
number
Outstanding Amount
-
processingDate(optional):
string
Processing Date
-
productCode(optional):
string
Product Code
-
productCodeDesc(optional):
string
Product Code Description
-
programCode(optional):
string
Program Code
-
repaymentAmt(optional):
number
Repayment Amount
-
supplierId(optional):
string
Supplier Id
-
supplierName(optional):
string
Supplier Name
-
txnRefNo(optional):
string
Transaction Reference Number
Nested Schema : ObChargesTxnDTO
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
-
branchCode(optional):
string
Branch code
-
calcEndDate(optional):
string(date)
Calculate End Date
-
calcErrorCode(optional):
string
Calculate Error Code
-
calcFreq(optional):
string
Calculate Frequency
-
calcRefPeriod(optional):
string
Calculate Reference Period
-
calcStartDate(optional):
string(date)
Calculate Start Date
-
calcType(optional):
string
Calculate Type
-
calcUnits(optional):
number
Calculate Units
-
chargeAmount(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(date)
Charge Calculate Date
-
chgCollDate(optional):
string(date)
Charge Collection Date
-
chgCriteriaCcy(optional):
string
Charge Criteria Currency
-
chgCriteriaCount(optional):
string
Charge Criteria Count
-
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
-
creditAccNumber(optional):
string
Credit Account Number
-
debitAccNumber(optional):
string
Debit Account Number
-
eventCode(optional):
string
Event Code
-
exchangeRate(optional):
number
Exchange Rate
-
firstChgCalcDate(optional):
string(date)
First Charge Calculation Date
-
firstChgCollDate(optional):
string(date)
First Charge Collection Date
-
instrumentType(optional):
string
Instrument Type
-
nextChgCalcDate(optional):
string(date)
Next Charge Calculation Date
-
nextChgCollDate(optional):
string(date)
Next Charge Collection Date
-
parentChargeCode(optional):
string
Parent Charge Code
-
partyId(optional):
string
Party Id
-
partyName(optional):
string
Party name
-
partyToCharge(optional):
string
Party To Charge
-
postingDate(optional):
string(date)
Posting Date
-
postingErrorCode(optional):
string
Posting Error Code
-
priceMethodDesc(optional):
string
Price Method Description
-
priceTemplateId(optional):
string
Price Template Id
-
referenceEndDate(optional):
string
Reference End Date
-
referenceEndDateValue(optional):
string(date)
Reference End Date Value
-
referenceStartDate(optional):
string
Reference Start Date
-
referenceStartDateValue(optional):
string(date)
Reference Start Date Value
-
txnCcy(optional):
string
Transaction Currency
-
txnRefNo(optional):
string
Transaction Reference Number
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not auhorized.
500 Response
Internal error