Sales Order Mappings

* = Required

Sales Orders

Name

Description

Type

Values

ExternalId*

The external identifier for the sales order.  String Sales Order ID

Name*

Unique, changeable, text identifier. String Sales Order Name

CancelAtExpirationDate

If true, the sales order will be cancelled at the expiration date defined.  Boolean  

Cancelled

If cancelled, the Job won’t be scheduled. Boolean  

Customer

The customer for which the sales order is created for.  String  

Description

Text for describing the object. String  

Estimate

If true then this is a quote, not a firm order. Boolean  

ExpirationDate

If CancelAtExpirationDate is true then the Sales Order is marked as Cancelled when the PlanetTogether Clock passes this date. DateTime  

Notes

Comments or special considerations pertaining to this object. String  

Planner

The user responsible for planning this demand if planning by demand rather than by product or location. String  

Project

Can be used for tracking multiple demands tied to one project. String  

SalesAmount

Specifies the sales amount for the sales order.  Decimal  

SalesOffice

Specifies the sales office or other physical location that created the demand. This has no effect on the Warehouse that satisfies the order. It is for reference only. String  

SalesPerson

The employee in sales who is responsible for this demand. String  

UserFields

An optional list of user-defined fields. Null if not initialized. String  

Sales Order Lines

ItemExternalId*

The external identifier of the item associated with the sales order.  String  

LineNumber*

The identifier for a line item within the sales order. String  

SalesOrderExternalId*

The external identifier for this sales order.  String  

Description

Text for describing the object. String  

UnitPrice

The sale price per unit. This can be used to maximize sales revenue. Decimal  

Sales Order Lines Distributions

SalesOrderExternalId*

The external identifier for this sales order.  String  

LineNumber*

The identifier for a line item within the sales order. String  

MustSupplyFromWarehouseExternalId*

Can be used to force the Line to be supplied from the specified Warehouse. If not specified then the material can come from any Warehouse. String  

RequiredAvailableDate*

The date when the material must be available in stock in order to reach the customer by the Promised Delivery Date. DateTime  

QtyOrdered*

The total quantity for this Line Item Distribution on the order. This remains the same even if there is a partial shipment made. Double  

AllowedLotCodes

  String  

AllowPartialAllocations

This is currently a flag that specifies whether partial allocations of material is allowed to supply the sales order. Boolean  

Closed

If true then the sales order has no effect on the plan. Boolean  

Hold

Whether the sales order was placed On-hold and work should not be done on it. Boolean  

HoldReason

The reason why the sales order was put on hold.  String  

Priority

Usually used to specify a combination of importance and urgency. This can be used by the Balanced Composite Rule. Lower numbers are more urgent/important. Int32  

MaximumLatenessDays

If using StockShortageRule of PushLater and the demand has been pushed this amount past the Required Available Date, then it is marked as a Missed Sale. Double  

MinAllocationQty

If AllowPartialAllocations is true then this is the minimum amount that must be allocated to the shipment. Double  

Priority

Indicates the importance of the shipment. Used during the allocation process to determine which requirements to allocate to first. Shipments with lower numbers are considered more important and receive allocation before shipments with higher numbers. Allocation is based upon the Allocation Rule specified during the time a Simulation is performed. Int32  

SalesRegion

The geographic region for the shipment. For information only. String  

ShipToZone

Specifies the geographic area where the shipment is going. For information only. String  

StockShortageRule

Specifies what should be done in stock planning when the shipments full QtyOpenToShip cannot be satisfied. This can also be overridden during Optimize with a global rule. String