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

概要

公開APIは主要オブジェクトの一覧取得・単体取得に対応し、受注・商品・在庫・入出庫・連絡先・企業・案件・サブスクリプション・請求・見積・発注・支払請求・出金・伝票・入金・ロケーション・メーター・レポートのCRUD(作成/更新/削除)に対応しています。さらに、ワークフローAPI(一覧/詳細/作成・更新/利用可能アクション取得)と、対応オブジェクトのカスタム項目を管理できるProperties APIにも対応しています。

対応状況

オブジェクト一覧取得単体取得作成更新削除補足
受注単発 / 一括作成・論理削除(アーカイブ)
商品external_id でUpsert / 論理削除(アーカイブ)
在庫external_id でUpsert / 論理削除(アーカイブ)
入出庫論理削除(アーカイブ)
連絡先external_id でUpsert / 論理削除(アーカイブ)
企業external_id でUpsert / 論理削除(アーカイブ)
案件external_id でUpsert / 論理削除(アーカイブ)
サブスクリプション論理削除(アーカイブ)
見積論理削除(アーカイブ)
請求論理削除(アーカイブ)
発注external_id でUpsert / 論理削除(アーカイブ)
支払請求external_id でUpsert / 論理削除(アーカイブ)
出金external_id でUpsert / 論理削除(アーカイブ)
伝票external_id でUpsert / 論理削除(アーカイブ)
入金external_id でUpsert / 論理削除(アーカイブ)
ロケーションexternal_id でUpsert / 論理削除(アーカイブ)
メーターexternal_id でUpsert / 論理削除(アーカイブ)
ワークフローexternal_id でUpsert(作成/更新は POST) / GET /v1/public/workflowsPOST /v1/public/workflowsGET /v1/public/workflows/actionsGET /v1/public/workflows/{workflow_ref}
レポートSalesforce互換の reportMetadata 形式。削除は論理削除
Properties(スキーマ)更新系は受注・商品・在庫・入出庫・サブスクリプション・請求・見積・入金・発注・支払請求・出金・伝票・連絡先・企業で対応。案件/ロケーション/メーターは読み取りのみ。

補足

  • 公開APIに含まれない機能は、APIリファレンスに表示されません。
  • 権限は Regular(読み取り専用) / Full Access(読み書き) の2種類です。