Default sales payment options
Currency and payment method that a sales commercial unit or site offers by default.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Position | rank | Order rank | Yes | |
| Treasury account | treasuryaccountId | Reference | Yes | |
| Quote currency | currency | Constant | Yes | Value from the table catalog for this field. |
| Method | method | Constant | Fixed option from the allowed set for this field. | |
| Default | isDefault | Boolean | Yes | When enabled, this row is the default choice among peers. |
| Exchange rate source | fxrateProvider | Constant | Settlement-rate provider. When set, a document in another currency can offer this option. The rate converts the document currency into this option's currency. It does not set the document exchange rate. | |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
| Field | Points to | Kind |
|---|---|---|
Treasury account treasuryaccountId | Treasury accounts | reference |
Actions
What you can do with a record. Every action also sends the webhook event salesdefaultpaymentoptions.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new payment option. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this payment option. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this payment option. It stays visible and can still appear on existing documents. Unblock to edit again. | App · WebMCP · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this payment option again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this payment option from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · WebMCP · API · MCP · CLI |
| Restore | unarchive | Return this payment option to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this payment option and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |