Supplier branches
Physical location that belongs to a supplier organization.
- API name:
supplierbranches - Domain: Parties
- Modules: Finances, Inventory, Manufacturing, Purchasing, Logistics, Directory
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Supplier | supplierId | Reference | Yes | |
| Name | label | Text | Yes | |
| Address | address | Address | ||
| Default | isDefault | Boolean | Yes | When enabled, this row is the default choice among peers. |
| Functions | functions | Constant | Yes | Purpose of this site. Choose General when no specific function applies. |
| Emails | emails | Email | Emails | ||
| Phones | phones | Phone | Phones | ||
| Links | links | Link | Links | ||
| Image | image | Image | ||
| Tags | tagIds | Tags | ||
| Description | description | Text Area | ||
| Data | data | Data | ||
| External identifiers | identifiers | External identifier | External identifiers | Remote system keys and optional id types. One value per system and type pair on this record. | |
| 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
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
Actions
What you can do with a record. Every action also sends the webhook event supplierbranches.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new branch. | App · API · MCP · CLI |
| Edit | update | Save changes to this branch. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this branch. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · CLI |
| Unblock | unblock | Allow edits and deletion of this branch again. | App · API · CLI |
| Archive | archive | Retire this branch from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · API · MCP · CLI |
| Restore | unarchive | Return this branch to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this branch and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |