Deals : /API/v1/Deals

帳票を送信します。

業務プロセスをキャンセルします。 ## 概要 取引管理番号(***dealNo***)と業務プロセスID（***businessProcessId***）を指定して、業務プロセスをキャンセルします。

取引を作成します。 ## 概要 港湾関連データ連携基盤を通して、複数の事業者間で帳票のやり取りを行うには、まずはこのAPIで取引を作成します。取引は、複数の事業者間と港湾・貿易業務を行う上での共有空間として機能します。 作成された取引情報には、取引管理番号（***dealNo***）という一意の番号が附番され、空のルートドキュメントが作成されます。以降、取引情報は、取引管理番号（***dealNo***）で一意に識別できます。 取引が作成された時点では、取引のオーナー情報として指定した組織と事業種別が割り当てられたユーザーしかアクセス出来ません。他の事業者を取引に参加させ、帳票のやり取りを行うには、作成した取引に対し、取引参加組織の登録（***/API/v1/Deals/RegisterOrganization***）を行う必要があります。 取引のオーナー情報は、取引内に作成する帳票の項目についての書き込み権限を決定する際に使用されます。取引のオーナーとして指定された組織ID（***organizationId***）と事業種別ID（***businessTypeId***）は、帳票の一部項目について、書き込み権限が設定されます。 ## 指定するパラメタについて ### 取引のオーナー情報 取引を作成する際は、その取引のオーナー情報として、組織ID（***organizationId***）と事業種別ID（***businessTypeId***）を指定する必要があります。 この組織（***organizationId***）と事業種別（***businessTypeId***）は、APIを呼び出すユーザーが所属している組織とその組織に割り当てられた事業種別から選択します。 例えば、 - 事業種別として、荷主（*Sipper/Consignee*）と海貨業者（*Forarder*）が割り当てられた組織A - 事業種別として、NVOCC（*NVOCC/International Freight Forwarder*）が割り当てられた組織B の両方の所属するユーザが取引を作成する場合、取引のオーナー情報として指定する組織（***organizationId***）と事業種別（***businessTypeId***）の組み合わせは以下の３通りとなります。 1. 組織＝組織A、事業種別＝荷主（*Sipper/Consignee*） 2. 組織＝組織A、事業種別＝海貨業者（*Forarder*） 3. 組織＝組織B、事業種別＝NVOCC（*NVOCC/International Freight Forwarder*） ### 業務パターン 取引の属性情報となる業務パターン（***businessPattern***,***businessPatternDetail***）は、取引内に作成できる帳票や事業種別毎の帳票へのRead/Write権限を決定します。このデフォルトの設定は、帳票アクセス権限マスタ（***/API/v1/Master/ReportPermissions/***）に設定されています。 取引の作成以降、業務パターンは変更出来ません。 業務パターンの内容は以下の通りです。 | № | 項目 | 意味 | 説明 | | :--- | -------------------------------------- | -------------- | :----------------------------------------------------------- | | 1 | ***businessPattern*** | 輸出・輸入 | 取引が輸出向けのものなのか、輸入向けのものなのかを決定します。 | | 2 | ***businessPatternDetail/fclOrLcl*** | FCL・LCL | 取引の輸送形態、FCL(Full Container Load)・LCL(Less Than Container Load)のどちらかを決定します。 | | 3 | ***businessPatternDetail/hasCoastal*** | 仲介なし・あり | 取引に事業種別：海貨やフォワーダー等の仲介業者が参加するのか否かを示す識別です。この識別は取引の検索条件などに使用します。 | | 4 | ***businessPatternDetail/withBroker*** | 内航なし・あり | 取引に事業種別：内航船社が参加する場合は、内航ありとします。 | ### 社内管理番号 社内管理番号（***domesticNo***）は、取引管理番号の別名として機能します。社内管理番号は取引に参加している組織・事業種別毎に附番できるので、各組織で任意の文字列による取引の特定が可能になります。社内管理番号（***domesticNo***）は、取引の作成後でも設定や変更が可能です（***/API/v1/Deals/SetDomesticNo***）。 社内管理番号（***domesticNo***）は、１つの取引に対して、取引のオーナーや取引参加組織毎に設定できます。社内管理番号（***domesticNo***）で取引を特定する場合は、***/API/v1/Deals/GetListByDomesticNo/{domesticNo}*** を使用します。 ### 取引名 取引名（***dealName***）は、取引に任意の名称をつける場合に指定します。取引の作成後でも設定や変更が可能です（***/API/v1/Deals/SetDealName***）。

