Jump to

• Request
• Response

Search for an existing purchase order

get

/service/v1/po

This endpoint is used to search for an existing purchase order.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• authStatus(optional): string
• buyerDivCode(optional): string
• buyerId(optional): string
• buyerName(optional): string
• channel: string
  channel
• currency(optional): string
• fileRefName(optional): string
• fromPoAmount(optional): number
• fromPoDate(optional): string
• fromPoNetAmount(optional): number
• fromPromisedDate(optional): string
• limit(optional): integer
  limit is maximum no of records to be fetched
• linkedProgram(optional): string
• offset(optional): integer
  offset is starting no of records to be fetched
• poExternalNumber(optional): string
• poInternalNumber(optional): string
• poStatus(optional): string
• poTransactionRefNo: string
  Po Transaction Ref Number
• preAccepted(optional): string
• programId(optional): string
• relationshipId(optional): string
• sourceTxnId: string
• supplierDivCode(optional): string
• supplierId(optional): string
• supplierName(optional): string
• toPoAmount(optional): number
• toPoDate(optional): string
• toPoNetAmount(optional): number
• toPromisedDate(optional): string

Header Parameters

• appId: string
• branchCode: string
• userId: string

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Body ()

Root Schema : PoSearchResponse

Match All

Show Source

• object PurchaseOrderCollection
  Collection of po.
• object PoSearchResponse-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/PurchaseOrderCollection"
        },
        {
            "type":"object",
            "properties":{
                "message":{
                    "type":"object",
                    "description":"Error Message",
                    "$ref":"#/definitions/ErrorDto"
                },
                "paging":{
                    "$ref":"#/definitions/PagingDto"
                }
            }
        }
    ]
}

Nested Schema : PurchaseOrderCollection

Type: object

Collection of po.

Show Source

• data(optional): array data

{
    "description":"Collection of po.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PurchaseOrderDTO"
            }
        }
    }
}

Nested Schema : PoSearchResponse-allOf[1]

Type: object

Show Source

• message(optional): object ErrorDto
• paging(optional): object PagingDto
  Paging DTO object

