Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Represents a company in Business Central.
Note
For information about enabling APIs for Business Central see guideline.
Methods
| Method | Return Type | Description |
|---|---|---|
| GET company | company | Gets a company object. |
Navigation
| Navigation | Return Type | Description |
|---|---|---|
| cloudMigrationCompanies | cloudMigrationCompanies | Gets the cloudmigrationcompanies of the company. |
| cloudMigrationStatus | cloudMigrationStatus | Gets the cloudmigrationstatus of the company. |
| cloudMigrationStatusDetails | cloudMigrationStatusDetails | Gets the cloudmigrationstatusdetails of the company. |
| tableMappings | tableMappings | Gets the tablemappings of the company. |
| setupCloudMigration | setupCloudMigration | Gets the setupcloudmigration of the company. |
| sourceProductTypes | sourceProductTypes | Gets the sourceproducttypes of the company. |
Properties
| Property | Type | Description |
|---|---|---|
| id | GUID | The unique ID of the company. Non-editable. |
| systemVersion | string | Specifies the internal version of the company. |
| name | string | Represents the company's name. |
| displayName | string | Specifies the company's name. This name will appear on all sales documents for the company. |
| businessProfileId | string | Specifies the Business Profile ID linked to the company. |
| systemCreatedAt | datetime | The datetime the company was created. |
| systemCreatedBy | GUID | The ID of the user who created the company. |
| systemModifiedAt | datetime | The last datetime the company was modified. |
| systemModifiedBy | GUID | The ID of the user who last modified the company. |
| estimatedSize | decimal | Read-Only property representing the approximate size of the On-Prem company. The data migrated will be smaller, since the data will be compressed and not all tables will be included. |
| created | boolean | Specifies if the company was created. It will not reflect if the setup of the company was correct or not. For this you should check the status property. If the company has been created, however status is different. |
JSON representation
Here is a JSON representation of the company resource.
{
"id": "GUID",
"systemVersion": "string",
"name": "string",
"displayName": "string",
"businessProfileId": "string",
"systemCreatedAt": "datetime",
"systemCreatedBy": "GUID",
"systemModifiedAt": "datetime",
"systemModifiedBy": "GUID"
}