Mazrica Open API References (v1)

Download OpenAPI specification:Download

URL: https://product-senses.mazrica.com/

Overview

Mazricaユーザ向けAPIです。本ドキュメントを確認頂き、ご利用ください。また随時APIは拡張していきますので、ご希望のものがない場合は右下のチャットサポートからリクエストください。今後の開発の参考とさせて頂きます。

Introduction

Endpoints

APIのエンドポイントのベースURLは以下になります。バージョンの v1 も含めてリクエストしてください。 {PATH_TO_REQUEST} は利用するAPIのパスを指定してください。

https://senses-open-api.mazrica.com/v1/{PATH_TO_REQUEST}

Requests Limit

APIのリクエストには以下の制限があります。制限を超過した場合は 429 Too Many Requests がレスポンスされます。

50,000リクエスト / 日
- リクエスト数のリセットタイミングは UTC となります
3リクエスト / 秒 (バースト 100)
- トークンバケット方式を利用した仕組みとなります

Response Size Limit

APIレスポンスにはサイズ上限が設けられています。レスポンスの合計サイズが上限を超過した場合、500 Internal Server Error が返されます。

最大レスポンスサイズ：10MB
- レスポンスデータ全体（HTTPヘッダーを除く本文）のサイズが上限となります
- 上限を超える場合は、limit パラメータなどを調整して取得件数を減らしてください

エラーメッセージ例

レスポンスサイズが大きすぎます（12.4MB）。応答上限（10MB）を超えているため、limitパラメータを調節し取得件数を減らしてください。

Sort

リストを返す API では、要素が「更新日時の降順」でソートされて返ってきます。ソート順を変更するには sort パラメータに並び替えのキーとなるプロパティを指定します。キーの前に - (ダッシュ) をつけると降順となります。以下を参考にしてください。

更新日時の昇順でソートする場合

https://senses-open-api.mazrica.com/v1/customers?sort=updatedAt

複数指定も可能(更新日時の降順かつidの昇順)

https://senses-open-api.mazrica.com/v1/customers?sort=-updatedAt,id

Authentication

X-Api-Key

APIの利用には APK Key が必要です。以下をご参考にMazricaの管理機能から API Key を発行できます。APIをリクエストする際、発行した API Key をリクエストに含めてください。

オンラインマニュアル: MazricaAPIを利用する – Mazrica
以下のように生成した APK Key をリクエスト時のヘッダで X-Api-Key に指定してください

curl -X GET \
  https://senses-open-api.mazrica.com/v1/domains/settings \
  -H 'X-Api-Key: YOUR_API_KEY'

Security Scheme Type: API Key

Header parameter name: X-Api-Key

チーム(Domains)

チーム設定情報取得 Deprecated

所属しているチームの設定情報を取得

このエンドポイントは非推奨です。ユーザー数やチーム設定が多い場合、性能に問題が出る可能性があります。各種設定の取得には、以下の設定別エンドポイントをご利用ください。

ユーザー情報
ロール情報
取引先設定情報
案件設定情報
コンタクト設定情報

Authorizations:

X-Api-Key

Responses

Response samples

200

Content type

application/json

{"dealTypes": [{"id": 0,
"name": "string",
"phases": [{"id": 0,
"name": "string",
"status": 1
}
],
"products": [{"id": 0,
"name": "string"
}
],
"probabilities": [{"id": 0,
"name": "string"
}
],
"channels": [{"id": 0,
"name": "string"
}
],
"endPhaseReasons": [{"id": 0,
"name": "string"
}
],
"actionsPurposes": [{"id": 0,
"name": "string",
"pattern": 0,
"patternName": "string"
}
],
"dealCustomItems": [{"id": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"orderNum": "string",
"customItemOptions": [{"id": 0,
"value": "string",
"label": "string"
}
]
}
],
"dealProductDetailTypes": [{"id": 0,
"name": "string",
"dealTypeIds": [0
],
"unit": "string",
"price": 0,
"billingType": {"id": 1,
"key": "lump",
"name": "一括"
},
"roundType": {"id": 1,
"key": "round_down",
"name": "切り捨て"
},
"unitCostRoundType": {"id": 0,
"key": "none",
"name": "未設定"
},
"memo": "string"
}
]
}
],
"users": [{"id": 0,
"name": "string",
"email": "string"
}
],
"roles": [{"id": 0,
"name": "string"
}
]
}

ユーザー(Users)

ユーザー情報リスト取得

ユーザー情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

query Parameters

page	integer ページ
deleted	integer `0` 削除ユーザー取得されません `1` 削除ユーザーも含めて取得します
email	string 指定したEメールアドレスのユーザーのみ取得します

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"page": 0,
"users": [{"id": 0,
"name": "string",
"email": "string",
"userGroups": [{"id": 0,
"name": "string"
}
],
"profile": {"id": 0,
"name": "string"
},
"role": {"id": 0,
"name": "string"
}
}
]
}

ユーザーグループ(UserGroups)

ユーザーグループ情報リスト取得

ユーザーグループ情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

query Parameters

userId	integer ユーザーID
page	integer ページ

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"page": 0,
"userGroups": [{"id": 0,
"name": "string",
"orderNum": 0,
"users": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
]
}

ユーザーグループ情報更新

ユーザーグループ情報を更新

Authorizations:

X-Api-Key

path Parameters

id

required

integer

ユーザーグループID

Request Body schema: application/json

name	string or null ユーザーグループ名 name指定なし->ユーザーグループ名は更新されない nameが空文字->ユーザーグループ名は更新されない

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"orderNum": 0
}

ユーザーグループメンバー追加

指定した1つのユーザーグループに指定したユーザー1名を紐づかせます

Authorizations:

X-Api-Key

path Parameters

userGroupId required	integer ユーザーグループID
userId required	integer ユーザーID

Request Body schema: application/json

userId

integer

指定したユーザーグループに追加するユーザのID

userId指定なし->何も追加されず200を返却

Responses

Request samples

Payload

Content type

application/json

{"userId": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"orderNum": 0,
"users": [{"id": 0,
"name": "string",
"email": "string"
}
]
}

ユーザーグループメンバー除外

指定したユーザー1名を指定した1つのユーザーグループから除外します
ユーザー自体が削除されることはありません

Authorizations:

X-Api-Key

path Parameters

userGroupId required	integer ユーザーグループID
userId required	integer ユーザーID

Responses

ユーザーグループメンバー一括更新

指定した1つのユーザーグループに紐づくユーザーを指定した複数名のユーザーに更新します

Authorizations:

X-Api-Key

path Parameters

userGroupId

required

integer

ユーザーグループID

Request Body schema: application/json

userIds

Array of integers or null

ユーザーID(複数指定)

userIds指定なし->ユーザーグループメンバーは更新されない

userIds:[]->対象グループの所属ユーザーを全除外

Responses

Request samples

Payload

Content type

application/json

{"userIds": [0
]
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"orderNum": 0,
"users": [{"id": 0,
"name": "string",
"email": "string"
}
]
}

ロール(Roles)

ロール情報リスト取得

ロール情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

query Parameters

page	integer ページ

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"page": 0,
"roles": [{"id": 0,
"name": "string"
}
]
}

アクション設定(ActionSetting)

アクション設定

アクション設定の取得

Authorizations:

X-Api-Key

Responses

Response samples

200

Content type

application/json

{"actionCustomItems": [{"id": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"actionCustomItemOptions": [{"id": 0,
"value": 0,
"label": "string"
}
]
}
]
}

アクション詳細項目登録

アクション詳細項目を追加します

Authorizations:

X-Api-Key

Request Body schema: application/json

name required	string 項目名
itemKey	string 項目キー。API指定用の任意のキーを指定できます。省略した場合、自動的に一意となる値が設定されます。
itemType required	string アクション詳細項目タイプ。以下のいずれかになります。 text: テキスト date: 日付 single_select: 単一選択 multi_select: 複数選択 url: URL decimal_number: 数値(小数点あり) label: ラベル
	Array of objects 選択肢一覧。`itemType` が `single_select` もしくは `multi_select` の場合の選択肢定義を設定します。この一覧で指定した通りの並び順で登録されます。
before	string 指定した項目キーの手前に項目を追加します。指定がない場合は最後に追加されます。

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"itemKey": "string",
"itemType": "string",
"actionCustomItemOptions": [{"value": 0,
"label": "string"
}
],
"before": "string"
}

Response samples

201
400

Content type

application/json

{"id": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"actionCustomItemOptions": [{"id": 0,
"value": 0,
"label": "string"
}
]
}

アクション詳細項目更新

アクション詳細項目を更新

Authorizations:

X-Api-Key

path Parameters

item_key

required

string

項目キー

Request Body schema: application/json

name	string 項目名
newItemKey	string 新しい項目キー項目キーを変更した場合、元の項目キーの値を前提とした処理が動作しなくなる可能性があります。
	Array of objects 選択肢一覧。この一覧で指定した通りの並び順で登録されます。
delete	boolean 削除する場合は true を指定してください

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"newItemKey": "string",
"actionCustomItemOptions": [{"value": 0,
"newValue": "string",
"delete": true,
"label": "string"
}
],
"delete": true
}

Response samples

200
400

Content type

application/json

{"id": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"actionCustomItemOptions": [{"id": 0,
"value": 0,
"label": "string"
}
]
}

アクション詳細項目削除

アクション詳細項目を削除

Authorizations:

X-Api-Key

path Parameters

item_key

required

string

項目キー

Responses

アクション詳細項目ラベルリスト

アクション詳細項目ごとのラベルをリスト取得
一度に取得できる件数はデフォルトで100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

query Parameters

actionCustomItemKey required	string アクション詳細の項目キー。パス内の {actionCustomItemKey} に指定します。
searchWord	string 指定した文字列と部分一致するラベルを検索します。
sort	string 並び順 `name` でラベル昇順、`-name` でラベル降順（デフォルトはラベル昇順）
page	integer 取得対象のページ番号。デフォルトは1（1ページ目）。
limit	integer 1ページあたりの件数。最大1000。省略した場合、デフォルトは100。

Responses

Response samples

200

Content type

application/json

{"actionCustomItemKey": "string",
"totalCount": 0,
"page": 0,
"labels": [{"id": 0,
"name": "string",
"createdAt": "2018-04-01T10:30:00+09:00"
}
]
}

取引先設定(CustomerSetting)

取引先設定

取引先設定の取得

Authorizations:

X-Api-Key

Responses

Response samples

200

Content type

application/json

{"customerCustomItems": [{"id": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"orderNum": 0,
"customItemOptions": [{"id": 0,
"value": 0,
"label": "string"
}
]
}
]
}

取引先詳細項目一括登録・更新・削除

取引先詳細項目を一括登録・更新・削除します
id がある場合は更新、ない場合は新規登録としてバックエンドがidを採番します
delete: true を指定した場合は削除します（id 必須）
customItemOptions 内の選択項目も同様に delete: true で個別削除できます

Authorizations:

X-Api-Key

Request Body schema: application/json

Array

id	integer or null 取引先詳細項目ID。既存アイテムの更新時に指定します。省略した場合は新規登録として扱われます。
itemKey	string or null API項目キー
itemType required	string 取引先詳細項目タイプ。text, date, number, decimal_number, url, single_select, multi_select, user のいずれかになります。
name required	string 取引先詳細項目名
orderNum	integer 並び順
delete	boolean or null trueを指定すると該当項目を削除します。idと併せて指定してください。
	Array of objects or null 取引先詳細選択項目リスト。itemType が single_select または multi_select の場合に指定します。

Responses

Request samples

Payload

Content type

application/json

[{"id": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"orderNum": 0,
"delete": true,
"customItemOptions": [{"id": 0,
"value": 0,
"label": "string",
"orderNum": 0,
"delete": true
}
]
}
]

Response samples

200
400

Content type

application/json

{"customerCustomItems": [{"id": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"orderNum": 0,
"customItemOptions": [{"id": 0,
"value": 0,
"label": "string",
"orderNum": 0
}
]
}
],
"results": [{"requestIndex": 0,
"operation": "created",
"id": 0
}
]
}

取引先(Customers)

取引先情報リスト

取引先の情報のリスト取得
pageを指定することで続きを取得

Authorizations:

X-Api-Key

query Parameters

searchWord	string 指定した文字列と取引先名が部分一致する取引先を検索します。
sort	string 並び順ソート可能 `updatedAt`、`createdAt`
updatedAtFrom	string <date-time> Example: updatedAtFrom=2018-04-01T10:30:00 更新日時による検索範囲(開始) ex) `2018-04-01T10:30:00`
updatedAtTo	string <date-time> Example: updatedAtTo=2018-04-01T10:30:00 更新日時による検索範囲(終了) ex) `2018-04-01T10:30:00`
page	integer ページ
limit	integer 1ページあたりの件数。最大1000。省略した場合、デフォルトは100。

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"page": 0,
"customers": [{"id": 0,
"name": "string",
"companyNum": "string",
"establishYear": 0,
"industry": {"id": 0,
"name": "string"
},
"address": "string",
"telNo": "string",
"webUrl": "string",
"employee": 0,
"capital": 0,
"company": {"name": "string",
"companyNum": 0
},
"closingMonth": 0,
"ownerRole": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"customerCustoms": [{"id": 0,
"customerCustomItemId": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"customerCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
]
}
]
}

取引先情報登録

取引先情報を新規に登録します
各種IDは、取引先設定で確認できます。

Authorizations:

X-Api-Key

Request Body schema: application/json

name

required

string

取引先名

companyNum

string

企業番号。TargetタブをSales上に表示するための条件として利用されます。画面に表示される項目ではありません。法人番号は customer.company.companyNum を参照してください。

establishYear

integer

設立年（西暦）

industryId

integer

業種ID。指定したIDに対応する業種名がレスポンスの industry.name に設定されます。

