取引商品(deal)
取引商品に関する情報の登録・更新・取得・削除ができます。
シートのidの取得にはSearch APIが使用できます。
取引商品取得
必要な権限
取引参照
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/deal/{id}
HTTP Method
GET
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
| 2 | id | ○ | string | - | 対象レコードID |
取引商品登録
必要な権限
取引登録
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/deal
HTTP Method
POST
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
Request Body
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|---|
| 1 | deals.deal.continue_or_terminate_flg | 継続/終了 | string | "継続"もしくは"終了" | |
| 2 | deals.deal.relational_product | 商品ID | number | ||
| 3 | deals.deal.relational_customer | 顧客ID | number | ||
| 4 | deals.deal.relational_businessplan | 案件ID | number | ||
| 5 | deals.deal.charge_employee @deals.charge_employee.main_charge | 主担当者ID | number | 社員IDを指定。自社担当者にも指定必須。 | |
| 6 | deals.deal.charge_employee @deals.charge_employee.target_employee @employees.employee.id | 自社担当者である社員ID | array(number) | 社員IDを指定。主担当者はこちらにも指定必須。 | |
| 7 | deals.deal.charge_department @deals.charge_department.main_charge | 主担当部署ID | number | 部署IDを指定。自社担当部署にも指定必須。 | |
| 8 | deals.deal.charge_department @deals.charge_department.target_department @employees.department.id | 自社担当部署である部署ID | array(number) | 部署IDを指定。主担当部署はこちらにも指定必須。 | |
| 9 | deals.deal.charge_group @deals.charge_group.main_charge_flg | 主担当グループID | number | グループIDを指定。自社担当グループにも指定必須。 | |
| 10 | deals.deal.charge_group @deals.charge_group.target_group @employees.group.id | 自社担当グループであるグループID | array(number) | グループIDを指定。主担当グループはこちらにも指定必須 | |
| 11 | deals.deal.order_price | 受注(予定)金額 | number | ||
| 12 | deals.deal.memo | メモ | string | ||
| 13 | deals.deal.business_type | 業務タイプ | string | 業務タイプマスタの選択肢名。マスタの選択肢取得方法 | |
| 14 | deals.deal.progress | 進捗状況 | string | 進捗マスタの選択肢名。マスタの選択肢取得方法 | |
| 15 | deals.deal.unit_price | 金額(単価) | number | ||
| 16 | deals.deal.amount | 数量 | number | ||
| 17 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | 拡張項目 | any() | 拡張項目を追加する際、アイテムタイプ別定義のシートを参照する |
Example
{
"deals.deal.continue_or_terminate_flg": "継続",
"deals.deal.relational_product": 123,
"deals.deal.relational_customer": 123,
"deals.deal.relational_businessplan": 123,
"deals.deal.charge_employee@deals.charge_employee.main_charge": 123,
"deals.deal.charge_employee@deals.charge_employee.target_employee@employees.employee.id": [
123
],
"deals.deal.charge_department@deals.charge_department.main_charge": 123,
"deals.deal.charge_department@deals.charge_department.target_department@employees.department.id": [
123
],
"deals.deal.charge_group@deals.charge_group.main_charge": 123,
"deals.deal.charge_group@deals.charge_group.target_group@employees.group.id": [
123
],
"deals.deal.order_price": 112,
"deals.deal.memo": "メモ",
"deals.deal.business_type": "一般対応",
"deals.deal.progress": "提案",
"deals.deal.unit_price": 10,
"deals.deal.amount": 10
}
取引商品更新
必要な権限
取引変更
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/deal/{id}
HTTP Method
PUT
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
| 2 | id | ○ | string | - | 対象レコードID |
Request Body
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|---|
| 1 | deals.deal.continue_or_terminate_flg | 継続/終了 | string | "継続"もしくは"終了" | |
| 2 | deals.deal.relational_product | 商品ID | number | ||
| 3 | deals.deal.relational_customer | 顧客ID | number | ||
| 4 | deals.deal.relational_businessplan | 案件ID | number | ||
| 5 | deals.deal.charge_employee @deals.charge_employee.main_charge | 主担当者ID | number | 社員IDを指定。自社担当者にも指定必須。 | |
| 6 | deals.deal.charge_employee @deals.charge_employee.target_employee @employees.employee.id | 自社担当者である社員ID | array(number) | 社員IDを指定。主担当者はこちらにも指定必須。 | |
| 7 | deals.deal.charge_department @deals.charge_department.main_charge | 主担当部署ID | number | 部署IDを指定。自社担当部署にも指定必須。 | |
| 8 | deals.deal.charge_department @deals.charge_department.target_department @employees.department.id | 自社担当部署である部署ID | array(number) | 部署IDを指定。主担当部署はこちらにも指定必須。 | |
| 9 | deals.deal.charge_group @deals.charge_group.main_charge_flg | 主担当グループID | number | グループIDを指定。自社担当グループにも指定必須。 | |
| 10 | deals.deal.charge_group @deals.charge_group.target_group @employees.group.id | 自社担当グループであるグループID | array(number) | グループIDを指定。主担当グループはこちらにも指定必須。 | |
| 11 | deals.deal.order_price | 受注(予定)金額 | number | ||
| 12 | deals.deal.memo | メモ | string | ||
| 13 | deals.deal.business_type | 業務タイプ | string | 業務タイプマスタの選択肢名。マスタの選択肢取得方法 | |
| 14 | deals.deal.progress | 進捗状況 | string | 進捗マスタの選択肢名。マスタの選択肢取得方法 | |
| 15 | deals.deal.unit_price | 金額(単価) | number | ||
| 16 | deals.deal.amount | 数量 | number | ||
| 17 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | 拡張項目 | any() | 拡張項目を追加する際、アイテムタイプ別定義のシートを参照する |
Example
{
"deals.deal.continue_or_terminate_flg": "継続",
"deals.deal.relational_product": 123,
"deals.deal.relational_customer": 123,
"deals.deal.relational_businessplan": 123,
"deals.deal.charge_employee@deals.charge_employee.main_charge": 123,
"deals.deal.charge_employee@deals.charge_employee.target_employee@employees.employee.id": [
123
],
"deals.deal.charge_department@deals.charge_department.main_charge": 123,
"deals.deal.charge_department@deals.charge_department.target_department@employees.department.id": [
123
],
"deals.deal.charge_group@deals.charge_group.main_charge": 123,
"deals.deal.charge_group@deals.charge_group.target_group@employees.group.id": [
123
],
"deals.deal.order_price": 112,
"deals.deal.memo": "メモ",
"deals.deal.business_type": "一般対応",
"deals.deal.progress": "提案",
"deals.deal.unit_price": 10,
"deals.deal.amount": 10
}
取引商品削除
必要な権限
取引削除・取引一括削除
Request
URL
https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/v1/sheet/deal/{id}
HTTP Method
DELETE
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | テナントID |
| 2 | id | ○ | string | - | 対象レコードID |
Response
Response Body
Response Bodyはこちらの共通仕様に則っています。
| No. | プロパティ名 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|
| 1 | deals.deal.id | 取引商品ID | number | |
| 2 | deals.deal.continue_or_terminate_flg | 継続/終了 | string | "継続"もしくは"終了" |
| 3 | deals.deal.relational_product | 商品ID | number | |
| 4 | deals.deal.relational_customer | 顧客ID | number | |
| 5 | deals.deal.relational_businessplan | 案件ID | number | |
| 6 | deals.deal.charge_employee @deals.charge_employee.main_charge | 主担当者ID | number | |
| 7 | deals.deal.charge_employee @deals.charge_employee.target_employee @employees.employee.id | 自社担当者である社員ID | array(number) | 主担当者はこちらにも含まれる。 |
| 8 | deals.deal.charge_department @deals.charge_department.main_charge | 主担当部署ID | number | |
| 9 | deals.deal.charge_department @deals.charge_department.target_department @employees.department.id | 自社担当部署である部署ID | array(number) | 主担当部署はこちらにも含まれる。 |
| 10 | deals.deal.charge_group @deals.charge_group.main_charge_flg | 主担当グループID | number | |
| 11 | deals.deal.charge_group @deals.charge_group.target_group @employees.group.id | 自社担当グループであるグループID | array(number) | 主担当グループはこちらにも含まれる。 |
| 12 | deals.deal.order_price | 受注(予定)金額 | number | |
| 13 | deals.deal.memo | メモ | string | |
| 14 | deals.deal.business_type | 業務タイプ | string | 業務タイプマスタの選択肢名。マスタの選択肢取得方法 |
| 15 | deals.deal.progress | 進捗状況 | string | 進捗マスタの選択肢名。マスタの選択肢取得方法 |
| 16 | deals.deal.unit_price | 金額(単価) | number | |
| 17 | deals.deal.amount | 数量 | number | |
| 18 | system_reg_date | 登録日 | string | "yyyy/mm/dd hh:MM"形式 ※取得のみ |
| 19 | system_reg_user | 登録ユーザ | number | 登録者ユーザID ※取得のみ |
| 20 | system_reg_employee | 登録社員 | number | 登録社員ID ※取得のみ |
| 21 | system_upd_date | 更新日 | string | "yyyy/mm/dd hh:MM"形式 ※取得のみ |
| 22 | system_upd_user | 最終更新ユーザ | number | 最終更新者ユーザID ※取得のみ |
| 23 | system_upd_employee | 最終更新社員 | number | 最終更新者社員ID ※取得のみ |
| 24 | 拡張項目の項目名は、システムで設定するitem_idを設定する。item_idの確認方法 | 拡張項目 | any() |
Example
{
"deals.deal.id": 123,
"deals.deal.continue_or_terminate_flg": "継続",
"deals.deal.relational_product": 123,
"deals.deal.relational_customer": 123,
"deals.deal.relational_businessplan": 123,
"deals.deal.charge_employee@deals.charge_employee.main_charge": 123,
"deals.deal.charge_employee@deals.charge_employee.target_employee@employees.employee.id": [
123
],
"deals.deal.charge_department@deals.charge_department.main_charge": 123,
"deals.deal.charge_department@deals.charge_department.target_department@employees.department.id": [
123
],
"deals.deal.charge_group@deals.charge_group.main_charge": 123,
"deals.deal.charge_group@deals.charge_group.target_group@employees.group.id": [
123
],
"deals.deal.order_price": 112,
"deals.deal.memo": "メモ",
"deals.deal.business_type": "一般対応",
"deals.deal.progress": "提案",
"deals.deal.unit_price": 10,
"deals.deal.amount": 10,
"system_reg_date": "2024/01/01 00:00",
"system_reg_user": 123,
"system_reg_employee": 456,
"system_upd_date": "2024/01/02 00:00",
"system_upd_user": 123,
"system_upd_employee": 456
}