Sales order header discounts
A discount applied at header level on a sales order and spread across its line items.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Order | salesorderId | Reference | Yes | |
| Order | sequence | Whole Number | Yes | Whole number without fractional part. |
| Label | label | Text | ||
| Kind | kind | Constant | Yes | Fixed option from the allowed set for this field. |
| Percent | percent | Percent | Percent value from 0 to 100. | |
| Amount | amount | Currency | Monetary amount in the applicable currency for this record. | |
| Amount applied | amountApplied | Currency | Yes | Amount in the document or line currency. |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Approved by | approvedBy | User | ||
| Approved at | approvedAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Order salesorderId | Sales orders | owned by |
Actions
What you can do with a record. Every action also sends the webhook event salesorderdiscounts.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new header discount. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this header discount. | App · API · MCP · CLI |
| Delete | delete | Delete this header discount and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |