Get |
Functions
Get Item Price is used to view price information of a sales order.
URL-{Root URL}/API/SO/PriceGet/{API Key}
Parameters
Parameter |
Description |
Required |
Comment |
SoNo |
Sales Order Number |
Y |
|
price |
Sales Order Price |
Y |
|
taxable |
Is the SO Taxable |
N |
Can be 'true' or 'false' |
flat |
|
|
|
recordType |
|
|
|
saleTypeID |
Sales Type ID |
N |
Can be 'CABLE/Harn', 'CONSULTING', 'LABOR', 'OTHER', 'PC ASSEMB.', 'PRIORITY', 'REPAIR', 'RESTOCKING', 'REWORK', 'SPARE PART', 'STENCILS', 'SYSTEM' |
extended |
|
|
|
uniqueLn |
Unique Sales Order item identifier
|
Y |
Must be unique. |
plpricelink |
Price Link Key |
N |
Must be unique. |
Example Strings
Add Price
URL-?UNIQUELN=UNIQUELN
JSON
{
'UNIQUELN':'UNIQUELN',
}
A successful request should return.
{
$id: "1",
Code: 200,
Message: "Sales Order Price details:",
SessionId: null,
IsValidUser: true,
-ResponseObject: {
$id: "2",
PLPRICELNK: "GAWG8ODL6Q",
SONO: "0000000789",
DESCRIPTIO: "Loud ",
QUANTITY: 0,
PRICE: 1,
EXTENDED: 0,
TAXABLE: false,
FLAT: false,
RECORDTYPE: "P",
SALETYPEID: "RESTOCKING",
UNIQUELN: "A6WDVN62YM",
PL_GL_NBR: "4050000-00-00",
COG_GL_NBR: "5090000-00-00",
OrigPluniqLnk: " "
}
}
Common Errors
API Key Error
If there is an error with the API key the system will return an error message.
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
URL Error
If there is an error with the entered URL has an error the system will return a "HTTP Resource not found" message.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SOPriceGet/23456789'.",
"MessageDetail": "No type was found that matches the controller named 'SOPriceGet'."
}
Parameter Error
If one of the entered parameters is invalid the system will fail to add the item price.
{
"$id": "1",
"Code": 403,
"Message": "Sales Order Price does not exists.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
|