OpenTimeline
Returns the month-by-month quantities sales expects each product line of an open contract to pull. One row per product line per month; only months that were entered on the contract's Timeline tab are returned.
Request
| URL | https://cap.crainwalnut.com/api/contracts/opentimeline |
|---|---|
| Method | GET |
Parameters
This endpoint has no parameters.
Returns
An array of objects of anonymous type with the following definition
| Name | Data Type | Description |
|---|---|---|
| ContractProduct | ContractProduct |
Refer to data type’s documentation for further information |
| PeriodStart | DateTime |
First day of the month the quantity is expected to pull in |
| Quantity | Decimal |
Amount of Product expected to pull in the month expressed in terms of the product’s PackagingType |
| Pounds | Nullable<Decimal> |
Amount of Product expected to pull in the month expressed in terms of the system's base UnitOfMeasure |
Remarks
The timeline is informational: it is sales' expectation of when the contract will pull, entered on the contract, and is not reduced by orders or shipments. Months are not forced to sum to the contracted quantity, so consumers should compare the sum of a line's months against the contracted quantity in ContractProduct.InventoryTransaction.Quantity rather than assume they agree.