POST /API/v1/Deals/Create

取引を作成します。 ## 概要 港湾関連データ連携基盤を通して、複数の事業者間で帳票のやり取りを行うには、まずはこの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***）。