Skip to main content
Version: v1.0.0(int)

Customers

Covers customers, the master-data tables that classify them (customer types, customer segments), and brokers (reusable broker entities used on customers and SOs).

Writes

  1. Create customer — Triggered from the Customers page → "New customer". Creates a customer with name, type, segment, optional broker, parent, country, address, currency, and QBO ID.
  2. Update customer — Triggered from Customer Detail. Edits any header field including parent (hierarchy) and broker.
  3. Delete customer — Triggered from Customer Detail. Removes the customer.
  4. Bulk-import customers — Triggered from the Data page → Customers import. Uploads a CSV/Excel file to create multiple customers at once.
  5. Create customer type — Triggered from Settings → Customer types. Adds a new type (e.g., Purchaser, Location).
  6. Update customer type — Triggered from Settings → Customer types. Renames a type.
  7. Delete customer type — Triggered from Settings → Customer types. Removes a type (only allowed if no customer is currently using it).
  8. Create customer segment — Triggered from Settings → Customer segments. Adds a new segment (e.g., Club, Distributor, Grocery).
  9. Update customer segment — Triggered from Settings → Customer segments. Renames a segment.
  10. Delete customer segment — Triggered from Settings → Customer segments. Removes a segment (only allowed if no customer uses it).
  11. Create broker — Triggered from Settings → Brokers (or quick-add on a customer). Adds a new broker.
  12. Update broker — Triggered from Settings → Brokers. Renames a broker.
  13. Delete broker — Triggered from Settings → Brokers. Removes a broker (only allowed if no customer/SO uses it).

Reads

  1. List customers — Triggered from the Customers page (default view). Returns customers with header fields, optionally filtered by type or segment.
  2. Get customer detail — Triggered by clicking a customer in the list. Returns the customer with type, segment, broker, hierarchy, and contact links.
  3. List customer types — Triggered from the Customers filter dropdown, the customer create/edit form, and Settings → Customer types. Returns the available types.
  4. Check if customer type is in use — Triggered before deleting a type. Returns whether any customer uses it.
  5. List customer segments — Triggered from the Customers filter dropdown, the customer create/edit form, and Settings → Customer segments. Returns the available segments.
  6. Check if customer segment is in use — Triggered before deleting a segment. Returns whether any customer uses it.
  7. List brokers — Triggered from the customer create/edit form, the SO header form, and Settings → Brokers. Returns the available brokers.
  8. Check if broker is in use — Triggered before deleting a broker. Returns whether any customer or SO references it.