Jump to

• Request
• Response

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(required): string
  Application Id
• applicationCode(required): string
  Application Code
• branchCode(required): string
  Branch Code
• event(required): string
  Event
• tenantId: string
  Tenant Id
• userId(required): string
  User Id

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : ObChargesTxnDTOCollection

Type: object

Collection of ObChargesTxnDTO.

Show Source

• finTxnDetails: object FinanceTxnDTO
• obChargesTxnDTOList: array obChargesTxnDTOList
• oldObChargesTxnDTOList: array oldObChargesTxnDTOList

{
    "description":"Collection of ObChargesTxnDTO.",
    "type":"object",
    "properties":{
        "obChargesTxnDTOList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObChargesTxnDTO"
            }
        },
        "oldObChargesTxnDTOList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObChargesTxnDTO"
            }
        },
        "finTxnDetails":{
            "type":"object",
            "$ref":"#/definitions/FinanceTxnDTO"
        }
    }
}

Nested Schema : FinanceTxnDTO

Type: object

Show Source

• buyerId: string
  Buyer Id
• buyerName: string
  Buyer Name
• eventCode: string
  Event Code
• financeAmt: number
  Finance Amount
• financeCcy: string
  Finance Currency
• financeDueDate: string
  Finance Due Date
• financeStartDate: string
  Finance Start Date
• outdtandingAmt: number
  Outstanding Amount
• processingDate: string
  Processing Date
• productCode: string
  Product Code
• productCodeDesc: string
  Product Code Description
• programCode: string
  Program Code
• repaymentAmt: number
  Repayment Amount
• seqNo: integer(int64)
  Sequence Number
• supplierId: string
  Supplier Id
• supplierName: string
  Supplier Name
• txnRefNo: string
  Transaction Reference Number

{
    "type":"object",
    "properties":{
        "txnRefNo":{
            "type":"string",
            "description":"Transaction Reference Number"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64",
            "description":"Sequence Number"
        },
        "buyerId":{
            "type":"string",
            "description":"Buyer Id"
        },
        "buyerName":{
            "type":"string",
            "description":"Buyer Name"
        },
        "supplierId":{
            "type":"string",
            "description":"Supplier Id"
        },
        "supplierName":{
            "type":"string",
            "description":"Supplier Name"
        },
        "financeCcy":{
            "type":"string",
            "description":"Finance Currency"
        },
        "financeAmt":{
            "type":"number",
            "description":"Finance Amount"
        },
        "productCode":{
            "type":"string",
            "description":"Product Code"
        },
        "productCodeDesc":{
            "type":"string",
            "description":"Product Code Description"
        },
        "financeStartDate":{
            "type":"string",
            "description":"Finance Start Date"
        },
        "financeDueDate":{
            "type":"string",
            "description":"Finance Due Date"
        },
        "outdtandingAmt":{
            "type":"number",
            "description":"Outstanding Amount"
        },
        "repaymentAmt":{
            "type":"number",
            "description":"Repayment Amount"
        },
        "programCode":{
            "type":"string",
            "description":"Program Code"
        },
        "eventCode":{
            "type":"string",
            "description":"Event Code"
        },
        "processingDate":{
            "type":"string",
            "description":"Processing Date"
        }
    }
}

Nested Schema : obChargesTxnDTOList

Type: array

Show Source

• Array of: object ObChargesTxnDTO

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

Nested Schema : oldObChargesTxnDTOList

Type: array

Show Source

• Array of: object ObChargesTxnDTO

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

Nested Schema : ObChargesTxnDTO

Type: object

Show Source

• allowOverride: string
  Allow Override
• allowPrcModify: string
  Allow Prc Modify
• allowWaive: string
  Allow Waive
• applicationCode: string
  Application Code
• autoWaive: string
  Auto Waive
• branchCode: string
  Branch code
• calcEndDate: string(date)
  Calculate End Date
• calcErrorCode: string
  Calculate Error Code
• calcFreq: string
  Calculate Frequency
• calcRefPeriod: string
  Calculate Reference Period
• calcStartDate: string(date)
  Calculate Start Date
• calcType: string
  Calculate Type
• calcUnits: number
  Calculate Units
• chargeAmount: number
  Charge Amount
• chargeCategory: string
  Charge Category
• chargeCode: string
  Charge Code
• chargeCodeDesc: string
  Charge Code Description
• chargeCriteria: string
  Charge Criteria
• chargeCriteriaValue: number
  Charge Criteria Value
• chargeGroup: string
  Charge Group
• chargeType: string
  Charge Type
• chgCalcDate: string(date)
  Charge Calculate Date
