For the complete documentation index, see llms.txt. This page is also available as Markdown.

Companies

Manage the companies stored in your Mimeeq account. Company records hold business details, delivery addresses and commercial relationships, including assigned price lists.

Use this section to synchronize company records with a CRM or ERP, retrieve company notes, and attach or detach price lists. People belonging to a company are managed through Contacts.

What you can do

Task
Reference

Find available companies

Add a new company

Read one company

Change company

Find available company notes

Change company price lists

Before you start

Your API key needs companies:read to read these resources. Use companies:write for write operations.

Important behaviour

Read Customer settings to obtain configured currency codes before creating or updating a company. General company updates replace the submitted configuration, and omitted optional arrays are cleared. Manage price-list assignments through their dedicated operation. Company deletion is not exposed by this API.

Last updated

Was this helpful?