id	name
1	耕種農業
2	畜産農業
3	農業サービス業
4	園芸サービス業
5	育林業
6	材木素材生産業
7	狩猟・昆虫採集業
8	水産業
9	金属鉱業
10	石炭・亜炭鉱業
11	原油・天然ガス鉱業
12	採石業，砂・砂利・玉石採取業
13	窯業原料用鉱物鉱業
14	ゼネコン
15	海洋ゼネコン
16	鉄道工事
17	土木工事業
18	舗装工事業
19	マンション開発業
20	戸建住宅開発業
21	ビル・住宅建築業（中堅ゼネコン）
22	工務店
23	建築改修工事業
24	大工工事業
25	とび・土工・コンクリート工事業
26	鉄骨・鉄筋工事業
27	石工・れんが・タイル・ブロック工事業
28	建具・屋根・防水・解体工事業
29	電気工事業
30	通信工事業
31	空調・衛生工事
32	プラント設備工事業
33	燃料タンク建設・工事業
34	乳業・乳製品製造業
35	食肉製造業
36	卵・卵加工品製造業
37	水産食料品製造業
38	野菜缶詰・果実缶詰・農産保存食料品製造業
39	調味料製造業
40	糖類製造業
41	精穀・製粉業
42	パン製造業
43	菓子製造業
44	動植物油脂製造業
45	健康食品製造業
46	冷凍食品製造業
47	惣菜類製造業
48	即席麺製造業
49	清涼飲料製造業
50	酒類製造業
51	オフィスコーヒーサービス業
52	たばこ製造業
53	飼料・有機質肥料製造業
54	製糸業，紡績業，化学繊維・ねん糸等製造業
55	織物業
56	染色整理業
57	漁業機器・備品製造業
58	繊維加工（不織布）業
59	外衣・シャツ製造業（和式を除く）
60	下着類製造業
61	和装製品・繊維製身の回り品製造業
62	寝具・絨毯・タオル製造業
63	製材業，木製品製造業
64	造作材・合板・建築用組立材料製造業
65	家具製造業
66	神仏具製造業
67	インテリア業
68	オフィス家具製造業
69	パルプ・紙製造業
70	加工紙製造業
71	印刷業
72	総合化学業
73	化学肥料製造業
74	無機化学工業製品製造業
75	有機化学工業製品製造業
76	油脂加工製品・塗料製造業
77	医療用医薬品製造業
78	後発医薬品製造業
79	一般医薬品製造業
80	化粧品・化粧調製品製造業
81	化粧品OEM
82	トイレタリー用品製造業
83	機能性化学（電子材料）業
84	機能性化学（医薬中間体）業
85	機能性化学（農薬）業
86	粘着素材・テープ製造業
87	油脂化学業
88	電池材料業
89	香料・火薬・化学薬品製造業
90	検査薬・試薬製造業
91	石油精製業
92	潤滑油・グリース製造業
93	コークス製造業
94	石油コークス・練炭類製造業
95	プラスチック板・棒・管・継手・異形押出製品製造業
96	皮革製品製造業
97	樹脂系建材・建築資材業
98	プラスチック製品製造業
99	タイヤ・チューブ製造業
100	靴・履物製造業
101	ゴムベルト・ゴムホース・工業用ゴム製品製造業
102	衛生ゴム製造業
103	なめし革・同加工品製造業
104	工業用革製品製造業
105	バッグ・身の回り品製造業
106	ガラス・同製品製造業
107	ファインセラミックス製造業
108	セメント・同製品製造業
109	窯業系建材・建築資材業
110	陶磁器・同関連製品製造業
111	耐火物製造業
112	炭素・黒鉛製品製造業
113	研磨材・同製品製造業
114	製鉄業
115	製鋼・製鋼圧延業
116	単圧鋼管・鋼板製造業
117	鋼線製造業
118	鉄素形材製造業
119	非鉄金属製錬・精製業
120	電線・ケーブル製造業
121	ブリキ缶・その他のめっき板等製品製造業
122	洋食器・刃物・手道具・金物類製造業
123	暖房装置・配管工事用附属品製造業
124	建設用・建築用金属製品製造業
125	金属素形材製品製造業
126	メッキ・熱処理加工業
127	釘・ワイヤ製造業
128	ボルト・ナット・リベット・小ねじ・木ねじ等製造業
129	スプリング製造業
130	ボイラ・原動機製造業
131	ポンプ・圧縮機器製造業
132	一般産業用機械・装置製造業
133	ベアリング製造業
134	パイプ・バルブ製造業
135	農業用機械製造業（農業用器具を除く）
136	建設機械・鉱山機械製造業
137	繊維機械製造業
138	包装機械製造業
139	食品機械製造業
140	基礎素材産業用機械製造業
141	金属加工機械製造業
142	半導体・フラットパネルディスプレイ製造装置製造業
143	ロボット製造業
144	金型製造業
145	事務用機械器具製造業
146	自動販売機製造業
147	アミューズメント機器製造業
148	情報読取機器製造業
149	計量器・測定器・分析機器・試験機・測量機械器具・理化学機械器具製造業
150	医療用機械器具・医療用品製造業
151	光学機械器具・レンズ製造業
152	電子デバイス製造業
153	コンデンサ製造業
154	音響部品製造業
155	スイッチ・コネクタ製造業
156	コイル・トランス製造業
157	抵抗器製造業
158	記録メディア製造業
159	電子回路製造業
160	分配器・ユニット部品製造業
161	モーター製造業
162	半導体素子業
163	半導体材料業
164	電源製造業
165	センサ製造業
166	ICカードベンダー
167	総合電機業
168	総合重機業
169	発電用・送電用・配電用電気機械器具製造業
170	溶接機械製造業
171	船舶機器製造業
172	電子部品製造・検査装置製造業
173	家庭用浄水器製造業
174	民生用空調機器製造業
175	業務厨房関連機器製造業
176	家事・台所用家電製造業
177	電球・電気照明器具製造業
178	電池製造業
179	電子応用装置製造業
180	電気計測器製造業
181	冷凍機・温湿調整装置製造業
182	自動車関連用品製造業
183	EMS
184	精密加工・組立業
185	水処理機械製造業
186	塗装機械製造業
187	通信機械器具（有線）製造業
188	通信機械器具（無線）製造業
189	通信機械器具（携帯電話・PHS）製造業
190	通信機械器具（アンテナ）製造業
191	通信機械器具（信号・交通機器）製造業
192	映像・音響機械器具製造業
193	カメラ製造業
194	防災・防犯機器製造業
195	PC周辺機器製造業
196	汎用コンピューター製造業
197	パーソナルコンピューター製造業
198	看板・電光表示器製造業
199	自動車製造業
200	自動車部品製造業
201	エンジン製造業
202	鉄道車両・同部分品製造業
203	造船業
204	航空機・同附属品製造業
205	産業用運搬車両・同部分品・附属品製造業
206	自転車製造業
207	貴金属・宝石製品製造業
208	時計製造業
209	楽器製造業
210	玩具製造業
211	スポーツ用品製造業
212	ベビー用品製造業
213	ペン・鉛筆・絵画用品・その他の事務用品製造業
214	眼鏡部品・コンタクト製造業
215	電気業
216	ガス業
217	熱供給業
218	上下水道業
219	固定電気通信業
220	移動電気通信業
221	通信回線販売業
222	民間放送（キー局）業
223	民間放送（地方局）業
224	有線放送業
225	システムインテグレーター
226	ネットワークインテグレーター
227	各種受託システム開発業
228	通信関連システム開発業
229	携帯・家電向けシステム開発業
230	医療情報システム開発業
231	CAD・CAMシステム開発業
232	情報セキュリティ業
233	ゲームソフト業
234	ソフトウェア（ERP）業
235	ソフトウェア（BtoC）業
236	ソフトウェア（業務支援）業
237	ソフトウェア（会計・財務）業
238	ソフトウェア（インフラ）業
239	ソフトウェア（電子商取引）業
240	金融情報サービス業
241	市場調査サービス業
242	環境調査サービス業
243	Eコマース
244	チケット取次業
245	ネット広告業
246	情報セキュリティ提供業
247	サーバーサービス業
248	インターネットサービスプロバイダー
249	ポータルサイト
250	ソーシャルネットワークサービス業
251	ソーシャルゲーム
252	専門情報サイト業
253	決済処理サービス業
254	IT保守サービス業
255	モバイルコンテンツサービス業
256	映像・CM制作業
257	アニメ企画・制作業
258	映画製作・配給業
259	音楽配信業
260	音楽レコード制作業
261	新聞業
262	フリーペーパー出版業
263	地図出版業
264	総合出版業
265	雑誌出版業
266	鉄道業
267	一般乗用旅客自動車運送業
268	バス
269	企業物流業
270	引っ越し・宅配業
271	バイク便・軽自動車運送業
272	外航海運業
273	沿海海運業
274	内陸水運業
275	航空運送業
276	航空測量業
277	国際複合輸送業
278	倉庫業
279	港湾運送業
280	こん包業
281	運輸施設提供業
282	総合商社
283	繊維品卸売業
284	衣服卸売業
285	日用品卸売業
286	食肉卸売業
287	水産物卸売業
288	農作物卸売業
289	食料・飲料卸売業
290	建築材料卸売業
291	化学製品卸売業
292	石油・鉱物卸売業
293	鉄鋼・非鉄金属卸売業
294	再生資源卸売業
295	産業機械器具卸売業
296	中古車オークション
297	電気機械器具卸売業
298	機械部品卸売業
299	電子部品・半導体卸売業
300	情報機器卸売業
301	電設資材卸売業
302	医療用機械器具卸売業
303	パイプ・バルブ卸売業
304	家具・建具・じゅう器等卸売業
305	医薬品・化粧品等卸売業
306	紙・紙製品卸売業
307	玩具卸売業
308	花き卸売業
309	百貨店
310	スーパーマーケット
311	小規模スーパー
312	総合アパレル業
313	カジュアル衣料品業
314	呉服・服地・寝具小売業
315	紳士服小売業
316	婦人服小売業
317	ベビー・子ども服小売業
318	靴・履物小売業
319	雑貨・身の回り品小売業
320	酒小売業
321	コンビニエンスストア
322	自動車ディーラー
323	中古車ディーラー
324	カー用品販売業
325	自転車小売業
326	家電量販店
327	パソコン専門店
328	携帯電話販売業
329	OA機器販売業
330	家具・インテリア
331	ドラッグストア
332	調剤薬局
333	ガソリンスタンド
334	書店
335	古本チェーン
336	スポーツ用品小売業
337	ゲームソフト小売業
338	レコード・楽器小売業
339	玩具小売業
340	眼鏡・コンタクトレンズ小売業
341	ディスカウントストア
342	100円ショップ
343	ホームセンター
344	生活雑貨小売業
345	宝石・貴金属小売業
346	リサイクルショップ
347	美術品小売業
348	ペットショップ
349	通信販売・訪問販売小売業
350	自動販売機オペレーター業
351	都市銀行
352	地方銀行
353	ネット銀行
354	信託銀行
355	貸金業
356	質屋
357	クレジットカード業，割賦金融業
358	専門ローン業
359	ネット証券
360	証券金融会社
361	証券会社
362	事業投資業
363	不動産投資業
364	投資運用業
365	商品先物取引業，商品投資業
366	補助的金融業，金融附帯業
367	生命保険業
368	損害保険業
369	保険媒介代理業
370	保険サービス業
371	総合ディベロッパー業
372	建物売買業，土地売買業
373	不動産代理業・仲介業
374	オフィス・商業施設開発・賃貸業
375	貸家業，貸間業
376	駐車場業
377	建設コンサルティング業
378	不動産管理業
379	総合リース業
380	建設機械リース業
381	建設仮設材リース業
382	物流資材製造・レンタル業
383	事務用機械器具賃貸業
384	自動車賃貸業
385	仮設建物業
386	清掃関連用具レンタル業
387	ビデオ・CDレンタル業
388	法律事務所，特許事務所
389	行政書士事務所
390	公認会計士事務所，税理士事務所
391	社会保険労務士事務所
392	デザイン業
393	経営コンサルタント業
394	人事・人材コンサルタント業
395	販促・マーケティング支援サービス業
396	アウトソーシングサービス業
397	消費者向け専門サービス業
398	広告業
399	獣医業
400	土木建築サービス業
401	写真業
402	プラントエンジニアリング・メンテナンス業
403	旅館，ホテル
404	カプセルホテル
405	保養所・リゾートクラブ
406	ファミリーレストラン
407	専門料理店
408	そば・うどん店
409	すし店
410	居酒屋
411	喫茶店
412	ファストフード
413	宅配・持ち帰り飲食サービス業
414	給食
415	洗濯業
416	美容・理容業
417	毛髪関連サービス業
418	温浴施設業
419	エステ・ネイルサロン
420	旅行業
421	家事サービス業
422	コインロッカー・荷物預り業
423	冠婚葬祭業
424	消費者向け生活関連サービス業
425	映画館
426	競輪・競馬等の競走場，競技団
427	ゴルフ場
428	フィットネスクラブ
429	公園，遊園地
430	アミューズメント施設
431	カラオケボックス
432	通信カラオケ業
433	ネットカフェ・漫画喫茶
434	学校・語学学校
435	学習塾
436	資格・社会人教育学校
437	病院
438	歯科診療所
439	療術業
440	医療関連サービス業
441	衛生用繊維製品業
442	バイオテクノロジー業
443	児童福祉事業
444	老人福祉・介護事業
445	福祉用具製造・賃貸業
446	産業廃棄物処理業
447	自動車整備業
448	機械修理業（電気機械器具を除く）
449	身の回り品修理業
450	人材紹介業
451	労働者派遣業
452	建物サービス業
453	警備業
454	ディスプレイ企画・運営業
455	NPO・官公庁・地方自治体

address

string

住所

telNo

string

電話番号

webUrl

string

URL

employee

integer

従業員数

capital

integer

資本金

closingMonth

integer [ 1 .. 12 ]

決算月（1〜12）

ownerRoleId

integer

所有ロールID。0 を指定するとロール未指定になります。

Array of objects

取引先詳細項目

Array of objects

関連付けカスタムオブジェクト

一度に登録可能な上限は1000件です

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"companyNum": "string",
"establishYear": 0,
"industryId": 0,
"address": "string",
"telNo": "string",
"webUrl": "string",
"employee": 0,
"capital": 0,
"closingMonth": 1,
"ownerRoleId": 0,
"customerCustoms": [{"customerCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
],
"customObjects": [{"id": 0,
"delete": true
}
]
}

Response samples

201

Content type

application/json