{
    "type":"object",
    "properties":{
        "message":{
            "type":"object",
            "description":"Error Message",
            "$ref":"#/definitions/ErrorDto"
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object PurchaseOrderDTO

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

Nested Schema : PurchaseOrderDTO

Type: object

Match All

Show Source

• object PurchaseOrderDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "buyerId":{
                    "type":"string",
                    "description":"Buyer Id"
                },
                "buyerDivCode":{
                    "type":"string",
                    "description":"Buyer Division Code"
                },
                "poAction":{
                    "type":"string"
                },
                "buyerDivName":{
                    "type":"string",
                    "description":"Buyer Division Name"
                },
                "buyerName":{
                    "type":"string",
                    "description":"Buyer Name"
                },
                "currency":{
                    "type":"string",
                    "description":"Currency"
                },
                "poDate":{
                    "type":"string",
                    "description":"Po Date"
                },
                "poExternalNumber":{
                    "type":"string",
                    "description":"Po External Number"
                },
                "poInternalNumber":{
                    "type":"string",
                    "description":"Po Internal Number"
                },
                "seqNo":{
                    "type":"string",
                    "description":"Sequence Number"
                },
                "programId":{
                    "type":"string",
                    "description":"Program Id"
                },
                "programName":{
                    "type":"string",
                    "description":"Program Name"
                },
                "relationshipCode":{
                    "type":"string",
                    "description":"Relationship Code"
                },
                "relationshipName":{
                    "type":"string",
                    "description":"Relationship Name"
                },
                "supplierId":{
                    "type":"string",
                    "description":"Supplier Id"
                },
                "supplierDivCode":{
                    "type":"string",
                    "description":"Supplier Division Code"
                },
                "supplierDivName":{
                    "type":"string",
                    "description":"Supplier Division Name"
                },
                "supplierName":{
                    "type":"string",
                    "description":"Supplier Name"
                },
                "fileRefName":{
                    "type":"string",
                    "description":"File Reference Name"
                },
                "poTransactionRefNo":{
                    "type":"string",
                    "description":"Po Transaction Reference Number"
                },
                "reqShipmentDate":{
                    "type":"string",
                    "description":"Required Shipment Date"
                },
                "shipTo":{
                    "type":"string",
                    "description":"Ship To"
                },
                "shipmentAddr":{
                    "type":"string",
                    "description":"Shipment Addr"
                },
                "shipmentAddr2":{
                    "type":"string",
                    "description":"Shipment Addr2"
                },
                "shipmentAddr3":{
                    "type":"string",
                    "description":"Shipment Addr3"
                },
                "shipmentCountry":{
                    "type":"string",
                    "description":"Shipment Addr"
                },
                "zipCode":{
                    "type":"string",
                    "description":"Zip Code"
                },
                "termsOfSale":{
                    "type":"string",
                    "description":"Terms Of Sale"
                },
                "paymentTerms":{
                    "type":"string",
                    "description":"Payment Terms"
                },
                "countryOfOrigin":{
                    "type":"string",
                    "description":"Country Of Origin"
                },
                "promisedShipmentDate":{
                    "type":"string",
                    "description":"Promised Shipment Date"
                },
                "oldPromisedShipmentDate":{
                    "type":"string",
                    "description":"Old Promised Shipment Date"
                },
                "phoneNumber":{
                    "type":"string",
                    "description":"Phone Number"
                },
                "taxId":{
                    "type":"string",
                    "description":"Tax Id"
                },
                "city":{
                    "type":"string",
                    "description":"City"
                },
                "miscChrg1Amt":{
                    "type":"number",
                    "description":"Miscellaneous Charge 1 Amount"
                },
                "miscChrg1Desc":{
                    "type":"string",
                    "description":"Miscellaneous Charge 1 Description"
                },
                "miscChrg2Amt":{
                    "type":"number",
                    "description":"Miscellaneous Charge 2 Amount"
                },
                "miscChrg2Desc":{
                    "type":"string",
                    "description":"Miscellaneous Charge 2 Description"
                },
                "basePoAmount":{
                    "type":"number",
                    "description":"Base Po Amount"
                },
                "discountAmount":{
                    "type":"number",
                    "description":"Discount Amount"
                },
                "discountPercent":{
                    "type":"number",
                    "description":"Discount Percent"
                },
                "netPoAmount":{
                    "type":"number",
                    "description":"Net Po Amount"
                },
                "taxAmount":{
                    "type":"number",
                    "description":"Tax Amount"
                },
                "taxPercent":{
                    "type":"number",
                    "description":"Tax Percent"
                },
                "totalPoAmount":{
                    "type":"number",
                    "description":"Total Po Amount"
                },
                "commodityList":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/PoCommodityListDTO"
                    }
                },
                "poStatus":{
                    "type":"string"
                },
                "processStatus":{
                    "type":"string"
                },
                "recordStatus":{
                    "type":"string"
                },
                "reasonCode":{
                    "type":"string"
                },
                "preAccepted":{
                    "type":"string"
                },
                "remarks":{
                    "type":"string"
                },
                "staleStatus":{
                    "type":"string"
                },
                "acceptanceAmount":{
                    "type":"number"
                },
                "oldAcceptanceAmount":{
                    "type":"number"
                },
                "acceptanceDate":{
                    "type":"string"
                },
                "financeAmount":{
                    "type":"number",
                    "description":"Amount already financed"
                },
                "oldFinanceAmount":{
                    "type":"number"
                },
                "financePCT":{
                    "type":"number"
                },
                "financiableAmount":{
                    "type":"number"
                },
                "financeStatus":{
                    "type":"string"
                },
                "reasonForExport":{
                    "type":"string"
                },
                "channel":{
                    "type":"string"
                },
                "sourceTxnId":{
                    "type":"string"
                },
                "fundReqAmount":{
                    "type":"string",
                    "description":"Funding Request Amount present in PO File"
                },
                "fundReqDate":{
                    "type":"string",
                    "description":"Funding Request Date"
                },
                "filler1":{
                    "type":"string",
                    "description":"Filter Attribute1"
                },
                "filler2":{
                    "type":"string",
                    "description":"Filter Attribute2"
                },
                "filler3":{
                    "type":"string",
                    "description":"Filter Attribute3"
                },
                "filler4":{
                    "type":"string",
                    "description":"Filter Attribute4"
                },
                "filler5":{
                    "type":"string",
                    "description":"Filter Attribute5"
                },
                "filler6":{
                    "type":"string",
                    "description":"Filter Attribute6"
                },
                "amountToBeFinanced":{
                    "type":"number",
                    "description":"Amount To Be Financed"
                },
                "expiresOn":{
                    "type":"string",
                    "description":"expiresOn"
                }
            }
        }
    ]
}

