Skip to main content

​
Summary

The Data Management API supports CRUD for core CRM and ERP records, plus workflow, report, and property-management endpoints where available.The Deal object is published in the Data Management API under /v1/public/deals.

​
Support status

ObjectListRetrieveCreateUpdateDeleteNotes
Deals (/v1/public/deals)✅✅✅✅✅Legacy /v1/public/cases aliases may still exist, but the published docs use /deals
Companies✅✅✅✅✅Upsert by external_id; soft-delete archives the record
Contacts✅✅✅✅✅Upsert by external_id; soft-delete archives the record
Orders✅✅✅✅✅Single & bulk create; soft-delete (archives record)
Items✅✅✅✅✅Upsert by external_id; soft-delete (archives record)
Inventories✅✅✅✅✅Upsert by external_id; soft-delete (archives record)
Inventory Transactions✅✅✅✅✅Soft-delete (archives record)
Subscriptions✅✅✅✅✅Soft-delete (archives record)
Estimates✅✅✅✅✅Soft-delete (archives record)
Invoices✅✅✅✅✅Soft-delete (archives record)
Purchase Orders✅✅✅✅✅Upsert by external_id; soft-delete (archives record)
Bills✅✅✅✅✅Upsert by external_id; soft-delete (archives record)
Disbursements✅✅✅✅✅Upsert by external_id; soft-delete (archives record)
Slips✅✅✅✅✅Upsert by external_id; soft-delete (archives record)
Payments✅✅✅✅✅Upsert by external_id; soft-delete (archives record)
Locations✅✅✅✅✅Upsert by external_id; soft-delete (archives record)
Meters✅✅✅✅✅Upsert by external_id; soft-delete (archives record)
Workflows✅✅✅❌❌Upsert by external_id (create/update via POST); GET /v1/public/workflows, POST /v1/public/workflows, GET /v1/public/workflows/actions, GET /v1/public/workflows/{workflow_ref}
Reports✅✅✅✅✅Salesforce-style reportMetadata; delete is soft-delete
Properties (Schema)✅✅✅✅✅Write supported for Orders, Items, Inventories, Inventory Transactions, Subscriptions, Invoices, Estimates, Payments, Purchase Orders, Bills, Disbursements, Slips, Contacts, and Companies. Cases/Locations/Meters are read-only.

​
AI endpoints

The AI endpoints live in separate API Reference groups because they use the root v1 namespace instead of /v1/public/....

​
Notes

  • Data Management endpoints use the /v1/public/... namespace.
  • AI endpoints use the root /v1 namespace.
  • Token permissions: Regular (read-only) or Full Access (read + write), plus OAuth scopes for root AI endpoints.