{"id": 0,
"name": "string",
"companyNum": "string",
"establishYear": 0,
"industry": {"id": 0,
"name": "string"
},
"address": "string",
"telNo": "string",
"webUrl": "string",
"employee": 0,
"capital": 0,
"company": {"name": "string",
"companyNum": 0
},
"closingMonth": 0,
"ownerRole": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"customerCustoms": [{"id": 0,
"customerCustomItemId": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"customerCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
]
}

取引先情報検索

取引先情報を検索します。

field の reference (参照先関連オブジェクト) 指定には対応していません。

Authorizations:

X-Api-Key

Request Body schema: application/json

required	object 絞り込み条件 compositeFilter と valueFilter を合わせて最大300個まで指定できます(最上位の compositeFilter は件数に含まれません)。
	object 並び替え条件。詳細項目、関連オブジェクトの項目指定の並び替えには対応していません。
page	integer ページ
limit	integer 1ページあたりの件数。最大1000。省略した場合、デフォルトは100。
compactCustoms	boolean Default: false `true` を指定した場合、詳細項目(customs)のレスポンスから冗長な項目を除外し、レスポンスサイズを削減します。
noCustoms	boolean Default: false `true` を指定した場合、詳細項目(customs)自体をレスポンスから除外します。詳細項目が不要な場合に指定することで、レスポンスサイズを大幅に削減できます。

Responses

Request samples

Payload

Content type

application/json

{"filter": {"compositeFilter": {"logicalOperator": "AND",
"subFilters": [{"compositeFilter": { },
"valueFilter": {"field": {"reference": "string",
"name": "string",
"customItemId": 0,
"itemKey": "string"
},
"comparisonOperator": "=",
"value": {"stringValue": "string",
"integerValue": 0,
"decimalValue": 0,
"datetimeValue": "2018-04-01T10:30:00"
}
}
}
]
}
},
"sort": {"field": {"name": "string"
},
"order": "ASC"
},
"page": 0,
"limit": 0,
"compactCustoms": false,
"noCustoms": false
}

Response samples

200

Content type

application/json

{"totalCount": 0,
"page": 0,
"customers": [{"id": 0,
"name": "string",
"companyNum": "string",
"establishYear": 0,
"industry": {"id": 0,
"name": "string"
},
"address": "string",
"telNo": "string",
"webUrl": "string",
"employee": 0,
"capital": 0,
"company": {"name": "string",
"companyNum": 0
},
"closingMonth": 0,
"ownerRole": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"customerCustoms": [{"id": 0,
"customerCustomItemId": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"customerCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
]
}
]
}

取引先情報

取引先情報を取得

Authorizations:

X-Api-Key

path Parameters

id

required

integer

取引先ID

query Parameters

include_related_objects

integer

1 を指定すると、関連付けオブジェクトの情報を含めて返します。

Responses

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"companyNum": "string",
"establishYear": 0,
"industry": {"id": 0,
"name": "string"
},
"address": "string",
"telNo": "string",
"webUrl": "string",
"employee": 0,
"capital": 0,
"company": {"name": "string",
"companyNum": 0
},
"closingMonth": 0,
"ownerRole": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"customerCustoms": [{"id": 0,
"customerCustomItemId": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"customerCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"customObjects": [{"id": 0,
"customObjectDefKey": "string"
}
]
}

取引先情報更新

取引先情報を更新
各種IDは、取引先設定で確認できます。

Authorizations:

X-Api-Key

path Parameters

id

required

integer

取引先ID

Request Body schema: application/json

name

string

取引先名

companyNum

string

企業番号。TargetタブをSales上に表示するための条件として利用されます。画面に表示される項目ではありません。法人番号は customer.company.companyNum を参照してください。

establishYear

integer

設立年（西暦）

industryId

integer

業種ID。指定したIDに対応する業種名がレスポンスの industry.name に設定されます。

id	name
1	耕種農業
2	畜産農業
3	農業サービス業
4	園芸サービス業
5	育林業
6	材木素材生産業
7	狩猟・昆虫採集業
8	水産業
9	金属鉱業
10	石炭・亜炭鉱業
11	原油・天然ガス鉱業
12	採石業，砂・砂利・玉石採取業
13	窯業原料用鉱物鉱業
14	ゼネコン
15	海洋ゼネコン
16	鉄道工事
17	土木工事業
18	舗装工事業
19	マンション開発業
20	戸建住宅開発業
21	ビル・住宅建築業（中堅ゼネコン）
22	工務店
23	建築改修工事業
24	大工工事業
25	とび・土工・コンクリート工事業
26	鉄骨・鉄筋工事業
27	石工・れんが・タイル・ブロック工事業
28	建具・屋根・防水・解体工事業
29	電気工事業
30	通信工事業
31	空調・衛生工事
32	プラント設備工事業
33	燃料タンク建設・工事業
34	乳業・乳製品製造業
35	食肉製造業
36	卵・卵加工品製造業
37	水産食料品製造業
38	野菜缶詰・果実缶詰・農産保存食料品製造業
39	調味料製造業
40	糖類製造業
41	精穀・製粉業
42	パン製造業
43	菓子製造業
44	動植物油脂製造業
45	健康食品製造業
46	冷凍食品製造業
47	惣菜類製造業
48	即席麺製造業
49	清涼飲料製造業
50	酒類製造業
51	オフィスコーヒーサービス業
52	たばこ製造業
53	飼料・有機質肥料製造業
54	製糸業，紡績業，化学繊維・ねん糸等製造業
55	織物業
56	染色整理業
57	漁業機器・備品製造業
58	繊維加工（不織布）業
59	外衣・シャツ製造業（和式を除く）
60	下着類製造業
61	和装製品・繊維製身の回り品製造業
62	寝具・絨毯・タオル製造業
63	製材業，木製品製造業
64	造作材・合板・建築用組立材料製造業
65	家具製造業
66	神仏具製造業
67	インテリア業
68	オフィス家具製造業
69	パルプ・紙製造業
70	加工紙製造業
71	印刷業
72	総合化学業
73	化学肥料製造業
74	無機化学工業製品製造業
75	有機化学工業製品製造業
76	油脂加工製品・塗料製造業
77	医療用医薬品製造業
78	後発医薬品製造業
79	一般医薬品製造業
80	化粧品・化粧調製品製造業
81	化粧品OEM
82	トイレタリー用品製造業
83	機能性化学（電子材料）業
84	機能性化学（医薬中間体）業
85	機能性化学（農薬）業
86	粘着素材・テープ製造業
87	油脂化学業
88	電池材料業
89	香料・火薬・化学薬品製造業
90	検査薬・試薬製造業
91	石油精製業
92	潤滑油・グリース製造業
93	コークス製造業
94	石油コークス・練炭類製造業
95	プラスチック板・棒・管・継手・異形押出製品製造業
96	皮革製品製造業
97	樹脂系建材・建築資材業
98	プラスチック製品製造業
99	タイヤ・チューブ製造業
100	靴・履物製造業
101	ゴムベルト・ゴムホース・工業用ゴム製品製造業
102	衛生ゴム製造業
103	なめし革・同加工品製造業
104	工業用革製品製造業
105	バッグ・身の回り品製造業
106	ガラス・同製品製造業
107	ファインセラミックス製造業
108	セメント・同製品製造業
109	窯業系建材・建築資材業
110	陶磁器・同関連製品製造業
111	耐火物製造業
112	炭素・黒鉛製品製造業
113	研磨材・同製品製造業
114	製鉄業
115	製鋼・製鋼圧延業
116	単圧鋼管・鋼板製造業
117	鋼線製造業
118	鉄素形材製造業
119	非鉄金属製錬・精製業
120	電線・ケーブル製造業
121	ブリキ缶・その他のめっき板等製品製造業
122	洋食器・刃物・手道具・金物類製造業
123	暖房装置・配管工事用附属品製造業
124	建設用・建築用金属製品製造業
125	金属素形材製品製造業
126	メッキ・熱処理加工業
127	釘・ワイヤ製造業
128	ボルト・ナット・リベット・小ねじ・木ねじ等製造業
129	スプリング製造業
130	ボイラ・原動機製造業
131	ポンプ・圧縮機器製造業
132	一般産業用機械・装置製造業
133	ベアリング製造業
134	パイプ・バルブ製造業
135	農業用機械製造業（農業用器具を除く）
136	建設機械・鉱山機械製造業
137	繊維機械製造業
138	包装機械製造業
139	食品機械製造業
140	基礎素材産業用機械製造業
141	金属加工機械製造業
142	半導体・フラットパネルディスプレイ製造装置製造業
143	ロボット製造業
144	金型製造業
145	事務用機械器具製造業
146	自動販売機製造業
147	アミューズメント機器製造業
148	情報読取機器製造業
149	計量器・測定器・分析機器・試験機・測量機械器具・理化学機械器具製造業
150	医療用機械器具・医療用品製造業
151	光学機械器具・レンズ製造業
152	電子デバイス製造業
153	コンデンサ製造業
154	音響部品製造業
155	スイッチ・コネクタ製造業
156	コイル・トランス製造業
157	抵抗器製造業
158	記録メディア製造業
159	電子回路製造業
160	分配器・ユニット部品製造業
161	モーター製造業
162	半導体素子業
163	半導体材料業
164	電源製造業
165	センサ製造業
166	ICカードベンダー
167	総合電機業
168	総合重機業
169	発電用・送電用・配電用電気機械器具製造業
170	溶接機械製造業
171	船舶機器製造業
172	電子部品製造・検査装置製造業
173	家庭用浄水器製造業
174	民生用空調機器製造業
175	業務厨房関連機器製造業
176	家事・台所用家電製造業
177	電球・電気照明器具製造業
178	電池製造業
179	電子応用装置製造業
180	電気計測器製造業
181	冷凍機・温湿調整装置製造業
182	自動車関連用品製造業
183	EMS
184	精密加工・組立業
185	水処理機械製造業
186	塗装機械製造業
187	通信機械器具（有線）製造業
188	通信機械器具（無線）製造業
189	通信機械器具（携帯電話・PHS）製造業
190	通信機械器具（アンテナ）製造業
191	通信機械器具（信号・交通機器）製造業
192	映像・音響機械器具製造業
193	カメラ製造業
194	防災・防犯機器製造業
195	PC周辺機器製造業
196	汎用コンピューター製造業
197	パーソナルコンピューター製造業
198	看板・電光表示器製造業
199	自動車製造業
200	自動車部品製造業
201	エンジン製造業
202	鉄道車両・同部分品製造業
203	造船業
204	航空機・同附属品製造業
205	産業用運搬車両・同部分品・附属品製造業
206	自転車製造業
207	貴金属・宝石製品製造業
208	時計製造業
209	楽器製造業
210	玩具製造業
211	スポーツ用品製造業
212	ベビー用品製造業
213	ペン・鉛筆・絵画用品・その他の事務用品製造業
214	眼鏡部品・コンタクト製造業
215	電気業
216	ガス業
217	熱供給業
218	上下水道業
219	固定電気通信業
220	移動電気通信業
221	通信回線販売業
222	民間放送（キー局）業
223	民間放送（地方局）業
224	有線放送業
225	システムインテグレーター
226	ネットワークインテグレーター
227	各種受託システム開発業
228	通信関連システム開発業
229	携帯・家電向けシステム開発業
230	医療情報システム開発業
231	CAD・CAMシステム開発業
232	情報セキュリティ業
233	ゲームソフト業
234	ソフトウェア（ERP）業
235	ソフトウェア（BtoC）業
236	ソフトウェア（業務支援）業
237	ソフトウェア（会計・財務）業
238	ソフトウェア（インフラ）業
239	ソフトウェア（電子商取引）業
240	金融情報サービス業
241	市場調査サービス業
242	環境調査サービス業
243	Eコマース
244	チケット取次業
245	ネット広告業
246	情報セキュリティ提供業
247	サーバーサービス業
248	インターネットサービスプロバイダー
249	ポータルサイト
250	ソーシャルネットワークサービス業
251	ソーシャルゲーム
252	専門情報サイト業
253	決済処理サービス業
254	IT保守サービス業
255	モバイルコンテンツサービス業
256	映像・CM制作業
257	アニメ企画・制作業
258	映画製作・配給業
259	音楽配信業
260	音楽レコード制作業
261	新聞業
262	フリーペーパー出版業
263	地図出版業
264	総合出版業
265	雑誌出版業
266	鉄道業
267	一般乗用旅客自動車運送業
268	バス
269	企業物流業
270	引っ越し・宅配業
271	バイク便・軽自動車運送業
272	外航海運業
273	沿海海運業
274	内陸水運業
275	航空運送業
276	航空測量業
277	国際複合輸送業
278	倉庫業
279	港湾運送業
280	こん包業
281	運輸施設提供業
282	総合商社
283	繊維品卸売業
284	衣服卸売業
285	日用品卸売業
286	食肉卸売業
287	水産物卸売業
288	農作物卸売業
289	食料・飲料卸売業
290	建築材料卸売業
291	化学製品卸売業
292	石油・鉱物卸売業
293	鉄鋼・非鉄金属卸売業
294	再生資源卸売業
295	産業機械器具卸売業
296	中古車オークション
297	電気機械器具卸売業
298	機械部品卸売業
299	電子部品・半導体卸売業
300	情報機器卸売業
301	電設資材卸売業
302	医療用機械器具卸売業
303	パイプ・バルブ卸売業
304	家具・建具・じゅう器等卸売業
305	医薬品・化粧品等卸売業
306	紙・紙製品卸売業
307	玩具卸売業
308	花き卸売業
309	百貨店
310	スーパーマーケット
311	小規模スーパー
312	総合アパレル業
313	カジュアル衣料品業
314	呉服・服地・寝具小売業
315	紳士服小売業
316	婦人服小売業
317	ベビー・子ども服小売業
318	靴・履物小売業
319	雑貨・身の回り品小売業
320	酒小売業
321	コンビニエンスストア
322	自動車ディーラー
323	中古車ディーラー
324	カー用品販売業
325	自転車小売業
326	家電量販店
327	パソコン専門店
328	携帯電話販売業
329	OA機器販売業
330	家具・インテリア
331	ドラッグストア
332	調剤薬局
333	ガソリンスタンド
334	書店
335	古本チェーン
336	スポーツ用品小売業
337	ゲームソフト小売業
338	レコード・楽器小売業
339	玩具小売業
340	眼鏡・コンタクトレンズ小売業
341	ディスカウントストア
342	100円ショップ
343	ホームセンター
344	生活雑貨小売業
345	宝石・貴金属小売業
346	リサイクルショップ
347	美術品小売業
348	ペットショップ
349	通信販売・訪問販売小売業
350	自動販売機オペレーター業
351	都市銀行
352	地方銀行
353	ネット銀行
354	信託銀行
355	貸金業
356	質屋
357	クレジットカード業，割賦金融業
358	専門ローン業
359	ネット証券
360	証券金融会社
361	証券会社
362	事業投資業
363	不動産投資業
364	投資運用業
365	商品先物取引業，商品投資業
366	補助的金融業，金融附帯業
367	生命保険業
368	損害保険業
369	保険媒介代理業
370	保険サービス業
371	総合ディベロッパー業
372	建物売買業，土地売買業
373	不動産代理業・仲介業
374	オフィス・商業施設開発・賃貸業
375	貸家業，貸間業
376	駐車場業
377	建設コンサルティング業
378	不動産管理業
379	総合リース業
380	建設機械リース業
381	建設仮設材リース業
382	物流資材製造・レンタル業
383	事務用機械器具賃貸業
384	自動車賃貸業
385	仮設建物業
386	清掃関連用具レンタル業
387	ビデオ・CDレンタル業
388	法律事務所，特許事務所
389	行政書士事務所
390	公認会計士事務所，税理士事務所
391	社会保険労務士事務所
392	デザイン業
393	経営コンサルタント業
394	人事・人材コンサルタント業
395	販促・マーケティング支援サービス業
396	アウトソーシングサービス業
397	消費者向け専門サービス業
398	広告業
399	獣医業
400	土木建築サービス業
401	写真業
402	プラントエンジニアリング・メンテナンス業
403	旅館，ホテル
404	カプセルホテル
405	保養所・リゾートクラブ
406	ファミリーレストラン
407	専門料理店
408	そば・うどん店
409	すし店
410	居酒屋
411	喫茶店
412	ファストフード
413	宅配・持ち帰り飲食サービス業
414	給食
415	洗濯業
416	美容・理容業
417	毛髪関連サービス業
418	温浴施設業
419	エステ・ネイルサロン
420	旅行業
421	家事サービス業
422	コインロッカー・荷物預り業
423	冠婚葬祭業
424	消費者向け生活関連サービス業
425	映画館
426	競輪・競馬等の競走場，競技団
427	ゴルフ場
428	フィットネスクラブ
429	公園，遊園地
430	アミューズメント施設
431	カラオケボックス
432	通信カラオケ業
433	ネットカフェ・漫画喫茶
434	学校・語学学校
435	学習塾
436	資格・社会人教育学校
437	病院
438	歯科診療所
439	療術業
440	医療関連サービス業
441	衛生用繊維製品業
442	バイオテクノロジー業
443	児童福祉事業
444	老人福祉・介護事業
445	福祉用具製造・賃貸業
446	産業廃棄物処理業
447	自動車整備業
448	機械修理業（電気機械器具を除く）
449	身の回り品修理業
450	人材紹介業
451	労働者派遣業
452	建物サービス業
453	警備業
454	ディスプレイ企画・運営業
455	NPO・官公庁・地方自治体

address

string

住所

telNo

string

電話番号

webUrl

string

URL

employee

integer

従業員数

capital

integer

資本金

closingMonth

integer [ 1 .. 12 ]

決算月（1〜12）

ownerRoleId

integer

所有ロールID。0 を指定するとロール未指定になります。

Array of objects

取引先詳細項目

Array of objects

関連付けカスタムオブジェクト

一度に登録可能な上限は1000件です

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"companyNum": "string",
"establishYear": 0,
"industryId": 0,
"address": "string",
"telNo": "string",
"webUrl": "string",
"employee": 0,
"capital": 0,
"closingMonth": 1,
"ownerRoleId": 0,
"customerCustoms": [{"customerCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
],
"customObjects": [{"id": 0,
"delete": true
}
]
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"companyNum": "string",
"establishYear": 0,
"industry": {"id": 0,
"name": "string"
},
"address": "string",
"telNo": "string",
"webUrl": "string",
"employee": 0,
"capital": 0,
"company": {"name": "string",
"companyNum": 0
},
"closingMonth": 0,
"ownerRole": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"customerCustoms": [{"id": 0,
"customerCustomItemId": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"customerCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
]
}

取引先情報削除

取引先情報を削除
取引先に紐づく案件、アクション、コンタクトは全て削除されます

Authorizations:

X-Api-Key

path Parameters

id

required

integer

取引先ID

Responses

取引先一括登録

取引先を一括登録します
一度に登録可能な上限は1000件です
各種IDは、取引先設定で確認できます
このAPIを使って登録した場合、Mazrica登録企業との自動紐付けは行われません
このAPIを使って登録した場合、監査ログは記録されません

Authorizations:

X-Api-Key

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"customers": [{"name": "string",
"companyNum": "string",
"establishYear": 0,
"industryId": 0,
"address": "string",
"telNo": "string",
"webUrl": "string",
"employee": 0,
"capital": 0,
"closingMonth": 1,
"ownerRoleId": 0,
"customerCustoms": [{"customerCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
]
}
]
}

Response samples

200
400

Content type

application/json

[0
]

取引先情報一括更新

取引先情報を一括更新します
一度に更新可能な上限は1000件です
各種IDは、取引先設定で確認できます
このAPIを使って更新した場合、監査ログは記録されません

Authorizations:

X-Api-Key

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"customers": [{"name": "string",
"companyNum": "string",
"establishYear": 0,
"industryId": 0,
"address": "string",
"telNo": "string",
"webUrl": "string",
"employee": 0,
"capital": 0,
"closingMonth": 1,
"ownerRoleId": 0,
"customerCustoms": [{"customerCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
],
"id": 0
}
]
}

Response samples

400

Content type

application/json

{"error": "string",
"messages": ["string"
],
"bulkErrors": [{"index": 0,
"messages": ["string"
]
}
]
}

取引先アクション(CustomerActions)

取引先アクション情報リスト

アクション情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

path Parameters

customerId

required

integer

取引先IDを指定してアクションを検索します。

取引先IDの代わりに、allと指定することで取引先IDを跨いだアクションの取得が可能です。

query Parameters

sort	string 並び順ソート可能 `startDatetime`
startDatetime	string <date-time> Example: startDatetime=2018-04-01T10:30:00 開始日時 ex) startDatetime=2019-01-01T09:00 endDatetime=2019-01-01T11:00 上記のように指定した場合、開始日時2019-01-01 09:00 から終了日時2019-01-01 11:00のアクションを検索します。
endDatetime	string <date-time> Example: endDatetime=2018-04-01T10:30:00 終了日時 ex) startDatetime=2019-01-01T09:00 endDatetime=2019-01-01T11:00 上記のように指定した場合、開始日時2019-01-01 09:00 から終了日時2019-01-01 11:00のアクションを検索します。
createdAtFrom	string <date-time> Example: createdAtFrom=2018-04-01T10:30:00 登録日時開始時間 ex) createdAtFrom=2019-01-01T09:00 createdAtTo=2019-01-01T11:00 上記のように指定した場合、登録日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
createdAtTo	string <date-time> Example: createdAtTo=2018-04-01T10:30:00 登録日時終了時間 ex) createdAtFrom=2019-01-01T09:00 createdAtTo=2019-01-01T11:00 上記のように指定した場合、登録日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
updatedAtFrom	string <date-time> Example: updatedAtFrom=2018-04-01T10:30:00 最終更新日時開始時間 ex) updatedAtFrom=2019-01-01T09:00 updatedAtTo=2019-01-01T11:00 上記のように指定した場合、最終更新日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
updatedAtTo	string <date-time> Example: updatedAtTo=2018-04-01T10:30:00 最終更新日時終了時間 ex) updatedAtFrom=2019-01-01T09:00 updatedAtTo=2019-01-01T11:00 上記のように指定した場合、最終更新日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
	Array of objects アクション担当者、その他の担当者を検索します。 GETパラメータで指定する場合、以下の形式で指定します。 `?users[]id=1&users[]id=2`
