Companies

Retrieve a company from Basecone by it's unique identifier.

GET companies/:id?fields=modules

Request properties

Property	Type	Description	Optional
fields	Array	Optional fields to retrieve.	Yes

Company properties

Property	Type	Description	Optional
CompanyId	Guid	Unique identifier of the company.	No
Name	String	The name of the company.	No
Email	String	The email of the company.	No
HasAccess	Boolean	Defines if the user has access to the given company.	No
TotalDocumentsToAuthorize	Number	The number of documents waiting to be authorized.	No
AccountingSystem	Complex object	Details on the accounting system this company is using.	No
ExtraData	Array	The existing extra data for the company.	No
Modules	Array	The available modules for the company and their status.	Yes

Accounting system properties

Property	Type	Description
CompanyCode	String	The company code used by the accounting system.
ExternalId	String	An identifier used by the accounting system.
Type	String	Indicates the type of accounting system. possible value are `Twinfield`,`Exact`,`AccountView`.

Modules properties

Property	Type	Description
Code	String	The available modules for the company. Possible values are: `Agro`
Status	String	The status of the module for the company. Possible values are: `Enabled` `Disabled` `DisabledAtOffice` `NotSupported`

Example response:

{
    "companyId": "9eef0578-e92c-4443-bc8a-7d5721271891",
    "accountingSystem": {
        "type": "Twinfield",
        "externalId": "MANCITY",
        "companyCode": "MANCITY"
    },
    "totalDocumentsToAuthorize": 0,
    "name": "Manchester City",
    "email": "email",
    "_links": [
        {
            "rel": "self",
            "href": "http://api.basecone.com/companies/9eef0578-e92c-4443-bc8a-7d5721271891"
        },
        {
            "rel": "documents",
            "href": "http://api.basecone.com/documents?companyid=9eef0578-e92c-4443-bc8a-7d5721271891"
        }
    ],
    "externalId": "MANCITY",
    "language": "EN",
    "extraData": [
    ],
    "hasAccess": true,
    "isArchived": false,
    "modules": [
        {
            "code": "Agro",
            "status": "DisabledAtOffice"
        }
    ]
}