| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Sales order unique id - auto generated by the system. |
integer |
None. |
| Type |
The sales order type. |
IdNamePair |
Required |
| Customer |
The customer associated with the sales order. |
CustomerRef |
Required |
| BillToLocation |
The customer bill to location. This is required when "Require Bill To and Ship To Address for Sales Orders, Invoices, Credit Memos, and Sales Receipts" AR setting is turned on. Default location will be used in case is not specified and it's required. |
IdNamePair |
None. |
| ShipToLocation |
The customer ship to location. This is required when "Require Bill To and Ship To Address for Sales Orders, Invoices, Credit Memos, and Sales Receipts" AR setting is turned on. Default location will be used in case is not specified and it's required. |
IdNamePair |
None. |
| ShipVia |
Ship Via |
IdNamePair |
None. |
| TrackingNumber |
Shipment tracking number. |
string |
None. |
| Contact |
Contact associated with the sales order. |
IdNamePair |
None. |
| Project |
Project associated with the sales order. |
IdNamePair |
None. |
| SalesRep |
Sales rep associated with the sales order. |
IdNamePair |
None. |
| OrderDate |
Order date - required. Today's date will be used in case is not specified. |
date |
None. |
| OrderNumber |
Order number - auto generated by the system for new orders if not provided. Required on update. |
string |
None. |
| OrderName |
Order name - required based on sales order type settings. Order date will be used in case is not specified. |
string |
None. |
| CustomerPONumber |
Customer PO number. |
string |
None. |
| ToBePrinted |
Whether this sales order is queued to be printed. |
boolean |
None. |
| TargetDate |
Target date - required based on sales order type settings. |
date |
None. |
| PaymentTerm |
Payment term. One of the following settings will be used in case is not specified: Customer level, Type level, Global level default. Required when none of these are set. |
IdNamePair |
None. |
| ARGLAccount |
Accounts Receivable associated with the sales order. Required when more than one AR account is available. |
IdNamePair |
None. |
| InvoiceFormat |
Invoice Format - required if more than one available. |
IdNamePair |
None. |
| CustomerNotes |
Customer Notes. |
Note |
None. |
| InternalNotes |
Internal Notes. |
Note |
None. |
| LineItemsClass |
Class. Is only required if class tracking is turned on and is flagged as required. |
IdNamePair |
None. |
| SalesTax |
Tax - The following settings will be used in case is not specified: Shipping to location address, Global level default. Required when none of these are set. |
IdNamePair |
None. |
| OrderTotal |
Read-only. Order total. |
decimal number |
None. |
| Status |
The status of the sales order. For new orders, this property is optional. If not provided, it will be set to the "order creation status" defined at the order type level. The status of new orders can explicitly set to any of the following: Incomplete (18), Quoted (19), Pending Approval (20), Approved (22) This property is read-only for existing orders. |
IdNamePair |
None. |
| InvoiceStatus |
Read-only. The invoiced status of the sales order. |
IdNamePair |
None. |
| IsChangeOrder |
Whether or not sales order is a change order |
boolean |
None. |
| ParentId |
Parent sales order Id |
integer |
None. |
| IsRecurring |
Whether or not sales order is recurring. |
boolean |
None. |
| LineItems |
Sales order line items. |
Collection of SalesOrderLineItem |
None. |
| CustomFields |
Sales Order Custom Fields. |
Collection of CustomField |
None. |
| NotesLogCount |
Read-only. The number of notes logged to the sales order. |
integer |
None. |
| AttachmentCount |
Read-only. The number of attachments uploaded to the sales order. |
integer |
None. |
| DateCreated |
Read-only. The date and time (in company time zone) when the sales order was created. |
date |
None. |
| CreatedBy |
The person who created the sales order. |
IdNamePair |
None. |
| LastUpdatedDate |
Read-only. The date and time (in company time zone) when the sales order was last updated. |
date |
None. |
| LastUpdatedBy |
The person who last updated the sales order. |
IdNamePair |
None. |
| Currency |
Read Only - Currency Information. |
Currency |
None. |