• chgCollDate: string(date)
  Charge Collection Date
• chgCriteriaCcy: string
  Charge Criteria Currency
• chgCriteriaCount: string
  Charge Criteria Count
• chgSharing: string
  Charge Sharing
• chgSharingPct: number
  Charge Sharing Pct
• collectionFreq: string
  Collection Frequency
• collectionRefPeriod: string
  Collection Reference Period
• collectionType: string
  Collection Type
• collectionUnits: number
  Collection Units
• creditAccNumber: string
  Credit Account Number
• debitAccNumber: string
  Debit Account Number
• eventCode: string
  Event Code
• exchangeRate: number
  Exchange Rate
• externalPricing: string
  External Pricing Flag
• externalPricingConsumerService: string
  External Pricing Consumer Service Name
• externalPricingIdDescription: string
  External Pricing Identifier Description/Price Component Code Description
• externalPricingIdentifier: string
  External Pricing Identifier/Price Component Code
• externalPricingSystem: string
  External Pricing System
• externalPricingSystemName: string
  External Pricing System Name
• firstChgCalcDate: string(date)
  First Charge Calculation Date
• firstChgCollDate: string(date)
  First Charge Collection Date
• instrumentType: string
  Instrument Type
• isAutoWaived: string
  Is Charge Auto Waived
• isModified: string
  Is Charge Modified
• isOverridden: string
  Is Charge overridden
• isWaived: string
  Is Charge Waived
• nextChgCalcDate: string(date)
  Next Charge Calculation Date
• nextChgCollDate: string(date)
  Next Charge Collection Date
• oldChargeAmount: number
  Old Charge Amount
• oldPrcTemplateDesc: string
  Old Price Rule Description
• oldPriceTemplateId: string
  Old Price Rule Id
• parentChargeCode: string
  Parent Charge Code
• partyId: string
  Party Id
• partyName: string
  Party name
• partyToCharge: string
  Party To Charge
• postingDate: string(date)
  Posting Date
• postingErrorCode: string
  Posting Error Code
• prcTemplateDesc: string
  Price Rule Description
• priceMethodDesc: string
  Price Method Description
• priceTemplateId: string
  Price Rule Id
• referenceEndDate: string
  Reference End Date
• referenceEndDateValue: string(date)
  Reference End Date Value
• referenceStartDate: string
  Reference Start Date
• referenceStartDateValue: string(date)
  Reference Start Date Value
• seqNo: integer(int64)
  Sequence Number
• txnCcy: string
  Transaction Currency
• txnRefNo: string
  Transaction Reference Number

