Jump to

• Request
• Response

Adds a new Purchase Order

post

/service/v1/po/create

This endpoint is used to add a new purchase order.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

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

Body ()

Request Body that contains data required for creating a new po

Root Schema : PoServiceCollection

Type: object

Collection of po.

Show Source

• authRequire(optional): string
  Authorization require Y/N
• data(optional): array data
• sourceTxnId(optional): string

{
    "description":"Collection of po.",
    "type":"object",
    "properties":{
        "sourceTxnId":{
            "type":"string"
        },
        "authRequire":{
            "type":"string",
            "description":"Authorization require Y/N"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PoServiceDTO"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object PoServiceDTO

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

Nested Schema : PoServiceDTO

Type: object

Show Source

• acceptanceAmount(optional): number
  Acceptance Amount
• acceptanceDate(optional): string
  Acceptance Date
• basePoAmount(optional): number
  Amount (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
  channel
• city(optional): string
  City
• commodityList(optional): array commodityList
• currency(optional): string
  Currency of PO
• discountAmount(optional): number
  Discount Amount
• discountPercent(optional): number
  Discount Percent
• filler1(optional): string
  Filler 1
• filler2(optional): string
  Filler 2
• filler3(optional): string
  Filler 3
• filler4(optional): string
  Filler 4
• filler5(optional): string
  Filler 5
• filler6(optional): string
  Filler 6
• fundReqAmount(optional): number
  Funding Request Amount
• miscChrg1Amt(optional): number
  Misc Charge 1 Amount
• miscChrg1Desc(optional): string
  Misc Charge 1 Description
• miscChrg2Amt(optional): number
  Misc Charge 2 Amount
• miscChrg2Desc(optional): string
  Misc Charge 2 Description
• netPoAmount(optional): number
  Net PO Amount
• oldPromisedShipmentDate(optional): string
  Old Promised Shipment Date
• paymentTerms(optional): string
  Payment Term
• poDate(optional): string
  Purchase Order Date
• poExternalNumber(optional): string
  Purchase Order External Number
• poTransactionRefNo(optional): string
  Po Transaction Ref Number
• preAccepted(optional): string
  Pre Accepted
• programId(optional): string
  Program Code
• promisedShipmentDate(optional): string
  Promised Shipment Date
• raisedBy(optional): string
  Raised By
• reasonForExport(optional): string
• shipmentAddr(optional): string
  Shipment Address
• shipmentAddr2(optional): string
  Shipment Address2
• shipmentAddr3(optional): string
  Shipment Address3
• shipmentCountry(optional): string
  Shipment Country
• sourceTxnId(optional): string
  sourceTxnId
• 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
• zipCode(optional): string
  Zipcode

{
    "type":"object",
    "properties":{
        "buyerId":{
            "type":"string",
            "description":"Buyer Id"
        },
        "buyerDivCode":{
            "type":"string",
            "description":"Buyer Division Code"
        },
        "buyerName":{
            "type":"string",
            "description":"Buyer Name"
        },
        "buyerDivName":{
            "type":"string",
            "description":"Buyer Division Name"
        },
        "currency":{
            "type":"string",
            "description":"Currency of PO"
        },
        "poDate":{
            "type":"string",
            "description":"Purchase Order Date"
        },
        "poExternalNumber":{
            "type":"string",
            "description":"Purchase Order External Number"
        },
        "programId":{
            "type":"string",
            "description":"Program Code"
        },
        "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"
        },
        "shipmentAddr":{
            "type":"string",
            "description":"Shipment Address"
        },
        "shipmentAddr2":{
            "type":"string",
            "description":"Shipment Address2"
        },
        "shipmentAddr3":{
            "type":"string",
            "description":"Shipment Address3"
        },
        "city":{
            "type":"string",
            "description":"City"
        },
        "shipmentCountry":{
            "type":"string",
            "description":"Shipment Country"
        },
        "zipCode":{
            "type":"string",
            "description":"Zipcode"
        },
        "promisedShipmentDate":{
            "type":"string",
            "description":"Promised Shipment Date"
        },
        "oldPromisedShipmentDate":{
            "type":"string",
            "description":"Old Promised Shipment Date"
        },
        "taxId":{
            "type":"string",
            "description":"Tax Id"
        },
        "paymentTerms":{
            "type":"string",
            "description":"Payment Term"
        },
        "miscChrg1Desc":{
            "type":"string",
            "description":"Misc Charge 1 Description"
        },
        "miscChrg1Amt":{
            "type":"number",
            "description":"Misc Charge 1 Amount"
        },
        "miscChrg2Desc":{
            "type":"string",
            "description":"Misc Charge 2 Description"
        },
        "miscChrg2Amt":{
            "type":"number",
            "description":"Misc Charge 2 Amount"
        },
        "commodityList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PoComServiceDTO"
            }
        },
        "preAccepted":{
            "type":"string",
            "description":"Pre Accepted"
        },
        "basePoAmount":{
            "type":"number",
            "description":"Amount (Base PO Amount)"
        },
        "discountAmount":{
            "type":"number",
            "description":"Discount Amount"
        },
        "discountPercent":{
            "type":"number",
            "description":"Discount Percent"
        },
        "taxAmount":{
            "type":"number",
            "description":"Tax Amount"
        },
        "taxPercent":{
            "type":"number",
            "description":"Tax Percent"
        },
        "netPoAmount":{
            "type":"number",
            "description":"Net PO Amount"
        },
        "acceptanceAmount":{
            "type":"number",
            "description":"Acceptance Amount"
        },
        "acceptanceDate":{
            "type":"string",
            "description":"Acceptance Date"
        },
        "fundReqAmount":{
            "type":"number",
            "description":"Funding Request Amount"
        },
        "raisedBy":{
            "type":"string",
            "description":"Raised By"
        },
        "filler1":{
            "type":"string",
            "description":"Filler 1"
        },
        "filler2":{
            "type":"string",
            "description":"Filler 2"
        },
        "filler3":{
            "type":"string",
            "description":"Filler 3"
        },
        "filler4":{
            "type":"string",
            "description":"Filler 4"
        },
        "filler5":{
            "type":"string",
            "description":"Filler 5"
        },
        "filler6":{
            "type":"string",
            "description":"Filler 6"
        },
        "reasonForExport":{
            "type":"string"
        },
        "poTransactionRefNo":{
            "type":"string",
            "description":"Po Transaction Ref Number"
        },
        "channel":{
            "type":"string",
            "description":"channel"
        },
        "sourceTxnId":{
            "type":"string",
            "description":"sourceTxnId"
        }
    }
}

Nested Schema : commodityList

Type: array

Show Source

• Array of: object PoComServiceDTO

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

Nested Schema : PoComServiceDTO

Type: object

Show Source

• commodityCode(optional): string
  Commodity Code
• commodityName(optional): string
  Commodity Name
• currency(optional): string
  CCY for commodity
• discountAmount(optional): number
  Dsicount Amt for Commodity
• discountPercent(optional): number
  Discount percent for Commodity
• goodsDescription(optional): string
  Description of Commodity
• id(optional): string
  Id to modify
• netCost(optional): number
  Net Cost of Commodity
• quantity(optional): number
  Quantity of Commodity
• taxAmount(optional): number
  Tax Amount of Commodity
• taxPercent(optional): number
  Tax Percent of Commodity
• totalCost(optional): number
  Total Cost Of Commodity
• totalWeight(optional): number
  Total Weight of Commodity
• unit(optional): string
  Unit of Commodity
• unitCost(optional): number
  Unit Cost of Commodity
• unitWeight(optional): number
  Unit wight Of Commodity

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id to modify"
        },
        "commodityCode":{
            "type":"string",
            "description":"Commodity Code"
        },
        "commodityName":{
            "type":"string",
            "description":"Commodity Name"
        },
        "currency":{
            "type":"string",
            "description":"CCY for commodity"
        },
        "discountAmount":{
            "type":"number",
            "description":"Dsicount Amt for Commodity"
        },
        "discountPercent":{
            "type":"number",
            "description":"Discount percent for Commodity"
        },
        "goodsDescription":{
            "type":"string",
            "description":"Description of Commodity"
        },
        "netCost":{
            "type":"number",
            "description":"Net Cost of Commodity"
        },
        "quantity":{
            "type":"number",
            "description":"Quantity of Commodity"
        },
        "taxAmount":{
            "type":"number",
            "description":"Tax Amount of Commodity"
        },
        "taxPercent":{
            "type":"number",
            "description":"Tax Percent of Commodity"
        },
        "totalCost":{
            "type":"number",
            "description":"Total Cost Of Commodity"
        },
        "totalWeight":{
            "type":"number",
            "description":"Total Weight of Commodity"
        },
        "unit":{
            "type":"string",
            "description":"Unit of Commodity"
        },
        "unitCost":{
            "type":"number",
            "description":"Unit Cost of Commodity"
        },
        "unitWeight":{
            "type":"number",
            "description":"Unit wight Of Commodity"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Po Response

Body ()

Root Schema : PoServiceListResponse

Type: object

Collection of po response.

Show Source

• data(optional): array data

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

Nested Schema : data

Type: array

Show Source

• Array of: object PoServiceResponse

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

Nested Schema : PoServiceResponse

Type: object

Show Source

• buyerId(optional): string
  Buyer Id
• errors(optional): array errors
  Error List
• poExternalNumber(optional): string
  Po External Number
• poInternalNumber(optional): string
  Po Internal Number
• poStatus(optional): string
  Po Status
• poTransactionRefNo(optional): string
  Po Transaction Ref Number
• processStatus(optional): string
  Process Status
• sourceTxnId(optional): string
  sourceTxnId

{
    "type":"object",
    "properties":{
        "poInternalNumber":{
            "type":"string",
            "description":"Po Internal Number"
        },
        "poExternalNumber":{
            "type":"string",
            "description":"Po External Number"
        },
        "buyerId":{
            "type":"string",
            "description":"Buyer Id"
        },
        "poStatus":{
            "type":"string",
            "description":"Po Status"
        },
        "processStatus":{
            "type":"string",
            "description":"Process Status"
        },
        "poTransactionRefNo":{
            "type":"string",
            "description":"Po Transaction Ref Number"
        },
        "sourceTxnId":{
            "type":"string",
            "description":"sourceTxnId"
        },
        "errors":{
            "type":"array",
            "description":"Error List",
            "items":{
                "$ref":"#/definitions/ErrorDto"
            }
        }
    }
}

Nested Schema : errors

Type: array

Error List

Show Source

• Array of: object ErrorDto

{
    "type":"array",
    "description":"Error List",
    "items":{
        "$ref":"#/definitions/ErrorDto"
    }
}

Nested Schema : ErrorDto

Type: object

Show Source

• errorCode(optional): string
  Error Codes Displaying
• errorDesc(optional): string
  Error Description displaying based on error codes

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Codes Displaying"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Description displaying based on error codes"
        }
    }
}

400 Response

Bad Request

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