TerminalPayment : /API/v1/Report/TerminalPayment
Venndor name
0000000000000_CyberPort(港湾物流分野)
System name
CyberPort
Infomation | |
Category |
|
Field |
|
Governments |
|
Data / Business logic |
|
Paid / Free |
Free |
Fees |
|
Created by |
|
Maintainer |
|
Date created |
|
Last updated |
|
Update frequency |
|
Necessity of contract |
Unnecessary |
About contract |
|
Version |
|
Terms and Conditions |
|
API List
API | Description | |
POST |
/API/v1/Report/TerminalPayment/Create |
帳票:ターミナル支払申込兼入金通知書を作成します。
## 概要
帳票を作成するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。
## 指定するパラメタについて
### 取引管理番号
帳票を作成する取引の取引管理番号(***dealNo***)を指定します。
### 帳票を作成する組織の組織ID・事業種別ID
帳票を作成する権限のある組織の組織ID(***organizationId***)と事業種別ID(***businessTypeId***)のセットで指定します。
### ターミナル問合せの取引・帳票ID
作成されるターミナル支払申込兼入金通知書にデータを引き継ぐ元となる、ターミナル問合せの取引・帳票ID(***terminalInquiryDealReportId***)を指定します。
### デマレージ支払申込対象の明細番号
ターミナル支払申込兼入金通知書にデータを引き継ぐ際に、支払申込の対象とするターミナル問合せのコンテナ明細の明細番号(インデックス)を配列で指定します。(***demurragePaymentTarget***)
このパラメータは必須ではありません。指定されなかった場合は、引継ぎ元のターミナル問合せのコンテナ明細すべてが引き継がれます。
また、引継ぎ元の問合せ項目(***inquiryItem***)がデマレージ(***demurrage***)以外の場合、このパラメータは指定できません。
|
|
DELETE |
/API/v1/Report/TerminalPayment/Delete/{dealReportId}?organizationId={organizationId}&businessTypeId={businessTypeId} |
帳票:ターミナル支払申込兼入金通知書を削除します。
## 概要
帳票を削除できるのは、その帳票を作成した組織(と事業種別)に所属するユーザのみです。
## 指定するパラメタについて
### 取引・帳票ID
削除する帳票の取引・帳票ID(***dealReportId***)を指定します。
### 帳票を削除する組織の組織ID・事業種別ID
帳票を削除する権限のある組織の組織ID(***organizationId***)と事業種別ID(***businessTypeId***)のセットで指定します。
|
|
GET |
/API/v1/Report/TerminalPayment/Get/{dealReportId} |
帳票:ターミナル支払申込兼入金通知書を取得します。
## 概要
帳票を取得するには、その帳票が格納された取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Read権限が必要です。
## 指定するパラメタについて
### 取引・帳票ID
取得する帳票の取引・帳票ID(***dealReportId***)を指定します。
|
|
POST |
/API/v1/Report/TerminalPayment/Register |
帳票:ターミナル支払申込兼入金通知書を保存します。
## 概要
帳票を保存するには、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対して、Write権限が必要です。
また、取引内の帳票はルートドキュメントにより、他の帳票と項目を共有しているので、事業者の更新が上書きされないよう帳票毎にバージョン識別子(***_etag***)がつけられています。
このバージョン識別子(etag)は、帳票の保存(Register)が行われると、違う値に更新されます。帳票の保存(Register)のときに、このバージョン識別子(***_etag***)が異なると、排他エラー(***409:Conflict***)が発生します。
Registerメソッドで指定するJSONデータは、GetもしくはCreateでのレスポンスデータを編集し、指定するようにしてください。
## 指定するパラメタについて
### 取引管理番号
帳票を作成する取引の取引管理番号(***dealNo***)を指定します。
### 帳票を作成する組織の組織ID・事業種別ID
帳票を作成する権限のある組織の組織ID(***organizationId***)と事業種別ID(***businessTypeId***)のセットで指定します。
|
|