Worksheet (Detail)

A Worksheet in cieTrade.net is a logistical event such as a received load (Purchase Receipt "PR"), a brokerage transaction (Buy/sell between 2 external parties), or an inventory shipment. Worksheet details represent the commodities, grades or products that are received and/or sold on the worksheet including product name, quantity, pricing, amount extensions, product attributes, sales and purchase order references, etc.

ListWorksheetDetails Example

https://api.cietrade.net/ListWorksheetDetails?UserID=Example@cieTrade.com&UserPwd=ASDF123&DateFrom=&DateTo=&TradeType=&Status=&DateType=&Customer=&Supplier=&InvType=&Warehouse=&CustLoc=&SuppLoc=&Dept=&WorksheetNo=514243<br>

Query Parameters (Filters)

UserID	cieTrade.net User Name.	Required
UserPwd	cieTrade.net User Password.	Required
DateType	Determines how to filter results using the DateFrom and DateTo dates parameters (below). INV=Invoice-Date SHIP=Ship-Date ASOF=Returns all worksheets with a shipping date on or after the DateFrom parameter.	Optional
DateFrom	Beginning date range date based on the DateType parameter (above). If left blank will default to the past 30 days.	Optional
DateTo	Ending date range date based on the DateType parameter (above). If left blank will default to today's date.	Optional
Customer	Customer receiving goods. Pass the exact customer name as listed in cieTrade or the customer's account ID. Blank value defaults to all customers.	Optional
CustLoc	Ship to or receiving location of the specified customer parameter. Default value is blank which returns results for all locations.	Optional
Supplier	Supplier shipping goods. Pass the exact company name as listed in cieTrade or the supplier's account ID. Blank value defaults to all suppliers.	Optional
SupplierLoc	Shipping point or pickup location of the specified supplier parameter. Default value is blank which returns results for all locations.	Optional
InventoryType	Inventory Worksheet Type filter: RCV = Filter on receiving only SHIP=Filter on shipping only. Default value of blank includes all worksheets.	Optional
Warehouse	Warehouse Name to filter results based on when InventoryType parameter is used.	Optional
Status	Status of the Worksheet records to return worksheet details for. If left blank it will include ALL status types.	Optional
Dept	Department Filter Example: “00” as it is stored in cieTrade, or Department Short Name. This parameter is Optional, no default value if not provided.	Optional
TradeType	Worksheet trade type value to filter Worksheet detail results for. If left blank the result set will be run for ALL Trade Types.	Optional
WorksheetUDF	Filters results for worksheets where the user defined field specified using the character "x" has an exact matching value. Character x can have a value of 1 through 5. If this parameter is not used then no filter will be applied. For example: To filter results on field "UDF2" use the parameter name "WorksheetUDF2"	Optional
WorksheetNo	if provided, will return the details for this specific worksheet and override all other parameters. You do not need to include any other parameters if there is a value provided here for Worksheet.

Response Example

{
        "WorksheetNo": "514243",
        "grade_name": "#1 Copper Tubing",
        "alternate_name": "Copper Tubes",
        "sale_weight": 113.000,
        "sale_weight_uom": "L",
        "sale_price": 15.00,
        "sale_price_uom": "L",
        "purchase_weight": 113.000,
        "purchase_weight_uom": "L",
        "purchase_price": 10.00,
        "purchase_price_uom": "L",
        "sale_amount": 1695.00,
        "sale_currency": "USD",
        "purchase_amount": 1130.00,
        "purchase_currency": "USD",
        "hc_sale_amount": 1695.00,
        "hc_purchase_amount": 1130.00,
        "home_currency": "USD",
        "specifications": "BW 1lb, RW 3in, DIA 4in, LEN 6-in., Core 5in, CAL 2, CLEAR",
        "unit_type": "Containers",
        "unit_count": 0,
        "color": "CLEAR",
        "property_set": "Roll",
        "roll_basis_weight": 1.000,
        "roll_basis_weight_uom": "LB",
        "roll_caliper": "2.000",
        "roll_width": 3.000,
        "roll_width_uom": "IN",
        "roll_diameter": 4.000,
        "roll_diameter_uom": "IN",
        "roll_core_size": "5.00",
        "roll_core_size_uom": "IN",
        "roll_linear_length": "6",
        "roll_linear_length_uom": "IN",
        "plastic_type": "",
        "plastic_form": "",
        "plastic_melt": "",
        "UDF1": "",
        "UDF2": "",
        "UDF3": "",
        "UDF4": "",
        "UDF5": ""
    }




<br>