Worksheet

A Worksheet in cieTrade.net is a logistical event such as a received load (Purchase Receipt "PR"), a brokerage transaction (Buy/sell worksheet between 2 parties), or an inventory sale/shipment. On the cieTtrade.net platform, all of these type of worksheets are segmented into different dedicated pages but can be collectively reported on here with this API similar to how the "Load Manager" works where all different types of worksheets are represented together. This API returns a single row for each worksheet based on the parameters used. Note: Inventory Sales will have a supplier value of "(INV)" while inventory receipts will have a customer value of "(INV)"

This dataset provides summary financial sales, purchases, expenses and logistical information per load. It does NOT provide a list of items shipped or detailed packing lists. Shipping items can be obtained from the Trading Inquiry API inquiry. Packing lists are not currently available.

ListWorksheets Example

https://api.cietrade.net/ListWorksheets?UserID=ExampleUser@gmail.com&UserPwd=ABC123&DateFrom=7/1/2024&DateTo=7/3/2024&TradeType=METAL&Status=Work&DateType=SHIP&Customer=daktest234&Supplier=""&InvType=SHIP&Warehouse=PERKIOMEN&CustLoc=new location&SuppLoc=""&Dept=REDHOOK

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 blank includes all worksheets.	Optional
Warehouse	Warehouse Name to filter results based on whether the InventoryType parameter is used.	Optional
Status	Status of the records the Worksheet inquiry will filter be run for. If left blank the Worksheet inquiry will be run for 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	The specific worksheet trade type value to filter results for. If left blank the Worksheet Inquiry will be run for ALL Trade Types.	Optional
WorksheetUDF	Filters results for only those 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
Status	Filters results on Worksheet Status. If not provided defaults to only INVOICE OR POSTED status worksheets. Options include: PIOSTED, UNPOSTED and ALL (Note Cancelled status worksheets are excluded for all options)	Optional

Response Example

{
        "WorksheetNo": "512629",
        "Department": "REDHOOK",
        "TradeType": "METAL",
        "ShippingDate": "2024-07-02",
        "status": "WORK",
        "PostDate": null,
        "Customer": "DAKTEST234",
        "ShipToLocation": "new location",
        "Supplier": "(INVENTORY)",
        "ShipFromLocation": "PERKIOMEN",
        "FreightCarrier": "BLACK TRUCKS",
        "FreightRate": "23.00",
        "ReleaseNumber": "",
        "PickupNumber": "",
        "BookingNumber": "",
        "ShippingStatus": "SETUP",
        "Sales": 369.00,
        "Chargebacks": 0.00,
        "TotalSale": 369.00,
        "Purchases": 0.00,
        "Expenses": 23.00,
        "TotalCosts": 23.00,
        "SalesAdj": 0.00,
        "PurchaseAdj": 0.00,
        "GrossProfit": 0.00,
        "SalesTaxAmnt": 0.00,
        "SalesCurrency": "USD",
        "ExchangeRate": "1.00000000000000",
        "PurchaseFxRate": "1.00000000000000",
        "FxInvoiceAmount": 369.00,
        "FxSalesTaxAmt": 0.00,
        "PurchaseCurrency": "USD",
        "FxPurchases": 0.00,
	"WeightInLbs": 99999.12,
	"GradeRef": "Old Corrugated Containers",
        "WorksheetUDF1":"UDF1",
        "WorksheetUDF2":"UDF2",
        "WorksheetUDF3":"UDF3",
        "WorksheetUDF4":"UDF4",
        "WorksheetUDF5":"UDF5"
    }