Framework agreement line items
A line of a framework agreement with the target quantity and unit price agreed for one catalog item.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Framework agreement | salesagreementId | Reference | Yes | |
| Position | rank | Order rank | Yes | |
| Item | productitemId | Reference | ||
| Target quantity | quantityTarget | Quantity | Yes | Quantity committed on the contract for this line. |
| Released quantity | quantityReleased | Quantity | Yes | Quantity already released to orders or other contract documents. |
| Delivered quantity | quantityDelivered | Quantity | Yes | Quantity delivered to the customer under this contract. |
| Invoiced quantity | quantityInvoiced | Quantity | Yes | Quantity in the catalog unit after any unit conversion on the line. |
| Item | serviceitemId | Reference | ||
| Item | customitemId | Reference | ||
| Material | materialId | Reference | ||
| Catalog | catalog | Constant | Yes | Fixed option from the allowed set for this field. |
| Unit | catalogunit | Unit | ||
| Unit price | unitPrice | Unit price | Price for one unit, before line discount. Includes tax only when the document price basis is gross. | |
| Description | description | Text Area | ||
| 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 | ||
| 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 |
|---|---|---|
Framework agreement salesagreementId | Framework agreements | owned by |
Actions
What you can do with a record. Every action also sends the webhook event salesagreementitems.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new line item. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this line item. | App · API · MCP · CLI |
| Delete | delete | Delete this line item and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |