Sales order payment options
The payment currency, payment method, and optional treasury account offered on a sales order.
- API name:
salesorderpaymentoptions - Domain: Sales
- Modules: Sales analytics, Sales, Stores
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 | |
| Position | rank | Order rank | Yes | |
| Treasury account | treasuryaccountId | Reference | Optional account that receives payment in the payment currency. | |
| Payment currency | currency | Constant | Yes | Currency in which the customer can pay this option. |
| Payment option | salesquotepaymentoptionId | Reference | ||
| Payment method | method | Constant | How the customer pays for this option. | |
| Exchange rate date | dateFxrateSource | Date | Date of the published rate. Leave empty to use the payment date. | |
| Exchange rate source | fxrateProvider | Constant | Published rate series used to convert the document currency into the payment currency. Leave empty when the currencies match or when the rate is agreed. | |
| Agreed exchange rate | fxrateAgreed | Decimal | Units of payment currency per 1 unit of document currency. Leave empty when using a published rate or when the currencies match. | |
| 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 |
Treasury account treasuryaccountId | Treasury accounts | reference |
Payment option salesquotepaymentoptionId | Sales quote payment options | reference |
Actions
What you can do with a record. Every action also sends the webhook event salesorderpaymentoptions.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new payment option. | App · API · MCP · CLI |
| Edit | update | Save changes to this payment option. | App · API · MCP · CLI |
| Delete | delete | Delete this payment option and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |