Get a company
distru-get-companyReadGets one customer, vendor or your own company, with its licenses, addresses and default order notes.
Inputs
Every tool also takes the common inputs.
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | Resolve via distru-search-companies. |
| includeContacts | boolean | No | contacts is empty without permission to view contacts. |
| includeLocations | boolean | No | Addresses. |
| includeLicenses | boolean | No | State cannabis licenses. Customer and vendor license numbers are user-entered, not checked against Metrc. |
Output
Presence on a nested field assumes its parent exists.
| Field | Type | Presence | Description |
|---|---|---|---|
| company | object | Can be null | |
| company. | string | Always | |
| company. | string | Null or absent | |
| company. | boolean | Always | |
| company. | object[] | Always | |
| company. | object | Always | |
| company. | string | Always | |
| company. | string | Always | |
| company. | enumCHECKBOXDATEDROPDOWNTEXT | Always | |
| company. | string | Can be null | Null when unset. DATE values are days (YYYY-MM-DD) in the company timezone; CHECKBOX values are the selected option names, separated by commas. |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | integer | Null or absent | |
| company. | string | Null or absent | |
| company. | object | Null or absent | |
| company. | string | Always | |
| company. | string | Null or absent | |
| company. | object | Null or absent | |
| company. | string | Always | |
| company. | string | Null or absent | |
| company. | object | Null or absent | |
| company. | string | Always | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | object | Null or absent | |
| company. | string | Always | |
| company. | string | Always | |
| company. | object | Null or absent | |
| company. | string | Always | |
| company. | string | Always | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | object | Null or absent | |
| company. | string | Always | |
| company. | boolean | Always | |
| company. | boolean | Always | |
| company. | string | Null or absent | |
| company. | object | Null or absent | |
| company. | string | Always | |
| company. | boolean | Always | |
| company. | boolean | Always | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | object[] | Can be absent | |
| company. | string | Always | |
| company. | string | Always | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | object | Null or absent | |
| company. | string | Always | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | string | Null or absent | |
| company. | object[] | Always | |
| company. | object | Always | |
| company. | string | Always | |
| company. | string | Always | |
| company. | enumCHECKBOXDATEDROPDOWNTEXT | Always | |
| company. | string | Can be null | Null when unset. DATE values are days (YYYY-MM-DD) in the company timezone; CHECKBOX values are the selected option names, separated by commas. |
| company. | object[] | Can be absent | |
| company. | string | Always | |
| company. | string | Always | |
| company. | string | Always | |
| company. | string | Null or absent | |
| company. | string | Always | |
| company. | string | Always | |
| company. | string | Always | |
| company. | string | Always | |
| company. | object | Null or absent | |
| company. | string | Always | |
| company. | string | Always | |
| company. | object[] | Can be absent | |
| company. | string | Always | |
| company. | string | Always | |
| company. | string | Always | |
| company. | enumBIOTRACKMETRCNONE | Always | |
| company. | boolean | Always | |
| company. | string | Null or absent | |
| company. | string | Always |
What the AI reads
Gets one company by ID — a customer, a vendor, or the user's own company (isMyCompany): the distru-search-companies summary plus its US state, description, default sales and purchase order notes, and the emails its documents go to. Contacts, locations and licenses are left out unless you pass includeContacts, includeLocations or includeLicenses. Use for a specific company after resolving its ID via distru-search-companies; to browse companies use distru-search-companies. qbCustomerId and qbVendorId are its QuickBooks customer and vendor IDs, null when not mapped. qbCustomer and qbVendor are null when mapped but Distru has no current copy of the QuickBooks record. isDeleted means QuickBooks no longer has the record, and active indicates whether the record is active in QuickBooks. An invoice sync re-maps a deleted or missing customer by name, or creates one, but fails on an inactive one. Null if no company matches the ID; a permission error if the caller can't view it.