{
    "type":"object",
    "properties":{
        "allowOverride":{
            "type":"string",
            "description":"Allow Override"
        },
        "allowPrcModify":{
            "type":"string",
            "description":"Allow Prc Modify"
        },
        "allowWaive":{
            "type":"string",
            "description":"Allow Waive"
        },
        "applicationCode":{
            "type":"string",
            "description":"Application Code"
        },
        "autoWaive":{
            "type":"string",
            "description":"Auto Waive"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch code"
        },
        "calcErrorCode":{
            "type":"string",
            "description":"Calculate Error Code"
        },
        "calcFreq":{
            "type":"string",
            "description":"Calculate Frequency"
        },
        "calcRefPeriod":{
            "type":"string",
            "description":"Calculate Reference Period"
        },
        "calcType":{
            "type":"string",
            "description":"Calculate Type"
        },
        "calcUnits":{
            "type":"number",
            "description":"Calculate Units"
        },
        "chargeAmount":{
            "type":"number",
            "description":"Charge Amount"
        },
        "oldChargeAmount":{
            "type":"number",
            "description":"Old Charge Amount"
        },
        "chargeCategory":{
            "type":"string",
            "description":"Charge Category"
        },
        "chargeCode":{
            "type":"string",
            "description":"Charge Code"
        },
        "chargeCodeDesc":{
            "type":"string",
            "description":"Charge Code Description"
        },
        "chargeGroup":{
            "type":"string",
            "description":"Charge Group"
        },
        "chargeType":{
            "type":"string",
            "description":"Charge Type"
        },
        "chgCalcDate":{
            "type":"string",
            "format":"date",
            "description":"Charge Calculate Date"
        },
        "txnCcy":{
            "type":"string",
            "description":"Transaction Currency"
        },
        "chargeCriteria":{
            "type":"string",
            "description":"Charge Criteria"
        },
        "chargeCriteriaValue":{
            "type":"number",
            "description":"Charge Criteria Value"
        },
        "chgCriteriaCcy":{
            "type":"string",
            "description":"Charge Criteria Currency"
        },
        "chgCriteriaCount":{
            "type":"string",
            "description":"Charge Criteria Count"
        },
        "priceMethodDesc":{
            "type":"string",
            "description":"Price Method Description"
        },
        "priceTemplateId":{
            "type":"string",
            "description":"Price Rule Id"
        },
        "prcTemplateDesc":{
            "type":"string",
            "description":"Price Rule Description"
        },
        "oldPriceTemplateId":{
            "type":"string",
            "description":"Old Price Rule Id"
        },
        "oldPrcTemplateDesc":{
            "type":"string",
            "description":"Old Price Rule Description"
        },
        "chgSharing":{
            "type":"string",
            "description":"Charge Sharing"
        },
        "collectionType":{
            "type":"string",
            "description":"Collection Type"
        },
        "collectionFreq":{
            "type":"string",
            "description":"Collection Frequency"
        },
        "collectionRefPeriod":{
            "type":"string",
            "description":"Collection Reference Period"
        },
        "collectionUnits":{
            "type":"number",
            "description":"Collection Units"
        },
        "parentChargeCode":{
            "type":"string",
            "description":"Parent Charge Code"
        },
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "partyToCharge":{
            "type":"string",
            "description":"Party To Charge"
        },
        "postingErrorCode":{
            "type":"string",
            "description":"Posting Error Code"
        },
        "referenceEndDate":{
            "type":"string",
            "description":"Reference End Date"
        },
        "referenceStartDate":{
            "type":"string",
            "description":"Reference Start Date"
        },
        "referenceEndDateValue":{
            "type":"string",
            "format":"date",
            "description":"Reference End Date Value"
        },
        "referenceStartDateValue":{
            "type":"string",
            "format":"date",
            "description":"Reference Start Date Value"
        },
        "txnRefNo":{
            "type":"string",
            "description":"Transaction Reference Number"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64",
            "description":"Sequence Number"
        },
        "partyName":{
            "type":"string",
            "description":"Party name"
        },
        "instrumentType":{
            "type":"string",
            "description":"Instrument Type"
        },
        "eventCode":{
            "type":"string",
            "description":"Event Code"
        },
        "exchangeRate":{
            "type":"number",
            "description":"Exchange Rate"
        },
        "firstChgCalcDate":{
            "type":"string",
            "format":"date",
            "description":"First Charge Calculation Date"
        },
        "nextChgCalcDate":{
            "type":"string",
            "format":"date",
            "description":"Next Charge Calculation Date"
        },
        "chgCollDate":{
            "type":"string",
            "format":"date",
            "description":"Charge Collection Date"
        },
        "firstChgCollDate":{
            "type":"string",
            "format":"date",
            "description":"First Charge Collection Date"
        },
        "nextChgCollDate":{
            "type":"string",
            "format":"date",
            "description":"Next Charge Collection Date"
        },
        "debitAccNumber":{
            "type":"string",
            "description":"Debit Account Number"
        },
        "creditAccNumber":{
            "type":"string",
            "description":"Credit Account Number"
        },
        "chgSharingPct":{
            "type":"number",
            "description":"Charge Sharing Pct"
        },
        "postingDate":{
            "type":"string",
            "format":"date",
            "description":"Posting Date"
        },
        "calcStartDate":{
            "type":"string",
            "format":"date",
            "description":"Calculate Start Date"
        },
        "calcEndDate":{
            "type":"string",
            "format":"date",
            "description":"Calculate End Date"
        },
        "externalPricingSystem":{
            "description":"External Pricing System",
            "type":"string"
        },
        "externalPricing":{
            "type":"string",
            "description":"External Pricing Flag"
        },
        "externalPricingConsumerService":{
            "type":"string",
            "description":"External Pricing Consumer Service Name"
        },
        "externalPricingIdentifier":{
            "type":"string",
            "description":"External Pricing Identifier/Price Component Code"
        },
        "externalPricingIdDescription":{
            "type":"string",
            "description":"External Pricing Identifier Description/Price Component Code Description"
        },
        "externalPricingSystemName":{
            "type":"string",
            "description":"External Pricing System Name"
        },
        "isWaived":{
            "type":"string",
            "description":"Is Charge Waived"
        },
        "isAutoWaived":{
            "type":"string",
            "description":"Is Charge Auto Waived"
        },
        "isOverridden":{
            "type":"string",
            "description":"Is Charge overridden"
        },
        "isModified":{
            "type":"string",
            "description":"Is Charge Modified"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not auhorized.

500 Response

Internal error

Back to Top