Nested Schema : PurchaseOrderDTO-allOf[0]

Type: object

Show Source

• acceptanceAmount(optional): number
• acceptanceDate(optional): string
• amountToBeFinanced(optional): number
  Amount To Be Financed
• basePoAmount(optional): number
  Base Po Amount
• buyerDivCode(optional): string
  Buyer Division Code
• buyerDivName(optional): string
  Buyer Division Name
• buyerId(optional): string
  Buyer Id
• buyerName(optional): string
  Buyer Name
• channel(optional): string
• city(optional): string
  City
• commodityList(optional): array commodityList
• countryOfOrigin(optional): string
  Country Of Origin
• currency(optional): string
  Currency
• discountAmount(optional): number
  Discount Amount
• discountPercent(optional): number
  Discount Percent
• expiresOn(optional): string
  expiresOn
• fileRefName(optional): string
  File Reference Name
• filler1(optional): string
  Filter Attribute1
• filler2(optional): string
  Filter Attribute2
• filler3(optional): string
  Filter Attribute3
• filler4(optional): string
  Filter Attribute4
• filler5(optional): string
  Filter Attribute5
• filler6(optional): string
  Filter Attribute6
• financeAmount(optional): number
  Amount already financed
• financePCT(optional): number
• financeStatus(optional): string
• financiableAmount(optional): number
• fundReqAmount(optional): string
  Funding Request Amount present in PO File
• fundReqDate(optional): string
  Funding Request Date
• miscChrg1Amt(optional): number
  Miscellaneous Charge 1 Amount
• miscChrg1Desc(optional): string
  Miscellaneous Charge 1 Description
• miscChrg2Amt(optional): number
  Miscellaneous Charge 2 Amount
• miscChrg2Desc(optional): string
  Miscellaneous Charge 2 Description
• netPoAmount(optional): number
  Net Po Amount
• oldAcceptanceAmount(optional): number
• oldFinanceAmount(optional): number
• oldPromisedShipmentDate(optional): string
  Old Promised Shipment Date
• paymentTerms(optional): string
  Payment Terms
• phoneNumber(optional): string
  Phone Number
• poAction(optional): string
• poDate(optional): string
  Po Date
• poExternalNumber(optional): string
  Po External Number
• poInternalNumber(optional): string
  Po Internal Number
• poStatus(optional): string
• poTransactionRefNo(optional): string
  Po Transaction Reference Number
• preAccepted(optional): string
• processStatus(optional): string
• programId(optional): string
  Program Id
• programName(optional): string
  Program Name
• promisedShipmentDate(optional): string
  Promised Shipment Date
• reasonCode(optional): string
• reasonForExport(optional): string
• recordStatus(optional): string
• relationshipCode(optional): string
  Relationship Code
• relationshipName(optional): string
  Relationship Name
• remarks(optional): string
• reqShipmentDate(optional): string
  Required Shipment Date
• seqNo(optional): string
  Sequence Number
• shipmentAddr(optional): string
  Shipment Addr
• shipmentAddr2(optional): string
  Shipment Addr2
• shipmentAddr3(optional): string
  Shipment Addr3
• shipmentCountry(optional): string
  Shipment Addr
• shipTo(optional): string
  Ship To
• sourceTxnId(optional): string
• staleStatus(optional): string
• supplierDivCode(optional): string
  Supplier Division Code
• supplierDivName(optional): string
  Supplier Division Name
• supplierId(optional): string
  Supplier Id
• supplierName(optional): string
  Supplier Name
• taxAmount(optional): number
  Tax Amount
• taxId(optional): string
  Tax Id
• taxPercent(optional): number
  Tax Percent
• termsOfSale(optional): string
  Terms Of Sale
• totalPoAmount(optional): number
  Total Po Amount
• zipCode(optional): string
  Zip Code

