| 1. Purchase Order API | | Purchase Order API allows you to easily interact with purchase orders outside of the ManEx Applications. There are three different levels of the PO API, this allows you to specifically interact with the different aspects of the PO without having to rework all parts. The three different levels are PO main, PO item, and PO item schedule. |
| 1.1. PO Main API | Purchase Order API allows you to easily interact with purchase orders outside of the ManEx Applications. There are three different levels of the PO API, this allows you to specifically interact with the different aspects of the PO without having to rework all parts. The three different levels are PO main, PO item, and PO item schedule.
|
| 1.1.1. PO Main Add |
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/Add/{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. |
| POItemsList | | N | | | POITTYPE | Purchase Order Item Type
| Y | Can be INVT PART, MRO, or Services
| part_no
| Part Number
| Y
| Used to choose a part
| UNIQ_KEY
| Part Identifier Key
| N
| Can be used instead of part number and revision
| | Rev | Part Revision
| N | Required if Part_no is used
| | UniqMfgrhd | Manufacturer Key
| N | Can be used in place of partmfgr and mfgr_pt_no | | PARTMFGR | Part Manufacturer
| N | Can be used to specify a manufacturer for a part. Must be an existing manufacturer for the part | | MFGR_PT_NO | Manufacturer Part Number
| N | Can be used instead of part_no to choose an item | | ORD_QTY | Order Qty
| Y | The amount ordered
| | PoitschdList | | N | | | SCHD_QTY | Scheduled Qty
| N | Must be equal to or less than order quantity | | SCHD_DATE | Schedule Date | N | Will default to current date or enter in MM-DD-YYYY format |
Example PO Add String-
URL-{Root URL}/api/PO/Add/{API Key}
JSON
{
"supName":supName", "PoItemsList": [{
"POITTYPE":"POITTYPE", "UNIQ_KEY":"UNIQ_KEY", "part_no":"part_no",
"Rev":"Rev", "UniqMfgrhd":"UniqMfgrhd",
"PARTMFGR":"PARTMFGR", "MFGR_PT_NO":"MFGR_PT_NO", "ORD_QTY":"ORD_QTY",
"PoitschdList": [{ "SCHD_QTY":"SCHD_QTY", "SCHD_DATE":"SCHD_DATE"
}] }] }
|
| 1.1.2. PO Main Edit |
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
}
|
| 1.1.3. PO Main Get |
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
}
|
| 1.2.1. PO Item Add |
Functions
Item Add API is used to add items to existing Purchase Orders.
URL-{Root URL}/API/PO/ItemAdd/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| POITTYPE |
Purchase Order Item Type |
Y |
Can be INVT PART, MRO, or Services |
| part_no |
Part Number |
Y |
Used to choose a part |
| revision |
Part Revision |
N |
Required if Part_no is used |
| uniq_key |
Part Identifier Key |
N |
Can be used in place of part number and revision |
| partmfgr |
Part Manufacturer |
N |
Can be used to specify a manufacturer for a part. Must be an existing manufacturer for the part |
| mfgr_pt_no |
Manufacturer Part Number |
N |
Can be used instead of part_no to choose an item |
| uniqmfgrhd |
Manufacturer Key |
Y |
Can be used in place of partmfgr and mfgr_pt_no |
| uniqmfsp |
|
N |
|
| overage |
overage |
N |
Percentage of parts that can be received over the ordered qty. |
| package |
Package |
N |
The item's package size. Can be AMMO BELT, BULK, CARTON, EACH, REAM, REEL, TRAY, TUBE |
| updatePLT |
Update Purchase Lead Time |
N |
|
| pur_ltime |
Purchase Lead Time |
N |
Must be numerical, followed by DY, WK, Mo |
| updateMinOrdMult |
Update Minimum/Multi order values. |
N |
|
| minorder |
Minimum Order |
N |
Minimum amount required per order. |
| ordmult |
Multiple Order |
N |
Amount that must be ordered over the min order. |
| COSTEACH |
Cost Each |
N |
Cost of each ordered |
| ORD_QTY |
Order Quantity |
Y |
The amount ordered |
| updateMaterialCost |
Update Material Cost |
N |
|
| updateTargetPrice |
Update Target Price |
N |
|
| IS_TAX |
It the PO taxable |
N |
|
| ISFIRM |
Is Firm Planned |
N |
Selects if the order is firm planned, preventing the MRP from overwriting it. |
| FIRSTARTICLE |
First Article Inspection |
N |
Does the PO require first article inspaction |
| supplierPartNumber |
Supplier Part Number |
N |
|
| INSPEXCNOTE |
Inspection Exception Note |
N |
|
| INSPEXCDOC |
Inspection Exception Code |
N |
|
| PUR_UOFM |
Purchase Unit of Measurement |
N |
|
| U_OF_MEAS |
Unit of Measurement |
N |
Can be EACH, IN, DOZ, REEL, LOT, BULK, SQIN, SQFT, SQYD, SQMM, SQCM, SQME, GRAM, KGRM, MLTR, LITR, CC, OUNC, PINT, QUAR, GAL, M, FT, CM, LB, YARD |
Example Strings
Add Item
Url-?poNum=PONUMBER&POITTYPE=INVT PART&part_no=PARTNUMBER&revision=REVISION&uniqmfgrhd=UNIQMFGRHD
JSON
{
'poNum':'PONUMBER',
'POITTYPE':'INVT PART',
'part_no':'PARTNUMBER',
'revision':'REVISION',
'uniqmfgrhd':'UNIQMFGRHD'
}
A successful request should result in
{
$id: "1",
Code: 200,
Message: "PO Items added successfully.",
SessionId: null,
IsValidUser: true,
-ResponseObject: {
$id: "2",
UNIQLNNO: "65ENDLS6VN",
PONUM: "1748",
UNIQ_KEY: "_45Z0YNRSR",
ITEMNO: "002",
COSTEACH: 0,
ORD_QTY: 0,
RECV_QTY: 0,
REJ_QTY: 0,
ACPT_QTY: 0,
NOTE1: "",
IS_TAX: false,
TAX_PCT: 0,
IS_CONTR: false,
OVERAGE: 5,
POITTYPE: "INVT PART",
L_PRINT: false,
NO_PKG: 0,
PART_NO: "416-242424",
REVISION: "",
DESCRIPT: "",
PARTMFGR: "GENR",
MFGR_PT_NO: "416-242424",
PACKAGE: "EACH",
PART_CLASS: "",
PART_TYPE: "",
U_OF_MEAS: "EACH"
,
PUR_UOFM: "EACH",
S_ORD_QTY: 0,
ISFIRM: false,
UNIQMFGRHD: "_45Z0YOITA",
FIRSTARTICLE: false,
INSPEXCEPT: false,
INSPEXCEPTION: "",
INSPEXCINIT: "",
INSPEXCDT: null,
INSPEXCNOTE: "",
INSPEXCDOC: "",
LCANCEL: false,
UNIQMFSP: "",
INSPECTIONOTE: "",
lRemvRcv: false,
UNIQSUPNO: "_1D50WFSWT",
pur_ltime: 0,
pur_lunit: "",
updatePLT: false,
minorder: 0,
ordmult: 0,
updateMinOrdMult: false,
updateMaterialCost: false,
Targetprice: 0,
updateTargetPrice: false,
supplierPartNumber: "",
PoitschdList: [ ]
}
}
Common Error Messages
JSON Error
If there is an error with the setup of the JSON string (such as a misplaced comma or other punctuation) the system will return the following error.
{
"$id": "1",
"Code": 403,
"Message": "'PO Items' Object is not initialized properly.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
Parameter Error
If there is an error with an individual parameter the system will return an error message describing the error
{
"$id": "1",
"Code": 403,
"Message": "PO Items add failed.UniqMfgrhd is Invalid.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
| 1.2.2. PO Item Edit |
Functions
URL-{Root URL}/API/PO/ItemEdit/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| poNum |
Purchase Order Number |
Y |
|
| uniqueLnNo |
Unique PO Item Identifier |
Y |
|
| POITTYPE |
Purchase Order Item Type |
Y |
Can be INVT PART, MRO, or Services |
| part_no |
Part Number |
Y |
Used to choose a part |
| revision |
Part Revision |
N |
Required if Part_no is used |
| uniq_key |
Part Identifier Key |
N |
Can be used in place of part number and revision |
| partmfgr |
Part Manufacturer |
N |
Can be used to specify a manufacturer for a part. Must be an existing manufacturer for the part |
| mfgr_pt_no |
Manufacturer Part Number |
N |
Can be used instead of part_no to choose an item |
| uniqmfgrhd |
Manufacturer Key |
Y |
Can be used in place of partmfgr and mfgr_pt_no |
| uniqmfsp |
|
N |
|
| overage |
overage |
N |
Percentage of parts that can be received over the ordered qty. |
| package |
Package |
N |
The item's package size. Can be AMMO BELT, BULK, CARTON, EACH, REAM, REEL, TRAY, TUBE |
| updatePLT |
Update Purchase Lead Time |
N |
|
| pur_ltime |
Purchase Lead Time |
N |
Must be numerical, followed by DY, WK, Mo |
| updateMinOrdMult |
Update Minimum/Multi order values. |
N |
|
| minorder |
Minimum Order |
N |
Minimum amount required per order. |
| ordmult |
Multiple Order |
N |
Amount that must be ordered over the min order. |
| COSTEACH |
Cost Each |
N |
Cost of each ordered |
| ORD_QTY |
Order Quantity |
Y |
The amount ordered |
| updateMaterialCost |
Update Material Cost |
N |
|
| updateTargetPrice |
Update Target Price |
N |
|
| IS_TAX |
It the PO taxable |
N |
|
| ISFIRM |
Is Firm Planned |
N |
Selects if the order is firm planned, preventing the MRP from overwriting it. |
| FIRSTARTICLE |
First Article Inspection |
N |
Does the PO require first article inspaction |
| supplierPartNumber |
Supplier Part Number |
N |
|
| INSPEXCNOTE |
Inspection Exception Note |
N |
|
| INSPEXCDOC |
Inspection Exception Code |
N |
|
| PUR_UOFM |
Purchase Unit of Measurement |
N |
|
| U_OF_MEAS |
Unit of Measurement |
N |
Can be EACH, IN, DOZ, REEL, LOT, BULK, SQIN, SQFT, SQYD, SQMM, SQCM, SQME, GRAM, KGRM, MLTR, LITR, CC, OUNC, PINT, QUAR, GAL, M, FT, CM, LB, YARD |
Example Strings
Add Item
Url-?poNum=PONUMBER&UNIQLNNO=UNIQLNNO&costeach=10&ord_qty=1'
JSON
{
'poNum':'PONUMber',
'UNIQLNNO':'UNIQLNNO',
'costeach':'10',
'ord_qty':'1'
}
A successful request should result in
{
$id: "1",
Code: 200,
Message: "PO Items edited successfully.",
SessionId: null,
IsValidUser: true,
ResponseObject: null
}
Common Error Messages
JSON Error
If there is an error with the setup of the JSON string (such as a misplaced comma or other punctuation) the system will return the following error.
{
"$id": "1",
"Code": 403,
"Message": "'PO Items' Object is not initialized properly.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
Parameter Error
If there is an error with an individual parameter the system will return an error message describing the error
{
"$id": "1",
"Code": 403,
"Message": "PO Items add failed.UniqMfgrhd is Invalid.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
| 1.2.3. PO Item Delete |
Functions
PO Delete Item API is used to remove existing items from Purchase Orders.
URL-{Root URL}/API/PO/ItemDelete/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| PoNum |
Purchase Order Number |
Y |
|
| itemNumber |
Item Number |
N |
Used to choose which item to delete from the PO |
| part_no |
Part Number |
N |
Used to choose which item to delete from the PO |
| revision |
Part Revision |
N |
Used with Part_no to choose an item. |
| uniq_key |
Part Unique Identifier |
N |
Can be used instead of part_no and revision |
| partMfgr |
Part Manufacturer |
N |
Can be used to choose item to delete from PO by part manufacturer |
| mfgr_pt_no |
Manufacturer Part Number |
N |
Used with partMfgr. |
| uniqmfgrhd |
Unique manufacturer part identifier |
N |
Can be used in place of mfgr_pt_no and uniqmfgrhd |
| uniqlnno |
Unique PO item Identifier |
N |
Can be used in place of part_no or partMfgr |
Example Strings
Delete Item
URL-?PoNum=PONUMBER&UNIQLNNO=UNIQLNNO
JSON
{
'poNum':'PONUMBER'
'UNIQLNNO':'UNIQLNNO'
}
A successful request should return
{
$id: "1",
Code: 200,
Message: "PO Items deleted successfully.",
SessionId: null,
IsValidUser: true,
ResponseObject: null
}
Common Errors
Incorrect Parameter
If a parameter is incorrect the system will return an error message describing the error
{
"$id": "1",
"Code": 403,
"Message": "PO Items delete failed.Po Item does not exists.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
URL Error
If there is an error with the URL the system will return the following error message
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/PO/ItemDelet/123456789'.",
"MessageDetail": "No action was found on the controller 'Po' that matches the name 'ItemDelet'."
}
|
| 1.2.4. PO Item Get API |
Functions
PO Item Get API is used to get information about the items on existing Purchase Orders
URL-{Root URL}/PO/ItemGet/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| poNum |
Purchase Order Number |
N |
|
| supplierName |
Supplier Name |
N |
Can be used to sort POs by supplier |
| uniqsupno |
Supplier Identification Number |
N |
Can be used in place of supplier name |
| partNo |
Part Number |
N |
Can be used to sort POs by part |
| revision |
Part Revision |
N |
Used alongside partNo |
| uniqKey |
Part Unique Identifier |
N |
Can be used in place of art number and revision |
| uniqlnno |
|
N |
|
| poStatus |
Purchase Order Status |
N |
Can be Open, Cancelled, Closed |
| mfgrPtNo |
Manufacturer Part Number |
N |
Can be used to sort POs by manufacturer part number |
| partmfgr |
Part Manufacturer |
N |
Can be used to sort POs by Manufacturer |
| withBalance |
POs with Balace |
N |
Can be true or false |
| received |
PO Received |
N |
Can be true or false |
| scheduledPriorTo |
|
|
|
Example Strings
Get Item
URL-?PoNum=PONUMBER
JSON
A successful request should return
{
$id: "1",
Code: 200,
Message: "PO Items details:",
SessionId: null,
IsValidUser: true,
-ResponseObject: [
-{
$id: "2",
UNIQLNNO: "_1ZM0LAXRD",
PONUM: "000000000001749",
UNIQ_KEY: "_4750SWEOD",
ITEMNO: "001",
COSTEACH: 0.88,
ORD_QTY: 100,
RECV_QTY: 0,
REJ_QTY: 0,
ACPT_QTY: 0,
NOTE1: "",
IS_TAX: false,
TAX_PCT: 0,
IS_CONTR: false,
OVERAGE: 5,
POITTYPE: "Invt Part",
L_PRINT: false,
NO_PKG: 0,
DESCRIPT: "",
PARTMFGR: "GENR",
MFGR_PT_NO: "",
PACKAGE: "BULK",
PART_CLASS: "",
PART_TYPE: "",
U_OF_MEAS: "EACH",
PUR_UOFM: "EACH",
S_ORD_QTY: 100,
ISFIRM: false,
UNIQMFGRHD: "_4750SXAYM",
FIRSTARTICLE: false,
INSPEXCEPT: false,
INSPEXCEPTION: "",
INSPEXCINIT: "",
INSPEXCDT: null,
INSPEXCNOTE: "",
INSPEXCDOC: "",
LCANCEL: false,
UNIQMFSP: "",
INSPECTIONOTE: "",
lRemvRcv: false,
POSTATUS: "OPEN",
PODATE: "2014-10-31T13:49:00",
Part_No: "416-110989",
Revision: "b",
Part_Sourc: "BUY",
Supname: "Romp",
Status: "APPROVED",
SUP_TYPE: "INDEPENDENT REP",
Supid: "0000000005"
}
]
}
Common Errors
Not Enough Information
If there is not enough data provided or the parameters provided are invalid to retrieve the PO information the system will return the following error message.
{
"$id": "1",
"Code": 403,
"Message": "PO Items details failed:Not enough information to return the data, please provide valid parameters.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
| 1.3.1. PO Schedule Add |
Functions
Schedule add API is used to add scheduling information to existing Purchase Orders.
URL-{Root URL}/API/PO/ScheduleAdd/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| poNum |
Purchase Order Number |
Y |
|
| uniqLnNo |
PO Unique item identifier |
Y |
|
| schd_date |
Schedule Date |
N |
Will default to current date or enter in MM-DD-YYYY format. |
| req_date |
Required Date |
N |
Will default to current date or enter in MM-DD-YYYY format. |
| schd_qty |
Scheduled Quantity |
Y |
Must be equal to or less than order quantity. |
| warehouse |
Warehouse |
N |
Warehouse where the item will be received into |
| location |
Warehouse Location |
N |
Used with warehouse to designate a location. |
| origcommitdt |
Commit Date |
N |
Will default to current date or enter in MM-DD-YYYY Format. |
| schdNotes |
Schedule Notes |
N |
Can be used to attach a schedule note to the PO. |
Example Strings
Add Schedule Information
URL-?poNum=PONUMBER&uniqLnNo=UNIQLNNO&SCHD_DATE=MM-DD-YYYY&REQ_DATE=MM-DD-YYYY&SCHD_QTY=QTY&Warehouse=WAREHOUSE&LOCATION=LOCATION&ORIGCOMMITDT=MM-DD-YYYY&SCHDNOTES=NOTE
JSON
{
'poNum':'PONUMBER',
'uniqLnNo':'UNIQLNNO',
'SCHD_DATE':'MMM-DD-YYYY',
'REQ_DATE':'MMM-DD-YYYY',
'SCHD_QTY':'QTY',
'Warehouse':'WAREHOUSE',
'LOCATION':'LOCATION',
'ORIGCOMMITDT':'MMM-DD-YYYY',
'SCHDNOTES':'NOTE'
}
A successful add should result in
{
$id: "1",
Code: 200,
Message: "PO Schedule added successfully.",
SessionId: null,
IsValidUser: true,
-ResponseObject: {
$id: "2",
UNIQDETNO: "O2YHUQB45I",
UNIQLNNO: "_47A0PHH67",
SCHD_DATE: "2014-11-07T00:00:00",
REQ_DATE: "2014-11-07T00:00:00",
SCHD_QTY: 5,
RECDQTY: 0,
BALANCE: 5,
GL_NBR: "",
REQUESTTP: "Invt Recv",
REQUESTOR: "",
UNIQWH: "",
LOCATION: "",
WOPRJNUMBER: "",
COMPLETEDT: null,
PONUM: "1751",
ORIGCOMMITDT: "2014-11-04T00:00:00",
SCHDNOTES: "test",
UNIQMFGRHD: "_44Y0X2L9H",
UNIQ_KEY: "_44Y0WP6H4",
WAREHOUSE: "MAIN1",
ORD_QTY: 0,
RECV_QTY: 0,
POITTYPE: "Invt Part",
ITEMNO: null,
PART_NO: null,
REVISION: null,
PARTMFGR: null,
MFGR_PT_NO: null
}
}
Common Errors
API Key Error
If there is an error with the API key the system will return an error message describing it.
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
URL Error
If there is an error with the URL the system will return a HTTP not found error.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/POScheduleAdd/123456789'.",
"MessageDetail": "No type was found that matches the controller named 'POScheduleAdd'."
}
Schedule Add Failed
If the used parameter is invalid or the record being retrieved no longer exists the system will return a Schedule Details Failed message.
{
"$id": "1",
"Code": 403,
"Message": "PO Schedule add failed.An error occurred while executing the command definition. See the inner exception for details.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
| 1.3.2. PO Schedule Edit |
Functions
Schedule Edit API is used to edit scheduling information in Purchase Orders.
URL-{Root URL}/API/PO/ScheduleEdit/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| poNum |
Purchase Order Number |
Y |
|
| uniqDetNo |
PO Schedule Identifier |
Y |
|
| schd_date |
Schedule Date |
N |
Will default to current date or enter in MM-DD-YYYY format. |
| req_date |
Required Date |
N |
Will default to current date or enter in MM-DD-YYYY format. |
| schd_qty |
Scheduled Quantity |
Y |
Must be equal to or less than order quantity. |
| warehouse |
Warehouse |
N |
Warehouse where the item will be received into |
| location |
Warehouse Location |
N |
Used with warehouse to designate a location. |
| origcommitdt |
Commit Date |
N |
Will default to current date or enter in MM-DD-YYYY Format. |
| schdNotes |
Schedule Notes |
N |
Can be used to attach a schedule note to the PO. |
Example Strings
Edit Schedule Qty
URL-?poNum=PONUMBER&uniqDetNo=UNIQDETNO&SCHD_QTY=QTY
JSON
{
'poNum':'PONUMBER',
'uniqLnNo':'UNIQLNNO',
'SCHD_QTY':'QTY',
}
A successful add should result in
{
$id: "1",
Code: 200,
Message: "PO Schedule edited successfully.",
SessionId: null,
IsValidUser: true,
ResponseObject: null
}
Common Errors
API Key Error
If there is an error with the API key the system will return an error message describing it.
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
URL Error
If there is an error with the URL the system will return a HTTP not found error.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/POScheduleAdd/123456789'.",
"MessageDetail": "No type was found that matches the controller named 'POScheduleAdd'."
}
Missing Parameter
If there is a missing required parameter the system will return an error detailing which parameter is required.
{
"$id": "1",
"Code": 403,
"Message": "PO Schedule edit failed.UNIQDETNO is required.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
| 1.3.3. PO Schedule Delete |
Functions
Schedule Edit API is used to delete scheduling information in Purchase Orders.
URL-{Root URL}/API/PO/ScheduleDelete/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| poNum |
Purchase Order Number |
Y |
|
| uniqDetNo |
PO Schedule Identifier |
Y |
|
Example Strings
Edit Schedule Qty
URL-?poNum=PONUMBER&uniqDetNo=UNIQDETNO
JSON
{
'poNum':'PONUMBER',
'uniqLnNo':'UNIQLNNO',
}
A successful add should result in
{
$id: "1",
Code: 200,
Message: "PO Schedule deleted successfully.",
SessionId: null,
IsValidUser: true,
ResponseObject: null
}
Common Errors
API Key Error
If there is an error with the API key the system will return an error message describing it.
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
URL Error
If there is an error with the URL the system will return a HTTP not found error.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/PO/ScheduleDelet/123456789'.",
"MessageDetail": "No action was found on the controller 'Po' that matches the name 'ScheduleDelet'."
}
Schedule Delete Failed
If the used parameter is invalid or the record being retrieved no longer exists the system will return a Schedule Details Failed message.
{
"$id": "1",
"Code": 403,
"Message": "PO Schedule delete failed.An error occurred while executing the command definition. See the inner exception for details.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
| 1.3.4. PO Schedule Get |
Functions
PO Schedule Get API is used to view scheduling information for items on the Purchase Orders.
URL-{Root URL}/API/PO/ScheduleGet/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| poNum |
Purchase Order Number |
Y |
|
| uniqLnNo |
Unique PO Item Identifier Number |
Y |
|
Example Strings
Get Schedule
URL-
?poNum=PONUMBER
JSON
Successful results should result in.
{
$id: "1",
Code: 200,
Message: "PO Schedule details:",
SessionId: null,
IsValidUser: true,
ResponseObject: [
{
$id: "2",
UNIQDETNO: "_44Z0M6ZZW",
UNIQLNNO: "_44Z0M4ZD2",
SCHD_DATE: "2014-09-03T00:00:00",
REQ_DATE: "2014-09-03T00:00:00",
SCHD_QTY: 1,
RECDQTY: 100,
BALANCE: -99,
GL_NBR: "1315000-00-00",
REQUESTTP: "Invt Recv ",
REQUESTOR: " ",
UNIQWH: "_0DM120YNM",
LOCATION: "s4r1 ",
WOPRJNUMBER: " ",
COMPLETEDT: null,
PONUM: "000000000001724",
ORIGCOMMITDT: "2014-09-03T00:00:00",
SCHDNOTES: "",
UNIQMFGRHD: null,
UNIQ_KEY: null,
WAREHOUSE: null,
ORD_QTY: 0,
RECV_QTY: 0,
POITTYPE: null,
ITEMNO: null,
PART_NO: null,
REVISION: null,
PARTMFGR: null,
MFGR_PT_NO: null
}
]
}
Common Errors
API Key Error
If there is an error with the API key the system will return an error message describing it.
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
URL Error
If there is an error with the URL the system will return a HTTP not found error.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/POScheduleGet/123456789?poNum=410'.",
"MessageDetail": "No type was found that matches the controller named 'POScheduleGet'."
}
Detail Get Failed
If the used parameter is invalid or the record being retrieved no longer exists the system will return a Schedule Details Failed message.
{
"$id": "1",
"Code": 403,
"Message": "PO Schedule details failed:",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
|