pattern	integer アクションの種別
active	boolean true:予定 false:完了
page	integer ページ

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"page": 0,
"actions": [{"id": 0,
"pattern": {"id": 0,
"name": "string"
},
"contacts": [{"id": 0,
"name": "string",
"email": "string",
"tel": "string",
"mobileTel": "string",
"address": "string",
"dept": "string",
"position": "string",
"memo": "string",
"marketoLeadScore": 0,
"customer": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"contactCustoms": [{"id": 0,
"contactCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"lifecycleStages": [{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
],
"customer": {"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"creator": {"id": 0,
"name": "string"
},
"invitees": [{"id": 0,
"name": "string"
}
],
"actionCustoms": [{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
]
}
]
}

取引先アクション登録

アクションを新規に登録します

Authorizations:

X-Api-Key

Request Body schema: application/json

startDatetime required	string <date-time> 開始日時
endDatetime required	string <date-time> 終了日時
required	object アクション担当者ID
	Array of objects 他の担当者
preNote	string アクションの事前メモ
result	string アクションの実施結果
active	boolean アクションの状態(true=未完了、false=完了)
required	object
	Array of objects アクションコンタクト
	Array of objects アクション詳細項目一覧

Responses

Request samples

Payload

Content type

application/json

{"startDatetime": "2018-04-01T10:30:00+09:00",
"endDatetime": "2018-04-01T10:30:00+09:00",
"creator": {"id": 0
},
"invitees": [{"id": 0
}
],
"preNote": "string",
"result": "string",
"active": true,
"pattern": {"id": 0
},
"contacts": [{"id": 0
}
],
"actionCustoms": [{"itemKey": "string",
"value": "テキスト"
}
]
}

Response samples

201

Content type

application/json

{"id": 0,
"pattern": {"id": 0,
"name": "string"
},
"contacts": [{"id": 0,
"name": "string",
"email": "string",
"tel": "string",
"mobileTel": "string",
"address": "string",
"dept": "string",
"position": "string",
"memo": "string",
"marketoLeadScore": 0,
"customer": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"contactCustoms": [{"id": 0,
"contactCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"lifecycleStages": [{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
],
"customer": {"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"creator": {"id": 0,
"name": "string"
},
"invitees": [{"id": 0,
"name": "string"
}
],
"actionCustoms": [{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
]
}

取引先アクション情報

アクション情報を取得

Authorizations:

X-Api-Key

path Parameters

customerId required	integer 取引先ID
id required	integer アクションID

query Parameters

include_files

integer

1 を指定すると、添付ファイルの情報を含めて返します。

Responses

Response samples

200

Content type

application/json

{"id": 0,
"pattern": {"id": 0,
"name": "string"
},
"contacts": [{"id": 0,
"name": "string",
"email": "string",
"tel": "string",
"mobileTel": "string",
"address": "string",
"dept": "string",
"position": "string",
"memo": "string",
"marketoLeadScore": 0,
"customer": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"contactCustoms": [{"id": 0,
"contactCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"lifecycleStages": [{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
],
"customer": {"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"creator": {"id": 0,
"name": "string"
},
"invitees": [{"id": 0,
"name": "string"
}
],
"actionCustoms": [{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
],
"files": [{"name": "string",
"mimeType": "string",
"url": "string"
}
]
}

取引先アクション情報更新

アクション情報を更新

Authorizations:

X-Api-Key

path Parameters

customerId required	integer 取引先ID
id required	integer アクションID

Request Body schema: application/json

startDatetime	string <date-time> 開始日時
endDatetime	string <date-time> 終了日時
	object アクション担当者ID
	Array of objects 他の担当者
preNote	string アクションの事前メモ
result	string アクションの実施結果
active	boolean アクションの状態(true=未完了、false=完了)
	object
	Array of objects アクションコンタクト
	Array of objects アクション詳細項目一覧

Responses

Request samples

Payload

Content type

application/json

{"startDatetime": "2018-04-01T10:30:00+09:00",
"endDatetime": "2018-04-01T10:30:00+09:00",
"creator": {"id": 0
},
"invitees": [{"id": 0
}
],
"preNote": "string",
"result": "string",
"active": true,
"pattern": {"id": 0
},
"contacts": [{"id": 0
}
],
"actionCustoms": [{"itemKey": "string",
"value": "テキスト"
}
]
}

Response samples

200

Content type

application/json

{"id": 0,
"pattern": {"id": 0,
"name": "string"
},
"contacts": [{"id": 0,
"name": "string",
"email": "string",
"tel": "string",
"mobileTel": "string",
"address": "string",
"dept": "string",
"position": "string",
"memo": "string",
"marketoLeadScore": 0,
"customer": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"contactCustoms": [{"id": 0,
"contactCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"lifecycleStages": [{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
],
"customer": {"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"creator": {"id": 0,
"name": "string"
},
"invitees": [{"id": 0,
"name": "string"
}
],
"actionCustoms": [{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
]
}

取引先アクション情報削除

アクション情報を削除

Authorizations:

X-Api-Key

path Parameters

customerId required	integer 取引先ID
id required	integer アクションID

Responses

取引先アクション一括登録

取引先アクションを一括登録します
一度に登録可能な上限は1000件です
このAPIを使って登録した場合、監査ログは記録されません

Authorizations:

X-Api-Key

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"actions": [{"customer": {"id": 0
},
"startDatetime": "2018-04-01T10:30:00+09:00",
"endDatetime": "2018-04-01T10:30:00+09:00",
"creator": {"id": 0
},
"invitees": [{"id": 0
}
],
"preNote": "string",
"result": "string",
"active": true,
"pattern": {"id": 0
},
"contacts": [{"id": 0
}
],
"actionCustoms": [{"itemKey": "string",
"value": "テキスト"
}
],
"files": [{"name": "string",
"path": "string"
}
]
}
]
}

Response samples

200
400

Content type

application/json

[0
]

案件設定(DealSetting)

案件タイプリスト

案件タイプのリスト取得

Authorizations:

X-Api-Key

Responses

Response samples

200

Content type

application/json

{"id": 0,
"name": "string"
}

案件タイプ設定情報

案件タイプ設定情報

Authorizations:

X-Api-Key

path Parameters

id

required

integer

案件タイプID

Responses

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"phases": [{"id": 0,
"name": "string",
"status": 1
}
],
"products": [{"id": 0,
"name": "string"
}
],
"probabilities": [{"id": 0,
"name": "string"
}
],
"channels": [{"id": 0,
"name": "string"
}
],
"endPhaseReasons": [{"id": 0,
"name": "string"
}
],
"actionsPurposes": [{"id": 0,
"name": "string",
"pattern": 0,
"patternName": "string",
"orderNum": 0
}
],
"dealCustomItems": [{"id": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"orderNum": "string",
"customItemOptions": [{"id": 0,
"value": "string",
"label": "string"
}
]
}
],
"dealProductDetailTypes": [{"id": 0,
"name": "string",
"dealTypeIds": [0
],
"unit": "string",
"price": 0,
"billingType": {"id": 1,
"key": "lump",
"name": "一括"
},
"roundType": {"id": 1,
"key": "round_down",
"name": "切り捨て"
},
"unitCostRoundType": {"id": 0,
"key": "none",
"name": "未設定"
},
"memo": "string"
}
],
"dealCustomerTypes": [{"id": 0,
"name": "string",
"orderNum": 0
}
],
"dealRequiredFields": [{"phaseId": 0,
"amount": true,
"dealProductDetail": true,
"dealCustomItemIds": [0
]
}
]
}

商品内訳設定(DealProductDetailTypes)

商品内訳設定リスト

商品内訳設定リストの取得
一度に取得できる件数はデフォルトで100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

query Parameters

dealTypeId	integer 案件タイプID。未指定時はドメイン全ての商品内訳設定を取得。指定時は指定案件タイプで利用可能な商品内訳設定を取得。 `dealTypeId[]=1&dealTypeId[]=2` のような形式で指定することで複数にも対応できます。
sort	string 並び順ソート可能 `createdAt` `updatedAt` `name` 未指定時は `id` 昇順になります
page	integer 取得対象のページ番号。デフォルトは1（1ページ目）。
limit	integer 1ページあたりの件数。最大1000。省略した場合、デフォルトは100。

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"page": 0,
"dealProductDetailTypes": [{"id": 0,
"name": "string",
"dealTypeIds": [0
],
"unit": "string",
"price": 0,
"billingType": {"id": 1,
"key": "lump",
"name": "一括"
},
"roundType": {"id": 1,
"key": "round_down",
"name": "切り捨て"
},
"unitCostRoundType": {"id": 0,
"key": "none",
"name": "未設定"
},
"memo": "string",
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"dealProductDetailTypeCustoms": {"property1": {"id": 0,
"itemType": "string",
"name": "string",
"text": "テキスト",
"selectedOption": {"dealProductDetailTypeCustomItemOptionId": 0,
"label": "string"
},
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56"
},
"property2": {"id": 0,
"itemType": "string",
"name": "string",
"text": "テキスト",
"selectedOption": {"dealProductDetailTypeCustomItemOptionId": 0,
"label": "string"
},
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56"
}
}
}
]
}

商品内訳設定カスタム項目リスト

商品内訳設定カスタム項目リストの取得

Authorizations:

X-Api-Key

query Parameters

dealTypeId

integer

案件タイプID。

未指定時はドメイン全ての商品内訳設定カスタム項目を取得。
指定時は指定案件タイプで利用可能な商品内訳設定カスタム項目を取得。

dealTypeId[]=1&dealTypeId[]=2 のような形式で指定することで複数にも対応できます。

Responses

Response samples

200

Content type

application/json

{"dealProductDetailTypeCustomItems": [{"id": 0,
"dealTypeId": 0,
"dealTypeIds": [0
],
"name": "string",
"itemType": "string",
"orderNum": 0,
"itemKey": "string",
"dealProductDetailTypeCustomItemOptions": [{"id": 0,
"label": "string"
}
]
}
]
}

商品内訳設定一括登録

商品内訳設定を一括登録します
一度に登録可能な上限は1000件です
このAPIを使って登録した場合、監査ログは記録されません

Authorizations:

X-Api-Key

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"dealProductDetailTypes": [{"name": "商品内訳設定名",
"dealTypeIds": [1,
2,
3
],
"price": "123.45",
"unitCost": "123.45",
"quantity": "123.45",
"unit": "123.45",
"billingTypeId": 1,
"roundTypeId": 1,
"unitCostRoundTypeId": 0,
"grossProfitMargin": "99.99999",
"enableAutoCalculatePrice": "true",
"memo": "memo",
"dealProductDetailTypeCustoms": [{"dealProductDetailTypeCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
]
}
]
}

Response samples

200
400

Content type

application/json

[0
]

商品内訳設定一括更新

商品内訳設定を一括更新します
一度に更新可能な上限は1000件です
このAPIを使って更新した場合、監査ログは記録されません

Authorizations:

X-Api-Key

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"dealProductDetailTypes": [{"id": 1,
"name": "商品内訳設定名",
"dealTypeIds": [1,
2,
3
],
"price": "123.45",
"unitCost": "123.45",
"quantity": "123",
"unit": "123.45",
"grossProfitMargin": "123.45",
"enableAutoCalculatePrice": "true",
"memo": "memo",
"dealProductDetailTypeCustoms": [{"dealProductDetailTypeCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
]
}
]
}

Response samples

400

Content type

application/json

{"error": "string",
"messages": ["string"
],
"bulkErrors": [{"index": 0,
"messages": ["string"
]
}
]
}

案件(Deals)

案件情報リスト

案件情報のリスト取得
pageを指定することで続きを取得

Authorizations:

X-Api-Key

query Parameters

searchWord	string 指定した文字列と取引先名、または案件名が部分一致する案件を検索します。
dealTypeId	number 案件タイプID
sort	string 並び順ソート可能 `updatedAt`、`createdAt`
updatedAtFrom	string <date-time> Example: updatedAtFrom=2018-04-01T10:30:00 更新日時による検索範囲（開始） ex) `2018-04-01T10:30:00`
updatedAtTo	string <date-time> Example: updatedAtTo=2018-04-01T10:30:00 更新日時による検索範囲指定（終了） ex) `2018-04-01T10:30:00`
page	integer ページ
limit	integer 1ページあたりの件数。最大1000。省略した場合、デフォルトは100。
itemKeyAsPropertyKey	string Default: "false" Example: itemKeyAsPropertyKey=true `true` を指定した場合、詳細項目のレスポンス形式が itemKey(API項目キー) をプロパティキーとしたオブジェクトになります。 itemKey は管理者設定画面で「API項目キー」として任意の値を設定可能です。 itemKey が未設定の場合、プロパティキーとして詳細項目IDを文字列型に変換した値が使われます。

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"page": 0,
"deals": [{"id": 0,
"name": "string",
"amount": 0,
"closingLeadtime": 0,
"fromEmail": true,
"memo": "string",
"expectedContractDate": "2018-04-11",
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"reason": "string",
"dealType": {"id": 0,
"name": "string"
},
"endPhaseReasons": [{"id": 0,
"name": "string"
}
],
"customer": {"id": 0,
"name": "string"
},
"phase": {"id": 0,
"name": "string",
"status": 1
},
"phaseStayDays": [{"id": 0,
"name": "string",
"phaseStayDays": 0,
"isCurrentPhase": true
}
],
"product": {"id": 0,
"name": "string"
},
"probability": {"id": 0,
"name": "string"
},
"channel": {"id": 0,
"name": "string"
},
"user": {"id": 0,
"name": "string"
},
"dealCustoms": [{"id": 0,
"dealCustomItemId": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"calculationResult": 0,
"selectedValue": 1,
"selectedOption": {"value": 0,
"label": "string",
"dealCustomItemOptionId": 0
},
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"dealCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"dealProductDetails": [{"id": 0,
"dealProductDetailTypeId": 0,
"name": "string",
"billingType": {"id": 1,
"key": "lump",
"name": "一括"
},
"quantity": 0,
"unit": "string",
"price": 0,
"unitCost": 0,
"term": 0,
"subtotal": 0,
"firstSales": "2018-04-01T00:00:00+09:00",
"memo": "string",
"dealProductDetailCustoms": [{"property1": {"id": 0,
"dealProductDetailTypeCustomItemId": 0,
"itemType": "string",
"name": "string",
"text": "テキスト",
"selectedOption": {"dealProductDetailTypeCustomItemOptionId": 0,
"label": "string"
},
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56"
},
"property2": {"id": 0,
"dealProductDetailTypeCustomItemId": 0,
"itemType": "string",
"name": "string",
"text": "テキスト",
"selectedOption": {"dealProductDetailTypeCustomItemOptionId": 0,
"label": "string"
},
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56"
}
}
]
}
],
"dealCustomerTypes": [{"dealCustomerType": {"id": 0,
"name": "string"
},
"customers": [{"id": 0,
"name": "string"
}
]
}
]
}
]
}

案件情報登録

案件情報を新規に登録します
各種IDは、案件タイプ設定情報で確認できます

Authorizations:

X-Api-Key

query Parameters

itemKeyAsPropertyKey

string

Default: "false"

Example: itemKeyAsPropertyKey=true

true を指定した場合、詳細項目のレスポンス形式が itemKey(API項目キー) をプロパティキーとしたオブジェクトになります。

itemKey は管理者設定画面で「API項目キー」として任意の値を設定可能です。

itemKey が未設定の場合、プロパティキーとして詳細項目IDを文字列型に変換した値が使われます。

Request Body schema: application/json

required	object 案件タイプ
name required	string 案件名
amount	integer 契約金額
expectedContractDate required	string <date> 契約予定日
reason	string 最終停止理由
endPhaseReasonIds	Array of integers 最終停止理由ID 配列
	Array of objects 商品内訳
required	object 取引先
required	object フェーズ
required	object 商品
required	object 契約確度
required	object チャネル
required	object ユーザー
	Array of objects 案件詳細項目
	Array of objects 関連取引先
	Array of objects 関連付けカスタムオブジェクト一度に登録可能な上限は1000件です

Responses

Request samples

Payload

Content type

application/json

{"dealType": {"id": 0
},
"name": "string",
"amount": 0,
"expectedContractDate": "2018-04-11",
"reason": "string",
"endPhaseReasonIds": [0
],
"dealProductDetails": [{"id": 0,
"dealProductDetailTypeId": 0,
"quantity": 0,
"price": 0,
"unitCost": 0,
"term": 0,
"firstSales": "2018-04-01T00:00:00+09:00",
"memo": "string",
"dealProductDetailCustoms": [{"dealProductDetailTypeCustomItemId": 0,
"value": "string"
}
],
"deleted": true
}
],
"customer": {"id": 0
},
"phase": {"id": 0
},
"product": {"id": 0
},
"probability": {"id": 0
},
"channel": {"id": 0
},
"user": {"id": 0
},
"dealCustoms": [{"dealCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
],
"dealCustomers": [{"dealCustomerTypeId": 1,
"customerId": 200
}
],
"customObjects": [{"id": 0,
"delete": true
}
]
}

Response samples

201

Content type

application/json

{"id": 0,
"name": "string",
"amount": 0,
"closingLeadtime": 0,
"fromEmail": true,
"memo": "string",
"expectedContractDate": "2018-04-11",
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"reason": "string",
"dealType": {"id": 0,
"name": "string"
},
"endPhaseReasons": [{"id": 0,
"name": "string"
}
],
"customer": {"id": 0,
"name": "string"
},
"phase": {"id": 0,
"name": "string",
"status": 1
},
"phaseStayDays": [{"id": 0,
"name": "string",
"phaseStayDays": 0,
"isCurrentPhase": true
}
],
"product": {"id": 0,
"name": "string"
},
"probability": {"id": 0,
"name": "string"
},
"channel": {"id": 0,
"name": "string"
},
"user": {"id": 0,
"name": "string"
},
"dealCustoms": [{"id": 0,
"dealCustomItemId": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"calculationResult": 0,
"selectedValue": 1,
"selectedOption": {"value": 0,
"label": "string",
"dealCustomItemOptionId": 0
},
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"dealCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"dealProductDetails": [{"id": 0,
"dealProductDetailTypeId": 0,
"name": "string",
"billingType": {"id": 1,
"key": "lump",
"name": "一括"
},
"quantity": 0,
"unit": "string",
"price": 0,
"unitCost": 0,
"term": 0,
"subtotal": 0,
"firstSales": "2018-04-01T00:00:00+09:00",
"memo": "string",
"dealProductDetailCustoms": [{"property1": {"id": 0,
"dealProductDetailTypeCustomItemId": 0,
"itemType": "string",
"name": "string",
"text": "テキスト",
"selectedOption": {"dealProductDetailTypeCustomItemOptionId": 0,
"label": "string"
},
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56"
},
"property2": {"id": 0,
"dealProductDetailTypeCustomItemId": 0,
"itemType": "string",
"name": "string",
"text": "テキスト",
"selectedOption": {"dealProductDetailTypeCustomItemOptionId": 0,
"label": "string"
},
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56"
}
}
]
}
],
"dealCustomerTypes": [{"dealCustomerType": {"id": 0,
"name": "string"
},
"customers": [{"id": 0,
"name": "string"
}
]
}
]
}

案件情報検索

案件情報を検索します。

field の reference (参照先関連オブジェクト) 指定には対応していません。
基本項目で検索対象として指定可能な field.name は以下の通りです。
- id (integer) - 案件ID
- name (string) - 案件名
- amount (integer) - 契約金額
- expectedContractDate (datetime) - 契約予定日
- memo (string) - メモ
- reason (string) - 最終停止理由
- customerId (integer) - 取引先ID
- userId (integer) - 担当者ID
- phaseId (integer) - フェーズID
- productId (integer) - 商品ID
- channelId (integer) - チャネルID
- probabilityId (integer) - 確度ID
- dealTypeId (integer) - 案件タイプID
- createdAt (datetime) - 作成日時
- updatedAt (datetime) - 更新日時
カスタム項目は field.customItemId または field.itemKey で指定できます。

Authorizations:

X-Api-Key

Request Body schema: application/json

required	object 絞り込み条件 compositeFilter と valueFilter を合わせて最大300個まで指定できます(最上位の compositeFilter は件数に含まれません)。
	object 並び替え条件。詳細項目、関連オブジェクトの項目指定の並び替えには対応していません。
page	integer ページ
limit	integer 1ページあたりの件数。最大1000。省略した場合、デフォルトは100。
compactCustoms	boolean Default: false `true` を指定した場合、詳細項目(customs)のレスポンスから冗長な項目を除外し、レスポンスサイズを削減します。
noCustoms	boolean Default: false `true` を指定した場合、詳細項目(customs)自体をレスポンスから除外します。詳細項目が不要な場合に指定することで、レスポンスサイズを大幅に削減できます。

Responses

Request samples

Payload

Content type

application/json

{"filter": {"compositeFilter": {"logicalOperator": "AND",
"subFilters": [{"compositeFilter": { },
"valueFilter": {"field": {"reference": "string",
"name": "string",
"customItemId": 0,
"itemKey": "string"
},
"comparisonOperator": "=",
"value": {"stringValue": "string",
"integerValue": 0,
"decimalValue": 0,
"datetimeValue": "2018-04-01T10:30:00"
}
}
}
]
}
},
"sort": {"field": {"name": "string"
},
"order": "ASC"
},
"page": 0,
"limit": 0,
"compactCustoms": false,
"noCustoms": false
}

Response samples

200

Content type

application/json

{"totalCount": 0,
"page": 0,
"deals": [{"id": 0,
"name": "string",
"amount": 0,
"closingLeadtime": 0,
"fromEmail": true,
"memo": "string",
"expectedContractDate": "2018-04-11",
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"reason": "string",
"dealType": {"id": 0,
"name": "string"
},
"endPhaseReasons": [{"id": 0,
"name": "string"
}
],
"customer": {"id": 0,
"name": "string"
},
"phase": {"id": 0,
"name": "string",
"status": 1
},
"phaseStayDays": [{"id": 0,
"name": "string",
"phaseStayDays": 0,
"isCurrentPhase": true
}
],
"product": {"id": 0,
"name": "string"
},
"probability": {"id": 0,
"name": "string"
},
"channel": {"id": 0,
"name": "string"
},
"user": {"id": 0,
"name": "string"
},
"dealCustoms": [{"id": 0,
"dealCustomItemId": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"calculationResult": 0,
"selectedValue": 1,
"selectedOption": {"value": 0,
"label": "string",
"dealCustomItemOptionId": 0
},
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"dealCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"dealProductDetails": [{"id": 0,
"dealProductDetailTypeId": 0,
"name": "string",
"billingType": {"id": 1,
"key": "lump",
"name": "一括"
},
"quantity": 0,
"unit": "string",
"price": 0,
"unitCost": 0,
"term": 0,
"subtotal": 0,
"firstSales": "2018-04-01T00:00:00+09:00",
"memo": "string",
"dealProductDetailCustoms": [{"property1": {"id": 0,
"dealProductDetailTypeCustomItemId": 0,
"itemType": "string",
"name": "string",
"text": "テキスト",
"selectedOption": {"dealProductDetailTypeCustomItemOptionId": 0,
"label": "string"
},
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56"
},
"property2": {"id": 0,
"dealProductDetailTypeCustomItemId": 0,
"itemType": "string",
"name": "string",
"text": "テキスト",
"selectedOption": {"dealProductDetailTypeCustomItemOptionId": 0,
"label": "string"
},
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56"
}
}
]
}
],
"dealCustomerTypes": [{"dealCustomerType": {"id": 0,
"name": "string"
},
"customers": [{"id": 0,
"name": "string"
}
]
}
]
}
]
}

案件情報

案件情報を取得

Authorizations:

X-Api-Key

path Parameters

id

required

integer

案件ID

query Parameters

itemKeyAsPropertyKey

string

Default: "false"

Example: itemKeyAsPropertyKey=true

true を指定した場合、詳細項目のレスポンス形式が itemKey(API項目キー) をプロパティキーとしたオブジェクトになります。

itemKey は管理者設定画面で「API項目キー」として任意の値を設定可能です。

itemKey が未設定の場合、プロパティキーとして詳細項目IDを文字列型に変換した値が使われます。

include_related_objects

integer

1 を指定すると、関連付けオブジェクトの情報を含めて返します。

Responses

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"amount": 0,
"closingLeadtime": 0,
"fromEmail": true,
"memo": "string",
"expectedContractDate": "2018-04-11",
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"reason": "string",
"dealType": {"id": 0,
"name": "string"
},
"endPhaseReasons": [{"id": 0,
"name": "string"
}
],
"customer": {"id": 0,
"name": "string"
},
"phase": {"id": 0,
"name": "string",
"status": 1
},
"phaseStayDays": [{"id": 0,
"name": "string",
"phaseStayDays": 0,
"isCurrentPhase": true
}
],
"product": {"id": 0,
"name": "string"
},
"probability": {"id": 0,
"name": "string"
},
"channel": {"id": 0,
"name": "string"
},
"user": {"id": 0,
"name": "string"
},
"dealCustoms": [{"id": 0,
"dealCustomItemId": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"calculationResult": 0,
"selectedValue": 1,
"selectedOption": {"value": 0,
"label": "string",
"dealCustomItemOptionId": 0
},
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"dealCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"dealProductDetails": [{"id": 0,
"dealProductDetailTypeId": 0,
"name": "string",
"billingType": {"id": 1,
"key": "lump",
"name": "一括"
},
"quantity": 0,
"unit": "string",
"price": 0,
"unitCost": 0,
"term": 0,
"subtotal": 0,
"firstSales": "2018-04-01T00:00:00+09:00",
"memo": "string",
"dealProductDetailCustoms": [{"property1": {"id": 0,
"dealProductDetailTypeCustomItemId": 0,
"itemType": "string",
"name": "string",
"text": "テキスト",
"selectedOption": {"dealProductDetailTypeCustomItemOptionId": 0,
"label": "string"
},
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56"
},
"property2": {"id": 0,
"dealProductDetailTypeCustomItemId": 0,
"itemType": "string",
"name": "string",
"text": "テキスト",
"selectedOption": {"dealProductDetailTypeCustomItemOptionId": 0,
"label": "string"
},
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56"
}
}
]
}
],
"dealCustomerTypes": [{"dealCustomerType": {"id": 0,
"name": "string"
},
"customers": [{"id": 0,
"name": "string"
}
]
}
],
"customObjects": [{"id": 0,
"customObjectDefKey": "string"
}
]
}

案件情報更新

案件情報を更新
各種IDは、案件タイプ設定情報で確認できます

Authorizations:

X-Api-Key

path Parameters

id

required

integer

案件ID

query Parameters

itemKeyAsPropertyKey

string

Default: "false"

Example: itemKeyAsPropertyKey=true

true を指定した場合、詳細項目のレスポンス形式が itemKey(API項目キー) をプロパティキーとしたオブジェクトになります。

itemKey は管理者設定画面で「API項目キー」として任意の値を設定可能です。

itemKey が未設定の場合、プロパティキーとして詳細項目IDを文字列型に変換した値が使われます。

Request Body schema: application/json

	object 案件タイプ
name	string 案件名
amount	integer 契約金額
expectedContractDate	string <date> 契約予定日
reason	string 最終停止理由
endPhaseReasonIds	Array of integers 最終停止理由ID 配列
	Array of objects 商品内訳
	object 取引先
	object フェーズ
	object 商品
	object 契約確度
	object チャネル
	object ユーザー
	Array of objects 案件詳細項目
	Array of objects 関連取引先
	Array of objects 関連付けカスタムオブジェクト一度に登録可能な上限は1000件です

Responses

Request samples

Payload

Content type

application/json

{"dealType": {"id": 0
},
"name": "string",
"amount": 0,
"expectedContractDate": "2018-04-11",
"reason": "string",
"endPhaseReasonIds": [0
],
"dealProductDetails": [{"id": 0,
"dealProductDetailTypeId": 0,
"quantity": 0,
"price": 0,
"unitCost": 0,
"term": 0,
"firstSales": "2018-04-01T00:00:00+09:00",
"memo": "string",
"dealProductDetailCustoms": [{"dealProductDetailTypeCustomItemId": 0,
"value": "string"
}
],
"deleted": true
}
],
"customer": {"id": 0
},
"phase": {"id": 0
},
"product": {"id": 0
},
"probability": {"id": 0
},
"channel": {"id": 0
},
"user": {"id": 0
},
"dealCustoms": [{"dealCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
],
"dealCustomers": [{"dealCustomerTypeId": 1,
"customerId": 200
}
],
"customObjects": [{"id": 0,
"delete": true
}
]
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"amount": 0,
"closingLeadtime": 0,
"fromEmail": true,
"memo": "string",
"expectedContractDate": "2018-04-11",
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"reason": "string",
"dealType": {"id": 0,
"name": "string"
},
"endPhaseReasons": [{"id": 0,
"name": "string"
}
],
"customer": {"id": 0,
"name": "string"
},
"phase": {"id": 0,
"name": "string",
"status": 1
},
"phaseStayDays": [{"id": 0,
"name": "string",
"phaseStayDays": 0,
"isCurrentPhase": true
}
],
"product": {"id": 0,
"name": "string"
},
"probability": {"id": 0,
"name": "string"
},
"channel": {"id": 0,
"name": "string"
},
"user": {"id": 0,
"name": "string"
},
"dealCustoms": [{"id": 0,
"dealCustomItemId": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"calculationResult": 0,
"selectedValue": 1,
"selectedOption": {"value": 0,
"label": "string",
"dealCustomItemOptionId": 0
},
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"dealCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"dealProductDetails": [{"id": 0,
"dealProductDetailTypeId": 0,
"name": "string",
"billingType": {"id": 1,
"key": "lump",
"name": "一括"
},
"quantity": 0,
"unit": "string",
"price": 0,
"unitCost": 0,
"term": 0,
"subtotal": 0,
"firstSales": "2018-04-01T00:00:00+09:00",
"memo": "string",
"dealProductDetailCustoms": [{"property1": {"id": 0,
"dealProductDetailTypeCustomItemId": 0,
"itemType": "string",
"name": "string",
"text": "テキスト",
"selectedOption": {"dealProductDetailTypeCustomItemOptionId": 0,
"label": "string"
},
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56"
},
"property2": {"id": 0,
"dealProductDetailTypeCustomItemId": 0,
"itemType": "string",
"name": "string",
"text": "テキスト",
"selectedOption": {"dealProductDetailTypeCustomItemOptionId": 0,
"label": "string"
},
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56"
}
}
]
}
],
"dealCustomerTypes": [{"dealCustomerType": {"id": 0,
"name": "string"
},
"customers": [{"id": 0,
"name": "string"
}
]
}
]
}

案件情報削除

案件情報を削除
案件に紐づく案件、アクションは全て削除されます

Authorizations:

X-Api-Key

path Parameters

id

required

integer

案件ID

Responses

案件一括登録

案件を一括登録します
一度に登録可能な上限は1000件です
このAPIを使って登録した場合、監査ログは記録されません
各種IDは、案件タイプ設定情報で確認できます

Authorizations:

X-Api-Key

path Parameters

deal_type_id

required

integer

案件タイプID

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"deals": [{"dealType": {"id": 0
},
"name": "string",
"amount": 0,
"expectedContractDate": "2018-04-11",
"reason": "string",
"endPhaseReasonIds": [0
],
"dealProductDetails": [{"id": 0,
"dealProductDetailTypeId": 0,
"quantity": 0,
"price": 0,
"unitCost": 0,
"term": 0,
"firstSales": "2018-04-01T00:00:00+09:00",
"memo": "string",
"dealProductDetailCustoms": [{"dealProductDetailTypeCustomItemId": 0,
"value": "string"
}
],
"deleted": true
}
],
"customer": {"id": 0
},
"phase": {"id": 0
},
"product": {"id": 0
},
"probability": {"id": 0
},
"channel": {"id": 0
},
"user": {"id": 0
},
"dealCustoms": [{"dealCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
],
"dealCustomers": [{"dealCustomerTypeId": 1,
"customerId": 200
}
]
}
]
}

Response samples

200
400

Content type

application/json

[0
]

案件一括更新

案件を一括更新します
一度に更新可能な上限は1000件です
このAPIを使って更新した場合、監査ログは記録されません
各種IDは、案件タイプ設定情報で確認できます

Authorizations:

X-Api-Key

path Parameters

deal_type_id

required

integer

案件タイプID

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"deals": [{"id": 0,
"dealType": {"id": 0
},
"name": "string",
"amount": 0,
"expectedContractDate": "2018-04-11",
"reason": "string",
"endPhaseReasonIds": [0
],
"dealProductDetails": [{"id": 0,
"dealProductDetailTypeId": 0,
"quantity": 0,
"price": 0,
"unitCost": 0,
"term": 0,
"firstSales": "2018-04-01T00:00:00+09:00",
"memo": "string",
"dealProductDetailCustoms": [{"dealProductDetailTypeCustomItemId": 0,
"value": "string"
}
],
"deleted": true
}
],
"customer": {"id": 0
},
"phase": {"id": 0
},
"product": {"id": 0
},
"probability": {"id": 0
},
"channel": {"id": 0
},
"user": {"id": 0
},
"dealCustoms": [{"dealCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
],
"dealCustomers": [{"dealCustomerTypeId": 1,
"customerId": 200
}
]
}
]
}

Response samples

400

Content type

application/json

{"error": "string",
"messages": ["string"
],
"bulkErrors": [{"index": 0,
"messages": ["string"
]
}
]
}

案件コンタクト(DealsContacts)

案件コンタクトリスト

案件情報を取得

Authorizations:

X-Api-Key

path Parameters

dealId

required

integer

案件ID

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"page": 0,
"contacts": [{"id": 0,
"name": "string",
"email": "string",
"tel": "string",
"mobileTel": "string",
"address": "string",
"dept": "string",
"position": "string",
"memo": "string",
"marketoLeadScore": 0,
"customer": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"contactCustoms": [{"id": 0,
"contactCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"lifecycleStages": [{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
]
}

案件コンタクト情報登録

案件にコンタクトを紐づけます

Authorizations:

X-Api-Key

path Parameters

dealId required	integer 案件ID
id required	integer コンタクトID

Responses

案件コンタクト情報削除

案件からコンタクトを削除します
コンタクト自体は削除されません

Authorizations:

X-Api-Key

path Parameters

dealId required	integer 案件ID
id required	integer コンタクトID

Responses

案件アクション(Actions)

案件アクション情報リスト

アクション情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

query Parameters

sort	string 並び順ソート可能 `startDatetime`
startDatetime	string <date-time> Example: startDatetime=2018-04-01T10:30:00 開始日時 ex) startDatetime=2019-01-01T09:00 endDatetime=2019-01-01T11:00 上記のように指定した場合、開始日時2019-01-01 09:00 から終了日時2019-01-01 11:00のアクションを検索します。
endDatetime	string <date-time> Example: endDatetime=2018-04-01T10:30:00 終了日時 ex) startDatetime=2019-01-01T09:00 endDatetime=2019-01-01T11:00 上記のように指定した場合、開始日時2019-01-01 09:00 から終了日時2019-01-01 11:00のアクションを検索します。
createdAtFrom	string <date-time> Example: createdAtFrom=2018-04-01T10:30:00 登録日時開始時間 ex) createdAtFrom=2019-01-01T09:00 createdAtTo=2019-01-01T11:00 上記のように指定した場合、登録日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
createdAtTo	string <date-time> Example: createdAtTo=2018-04-01T10:30:00 登録日時終了時間 ex) createdAtFrom=2019-01-01T09:00 createdAtTo=2019-01-01T11:00 上記のように指定した場合、登録日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
updatedAtFrom	string <date-time> Example: updatedAtFrom=2018-04-01T10:30:00 最終更新日時開始時間 ex) updatedAtFrom=2019-01-01T09:00 updatedAtTo=2019-01-01T11:00 上記のように指定した場合、最終更新日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
updatedAtTo	string <date-time> Example: updatedAtTo=2018-04-01T10:30:00 最終更新日時終了時間 ex) updatedAtFrom=2019-01-01T09:00 updatedAtTo=2019-01-01T11:00 上記のように指定した場合、最終更新日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
	Array of objects アクション担当者、その他の担当者を検索します。 GETパラメータで指定する場合、以下の形式で指定します。 `?users[]id=1&users[]id=2`
purpose	integer アクションの目的
active	boolean true:予定 false:完了
dealId	integer 案件IDを指定して検索します。
page	integer ページ

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"page": 0,
"actions": [{"id": 0,
"pattern": {"id": 0,
"name": "string"
},
"purpose": {"id": 0,
"name": "string"
},
"deal": {"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"contacts": [{"id": 0,
"name": "string",
"email": "string",
"tel": "string",
"mobileTel": "string",
"address": "string",
"dept": "string",
"position": "string",
"memo": "string",
"marketoLeadScore": 0,
"customer": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"contactCustoms": [{"id": 0,
"contactCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"lifecycleStages": [{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
],
"creator": {"id": 0,
"name": "string"
},
"invitees": [{"id": 0,
"name": "string"
}
],
"actionCustoms": [{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
]
}
]
}

案件アクション登録

アクションを新規に登録します

Authorizations:

X-Api-Key

Request Body schema: application/json

startDatetime required	string <date-time> 開始日時
endDatetime required	string <date-time> 終了日時
required	object アクション担当者ID
	Array of objects 他の担当者
preNote	string アクションの事前メモ
result	string アクションの実施結果
active	boolean アクションの状態(true=未完了、false=完了)
required	object アクションの目的アクションの種別は目的に対応する値が自動的に設定されます。目的IDは、案件タイプ設定情報で確認できます
required	object 案件ID
	Array of objects アクションコンタクト
	Array of objects アクション詳細項目一覧

Responses

Request samples

Payload

Content type

application/json

{"startDatetime": "2018-04-01T10:30:00+09:00",
"endDatetime": "2018-04-01T10:30:00+09:00",
"creator": {"id": 0
},
"invitees": [{"id": 0
}
],
"preNote": "string",
"result": "string",
"active": true,
"purpose": {"id": 0
},
"deal": {"id": 0
},
"contacts": [{"id": 0
}
],
"actionCustoms": [{"itemKey": "string",
"value": "テキスト"
}
]
}

Response samples

201

Content type

application/json

{"id": 0,
"pattern": {"id": 0,
"name": "string"
},
"purpose": {"id": 0,
"name": "string"
},
"deal": {"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"contacts": [{"id": 0,
"name": "string",
"email": "string",
"tel": "string",
"mobileTel": "string",
"address": "string",
"dept": "string",
"position": "string",
"memo": "string",
"marketoLeadScore": 0,
"customer": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"contactCustoms": [{"id": 0,
"contactCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"lifecycleStages": [{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
],
"creator": {"id": 0,
"name": "string"
},
"invitees": [{"id": 0,
"name": "string"
}
],
"actionCustoms": [{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
]
}

案件アクション情報

アクション情報を取得

Authorizations:

X-Api-Key

path Parameters

id

required

integer

アクションID

query Parameters

include_files

integer

1 を指定すると、添付ファイルの情報を含めて返します。

Responses

Response samples

200

Content type

application/json

{"id": 0,
"pattern": {"id": 0,
"name": "string"
},
"purpose": {"id": 0,
"name": "string"
},
"deal": {"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"contacts": [{"id": 0,
"name": "string",
"email": "string",
"tel": "string",
"mobileTel": "string",
"address": "string",
"dept": "string",
"position": "string",
"memo": "string",
"marketoLeadScore": 0,
"customer": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"contactCustoms": [{"id": 0,
"contactCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"lifecycleStages": [{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
],
"creator": {"id": 0,
"name": "string"
},
"invitees": [{"id": 0,
"name": "string"
}
],
"actionCustoms": [{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
],
"files": [{"name": "string",
"mimeType": "string",
"url": "string"
}
]
}

案件アクション情報更新

アクション情報を更新

Authorizations:

X-Api-Key

path Parameters

id

required

integer

アクションID

Request Body schema: application/json

startDatetime	string <date-time> 開始日時
endDatetime	string <date-time> 終了日時
	object アクション担当者ID
	Array of objects 他の担当者
preNote	string アクションの事前メモ
result	string アクションの実施結果
active	boolean アクションの状態(true=未完了、false=完了)
	object アクションの目的アクションの種別は目的に対応する値が自動的に設定されます。目的IDは、案件タイプ設定情報で確認できます
required	object 案件ID
	Array of objects アクションコンタクト
	Array of objects アクション詳細項目一覧

Responses

Request samples

Payload

Content type

application/json

{"startDatetime": "2018-04-01T10:30:00+09:00",
"endDatetime": "2018-04-01T10:30:00+09:00",
"creator": {"id": 0
},
"invitees": [{"id": 0
}
],
"preNote": "string",
"result": "string",
"active": true,
"purpose": {"id": 0
},
"deal": {"id": 0
},
"contacts": [{"id": 0
}
],
"actionCustoms": [{"itemKey": "string",
"value": "テキスト"
}
]
}

Response samples

200

Content type

application/json

{"id": 0,
"pattern": {"id": 0,
"name": "string"
},
"purpose": {"id": 0,
"name": "string"
},
"deal": {"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"contacts": [{"id": 0,
"name": "string",
"email": "string",
"tel": "string",
"mobileTel": "string",
"address": "string",
"dept": "string",
"position": "string",
"memo": "string",
"marketoLeadScore": 0,
"customer": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"contactCustoms": [{"id": 0,
"contactCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"lifecycleStages": [{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
],
"creator": {"id": 0,
"name": "string"
},
"invitees": [{"id": 0,
"name": "string"
}
],
"actionCustoms": [{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
]
}

案件アクション情報削除

アクション情報を削除

Authorizations:

X-Api-Key

path Parameters

id

required

integer

アクションID

Responses

案件アクション一括登録

案件アクションを一括登録します
一度に登録可能な上限は1000件です
このAPIを使って登録した場合、監査ログは記録されません

Authorizations:

X-Api-Key

Request Body schema: application/json

dealTypeId required	integer 案件タイプID 指定した一つの案件タイプのアクションのみ一括作成可能です。案件タイプを跨った一括登録には対応しておりません。
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"dealTypeId": 0,
"actions": [{"startDatetime": "2018-04-01T10:30:00+09:00",
"endDatetime": "2018-04-01T10:30:00+09:00",
"creator": {"id": 0
},
"invitees": [{"id": 0
}
],
"preNote": "string",
"result": "string",
"active": true,
"purpose": {"id": 0
},
"deal": {"id": 0
},
"contacts": [{"id": 0
}
],
"actionCustoms": [{"itemKey": "string",
"value": "テキスト"
}
],
"files": [{"name": "string",
"path": "string"
}
]
}
]
}

Response samples

200
400

Content type

application/json

[0
]

コンタクト設定(ContactSetting)

コンタクト設定

コンタクト設定の取得

Authorizations:

X-Api-Key

Responses

Response samples

200

Content type

application/json

{"contactCustomItems": [{"id": 0,
"itemKey": "string",
"itemType": "string",
"name": "string",
"orderNum": 0,
"customItemOptions": [{"id": 0,
"value": 0,
"label": "string"
}
]
}
]
}

コンタクト(Contacts)

コンタクト情報リスト

コンタクトの情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

query Parameters

searchWord	string 指定した文字列と取引先名、コンタクト名、またはメールアドレスが部分一致するコンタクトを検索します。
sort	string 並び順ソート可能 `updatedAt`、`createdAt`
updatedAtFrom	string <date-time> Example: updatedAtFrom=2018-04-01T10:30:00 更新日時による検索範囲(開始) ex) `2018-04-01T10:30:00`
updatedAtTo	string <date-time> Example: updatedAtTo=2018-04-01T10:30:00 更新日時による検索範囲(終了) ex) `2018-04-01T10:30:00`
page	integer ページ
phoneNumber	string Example: phoneNumber=03-1111-2222 固定電話番号、携帯電話番号による検索ハイフン市外局番検索可能 ex) `03-1111-2222` ex) `0311112222` ex) `04992(0)1111` ex) `049920局1111`

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"page": 0,
"contacts": [{"id": 0,
"name": "string",
"email": "string",
"tel": "string",
"mobileTel": "string",
"address": "string",
"dept": "string",
"position": "string",
"memo": "string",
"marketoLeadScore": 0,
"customer": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"contactCustoms": [{"id": 0,
"contactCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"lifecycleStages": [{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
]
}

コンタクト情報登録

コンタクト情報を新規に登録します
登録後のコンタクト情報をレスポンスとして返します

Authorizations:

X-Api-Key

Request Body schema: application/json

name required	string コンタクト名
email	string or null メールアドレス
tel	string or null 電話番号
mobileTel	string or null 携帯電話番号
address	string or null 住所
dept	string or null 部署
position	string or null 役職
memo	string or null メモ
	object or null 取引先
	Array of objects コンタクト詳細項目
	Array of objects ライフサイクルステージ
	Array of objects 関連付けカスタムオブジェクト一度に登録可能な上限は1000件です

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "string",
"tel": "string",
"mobileTel": "string",
"address": "string",
"dept": "string",
"position": "string",
"memo": "string",
"customer": {"id": 0
},
"contactCustoms": [{"contactCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
],
"lifecycleStages": [{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
],
"customObjects": [{"id": 0,
"delete": true
}
]
}

Response samples

201

Content type

application/json

{"id": 0,
"name": "string",
"email": "string",
"tel": "string",
"mobileTel": "string",
"address": "string",
"dept": "string",
"position": "string",
"memo": "string",
"marketoLeadScore": 0,
"customer": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"contactCustoms": [{"id": 0,
"contactCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"lifecycleStages": [{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}

コンタクト情報検索

コンタクト情報を検索します。

field の reference (参照先関連オブジェクト) として以下を指定できます。
- customer (取引先)

Authorizations:

X-Api-Key

Request Body schema: application/json

required	object 絞り込み条件 compositeFilter と valueFilter を合わせて最大300個まで指定できます(最上位の compositeFilter は件数に含まれません)。
	object 並び替え条件。詳細項目、関連オブジェクトの項目指定の並び替えには対応していません。
page	integer ページ
limit	integer 1ページあたりの件数。最大1000。省略した場合、デフォルトは100。
compactCustoms	boolean Default: false `true` を指定した場合、詳細項目(customs)のレスポンスから冗長な項目を除外し、レスポンスサイズを削減します。
noCustoms	boolean Default: false `true` を指定した場合、詳細項目(customs)自体をレスポンスから除外します。詳細項目が不要な場合に指定することで、レスポンスサイズを大幅に削減できます。

Responses

Request samples

Payload

Content type

application/json

{"filter": {"compositeFilter": {"logicalOperator": "AND",
"subFilters": [{"compositeFilter": { },
"valueFilter": {"field": {"reference": "string",
"name": "string",
"customItemId": 0,
"itemKey": "string"
},
"comparisonOperator": "=",
"value": {"stringValue": "string",
"integerValue": 0,
"decimalValue": 0,
"datetimeValue": "2018-04-01T10:30:00"
}
}
}
]
}
},
"sort": {"field": {"name": "string"
},
"order": "ASC"
},
"page": 0,
"limit": 0,
"compactCustoms": false,
"noCustoms": false
}

Response samples

200

Content type

application/json

{"totalCount": 0,
"page": 0,
"contacts": [{"id": 0,
"name": "string",
"email": "string",
"tel": "string",
"mobileTel": "string",
"address": "string",
"dept": "string",
"position": "string",
"memo": "string",
"marketoLeadScore": 0,
"customer": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"contactCustoms": [{"id": 0,
"contactCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"lifecycleStages": [{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}
]
}

コンタクト情報

コンタクト情報を取得

Authorizations:

X-Api-Key

path Parameters

id

required

integer

コンタクトID

query Parameters

include_related_objects

integer

1 を指定すると、関連付けオブジェクトの情報を含めて返します。

Responses

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"email": "string",
"tel": "string",
"mobileTel": "string",
"address": "string",
"dept": "string",
"position": "string",
"memo": "string",
"marketoLeadScore": 0,
"customer": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"contactCustoms": [{"id": 0,
"contactCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"lifecycleStages": [{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
],
"customObjects": [{"id": 0,
"customObjectDefKey": "string"
}
]
}

コンタクト情報更新

コンタクト情報を更新

Authorizations:

X-Api-Key

path Parameters

id

required

integer

コンタクトID

Request Body schema: application/json

name	string コンタクト名
email	string or null メールアドレス
tel	string or null 電話番号
mobileTel	string or null 携帯電話番号
address	string or null 住所
dept	string or null 部署
position	string or null 役職
memo	string or null メモ
	object or null 取引先
	Array of objects コンタクト詳細項目
	Array of objects ライフサイクルステージ
	Array of objects 関連付けカスタムオブジェクト一度に登録可能な上限は1000件です

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "string",
"tel": "string",
"mobileTel": "string",
"address": "string",
"dept": "string",
"position": "string",
"memo": "string",
"customer": {"id": 0
},
"contactCustoms": [{"contactCustomItemId": 0,
"itemKey": "string",
"value": "string"
}
],
"lifecycleStages": [{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
],
"customObjects": [{"id": 0,
"delete": true
}
]
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"email": "string",
"tel": "string",
"mobileTel": "string",
"address": "string",
"dept": "string",
"position": "string",
"memo": "string",
"marketoLeadScore": 0,
"customer": {"id": 0,
"name": "string"
},
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"contactCustoms": [{"id": 0,
"contactCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"number": 123456,
"url": "https://mazrica.com",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
],
"selectedUsers": [{"id": 0,
"name": "string",
"email": "string"
}
]
}
],
"lifecycleStages": [{"lifecycleStageTypeId": 0,
"id": 0,
"name": "string"
}
]
}

コンタクト情報削除

コンタクト情報を削除

Authorizations:

X-Api-Key

path Parameters

id

required

integer

コンタクトID

Responses

コンタクトアクション(ContactActions)

コンタクトアクション情報リスト

アクション情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

path Parameters

contactId

required

integer

コンタクトIDを指定してアクションを検索します。

コンタクトIDの代わりに、allと指定することでコンタクトIDを跨いだアクションの取得が可能です。

また、data_typeを指定することで、アクションの種類を絞り込むことも可能です。

data_type: 0 → コンタクトが紐付いている案件アクション

data_type: 1 → コンタクトアクション

query Parameters

sort	string 並び順ソート可能 `startDatetime`
startDatetime	string <date-time> Example: startDatetime=2018-04-01T10:30:00 開始日時 ex) startDatetime=2019-01-01T09:00 endDatetime=2019-01-01T11:00 上記のように指定した場合、開始日時2019-01-01 09:00 から終了日時2019-01-01 11:00のアクションを検索します。
endDatetime	string <date-time> Example: endDatetime=2018-04-01T10:30:00 終了日時 ex) startDatetime=2019-01-01T09:00 endDatetime=2019-01-01T11:00 上記のように指定した場合、開始日時2019-01-01 09:00 から終了日時2019-01-01 11:00のアクションを検索します。
createdAtFrom	string <date-time> Example: createdAtFrom=2018-04-01T10:30:00 登録日時開始時間 ex) createdAtFrom=2019-01-01T09:00 createdAtTo=2019-01-01T11:00 上記のように指定した場合、登録日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
createdAtTo	string <date-time> Example: createdAtTo=2018-04-01T10:30:00 登録日時終了時間 ex) createdAtFrom=2019-01-01T09:00 createdAtTo=2019-01-01T11:00 上記のように指定した場合、登録日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
updatedAtFrom	string <date-time> Example: updatedAtFrom=2018-04-01T10:30:00 最終更新日時開始時間 ex) updatedAtFrom=2019-01-01T09:00 updatedAtTo=2019-01-01T11:00 上記のように指定した場合、最終更新日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
updatedAtTo	string <date-time> Example: updatedAtTo=2018-04-01T10:30:00 最終更新日時終了時間 ex) updatedAtFrom=2019-01-01T09:00 updatedAtTo=2019-01-01T11:00 上記のように指定した場合、最終更新日時が2019-01-01 09:00 から 2019-01-01 11:00のアクションを検索します。
	Array of objects アクション担当者、その他の担当者を検索します。 GETパラメータで指定する場合、以下の形式で指定します。 `?users[]id=1&users[]id=2`
pattern	integer アクションの種別
active	boolean true:予定 false:完了
dataType	integer コンタクトの種類: `0` - 案件アクション `1` - コンタクトアクション
page	integer ページ

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"page": 0,
"actions": [{"id": 0,
"pattern": {"id": 0,
"name": "string"
},
"dataType": 0,
"deal": {"id": 0,
"name": "string"
},
"contact": {"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"creator": {"id": 0,
"name": "string"
},
"invitees": [{"id": 0,
"name": "string"
}
],
"actionCustoms": [{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
]
}
]
}

コンタクトアクション登録

アクションを新規に登録します

Authorizations:

X-Api-Key

Request Body schema: application/json

startDatetime required	string <date-time> 開始日時
endDatetime required	string <date-time> 終了日時
required	object アクション担当者ID
	Array of objects 他の担当者
preNote	string アクションの事前メモ
result	string アクションの実施結果
active	boolean アクションの状態(true=未完了、false=完了)
required	object
	Array of objects アクション詳細項目一覧

Responses

Request samples

Payload

Content type

application/json

{"startDatetime": "2018-04-01T10:30:00+09:00",
"endDatetime": "2018-04-01T10:30:00+09:00",
"creator": {"id": 0
},
"invitees": [{"id": 0
}
],
"preNote": "string",
"result": "string",
"active": true,
"pattern": {"id": 0
},
"actionCustoms": [{"itemKey": "string",
"value": "テキスト"
}
]
}

Response samples

201

Content type

application/json

{"id": 0,
"pattern": {"id": 0,
"name": "string"
},
"dataType": 0,
"deal": {"id": 0,
"name": "string"
},
"contact": {"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"creator": {"id": 0,
"name": "string"
},
"invitees": [{"id": 0,
"name": "string"
}
],
"actionCustoms": [{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
]
}

コンタクトアクション情報

アクション情報を取得

Authorizations:

X-Api-Key

path Parameters

contactId required	integer コンタクトID
id required	integer アクションID

query Parameters

include_files

integer

1 を指定すると、添付ファイルの情報を含めて返します。

Responses

Response samples

200

Content type

application/json

{"id": 0,
"pattern": {"id": 0,
"name": "string"
},
"dataType": 0,
"deal": {"id": 0,
"name": "string"
},
"contact": {"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"creator": {"id": 0,
"name": "string"
},
"invitees": [{"id": 0,
"name": "string"
}
],
"actionCustoms": [{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
],
"files": [{"name": "string",
"mimeType": "string",
"url": "string"
}
]
}

コンタクトアクション情報更新

アクション情報を更新

Authorizations:

X-Api-Key

path Parameters

contactId required	integer コンタクトID
id required	integer アクションID

Request Body schema: application/json

startDatetime	string <date-time> 開始日時
endDatetime	string <date-time> 終了日時
	object アクション担当者ID
	Array of objects 他の担当者
preNote	string アクションの事前メモ
result	string アクションの実施結果
active	boolean アクションの状態(true=未完了、false=完了)
	object
	Array of objects アクション詳細項目一覧

Responses

Request samples

Payload

Content type

application/json

{"startDatetime": "2018-04-01T10:30:00+09:00",
"endDatetime": "2018-04-01T10:30:00+09:00",
"creator": {"id": 0
},
"invitees": [{"id": 0
}
],
"preNote": "string",
"result": "string",
"active": true,
"pattern": {"id": 0
},
"actionCustoms": [{"itemKey": "string",
"value": "テキスト"
}
]
}

Response samples

200

Content type

application/json

{"id": 0,
"pattern": {"id": 0,
"name": "string"
},
"dataType": 0,
"deal": {"id": 0,
"name": "string"
},
"contact": {"id": 0,
"name": "string"
},
"startDatetime": null,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"preNote": "string",
"endDatetime": null,
"active": true,
"result": "string",
"extraResult": "外部サービスなどから取り込んだ,\nアクションの実施結果",
"syncCalendar": true,
"creator": {"id": 0,
"name": "string"
},
"invitees": [{"id": 0,
"name": "string"
}
],
"actionCustoms": [{"id": 0,
"actionCustomItemId": 0,
"itemType": "string",
"name": "string",
"value": "テキスト",
"text": "テキスト",
"datetime": "2018-04-01T10:30:00+09:00",
"decimalNumber": "1234.56",
"selectedValue": 1,
"selectedValues": [1,
2,
3
],
"selectedOptions": [{"id": 0,
"value": 0,
"label": "string",
"contactCustomItemOptionId": 0
}
]
}
]
}

コンタクトアクション情報削除

アクション情報を削除

Authorizations:

X-Api-Key

path Parameters

contactId required	integer コンタクトID
id required	integer アクションID

Responses

コンタクトアクション一括登録

コンタクトアクションを一括登録します
一度に登録可能な上限は1000件です
このAPIを使って登録した場合、監査ログは記録されません

Authorizations:

X-Api-Key

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"actions": [{"contact": {"id": 0
},
"startDatetime": "2018-04-01T10:30:00+09:00",
"endDatetime": "2018-04-01T10:30:00+09:00",
"creator": {"id": 0
},
"invitees": [{"id": 0
}
],
"preNote": "string",
"result": "string",
"active": true,
"pattern": {"id": 0
},
"actionCustoms": [{"itemKey": "string",
"value": "テキスト"
}
],
"files": [{"name": "string",
"path": "string"
}
]
}
]
}

Response samples

200
400

Content type

application/json

[0
]

ライフサイクルステージ設定(LifecycleStageSetting)

ライフサイクルステージを利用可能な契約プランのお客様のみ実行可能です。

ライフサイクルステージ設定

ライフサイクルステージ設定の取得

Authorizations:

X-Api-Key

Responses

Response samples

200

Content type

application/json

{"lifecycleStageTypes": [{"id": 0,
"name": "string",
"lifecycleStages": [{"id": 0,
"name": "string"
}
]
}
]
}

カスタムオブジェクト設定(CustomObjectSetting)

カスタムオブジェクトを利用可能な契約プランのお客様のみ実行可能です。

カスタムオブジェクト定義情報リスト

カスタムオブジェクト定義情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

query Parameters

searchWord	string 名前が部分一致するカスタムオブジェクト定義を検索します。
page	integer ページ

Responses

Response samples

200
403

Content type

application/json

{"totalCount": 0,
"page": 0,
"customObjectDefs": [{"key": "string",
"name": "string",
"enableBi": true,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00"
}
]
}

カスタムオブジェクト定義情報登録

カスタムオブジェクト定義を新規に登録します

Authorizations:

X-Api-Key

Request Body schema: application/json

name required	string カスタムオブジェクト名
enable_bi	boolean BIのデータソースとして使用するかどうか BIが利用可能でない場合、true にすると登録エラーになります。
key required	string カスタムオブジェクト定義キー。API指定用のキーになります。
	Array of objects 項目定義一覧

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"enable_bi": true,
"key": "string",
"customObjectItemDefs": [{"name": "string",
"key": "string",
"itemType": "string",
"customObjectOptionDefs": [[{"key": "string",
"name": "string"
}
]
]
}
]
}

Response samples

201
400
403

Content type

application/json

{"key": "string",
"name": "string",
"enableBi": true,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"customObjectItemDefs": [{"key": "string",
"name": "string",
"itemType": "string",
"customObjectOptionDefs": [{"key": "string",
"name": "string"
}
]
}
]
}

カスタムオブジェクト定義情報

カスタムオブジェクト定義情報を取得

Authorizations:

X-Api-Key

path Parameters

key

required

string

カスタムオブジェクト定義キー

Responses

Response samples

200
400
403

Content type

application/json

{"key": "string",
"name": "string",
"enableBi": true,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"customObjectItemDefs": [{"key": "string",
"name": "string",
"itemType": "string",
"customObjectOptionDefs": [{"key": "string",
"name": "string"
}
]
}
]
}

カスタムオブジェクト定義情報更新

カスタムオブジェクト定義情報を更新

Authorizations:

X-Api-Key

path Parameters

key

required

string

カスタムオブジェクト定義キー

Request Body schema: application/json

name	string カスタムオブジェクト名
enable_bi	boolean BIのデータソースとして使用するかどうか BIが利用可能でない場合、true にすると登録エラーになります。
newKey	string 新しい定義キーを指定します。
	Array of objects 項目定義一覧

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"enable_bi": true,
"newKey": "string",
"customObjectItemDefs": [{"key": "string",
"delete": true,
"name": "string",
"newKey": "string",
"customObjectOptionDefs": [[{"key": "string",
"name": "string",
"newKey": "string",
"delete": true
}
]
]
}
]
}

Response samples

200
400
403

Content type

application/json

{"key": "string",
"name": "string",
"enableBi": true,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"customObjectItemDefs": [{"key": "string",
"name": "string",
"itemType": "string",
"customObjectOptionDefs": [{"key": "string",
"name": "string"
}
]
}
]
}

カスタムオブジェクト定義情報削除

カスタムオブジェクト定義情報を削除

Authorizations:

X-Api-Key

path Parameters

key

required

string

カスタムオブジェクト定義キー

Responses

Response samples

403

Content type

application/json

{"error": "string",
"messages": ["string"
]
}

カスタムオブジェクト項目登録

カスタムオブジェクト定義に項目を追加します

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key

required

string

カスタムオブジェクト定義キー

Request Body schema: application/json

name required	string 項目名
key required	string 項目キー。API指定用のキーになります。
itemType required	string text: 文字列タイプ date: 日付タイプ number: 整数タイプ decimal_number: 小数タイプ single_select: 単一選択タイプ multi_select: 複数選択タイプ
	Array of objects[ items ] 選択肢定義一覧
before	string 指定した項目キーの手前に項目を追加します。指定がない場合は最後に追加されます。

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"key": "string",
"itemType": "string",
"customObjectOptionDefs": [[{"key": "string",
"name": "string"
}
]
],
"before": "string"
}

Response samples

201
400
403

Content type

application/json

{"key": "string",
"name": "string",
"itemType": "string",
"customObjectOptionDefs": [{"key": "string",
"name": "string"
}
]
}

カスタムオブジェクト項目更新

カスタムオブジェクト項目を更新

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key required	string カスタムオブジェクト定義キー
key required	string 項目キー

Request Body schema: application/json

name	string 項目名
newKey	string 新しい項目キーを指定します。
	Array of objects[ items ] 選択肢定義一覧

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"newKey": "string",
"customObjectOptionDefs": [[{"key": "string",
"name": "string",
"newKey": "string",
"delete": true
}
]
]
}

Response samples

200
400
403

Content type

application/json

{"key": "string",
"name": "string",
"itemType": "string",
"customObjectOptionDefs": [{"key": "string",
"name": "string"
}
]
}

カスタムオブジェクト項目削除

カスタムオブジェクト項目を削除

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key required	string カスタムオブジェクト定義キー
key required	string 項目キー

Responses

Response samples

403

Content type

application/json

{"error": "string",
"messages": ["string"
]
}

カスタムオブジェクト(CustomObjects)

カスタムオブジェクトを利用可能な契約プランのお客様のみ実行可能です。

カスタムオブジェクト情報リスト

カスタムオブジェクト情報のリスト取得
一度に取得できる件数は100件
pageを指定することで続きを取得

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key

required

string

カスタムオブジェクト定義キー

query Parameters

createdAtFrom

string <date-time>

Example: createdAtFrom=2018-04-01T10:30:00+900

作成日時による検索範囲（開始）

createdAtTo

string <date-time>

Example: createdAtTo=2018-04-01T10:30:00+900

作成日時による検索範囲指定（終了）

updatedAtFrom

string <date-time>

Example: updatedAtFrom=2018-04-01T10:30:00+900

更新日時による検索範囲（開始）

updatedAtTo

string <date-time>

Example: updatedAtTo=2018-04-01T10:30:00+900

更新日時による検索範囲指定（終了）

カスタムオブジェクト項目キー

string

カスタムオブジェクト項目定義の「項目キー」を検索キーとして指定します。

検索条件に指定できるのは下記の項目タイプです。

文字列タイプ(text)
整数タイプ(number)
小数タイプ(decimal_number)

例)カスタムオブジェクト「商品」の定義が以下だった場合

項目名	項目キー	項目タイプ
商品コード	productCode	number
商品名	productName	text

商品コード=123
商品名=サンプル商品

という検索条件を指定する場合、以下のようにクエリパラメータを設定します。

  /custom_object_defs/{custom_object_def_key}/custom_objects?productCode=123&productName=サンプル商品

sort

string

並び順ソート可能 updatedAt、createdAt

page

integer

ページ

Responses

Response samples

200
403

Content type

application/json

{"totalCount": 0,
"page": 0,
"customObjects": [{"id": 0,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"カスタムオブジェクト項目": null
}
]
}

カスタムオブジェクト情報登録

カスタムオブジェクトを新規に登録します

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key

required

string

カスタムオブジェクト定義キー

Request Body schema: application/json

カスタムオブジェクト項目

any

カスタムオブジェクト項目定義の「項目キー」をJSONのプロパティキーとして指定します。

項目タイプごとに以下の値を設定してください。

文字列タイプ(text)
- type: string
日付タイプ(date)
- type: string
- ISO 8601形式文字列
- ex) 2023-04-22T00:02:03+09:00
整数タイプ(number)
- type: integer
小数タイプ(decimal_number)
- type: string
単一選択タイプ(single_select)
- type: string
- 選択肢キー
複数選択タイプ(multi_select)
- type: Array of string
- 選択肢キーの配列

例)カスタムオブジェクト「商品」の定義が以下だった場合

項目名	項目キー	項目タイプ
商品コード	productCode	number
商品名	productName	text

商品コード=123
商品名=サンプル商品

というデータを追加するリクエストペイロードは以下になります。

  {
    "productCode": 123,
    "productName": "サンプル商品"
  }

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"カスタムオブジェクト項目": null,
"deals": [{"id": 0,
"delete": true
}
],
"customers": [{"id": 0,
"delete": true
}
],
"contacts": [{"id": 0,
"delete": true
}
]
}

Response samples

201
400
403

Content type

application/json

{"id": 0,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"カスタムオブジェクト項目": null
}

カスタムオブジェクト情報

カスタムオブジェクト情報を取得

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key required	string カスタムオブジェクト定義キー
id required	integer カスタムオブジェクトID

query Parameters

include_related_objects

integer

1 を指定すると、関連付けオブジェクトの情報を含めて返します。

Responses

Response samples

200
403

Content type

application/json

{"id": 0,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"カスタムオブジェクト項目": null,
"deals": [{"id": 0
}
],
"customers": [{"id": 0
}
],
"contacts": [{"id": 0
}
]
}

カスタムオブジェクト情報更新

カスタムオブジェクト情報を更新

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key required	string カスタムオブジェクト定義キー
id required	integer カスタムオブジェクトID

Request Body schema: application/json

カスタムオブジェクト項目

any

カスタムオブジェクト項目定義の「項目キー」をJSONのプロパティキーとして指定します。

項目タイプごとに以下の値を設定してください。

文字列タイプ(text)
- type: string
日付タイプ(date)
- type: string
- ISO 8601形式文字列
- ex) 2023-04-22T00:02:03+09:00
整数タイプ(number)
- type: integer
小数タイプ(decimal_number)
- type: string
単一選択タイプ(single_select)
- type: string
- 選択肢キー
複数選択タイプ(multi_select)
- type: Array of string
- 選択肢キーの配列

例)カスタムオブジェクト「商品」の定義が以下だった場合

項目名	項目キー	項目タイプ
商品コード	productCode	number
商品名	productName	text

商品コード=123
商品名=サンプル商品

というデータを追加するリクエストペイロードは以下になります。

  {
    "productCode": 123,
    "productName": "サンプル商品"
  }

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"カスタムオブジェクト項目": null,
"deals": [{"id": 0,
"delete": true
}
],
"customers": [{"id": 0,
"delete": true
}
],
"contacts": [{"id": 0,
"delete": true
}
]
}

Response samples

200
400
403

Content type

application/json

{"id": 0,
"createdAt": "2018-04-01T10:30:00+09:00",
"updatedAt": "2018-04-01T10:30:00+09:00",
"カスタムオブジェクト項目": null
}

カスタムオブジェクト情報削除

カスタムオブジェクト情報を削除

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key required	string カスタムオブジェクト定義キー
id required	integer カスタムオブジェクトID

Responses

Response samples

403

Content type

application/json

{"error": "string",
"messages": ["string"
]
}

カスタムオブジェクト情報一括登録

カスタムオブジェクトを一括登録します
一度に登録可能な上限は1000件です
このAPIを使って登録した場合、監査ログは記録されません

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key

required

string

カスタムオブジェクト定義キー

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"customObjects": [{"カスタムオブジェクト項目": null,
"deals": [{"id": 0,
"delete": true
}
],
"customers": [{"id": 0,
"delete": true
}
],
"contacts": [{"id": 0,
"delete": true
}
]
}
]
}

Response samples

200
400

Content type

application/json

[0
]

カスタムオブジェクト情報一括更新

カスタムオブジェクトを一括更新します
一度に更新可能な上限は1000件です
このAPIを使って更新した場合、監査ログは記録されません

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key

required

string

カスタムオブジェクト定義キー

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"customObjects": [{"id": 0,
"カスタムオブジェクト項目": null,
"deals": [{"id": 0,
"delete": true
}
],
"customers": [{"id": 0,
"delete": true
}
],
"contacts": [{"id": 0,
"delete": true
}
]
}
]
}