{
    "type":"object",
    "properties":{
        "buyerId":{
            "type":"string",
            "description":"Buyer Id"
        },
        "buyerDivCode":{
            "type":"string",
            "description":"Buyer Division Code"
        },
        "poAction":{
            "type":"string"
        },
        "buyerDivName":{
            "type":"string",
            "description":"Buyer Division Name"
        },
        "buyerName":{
            "type":"string",
            "description":"Buyer Name"
        },
        "currency":{
            "type":"string",
            "description":"Currency"
        },
        "poDate":{
            "type":"string",
            "description":"Po Date"
        },
        "poExternalNumber":{
            "type":"string",
            "description":"Po External Number"
        },
        "poInternalNumber":{
            "type":"string",
            "description":"Po Internal Number"
        },
        "seqNo":{
            "type":"string",
            "description":"Sequence Number"
        },
        "programId":{
            "type":"string",
            "description":"Program Id"
        },
        "programName":{
            "type":"string",
            "description":"Program Name"
        },
        "relationshipCode":{
            "type":"string",
            "description":"Relationship Code"
        },
        "relationshipName":{
            "type":"string",
            "description":"Relationship Name"
        },
        "supplierId":{
            "type":"string",
            "description":"Supplier Id"
        },
        "supplierDivCode":{
            "type":"string",
            "description":"Supplier Division Code"
        },
        "supplierDivName":{
            "type":"string",
            "description":"Supplier Division Name"
        },
        "supplierName":{
            "type":"string",
            "description":"Supplier Name"
        },
        "fileRefName":{
            "type":"string",
            "description":"File Reference Name"
        },
        "poTransactionRefNo":{
            "type":"string",
            "description":"Po Transaction Reference Number"
        },
        "reqShipmentDate":{
            "type":"string",
            "description":"Required Shipment Date"
        },
        "shipTo":{
            "type":"string",
            "description":"Ship To"
        },
        "shipmentAddr":{
            "type":"string",
            "description":"Shipment Addr"
        },
        "shipmentAddr2":{
            "type":"string",
            "description":"Shipment Addr2"
        },
        "shipmentAddr3":{
            "type":"string",
            "description":"Shipment Addr3"
        },
        "shipmentCountry":{
            "type":"string",
            "description":"Shipment Addr"
        },
        "zipCode":{
            "type":"string",
            "description":"Zip Code"
        },
        "termsOfSale":{
            "type":"string",
            "description":"Terms Of Sale"
        },
        "paymentTerms":{
            "type":"string",
            "description":"Payment Terms"
        },
        "countryOfOrigin":{
            "type":"string",
            "description":"Country Of Origin"
        },
        "promisedShipmentDate":{
            "type":"string",
            "description":"Promised Shipment Date"
        },
        "oldPromisedShipmentDate":{
            "type":"string",
            "description":"Old Promised Shipment Date"
        },
        "phoneNumber":{
            "type":"string",
            "description":"Phone Number"
        },
        "taxId":{
            "type":"string",
            "description":"Tax Id"
        },
        "city":{
            "type":"string",
            "description":"City"
        },
        "miscChrg1Amt":{
            "type":"number",
            "description":"Miscellaneous Charge 1 Amount"
        },
        "miscChrg1Desc":{
            "type":"string",
            "description":"Miscellaneous Charge 1 Description"
        },
        "miscChrg2Amt":{
            "type":"number",
            "description":"Miscellaneous Charge 2 Amount"
        },
        "miscChrg2Desc":{
            "type":"string",
            "description":"Miscellaneous Charge 2 Description"
        },
        "basePoAmount":{
            "type":"number",
            "description":"Base Po Amount"
        },
        "discountAmount":{
            "type":"number",
            "description":"Discount Amount"
        },
        "discountPercent":{
            "type":"number",
            "description":"Discount Percent"
        },
        "netPoAmount":{
            "type":"number",
            "description":"Net Po Amount"
        },
        "taxAmount":{
            "type":"number",
            "description":"Tax Amount"
        },
        "taxPercent":{
            "type":"number",
            "description":"Tax Percent"
        },
        "totalPoAmount":{
            "type":"number",
            "description":"Total Po Amount"
        },
        "commodityList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PoCommodityListDTO"
            }
        },
        "poStatus":{
            "type":"string"
        },
        "processStatus":{
            "type":"string"
        },
        "recordStatus":{
            "type":"string"
        },
        "reasonCode":{
            "type":"string"
        },
        "preAccepted":{
            "type":"string"
        },
        "remarks":{
            "type":"string"
        },
        "staleStatus":{
            "type":"string"
        },
        "acceptanceAmount":{
            "type":"number"
        },
        "oldAcceptanceAmount":{
            "type":"number"
        },
        "acceptanceDate":{
            "type":"string"
        },
        "financeAmount":{
            "type":"number",
            "description":"Amount already financed"
        },
        "oldFinanceAmount":{
            "type":"number"
        },
        "financePCT":{
            "type":"number"
        },
        "financiableAmount":{
            "type":"number"
        },
        "financeStatus":{
            "type":"string"
        },
        "reasonForExport":{
            "type":"string"
        },
        "channel":{
            "type":"string"
        },
        "sourceTxnId":{
            "type":"string"
        },
        "fundReqAmount":{
            "type":"string",
            "description":"Funding Request Amount present in PO File"
        },
        "fundReqDate":{
            "type":"string",
            "description":"Funding Request Date"
        },
        "filler1":{
            "type":"string",
            "description":"Filter Attribute1"
        },
        "filler2":{
            "type":"string",
            "description":"Filter Attribute2"
        },
        "filler3":{
            "type":"string",
            "description":"Filter Attribute3"
        },
        "filler4":{
            "type":"string",
            "description":"Filter Attribute4"
        },
        "filler5":{
            "type":"string",
            "description":"Filter Attribute5"
        },
        "filler6":{
            "type":"string",
            "description":"Filter Attribute6"
        },
        "amountToBeFinanced":{
            "type":"number",
            "description":"Amount To Be Financed"
        },
        "expiresOn":{
            "type":"string",
            "description":"expiresOn"
        }
    }
}