問合せ専用の取引を作成および取得します。 ## 概要 「問合せ元」と「問合せ先」のみが参加する問合せ専用の取引を作成および取得、また既に存在する場合は取得のみを行います。 ## 指定するパラメタについて ### 問合せ元の組織の組織ID・事業種別ID 問合せ元（＝親）の組織ID（***parentOrganizationId***）と事業種別ID（***parentBusinessTypeId***）をセットで指定します。 ### 問合せ先の組織の組織ID・事業種別ID 問合せ先の組織（***organizationId***）と事業種別（***businessTypeId***）をセットで指定します。

取引を削除します。

取引に参加している組織を取引から削除します。 ## 概要 取引に参加している組織を削除できるのは、その組織を取引に招待した組織（に所属するユーザ）のみです。 このAPIの呼び出しに成功すると、その組織が取引内で作成した帳票も全て削除されます。 ## 指定するパラメタについて ### 取引管理番号 取引参加組織を削除する取引の取引管理番号（***dealNo***）を指定します。 ### 組織の組織ID・事業種別ID 削除する取引参加組織の組織ID（***organizationId***）と事業種別ID（***businessTypeId***）をセットで指定します。

取引を複製します。 ## 概要 複製できる取引は、ユーザが所属する組織と事業種別が参加する取引のみとなります。取引を複製すると、複製元の取引から、取引参加組織を引き継いだ形で、取引が作成されます。 但し、複製範囲（***organizationScope***）で、追加した組織のみとした場合、複製元でユーザが所属する組織（と事業種別）が追加した組織が複製対象となります。複製元の取引内に存在している帳票は複製対象とはなりません。 ## 指定するパラメタについて ### 取引管理番号 複製する取引の取引管理番号（***dealNo***）を指定します。 ### 組織ID・事業種別ID 取引を作成する際の取引のオーナー情報として、組織ID（***organizationId***）と事業種別ID（***businessTypeId***）を指定します。 ### 複製範囲 複製範囲（***organizationScope***）には、以下を指定します。 | パラメタ | 意味 | | ------------- | ------------------------------------------------------------ | | ***all*** | 複製元の取引に参加している全ての組織を含めて複製します。ただし、非公開組織は除きます。 | | ***selfAdd*** | 複製元の取引に追加した組織のみ複製します。ただし、非公開組織は除きます。 | ### 社内管理番号 作成する取引に社内管理番号（***domesticNo***）を附番する場合は指定します。 ### 取引名 作成する取引に取引名（***dealName***）をつける場合は指定します。

取引管理番号を指定して、取引を取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引について、取引管理番号（***dealNo***）を指定して、取引を取得します。 ## 指定するパラメタについて ### 取引管理番号 複製する取引の取引管理番号（***dealNo***）を指定します。

