Companies
A legal entity within an organization with its own general ledger, tax profile, and financial statements.
- API name:
companies - Domain: Structure
- Modules: Master data, Directory, Administration
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 | |
| Name | label | Text I18n | ||
| Emails | emails | Email | Emails | ||
| Phones | phones | Phone | Phones | ||
| Links | links | Link | Links | ||
| Country of registration | countryCode | Constant | Yes | Country where the company is legally registered. Determines the applicable legal requirements and legal data. |
| Accounting currency | currency | Constant | Yes | Currency of the books and the financial statements. It cannot change after you publish the company. |
| Accounting framework | accountingFramework | Constant | Yes | Framework used to prepare the financial statements: IFRS or US GAAP. This does not replace statutory tax accounting requirements. |
| Tax basis | accountingTaxBasis | Constant | Yes | Determines when tax is recognized for tax purposes: when the document is issued or received, or when payment is collected or made. |
| Ledger mode | ledgerMode | Constant | Yes | Fixed option from the allowed set for this field. |
| Fiscal year end | monthFiscalYearEnd | Whole Number | Yes | Month when the fiscal year ends. New fiscal years use this month. |
| Inventory valuation method | inventoryValuationMethod | Constant | Yes | Accounting valuation policy for all inventory owned by this company. Every warehouse, store, and factory under the company uses this method; costing still runs at site and position grain. |
| Quote cost basis | costBasisQuote | Constant | Yes | Defines which catalog cost a sales quote margin uses for this company. |
| Revenue posting point | revenuePostingPoint | Constant | Yes | Sets when sales revenue posts for this company. Locked once the company is published. |
| Require qualified supplier | requireQualifiedSupplier | Boolean | Yes | Purchase orders of this company approve only when the supplier holds a current qualification. |
| Tax ID | taxId | Text | Tax identifier for the company, according to its country of registration. | |
| Exchange rate source | fxrateProvider | Constant | Published rate series this company uses by default to convert documents into its accounting currency. | |
| Maximum exchange-rate age (days) | fxrateMaxAgeDays | Whole Number | Yes | Maximum age, in days, of the exchange rate used for foreign-currency documents. 0 means a same-day rate only. |
| Logo | logo | Image | Company logo for lists and documents. | |
| Symbol | symbol | Image | Compact monogram or icon for the company. | |
| Description | description | Text Area I18n | ||
| 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 | |
| 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.
Actions
What you can do with a record. Every action also sends the webhook event companies.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new company. | App · API · MCP · CLI |
| Edit | update | Save changes to this company. | App · API · MCP · CLI |
| Disable | disable | Turn this company off for new use. Existing references stay. Enable it again to use it. | App · API · MCP · CLI |
| Enable | undisable | Turn this company back on for new use. | App · API · MCP · CLI |
| Publish | publish | Make this company available for use. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this company. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this company again. | App · API · MCP · CLI |
| Delete | delete | Delete this company and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.