Function
The get function of the PO Main can be used to search the databases for POs based on a variety of parameters.
URL: {Root URL}/api/PO/Get/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| poNum |
Purchase Order Number |
N |
|
| supName |
Supplier Name |
N |
Name of the supplier the PO is going to. |
| uniqSupNo |
Unique Supplier Identifier Number |
N |
Can be used in place of supplier name |
| partNo |
Part Number |
N |
Find Purchase Orders containing the part number |
| revision |
Part Revision |
N |
Used alongside part number |
| uniqKey |
Part Unique Identifier |
N |
Used in place of part number and revision |
| uniqlnno |
Unique |
N |
|
| poStatus |
Purchase Order Status |
N |
Can be Open, Cancelled, Closed |
| mfgrPtNo |
Manufacturer Part Number |
N |
|
| partmfgr |
Part Manufacturer |
N |
|
| withBalance |
|
N |
|
| received |
PO Received or Not |
N |
Can be true or false |
| scheduledPriorTo |
POs Scheduled Before Date |
N |
Use MM-DD-YYYY format |
Example Strings
Purchase Order Get
URL-?PoNum=PONUM
JSON
A successful request should result in the following
{
$id: "1",
Code: 200,
Message: "Purchase Order details:",
SessionId: null,
IsValidUser: true,
-ResponseObject: [
{
$id: "2",
PONUM: "000000000001745",
PODATE: "2014-09-18T10:40:00",
POSTATUS: "OPEN",
CONUM: 0,
VERDATE: "2014-10-28T16:38:00",
BUYER: "",
APPVNAME: "T1000",
FINALNAME: "T1000",
POTAX: 0,
POTOTAL: 25,
TERMS: "NET 30/2% 10",
PONOTE: "",
POFOOTER: "",
CLOSDDATE: null,
IS_PRINTED: true,
C_LINK: "_1D50WHB6G",
R_LINK: "_1D50WGLC4",
I_LINK: "_0TG0WZ7T2",
B_LINK: "_3I30XB5DF",
SHIPCHG: 1,
IS_SCTAX: true,
SCTAXPCT: 8.25,
CONFNAME: "",
CONFIRMBY: "",
SHIPCHARGE: "",
FOB: "ORIGIN-CUST P/U",
SHIPVIA: "CUST PICK UP",
DELTIME: "12:00",
ISINBATCH: false,
RECONTODT: 0,
ARCSTAT: "",
POPRIORITY: "Standard",
POACKNDOC: "",
VERINIT: "T1000",
UNIQSUPNO: "_1D50WFSWT",
POCHANGES: "New PO created by User: T1000, on 09/18/2014 10:39:34, PO Total: $25.00",
LFREIGHTINCLUDE: false,
POUNIQUE: "_45Z0MUI59",
CurrChange: "",
Acknowledged: false,
RecVer: "AAAAAAAuqVI=",
Supname: "Anixter",
Status: "APPROVED",
SUP_TYPE: "DISTRIBUTOR",
Supid: "0000000003"
}
]
}
Common Errors
Incorrect Parameters
If incorrect parameters are used the system will return the following
{
"$id": "1",
"Code": 403,
"Message": "Purchase Order details failed:",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
Not Enough Information
If the information provided is not enough to pull purchase order details the system will return
{
"$id": "1",
"Code": 403,
"Message": "Purchase Order details failed:Not enough information to return the data, please provide valid parameters.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
