Accounts

Accounts represent 3 different types of entities within the system: Customers, Distributors, and Garmat. They all share multiple attributes but have different functionality depending on the type of account.

The Account Object

An account returned by the API may have the following fields:

• id: A UUID that uniquely represents the account in the system
• name: The name of the account in the system
• type: The type of account. This can be one of "customer", "garmat", or "distributor"
• customer_type: If it's a customer account, the type of customer account. Can be one of "consolidator", "mso", "manufacturer", "banner_or_franchise", "buying_group" or "dealer_group".
• primary_industry: If it's a customer account, the primary industry. Can be one of "automotive", "aerospace", "marine", "industrial", or "other".
• status: Whether the account is active or has been deactivated. Can be "active" or "deactivated"
• users: The number of users that belong to the account. This is only included in the index endpoint.
• facilities: The number of facilities that belong to the account. This is only included in the index endpoint.
• booths: The number of booths that belong to the account. This is only included in the index endpoint.

And here's what an example of an account could look like:

{
  "id": "057b7920-d428-4ac4-8bdb-b2375316fad7",
  "name": "Car Dealer Company",
  "type": "customer",
  "customer_type": "mso",
  "primary_industry": "automotive",
  "status": "active",
  "users": 0,
  "facilities": 0,
  "booths": 0
}