SalesOrders
Manages sales order transactions including items, billing, and shipping details. Not accessible in free or standard accounts.
Table-Specific Information
Select
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
Insert
INSERT INTO SalesOrders (Subject, ProductDetails) VALUES ('Sales Order', '[
{
"product": {
"Product_Code": "12342321",
"name": "Egg",
"id": "3276571000000184076"
},
"quantity": 1024,
"Discount": 0,
"total_after_discount": 1239.04,
"net_total": 1239.04,
"book": null,
"Tax": 0,
"list_price": 1.21,
"unit_price": 1.21,
"quantity_in_stock": -1024,
"total": 1239.04,
"id": "3276571000000184104",
"product_description": null,
"line_tax": []
}
]')
Required fields: Subject, ProductDetails
Any field which is not read-only (ReadOnly = false in the table below) can be inserted.
Delete
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM SalesOrders WHERE Id = '3152079000000153079'
Update
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE SalesOrders SET Description = 'Changed from the API.' WHERE Id = '3152079000000493027'
Required fields: Id.
Any field which is not read-only (ReadOnly = false in the table below) can be updated.
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
Unique identifier for the sales order record. |
| CustomerNo. | String | False |
Customer number associated with this sales order. |
| SONumber | String | True |
Internal sales order number used for tracking. |
| Subject | String | False |
Subject line or title of the sales order. |
| DealName_Id | String | False |
Unique identifier of the deal associated with this sales order. |
| DealName_Name | String | True |
Name of the deal linked to this sales order. |
| PurchaseOrder | String | False |
Purchase order number referenced in the sales order. |
| QuoteName_Id | String | False |
Unique identifier of the quote associated with this sales order. |
| QuoteName_Name | String | True |
Name of the quote linked to this sales order. |
| DueDate | Date | False |
The date by which the order is expected to be fulfilled. |
| Pending | String | False |
Pending status or notes for this sales order, if any. |
| ContactName_Id | String | False |
Unique identifier of the contact linked to this sales order. |
| ContactName_Name | String | True |
Name of the contact person related to this sales order. |
| Carrier | String | False |
Shipping carrier selected for this order. |
| ExciseDuty | Decimal | False |
Amount of excise duty applied to this sales order. |
| SalesCommission | Decimal | False |
Commission amount applicable for the sales agent on this order. |
| Status | String | False |
Current status of the sales order (for example, Open, Delivered, or Cancelled). |
| AccountName_Id | String | False |
Unique identifier of the account associated with this order. |
| AccountName_Name | String | True |
Name of the account linked to this sales order. |
| SalesOrderOwner_Id | String | False |
Unique identifier of the owner of this sales order. |
| SalesOrderOwner_FirstName | String | True |
First name of the sales order owner. |
| SalesOrderOwner_LastName | String | True |
Last name of the sales order owner. |
| SalesOrderOwner_Email | String | True |
Email address of the sales order owner. |
| SalesOrderOwner_Name | String | True |
Full name of the sales order owner. |
| CreatedBy_Id | String | False |
Unique identifier of the user who created this sales order. |
| CreatedBy_FirstName | String | True |
First name of the user who created this record. |
| CreatedBy_LastName | String | True |
Last name of the user who created this record. |
| CreatedBy_Email | String | True |
Email address of the user who created this record. |
| CreatedBy_Name | String | True |
Full name of the user who created this record. |
| ModifiedBy_Id | String | False |
Unique identifier of the user who last modified this record. |
| ModifiedBy_FirstName | String | True |
First name of the user who last modified this record. |
| ModifiedBy_LastName | String | True |
Last name of the user who last modified this record. |
| ModifiedBy_Email | String | True |
Email address of the user who last modified this record. |
| ModifiedBy_Name | String | True |
Full name of the user who last modified this record. |
| CreatedTime | Datetime | False |
Date and time when the sales order was created. |
| ModifiedTime | Datetime | False |
Date and time when the sales order was last modified. |
| Tag | String | False |
Tags associated with the sales order for categorization or filtering. |
| BillingStreet | String | False |
Street address for billing. |
| ShippingStreet | String | False |
Street address for shipping. |
| BillingCity | String | False |
City specified in the billing address. |
| ShippingCity | String | False |
City specified in the shipping address. |
| BillingState | String | False |
State or region for the billing address. |
| ShippingState | String | False |
State or region for the shipping address. |
| BillingCode | String | False |
Postal code for the billing address. |
| ShippingCode | String | False |
Postal code for the shipping address. |
| BillingCountry | String | False |
Country specified in the billing address. |
| ShippingCountry | String | False |
Country specified in the shipping address. |
| ProductDetails | String | False |
Line-item product details associated with this sales order. |
| SubTotal | Decimal | True |
Subtotal amount before any discounts or taxes. |
| Discount | Decimal | False |
Total discount applied to this sales order. |
| Tax | Decimal | True |
Total tax applied to the sales order. |
| Adjustment | Decimal | False |
Additional adjustments made to the final amount. |
| GrandTotal | Decimal | True |
Final total amount including discounts, taxes, and adjustments. |
| TermsandConditions | String | False |
Terms and conditions related to this sales order. |
| Description | String | False |
Additional description or notes related to this sales order. |
| Locked | Bool | True |
Indicates whether this record is locked from further editing. |
| LastActivityTime | Datetime | False |
Timestamp of the last activity related to this sales order. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| DuplicateCheckFields | String |
The fields to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check, but the BULK API only allows one field. |
| Trigger | String |
To trigger the rule while inserting record into CRM account. |
| CustomViewId | Long |
The custom view Id to be used for filtering this record. Works when the useCOQL parameter is false. |