Existing purchase order
get
/service/v1/po
This service is used to search for an existing purchase order.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
action: string
Action
-
authStatus: string
-
buyerDivCode: string
-
buyerId: string
-
buyerName: string
-
channel: string
channel
-
currency: string
-
fileRefName: string
-
financeStatus: string
-
fromAvailableAmount: number
-
fromPoAmount: number
-
fromPoDate: string
-
fromPoNetAmount: number
-
fromPromisedDate: string
-
limit: integer
limit is maximum no of records to be fetched
-
linkedProgram: string
-
offset: integer
offset is starting no of records to be fetched
-
orderBy: string
order By Parameter
-
poExternalNumber: string
-
poInternalNumber: string
-
poStatus: string
-
poTransactionRefNo: string
Po Transaction Ref Number
-
preAccepted: string
-
programId: string
-
relationshipId: string
-
sourceTxnId: string
-
supplierDivCode: string
-
supplierId: string
-
supplierName: string
-
toAvailableAmount: number
-
toPoAmount: number
-
toPoDate: string
-
toPoNetAmount: number
-
toPromisedDate: string
Header Parameters
Back to Top
Response
Supported Media Types
- application/json
- application/xml
201 Response
Returns message of succes or failure
Root Schema : PoSearchResponse
Match All
Show Source
-
object
PurchaseOrderCollection
Collection of po.
-
object
PoSearchResponse-allOf[1]
Nested Schema : PurchaseOrderDTO-allOf[0]
Type:
Show Source
object-
acceptanceAmount:
number
-
acceptanceDate:
string
-
allowBackDatedDisbursments:
string
Allow Back-dated Disbursments
-
amountToBeFinanced:
number
Amount To Be Financed
-
availableAmount:
number
expiresOn
-
basePoAmount:
number
Base Po Amount
-
buyerDivCode:
string
Buyer Division Code
-
buyerDivName:
string
Buyer Division Name
-
buyerId:
string
Buyer Id
-
buyerName:
string
Buyer Name
-
channel:
string
-
city:
string
City
-
commodityList:
array commodityList
-
countryOfOrigin:
string
Country Of Origin
-
currency:
string
Currency
-
discountAmount:
number
Discount Amount
-
discountPercent:
number
Discount Percent
-
editInfo:
string
edited fields
-
expiresOn:
string
expiresOn
-
fileRefName:
string
File Reference Name
-
filler1:
string
Filter Attribute1
-
filler2:
string
Filter Attribute2
-
filler3:
string
Filter Attribute3
-
filler4:
string
Filter Attribute4
-
filler5:
string
Filter Attribute5
-
filler6:
string
Filter Attribute6
-
financeAmount:
number
Amount already financed
-
financePCT:
number
-
financeStatus:
string
-
financiableAmount:
number
-
fundReqAmount:
string
Funding Request Amount present in PO File
-
fundReqDate:
string
Funding Request Date
-
linkedInvoiceList:
array linkedInvoiceList
-
makerDate:
string
Maker Date
-
miscChrg1Amt:
number
Miscellaneous Charge 1 Amount
-
miscChrg1Desc:
string
Miscellaneous Charge 1 Description
-
miscChrg2Amt:
number
Miscellaneous Charge 2 Amount
-
miscChrg2Desc:
string
Miscellaneous Charge 2 Description
-
netPoAmount:
number
Net Po Amount
-
oldAcceptanceAmount:
number
-
oldFinanceAmount:
number
-
oldPromisedShipmentDate:
string
Old Promised Shipment Date
-
paymentTerms:
string
Payment Terms
-
phoneNumber:
string
Phone Number
-
poAction:
string
-
poDate:
string
Po Date
-
poExternalNumber:
string
Po External Number
-
poId:
string
Purchase Order Id
-
poInternalNumber:
string
Po Internal Number
-
poStatus:
string
-
poTransactionRefNo:
string
Po Transaction Reference Number
-
preAccepted:
string
-
processStatus:
string
-
programId:
string
Program Id
-
programName:
string
Program Name
-
promisedShipmentDate:
string
Promised Shipment Date
-
reasonCode:
string
-
reasonForExport:
string
-
recordStatus:
string
-
relationshipCode:
string
Relationship Code
-
relationshipName:
string
Relationship Name
-
remarks:
string
-
reqShipmentDate:
string
Required Shipment Date
-
seqNo:
string
Sequence Number
-
shipmentAddr:
string
Shipment Addr
-
shipmentAddr2:
string
Shipment Addr2
-
shipmentAddr3:
string
Shipment Addr3
-
shipmentCountry:
string
Shipment Addr
-
shipTo:
string
Ship To
-
sourceTxnId:
string
-
staleStatus:
string
-
supplierDivCode:
string
Supplier Division Code
-
supplierDivName:
string
Supplier Division Name
-
supplierId:
string
Supplier Id
-
supplierName:
string
Supplier Name
-
taxAmount:
number
Tax Amount
-
taxId:
string
Tax Id
-
taxPercent:
number
Tax Percent
-
termsOfSale:
string
Terms Of Sale
-
totalPoAmount:
number
Total Po Amount
-
zipCode:
string
Zip Code
Nested Schema : PoCommodityListDTO
Type:
Show Source
object-
allocatedAmount:
number
Allocated Amount
-
availableAmount:
number
Available Amount
-
commodityCode:
string
Commodity Code
-
commodityName:
string
Commodity Name
-
currency:
string
Currency
-
discountAmount:
number
Discount Amount
-
discountPercent:
number
Discount Percent
-
goodsDescription:
string
Goods Description
-
id:
string
Id
-
netCost:
number
Net Cost
-
poMasterId:
string
-
quantity:
number
Quantity
-
taxAmount:
number
Tax Amount
-
taxPercent:
number
Tax Percent
-
totalCost:
number
Total Cost
-
totalWeight:
number
Total Weight
-
unit:
string
Unit
-
unitCost:
number
Unit Cost
-
unitWeight:
number
Unit Weight
Nested Schema : LinkedInvoiceDTO
Type:
Show Source
object-
currency:
string
-
exchangeRate:
number
-
id:
string
-
invoiceAllocAmount:
number
-
invoiceAllocAmountToBe:
number
-
invoiceAllocPercentage:
number
-
invoiceMasterId:
string
-
invoiceRefNo:
string
-
isLinkageSuccessful:
string
-
netPoAmount:
number
-
poAvailableAmount:
number
-
poAvailableAmountPostLink:
number
-
poDate:
string
-
poExternalNumber:
string
-
poInternalNumber:
string
-
poStatus:
string
-
seqNo:
integer(int64)
Nested Schema : ErrorDto
Type:
Show Source
object-
errorCode:
string
Error Codes Displaying
-
errorDesc:
string
Error Description displaying based on error codes
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error