GET /API/v1/Deals/GetListByBookingNo?scacCode={scacCode}&bookingNo={bookingNo}
ブッキング番号を指定して、取引を取得します。 ## 概要 ユーザが所属している組織が作成、または参加している取引について、船社コード(***scacCode***)とブッキング番号(***bookingNo***)を指定して、取引を取得します。 取引内に作成する帳票に船社コード(***scacCode***)とブッキング番号(***bookingNo***)を設定すると、その帳票が格納された取引は船社コード(***scacCode***)とブッキング番号(***bookingNo***)で特定できるようになります。 このAPIでは、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)が附番されている全ての取引を取得します。 ## 指定するパラメタについて ### 船社コード 船社コード(***scacCode***)は、取引に対して設定するのではなく、帳票を通して(帳票の項目として)設定します。 ### ブッキング番号 ブッキング番号(***bookingNo***)は、取引に対して設定するのではなく、帳票を通して(帳票の項目として)設定します。
Request Information
URI Parameters
UriModel of Deals.GetListByBookingNo
Name | Description | Type | Additional information |
---|---|---|---|
scacCode | scacCode |
String |
Required |
bookingNo | bookingNo |
String |
Required |
Body Parameters
None.
Response Information
Resource Description
Name | Description | Type | Additional information |
---|---|---|---|
dealNo | 取引管理番号 |
String |
Required |
dealName | 取引名 |
String, Null |
None. |
businessPattern | 業務パターン |
String |
Required |
businessPatternDetail |
Required |
||
parentDealNo | 親の取引管理番号 |
String, Null |
None. |
organizations | 取引に参加している組織 |
Collection of organizations |
Required |
reports | 帳票 |
Collection of reports |
Required |
isCompleted | 取引完了フラグ |
Boolean |
Required |
estimatedTimeOfDeparturePolEtd | 積荷港 出港予定日 |
String, Null |
Format : date |
estimatedTimeOfArrivalPodEta | 荷揚港 入港予定日 |
String, Null |
Format : date |
portOfLoading | 積荷港 名称 |
String, Null |
None. |
portOfDischarge | 荷揚港 名称 |
String, Null |
None. |
bookingNo | ブッキング(船腹予約)番号 |
String, Null |
None. |
blNumber | B/L番号 |
String, Null |
None. |
vesselName | 本船名 |
String, Null |
None. |
scacCode | 船社コード |
String, Null |
None. |
voyageNo | 航海番号 |
String, Null |
None. |
createBusinessTypeId | 作成事業種別ID |
String |
Required |
createOrganizationId | 作成組織ID |
String |
Required |
createEmployeeId | 作成利用者ID |
String |
Required |
createDatetime | 作成日時 |
String |
Required Format : date-time |
updateDatetime | 更新日時 |
String, Null |
Format : date-time |
partitionNo | パーティション番号 |
Integer |
Required |
businessProcesses | 業務プロセス |
Collection, Null of businessProcesses |
None. |
cyCutDate | CYカット日 |
String, Null |
Format : date |
cfsCutDate | CFSカット日 |
String, Null |
Format : date |
invoiceNo | インボイス番号 |
String, Null |
None. |