SalesOrders

Tracks confirmed sales orders with shipment status, billing terms, and linked invoices; not available in free or standard editions.

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, AccountName_Id, OrderedItems) VALUES ('Sales Order', '1021046000000427104', '[
  {
    "Product_Name": {
      "id": "1021046000000414457"
    },
    "Quantity": 1024,
    "Discount": 99,
    "Tax": 13,
    "List_Price": 176.21,
    "Description": "test description 3"
  }
]');

Required fields for REST API: Subject, OrderedItems.

Required fields for BULK API: Subject, AccountName_Id, OrderedItems.

Any field which is not read-only (ReadOnly = false in the table below) can be inserted.

Please note that the REST API honors only the 'id' field of the 'Product_Name' aggregate in the OrderedItems column. The BULK API does not accept any other field in this aggregate.

Required fields: Subject, OrderedItems

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.
CustomerNo.	String	False	Customer number associated with the sales order.
SONumber	String	True	Sales order number.
Subject	String	False	Subject line or title for the sales order.
DealName_Id	String	False	Identifier of the related deal.
DealName_Name	String	True	Name of the related deal.
PurchaseOrder	String	False	Purchase order number associated with this sales order.
QuoteName_Id	String	False	Identifier of the related quote.
QuoteName_Name	String	True	Name of the related quote.
DueDate	Date	False	Date by which the order is due.
Pending	String	False	Indicates any pending items or actions for the sales order.
ContactName_Id	String	False	Identifier of the associated contact.
ContactName_Name	String	True	Name of the associated contact.
Carrier	String	False	Shipping carrier for the order.
ExciseDuty	Decimal	False	Amount of excise duty applied to the sales order.
SalesCommission	Decimal	False	Sales commission for this order.
Status	String	False	Current status of the sales order.
AccountName_Id	String	False	Identifier of the associated account.
AccountName_Name	String	True	Name of the associated account.
SalesOrderOwner_Id	String	False	Identifier of the user who owns 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	Identifier of the user who created the sales order.
CreatedBy_FirstName	String	True	First name of the creator.
CreatedBy_LastName	String	True	Last name of the creator.
CreatedBy_Email	String	True	Email address of the creator.
CreatedBy_Name	String	True	Full name of the creator.
ModifiedBy_Id	String	False	Identifier of the user who last modified the sales order.
ModifiedBy_FirstName	String	True	First name of the user who last modified the record.
ModifiedBy_LastName	String	True	Last name of the user who last modified the record.
ModifiedBy_Email	String	True	Email address of the user who last modified the record.
ModifiedBy_Name	String	True	Full name of the user who last modified the record.
CreatedTime	Datetime	False	Date and time the sales order was created.
ModifiedTime	Datetime	False	Date and time the sales order was last modified.
Tag	String	False	Tags associated with the sales order.
BillingStreet	String	False	Street address for billing.
ShippingStreet	String	False	Street address for shipping.
BillingCity	String	False	City for billing.
ShippingCity	String	False	City for shipping.
BillingState	String	False	State or province for billing.
ShippingState	String	False	State or province for shipping.
BillingCode	String	False	Postal or ZIP code for billing.
ShippingCode	String	False	Postal or ZIP code for shipping.
BillingCountry	String	False	Country for billing.
ShippingCountry	String	False	Country for shipping.
SubTotal	String	True	Subtotal amount before any discounts, taxes, or adjustments.
Discount	Decimal	False	Discount applied to the sales order.
Tax	Decimal	False	Tax amount applied to the sales order.
Adjustment	Decimal	False	Any adjustments made to the total amount.
GrandTotal	String	True	Total amount after applying discount, tax, and adjustments.
TermsandConditions	String	False	Terms and conditions related to the sales order.
Description	String	False	Additional description or notes for the sales order.
OrderedItems	String	False	List of items included in the sales order.
Locked	Bool	True	Indicates whether the sales order is locked from editing.
LastActivityTime	Datetime	False	Date and time of the most recent activity on the 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	Fields used to check for duplicates during an upsert. The REST API supports multiple fields; the BULK API supports only one.
Trigger	String	Indicates whether to trigger automation rules during record insertion.
CustomViewId	Long	Custom view identifier used to filter this record when the useCOQL parameter is set to false.

MCP Server for Zoho CRM