検索条件を指定して、条件に該当する取引の件数を取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引について、検索条件を指定して、条件に該当する取引の件数を取得します。 検索条件の指定方法については、[こちらを参照ください](https://docs.microsoft.com/ja-jp/graph/query-parameters#filter-parameter)。

検索条件を指定して、条件に該当する取引の件数を取得します。

検索条件を指定して、条件に該当する取引を全て取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引について、検索条件を指定して、条件に該当する取引を全て取得します。 検索条件の指定方法については、[こちらを参照ください](https://docs.microsoft.com/ja-jp/graph/query-parameters#filter-parameter)。

検索条件を指定して、条件に該当する取引を全て取得します。

B/L番号を指定して、取引を取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引について、B/L番号（***blNo***）を指定して、取引を取得します。 取引内に作成する帳票にB/L番号（***blNo***）を設定すると、その帳票が格納された取引はB/L番号（***blNo***）で特定できるようになります。 このAPIでは、指定されたB/L番号（***blNo***）が附番されている全ての取引を取得します。 ## 指定するパラメタについて ### B/L番号 B/L番号（***blNo***）は、取引に対して設定するのではなく、帳票を通して（帳票の項目として）設定します。

ブッキング番号を指定して、取引を取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引について、船社コード（***scacCode***）とブッキング番号（***bookingNo***）を指定して、取引を取得します。 取引内に作成する帳票に船社コード（***scacCode***）とブッキング番号（***bookingNo***）を設定すると、その帳票が格納された取引は船社コード（***scacCode***）とブッキング番号（***bookingNo***）で特定できるようになります。 このAPIでは、指定された船社コード（***scacCode***）とブッキング番号（***bookingNo***）が附番されている全ての取引を取得します。 ## 指定するパラメタについて ### 船社コード 船社コード（***scacCode***）は、取引に対して設定するのではなく、帳票を通して（帳票の項目として）設定します。 ### ブッキング番号 ブッキング番号（***bookingNo***）は、取引に対して設定するのではなく、帳票を通して（帳票の項目として）設定します。

社内管理番号を指定して、取引を取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引について、社内管理番号（***domesticNo***）を指定して、取引を取得します。 社内管理番号（***domesticNo***）は、取引管理番号の別名として機能します。社内管理番号は取引に参加している組織・事業種別毎に附番できるので、各組織で任意の文字列による取引の特定が可能になります。 このAPIでは、社内管理番号（***domesticNo***）が附番されている全ての取引を取得します。 ## 指定するパラメタについて ### 社内管理番号 社内管理番号（***domesticNo***）を指定します。

取引管理番号を指定して、取引内に作成された帳票の一覧を取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引について、取引管理番号（***dealNo***）を指定して、取引内に作成された帳票の一覧を取得します。 ## 指定するパラメタについて ### 取引管理番号 複製する取引の取引管理番号（***dealNo***）を指定します。

業務プロセスを予定(New)のステータスで登録します。 ## 概要 業務プロセスを予定(New)のステータスで新規作成し、取引に設定します。 ## 指定するパラメタについて ### 取引管理番号 業務プロセスを作成する取引の取引管理番号（***dealNo***）を指定します。 ### 業務テンプレートID 業務プロセス作成に利用する業務テンプレートのID(***businessTemplateId***)を指定します。 ### 組織の組織ID・事業種別ID 業務プロセスの作成者となる組織の組織ID（***organizationId***）と事業種別ID（***businessTypeId***）をセットで指定します。

取引参加組織を登録します。 ## 概要 取引が作成された時点では、取引のオーナー情報として指定した組織と事業種別が割り当てられたユーザーしかアクセス出来ません。このAPIで、取引に他の事業者を参加させます。 取引参加組織を登録すると、取引を他の事業者と共有することになります。 ## 指定するパラメタについて ### 取引管理番号 取引参加組織を登録する取引の取引管理番号（***dealNo***）を指定します。 ### 招待元となる組織の組織ID・事業種別ID 取引に参加する組織の招待元となる組織の組織ID（***parentOrganizationId***）と事業種別ID（***parentBusinessTypeId***）を指定します。 ### 招待先となる組織の組織ID・事業種別ID 取引に参加する組織の組織（***organizationId***）と事業種別（***businessTypeId***）をセットで指定します。 ### 他の組織に公開するか否か 取引参加組織を他の取引参加組織に公開するか否かを指定します。

取引参加組織の帳票アクセス権限を変更します。 ## 概要 取引参加組織の登録（***/API/v1/Deals/RegisterOrganization***）を行うと、登録した組織の事業種別に従い、システムデフォルトでの帳票のRead/Write権限が設定されていますが、これを変更する場合に、このAPIを使用します。 この変更は、変更を行った取引に対してのみ有効です。 また、システムデフォルトでの帳票のRead/Write権限以上に権限を変更することは出来ません。例えば、システムデフォルトの設定で、ある帳票にRead権限までが設定されている場合、これをWrite権限に変更することは出来ません。 ## 指定するパラメタについて ### 取引管理番号 取引参加組織の帳票アクセス権限を変更する取引の取引管理番号（***dealNo***）を指定します。 ### 組織の組織ID・事業種別ID 帳票アクセス権限を変更する取引参加組織の組織ID（***organizationId***）と事業種別ID（***businessTypeId***）をセットで指定します。 ### 帳票アクセス権限 帳票アクセス権限を帳票毎に帳票コードで指定します。帳票コードについては、帳票マスタ（***/API/v1/Master/Reports***）を参照ください。

帳票を送信します。 ## 概要 指定された帳票を取引参加組織に送信します。 帳票の送信は、その帳票が格納された取引に参加している組織のうち、その帳票にRead権限がある組織に対して行われます。 ## 指定するパラメタについて ### 取引管理番号 送信する帳票が格納された取引の取引管理番号（***dealNo***）を指定します。*※ただし、取引管理番号は指定しなくとも構いません。* ### 取引・帳票ID 送信する帳票の取引・帳票ID（***dealReportId***）を指定します。 ### 組織の組織ID・事業種別ID 送信元となる組織の組織ID（***organizationId***）と事業種別ID（***businessTypeId***）をセットで指定します。 ### メッセージ 帳票を送信する際の送信メッセージを指定します。 ### 帳票を担当する組織の組織ID・事業種別ID 取引参加組織の中から、帳票の担当者となる組織を、組織ID（***organizationId***）と事業種別ID（***businessTypeId***）のセットで指定します。 ## 通知を受け取る方法について このAPIで発行された通知を受け取る方法は、メール方式とWebhook方式の２つがあります。 ### メール方式 - 港湾関連データ連携基盤でのデフォルトでの通知受け取り方法です。組織に利用者アカウントを登録することで通知が受けられます。 - 通知について で各アクションで送信対象となる取引参加組織に所属する利用者全てにメールが送信されます。 - この通知を受け取るか否かは、利用者・帳票毎に設定可能です。 ### Webhook方式 - 港湾関連データ連携基盤でのオプションとしての通知受け取り方法です。組織情報にWebhookで使用するURLを設定することで、通知をJSONデータとして受け取ることが可能です。 - 例えば、通知について でのアクションと、貴社システムのアプリケーションをWebhookをトリガーとして自動で連携処理を行いたい場合などは、この方式を利用します。 - 組織に、Webhook通知用のシステムを登録する必要があります。

取引名を設定します。 ## 概要 作成した取引に任意の名称を設定します。 この名称は、取引の作成（***/API/v1/Deals/Create***）でも指定可能です。 取引の作成（***/API/v1/Deals/Create***）で設定した名称を変更する場合にも使用できます。 ## 指定するパラメタについて ### 取引管理番号 取引名を設定する取引の取引管理番号（***dealNo***）を指定します。 ### 取引名 取引名（***dealName***）を指定します。

社内管理番号を設定します。 ## 概要 社内管理番号（***domesticNo***）は、取引管理番号の別名として機能します。社内管理番号は取引に参加している組織・事業種別毎に附番できるので、各組織で任意の文字列による取引の特定が可能になります。 ## 指定するパラメタについて ### 取引管理番号 社内管理番号を設定する取引の取引管理番号（***dealNo***）を指定します。 ### 社内管理番号 社内管理番号（***domesticNo***）を指定します。

取引内の帳票について、担当となる組織を設定します。 ## 概要 取引内の帳票について、取引参加組織の中から、帳票の担当者となる組織を設定します。 ## 指定するパラメタについて ### 取引管理番号 担当となる組織を設定する帳票が格納された取引の取引管理番号（***dealNo***）を指定します。 ### 帳票を担当する組織の組織ID・事業種別ID 取引参加組織の中から、帳票の担当者となる組織を、組織ID（***organizationId***）と事業種別ID（***businessTypeId***）のセットで指定します。 ### 取引・帳票ID 担当となる組織を設定する帳票の取引・帳票ID（***dealReportId***）を指定します。 ### 担当状態 担当状態（***inCharge***）には、”担当する"の場合はtrue、"担当しない（解除する）"の場合はfalseを指定します。

取引完了フラグを設定します。 ## 概要 指定された取引の完了フラグを設定します。 ## 指定するパラメタについて ### 取引管理番号 完了フラグを設定する取引の取引管理番号（***dealNo***）を指定します。 ### 完了フラグ 完了フラグ（***isCompleted***）取引を完了にする場合はtrue、しない場合はfalseを指定します。

親の取引管理番号を設定します。 ## 概要 指定された取引に、親となる取引の取引管理番号を設定します。親子関係となった取引では、LCLなどの業務が行えます。 ## 指定するパラメタについて ### 取引管理番号 取引の取引管理番号（***dealNo***）を指定します。 ### 親となる取引の取引管理番号 親となる取引の取引管理番号（***parentDealNo***）を設定します。

業務プロセス(未処理)を開始します。 ## 概要 ステータスが未処理の業務プロセスを開始し、取引に設定します。 業務プロセスを開始すると、業務テンプレートにて定義されている取り扱う帳票と、その帳票に紐づくタスクが作成されます。作成されたタスクは、業務プロセスに紐づきます。 ## 指定するパラメタについて ### 業務プロセスID 開始する業務プロセスID（***businessProcessId***）を指定します ### 業務プロセス名 開始する業務プロセスの名称を変更する場合、業務プロセスの名称（***businessProcessName***）を指定します ### 組織の組織ID・事業種別ID・利用者ID 業務プロセスの担当者(業務プロセスにて取り扱う帳票の入力者)となる組織の組織ID（***organizationId***）と事業種別ID（***businessTypeId***）をセットで指定します。 利用者ID(***employeeId***)は任意となります。 APIの実行者が所属する組織と業務プロセスの担当者の所属する組織は同一である必要があります。 同様に、業務プロセスにて取り扱う帳票の宛先となる組織の組織ID（***organizationId***）と事業種別ID（***businessTypeId***）も指定します。 利用者ID(***employeeId***)は入力不要となります。 ### 帳票 業務プロセスにて取り扱う帳票に対し、帳票コード、取引・帳票ID、コンテナ番号、機器受渡種別（IN/OUT）、コンテナ状態（FULL/EMPTY）、コンテナターミナルコードのセットを配列方式で指定します。 このパラメタでは同一帳票コードの帳票を複数指定することができます。 また、業務プロセスにて取り扱う帳票に対応する帳票コードは各帳票それぞれ1回以上指定してください。 取引内に既存の帳票を指定する場合は帳票の取引・帳票IDを指定してください。 対象の帳票がコンテナ単位の帳票である場合、コンテナ番号(***containerNo***)を指定します。 対象の帳票が機器受領書(EIR)である場合、機器受渡種別（IN/OUT）(***equipmentInterchangeTypeInOut***)、コンテナ状態（FULL/EMPTY）(***countainerTypeId***)、コンテナターミナルコード(***countainerTerminalCode***)を指定します。 取引内に1つしか作成できない帳票と取引内にコンテナ単位で1つしか作成できない帳票については、取引内に既存の場合は自動的に既存の帳票に紐づく形でタスクが作成されます。 ### メッセージ 業務開始時に付与するメッセージ("***message***)を指定することができます。メッセージは帳票およびタスク作成時のメッセージとなります。

業務プロセス(予定)を削除します。 ## 概要 取引管理番号(***dealNo***)と業務プロセスID（***businessProcessId***）を指定して、業務プロセス(予定)を削除します。 ステータスがNewである業務プロセスに対してのみ有効となります。 ## 指定するパラメタについて ### 取引管理番号 対象の業務プロセスが存在する取引の取引管理番号（***dealNo***）を指定します。 ### 業務プロセスID 対象の業務プロセスID（***businessProcessId***）を指定します。

業務プロセスを更新します。 ## 概要 業務プロセスを更新します。 ## 指定するパラメタについて ### 業務プロセスID 更新する業務プロセスのID（***businessProcessId***）を指定します ### 業務プロセス名 更新後の業務プロセス名（***businessProcessName***）を指定します。 ### ステータス 更新後のステータス（***status***）を指定します。

業務プロセスの表示順を更新します。 ## 概要 業務プロセスの取引内でのカテゴリ単位の表示順を更新します。 ## 指定するパラメタについて ### 業務プロセスID 更新する業務プロセスのID（***businessProcessId***）を指定します ### 取引管理番号 業務プロセスの表示順を更新する取引の取引管理番号（***dealNo***）を指定します。 ### 表示順 更新後の表示順（***displayOrder***）を指定します。