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***)のセットで指定します。
Request Information
URI Parameters
None.
Body Parameters
TerminalPayment
Name | Description | Type | Additional information |
---|---|---|---|
_etag | etag |
String |
Required |
amountBilled | 請求金額 |
Number, Null |
Format : Number(9,0) |
applicationDate | 申込日付 |
String, Null |
None. |
bankAccountNo | 銀行 口座番号 |
String, Null |
None. |
bankBranchCode | 銀行 支店コード |
String, Null |
None. |
bankBranchName | 銀行 支店名 |
String, Null |
None. |
bankCode | 銀行コード |
String, Null |
None. |
bankName | 銀行名 |
String, Null |
None. |
bankNameOfAccount | 銀行 口座名義 |
String, Null |
None. |
businessTypeId | 事業種別ID |
String |
Required Format : Protect Pattern : ^(?!.*(\?|\$|#|&|,|=)).*$ |
containerDetails |
Collection, Null of containerDetails |
None. |
|
customId | カスタムID |
String, Null |
Format : Protect |
dealInformation |
Required |
||
dealReportId | 取引・帳票ID |
String |
Required |
inquiryItem | 問合せ項目 |
String, Null |
None. |
inspectionDate | 検査日付 |
String, Null |
None. |
inspectionTime | 検査時刻 |
String, Null |
None. |
inspectionType | 検査種別 |
String, Null |
None. |
invoiceNumber | 請求書番号 |
String, Null |
None. |
note1 | 備考1 |
String, Null |
None. |
note2 | 備考2 |
String, Null |
None. |
note3 | 備考3 |
String, Null |
None. |
organizationId | 組織ID |
String |
Required Format : Protect Pattern : ^(?!.*(\?|\$|#|&|,|=)).*$ |
partitionNo | パーティション番号 |
Integer, Null |
Format : Protect |
payeeCompanyName | 支払先_会社名 |
String, Null |
None. |
payeeEmail | 支払先_メールアドレス |
String, Null |
None. |
payeePersonInCharge | 支払先_担当者 |
String, Null |
None. |
payeeTel | 支払先_電話番号 |
String, Null |
None. |
paymentAmount | 支払金額 |
Number, Null |
Format : Number(9,0) Maximum : 999999999 Minimum : 0 |
paySourceCompanyName | 支払元_会社名 |
String, Null |
None. |
paySourceEmail | 支払元_メールアドレス |
String, Null |
None. |
paySourcePersonInCharge | 支払元_担当者 |
String, Null |
None. |
paySourceTel | 支払元_電話番号 |
String, Null |
None. |
remarks | 摘要 |
String, Null |
None. |
status | ステータス |
String, Null |
None. |
transferAmount | 振込金額 |
Number, Null |
Format : Number(9,0) Maximum : 999999999 Minimum : 0 |
transferDate | 振込日付 |
String, Null |
None. |
transferGuidance | 振込先案内 |
String, Null |
None. |
transferNote | 振込備考 |
String, Null |
None. |
Response Information
Resource Description
None.