Response samples

400

Content type

application/json

{"error": "string",
"messages": ["string"
],
"bulkErrors": [{"index": 0,
"messages": ["string"
]
}
]
}

カスタムオブジェクト情報一括削除

カスタムオブジェクトを一括削除します
このAPIを使って登録した場合、監査ログは記録されません

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key

required

string

カスタムオブジェクト定義キー

query Parameters

createdAtFrom	string <date-time> Example: createdAtFrom=2018-04-01T10:30:00+900 作成日時による検索範囲（開始）
createdAtTo	string <date-time> Example: createdAtTo=2018-04-01T10:30:00+900 作成日時による検索範囲指定（終了）
updatedAtFrom	string <date-time> Example: updatedAtFrom=2018-04-01T10:30:00+900 更新日時による検索範囲（開始）
updatedAtTo	string <date-time> Example: updatedAtTo=2018-04-01T10:30:00+900 更新日時による検索範囲指定（終了）
customObjectIds	Array of integers <int64> <= 200 items [ items <int64 > ] Deprecated カスタムオブジェクトIDのリスト複数指定する場合は同じパラメータ名を繰り返し指定（例: customObjectIds[]=1&customObjectIds[]=2&customObjectIds[]=3）最大200件まで指定可能

Responses

カスタムオブジェクト情報一括削除

