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

• obChargesTxnDTOList(optional): array obChargesTxnDTOList

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

Nested Schema : obChargesTxnDTOList

Type: array

Show Source

• Array of: object ObChargesTxnDTO

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

Nested Schema : ObChargesTxnDTO

Type: object

Show Source

• allowOverride(optional): string
• allowPrcModify(optional): string
• allowWaive(optional): string
• applicationCode(optional): string
• autoWaive(optional): string
• branchCode(optional): string
• calcEndDate(optional): string(date)
• calcErrorCode(optional): string
• calcFreq(optional): string
• calcRefPeriod(optional): string
• calcStartDate(optional): string(date)
• calcType(optional): string
• calcUnits(optional): number
• chargeAmount(optional): number
• chargeCategory(optional): string
• chargeCode(optional): string
• chargeCodeDesc(optional): string
• chargeCriteria(optional): string
• chargeCriteriaValue(optional): number
• chargeGroup(optional): string
• chargeType(optional): string
• chgCalcDate(optional): string(date)
• chgCriteriaCcy(optional): string
• chgCriteriaCount(optional): string
• chgSharing(optional): string
• chgSharingPct(optional): number
• collectionFreq(optional): string
• collectionRefPeriod(optional): string
• collectionType(optional): string
• collectionUnits(optional): number
• creditAccNumber(optional): string
• debitAccNumber(optional): string
• eventCode(optional): string
• exchangeRate(optional): number
• firstChgCalcDate(optional): string(date)
• firstChgCollDate(optional): string(date)
• instrumentType(optional): string
• nextChgCalcDate(optional): string(date)
• nextChgCollDate(optional): string(date)
• parentChargeCode(optional): string
• partyId(optional): string
• partyName(optional): string
• partyToCharge(optional): string
• postingErrorCode(optional): string
• priceMethodDesc(optional): string
• priceTemplateId(optional): string
• referenceEndDate(optional): string
• referenceEndDateValue(optional): string(date)
• referenceStartDate(optional): string
• referenceStartDateValue(optional): string(date)
• txnCcy(optional): string
• txnRefNo(optional): string

{
    "type":"object",
    "properties":{
        "allowOverride":{
            "type":"string"
        },
        "allowPrcModify":{
            "type":"string"
        },
        "allowWaive":{
            "type":"string"
        },
        "applicationCode":{
            "type":"string"
        },
        "autoWaive":{
            "type":"string"
        },
        "branchCode":{
            "type":"string"
        },
        "calcErrorCode":{
            "type":"string"
        },
        "calcFreq":{
            "type":"string"
        },
        "calcRefPeriod":{
            "type":"string"
        },
        "calcType":{
            "type":"string"
        },
        "calcUnits":{
            "type":"number"
        },
        "chargeAmount":{
            "type":"number"
        },
        "chargeCategory":{
            "type":"string"
        },
        "chargeCode":{
            "type":"string"
        },
        "chargeCodeDesc":{
            "type":"string"
        },
        "chargeGroup":{
            "type":"string"
        },
        "chargeType":{
            "type":"string"
        },
        "chgCalcDate":{
            "type":"string",
            "format":"date"
        },
        "txnCcy":{
            "type":"string"
        },
        "chargeCriteria":{
            "type":"string"
        },
        "chargeCriteriaValue":{
            "type":"number"
        },
        "chgCriteriaCcy":{
            "type":"string"
        },
        "chgCriteriaCount":{
            "type":"string"
        },
        "priceMethodDesc":{
            "type":"string"
        },
        "priceTemplateId":{
            "type":"string"
        },
        "chgSharing":{
            "type":"string"
        },
        "instrumentType":{
            "type":"string"
        },
        "collectionType":{
            "type":"string"
        },
        "collectionFreq":{
            "type":"string"
        },
        "collectionRefPeriod":{
            "type":"string"
        },
        "collectionUnits":{
            "type":"number"
        },
        "parentChargeCode":{
            "type":"string"
        },
        "partyId":{
            "type":"string"
        },
        "partyToCharge":{
            "type":"string"
        },
        "postingErrorCode":{
            "type":"string"
        },
        "referenceEndDate":{
            "type":"string"
        },
        "referenceStartDate":{
            "type":"string"
        },
        "referenceEndDateValue":{
            "type":"string",
            "format":"date"
        },
        "referenceStartDateValue":{
            "type":"string",
            "format":"date"
        },
        "txnRefNo":{
            "type":"string"
        },
        "partyName":{
            "type":"string"
        },
        "eventCode":{
            "type":"string"
        },
        "exchangeRate":{
            "type":"number"
        },
        "firstChgCalcDate":{
            "type":"string",
            "format":"date"
        },
        "nextChgCalcDate":{
            "type":"string",
            "format":"date"
        },
        "firstChgCollDate":{
            "type":"string",
            "format":"date"
        },
        "nextChgCollDate":{
            "type":"string",
            "format":"date"
        },
        "debitAccNumber":{
            "type":"string"
        },
        "creditAccNumber":{
            "type":"string"
        },
        "chgSharingPct":{
            "type":"number"
        },
        "calcStartDate":{
            "type":"string",
            "format":"date"
        },
        "calcEndDate":{
            "type":"string",
            "format":"date"
        }
    }
}

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