Sales Order¶
Confirmed customer order.
API Name: SalesOrder
Fields¶
| Field | Type | Description |
|---|---|---|
name |
varchar | Order number (readOnly) |
referenceIdentifier |
varchar | Reference number (max 30) |
automaticReferenceIdentifier |
multiIncrement | Automatic number (I{YY}-{number}) |
status |
enum | Order status |
account |
link | Customer |
billingAddress |
address | Billing address |
shippingAddress |
address | Shipping address |
dateOrdered |
datetime | Order date (default: now) |
dueDate |
date | Due date |
amount |
currency | Amount (calculated) |
grandTotalAmount |
floatCurrency | Total amount (calculated) |
quote |
link | Quote |
salesOrderDocument |
file | Order document |
assignedUser |
link | Assigned user |
Enum Values¶
status:
| Value | Description | Color |
|---|---|---|
Draft |
Draft | - |
Ready |
Ready | primary |
Active |
Active | info |
Completed |
Completed | success |
Rejected |
Rejected | danger |
Canceled |
Canceled | danger |
Relationships¶
| Relationship | Type | Target Entity | Description |
|---|---|---|---|
account |
belongsTo | Account | Customer |
items |
hasMany | SalesOrderItem | Items |
quote |
belongsTo | Quote | Quote |
invoices |
hasMany | Invoice | Invoices |
issuedTaxDocuments |
hasMany | IssuedTaxDocument | Tax documents |