Nested Schema : commodityList

Type: array

Show Source

• Array of: object PoCommodityListDTO

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

Nested Schema : PoCommodityListDTO

Type: object

Show Source

• commodityCode(optional): string
  Commodity Code
• commodityName(optional): string
  Commodity Name
• currency(optional): string
  Currency
• discountAmount(optional): number
  Discount Amount
• discountPercent(optional): number
  Discount Percent
• goodsDescription(optional): string
  Goods Description
• id(optional): string
  Id
• netCost(optional): number
  Net Cost
• poMasterId(optional): string
• quantity(optional): number
  Quantity
• taxAmount(optional): number
  Tax Amount
• taxPercent(optional): number
  Tax Percent
• totalCost(optional): number
  Total Cost
• totalWeight(optional): number
  Total Weight
• unit(optional): string
  Unit
• unitCost(optional): number
  Unit Cost
• unitWeight(optional): number
  Unit Weight

{
    "type":"object",
    "properties":{
        "commodityCode":{
            "type":"string",
            "description":"Commodity Code"
        },
        "commodityName":{
            "type":"string",
            "description":"Commodity Name"
        },
        "currency":{
            "type":"string",
            "description":"Currency"
        },
        "discountAmount":{
            "type":"number",
            "description":"Discount Amount"
        },
        "discountPercent":{
            "type":"number",
            "description":"Discount Percent"
        },
        "goodsDescription":{
            "type":"string",
            "description":"Goods Description"
        },
        "poMasterId":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "netCost":{
            "type":"number",
            "description":"Net Cost"
        },
        "quantity":{
            "type":"number",
            "description":"Quantity"
        },
        "taxAmount":{
            "type":"number",
            "description":"Tax Amount"
        },
        "taxPercent":{
            "type":"number",
            "description":"Tax Percent"
        },
        "totalCost":{
            "type":"number",
            "description":"Total Cost"
        },
        "totalWeight":{
            "type":"number",
            "description":"Total Weight"
        },
        "unit":{
            "type":"string",
            "description":"Unit"
        },
        "unitCost":{
            "type":"number",
            "description":"Unit Cost"
        },
        "unitWeight":{
            "type":"number",
            "description":"Unit Weight"
        }
    }
}

Nested Schema : ErrorDto

Type: object

Show Source

• errorCode(optional): string
  Error Code
• errorDesc(optional): string
  Error Desc

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Desc"
        }
    }
}

Nested Schema : PagingDto

Type: object

Paging DTO object

Show Source

• totalResults(optional): integer
  Total Results

{
    "description":"Paging DTO object",
    "type":"object",
    "properties":{
        "totalResults":{
            "description":"Total Results",
            "type":"integer"
        }
    }
}

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

Back to Top