The PO add function is used to add a new PO. An Item must be added to the PO tables as well. Scheduling does not need to be added at this point.
URL-{Root URL}/api/PO/Edit/{API KEY}
Parameters
| Parameter |
Description |
Required |
Comment |
| supName |
Supplier Name |
Y |
|
| confirmName |
Confirm Name |
N |
User Input, No validation |
| poDate |
Purchase order date. |
N |
If not entered manually will default to today’s date |
| FreightIncluded |
Freight Included |
N |
Can be 1 or 0, default is 0. |
| buyerName |
Name of the Buyer |
N |
Has to be entered in the following format [LastName, FirstName]. Must be a buyer in the system. |
| remitToLink |
The link to the Remit to address
|
N |
If entered it must be a valid link. |
| confirmToLink |
The link to the Confirm to Address |
N |
|
| receiveToLink |
The link to the receiving address |
N |
If entered it must be a valid link |
| deliveryTime |
The delivery time for the receiving address |
N |
Must be in a 24 hour format, e.g. ‘13:00’ |
| Terms |
Payment terms for the supplier. |
N |
Can be NET 10, NET 15, NET 30, NET 30/2% 10, NET 45, COD, NONE |
| FOB |
|
N |
|
| shipVia |
The method of shipping |
N |
|
| shipCharge |
|
N |
|
| shippingAmount |
|
N |
Default 0, Entered manually |
| isShippingTaxable |
Choose whether or not the shipping is taxable |
N |
Can be 0 or 1, default 0 |
| shippingTaxPct |
The amount of the shipping tax |
N |
Default 0.00. If a value is entered here isShippingTaxable must be set as 1 |
| billToLink |
This links the record to the supplier's billing address. |
N |
If entered it has to be a valid link. |
Example Strings
PO Add String
URL-?poNUM=PONUMBER&supName=SUPPLIERNAME&POUNIQUE=POUNIQUE
JSON
{
'PoNUM':'PONUMBER',
'supName':'SUPPLIERNAME',
'POUNIQUE':'POUNIQUE',
}
A successful request should result in
{
$id: "1",
Code: 200,
Message: "Purchase Order edited successfully.",
SessionId: null,
IsValidUser: true,
ResponseObject: null
}
Common Errors
Incorrect Parameters
If there is an error with an entered parameter the system should return a message detailing which parameter there is a problem with.
{
"$id": "1",
"Code": 403,
"Message": "Purchase Order edit failed.UniqSupNo does not exists in SUPINFO Table.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
JSON Error
If there is an error in the JSON string the system will return the following error message.
{
"$id": "1",
"Code": 403,
"Message": "'Purchase Order' Object is not initialized properly.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|