カスタムオブジェクトを一括削除します
一度に削除可能な上限は1000件です
このAPIを使って削除した場合、監査ログは記録されません

Authorizations:

X-Api-Key

path Parameters

custom_object_def_key

required

string

カスタムオブジェクト定義キー

Request Body schema: application/json

customObjectIds

required

Array of integers <int64> <= 1000 items [ items <int64 > ]

カスタムオブジェクトIDのリスト

最大1000件まで指定可能

Responses

Request samples

Payload

Content type

application/json

{"customObjectIds": [0
]
}

監査ログ(Audits)

監査ログ取得

一度に取得できる件数は1000件
pageを指定することで続きを取得
作成・更新・削除対象のオブジェクトIDは各監査ログの dataId で取得できます

Authorizations:

X-Api-Key

query Parameters

page	integer ページ
startTime	string <date-time> Example: startTime=2018-04-01T10:30:00+09:00 開始日時 ex) startTime=2019-01-01T09:00 endTime=2019-01-01T11:00 上記のように指定した場合、開始日時2019-01-01 09:00 から終了日時2019-01-01 11:00を検索します。
endTime	string <date-time> Example: endTime=2018-04-01T10:30:00+09:00 終了日時 ex) startTime=2019-01-01T09:00+09:00 endTime=2019-01-01T11:00+09:00 上記のように指定した場合、開始日時 2019-01-01 09:00(日本時間) から終了日時2019-01-01 11:00(日本時間) を検索します。

Responses

Response samples

200

Content type

application/json

{"totalCount": 1,
"page": 1,
"audits": [{"id": 1,
"dataId": 12345,
"dataType": "案件",
"operationType": "update",
"details": "{\"probability_id\":[10,20]}",
"user": {"id": 1,
"name": "監査ログテスト",
"email": "audittest@mazrica.com"
},
"time": "2018-04-01T10:30:00+09:00"
}
]
}