Supplier scorecards
A performance evaluation of a supplier for a purchasing commercial unit.
- API name:
purchasescorecards - Domain: Purchases
- Modules: Purchasing
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Name | label | Text | ||
| Number | uid | Text | The number is a human-readable, unique identifier for the record. | |
| Day | date | Date | Yes | |
| Deal | purchasedealId | Reference | ||
| Supplier | supplierId | Reference | Yes | |
| Buyer | userId | User | ||
| Period start | dateStart | Date | Calendar date without time of date. | |
| Period end | dateEnd | Date | Calendar date without time of date. | |
| Coverage | coverage | Percent | Rate expressed as a percent of a base amount. | |
| Basis | basis | Constant | Yes | Whether the tax is a percent of the base or an amount per unit. |
| Class | class | Constant | Yes | Primary class of the record within its table, as defined by the applicable option list. |
| Score | score | Percent | Yes | Rate expressed as a percent of a base amount. |
| 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 | ||
| 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 |
|---|---|---|
Deal purchasedealId | Purchase deals | reference |
Supplier supplierId | Suppliers | reference |
Buyer userId | Users | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event purchasescorecards.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new scorecard. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this scorecard. | App · WebMCP · API · MCP · CLI |
| Publish | publish | Make this scorecard available for use. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this scorecard. 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 scorecard again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this scorecard 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 scorecard to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this scorecard 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.