メインコンテンツへスキップ

​
概要

データ管理 APIでは、主要なCRM・ERPレコードに対するCRUDに加え、対応している範囲でワークフロー、レポート、プロパティ管理のエンドポイントも利用できます。Dealオブジェクトは、データ管理APIでは /v1/public/deals として公開されています。

​
対応状況

オブジェクト一覧取得作成更新削除補足
Deals (/v1/public/deals)✅✅✅✅✅旧 /v1/public/cases エイリアスが残っている場合がありますが、公開ドキュメントでは /deals を使用します
Companies✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Contacts✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Orders✅✅✅✅✅単件・一括作成に対応。削除はアーカイブです
Items✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Inventories✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Inventory Transactions✅✅✅✅✅削除はアーカイブです
Subscriptions✅✅✅✅✅削除はアーカイブです
Estimates✅✅✅✅✅削除はアーカイブです
Invoices✅✅✅✅✅削除はアーカイブです
Purchase Orders✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Bills✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Disbursements✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Slips✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Payments✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Locations✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Meters✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Workflows✅✅✅❌❌POST /v1/public/workflows で external_id によるUpsertに対応します
Reports✅✅✅✅✅Salesforce形式の reportMetadata を利用。削除はアーカイブです
Properties (Schema)✅✅✅✅✅Cases、Locations、Meters はプロパティ書き込みが読み取り専用です

​
AIエンドポイント

AIエンドポイントは /v1/public/... ではなく v1 直下の名前空間を使うため、APIリファレンス上でも別グループとして分かれています。

​
補足

  • データ管理APIは /v1/public/... 名前空間を使います。
  • AIエンドポイントは /v1 直下の名前空間を使います。
  • トークン権限は Regular（読み取りのみ） または Full Access（読み取り・書き込み） を使い、AIエンドポイントでは追加でOAuth権限も必要です。