Framework agreements
Standing commercial agreement with one customer in one company and currency, tied to a sales price list and validity dates.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Label | label | Text | Yes | |
| Number | uid | Text | The number is a human-readable, unique identifier for the record. | |
| Previous framework agreement | salesagreementIdPrevious | Reference | Prior published agreement this renewal replaces, when applicable. | |
| Customer | customerId | Reference | Yes | |
| Quote currency | currency | Constant | Yes | Value from the table catalog for this field. |
| Price list on renew | priceRenewal | Constant | Value from the table catalog for this field. | |
| Target amount | amountTarget | Currency | Optional pre-tax cap. Checked against this agreement's approved orders when an order is approved. | |
| Valid from | dateFrom | Date | First calendar date this record applies. | |
| Valid to | dateTo | Date | Last calendar date this record applies, if any. | |
| Price list | salespricelistId | Reference | Yes | |
| Tags | tagIds | Tags | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Published by | publishedBy | User | ||
| Published at | publishedAt | Date and Time | ||
| Disabled by | disabledBy | User | ||
| Disabled at | disabledAt | 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 |
|---|---|---|
Previous framework agreement salesagreementIdPrevious | Framework agreements | reference |
Customer customerId | Customers | reference |
Price list salespricelistId | Sales price lists | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event salesagreements.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new framework agreement. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this framework agreement. | App · WebMCP · API · MCP · CLI |
| Disable | disable | Turn this framework agreement off for new use. Existing references stay. Enable it again to use it. | App · WebMCP · API · MCP · CLI |
| Enable | undisable | Turn this framework agreement back on for new use. | App · WebMCP · API · MCP · CLI |
| Publish | publish | Make this framework agreement available for use. | App · WebMCP · API · MCP · CLI |
| Renew | renew | Create the next agreement period with the same terms. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this framework agreement. 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 framework agreement again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this framework agreement 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 framework agreement to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this framework agreement and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.