AccessiblePartners
帳票にアクセス可能なパートナー
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Reports/AccessiblePartners/Delete/{accessiblePartnerId} |
帳票にアクセス可能なパートナーを削除します。 アクセス可能なパートナーID(***accessiblePartnerId***)を指定して、アクセス可能なパートナーを削除します。 帳票にアクセス可能なパートナーに関する詳細については、[帳票にアクセス可能なパートナーについて]()を参照ください。 |
|
| GET | /API/v2/Reports/AccessiblePartners/Get/{accessiblePartnerId} |
帳票にアクセス可能なパートナーを取得します。 アクセス可能なパートナーID(***accessiblePartnerId***)を指定して、帳票にアクセス可能なパートナーを取得します。 帳票にアクセス可能なパートナーに関する詳細については、[帳票にアクセス可能なパートナーについて]()を参照ください。 |
|
| GET | /API/v2/Reports/AccessiblePartners/GetAddablePartners/{reportId} |
帳票に追加が可能なパートナーを取得します。 帳票ID(***reportId***)を指定して、帳票に追加が可能なパートナーを取得します。 帳票にアクセス可能なパートナーに関する詳細については、[帳票にアクセス可能なパートナーについて]()を参照ください。 |
|
| GET | /API/v2/Reports/AccessiblePartners/GetList/{reportId} |
帳票にアクセス可能なパートナーを取得します。 帳票ID(***reportId***)を指定して、帳票にアクセス可能なパートナーを取得します。 帳票にアクセス可能なパートナーに関する詳細については、[帳票にアクセス可能なパートナーについて]()を参照ください。 |
|
| POST | /API/v2/Reports/AccessiblePartners/Register |
帳票にアクセス可能なパートナーを登録します。 指定された帳票に、アクセス可能なパートナーを登録します。この操作を実行できるのは、帳票を作成した組織に所属する利用者のみです。 登録可能なパートナーは、取引内での帳票アクセス権限(***/API/v2/Trades/Partners/PermissionInTrades***)で、対象となる帳票に対して、RW、もしくは、R権限が付与されている必要があります。 ただし、帳票アクセス権限(***/API/v2/Master/Reports/Permissions***)での設定以上に権限を変更することは出来ません。例えば、帳票アクセス権限(***/API/v2/Master/Reports/Permissions***)での設定で、ある帳票にRead権限までが設定されている場合、これをWrite権限に変更することは出来ません。 帳票にアクセス可能なパートナーに関する詳細については、[帳票にアクセス可能なパートナーについて]()を参照ください。 |
|
| POST | /API/v2/Reports/AccessiblePartners/RegisterList |
帳票にアクセス可能なパートナーを登録します。 指定された帳票に、アクセス可能なパートナーをまとめて登録します。 帳票にアクセス可能なパートナーに関する詳細については、[帳票にアクセス可能なパートナーについて]()を参照ください。 |
|
| PATCH | /API/v2/Reports/AccessiblePartners/Update/{accessiblePartnerId} |
帳票へのアクセス権限を更新します。 帳票にアクセス可能なパートナーID(***accessiblePartnerId***)を指定して、帳票への帳票アクセス権限を更新します。 ただし、帳票アクセス権限(***/API/v2/Master/Reports/Permissions***)での設定以上に権限を変更することは出来ません。例えば、帳票アクセス権限(***/API/v2/Master/Reports/Permissions***)での設定で、ある帳票にRead権限までが設定されている場合、これをWrite権限に変更することは出来ません。 帳票にアクセス可能なパートナーに関する詳細については、[帳票にアクセス可能なパートナーについて]()を参照ください。 |
|
AccessPolicies
EDIFACTアクセスポリシー設定
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/Organizations/ParseEdifactSettings/AccessPolicies/Get/{accessPolicyId} |
EDIFACTアクセスポリシー設定を取得します。 アクセスポリシー設定(***accessPolicyId***)を指定して、EDIFACT検索ポリシー設定IDを取得します。 取得できるアクセスポリシー設定は、EDIFACT変換設定(***/API/v2/Organizations/ParseEdifactSettings***)に設定された組織、すなわち EDIFACTメッセージを送信する組織、または 本APIにより検索を許可された会社 のいずれかに該当するものです。 EDIFACTアクセスポリシー設定に関する詳細については、[EDIFACTアクセスポリシー設定について]()を参照ください。 |
|
| GET | /API/v2/Organizations/ParseEdifactSettings/AccessPolicies/GetList?accessPolicyId=!{accessPolicyId}&parseEdifactSettingId=!{parseEdifactSettingId}&companyId=!{companyId}&organizationId=!{organizationId} |
検索条件に該当するEDIFACTアクセスポリシー設定を全て取得します。 検索条件を指定して、EDIFACTアクセスポリシー設定を全て取得します。 取得できるアクセスポリシー設定は、EDIFACT変換設定(***/API/v2/Organizations/ParseEdifactSettings***)に設定された組織、すなわち EDIFACTメッセージを送信する組織、または 本APIにより検索を許可された会社 のいずれかに該当するものです。 EDIFACTアクセスポリシー設定に関する詳細については、[EDIFACTアクセスポリシー設定について]()を参照ください。 |
|
AccidentCodes
事故コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/AccidentCodes/DeleteAdmin/{accidentCode} |
事故コードを削除します。 事故コード(***accidentCode***)を指定して、事故コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/AccidentCodes/Get/{accidentCode} |
事故種別を取得します。 事故コード(***accidentCode***)を指定して、事故種別を取得します。 事故コードに関する詳細については、[事故コードについて]()を参照ください。 |
|
| GET | /API/v2/General/AccidentCodes/GetList |
事故種別を全て取得します。 事故コードに関する詳細については、[事故コードについて]()を参照ください。 |
|
| POST | /API/v2/General/AccidentCodes/RegisterAdmin |
事故種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/AccidentCodes/RegisterInternal |
事故種別を登録します。 内部呼び出し用。 (*For admin) |
|
AclInformationInquiries
IAL_ACL情報照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/AclInformationInquiries/Create |
IALを作成します。 IALを作成するには、利用者がIALを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/AclInformationInquiries/Delete/{reportId} |
IALを削除します。 帳票ID(***reportId***)を指定して、、IALを削除します。 IALを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/AclInformationInquiries/DeleteFile/{fileId} |
IALの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IALの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/AclInformationInquiries/Get/{reportId} |
IALを取得します。 帳票ID(***reportId***)を指定して、IAL取得します。 編集が行われていない場合は、ルートドキュメントから最新のIALを取得します。 編集中の場合は、先に保存した、IALを取得します。 |
|
| GET | /API/v2/NaccsReports/AclInformationInquiries/GetFile/{fileId} |
IALに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IALに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/AclInformationInquiries/Lock/{reportId} |
編集するため、IALをロックします。 帳票ID(***reportId***)を指定して、IALをロックします。 IALを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IALを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIALは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IALをルートドキュメントから参照できますが、編集中(ロック中)のIALは参照できません。 |
|
| POST | /API/v2/NaccsReports/AclInformationInquiries/SendToNaccs |
IALをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIALをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IALが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/AclInformationInquiries/SetCancel/{reportId} |
IALの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IALの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/AclInformationInquiries/Submit/{reportId} |
IALを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIALを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IALが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/AclInformationInquiries/Unlock/{reportId} |
IALのロックを解除します。 帳票ID(***reportId***)を指定して、IALのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/AclInformationInquiries/Update/{reportId} |
IALを更新します。 帳票ID(***reportId***)を指定して、IALを更新します。 このメソッドでは、IALの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/AclInformationInquiries/UploadFile |
IALにファイルを添付します。 指定されたIALに、ファイルを添付します。 |
|
AclRegistrationCalls
ACL11_ACL情報登録呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/AclRegistrationCalls/Create |
ACL11を作成します。 ACL11を作成するには、利用者がACL11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/AclRegistrationCalls/Delete/{reportId} |
ACL11を削除します。 帳票ID(***reportId***)を指定して、、ACL11を削除します。 ACL11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/AclRegistrationCalls/DeleteFile/{fileId} |
ACL11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、ACL11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/AclRegistrationCalls/Get/{reportId} |
ACL11を取得します。 帳票ID(***reportId***)を指定して、ACL11取得します。 編集が行われていない場合は、ルートドキュメントから最新のACL11を取得します。 編集中の場合は、先に保存した、ACL11を取得します。 |
|
| GET | /API/v2/NaccsReports/AclRegistrationCalls/GetFile/{fileId} |
ACL11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、ACL11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/AclRegistrationCalls/Lock/{reportId} |
編集するため、ACL11をロックします。 帳票ID(***reportId***)を指定して、ACL11をロックします。 ACL11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、ACL11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたACL11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、ACL11をルートドキュメントから参照できますが、編集中(ロック中)のACL11は参照できません。 |
|
| POST | /API/v2/NaccsReports/AclRegistrationCalls/SendToNaccs |
ACL11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したACL11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ACL11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/AclRegistrationCalls/SetCancel/{reportId} |
ACL11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、ACL11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/AclRegistrationCalls/Submit/{reportId} |
ACL11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したACL11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ACL11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/AclRegistrationCalls/Unlock/{reportId} |
ACL11のロックを解除します。 帳票ID(***reportId***)を指定して、ACL11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/AclRegistrationCalls/Update/{reportId} |
ACL11を更新します。 帳票ID(***reportId***)を指定して、ACL11を更新します。 このメソッドでは、ACL11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/AclRegistrationCalls/UploadFile |
ACL11にファイルを添付します。 指定されたACL11に、ファイルを添付します。 |
|
AclRegistrationForShips
ACL01_ACL情報登録(コンテナ船用)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/AclRegistrationForShips/Create |
ACL01を作成します。 ACL01を作成するには、利用者がACL01を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/AclRegistrationForShips/Delete/{reportId} |
ACL01を削除します。 帳票ID(***reportId***)を指定して、、ACL01を削除します。 ACL01を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/AclRegistrationForShips/DeleteFile/{fileId} |
ACL01の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、ACL01の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/AclRegistrationForShips/Get/{reportId} |
ACL01を取得します。 帳票ID(***reportId***)を指定して、ACL01取得します。 編集が行われていない場合は、ルートドキュメントから最新のACL01を取得します。 編集中の場合は、先に保存した、ACL01を取得します。 |
|
| GET | /API/v2/NaccsReports/AclRegistrationForShips/GetFile/{fileId} |
ACL01に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、ACL01に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/AclRegistrationForShips/Lock/{reportId} |
編集するため、ACL01をロックします。 帳票ID(***reportId***)を指定して、ACL01をロックします。 ACL01を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、ACL01を編集する場合は、このメソッドを呼び出してロックします。 ロックされたACL01は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、ACL01をルートドキュメントから参照できますが、編集中(ロック中)のACL01は参照できません。 |
|
| POST | /API/v2/NaccsReports/AclRegistrationForShips/SendToNaccs |
ACL01をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したACL01をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ACL01が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/AclRegistrationForShips/SetCancel/{reportId} |
ACL01の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、ACL01の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/AclRegistrationForShips/Submit/{reportId} |
ACL01を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したACL01を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ACL01が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/AclRegistrationForShips/SubmitByPost |
ACL01を提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/AclRegistrationForShips/Unlock/{reportId} |
ACL01のロックを解除します。 帳票ID(***reportId***)を指定して、ACL01のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/AclRegistrationForShips/Update/{reportId} |
ACL01を更新します。 帳票ID(***reportId***)を指定して、ACL01を更新します。 このメソッドでは、ACL01の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/AclRegistrationForShips/UpdateByPost |
ACL01を更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/AclRegistrationForShips/UploadFile |
ACL01にファイルを添付します。 指定されたACL01に、ファイルを添付します。 |
|
Administrators
会社の管理者
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Companies/Administrators/Delete/{administratorId} |
会社の管理者を削除します。 管理者ID(***administratorId***)を指定して、会社の管理者を削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 会社の管理者に関する詳細については、[会社の管理者について]()を参照ください。 |
|
| GET | /API/v2/Companies/Administrators/Get/{administratorId} |
会社の管理者を取得します。 管理者ID(***administratorId***)を指定して、会社の管理者を取得します。 会社の管理者に関する詳細については、[会社の管理者について]()を参照ください。 |
|
| GET | /API/v2/Companies/Administrators/GetList |
会社の管理者を全て取得します。 ログインしている利用者が所属する会社の管理者を全て取得します。 会社の管理者に関する詳細については、[会社の管理者について]()を参照ください。 |
|
| POST | /API/v2/Companies/Administrators/Register |
会社の管理者を登録します。 管理者が所属する会社の中から利用者を指定して、管理者として登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 会社の管理者に関する詳細については、[会社の管理者について]()を参照ください。 |
|
AirExportCargoInquiries
IGS_輸出貨物情報照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/AirExportCargoInquiries/Create |
IGSを作成します。 IGSを作成するには、利用者がIGSを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/AirExportCargoInquiries/Delete/{reportId} |
IGSを削除します。 帳票ID(***reportId***)を指定して、、IGSを削除します。 IGSを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/AirExportCargoInquiries/DeleteFile/{fileId} |
IGSの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IGSの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/AirExportCargoInquiries/Get/{reportId} |
IGSを取得します。 帳票ID(***reportId***)を指定して、IGS取得します。 編集が行われていない場合は、ルートドキュメントから最新のIGSを取得します。 編集中の場合は、先に保存した、IGSを取得します。 |
|
| GET | /API/v2/NaccsReports/AirExportCargoInquiries/GetFile/{fileId} |
IGSに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IGSに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/AirExportCargoInquiries/Lock/{reportId} |
編集するため、IGSをロックします。 帳票ID(***reportId***)を指定して、IGSをロックします。 IGSを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IGSを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIGSは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IGSをルートドキュメントから参照できますが、編集中(ロック中)のIGSは参照できません。 |
|
| POST | /API/v2/NaccsReports/AirExportCargoInquiries/SendToNaccs |
IGSをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIGSをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IGSが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/AirExportCargoInquiries/SetCancel/{reportId} |
IGSの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IGSの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/AirExportCargoInquiries/Submit/{reportId} |
IGSを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIGSを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IGSが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/AirExportCargoInquiries/SubmitByPost |
IGSを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/AirExportCargoInquiries/Unlock/{reportId} |
IGSのロックを解除します。 帳票ID(***reportId***)を指定して、IGSのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/AirExportCargoInquiries/Update/{reportId} |
IGSを更新します。 帳票ID(***reportId***)を指定して、IGSを更新します。 このメソッドでは、IGSの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/AirExportCargoInquiries/UpdateByPost |
IGSを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/AirExportCargoInquiries/UploadFile |
IGSにファイルを添付します。 指定されたIGSに、ファイルを添付します。 |
|
AirImportAwbRegistrations
ACH_AWB情報登録(輸入)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/AirImportAwbRegistrations/Create |
ACHを作成します。 ACHを作成するには、利用者がACHを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/AirImportAwbRegistrations/Delete/{reportId} |
ACHを削除します。 帳票ID(***reportId***)を指定して、、ACHを削除します。 ACHを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/AirImportAwbRegistrations/DeleteFile/{fileId} |
ACHの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、ACHの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/AirImportAwbRegistrations/Get/{reportId} |
ACHを取得します。 帳票ID(***reportId***)を指定して、ACH取得します。 編集が行われていない場合は、ルートドキュメントから最新のACHを取得します。 編集中の場合は、先に保存した、ACHを取得します。 |
|
| GET | /API/v2/NaccsReports/AirImportAwbRegistrations/GetFile/{fileId} |
ACHに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、ACHに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/AirImportAwbRegistrations/Lock/{reportId} |
編集するため、ACHをロックします。 帳票ID(***reportId***)を指定して、ACHをロックします。 ACHを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、ACHを編集する場合は、このメソッドを呼び出してロックします。 ロックされたACHは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、ACHをルートドキュメントから参照できますが、編集中(ロック中)のACHは参照できません。 |
|
| POST | /API/v2/NaccsReports/AirImportAwbRegistrations/SendToNaccs |
ACHをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したACHをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ACHが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/AirImportAwbRegistrations/SetCancel/{reportId} |
ACHの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、ACHの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/AirImportAwbRegistrations/Submit/{reportId} |
ACHを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したACHを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ACHが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/AirImportAwbRegistrations/SubmitByPost |
ACHを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/AirImportAwbRegistrations/Unlock/{reportId} |
ACHのロックを解除します。 帳票ID(***reportId***)を指定して、ACHのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/AirImportAwbRegistrations/Update/{reportId} |
ACHを更新します。 帳票ID(***reportId***)を指定して、ACHを更新します。 このメソッドでは、ACHの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/AirImportAwbRegistrations/UpdateByPost |
ACHを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/AirImportAwbRegistrations/UploadFile |
ACHにファイルを添付します。 指定されたACHに、ファイルを添付します。 |
|
AirImportCargoInquiries
IAW_輸入貨物情報照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/AirImportCargoInquiries/Create |
IAWを作成します。 IAWを作成するには、利用者がIAWを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/AirImportCargoInquiries/Delete/{reportId} |
IAWを削除します。 帳票ID(***reportId***)を指定して、、IAWを削除します。 IAWを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/AirImportCargoInquiries/DeleteFile/{fileId} |
IAWの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IAWの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/AirImportCargoInquiries/Get/{reportId} |
IAWを取得します。 帳票ID(***reportId***)を指定して、IAW取得します。 編集が行われていない場合は、ルートドキュメントから最新のIAWを取得します。 編集中の場合は、先に保存した、IAWを取得します。 |
|
| GET | /API/v2/NaccsReports/AirImportCargoInquiries/GetFile/{fileId} |
IAWに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IAWに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/AirImportCargoInquiries/Lock/{reportId} |
編集するため、IAWをロックします。 帳票ID(***reportId***)を指定して、IAWをロックします。 IAWを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IAWを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIAWは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IAWをルートドキュメントから参照できますが、編集中(ロック中)のIAWは参照できません。 |
|
| POST | /API/v2/NaccsReports/AirImportCargoInquiries/SendToNaccs |
IAWをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIAWをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IAWが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/AirImportCargoInquiries/SetCancel/{reportId} |
IAWの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IAWの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/AirImportCargoInquiries/Submit/{reportId} |
IAWを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIAWを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IAWが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/AirImportCargoInquiries/SubmitByPost |
IAWを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/AirImportCargoInquiries/Unlock/{reportId} |
IAWのロックを解除します。 帳票ID(***reportId***)を指定して、IAWのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/AirImportCargoInquiries/Update/{reportId} |
IAWを更新します。 帳票ID(***reportId***)を指定して、IAWを更新します。 このメソッドでは、IAWの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/AirImportCargoInquiries/UpdateByPost |
IAWを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/AirImportCargoInquiries/UploadFile |
IAWにファイルを添付します。 指定されたIAWに、ファイルを添付します。 |
|
AirImportHawbRegistrations
HCH01_HAWB情報登録(輸入)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/AirImportHawbRegistrations/Create |
HCH01を作成します。 HCH01を作成するには、利用者がHCH01を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/AirImportHawbRegistrations/Delete/{reportId} |
HCH01を削除します。 帳票ID(***reportId***)を指定して、、HCH01を削除します。 HCH01を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/AirImportHawbRegistrations/DeleteFile/{fileId} |
HCH01の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、HCH01の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/AirImportHawbRegistrations/Get/{reportId} |
HCH01を取得します。 帳票ID(***reportId***)を指定して、HCH01取得します。 編集が行われていない場合は、ルートドキュメントから最新のHCH01を取得します。 編集中の場合は、先に保存した、HCH01を取得します。 |
|
| GET | /API/v2/NaccsReports/AirImportHawbRegistrations/GetFile/{fileId} |
HCH01に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、HCH01に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/AirImportHawbRegistrations/Lock/{reportId} |
編集するため、HCH01をロックします。 帳票ID(***reportId***)を指定して、HCH01をロックします。 HCH01を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、HCH01を編集する場合は、このメソッドを呼び出してロックします。 ロックされたHCH01は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、HCH01をルートドキュメントから参照できますが、編集中(ロック中)のHCH01は参照できません。 |
|
| POST | /API/v2/NaccsReports/AirImportHawbRegistrations/SendToNaccs |
HCH01をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したHCH01をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、HCH01が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/AirImportHawbRegistrations/SetCancel/{reportId} |
HCH01の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、HCH01の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/AirImportHawbRegistrations/Submit/{reportId} |
HCH01を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したHCH01を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、HCH01が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/AirImportHawbRegistrations/SubmitByPost |
HCH01を提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/AirImportHawbRegistrations/Unlock/{reportId} |
HCH01のロックを解除します。 帳票ID(***reportId***)を指定して、HCH01のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/AirImportHawbRegistrations/Update/{reportId} |
HCH01を更新します。 帳票ID(***reportId***)を指定して、HCH01を更新します。 このメソッドでは、HCH01の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/AirImportHawbRegistrations/UpdateByPost |
HCH01を更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/AirImportHawbRegistrations/UploadFile |
HCH01にファイルを添付します。 指定されたHCH01に、ファイルを添付します。 |
|
Announcements
お知らせ
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/Announcements/GetList |
ポータルサイトのお知らせを取得します。 [ポータルサイト](https://www.cyber-port.net/)のお知らせを取得します。 このAPIではお知らせから、直近の5件を取得します。 全てのお知らせを確認する場合は、ポータルサイトの[お知らせ](https://www.cyber-port.net/ja/information/) を参照ください。 |
|
ArrivalAndDepartureInquiries
IVS_入出港届等照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ArrivalAndDepartureInquiries/Create |
IVSを作成します。 IVSを作成するには、利用者がIVSを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ArrivalAndDepartureInquiries/Delete/{reportId} |
IVSを削除します。 帳票ID(***reportId***)を指定して、、IVSを削除します。 IVSを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ArrivalAndDepartureInquiries/DeleteFile/{fileId} |
IVSの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IVSの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ArrivalAndDepartureInquiries/Get/{reportId} |
IVSを取得します。 帳票ID(***reportId***)を指定して、IVS取得します。 編集が行われていない場合は、ルートドキュメントから最新のIVSを取得します。 編集中の場合は、先に保存した、IVSを取得します。 |
|
| GET | /API/v2/NaccsReports/ArrivalAndDepartureInquiries/GetFile/{fileId} |
IVSに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IVSに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ArrivalAndDepartureInquiries/Lock/{reportId} |
編集するため、IVSをロックします。 帳票ID(***reportId***)を指定して、IVSをロックします。 IVSを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IVSを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIVSは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IVSをルートドキュメントから参照できますが、編集中(ロック中)のIVSは参照できません。 |
|
| POST | /API/v2/NaccsReports/ArrivalAndDepartureInquiries/SendToNaccs |
IVSをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIVSをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IVSが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ArrivalAndDepartureInquiries/SetCancel/{reportId} |
IVSの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IVSの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ArrivalAndDepartureInquiries/Submit/{reportId} |
IVSを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIVSを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IVSが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ArrivalAndDepartureInquiries/Unlock/{reportId} |
IVSのロックを解除します。 帳票ID(***reportId***)を指定して、IVSのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ArrivalAndDepartureInquiries/Update/{reportId} |
IVSを更新します。 帳票ID(***reportId***)を指定して、IVSを更新します。 このメソッドでは、IVSの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ArrivalAndDepartureInquiries/UploadFile |
IVSにファイルを添付します。 指定されたIVSに、ファイルを添付します。 |
|
ArrivalNotices
到着通知(A/N)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/ArrivalNotices/Create |
到着通知(A/N)を作成します。 到着通知(A/N)を作成するには、利用者が到着通知(A/N)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 到着通知(A/N)に関する詳細については、[到着通知(A/N)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/ArrivalNotices/Delete/{reportId} |
到着通知(A/N)を削除します。 帳票ID(***reportId***)を指定して、到着通知(A/N)を削除します。 到着通知(A/N)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した到着通知(A/N)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 到着通知(A/N)に関する詳細については、[到着通知(A/N)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/ArrivalNotices/DeleteFile/{fileId} |
到着通知(A/N)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、到着通知(A/N)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/ArrivalNotices/Get/{reportId}?historyId=!{historyId} |
到着通知(A/N)を取得します。 帳票ID(***reportId***)を指定して、到着通知(A/N)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の到着通知(A/N)を取得します。 編集中の場合は、先に保存した、到着通知(A/N)を取得します。 到着通知(A/N)に関する詳細については、[到着通知(A/N)について]()を参照ください。 |
|
| GET | /API/v2/Reports/ArrivalNotices/GetDiff/{reportId}?historyId=!{historyId} |
保存されている到着通知(A/N)とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する到着通知(A/N)と、ルートドキュメントの差分を取得します。 比較元を保存されている到着通知(A/N)、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/ArrivalNotices/GetFile/{fileId} |
到着通知(A/N)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、到着通知(A/N)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/ArrivalNotices/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
到着通知(A/N)を全て取得します。 検索条件に該当する到着通知(A/N)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の到着通知(A/N)を取得します。 編集中の場合は、先に保存した、到着通知(A/N)を取得します。 到着通知(A/N)に関する詳細については、[到着通知(A/N)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ArrivalNotices/Lock/{reportId} |
編集するため、到着通知(A/N)をロックします 帳票ID(***reportId***)を指定して、到着通知(A/N)をロックします。 到着通知(A/N)を作成(***Create***)した時点では、到着通知(A/N)をロックが掛かりますが、取得(***Get***)したあとで、到着通知(A/N)を編集する場合は、このメソッドを呼び出して、到着通知(A/N)をロックします。 ロックされた到着通知(A/N)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、到着通知(A/N)をルートドキュメントから参照できますが、編集中(ロック中)の到着通知(A/N)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 到着通知(A/N)に関する詳細については、[到着通知(A/N)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ArrivalNotices/SetCancel/{reportId} |
到着通知(A/N)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、到着通知(A/N)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 到着通知(A/N)に関する詳細については、[到着通知(A/N)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ArrivalNotices/Submit/{reportId} |
到着通知(A/N)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した到着通知(A/N)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、到着通知(A/N)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、到着通知(A/N)もロックされた状態のままなので、ご注意ください。 到着通知(A/N)に関する詳細については、[到着通知(A/N)について]()を参照ください。 |
|
| POST | /API/v2/Reports/ArrivalNotices/SubmitByPost |
到着通知(A/N)を提出します。 動作は、到着通知(A/N)(***/API/v2/Reports/ArrivalNotices/Submit***)と同様です。 到着通知(A/N)に関する詳細については、[到着通知(A/N)]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ArrivalNotices/Unlock/{reportId} |
到着通知(A/N)のロックを解除します 帳票ID(***reportId***)を指定して、到着通知(A/N)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 到着通知(A/N)に関する詳細については、[到着通知(A/N)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ArrivalNotices/Update/{reportId} |
到着通知(A/N)を更新します。 帳票ID(***reportId***)を指定して、到着通知(A/N)を更新します。 このメソッドでは、到着通知(A/N)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 到着通知(A/N)に関する詳細については、[到着通知(A/N)について]()を参照ください。 |
|
| POST | /API/v2/Reports/ArrivalNotices/UpdateByPost |
到着通知(A/N)を更新します。 動作は、到着通知(A/N)(***/API/v2/Reports/ArrivalNotices/Update***)と同様です。 到着通知(A/N)に関する詳細については、[到着通知(A/N)]()を参照ください。 |
|
| POST | /API/v2/Reports/ArrivalNotices/UploadFile |
到着通知(A/N)にファイルを添付します。 指定された到着通知(A/N)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
AssignedBusinessTypes
組織の事業種別
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/Organizations/AssignedBusinessTypes/GetAssignedBusinessTypeId/{organizationId}/{businessTypeCode} |
組織に割り当てられた事業種別IDを取得します。 組織ID(***organizationId***)と事業種別コード(***businessTypeCode***)を指定して、組織に割り当てられた事業種別ID(***assignedBusinessTypeId***)を取得します。 組織に割り当てられた事業種別に関する詳細については、[組織の事業種別について]()を参照ください。 |
|
| GET | /API/v2/Organizations/AssignedBusinessTypes/GetList/{organizationId} |
組織に割り当てられた事業種別を全て取得します。 組織ID(***organizationId***)を指定して、組織に割り当てられた事業種別を全て取得します。 組織に割り当てられた事業種別に関する詳細については、[組織の事業種別について]()を参照ください。 |
|
| POST | /API/v2/Organizations/AssignedBusinessTypes/Register |
会社内の組織に割り当てる事業種別を登録します。 会社に割り当てられた事業種別の中から、組織に割り当てる事業種別を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 組織に割り当てられた事業種別に関する詳細については、[組織の事業種別について]()を参照ください。 |
|
| POST | /API/v2/Organizations/AssignedBusinessTypes/RegisterList |
会社内の組織に割り当てる事業種別を一括で登録します。 会社に割り当てられた事業種別の中から、組織に割り当てる事業種別を一括で登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 組織に割り当てられた事業種別に関する詳細については、[組織の事業種別について]()を参照ください。 |
|
AssignedVgmCertifications
組織のVGM確定認証
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Organizations/AssignedVgmCertifications/Delete/{assignedVgmCertificationId} |
組織に割り当てられたVGM確定認証を削除します。 組織のVGM確定認証ID(***assignedVgmCertificationId***)を指定して、組織に割り当てられたVGM確定事業者を削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 組織に割り当てられたVGM確定認証に関する詳細については、[組織のVGM確定認証について]()を参照ください。 |
|
| GET | /API/v2/Organizations/AssignedVgmCertifications/GetList/{organizationId}?notificationNo=!{notificationNo}®istrationNo=!{registrationNo}&isValid=!{isValid} |
組織に割り当てられたVGM確定認証を全て取得します。 組織ID(***organizationId***)を指定して、組織に割り当てられたVGM確定認証を全て取得します。 組織に割り当てられたVGM確定認証に関する詳細については、[組織のVGM確定認証について]()を参照ください。 |
|
| GET | /API/v2/Organizations/AssignedVgmCertifications/GetSettableVgmCertifications/{organizationId} |
組織に割り当て可能なVGM確定情報を取得します。 組織に割り当て可能なVGM確定情報を取得します。 組織に割り当てられたVGM確定認証に関する詳細については、[組織のVGM確定認証について]()を参照ください。 |
|
| POST | /API/v2/Organizations/AssignedVgmCertifications/Register |
会社内の組織に割り当てるVGM確定認証を登録します。 会社に割り当てられたVGM確定認証の中から、組織に割り当てるVGM確定認証を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 組織に割り当てられたVGM確定認証に関する詳細については、[組織のVGM確定認証について]()を参照ください。 |
|
AssociatedEmployees
組織に所属する利用者
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/Organizations/AssociatedEmployees/Get/{associatedEmployeeId} |
組織に所属する利用者を取得します。 組織に所属する利用者ID(***associatedEmployeeId***)を指定して、組織に所属する利用者を取得します。 組織と利用者に関する詳細については、[組織と利用者について]()を参照ください。 |
|
| GET | /API/v2/Organizations/AssociatedEmployees/GetCoworkers/{organizationId} |
組織に所属する利用者を全て取得します。 組織ID(***organizationId***)を指定して、組織に所属する利用者を全て取得します。 組織と利用者に関する詳細については、[組織と利用者について]()を参照ください。 |
|
| POST | /API/v2/Organizations/AssociatedEmployees/Register |
組織に所属する利用者を登録します。 管理者が所属する会社の組織に、利用者を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 組織と利用者に関する詳細については、[組織と利用者について]()を参照ください。 |
|
AttachmentFileRegistrations
MSB_添付ファイル登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/AttachmentFileRegistrations/Create |
MSBを作成します。 MSBを作成するには、利用者がMSBを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/AttachmentFileRegistrations/Delete/{reportId} |
MSBを削除します。 帳票ID(***reportId***)を指定して、、MSBを削除します。 MSBを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/AttachmentFileRegistrations/DeleteFile/{fileId} |
MSBの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、MSBの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/AttachmentFileRegistrations/Get/{reportId} |
MSBを取得します。 帳票ID(***reportId***)を指定して、MSB取得します。 編集が行われていない場合は、ルートドキュメントから最新のMSBを取得します。 編集中の場合は、先に保存した、MSBを取得します。 |
|
| GET | /API/v2/NaccsReports/AttachmentFileRegistrations/GetFile/{fileId} |
MSBに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、MSBに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/AttachmentFileRegistrations/Lock/{reportId} |
編集するため、MSBをロックします。 帳票ID(***reportId***)を指定して、MSBをロックします。 MSBを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、MSBを編集する場合は、このメソッドを呼び出してロックします。 ロックされたMSBは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、MSBをルートドキュメントから参照できますが、編集中(ロック中)のMSBは参照できません。 |
|
| POST | /API/v2/NaccsReports/AttachmentFileRegistrations/SendToNaccs |
MSBをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したMSBをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、MSBが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/AttachmentFileRegistrations/SetCancel/{reportId} |
MSBの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、MSBの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/AttachmentFileRegistrations/Submit/{reportId} |
MSBを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したMSBを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、MSBが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/AttachmentFileRegistrations/SubmitByPost |
MSBを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/AttachmentFileRegistrations/Unlock/{reportId} |
MSBのロックを解除します。 帳票ID(***reportId***)を指定して、MSBのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/AttachmentFileRegistrations/Update/{reportId} |
MSBを更新します。 帳票ID(***reportId***)を指定して、MSBを更新します。 このメソッドでは、MSBの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/AttachmentFileRegistrations/UpdateByPost |
MSBを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/AttachmentFileRegistrations/UploadFile |
MSBにファイルを添付します。 指定されたMSBに、ファイルを添付します。 |
|
BerthCodes
バースコード
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/General/BerthCodes/Get/{portCode}/{berthCode} |
バースコードを取得します。 港コード(***portCode***)とバースコード(***berthCode***)を指定して、バースコードを取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
|
| GET | /API/v2/General/BerthCodes/GetList?portCode=!{portCode}&berthCode=!{berthCode}&berthNameJa=!{berthNameJa}&berthName=!{berthName} |
バースコードを取得します。 検索条件に該当するバースコードを全て取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
|
BillingExceptionRules
集計例外条件
BillingSettings
会社の請求先
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Companies/BillingSettings/DeleteAdmin/{companyId} |
会社の請求先情報を削除します。 会社ID(***companyId***)を指定して、会社の請求先情報を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/Companies/BillingSettings/Get |
会社の請求先を取得します。 ログインしている利用者が所属する会社の請求先を取得します。 会社の請求先に関する詳細については、[会社の請求先について]()を参照ください。 |
|
| POST | /API/v2/Companies/BillingSettings/Register |
会社の請求先情報を登録します。 管理者が所属する会社の請求先を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 会社の請求先に関する詳細については、[会社の請求先について]()を参照ください。 |
|
| PATCH | /API/v2/Companies/BillingSettings/Update/{companyId} |
会社の請求先を更新します。 管理者が所属する会社の請求先を更新します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 会社の請求先に関する詳細については、[会社の請求先について]()を参照ください。 |
|
| PATCH | /API/v2/Companies/BillingSettings/UpdateInternal/{companyId} |
会社の請求先情報を更新します。 会社ID(***companyId***)を指定して、請求先情報を更新します。 内部呼び出し用。 |
|
BillOfLadingNumberNotices
B/L番号通知書
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/BillOfLadingNumberNotices/Create |
B/L番号通知書を作成します。 B/L番号通知書を作成するには、利用者がB/L番号通知書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 B/L番号通知書に関する詳細については、[B/L番号通知書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/BillOfLadingNumberNotices/Delete/{reportId} |
B/L番号通知書を削除します。 帳票ID(***reportId***)を指定して、B/L番号通知書を削除します。 B/L番号通知書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したB/L番号通知書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 B/L番号通知書に関する詳細については、[B/L番号通知書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/BillOfLadingNumberNotices/DeleteFile/{fileId} |
B/L番号通知書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、B/L番号通知書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/BillOfLadingNumberNotices/Get/{reportId}?historyId=!{historyId} |
B/L番号通知書を取得します。 帳票ID(***reportId***)を指定して、B/L番号通知書を取得します。 編集が行われていない場合は、ルートドキュメントから最新のB/L番号通知書を取得します。 編集中の場合は、先に保存した、B/L番号通知書を取得します。 B/L番号通知書に関する詳細については、[B/L番号通知書について]()を参照ください。 |
|
| GET | /API/v2/Reports/BillOfLadingNumberNotices/GetDiff/{reportId}?historyId=!{historyId} |
保存されているB/L番号通知書とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当するB/L番号通知書と、ルートドキュメントの差分を取得します。 比較元を保存されているB/L番号通知書、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/BillOfLadingNumberNotices/GetFile/{fileId} |
B/L番号通知書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、B/L番号通知書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/BillOfLadingNumberNotices/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
B/L番号通知書を全て取得します。 検索条件に該当するB/L番号通知書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のB/L番号通知書を取得します。 編集中の場合は、先に保存した、B/L番号通知書を取得します。 B/L番号通知書に関する詳細については、[B/L番号通知書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BillOfLadingNumberNotices/Lock/{reportId} |
編集するため、B/L番号通知書をロックします 帳票ID(***reportId***)を指定して、B/L番号通知書をロックします。 B/L番号通知書を作成(***Create***)した時点では、B/L番号通知書をロックが掛かりますが、取得(***Get***)したあとで、B/L番号通知書を編集する場合は、このメソッドを呼び出して、B/L番号通知書をロックします。 ロックされたB/L番号通知書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、B/L番号通知書をルートドキュメントから参照できますが、編集中(ロック中)の船荷証券(B/L)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 B/L番号通知書に関する詳細については、[B/L番号通知書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BillOfLadingNumberNotices/SetCancel/{reportId} |
B/L番号通知書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、B/L番号通知書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 B/L番号通知書に関する詳細については、[B/L番号通知書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BillOfLadingNumberNotices/Submit/{reportId} |
B/L番号通知書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したB/L番号通知書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、B/L番号通知書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、B/L番号通知書もロックされた状態のままなので、ご注意ください。 B/L番号通知書に関する詳細については、[B/L番号通知書について]()を参照ください。 |
|
| POST | /API/v2/Reports/BillOfLadingNumberNotices/SubmitByPost |
B/L番号通知書を提出します。 動作は、B/L番号通知書(***/API/v2/Reports/BillOfLadingNumberNotices/Submit***)と同様です。 B/L番号通知書に関する詳細については、[B/L番号通知書]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BillOfLadingNumberNotices/Unlock/{reportId} |
B/L番号通知書のロックを解除します 帳票ID(***reportId***)を指定して、B/L番号通知書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 B/L番号通知書に関する詳細については、[B/L番号通知書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BillOfLadingNumberNotices/Update/{reportId} |
B/L番号通知書を更新します。 帳票ID(***reportId***)を指定して、B/L番号通知書を更新します。 このメソッドでは、B/L番号通知書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 B/L番号通知書に関する詳細については、[B/L番号通知書について]()を参照ください。 |
|
| POST | /API/v2/Reports/BillOfLadingNumberNotices/UpdateByPost |
B/L番号通知書を更新します。 動作は、B/L番号通知書(***/API/v2/Reports/BillOfLadingNumberNotices/Update***)と同様です。 B/L番号通知書に関する詳細については、[B/L番号通知書]()を参照ください。 |
|
| POST | /API/v2/Reports/BillOfLadingNumberNotices/UploadFile |
B/L番号通知書にファイルを添付します。 指定されたB/L番号通知書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
BillOfLadings
船荷証券(B/L)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/BillOfLadings/Create |
船荷証券(B/L)を作成します。 船荷証券(B/L)を作成するには、利用者が船荷証券(B/L)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/BillOfLadings/Delete/{reportId} |
船荷証券(B/L) を削除します。 帳票ID(***reportId***)を指定して、船荷証券(B/L)を削除します。 船荷証券(B/L)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した船荷証券(B/L)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/BillOfLadings/DeleteFile/{fileId} |
船荷証券(B/L) の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、船荷証券(B/L) の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/BillOfLadings/Get/{reportId}?historyId=!{historyId} |
船荷証券(B/L)を取得します。 帳票ID(***reportId***)を指定して、船荷証券(B/L)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の船荷証券(B/L)を取得します。 編集中の場合は、先に保存した、船荷証券(B/L)を取得します。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。 |
|
| GET | /API/v2/Reports/BillOfLadings/GetDiff/{reportId}?historyId=!{historyId} |
保存されている船荷証券(B/L)とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する船荷証券(B/L)と、ルートドキュメントの差分を取得します。 比較元を保存されている船荷証券(B/L)、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/BillOfLadings/GetFile/{fileId} |
船荷証券(B/L)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、船荷証券(B/L)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/BillOfLadings/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
船荷証券(B/L)を全て取得します。 検索条件に該当する船荷証券(B/L)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の船荷証券(B/L)を取得します。 編集中の場合は、先に保存した、船荷証券(B/L)を取得します。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BillOfLadings/Lock/{reportId} |
編集するため、船荷証券(B/L)をロックします 帳票ID(***reportId***)を指定して、船荷証券(B/L)をロックします。 船荷証券(B/L)を作成(***Create***)した時点では、船荷証券(B/L)をロックが掛かりますが、取得(***Get***)したあとで、船荷証券(B/L)を編集する場合は、このメソッドを呼び出して、船荷証券(B/L)をロックします。 ロックされた船荷証券(B/L)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、船荷証券(B/L)をルートドキュメントから参照できますが、編集中(ロック中)の船荷証券(B/L)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BillOfLadings/SetCancel/{reportId} |
船荷証券(B/L)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、船荷証券(B/L)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BillOfLadings/Submit/{reportId} |
船荷証券(B/L)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した船荷証券(B/L)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、船荷証券(B/L)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、船荷証券(B/L)もロックされた状態のままなので、ご注意ください。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。 |
|
| POST | /API/v2/Reports/BillOfLadings/SubmitByPost |
船荷証券(B/L)を提出します。 動作は、船荷証券(B/L)(***/API/v2/Reports/BillOfLadings/Submit***)と同様です。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BillOfLadings/Unlock/{reportId} |
船荷証券(B/L)のロックを解除します 帳票ID(***reportId***)を指定して、船荷証券(B/L)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BillOfLadings/Update/{reportId} |
船荷証券(B/L)を更新します。 帳票ID(***reportId***)を指定して、船荷証券(B/L)を更新します。 このメソッドでは、船荷証券(B/L)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)について]()を参照ください。 |
|
| POST | /API/v2/Reports/BillOfLadings/UpdateByPost |
船荷証券(B/L)を更新します。 動作は、船荷証券(B/L)(***/API/v2/Reports/BillOfLadings/Update***)と同様です。 船荷証券(B/L)に関する詳細については、[船荷証券(B/L)]()を参照ください。 |
|
| POST | /API/v2/Reports/BillOfLadings/UploadFile |
船荷証券(B/L)にファイルを添付します。 指定された船荷証券(B/L)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
BondedAreaCodes
保税地域コード
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/General/BondedAreaCodes/GetList?bondedAreaCode=!{bondedAreaCode}&bondedAreaAbbr=!{bondedAreaAbbr}&userCode=!{userCode}&joinAsSea=!{joinAsSea}&joinAsAir=!{joinAsAir}&postIsCargoManage=!{postIsCargoManage}&isCompanyFacilities=!{isCompanyFacilities} |
コンテナターミナルコードを取得します。 検索条件に該当するコンテナターミナルコード(保税地域コード)を全て取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
|
BookingChangeCalls
BKC11_ブッキング情報変更呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/BookingChangeCalls/Create |
BKC11を作成します。 BKC11を作成するには、利用者がBKC11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/BookingChangeCalls/Delete/{reportId} |
BKC11を削除します。 帳票ID(***reportId***)を指定して、、BKC11を削除します。 BKC11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/BookingChangeCalls/DeleteFile/{fileId} |
BKC11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、BKC11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/BookingChangeCalls/Get/{reportId} |
BKC11を取得します。 帳票ID(***reportId***)を指定して、BKC11取得します。 編集が行われていない場合は、ルートドキュメントから最新のBKC11を取得します。 編集中の場合は、先に保存した、BKC11を取得します。 |
|
| GET | /API/v2/NaccsReports/BookingChangeCalls/GetFile/{fileId} |
BKC11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、BKC11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/BookingChangeCalls/Lock/{reportId} |
編集するため、BKC11をロックします。 帳票ID(***reportId***)を指定して、BKC11をロックします。 BKC11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、BKC11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたBKC11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、BKC11をルートドキュメントから参照できますが、編集中(ロック中)のBKC11は参照できません。 |
|
| POST | /API/v2/NaccsReports/BookingChangeCalls/SendToNaccs |
BKC11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したBKC11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BKC11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/BookingChangeCalls/SetCancel/{reportId} |
BKC11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、BKC11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/BookingChangeCalls/Submit/{reportId} |
BKC11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したBKC11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BKC11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/BookingChangeCalls/Unlock/{reportId} |
BKC11のロックを解除します。 帳票ID(***reportId***)を指定して、BKC11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/BookingChangeCalls/Update/{reportId} |
BKC11を更新します。 帳票ID(***reportId***)を指定して、BKC11を更新します。 このメソッドでは、BKC11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/BookingChangeCalls/UploadFile |
BKC11にファイルを添付します。 指定されたBKC11に、ファイルを添付します。 |
|
BookingChanges
BKC_ブッキング情報変更
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/BookingChanges/Create |
BKCを作成します。 BKCを作成するには、利用者がBKCを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/BookingChanges/Delete/{reportId} |
BKCを削除します。 帳票ID(***reportId***)を指定して、、BKCを削除します。 BKCを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/BookingChanges/DeleteFile/{fileId} |
BKCの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、BKCの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/BookingChanges/Get/{reportId} |
BKCを取得します。 帳票ID(***reportId***)を指定して、BKC取得します。 編集が行われていない場合は、ルートドキュメントから最新のBKCを取得します。 編集中の場合は、先に保存した、BKCを取得します。 |
|
| GET | /API/v2/NaccsReports/BookingChanges/GetFile/{fileId} |
BKCに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、BKCに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/BookingChanges/Lock/{reportId} |
編集するため、BKCをロックします。 帳票ID(***reportId***)を指定して、BKCをロックします。 BKCを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、BKCを編集する場合は、このメソッドを呼び出してロックします。 ロックされたBKCは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、BKCをルートドキュメントから参照できますが、編集中(ロック中)のBKCは参照できません。 |
|
| POST | /API/v2/NaccsReports/BookingChanges/SendToNaccs |
BKCをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したBKCをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BKCが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/BookingChanges/SetCancel/{reportId} |
BKCの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、BKCの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/BookingChanges/Submit/{reportId} |
BKCを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したBKCを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BKCが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/BookingChanges/SubmitByPost |
BKCを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/BookingChanges/Unlock/{reportId} |
BKCのロックを解除します。 帳票ID(***reportId***)を指定して、BKCのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/BookingChanges/Update/{reportId} |
BKCを更新します。 帳票ID(***reportId***)を指定して、BKCを更新します。 このメソッドでは、BKCの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/BookingChanges/UpdateByPost |
BKCを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/BookingChanges/UploadFile |
BKCにファイルを添付します。 指定されたBKCに、ファイルを添付します。 |
|
BookingConfirmations
船腹予約確認書
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/BookingConfirmations/Create |
船腹予約確認書を作成します。 船腹予約確認書を作成するには、利用者が船腹予約確認書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/BookingConfirmations/Delete/{reportId} |
船腹予約確認書を削除します。 帳票ID(***reportId***)を指定して、船腹予約確認書を削除します。 船腹予約確認書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した船腹予約確認書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/BookingConfirmations/DeleteFile/{fileId} |
船腹予約確認書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、船腹予約確認書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/BookingConfirmations/Get/{reportId}?historyId=!{historyId} |
船腹予約確認書を取得します。 帳票ID(***reportId***)を指定して、船腹予約確認書を取得します。 編集が行われていない場合は、ルートドキュメントから最新の船腹予約確認書を取得します。 編集中の場合は、先に保存した、船腹予約確認書を取得します。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
| GET | /API/v2/Reports/BookingConfirmations/GetDiff/{reportId}?historyId=!{historyId} |
保存されている船腹予約確認書とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する船腹予約確認書と、ルートドキュメントの差分を取得します。 比較元を保存されている船腹予約確認書、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/BookingConfirmations/GetFile/{fileId} |
船腹予約確認書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、船腹予約確認書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/BookingConfirmations/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
船腹予約確認書を全て取得します。 検索条件に該当する船腹予約確認書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の船腹予約確認書を取得します。 編集中の場合は、先に保存した、船腹予約確認書を取得します。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BookingConfirmations/Lock/{reportId} |
編集するため、船腹予約確認書をロックします 帳票ID(***reportId***)を指定して、船腹予約確認書をロックします。 船腹予約確認書を作成(***Create***)した時点では、船腹予約確認書をロックが掛かりますが、取得(***Get***)したあとで、船腹予約確認書を編集する場合は、このメソッドを呼び出して、船腹予約確認書をロックします。 ロックされた船腹予約確認書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、船腹予約確認書をルートドキュメントから参照できますが、編集中(ロック中)の船腹予約確認書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BookingConfirmations/SetCancel/{reportId} |
船腹予約確認書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、船腹予約確認書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BookingConfirmations/Submit/{reportId} |
船腹予約確認書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した船腹予約確認書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、船腹予約確認書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、船腹予約確認書もロックされた状態のままなので、ご注意ください。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
| POST | /API/v2/Reports/BookingConfirmations/SubmitByPost |
船腹予約確認書を提出します 動作は、船腹予約確認書の提出(***/API/v2/Reports/BookingConfirmations/Submit***)と同様です。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BookingConfirmations/Unlock/{reportId} |
船腹予約確認書のロックを解除します 帳票ID(***reportId***)を指定して、船腹予約確認書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BookingConfirmations/Update/{reportId} |
船腹予約確認書を更新します。 帳票ID(***reportId***)を指定して、船腹予約確認書を更新します。 このメソッドでは、船腹予約確認書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
| POST | /API/v2/Reports/BookingConfirmations/UpdateByPost |
船腹予約確認書を更新します。 動作は、船腹予約確認書の更新(***/API/v2/Reports/BookingConfirmations/Update***)と同様です。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。 |
|
| POST | /API/v2/Reports/BookingConfirmations/UploadFile |
船腹予約確認書にファイルを添付します。 指定された船腹予約確認書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
BookingContainerNoChangeCalls
BCC11_ブッキング・コンテナ番号変更呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/BookingContainerNoChangeCalls/Create |
BCC11を作成します。 BCC11を作成するには、利用者がBCC11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/BookingContainerNoChangeCalls/Delete/{reportId} |
BCC11を削除します。 帳票ID(***reportId***)を指定して、、BCC11を削除します。 BCC11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/BookingContainerNoChangeCalls/DeleteFile/{fileId} |
BCC11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、BCC11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/BookingContainerNoChangeCalls/Get/{reportId} |
BCC11を取得します。 帳票ID(***reportId***)を指定して、BCC11取得します。 編集が行われていない場合は、ルートドキュメントから最新のBCC11を取得します。 編集中の場合は、先に保存した、BCC11を取得します。 |
|
| GET | /API/v2/NaccsReports/BookingContainerNoChangeCalls/GetFile/{fileId} |
BCC11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、BCC11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/BookingContainerNoChangeCalls/Lock/{reportId} |
編集するため、BCC11をロックします。 帳票ID(***reportId***)を指定して、BCC11をロックします。 BCC11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、BCC11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたBCC11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、BCC11をルートドキュメントから参照できますが、編集中(ロック中)のBCC11は参照できません。 |
|
| POST | /API/v2/NaccsReports/BookingContainerNoChangeCalls/SendToNaccs |
BCC11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したBCC11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BCC11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/BookingContainerNoChangeCalls/SetCancel/{reportId} |
BCC11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、BCC11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/BookingContainerNoChangeCalls/Submit/{reportId} |
BCC11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したBCC11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BCC11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/BookingContainerNoChangeCalls/Unlock/{reportId} |
BCC11のロックを解除します。 帳票ID(***reportId***)を指定して、BCC11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/BookingContainerNoChangeCalls/Update/{reportId} |
BCC11を更新します。 帳票ID(***reportId***)を指定して、BCC11を更新します。 このメソッドでは、BCC11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/BookingContainerNoChangeCalls/UploadFile |
BCC11にファイルを添付します。 指定されたBCC11に、ファイルを添付します。 |
|
BookingContainerNoChanges
BCC_ブッキング・コンテナ番号変更
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/BookingContainerNoChanges/Create |
BCCを作成します。 BCCを作成するには、利用者がBCCを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/BookingContainerNoChanges/Delete/{reportId} |
BCCを削除します。 帳票ID(***reportId***)を指定して、、BCCを削除します。 BCCを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/BookingContainerNoChanges/DeleteFile/{fileId} |
BCCの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、BCCの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/BookingContainerNoChanges/Get/{reportId} |
BCCを取得します。 帳票ID(***reportId***)を指定して、BCC取得します。 編集が行われていない場合は、ルートドキュメントから最新のBCCを取得します。 編集中の場合は、先に保存した、BCCを取得します。 |
|
| GET | /API/v2/NaccsReports/BookingContainerNoChanges/GetFile/{fileId} |
BCCに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、BCCに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/BookingContainerNoChanges/Lock/{reportId} |
編集するため、BCCをロックします。 帳票ID(***reportId***)を指定して、BCCをロックします。 BCCを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、BCCを編集する場合は、このメソッドを呼び出してロックします。 ロックされたBCCは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、BCCをルートドキュメントから参照できますが、編集中(ロック中)のBCCは参照できません。 |
|
| POST | /API/v2/NaccsReports/BookingContainerNoChanges/SendToNaccs |
BCCをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したBCCをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BCCが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/BookingContainerNoChanges/SetCancel/{reportId} |
BCCの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、BCCの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/BookingContainerNoChanges/Submit/{reportId} |
BCCを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したBCCを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BCCが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/BookingContainerNoChanges/SubmitByPost |
BCCを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/BookingContainerNoChanges/Unlock/{reportId} |
BCCのロックを解除します。 帳票ID(***reportId***)を指定して、BCCのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/BookingContainerNoChanges/Update/{reportId} |
BCCを更新します。 帳票ID(***reportId***)を指定して、BCCを更新します。 このメソッドでは、BCCの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/BookingContainerNoChanges/UpdateByPost |
BCCを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/BookingContainerNoChanges/UploadFile |
BCCにファイルを添付します。 指定されたBCCに、ファイルを添付します。 |
|
BookingRegistrations
BKR_ブッキング情報登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/BookingRegistrations/Create |
BKRを作成します。 BKRを作成するには、利用者がBKRを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/BookingRegistrations/Delete/{reportId} |
BKRを削除します。 帳票ID(***reportId***)を指定して、、BKRを削除します。 BKRを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/BookingRegistrations/DeleteFile/{fileId} |
BKRの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、BKRの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/BookingRegistrations/Get/{reportId} |
BKRを取得します。 帳票ID(***reportId***)を指定して、BKR取得します。 編集が行われていない場合は、ルートドキュメントから最新のBKRを取得します。 編集中の場合は、先に保存した、BKRを取得します。 |
|
| GET | /API/v2/NaccsReports/BookingRegistrations/GetFile/{fileId} |
BKRに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、BKRに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/BookingRegistrations/Lock/{reportId} |
編集するため、BKRをロックします。 帳票ID(***reportId***)を指定して、BKRをロックします。 BKRを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、BKRを編集する場合は、このメソッドを呼び出してロックします。 ロックされたBKRは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、BKRをルートドキュメントから参照できますが、編集中(ロック中)のBKRは参照できません。 |
|
| POST | /API/v2/NaccsReports/BookingRegistrations/SendToNaccs |
BKRをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したBKRをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BKRが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/BookingRegistrations/SetCancel/{reportId} |
BKRの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、BKRの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/BookingRegistrations/Submit/{reportId} |
BKRを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したBKRを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BKRが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/BookingRegistrations/SubmitByPost |
BKRを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/BookingRegistrations/Unlock/{reportId} |
BKRのロックを解除します。 帳票ID(***reportId***)を指定して、BKRのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/BookingRegistrations/Update/{reportId} |
BKRを更新します。 帳票ID(***reportId***)を指定して、BKRを更新します。 このメソッドでは、BKRの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/BookingRegistrations/UpdateByPost |
BKRを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/BookingRegistrations/UploadFile |
BKRにファイルを添付します。 指定されたBKRに、ファイルを添付します。 |
|
BookingRequests
ブッキング依頼書
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/BookingRequests/Create |
ブッキング依頼書を作成します。 ブッキング依頼書を作成するには、利用者がブッキング依頼書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/BookingRequests/Delete/{reportId} |
ブッキング依頼書を削除します。 帳票ID(***reportId***)を指定して、ブッキング依頼書を削除します。 ブッキング依頼書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したブッキング依頼書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/BookingRequests/DeleteFile/{fileId} |
ブッキング依頼書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、ブッキング依頼書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/BookingRequests/Get/{reportId}?historyId=!{historyId} |
ブッキング依頼書を取得します。 帳票ID(***reportId***)を指定して、ブッキング依頼書を取得します。 編集が行われていない場合は、ルートドキュメントから最新のブッキング依頼書を取得します。 編集中の場合は、先に保存した、ブッキング依頼書を取得します。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
| GET | /API/v2/Reports/BookingRequests/GetDiff/{reportId}?historyId=!{historyId} |
保存されているブッキング依頼書とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当するブッキング依頼書と、ルートドキュメントの差分を取得します。 比較元を保存されているブッキング依頼書、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/BookingRequests/GetFile/{fileId} |
ブッキング依頼書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、ブッキング依頼書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/BookingRequests/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
ブッキング依頼書を全て取得します。 検索条件に該当するブッキング依頼書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のブッキング依頼書を取得します。 編集中の場合は、先に保存した、ブッキング依頼書を取得します。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BookingRequests/Lock/{reportId} |
編集するため、ブッキング依頼書をロックします 帳票ID(***reportId***)を指定して、ブッキング依頼書をロックします。 ブッキング依頼書を作成(***Create***)した時点では、ブッキング依頼書をロックが掛かりますが、取得(***Get***)したあとで、ブッキング依頼書を編集する場合は、このメソッドを呼び出して、ブッキング依頼書をロックします。 ロックされたブッキング依頼書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、ブッキング依頼書をルートドキュメントから参照できますが、編集中(ロック中)のブッキング依頼書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BookingRequests/SetCancel/{reportId} |
ブッキング依頼書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、ブッキング依頼書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BookingRequests/Submit/{reportId} |
ブッキング依頼書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したブッキング依頼書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ブッキング依頼書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ブッキング依頼書もロックされた状態のままなので、ご注意ください。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
| POST | /API/v2/Reports/BookingRequests/SubmitByPost |
ブッキング依頼書を提出します 動作は、ブッキング依頼書の提出(***/API/v2/Reports/BookingRequests/Submit***)と同様です。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BookingRequests/Unlock/{reportId} |
ブッキング依頼書のロックを解除します 帳票ID(***reportId***)を指定して、ブッキング依頼書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/BookingRequests/Update/{reportId} |
ブッキング依頼書を更新します。 帳票ID(***reportId***)を指定して、ブッキング依頼書を更新します。 このメソッドでは、ブッキング依頼書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
| POST | /API/v2/Reports/BookingRequests/UpdateByPost |
ブッキング依頼書を更新します。 動作は、ブッキング依頼書の更新(***/API/v2/Reports/BookingRequests/Update***)と同様です。 ブッキング依頼書に関する詳細については、[ブッキング依頼書について]()を参照ください。 |
|
| POST | /API/v2/Reports/BookingRequests/UploadFile |
ブッキング依頼書にファイルを添付します。 指定されたブッキング依頼書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
BpApplicationReasonCodes
BP申請事由コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/BpApplicationReasonCodes/DeleteAdmin/{bpApplicationReasonCode} |
BP申請事由コードを削除します。 BP申請事由コード(***bpApplicationReasonCode***)を指定して、BP申請事由コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/BpApplicationReasonCodes/Get/{bpApplicationReasonCode} |
BP申請事由を取得します。 BP申請事由コード(***bpApplicationReasonCode***)を指定して、BP申請事由を取得します。 BP申請事由コードに関する詳細については、[BP申請事由コードについて]()を参照ください。 |
|
| GET | /API/v2/General/BpApplicationReasonCodes/GetList |
BP申請事由を全て取得します。 BP申請事由コードに関する詳細については、[BP申請事由コードについて]()を参照ください。 |
|
| POST | /API/v2/General/BpApplicationReasonCodes/RegisterAdmin |
BP申請事由を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/BpApplicationReasonCodes/RegisterInternal |
BP申請事由を登録します。 内部呼び出し用。 (*For admin) |
|
BulkDownloads
一括ダウンロード
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/Reports/BulkDownloads/Get/{bulkDownloadId} |
帳票の一括ダウンロードの要求を取得します。 一括ダウンロードID(***bulkDownloadId***)を指定して、帳票の一括ダウンロードの要求を取得します。 ステータス(***downloadStatus***)で確認可能です。 帳票の一括ダウンロードに関する詳細については、[帳票の一括ダウンロードについて]()を参照ください。 |
|
| GET | /API/v2/Reports/BulkDownloads/GetAdmin/{bulkDownloadId} |
帳票の一括ダウンロードの要求を取得します。 一括ダウンロードID(***bulkDownloadId***)を指定して、帳票の一括ダウンロードの要求を取得します。 ステータス(***downloadStatus***)で確認可能です。 帳票の一括ダウンロードに関する詳細については、[帳票の一括ダウンロードについて]()を参照ください。 このメソッドはシステム管理者しか呼び出せません。 (*For admin) |
|
| GET | /API/v2/Reports/BulkDownloads/GetFile/{bulkDownloadId} |
帳票の一括ダウンロードの結果ファイルを取得します。 一括ダウンロードID(***bulkDownloadId***)を指定して、帳票の一括ダウンロードの結果であるzipファイルを取得します。 zipファイルは、ステータス(***downloadStatus***)がdoneである場合に取得可能です。 帳票の一括ダウンロードに関する詳細については、[帳票の一括ダウンロードについて]()を参照ください。 |
|
| GET | /API/v2/Reports/BulkDownloads/GetList?organizationId=!{organizationId}&tradeType=!{tradeType}&reportCode=!{reportCode}&excelFormatCode=!{excelFormatCode}&from=!{from}&to=!{to}&downloadStatus=!{downloadStatus} |
帳票の一括ダウンロードの要求を全て取得します。 検索条件に該当する帳票の一括ダウンロード要求を全て取得します。 帳票の一括ダウンロードに関する詳細については、[帳票の一括ダウンロードについて]()を参照ください。 |
|
| POST | /API/v2/Reports/BulkDownloads/Request |
帳票の一括ダウンロードを要求(登録)します。 帳票の一括ダウンロードの要求を登録します。 帳票の一括ダウンロードは、この要求に従い、 - 指定された組織IDでアクセス可能な - 取引タイプ、帳票コードで指定された - 対象期間(from-to)内に更新された 帳票を一括でダウンロードするため、zipファイルにパッケージングします。 さらに、Excelフォーマットコード(***excelFormatCode***)を指定することで、帳票をExcelファイル化し、zipファイルにパッケージングします。 zipファイルに含まれるものは、 - 帳票JSON - 帳票の添付ファイル - 帳票のExcelファイル(※Excelフォーマットコードを指定した場合) です。 帳票の一括ダウンロードには、時間が掛かるので、処理結果については、要求の取得(***/API/v2/Reports/BulkDownload/Get/{bulkDownloadId}***)を使って、確認します。 帳票の一括ダウンロードに関する詳細については、[帳票の一括ダウンロードについて]()を参照ください。 |
|
BusinessTypes
事業種別
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Master/BusinessTypes/DeleteAdmin/{businessTypeCode} |
事業種別を削除します。 事業種別コード(***businessTypeCode***)を指定して、事業種別を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/Master/BusinessTypes/Get/{businessTypeCode} |
事業種別を取得します。 事業種別コード(***businessTypeCode***)を指定して、事業種別を取得します。 事業種別に関する詳細については、[事業種別について]()を参照ください。 |
|
| GET | /API/v2/Master/BusinessTypes/GetList |
事業種別を全て取得します。 事業種別を全て取得します。 事業種別に関する詳細については、[事業種別について]()を参照ください。 |
|
| POST | /API/v2/Master/BusinessTypes/RegisterAdmin |
事業種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/Master/BusinessTypes/RegisterInternal |
事業種別を登録します。 内部呼び出し用。 (*For admin) |
|
Callsigns
コールサイン
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/General/Callsigns/Get/{callSignCode} |
コールサインを取得します。 コールサインコード(***callSignCode***)を指定して、コールサインを取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
|
| GET | /API/v2/General/Callsigns/GetList?callSignCode=!{callSignCode}&callSignName=!{callSignName}&vesselOperatorCode=!{vesselOperatorCode}&lastUpdatedBy=!{lastUpdatedBy} |
コールサインを取得します。 検索条件に該当するコールサインを全て取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
|
CargoClearanceAndDeliveryInstructions
輸入貨物荷捌依頼書
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/Create |
輸入貨物荷捌依頼書を作成します。 輸入貨物荷捌依頼書を作成するには、利用者が輸入貨物荷捌依頼書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/Delete/{reportId} |
輸入貨物荷捌依頼書を削除します。 帳票ID(***reportId***)を指定して、輸入貨物荷捌依頼書を削除します。 輸入貨物荷捌依頼書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した輸入貨物荷捌依頼書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/DeleteFile/{fileId} |
輸入貨物荷捌依頼書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、輸入貨物荷捌依頼書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/Get/{reportId}?historyId=!{historyId} |
輸入貨物荷捌依頼書を取得します。 帳票ID(***reportId***)を指定して、輸入貨物荷捌依頼書を取得します。 編集が行われていない場合は、ルートドキュメントから最新の輸入貨物荷捌依頼書を取得します。 編集中の場合は、先に保存した、輸入貨物荷捌依頼書を取得します。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書について]()を参照ください。 |
|
| GET | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/GetDiff/{reportId}?historyId=!{historyId} |
保存されている輸入貨物荷捌依頼書とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する輸入貨物荷捌依頼書と、ルートドキュメントの差分を取得します。 比較元を保存されている輸入貨物荷捌依頼書、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/GetFile/{fileId} |
輸入貨物荷捌依頼書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、輸入貨物荷捌依頼書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
輸入貨物荷捌依頼書を全て取得します。 検索条件に該当する輸入貨物荷捌依頼書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の輸入貨物荷捌依頼書を取得します。 編集中の場合は、先に保存した、輸入貨物荷捌依頼書を取得します。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/Lock/{reportId} |
編集するため、輸入貨物荷捌依頼書をロックします 帳票ID(***reportId***)を指定して、輸入貨物荷捌依頼書をロックします。 輸入貨物荷捌依頼書を作成(***Create***)した時点では、輸入貨物荷捌依頼書をロックが掛かりますが、取得(***Get***)したあとで、輸入貨物荷捌依頼書を編集する場合は、このメソッドを呼び出して、輸入貨物荷捌依頼書をロックします。 ロックされた輸入貨物荷捌依頼書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、輸入貨物荷捌依頼書をルートドキュメントから参照できますが、編集中(ロック中)の輸入貨物荷捌依頼書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/SetCancel/{reportId} |
輸入貨物荷捌依頼書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、輸入貨物荷捌依頼書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/Submit/{reportId} |
輸入貨物荷捌依頼書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した輸入貨物荷捌依頼書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、輸入貨物荷捌依頼書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、輸入貨物荷捌依頼書もロックされた状態のままなので、ご注意ください。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書について]()を参照ください。 |
|
| POST | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/SubmitByPost |
輸入貨物荷捌依頼書を提出します。 動作は、輸入貨物荷捌依頼書(***/API/v2/Reports/CargoClearanceAndDeliveryInstructions/Submit***)と同様です。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/Unlock/{reportId} |
輸入貨物荷捌依頼書のロックを解除します 帳票ID(***reportId***)を指定して、輸入貨物荷捌依頼書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/Update/{reportId} |
輸入貨物荷捌依頼書を更新します。 帳票ID(***reportId***)を指定して、輸入貨物荷捌依頼書を更新します。 このメソッドでは、輸入貨物荷捌依頼書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書について]()を参照ください。 |
|
| POST | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/UpdateByPost |
輸入貨物荷捌依頼書を更新します。 動作は、輸入貨物荷捌依頼書(***/API/v2/Reports/CargoClearanceAndDeliveryInstructions/Update***)と同様です。 輸入貨物荷捌依頼書に関する詳細については、[輸入貨物荷捌依頼書]()を参照ください。 |
|
| POST | /API/v2/Reports/CargoClearanceAndDeliveryInstructions/UploadFile |
輸入貨物荷捌依頼書にファイルを添付します。 指定された輸入貨物荷捌依頼書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
CargoInformationInquiries
ICG_貨物情報照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/CargoInformationInquiries/Create |
ICGを作成します。 ICGを作成するには、利用者がICGを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/CargoInformationInquiries/Delete/{reportId} |
ICGを削除します。 帳票ID(***reportId***)を指定して、、ICGを削除します。 ICGを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/CargoInformationInquiries/DeleteFile/{fileId} |
ICGの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、ICGの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/CargoInformationInquiries/Get/{reportId} |
ICGを取得します。 帳票ID(***reportId***)を指定して、ICG取得します。 編集が行われていない場合は、ルートドキュメントから最新のICGを取得します。 編集中の場合は、先に保存した、ICGを取得します。 |
|
| GET | /API/v2/NaccsReports/CargoInformationInquiries/GetFile/{fileId} |
ICGに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、ICGに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/CargoInformationInquiries/Lock/{reportId} |
編集するため、ICGをロックします。 帳票ID(***reportId***)を指定して、ICGをロックします。 ICGを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、ICGを編集する場合は、このメソッドを呼び出してロックします。 ロックされたICGは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、ICGをルートドキュメントから参照できますが、編集中(ロック中)のICGは参照できません。 |
|
| POST | /API/v2/NaccsReports/CargoInformationInquiries/SendToNaccs |
ICGをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したICGをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ICGが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/CargoInformationInquiries/SetCancel/{reportId} |
ICGの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、ICGの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/CargoInformationInquiries/Submit/{reportId} |
ICGを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したICGを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ICGが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/CargoInformationInquiries/Unlock/{reportId} |
ICGのロックを解除します。 帳票ID(***reportId***)を指定して、ICGのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/CargoInformationInquiries/Update/{reportId} |
ICGを更新します。 帳票ID(***reportId***)を指定して、ICGを更新します。 このメソッドでは、ICGの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/CargoInformationInquiries/UploadFile |
ICGにファイルを添付します。 指定されたICGに、ファイルを添付します。 |
|
CargoInventoryStatusInquiries
IWS_貨物在庫状況照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/CargoInventoryStatusInquiries/Create |
IWSを作成します。 IWSを作成するには、利用者がIWSを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/CargoInventoryStatusInquiries/Delete/{reportId} |
IWSを削除します。 帳票ID(***reportId***)を指定して、、IWSを削除します。 IWSを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/CargoInventoryStatusInquiries/DeleteFile/{fileId} |
IWSの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IWSの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/CargoInventoryStatusInquiries/Get/{reportId} |
IWSを取得します。 帳票ID(***reportId***)を指定して、IWS取得します。 編集が行われていない場合は、ルートドキュメントから最新のIWSを取得します。 編集中の場合は、先に保存した、IWSを取得します。 |
|
| GET | /API/v2/NaccsReports/CargoInventoryStatusInquiries/GetFile/{fileId} |
IWSに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IWSに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/CargoInventoryStatusInquiries/Lock/{reportId} |
編集するため、IWSをロックします。 帳票ID(***reportId***)を指定して、IWSをロックします。 IWSを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IWSを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIWSは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IWSをルートドキュメントから参照できますが、編集中(ロック中)のIWSは参照できません。 |
|
| POST | /API/v2/NaccsReports/CargoInventoryStatusInquiries/SendToNaccs |
IWSをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIWSをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IWSが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/CargoInventoryStatusInquiries/SetCancel/{reportId} |
IWSの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IWSの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/CargoInventoryStatusInquiries/Submit/{reportId} |
IWSを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIWSを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IWSが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/CargoInventoryStatusInquiries/Unlock/{reportId} |
IWSのロックを解除します。 帳票ID(***reportId***)を指定して、IWSのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/CargoInventoryStatusInquiries/Update/{reportId} |
IWSを更新します。 帳票ID(***reportId***)を指定して、IWSを更新します。 このメソッドでは、IWSの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/CargoInventoryStatusInquiries/UploadFile |
IWSにファイルを添付します。 指定されたIWSに、ファイルを添付します。 |
|
CargoManifestsStatusInquiries
IMI_積荷目録状況照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/CargoManifestsStatusInquiries/Create |
IMIを作成します。 IMIを作成するには、利用者がIMIを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/CargoManifestsStatusInquiries/Delete/{reportId} |
IMIを削除します。 帳票ID(***reportId***)を指定して、、IMIを削除します。 IMIを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/CargoManifestsStatusInquiries/DeleteFile/{fileId} |
IMIの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IMIの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/CargoManifestsStatusInquiries/Get/{reportId} |
IMIを取得します。 帳票ID(***reportId***)を指定して、IMI取得します。 編集が行われていない場合は、ルートドキュメントから最新のIMIを取得します。 編集中の場合は、先に保存した、IMIを取得します。 |
|
| GET | /API/v2/NaccsReports/CargoManifestsStatusInquiries/GetFile/{fileId} |
IMIに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IMIに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/CargoManifestsStatusInquiries/Lock/{reportId} |
編集するため、IMIをロックします。 帳票ID(***reportId***)を指定して、IMIをロックします。 IMIを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IMIを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIMIは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IMIをルートドキュメントから参照できますが、編集中(ロック中)のIMIは参照できません。 |
|
| POST | /API/v2/NaccsReports/CargoManifestsStatusInquiries/SendToNaccs |
IMIをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIMIをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IMIが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/CargoManifestsStatusInquiries/SetCancel/{reportId} |
IMIの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IMIの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/CargoManifestsStatusInquiries/Submit/{reportId} |
IMIを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIMIを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IMIが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/CargoManifestsStatusInquiries/Unlock/{reportId} |
IMIのロックを解除します。 帳票ID(***reportId***)を指定して、IMIのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/CargoManifestsStatusInquiries/Update/{reportId} |
IMIを更新します。 帳票ID(***reportId***)を指定して、IMIを更新します。 このメソッドでは、IMIの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/CargoManifestsStatusInquiries/UploadFile |
IMIにファイルを添付します。 指定されたIMIに、ファイルを添付します。 |
|
CertificateOfOriginIdentificationCodes
原産地証明書識別コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/CertificateOfOriginIdentificationCodes/DeleteAdmin/{certificateOfOriginIdentificationCode} |
原産地証明書識別コードを削除します。 原産地証明書識別コード(***certificateOfOriginIdentificationCode***)を指定して、原産地証明書識別コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/CertificateOfOriginIdentificationCodes/Get/{certificateOfOriginIdentificationCode} |
原産地証明書識別を取得します。 原産地証明書識別コード(***certificateOfOriginIdentificationCode***)を指定して、原産地証明書識別を取得します。 原産地証明書識別コードに関する詳細については、[原産地証明書識別コードについて]()を参照ください。 |
|
| GET | /API/v2/General/CertificateOfOriginIdentificationCodes/GetList |
原産地証明書識別を全て取得します。 原産地証明書識別コードに関する詳細については、[原産地証明書識別コードについて]()を参照ください。 |
|
| POST | /API/v2/General/CertificateOfOriginIdentificationCodes/RegisterAdmin |
原産地証明書識別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/CertificateOfOriginIdentificationCodes/RegisterInternal |
原産地証明書識別を登録します。 内部呼び出し用。 (*For admin) |
|
CfsDispatchOrders
CFS搬出票
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/CfsDispatchOrders/Create |
CFS搬出票を作成します。 CFS搬出票を作成するには、利用者がCFS搬出票を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 CFS搬出票に関する詳細については、[CFS搬出票について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/CfsDispatchOrders/Delete/{reportId} |
CFS搬出票を削除します。 帳票ID(***reportId***)を指定して、CFS搬出票を削除します。 CFS搬出票を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したCFS搬出票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 CFS搬出票に関する詳細については、[CFS搬出票について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/CfsDispatchOrders/DeleteFile/{fileId} |
CFS搬出票の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、CFS搬出票の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/CfsDispatchOrders/Get/{reportId}?historyId=!{historyId} |
CFS搬出票を取得します。 帳票ID(***reportId***)を指定して、CFS搬出票を取得します。 編集が行われていない場合は、ルートドキュメントから最新のCFS搬出票を取得します。 編集中の場合は、先に保存した、CFS搬出票を取得します。 CFS搬出票に関する詳細については、[CFS搬出票について]()を参照ください。 |
|
| GET | /API/v2/Reports/CfsDispatchOrders/GetDiff/{reportId}?historyId=!{historyId} |
保存されているCFS搬出票とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当するCFS搬出票と、ルートドキュメントの差分を取得します。 比較元を保存されているCFS搬出票、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/CfsDispatchOrders/GetFile/{fileId} |
CFS搬出票に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、CFS搬出票に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/CfsDispatchOrders/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
CFS搬出票を全て取得します。 検索条件に該当するCFS搬出票を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のCFS搬出票を取得します。 編集中の場合は、先に保存した、CFS搬出票を取得します。 CFS搬出票に関する詳細については、[CFS搬出票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CfsDispatchOrders/Lock/{reportId} |
編集するため、CFS搬出票をロックします 帳票ID(***reportId***)を指定して、CFS搬出票をロックします。 CFS搬出票を作成(***Create***)した時点では、CFS搬出票をロックが掛かりますが、取得(***Get***)したあとで、CFS搬出票を編集する場合は、このメソッドを呼び出して、CFS搬出票をロックします。 ロックされたCFS搬出票は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、CFS搬出票をルートドキュメントから参照できますが、編集中(ロック中)のCFS搬出票は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 CFS搬出票に関する詳細については、[CFS搬出票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CfsDispatchOrders/SetCancel/{reportId} |
CFS搬出票の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、CFS搬出票の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 CFS搬出票に関する詳細については、[CFS搬出票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CfsDispatchOrders/Submit/{reportId} |
CFS搬出票を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したCFS搬出票を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、CFS搬出票が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、コンテナ貨物搬入票もロックされた状態のままなので、ご注意ください。 CFS搬出票に関する詳細については、[CFS搬出票について]()を参照ください。 |
|
| POST | /API/v2/Reports/CfsDispatchOrders/SubmitByPost |
CFS搬出票を提出します。 動作は、CFS搬出票(***/API/v2/Reports/CfsDispatchOrders/Submit***)と同様です。 CFS搬出票に関する詳細については、[CFS搬出票]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CfsDispatchOrders/Unlock/{reportId} |
CFS搬出票のロックを解除します 帳票ID(***reportId***)を指定して、CFS搬出票のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 CFS搬出票に関する詳細については、[CFS搬出票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CfsDispatchOrders/Update/{reportId} |
CFS搬出票を更新します。 帳票ID(***reportId***)を指定して、CFS搬出票を更新します。 このメソッドでは、CFS搬出票の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 CFS搬出票に関する詳細については、[CFS搬出票について]()を参照ください。 |
|
| POST | /API/v2/Reports/CfsDispatchOrders/UpdateByPost |
CFS搬出票を更新します。 動作は、CFS搬出票(***/API/v2/Reports/CfsDispatchOrders/Update***)と同様です。 CFS搬出票に関する詳細については、[CFS搬出票]()を参照ください。 |
|
| POST | /API/v2/Reports/CfsDispatchOrders/UploadFile |
CFS搬出票にファイルを添付します。 指定されたCFS搬出票に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
ColinsViewers
Colinsビューアー
CollateralInquiries
IAS_担保照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/CollateralInquiries/Create |
IASを作成します。 IASを作成するには、利用者がIASを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/CollateralInquiries/Delete/{reportId} |
IASを削除します。 帳票ID(***reportId***)を指定して、、IASを削除します。 IASを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/CollateralInquiries/DeleteFile/{fileId} |
IASの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IASの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/CollateralInquiries/Get/{reportId} |
IASを取得します。 帳票ID(***reportId***)を指定して、IAS取得します。 編集が行われていない場合は、ルートドキュメントから最新のIASを取得します。 編集中の場合は、先に保存した、IASを取得します。 |
|
| GET | /API/v2/NaccsReports/CollateralInquiries/GetFile/{fileId} |
IASに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IASに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/CollateralInquiries/Lock/{reportId} |
編集するため、IASをロックします。 帳票ID(***reportId***)を指定して、IASをロックします。 IASを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IASを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIASは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IASをルートドキュメントから参照できますが、編集中(ロック中)のIASは参照できません。 |
|
| POST | /API/v2/NaccsReports/CollateralInquiries/SendToNaccs |
IASをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIASをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IASが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/CollateralInquiries/SetCancel/{reportId} |
IASの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IASの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/CollateralInquiries/Submit/{reportId} |
IASを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIASを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IASが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/CollateralInquiries/Unlock/{reportId} |
IASのロックを解除します。 帳票ID(***reportId***)を指定して、IASのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/CollateralInquiries/Update/{reportId} |
IASを更新します。 帳票ID(***reportId***)を指定して、IASを更新します。 このメソッドでは、IASの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/CollateralInquiries/UploadFile |
IASにファイルを添付します。 指定されたIASに、ファイルを添付します。 |
|
Columns
帳票の項目
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Master/ReportTypes/Columns/DeleteAdmin/{reportColumnCode} |
帳票の項目を削除します。 帳票の項目コード(***reportColumnCode***)を指定して、帳票の種類を削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| GET | /API/v2/Master/ReportTypes/Columns/Get/{reportCode} |
帳票コードを指定して、帳票の項目を全て取得します。 帳票コード(***reportCode***)を指定して、帳票の項目を全て取得します。 帳票の項目とルートドキュメントに関する詳細については、[帳票の項目とルートドキュメントについて]()を参照ください。 |
|
| POST | /API/v2/Master/ReportTypes/Columns/RegisterAdmin |
帳票の種類と項目を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/Master/ReportTypes/Columns/RegisterInternal |
帳票の種類と項目を登録します。 内部呼び出し用。 (*For admin) |
|
ColumnTemplates
項目テンプレート
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Organizations/ColumnTemplates/Delete/{columnTemplateId} |
項目テンプレートを削除します。 項目テンプレートID(***columnTemplateId***)を指定して、項目テンプレートを削除します。 項目テンプレートに関する詳細については、[項目テンプレートについて]()を参照ください。 |
|
| GET | /API/v2/Organizations/ColumnTemplates/Get/{columnTemplateId} |
項目テンプレートを取得します。 項目テンプレートID(***columnTemplateId***)を指定して、項目テンプレートを取得します。 項目テンプレートに関する詳細については、[項目テンプレートについて]()を参照ください。 |
|
| GET | /API/v2/Organizations/ColumnTemplates/GetList?columnTemplateId=!{columnTemplateId}&columnTemplateName=!{columnTemplateName}&organizationId=!{organizationId}&columnCode=!{columnCode} |
検索条件に該当する項目テンプレートを全て取得します。 検索条件を指定して、ログインしている利用者が所属する組織が所有する項目テンプレートを全て取得します。 項目テンプレートに関する詳細については、[項目テンプレートについて]()を参照ください。 |
|
| POST | /API/v2/Organizations/ColumnTemplates/Register |
項目テンプレートを登録します。 組織で使用する帳票の項目テンプレートを登録します。 項目テンプレートは、帳票を編集する際に入力した情報を保存し、次回、同じ項目を入力する際のテンプレートとして機能します。 登録した項目テンプレートは、利用者が所属する指定された組織内で共有されます。 項目テンプレートに関する詳細については、[項目テンプレートについて]()を参照ください。 |
|
CommercialInvoices
商業送り状(I/V)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/CommercialInvoices/Create |
商業送り状(I/V)を作成します。 商業送り状(I/V)を作成するには、利用者が商業送り状(I/V)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/CommercialInvoices/Delete/{reportId} |
商業送り状(I/V)を削除します。 帳票ID(***reportId***)を指定して、商業送り状(I/V)を削除します。 商業送り状(I/V)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した商業送り状(I/V)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/CommercialInvoices/DeleteFile/{fileId} |
商業送り状(I/V)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、商業送り状(I/V)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/CommercialInvoices/Get/{reportId}?historyId=!{historyId} |
商業送り状(I/V)を取得します。 帳票ID(***reportId***)を指定して、商業送り状(I/V)を取得します。 編集が行われていない場合は、ルートドキュメントから最新のブッキング依頼書を取得します。 編集中の場合は、先に保存した、商業送り状(I/V)を取得します。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
| GET | /API/v2/Reports/CommercialInvoices/GetDiff/{reportId}?historyId=!{historyId} |
保存されている商業送り状(I/V)とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する商業送り状(I/V)と、ルートドキュメントの差分を取得します。 比較元を保存されている商業送り状(I/V)、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/CommercialInvoices/GetFile/{fileId} |
商業送り状(I/V)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、商業送り状(I/V)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/CommercialInvoices/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
商業送り状(I/V)を全て取得します。 検索条件に該当する商業送り状(I/V)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の商業送り状(I/V)を取得します。 編集中の場合は、先に保存した、商業送り状(I/V)を取得します。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CommercialInvoices/Lock/{reportId} |
編集するため、商業送り状(I/V)をロックします 帳票ID(***reportId***)を指定して、商業送り状(I/V)をロックします。 商業送り状(I/V)を作成(***Create***)した時点では、商業送り状(I/V)をロックが掛かりますが、取得(***Get***)したあとで、商業送り状(I/V)を編集する場合は、このメソッドを呼び出して、商業送り状(I/V)をロックします。 ロックされた商業送り状(I/V)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、商業送り状(I/V)をルートドキュメントから参照できますが、編集中(ロック中)の商業送り状(I/V)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CommercialInvoices/SetCancel/{reportId} |
商業送り状(I/V)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、商業送り状(I/V)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CommercialInvoices/Submit/{reportId} |
商業送り状(I/V)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した商業送り状(I/V)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、商業送り状(I/V)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、商業送り状(I/V)もロックされた状態のままなので、ご注意ください。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
| POST | /API/v2/Reports/CommercialInvoices/SubmitByPost |
商業送り状(I/V)を提出します 動作は、商業送り状(I/V)(***/API/v2/Reports/CommercialInvoices/Submit***)と同様です。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CommercialInvoices/Unlock/{reportId} |
商業送り状(I/V)のロックを解除します 帳票ID(***reportId***)を指定して、商業送り状(I/V)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CommercialInvoices/Update/{reportId} |
商業送り状(I/V)を更新します。 帳票ID(***reportId***)を指定して、商業送り状(I/V)を更新します。 このメソッドでは、商業送り状(I/V)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)について]()を参照ください。 |
|
| POST | /API/v2/Reports/CommercialInvoices/UpdateByPost |
商業送り状(I/V)を更新します。 動作は、商業送り状(I/V)(***/API/v2/Reports/CommercialInvoices/Update***)と同様です。 商業送り状(I/V)に関する詳細については、[商業送り状(I/V)]()を参照ください。 |
|
| POST | /API/v2/Reports/CommercialInvoices/UploadFile |
商業送り状(I/V)にファイルを添付します。 指定された商業送り状(I/V)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
Companies
会社
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Companies/DeleteLogoImage/{companyId} |
会社のロゴイメージを削除します。 ログインしている利用者が所属する会社のロゴイメージを削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 会社に関する詳細については、[会社について]()を参照ください。 |
|
| GET | /API/v2/Companies/Get |
会社を取得します。 ログインしている利用者が所属する会社を取得します。 会社に関する詳細については、[会社について]()を参照ください。 |
|
| GET | /API/v2/Companies/GetLogoImage/{corporateNo} |
会社のロゴイメージを取得します。 会社に登録されているロゴイメージを取得します。 ロゴイメージはBase64形式でエンコードされた形で返却します。 |
|
| GET | /API/v2/Companies/Search?corporateNo=!{corporateNo}&companyName=!{companyName}&companyNameEn=!{companyNameEn}&businessTypeCodeList=!{businessTypeCodeList} |
検索条件に該当する会社を取得します。 ログインしている利用者が所属する会社以外の検索条件に該当する会社を全て取得します。 会社に関する詳細については、[会社について]()を参照ください。 |
|
| PATCH | /API/v2/Companies/Update/{companyId} |
会社を更新します。 ログインしている利用者が所属する会社を更新します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 会社に関する詳細については、[会社について]()を参照ください。 |
|
| PATCH | /API/v2/Companies/UploadLogoImage/{companyId} |
会社のロゴイメージを登録・更新します。 ログインしている利用者が所属する会社のロゴイメージを登録・更新します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 会社に関する詳細については、[会社について]()を参照ください。 |
|
CompanyOtherCompanyIdentificationCodes
自社・他社識別符号
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/CompanyOtherCompanyIdentificationCodes/DeleteAdmin/{companyOtherCompanyIdentificationCode} |
自社・他社識別符号を削除します。 自社・他社識別符号(***companyOtherCompanyIdentificationCode***)を指定して、自社・他社識別符号を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/CompanyOtherCompanyIdentificationCodes/Get/{companyOtherCompanyIdentificationCode} |
自社・他社識別を取得します。 自社・他社識別符号(***companyOtherCompanyIdentificationCode***)を指定して、自社・他社識別を取得します。 自社・他社識別符号に関する詳細については、[自社・他社識別符号について]()を参照ください。 |
|
| GET | /API/v2/General/CompanyOtherCompanyIdentificationCodes/GetList |
自社・他社識別を全て取得します。 自社・他社識別符号に関する詳細については、[自社・他社識別符号について]()を参照ください。 |
|
| POST | /API/v2/General/CompanyOtherCompanyIdentificationCodes/RegisterAdmin |
自社・他社識別符号を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/CompanyOtherCompanyIdentificationCodes/RegisterInternal |
自社・他社識別符号を登録します。 内部呼び出し用。 (*For admin) |
|
ConpasIntegrationSettings
CONPAS連携設定
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Master/ConpasIntegrationSettings/DeleteAdmin/{terminalCodeForConpas} |
CONPAS連携設定を削除します。 CONPAS用ターミナルコード(***terminalCodeForConpas***)を指定して、CONPAS連携設定を削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| GET | /API/v2/Master/ConpasIntegrationSettings/Get/{terminalCodeForConpas} |
CONPAS連携設定を取得します。 CONPAS用ターミナルコード(***terminalCodeForConpas***)を指定して、CONPAS連携設定を取得します。 CONPAS連携に関する詳細については、[CONPAS連携について]()を参照ください。 |
|
| GET | /API/v2/Master/ConpasIntegrationSettings/GetByGateInSlipReportId/{gateInSlipReportId} |
コンテナ貨物搬入票に該当するCONPA連携設定を取得します。 コンテナ貨物搬入票(***/API/v2/Reports/ContainerGateInSlips***)の帳票IDを指定して、CONPA連携設定を取得します。 このメソッドでは、指定された帳票IDが示す帳票がコンテナ貨物搬入票(***/API/v2/Reports/ContainerGateInSlips***)であり、かつ、呼び出す利用者が所属する組織が、そのコンテナ貨物搬入票にアクセス権限を有している必要があり、かつ、そのコンテナ貨物搬入票に「CONPAS用ターミナルコード(***terminalCodeForConpas***)」が設定されている必要があります。 この条件に合致しない場合、CONPA連携設定は取得できません。 CONPAS連携に関する詳細については、[CONPAS連携について]()を参照ください。 |
|
| GET | /API/v2/Master/ConpasIntegrationSettings/GetList |
CONPAS連携設定を全て取得します。 CONPAS連携設定を全て取得します。 CONPAS連携に関する詳細については、[CONPAS連携について]()を参照ください。 |
|
| GET | /API/v2/Master/ConpasIntegrationSettings/GetListInternal?terminalCodeForConpas=!{terminalCodeForConpas}&gateInSlipReportId=!{gateInSlipReportId}&includeDummy=!{includeDummy}&openId=!{openId} |
CONPAS連携設定を全て取得します。 CONPAS連携設定を全て取得します。 内部呼び出し用 |
|
| POST | /API/v2/Master/ConpasIntegrationSettings/RegisterAdmin |
CONPAS連携設定を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/Master/ConpasIntegrationSettings/RegisterInternal |
CONPAS連携設定を登録します。 内部呼び出し用。 (*For admin) |
|
ContactInformations
問合せ先
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Master/ContactInformations/DeleteAdmin/{contactInformationId} |
問合せ先を削除します。 問合せ先ID(***contactInformationId***)を指定して、問合せ先を削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| GET | /API/v2/Master/ContactInformations/Get/{contactInformationId} |
問合せ先IDを指定して、問合せ先を取得します。 問合せ先ID(***contactInformationId***)を指定して、問合せ先を取得します。 |
|
| GET | /API/v2/Master/ContactInformations/GetList/{reportCode} |
帳票コードを指定して、問合せ先を全て取得します。 帳票コード(***reportCode***)を指定して、問合せ先を全て取得します。 |
|
| POST | /API/v2/Master/ContactInformations/RegisterAdmin |
問合せ先を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/Master/ContactInformations/RegisterInternal |
問合せ先を登録します。 内部呼び出し用。 (*For admin) |
|
ContainerDeliveryReceipts
コンテナ貨物受領書
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/ContainerDeliveryReceipts/Create |
コンテナ貨物受領書を作成します。 コンテナ貨物受領書を作成するには、利用者がコンテナ貨物受領書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/ContainerDeliveryReceipts/Delete/{reportId} |
コンテナ貨物受領書を削除します。 帳票ID(***reportId***)を指定して、コンテナ貨物受領書を削除します。 コンテナ貨物受領書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したコンテナ貨物受領書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/ContainerDeliveryReceipts/DeleteFile/{fileId} |
コンテナ貨物受領書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、コンテナ貨物受領書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/ContainerDeliveryReceipts/Get/{reportId}?historyId=!{historyId} |
コンテナ貨物受領書を取得します。 帳票ID(***reportId***)を指定して、コンテナ貨物受領書を取得します。 編集が行われていない場合は、ルートドキュメントから最新のコンテナ貨物受領書を取得します。 編集中の場合は、先に保存した、コンテナ貨物受領書を取得します。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書について]()を参照ください。 |
|
| GET | /API/v2/Reports/ContainerDeliveryReceipts/GetDiff/{reportId}?historyId=!{historyId} |
保存されているコンテナ貨物受領書とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当するコンテナ貨物受領書と、ルートドキュメントの差分を取得します。 比較元を保存されているコンテナ貨物受領書、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/ContainerDeliveryReceipts/GetFile/{fileId} |
コンテナ貨物受領書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、コンテナ貨物受領書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/ContainerDeliveryReceipts/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
コンテナ貨物受領書を全て取得します。 検索条件に該当するコンテナ貨物受領書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のコンテナ貨物受領書を取得します。 編集中の場合は、先に保存した、コンテナ貨物受領書を取得します。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerDeliveryReceipts/Lock/{reportId} |
編集するため、コンテナ貨物受領書をロックします 帳票ID(***reportId***)を指定して、コンテナ貨物受領書をロックします。 コンテナ貨物受領書を作成(***Create***)した時点では、コンテナ貨物受領書をロックが掛かりますが、取得(***Get***)したあとで、コンテナ貨物受領書を編集する場合は、このメソッドを呼び出して、コンテナ貨物受領書をロックします。 ロックされたコンテナ貨物受領書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、コンテナ貨物受領書をルートドキュメントから参照できますが、編集中(ロック中)のコンテナ貨物受領書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerDeliveryReceipts/SetCancel/{reportId} |
コンテナ貨物受領書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、コンテナ貨物受領書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerDeliveryReceipts/Submit/{reportId} |
コンテナ貨物受領書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したコンテナ貨物受領書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、コンテナ貨物受領書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、コンテナ貨物受領書もロックされた状態のままなので、ご注意ください。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書について]()を参照ください。 |
|
| POST | /API/v2/Reports/ContainerDeliveryReceipts/SubmitByPost |
コンテナ貨物受領書を提出します。 動作は、コンテナ貨物受領書(***/API/v2/Reports/ContainerDeliveryReceipts/Submit***)と同様です。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerDeliveryReceipts/Unlock/{reportId} |
コンテナ貨物受領書のロックを解除します 帳票ID(***reportId***)を指定して、コンテナ貨物受領書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerDeliveryReceipts/Update/{reportId} |
コンテナ貨物受領書を更新します。 帳票ID(***reportId***)を指定して、コンテナ貨物受領書を更新します。 このメソッドでは、コンテナ貨物受領書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書について]()を参照ください。 |
|
| POST | /API/v2/Reports/ContainerDeliveryReceipts/UpdateByPost |
コンテナ貨物受領書を更新します。 動作は、コンテナ貨物受領書(***/API/v2/Reports/ContainerDeliveryReceipts/Update***)と同様です。 コンテナ貨物受領書に関する詳細については、[コンテナ貨物受領書]()を参照ください。 |
|
| POST | /API/v2/Reports/ContainerDeliveryReceipts/UploadFile |
コンテナ貨物受領書にファイルを添付します。 指定されたコンテナ貨物受領書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
ContainerGateInMatchings
搬入情報マッチング
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/Reports/ContainerGateInMatchings/GetMatchResultDetails/{gateInSlipReportId}/{historyId} |
コンテナ搬入情報の照合結果の詳細を取得します コンテナ貨物搬入票(***/API/v2/Reports/ContainerGateInSlips***)の帳票ID(***reportId***)と履歴ID(***historyId***)を指定して、CONPASとのコンテナ搬入情報の照合結果の詳細を取得します。 このメソッドを使用するには、利用者が所属する会社が「CONPASの利用」を申請しており、かつ、帳票ID(***reportId***)が示すコンテナ貨物搬入票(***/API/v2/Reports/ContainerGateInSlips***)へのアクセス権限を有している必要があります。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
| GET | /API/v2/Reports/ContainerGateInMatchings/GetPastMatchResults/{gateInSlipReportId} |
コンテナ搬入情報の照合結果を取得します コンテナ貨物搬入票(***/API/v2/Reports/ContainerGateInSlips***)の帳票ID(***reportId***)を指定して、CONPASとのコンテナ搬入情報の照合結果を取得します。 このメソッドを使用するには、利用者が所属する会社が「CONPASの利用」を申請しており、かつ、帳票ID(***reportId***)が示すコンテナ貨物搬入票(***/API/v2/Reports/ContainerGateInSlips***)へのアクセス権限を有している必要があります。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
ContainerGateInMatchings-Request
搬入情報マッチング依頼
| API | Description | ||
|---|---|---|---|
| PATCH | /API/v2/Reports/ContainerGateInMatchings-Request/Submit/{reportId} |
搬入情報マッチングをCONPANSに依頼します コンテナ貨物搬入票(***/API/v2/Reports/ContainerGateInSlips***)の帳票ID(***reportId***)を指定して、CONPASにコンテナ搬入情報の照合を依頼します。 このメソッドを使用するには、利用者が所属する会社が「CONPASの利用」を申請しており、かつ、帳票ID(***reportId***)が示すコンテナ貨物搬入票(***/API/v2/Reports/ContainerGateInSlips***)へのアクセス権限を有している必要があります。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
ContainerGateInMatchings-Result
搬入情報マッチング結果
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/ContainerGateInMatchings-Result/Create |
搬入情報マッチング結果を作成します。 搬入情報マッチング結果を作成するには、利用者が搬入情報マッチング結果を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/ContainerGateInMatchings-Result/Delete/{reportId} |
搬入情報マッチング結果を削除します。 帳票ID(***reportId***)を指定して、搬入情報マッチング結果を削除します。 搬入情報マッチング結果を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したコンテナ貨物搬入票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/ContainerGateInMatchings-Result/DeleteFile/{fileId} |
搬入情報マッチング結果の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、搬入情報マッチング結果の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/ContainerGateInMatchings-Result/Get/{reportId}?historyId=!{historyId} |
搬入情報マッチング結果を取得します。 帳票ID(***reportId***)を指定して、搬入情報マッチング結果を取得します。 編集が行われていない場合は、ルートドキュメントから最新の搬入情報マッチング結果を取得します。 編集中の場合は、先に保存した、搬入情報マッチング結果を取得します。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
| GET | /API/v2/Reports/ContainerGateInMatchings-Result/GetDiff/{reportId}?historyId=!{historyId} |
保存されている搬入情報マッチング結果とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する搬入情報マッチング結果と、ルートドキュメントの差分を取得します。 比較元を保存されている搬入情報マッチング結果、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/ContainerGateInMatchings-Result/GetFile/{fileId} |
搬入情報マッチング結果に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、搬入情報マッチング結果に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/ContainerGateInMatchings-Result/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
搬入情報マッチング結果を全て取得します。 検索条件に該当する搬入情報マッチング結果を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の搬入情報マッチング結果を取得します。 編集中の場合は、先に保存した、搬入情報マッチング結果を取得します。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerGateInMatchings-Result/Lock/{reportId} |
編集するため、搬入情報マッチング結果をロックします 帳票ID(***reportId***)を指定して、搬入情報マッチング結果をロックします。 搬入情報マッチング結果を作成(***Create***)した時点では、搬入情報マッチング結果をロックが掛かりますが、取得(***Get***)したあとで、搬入情報マッチング結果を編集する場合は、このメソッドを呼び出して、搬入情報マッチング結果をロックします。 ロックされた搬入情報マッチング結果は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、搬入情報マッチング結果をルートドキュメントから参照できますが、編集中(ロック中)の搬入情報マッチング結果は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerGateInMatchings-Result/SetCancel/{reportId} |
搬入情報マッチング結果の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、搬入情報マッチング結果の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerGateInMatchings-Result/Submit/{reportId} |
搬入情報マッチング結果を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したコンテナ貨物搬出票を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、搬入情報マッチング結果が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、搬入情報マッチング結果もロックされた状態のままなので、ご注意ください。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
| POST | /API/v2/Reports/ContainerGateInMatchings-Result/SubmitByPost |
搬入情報マッチング結果を提出します。 動作は、搬入情報マッチング結果(***/API/v2/Reports/ContainerGateInMatchings-Result/Submit***)と同様です。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerGateInMatchings-Result/Unlock/{reportId} |
搬入情報マッチング結果のロックを解除します 帳票ID(***reportId***)を指定して、搬入情報マッチング結果のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerGateInMatchings-Result/Update/{reportId} |
搬入情報マッチング結果を更新します。 帳票ID(***reportId***)を指定して、搬入情報マッチング結果を更新します。 このメソッドでは、搬入情報マッチング結果の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果について]()を参照ください。 |
|
| POST | /API/v2/Reports/ContainerGateInMatchings-Result/UpdateByPost |
搬入情報マッチング結果を更新します。 動作は、搬入情報マッチング結果(***/API/v2/Reports/ContainerGateInMatchings-Result/Update***)と同様です。 搬入情報マッチング結果に関する詳細については、[搬入情報マッチング結果]()を参照ください。 |
|
| POST | /API/v2/Reports/ContainerGateInMatchings-Result/UploadFile |
搬入情報マッチング結果にファイルを添付します。 指定された搬入情報マッチング結果に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
ContainerGateInSlips
コンテナ貨物搬入票
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/ContainerGateInSlips/Create |
コンテナ貨物搬入票を作成します。 コンテナ貨物搬入票を作成するには、利用者がコンテナ貨物搬入票を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/ContainerGateInSlips/Delete/{reportId} |
コンテナ貨物搬入票を削除します。 帳票ID(***reportId***)を指定して、コンテナ貨物搬入票を削除します。 コンテナ貨物搬入票を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したコンテナ貨物搬入票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/ContainerGateInSlips/DeleteFile/{fileId} |
コンテナ貨物搬入票の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、コンテナ貨物搬入票の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/ContainerGateInSlips/Get/{reportId}?historyId=!{historyId} |
コンテナ貨物搬入票を取得します。 帳票ID(***reportId***)を指定して、コンテナ貨物搬入票を取得します。 編集が行われていない場合は、ルートドキュメントから最新のコンテナ貨物搬入票を取得します。 編集中の場合は、先に保存した、コンテナ貨物搬入票を取得します。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
| GET | /API/v2/Reports/ContainerGateInSlips/GetDiff/{reportId}?historyId=!{historyId} |
保存されているコンテナ貨物搬入票とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当するコンテナ貨物搬入票と、ルートドキュメントの差分を取得します。 比較元を保存されているコンテナ貨物搬入票、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/ContainerGateInSlips/GetFile/{fileId} |
コンテナ貨物搬入票に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、コンテナ貨物搬入票に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/ContainerGateInSlips/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
コンテナ貨物搬入票を全て取得します。 検索条件に該当するコンテナ貨物搬入票を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のコンテナ貨物搬入票を取得します。 編集中の場合は、先に保存した、コンテナ貨物搬入票を取得します。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerGateInSlips/Lock/{reportId} |
編集するため、コンテナ貨物搬入票をロックします 帳票ID(***reportId***)を指定して、コンテナ貨物搬入票をロックします。 コンテナ貨物搬入票を作成(***Create***)した時点では、コンテナ貨物搬入票をロックが掛かりますが、取得(***Get***)したあとで、コンテナ貨物搬入票を編集する場合は、このメソッドを呼び出して、コンテナ貨物搬入票をロックします。 ロックされたコンテナ貨物搬入票は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、コンテナ貨物搬入票をルートドキュメントから参照できますが、編集中(ロック中)のコンテナ貨物搬入票は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerGateInSlips/SetCancel/{reportId} |
コンテナ貨物搬入票の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、コンテナ貨物搬入票の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerGateInSlips/Submit/{reportId} |
コンテナ貨物搬入票を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したコンテナ貨物搬入票を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、コンテナ貨物搬入票が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、コンテナ貨物搬入票もロックされた状態のままなので、ご注意ください。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
| POST | /API/v2/Reports/ContainerGateInSlips/SubmitByPost |
コンテナ貨物搬入票を提出します 動作は、コンテナ貨物搬入票(***/API/v2/Reports/ContainerGateInSlips/Submit***)と同様です。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerGateInSlips/Unlock/{reportId} |
コンテナ貨物搬入票のロックを解除します 帳票ID(***reportId***)を指定して、コンテナ貨物搬入票のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerGateInSlips/Update/{reportId} |
コンテナ貨物搬入票を更新します。 帳票ID(***reportId***)を指定して、コンテナ貨物搬入票を更新します。 このメソッドでは、コンテナ貨物搬入票の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票について]()を参照ください。 |
|
| POST | /API/v2/Reports/ContainerGateInSlips/UpdateByPost |
コンテナ貨物搬入票を更新します。 動作は、コンテナ貨物搬入票(***/API/v2/Reports/ContainerGateInSlips/Update***)と同様です。 コンテナ貨物搬入票に関する詳細については、[コンテナ貨物搬入票]()を参照ください。 |
|
| POST | /API/v2/Reports/ContainerGateInSlips/UploadFile |
コンテナ貨物搬入票にファイルを添付します。 指定されたコンテナ貨物搬入票に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
ContainerInformationInquiries
ICN_コンテナ情報照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ContainerInformationInquiries/Create |
ICNを作成します。 ICNを作成するには、利用者がICNを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ContainerInformationInquiries/Delete/{reportId} |
ICNを削除します。 帳票ID(***reportId***)を指定して、、ICNを削除します。 ICNを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ContainerInformationInquiries/DeleteFile/{fileId} |
ICNの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、ICNの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ContainerInformationInquiries/Get/{reportId} |
ICNを取得します。 帳票ID(***reportId***)を指定して、ICN取得します。 編集が行われていない場合は、ルートドキュメントから最新のICNを取得します。 編集中の場合は、先に保存した、ICNを取得します。 |
|
| GET | /API/v2/NaccsReports/ContainerInformationInquiries/GetFile/{fileId} |
ICNに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、ICNに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ContainerInformationInquiries/Lock/{reportId} |
編集するため、ICNをロックします。 帳票ID(***reportId***)を指定して、ICNをロックします。 ICNを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、ICNを編集する場合は、このメソッドを呼び出してロックします。 ロックされたICNは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、ICNをルートドキュメントから参照できますが、編集中(ロック中)のICNは参照できません。 |
|
| POST | /API/v2/NaccsReports/ContainerInformationInquiries/SendToNaccs |
ICNをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したICNをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ICNが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ContainerInformationInquiries/SetCancel/{reportId} |
ICNの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、ICNの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ContainerInformationInquiries/Submit/{reportId} |
ICNを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したICNを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ICNが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ContainerInformationInquiries/Unlock/{reportId} |
ICNのロックを解除します。 帳票ID(***reportId***)を指定して、ICNのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ContainerInformationInquiries/Update/{reportId} |
ICNを更新します。 帳票ID(***reportId***)を指定して、ICNを更新します。 このメソッドでは、ICNの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ContainerInformationInquiries/UploadFile |
ICNにファイルを添付します。 指定されたICNに、ファイルを添付します。 |
|
ContainerInspectionTypes
コンテナ検査種別
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/ContainerInspectionTypes/DeleteAdmin/{containerInspectionTypeCode} |
コンテナ検査種別コードを削除します。 コンテナ検査種別コード(***containerInspectionTypeCode***)を指定して、コンテナ検査種別コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/ContainerInspectionTypes/Get/{containerInspectionTypeCode} |
コンテナ検査種別を取得します。 コンテナ検査種別コード(***containerInspectionTypeCode***)を指定して、コンテナ検査種別を取得します。 コンテナ検査種別コードに関する詳細については、[コンテナ検査種別コードについて]()を参照ください。 |
|
| GET | /API/v2/General/ContainerInspectionTypes/GetList |
コンテナ検査種別を全て取得します。 コンテナ検査種別コードに関する詳細については、[コンテナ検査種別コードについて]()を参照ください。 |
|
| POST | /API/v2/General/ContainerInspectionTypes/RegisterAdmin |
コンテナ検査種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/ContainerInspectionTypes/RegisterInternal |
コンテナ検査種別を登録します。 内部呼び出し用。 (*For admin) |
|
ContainerLoadPlans
コンテナ内積付書(CLP)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/ContainerLoadPlans/Create |
コンテナ内積付書(CLP)を作成します。 コンテナ内積付書(CLP)を作成するには、利用者がコンテナ内積付書(CLP)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/ContainerLoadPlans/Delete/{reportId} |
コンテナ内積付書(CLP)を削除します。 帳票ID(***reportId***)を指定して、コンテナ内積付書(CLP)を削除します。 コンテナ内積付書(CLP)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したコンテナ内積付書(CLP)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/ContainerLoadPlans/DeleteFile/{fileId} |
コンテナ内積付書(CLP)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、コンテナ内積付書(CLP)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/ContainerLoadPlans/Get/{reportId}?historyId=!{historyId} |
コンテナ内積付書(CLP)を取得します。 帳票ID(***reportId***)を指定して、コンテナ内積付書(CLP)を取得します。 編集が行われていない場合は、ルートドキュメントから最新のコンテナ内積付書(CLP)を取得します。 編集中の場合は、先に保存した、コンテナ内積付書(CLP)を取得します。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)について]()を参照ください。 |
|
| GET | /API/v2/Reports/ContainerLoadPlans/GetDiff/{reportId}?historyId=!{historyId} |
保存されているコンテナ内積付書(CLP)とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当するコンテナ内積付書(CLP)と、ルートドキュメントの差分を取得します。 比較元を保存されているコンテナ内積付書(CLP)、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/ContainerLoadPlans/GetFile/{fileId} |
コンテナ内積付書(CLP)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、コンテナ内積付書(CLP)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/ContainerLoadPlans/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
コンテナ内積付書(CLP)を全て取得します。 検索条件に該当するコンテナ内積付書(CLP)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の船積依頼書を取得します。 編集中の場合は、先に保存した、コンテナ内積付書(CLP)を取得します。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerLoadPlans/Lock/{reportId} |
編集するため、コンテナ内積付書(CLP)をロックします 帳票ID(***reportId***)を指定して、コンテナ内積付書(CLP)をロックします。 コンテナ内積付書(CLP)を作成(***Create***)した時点では、コンテナ内積付書(CLP)をロックが掛かりますが、取得(***Get***)したあとで、コンテナ内積付書(CLP)を編集する場合は、このメソッドを呼び出して、コンテナ内積付書(CLP)をロックします。 ロックされたコンテナ内積付書(CLP)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、コンテナ内積付書(CLP)をルートドキュメントから参照できますが、編集中(ロック中)のコンテナ内積付書(CLP)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerLoadPlans/SetCancel/{reportId} |
コンテナ内積付書(CLP)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、コンテナ内積付書(CLP)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerLoadPlans/Submit/{reportId} |
コンテナ内積付書(CLP)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したコンテナ内積付書(CLP)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、コンテナ内積付書(CLP)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、船積依頼書もロックされた状態のままなので、ご注意ください。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)について]()を参照ください。 |
|
| POST | /API/v2/Reports/ContainerLoadPlans/SubmitByPost |
コンテナ内積付書(CLP)を提出します。 動作は、コンテナ内積付書(CLP)(***/API/v2/Reports/ContainerLoadPlans/Update***)と同様です。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerLoadPlans/Unlock/{reportId} |
コンテナ内積付書(CLP)のロックを解除します 帳票ID(***reportId***)を指定して、コンテナ内積付書(CLP)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ContainerLoadPlans/Update/{reportId} |
コンテナ内積付書(CLP)を更新します。 帳票ID(***reportId***)を指定して、コンテナ内積付書(CLP)を更新します。 このメソッドでは、コンテナ内積付書(CLP)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)について]()を参照ください。 |
|
| POST | /API/v2/Reports/ContainerLoadPlans/UpdateByPost |
コンテナ内積付書(CLP)を更新します。 動作は、コンテナ内積付書(CLP)(***/API/v2/Reports/ContainerLoadPlans/Update***)と同様です。 コンテナ内積付書(CLP)に関する詳細については、[コンテナ内積付書(CLP)]()を参照ください。 |
|
| POST | /API/v2/Reports/ContainerLoadPlans/UploadFile |
コンテナ内積付書(CLP)にファイルを添付します。 指定されたコンテナ内積付書(CLP)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
ContainerSizeHeights
コンテナサイズ(高さ)
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/ContainerSizeHeights/DeleteAdmin/{heightCode} |
コンテナサイズ(高さ)を削除します。 コンテナサイズ(高さ)(***heightCode***)を指定して、コンテナサイズ(長さ)を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/ContainerSizeHeights/Get/{heightCode} |
コンテナサイズ(高さ)を取得します。 コンテナサイズ(高さ)(***heightCode***)を指定して、コンテナサイズ(高さ)を取得します。 コンテナタイプやサイズに関する詳細については、[コンテナタイプやサイズについて]()を参照ください。 |
|
| GET | /API/v2/General/ContainerSizeHeights/GetList |
コンテナサイズ(高さ)を取得します。 コンテナサイズ(高さ)を全て取得します。 コンテナタイプやサイズに関する詳細については、[コンテナタイプやサイズについて]()を参照ください。 |
|
| POST | /API/v2/General/ContainerSizeHeights/RegisterAdmin |
コンテナサイズ(高さ)を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/General/ContainerSizeHeights/RegisterInternal |
コンテナサイズ(高さ)を登録します。 内部呼び出し用。 (*For admin) |
|
ContainerSizeLengths
コンテナサイズ(長さ)
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/ContainerSizeLengths/DeleteAdmin/{lengthCode} |
コンテナサイズ(長さ)を削除します。 コンテナサイズ(長さ)(***lengthCode***)を指定して、コンテナサイズ(長さ)を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/ContainerSizeLengths/Get/{lengthCode} |
コンテナサイズ(長さ)を取得します。 コンテナサイズ(長さ)(***lengthCode***)を指定して、コンテナサイズ(長さ)を取得します。 コンテナタイプやサイズに関する詳細については、[コンテナタイプやサイズについて]()を参照ください。 |
|
| GET | /API/v2/General/ContainerSizeLengths/GetList |
コンテナサイズ(長さ)を取得します。 コンテナサイズ(長さ)を全て取得します。 コンテナタイプやサイズに関する詳細については、[コンテナタイプやサイズについて]()を参照ください。 |
|
| POST | /API/v2/General/ContainerSizeLengths/RegisterAdmin |
コンテナサイズ(長さ)を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/General/ContainerSizeLengths/RegisterInternal |
コンテナサイズ(長さ)を登録します。 内部呼び出し用。 (*For admin) |
|
ContainerTerminals
コンテナターミナル
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/General/ContainerTerminals/Get/{containerTerminalCode} |
コンテナターミナルコードを取得します。 コンテナターミナルコード(***containerTerminalCode***)を指定して、コンテナターミナルコード(保税地域コード)を取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
|
| GET | /API/v2/General/ContainerTerminals/GetList?containerTerminalCode=!{containerTerminalCode}&containerTerminalName=!{containerTerminalName}&userCode=!{userCode}&joinAsSea=!{joinAsSea}&joinAsAir=!{joinAsAir}&postIsCargoManage=!{postIsCargoManage}&isCompanyFacilities=!{isCompanyFacilities} |
コンテナターミナルコードを取得します。 検索条件に該当するコンテナターミナルコード(保税地域コード)を全て取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
|
ContainerTypes
コンテナタイプ
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/ContainerTypes/DeleteAdmin/{containerTypeCode} |
コンテナタイプを削除します。 コンテナタイプコード(***containerTypeCode***)を指定して、コンテナタイプを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/ContainerTypes/Get/{containerTypeCode} |
コンテナタイプを取得します。 コンテナタイプコード(***containerTypeCode***)を指定して、コンテナタイプを取得します。 コンテナタイプやサイズに関する詳細については、[コンテナタイプやサイズについて]()を参照ください。 |
|
| GET | /API/v2/General/ContainerTypes/GetList |
コンテナタイプを取得します。 コンテナタイプを全て取得します。 コンテナタイプやサイズに関する詳細については、[コンテナタイプやサイズについて]()を参照ください。 |
|
| POST | /API/v2/General/ContainerTypes/RegisterAdmin |
コンテナタイプを登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/General/ContainerTypes/RegisterInternal |
コンテナタイプを登録します。 内部呼び出し用。 (*For admin) |
|
ContractIncotermsCodes
価格条件コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/ContractIncotermsCodes/DeleteAdmin/{contractIncotermsCode} |
価格条件コードを削除します。 価格条件コード(***contractIncotermsCode***)を指定して、価格条件コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/ContractIncotermsCodes/Get/{contractIncotermsCode} |
価格条件種別を取得します。 価格条件コード(***contractIncotermsCode***)を指定して、価格条件種別を取得します。 価格条件コードに関する詳細については、[価格条件コードについて]()を参照ください。 |
|
| GET | /API/v2/General/ContractIncotermsCodes/GetList |
価格条件種別を全て取得します。 価格条件コードに関する詳細については、[価格条件コードについて]()を参照ください。 |
|
| POST | /API/v2/General/ContractIncotermsCodes/RegisterAdmin |
価格条件種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/ContractIncotermsCodes/RegisterInternal |
価格条件種別を登録します。 内部呼び出し用。 (*For admin) |
|
ConversionUnitCodeForCustoms
通関用数量換算単位コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/ConversionUnitCodeForCustoms/DeleteAdmin/{conversionUnitCode} |
通関用数量換算単位コードを削除します。 通関用数量換算単位コード(***conversionUnitCode***)を指定して、通関用数量換算単位コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/ConversionUnitCodeForCustoms/Get/{conversionUnitCode} |
通関用数量換算単位を取得します。 通関用数量換算単位コード(***conversionUnitCode***)を指定して、通関用数量換算単位を取得します。 通関用数量換算単位コードに関する詳細については、[通関用数量換算単位コードについて]()を参照ください。 |
|
| GET | /API/v2/General/ConversionUnitCodeForCustoms/GetList |
通関用数量換算単位を全て取得します。 通関用数量換算単位コードに関する詳細については、[通関用数量換算単位コードについて]()を参照ください。 |
|
| POST | /API/v2/General/ConversionUnitCodeForCustoms/RegisterAdmin |
通関用数量換算単位を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/ConversionUnitCodeForCustoms/RegisterInternal |
通関用数量換算単位を登録します。 内部呼び出し用。 (*For admin) |
|
CorporateNumberInquiries
IIE01_法人番号情報照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/CorporateNumberInquiries/Create |
IIE01を作成します。 IIE01を作成するには、利用者がIIE01を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/CorporateNumberInquiries/Delete/{reportId} |
IIE01を削除します。 帳票ID(***reportId***)を指定して、、IIE01を削除します。 IIE01を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/CorporateNumberInquiries/DeleteFile/{fileId} |
IIE01の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IIE01の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/CorporateNumberInquiries/Get/{reportId} |
IIE01を取得します。 帳票ID(***reportId***)を指定して、IIE01取得します。 編集が行われていない場合は、ルートドキュメントから最新のIIE01を取得します。 編集中の場合は、先に保存した、IIE01を取得します。 |
|
| GET | /API/v2/NaccsReports/CorporateNumberInquiries/GetFile/{fileId} |
IIE01に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IIE01に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/CorporateNumberInquiries/Lock/{reportId} |
編集するため、IIE01をロックします。 帳票ID(***reportId***)を指定して、IIE01をロックします。 IIE01を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IIE01を編集する場合は、このメソッドを呼び出してロックします。 ロックされたIIE01は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IIE01をルートドキュメントから参照できますが、編集中(ロック中)のIIE01は参照できません。 |
|
| POST | /API/v2/NaccsReports/CorporateNumberInquiries/SendToNaccs |
IIE01をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIIE01をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IIE01が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/CorporateNumberInquiries/SetCancel/{reportId} |
IIE01の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IIE01の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/CorporateNumberInquiries/Submit/{reportId} |
IIE01を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIIE01を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IIE01が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/CorporateNumberInquiries/Unlock/{reportId} |
IIE01のロックを解除します。 帳票ID(***reportId***)を指定して、IIE01のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/CorporateNumberInquiries/Update/{reportId} |
IIE01を更新します。 帳票ID(***reportId***)を指定して、IIE01を更新します。 このメソッドでは、IIE01の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/CorporateNumberInquiries/UploadFile |
IIE01にファイルを添付します。 指定されたIIE01に、ファイルを添付します。 |
|
CorrectionReasonCodes
訂正理由コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/CorrectionReasonCodes/DeleteAdmin/{correctionReasonCode} |
訂正理由コードを削除します。 訂正理由コード(***correctionReasonCode***)を指定して、訂正理由コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/CorrectionReasonCodes/Get/{correctionReasonCode} |
訂正理由を取得します。 訂正理由コード(***correctionReasonCode***)を指定して、訂正理由を取得します。 訂正理由コードに関する詳細については、[通関用数量換算単位コードについて]()を参照ください。 |
|
| GET | /API/v2/General/CorrectionReasonCodes/GetList |
訂正理由を全て取得します。 訂正理由コードに関する詳細については、[訂正理由コードについて]()を参照ください。 |
|
| POST | /API/v2/General/CorrectionReasonCodes/RegisterAdmin |
訂正理由を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/CorrectionReasonCodes/RegisterInternal |
訂正理由を登録します。 内部呼び出し用。 (*For admin) |
|
Countries
国
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/Countries/DeleteAdmin/{countryCode} |
国を削除します。 国(***countryCode***)を指定して、国を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/Countries/Get/{countryCode} |
国を取得します。 国コード(***countryCode***)を指定して、国を取得します。 |
|
| GET | /API/v2/General/Countries/GetList?countryCode=!{countryCode}&countryCodeAlfa3=!{countryCodeAlfa3}&countryCodeNumeric=!{countryCodeNumeric}&countryName=!{countryName}&countryNameEn=!{countryNameEn} |
国を取得します。 検索条件に該当する国を全て取得します。 |
|
| POST | /API/v2/General/Countries/RegisterAdmin |
国を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/General/Countries/RegisterInternal |
国を登録します。 内部呼び出し用。 (*For admin) |
|
Currencies
通貨
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/General/Currencies/Get/{currencyCode} |
通貨を取得します。 通貨コード(***currencyCode***)を指定して、国を取得します。 |
|
| GET | /API/v2/General/Currencies/GetList?currencyCode=!{currencyCode}&countryName=!{countryName}&isTaxableValueConversionRate=!{isTaxableValueConversionRate}&isExchangeRate=!{isExchangeRate} |
通貨を取得します。 検索条件に該当する通貨を全て取得します。 |
|
| POST | /API/v2/General/Currencies/RegisterInternal |
通貨を登録します。 内部呼び出し用。 (*For admin) |
|
CustomizedExcelFormats
カスタマイズしたExcelフォーマット
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Organizations/CustomizedExcelFormats/Delete/{customizedExcelFormatCode} |
カスタマイズしたExcelフォーマットを削除します。 カスタマイズしたExcelフォーマットコード(***customizedExcelFormatCode***)を指定して、カスタマイズしたExcelフォーマットを削除します。 Excelフォーマットに関する詳細については、[Excelフォーマットについて]()を参照ください。 |
|
| GET | /API/v2/Organizations/CustomizedExcelFormats/Get/{customizedExcelFormatCode} |
所属する組織が使用するカスタマイズしたExcelフォーマットを取得します。 カスタマイズしたExcelフォーマットコード(***customizedExcelFormatCode***)を指定して、所属する組織が使用するカスタマイズしたExcelフォーマットを取得します カスタマイズしたExcelフォーマットは、帳票のExcelプレビューで使用でき、そのフォーマットに従い、帳票のJSONがExcelファイルとなり、ダウンロードできます。 このAPIでは、Excelフォーマットファイル本体までは取得しません。Excelフォーマットファイル本体を取得するには、(***/API/v2/Organizations/CustomizedExcelFormats/GetFormat/{customizedExcelFormatCode}***)を使用します。 Excelフォーマットに関する詳細については、[Excelフォーマットについて]()を参照ください。 |
|
| GET | /API/v2/Organizations/CustomizedExcelFormats/GetFormat/{customizedExcelFormatCode} |
カスタマイズしたExcelフォーマットとなるファイルを取得します。 カスタマイズしたExcelフォーマットコード(***customizedExcelFormatCode***)を指定して、Excelフォーマットとなるファイルを取得します。 Excelフォーマットに関する詳細については、[Excelフォーマットについて]()を参照ください。 |
|
| GET | /API/v2/Organizations/CustomizedExcelFormats/GetList?customizedExcelFormatName=!{customizedExcelFormatName}&organizationId=!{organizationId}&tradeType=!{tradeType}&reportCode=!{reportCode} |
所属する組織が使用するカスタマイズしたExcelフォーマットを取得します。 検索条件を指定して、所属する組織が使用するカスタマイズしたExcelフォーマットを取得します カスタマイズしたExcelフォーマットは、帳票のExcelプレビューで使用でき、そのフォーマットに従い、帳票のJSONがExcelファイルとなり、ダウンロードできます。 このAPIでは、Excelフォーマットファイル本体までは取得しません。Excelフォーマットファイル本体を取得するには、(***/API/v2/Organizations/CustomizedExcelFormats/GetFormat/{customizedExcelFormatCode}***)を使用します。 Excelフォーマットに関する詳細については、[Excelフォーマットについて]()を参照ください。 |
|
| POST | /API/v2/Organizations/CustomizedExcelFormats/Register |
所属する組織が使用するカスタマイズしたExcelフォーマットを登録します。 利用者が所属する組織に、カスタマイズしたExcelフォーマットを登録します。 カスタマイズしたExcelフォーマットは、帳票のExcelプレビューで使用でき、そのフォーマットに従い、帳票のJSONがExcelファイルとなり、ダウンロードできます。 Excelフォーマットに関する詳細については、[Excelフォーマットについて]()を参照ください。 |
|
| PATCH | /API/v2/Organizations/CustomizedExcelFormats/Update/{customizedExcelFormatCode} |
カスタマイズしたExcelフォーマットを更新します。 カスタマイズしたExcelフォーマットコード(***customizedExcelFormatCode***)を指定して、カスタマイズしたExcelフォーマットを更新します。 Excelフォーマットに関する詳細については、[Excelフォーマットについて]()を参照ください。 |
|
CustomizedProcesses
カスタマイズしたプロセス
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Organizations/CustomizedProcesses/Delete/{customizedProcessCode} |
カスタマイズしたプロセスを削除します。 カスタマイズプロセスコード(***customizedProcessCode***)を指定して、カスタマイズしたプロセスを削除します。 尚、カスタマイズしたプロセスを削除しても、そのプロセスが開始している取引には影響はありませんが、プロセスの名称や説明は、カスタマイズしたプロセスの基となった標準プロセスの名称や説明が使用されます。 プロセスのカスタマイズに関する詳細については、[プロセスのカスタマイズについて]()を参照ください。 |
|
| GET | /API/v2/Organizations/CustomizedProcesses/Get/{customizedProcessCode} |
カスタマイズプロセスコードを指定して、カスタマイズしたプロセスコードを取得します。 カスタマイズプロセスコード(***customizedProcessCode***)を指定して、カスタマイズしたプロセスを取得します。 プロセスのカスタマイズに関する詳細については、[プロセスのカスタマイズについて]()を参照ください。 |
|
| GET | /API/v2/Organizations/CustomizedProcesses/GetList?processGroupCode=!{processGroupCode}&processCode=!{processCode}&customizedProcessCode=!{customizedProcessCode}&customizedProcessName=!{customizedProcessName}&customizedProcessNameEn=!{customizedProcessNameEn}&organizationId=!{organizationId}&processType=!{processType}&tradeType=!{tradeType} |
検索条件を指定して、カスタマイズしたプロセスコードを取得します。 検索条件を指定して、カスタマイズしたプロセスコードを取得します。 取引タイプ(***tradeNo***)、事業種別コード(***businessTypeCode***)、組織ID(***organizationId***)は、必須の検索条件となります。 プロセスのカスタマイズに関する詳細については、[プロセスのカスタマイズについて]()を参照ください。 |
|
| POST | /API/v2/Organizations/CustomizedProcesses/Register |
カスタマイズした標準プロセスを登録します。 指定された組織・事業種別に、そのカスタマイズした標準プロセスを登録します。 サイバーポートの標準としてのプロセス(***/API/v2/Master/StandardProcesses***)をカスタマイズし、このプロセスで必要となる項目や帳票毎に必須項目を設定します。 カスタマイズした標準プロセスでは、プロセス種別(帳票を提出するのか、帳票を受け取るのか)やプロセスで取り扱う帳票、その帳票における必須項目が設定できます。 頻繫に使用する標準プロセスをカスタマイズしたプロセスとして登録しておくと、取引でのプロセス開始時に、操作を簡略化することが可能です。 カスタマイズしたプロセスは、自社、及び、その組織・事業種別(***assignedBusinessTypeId***)でプロセス種別が選択可能なプロセスについて、登録できます。 プロセスのカスタマイズに関する詳細については、[プロセスのカスタマイズについて]()を参照ください。 |
|
| PATCH | /API/v2/Organizations/CustomizedProcesses/Update/{customizedProcessCode} |
カスタマイズしたプロセスを更新します。 カスタマイズプロセスコード(***customizedProcessCode***)を指定して、カスタマイズしたプロセスの名称や説明を更新します。 カスタマイズしたプロセスを作成し直す場合は、削除を行ってから、作成し直してください。 プロセスのカスタマイズに関する詳細については、[プロセスのカスタマイズについて]()を参照ください。 |
|
| PATCH | /API/v2/Organizations/CustomizedProcesses/UpdateDisplayOrder/{customizedProcessCode} |
カスタマイズしたプロセスの表示順を変更します。 カスタマイズプロセスコード(***customizedProcessCode***)を指定して、カスタマイズプロセスの表示順を変更します。 |
|
CustomsDutyReductionAndExemptionCodes
関税減免税コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/CustomsDutyReductionAndExemptionCodes/DeleteAdmin/{customsDutyReductionAndExemptionCode} |
関税減免税コードを削除します。 関税減免税コード(***customsDutyReductionAndExemptionCode***)を指定して、関税減免税コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/CustomsDutyReductionAndExemptionCodes/Get/{customsDutyReductionAndExemptionCode} |
関税減免税種別を取得します。 関税減免税コード(***customsDutyReductionAndExemptionCode***)を指定して、関税減免税種別を取得します。 関税減免税コードに関する詳細については、[関税減免税コードについて]()を参照ください。 |
|
| GET | /API/v2/General/CustomsDutyReductionAndExemptionCodes/GetList |
関税減免税種別を全て取得します。 関税減免税コードに関する詳細については、[関税減免税コードについて]()を参照ください。 |
|
| POST | /API/v2/General/CustomsDutyReductionAndExemptionCodes/RegisterAdmin |
関税減免税種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/CustomsDutyReductionAndExemptionCodes/RegisterInternal |
関税減免税種別を登録します。 内部呼び出し用。 (*For admin) |
|
CustomsDutyReductionAndExemptionTaxCodes
関税減免戻税コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/CustomsDutyReductionAndExemptionTaxCodes/DeleteAdmin/{customsDutyReductionAndExemptionTaxCode} |
関税減免戻税コードを削除します。 関税減免戻税コード(***customsDutyReductionAndExemptionTaxCode***)を指定して、関税減免戻税コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/CustomsDutyReductionAndExemptionTaxCodes/Get/{customsDutyReductionAndExemptionTaxCode} |
関税減免戻税種別を取得します。 関税減免戻税コード(***customsDutyReductionAndExemptionTaxCode***)を指定して、関税減免戻税種別を取得します。 関税減免戻税コードに関する詳細については、[関税減免戻税コードについて]()を参照ください。 |
|
| GET | /API/v2/General/CustomsDutyReductionAndExemptionTaxCodes/GetList |
関税減免戻税種別を全て取得します。 関税減免戻税コードに関する詳細については、[関税減免戻税コードについて]()を参照ください。 |
|
| POST | /API/v2/General/CustomsDutyReductionAndExemptionTaxCodes/RegisterAdmin |
関税減免戻税種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/CustomsDutyReductionAndExemptionTaxCodes/RegisterInternal |
関税減免戻税種別を登録します。 内部呼び出し用。 (*For admin) |
|
CustomsOfficeCodes
税関官署コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/CustomsOfficeCodes/DeleteAdmin/{customsOfficeCode} |
税関官署コードを削除します。 税関官署コード(***customsOfficeCode***)を指定して、税関官署コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/CustomsOfficeCodes/Get/{customsOfficeCode} |
税関官署を取得します。 税関官署コード(***customsOfficeCode***)を指定して、税関官署を取得します。 税関官署コードに関する詳細については、[税関官署コードについて]()を参照ください。 |
|
| GET | /API/v2/General/CustomsOfficeCodes/GetList |
税関官署を全て取得します。 税関官署コードに関する詳細については、[税関官署コードについて]()を参照ください。 |
|
| POST | /API/v2/General/CustomsOfficeCodes/RegisterAdmin |
税関官署を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/CustomsOfficeCodes/RegisterInternal |
税関官署を登録します。 内部呼び出し用。 (*For admin) |
|
CustomsTransportDeclarationCalls
OLC11_保税運送申告呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarationCalls/Create |
OLC11を作成します。 OLC11を作成するには、利用者がOLC11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/CustomsTransportDeclarationCalls/Delete/{reportId} |
OLC11を削除します。 帳票ID(***reportId***)を指定して、、OLC11を削除します。 OLC11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/CustomsTransportDeclarationCalls/DeleteFile/{fileId} |
OLC11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、OLC11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/CustomsTransportDeclarationCalls/Get/{reportId} |
OLC11を取得します。 帳票ID(***reportId***)を指定して、OLC11取得します。 編集が行われていない場合は、ルートドキュメントから最新のOLC11を取得します。 編集中の場合は、先に保存した、OLC11を取得します。 |
|
| GET | /API/v2/NaccsReports/CustomsTransportDeclarationCalls/GetFile/{fileId} |
OLC11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、OLC11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationCalls/Lock/{reportId} |
編集するため、OLC11をロックします。 帳票ID(***reportId***)を指定して、OLC11をロックします。 OLC11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、OLC11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたOLC11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、OLC11をルートドキュメントから参照できますが、編集中(ロック中)のOLC11は参照できません。 |
|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarationCalls/SendToNaccs |
OLC11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したOLC11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、OLC11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationCalls/SetCancel/{reportId} |
OLC11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、OLC11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationCalls/Submit/{reportId} |
OLC11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したOLC11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、OLC11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationCalls/Unlock/{reportId} |
OLC11のロックを解除します。 帳票ID(***reportId***)を指定して、OLC11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationCalls/Update/{reportId} |
OLC11を更新します。 帳票ID(***reportId***)を指定して、OLC11を更新します。 このメソッドでは、OLC11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarationCalls/UploadFile |
OLC11にファイルを添付します。 指定されたOLC11に、ファイルを添付します。 |
|
CustomsTransportDeclarationPreRegistereds
OLC20_保税運送申告(事項登録あり)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarationPreRegistereds/Create |
OLC20を作成します。 OLC20を作成するには、利用者がOLC20を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/CustomsTransportDeclarationPreRegistereds/Delete/{reportId} |
OLC20を削除します。 帳票ID(***reportId***)を指定して、、OLC20を削除します。 OLC20を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/CustomsTransportDeclarationPreRegistereds/DeleteFile/{fileId} |
OLC20の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、OLC20の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/CustomsTransportDeclarationPreRegistereds/Get/{reportId} |
OLC20を取得します。 帳票ID(***reportId***)を指定して、OLC20取得します。 編集が行われていない場合は、ルートドキュメントから最新のOLC20を取得します。 編集中の場合は、先に保存した、OLC20を取得します。 |
|
| GET | /API/v2/NaccsReports/CustomsTransportDeclarationPreRegistereds/GetFile/{fileId} |
OLC20に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、OLC20に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationPreRegistereds/Lock/{reportId} |
編集するため、OLC20をロックします。 帳票ID(***reportId***)を指定して、OLC20をロックします。 OLC20を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、OLC20を編集する場合は、このメソッドを呼び出してロックします。 ロックされたOLC20は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、OLC20をルートドキュメントから参照できますが、編集中(ロック中)のOLC20は参照できません。 |
|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarationPreRegistereds/SendToNaccs |
OLC20をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したOLC20をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、OLC20が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationPreRegistereds/SetCancel/{reportId} |
OLC20の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、OLC20の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationPreRegistereds/Submit/{reportId} |
OLC20を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したOLC20を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、OLC20が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarationPreRegistereds/SubmitByPost |
OLC20を提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationPreRegistereds/Unlock/{reportId} |
OLC20のロックを解除します。 帳票ID(***reportId***)を指定して、OLC20のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationPreRegistereds/Update/{reportId} |
OLC20を更新します。 帳票ID(***reportId***)を指定して、OLC20を更新します。 このメソッドでは、OLC20の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarationPreRegistereds/UpdateByPost |
OLC20を更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarationPreRegistereds/UploadFile |
OLC20にファイルを添付します。 指定されたOLC20に、ファイルを添付します。 |
|
CustomsTransportDeclarationRegistrationCalls
OLA11_保税運送申告事項登録呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrationCalls/Create |
OLA11を作成します。 OLA11を作成するには、利用者がOLA11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrationCalls/Delete/{reportId} |
OLA11を削除します。 帳票ID(***reportId***)を指定して、、OLA11を削除します。 OLA11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrationCalls/DeleteFile/{fileId} |
OLA11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、OLA11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrationCalls/Get/{reportId} |
OLA11を取得します。 帳票ID(***reportId***)を指定して、OLA11取得します。 編集が行われていない場合は、ルートドキュメントから最新のOLA11を取得します。 編集中の場合は、先に保存した、OLA11を取得します。 |
|
| GET | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrationCalls/GetFile/{fileId} |
OLA11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、OLA11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrationCalls/Lock/{reportId} |
編集するため、OLA11をロックします。 帳票ID(***reportId***)を指定して、OLA11をロックします。 OLA11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、OLA11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたOLA11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、OLA11をルートドキュメントから参照できますが、編集中(ロック中)のOLA11は参照できません。 |
|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrationCalls/SendToNaccs |
OLA11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したOLA11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、OLA11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrationCalls/SetCancel/{reportId} |
OLA11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、OLA11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrationCalls/Submit/{reportId} |
OLA11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したOLA11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、OLA11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrationCalls/Unlock/{reportId} |
OLA11のロックを解除します。 帳票ID(***reportId***)を指定して、OLA11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrationCalls/Update/{reportId} |
OLA11を更新します。 帳票ID(***reportId***)を指定して、OLA11を更新します。 このメソッドでは、OLA11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrationCalls/UploadFile |
OLA11にファイルを添付します。 指定されたOLA11に、ファイルを添付します。 |
|
CustomsTransportDeclarationRegistrations
OLA_保税運送申告事項登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrations/Create |
OLAを作成します。 OLAを作成するには、利用者がOLAを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrations/Delete/{reportId} |
OLAを削除します。 帳票ID(***reportId***)を指定して、、OLAを削除します。 OLAを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrations/DeleteFile/{fileId} |
OLAの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、OLAの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrations/Get/{reportId} |
OLAを取得します。 帳票ID(***reportId***)を指定して、OLA取得します。 編集が行われていない場合は、ルートドキュメントから最新のOLAを取得します。 編集中の場合は、先に保存した、OLAを取得します。 |
|
| GET | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrations/GetFile/{fileId} |
OLAに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、OLAに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrations/Lock/{reportId} |
編集するため、OLAをロックします。 帳票ID(***reportId***)を指定して、OLAをロックします。 OLAを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、OLAを編集する場合は、このメソッドを呼び出してロックします。 ロックされたOLAは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、OLAをルートドキュメントから参照できますが、編集中(ロック中)のOLAは参照できません。 |
|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrations/SendToNaccs |
OLAをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したOLAをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、OLAが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrations/SetCancel/{reportId} |
OLAの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、OLAの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrations/Submit/{reportId} |
OLAを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したOLAを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、OLAが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrations/SubmitByPost |
OLAを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrations/Unlock/{reportId} |
OLAのロックを解除します。 帳票ID(***reportId***)を指定して、OLAのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrations/Update/{reportId} |
OLAを更新します。 帳票ID(***reportId***)を指定して、OLAを更新します。 このメソッドでは、OLAの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrations/UpdateByPost |
OLAを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarationRegistrations/UploadFile |
OLAにファイルを添付します。 指定されたOLAに、ファイルを添付します。 |
|
CustomsTransportDeclarations
OLC_保税運送申告
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarations/Create |
OLCを作成します。 OLCを作成するには、利用者がOLCを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/CustomsTransportDeclarations/Delete/{reportId} |
OLCを削除します。 帳票ID(***reportId***)を指定して、、OLCを削除します。 OLCを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/CustomsTransportDeclarations/DeleteFile/{fileId} |
OLCの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、OLCの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/CustomsTransportDeclarations/Get/{reportId} |
OLCを取得します。 帳票ID(***reportId***)を指定して、OLC取得します。 編集が行われていない場合は、ルートドキュメントから最新のOLCを取得します。 編集中の場合は、先に保存した、OLCを取得します。 |
|
| GET | /API/v2/NaccsReports/CustomsTransportDeclarations/GetFile/{fileId} |
OLCに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、OLCに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarations/Lock/{reportId} |
編集するため、OLCをロックします。 帳票ID(***reportId***)を指定して、OLCをロックします。 OLCを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、OLCを編集する場合は、このメソッドを呼び出してロックします。 ロックされたOLCは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、OLCをルートドキュメントから参照できますが、編集中(ロック中)のOLCは参照できません。 |
|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarations/SendToNaccs |
OLCをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したOLCをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、OLCが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarations/SetCancel/{reportId} |
OLCの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、OLCの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarations/Submit/{reportId} |
OLCを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したOLCを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、OLCが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarations/SubmitByPost |
OLCを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarations/Unlock/{reportId} |
OLCのロックを解除します。 帳票ID(***reportId***)を指定して、OLCのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/CustomsTransportDeclarations/Update/{reportId} |
OLCを更新します。 帳票ID(***reportId***)を指定して、OLCを更新します。 このメソッドでは、OLCの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarations/UpdateByPost |
OLCを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/CustomsTransportDeclarations/UploadFile |
OLCにファイルを添付します。 指定されたOLCに、ファイルを添付します。 |
|
CyDeliveryConfirmations
CYA_CY搬入確認登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/CyDeliveryConfirmations/Create |
CYAを作成します。 CYAを作成するには、利用者がCYAを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/CyDeliveryConfirmations/Delete/{reportId} |
CYAを削除します。 帳票ID(***reportId***)を指定して、、CYAを削除します。 CYAを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/CyDeliveryConfirmations/DeleteFile/{fileId} |
CYAの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、CYAの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/CyDeliveryConfirmations/Get/{reportId} |
CYAを取得します。 帳票ID(***reportId***)を指定して、CYA取得します。 編集が行われていない場合は、ルートドキュメントから最新のCYAを取得します。 編集中の場合は、先に保存した、CYAを取得します。 |
|
| GET | /API/v2/NaccsReports/CyDeliveryConfirmations/GetFile/{fileId} |
CYAに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、CYAに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/CyDeliveryConfirmations/Lock/{reportId} |
編集するため、CYAをロックします。 帳票ID(***reportId***)を指定して、CYAをロックします。 CYAを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、CYAを編集する場合は、このメソッドを呼び出してロックします。 ロックされたCYAは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、CYAをルートドキュメントから参照できますが、編集中(ロック中)のCYAは参照できません。 |
|
| POST | /API/v2/NaccsReports/CyDeliveryConfirmations/SendToNaccs |
CYAをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したCYAをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、CYAが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/CyDeliveryConfirmations/SetCancel/{reportId} |
CYAの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、CYAの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/CyDeliveryConfirmations/Submit/{reportId} |
CYAを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したCYAを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、CYAが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/CyDeliveryConfirmations/SubmitByPost |
CYAを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/CyDeliveryConfirmations/Unlock/{reportId} |
CYAのロックを解除します。 帳票ID(***reportId***)を指定して、CYAのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/CyDeliveryConfirmations/Update/{reportId} |
CYAを更新します。 帳票ID(***reportId***)を指定して、CYAを更新します。 このメソッドでは、CYAの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/CyDeliveryConfirmations/UpdateByPost |
CYAを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/CyDeliveryConfirmations/UploadFile |
CYAにファイルを添付します。 指定されたCYAに、ファイルを添付します。 |
|
CyDeliveryDataRegistrationCalls
CYH11_CY搬入情報登録呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/CyDeliveryDataRegistrationCalls/Create |
CYH11を作成します。 CYH11を作成するには、利用者がCYH11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/CyDeliveryDataRegistrationCalls/Delete/{reportId} |
CYH11を削除します。 帳票ID(***reportId***)を指定して、、CYH11を削除します。 CYH11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/CyDeliveryDataRegistrationCalls/DeleteFile/{fileId} |
CYH11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、CYH11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/CyDeliveryDataRegistrationCalls/Get/{reportId} |
CYH11を取得します。 帳票ID(***reportId***)を指定して、CYH11取得します。 編集が行われていない場合は、ルートドキュメントから最新のCYH11を取得します。 編集中の場合は、先に保存した、CYH11を取得します。 |
|
| GET | /API/v2/NaccsReports/CyDeliveryDataRegistrationCalls/GetFile/{fileId} |
CYH11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、CYH11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/CyDeliveryDataRegistrationCalls/Lock/{reportId} |
編集するため、CYH11をロックします。 帳票ID(***reportId***)を指定して、CYH11をロックします。 CYH11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、CYH11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたCYH11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、CYH11をルートドキュメントから参照できますが、編集中(ロック中)のCYH11は参照できません。 |
|
| POST | /API/v2/NaccsReports/CyDeliveryDataRegistrationCalls/SendToNaccs |
CYH11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したCYH11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、CYH11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/CyDeliveryDataRegistrationCalls/SetCancel/{reportId} |
CYH11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、CYH11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/CyDeliveryDataRegistrationCalls/Submit/{reportId} |
CYH11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したCYH11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、CYH11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/CyDeliveryDataRegistrationCalls/Unlock/{reportId} |
CYH11のロックを解除します。 帳票ID(***reportId***)を指定して、CYH11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/CyDeliveryDataRegistrationCalls/Update/{reportId} |
CYH11を更新します。 帳票ID(***reportId***)を指定して、CYH11を更新します。 このメソッドでは、CYH11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/CyDeliveryDataRegistrationCalls/UploadFile |
CYH11にファイルを添付します。 指定されたCYH11に、ファイルを添付します。 |
|
CyDeliveryDataRegistrations
CYH_CY搬入情報登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/CyDeliveryDataRegistrations/Create |
CYHを作成します。 CYHを作成するには、利用者がCYHを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/CyDeliveryDataRegistrations/Delete/{reportId} |
CYHを削除します。 帳票ID(***reportId***)を指定して、、CYHを削除します。 CYHを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/CyDeliveryDataRegistrations/DeleteFile/{fileId} |
CYHの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、CYHの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/CyDeliveryDataRegistrations/Get/{reportId} |
CYHを取得します。 帳票ID(***reportId***)を指定して、CYH取得します。 編集が行われていない場合は、ルートドキュメントから最新のCYHを取得します。 編集中の場合は、先に保存した、CYHを取得します。 |
|
| GET | /API/v2/NaccsReports/CyDeliveryDataRegistrations/GetFile/{fileId} |
CYHに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、CYHに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/CyDeliveryDataRegistrations/Lock/{reportId} |
編集するため、CYHをロックします。 帳票ID(***reportId***)を指定して、CYHをロックします。 CYHを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、CYHを編集する場合は、このメソッドを呼び出してロックします。 ロックされたCYHは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、CYHをルートドキュメントから参照できますが、編集中(ロック中)のCYHは参照できません。 |
|
| POST | /API/v2/NaccsReports/CyDeliveryDataRegistrations/SendToNaccs |
CYHをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したCYHをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、CYHが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/CyDeliveryDataRegistrations/SetCancel/{reportId} |
CYHの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、CYHの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/CyDeliveryDataRegistrations/Submit/{reportId} |
CYHを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したCYHを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、CYHが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/CyDeliveryDataRegistrations/SubmitByPost |
CYHを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/CyDeliveryDataRegistrations/Unlock/{reportId} |
CYHのロックを解除します。 帳票ID(***reportId***)を指定して、CYHのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/CyDeliveryDataRegistrations/Update/{reportId} |
CYHを更新します。 帳票ID(***reportId***)を指定して、CYHを更新します。 このメソッドでは、CYHの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/CyDeliveryDataRegistrations/UpdateByPost |
CYHを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/CyDeliveryDataRegistrations/UploadFile |
CYHにファイルを添付します。 指定されたCYHに、ファイルを添付します。 |
|
CyDispatchConfirmRegistrations
CYO_CY搬出確認登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/CyDispatchConfirmRegistrations/Create |
CYOを作成します。 CYOを作成するには、利用者がCYOを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/CyDispatchConfirmRegistrations/Delete/{reportId} |
CYOを削除します。 帳票ID(***reportId***)を指定して、、CYOを削除します。 CYOを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/CyDispatchConfirmRegistrations/DeleteFile/{fileId} |
CYOの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、CYOの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/CyDispatchConfirmRegistrations/Get/{reportId} |
CYOを取得します。 帳票ID(***reportId***)を指定して、CYO取得します。 編集が行われていない場合は、ルートドキュメントから最新のCYOを取得します。 編集中の場合は、先に保存した、CYOを取得します。 |
|
| GET | /API/v2/NaccsReports/CyDispatchConfirmRegistrations/GetFile/{fileId} |
CYOに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、CYOに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/CyDispatchConfirmRegistrations/Lock/{reportId} |
編集するため、CYOをロックします。 帳票ID(***reportId***)を指定して、CYOをロックします。 CYOを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、CYOを編集する場合は、このメソッドを呼び出してロックします。 ロックされたCYOは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、CYOをルートドキュメントから参照できますが、編集中(ロック中)のCYOは参照できません。 |
|
| POST | /API/v2/NaccsReports/CyDispatchConfirmRegistrations/SendToNaccs |
CYOをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したCYOをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、CYOが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/CyDispatchConfirmRegistrations/SetCancel/{reportId} |
CYOの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、CYOの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/CyDispatchConfirmRegistrations/Submit/{reportId} |
CYOを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したCYOを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、CYOが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/CyDispatchConfirmRegistrations/SubmitByPost |
CYOを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/CyDispatchConfirmRegistrations/Unlock/{reportId} |
CYOのロックを解除します。 帳票ID(***reportId***)を指定して、CYOのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/CyDispatchConfirmRegistrations/Update/{reportId} |
CYOを更新します。 帳票ID(***reportId***)を指定して、CYOを更新します。 このメソッドでは、CYOの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/CyDispatchConfirmRegistrations/UpdateByPost |
CYOを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/CyDispatchConfirmRegistrations/UploadFile |
CYOにファイルを添付します。 指定されたCYOに、ファイルを添付します。 |
|
CyDispatchOrders
コンテナ貨物搬出票
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/CyDispatchOrders/Create |
コンテナ貨物搬出票を作成します。 コンテナ貨物搬出票を作成するには、利用者がコンテナ貨物搬出票を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/CyDispatchOrders/Delete/{reportId} |
コンテナ貨物搬出票を削除します。 帳票ID(***reportId***)を指定して、コンテナ貨物搬出票を削除します。 コンテナ貨物搬出票を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したコンテナ貨物搬入票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/CyDispatchOrders/DeleteFile/{fileId} |
コンテナ貨物搬出票の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、コンテナ貨物搬出票の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/CyDispatchOrders/Get/{reportId}?historyId=!{historyId} |
コンテナ貨物搬出票を取得します。 帳票ID(***reportId***)を指定して、コンテナ貨物搬出票を取得します。 編集が行われていない場合は、ルートドキュメントから最新のコンテナ貨物搬出票を取得します。 編集中の場合は、先に保存した、コンテナ貨物搬出票を取得します。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票について]()を参照ください。 |
|
| GET | /API/v2/Reports/CyDispatchOrders/GetDiff/{reportId}?historyId=!{historyId} |
保存されているコンテナ貨物搬出票とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当するコンテナ貨物搬出票と、ルートドキュメントの差分を取得します。 比較元を保存されているコンテナ貨物搬出票、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/CyDispatchOrders/GetFile/{fileId} |
コンテナ貨物搬出票に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、コンテナ貨物搬出票に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/CyDispatchOrders/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
コンテナ貨物搬出票を全て取得します。 検索条件に該当するコンテナ貨物搬出票を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のコンテナ貨物搬出票を取得します。 編集中の場合は、先に保存した、コンテナ貨物搬出票を取得します。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CyDispatchOrders/Lock/{reportId} |
編集するため、コンテナ貨物搬出票をロックします 帳票ID(***reportId***)を指定して、コンテナ貨物搬出票をロックします。 コンテナ貨物搬出票を作成(***Create***)した時点では、コンテナ貨物搬出票をロックが掛かりますが、取得(***Get***)したあとで、コンテナ貨物搬出票を編集する場合は、このメソッドを呼び出して、コンテナ貨物搬出票をロックします。 ロックされたコンテナ貨物搬出票は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、コンテナ貨物搬出票をルートドキュメントから参照できますが、編集中(ロック中)のコンテナ貨物搬出票は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CyDispatchOrders/SetCancel/{reportId} |
コンテナ貨物搬出票の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、コンテナ貨物搬出票の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CyDispatchOrders/Submit/{reportId} |
コンテナ貨物搬出票を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したコンテナ貨物搬出票を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、コンテナ貨物搬出票が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、コンテナ貨物搬入票もロックされた状態のままなので、ご注意ください。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票について]()を参照ください。 |
|
| POST | /API/v2/Reports/CyDispatchOrders/SubmitByPost |
コンテナ貨物搬出票を更新します。 動作は、コンテナ貨物搬出票(***/API/v2/Reports/CyDispatchOrders/Update***)と同様です。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CyDispatchOrders/Unlock/{reportId} |
コンテナ貨物搬出票のロックを解除します 帳票ID(***reportId***)を指定して、コンテナ貨物搬出票のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/CyDispatchOrders/Update/{reportId} |
コンテナ貨物搬出票を更新します。 帳票ID(***reportId***)を指定して、コンテナ貨物搬出票を更新します。 このメソッドでは、コンテナ貨物搬出票の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票について]()を参照ください。 |
|
| POST | /API/v2/Reports/CyDispatchOrders/UpdateByPost |
コンテナ貨物搬出票を更新します。 動作は、コンテナ貨物搬出票(***/API/v2/Reports/CyDispatchOrders/Update***)と同様です。 コンテナ貨物搬出票に関する詳細については、[コンテナ貨物搬出票]()を参照ください。 |
|
| POST | /API/v2/Reports/CyDispatchOrders/UploadFile |
コンテナ貨物搬入票にファイルを添付します。 指定されたコンテナ貨物搬入票に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
DangerousGoodsAdvanceNotices
危険物又は有害物事前連絡表
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/DangerousGoodsAdvanceNotices/Create |
危険物又は有害物事前連絡表を作成します。 危険物又は有害物事前連絡表を作成するには、利用者が危険物又は有害物事前連絡表を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 危険物又は有害物事前連絡表に関する詳細については、[危険物又は有害物事前連絡表について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DangerousGoodsAdvanceNotices/Delete/{reportId} |
危険物又は有害物事前連絡表を削除します。 帳票ID(***reportId***)を指定して、危険物又は有害物事前連絡表を削除します。 危険物又は有害物事前連絡表を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した危険物又は有害物事前連絡表のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 危険物又は有害物事前連絡表に関する詳細については、[危険物又は有害物事前連絡表について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DangerousGoodsAdvanceNotices/DeleteFile/{fileId} |
危険物又は有害物事前連絡表の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、危険物又は有害物事前連絡表の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DangerousGoodsAdvanceNotices/Get/{reportId}?historyId=!{historyId} |
危険物又は有害物事前連絡表を取得します。 帳票ID(***reportId***)を指定して、危険物又は有害物事前連絡表を取得します。 編集が行われていない場合は、ルートドキュメントから最新のブッキング依頼書を取得します。 編集中の場合は、先に保存した、危険物又は有害物事前連絡表を取得します。 危険物又は有害物事前連絡表に関する詳細については、[危険物又は有害物事前連絡表について]()を参照ください。 |
|
| GET | /API/v2/Reports/DangerousGoodsAdvanceNotices/GetDiff/{reportId}?historyId=!{historyId} |
保存されている危険物又は有害物事前連絡表とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する危険物又は有害物事前連絡表と、ルートドキュメントの差分を取得します。 比較元を保存されている危険物又は有害物事前連絡表、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/DangerousGoodsAdvanceNotices/GetFile/{fileId} |
危険物又は有害物事前連絡表に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、危険物又は有害物事前連絡表に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DangerousGoodsAdvanceNotices/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
危険物又は有害物事前連絡表を全て取得します。 検索条件に該当する危険物又は有害物事前連絡表を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の危険物明細書を取得します。 編集中の場合は、先に保存した、危険物又は有害物事前連絡表を取得します。 危険物又は有害物事前連絡表に関する詳細については、[危険物又は有害物事前連絡表について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DangerousGoodsAdvanceNotices/Lock/{reportId} |
編集するため、危険物又は有害物事前連絡表をロックします 帳票ID(***reportId***)を指定して、危険物又は有害物事前連絡表をロックします。 危険物又は有害物事前連絡表を作成(***Create***)した時点では、危険物又は有害物事前連絡表をロックが掛かりますが、取得(***Get***)したあとで、危険物又は有害物事前連絡表を編集する場合は、このメソッドを呼び出して、危険物又は有害物事前連絡表をロックします。 ロックされた危険物又は有害物事前連絡表は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、危険物又は有害物事前連絡表をルートドキュメントから参照できますが、編集中(ロック中)の危険物又は有害物事前連絡表は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 危険物又は有害物事前連絡表に関する詳細については、[危険物又は有害物事前連絡表について]()を参照ください。 |
|
| GET | /API/v2/Reports/DangerousGoodsAdvanceNotices/Search?tradeNo=!{tradeNo}&tradeType=!{tradeType}&tradeName=!{tradeName}&uniqueNo=!{uniqueNo}&parentTradeNo=!{parentTradeNo}&organizationIdAsOwner=!{organizationIdAsOwner}&organizationIdAsPartnerList=!{organizationIdAsPartnerList}&tradeStatus=!{tradeStatus}&createdAtFrom=!{createdAtFrom}&createdAtTo=!{createdAtTo}&createdAtRange=!{createdAtRange}&createdAtRangeUnit=!{createdAtRangeUnit}&updatedAtFrom=!{updatedAtFrom}&updatedAtTo=!{updatedAtTo}&updatedAtRange=!{updatedAtRange}&updatedAtRangeUnit=!{updatedAtRangeUnit}&dealerCompanyName=!{dealerCompanyName}&advanceNoticeNo=!{advanceNoticeNo}&advanceNoticeStatus=!{advanceNoticeStatus}&submissionDateFrom=!{submissionDateFrom}&submissionDateTo=!{submissionDateTo}&submissionDateRange=!{submissionDateRange}&submissionDateRangeUnit=!{submissionDateRangeUnit}&estimatedDeliveryDateFrom=!{estimatedDeliveryDateFrom}&estimatedDeliveryDateTo=!{estimatedDeliveryDateTo}&estimatedDeliveryDateRange=!{estimatedDeliveryDateRange}&estimatedDeliveryDateRangeUnit=!{estimatedDeliveryDateRangeUnit} |
危険物又は有害物事前連絡表。 検索条件に該当する、利用者が所属する組織が参加している取引の危険物又は有害物事前連絡表を全て取得します。 |
|
| GET | /API/v2/Reports/DangerousGoodsAdvanceNotices/SearchInternal?tradeNo=!{tradeNo}&tradeType=!{tradeType}&tradeName=!{tradeName}&uniqueNo=!{uniqueNo}&parentTradeNo=!{parentTradeNo}&organizationIdAsOwner=!{organizationIdAsOwner}&organizationIdAsPartnerList=!{organizationIdAsPartnerList}&tradeStatus=!{tradeStatus}&createdAtFrom=!{createdAtFrom}&createdAtTo=!{createdAtTo}&createdAtRange=!{createdAtRange}&createdAtRangeUnit=!{createdAtRangeUnit}&updatedAtFrom=!{updatedAtFrom}&updatedAtTo=!{updatedAtTo}&updatedAtRange=!{updatedAtRange}&updatedAtRangeUnit=!{updatedAtRangeUnit}&dealerCompanyName=!{dealerCompanyName}&advanceNoticeNo=!{advanceNoticeNo}&advanceNoticeStatus=!{advanceNoticeStatus}&submissionDateFrom=!{submissionDateFrom}&submissionDateTo=!{submissionDateTo}&submissionDateRange=!{submissionDateRange}&submissionDateRangeUnit=!{submissionDateRangeUnit}&estimatedDeliveryDateFrom=!{estimatedDeliveryDateFrom}&estimatedDeliveryDateTo=!{estimatedDeliveryDateTo}&estimatedDeliveryDateRange=!{estimatedDeliveryDateRange}&estimatedDeliveryDateRangeUnit=!{estimatedDeliveryDateRangeUnit}&openId=!{openId} |
危険物又は有害物事前連絡表。 検索条件に該当する、利用者が所属する組織が参加している取引の危険物又は有害物事前連絡表を全て取得します。 内部呼び出し用。 |
|
| PATCH | /API/v2/Reports/DangerousGoodsAdvanceNotices/SetCancel/{reportId} |
危険物又は有害物事前連絡表の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、危険物又は有害物事前連絡表の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 危険物又は有害物事前連絡表に関する詳細については、[危険物又は有害物事前連絡表について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DangerousGoodsAdvanceNotices/Submit/{reportId} |
危険物又は有害物事前連絡表を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したブッキング依頼書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、危険物又は有害物事前連絡表が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ブッキング依頼書もロックされた状態のままなので、ご注意ください。 危険物又は有害物事前連絡表に関する詳細については、[危険物又は有害物事前連絡表について]()を参照ください。 |
|
| POST | /API/v2/Reports/DangerousGoodsAdvanceNotices/SubmitByPost |
危険物又は有害物事前連絡表を提出します 動作は、危険物又は有害物事前連絡表の提出(***/API/v2/Reports/DangerousGoodsAdvanceNotices/Submit***)と同様です。 危険物又は有害物事前連絡表に関する詳細については、[危険物又は有害物事前連絡表について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DangerousGoodsAdvanceNotices/Unlock/{reportId} |
危険物又は有害物事前連絡表のロックを解除します 帳票ID(***reportId***)を指定して、危険物又は有害物事前連絡表のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 危険物又は有害物事前連絡表に関する詳細については、[危険物又は有害物事前連絡表について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DangerousGoodsAdvanceNotices/Update/{reportId} |
危険物又は有害物事前連絡表を更新します。 帳票ID(***reportId***)を指定して、危険物又は有害物事前連絡表を更新します。 このメソッドでは、危険物又は有害物事前連絡表の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 危険物又は有害物事前連絡表に関する詳細については、[危険物又は有害物事前連絡表について]()を参照ください。 |
|
| POST | /API/v2/Reports/DangerousGoodsAdvanceNotices/UpdateByPost |
危険物又は有害物事前連絡表を更新します。 動作は、危険物又は有害物事前連絡表の更新(***/API/v2/Reports/DangerousGoodsAdvanceNotices/Update***)と同様です。 危険物又は有害物事前連絡表に関する詳細については、[危険物又は有害物事前連絡表について]()を参照ください。 |
|
| POST | /API/v2/Reports/DangerousGoodsAdvanceNotices/UploadFile |
危険物又は有害物事前連絡表にファイルを添付します。 指定された危険物又は有害物事前連絡表に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
DangerousGoodsCargoListCalls
DLR11_危険物積荷一覧情報呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DangerousGoodsCargoListCalls/Create |
DLR11を作成します。 DLR11を作成するには、利用者がDLR11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsCargoListCalls/Delete/{reportId} |
DLR11を削除します。 帳票ID(***reportId***)を指定して、、DLR11を削除します。 DLR11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsCargoListCalls/DeleteFile/{fileId} |
DLR11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、DLR11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsCargoListCalls/Get/{reportId} |
DLR11を取得します。 帳票ID(***reportId***)を指定して、DLR11取得します。 編集が行われていない場合は、ルートドキュメントから最新のDLR11を取得します。 編集中の場合は、先に保存した、DLR11を取得します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsCargoListCalls/GetFile/{fileId} |
DLR11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、DLR11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsCargoListCalls/Lock/{reportId} |
編集するため、DLR11をロックします。 帳票ID(***reportId***)を指定して、DLR11をロックします。 DLR11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、DLR11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたDLR11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、DLR11をルートドキュメントから参照できますが、編集中(ロック中)のDLR11は参照できません。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsCargoListCalls/SendToNaccs |
DLR11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したDLR11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DLR11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsCargoListCalls/SetCancel/{reportId} |
DLR11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、DLR11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsCargoListCalls/Submit/{reportId} |
DLR11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したDLR11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DLR11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsCargoListCalls/SubmitByPost |
DLR11を提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsCargoListCalls/Unlock/{reportId} |
DLR11のロックを解除します。 帳票ID(***reportId***)を指定して、DLR11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsCargoListCalls/Update/{reportId} |
DLR11を更新します。 帳票ID(***reportId***)を指定して、DLR11を更新します。 このメソッドでは、DLR11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsCargoListCalls/UpdateByPost |
DLR11を更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsCargoListCalls/UploadFile |
DLR11にファイルを添付します。 指定されたDLR11に、ファイルを添付します。 |
|
DangerousGoodsCargoLists
DLR_危険物積荷一覧情報出力
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DangerousGoodsCargoLists/Create |
DLRを作成します。 DLRを作成するには、利用者がDLRを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsCargoLists/Delete/{reportId} |
DLRを削除します。 帳票ID(***reportId***)を指定して、、DLRを削除します。 DLRを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsCargoLists/DeleteFile/{fileId} |
DLRの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、DLRの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsCargoLists/Get/{reportId} |
DLRを取得します。 帳票ID(***reportId***)を指定して、DLR取得します。 編集が行われていない場合は、ルートドキュメントから最新のDLRを取得します。 編集中の場合は、先に保存した、DLRを取得します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsCargoLists/GetFile/{fileId} |
DLRに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、DLRに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsCargoLists/Lock/{reportId} |
編集するため、DLRをロックします。 帳票ID(***reportId***)を指定して、DLRをロックします。 DLRを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、DLRを編集する場合は、このメソッドを呼び出してロックします。 ロックされたDLRは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、DLRをルートドキュメントから参照できますが、編集中(ロック中)のDLRは参照できません。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsCargoLists/SendToNaccs |
DLRをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したDLRをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DLRが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsCargoLists/SetCancel/{reportId} |
DLRの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、DLRの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsCargoLists/Submit/{reportId} |
DLRを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したDLRを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DLRが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsCargoLists/SubmitByPost |
DLRを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsCargoLists/Unlock/{reportId} |
DLRのロックを解除します。 帳票ID(***reportId***)を指定して、DLRのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsCargoLists/Update/{reportId} |
DLRを更新します。 帳票ID(***reportId***)を指定して、DLRを更新します。 このメソッドでは、DLRの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsCargoLists/UpdateByPost |
DLRを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsCargoLists/UploadFile |
DLRにファイルを添付します。 指定されたDLRに、ファイルを添付します。 |
|
DangerousGoodsDescriptionAndAdvanceNoticeCommons
危険物共通帳票
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/Create |
危険物共通帳票を作成します。 危険物共通帳票を作成するには、利用者が危険物又は有害物事前連絡表を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 危険物共通帳票に関する詳細については、[危険物共通帳票について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/Delete/{reportId} |
危険物共通帳票を削除します。 帳票ID(***reportId***)を指定して、危険物共通帳票を削除します。 危険物共通帳票を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した危険物共通帳票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 危険物共通帳票に関する詳細については、[危険物共通帳票について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/DeleteFile/{fileId} |
危険物共通帳票の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、危険物共通帳票の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/Get/{reportId}?historyId=!{historyId} |
危険物共通帳票を取得します。 帳票ID(***reportId***)を指定して、危険物共通帳票を取得します。 編集が行われていない場合は、ルートドキュメントから最新のブッキング依頼書を取得します。 編集中の場合は、先に保存した、危険物共通帳票を取得します。 危険物共通帳票に関する詳細については、[危険物共通帳票について]()を参照ください。 |
|
| GET | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/GetDiff/{reportId}?historyId=!{historyId} |
保存されている危険物共通帳票とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する危険物共通帳票と、ルートドキュメントの差分を取得します。 比較元を保存されている危険物共通帳票、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/GetFile/{fileId} |
危険物共通帳票に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、危険物共通帳票に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
危険物共通帳票を全て取得します。 検索条件に該当する危険物共通帳票を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の危険物明細書・危険物又は有害物事前連絡表 共通帳票を取得します。 編集中の場合は、先に保存した、危険物明細書・危険物又は有害物事前連絡表 共通帳票を取得します。 危険物明細書・危険物又は有害物事前連絡表 共通帳票に関する詳細については、[危険物明細書・危険物又は有害物事前連絡表 共通帳票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/Lock/{reportId} |
編集するため、危険物共通帳票をロックします 帳票ID(***reportId***)を指定して、危険物共通帳票をロックします。 危険物共通帳票を作成(***Create***)した時点では、危険物共通帳票をロックが掛かりますが、取得(***Get***)したあとで、危険物共通帳票を編集する場合は、このメソッドを呼び出して、危険物共通帳票をロックします。 ロックされた危険物共通帳票は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、危険物共通帳票をルートドキュメントから参照できますが、編集中(ロック中)の危険物共通帳票は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 危険物又は有害物事前連絡票に関する詳細については、[危険物又は有害物事前連絡票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/SetCancel/{reportId} |
危険物共通帳票の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、危険物共通帳票の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 危険物共通帳票に関する詳細については、[危険物共通帳票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/Submit/{reportId} |
危険物共通帳票を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した危険物共通帳票を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、危険物共通帳票が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、危険物共通帳票もロックされた状態のままなので、ご注意ください。 危険物共通帳票に関する詳細については、[危険物共通帳票について]()を参照ください。 |
|
| POST | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/SubmitByPost |
危険物共通帳票を提出します 動作は、危険物共通帳票の提出(***/API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/Submit***)と同様です。 危険物共通帳票に関する詳細については、[危険物共通帳票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/Unlock/{reportId} |
危険物共通帳票のロックを解除します 帳票ID(***reportId***)を指定して、危険物共通帳票のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 危険物共通帳票に関する詳細については、[危険物共通帳票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/Update/{reportId} |
危険物共通帳票を更新します。 帳票ID(***reportId***)を指定して、危険物共通帳票を更新します。 このメソッドでは、危険物共通帳票の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 危険物共通帳票に関する詳細については、[危険物共通帳票について]()を参照ください。 |
|
| POST | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/UpdateByPost |
危険物共通帳票を更新します。 動作は、危険物共通帳票の更新(***/API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/Update***)と同様です。 危険物共通帳票に関する詳細については、[危険物共通帳票について]()を参照ください。 |
|
| POST | /API/v2/Reports/DangerousGoodsDescriptionAndAdvanceNoticeCommons/UploadFile |
危険物共通帳票にファイルを添付します。 指定された危険物共通帳票に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
DangerousGoodsDescriptions
危険物明細書
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/DangerousGoodsDescriptions/Create |
危険物明細書を作成します。 危険物明細書を作成するには、利用者が危険物明細書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DangerousGoodsDescriptions/Delete/{reportId} |
危険物明細書を削除します。 帳票ID(***reportId***)を指定して、危険物明細書を削除します。 危険物明細書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した危険物明細書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DangerousGoodsDescriptions/DeleteFile/{fileId} |
危険物明細書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、危険物明細書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DangerousGoodsDescriptions/Get/{reportId}?historyId=!{historyId} |
危険物明細書を取得します。 帳票ID(***reportId***)を指定して、危険物明細書を取得します。 編集が行われていない場合は、ルートドキュメントから最新のブッキング依頼書を取得します。 編集中の場合は、先に保存した、危険物明細書を取得します。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
| GET | /API/v2/Reports/DangerousGoodsDescriptions/GetDiff/{reportId}?historyId=!{historyId} |
保存されている危険物明細書とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する危険物明細書と、ルートドキュメントの差分を取得します。 比較元を保存されている危険物明細書、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/DangerousGoodsDescriptions/GetFile/{fileId} |
危険物明細書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、危険物明細書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DangerousGoodsDescriptions/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
危険物明細書を全て取得します。 検索条件に該当する危険物明細書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の危険物明細書を取得します。 編集中の場合は、先に保存した、危険物明細書を取得します。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DangerousGoodsDescriptions/Lock/{reportId} |
編集するため、危険物明細書をロックします 帳票ID(***reportId***)を指定して、危険物明細書をロックします。 危険物明細書を作成(***Create***)した時点では、危険物明細書をロックが掛かりますが、取得(***Get***)したあとで、危険物明細書を編集する場合は、このメソッドを呼び出して、ブッキング依頼書をロックします。 ロックされた危険物明細書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、危険物明細書をルートドキュメントから参照できますが、編集中(ロック中)の危険物明細書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DangerousGoodsDescriptions/SetCancel/{reportId} |
危険物明細書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、危険物明細書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DangerousGoodsDescriptions/Submit/{reportId} |
危険物明細書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したブッキング依頼書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、危険物明細書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ブッキング依頼書もロックされた状態のままなので、ご注意ください。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
| POST | /API/v2/Reports/DangerousGoodsDescriptions/SubmitByPost |
危険物明細書を提出します 動作は、危険物明細書の提出(***/API/v2/Reports/DangerousGoodsDescriptions/Submit***)と同様です。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DangerousGoodsDescriptions/Unlock/{reportId} |
危険物明細書のロックを解除します 帳票ID(***reportId***)を指定して、危険物明細書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DangerousGoodsDescriptions/Update/{reportId} |
危険物明細書を更新します。 帳票ID(***reportId***)を指定して、危険物明細書を更新します。 このメソッドでは、危険物明細書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
| POST | /API/v2/Reports/DangerousGoodsDescriptions/UpdateByPost |
危険物明細書を更新します。 動作は、危険物明細書の更新(***/API/v2/Reports/DangerousGoodsDescriptions/Update***)と同様です。 危険物明細書に関する詳細については、[危険物明細書について]()を参照ください。 |
|
| POST | /API/v2/Reports/DangerousGoodsDescriptions/UploadFile |
危険物明細書にファイルを添付します。 指定された危険物明細書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
DangerousGoodsDetailsConfirmCalls
DDC11_危険物明細情報確認呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsConfirmCalls/Create |
DDC11を作成します。 DDC11を作成するには、利用者がDDC11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsDetailsConfirmCalls/Delete/{reportId} |
DDC11を削除します。 帳票ID(***reportId***)を指定して、、DDC11を削除します。 DDC11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsDetailsConfirmCalls/DeleteFile/{fileId} |
DDC11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、DDC11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsDetailsConfirmCalls/Get/{reportId} |
DDC11を取得します。 帳票ID(***reportId***)を指定して、DDC11取得します。 編集が行われていない場合は、ルートドキュメントから最新のDDC11を取得します。 編集中の場合は、先に保存した、DDC11を取得します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsDetailsConfirmCalls/GetFile/{fileId} |
DDC11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、DDC11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsConfirmCalls/Lock/{reportId} |
編集するため、DDC11をロックします。 帳票ID(***reportId***)を指定して、DDC11をロックします。 DDC11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、DDC11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたDDC11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、DDC11をルートドキュメントから参照できますが、編集中(ロック中)のDDC11は参照できません。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsConfirmCalls/SendToNaccs |
DDC11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したDDC11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DDC11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsConfirmCalls/SetCancel/{reportId} |
DDC11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、DDC11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsConfirmCalls/Submit/{reportId} |
DDC11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したDDC11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DDC11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsConfirmCalls/Unlock/{reportId} |
DDC11のロックを解除します。 帳票ID(***reportId***)を指定して、DDC11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsConfirmCalls/Update/{reportId} |
DDC11を更新します。 帳票ID(***reportId***)を指定して、DDC11を更新します。 このメソッドでは、DDC11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsConfirmCalls/UploadFile |
DDC11にファイルを添付します。 指定されたDDC11に、ファイルを添付します。 |
|
DangerousGoodsDetailsConfirms
DDC_危険物明細情報確認
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsConfirms/Create |
DDCを作成します。 DDCを作成するには、利用者がDDCを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsDetailsConfirms/Delete/{reportId} |
DDCを削除します。 帳票ID(***reportId***)を指定して、、DDCを削除します。 DDCを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsDetailsConfirms/DeleteFile/{fileId} |
DDCの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、DDCの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsDetailsConfirms/Get/{reportId} |
DDCを取得します。 帳票ID(***reportId***)を指定して、DDC取得します。 編集が行われていない場合は、ルートドキュメントから最新のDDCを取得します。 編集中の場合は、先に保存した、DDCを取得します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsDetailsConfirms/GetFile/{fileId} |
DDCに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、DDCに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsConfirms/Lock/{reportId} |
編集するため、DDCをロックします。 帳票ID(***reportId***)を指定して、DDCをロックします。 DDCを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、DDCを編集する場合は、このメソッドを呼び出してロックします。 ロックされたDDCは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、DDCをルートドキュメントから参照できますが、編集中(ロック中)のDDCは参照できません。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsConfirms/SendToNaccs |
DDCをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したDDCをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DDCが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsConfirms/SetCancel/{reportId} |
DDCの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、DDCの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsConfirms/Submit/{reportId} |
DDCを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したDDCを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DDCが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsConfirms/SubmitByPost |
DDCを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsConfirms/Unlock/{reportId} |
DDCのロックを解除します。 帳票ID(***reportId***)を指定して、DDCのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsConfirms/Update/{reportId} |
DDCを更新します。 帳票ID(***reportId***)を指定して、DDCを更新します。 このメソッドでは、DDCの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsConfirms/UpdateByPost |
DDCを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsConfirms/UploadFile |
DDCにファイルを添付します。 指定されたDDCに、ファイルを添付します。 |
|
DangerousGoodsDetailsInquiries
IDR_危険物明細情報照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsInquiries/Create |
IDRを作成します。 IDRを作成するには、利用者がIDRを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsDetailsInquiries/Delete/{reportId} |
IDRを削除します。 帳票ID(***reportId***)を指定して、、IDRを削除します。 IDRを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsDetailsInquiries/DeleteFile/{fileId} |
IDRの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IDRの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsDetailsInquiries/Get/{reportId} |
IDRを取得します。 帳票ID(***reportId***)を指定して、IDR取得します。 編集が行われていない場合は、ルートドキュメントから最新のIDRを取得します。 編集中の場合は、先に保存した、IDRを取得します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsDetailsInquiries/GetFile/{fileId} |
IDRに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IDRに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsInquiries/Lock/{reportId} |
編集するため、IDRをロックします。 帳票ID(***reportId***)を指定して、IDRをロックします。 IDRを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IDRを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIDRは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IDRをルートドキュメントから参照できますが、編集中(ロック中)のIDRは参照できません。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsInquiries/SendToNaccs |
IDRをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIDRをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IDRが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsInquiries/SetCancel/{reportId} |
IDRの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IDRの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsInquiries/Submit/{reportId} |
IDRを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIDRを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IDRが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsInquiries/Unlock/{reportId} |
IDRのロックを解除します。 帳票ID(***reportId***)を指定して、IDRのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsInquiries/Update/{reportId} |
IDRを更新します。 帳票ID(***reportId***)を指定して、IDRを更新します。 このメソッドでは、IDRの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsInquiries/UploadFile |
IDRにファイルを添付します。 指定されたIDRに、ファイルを添付します。 |
|
DangerousGoodsDetailsReceptionCalls
DCR11_危険物明細受付締切日呼出し・照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsReceptionCalls/Create |
DCR11を作成します。 DCR11を作成するには、利用者がDCR11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsDetailsReceptionCalls/Delete/{reportId} |
DCR11を削除します。 帳票ID(***reportId***)を指定して、、DCR11を削除します。 DCR11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsDetailsReceptionCalls/DeleteFile/{fileId} |
DCR11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、DCR11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsDetailsReceptionCalls/Get/{reportId} |
DCR11を取得します。 帳票ID(***reportId***)を指定して、DCR11取得します。 編集が行われていない場合は、ルートドキュメントから最新のDCR11を取得します。 編集中の場合は、先に保存した、DCR11を取得します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsDetailsReceptionCalls/GetFile/{fileId} |
DCR11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、DCR11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsReceptionCalls/Lock/{reportId} |
編集するため、DCR11をロックします。 帳票ID(***reportId***)を指定して、DCR11をロックします。 DCR11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、DCR11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたDCR11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、DCR11をルートドキュメントから参照できますが、編集中(ロック中)のDCR11は参照できません。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsReceptionCalls/SendToNaccs |
DCR11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したDCR11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DCR11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsReceptionCalls/SetCancel/{reportId} |
DCR11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、DCR11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsReceptionCalls/Submit/{reportId} |
DCR11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したDCR11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DCR11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsReceptionCalls/SubmitByPost |
DCR11を提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsReceptionCalls/Unlock/{reportId} |
DCR11のロックを解除します。 帳票ID(***reportId***)を指定して、DCR11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsReceptionCalls/Update/{reportId} |
DCR11を更新します。 帳票ID(***reportId***)を指定して、DCR11を更新します。 このメソッドでは、DCR11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsReceptionCalls/UpdateByPost |
DCR11を更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsReceptionCalls/UploadFile |
DCR11にファイルを添付します。 指定されたDCR11に、ファイルを添付します。 |
|
DangerousGoodsDetailsReceptions
DCR_危険物明細受付 完了日登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsReceptions/Create |
DCRを作成します。 DCRを作成するには、利用者がDCRを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsDetailsReceptions/Delete/{reportId} |
DCRを削除します。 帳票ID(***reportId***)を指定して、、DCRを削除します。 DCRを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsDetailsReceptions/DeleteFile/{fileId} |
DCRの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、DCRの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsDetailsReceptions/Get/{reportId} |
DCRを取得します。 帳票ID(***reportId***)を指定して、DCR取得します。 編集が行われていない場合は、ルートドキュメントから最新のDCRを取得します。 編集中の場合は、先に保存した、DCRを取得します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsDetailsReceptions/GetFile/{fileId} |
DCRに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、DCRに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsReceptions/Lock/{reportId} |
編集するため、DCRをロックします。 帳票ID(***reportId***)を指定して、DCRをロックします。 DCRを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、DCRを編集する場合は、このメソッドを呼び出してロックします。 ロックされたDCRは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、DCRをルートドキュメントから参照できますが、編集中(ロック中)のDCRは参照できません。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsReceptions/SendToNaccs |
DCRをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したDCRをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DCRが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsReceptions/SetCancel/{reportId} |
DCRの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、DCRの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsReceptions/Submit/{reportId} |
DCRを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したDCRを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DCRが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsReceptions/SubmitByPost |
DCRを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsReceptions/Unlock/{reportId} |
DCRのロックを解除します。 帳票ID(***reportId***)を指定して、DCRのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsReceptions/Update/{reportId} |
DCRを更新します。 帳票ID(***reportId***)を指定して、DCRを更新します。 このメソッドでは、DCRの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsReceptions/UpdateByPost |
DCRを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsReceptions/UploadFile |
DCRにファイルを添付します。 指定されたDCRに、ファイルを添付します。 |
|
DangerousGoodsDetailsRegistrationCalls
DDR11_危険物明細情報登録呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationCalls/Create |
DDR11を作成します。 DDR11を作成するには、利用者がDDR11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationCalls/Delete/{reportId} |
DDR11を削除します。 帳票ID(***reportId***)を指定して、、DDR11を削除します。 DDR11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationCalls/DeleteFile/{fileId} |
DDR11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、DDR11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationCalls/Get/{reportId} |
DDR11を取得します。 帳票ID(***reportId***)を指定して、DDR11取得します。 編集が行われていない場合は、ルートドキュメントから最新のDDR11を取得します。 編集中の場合は、先に保存した、DDR11を取得します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationCalls/GetFile/{fileId} |
DDR11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、DDR11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationCalls/Lock/{reportId} |
編集するため、DDR11をロックします。 帳票ID(***reportId***)を指定して、DDR11をロックします。 DDR11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、DDR11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたDDR11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、DDR11をルートドキュメントから参照できますが、編集中(ロック中)のDDR11は参照できません。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationCalls/SendToNaccs |
DDR11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したDDR11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DDR11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationCalls/SetCancel/{reportId} |
DDR11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、DDR11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationCalls/Submit/{reportId} |
DDR11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したDDR11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DDR11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationCalls/SubmitByPost |
DDR11を提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationCalls/Unlock/{reportId} |
DDR11のロックを解除します。 帳票ID(***reportId***)を指定して、DDR11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationCalls/Update/{reportId} |
DDR11を更新します。 帳票ID(***reportId***)を指定して、DDR11を更新します。 このメソッドでは、DDR11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationCalls/UpdateByPost |
DDR11を更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationCalls/UploadFile |
DDR11にファイルを添付します。 指定されたDDR11に、ファイルを添付します。 |
|
DangerousGoodsDetailsRegistrationNotifications
DDR01_危険物明細情報(危険物・ 有害物事前連絡表)登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationNotifications/Create |
DDR01を作成します。 DDR01を作成するには、利用者がDDR01を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationNotifications/Delete/{reportId} |
DDR01を削除します。 帳票ID(***reportId***)を指定して、、DDR01を削除します。 DDR01を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationNotifications/DeleteFile/{fileId} |
DDR01の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、DDR01の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationNotifications/Get/{reportId} |
DDR01を取得します。 帳票ID(***reportId***)を指定して、DDR01取得します。 編集が行われていない場合は、ルートドキュメントから最新のDDR01を取得します。 編集中の場合は、先に保存した、DDR01を取得します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationNotifications/GetFile/{fileId} |
DDR01に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、DDR01に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationNotifications/Lock/{reportId} |
編集するため、DDR01をロックします。 帳票ID(***reportId***)を指定して、DDR01をロックします。 DDR01を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、DDR01を編集する場合は、このメソッドを呼び出してロックします。 ロックされたDDR01は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、DDR01をルートドキュメントから参照できますが、編集中(ロック中)のDDR01は参照できません。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationNotifications/SendToNaccs |
DDR01をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したDDR01をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DDR01が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationNotifications/SetCancel/{reportId} |
DDR01の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、DDR01の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationNotifications/Submit/{reportId} |
DDR01を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したDDR01を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DDR01が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationNotifications/SubmitByPost |
DDR01を提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationNotifications/Unlock/{reportId} |
DDR01のロックを解除します。 帳票ID(***reportId***)を指定して、DDR01のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationNotifications/Update/{reportId} |
DDR01を更新します。 帳票ID(***reportId***)を指定して、DDR01を更新します。 このメソッドでは、DDR01の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationNotifications/UpdateByPost |
DDR01を更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrationNotifications/UploadFile |
DDR01にファイルを添付します。 指定されたDDR01に、ファイルを添付します。 |
|
DangerousGoodsDetailsRegistrations
DDR_危険物明細情報登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrations/Create |
DDRを作成します。 DDRを作成するには、利用者がDDRを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrations/Delete/{reportId} |
DDRを削除します。 帳票ID(***reportId***)を指定して、、DDRを削除します。 DDRを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrations/DeleteFile/{fileId} |
DDRの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、DDRの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrations/Get/{reportId} |
DDRを取得します。 帳票ID(***reportId***)を指定して、DDR取得します。 編集が行われていない場合は、ルートドキュメントから最新のDDRを取得します。 編集中の場合は、先に保存した、DDRを取得します。 |
|
| GET | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrations/GetFile/{fileId} |
DDRに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、DDRに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrations/Lock/{reportId} |
編集するため、DDRをロックします。 帳票ID(***reportId***)を指定して、DDRをロックします。 DDRを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、DDRを編集する場合は、このメソッドを呼び出してロックします。 ロックされたDDRは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、DDRをルートドキュメントから参照できますが、編集中(ロック中)のDDRは参照できません。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrations/SendToNaccs |
DDRをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したDDRをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DDRが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrations/SetCancel/{reportId} |
DDRの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、DDRの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrations/Submit/{reportId} |
DDRを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したDDRを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DDRが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrations/SubmitByPost |
DDRを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrations/Unlock/{reportId} |
DDRのロックを解除します。 帳票ID(***reportId***)を指定して、DDRのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrations/Update/{reportId} |
DDRを更新します。 帳票ID(***reportId***)を指定して、DDRを更新します。 このメソッドでは、DDRの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrations/UpdateByPost |
DDRを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/DangerousGoodsDetailsRegistrations/UploadFile |
DDRにファイルを添付します。 指定されたDDRに、ファイルを添付します。 |
|
DangerousGoodsPackageTypes
危険物容器・包装種別
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/DangerousGoodsPackageTypes/DeleteAdmin/{packageTypeCode} |
危険物容器・包装種別を削除します。 容器・包装種類コード(***packageTypeCode***)を指定して、IMOクラスを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/DangerousGoodsPackageTypes/Get/{packageTypeCode} |
危険物容器・包装種別を取得します。 容器・包装種類コード(***packageTypeCode***)を指定して、危険物容器・包装種別を取得します。 |
|
| GET | /API/v2/General/DangerousGoodsPackageTypes/GetList |
危険物容器・包装種別を全て取得します。 |
|
| POST | /API/v2/General/DangerousGoodsPackageTypes/RegisterAdmin |
危険物容器・包装種別を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/General/DangerousGoodsPackageTypes/RegisterInternal |
危険物容器・包装種別を登録します。 内部呼び出し用。 (*For admin) |
|
DangerousGoodsSummaries
危険物関連帳票サマリ
DeclarationAttachmentCorrectionCalls
MSY_申告添付訂正呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DeclarationAttachmentCorrectionCalls/Create |
MSYを作成します。 MSYを作成するには、利用者がMSYを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DeclarationAttachmentCorrectionCalls/Delete/{reportId} |
MSYを削除します。 帳票ID(***reportId***)を指定して、、MSYを削除します。 MSYを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DeclarationAttachmentCorrectionCalls/DeleteFile/{fileId} |
MSYの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、MSYの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DeclarationAttachmentCorrectionCalls/Get/{reportId} |
MSYを取得します。 帳票ID(***reportId***)を指定して、MSY取得します。 編集が行われていない場合は、ルートドキュメントから最新のMSYを取得します。 編集中の場合は、先に保存した、MSYを取得します。 |
|
| GET | /API/v2/NaccsReports/DeclarationAttachmentCorrectionCalls/GetFile/{fileId} |
MSYに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、MSYに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentCorrectionCalls/Lock/{reportId} |
編集するため、MSYをロックします。 帳票ID(***reportId***)を指定して、MSYをロックします。 MSYを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、MSYを編集する場合は、このメソッドを呼び出してロックします。 ロックされたMSYは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、MSYをルートドキュメントから参照できますが、編集中(ロック中)のMSYは参照できません。 |
|
| POST | /API/v2/NaccsReports/DeclarationAttachmentCorrectionCalls/SendToNaccs |
MSYをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したMSYをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、MSYが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentCorrectionCalls/SetCancel/{reportId} |
MSYの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、MSYの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentCorrectionCalls/Submit/{reportId} |
MSYを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したMSYを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、MSYが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentCorrectionCalls/Unlock/{reportId} |
MSYのロックを解除します。 帳票ID(***reportId***)を指定して、MSYのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentCorrectionCalls/Update/{reportId} |
MSYを更新します。 帳票ID(***reportId***)を指定して、MSYを更新します。 このメソッドでは、MSYの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DeclarationAttachmentCorrectionCalls/UploadFile |
MSYにファイルを添付します。 指定されたMSYに、ファイルを添付します。 |
|
DeclarationAttachmentCorrections
MSY01_申告添付訂正
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DeclarationAttachmentCorrections/Create |
MSY01を作成します。 MSY01を作成するには、利用者がMSY01を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DeclarationAttachmentCorrections/Delete/{reportId} |
MSY01を削除します。 帳票ID(***reportId***)を指定して、、MSY01を削除します。 MSY01を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DeclarationAttachmentCorrections/DeleteFile/{fileId} |
MSY01の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、MSY01の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DeclarationAttachmentCorrections/Get/{reportId} |
MSY01を取得します。 帳票ID(***reportId***)を指定して、MSY01取得します。 編集が行われていない場合は、ルートドキュメントから最新のMSY01を取得します。 編集中の場合は、先に保存した、MSY01を取得します。 |
|
| GET | /API/v2/NaccsReports/DeclarationAttachmentCorrections/GetFile/{fileId} |
MSY01に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、MSY01に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentCorrections/Lock/{reportId} |
編集するため、MSY01をロックします。 帳票ID(***reportId***)を指定して、MSY01をロックします。 MSY01を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、MSY01を編集する場合は、このメソッドを呼び出してロックします。 ロックされたMSY01は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、MSY01をルートドキュメントから参照できますが、編集中(ロック中)のMSY01は参照できません。 |
|
| POST | /API/v2/NaccsReports/DeclarationAttachmentCorrections/SendToNaccs |
MSY01をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したMSY01をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、MSY01が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentCorrections/SetCancel/{reportId} |
MSY01の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、MSY01の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentCorrections/Submit/{reportId} |
MSY01を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したMSY01を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、MSY01が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/DeclarationAttachmentCorrections/SubmitByPost |
MSY01を提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentCorrections/Unlock/{reportId} |
MSY01のロックを解除します。 帳票ID(***reportId***)を指定して、MSY01のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentCorrections/Update/{reportId} |
MSY01を更新します。 帳票ID(***reportId***)を指定して、MSY01を更新します。 このメソッドでは、MSY01の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DeclarationAttachmentCorrections/UpdateByPost |
MSY01を更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/DeclarationAttachmentCorrections/UploadFile |
MSY01にファイルを添付します。 指定されたMSY01に、ファイルを添付します。 |
|
DeclarationAttachmentListInquiries
IMS_申告添付一覧照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DeclarationAttachmentListInquiries/Create |
IMSを作成します。 IMSを作成するには、利用者がIMSを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DeclarationAttachmentListInquiries/Delete/{reportId} |
IMSを削除します。 帳票ID(***reportId***)を指定して、、IMSを削除します。 IMSを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DeclarationAttachmentListInquiries/DeleteFile/{fileId} |
IMSの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IMSの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DeclarationAttachmentListInquiries/Get/{reportId} |
IMSを取得します。 帳票ID(***reportId***)を指定して、IMS取得します。 編集が行われていない場合は、ルートドキュメントから最新のIMSを取得します。 編集中の場合は、先に保存した、IMSを取得します。 |
|
| GET | /API/v2/NaccsReports/DeclarationAttachmentListInquiries/GetFile/{fileId} |
IMSに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IMSに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentListInquiries/Lock/{reportId} |
編集するため、IMSをロックします。 帳票ID(***reportId***)を指定して、IMSをロックします。 IMSを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IMSを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIMSは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IMSをルートドキュメントから参照できますが、編集中(ロック中)のIMSは参照できません。 |
|
| POST | /API/v2/NaccsReports/DeclarationAttachmentListInquiries/SendToNaccs |
IMSをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIMSをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IMSが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentListInquiries/SetCancel/{reportId} |
IMSの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IMSの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentListInquiries/Submit/{reportId} |
IMSを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIMSを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IMSが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentListInquiries/Unlock/{reportId} |
IMSのロックを解除します。 帳票ID(***reportId***)を指定して、IMSのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentListInquiries/Update/{reportId} |
IMSを更新します。 帳票ID(***reportId***)を指定して、IMSを更新します。 このメソッドでは、IMSの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DeclarationAttachmentListInquiries/UploadFile |
IMSにファイルを添付します。 指定されたIMSに、ファイルを添付します。 |
|
DeclarationAttachmentRegistrations
MSX_申告添付登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DeclarationAttachmentRegistrations/Create |
MSXを作成します。 MSXを作成するには、利用者がMSXを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DeclarationAttachmentRegistrations/Delete/{reportId} |
MSXを削除します。 帳票ID(***reportId***)を指定して、、MSXを削除します。 MSXを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DeclarationAttachmentRegistrations/DeleteFile/{fileId} |
MSXの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、MSXの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DeclarationAttachmentRegistrations/Get/{reportId} |
MSXを取得します。 帳票ID(***reportId***)を指定して、MSX取得します。 編集が行われていない場合は、ルートドキュメントから最新のMSXを取得します。 編集中の場合は、先に保存した、MSXを取得します。 |
|
| GET | /API/v2/NaccsReports/DeclarationAttachmentRegistrations/GetFile/{fileId} |
MSXに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、MSXに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentRegistrations/Lock/{reportId} |
編集するため、MSXをロックします。 帳票ID(***reportId***)を指定して、MSXをロックします。 MSXを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、MSXを編集する場合は、このメソッドを呼び出してロックします。 ロックされたMSXは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、MSXをルートドキュメントから参照できますが、編集中(ロック中)のMSXは参照できません。 |
|
| POST | /API/v2/NaccsReports/DeclarationAttachmentRegistrations/SendToNaccs |
MSXをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したMSXをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、MSXが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentRegistrations/SetCancel/{reportId} |
MSXの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、MSXの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentRegistrations/Submit/{reportId} |
MSXを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したMSXを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、MSXが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/DeclarationAttachmentRegistrations/SubmitByPost |
MSXを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentRegistrations/Unlock/{reportId} |
MSXのロックを解除します。 帳票ID(***reportId***)を指定して、MSXのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DeclarationAttachmentRegistrations/Update/{reportId} |
MSXを更新します。 帳票ID(***reportId***)を指定して、MSXを更新します。 このメソッドでは、MSXの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DeclarationAttachmentRegistrations/UpdateByPost |
MSXを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/DeclarationAttachmentRegistrations/UploadFile |
MSXにファイルを添付します。 指定されたMSXに、ファイルを添付します。 |
|
DeliveryConfirmationBondedTransportCargoes
BIA_搬入確認登録(保税運送貨物)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DeliveryConfirmationBondedTransportCargoes/Create |
BIAを作成します。 BIAを作成するには、利用者がBIAを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DeliveryConfirmationBondedTransportCargoes/Delete/{reportId} |
BIAを削除します。 帳票ID(***reportId***)を指定して、、BIAを削除します。 BIAを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DeliveryConfirmationBondedTransportCargoes/DeleteFile/{fileId} |
BIAの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、BIAの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DeliveryConfirmationBondedTransportCargoes/Get/{reportId} |
BIAを取得します。 帳票ID(***reportId***)を指定して、BIA取得します。 編集が行われていない場合は、ルートドキュメントから最新のBIAを取得します。 編集中の場合は、先に保存した、BIAを取得します。 |
|
| GET | /API/v2/NaccsReports/DeliveryConfirmationBondedTransportCargoes/GetFile/{fileId} |
BIAに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、BIAに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DeliveryConfirmationBondedTransportCargoes/Lock/{reportId} |
編集するため、BIAをロックします。 帳票ID(***reportId***)を指定して、BIAをロックします。 BIAを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、BIAを編集する場合は、このメソッドを呼び出してロックします。 ロックされたBIAは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、BIAをルートドキュメントから参照できますが、編集中(ロック中)のBIAは参照できません。 |
|
| POST | /API/v2/NaccsReports/DeliveryConfirmationBondedTransportCargoes/SendToNaccs |
BIAをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したBIAをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BIAが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DeliveryConfirmationBondedTransportCargoes/SetCancel/{reportId} |
BIAの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、BIAの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DeliveryConfirmationBondedTransportCargoes/Submit/{reportId} |
BIAを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したBIAを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BIAが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/DeliveryConfirmationBondedTransportCargoes/SubmitByPost |
BIAを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/DeliveryConfirmationBondedTransportCargoes/Unlock/{reportId} |
BIAのロックを解除します。 帳票ID(***reportId***)を指定して、BIAのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DeliveryConfirmationBondedTransportCargoes/Update/{reportId} |
BIAを更新します。 帳票ID(***reportId***)を指定して、BIAを更新します。 このメソッドでは、BIAの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DeliveryConfirmationBondedTransportCargoes/UpdateByPost |
BIAを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/DeliveryConfirmationBondedTransportCargoes/UploadFile |
BIAにファイルを添付します。 指定されたBIAに、ファイルを添付します。 |
|
DeliveryConfirmationExportApprovals
BID_搬入確認登録(輸出許可済)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DeliveryConfirmationExportApprovals/Create |
BIDを作成します。 BIDを作成するには、利用者がBIDを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DeliveryConfirmationExportApprovals/Delete/{reportId} |
BIDを削除します。 帳票ID(***reportId***)を指定して、、BIDを削除します。 BIDを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DeliveryConfirmationExportApprovals/DeleteFile/{fileId} |
BIDの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、BIDの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DeliveryConfirmationExportApprovals/Get/{reportId} |
BIDを取得します。 帳票ID(***reportId***)を指定して、BID取得します。 編集が行われていない場合は、ルートドキュメントから最新のBIDを取得します。 編集中の場合は、先に保存した、BIDを取得します。 |
|
| GET | /API/v2/NaccsReports/DeliveryConfirmationExportApprovals/GetFile/{fileId} |
BIDに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、BIDに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DeliveryConfirmationExportApprovals/Lock/{reportId} |
編集するため、BIDをロックします。 帳票ID(***reportId***)を指定して、BIDをロックします。 BIDを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、BIDを編集する場合は、このメソッドを呼び出してロックします。 ロックされたBIDは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、BIDをルートドキュメントから参照できますが、編集中(ロック中)のBIDは参照できません。 |
|
| POST | /API/v2/NaccsReports/DeliveryConfirmationExportApprovals/SendToNaccs |
BIDをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したBIDをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BIDが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DeliveryConfirmationExportApprovals/SetCancel/{reportId} |
BIDの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、BIDの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DeliveryConfirmationExportApprovals/Submit/{reportId} |
BIDを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したBIDを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BIDが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/DeliveryConfirmationExportApprovals/SubmitByPost |
BIDを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/DeliveryConfirmationExportApprovals/Unlock/{reportId} |
BIDのロックを解除します。 帳票ID(***reportId***)を指定して、BIDのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DeliveryConfirmationExportApprovals/Update/{reportId} |
BIDを更新します。 帳票ID(***reportId***)を指定して、BIDを更新します。 このメソッドでは、BIDの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DeliveryConfirmationExportApprovals/UpdateByPost |
BIDを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/DeliveryConfirmationExportApprovals/UploadFile |
BIDにファイルを添付します。 指定されたBIDに、ファイルを添付します。 |
|
DeliveryConfirmationPreExportApprovals
BIC_搬入確認登録(輸出未通関)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DeliveryConfirmationPreExportApprovals/Create |
BICを作成します。 BICを作成するには、利用者がBICを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DeliveryConfirmationPreExportApprovals/Delete/{reportId} |
BICを削除します。 帳票ID(***reportId***)を指定して、、BICを削除します。 BICを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DeliveryConfirmationPreExportApprovals/DeleteFile/{fileId} |
BICの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、BICの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DeliveryConfirmationPreExportApprovals/Get/{reportId} |
BICを取得します。 帳票ID(***reportId***)を指定して、BIC取得します。 編集が行われていない場合は、ルートドキュメントから最新のBICを取得します。 編集中の場合は、先に保存した、BICを取得します。 |
|
| GET | /API/v2/NaccsReports/DeliveryConfirmationPreExportApprovals/GetFile/{fileId} |
BICに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、BICに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DeliveryConfirmationPreExportApprovals/Lock/{reportId} |
編集するため、BICをロックします。 帳票ID(***reportId***)を指定して、BICをロックします。 BICを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、BICを編集する場合は、このメソッドを呼び出してロックします。 ロックされたBICは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、BICをルートドキュメントから参照できますが、編集中(ロック中)のBICは参照できません。 |
|
| POST | /API/v2/NaccsReports/DeliveryConfirmationPreExportApprovals/SendToNaccs |
BICをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したBICをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BICが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DeliveryConfirmationPreExportApprovals/SetCancel/{reportId} |
BICの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、BICの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DeliveryConfirmationPreExportApprovals/Submit/{reportId} |
BICを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したBICを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BICが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/DeliveryConfirmationPreExportApprovals/SubmitByPost |
BICを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/DeliveryConfirmationPreExportApprovals/Unlock/{reportId} |
BICのロックを解除します。 帳票ID(***reportId***)を指定して、BICのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DeliveryConfirmationPreExportApprovals/Update/{reportId} |
BICを更新します。 帳票ID(***reportId***)を指定して、BICを更新します。 このメソッドでは、BICの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DeliveryConfirmationPreExportApprovals/UpdateByPost |
BICを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/DeliveryConfirmationPreExportApprovals/UploadFile |
BICにファイルを添付します。 指定されたBICに、ファイルを添付します。 |
|
DeliveryConfirmationRequests
搬入確認依頼票
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/DeliveryConfirmationRequests/Create |
搬入確認依頼票を作成します。 搬入確認依頼票を作成するには、利用者が搬入確認依頼票を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 搬入確認依頼票に関する詳細については、[搬入確認依頼票について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DeliveryConfirmationRequests/Delete/{reportId} |
搬入確認依頼票を削除します。 帳票ID(***reportId***)を指定して、搬入確認依頼票を削除します。 搬入確認依頼票を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した搬入確認依頼票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 搬入確認依頼票に関する詳細については、[搬入確認依頼票について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DeliveryConfirmationRequests/DeleteFile/{fileId} |
搬入確認依頼票の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、搬入確認依頼票の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryConfirmationRequests/Get/{reportId}?historyId=!{historyId} |
搬入確認依頼票を取得します。 帳票ID(***reportId***)を指定して、搬入確認依頼票を取得します。 編集が行われていない場合は、ルートドキュメントから最新の搬入確認依頼票を取得します。 編集中の場合は、先に保存した、搬入確認依頼票を取得します。 搬入確認依頼票に関する詳細については、[搬入確認依頼票について]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryConfirmationRequests/GetDiff/{reportId}?historyId=!{historyId} |
保存されている搬入確認依頼票とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する搬入確認依頼票と、ルートドキュメントの差分を取得します。 比較元を保存されている搬入確認依頼票、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryConfirmationRequests/GetFile/{fileId} |
搬入確認依頼票に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、搬入確認依頼票に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryConfirmationRequests/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
搬入確認依頼票を全て取得します。 検索条件に該当する搬入確認依頼票を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の搬入確認依頼票を取得します。 編集中の場合は、先に保存した、搬入確認依頼票を取得します。 搬入確認依頼票に関する詳細については、[搬入確認依頼票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryConfirmationRequests/Lock/{reportId} |
編集するため、搬入確認依頼票をロックします 帳票ID(***reportId***)を指定して、搬入確認依頼票をロックします。 搬入確認依頼票を作成(***Create***)した時点では、搬入確認依頼票をロックが掛かりますが、取得(***Get***)したあとで、搬入確認依頼票を編集する場合は、このメソッドを呼び出して、搬入確認依頼票をロックします。 ロックされた搬入確認依頼票は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、搬入確認依頼票をルートドキュメントから参照できますが、編集中(ロック中)のブッキング依頼書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 搬入確認依頼票に関する詳細については、[搬入確認依頼票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryConfirmationRequests/SetCancel/{reportId} |
搬入確認依頼票の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、搬入確認依頼票の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 搬入確認依頼票に関する詳細については、[搬入確認依頼票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryConfirmationRequests/Submit/{reportId} |
搬入確認依頼票を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した搬入確認依頼票を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、搬入確認依頼票が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、搬入確認依頼票もロックされた状態のままなので、ご注意ください。 搬入確認依頼票に関する詳細については、[搬入確認依頼票について]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryConfirmationRequests/SubmitByPost |
搬入確認依頼票を提出します。 動作は、搬入確認依頼票(***/API/v2/Reports/DeliveryConfirmationRequests/Submit***)と同様です。 搬入確認依頼票に関する詳細については、[搬入確認依頼票]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryConfirmationRequests/Unlock/{reportId} |
搬入確認依頼票のロックを解除します 帳票ID(***reportId***)を指定して、搬入確認依頼票のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 搬入確認依頼票に関する詳細については、[搬入確認依頼票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryConfirmationRequests/Update/{reportId} |
搬入確認依頼票を更新します。 帳票ID(***reportId***)を指定して、搬入確認依頼票を更新します。 このメソッドでは、搬入確認依頼票の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 搬入確認依頼票に関する詳細については、[搬入確認依頼票について]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryConfirmationRequests/UpdateByPost |
搬入確認依頼票を更新します。 動作は、搬入確認依頼票(***/API/v2/Reports/DeliveryConfirmationRequests/Update***)と同様です。 搬入確認依頼票に関する詳細については、[搬入確認依頼票]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryConfirmationRequests/UploadFile |
搬入確認依頼票にファイルを添付します。 指定された搬入確認依頼票に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
DeliveryDocuments
貨物輸送送り状
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/DeliveryDocuments/Create |
貨物輸送送り状を作成します。 貨物輸送送り状を作成するには、利用者が貨物輸送送り状を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 貨物輸送送り状に関する詳細については、[貨物輸送送り状について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DeliveryDocuments/Delete/{reportId} |
貨物輸送送り状を削除します。 帳票ID(***reportId***)を指定して、貨物輸送送り状を削除します。 貨物輸送送り状を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したCFS搬出票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 貨物輸送送り状に関する詳細については、[貨物輸送送り状について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DeliveryDocuments/DeleteFile/{fileId} |
貨物輸送送り状の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、貨物輸送送り状の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryDocuments/Get/{reportId}?historyId=!{historyId} |
貨物輸送送り状を取得します。 帳票ID(***reportId***)を指定して、貨物輸送送り状を取得します。 編集が行われていない場合は、ルートドキュメントから最新の貨物輸送送り状を取得します。 編集中の場合は、先に保存した、貨物輸送送り状を取得します。 貨物輸送送り状に関する詳細については、[貨物輸送送り状について]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryDocuments/GetDiff/{reportId}?historyId=!{historyId} |
保存されている貨物輸送送り状とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する貨物輸送送り状と、ルートドキュメントの差分を取得します。 比較元を保存されている貨物輸送送り状、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryDocuments/GetFile/{fileId} |
貨物輸送送り状に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、貨物輸送送り状に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryDocuments/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
貨物輸送送り状を全て取得します。 検索条件に該当する貨物輸送送り状を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の貨物輸送送り状を取得します。 編集中の場合は、先に保存した、貨物輸送送り状を取得します。 貨物輸送送り状に関する詳細については、[貨物輸送送り状について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryDocuments/Lock/{reportId} |
編集するため、貨物輸送送り状をロックします 帳票ID(***reportId***)を指定して、貨物輸送送り状をロックします。 貨物輸送送り状を作成(***Create***)した時点では、貨物輸送送り状をロックが掛かりますが、取得(***Get***)したあとで、貨物輸送送り状を編集する場合は、このメソッドを呼び出して、貨物輸送送り状をロックします。 ロックされた貨物輸送送り状は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、貨物輸送送り状をルートドキュメントから参照できますが、編集中(ロック中)の貨物輸送送り状は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 貨物輸送送り状に関する詳細については、[貨物輸送送り状について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryDocuments/SetCancel/{reportId} |
貨物輸送送り状の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、貨物輸送送り状の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 貨物輸送送り状に関する詳細については、[貨物輸送送り状について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryDocuments/Submit/{reportId} |
貨物輸送送り状を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した貨物輸送送り状を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、貨物輸送送り状が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、コンテナ貨物搬入票もロックされた状態のままなので、ご注意ください。 貨物輸送送り状に関する詳細については、[貨物輸送送り状について]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryDocuments/SubmitByPost |
貨物輸送送り状を提出します。 動作は、貨物輸送送り状(***/API/v2/Reports/DeliveryDocuments/Submit***)と同様です。 貨物輸送送り状に関する詳細については、[貨物輸送送り状]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryDocuments/Unlock/{reportId} |
貨物輸送送り状のロックを解除します 帳票ID(***reportId***)を指定して、貨物輸送送り状のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 貨物輸送送り状に関する詳細については、[貨物輸送送り状について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryDocuments/Update/{reportId} |
貨物輸送送り状を更新します。 帳票ID(***reportId***)を指定して、貨物輸送送り状を更新します。 このメソッドでは、貨物輸送送り状の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 貨物輸送送り状に関する詳細については、[貨物輸送送り状について]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryDocuments/UpdateByPost |
貨物輸送送り状を更新します。 動作は、貨物輸送送り状(***/API/v2/Reports/DeliveryDocuments/Update***)と同様です。 貨物輸送送り状に関する詳細については、[貨物輸送送り状]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryDocuments/UploadFile |
貨物輸送送り状にファイルを添付します。 指定された貨物輸送送り状に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
DeliveryInstructions-EmptyContainerDelivery
運送依頼書(空コンテナ返却)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/Create |
運送依頼書(空コンテナ返却)を作成します。 運送依頼書(空コンテナ返却)を作成するには、利用者が運送依頼書(空コンテナ返却)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/Delete/{reportId} |
運送依頼書(空コンテナ返却)を削除します。 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ返却)を削除します。 運送依頼書(空コンテナ返却)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した運送依頼書(空コンテナ返却)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/DeleteFile/{fileId} |
運送依頼書(空コンテナ返却)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、運送依頼書(空コンテナ返却)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/Get/{reportId}?historyId=!{historyId} |
運送依頼書(空コンテナ返却)を取得します。 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ返却)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の運送依頼書(空コンテナ返却)を取得します。 編集中の場合は、先に保存した、運送依頼書(空コンテナ返却)を取得します。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/GetDiff/{reportId}?historyId=!{historyId} |
保存されている運送依頼書(空コンテナ返却)とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する運送依頼書(空コンテナ返却)と、ルートドキュメントの差分を取得します。 比較元を保存されている運送依頼書(空コンテナ返却)、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/GetFile/{fileId} |
運送依頼書(空コンテナ返却)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、運送依頼書(空コンテナ返却)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
運送依頼書(空コンテナ返却)を全て取得します。 検索条件に該当する運送依頼書(空コンテナ返却)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の運送依頼書(空コンテナ返却)を取得します。 編集中の場合は、先に保存した、運送依頼書(空コンテナ返却)を取得します。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/Lock/{reportId} |
編集するため、運送依頼書(空コンテナ返却)をロックします 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ返却)をロックします。 運送依頼書(空コンテナ返却)を作成(***Create***)した時点では、運送依頼書(空コンテナ返却)をロックが掛かりますが、取得(***Get***)したあとで、運送依頼書(空コンテナ返却)を編集する場合は、このメソッドを呼び出して、運送依頼書(空コンテナ返却)をロックします。 ロックされた運送依頼書(空コンテナ返却)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、運送依頼書(空コンテナ返却)をルートドキュメントから参照できますが、編集中(ロック中)の運送依頼書(空コンテナ返却)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/SetCancel/{reportId} |
運送依頼書(空コンテナ返却)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ返却)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/Submit/{reportId} |
運送依頼書(空コンテナ返却)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した運送依頼書(空コンテナ返却)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、運送依頼書(空コンテナ返却)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、運送依頼書(空コンテナ返却)もロックされた状態のままなので、ご注意ください。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/SubmitByPost |
運送依頼書(空コンテナ返却)を提出します 動作は、運送依頼書(空コンテナ返却)(***/API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/Submit***)と同様です。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/Unlock/{reportId} |
運送依頼書(空コンテナ返却)のロックを解除します 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ返却)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/Update/{reportId} |
運送依頼書(空コンテナ返却)を更新します。 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ返却)を更新します。 このメソッドでは、運送依頼書(空コンテナ返却)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)について]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/UpdateByPost |
運送依頼書(空コンテナ返却)を更新します。 動作は、運送依頼書(空コンテナ返却)(***/API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/Update***)と同様です。 運送依頼書(空コンテナ返却)に関する詳細については、[運送依頼書(空コンテナ返却)]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryInstructions-EmptyContainerDelivery/UploadFile |
運送依頼書(空コンテナ返却)にファイルを添付します。 指定された運送依頼書(空コンテナ返却)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
DeliveryInstructions-EmptyContainerPickup
運送依頼書(空コンテナ搬出)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/Create |
運送依頼書(空コンテナ搬出)を作成します。 運送依頼書(空コンテナ搬出)を作成するには、利用者が運送依頼書(空コンテナ搬出)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/Delete/{reportId} |
運送依頼書(空コンテナ搬出)を削除します。 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ搬出)を削除します。 運送依頼書(空コンテナ搬出)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した運送依頼書(空コンテナ搬出)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/DeleteFile/{fileId} |
運送依頼書(空コンテナ搬出)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、運送依頼書(空コンテナ搬出)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/Get/{reportId}?historyId=!{historyId} |
運送依頼書(空コンテナ搬出)を取得します。 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ搬出)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の運送依頼書(空コンテナ搬出)を取得します。 編集中の場合は、先に保存した、運送依頼書(空コンテナ搬出)を取得します。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/GetDiff/{reportId}?historyId=!{historyId} |
保存されている運送依頼書(空コンテナ搬出)とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する運送依頼書(空コンテナ搬出)と、ルートドキュメントの差分を取得します。 比較元を保存されている運送依頼書(空コンテナ搬出)、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/GetFile/{fileId} |
運送依頼書(空コンテナ搬出)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、運送依頼書(空コンテナ搬出)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
運送依頼書(空コンテナ搬出)を全て取得します。 検索条件に該当する運送依頼書(空コンテナ搬出)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の運送依頼書(空コンテナ搬出)を取得します。 編集中の場合は、先に保存した、運送依頼書(空コンテナ搬出)を取得します。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/Lock/{reportId} |
編集するため、運送依頼書(空コンテナ搬出)をロックします 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ搬出)をロックします。 運送依頼書(空コンテナ搬出)を作成(***Create***)した時点では、運送依頼書(空コンテナ搬出)をロックが掛かりますが、取得(***Get***)したあとで、運送依頼書(空コンテナ搬出)を編集する場合は、このメソッドを呼び出して、運送依頼書(空コンテナ搬出)をロックします。 ロックされた運送依頼書(空コンテナ搬出)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、運送依頼書(空コンテナ搬出)をルートドキュメントから参照できますが、編集中(ロック中)の運送依頼書(空コンテナ搬出)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/SetCancel/{reportId} |
運送依頼書(空コンテナ搬出)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ搬出)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/Submit/{reportId} |
運送依頼書(空コンテナ搬出)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した運送依頼書(空コンテナ搬出)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、運送依頼書(空コンテナ搬出)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、運送依頼書(空コンテナ搬出)もロックされた状態のままなので、ご注意ください。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/SubmitByPost |
運送依頼書(空コンテナ搬出)を提出します 動作は、運送依頼書(空コンテナ搬出)(***/API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/Submit***)と同様です。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/Unlock/{reportId} |
運送依頼書(空コンテナ搬出)のロックを解除します 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ搬出)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/Update/{reportId} |
運送依頼書(空コンテナ搬出)を更新します。 帳票ID(***reportId***)を指定して、運送依頼書(空コンテナ搬出)を更新します。 このメソッドでは、運送依頼書(空コンテナ搬出)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)について]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/UpdateByPost |
運送依頼書(空コンテナ搬出)を更新します。 動作は、運送依頼書(空コンテナ搬出)(***/API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/Update***)と同様です。 運送依頼書(空コンテナ搬出)に関する詳細については、[運送依頼書(空コンテナ搬出)]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryInstructions-EmptyContainerPickup/UploadFile |
運送依頼書(空コンテナ搬出)にファイルを添付します。 指定された運送依頼書(空コンテナ搬出)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
DeliveryInstructions-LoadedContainerDelivery
運送依頼書(実入りコンテナ搬入)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/Create |
運送依頼書(実入りコンテナ搬入)を作成します。 運送依頼書(実入りコンテナ搬入)を作成するには、利用者が運送依頼書(実入りコンテナ搬入)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/Delete/{reportId} |
運送依頼書(実入りコンテナ搬入)を削除します。 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬入)を削除します。 運送依頼書(実入りコンテナ搬入)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した運送依頼書(実入りコンテナ搬入)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/DeleteFile/{fileId} |
運送依頼書(実入りコンテナ搬入)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、運送依頼書(実入りコンテナ搬入)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/Get/{reportId}?historyId=!{historyId} |
運送依頼書(実入りコンテナ搬入)を取得します。 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬入)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の運送依頼書(実入りコンテナ搬入)を取得します。 編集中の場合は、先に保存した、運送依頼書(実入りコンテナ搬入)を取得します。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/GetDiff/{reportId}?historyId=!{historyId} |
保存されている運送依頼書(実入りコンテナ搬入)とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する運送依頼書(実入りコンテナ搬入)と、ルートドキュメントの差分を取得します。 比較元を保存されている運送依頼書(実入りコンテナ搬入)、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/GetFile/{fileId} |
運送依頼書(実入りコンテナ搬入)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、運送依頼書(実入りコンテナ搬入)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
運送依頼書(実入りコンテナ搬入)を全て取得します。 検索条件に該当する運送依頼書(実入りコンテナ搬入)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の運送依頼書(実入りコンテナ搬入)を取得します。 編集中の場合は、先に保存した、運送依頼書(実入りコンテナ搬入)を取得します。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/Lock/{reportId} |
編集するため、運送依頼書(実入りコンテナ搬入)をロックします 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬入)をロックします。 運送依頼書(実入りコンテナ搬入)を作成(***Create***)した時点では、運送依頼書(実入りコンテナ搬入)をロックが掛かりますが、取得(***Get***)したあとで、運送依頼書(実入りコンテナ搬入)を編集する場合は、このメソッドを呼び出して、運送依頼書(実入りコンテナ搬入)をロックします。 ロックされた運送依頼書(実入りコンテナ搬入)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、運送依頼書(実入りコンテナ搬入)をルートドキュメントから参照できますが、編集中(ロック中)の運送依頼書(実入りコンテナ搬入)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/SetCancel/{reportId} |
運送依頼書(実入りコンテナ搬入)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬入)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/Submit/{reportId} |
運送依頼書(実入りコンテナ搬入)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した運送依頼書(実入りコンテナ搬入)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、運送依頼書(実入りコンテナ搬入)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、運送依頼書(実入りコンテナ搬入)もロックされた状態のままなので、ご注意ください。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/SubmitByPost |
運送依頼書(実入りコンテナ搬入)を提出します 動作は、運送依頼書(実入りコンテナ搬入)(***/API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/Submit***)と同様です。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/Unlock/{reportId} |
運送依頼書(実入りコンテナ搬入)のロックを解除します 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬入)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/Update/{reportId} |
運送依頼書(実入りコンテナ搬入)を更新します。 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬入)を更新します。 このメソッドでは、運送依頼書(実入りコンテナ搬入)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)について]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/UpdateByPost |
運送依頼書(実入りコンテナ搬入)を更新します。 動作は、運送依頼書(実入りコンテナ搬入)(***/API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/Update***)と同様です。 運送依頼書(実入りコンテナ搬入)に関する詳細については、[運送依頼書(実入りコンテナ搬入)]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryInstructions-LoadedContainerDelivery/UploadFile |
運送依頼書(実入りコンテナ搬入)にファイルを添付します。 指定された運送依頼書(実入りコンテナ搬入)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
DeliveryInstructions-LoadedContainerPickup
運送依頼書(実入りコンテナ搬出)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/Create |
運送依頼書(実入りコンテナ搬出)を作成します。 運送依頼書(実入りコンテナ搬出)を作成するには、利用者が運送依頼書(実入りコンテナ搬出)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/Delete/{reportId} |
運送依頼書(実入りコンテナ搬出)を削除します。 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬出)を削除します。 運送依頼書(実入りコンテナ搬出)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した運送依頼書(実入りコンテナ搬出)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/DeleteFile/{fileId} |
運送依頼書(実入りコンテナ搬出)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、運送依頼書(実入りコンテナ搬出)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/Get/{reportId}?historyId=!{historyId} |
運送依頼書(実入りコンテナ搬出)を取得します。 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬出)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の運送依頼書(実入りコンテナ搬出)を取得します。 編集中の場合は、先に保存した、運送依頼書(実入りコンテナ搬出)を取得します。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/GetDiff/{reportId}?historyId=!{historyId} |
保存されている運送依頼書(実入りコンテナ搬出)とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する運送依頼書(実入りコンテナ搬出)と、ルートドキュメントの差分を取得します。 比較元を保存されている運送依頼書(実入りコンテナ搬出)、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/GetFile/{fileId} |
運送依頼書(実入りコンテナ搬出)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、運送依頼書(実入りコンテナ搬出)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
運送依頼書(実入りコンテナ搬出)を全て取得します。 検索条件に該当する運送依頼書(実入りコンテナ搬出)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の運送依頼書(実入りコンテナ搬出)を取得します。 編集中の場合は、先に保存した、運送依頼書(実入りコンテナ搬出)を取得します。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/Lock/{reportId} |
編集するため、運送依頼書(実入りコンテナ搬出)をロックします 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬出)をロックします。 運送依頼書(実入りコンテナ搬出)を作成(***Create***)した時点では、運送依頼書(実入りコンテナ搬出)をロックが掛かりますが、取得(***Get***)したあとで、運送依頼書(実入りコンテナ搬出)を編集する場合は、このメソッドを呼び出して、運送依頼書(実入りコンテナ搬出)をロックします。 ロックされた運送依頼書(実入りコンテナ搬出)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、運送依頼書(実入りコンテナ搬出)をルートドキュメントから参照できますが、編集中(ロック中)の運送依頼書(実入りコンテナ搬出)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/SetCancel/{reportId} |
運送依頼書(実入りコンテナ搬出)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬出)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/Submit/{reportId} |
運送依頼書(実入りコンテナ搬出)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した運送依頼書(実入りコンテナ搬出)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、運送依頼書(実入りコンテナ搬出)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、運送依頼書(実入りコンテナ搬出)もロックされた状態のままなので、ご注意ください。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/SubmitByPost |
運送依頼書(実入りコンテナ搬出)を提出します 動作は、運送依頼書(実入りコンテナ搬出)(***/API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/Submit***)と同様です。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/Unlock/{reportId} |
運送依頼書(実入りコンテナ搬出)のロックを解除します 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬出)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/Update/{reportId} |
運送依頼書(実入りコンテナ搬出)を更新します。 帳票ID(***reportId***)を指定して、運送依頼書(実入りコンテナ搬出)を更新します。 このメソッドでは、運送依頼書(実入りコンテナ搬出)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)について]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/UpdateByPost |
運送依頼書(実入りコンテナ搬出)を更新します。 動作は、運送依頼書(実入りコンテナ搬出)(***/API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/Update***)と同様です。 運送依頼書(実入りコンテナ搬出)に関する詳細については、[運送依頼書(実入りコンテナ搬出)]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryInstructions-LoadedContainerPickup/UploadFile |
運送依頼書(実入りコンテナ搬出)にファイルを添付します。 指定された運送依頼書(実入りコンテナ搬出)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
DeliveryOrderLessRequests
荷渡指図書レス申込書
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/DeliveryOrderLessRequests/Create |
荷渡指図書レス申込書を作成します。 荷渡指図書レス申込書を作成するには、利用者が荷渡指図書レス申込書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DeliveryOrderLessRequests/Delete/{reportId} |
荷渡指図書レス申込書を削除します。 帳票ID(***reportId***)を指定して、荷渡指図書レス申込書を削除します。 荷渡指図書レス申込書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した荷渡指図書レス申込書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DeliveryOrderLessRequests/DeleteFile/{fileId} |
荷渡指図書レス申込書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、荷渡指図書レス申込書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryOrderLessRequests/Get/{reportId}?historyId=!{historyId} |
荷渡指図書レス申込書を取得します。 帳票ID(***reportId***)を指定して、荷渡指図書レス申込書を取得します。 編集が行われていない場合は、ルートドキュメントから最新の荷渡指図書レス申込書を取得します。 編集中の場合は、先に保存した、荷渡指図書レス申込書を取得します。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書について]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryOrderLessRequests/GetDiff/{reportId}?historyId=!{historyId} |
保存されている荷渡指図書レス申込書とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する荷渡指図書レス申込書と、ルートドキュメントの差分を取得します。 比較元を保存されている荷渡指図書レス申込書、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryOrderLessRequests/GetFile/{fileId} |
荷渡指図書レス申込書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、荷渡指図書レス申込書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryOrderLessRequests/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
荷渡指図書レス申込書を全て取得します。 検索条件に該当する荷渡指図書レス申込書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の荷渡指図書レス申込書を取得します。 編集中の場合は、先に保存した、荷渡指図書レス申込書を取得します。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryOrderLessRequests/Lock/{reportId} |
編集するため、荷渡指図書レス申込書をロックします 帳票ID(***reportId***)を指定して、荷渡指図書レス申込書をロックします。 荷渡指図書レス申込書を作成(***Create***)した時点では、荷渡指図書レス申込書をロックが掛かりますが、取得(***Get***)したあとで、荷渡指図書レス申込書を編集する場合は、このメソッドを呼び出して、荷渡指図書レス申込書をロックします。 ロックされた荷渡指図書レス申込書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、荷渡指図書レス申込書をルートドキュメントから参照できますが、編集中(ロック中)の荷渡指図書レス申込書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryOrderLessRequests/SetCancel/{reportId} |
荷渡指図書レス申込書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、荷渡指図書レス申込書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryOrderLessRequests/Submit/{reportId} |
荷渡指図書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した荷渡指図書レス申込書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、荷渡指図書レス申込書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、荷渡指図書レス申込書もロックされた状態のままなので、ご注意ください。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書について]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryOrderLessRequests/SubmitByPost |
荷渡指図書レス申込書を提出します。 動作は、荷渡指図書レス申込書(***/API/v2/Reports/DeliveryOrderLessRequests/Submit***)と同様です。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryOrderLessRequests/Unlock/{reportId} |
荷渡指図書レス申込書のロックを解除します 帳票ID(***reportId***)を指定して、荷渡指図書レス申込書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryOrderLessRequests/Update/{reportId} |
荷渡指図書レス申込書を更新します。 帳票ID(***reportId***)を指定して、荷渡指図書レス申込書を更新します。 このメソッドでは、荷渡指図書レス申込書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書について]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryOrderLessRequests/UpdateByPost |
荷渡指図書レス申込書を更新します。 動作は、荷渡指図書レス申込書(***/API/v2/Reports/DeliveryOrderLessRequests/Update***)と同様です。 荷渡指図書レス申込書に関する詳細については、[荷渡指図書レス申込書]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryOrderLessRequests/UploadFile |
荷渡指図書レス申込書にファイルを添付します。 指定された荷渡指図書レス申込書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
DeliveryOrders
荷渡指図書
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/DeliveryOrders/Create |
荷渡指図書を作成します。 荷渡指図書を作成するには、利用者が荷渡指図書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 荷渡指図書に関する詳細については、[荷渡指図書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DeliveryOrders/Delete/{reportId} |
荷渡指図書を削除します。 帳票ID(***reportId***)を指定して、荷渡指図書を削除します。 荷渡指図書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した荷渡指図書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 荷渡指図書に関する詳細については、[荷渡指図書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DeliveryOrders/DeleteFile/{fileId} |
荷渡指図書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、荷渡指図書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryOrders/Get/{reportId}?historyId=!{historyId} |
荷渡指図書を取得します。 帳票ID(***reportId***)を指定して、荷渡指図書を取得します。 編集が行われていない場合は、ルートドキュメントから最新の荷渡指図書を取得します。 編集中の場合は、先に保存した、荷渡指図書を取得します。 荷渡指図書に関する詳細については、[荷渡指図書について]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryOrders/GetDiff/{reportId}?historyId=!{historyId} |
保存されている荷渡指図書とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する荷渡指図書と、ルートドキュメントの差分を取得します。 比較元を保存されている荷渡指図書、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryOrders/GetFile/{fileId} |
荷渡指図書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、荷渡指図書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DeliveryOrders/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
荷渡指図書を全て取得します。 検索条件に該当する荷渡指図書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の荷渡指図書を取得します。 編集中の場合は、先に保存した、荷渡指図書を取得します。 荷渡指図書に関する詳細については、[荷渡指図書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryOrders/Lock/{reportId} |
編集するため、荷渡指図書をロックします 帳票ID(***reportId***)を指定して、荷渡指図書をロックします。 荷渡指図書を作成(***Create***)した時点では、荷渡指図書をロックが掛かりますが、取得(***Get***)したあとで、荷渡指図書を編集する場合は、このメソッドを呼び出して、荷渡指図書をロックします。 ロックされた荷渡指図書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、荷渡指図書をルートドキュメントから参照できますが、編集中(ロック中)の荷渡指図書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 荷渡指図書に関する詳細については、[荷渡指図書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryOrders/SetCancel/{reportId} |
荷渡指図書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、荷渡指図書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 荷渡指図書に関する詳細については、[荷渡指図書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryOrders/Submit/{reportId} |
荷渡指図書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した荷渡指図書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、荷渡指図書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、荷渡指図書もロックされた状態のままなので、ご注意ください。 荷渡指図書に関する詳細については、[荷渡指図書について]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryOrders/SubmitByPost |
荷渡指図書を提出します。 動作は、荷渡指図書(***/API/v2/Reports/DeliveryOrders/Submit***)と同様です。 荷渡指図書に関する詳細については、[荷渡指図書]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryOrders/Unlock/{reportId} |
荷渡指図書のロックを解除します 帳票ID(***reportId***)を指定して、荷渡指図書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 荷渡指図書に関する詳細については、[荷渡指図書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DeliveryOrders/Update/{reportId} |
荷渡指図書を更新します。 帳票ID(***reportId***)を指定して、荷渡指図書を更新します。 このメソッドでは、荷渡指図書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 荷渡指図書に関する詳細については、[荷渡指図書について]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryOrders/UpdateByPost |
荷渡指図書を更新します。 動作は、荷渡指図書(***/API/v2/Reports/DeliveryOrders/Update***)と同様です。 荷渡指図書に関する詳細については、[荷渡指図書]()を参照ください。 |
|
| POST | /API/v2/Reports/DeliveryOrders/UploadFile |
荷渡指図書にファイルを添付します。 指定された荷渡指図書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
DeliveryTerms
荷渡形態
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/DeliveryTerms/DeleteAdmin/{deliveryTermCode} |
荷渡形態を削除します。 荷渡形態コード(***deliveryTermCode***)を指定して、荷渡形態を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/DeliveryTerms/Get/{deliveryTermCode} |
荷渡形態を取得します。 荷渡形態コード(***deliveryTermCode***)を指定して、荷渡形態を取得します。 |
|
| GET | /API/v2/General/DeliveryTerms/GetList |
荷渡形態を全て取得します。 荷渡形態を全て取得します。 |
|
| POST | /API/v2/General/DeliveryTerms/RegisterAdmin |
荷渡形態を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/General/DeliveryTerms/RegisterInternal |
荷渡形態を登録します。 内部呼び出し用。 (*For admin) |
|
DepartureDeclarationListInquiries
IES_輸出申告等一覧照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DepartureDeclarationListInquiries/Create |
IESを作成します。 IESを作成するには、利用者がIESを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DepartureDeclarationListInquiries/Delete/{reportId} |
IESを削除します。 帳票ID(***reportId***)を指定して、、IESを削除します。 IESを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DepartureDeclarationListInquiries/DeleteFile/{fileId} |
IESの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IESの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DepartureDeclarationListInquiries/Get/{reportId} |
IESを取得します。 帳票ID(***reportId***)を指定して、IES取得します。 編集が行われていない場合は、ルートドキュメントから最新のIESを取得します。 編集中の場合は、先に保存した、IESを取得します。 |
|
| GET | /API/v2/NaccsReports/DepartureDeclarationListInquiries/GetFile/{fileId} |
IESに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IESに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DepartureDeclarationListInquiries/Lock/{reportId} |
編集するため、IESをロックします。 帳票ID(***reportId***)を指定して、IESをロックします。 IESを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IESを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIESは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IESをルートドキュメントから参照できますが、編集中(ロック中)のIESは参照できません。 |
|
| POST | /API/v2/NaccsReports/DepartureDeclarationListInquiries/SendToNaccs |
IESをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIESをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IESが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DepartureDeclarationListInquiries/SetCancel/{reportId} |
IESの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IESの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DepartureDeclarationListInquiries/Submit/{reportId} |
IESを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIESを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IESが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/DepartureDeclarationListInquiries/Unlock/{reportId} |
IESのロックを解除します。 帳票ID(***reportId***)を指定して、IESのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DepartureDeclarationListInquiries/Update/{reportId} |
IESを更新します。 帳票ID(***reportId***)を指定して、IESを更新します。 このメソッドでは、IESの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DepartureDeclarationListInquiries/UploadFile |
IESにファイルを添付します。 指定されたIESに、ファイルを添付します。 |
|
DgListExcelConverters
DGリスト用Excelフォーマット出力
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/DgListExcelConverters/Convert |
帳票をExcelに出力します 帳票ID(***reportId***)とExcelフォーマットコード(***excelFormatCode***)を指定して、帳票(JSON)をExcelファイルに出力、そのExcelファイルを返却します。 ExcelファイルはBase64形式でエンコードされた形で返却します。 |
|
DispatchConfirmRegistrationCargoPickUps
BOB_搬出確認登録(貨物引取り)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DispatchConfirmRegistrationCargoPickUps/Create |
BOBを作成します。 BOBを作成するには、利用者がBOBを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DispatchConfirmRegistrationCargoPickUps/Delete/{reportId} |
BOBを削除します。 帳票ID(***reportId***)を指定して、、BOBを削除します。 BOBを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DispatchConfirmRegistrationCargoPickUps/DeleteFile/{fileId} |
BOBの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、BOBの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DispatchConfirmRegistrationCargoPickUps/Get/{reportId} |
BOBを取得します。 帳票ID(***reportId***)を指定して、BOB取得します。 編集が行われていない場合は、ルートドキュメントから最新のBOBを取得します。 編集中の場合は、先に保存した、BOBを取得します。 |
|
| GET | /API/v2/NaccsReports/DispatchConfirmRegistrationCargoPickUps/GetFile/{fileId} |
BOBに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、BOBに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DispatchConfirmRegistrationCargoPickUps/Lock/{reportId} |
編集するため、BOBをロックします。 帳票ID(***reportId***)を指定して、BOBをロックします。 BOBを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、BOBを編集する場合は、このメソッドを呼び出してロックします。 ロックされたBOBは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、BOBをルートドキュメントから参照できますが、編集中(ロック中)のBOBは参照できません。 |
|
| POST | /API/v2/NaccsReports/DispatchConfirmRegistrationCargoPickUps/SendToNaccs |
BOBをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したBOBをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BOBが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DispatchConfirmRegistrationCargoPickUps/SetCancel/{reportId} |
BOBの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、BOBの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DispatchConfirmRegistrationCargoPickUps/Submit/{reportId} |
BOBを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したBOBを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BOBが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/DispatchConfirmRegistrationCargoPickUps/SubmitByPost |
BOBを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/DispatchConfirmRegistrationCargoPickUps/Unlock/{reportId} |
BOBのロックを解除します。 帳票ID(***reportId***)を指定して、BOBのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DispatchConfirmRegistrationCargoPickUps/Update/{reportId} |
BOBを更新します。 帳票ID(***reportId***)を指定して、BOBを更新します。 このメソッドでは、BOBの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DispatchConfirmRegistrationCargoPickUps/UpdateByPost |
BOBを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/DispatchConfirmRegistrationCargoPickUps/UploadFile |
BOBにファイルを添付します。 指定されたBOBに、ファイルを添付します。 |
|
DispatchConfirmRegistrationCustomsTransportCargoes
BOA_搬出確認登録(保税運送貨物)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DispatchConfirmRegistrationCustomsTransportCargoes/Create |
BOAを作成します。 BOAを作成するには、利用者がBOAを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DispatchConfirmRegistrationCustomsTransportCargoes/Delete/{reportId} |
BOAを削除します。 帳票ID(***reportId***)を指定して、、BOAを削除します。 BOAを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DispatchConfirmRegistrationCustomsTransportCargoes/DeleteFile/{fileId} |
BOAの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、BOAの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DispatchConfirmRegistrationCustomsTransportCargoes/Get/{reportId} |
BOAを取得します。 帳票ID(***reportId***)を指定して、BOA取得します。 編集が行われていない場合は、ルートドキュメントから最新のBOAを取得します。 編集中の場合は、先に保存した、BOAを取得します。 |
|
| GET | /API/v2/NaccsReports/DispatchConfirmRegistrationCustomsTransportCargoes/GetFile/{fileId} |
BOAに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、BOAに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DispatchConfirmRegistrationCustomsTransportCargoes/Lock/{reportId} |
編集するため、BOAをロックします。 帳票ID(***reportId***)を指定して、BOAをロックします。 BOAを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、BOAを編集する場合は、このメソッドを呼び出してロックします。 ロックされたBOAは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、BOAをルートドキュメントから参照できますが、編集中(ロック中)のBOAは参照できません。 |
|
| POST | /API/v2/NaccsReports/DispatchConfirmRegistrationCustomsTransportCargoes/SendToNaccs |
BOAをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したBOAをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BOAが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DispatchConfirmRegistrationCustomsTransportCargoes/SetCancel/{reportId} |
BOAの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、BOAの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DispatchConfirmRegistrationCustomsTransportCargoes/Submit/{reportId} |
BOAを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したBOAを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BOAが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/DispatchConfirmRegistrationCustomsTransportCargoes/SubmitByPost |
BOAを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/DispatchConfirmRegistrationCustomsTransportCargoes/Unlock/{reportId} |
BOAのロックを解除します。 帳票ID(***reportId***)を指定して、BOAのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DispatchConfirmRegistrationCustomsTransportCargoes/Update/{reportId} |
BOAを更新します。 帳票ID(***reportId***)を指定して、BOAを更新します。 このメソッドでは、BOAの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DispatchConfirmRegistrationCustomsTransportCargoes/UpdateByPost |
BOAを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/DispatchConfirmRegistrationCustomsTransportCargoes/UploadFile |
BOAにファイルを添付します。 指定されたBOAに、ファイルを添付します。 |
|
DispatchConfirmRegistrationExportPermitteds
BOC_搬出確認登録(輸出許可済)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/DispatchConfirmRegistrationExportPermitteds/Create |
BOCを作成します。 BOCを作成するには、利用者がBOCを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/DispatchConfirmRegistrationExportPermitteds/Delete/{reportId} |
BOCを削除します。 帳票ID(***reportId***)を指定して、、BOCを削除します。 BOCを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/DispatchConfirmRegistrationExportPermitteds/DeleteFile/{fileId} |
BOCの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、BOCの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/DispatchConfirmRegistrationExportPermitteds/Get/{reportId} |
BOCを取得します。 帳票ID(***reportId***)を指定して、BOC取得します。 編集が行われていない場合は、ルートドキュメントから最新のBOCを取得します。 編集中の場合は、先に保存した、BOCを取得します。 |
|
| GET | /API/v2/NaccsReports/DispatchConfirmRegistrationExportPermitteds/GetFile/{fileId} |
BOCに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、BOCに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/DispatchConfirmRegistrationExportPermitteds/Lock/{reportId} |
編集するため、BOCをロックします。 帳票ID(***reportId***)を指定して、BOCをロックします。 BOCを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、BOCを編集する場合は、このメソッドを呼び出してロックします。 ロックされたBOCは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、BOCをルートドキュメントから参照できますが、編集中(ロック中)のBOCは参照できません。 |
|
| POST | /API/v2/NaccsReports/DispatchConfirmRegistrationExportPermitteds/SendToNaccs |
BOCをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したBOCをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BOCが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/DispatchConfirmRegistrationExportPermitteds/SetCancel/{reportId} |
BOCの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、BOCの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/DispatchConfirmRegistrationExportPermitteds/Submit/{reportId} |
BOCを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したBOCを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BOCが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/DispatchConfirmRegistrationExportPermitteds/SubmitByPost |
BOCを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/DispatchConfirmRegistrationExportPermitteds/Unlock/{reportId} |
BOCのロックを解除します。 帳票ID(***reportId***)を指定して、BOCのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/DispatchConfirmRegistrationExportPermitteds/Update/{reportId} |
BOCを更新します。 帳票ID(***reportId***)を指定して、BOCを更新します。 このメソッドでは、BOCの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/DispatchConfirmRegistrationExportPermitteds/UpdateByPost |
BOCを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/DispatchConfirmRegistrationExportPermitteds/UploadFile |
BOCにファイルを添付します。 指定されたBOCに、ファイルを添付します。 |
|
DockReceipts
ドックレシート(D/R)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/DockReceipts/Create |
ドックレシート(D/R)を作成します。 ドックレシート(D/R)を作成するには、利用者がドックレシート(D/R)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DockReceipts/Delete/{reportId} |
ドックレシート(D/R)を削除します。 帳票ID(***reportId***)を指定して、ドックレシート(D/R)を削除します。 ドックレシート(D/R)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したドックレシート(D/R)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/DockReceipts/DeleteFile/{fileId} |
ドックレシート(D/R)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、ドックレシート(D/R)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DockReceipts/Get/{reportId}?historyId=!{historyId} |
ドックレシート(D/R)を取得します。 帳票ID(***reportId***)を指定して、ドックレシート(D/R)を取得します。 編集が行われていない場合は、ルートドキュメントから最新のドックレシート(D/R)を取得します。 編集中の場合は、先に保存した、ドックレシート(D/R)を取得します。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)について]()を参照ください。 |
|
| GET | /API/v2/Reports/DockReceipts/GetDiff/{reportId}?historyId=!{historyId} |
保存されているドックレシート(D/R)とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当するドックレシート(D/R)と、ルートドキュメントの差分を取得します。 比較元を保存されているドックレシート(D/R)、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/DockReceipts/GetFile/{fileId} |
ドックレシート(D/R)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、ドックレシート(D/R)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/DockReceipts/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
ドックレシート(D/R)を全て取得します。 検索条件に該当するドックレシート(D/R)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のドックレシート(D/R)を取得します。 編集中の場合は、先に保存した、ドックレシート(D/R)を取得します。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DockReceipts/Lock/{reportId} |
編集するため、ドックレシート(D/R)をロックします 帳票ID(***reportId***)を指定して、ドックレシート(D/R)をロックします。 ドックレシート(D/R)を作成(***Create***)した時点では、ドックレシート(D/R)をロックが掛かりますが、取得(***Get***)したあとで、ドックレシート(D/R)を編集する場合は、このメソッドを呼び出して、ドックレシート(D/R)をロックします。 ロックされたドックレシート(D/R)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、ドックレシート(D/R)をルートドキュメントから参照できますが、編集中(ロック中)のドックレシート(D/R)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DockReceipts/SetCancel/{reportId} |
ドックレシート(D/R)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、ドックレシート(D/R)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DockReceipts/Submit/{reportId} |
ドックレシート(D/R)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したドックレシート(D/R)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ドックレシート(D/R)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ドックレシート(D/R)もロックされた状態のままなので、ご注意ください。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)について]()を参照ください。 |
|
| POST | /API/v2/Reports/DockReceipts/SubmitByPost |
ドックレシート(D/R)を提出します。 動作は、ドックレシート(D/R)(***/API/v2/Reports/DockReceipts/Submit***)と同様です。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DockReceipts/Unlock/{reportId} |
ドックレシート(D/R)のロックを解除します 帳票ID(***reportId***)を指定して、ドックレシート(D/R)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/DockReceipts/Update/{reportId} |
ドックレシート(D/R)を更新します。 帳票ID(***reportId***)を指定して、ドックレシート(D/R)を更新します。 このメソッドでは、ドックレシート(D/R)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)について]()を参照ください。 |
|
| POST | /API/v2/Reports/DockReceipts/UpdateByPost |
ドックレシート(D/R)を更新します。 動作は、ドックレシート(D/R)(***/API/v2/Reports/DockReceipts/Update***)と同様です。 ドックレシート(D/R)に関する詳細については、[ドックレシート(D/R)]()を参照ください。 |
|
| POST | /API/v2/Reports/DockReceipts/UploadFile |
ドックレシート(D/R)にファイルを添付します。 指定されたドックレシート(D/R)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
DocumentClassificationCodes
書類区分コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/DocumentClassificationCodes/DeleteAdmin/{documentClassificationCode} |
書類区分コードを削除します。 書類区分コード(***documentClassificationCode***)を指定して、書類区分コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/DocumentClassificationCodes/Get/{documentClassificationCode} |
書類区分を取得します。 書類区分コード(***documentClassificationCode***)を指定して、書類区分を取得します。 書類区分コードに関する詳細については、[書類区分コードについて]()を参照ください。 |
|
| GET | /API/v2/General/DocumentClassificationCodes/GetList |
書類区分を全て取得します。 書類区分コードに関する詳細については、[書類区分コードについて]()を参照ください。 |
|
| POST | /API/v2/General/DocumentClassificationCodes/RegisterAdmin |
書類区分を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/DocumentClassificationCodes/RegisterInternal |
書類区分を登録します。 内部呼び出し用。 (*For admin) |
|
DocumentDestinationReportCountResultHistories
書類送付先ごとの白紙提出件数の集計結果履歴
DocumentDestinations
書類送付先
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/Companies/DocumentDestinations/Get/{documentDestinationId} |
書類送付先を取得します。 書類送付先ID(***documentDestinationId***)を指定して、書類送付先を取得します。 書類送付先に関する詳細については、[書類送付先について]()を参照ください。 |
|
| GET | /API/v2/Companies/DocumentDestinations/GetList?documentDestinationId=!{documentDestinationId}&companyId=!{companyId}&organizationId=!{organizationId}&submissionBranchCode=!{submissionBranchCode}&isActive=!{isActive} |
書類送付先を全て取得します。 |
|
| POST | /API/v2/Companies/DocumentDestinations/Register |
書類送付先を登録します。 |
|
| POST | /API/v2/Companies/DocumentDestinations/RegisterList |
書類送付先を一括で登録します。 |
|
| PATCH | /API/v2/Companies/DocumentDestinations/Update/{documentDestinationId} |
書類送付先を更新します。 書類送付先ID(***documentDestinationId***)を指定して、書類送付先を更新します。 |
|
DomesticConsumptionTaxExemptionCodes
内国消費税免税コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/DomesticConsumptionTaxExemptionCodes/DeleteAdmin/{domesticConsumptionTaxExemptionCode} |
内国消費税免税コードを削除します。 内国消費税免税コード(***domesticConsumptionTaxExemptionCode***)を指定して、内国消費税免税コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/DomesticConsumptionTaxExemptionCodes/Get/{domesticConsumptionTaxExemptionCode} |
内国消費税免税種別を取得します。 内国消費税免税コード(***domesticConsumptionTaxExemptionCode***)を指定して、内国消費税免税種別を取得します。 内国消費税免税コードに関する詳細については、[内国消費税免税コードについて]()を参照ください。 |
|
| GET | /API/v2/General/DomesticConsumptionTaxExemptionCodes/GetList |
内国消費税免税種別を全て取得します。 内国消費税免税コードに関する詳細については、[内国消費税免税コードについて]()を参照ください。 |
|
| POST | /API/v2/General/DomesticConsumptionTaxExemptionCodes/RegisterAdmin |
内国消費税免税種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/DomesticConsumptionTaxExemptionCodes/RegisterInternal |
内国消費税免税種別を登録します。 内部呼び出し用。 (*For admin) |
|
DomesticConsumptionTaxReductionAndExemptionCodes
内国消費税等減免税コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/DomesticConsumptionTaxReductionAndExemptionCodes/DeleteAdmin/{domesticConsumptionTaxReductionAndExemptionCode} |
内国消費税等減免税コードを削除します。 内国消費税等減免税コード(***domesticConsumptionTaxReductionAndExemptionCode***)を指定して、内国消費税等減免税コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/DomesticConsumptionTaxReductionAndExemptionCodes/Get/{domesticConsumptionTaxReductionAndExemptionCode} |
内国消費税等減免税種別を取得します。 内国消費税等減免税コード(***domesticConsumptionTaxReductionAndExemptionCode***)を指定して、内国消費税等減免税種別を取得します。 内国消費税等減免税コードに関する詳細については、[内国消費税等減免税コードについて]()を参照ください。 |
|
| GET | /API/v2/General/DomesticConsumptionTaxReductionAndExemptionCodes/GetList |
内国消費税等減免税種別を全て取得します。 内国消費税等減免税コードに関する詳細については、[内国消費税等減免税コードについて]()を参照ください。 |
|
| POST | /API/v2/General/DomesticConsumptionTaxReductionAndExemptionCodes/RegisterAdmin |
内国消費税等減免税種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/DomesticConsumptionTaxReductionAndExemptionCodes/RegisterInternal |
内国消費税等減免税種別を登録します。 内部呼び出し用。 (*For admin) |
|
DomesticConsumptionTaxTypeCodes
内国消費税等種別コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/DomesticConsumptionTaxTypeCodes/DeleteAdmin/{domesticConsumptionTaxTypeCode} |
内国消費税等種別コードを削除します。 内国消費税等種別コード(***domesticConsumptionTaxTypeCode***)を指定して、内国消費税等種別コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/DomesticConsumptionTaxTypeCodes/Get/{domesticConsumptionTaxTypeCode} |
内国消費税等種別を取得します。 内国消費税等種別コード(***domesticConsumptionTaxTypeCode***)を指定して、原産地証明書識別を取得します。 内国消費税等種別コードに関する詳細については、[内国消費税等種別コードについて]()を参照ください。 |
|
| GET | /API/v2/General/DomesticConsumptionTaxTypeCodes/GetList |
内国消費税等種別を全て取得します。 内国消費税等種別コードに関する詳細については、[内国消費税等種別コードについて]()を参照ください。 |
|
| POST | /API/v2/General/DomesticConsumptionTaxTypeCodes/RegisterAdmin |
内国消費税等種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/DomesticConsumptionTaxTypeCodes/RegisterInternal |
内国消費税等種別を登録します。 内部呼び出し用。 (*For admin) |
|
EmergencyMeasures
緊急措置
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/EmergencyMeasures/DeleteAdmin/{emergencyMeasureCode} |
緊急措置を削除します。 緊急措置コード(***emergencyMeasureCode***)を指定して、緊急措置を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/EmergencyMeasures/Get/{emergencyMeasureCode} |
緊急措置を取得します。 緊急措置コード(***emergencyMeasureCode***)を指定して、緊急措置を取得します。 |
|
| GET | /API/v2/General/EmergencyMeasures/GetList |
緊急措置を全て取得します。 緊急措置を全て取得します。 |
|
| POST | /API/v2/General/EmergencyMeasures/RegisterAdmin |
緊急措置を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/General/EmergencyMeasures/RegisterInternal |
緊急措置を登録します。 内部呼び出し用。 (*For admin) |
|
Employees
利用者
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Employees/Delete/{employeeId} |
利用者を削除します。 利用者ID(***employeeId***)を指定して、会社に所属する利用者を削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 利用者に関する詳細については、[利用者について]()を参照ください。 |
|
| GET | /API/v2/Employees/Get |
利用者を取得します。 ログインしている利用者を取得します。 利用者に関する詳細については、[利用者について]()を参照ください。 |
|
| GET | /API/v2/Employees/GetAccessibleReports |
利用者がアクセス可能な帳票を全て取得します。 ログインしている利用者がアクセス可能な帳票を全て取得します。 アクセス可能な帳票は、利用者が所属している組織に割り当てられた事業種別を条件に、(***/API/v2/Master/ReportTypes/Permissions****)で、アクセス権限がR権限以上のものを取得します。 |
|
| GET | /API/v2/Employees/GetCoworkers?employeeId=!{employeeId}&emailAddress=!{emailAddress}&isActive=!{isActive} |
会社の利用者を全て取得します。 ログインしている利用者が所属する会社配下に登録されている全ての利用者を取得します。 利用者に関する詳細については、[利用者について]()を参照ください。 |
|
| POST | /API/v2/Employees/Register |
所属する会社に利用者を登録します。 管理者が所属する会社に、利用者を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 利用者に関する詳細については、[利用者について]()を参照ください。 |
|
| POST | /API/v2/Employees/RegisterList |
所属する会社に利用者を一括で登録します。 管理者が所属する会社に、利用者を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 利用者に関する詳細については、[利用者について]()を参照ください。 |
|
| PATCH | /API/v2/Employees/SetActive/{employeeId} |
利用者が有効であるか(isActive)を更新します。 利用者ID(***employeeId***)を指定して、利用者が有効であるか(***isActive***)を更新します。 isActiveをfalseにすると、その利用者は、 - ログインできなくなります。 - 一部を除き、サイバーポートのAPIは呼び出せません。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 利用者に関する詳細については、[利用者について]()を参照ください。 |
|
| PATCH | /API/v2/Employees/SetDefaultOrganization/{employeeId} |
利用者が所属する組織の中からデフォルトの組織を更新します。 利用者ID(***employeeId***)を指定して、会社に所属する利用者について、利用者が所属する組織の中からデフォルトの組織を更新します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 利用者に関する詳細については、[利用者について]()を参照ください。 |
|
| PATCH | /API/v2/Employees/SetEmployeeName |
利用者の氏名を更新します。 ログインしている利用者の氏名を更新します。 利用者に関する詳細については、[利用者について]()を参照ください。 |
|
| PATCH | /API/v2/Employees/SetEmployeeName/{employeeId} |
利用者の氏名を更新します。 利用者ID(***employeeId***)を指定して、利用者の氏名を更新します。 利用者に関する詳細については、[利用者について]()を参照ください。 |
|
| PATCH | /API/v2/Employees/SetLanguage |
利用者が利用する言語を更新します。 ログインしている利用者が利用する言語を更新します。 利用者に関する詳細については、[利用者について]()を参照ください。 |
|
| PATCH | /API/v2/Employees/SetMailType |
利用者が通知で受け取るメール形式やメールアドレスを更新します。 ログインしているが通知で受け取るメール形式やメールアドレスを更新します。 利用者の通知設定に関する詳細については、[利用者の通知設定について]()を参照ください。 |
|
EmptyContainerDeliveryRegistrations
PCD_空コンテナ引渡情報登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/EmptyContainerDeliveryRegistrations/Create |
PCDを作成します。 PCDを作成するには、利用者がPCDを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/EmptyContainerDeliveryRegistrations/Delete/{reportId} |
PCDを削除します。 帳票ID(***reportId***)を指定して、、PCDを削除します。 PCDを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/EmptyContainerDeliveryRegistrations/DeleteFile/{fileId} |
PCDの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、PCDの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/EmptyContainerDeliveryRegistrations/Get/{reportId} |
PCDを取得します。 帳票ID(***reportId***)を指定して、PCD取得します。 編集が行われていない場合は、ルートドキュメントから最新のPCDを取得します。 編集中の場合は、先に保存した、PCDを取得します。 |
|
| GET | /API/v2/NaccsReports/EmptyContainerDeliveryRegistrations/GetFile/{fileId} |
PCDに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、PCDに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerDeliveryRegistrations/Lock/{reportId} |
編集するため、PCDをロックします。 帳票ID(***reportId***)を指定して、PCDをロックします。 PCDを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、PCDを編集する場合は、このメソッドを呼び出してロックします。 ロックされたPCDは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、PCDをルートドキュメントから参照できますが、編集中(ロック中)のPCDは参照できません。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerDeliveryRegistrations/SendToNaccs |
PCDをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したPCDをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、PCDが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerDeliveryRegistrations/SetCancel/{reportId} |
PCDの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、PCDの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerDeliveryRegistrations/Submit/{reportId} |
PCDを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したPCDを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、PCDが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerDeliveryRegistrations/SubmitByPost |
PCDを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerDeliveryRegistrations/Unlock/{reportId} |
PCDのロックを解除します。 帳票ID(***reportId***)を指定して、PCDのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerDeliveryRegistrations/Update/{reportId} |
PCDを更新します。 帳票ID(***reportId***)を指定して、PCDを更新します。 このメソッドでは、PCDの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerDeliveryRegistrations/UpdateByPost |
PCDを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerDeliveryRegistrations/UploadFile |
PCDにファイルを添付します。 指定されたPCDに、ファイルを添付します。 |
|
EmptyContainerPickUpAnswerCalls
PUA11_空コンテナピックアップ回答呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpAnswerCalls/Create |
PUA11を作成します。 PUA11を作成するには、利用者がPUA11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/EmptyContainerPickUpAnswerCalls/Delete/{reportId} |
PUA11を削除します。 帳票ID(***reportId***)を指定して、、PUA11を削除します。 PUA11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/EmptyContainerPickUpAnswerCalls/DeleteFile/{fileId} |
PUA11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、PUA11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/EmptyContainerPickUpAnswerCalls/Get/{reportId} |
PUA11を取得します。 帳票ID(***reportId***)を指定して、PUA11取得します。 編集が行われていない場合は、ルートドキュメントから最新のPUA11を取得します。 編集中の場合は、先に保存した、PUA11を取得します。 |
|
| GET | /API/v2/NaccsReports/EmptyContainerPickUpAnswerCalls/GetFile/{fileId} |
PUA11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、PUA11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpAnswerCalls/Lock/{reportId} |
編集するため、PUA11をロックします。 帳票ID(***reportId***)を指定して、PUA11をロックします。 PUA11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、PUA11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたPUA11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、PUA11をルートドキュメントから参照できますが、編集中(ロック中)のPUA11は参照できません。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpAnswerCalls/SendToNaccs |
PUA11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したPUA11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、PUA11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpAnswerCalls/SetCancel/{reportId} |
PUA11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、PUA11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpAnswerCalls/Submit/{reportId} |
PUA11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したPUA11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、PUA11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpAnswerCalls/Unlock/{reportId} |
PUA11のロックを解除します。 帳票ID(***reportId***)を指定して、PUA11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpAnswerCalls/Update/{reportId} |
PUA11を更新します。 帳票ID(***reportId***)を指定して、PUA11を更新します。 このメソッドでは、PUA11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpAnswerCalls/UploadFile |
PUA11にファイルを添付します。 指定されたPUA11に、ファイルを添付します。 |
|
EmptyContainerPickUpAnswers
PUA_空コンテナピックアップ回答
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpAnswers/Create |
PUAを作成します。 PUAを作成するには、利用者がPUAを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/EmptyContainerPickUpAnswers/Delete/{reportId} |
PUAを削除します。 帳票ID(***reportId***)を指定して、、PUAを削除します。 PUAを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/EmptyContainerPickUpAnswers/DeleteFile/{fileId} |
PUAの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、PUAの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/EmptyContainerPickUpAnswers/Get/{reportId} |
PUAを取得します。 帳票ID(***reportId***)を指定して、PUA取得します。 編集が行われていない場合は、ルートドキュメントから最新のPUAを取得します。 編集中の場合は、先に保存した、PUAを取得します。 |
|
| GET | /API/v2/NaccsReports/EmptyContainerPickUpAnswers/GetFile/{fileId} |
PUAに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、PUAに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpAnswers/Lock/{reportId} |
編集するため、PUAをロックします。 帳票ID(***reportId***)を指定して、PUAをロックします。 PUAを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、PUAを編集する場合は、このメソッドを呼び出してロックします。 ロックされたPUAは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、PUAをルートドキュメントから参照できますが、編集中(ロック中)のPUAは参照できません。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpAnswers/SendToNaccs |
PUAをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したPUAをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、PUAが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpAnswers/SetCancel/{reportId} |
PUAの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、PUAの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpAnswers/Submit/{reportId} |
PUAを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したPUAを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、PUAが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpAnswers/SubmitByPost |
PUAを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpAnswers/Unlock/{reportId} |
PUAのロックを解除します。 帳票ID(***reportId***)を指定して、PUAのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpAnswers/Update/{reportId} |
PUAを更新します。 帳票ID(***reportId***)を指定して、PUAを更新します。 このメソッドでは、PUAの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpAnswers/UpdateByPost |
PUAを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpAnswers/UploadFile |
PUAにファイルを添付します。 指定されたPUAに、ファイルを添付します。 |
|
EmptyContainerPickUpChangeCalls
PUH11_空コンテナピックアップ変更呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpChangeCalls/Create |
PUH11を作成します。 PUH11を作成するには、利用者がPUH11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/EmptyContainerPickUpChangeCalls/Delete/{reportId} |
PUH11を削除します。 帳票ID(***reportId***)を指定して、、PUH11を削除します。 PUH11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/EmptyContainerPickUpChangeCalls/DeleteFile/{fileId} |
PUH11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、PUH11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/EmptyContainerPickUpChangeCalls/Get/{reportId} |
PUH11を取得します。 帳票ID(***reportId***)を指定して、PUH11取得します。 編集が行われていない場合は、ルートドキュメントから最新のPUH11を取得します。 編集中の場合は、先に保存した、PUH11を取得します。 |
|
| GET | /API/v2/NaccsReports/EmptyContainerPickUpChangeCalls/GetFile/{fileId} |
PUH11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、PUH11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpChangeCalls/Lock/{reportId} |
編集するため、PUH11をロックします。 帳票ID(***reportId***)を指定して、PUH11をロックします。 PUH11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、PUH11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたPUH11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、PUH11をルートドキュメントから参照できますが、編集中(ロック中)のPUH11は参照できません。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpChangeCalls/SendToNaccs |
PUH11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したPUH11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、PUH11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpChangeCalls/SetCancel/{reportId} |
PUH11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、PUH11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpChangeCalls/Submit/{reportId} |
PUH11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したPUH11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、PUH11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpChangeCalls/Unlock/{reportId} |
PUH11のロックを解除します。 帳票ID(***reportId***)を指定して、PUH11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpChangeCalls/Update/{reportId} |
PUH11を更新します。 帳票ID(***reportId***)を指定して、PUH11を更新します。 このメソッドでは、PUH11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpChangeCalls/UploadFile |
PUH11にファイルを添付します。 指定されたPUH11に、ファイルを添付します。 |
|
EmptyContainerPickUpChanges
PUH_空コンテナピックアップ変更
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpChanges/Create |
PUHを作成します。 PUHを作成するには、利用者がPUHを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/EmptyContainerPickUpChanges/Delete/{reportId} |
PUHを削除します。 帳票ID(***reportId***)を指定して、、PUHを削除します。 PUHを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/EmptyContainerPickUpChanges/DeleteFile/{fileId} |
PUHの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、PUHの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/EmptyContainerPickUpChanges/Get/{reportId} |
PUHを取得します。 帳票ID(***reportId***)を指定して、PUH取得します。 編集が行われていない場合は、ルートドキュメントから最新のPUHを取得します。 編集中の場合は、先に保存した、PUHを取得します。 |
|
| GET | /API/v2/NaccsReports/EmptyContainerPickUpChanges/GetFile/{fileId} |
PUHに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、PUHに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpChanges/Lock/{reportId} |
編集するため、PUHをロックします。 帳票ID(***reportId***)を指定して、PUHをロックします。 PUHを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、PUHを編集する場合は、このメソッドを呼び出してロックします。 ロックされたPUHは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、PUHをルートドキュメントから参照できますが、編集中(ロック中)のPUHは参照できません。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpChanges/SendToNaccs |
PUHをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したPUHをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、PUHが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpChanges/SetCancel/{reportId} |
PUHの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、PUHの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpChanges/Submit/{reportId} |
PUHを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したPUHを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、PUHが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpChanges/SubmitByPost |
PUHを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpChanges/Unlock/{reportId} |
PUHのロックを解除します。 帳票ID(***reportId***)を指定して、PUHのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpChanges/Update/{reportId} |
PUHを更新します。 帳票ID(***reportId***)を指定して、PUHを更新します。 このメソッドでは、PUHの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpChanges/UpdateByPost |
PUHを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpChanges/UploadFile |
PUHにファイルを添付します。 指定されたPUHに、ファイルを添付します。 |
|
EmptyContainerPickUpLists
PUL_空コンテナピックアップ一覧作成
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpLists/Create |
PULを作成します。 PULを作成するには、利用者がPULを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/EmptyContainerPickUpLists/Delete/{reportId} |
PULを削除します。 帳票ID(***reportId***)を指定して、、PULを削除します。 PULを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/EmptyContainerPickUpLists/DeleteFile/{fileId} |
PULの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、PULの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/EmptyContainerPickUpLists/Get/{reportId} |
PULを取得します。 帳票ID(***reportId***)を指定して、PUL取得します。 編集が行われていない場合は、ルートドキュメントから最新のPULを取得します。 編集中の場合は、先に保存した、PULを取得します。 |
|
| GET | /API/v2/NaccsReports/EmptyContainerPickUpLists/GetFile/{fileId} |
PULに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、PULに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpLists/Lock/{reportId} |
編集するため、PULをロックします。 帳票ID(***reportId***)を指定して、PULをロックします。 PULを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、PULを編集する場合は、このメソッドを呼び出してロックします。 ロックされたPULは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、PULをルートドキュメントから参照できますが、編集中(ロック中)のPULは参照できません。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpLists/SendToNaccs |
PULをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したPULをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、PULが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpLists/SetCancel/{reportId} |
PULの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、PULの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpLists/Submit/{reportId} |
PULを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したPULを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、PULが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpLists/Unlock/{reportId} |
PULのロックを解除します。 帳票ID(***reportId***)を指定して、PULのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpLists/Update/{reportId} |
PULを更新します。 帳票ID(***reportId***)を指定して、PULを更新します。 このメソッドでは、PULの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpLists/UploadFile |
PULにファイルを添付します。 指定されたPULに、ファイルを添付します。 |
|
EmptyContainerPickUpOrders
空コンテナピックアップオーダー
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/EmptyContainerPickUpOrders/Create |
空コンテナピックアップオーダーを作成します。 空コンテナピックアップオーダーを作成するには、利用者が空コンテナピックアップオーダーを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
| DELETE | /API/v2/Reports/EmptyContainerPickUpOrders/Delete/{reportId} |
空コンテナピックアップオーダーを削除します。 帳票ID(***reportId***)を指定して、空コンテナピックアップオーダーを削除します。 空コンテナピックアップオーダーを削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した空コンテナピックアップオーダーのキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
| DELETE | /API/v2/Reports/EmptyContainerPickUpOrders/DeleteFile/{fileId} |
空コンテナピックアップオーダーの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、空コンテナピックアップオーダーの添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/EmptyContainerPickUpOrders/Get/{reportId}?historyId=!{historyId} |
空コンテナピックアップオーダーを取得します。 帳票ID(***reportId***)を指定して、空コンテナピックアップオーダーを取得します。 編集が行われていない場合は、ルートドキュメントから最新の空コンテナピックアップオーダーを取得します。 編集中の場合は、先に保存した、空コンテナピックアップオーダーを取得します。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
| GET | /API/v2/Reports/EmptyContainerPickUpOrders/GetDiff/{reportId}?historyId=!{historyId} |
保存されている空コンテナピックアップオーダーとルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する空コンテナピックアップオーダーと、ルートドキュメントの差分を取得します。 比較元を保存されている空コンテナピックアップオーダー、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/EmptyContainerPickUpOrders/GetFile/{fileId} |
空コンテナピックアップオーダーに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、空コンテナピックアップオーダーに添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/EmptyContainerPickUpOrders/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
空コンテナピックアップオーダーを全て取得します。 検索条件に該当する空コンテナピックアップオーダーを全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の空コンテナピックアップオーダーを取得します。 編集中の場合は、先に保存した、空コンテナピックアップオーダーを取得します。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EmptyContainerPickUpOrders/Lock/{reportId} |
編集するため、空コンテナピックアップオーダー回答をロックします 帳票ID(***reportId***)を指定して、空コンテナピックアップオーダーをロックします。 空コンテナピックアップオーダーを作成(***Create***)した時点では、空コンテナピックアップオーダーをロックが掛かりますが、取得(***Get***)したあとで、空コンテナピックアップオーダーを編集する場合は、このメソッドを呼び出して、空コンテナピックアップオーダーをロックします。 ロックされた空コンテナピックアップオーダーは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、空コンテナピックアップオーダーをルートドキュメントから参照できますが、編集中(ロック中)の空コンテナピックアップオーダー回答は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EmptyContainerPickUpOrders/SetCancel/{reportId} |
空コンテナピックアップオーダーの申請種別をキャンセルします 帳票ID(***reportId***)を指定して、空コンテナピックアップオーダーの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EmptyContainerPickUpOrders/Submit/{reportId} |
空コンテナピックアップオーダーを提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した空コンテナピックアップオーダーを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、空コンテナピックアップオーダーが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、空コンテナピックアップオーダーもロックされた状態のままなので、ご注意ください。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
| POST | /API/v2/Reports/EmptyContainerPickUpOrders/SubmitByPost |
空コンテナピックアップオーダーを提出します 動作は、空コンテナピックアップオーダーの提出(***/API/v2/Reports/EmptyContainerPickUpOrders/Submit***)と同様です。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EmptyContainerPickUpOrders/Unlock/{reportId} |
空コンテナピックアップオーダーのロックを解除します 帳票ID(***reportId***)を指定して、空コンテナピックアップオーダーのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EmptyContainerPickUpOrders/Update/{reportId} |
空コンテナピックアップオーダーを更新します。 帳票ID(***reportId***)を指定して、空コンテナピックアップオーダーを更新します。 このメソッドでは、空コンテナピックアップオーダーの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
| POST | /API/v2/Reports/EmptyContainerPickUpOrders/UpdateByPost |
空コンテナピックアップオーダーを更新します。 動作は、空コンテナピックアップオーダーの更新(***/API/v2/Reports/EmptyContainerPickUpOrders/Update***)と同様です。 空コンテナピックアップオーダーに関する詳細については、[空コンテナピックアップオーダーについて]()を参照ください。 |
|
| POST | /API/v2/Reports/EmptyContainerPickUpOrders/UploadFile |
空コンテナピックアップオーダーにファイルを添付します。 指定された空コンテナピックアップオーダーに、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
EmptyContainerPickUpRegistrationCalls
PUR11_空コンテナピックアップ登録呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpRegistrationCalls/Create |
PUR11を作成します。 PUR11を作成するには、利用者がPUR11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/EmptyContainerPickUpRegistrationCalls/Delete/{reportId} |
PUR11を削除します。 帳票ID(***reportId***)を指定して、、PUR11を削除します。 PUR11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/EmptyContainerPickUpRegistrationCalls/DeleteFile/{fileId} |
PUR11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、PUR11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/EmptyContainerPickUpRegistrationCalls/Get/{reportId} |
PUR11を取得します。 帳票ID(***reportId***)を指定して、PUR11取得します。 編集が行われていない場合は、ルートドキュメントから最新のPUR11を取得します。 編集中の場合は、先に保存した、PUR11を取得します。 |
|
| GET | /API/v2/NaccsReports/EmptyContainerPickUpRegistrationCalls/GetFile/{fileId} |
PUR11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、PUR11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpRegistrationCalls/Lock/{reportId} |
編集するため、PUR11をロックします。 帳票ID(***reportId***)を指定して、PUR11をロックします。 PUR11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、PUR11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたPUR11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、PUR11をルートドキュメントから参照できますが、編集中(ロック中)のPUR11は参照できません。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpRegistrationCalls/SendToNaccs |
PUR11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したPUR11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、PUR11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpRegistrationCalls/SetCancel/{reportId} |
PUR11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、PUR11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpRegistrationCalls/Submit/{reportId} |
PUR11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したPUR11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、PUR11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpRegistrationCalls/Unlock/{reportId} |
PUR11のロックを解除します。 帳票ID(***reportId***)を指定して、PUR11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpRegistrationCalls/Update/{reportId} |
PUR11を更新します。 帳票ID(***reportId***)を指定して、PUR11を更新します。 このメソッドでは、PUR11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpRegistrationCalls/UploadFile |
PUR11にファイルを添付します。 指定されたPUR11に、ファイルを添付します。 |
|
EmptyContainerPickUpRegistrations
PUR_空コンテナピックアップ登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpRegistrations/Create |
PURを作成します。 PURを作成するには、利用者がPURを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/EmptyContainerPickUpRegistrations/Delete/{reportId} |
PURを削除します。 帳票ID(***reportId***)を指定して、、PURを削除します。 PURを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/EmptyContainerPickUpRegistrations/DeleteFile/{fileId} |
PURの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、PURの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/EmptyContainerPickUpRegistrations/Get/{reportId} |
PURを取得します。 帳票ID(***reportId***)を指定して、PUR取得します。 編集が行われていない場合は、ルートドキュメントから最新のPURを取得します。 編集中の場合は、先に保存した、PURを取得します。 |
|
| GET | /API/v2/NaccsReports/EmptyContainerPickUpRegistrations/GetFile/{fileId} |
PURに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、PURに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpRegistrations/Lock/{reportId} |
編集するため、PURをロックします。 帳票ID(***reportId***)を指定して、PURをロックします。 PURを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、PURを編集する場合は、このメソッドを呼び出してロックします。 ロックされたPURは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、PURをルートドキュメントから参照できますが、編集中(ロック中)のPURは参照できません。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpRegistrations/SendToNaccs |
PURをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したPURをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、PURが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpRegistrations/SetCancel/{reportId} |
PURの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、PURの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpRegistrations/Submit/{reportId} |
PURを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したPURを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、PURが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpRegistrations/SubmitByPost |
PURを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpRegistrations/Unlock/{reportId} |
PURのロックを解除します。 帳票ID(***reportId***)を指定して、PURのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/EmptyContainerPickUpRegistrations/Update/{reportId} |
PURを更新します。 帳票ID(***reportId***)を指定して、PURを更新します。 このメソッドでは、PURの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpRegistrations/UpdateByPost |
PURを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/EmptyContainerPickUpRegistrations/UploadFile |
PURにファイルを添付します。 指定されたPURに、ファイルを添付します。 |
|
EquipmentInterchangeReceipts-In-Empty
機器受領書(IN EMPTY)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/Create |
機器受領書(IN EMPTY)を作成します。 機器受領書(IN EMPTY)を作成するには、利用者が機器受領書(IN EMPTY)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/Delete/{reportId} |
機器受領書(IN EMPTY)を削除します。 帳票ID(***reportId***)を指定して、機器受領書(IN EMPTY)を削除します。 機器受領書(IN EMPTY)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した機器受領書(IN EMPTY)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/DeleteFile/{fileId} |
機器受領書(IN EMPTY)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、機器受領書(IN EMPTY)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/Get/{reportId}?historyId=!{historyId} |
機器受領書(IN EMPTY)を取得します。 帳票ID(***reportId***)を指定して、機器受領書(IN EMPTY)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の機器受領書(IN EMPTY)を取得します。 編集中の場合は、先に保存した、機器受領書(IN EMPTY)を取得します。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
| GET | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/GetDiff/{reportId}?historyId=!{historyId} |
保存されている機器受領書(IN EMPTY)とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する機器受領書(IN EMPTY)と、ルートドキュメントの差分を取得します。 比較元を保存されている機器受領書(IN EMPTY)、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/GetFile/{fileId} |
機器受領書(IN EMPTY)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、機器受領書(IN EMPTY)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
機器受領書(IN EMPTY)を全て取得します。 検索条件に該当する機器受領書(IN EMPTY)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の機器受領書(IN EMPTY)を取得します。 編集中の場合は、先に保存した、機器受領書(IN EMPTY)を取得します。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/Lock/{reportId} |
編集するため、機器受領書(IN EMPTY)をロックします 帳票ID(***reportId***)を指定して、機器受領書(IN EMPTY)をロックします。 機器受領書(IN EMPTY)を作成(***Create***)した時点では、機器受領書(IN EMPTY)をロックが掛かりますが、取得(***Get***)したあとで、機器受領書(IN EMPTY)を編集する場合は、このメソッドを呼び出して、機器受領書(IN EMPTY)をロックします。 ロックされた機器受領書(IN EMPTY)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、機器受領書(IN EMPTY)をルートドキュメントから参照できますが、編集中(ロック中)の機器受領書(IN EMPTY)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/SetCancel/{reportId} |
機器受領書(IN EMPTY)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、機器受領書(IN EMPTY)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/Submit/{reportId} |
機器受領書(IN EMPTY)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した機器受領書(IN EMPTY)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、機器受領書(IN EMPTY)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、機器受領書(IN EMPTY)もロックされた状態のままなので、ご注意ください。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
| POST | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/SubmitByPost |
機器受領書(IN EMPTY)を提出します 動作は、機器受領書(IN EMPTY)(***/API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/Submit***)と同様です。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/Unlock/{reportId} |
機器受領書(IN EMPTY)のロックを解除します 帳票ID(***reportId***)を指定して、機器受領書(IN EMPTY)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/Update/{reportId} |
機器受領書(IN EMPTY)を更新します。 帳票ID(***reportId***)を指定して、機器受領書(IN EMPTY)を更新します。 このメソッドでは、機器受領書(IN EMPTY)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)について]()を参照ください。 |
|
| POST | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/UpdateByPost |
機器受領書(IN EMPTY)を更新します。 動作は、機器受領書(IN EMPTY)(***/API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/Update***)と同様です。 機器受領書(IN EMPTY)に関する詳細については、[機器受領書(IN EMPTY)]()を参照ください。 |
|
| POST | /API/v2/Reports/EquipmentInterchangeReceipts-In-Empty/UploadFile |
機器受領書(IN EMPTY)にファイルを添付します。 指定された機器受領書(IN EMPTY)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
EquipmentInterchangeReceipts-In-Full
機器受領書(IN FULL)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/Create |
機器受領書(IN FULL)を作成します。 機器受領書(IN FULL)を作成するには、利用者が機器受領書(IN FULL)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/Delete/{reportId} |
機器受領書(IN FULL)を削除します。 帳票ID(***reportId***)を指定して、機器受領書(IN FULL)を削除します。 機器受領書(IN FULL)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した機器受領書(IN FULL)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/DeleteFile/{fileId} |
機器受領書(IN FULL)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、機器受領書(IN FULL)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/Get/{reportId}?historyId=!{historyId} |
機器受領書(IN FULL)を取得します。 帳票ID(***reportId***)を指定して、機器受領書(IN FULL)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の機器受領書(IN FULL)を取得します。 編集中の場合は、先に保存した、機器受領書(IN FULL)を取得します。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
| GET | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/GetDiff/{reportId}?historyId=!{historyId} |
保存されている機器受領書(IN FULL)とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する機器受領書(IN FULL)と、ルートドキュメントの差分を取得します。 比較元を保存されている機器受領書(IN FULL)、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/GetFile/{fileId} |
機器受領書(IN FULL)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、機器受領書(OUT FULL)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
機器受領書(IN FULL)を全て取得します。 検索条件に該当する機器受領書(IN FULL)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の機器受領書(IN FULL)を取得します。 編集中の場合は、先に保存した、機器受領書(IN FULL)を取得します。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/Lock/{reportId} |
編集するため、機器受領書(IN FULL)をロックします 帳票ID(***reportId***)を指定して、機器受領書(IN FULL)をロックします。 機器受領書(IN FULL)を作成(***Create***)した時点では、機器受領書(IN FULL)をロックが掛かりますが、取得(***Get***)したあとで、機器受領書(IN FULL)を編集する場合は、このメソッドを呼び出して、機器受領書(IN FULL)をロックします。 ロックされた機器受領書(IN FULL)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、機器受領書(IN FULL)をルートドキュメントから参照できますが、編集中(ロック中)の機器受領書(IN FULL)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/SetCancel/{reportId} |
機器受領書(IN FULL)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、機器受領書(IN FULL)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/Submit/{reportId} |
機器受領書(IN FULL)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した機器受領書(IN FULL)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、機器受領書(IN FULL)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、機器受領書(IN FULL)もロックされた状態のままなので、ご注意ください。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
| POST | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/SubmitByPost |
機器受領書(IN FULL)を提出します 動作は、機器受領書(IN FULL)(***/API/v2/Reports/EquipmentInterchangeReceipts-In-Full/Submit***)と同様です。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/Unlock/{reportId} |
機器受領書(IN FULL)のロックを解除します 帳票ID(***reportId***)を指定して、機器受領書(IN FULL)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/Update/{reportId} |
機器受領書(IN FULL)を更新します。 帳票ID(***reportId***)を指定して、機器受領書(IN FULL)を更新します。 このメソッドでは、機器受領書(IN FULL)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)について]()を参照ください。 |
|
| POST | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/UpdateByPost |
機器受領書(IN FULL)を更新します。 動作は、機器受領書(IN FULL)(***/API/v2/Reports/EquipmentInterchangeReceipts-In-Full/Update***)と同様です。 機器受領書(IN FULL)に関する詳細については、[機器受領書(IN FULL)]()を参照ください。 |
|
| POST | /API/v2/Reports/EquipmentInterchangeReceipts-In-Full/UploadFile |
機器受領書(IN FULL)にファイルを添付します。 指定された機器受領書(IN FULL)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
EquipmentInterchangeReceipts-Out-Empty
機器受領書(OUT EMPTY)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/Create |
機器受領書(OUT EMPTY)を作成します。 機器受領書(OUT EMPTY)を作成するには、利用者が機器受領書(OUT EMPTY)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/Delete/{reportId} |
機器受領書(OUT EMPTY)を削除します。 帳票ID(***reportId***)を指定して、機器受領書(OUT EMPTY)を削除します。 機器受領書(OUT EMPTY)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した機器受領書(OUT EMPTY)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/DeleteFile/{fileId} |
機器受領書(OUT EMPTY)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、機器受領書(OUT EMPTY)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/Get/{reportId}?historyId=!{historyId} |
機器受領書(OUT EMPTY)を取得します。 帳票ID(***reportId***)を指定して、機器受領書(OUT EMPTY)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の機器受領書(OUT EMPTY)を取得します。 編集中の場合は、先に保存した、機器受領書(OUT EMPTY)を取得します。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
| GET | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/GetDiff/{reportId}?historyId=!{historyId} |
保存されている機器受領書(OUT EMPTY)とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する機器受領書(OUT EMPTY)と、ルートドキュメントの差分を取得します。 比較元を保存されている機器受領書(OUT EMPTY)、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/GetFile/{fileId} |
機器受領書(OUT EMPTY)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、機器受領書(OUT EMPTY)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
機器受領書(OUT EMPTY)を全て取得します。 検索条件に該当する機器受領書(OUT EMPTY)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の機器受領書(OUT EMPTY)を取得します。 編集中の場合は、先に保存した、機器受領書(OUT EMPTY)を取得します。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/Lock/{reportId} |
編集するため、機器受領書(OUT EMPTY)をロックします 帳票ID(***reportId***)を指定して、機器受領書(OUT EMPTY)をロックします。 機器受領書(OUT EMPTY)を作成(***Create***)した時点では、機器受領書(OUT EMPTY)をロックが掛かりますが、取得(***Get***)したあとで、機器受領書(OUT EMPTY)を編集する場合は、このメソッドを呼び出して、機器受領書(OUT EMPTY)をロックします。 ロックされた機器受領書(OUT EMPTY)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、機器受領書(OUT EMPTY)をルートドキュメントから参照できますが、編集中(ロック中)の機器受領書(OUT EMPTY)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/SetCancel/{reportId} |
機器受領書(OUT EMPTY)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、機器受領書(OUT EMPTY)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/Submit/{reportId} |
機器受領書(OUT EMPTY)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した機器受領書(OUT EMPTY)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、機器受領書(OUT EMPTY)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、機器受領書(OUT EMPTY)もロックされた状態のままなので、ご注意ください。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
| POST | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/SubmitByPost |
機器受領書(OUT EMPTY)を提出します 動作は、機器受領書(OUT EMPTY)(***/API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/Submit***)と同様です。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/Unlock/{reportId} |
機器受領書(OUT EMPTY)のロックを解除します 帳票ID(***reportId***)を指定して、機器受領書(OUT EMPTY)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/Update/{reportId} |
機器受領書(OUT EMPTY)を更新します。 帳票ID(***reportId***)を指定して、機器受領書(OUT EMPTY)を更新します。 このメソッドでは、機器受領書(OUT EMPTY)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)について]()を参照ください。 |
|
| POST | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/UpdateByPost |
機器受領書(OUT EMPTY)を更新します。 動作は、機器受領書(OUT EMPTY)(***/API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/Update***)と同様です。 機器受領書(OUT EMPTY)に関する詳細については、[機器受領書(OUT EMPTY)]()を参照ください。 |
|
| POST | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Empty/UploadFile |
機器受領書(OUT EMPTY)にファイルを添付します。 指定された機器受領書(OUT EMPTY)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
EquipmentInterchangeReceipts-Out-Full
機器受領書(OUT FULL)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/Create |
機器受領書(OUT FULL)を作成します。 機器受領書(OUT FULL)を作成するには、利用者が機器受領書(OUT FULL)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/Delete/{reportId} |
機器受領書(OUT FULL)を削除します。 帳票ID(***reportId***)を指定して、機器受領書(OUT FULL)を削除します。 機器受領書(OUT FULL)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した機器受領書(OUT FULL)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/DeleteFile/{fileId} |
機器受領書(OUT FULL)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、機器受領書(OUT FULL)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/Get/{reportId}?historyId=!{historyId} |
機器受領書(OUT FULL)を取得します。 帳票ID(***reportId***)を指定して、機器受領書(OUT FULL)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の機器受領書(OUT FULL)を取得します。 編集中の場合は、先に保存した、機器受領書(OUT FULL)を取得します。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
| GET | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/GetDiff/{reportId}?historyId=!{historyId} |
保存されている機器受領書(OUT FULL)とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する機器受領書(OUT FULL)と、ルートドキュメントの差分を取得します。 比較元を保存されている機器受領書(OUT FULL)、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/GetFile/{fileId} |
機器受領書(OUT FULL)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、機器受領書(OUT FULL)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
機器受領書(OUT FULL)を全て取得します。 検索条件に該当する機器受領書(OUT FULL)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の機器受領書(OUT FULL)を取得します。 編集中の場合は、先に保存した、機器受領書(OUT FULL)を取得します。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/Lock/{reportId} |
編集するため、機器受領書(OUT FULL)をロックします 帳票ID(***reportId***)を指定して、機器受領書(OUT FULL)をロックします。 機器受領書(OUT FULL)を作成(***Create***)した時点では、機器受領書(OUT FULL)をロックが掛かりますが、取得(***Get***)したあとで、機器受領書(OUT FULL)を編集する場合は、このメソッドを呼び出して、機器受領書(OUT FULL)をロックします。 ロックされた機器受領書(OUT FULL)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、機器受領書(OUT FULL)をルートドキュメントから参照できますが、編集中(ロック中)の機器受領書(OUT FULL)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/SetCancel/{reportId} |
機器受領書(OUT FULL)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、機器受領書(OUT FULL)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/Submit/{reportId} |
機器受領書(OUT FULL)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した機器受領書(OUT FULL)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、機器受領書(OUT FULL)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、機器受領書(OUT FULL)もロックされた状態のままなので、ご注意ください。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
| POST | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/SubmitByPost |
機器受領書(OUT FULL)を提出します 動作は、機器受領書(OUT FULL)(***/API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/Submit***)と同様です。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/Unlock/{reportId} |
機器受領書(OUT FULL)のロックを解除します 帳票ID(***reportId***)を指定して、機器受領書(OUT FULL)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/Update/{reportId} |
機器受領書(OUT FULL)を更新します。 帳票ID(***reportId***)を指定して、機器受領書(OUT FULL)を更新します。 このメソッドでは、機器受領書(OUT FULL)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)について]()を参照ください。 |
|
| POST | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/UpdateByPost |
機器受領書(OUT FULL)を更新します。 動作は、機器受領書(OUT FULL)(***/API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/Update***)と同様です。 機器受領書(OUT FULL)に関する詳細については、[機器受領書(OUT FULL)]()を参照ください。 |
|
| POST | /API/v2/Reports/EquipmentInterchangeReceipts-Out-Full/UploadFile |
機器受領書(OUT FULL)にファイルを添付します。 指定された機器受領書(OUT FULL)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
ExcelConverters
Excelフォーマット出力
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/Reports/ExcelConverters/Convert/{reportId}/{excelFormatCode}?historyId=!{historyId} |
帳票をExcelに出力します 帳票ID(***reportId***)とExcelフォーマットコード(***excelFormatCode***)を指定して、帳票(JSON)をExcelファイルに出力、そのExcelファイルを返却します。 ExcelファイルはBase64形式でエンコードされた形で返却します。 |
|
| GET | /API/v2/Reports/ExcelConverters/ConvertToDownloadUrl/{reportId}/{excelFormatCode}?historyId=!{historyId} |
帳票をExcelに出力し、そのダウンロードURLを取得します。 帳票ID(***reportId***)とExcelフォーマットコード(***excelFormatCode***)を指定して、帳票(JSON)をExcelファイルに出力、そのダウンロードURLを返却します。 ExcelファイルはBase64形式でエンコードされた形で返却します。 |
|
| GET | /API/v2/Reports/ExcelConverters/GetFormatInternal/{reportId}/{excelFormatCode}/{openId} |
帳票で使用できるExcelフォーマットファイルを取得します。 帳票ID(***reportId***)を指定して、帳票で使用できるExcelフォーマットファイルを取得します。 内部呼び出し用 |
|
| GET | /API/v2/Reports/ExcelConverters/GetList/{reportId}?excelFormatCode=!{excelFormatCode} |
帳票で使用できるExcelフォーマットを取得します。 帳票ID(***reportId***)を指定して、帳票で使用できるExcelフォーマット(メタ情報)を取得します。 取得できるExcelフォーマットは、以下の通りです。 - Cyber Portで予め用意された標準フォーマット(***/API/v2/Master/ExcelFormat***) - 取引関係先が用意し、公開された(isPublic=true)、カスタマイズしたExcelフォーマット(***/API/v2/Organizations/CustomizedExcelFormats***) - 利用者が所属する組織がカスタマイズしたExcelフォーマット(***/API/v2/Organizations/CustomizedExcelFormats***) このフォーマットを使用して、帳票(JSON)をExcelに出力するには、 ***/API/v2/Reports/ExcelConverters/Convert*** を使用します。 Excelフォーマットに関する詳細については、[Excelフォーマットについて]()を参照ください。 |
|
ExcelFormats
Excelフォーマット
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/Master/ExcelFormats/Get/{excelFormatCode} |
Excelフォーマットを取得します。 Excelフォーマットコード(***excelFormatCode***)を指定して、Excelフォーマットを取得します。 |
|
| GET | /API/v2/Master/ExcelFormats/GetFormat/{excelFormatCode} |
Excelフォーマットとなるファイルを取得します。 Excelフォーマットコード(***excelFormatCode***)を指定して、Excelフォーマットとなるファイルを取得します。 |
|
| GET | /API/v2/Master/ExcelFormats/GetList?excelFormatCode=!{excelFormatCode}&excelFormatName=!{excelFormatName}&tradeType=!{tradeType}&reportCode=!{reportCode} |
Excelフォーマットを全て取得します。 検索条件を指定して、条件に該当するExcelフォーマットを全て取得します。 |
|
ExchangeRateInquiries
IER_為替レート照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ExchangeRateInquiries/Create |
IERを作成します。 IERを作成するには、利用者がIERを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ExchangeRateInquiries/Delete/{reportId} |
IERを削除します。 帳票ID(***reportId***)を指定して、、IERを削除します。 IERを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ExchangeRateInquiries/DeleteFile/{fileId} |
IERの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IERの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ExchangeRateInquiries/Get/{reportId} |
IERを取得します。 帳票ID(***reportId***)を指定して、IER取得します。 編集が行われていない場合は、ルートドキュメントから最新のIERを取得します。 編集中の場合は、先に保存した、IERを取得します。 |
|
| GET | /API/v2/NaccsReports/ExchangeRateInquiries/GetFile/{fileId} |
IERに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IERに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ExchangeRateInquiries/Lock/{reportId} |
編集するため、IERをロックします。 帳票ID(***reportId***)を指定して、IERをロックします。 IERを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IERを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIERは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IERをルートドキュメントから参照できますが、編集中(ロック中)のIERは参照できません。 |
|
| POST | /API/v2/NaccsReports/ExchangeRateInquiries/SendToNaccs |
IERをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIERをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IERが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ExchangeRateInquiries/SetCancel/{reportId} |
IERの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IERの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ExchangeRateInquiries/Submit/{reportId} |
IERを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIERを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IERが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ExchangeRateInquiries/Unlock/{reportId} |
IERのロックを解除します。 帳票ID(***reportId***)を指定して、IERのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ExchangeRateInquiries/Update/{reportId} |
IERを更新します。 帳票ID(***reportId***)を指定して、IERを更新します。 このメソッドでは、IERの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ExchangeRateInquiries/UploadFile |
IERにファイルを添付します。 指定されたIERに、ファイルを添付します。 |
|
ExchangeReports
標準プロセスで取り扱う帳票
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Master/StandardProcesses/ExchangeReports/DeleteAdmin/{exchangeReportCode} |
標準プロセスで取り扱う帳票を登録します。 取り扱う帳票コード(***exchangeReportCode***)を指定して、標準プロセスで取り扱う帳票を削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| GET | /API/v2/Master/StandardProcesses/ExchangeReports/Get/{exchangeReportCode} |
取り扱う帳票コードを指定して、標準プロセスでの取り扱う帳票を取得します 取り扱う帳票コード(***exchangeReportCode***)を指定して、標準プロセスで取り扱う帳票を取得します。 グループ配下のプロセスも含めて、取得する場合は、(***/API/v2/Master/StandardProcesses/GetList***)を使用します。 プロセスに関する詳細については、[プロセスについて]()を参照ください。 |
|
| GET | /API/v2/Master/StandardProcesses/ExchangeReports/GetList/{processCode} |
プロセスコードを指定して、標準プロセスで取り扱う帳票を全て取得します プロセスコード(***processCode***)を指定して、指定した標準プロセスで取り扱う帳票を全て取得します。 プロセスに関する詳細については、[プロセスについて]()を参照ください。 |
|
| POST | /API/v2/Master/StandardProcesses/ExchangeReports/RegisterAdmin |
標準プロセスで取り扱う帳票を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/Master/StandardProcesses/ExchangeReports/RegisterInternal |
標準プロセスで取り扱う帳票を登録します。 内部呼び出し用。 (*For admin) |
|
ExportApprovalCodes
輸出承認証等識別コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/ExportApprovalCodes/DeleteAdmin/{exportApprovalCode} |
輸出承認証等識別コードを削除します。 輸出承認証等識別コード(***exportApprovalCode***)を指定して、輸出承認証等識別コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/ExportApprovalCodes/Get/{exportApprovalCode} |
輸出承認証等識別を取得します。 輸出承認証等識別コード(***exportApprovalCode***)を指定して、輸出承認証等識別を取得します。 輸出承認証等識別コードに関する詳細については、[輸出承認証等識別コードについて]()を参照ください。 |
|
| GET | /API/v2/General/ExportApprovalCodes/GetList |
輸出承認証等識別を全て取得します。 輸出承認証等識別コードに関する詳細については、[輸出承認証等識別コードについて]()を参照ください。 |
|
| POST | /API/v2/General/ExportApprovalCodes/RegisterAdmin |
輸出承認証等識別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/ExportApprovalCodes/RegisterInternal |
輸出承認証等識別を登録します。 内部呼び出し用。 (*For admin) |
|
ExportCargoCorrectionCalls
BIF11_輸出貨物情報訂正呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ExportCargoCorrectionCalls/Create |
BIF11を作成します。 BIF11を作成するには、利用者がBIF11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ExportCargoCorrectionCalls/Delete/{reportId} |
BIF11を削除します。 帳票ID(***reportId***)を指定して、、BIF11を削除します。 BIF11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ExportCargoCorrectionCalls/DeleteFile/{fileId} |
BIF11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、BIF11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ExportCargoCorrectionCalls/Get/{reportId} |
BIF11を取得します。 帳票ID(***reportId***)を指定して、BIF11取得します。 編集が行われていない場合は、ルートドキュメントから最新のBIF11を取得します。 編集中の場合は、先に保存した、BIF11を取得します。 |
|
| GET | /API/v2/NaccsReports/ExportCargoCorrectionCalls/GetFile/{fileId} |
BIF11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、BIF11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoCorrectionCalls/Lock/{reportId} |
編集するため、BIF11をロックします。 帳票ID(***reportId***)を指定して、BIF11をロックします。 BIF11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、BIF11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたBIF11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、BIF11をルートドキュメントから参照できますが、編集中(ロック中)のBIF11は参照できません。 |
|
| POST | /API/v2/NaccsReports/ExportCargoCorrectionCalls/SendToNaccs |
BIF11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したBIF11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BIF11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoCorrectionCalls/SetCancel/{reportId} |
BIF11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、BIF11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoCorrectionCalls/Submit/{reportId} |
BIF11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したBIF11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BIF11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoCorrectionCalls/Unlock/{reportId} |
BIF11のロックを解除します。 帳票ID(***reportId***)を指定して、BIF11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoCorrectionCalls/Update/{reportId} |
BIF11を更新します。 帳票ID(***reportId***)を指定して、BIF11を更新します。 このメソッドでは、BIF11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ExportCargoCorrectionCalls/UploadFile |
BIF11にファイルを添付します。 指定されたBIF11に、ファイルを添付します。 |
|
ExportCargoCorrections
BIF_輸出貨物情報訂正
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ExportCargoCorrections/Create |
BIFを作成します。 BIFを作成するには、利用者がBIFを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ExportCargoCorrections/Delete/{reportId} |
BIFを削除します。 帳票ID(***reportId***)を指定して、、BIFを削除します。 BIFを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ExportCargoCorrections/DeleteFile/{fileId} |
BIFの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、BIFの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ExportCargoCorrections/Get/{reportId} |
BIFを取得します。 帳票ID(***reportId***)を指定して、BIF取得します。 編集が行われていない場合は、ルートドキュメントから最新のBIFを取得します。 編集中の場合は、先に保存した、BIFを取得します。 |
|
| GET | /API/v2/NaccsReports/ExportCargoCorrections/GetFile/{fileId} |
BIFに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、BIFに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoCorrections/Lock/{reportId} |
編集するため、BIFをロックします。 帳票ID(***reportId***)を指定して、BIFをロックします。 BIFを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、BIFを編集する場合は、このメソッドを呼び出してロックします。 ロックされたBIFは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、BIFをルートドキュメントから参照できますが、編集中(ロック中)のBIFは参照できません。 |
|
| POST | /API/v2/NaccsReports/ExportCargoCorrections/SendToNaccs |
BIFをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したBIFをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BIFが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoCorrections/SetCancel/{reportId} |
BIFの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、BIFの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoCorrections/Submit/{reportId} |
BIFを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したBIFを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BIFが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/ExportCargoCorrections/SubmitByPost |
BIFを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoCorrections/Unlock/{reportId} |
BIFのロックを解除します。 帳票ID(***reportId***)を指定して、BIFのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoCorrections/Update/{reportId} |
BIFを更新します。 帳票ID(***reportId***)を指定して、BIFを更新します。 このメソッドでは、BIFの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ExportCargoCorrections/UpdateByPost |
BIFを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/ExportCargoCorrections/UploadFile |
BIFにファイルを添付します。 指定されたBIFに、ファイルを添付します。 |
|
ExportCargoRegistrationCalls
ECR11_輸出貨物情報登録呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ExportCargoRegistrationCalls/Create |
ECR11を作成します。 ECR11を作成するには、利用者がECR11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ExportCargoRegistrationCalls/Delete/{reportId} |
ECR11を削除します。 帳票ID(***reportId***)を指定して、、ECR11を削除します。 ECR11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ExportCargoRegistrationCalls/DeleteFile/{fileId} |
ECR11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、ECR11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ExportCargoRegistrationCalls/Get/{reportId} |
ECR11を取得します。 帳票ID(***reportId***)を指定して、ECR11取得します。 編集が行われていない場合は、ルートドキュメントから最新のECR11を取得します。 編集中の場合は、先に保存した、ECR11を取得します。 |
|
| GET | /API/v2/NaccsReports/ExportCargoRegistrationCalls/GetFile/{fileId} |
ECR11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、ECR11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoRegistrationCalls/Lock/{reportId} |
編集するため、ECR11をロックします。 帳票ID(***reportId***)を指定して、ECR11をロックします。 ECR11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、ECR11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたECR11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、ECR11をルートドキュメントから参照できますが、編集中(ロック中)のECR11は参照できません。 |
|
| POST | /API/v2/NaccsReports/ExportCargoRegistrationCalls/SendToNaccs |
ECR11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したECR11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ECR11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoRegistrationCalls/SetCancel/{reportId} |
ECR11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、ECR11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoRegistrationCalls/Submit/{reportId} |
ECR11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したECR11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ECR11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoRegistrationCalls/Unlock/{reportId} |
ECR11のロックを解除します。 帳票ID(***reportId***)を指定して、ECR11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoRegistrationCalls/Update/{reportId} |
ECR11を更新します。 帳票ID(***reportId***)を指定して、ECR11を更新します。 このメソッドでは、ECR11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ExportCargoRegistrationCalls/UploadFile |
ECR11にファイルを添付します。 指定されたECR11に、ファイルを添付します。 |
|
ExportCargoRegistrations
ECR_輸出貨物情報登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ExportCargoRegistrations/Create |
ECRを作成します。 ECRを作成するには、利用者がECRを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ExportCargoRegistrations/Delete/{reportId} |
ECRを削除します。 帳票ID(***reportId***)を指定して、、ECRを削除します。 ECRを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ExportCargoRegistrations/DeleteFile/{fileId} |
ECRの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、ECRの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ExportCargoRegistrations/Get/{reportId} |
ECRを取得します。 帳票ID(***reportId***)を指定して、ECR取得します。 編集が行われていない場合は、ルートドキュメントから最新のECRを取得します。 編集中の場合は、先に保存した、ECRを取得します。 |
|
| GET | /API/v2/NaccsReports/ExportCargoRegistrations/GetFile/{fileId} |
ECRに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、ECRに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoRegistrations/Lock/{reportId} |
編集するため、ECRをロックします。 帳票ID(***reportId***)を指定して、ECRをロックします。 ECRを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、ECRを編集する場合は、このメソッドを呼び出してロックします。 ロックされたECRは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、ECRをルートドキュメントから参照できますが、編集中(ロック中)のECRは参照できません。 |
|
| POST | /API/v2/NaccsReports/ExportCargoRegistrations/SendToNaccs |
ECRをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したECRをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ECRが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoRegistrations/SetCancel/{reportId} |
ECRの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、ECRの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoRegistrations/Submit/{reportId} |
ECRを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したECRを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ECRが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/ExportCargoRegistrations/SubmitByPost |
ECRを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoRegistrations/Unlock/{reportId} |
ECRのロックを解除します。 帳票ID(***reportId***)を指定して、ECRのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ExportCargoRegistrations/Update/{reportId} |
ECRを更新します。 帳票ID(***reportId***)を指定して、ECRを更新します。 このメソッドでは、ECRの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ExportCargoRegistrations/UpdateByPost |
ECRを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/ExportCargoRegistrations/UploadFile |
ECRにファイルを添付します。 指定されたECRに、ファイルを添付します。 |
|
ExportDeclarationCalls
EDB_輸出申告事項呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ExportDeclarationCalls/Create |
EDBを作成します。 EDBを作成するには、利用者がEDBを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ExportDeclarationCalls/Delete/{reportId} |
EDBを削除します。 帳票ID(***reportId***)を指定して、、EDBを削除します。 EDBを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ExportDeclarationCalls/DeleteFile/{fileId} |
EDBの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、EDBの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ExportDeclarationCalls/Get/{reportId} |
EDBを取得します。 帳票ID(***reportId***)を指定して、EDB取得します。 編集が行われていない場合は、ルートドキュメントから最新のEDBを取得します。 編集中の場合は、先に保存した、EDBを取得します。 |
|
| GET | /API/v2/NaccsReports/ExportDeclarationCalls/GetFile/{fileId} |
EDBに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、EDBに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarationCalls/Lock/{reportId} |
編集するため、EDBをロックします。 帳票ID(***reportId***)を指定して、EDBをロックします。 EDBを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、EDBを編集する場合は、このメソッドを呼び出してロックします。 ロックされたEDBは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、EDBをルートドキュメントから参照できますが、編集中(ロック中)のEDBは参照できません。 |
|
| POST | /API/v2/NaccsReports/ExportDeclarationCalls/SendToNaccs |
EDBをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したEDBをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、EDBが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarationCalls/SetCancel/{reportId} |
EDBの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、EDBの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarationCalls/Submit/{reportId} |
EDBを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したEDBを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、EDBが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarationCalls/Unlock/{reportId} |
EDBのロックを解除します。 帳票ID(***reportId***)を指定して、EDBのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarationCalls/Update/{reportId} |
EDBを更新します。 帳票ID(***reportId***)を指定して、EDBを更新します。 このメソッドでは、EDBの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ExportDeclarationCalls/UploadFile |
EDBにファイルを添付します。 指定されたEDBに、ファイルを添付します。 |
|
ExportDeclarationInquiries
IEX_輸出申告等照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ExportDeclarationInquiries/Create |
IEXを作成します。 IEXを作成するには、利用者がIEXを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ExportDeclarationInquiries/Delete/{reportId} |
IEXを削除します。 帳票ID(***reportId***)を指定して、、IEXを削除します。 IEXを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ExportDeclarationInquiries/DeleteFile/{fileId} |
IEXの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IEXの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ExportDeclarationInquiries/Get/{reportId} |
IEXを取得します。 帳票ID(***reportId***)を指定して、IEX取得します。 編集が行われていない場合は、ルートドキュメントから最新のIEXを取得します。 編集中の場合は、先に保存した、IEXを取得します。 |
|
| GET | /API/v2/NaccsReports/ExportDeclarationInquiries/GetFile/{fileId} |
IEXに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IEXに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarationInquiries/Lock/{reportId} |
編集するため、IEXをロックします。 帳票ID(***reportId***)を指定して、IEXをロックします。 IEXを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IEXを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIEXは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IEXをルートドキュメントから参照できますが、編集中(ロック中)のIEXは参照できません。 |
|
| POST | /API/v2/NaccsReports/ExportDeclarationInquiries/SendToNaccs |
IEXをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIEXをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IEXが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarationInquiries/SetCancel/{reportId} |
IEXの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IEXの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarationInquiries/Submit/{reportId} |
IEXを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIEXを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IEXが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarationInquiries/Unlock/{reportId} |
IEXのロックを解除します。 帳票ID(***reportId***)を指定して、IEXのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarationInquiries/Update/{reportId} |
IEXを更新します。 帳票ID(***reportId***)を指定して、IEXを更新します。 このメソッドでは、IEXの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ExportDeclarationInquiries/UploadFile |
IEXにファイルを添付します。 指定されたIEXに、ファイルを添付します。 |
|
ExportDeclarationRegistrations
EDA_輸出申告事項登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ExportDeclarationRegistrations/Create |
EDAを作成します。 EDAを作成するには、利用者がEDAを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ExportDeclarationRegistrations/Delete/{reportId} |
EDAを削除します。 帳票ID(***reportId***)を指定して、、EDAを削除します。 EDAを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ExportDeclarationRegistrations/DeleteFile/{fileId} |
EDAの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、EDAの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ExportDeclarationRegistrations/Get/{reportId} |
EDAを取得します。 帳票ID(***reportId***)を指定して、EDA取得します。 編集が行われていない場合は、ルートドキュメントから最新のEDAを取得します。 編集中の場合は、先に保存した、EDAを取得します。 |
|
| GET | /API/v2/NaccsReports/ExportDeclarationRegistrations/GetFile/{fileId} |
EDAに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、EDAに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarationRegistrations/Lock/{reportId} |
編集するため、EDAをロックします。 帳票ID(***reportId***)を指定して、EDAをロックします。 EDAを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、EDAを編集する場合は、このメソッドを呼び出してロックします。 ロックされたEDAは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、EDAをルートドキュメントから参照できますが、編集中(ロック中)のEDAは参照できません。 |
|
| POST | /API/v2/NaccsReports/ExportDeclarationRegistrations/SendToNaccs |
EDAをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したEDAをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、EDAが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarationRegistrations/SetCancel/{reportId} |
EDAの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、EDAの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarationRegistrations/Submit/{reportId} |
EDAを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したEDAを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、EDAが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/ExportDeclarationRegistrations/SubmitByPost |
EDAを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarationRegistrations/Unlock/{reportId} |
EDAのロックを解除します。 帳票ID(***reportId***)を指定して、EDAのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarationRegistrations/Update/{reportId} |
EDAを更新します。 帳票ID(***reportId***)を指定して、EDAを更新します。 このメソッドでは、EDAの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ExportDeclarationRegistrations/UpdateByPost |
EDAを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/ExportDeclarationRegistrations/UploadFile |
EDAにファイルを添付します。 指定されたEDAに、ファイルを添付します。 |
|
ExportDeclarations
EDC_輸出申告
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ExportDeclarations/Create |
EDCを作成します。 EDCを作成するには、利用者がEDCを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ExportDeclarations/Delete/{reportId} |
EDCを削除します。 帳票ID(***reportId***)を指定して、、EDCを削除します。 EDCを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ExportDeclarations/DeleteFile/{fileId} |
EDCの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、EDCの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ExportDeclarations/Get/{reportId} |
EDCを取得します。 帳票ID(***reportId***)を指定して、EDC取得します。 編集が行われていない場合は、ルートドキュメントから最新のEDCを取得します。 編集中の場合は、先に保存した、EDCを取得します。 |
|
| GET | /API/v2/NaccsReports/ExportDeclarations/GetFile/{fileId} |
EDCに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、EDCに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarations/Lock/{reportId} |
編集するため、EDCをロックします。 帳票ID(***reportId***)を指定して、EDCをロックします。 EDCを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、EDCを編集する場合は、このメソッドを呼び出してロックします。 ロックされたEDCは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、EDCをルートドキュメントから参照できますが、編集中(ロック中)のEDCは参照できません。 |
|
| POST | /API/v2/NaccsReports/ExportDeclarations/SendToNaccs |
EDCをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したEDCをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、EDCが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarations/SetCancel/{reportId} |
EDCの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、EDCの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarations/Submit/{reportId} |
EDCを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したEDCを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、EDCが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/ExportDeclarations/SubmitByPost |
EDCを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarations/Unlock/{reportId} |
EDCのロックを解除します。 帳票ID(***reportId***)を指定して、EDCのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ExportDeclarations/Update/{reportId} |
EDCを更新します。 帳票ID(***reportId***)を指定して、EDCを更新します。 このメソッドでは、EDCの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ExportDeclarations/UpdateByPost |
EDCを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/ExportDeclarations/UploadFile |
EDCにファイルを添付します。 指定されたEDCに、ファイルを添付します。 |
|
ExporterImporterInquiries
IIE_輸出入者情報照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ExporterImporterInquiries/Create |
IIEを作成します。 IIEを作成するには、利用者がIIEを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ExporterImporterInquiries/Delete/{reportId} |
IIEを削除します。 帳票ID(***reportId***)を指定して、、IIEを削除します。 IIEを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ExporterImporterInquiries/DeleteFile/{fileId} |
IIEの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IIEの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ExporterImporterInquiries/Get/{reportId} |
IIEを取得します。 帳票ID(***reportId***)を指定して、IIE取得します。 編集が行われていない場合は、ルートドキュメントから最新のIIEを取得します。 編集中の場合は、先に保存した、IIEを取得します。 |
|
| GET | /API/v2/NaccsReports/ExporterImporterInquiries/GetFile/{fileId} |
IIEに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IIEに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ExporterImporterInquiries/Lock/{reportId} |
編集するため、IIEをロックします。 帳票ID(***reportId***)を指定して、IIEをロックします。 IIEを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IIEを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIIEは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IIEをルートドキュメントから参照できますが、編集中(ロック中)のIIEは参照できません。 |
|
| POST | /API/v2/NaccsReports/ExporterImporterInquiries/SendToNaccs |
IIEをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIIEをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IIEが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ExporterImporterInquiries/SetCancel/{reportId} |
IIEの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IIEの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ExporterImporterInquiries/Submit/{reportId} |
IIEを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIIEを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IIEが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ExporterImporterInquiries/Unlock/{reportId} |
IIEのロックを解除します。 帳票ID(***reportId***)を指定して、IIEのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ExporterImporterInquiries/Update/{reportId} |
IIEを更新します。 帳票ID(***reportId***)を指定して、IIEを更新します。 このメソッドでは、IIEの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ExporterImporterInquiries/UploadFile |
IIEにファイルを添付します。 指定されたIIEに、ファイルを添付します。 |
|
ExportPermitDetailsChangeApplicationCalls
EAB_輸出許可内容変更申請事項呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationCalls/Create |
EABを作成します。 EABを作成するには、利用者がEABを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationCalls/Delete/{reportId} |
EABを削除します。 帳票ID(***reportId***)を指定して、、EABを削除します。 EABを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationCalls/DeleteFile/{fileId} |
EABの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、EABの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationCalls/Get/{reportId} |
EABを取得します。 帳票ID(***reportId***)を指定して、EAB取得します。 編集が行われていない場合は、ルートドキュメントから最新のEABを取得します。 編集中の場合は、先に保存した、EABを取得します。 |
|
| GET | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationCalls/GetFile/{fileId} |
EABに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、EABに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationCalls/Lock/{reportId} |
編集するため、EABをロックします。 帳票ID(***reportId***)を指定して、EABをロックします。 EABを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、EABを編集する場合は、このメソッドを呼び出してロックします。 ロックされたEABは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、EABをルートドキュメントから参照できますが、編集中(ロック中)のEABは参照できません。 |
|
| POST | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationCalls/SendToNaccs |
EABをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したEABをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、EABが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationCalls/SetCancel/{reportId} |
EABの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、EABの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationCalls/Submit/{reportId} |
EABを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したEABを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、EABが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationCalls/Unlock/{reportId} |
EABのロックを解除します。 帳票ID(***reportId***)を指定して、EABのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationCalls/Update/{reportId} |
EABを更新します。 帳票ID(***reportId***)を指定して、EABを更新します。 このメソッドでは、EABの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationCalls/UploadFile |
EABにファイルを添付します。 指定されたEABに、ファイルを添付します。 |
|
ExportPermitDetailsChangeApplicationRegistrations
EAA_輸出許可内容変更申請事項登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationRegistrations/Create |
EAAを作成します。 EAAを作成するには、利用者がEAAを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationRegistrations/Delete/{reportId} |
EAAを削除します。 帳票ID(***reportId***)を指定して、、EAAを削除します。 EAAを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationRegistrations/DeleteFile/{fileId} |
EAAの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、EAAの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationRegistrations/Get/{reportId} |
EAAを取得します。 帳票ID(***reportId***)を指定して、EAA取得します。 編集が行われていない場合は、ルートドキュメントから最新のEAAを取得します。 編集中の場合は、先に保存した、EAAを取得します。 |
|
| GET | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationRegistrations/GetFile/{fileId} |
EAAに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、EAAに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationRegistrations/Lock/{reportId} |
編集するため、EAAをロックします。 帳票ID(***reportId***)を指定して、EAAをロックします。 EAAを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、EAAを編集する場合は、このメソッドを呼び出してロックします。 ロックされたEAAは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、EAAをルートドキュメントから参照できますが、編集中(ロック中)のEAAは参照できません。 |
|
| POST | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationRegistrations/SendToNaccs |
EAAをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したEAAをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、EAAが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationRegistrations/SetCancel/{reportId} |
EAAの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、EAAの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationRegistrations/Submit/{reportId} |
EAAを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したEAAを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、EAAが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationRegistrations/SubmitByPost |
EAAを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationRegistrations/Unlock/{reportId} |
EAAのロックを解除します。 帳票ID(***reportId***)を指定して、EAAのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationRegistrations/Update/{reportId} |
EAAを更新します。 帳票ID(***reportId***)を指定して、EAAを更新します。 このメソッドでは、EAAの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationRegistrations/UpdateByPost |
EAAを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/ExportPermitDetailsChangeApplicationRegistrations/UploadFile |
EAAにファイルを添付します。 指定されたEAAに、ファイルを添付します。 |
|
ExportPermitDetailsChangeApplications
EAC_輸出許可内容変更申請
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ExportPermitDetailsChangeApplications/Create |
EACを作成します。 EACを作成するには、利用者がEACを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ExportPermitDetailsChangeApplications/Delete/{reportId} |
EACを削除します。 帳票ID(***reportId***)を指定して、、EACを削除します。 EACを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ExportPermitDetailsChangeApplications/DeleteFile/{fileId} |
EACの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、EACの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ExportPermitDetailsChangeApplications/Get/{reportId} |
EACを取得します。 帳票ID(***reportId***)を指定して、EAC取得します。 編集が行われていない場合は、ルートドキュメントから最新のEACを取得します。 編集中の場合は、先に保存した、EACを取得します。 |
|
| GET | /API/v2/NaccsReports/ExportPermitDetailsChangeApplications/GetFile/{fileId} |
EACに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、EACに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ExportPermitDetailsChangeApplications/Lock/{reportId} |
編集するため、EACをロックします。 帳票ID(***reportId***)を指定して、EACをロックします。 EACを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、EACを編集する場合は、このメソッドを呼び出してロックします。 ロックされたEACは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、EACをルートドキュメントから参照できますが、編集中(ロック中)のEACは参照できません。 |
|
| POST | /API/v2/NaccsReports/ExportPermitDetailsChangeApplications/SendToNaccs |
EACをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したEACをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、EACが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ExportPermitDetailsChangeApplications/SetCancel/{reportId} |
EACの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、EACの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ExportPermitDetailsChangeApplications/Submit/{reportId} |
EACを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したEACを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、EACが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/ExportPermitDetailsChangeApplications/SubmitByPost |
EACを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/ExportPermitDetailsChangeApplications/Unlock/{reportId} |
EACのロックを解除します。 帳票ID(***reportId***)を指定して、EACのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ExportPermitDetailsChangeApplications/Update/{reportId} |
EACを更新します。 帳票ID(***reportId***)を指定して、EACを更新します。 このメソッドでは、EACの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ExportPermitDetailsChangeApplications/UpdateByPost |
EACを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/ExportPermitDetailsChangeApplications/UploadFile |
EACにファイルを添付します。 指定されたEACに、ファイルを添付します。 |
|
ExportTradeControlOrdinanceAppendixCodes
輸出貿易管理令別表コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/ExportTradeControlOrdinanceAppendixCodes/DeleteAdmin/{exportTradeControlOrdinanceAppendixCode} |
輸出貿易管理令別表コードを削除します。 輸出貿易管理令別表コード(***exportTradeControlOrdinanceAppendixCode***)を指定して、輸出貿易管理令別表コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/ExportTradeControlOrdinanceAppendixCodes/Get/{exportTradeControlOrdinanceAppendixCode} |
輸出貿易管理令別表を取得します。 輸出貿易管理令別表コード(***exportTradeControlOrdinanceAppendixCode***)を指定して、輸出貿易管理令別表を取得します。 輸出貿易管理令別表コードに関する詳細については、[輸出貿易管理令別表コードについて]()を参照ください。 |
|
| GET | /API/v2/General/ExportTradeControlOrdinanceAppendixCodes/GetList |
輸出貿易管理令別表を全て取得します。 輸出貿易管理令別表コードに関する詳細については、[輸出貿易管理令別表コードについて]()を参照ください。 |
|
| POST | /API/v2/General/ExportTradeControlOrdinanceAppendixCodes/RegisterAdmin |
輸出貿易管理令別表を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/ExportTradeControlOrdinanceAppendixCodes/RegisterInternal |
輸出貿易管理令別表を登録します。 内部呼び出し用。 (*For admin) |
|
ExternalLinkScacCodes
外部連携船会社コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Master/ExternalLinkScacCodes/DeleteAdmin/{externalLinkScacId} |
外部連携船会社コードを削除します。 外部連携船会社ID(***externalLinkScacId***)を指定して、外部連携船会社コードを削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| GET | /API/v2/Master/ExternalLinkScacCodes/Get/{externalLinkScacId} |
外部連携船会社IDを指定して、外部連携船会社コードを取得します。 外部連携船会社ID(***externalLinkScacId***)を指定して、外部連携船会社コードを取得します。 |
|
| GET | /API/v2/Master/ExternalLinkScacCodes/GetList?scacCode=!{scacCode}&externalLinkType=!{externalLinkType} |
検索条件に該当する外部連携船会社コードを全て取得します。 |
|
| POST | /API/v2/Master/ExternalLinkScacCodes/RegisterAdmin |
外部連携船会社コードを登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/Master/ExternalLinkScacCodes/RegisterInternal |
外部連携船会社コードを登録します。 内部呼び出し用。 (*For admin) |
|
FreeTimeInformationInquiries
IFR_フリータイム情報照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/FreeTimeInformationInquiries/Create |
IFRを作成します。 IFRを作成するには、利用者がIFRを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/FreeTimeInformationInquiries/Delete/{reportId} |
IFRを削除します。 帳票ID(***reportId***)を指定して、、IFRを削除します。 IFRを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/FreeTimeInformationInquiries/DeleteFile/{fileId} |
IFRの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IFRの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/FreeTimeInformationInquiries/Get/{reportId} |
IFRを取得します。 帳票ID(***reportId***)を指定して、IFR取得します。 編集が行われていない場合は、ルートドキュメントから最新のIFRを取得します。 編集中の場合は、先に保存した、IFRを取得します。 |
|
| GET | /API/v2/NaccsReports/FreeTimeInformationInquiries/GetFile/{fileId} |
IFRに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IFRに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/FreeTimeInformationInquiries/Lock/{reportId} |
編集するため、IFRをロックします。 帳票ID(***reportId***)を指定して、IFRをロックします。 IFRを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IFRを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIFRは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IFRをルートドキュメントから参照できますが、編集中(ロック中)のIFRは参照できません。 |
|
| POST | /API/v2/NaccsReports/FreeTimeInformationInquiries/SendToNaccs |
IFRをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIFRをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IFRが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/FreeTimeInformationInquiries/SetCancel/{reportId} |
IFRの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IFRの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/FreeTimeInformationInquiries/Submit/{reportId} |
IFRを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIFRを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IFRが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/FreeTimeInformationInquiries/Unlock/{reportId} |
IFRのロックを解除します。 帳票ID(***reportId***)を指定して、IFRのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/FreeTimeInformationInquiries/Update/{reportId} |
IFRを更新します。 帳票ID(***reportId***)を指定して、IFRを更新します。 このメソッドでは、IFRの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/FreeTimeInformationInquiries/UploadFile |
IFRにファイルを添付します。 指定されたIFRに、ファイルを添付します。 |
|
FreightInformations
フレイト情報
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/FreightInformations/Create |
フレイト情報を作成します。 フレイト情報を作成するには、利用者が船荷証券(B/L)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 フレイト情報に関する詳細については、[フレイト情報について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/FreightInformations/Delete/{reportId} |
フレイト情報を削除します。 帳票ID(***reportId***)を指定して、フレイト情報を削除します。 フレイト情報を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したフレイト情報のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 フレイト情報に関する詳細については、[フレイト情報について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/FreightInformations/DeleteFile/{fileId} |
フレイト情報の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、フレイト情報 の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/FreightInformations/Get/{reportId}?historyId=!{historyId} |
フレイト情報を取得します。 帳票ID(***reportId***)を指定して、フレイト情報を取得します。 編集が行われていない場合は、ルートドキュメントから最新のフレイト情報を取得します。 編集中の場合は、先に保存した、フレイト情報を取得します。 フレイト情報に関する詳細については、[フレイト情報について]()を参照ください。 |
|
| GET | /API/v2/Reports/FreightInformations/GetDiff/{reportId}?historyId=!{historyId} |
保存されているフレイト情報とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当するフレイト情報と、ルートドキュメントの差分を取得します。 比較元を保存されているフレイト情報、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/FreightInformations/GetFile/{fileId} |
フレイト情報に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、フレイト情報に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/FreightInformations/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
フレイト情報を全て取得します。 検索条件に該当するフレイト情報を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のフレイト情報を取得します。 編集中の場合は、先に保存した、フレイト情報を取得します。 フレイト情報に関する詳細については、[フレイト情報について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/FreightInformations/Lock/{reportId} |
編集するため、フレイト情報をロックします 帳票ID(***reportId***)を指定して、フレイト情報をロックします。 フレイト情報を作成(***Create***)した時点では、フレイト情報をロックが掛かりますが、取得(***Get***)したあとで、フレイト情報を編集する場合は、このメソッドを呼び出して、フレイト情報をロックします。 ロックされたフレイト情報は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、フレイト情報をルートドキュメントから参照できますが、編集中(ロック中)の船荷証券(B/L)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 フレイト情報に関する詳細については、[フレイト情報について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/FreightInformations/SetCancel/{reportId} |
フレイト情報の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、フレイト情報の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 フレイト情報に関する詳細については、[フレイト情報について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/FreightInformations/Submit/{reportId} |
フレイト情報を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したフレイト情報を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、フレイト情報が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、フレイト情報もロックされた状態のままなので、ご注意ください。 フレイト情報に関する詳細については、[フレイト情報について]()を参照ください。 |
|
| POST | /API/v2/Reports/FreightInformations/SubmitByPost |
フレイト情報を提出します。 動作は、フレイト情報(***/API/v2/Reports/FreightInformations/Submit***)と同様です。 フレイト情報に関する詳細については、[フレイト情報]()を参照ください。 |
|
| PATCH | /API/v2/Reports/FreightInformations/Unlock/{reportId} |
フレイト情報のロックを解除します 帳票ID(***reportId***)を指定して、フレイト情報のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 フレイト情報に関する詳細については、[フレイト情報について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/FreightInformations/Update/{reportId} |
フレイト情報を更新します。 帳票ID(***reportId***)を指定して、フレイト情報を更新します。 このメソッドでは、フレイト情報の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 フレイト情報に関する詳細については、[フレイト情報について]()を参照ください。 |
|
| POST | /API/v2/Reports/FreightInformations/UpdateByPost |
フレイト情報を更新します。 動作は、フレイト情報(***/API/v2/Reports/FreightInformations/Update***)と同様です。 フレイト情報に関する詳細については、[フレイト情報]()を参照ください。 |
|
| POST | /API/v2/Reports/FreightInformations/UploadFile |
フレイト情報にファイルを添付します。 指定されたフレイト情報に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
GateOpenWindows
ゲートオープン時間帯
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Terminals/GateOpenWindows/Delete/{terminalCode} |
description="ターミナルのゲートオープン時間帯を削除します。 |
|
| GET | /API/v2/Terminals/GateOpenWindows/Get/{terminalCode} |
ターミナルのゲートオープン時間帯を取得します。 ターミナルコード(***terminalCode***)を指定して、ゲートオープン時間帯を取得します。 ターミナルのゲートオープン時間帯に関する詳細については、[ターミナルのゲートオープン時間帯について]()を参照ください。 |
|
| GET | /API/v2/Terminals/GateOpenWindows/GetList/{portCode}?terminalCode=!{terminalCode} |
ターミナルのゲートオープン時間帯を取得します。 検索条件に該当するターミナルのゲートオープン時間帯を全て取得します。 ターミナルのゲートオープン時間帯に関する詳細については、[ターミナルのゲートオープン時間帯について]()を参照ください。 |
|
| POST | /API/v2/Terminals/GateOpenWindows/Register |
ターミナルのゲートオープン時間帯を登録します。 ターミナルのゲートオープン時間帯をバース毎に登録します。 ターミナルのゲートオープン時間帯を登録するには、その利用者が、ゲートオープン時間帯を登録するターミナルに対して、ターミナルを運営する組織に所属している必要があります。 ターミナルのゲートオープン時間帯に関する詳細については、[ターミナルのゲートオープン時間帯について]()を参照ください。 |
|
| PATCH | /API/v2/Terminals/GateOpenWindows/Update/{terminalCode} |
ターミナルのゲートオープン時間帯を更新します。 ターミナルコード(***terminalCode***)に該当するターミナルのゲートオープン時間帯を更新します。 ターミナルのゲートオープン時間帯を更新するには、その利用者が、ゲートオープン時間帯を更新するターミナルに対して、ターミナルを運営する組織に所属している必要があります。 ターミナルのゲートオープン時間帯に関する詳細については、[ターミナルのゲートオープン時間帯について]()を参照ください。 |
|
GrantedBusinessTypes
会社の事業種別
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/Companies/GrantedBusinessTypes/GetList |
会社に割り当てられた事業種別を全て取得します。 ログインしている利用者が所属する会社に割り当てられた事業種別を全て取得します。 会社に割り当てられた事業種別に関する詳細については、[会社の事業種別について]()を参照ください。 |
|
HazardousCargoCodes
危険貨物等コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/HazardousCargoCodes/DeleteAdmin/{hazardousCargoCode} |
危険貨物等コードを削除します。 危険貨物等コード(***hazardousCargoCode***)を指定して、危険貨物等コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/HazardousCargoCodes/Get/{hazardousCargoCode} |
危険貨物等を取得します。 危険貨物等コード(***hazardousCargoCode***)を指定して、危険貨物等を取得します。 危険貨物等に関する詳細については、きてについて]()を参照ください。 |
|
| GET | /API/v2/General/HazardousCargoCodes/GetList |
危険貨物等種別を全て取得します。 危険貨物等コードに関する詳細については、[危険貨物等コードについて]()を参照ください。 |
|
| POST | /API/v2/General/HazardousCargoCodes/RegisterAdmin |
危険貨物等を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/HazardousCargoCodes/RegisterInternal |
危険貨物等種別を登録します。 内部呼び出し用。 (*For admin) |
|
Histories
取引内での操作履歴
HouseBlCargoRegistrationAssociations
NVC02_ハウスB/L貨物情報登録(関連付け)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/HouseBlCargoRegistrationAssociations/Create |
NVC02を作成します。 NVC02を作成するには、利用者がNVC02を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/HouseBlCargoRegistrationAssociations/Delete/{reportId} |
NVC02を削除します。 帳票ID(***reportId***)を指定して、、NVC02を削除します。 NVC02を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/HouseBlCargoRegistrationAssociations/DeleteFile/{fileId} |
NVC02の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、NVC02の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/HouseBlCargoRegistrationAssociations/Get/{reportId} |
NVC02を取得します。 帳票ID(***reportId***)を指定して、NVC02取得します。 編集が行われていない場合は、ルートドキュメントから最新のNVC02を取得します。 編集中の場合は、先に保存した、NVC02を取得します。 |
|
| GET | /API/v2/NaccsReports/HouseBlCargoRegistrationAssociations/GetFile/{fileId} |
NVC02に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、NVC02に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/HouseBlCargoRegistrationAssociations/Lock/{reportId} |
編集するため、NVC02をロックします。 帳票ID(***reportId***)を指定して、NVC02をロックします。 NVC02を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、NVC02を編集する場合は、このメソッドを呼び出してロックします。 ロックされたNVC02は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、NVC02をルートドキュメントから参照できますが、編集中(ロック中)のNVC02は参照できません。 |
|
| POST | /API/v2/NaccsReports/HouseBlCargoRegistrationAssociations/SendToNaccs |
NVC02をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したNVC02をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、NVC02が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/HouseBlCargoRegistrationAssociations/SetCancel/{reportId} |
NVC02の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、NVC02の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/HouseBlCargoRegistrationAssociations/Submit/{reportId} |
NVC02を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したNVC02を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、NVC02が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/HouseBlCargoRegistrationAssociations/SubmitByPost |
NVC02を提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/HouseBlCargoRegistrationAssociations/Unlock/{reportId} |
NVC02のロックを解除します。 帳票ID(***reportId***)を指定して、NVC02のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/HouseBlCargoRegistrationAssociations/Update/{reportId} |
NVC02を更新します。 帳票ID(***reportId***)を指定して、NVC02を更新します。 このメソッドでは、NVC02の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/HouseBlCargoRegistrationAssociations/UpdateByPost |
NVC02を更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/HouseBlCargoRegistrationAssociations/UploadFile |
NVC02にファイルを添付します。 指定されたNVC02に、ファイルを添付します。 |
|
HouseBlCargoRegistrationCalls
NVC11_ハウスB/L貨物情報登録呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/HouseBlCargoRegistrationCalls/Create |
NVC11を作成します。 NVC11を作成するには、利用者がNVC11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/HouseBlCargoRegistrationCalls/Delete/{reportId} |
NVC11を削除します。 帳票ID(***reportId***)を指定して、、NVC11を削除します。 NVC11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/HouseBlCargoRegistrationCalls/DeleteFile/{fileId} |
NVC11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、NVC11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/HouseBlCargoRegistrationCalls/Get/{reportId} |
NVC11を取得します。 帳票ID(***reportId***)を指定して、NVC11取得します。 編集が行われていない場合は、ルートドキュメントから最新のNVC11を取得します。 編集中の場合は、先に保存した、NVC11を取得します。 |
|
| GET | /API/v2/NaccsReports/HouseBlCargoRegistrationCalls/GetFile/{fileId} |
NVC11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、NVC11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/HouseBlCargoRegistrationCalls/Lock/{reportId} |
編集するため、NVC11をロックします。 帳票ID(***reportId***)を指定して、NVC11をロックします。 NVC11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、NVC11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたNVC11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、NVC11をルートドキュメントから参照できますが、編集中(ロック中)のNVC11は参照できません。 |
|
| POST | /API/v2/NaccsReports/HouseBlCargoRegistrationCalls/SendToNaccs |
NVC11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したNVC11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、NVC11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/HouseBlCargoRegistrationCalls/SetCancel/{reportId} |
NVC11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、NVC11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/HouseBlCargoRegistrationCalls/Submit/{reportId} |
NVC11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したNVC11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、NVC11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/HouseBlCargoRegistrationCalls/Unlock/{reportId} |
NVC11のロックを解除します。 帳票ID(***reportId***)を指定して、NVC11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/HouseBlCargoRegistrationCalls/Update/{reportId} |
NVC11を更新します。 帳票ID(***reportId***)を指定して、NVC11を更新します。 このメソッドでは、NVC11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/HouseBlCargoRegistrationCalls/UploadFile |
NVC11にファイルを添付します。 指定されたNVC11に、ファイルを添付します。 |
|
HouseBlCargoRegistrationRegisterCorrectDeletes
NVC01_ハウスB/L貨物情報登録(登録、訂正、削除)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/HouseBlCargoRegistrationRegisterCorrectDeletes/Create |
NVC01を作成します。 NVC01を作成するには、利用者がNVC01を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/HouseBlCargoRegistrationRegisterCorrectDeletes/Delete/{reportId} |
NVC01を削除します。 帳票ID(***reportId***)を指定して、、NVC01を削除します。 NVC01を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/HouseBlCargoRegistrationRegisterCorrectDeletes/DeleteFile/{fileId} |
NVC01の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、NVC01の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/HouseBlCargoRegistrationRegisterCorrectDeletes/Get/{reportId} |
NVC01を取得します。 帳票ID(***reportId***)を指定して、NVC01取得します。 編集が行われていない場合は、ルートドキュメントから最新のNVC01を取得します。 編集中の場合は、先に保存した、NVC01を取得します。 |
|
| GET | /API/v2/NaccsReports/HouseBlCargoRegistrationRegisterCorrectDeletes/GetFile/{fileId} |
NVC01に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、NVC01に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/HouseBlCargoRegistrationRegisterCorrectDeletes/Lock/{reportId} |
編集するため、NVC01をロックします。 帳票ID(***reportId***)を指定して、NVC01をロックします。 NVC01を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、NVC01を編集する場合は、このメソッドを呼び出してロックします。 ロックされたNVC01は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、NVC01をルートドキュメントから参照できますが、編集中(ロック中)のNVC01は参照できません。 |
|
| POST | /API/v2/NaccsReports/HouseBlCargoRegistrationRegisterCorrectDeletes/SendToNaccs |
NVC01をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したNVC01をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、NVC01が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/HouseBlCargoRegistrationRegisterCorrectDeletes/SetCancel/{reportId} |
NVC01の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、NVC01の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/HouseBlCargoRegistrationRegisterCorrectDeletes/Submit/{reportId} |
NVC01を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したNVC01を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、NVC01が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/HouseBlCargoRegistrationRegisterCorrectDeletes/SubmitByPost |
NVC01を提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/HouseBlCargoRegistrationRegisterCorrectDeletes/Unlock/{reportId} |
NVC01のロックを解除します。 帳票ID(***reportId***)を指定して、NVC01のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/HouseBlCargoRegistrationRegisterCorrectDeletes/Update/{reportId} |
NVC01を更新します。 帳票ID(***reportId***)を指定して、NVC01を更新します。 このメソッドでは、NVC01の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/HouseBlCargoRegistrationRegisterCorrectDeletes/UpdateByPost |
NVC01を更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/HouseBlCargoRegistrationRegisterCorrectDeletes/UploadFile |
NVC01にファイルを添付します。 指定されたNVC01に、ファイルを添付します。 |
|
ImoClasses
Imo Class
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/ImoClasses/DeleteAdmin/{imoClassCode} |
IMO Classを削除します。 IMO Classコード(***imoClassCode***)を指定して、IMO Classを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/ImoClasses/Get/{imoClassCode} |
IMO Classを取得します。 IMO Classコード(***imoClassCode***)を指定して、IMO Classを取得します。 |
|
| GET | /API/v2/General/ImoClasses/GetList |
IMO Classを全て取得します。 |
|
| POST | /API/v2/General/ImoClasses/RegisterAdmin |
IMO Classを登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/General/ImoClasses/RegisterInternal |
IMO Classを登録します。 内部呼び出し用。 (*For admin) |
|
ImportAndExportStatisticsItemNaccsCodes
輸出入統計品目NACCS用コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/ImportAndExportStatisticsItemNaccsCodes/DeleteAdmin/{importAndExportStatisticsItemNaccsCode} |
輸出入統計品目NACCS用コードを削除します。 輸出入統計品目NACCS用コード(***importAndExportStatisticsItemNaccsCode***)を指定して、輸出入統計品目NACCS用コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/ImportAndExportStatisticsItemNaccsCodes/Get/{importAndExportStatisticsItemNaccsCode} |
輸出入統計品目NACCS用コードを取得します。 輸出入統計品目NACCS用コード(***importAndExportStatisticsItemNaccsCode***)を指定して、輸出入統計品目NACCS用コード種別を取得します。 輸出入統計品目NACCS用コードに関する詳細については、[輸出入統計品目NACCS用コードについて]()を参照ください。 |
|
| GET | /API/v2/General/ImportAndExportStatisticsItemNaccsCodes/GetList |
輸出入統計品目NACCS用コード種別を全て取得します。 輸出入統計品目NACCS用コードに関する詳細については、輸出入統計品目NACCS用コードについて]()を参照ください。 |
|
| POST | /API/v2/General/ImportAndExportStatisticsItemNaccsCodes/RegisterAdmin |
輸出入統計品目NACCS用コードを登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/ImportAndExportStatisticsItemNaccsCodes/RegisterInternal |
輸出入統計品目NACCS用種別を登録します。 内部呼び出し用。 (*For admin) |
|
ImportApprovalCodes
輸入承認証等識別コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/ImportApprovalCodes/DeleteAdmin/{importApprovalCode} |
輸入承認証等識別コードを削除します。 輸入承認証等識別コード(***importApprovalCode***)を指定して、輸入承認証等識別コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/ImportApprovalCodes/Get/{importApprovalCode} |
輸入承認証等識別を取得します。 輸入承認証等識別コード(***importApprovalCode***)を指定して、輸入承認証等識別を取得します。 輸入承認証等識別コードに関する詳細については、[輸入承認証等識別コードについて]()を参照ください。 |
|
| GET | /API/v2/General/ImportApprovalCodes/GetList |
輸入承認証等識別を全て取得します。 輸入承認証等識別コードに関する詳細については、[輸入承認証等識別コードについて]()を参照ください。 |
|
| POST | /API/v2/General/ImportApprovalCodes/RegisterAdmin |
輸入承認証等識別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/ImportApprovalCodes/RegisterInternal |
輸入承認証等識別を登録します。 内部呼び出し用。 (*For admin) |
|
ImportCargoCorrectionCalls
SAI11_輸入貨物情報訂正呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ImportCargoCorrectionCalls/Create |
SAI11を作成します。 SAI11を作成するには、利用者がSAI11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ImportCargoCorrectionCalls/Delete/{reportId} |
SAI11を削除します。 帳票ID(***reportId***)を指定して、、SAI11を削除します。 SAI11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ImportCargoCorrectionCalls/DeleteFile/{fileId} |
SAI11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、SAI11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ImportCargoCorrectionCalls/Get/{reportId} |
SAI11を取得します。 帳票ID(***reportId***)を指定して、SAI11取得します。 編集が行われていない場合は、ルートドキュメントから最新のSAI11を取得します。 編集中の場合は、先に保存した、SAI11を取得します。 |
|
| GET | /API/v2/NaccsReports/ImportCargoCorrectionCalls/GetFile/{fileId} |
SAI11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、SAI11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ImportCargoCorrectionCalls/Lock/{reportId} |
編集するため、SAI11をロックします。 帳票ID(***reportId***)を指定して、SAI11をロックします。 SAI11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、SAI11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたSAI11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、SAI11をルートドキュメントから参照できますが、編集中(ロック中)のSAI11は参照できません。 |
|
| POST | /API/v2/NaccsReports/ImportCargoCorrectionCalls/SendToNaccs |
SAI11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したSAI11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、SAI11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ImportCargoCorrectionCalls/SetCancel/{reportId} |
SAI11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、SAI11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ImportCargoCorrectionCalls/Submit/{reportId} |
SAI11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したSAI11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、SAI11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ImportCargoCorrectionCalls/Unlock/{reportId} |
SAI11のロックを解除します。 帳票ID(***reportId***)を指定して、SAI11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ImportCargoCorrectionCalls/Update/{reportId} |
SAI11を更新します。 帳票ID(***reportId***)を指定して、SAI11を更新します。 このメソッドでは、SAI11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ImportCargoCorrectionCalls/UploadFile |
SAI11にファイルを添付します。 指定されたSAI11に、ファイルを添付します。 |
|
ImportCargoCorrections
SAI_輸入貨物情報訂正
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ImportCargoCorrections/Create |
SAIを作成します。 SAIを作成するには、利用者がSAIを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ImportCargoCorrections/Delete/{reportId} |
SAIを削除します。 帳票ID(***reportId***)を指定して、、SAIを削除します。 SAIを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ImportCargoCorrections/DeleteFile/{fileId} |
SAIの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、SAIの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ImportCargoCorrections/Get/{reportId} |
SAIを取得します。 帳票ID(***reportId***)を指定して、SAI取得します。 編集が行われていない場合は、ルートドキュメントから最新のSAIを取得します。 編集中の場合は、先に保存した、SAIを取得します。 |
|
| GET | /API/v2/NaccsReports/ImportCargoCorrections/GetFile/{fileId} |
SAIに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、SAIに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ImportCargoCorrections/Lock/{reportId} |
編集するため、SAIをロックします。 帳票ID(***reportId***)を指定して、SAIをロックします。 SAIを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、SAIを編集する場合は、このメソッドを呼び出してロックします。 ロックされたSAIは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、SAIをルートドキュメントから参照できますが、編集中(ロック中)のSAIは参照できません。 |
|
| POST | /API/v2/NaccsReports/ImportCargoCorrections/SendToNaccs |
SAIをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したSAIをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、SAIが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ImportCargoCorrections/SetCancel/{reportId} |
SAIの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、SAIの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ImportCargoCorrections/Submit/{reportId} |
SAIを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したSAIを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、SAIが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/ImportCargoCorrections/SubmitByPost |
SAIを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/ImportCargoCorrections/Unlock/{reportId} |
SAIのロックを解除します。 帳票ID(***reportId***)を指定して、SAIのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ImportCargoCorrections/Update/{reportId} |
SAIを更新します。 帳票ID(***reportId***)を指定して、SAIを更新します。 このメソッドでは、SAIの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ImportCargoCorrections/UpdateByPost |
SAIを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/ImportCargoCorrections/UploadFile |
SAIにファイルを添付します。 指定されたSAIに、ファイルを添付します。 |
|
ImportCargoDeliveryRegistrations
DOR_輸入貨物荷渡情報登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ImportCargoDeliveryRegistrations/Create |
DORを作成します。 DORを作成するには、利用者がDORを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ImportCargoDeliveryRegistrations/Delete/{reportId} |
DORを削除します。 帳票ID(***reportId***)を指定して、、DORを削除します。 DORを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ImportCargoDeliveryRegistrations/DeleteFile/{fileId} |
DORの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、DORの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ImportCargoDeliveryRegistrations/Get/{reportId} |
DORを取得します。 帳票ID(***reportId***)を指定して、DOR取得します。 編集が行われていない場合は、ルートドキュメントから最新のDORを取得します。 編集中の場合は、先に保存した、DORを取得します。 |
|
| GET | /API/v2/NaccsReports/ImportCargoDeliveryRegistrations/GetFile/{fileId} |
DORに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、DORに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ImportCargoDeliveryRegistrations/Lock/{reportId} |
編集するため、DORをロックします。 帳票ID(***reportId***)を指定して、DORをロックします。 DORを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、DORを編集する場合は、このメソッドを呼び出してロックします。 ロックされたDORは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、DORをルートドキュメントから参照できますが、編集中(ロック中)のDORは参照できません。 |
|
| POST | /API/v2/NaccsReports/ImportCargoDeliveryRegistrations/SendToNaccs |
DORをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したDORをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DORが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ImportCargoDeliveryRegistrations/SetCancel/{reportId} |
DORの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、DORの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ImportCargoDeliveryRegistrations/Submit/{reportId} |
DORを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したDORを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、DORが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/ImportCargoDeliveryRegistrations/SubmitByPost |
DORを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/ImportCargoDeliveryRegistrations/Unlock/{reportId} |
DORのロックを解除します。 帳票ID(***reportId***)を指定して、DORのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ImportCargoDeliveryRegistrations/Update/{reportId} |
DORを更新します。 帳票ID(***reportId***)を指定して、DORを更新します。 このメソッドでは、DORの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ImportCargoDeliveryRegistrations/UpdateByPost |
DORを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/ImportCargoDeliveryRegistrations/UploadFile |
DORにファイルを添付します。 指定されたDORに、ファイルを添付します。 |
|
ImportContainerPickUpScheduleNotificationIdConfirmCalls
RST11_輸入コンテナ引取予定確認情報通知(ID確認)呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirmCalls/Create |
RST11を作成します。 RST11を作成するには、利用者がRST11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirmCalls/Delete/{reportId} |
RST11を削除します。 帳票ID(***reportId***)を指定して、、RST11を削除します。 RST11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirmCalls/DeleteFile/{fileId} |
RST11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、RST11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirmCalls/Get/{reportId} |
RST11を取得します。 帳票ID(***reportId***)を指定して、RST11取得します。 編集が行われていない場合は、ルートドキュメントから最新のRST11を取得します。 編集中の場合は、先に保存した、RST11を取得します。 |
|
| GET | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirmCalls/GetFile/{fileId} |
RST11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、RST11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirmCalls/Lock/{reportId} |
編集するため、RST11をロックします。 帳票ID(***reportId***)を指定して、RST11をロックします。 RST11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、RST11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたRST11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、RST11をルートドキュメントから参照できますが、編集中(ロック中)のRST11は参照できません。 |
|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirmCalls/SendToNaccs |
RST11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したRST11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、RST11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirmCalls/SetCancel/{reportId} |
RST11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、RST11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirmCalls/Submit/{reportId} |
RST11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したRST11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、RST11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirmCalls/Unlock/{reportId} |
RST11のロックを解除します。 帳票ID(***reportId***)を指定して、RST11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirmCalls/Update/{reportId} |
RST11を更新します。 帳票ID(***reportId***)を指定して、RST11を更新します。 このメソッドでは、RST11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirmCalls/UploadFile |
RST11にファイルを添付します。 指定されたRST11に、ファイルを添付します。 |
|
ImportContainerPickUpScheduleNotificationIdConfirms
RST01_輸入コンテナ引取予定確認情報通知(ID確認)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirms/Create |
RST01を作成します。 RST01を作成するには、利用者がRST01を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirms/Delete/{reportId} |
RST01を削除します。 帳票ID(***reportId***)を指定して、、RST01を削除します。 RST01を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirms/DeleteFile/{fileId} |
RST01の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、RST01の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirms/Get/{reportId} |
RST01を取得します。 帳票ID(***reportId***)を指定して、RST01取得します。 編集が行われていない場合は、ルートドキュメントから最新のRST01を取得します。 編集中の場合は、先に保存した、RST01を取得します。 |
|
| GET | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirms/GetFile/{fileId} |
RST01に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、RST01に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirms/Lock/{reportId} |
編集するため、RST01をロックします。 帳票ID(***reportId***)を指定して、RST01をロックします。 RST01を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、RST01を編集する場合は、このメソッドを呼び出してロックします。 ロックされたRST01は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、RST01をルートドキュメントから参照できますが、編集中(ロック中)のRST01は参照できません。 |
|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirms/SendToNaccs |
RST01をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したRST01をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、RST01が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirms/SetCancel/{reportId} |
RST01の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、RST01の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirms/Submit/{reportId} |
RST01を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したRST01を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、RST01が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirms/SubmitByPost |
RST01を提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirms/Unlock/{reportId} |
RST01のロックを解除します。 帳票ID(***reportId***)を指定して、RST01のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirms/Update/{reportId} |
RST01を更新します。 帳票ID(***reportId***)を指定して、RST01を更新します。 このメソッドでは、RST01の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirms/UpdateByPost |
RST01を更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdConfirms/UploadFile |
RST01にファイルを添付します。 指定されたRST01に、ファイルを添付します。 |
|
ImportContainerPickUpScheduleNotificationIdNotificationCalls
RSS11_輸入コンテナ引取予定情報通知(ID通知)呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotificationCalls/Create |
RSS11を作成します。 RSS11を作成するには、利用者がRSS11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotificationCalls/Delete/{reportId} |
RSS11を削除します。 帳票ID(***reportId***)を指定して、、RSS11を削除します。 RSS11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotificationCalls/DeleteFile/{fileId} |
RSS11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、RSS11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotificationCalls/Get/{reportId} |
RSS11を取得します。 帳票ID(***reportId***)を指定して、RSS11取得します。 編集が行われていない場合は、ルートドキュメントから最新のRSS11を取得します。 編集中の場合は、先に保存した、RSS11を取得します。 |
|
| GET | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotificationCalls/GetFile/{fileId} |
RSS11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、RSS11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotificationCalls/Lock/{reportId} |
編集するため、RSS11をロックします。 帳票ID(***reportId***)を指定して、RSS11をロックします。 RSS11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、RSS11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたRSS11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、RSS11をルートドキュメントから参照できますが、編集中(ロック中)のRSS11は参照できません。 |
|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotificationCalls/SendToNaccs |
RSS11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したRSS11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、RSS11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotificationCalls/SetCancel/{reportId} |
RSS11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、RSS11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotificationCalls/Submit/{reportId} |
RSS11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したRSS11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、RSS11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotificationCalls/Unlock/{reportId} |
RSS11のロックを解除します。 帳票ID(***reportId***)を指定して、RSS11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotificationCalls/Update/{reportId} |
RSS11を更新します。 帳票ID(***reportId***)を指定して、RSS11を更新します。 このメソッドでは、RSS11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotificationCalls/UploadFile |
RSS11にファイルを添付します。 指定されたRSS11に、ファイルを添付します。 |
|
ImportContainerPickUpScheduleNotificationIdNotifications
RSS01_輸入コンテナ引取予定情報通知(ID通知)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotifications/Create |
RSS01を作成します。 RSS01を作成するには、利用者がRSS01を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotifications/Delete/{reportId} |
RSS01を削除します。 帳票ID(***reportId***)を指定して、、RSS01を削除します。 RSS01を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotifications/DeleteFile/{fileId} |
RSS01の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、RSS01の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotifications/Get/{reportId} |
RSS01を取得します。 帳票ID(***reportId***)を指定して、RSS01取得します。 編集が行われていない場合は、ルートドキュメントから最新のRSS01を取得します。 編集中の場合は、先に保存した、RSS01を取得します。 |
|
| GET | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotifications/GetFile/{fileId} |
RSS01に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、RSS01に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotifications/Lock/{reportId} |
編集するため、RSS01をロックします。 帳票ID(***reportId***)を指定して、RSS01をロックします。 RSS01を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、RSS01を編集する場合は、このメソッドを呼び出してロックします。 ロックされたRSS01は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、RSS01をルートドキュメントから参照できますが、編集中(ロック中)のRSS01は参照できません。 |
|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotifications/SendToNaccs |
RSS01をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したRSS01をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、RSS01が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotifications/SetCancel/{reportId} |
RSS01の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、RSS01の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotifications/Submit/{reportId} |
RSS01を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したRSS01を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、RSS01が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotifications/SubmitByPost |
RSS01を提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotifications/Unlock/{reportId} |
RSS01のロックを解除します。 帳票ID(***reportId***)を指定して、RSS01のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotifications/Update/{reportId} |
RSS01を更新します。 帳票ID(***reportId***)を指定して、RSS01を更新します。 このメソッドでは、RSS01の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotifications/UpdateByPost |
RSS01を更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleNotificationIdNotifications/UploadFile |
RSS01にファイルを添付します。 指定されたRSS01に、ファイルを添付します。 |
|
ImportContainerPickUpScheduleSelectionIdNotificationCalls
RSS12_輸入コンテナ引取予定情報選択(ID通知)呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleSelectionIdNotificationCalls/Create |
RSS12を作成します。 RSS12を作成するには、利用者がRSS12を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ImportContainerPickUpScheduleSelectionIdNotificationCalls/Delete/{reportId} |
RSS12を削除します。 帳票ID(***reportId***)を指定して、、RSS12を削除します。 RSS12を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ImportContainerPickUpScheduleSelectionIdNotificationCalls/DeleteFile/{fileId} |
RSS12の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、RSS12の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ImportContainerPickUpScheduleSelectionIdNotificationCalls/Get/{reportId} |
RSS12を取得します。 帳票ID(***reportId***)を指定して、RSS12取得します。 編集が行われていない場合は、ルートドキュメントから最新のRSS12を取得します。 編集中の場合は、先に保存した、RSS12を取得します。 |
|
| GET | /API/v2/NaccsReports/ImportContainerPickUpScheduleSelectionIdNotificationCalls/GetFile/{fileId} |
RSS12に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、RSS12に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleSelectionIdNotificationCalls/Lock/{reportId} |
編集するため、RSS12をロックします。 帳票ID(***reportId***)を指定して、RSS12をロックします。 RSS12を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、RSS12を編集する場合は、このメソッドを呼び出してロックします。 ロックされたRSS12は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、RSS12をルートドキュメントから参照できますが、編集中(ロック中)のRSS12は参照できません。 |
|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleSelectionIdNotificationCalls/SendToNaccs |
RSS12をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したRSS12をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、RSS12が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleSelectionIdNotificationCalls/SetCancel/{reportId} |
RSS12の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、RSS12の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleSelectionIdNotificationCalls/Submit/{reportId} |
RSS12を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したRSS12を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、RSS12が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleSelectionIdNotificationCalls/Unlock/{reportId} |
RSS12のロックを解除します。 帳票ID(***reportId***)を指定して、RSS12のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ImportContainerPickUpScheduleSelectionIdNotificationCalls/Update/{reportId} |
RSS12を更新します。 帳票ID(***reportId***)を指定して、RSS12を更新します。 このメソッドでは、RSS12の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ImportContainerPickUpScheduleSelectionIdNotificationCalls/UploadFile |
RSS12にファイルを添付します。 指定されたRSS12に、ファイルを添付します。 |
|
ImportDeclarationCalls
IDB_輸入申告事項呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ImportDeclarationCalls/Create |
IDBを作成します。 IDBを作成するには、利用者がIDBを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ImportDeclarationCalls/Delete/{reportId} |
IDBを削除します。 帳票ID(***reportId***)を指定して、、IDBを削除します。 IDBを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ImportDeclarationCalls/DeleteFile/{fileId} |
IDBの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IDBの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ImportDeclarationCalls/Get/{reportId} |
IDBを取得します。 帳票ID(***reportId***)を指定して、IDB取得します。 編集が行われていない場合は、ルートドキュメントから最新のIDBを取得します。 編集中の場合は、先に保存した、IDBを取得します。 |
|
| GET | /API/v2/NaccsReports/ImportDeclarationCalls/GetFile/{fileId} |
IDBに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IDBに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationCalls/Lock/{reportId} |
編集するため、IDBをロックします。 帳票ID(***reportId***)を指定して、IDBをロックします。 IDBを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IDBを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIDBは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IDBをルートドキュメントから参照できますが、編集中(ロック中)のIDBは参照できません。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationCalls/SendToNaccs |
IDBをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIDBをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IDBが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationCalls/SetCancel/{reportId} |
IDBの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IDBの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationCalls/Submit/{reportId} |
IDBを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIDBを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IDBが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationCalls/Unlock/{reportId} |
IDBのロックを解除します。 帳票ID(***reportId***)を指定して、IDBのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationCalls/Update/{reportId} |
IDBを更新します。 帳票ID(***reportId***)を指定して、IDBを更新します。 このメソッドでは、IDBの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationCalls/UploadFile |
IDBにファイルを添付します。 指定されたIDBに、ファイルを添付します。 |
|
ImportDeclarationChangeCalls
IDD_輸入申告変更事項呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ImportDeclarationChangeCalls/Create |
IDDを作成します。 IDDを作成するには、利用者がIDDを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ImportDeclarationChangeCalls/Delete/{reportId} |
IDDを削除します。 帳票ID(***reportId***)を指定して、、IDDを削除します。 IDDを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ImportDeclarationChangeCalls/DeleteFile/{fileId} |
IDDの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IDDの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ImportDeclarationChangeCalls/Get/{reportId} |
IDDを取得します。 帳票ID(***reportId***)を指定して、IDD取得します。 編集が行われていない場合は、ルートドキュメントから最新のIDDを取得します。 編集中の場合は、先に保存した、IDDを取得します。 |
|
| GET | /API/v2/NaccsReports/ImportDeclarationChangeCalls/GetFile/{fileId} |
IDDに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IDDに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationChangeCalls/Lock/{reportId} |
編集するため、IDDをロックします。 帳票ID(***reportId***)を指定して、IDDをロックします。 IDDを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IDDを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIDDは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IDDをルートドキュメントから参照できますが、編集中(ロック中)のIDDは参照できません。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationChangeCalls/SendToNaccs |
IDDをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIDDをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IDDが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationChangeCalls/SetCancel/{reportId} |
IDDの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IDDの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationChangeCalls/Submit/{reportId} |
IDDを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIDDを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IDDが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationChangeCalls/Unlock/{reportId} |
IDDのロックを解除します。 帳票ID(***reportId***)を指定して、IDDのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationChangeCalls/Update/{reportId} |
IDDを更新します。 帳票ID(***reportId***)を指定して、IDDを更新します。 このメソッドでは、IDDの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationChangeCalls/UploadFile |
IDDにファイルを添付します。 指定されたIDDに、ファイルを添付します。 |
|
ImportDeclarationChangeRegistrations
IDA01_輸入申告変更事項登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ImportDeclarationChangeRegistrations/Create |
IDA01を作成します。 IDA01を作成するには、利用者がIDA01を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ImportDeclarationChangeRegistrations/Delete/{reportId} |
IDA01を削除します。 帳票ID(***reportId***)を指定して、、IDA01を削除します。 IDA01を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ImportDeclarationChangeRegistrations/DeleteFile/{fileId} |
IDA01の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IDA01の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ImportDeclarationChangeRegistrations/Get/{reportId} |
IDA01を取得します。 帳票ID(***reportId***)を指定して、IDA01取得します。 編集が行われていない場合は、ルートドキュメントから最新のIDA01を取得します。 編集中の場合は、先に保存した、IDA01を取得します。 |
|
| GET | /API/v2/NaccsReports/ImportDeclarationChangeRegistrations/GetFile/{fileId} |
IDA01に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IDA01に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationChangeRegistrations/Lock/{reportId} |
編集するため、IDA01をロックします。 帳票ID(***reportId***)を指定して、IDA01をロックします。 IDA01を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IDA01を編集する場合は、このメソッドを呼び出してロックします。 ロックされたIDA01は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IDA01をルートドキュメントから参照できますが、編集中(ロック中)のIDA01は参照できません。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationChangeRegistrations/SendToNaccs |
IDA01をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIDA01をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IDA01が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationChangeRegistrations/SetCancel/{reportId} |
IDA01の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IDA01の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationChangeRegistrations/Submit/{reportId} |
IDA01を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIDA01を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IDA01が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationChangeRegistrations/SubmitByPost |
IDA01を提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationChangeRegistrations/Unlock/{reportId} |
IDA01のロックを解除します。 帳票ID(***reportId***)を指定して、IDA01のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationChangeRegistrations/Update/{reportId} |
IDA01を更新します。 帳票ID(***reportId***)を指定して、IDA01を更新します。 このメソッドでは、IDA01の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationChangeRegistrations/UpdateByPost |
IDA01を更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationChangeRegistrations/UploadFile |
IDA01にファイルを添付します。 指定されたIDA01に、ファイルを添付します。 |
|
ImportDeclarationChanges
IDE_輸入申告変更
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ImportDeclarationChanges/Create |
IDEを作成します。 IDEを作成するには、利用者がIDEを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ImportDeclarationChanges/Delete/{reportId} |
IDEを削除します。 帳票ID(***reportId***)を指定して、、IDEを削除します。 IDEを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ImportDeclarationChanges/DeleteFile/{fileId} |
IDEの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IDEの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ImportDeclarationChanges/Get/{reportId} |
IDEを取得します。 帳票ID(***reportId***)を指定して、IDE取得します。 編集が行われていない場合は、ルートドキュメントから最新のIDEを取得します。 編集中の場合は、先に保存した、IDEを取得します。 |
|
| GET | /API/v2/NaccsReports/ImportDeclarationChanges/GetFile/{fileId} |
IDEに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IDEに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationChanges/Lock/{reportId} |
編集するため、IDEをロックします。 帳票ID(***reportId***)を指定して、IDEをロックします。 IDEを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IDEを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIDEは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IDEをルートドキュメントから参照できますが、編集中(ロック中)のIDEは参照できません。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationChanges/SendToNaccs |
IDEをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIDEをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IDEが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationChanges/SetCancel/{reportId} |
IDEの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IDEの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationChanges/Submit/{reportId} |
IDEを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIDEを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IDEが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationChanges/SubmitByPost |
IDEを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationChanges/Unlock/{reportId} |
IDEのロックを解除します。 帳票ID(***reportId***)を指定して、IDEのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationChanges/Update/{reportId} |
IDEを更新します。 帳票ID(***reportId***)を指定して、IDEを更新します。 このメソッドでは、IDEの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationChanges/UpdateByPost |
IDEを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationChanges/UploadFile |
IDEにファイルを添付します。 指定されたIDEに、ファイルを添付します。 |
|
ImportDeclarationInquiries
IID_輸入申告等照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ImportDeclarationInquiries/Create |
IIDを作成します。 IIDを作成するには、利用者がIIDを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ImportDeclarationInquiries/Delete/{reportId} |
IIDを削除します。 帳票ID(***reportId***)を指定して、、IIDを削除します。 IIDを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ImportDeclarationInquiries/DeleteFile/{fileId} |
IIDの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IIDの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ImportDeclarationInquiries/Get/{reportId} |
IIDを取得します。 帳票ID(***reportId***)を指定して、IID取得します。 編集が行われていない場合は、ルートドキュメントから最新のIIDを取得します。 編集中の場合は、先に保存した、IIDを取得します。 |
|
| GET | /API/v2/NaccsReports/ImportDeclarationInquiries/GetFile/{fileId} |
IIDに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IIDに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationInquiries/Lock/{reportId} |
編集するため、IIDをロックします。 帳票ID(***reportId***)を指定して、IIDをロックします。 IIDを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IIDを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIIDは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IIDをルートドキュメントから参照できますが、編集中(ロック中)のIIDは参照できません。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationInquiries/SendToNaccs |
IIDをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIIDをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IIDが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationInquiries/SetCancel/{reportId} |
IIDの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IIDの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationInquiries/Submit/{reportId} |
IIDを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIIDを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IIDが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationInquiries/Unlock/{reportId} |
IIDのロックを解除します。 帳票ID(***reportId***)を指定して、IIDのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationInquiries/Update/{reportId} |
IIDを更新します。 帳票ID(***reportId***)を指定して、IIDを更新します。 このメソッドでは、IIDの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationInquiries/UploadFile |
IIDにファイルを添付します。 指定されたIIDに、ファイルを添付します。 |
|
ImportDeclarationListInquiries
IDI_輸入申告等一覧照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ImportDeclarationListInquiries/Create |
IDIを作成します。 IDIを作成するには、利用者がIDIを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ImportDeclarationListInquiries/Delete/{reportId} |
IDIを削除します。 帳票ID(***reportId***)を指定して、、IDIを削除します。 IDIを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ImportDeclarationListInquiries/DeleteFile/{fileId} |
IDIの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IDIの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ImportDeclarationListInquiries/Get/{reportId} |
IDIを取得します。 帳票ID(***reportId***)を指定して、IDI取得します。 編集が行われていない場合は、ルートドキュメントから最新のIDIを取得します。 編集中の場合は、先に保存した、IDIを取得します。 |
|
| GET | /API/v2/NaccsReports/ImportDeclarationListInquiries/GetFile/{fileId} |
IDIに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IDIに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationListInquiries/Lock/{reportId} |
編集するため、IDIをロックします。 帳票ID(***reportId***)を指定して、IDIをロックします。 IDIを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IDIを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIDIは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IDIをルートドキュメントから参照できますが、編集中(ロック中)のIDIは参照できません。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationListInquiries/SendToNaccs |
IDIをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIDIをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IDIが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationListInquiries/SetCancel/{reportId} |
IDIの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IDIの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationListInquiries/Submit/{reportId} |
IDIを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIDIを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IDIが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationListInquiries/Unlock/{reportId} |
IDIのロックを解除します。 帳票ID(***reportId***)を指定して、IDIのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationListInquiries/Update/{reportId} |
IDIを更新します。 帳票ID(***reportId***)を指定して、IDIを更新します。 このメソッドでは、IDIの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationListInquiries/UploadFile |
IDIにファイルを添付します。 指定されたIDIに、ファイルを添付します。 |
|
ImportDeclarationRegistrations
IDA_輸入申告事項登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ImportDeclarationRegistrations/Create |
IDAを作成します。 IDAを作成するには、利用者がIDAを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ImportDeclarationRegistrations/Delete/{reportId} |
IDAを削除します。 帳票ID(***reportId***)を指定して、、IDAを削除します。 IDAを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ImportDeclarationRegistrations/DeleteFile/{fileId} |
IDAの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IDAの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ImportDeclarationRegistrations/Get/{reportId} |
IDAを取得します。 帳票ID(***reportId***)を指定して、IDA取得します。 編集が行われていない場合は、ルートドキュメントから最新のIDAを取得します。 編集中の場合は、先に保存した、IDAを取得します。 |
|
| GET | /API/v2/NaccsReports/ImportDeclarationRegistrations/GetFile/{fileId} |
IDAに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IDAに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationRegistrations/Lock/{reportId} |
編集するため、IDAをロックします。 帳票ID(***reportId***)を指定して、IDAをロックします。 IDAを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IDAを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIDAは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IDAをルートドキュメントから参照できますが、編集中(ロック中)のIDAは参照できません。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationRegistrations/SendToNaccs |
IDAをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIDAをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IDAが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationRegistrations/SetCancel/{reportId} |
IDAの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IDAの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationRegistrations/Submit/{reportId} |
IDAを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIDAを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IDAが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationRegistrations/SubmitByPost |
IDAを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationRegistrations/Unlock/{reportId} |
IDAのロックを解除します。 帳票ID(***reportId***)を指定して、IDAのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarationRegistrations/Update/{reportId} |
IDAを更新します。 帳票ID(***reportId***)を指定して、IDAを更新します。 このメソッドでは、IDAの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationRegistrations/UpdateByPost |
IDAを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarationRegistrations/UploadFile |
IDAにファイルを添付します。 指定されたIDAに、ファイルを添付します。 |
|
ImportDeclarations
IDC_輸入申告
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ImportDeclarations/Create |
IDCを作成します。 IDCを作成するには、利用者がIDCを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ImportDeclarations/Delete/{reportId} |
IDCを削除します。 帳票ID(***reportId***)を指定して、、IDCを削除します。 IDCを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ImportDeclarations/DeleteFile/{fileId} |
IDCの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IDCの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ImportDeclarations/Get/{reportId} |
IDCを取得します。 帳票ID(***reportId***)を指定して、IDC取得します。 編集が行われていない場合は、ルートドキュメントから最新のIDCを取得します。 編集中の場合は、先に保存した、IDCを取得します。 |
|
| GET | /API/v2/NaccsReports/ImportDeclarations/GetFile/{fileId} |
IDCに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IDCに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarations/Lock/{reportId} |
編集するため、IDCをロックします。 帳票ID(***reportId***)を指定して、IDCをロックします。 IDCを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IDCを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIDCは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IDCをルートドキュメントから参照できますが、編集中(ロック中)のIDCは参照できません。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarations/SendToNaccs |
IDCをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIDCをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IDCが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarations/SetCancel/{reportId} |
IDCの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IDCの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarations/Submit/{reportId} |
IDCを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIDCを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IDCが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarations/SubmitByPost |
IDCを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarations/Unlock/{reportId} |
IDCのロックを解除します。 帳票ID(***reportId***)を指定して、IDCのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ImportDeclarations/Update/{reportId} |
IDCを更新します。 帳票ID(***reportId***)を指定して、IDCを更新します。 このメソッドでは、IDCの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarations/UpdateByPost |
IDCを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/ImportDeclarations/UploadFile |
IDCにファイルを添付します。 指定されたIDCに、ファイルを添付します。 |
|
ImportInstructions
輸入指図書
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/ImportInstructions/Create |
輸入指図書を作成します。 輸入指図書を作成するには、利用者が輸入指図書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 輸入指図書に関する詳細については、[輸入指図書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/ImportInstructions/Delete/{reportId} |
輸入指図書を削除します。 帳票ID(***reportId***)を指定して、輸入指図書を削除します。 輸入指図書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した輸入指図書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 輸入指図書に関する詳細については、[輸入指図書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/ImportInstructions/DeleteFile/{fileId} |
輸入指図書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、輸入指図書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/ImportInstructions/Get/{reportId}?historyId=!{historyId} |
輸入指図書を取得します。 帳票ID(***reportId***)を指定して、輸入指図書を取得します。 編集が行われていない場合は、ルートドキュメントから最新の輸入指図書を取得します。 編集中の場合は、先に保存した、輸入指図書を取得します。 輸入指図書に関する詳細については、[輸入指図書について]()を参照ください。 |
|
| GET | /API/v2/Reports/ImportInstructions/GetDiff/{reportId}?historyId=!{historyId} |
保存されている輸入指図書とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する輸入指図書と、ルートドキュメントの差分を取得します。 比較元を保存されている輸入指図書、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/ImportInstructions/GetFile/{fileId} |
輸入指図書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、輸入指図書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/ImportInstructions/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
輸入指図書を全て取得します。 検索条件に該当する輸入指図書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の輸入指図書を取得します。 編集中の場合は、先に保存した、輸入指図書を取得します。 輸入指図書に関する詳細については、[輸入指図書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ImportInstructions/Lock/{reportId} |
編集するため、輸入指図書をロックします 帳票ID(***reportId***)を指定して、輸入指図書をロックします。 輸入指図書を作成(***Create***)した時点では、輸入指図書をロックが掛かりますが、取得(***Get***)したあとで、輸入指図書を編集する場合は、このメソッドを呼び出して、輸入指図書をロックします。 ロックされた輸入指図書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、輸入指図書をルートドキュメントから参照できますが、編集中(ロック中)の輸入指図書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 輸入指図書に関する詳細については、[輸入指図書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ImportInstructions/SetCancel/{reportId} |
輸入指図書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、輸入指図書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 輸入指図書に関する詳細については、[輸入指図書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ImportInstructions/Submit/{reportId} |
輸入指図書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した輸入指図書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、輸入指図書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、輸入指図書もロックされた状態のままなので、ご注意ください。 輸入指図書に関する詳細については、[輸入指図書について]()を参照ください。 |
|
| POST | /API/v2/Reports/ImportInstructions/SubmitByPost |
輸入指図書を提出します。 動作は、輸入指図書(***/API/v2/Reports/ImportInstructions/Submit***)と同様です。 輸入指図書に関する詳細については、[輸入指図書]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ImportInstructions/Unlock/{reportId} |
輸入指図書のロックを解除します 帳票ID(***reportId***)を指定して、輸入指図書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 輸入指図書に関する詳細については、[輸入指図書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ImportInstructions/Update/{reportId} |
輸入指図書を更新します。 帳票ID(***reportId***)を指定して、輸入指図書を更新します。 このメソッドでは、輸入指図書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 輸入指図書に関する詳細については、[輸入指図書について]()を参照ください。 |
|
| POST | /API/v2/Reports/ImportInstructions/UpdateByPost |
輸入指図書を更新します。 動作は、輸入指図書(***/API/v2/Reports/ImportInstructions/Update***)と同様です。 輸入指図書に関する詳細については、[輸入指図書]()を参照ください。 |
|
| POST | /API/v2/Reports/ImportInstructions/UploadFile |
輸入指図書にファイルを添付します。 指定された輸入指図書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
ImportTradeControlOrdinanceAppendixCodes
輸入貿易管理令別表コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/ImportTradeControlOrdinanceAppendixCodes/DeleteAdmin/{importTradeControlOrdinanceAppendixCode} |
輸入貿易管理令別表コードを削除します。 輸入貿易管理令別表コード(***importTradeControlOrdinanceAppendixCode***)を指定して、輸入貿易管理令別表コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/ImportTradeControlOrdinanceAppendixCodes/Get/{importTradeControlOrdinanceAppendixCode} |
輸入貿易管理令別表を取得します。 輸入貿易管理令別表コード(***importTradeControlOrdinanceAppendixCode***)を指定して、輸入貿易管理令別表を取得します。 輸入貿易管理令別表コードに関する詳細については、[輸入貿易管理令別表コードについて]()を参照ください。 |
|
| GET | /API/v2/General/ImportTradeControlOrdinanceAppendixCodes/GetList |
輸入貿易管理令別表を全て取得します。 輸入貿易管理令別表コードに関する詳細については、[輸入貿易管理令別表コードについて]()を参照ください。 |
|
| POST | /API/v2/General/ImportTradeControlOrdinanceAppendixCodes/RegisterAdmin |
輸入貿易管理令別表を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/ImportTradeControlOrdinanceAppendixCodes/RegisterInternal |
輸入貿易管理令別表を登録します。 内部呼び出し用。 (*For admin) |
|
LinkageTrades
TradeWaltz連携取引
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/TradeWaltz/LinkageTrades/DeleteAdmin/{linkageId} |
TradeWaltz連携取引を削除します。 連携キー(***lenkageKey***)を指定して、TradeWaltz連携取引を削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| GET | /API/v2/TradeWaltz/LinkageTrades/GetAdmin/{linkageId} |
TradeWaltz連携帳票を取得します。 連携ID(***linkageId***)を指定して、TradeWaltz連携帳票を取得します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| GET | /API/v2/TradeWaltz/LinkageTrades/GetListAdmin |
TradeWaltz連携取引を全て取得します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/TradeWaltz/LinkageTrades/RegisterAdmin |
TradeWaltz連携取引を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/TradeWaltz/LinkageTrades/RegisterInternal |
TradeWaltz連携取引を登録します。 内部呼び出し用。 (*For admin) |
|
Messages
取引内のメッセージ
| API | Description | ||
|---|---|---|---|
| PATCH | /API/v2/Trades/Messages/Edit/{historyId} |
送信した取引内のメッセージを更新します。 メッセージID(***messageId***)を指定して、送信した取引内のメッセージを更新します。 |
|
| GET | /API/v2/Trades/Messages/GetDetails/{historyId} |
取引内のメッセージを取得します。 履歴ID(***historyId***)を指定して、その操作に対するメッセージを返信メッセージも含めて、取得します。 |
|
| GET | /API/v2/Trades/Messages/GetHistories/{historyId} |
取引内のメッセージについての履歴を取得します。 履歴ID(***historyId***)を指定して、その操作に対するメッセージの履歴を取得します。 |
|
| PATCH | /API/v2/Trades/Messages/MarkAsDelete/{historyId} |
送信した取引内のメッセージのメッセージ内容を削除します。 メッセージID(***messageId***)を指定して、送信した取引内のメッセージを削除としてマークします。 削除してマークされたメッセージは、メッセージ内容が確認できなくなります。 |
|
| POST | /API/v2/Trades/Messages/Reply |
取引内のメッセージを返信します。 取引内でメッセージを返信します。 取引内のメッセージに関する詳細については、[取引内のメッセージでの操作履歴について]()を参照ください。 |
|
| POST | /API/v2/Trades/Messages/Send |
取引内のメッセージを送信します。 取引のパートナーに対して、メッセージを送信します。 取引内のメッセージに関する詳細については、[取引内のメッセージでの操作履歴について]()を参照ください。 |
|
ModifiedDeclarationCalls
AMB_修正申告事項呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ModifiedDeclarationCalls/Create |
AMBを作成します。 AMBを作成するには、利用者がAMBを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ModifiedDeclarationCalls/Delete/{reportId} |
AMBを削除します。 帳票ID(***reportId***)を指定して、、AMBを削除します。 AMBを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ModifiedDeclarationCalls/DeleteFile/{fileId} |
AMBの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、AMBの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ModifiedDeclarationCalls/Get/{reportId} |
AMBを取得します。 帳票ID(***reportId***)を指定して、AMB取得します。 編集が行われていない場合は、ルートドキュメントから最新のAMBを取得します。 編集中の場合は、先に保存した、AMBを取得します。 |
|
| GET | /API/v2/NaccsReports/ModifiedDeclarationCalls/GetFile/{fileId} |
AMBに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、AMBに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ModifiedDeclarationCalls/Lock/{reportId} |
編集するため、AMBをロックします。 帳票ID(***reportId***)を指定して、AMBをロックします。 AMBを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、AMBを編集する場合は、このメソッドを呼び出してロックします。 ロックされたAMBは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、AMBをルートドキュメントから参照できますが、編集中(ロック中)のAMBは参照できません。 |
|
| POST | /API/v2/NaccsReports/ModifiedDeclarationCalls/SendToNaccs |
AMBをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したAMBをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、AMBが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ModifiedDeclarationCalls/SetCancel/{reportId} |
AMBの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、AMBの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ModifiedDeclarationCalls/Submit/{reportId} |
AMBを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したAMBを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、AMBが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ModifiedDeclarationCalls/Unlock/{reportId} |
AMBのロックを解除します。 帳票ID(***reportId***)を指定して、AMBのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ModifiedDeclarationCalls/Update/{reportId} |
AMBを更新します。 帳票ID(***reportId***)を指定して、AMBを更新します。 このメソッドでは、AMBの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ModifiedDeclarationCalls/UploadFile |
AMBにファイルを添付します。 指定されたAMBに、ファイルを添付します。 |
|
ModifiedDeclarationRegistrations
AMA_修正申告事項登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ModifiedDeclarationRegistrations/Create |
AMAを作成します。 AMAを作成するには、利用者がAMAを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ModifiedDeclarationRegistrations/Delete/{reportId} |
AMAを削除します。 帳票ID(***reportId***)を指定して、、AMAを削除します。 AMAを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ModifiedDeclarationRegistrations/DeleteFile/{fileId} |
AMAの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、AMAの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ModifiedDeclarationRegistrations/Get/{reportId} |
AMAを取得します。 帳票ID(***reportId***)を指定して、AMA取得します。 編集が行われていない場合は、ルートドキュメントから最新のAMAを取得します。 編集中の場合は、先に保存した、AMAを取得します。 |
|
| GET | /API/v2/NaccsReports/ModifiedDeclarationRegistrations/GetFile/{fileId} |
AMAに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、AMAに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ModifiedDeclarationRegistrations/Lock/{reportId} |
編集するため、AMAをロックします。 帳票ID(***reportId***)を指定して、AMAをロックします。 AMAを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、AMAを編集する場合は、このメソッドを呼び出してロックします。 ロックされたAMAは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、AMAをルートドキュメントから参照できますが、編集中(ロック中)のAMAは参照できません。 |
|
| POST | /API/v2/NaccsReports/ModifiedDeclarationRegistrations/SendToNaccs |
AMAをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したAMAをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、AMAが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ModifiedDeclarationRegistrations/SetCancel/{reportId} |
AMAの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、AMAの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ModifiedDeclarationRegistrations/Submit/{reportId} |
AMAを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したAMAを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、AMAが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/ModifiedDeclarationRegistrations/SubmitByPost |
AMAを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/ModifiedDeclarationRegistrations/Unlock/{reportId} |
AMAのロックを解除します。 帳票ID(***reportId***)を指定して、AMAのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ModifiedDeclarationRegistrations/Update/{reportId} |
AMAを更新します。 帳票ID(***reportId***)を指定して、AMAを更新します。 このメソッドでは、AMAの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ModifiedDeclarationRegistrations/UpdateByPost |
AMAを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/ModifiedDeclarationRegistrations/UploadFile |
AMAにファイルを添付します。 指定されたAMAに、ファイルを添付します。 |
|
ModifiedDeclarations
AMC_修正申告
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ModifiedDeclarations/Create |
AMCを作成します。 AMCを作成するには、利用者がAMCを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ModifiedDeclarations/Delete/{reportId} |
AMCを削除します。 帳票ID(***reportId***)を指定して、、AMCを削除します。 AMCを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ModifiedDeclarations/DeleteFile/{fileId} |
AMCの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、AMCの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ModifiedDeclarations/Get/{reportId} |
AMCを取得します。 帳票ID(***reportId***)を指定して、AMC取得します。 編集が行われていない場合は、ルートドキュメントから最新のAMCを取得します。 編集中の場合は、先に保存した、AMCを取得します。 |
|
| GET | /API/v2/NaccsReports/ModifiedDeclarations/GetFile/{fileId} |
AMCに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、AMCに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ModifiedDeclarations/Lock/{reportId} |
編集するため、AMCをロックします。 帳票ID(***reportId***)を指定して、AMCをロックします。 AMCを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、AMCを編集する場合は、このメソッドを呼び出してロックします。 ロックされたAMCは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、AMCをルートドキュメントから参照できますが、編集中(ロック中)のAMCは参照できません。 |
|
| POST | /API/v2/NaccsReports/ModifiedDeclarations/SendToNaccs |
AMCをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したAMCをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、AMCが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ModifiedDeclarations/SetCancel/{reportId} |
AMCの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、AMCの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ModifiedDeclarations/Submit/{reportId} |
AMCを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したAMCを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、AMCが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/ModifiedDeclarations/SubmitByPost |
AMCを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/ModifiedDeclarations/Unlock/{reportId} |
AMCのロックを解除します。 帳票ID(***reportId***)を指定して、AMCのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ModifiedDeclarations/Update/{reportId} |
AMCを更新します。 帳票ID(***reportId***)を指定して、AMCを更新します。 このメソッドでは、AMCの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ModifiedDeclarations/UpdateByPost |
AMCを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/ModifiedDeclarations/UploadFile |
AMCにファイルを添付します。 指定されたAMCに、ファイルを添付します。 |
|
MultimodalTransportBillOfLadings
複合運送証券
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/MultimodalTransportBillOfLadings/Create |
複合運送証券を作成します。 複合運送証券を作成するには、利用者が複合運送証券を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 複合運送証券に関する詳細については、[複合運送証券について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/MultimodalTransportBillOfLadings/Delete/{reportId} |
複合運送証券を削除します。 帳票ID(***reportId***)を指定して、複合運送証券を削除します。 複合運送証券を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した複合運送証券のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 複合運送証券に関する詳細については、[複合運送証券について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/MultimodalTransportBillOfLadings/DeleteFile/{fileId} |
複合運送証券の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、複合運送証券の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/MultimodalTransportBillOfLadings/Get/{reportId}?historyId=!{historyId} |
複合運送証券を取得します。 帳票ID(***reportId***)を指定して、複合運送証券を取得します。 編集が行われていない場合は、ルートドキュメントから最新の複合運送証券を取得します。 編集中の場合は、先に保存した、複合運送証券を取得します。 複合運送証券に関する詳細については、[複合運送証券について]()を参照ください。 |
|
| GET | /API/v2/Reports/MultimodalTransportBillOfLadings/GetDiff/{reportId}?historyId=!{historyId} |
保存されている複合運送証券とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する複合運送証券と、ルートドキュメントの差分を取得します。 比較元を保存されている複合運送証券、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/MultimodalTransportBillOfLadings/GetFile/{fileId} |
複合運送証券に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、複合運送証券に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/MultimodalTransportBillOfLadings/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
複合運送証券を全て取得します。 検索条件に該当する複合運送証券を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の複合運送証券を取得します。 編集中の場合は、先に保存した、複合運送証券を取得します。 複合運送証券に関する詳細については、[複合運送証券について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/MultimodalTransportBillOfLadings/Lock/{reportId} |
編集するため、複合運送証券をロックします 帳票ID(***reportId***)を指定して、複合運送証券をロックします。 複合運送証券を作成(***Create***)した時点では、複合運送証券をロックが掛かりますが、取得(***Get***)したあとで、複合運送証券を編集する場合は、このメソッドを呼び出して、複合運送証券をロックします。 ロックされた複合運送証券は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、海上運送状(ウェイビル)をルートドキュメントから参照できますが、編集中(ロック中)の複合運送証券は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 複合運送証券に関する詳細については、[複合運送証券について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/MultimodalTransportBillOfLadings/SetCancel/{reportId} |
複合運送証券の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、複合運送証券の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 複合運送証券に関する詳細については、[複合運送証券について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/MultimodalTransportBillOfLadings/Submit/{reportId} |
複合運送証券を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した複合運送証券を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、複合運送証券が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、複合運送証券もロックされた状態のままなので、ご注意ください。 複合運送証券に関する詳細については、[複合運送証券について]()を参照ください。 |
|
| POST | /API/v2/Reports/MultimodalTransportBillOfLadings/SubmitByPost |
複合運送証券を提出します。 動作は、複合運送証券(***/API/v2/Reports/MultimodalTransportBillOfLadings/Update***)と同様です。 複合運送証券に関する詳細については、[複合運送証券]()を参照ください。 |
|
| PATCH | /API/v2/Reports/MultimodalTransportBillOfLadings/Unlock/{reportId} |
複合運送証券のロックを解除します 帳票ID(***reportId***)を指定して、複合運送証券のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 複合運送証券に関する詳細については、[複合運送証券について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/MultimodalTransportBillOfLadings/Update/{reportId} |
複合運送証券を更新します。 帳票ID(***reportId***)を指定して、複合運送証券を更新します。 このメソッドでは、複合運送証券の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 複合運送証券に関する詳細については、[複合運送証券について]()を参照ください。 |
|
| POST | /API/v2/Reports/MultimodalTransportBillOfLadings/UpdateByPost |
複合運送証券を更新します。 動作は、複合運送証券(***/API/v2/Reports/MultimodalTransportBillOfLadings/Update***)と同様です。 複合運送証券に関する詳細については、[複合運送証券]()を参照ください。 |
|
| POST | /API/v2/Reports/MultimodalTransportBillOfLadings/UploadFile |
複合運送証券にファイルを添付します。 指定された複合運送証券に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
NaccsBusinessTypes
NACCS業務
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/NaccsBusinessTypes/DeleteAdmin/{naccsBusinessCode} |
NACCS業務を削除します。 NACCS業務コード(***naccsBusinessCode***)を指定して、NACCS業務を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/NaccsBusinessTypes/Get/{naccsBusinessCode} |
NACCS業務を取得します。 NACCS業務コード(***naccsBusinessCode***)を指定して、NACCS業務を取得します。 NACCS業務に関する詳細については、[NACCS業務について]()を参照ください。 |
|
| GET | /API/v2/General/NaccsBusinessTypes/GetList |
NACCS業務を全て取得します。 NACCS業務を全て取得します。 NACCS業務に関する詳細については、[NACCS業務について]()を参照ください。 |
|
| POST | /API/v2/General/NaccsBusinessTypes/RegisterAdmin |
NACCS業務を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/NaccsBusinessTypes/RegisterInternal |
事業種別を登録します。 内部呼び出し用。 (*For admin) |
|
NaccsExportControls
NACCS出力制御
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/NaccsExportControls/DeleteAdmin/{naccsExportControlCode} |
NACCS出力制御を削除します。 NACCS出力制御コード(***naccsExportControlCode***)を指定して、NACCS出力制御を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/NaccsExportControls/Get/{naccsExportControlCode} |
NACCS出力制御を取得します。 NACCS出力制御コード(***naccsExportControlCode***)を指定して、NACCS出力制御を取得します。 NACCS出力制御に関する詳細については、[NACCS出力制御について]()を参照ください。 |
|
| GET | /API/v2/General/NaccsExportControls/GetList |
NACCS出力制御を全て取得します。 NACCS出力制御に関する詳細については、[NACCS出力制御について]()を参照ください。 |
|
| POST | /API/v2/General/NaccsExportControls/RegisterAdmin |
NACCS出力制御を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/NaccsExportControls/RegisterInternal |
出力制御種別を登録します。 内部呼び出し用。 (*For admin) |
|
NaccsImportControls
NACCS取込制御
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/NaccsImportControls/DeleteAdmin/{naccsImportControlCode} |
NACCS取入制御を削除します。 NACCS取入制御コード(***naccsImportControlCode***)を指定して、NACCS取入制御を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/NaccsImportControls/Get/{naccsImportControlCode} |
NACCS取入制御を取得します。 NACCS取入制御コード(***naccsImportControlCode***)を指定して、NACCS取入制御を取得します。 NACCS取入制御に関する詳細については、[NACCS取入制御について]()を参照ください。 |
|
| GET | /API/v2/General/NaccsImportControls/GetList |
NACCS取入制御を全て取得します。 NACCS取入制御に関する詳細については、[NACCS取入制御について]()を参照ください。 |
|
| POST | /API/v2/General/NaccsImportControls/RegisterAdmin |
NACCS取引制御を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/NaccsImportControls/RegisterInternal |
取引制御種別を登録します。 内部呼び出し用。 (*For admin) |
|
NaccsMessages
NACCSメッセージ
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/NaccsMessages/DeleteAdmin/{naccsMessageId} |
NACCSメッセージを削除します。 NACCSメッセージID(***naccsMessageId***)を指定して、NACCSメッセージを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| DELETE | /API/v2/General/NaccsMessages/DeleteAdminByNaccsBusinessCode/{naccsBusinessCode} |
NACCSメッセージをNACCS業務コード単位で削除します。 NACCS業務コード(***naccsBusinessCode***)を指定して、NACCSメッセージを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/NaccsMessages/Get/{naccsMessageId} |
NACCSメッセージを取得します。 NACCSメッセージID(***naccsMessageId***)を指定して、NACCSメッセージを取得します。 |
|
| GET | /API/v2/General/NaccsMessages/GetList?naccsBusinessCode={naccsBusinessCode} |
NACCSメッセージを取得します。 NACCS業務コードに該当する全てメッセージを取得します。 |
|
| GET | /API/v2/General/NaccsMessages/GetListInternal?naccsMessageId=!{naccsMessageId}&naccsBusinessCode=!{naccsBusinessCode} |
NACCSメッセージを取得します。 検索条件に該当するメッセージを全て取得します。 内部呼び出し用。 |
|
| POST | /API/v2/General/NaccsMessages/RegisterAdmin |
NACCS停止スケジュールを登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/General/NaccsMessages/RegisterInternal |
NACCS停止スケジュールを登録します。 内部呼び出し用。 (*For admin) |
|
NaccsReceiveDatas
NACCS受信データ
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/NACCS/NaccsReceiveDatas/GetByInputInfoSpecificNo/{naccsBusinessCode}?naccsUserCode={naccsUserCode}&inputInfoSpecificNo={inputInfoSpecificNo} |
NACCSから受信したデータをEDI形式で、入力情報特定番号単位に一括取得します。 ## 概要 NACCSから受信したデータをNACCS業務コード(***naccsBusinessCode***)、NACCS利用者コード(***naccsUserCode***)、入力情報特定番号(***inputInfoSpecificNo***)を指定して取得します。 取得したデータはEDI電文の形式です。 処理結果と出力情報の様に2種類ある場合は、List形式で一括取得されます。 また継続電文は1つのEDIデータにまとまって取得されますが、1つのEDIデータが1.8MBを超える場合には複数に分割されます。 ## 指定するパラメタについて ### NACCS業務コード 取得するEDIデータのNACCS業務コード(***naccsBusinessCode***)を必ず指定します。 ### NACCS利用者コード ユーザと紐づいているNACCS利用者コード(***naccsUserCode***)を必ず指定します。 指定したNACCS利用者コードがユーザと紐づいているNACCS利用者コードで無い場合エラーとなります。 ### 入力情報特定番号 取得するEDIデータの入力情報特定番号(***inputInfoSpecificNo***)を必ず指定します。 入力情報特定番号は、NACCSへの送信時に割り当てられています。 |
|
| GET | /API/v2/NACCS/NaccsReceiveDatas/GetEdiList/{naccsBusinessCode}?naccsOutputInfoCode={naccsOutputInfoCode}&naccsUserCode={naccsUserCode}&inputInfoSpecificNo={inputInfoSpecificNo} |
NACCSから受信したデータをEDI形式で取得します。 ## 概要 NACCSから受信したデータをNACCS業務コード(***naccsBusinessCode***)、NACCS出力情報コード(***naccsOutputInfoCode***)、NACCS利用者コード(***naccsUserCode***)、入力情報特定番号(***inputInfoSpecificNo***)を指定して取得します。 取得したデータはEDI電文の形式です。 継続電文は1つのEDIデータにまとまって取得されますが、1つのEDIデータが1.8MBを超える場合には複数に分割されます。 ## 指定するパラメタについて ### NACCS業務コード 取得するEDIデータのNACCS業務コード(***naccsBusinessCode***)を必ず指定します。 ### NACCS出力情報コード 取得するEDIデータのNACCS業務コード(***naccsBusinessCode***)のNACCS出力情報コード(***naccsOutputInfoCode***)を必ず指定します。 ### NACCS利用者コード ユーザと紐づいているNACCS利用者コード(***naccsUserCode***)を必ず指定します。 指定したNACCS利用者コードがユーザと紐づいているNACCS利用者コードで無い場合エラーとなります。 ### 入力情報特定番号 取得するEDIデータの入力情報特定番号(***inputInfoSpecificNo***)を必ず指定します。 入力情報特定番号は、NACCSへの送信時に割り当てられています。 |
|
| GET | /API/v2/NACCS/NaccsReceiveDatas/GetExcelReport/{naccsBusinessCode}?naccsOutputInfoCode={naccsOutputInfoCode}&naccsUserCode={naccsUserCode}&inputInfoSpecificNo={inputInfoSpecificNo}&detailNo=!{detailNo} |
NACCSから受信したデータをExcelフォーマットで取得します。 ## 概要 NACCSから受信したデータをNACCS業務コード(***naccsBusinessCode***)、NACCS出力情報コード(***naccsOutputInfoCode***)、NACCS利用者コード(***naccsUserCode***)、入力情報特定番号(***inputInfoSpecificNo***)を指定してExcelフォーマットで取得します。 同一出力情報データがある場合は、明細番号(***detailNo***)を指定します。 取得したデータはバイナリ形式です。 ***※このAPIは、Swagger上ではレスポンスを取得できません。*** ## 指定するパラメタについて ### NACCS業務コード 取得するEDIデータのNACCS業務コード(***naccsBusinessCode***)を必ず指定します。 ### NACCS出力情報コード 取得するEDIデータのNACCS業務コード(***naccsBusinessCode***)のNACCS出力情報コード(***naccsOutputInfoCode***)を必ず指定します。 ### NACCS利用者コード ユーザと紐づいているNACCS利用者コード(***naccsUserCode***)を必ず指定します。 指定したNACCS利用者コードがユーザと紐づいているNACCS利用者コードで無い場合エラーとなります。 ### 入力情報特定番号 取得するEDIデータの入力情報特定番号(***inputInfoSpecificNo***)を必ず指定します。 入力情報特定番号は、NACCSへの送信時に割り当てられています。 ### 明細番号 取得するEDIデータが複数ある場合、2つめ以降で帳票を作成する際に明細番号(***detailNo***)を指定します。未指定の場合は1つめで作成されます。 ## レスポンス例 (Responses Code : 200) ### Response headers content-disposition: attachment; filename=SAE1LF.xlsx ※filenameの形式は「NACCS出力情報コード.xlsx」です。 content-type: application/octet-stream ### Response body バイナリデータ |
|
| GET | /API/v2/NACCS/NaccsReceiveDatas/GetExcelReportUrl/{naccsBusinessCode}?naccsOutputInfoCode={naccsOutputInfoCode}&naccsUserCode={naccsUserCode}&inputInfoSpecificNo={inputInfoSpecificNo}&detailNo=!{detailNo} |
NACCSから受信したデータで作成したExce帳票のUrlを取得します。 ## 概要 NACCSから受信したデータをNACCS業務コード(***naccsBusinessCode***)、NACCS出力情報コード(***naccsOutputInfoCode***)、NACCS利用者コード(***naccsUserCode***)、入力情報特定番号(***inputInfoSpecificNo***)を指定してExcelフォーマットで取得します。 同一出力情報データがある場合は、明細番号(***detailNo***)を指定します。 取得したデータはバイナリ形式です。 ## 指定するパラメタについて ### NACCS業務コード 取得するEDIデータのNACCS業務コード(***naccsBusinessCode***)を必ず指定します。 ### NACCS出力情報コード 取得するEDIデータのNACCS業務コード(***naccsBusinessCode***)のNACCS出力情報コード(***naccsOutputInfoCode***)を必ず指定します。 ### NACCS利用者コード ユーザと紐づいているNACCS利用者コード(***naccsUserCode***)を必ず指定します。 指定したNACCS利用者コードがユーザと紐づいているNACCS利用者コードで無い場合エラーとなります。 ### 入力情報特定番号 取得するEDIデータの入力情報特定番号(***inputInfoSpecificNo***)を必ず指定します。 入力情報特定番号は、NACCSへの送信時に割り当てられています。 ### 明細番号 取得するEDIデータが複数ある場合、2つめ以降で帳票を作成する際に明細番号(***detailNo***)を指定します。未指定の場合は1つめで作成されます。 |
|
| GET | /API/v2/NACCS/NaccsReceiveDatas/GetJson/{naccsBusinessCode}?naccsOutputInfoCode={naccsOutputInfoCode}&naccsUserCode={naccsUserCode}&inputInfoSpecificNo={inputInfoSpecificNo} |
NACCSから受信したデータをJSON形式で取得します。 ## 概要 NACCSから受信したデータをNACCS業務コード(***naccsBusinessCode***)、NACCS出力情報コード(***naccsOutputInfoCode***)、NACCS利用者コード(***naccsUserCode***)、入力情報特定番号(***inputInfoSpecificNo***)を指定して取得します。 取得したデータはJSONの形式です。 取得可能なデータは、照会業務と呼出業務の出力情報と、輸出入申告の許可通知・申告控え情報です。 詳細はマニュアルを参照してください。 ## 指定するパラメタについて ### NACCS業務コード 取得するEDIデータのNACCS業務コード(***naccsBusinessCode***)を必ず指定します。 ### NACCS出力情報コード 取得するEDIデータのNACCS業務コード(***naccsBusinessCode***)のNACCS出力情報コード(***naccsOutputInfoCode***)を必ず指定します。 ### NACCS利用者コード ユーザと紐づいているNACCS利用者コード(***naccsUserCode***)を必ず指定します。 指定したNACCS利用者コードがユーザと紐づいているNACCS利用者コードで無い場合エラーとなります。 ### 入力情報特定番号 取得するEDIデータの入力情報特定番号(***inputInfoSpecificNo***)を必ず指定します。 入力情報特定番号は、NACCSへの送信時に割り当てられています。 |
|
NaccsSendPermissions
帳票NACCS送信権限
NaccsShutdownSchedules
NACCS停止スケジュール
NaccsUsers
NACCS利用者
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Companies/NaccsUsers/Delete/{naccsUserId} |
NACCS利用者を削除します。 NACCS利用者ID(***naccsUserId***)を指定して、自社に登録されているNACCS利用者を削除します。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
| GET | /API/v2/Companies/NaccsUsers/Get/{naccsUserId} |
NACCS利用者を取得します。 NACCS利用者ID(***naccsUserId***)を指定して、自社に登録されているNACCS利用者を取得します。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
| GET | /API/v2/Companies/NaccsUsers/GetBasic/{naccsUserId} |
NACCS利用者の基本情報を取得します。 NACCS利用者ID(***naccsUserId***)を指定して、自社に登録されているNACCS利用者の基本情報を取得します。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
| GET | /API/v2/Companies/NaccsUsers/GetBasicList |
自社に登録されているNACCS利用者の基本情報を全て取得します。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
| GET | /API/v2/Companies/NaccsUsers/GetList |
自社に登録されているNACCS利用者を全て取得します。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
| POST | /API/v2/Companies/NaccsUsers/Register |
NACCS利用者を登録します。 NACCS センターより付与された NACCS 利用者(利用者コード、識別番号、パスワード)をサイバーポートに登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
NotifiableOperations
通知可能な操作
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Master/NotifiableOperations/DeleteAdmin/{notifiableOperationCode} |
通知可能な操作を削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| GET | /API/v2/Master/NotifiableOperations/Get/{notifiableOperationCode} |
通知可能な操作を取得します。 通知可能な操作コード(***notifiableOperationCode***)を指定して、通知可能な操作を取得します。 通知可能な操作に関する詳細については、、[通知可能な操作について]()を参照ください。 |
|
| GET | /API/v2/Master/NotifiableOperations/GetList |
通知可能な操作を全て取得します。 通知可能な操作を全て取得します。 通知可能な操作に関する詳細については、[通知可能な操作について]()を参照ください。 |
|
| POST | /API/v2/Master/NotifiableOperations/RegisterAdmin |
通知可能な操作を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/Master/NotifiableOperations/RegisterInternal |
通知可能な操作を登録します。 内部呼び出し用。 (*For admin) |
|
NotificationContacts
お知らせの連絡先
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Companies/NotificationContacts/Delete/{notificationContactId} |
お知らせ通知先を削除します。 お知らせの連絡先ID(***notificationContactId***)を指定して、会社に登録されているお知らせ通知先を削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 お知らせ通知先に関する詳細については、[お知らせ通知先について]()を参照ください。 |
|
| GET | /API/v2/Companies/NotificationContacts/Get/{notificationContactId} |
お知らせの連絡先を取得します。 お知らせの連絡先ID(***notificationContactId***)を指定して、お知らせの連絡先を取得します。 お知らせの連絡先に関する詳細については、[お知らせの連絡先について]()を参照ください。 |
|
| GET | /API/v2/Companies/NotificationContacts/GetList?notificationContactId=!{notificationContactId}}&emailAddress=!{emailAddress}&employeeId=!{employeeId} |
お知らせの連絡先を全て取得します。 ログインしている利用者が所属するお知らせの連絡先を全て取得します。 お知らせの連絡先に関する詳細については、[お知らせの連絡先について]()を参照ください。 |
|
| POST | /API/v2/Companies/NotificationContacts/Register |
お知らせの連絡先を登録します。 管理者が所属する会社の中から利用者やメールアドレスを指定して、お知らせの連絡先として登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 お知らせの連絡先に関する詳細については、[お知らせの連絡先について]()を参照ください。 |
|
NotifyOperationByMails
利用者のメール通知設定
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Employees/NotifyOperationByMails/Delete/{employeeNotifyId} |
利用者の通知設定を削除します。 利用者の通知設定ID(***employeeNotifyId***)を指定して、利用者の通知設定を削除します。 利用者の通知設定に関する詳細については、[利用者の通知設定について]()を参照ください。 |
|
| GET | /API/v2/Employees/NotifyOperationByMails/Get/{employeeNotifyId} |
利用者の通知設定を取得します。 利用者の通知設定ID(***employeeNotifyId***)を指定して、利用者の通知設定を取得します。 利用者の通知設定に関する詳細については、[利用者の通知設定について]()を参照ください。 |
|
| GET | /API/v2/Employees/NotifyOperationByMails/GetList |
利用者の通知設定を全て取得します。 ログインしている利用者の通知設定を全て取得します。 利用者の通知設定に関する詳細については、[利用者の通知設定について]()を参照ください。 |
|
| POST | /API/v2/Employees/NotifyOperationByMails/Register |
利用者の通知設定を登録します。 ログインしている利用者の通知設定を登録します。 利用者の通知設定に関する詳細については、[利用者の通知設定について]()を参照ください。 |
|
NotifyOperations
Webhookの通知設定
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Organizations/UsedWebhooks/NotifyOperations/Delete/{webhookNotifyId} |
Webhookの通知設定を削除します。 Webhookの通知設定ID(***webhookNotifyId***)を指定して、Webhookの通知設定を削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 Webhookの通知設定に関する詳細については、[Webhookの通知設定について]()を参照ください。 |
|
| GET | /API/v2/Organizations/UsedWebhooks/NotifyOperations/Get/{webhookNotifyId} |
Webhookの通知設定を取得します。 Webhookの通知設定ID(***webhookNotifyId***)を指定して、Wenhookの通知設定を取得します。 Webhookの通知設定に関する詳細については、[Webhookの通知設定について]()を参照ください。 |
|
| GET | /API/v2/Organizations/UsedWebhooks/NotifyOperations/GetList/{usedWebhookId} |
Webhookの通知設定を全て取得します。 Webhook設定(***webhookId**)を指定して、Webhookの通知設定を全て取得します。 Webhookの通知設定に関する詳細については、[Webhookの通知設定について]()を参照ください。 |
|
| POST | /API/v2/Organizations/UsedWebhooks/NotifyOperations/Register |
Webhookの通知設定を登録します。 管理者が所属する会社に登録されたWebookの通知設定を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 Webhookの通知設定に関する詳細については、[Webhookの通知設定について]()を参照ください。 |
|
OffSystemDeliveryConfirmationExportApprovals
BIE_システム外搬入確認(輸出許可済)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/OffSystemDeliveryConfirmationExportApprovals/Create |
BIEを作成します。 BIEを作成するには、利用者がBIEを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/OffSystemDeliveryConfirmationExportApprovals/Delete/{reportId} |
BIEを削除します。 帳票ID(***reportId***)を指定して、、BIEを削除します。 BIEを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/OffSystemDeliveryConfirmationExportApprovals/DeleteFile/{fileId} |
BIEの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、BIEの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/OffSystemDeliveryConfirmationExportApprovals/Get/{reportId} |
BIEを取得します。 帳票ID(***reportId***)を指定して、BIE取得します。 編集が行われていない場合は、ルートドキュメントから最新のBIEを取得します。 編集中の場合は、先に保存した、BIEを取得します。 |
|
| GET | /API/v2/NaccsReports/OffSystemDeliveryConfirmationExportApprovals/GetFile/{fileId} |
BIEに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、BIEに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/OffSystemDeliveryConfirmationExportApprovals/Lock/{reportId} |
編集するため、BIEをロックします。 帳票ID(***reportId***)を指定して、BIEをロックします。 BIEを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、BIEを編集する場合は、このメソッドを呼び出してロックします。 ロックされたBIEは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、BIEをルートドキュメントから参照できますが、編集中(ロック中)のBIEは参照できません。 |
|
| POST | /API/v2/NaccsReports/OffSystemDeliveryConfirmationExportApprovals/SendToNaccs |
BIEをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したBIEをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BIEが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/OffSystemDeliveryConfirmationExportApprovals/SetCancel/{reportId} |
BIEの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、BIEの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/OffSystemDeliveryConfirmationExportApprovals/Submit/{reportId} |
BIEを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したBIEを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、BIEが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/OffSystemDeliveryConfirmationExportApprovals/SubmitByPost |
BIEを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/OffSystemDeliveryConfirmationExportApprovals/Unlock/{reportId} |
BIEのロックを解除します。 帳票ID(***reportId***)を指定して、BIEのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/OffSystemDeliveryConfirmationExportApprovals/Update/{reportId} |
BIEを更新します。 帳票ID(***reportId***)を指定して、BIEを更新します。 このメソッドでは、BIEの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/OffSystemDeliveryConfirmationExportApprovals/UpdateByPost |
BIEを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/OffSystemDeliveryConfirmationExportApprovals/UploadFile |
BIEにファイルを添付します。 指定されたBIEに、ファイルを添付します。 |
|
OffSystemDeliveryConfirmationPerBlPreRegistrations
CYD01_システム外CY搬入確認(B/L単位)(事前登録)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/OffSystemDeliveryConfirmationPerBlPreRegistrations/Create |
CYD01を作成します。 CYD01を作成するには、利用者がCYD01を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/OffSystemDeliveryConfirmationPerBlPreRegistrations/Delete/{reportId} |
CYD01を削除します。 帳票ID(***reportId***)を指定して、、CYD01を削除します。 CYD01を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/OffSystemDeliveryConfirmationPerBlPreRegistrations/DeleteFile/{fileId} |
CYD01の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、CYD01の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/OffSystemDeliveryConfirmationPerBlPreRegistrations/Get/{reportId} |
CYD01を取得します。 帳票ID(***reportId***)を指定して、CYD01取得します。 編集が行われていない場合は、ルートドキュメントから最新のCYD01を取得します。 編集中の場合は、先に保存した、CYD01を取得します。 |
|
| GET | /API/v2/NaccsReports/OffSystemDeliveryConfirmationPerBlPreRegistrations/GetFile/{fileId} |
CYD01に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、CYD01に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/OffSystemDeliveryConfirmationPerBlPreRegistrations/Lock/{reportId} |
編集するため、CYD01をロックします。 帳票ID(***reportId***)を指定して、CYD01をロックします。 CYD01を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、CYD01を編集する場合は、このメソッドを呼び出してロックします。 ロックされたCYD01は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、CYD01をルートドキュメントから参照できますが、編集中(ロック中)のCYD01は参照できません。 |
|
| POST | /API/v2/NaccsReports/OffSystemDeliveryConfirmationPerBlPreRegistrations/SendToNaccs |
CYD01をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したCYD01をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、CYD01が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/OffSystemDeliveryConfirmationPerBlPreRegistrations/SetCancel/{reportId} |
CYD01の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、CYD01の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/OffSystemDeliveryConfirmationPerBlPreRegistrations/Submit/{reportId} |
CYD01を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したCYD01を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、CYD01が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/OffSystemDeliveryConfirmationPerBlPreRegistrations/SubmitByPost |
CYD01を提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/OffSystemDeliveryConfirmationPerBlPreRegistrations/Unlock/{reportId} |
CYD01のロックを解除します。 帳票ID(***reportId***)を指定して、CYD01のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/OffSystemDeliveryConfirmationPerBlPreRegistrations/Update/{reportId} |
CYD01を更新します。 帳票ID(***reportId***)を指定して、CYD01を更新します。 このメソッドでは、CYD01の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/OffSystemDeliveryConfirmationPerBlPreRegistrations/UpdateByPost |
CYD01を更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/OffSystemDeliveryConfirmationPerBlPreRegistrations/UploadFile |
CYD01にファイルを添付します。 指定されたCYD01に、ファイルを添付します。 |
|
OperationTypes
操作種別
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Master/OperationTypes/DeleteAdmin/{operationTypeCode} |
操作種別を削除します。 操作種別コード(***operationTypeCode***)を指定して、操作種別を削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| GET | /API/v2/Master/OperationTypes/Get/{operationTypeCode} |
操作種別を取得します。 操作種別コード(***operationTypeCode***)を指定して、操作種別を取得します。 操作種別に関する詳細については、[操作種別について]()を参照ください。 |
|
| GET | /API/v2/Master/OperationTypes/GetList |
操作種別を全て取得します。 操作種別を全て取得します。 操作種別に関する詳細については、[操作種別について]()を参照ください。 |
|
| POST | /API/v2/Master/OperationTypes/RegisterAdmin |
操作種別を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/Master/OperationTypes/RegisterInternal |
操作種別を登録します。 内部呼び出し用。 (*For admin) |
|
OperatorCompanies
ターミナルを運営する事業者
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/Terminals/OperatorCompanies/Get/{operatorCompanyId} |
ターミナルを取得します。 ターミナルコード(***terminalCode***)を指定して、ターミナルを取得します。 ターミナルに関する詳細については、[ターミナルについて]()を参照ください。 |
|
| GET | /API/v2/Terminals/OperatorCompanies/GetList?operatorCompanyId=!{operatorCompanyId}&terminalCode=!{terminalCode}&companyId=!{companyId}&organizationId=!{organizationId} |
ターミナルを運営する事業者を取得します。 検索条件に該当するターミナルを運営する事業者をを全て取得します。 ターミナルに関する詳細については、[ターミナルについて]()を参照ください。 |
|
| PATCH | /API/v2/Terminals/OperatorCompanies/SetOperatorOrganization/{operatorCompanyId} |
ターミナルを運営する組織を設定します。 指定されたターミナルコード(***terminalCode***)に該当するターミナルについて、ターミナルを運営する組織を更新します。 ターミナルに運営する組織は、そのターミナルについて、ターミナルを運営する会社として設定されている会社配下の組織である必要があります。 ターミナルに関する詳細については、[ターミナルについて]()を参照ください。 |
|
Organizations
組織
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Organizations/Delete/{organizationId} |
組織を削除します。 組織ID(organizationId)を指定して、組織を削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 また、取引に参加している組織については、削除は行えません。 組織に関する詳細については、[組織について]()を参照ください。 |
|
| GET | /API/v2/Organizations/Get/{organizationId} |
組織を取得します。 組織ID(***organizationId***)を指定して、組織を取得します。 組織に関する詳細については、[組織について]()を参照ください。 |
|
| GET | /API/v2/Organizations/GetAccessibleReports/{organizationId} |
組織がアクセス可能な帳票を全て取得します。 組織がアクセス可能な帳票を全て取得します。 アクセス可能な帳票は、組織に割り当てられた事業種別を条件に、(***/API/v2/Master/ReportTypes/Permissions****)で、アクセス権限がR権限以上のものを取得します。 |
|
| GET | /API/v2/Organizations/GetMyList?organizationId=!{organizationId} |
会社配下の組織を全て取得します。 ログインしている利用者が所属する会社配下に登録されている全ての組織を取得します。 有効でない組織(isActive=false)を含めて、会社配下に登録されている全ての組織を取得します。 組織に関する詳細については、[組織について]()を参照ください。 |
|
| GET | /API/v2/Organizations/IsUnique/{organizationId} |
組織IDが一意であるかを判定します。 組織ID(***organizationId***)を指定して、組織IDが一意であるか(このIDで組織を追加できるのか)を判定します。 組織に関する詳細については、[組織について]()を参照ください。 |
|
| POST | /API/v2/Organizations/Register |
所属する会社に組織を登録します。 管理者が所属する会社に、組織を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 組織に関する詳細については、[組織について]()を参照ください。 |
|
| GET | /API/v2/Organizations/Search?corporateNo=!{corporateNo}&companyName=!{companyName}&companyNameEn=!{companyNameEn}&organizationName=!{organizationName}&organizationNameEn=!{organizationNameEn}&businessTypeCodeList=!{businessTypeCodeList}&phoneNumber=!{phoneNumber}&faxNumber=!{faxNumber}&emailAddress=!{emailAddress} |
検索条件に該当する組織を取得します。 検索条件を指定して、条件に該当する組織を全て取得します。非公開の組織(***permitSearchByName=false***)や無効な組織(***isActive=false***)は検索対象外となります。 組織に関する詳細については、[組織について]()を参照ください。 |
|
| PATCH | /API/v2/Organizations/SetActive/{organizationId} |
組織が有効であるか(isActive)を更新します。 組織ID(***organizationId***)を指定して、組織が有効であるか(isActive)を更新します。 isActiveをfalseにすると、その組織は、 - 参加していた取引は参照できますが、取引内での操作は行えません。 - 新しい取引を作成したり、取引のパートナーとして参加することは出来ません。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 組織に関する詳細については、[組織について]()を参照ください。 |
|
| PATCH | /API/v2/Organizations/Update/{organizationId} |
組織を更新します。 組織ID(***organizationId***)を指定して、組織を更新します。 更新する組織は、ログインしている利用者が所属する会社配下になければなりません。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 組織に関する詳細については、[組織について]()を参照ください。 |
|
OtherLawCodes
他法令コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/OtherLawCodes/DeleteAdmin/{otherLawCode} |
他法令コードを削除します。 他法令コード(***otherLawCode***)を指定して、他法令コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/OtherLawCodes/Get/{otherLawCode} |
他法令種別を取得します。 他法令コード(***otherLawCode***)を指定して、他法令種別を取得します。 他法令コードに関する詳細については、[他法令コードについて]()を参照ください。 |
|
| GET | /API/v2/General/OtherLawCodes/GetList |
他法令種別を全て取得します。 他法令コードに関する詳細については、[他法令コードについて]()を参照ください。 |
|
| POST | /API/v2/General/OtherLawCodes/RegisterAdmin |
他法令種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/OtherLawCodes/RegisterInternal |
他法令種別を登録します。 内部呼び出し用。 (*For admin) |
|
PackageTypeCodes
包装種類コード(UN/ECE勧告第21号・英字)
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/PackageTypeCodes/DeleteAdmin/{packageTypeCode} |
包装種類コードを削除します。 包装種類コード(***packageTypeCode***)を指定して、包装種類コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/PackageTypeCodes/Get/{packageTypeCode} |
包装種類を取得します。 包装種類コード(***packageTypeCode***)を指定して、包装種類を取得します。 包装種類コードに関する詳細については、[包装コードについて]()を参照ください。 |
|
| GET | /API/v2/General/PackageTypeCodes/GetList |
包装種類を全て取得します。 包装種類コードに関する詳細については、[包装種類コードについて]()を参照ください。 |
|
| POST | /API/v2/General/PackageTypeCodes/RegisterAdmin |
包装種類を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/PackageTypeCodes/RegisterInternal |
包装種類を登録します。 内部呼び出し用。 (*For admin) |
|
PackingLists
パッキングリスト(P/L)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/PackingLists/Create |
パッキングリスト(P/L)を作成します。 パッキングリスト(P/L)を作成するには、利用者が商業送り状(I/V)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/PackingLists/Delete/{reportId} |
パッキングリスト(P/L)を削除します。 帳票ID(***reportId***)を指定して、パッキングリスト(P/L)を削除します。 パッキングリスト(P/L)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したパッキングリスト(P/L)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/PackingLists/DeleteFile/{fileId} |
パッキングリスト(P/L)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、商業送り状(I/V)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/PackingLists/Get/{reportId}?historyId=!{historyId} |
パッキングリスト(P/L)を取得します。 帳票ID(***reportId***)を指定して、パッキングリスト(P/L)を取得します。 編集が行われていない場合は、ルートドキュメントから最新のブッキング依頼書を取得します。 編集中の場合は、先に保存した、パッキングリスト(P/L)を取得します。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)について]()を参照ください。 |
|
| GET | /API/v2/Reports/PackingLists/GetDiff/{reportId}?historyId=!{historyId} |
保存されているパッキングリスト(P/L)とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当するパッキングリスト(P/L)と、ルートドキュメントの差分を取得します。 比較元を保存されているパッキングリスト(P/L)、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/PackingLists/GetFile/{fileId} |
パッキングリスト(P/L)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、商業送り状(I/V)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/PackingLists/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
パッキングリスト(P/L)を全て取得します。 検索条件に該当するパッキングリスト(P/L)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のパッキングリスト(P/L)を取得します。 編集中の場合は、先に保存した、パッキングリスト(P/L)を取得します。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/PackingLists/Lock/{reportId} |
編集するため、パッキングリスト(P/L)をロックします 帳票ID(***reportId***)を指定して、パッキングリスト(P/L)をロックします。 パッキングリスト(P/L)を作成(***Create***)した時点では、パッキングリスト(P/L)をロックが掛かりますが、取得(***Get***)したあとで、パッキングリスト(P/L)を編集する場合は、このメソッドを呼び出して、パッキングリスト(P/L)をロックします。 ロックされたパッキングリスト(P/L)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、パッキングリスト(P/L)をルートドキュメントから参照できますが、編集中(ロック中)のパッキングリスト(P/L)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/PackingLists/SetCancel/{reportId} |
パッキングリスト(P/L)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、パッキングリスト(P/L)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/PackingLists/Submit/{reportId} |
パッキングリスト(P/L)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したパッキングリスト(P/L)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、パッキングリスト(P/L)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、パッキングリスト(P/L)もロックされた状態のままなので、ご注意ください。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)について]()を参照ください。 |
|
| POST | /API/v2/Reports/PackingLists/SubmitByPost |
パッキングリスト(P/L)を提出します。 動作は、パッキングリスト(P/L)(***/API/v2/Reports/PackingLists/Submit***)と同様です。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)]()を参照ください。 |
|
| PATCH | /API/v2/Reports/PackingLists/Unlock/{reportId} |
パッキングリスト(P/L)のロックを解除します 帳票ID(***reportId***)を指定して、パッキングリスト(P/L)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/PackingLists/Update/{reportId} |
パッキングリスト(P/L)を更新します。 帳票ID(***reportId***)を指定して、パッキングリスト(P/L)を更新します。 このメソッドでは、パッキングリスト(P/L)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)について]()を参照ください。 |
|
| POST | /API/v2/Reports/PackingLists/UpdateByPost |
パッキングリスト(P/L)を更新します。 動作は、パッキングリスト(P/L)(***/API/v2/Reports/PackingLists/Update***)と同様です。 パッキングリスト(P/L)に関する詳細については、[パッキングリスト(P/L)]()を参照ください。 |
|
| POST | /API/v2/Reports/PackingLists/UploadFile |
パッキングリスト(P/L)にファイルを添付します。 指定されたパッキングリスト(P/L)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
ParseEdifacts
EDIFACT解析
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Reports/ParseEdifacts/Delete/{parseEdifactId} |
EDIFACT解析を削除します。 EDIFACT解析ID(***parseEdifactId***)を指定して、EDIFACT解析を削除します。 このAPIが削除するのは、EDFIACT解析を行った組織に所属している利用者、つまり、EDFIACT設定変換ID(***parseEdifactSettingId***)が示す組織に所属している利用者が行った解析についてとなります。 EDIFACT解析に関する詳細については、[EDIFACT解析について]()を参照ください。 |
|
| GET | /API/v2/Reports/ParseEdifacts/Get/{parseEdifactId} |
EDIFACT解析を取得します。 EDIFACT解析ID(***parseEdifactId***)を指定して、EDIFACT解析を全て取得します。 このAPIは返却するのは、EDFIACT解析を行った組織に所属している利用者、つまり、EDFIACT設定変換ID(***parseEdifactSettingId***)が示す組織に所属している利用者が行った解析についてとなります。 EDIFACT解析に関する詳細については、[EDIFACT解析について]()を参照ください。 |
|
| GET | /API/v2/Reports/ParseEdifacts/GetEdifactMessage/{parseEdifactId} |
EDIFACT解析を行うメッセージを取得します。 EDIFACT解析ID(***parseEdifactId***)を指定して、EDIFACT解析を行うメッセージを取得します。 このAPIは返却するのは、EDFIACT解析を行った組織に所属している利用者、つまり、EDFIACT設定変換ID(***parseEdifactSettingId***)が示す組織に所属している利用者が行った解析についてとなります。 EDIFACT解析に関する詳細については、[EDIFACT解析について]()を参照ください。 |
|
| GET | /API/v2/Reports/ParseEdifacts/GetList?organizationId=!{organizationId}&parseEdifactSettingId=!{parseEdifactSettingId}&fileName=!{fileName}&parseEdifactStatus=!{parseEdifactStatus}&requestedBy=!{requestedBy}&updatedAtFrom=!{updatedAtFrom}&updatedAtTo=!{updatedAtTo} |
EDIFACT解析を全て取得します。 検索条件に該当するEDIFACT解析を全て取得します。 このAPIは返却するのは、EDFIACT解析を行った組織に所属している利用者、つまり、EDFIACT設定変換ID(***parseEdifactSettingId***)が示す組織に所属している利用者が行った解析についてとなります。 EDIFACT解析に関する詳細については、[EDIFACT解析について]()を参照ください。 |
|
| GET | /API/v2/Reports/ParseEdifacts/GetParsedMessage/{parseEdifactId} |
解析されたEDIFACTメッセージを取得します。 EDIFACT解析ID(***parseEdifactId***)を指定して、解析されたEDIFACTメッセージを取得します。 このAPIは返却するのは、EDFIACT解析を行った組織に所属している利用者、つまり、EDFIACT設定変換ID(***parseEdifactSettingId***)が示す組織に所属している利用者が行った解析についてとなります。 EDIFACT解析に関する詳細については、[EDIFACT解析について]()を参照ください。 |
|
| POST | /API/v2/Reports/ParseEdifacts/Request |
EDIFACTの解析を要求(登録)します。 指定されたEDFIACT設定変換ID(***parseEdifactSettingId***)を基に、EDIFACTメッセージを解析し、サイバーポートの帳票項目に変換します。 このAPIを呼び出せるのは、EDFIACT設定変換ID(***parseEdifactSettingId***)が示す組織に所属している利用者だけとなります。 EDIFACT解析に関する詳細については、[EDIFACT解析について]()を参照ください。 |
|
| GET | /API/v2/Reports/ParseEdifacts/Search?name=!{name}&value=!{value} |
検索ポリシー設定に従い、EDIFACT解析結果を検索します。 検索ポリシー設定(***/API/v2/Organizations/ParseEdifactSettings/SearchPolicies***)のキーワード条件(name / value)を用いて、EDIFACT変換後の帳票データを検索します。 検索にあたっては、呼び出し元の利用者が所属する組織に対して設定された検索ポリシーを適用し、 検索を許可されたキーワードのみを条件として使用します。 また、検索結果は、検索ポリシーに定義された固定条件(value が * 以外の条件)のいずれかに一致するデータに限定されます。 EDIFACT解析に関する詳細については、[EDIFACT解析について]()を参照ください。 |
|
ParseEdifactSettings
EDIFACT変換設定
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/Organizations/ParseEdifactSettings/Get/{parseEdifactSettingId} |
EDIFACT解析設定を取得します。 EDIFACT解析設定ID(***parseEdifactSettingId***)を指定して、EDIFACT解析設定を取得します。 EDIFACT解析設定に関する詳細については、[EDIFACT解析設定について]()を参照ください。 |
|
| GET | /API/v2/Organizations/ParseEdifactSettings/GetList?parseEdifactSettingId=!{parseEdifactSettingId}&organizationId=!{organizationId}&messageCode=!{messageCode}&directoryVersion=!{directoryVersion} |
検索条件に該当するEDIFACT解析設定を全て取得します。 検索条件を指定して、EDIFACT解析設定を全て取得します。 EDIFACT解析設定に関する詳細については、[EDIFACT解析設定について]()を参照ください。 |
|
ParsePdfFiles
帳票AI-OCR解析
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Reports/ParsePdfFiles/Delete/{parsePdfId} |
帳票AI-OCR解析を削除します。 帳票AI-OCR解析ID(***parsePdfId***)を指定して、帳票AI-OCR解析を削除します。 帳票のAI-OCR解析に関する詳細については、[帳票のAI-OCR解析について]()を参照ください。 |
|
| GET | /API/v2/Reports/ParsePdfFiles/Get/{parsePdfId} |
帳票のAI-OCR解析についてのメタ情報を取得します。 帳票AI-OCR解析ID(***parsePdfId***)を指定して、帳票のAI-OCR解析についてのメタ情報を全て取得します。 帳票のAI-OCR解析に関する詳細については、[帳票のAI-OCR解析について]()を参照ください。 |
|
| GET | /API/v2/Reports/ParsePdfFiles/GetDiff/{reportId}/{parsePdfId} |
現在保存されている帳票と解析結果の差分を取得します。 帳票ID(***reportId***)と帳票AI-OCR解析ID(***parsePdfId***)を指定して、現在保存されている帳票と解析結果の差分を取得します。 比較元を現在保存されている帳票、比較先を解析結果として、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票のAI-OCR解析に関する詳細については、[帳票のAI-OCR解析について]()を参照ください。 |
|
| GET | /API/v2/Reports/ParsePdfFiles/GetFile/{parsePdfId} |
AI-OCR解析を行うPDFファイルを取得します。 帳票AI-OCR解析ID(***parsePdfId***)を指定して、AI-OCR解析を行うPDFファイルを取得します。 帳票のAI-OCR解析に関する詳細については、[帳票のAI-OCR解析について]()を参照ください。 |
|
| GET | /API/v2/Reports/ParsePdfFiles/GetFileAdmin/{parsePdfId} |
AI-OCR解析を行うPDFファイルを取得します。 帳票AI-OCR解析ID(***parsePdfId***)を指定して、AI-OCR解析を行うPDFファイルを取得します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/Reports/ParsePdfFiles/GetList?reportId=!{reportId}&organizationId=!{organizationId}&status=!{status}&pdfFileName=!{pdfFileName} |
帳票のAI-OCR解析についてのメタ情報を全て取得します。 検索条件に帳票のAI-OCR解析についてのメタ情報を全て取得します。 帳票のAI-OCR解析に関する詳細については、[帳票のAI-OCR解析について]()を参照ください。 |
|
| GET | /API/v2/Reports/ParsePdfFiles/GetResult/{parsePdfId} |
AI-OCR解析の結果を帳票コンテンツとしてを取得します。 帳票AI-OCR解析ID(***parsePdfId***)を指定して、AI-OCR解析の結果を帳票コンテンツ(JSON)として取得します。 帳票のAI-OCR解析に関する詳細については、[帳票のAI-OCR解析について]()を参照ください。 |
|
| POST | /API/v2/Reports/ParsePdfFiles/Request |
PDFファイルをAI-OCR解析します。 PDFファイルを指定して、AI-OCR解析を依頼します。 帳票のAI-OCR解析に関する詳細については、[帳票のAI-OCR解析について]()を参照ください。 |
|
Partners
取引のパートナー
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Trades/Partners/Delete/{partnerId} |
パートナーIDを指定して、取引のパートナーを削除します。 パートナーID(***partnerId***)を指定して、取引のパートナーを削除します。 このメソッドを呼び出す利用者は、対象となる取引に利用者が所属する組織が参加しており、さらに、取引から削除するパートナーを招待した組織に所属している必要があります。 取引からパートナーを削除すると、そのパートナーが作成した帳票は全て削除されます。 取引のパートナーに関する詳細については、[取引のパートナーについて]()を参照ください。 |
|
| GET | /API/v2/Trades/Partners/Get/{partnerId} |
取引のパートナーを取得します。 パートナーID(***partnerId***)を指定して、取引のパートナーを取得します。 対象となる取引に、利用者が所属する組織が参加している必要があります。 取引のパートナーに関する詳細については、[取引のパートナーについて]()を参照ください。 |
|
| GET | /API/v2/Trades/Partners/GetList/{tradeNo}?partnerId=!{partnerId}&organizationId=!{organizationId}&parentPartnerId=!{parentPartnerId}&parentOrganizationId=!{parentOrganizationId}&businessTypeCodeList=!{businessTypeCodeList}&myPartnerOnly=!{myPartnerOnly}&isActive=!{isActive} |
取引管理番号を指定して、取引のパートナーを全て取得します。 取引管理番号(***tradeNo***)を指定して、その取引に参加している取引のパートナーを全て取得します。 対象となる取引に、利用者が所属する組織が参加している必要があります。 |
|
| POST | /API/v2/Trades/Partners/Register |
取引にパートナーを追加します。 取引に他の事業者をパートナーとして追加します。 取引が作成された時点では、取引を作成した組織に所属する利用者しかアクセス出来ませんが、このメソッドで、他の事業者を取引のパートナーとして追加します。 取引のパートナーを追加すると、取引を他の事業者と共有することになります。 取引のパートナーに関する詳細については、[取引のパートナーについて]()を参照ください。 |
|
Payments
会社の納付情報
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Companies/Payments/DeleteAdmin/{paymentId} |
会社の納付情報を削除します。 納付情報ID(***paymentId***)を指定して、会社の納付情報を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/Companies/Payments/Get/{paymentId} |
会社の納付情報を取得します。 納付情報ID(***paymentId***)を指定して、ログインしている利用者が所属する会社の納付情報を取得します。 会社の納付情報に関する詳細については、[会社の納付情報について]()を参照ください。 |
|
| GET | /API/v2/Companies/Payments/GetList?periodCode=!{periodCode} |
会社の納付情報を全て取得します。 ログインしている利用者が所属する会社の納付情報を全て取得します。 会社の納付情報に関する詳細については、[会社の納付情報について]()を参照ください。 |
|
| PATCH | /API/v2/Companies/Payments/UpdateInternal/{paymentId} |
会社の納付情報を更新します。 納付情報ID(***paymentId***)を指定して、納付情報を更新します。 内部呼び出し用。 |
|
PermissionInTrades
取引内での帳票アクセス権限
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Trades/Partners/PermissionInTrades/Delete/{permissionInTradeId} |
取引内での帳票アクセス権限を削除します。 取引内での帳票アクセス権限ID(***permissionInTradeId***)を指定して、取引内での帳票アクセス権限を削除します。 取引内で変更した帳票アクセス権限がクリアされ、帳票アクセス権限(***/API/v2/Master/Reports/Permissions***)での帳票のRead/Write権限が適用されます。 取引内での帳票アクセス権限に関する詳細については、[取引内での帳票アクセス権限について]()を参照ください。 |
|
| GET | /API/v2/Trades/Partners/PermissionInTrades/Get/{permissionInTradeId} |
取引内での帳票アクセス権限を取得します。 取引内での帳票アクセス権限ID(***permissionInTradeId***)を指定して、取引内での帳票アクセス権限を取得します。 取引内での帳票アクセス権限に関する詳細については、[取引内での帳票アクセス権限について]()を参照ください。 |
|
| GET | /API/v2/Trades/Partners/PermissionInTrades/GetList/{tradeNo}?partnerId=!{partnerId}&organizationId=!{organizationId}&permissionInTradeId=!{permissionInTradeId}&reportCode=!{reportCode}&reportId=!{reportId}&permissionInTrade=!{permissionInTrade} |
取引内の帳票アクセス権限を取得します。 検索条件を指定して、取引のパートナーに与えられている取引内の帳票アクセス権限を全て取得します。 取引内での帳票アクセス権限に関する詳細については、[取引内での帳票アクセス権限について]()を参照ください。 |
|
| POST | /API/v2/Trades/Partners/PermissionInTrades/Register |
取引内での帳票アクセス制限を登録します。 取引のパートナーに対して、取引内での帳票アクセス制限を登録します。 取引のパートナーを追加(***/API/v2/Trades/Partners/Register***)した時点では、追加した組織の事業種別に従い、帳票アクセス権限(***/API/v2/Master/Reports/PermissionInTrades***)での帳票のRead/Write権限が適用されていますが、これを変更する場合に、このメソッドを使用します。 ただし、帳票アクセス権限(***/API/v2/Master/Reports/Permissions***)での設定以下にしか権限を変更することは出来ません。 例えば、帳票アクセス権限(***/API/v2/Master/Reports/Permissions***)での設定で、ある帳票にRead権限までが設定されている場合、これをWrite権限に変更することは出来ません。 この変更は、変更を行った取引に対してのみ有効です。また、取引を複製した場合も(***/API/v2/Trades/Duplicate***)、この設定は引き継がれます。 取引内での帳票アクセス権限に関する詳細については、[取引内での帳票アクセス権限について]()を参照ください。 |
|
| PATCH | /API/v2/Trades/Partners/PermissionInTrades/Update/{permissionInTradeId} |
取引内での帳票アクセス権限を更新します。 取引内での帳票アクセス権限ID(***permissionInTradeId***)を指定して、取引内での帳票アクセス権限を更新します。 ただし、帳票アクセス権限(***/API/v2/Master/Reports/Permissions***)での設定以下にしか権限を変更することは出来ません。 例えば、帳票アクセス権限(***/API/v2/Master/Reports/Permissions***)での設定で、ある帳票にRead権限までが設定されている場合、これをWrite権限に変更することは出来ません。 取引内での帳票アクセス権限に関する詳細については、[取引内での帳票アクセス権限について]()を参照ください。 |
|
Permissions
帳票アクセス権限
PortLocations
港(国連LOCODE拡張)
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/PortLocations/Get/{portCode} |
港(国連LOCODE拡張)を取得します。 港コード(***portCode***)を指定して、港(国連LOCODE拡張)を取得します。 港(国連LOCODE拡張)に関する詳細については、[ターミナルについて]()を参照ください。 |
|
| GET | /API/v2/PortLocations/GetList?portName=!{portName}&portNameEn=!{portNameEn}&portNameCn=!{portNameCn}&portNameAb=!{portNameAb} |
港(国連LOCODE拡張)を全て取得します。 検索条件に該当する港(国連LOCODE拡張)を全て取得します。 港(国連LOCODE拡張)に関する詳細については、[ターミナルについて]()を参照ください。 |
|
PreDepartureReportInquiries
IAR_出港前報告照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/PreDepartureReportInquiries/Create |
IARを作成します。 IARを作成するには、利用者がIARを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/PreDepartureReportInquiries/Delete/{reportId} |
IARを削除します。 帳票ID(***reportId***)を指定して、、IARを削除します。 IARを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/PreDepartureReportInquiries/DeleteFile/{fileId} |
IARの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IARの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/PreDepartureReportInquiries/Get/{reportId} |
IARを取得します。 帳票ID(***reportId***)を指定して、IAR取得します。 編集が行われていない場合は、ルートドキュメントから最新のIARを取得します。 編集中の場合は、先に保存した、IARを取得します。 |
|
| GET | /API/v2/NaccsReports/PreDepartureReportInquiries/GetFile/{fileId} |
IARに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IARに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/PreDepartureReportInquiries/Lock/{reportId} |
編集するため、IARをロックします。 帳票ID(***reportId***)を指定して、IARをロックします。 IARを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IARを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIARは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IARをルートドキュメントから参照できますが、編集中(ロック中)のIARは参照できません。 |
|
| POST | /API/v2/NaccsReports/PreDepartureReportInquiries/SendToNaccs |
IARをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIARをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IARが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/PreDepartureReportInquiries/SetCancel/{reportId} |
IARの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IARの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/PreDepartureReportInquiries/Submit/{reportId} |
IARを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIARを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IARが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/PreDepartureReportInquiries/Unlock/{reportId} |
IARのロックを解除します。 帳票ID(***reportId***)を指定して、IARのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/PreDepartureReportInquiries/Update/{reportId} |
IARを更新します。 帳票ID(***reportId***)を指定して、IARを更新します。 このメソッドでは、IARの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/PreDepartureReportInquiries/UploadFile |
IARにファイルを添付します。 指定されたIARに、ファイルを添付します。 |
|
PreDepartureReportListInquiries
IML_出港前報告一覧照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/PreDepartureReportListInquiries/Create |
IMLを作成します。 IMLを作成するには、利用者がIMLを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/PreDepartureReportListInquiries/Delete/{reportId} |
IMLを削除します。 帳票ID(***reportId***)を指定して、、IMLを削除します。 IMLを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/PreDepartureReportListInquiries/DeleteFile/{fileId} |
IMLの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IMLの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/PreDepartureReportListInquiries/Get/{reportId} |
IMLを取得します。 帳票ID(***reportId***)を指定して、IML取得します。 編集が行われていない場合は、ルートドキュメントから最新のIMLを取得します。 編集中の場合は、先に保存した、IMLを取得します。 |
|
| GET | /API/v2/NaccsReports/PreDepartureReportListInquiries/GetFile/{fileId} |
IMLに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IMLに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/PreDepartureReportListInquiries/Lock/{reportId} |
編集するため、IMLをロックします。 帳票ID(***reportId***)を指定して、IMLをロックします。 IMLを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IMLを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIMLは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IMLをルートドキュメントから参照できますが、編集中(ロック中)のIMLは参照できません。 |
|
| POST | /API/v2/NaccsReports/PreDepartureReportListInquiries/SendToNaccs |
IMLをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIMLをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IMLが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/PreDepartureReportListInquiries/SetCancel/{reportId} |
IMLの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IMLの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/PreDepartureReportListInquiries/Submit/{reportId} |
IMLを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIMLを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IMLが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/PreDepartureReportListInquiries/Unlock/{reportId} |
IMLのロックを解除します。 帳票ID(***reportId***)を指定して、IMLのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/PreDepartureReportListInquiries/Update/{reportId} |
IMLを更新します。 帳票ID(***reportId***)を指定して、IMLを更新します。 このメソッドでは、IMLの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/PreDepartureReportListInquiries/UploadFile |
IMLにファイルを添付します。 指定されたIMLに、ファイルを添付します。 |
|
Prefectures
都道府県
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/Prefectures/DeleteAdmin/{prefectureCode} |
コンテナサイズ(高さ)を削除します。 コンテナサイズ(高さ)(***heightCode***)を指定して、コンテナサイズ(長さ)を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/Prefectures/Get/{prefectureCode} |
都道府県を取得します。 都道府県コード(***prefectureCode***)を指定して、都道府県を取得します。 |
|
| GET | /API/v2/General/Prefectures/GetList?prefectureCode=!{prefectureCode}&prefectureName=!{prefectureName}&prefectureNameEn=!{prefectureNameEn} |
都道府県を取得します。 検索条件に該当する都道府県を全て取得します。 |
|
| POST | /API/v2/General/Prefectures/RegisterAdmin |
都道府県を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/General/Prefectures/RegisterInternal |
都道府県を登録します。 内部呼び出し用。 (*For admin) |
|
Processes
取引内のプロセス
| API | Description | ||
|---|---|---|---|
| PATCH | /API/v2/Trades/Processes/AddReports/{processId} |
取引のプロセスに帳票を追加します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
| DELETE | /API/v2/Trades/Processes/Delete/{processId} |
取引のプロセスを削除します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
| GET | /API/v2/Trades/Processes/Get/{processId} |
取引内のプロセスを取得します。 プロセスID(***processId***)を指定して、取引内のプロセスを取得します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
| GET | /API/v2/Trades/Processes/GetCustomizedList/{tradeNo}?processGroupCode=!{processGroupCode}&organizationId=!{organizationId} |
取引内の組織が作成したカスタマイズプロセスを取得します。 取引管理番号(***tradeNo***)で指定された取引に参加している組織が定義したカスタマイズプロセスを取得します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
| GET | /API/v2/Trades/Processes/GetList/{tradeNo}?processId=!{processId}&processGroupCode=!{processGroupCode}&processCode=!{processCode}&customizedProcessCode=!{customizedProcessCode}&organizationIdAsPlanner=!{organizationIdAsPlanner}&organizationIdAsSubmitter=!{organizationIdAsSubmitter}&organizationIdAsAccepter=!{organizationIdAsAccepter}&processStatus=!{processStatus}&startAtFrom=!{startAtFrom}&startAtTo=!{startAtTo}&dueAtFrom=!{dueAtFrom}&dueAtTo=!{dueAtTo} |
取引内のプロセスを全て取得します。 取引管理番号(***tradeNo***)を指定して、取引内のプロセスを全て取得します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
| GET | /API/v2/Trades/Processes/GetPartners/{processId}?reportCodeList=!{reportCodeList}&processType=!{processType}&canStart=!{canStart} |
取引内のプロセスに関与可能なパートナーを全て取得します。 プロセスID(***processId***)を指定して、を指定して、に関与可能なパートナーを全て取得します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
| POST | /API/v2/Trades/Processes/Plan |
取引にプロセスを登録(計画)します。 取引に実施予定のプロセスを登録(計画)します。 登録できるプロセスは、サイバーポート標準プロセス(***/API/v2/Master/StandardProcesses***)か、取引に参加しているパートナーがカスタマイズしたプロセス(***/API/v2/Organizations/CustomizedProcesses***)となります 取引にプロセスを登録(計画)した時点では、そのプロセスで取扱う帳票は、作成されません。 プロセスを開始する際(***/API/v2/Trades/Processes/Start***)に、そのプロセスで取扱う帳票とタスクを作成します。 ただし、作成済みの帳票を使用して、プロセスを開始することも可能です。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
| PATCH | /API/v2/Trades/Processes/SetStatus/{processId} |
取引のプロセスのステータスを設定します。 取引のプロセスのステータスを設定します。 ステータスを更新すると、紐づくタスクのステータスも連動して更新されます。例えば、プロセスのステータスをDoneにすると、紐づくタスクのステータスもDoneになります。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
| POST | /API/v2/Trades/Processes/Start |
取引のプロセスを開始します。 取引に登録されている実施予定のプロセスを開始します。 プロセスを開始すると、そのプロセスで取扱う帳票が作成され(作成済みでない場合)、各帳票にタスクが作成されます。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
| PATCH | /API/v2/Trades/Processes/Update/{processId} |
取引のプロセスを更新します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
| PATCH | /API/v2/Trades/Processes/UpdateDisplayOrder/{processId} |
取引のプロセスの並び順を設定します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。 |
|
ProcessGroups
プロセスグループ
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Master/ProcessGroups/DeleteAdmin/{processGroupCode} |
プロセスグループコードを指定して、プロセスグループを削除します。 プロセスグループコード(***processGroupCode***)を指定して、プロセスグループを削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| GET | /API/v2/Master/ProcessGroups/GetList/{tradeType}?processGroupCode=!{processGroupCode} |
取引タイプを指定して、プロセスグループを取得します 取引タイプ(***tradeType***)を指定して、プロセスグループを取得します。 ただし、このメソッドのレスポンスには、グループ配下のプロセス(***/API/v2/Master/StandardProcesses***)は含まれません。 グループ配下のプロセスも含めて、取得する場合は、(***/API/v2/Master/StandardProcesses/GetList***)を使用します。 プロセスに関する詳細については、[プロセスについて]()を参照ください。 |
|
| POST | /API/v2/Master/ProcessGroups/RegisterAdmin |
プロセスグループを登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/Master/ProcessGroups/RegisterInternal |
プロセスグループを登録します。 内部呼び出し用。 (*For admin) |
|
Products
会社で使用する商品情報(HSコード)
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Companies/Products/Delete/{productId} |
会社で使用する商品(HSコード)を削除します。 商品ID(***productId***)を指定して、会社に登録されている会社で使用する商品(HSコード)を削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 会社で使用する商品(HSコード)に関する詳細については、[会社で使用する商品(HSコード)について]()を参照ください。 |
|
| GET | /API/v2/Companies/Products/Get/{productId} |
会社で使用する商品(HSコード)を取得します。 商品ID(***productId***)を指定して、会社で使用する商品(HSコード)を取得します。 会社で使用する商品(HSコード)に関する詳細については、[会社で使用する商品(HSコード)について]()を参照ください。 |
|
| GET | /API/v2/Companies/Products/GetList?tradeType=!{tradeType}&number=!{number}&hsCode=!{hsCode}&name=!{name} |
会社で使用する商品(HSコード)を全て取得します。 ログインしている利用者が会社で使用する商品(HSコード)を全て取得します。 会社で使用する商品(HSコード)に関する詳細については、[会社で使用する商品(HSコード)について]()を参照ください。 |
|
| POST | /API/v2/Companies/Products/RegisterList |
会社で使用する商品(HSコード)を登録します。 会社で使用する商品(HSコード)を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 会社で使用する商品(HSコード)に関する詳細については、[会社で使用する商品(HSコード)について]()を参照ください。 |
|
ProformaInvoices
仮送り状
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/ProformaInvoices/Create |
仮送り状を作成します。 仮送り状を作成するには、利用者が仮送り状を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 仮送り状に関する詳細については、[仮送り状について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/ProformaInvoices/Delete/{reportId} |
仮送り状を削除します。 帳票ID(***reportId***)を指定して、仮送り状を削除します。 仮送り状を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した仮送り状のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 仮送り状に関する詳細については、[仮送り状について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/ProformaInvoices/DeleteFile/{fileId} |
仮送り状の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、仮送り状の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/ProformaInvoices/Get/{reportId}?historyId=!{historyId} |
仮送り状を取得します。 帳票ID(***reportId***)を指定して、仮送り状を取得します。 編集が行われていない場合は、ルートドキュメントから最新の仮送り状を取得します。 編集中の場合は、先に保存した、仮送り状を取得します。 仮送り状に関する詳細については、[仮送り状について]()を参照ください。 |
|
| GET | /API/v2/Reports/ProformaInvoices/GetDiff/{reportId}?historyId=!{historyId} |
保存されている仮送り状とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する仮送り状と、ルートドキュメントの差分を取得します。 比較元を保存されている仮送り状、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/ProformaInvoices/GetFile/{fileId} |
仮送り状に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、仮送り状に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/ProformaInvoices/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
仮送り状を全て取得します。 検索条件に該当する仮送り状を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の仮送り状を取得します。 編集中の場合は、先に保存した、仮送り状を取得します。 仮送り状に関する詳細については、[仮送り状について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ProformaInvoices/Lock/{reportId} |
編集するため、仮送り状をロックします 帳票ID(***reportId***)を指定して、仮送り状をロックします。 仮送り状を作成(***Create***)した時点では、仮送り状をロックが掛かりますが、取得(***Get***)したあとで、仮送り状を編集する場合は、このメソッドを呼び出して、仮送り状をロックします。 ロックされた仮送り状は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、仮送り状をルートドキュメントから参照できますが、編集中(ロック中)の仮送り状は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 仮送り状に関する詳細については、[仮送り状について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ProformaInvoices/SetCancel/{reportId} |
仮送り状の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、仮送り状の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 仮送り状に関する詳細については、[仮送り状について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ProformaInvoices/Submit/{reportId} |
仮送り状を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した仮送り状を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、仮送り状が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、仮送り状もロックされた状態のままなので、ご注意ください。 仮送り状に関する詳細については、[仮送り状について]()を参照ください。 |
|
| POST | /API/v2/Reports/ProformaInvoices/SubmitByPost |
仮送り状を提出します。 動作は、仮送り状(***/API/v2/Reports/ProformaInvoices/Submit***)と同様です。 仮送り状に関する詳細については、[仮送り状]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ProformaInvoices/Unlock/{reportId} |
仮送り状のロックを解除します 帳票ID(***reportId***)を指定して、仮送り状のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 仮送り状に関する詳細については、[仮送り状について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ProformaInvoices/Update/{reportId} |
仮送り状を更新します。 帳票ID(***reportId***)を指定して、仮送り状を更新します。 このメソッドでは、仮送り状の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 仮送り状に関する詳細については、[仮送り状について]()を参照ください。 |
|
| POST | /API/v2/Reports/ProformaInvoices/UpdateByPost |
仮送り状を更新します。 動作は、仮送り状(***/API/v2/Reports/ProformaInvoices/Update***)と同様です。 仮送り状に関する詳細については、[仮送り状]()を参照ください。 |
|
| POST | /API/v2/Reports/ProformaInvoices/UploadFile |
仮送り状にファイルを添付します。 指定された仮送り状に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
ReasonCodeForChanges
変更理由コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/ReasonCodeForChanges/DeleteAdmin/{changeReasonCode} |
変更理由コードを削除します。 変更理由コード(***changeReasonCode***)を指定して、内変更理由コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/ReasonCodeForChanges/Get/{changeReasonCode} |
変更理由を取得します。 変更理由コード(***changeReasonCode***)を指定して、変更理由を取得します。 変更理由コードに関する詳細については、[変更理由コードについて]()を参照ください。 |
|
| GET | /API/v2/General/ReasonCodeForChanges/GetList |
変更理由を全て取得します。 変更理由コードに関する詳細については、[変更理由コードについて]()を参照ください。 |
|
| POST | /API/v2/General/ReasonCodeForChanges/RegisterAdmin |
変更理由を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/ReasonCodeForChanges/RegisterInternal |
変更理由を登録します。 内部呼び出し用。 (*For admin) |
|
Receipts
会社の領収済み情報
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/Companies/Receipts/Get/{paymentId} |
会社の納付情報を取得します。 納付情報ID(***paymentId***)を指定して、会社の領収済み情報を取得します。 会社の領収済み情報に関する詳細については、[会社の領収済み情報情報について]()を参照ください。 |
|
ReceivingTerms
荷受形態
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/ReceivingTerms/DeleteAdmin/{receivingTermCode} |
荷受形態を削除します。 荷受形態コード(***receivingTermCode***)を指定して、荷受形態を削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/ReceivingTerms/Get/{receivingTermCode} |
荷受形態を取得します。 荷受形態コード(***receivingTermCode***)を指定して、荷受形態を取得します。 |
|
| GET | /API/v2/General/ReceivingTerms/GetList |
荷受形態を全て取得します。 荷受形態を全て取得します。 |
|
| POST | /API/v2/General/ReceivingTerms/RegisterAdmin |
荷受形態を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/General/ReceivingTerms/RegisterInternal |
荷受形態を登録します。 内部呼び出し用。 (*For admin) |
|
RelatedMinistriesDeclarationApplicationStatusInquiries
IXX_関連省庁申告・申請状況照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/RelatedMinistriesDeclarationApplicationStatusInquiries/Create |
IXXを作成します。 IXXを作成するには、利用者がIXXを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/RelatedMinistriesDeclarationApplicationStatusInquiries/Delete/{reportId} |
IXXを削除します。 帳票ID(***reportId***)を指定して、、IXXを削除します。 IXXを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/RelatedMinistriesDeclarationApplicationStatusInquiries/DeleteFile/{fileId} |
IXXの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IXXの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/RelatedMinistriesDeclarationApplicationStatusInquiries/Get/{reportId} |
IXXを取得します。 帳票ID(***reportId***)を指定して、IXX取得します。 編集が行われていない場合は、ルートドキュメントから最新のIXXを取得します。 編集中の場合は、先に保存した、IXXを取得します。 |
|
| GET | /API/v2/NaccsReports/RelatedMinistriesDeclarationApplicationStatusInquiries/GetFile/{fileId} |
IXXに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IXXに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/RelatedMinistriesDeclarationApplicationStatusInquiries/Lock/{reportId} |
編集するため、IXXをロックします。 帳票ID(***reportId***)を指定して、IXXをロックします。 IXXを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IXXを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIXXは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IXXをルートドキュメントから参照できますが、編集中(ロック中)のIXXは参照できません。 |
|
| POST | /API/v2/NaccsReports/RelatedMinistriesDeclarationApplicationStatusInquiries/SendToNaccs |
IXXをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIXXをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IXXが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/RelatedMinistriesDeclarationApplicationStatusInquiries/SetCancel/{reportId} |
IXXの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IXXの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/RelatedMinistriesDeclarationApplicationStatusInquiries/Submit/{reportId} |
IXXを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIXXを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IXXが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/RelatedMinistriesDeclarationApplicationStatusInquiries/Unlock/{reportId} |
IXXのロックを解除します。 帳票ID(***reportId***)を指定して、IXXのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/RelatedMinistriesDeclarationApplicationStatusInquiries/Update/{reportId} |
IXXを更新します。 帳票ID(***reportId***)を指定して、IXXを更新します。 このメソッドでは、IXXの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/RelatedMinistriesDeclarationApplicationStatusInquiries/UploadFile |
IXXにファイルを添付します。 指定されたIXXに、ファイルを添付します。 |
|
RemarkCodes
リマークコード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/RemarkCodes/DeleteAdmin/{remarkCode} |
リマークコードを削除します。 リマークコード(***remarkCode***)を指定して、リマークコードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/RemarkCodes/Get/{remarkCode} |
リマーク種別を取得します。 リマークコード(***remarkCode***)を指定して、リマーク種別を取得します。 リマークコードに関する詳細については、[リマークコードについて]()を参照ください。 |
|
| GET | /API/v2/General/RemarkCodes/GetList |
リマーク種別を全て取得します。 リマークコードに関する詳細については、[リマークコードについて]()を参照ください。 |
|
| POST | /API/v2/General/RemarkCodes/RegisterAdmin |
リマーク種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/RemarkCodes/RegisterInternal |
リマーク種別を登録します。 内部呼び出し用。 (*For admin) |
|
RemittanceAdvices
振込完了通知書
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/RemittanceAdvices/Create |
振込完了通知書を作成します。 振込完了通知書を作成するには、利用者が振込完了通知書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 振込完了通知書に関する詳細については、[振込完了通知書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/RemittanceAdvices/Delete/{reportId} |
振込完了通知書を削除します。 帳票ID(***reportId***)を指定して、振込完了通知書を削除します。 振込完了通知書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した振込完了通知書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 振込完了通知書に関する詳細については、[振込完了通知書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/RemittanceAdvices/DeleteFile/{fileId} |
振込完了通知書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、振込完了通知書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/RemittanceAdvices/Get/{reportId}?historyId=!{historyId} |
振込完了通知書を取得します。 帳票ID(***reportId***)を指定して、振込完了通知書を取得します。 編集が行われていない場合は、ルートドキュメントから最新の振込完了通知書を取得します。 編集中の場合は、先に保存した、振込完了通知書を取得します。 振込完了通知書に関する詳細については、[振込完了通知書について]()を参照ください。 |
|
| GET | /API/v2/Reports/RemittanceAdvices/GetDiff/{reportId}?historyId=!{historyId} |
保存されている振込完了通知書とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する振込完了通知書と、ルートドキュメントの差分を取得します。 比較元を保存されている振込完了通知書、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/RemittanceAdvices/GetFile/{fileId} |
振込完了通知書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、振込完了通知書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/RemittanceAdvices/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
振込完了通知書を全て取得します。 検索条件に該当する振込完了通知書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の振込完了通知書を取得します。 編集中の場合は、先に保存した、振込完了通知書を取得します。 振込完了通知書に関する詳細については、[振込完了通知書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/RemittanceAdvices/Lock/{reportId} |
編集するため、振込完了通知書をロックします 帳票ID(***reportId***)を指定して、振込完了通知書をロックします。 振込完了通知書を作成(***Create***)した時点では、振込完了通知書をロックが掛かりますが、取得(***Get***)したあとで、振込完了通知書を編集する場合は、このメソッドを呼び出して、振込完了通知書をロックします。 ロックされた振込完了通知書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、振込完了通知書をルートドキュメントから参照できますが、編集中(ロック中)の振込完了通知書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 振込完了通知書に関する詳細については、[振込完了通知書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/RemittanceAdvices/SetCancel/{reportId} |
振込完了通知書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、振込完了通知書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 振込完了通知書に関する詳細については、[振込完了通知書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/RemittanceAdvices/Submit/{reportId} |
振込完了通知書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した振込完了通知書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、振込完了通知書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、振込完了通知書もロックされた状態のままなので、ご注意ください。 振込完了通知書に関する詳細については、[振込完了通知書について]()を参照ください。 |
|
| POST | /API/v2/Reports/RemittanceAdvices/SubmitByPost |
振込完了通知書を提出します。 動作は、振込完了通知書(***/API/v2/Reports/RemittanceAdvices/Update***)と同様です。 振込完了通知書に関する詳細については、[振込完了通知書]()を参照ください。 |
|
| PATCH | /API/v2/Reports/RemittanceAdvices/Unlock/{reportId} |
振込完了通知書のロックを解除します 帳票ID(***reportId***)を指定して、振込完了通知書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 振込完了通知書に関する詳細については、[振込完了通知書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/RemittanceAdvices/Update/{reportId} |
振込完了通知書を更新します。 帳票ID(***reportId***)を指定して、振込完了通知書を更新します。 このメソッドでは、振込完了通知書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 振込完了通知書に関する詳細については、[振込完了通知書について]()を参照ください。 |
|
| POST | /API/v2/Reports/RemittanceAdvices/UpdateByPost |
振込完了通知書を更新します。 動作は、振込完了通知書(***/API/v2/Reports/RemittanceAdvices/Update***)と同様です。 振込完了通知書に関する詳細については、[振込完了通知書]()を参照ください。 |
|
| POST | /API/v2/Reports/RemittanceAdvices/UploadFile |
振込完了通知書にファイルを添付します。 指定された振込完了通知書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
RemittanceSlips
振込・振替明細帳票
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/RemittanceSlips/Create |
振込・振替明細帳票を作成します。 振込・振替明細帳票を作成するには、利用者が振込・振替明細帳票を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/RemittanceSlips/Delete/{reportId} |
振込・振替明細帳票を削除します。 帳票ID(***reportId***)を指定して、振込・振替明細帳票を削除します。 振込・振替明細帳票を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した振込・振替明細帳票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/RemittanceSlips/DeleteFile/{fileId} |
振込・振替明細帳票の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、振込・振替明細帳票の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/RemittanceSlips/Get/{reportId}?historyId=!{historyId} |
振込・振替明細帳票を取得します。 帳票ID(***reportId***)を指定して、振込・振替明細帳票を取得します。 編集が行われていない場合は、ルートドキュメントから最新の振込・振替明細帳票を取得します。 編集中の場合は、先に保存した、振込・振替明細帳票を取得します。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票について]()を参照ください。 |
|
| GET | /API/v2/Reports/RemittanceSlips/GetDiff/{reportId}?historyId=!{historyId} |
保存されている振込・振替明細帳票とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する振込・振替明細帳票と、ルートドキュメントの差分を取得します。 比較元を保存されている振込・振替明細帳票、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/RemittanceSlips/GetFile/{fileId} |
振込・振替明細帳票に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、振込・振替明細帳票に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/RemittanceSlips/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
振込・振替明細帳票を全て取得します。 検索条件に該当する振込・振替明細帳票を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の振込・振替明細帳票を取得します。 編集中の場合は、先に保存した、振込・振替明細帳票を取得します。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/RemittanceSlips/Lock/{reportId} |
編集するため、振込・振替明細帳票をロックします 帳票ID(***reportId***)を指定して、振込・振替明細帳票をロックします。 振込・振替明細帳票を作成(***Create***)した時点では、振込・振替明細帳票をロックが掛かりますが、取得(***Get***)したあとで、振込・振替明細帳票を編集する場合は、このメソッドを呼び出して、振込・振替明細帳票をロックします。 ロックされた振込・振替明細帳票は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、振込・振替明細帳票をルートドキュメントから参照できますが、編集中(ロック中)の振込・振替明細帳票は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/RemittanceSlips/SetCancel/{reportId} |
振込・振替明細帳票の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、振込・振替明細帳票の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/RemittanceSlips/Submit/{reportId} |
振込・振替明細帳票を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した振込・振替明細帳票を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、振込・振替明細帳票が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、振込・振替明細帳票もロックされた状態のままなので、ご注意ください。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票について]()を参照ください。 |
|
| POST | /API/v2/Reports/RemittanceSlips/SubmitByPost |
振込・振替明細帳票を提出します。 動作は、振込・振替明細帳票(***/API/v2/Reports/RemittanceSlips/Submit***)と同様です。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票]()を参照ください。 |
|
| PATCH | /API/v2/Reports/RemittanceSlips/Unlock/{reportId} |
振込・振替明細帳票のロックを解除します 帳票ID(***reportId***)を指定して、振込・振替明細帳票のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/RemittanceSlips/Update/{reportId} |
振込・振替明細帳票を更新します。 帳票ID(***reportId***)を指定して、振込・振替明細帳票を更新します。 このメソッドでは、振込・振替明細帳票の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票について]()を参照ください。 |
|
| POST | /API/v2/Reports/RemittanceSlips/UpdateByPost |
振込・振替明細帳票を更新します。 動作は、振込・振替明細帳票(***/API/v2/Reports/RemittanceSlips/Update***)と同様です。 振込・振替明細帳票に関する詳細については、[振込・振替明細帳票]()を参照ください。 |
|
| POST | /API/v2/Reports/RemittanceSlips/UploadFile |
振込・振替明細帳票にファイルを添付します。 指定された振込・振替明細帳票に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
ReportCategories
帳票カテゴリ
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Master/ReportCategories/DeleteAdmin/{reportCategoryCode} |
帳票のカテゴリを削除します。 帳票カテゴリコード(***reportCategoryCode***)を指定して、帳票のカテゴリを削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| GET | /API/v2/Master/ReportCategories/Get/{reportCategoryCode} |
帳票のカテゴリを取得します。 帳票カテゴリコード(***reportCategoryCode***)を指定して、帳票のカテゴリを取得します。 帳票カテゴリに関する詳細については、[帳票カテゴリについて]()を参照ください。 |
|
| GET | /API/v2/Master/ReportCategories/GetList |
帳票のカテゴリを全て取得します。 帳票のカテゴリを全て取得します。 帳票カテゴリに関する詳細については、[帳票カテゴリについて]()を参照ください。 |
|
| POST | /API/v2/Master/ReportCategories/RegisterAdmin |
帳票のカテゴリを登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/Master/ReportCategories/RegisterInternal |
帳票のカテゴリを登録します。 内部呼び出し用。 (*For admin) |
|
Reports
取引内の帳票
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/Trades/Reports/Get/{reportId} |
取引内の帳票を取得します。 帳票ID(***reportId***)を指定して、該当する取引内の帳票を取得します。 |
|
| GET | /API/v2/Trades/Reports/GetCreatable/{tradeNo}/{organizationId}?reportCategoryCodeList=!{reportCategoryCodeList} |
取引内で作成可能な帳票の種類を取得します。 取引内で、指定された組織(***organizationId***)が、作成可能な帳票の種類を取得します。 |
|
| GET | /API/v2/Trades/Reports/GetList/{tradeNo}?reportCode=!{reportCode}&createdByOrganizationId=!{createdByOrganizationId}&editingByOrganizationId=!{editingByOrganizationId}&updatedByOrganizationId=!{updatedByOrganizationId} |
取引内の帳票を全て取得します。 検索条件に該当する取引内の帳票を全て取得します。 |
|
| GET | /API/v2/Trades/Reports/GetWarehouseConfirmationList/{tradeNo} |
取引の入庫確認一覧を取得します。 指定された取引の入庫確認を一覧取得します。 |
|
ReportTemplates
帳票テンプレート
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Organizations/ReportTemplates/Delete/{reportTemplateId} |
帳票テンプレートを削除します。 帳票テンプレートID(***reportTemplateId***)を指定して、帳票テンプレートを削除します。 帳票テンプレートに関する詳細については、[帳票テンプレートについて]()を参照ください。 |
|
| GET | /API/v2/Organizations/ReportTemplates/Get/{reportTemplateId} |
帳票テンプレートを取得します。 帳票テンプレートID(***reportTemplateId***)を指定して、帳票テンプレートを取得します。 帳票テンプレートに関する詳細については、[帳票テンプレートについて]()を参照ください。 |
|
| GET | /API/v2/Organizations/ReportTemplates/GetDiff/{reportId}/{reportTemplateId} |
現在保存されている帳票と帳票テンプレートの差分を取得します。 帳票ID(***reportId***)と帳票テンプレートID(***reportTemplateId***)を指定して、現在保存されている帳票と帳票テンプレートの差分を取得します。 比較元を現在保存されている帳票、比較先を帳票テンプレートとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票テンプレートに関する詳細については、[帳票テンプレートについて]()を参照ください。 |
|
| GET | /API/v2/Organizations/ReportTemplates/GetList?reportTemplateId=!{reportTemplateId}&reportTemplateName=!{reportTemplateName}&organizationId=!{organizationId}&reportCode=!{reportCode} |
検索条件に該当する帳票テンプレートを全て取得します。 検索条件を指定して、ログインしている利用者が所属する組織が所有する帳票テンプレートを全て取得します。 帳票テンプレートに関する詳細については、[帳票テンプレートについて]()を参照ください。 |
|
| GET | /API/v2/Organizations/ReportTemplates/GetReportContent/{reportTemplateId} |
帳票テンプレートのJSONリソースを取得します。 帳票テンプレートID(***reportTemplateId***)を指定して、帳票テンプレートとして保存された帳票のJSONリソースを取得します。 帳票テンプレートに関する詳細については、[帳票テンプレートについて]()を参照ください。 |
|
| POST | /API/v2/Organizations/ReportTemplates/Register |
帳票テンプレートを登録します。 組織で使用する帳票のテンプレートを登録します。 帳票テンプレートは、帳票を編集する際に入力した情報を保存し、次回、同じ帳票を入力する際のテンプレートとして機能します。 登録した帳票テンプレートは、利用者が所属する指定された組織内で共有されます。 帳票テンプレートに関する詳細については、[帳票テンプレートについて]()を参照ください。 |
|
| PATCH | /API/v2/Organizations/ReportTemplates/Update/{reportTemplateId} |
帳票テンプレートを更新します。 帳票テンプレートID(***reportTemplateId***)を指定して、帳票テンプレートを更新します。 帳票テンプレートに関する詳細については、[帳票テンプレートについて]()を参照ください。 |
|
ReportTypes
帳票の種類
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Master/ReportTypes/DeleteAdmin/{reportCode} |
帳票を削除します。 帳票コード(***reportCode***)を指定して、帳票の種類を削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| GET | /API/v2/Master/ReportTypes/Get/{reportCode} |
帳票の種類を取得します。 帳票コード(***reportCode***)を指定して、帳票の種類を取得します。 帳票の種類に関する詳細については、[帳票の種類について]()を参照ください。 |
|
| GET | /API/v2/Master/ReportTypes/GetList |
帳票の種類を全て取得します。 帳票の種類を全て取得します。 帳票の種類に関する詳細については、[帳票の種類について]()を参照ください。 |
|
| GET | /API/v2/Master/ReportTypes/GetSchema/{reportCode} |
帳票のJSONスキーマを取得します。 帳票コード(***reportCode***)を指定して、帳票のJSONスキーマを取得します。 |
|
| POST | /API/v2/Master/ReportTypes/RegisterAdmin |
帳票の種類を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/Master/ReportTypes/RegisterInternal |
帳票の種類を登録します。 内部呼び出し用。 (*For admin) |
|
Reviews
レビュー
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/Reviews/Assign |
帳票にレビュー依頼を作成します。 レビュー依頼は、取引内の帳票に対して、更新や送信を行う取引内のパートナーに対して、レビューを依頼し、帳票を既読したかどうかを確認する機能です。 レビューを依頼したパートナーは、依頼された側の既読状況を ***/API/v2/Report/Reviews/Get/{reviewId}*** や、 ***/API/v2/Trades/Reports*** で確認できます。 レビューを依頼されたパートナーは、帳票の内容を確認し、***/API/v2/Report/Reviews/MarkAsRead/{reviewId}*** で、既読としてマークします。 レビューに関する詳細については、[レビューについて]()を参照ください。 |
|
| PATCH | /API/v2/Reports/Reviews/Cancel/{reviewId} |
依頼したレビューをキャンセルします。 レビューID(***reviewId***)と組織ID(***organizationId***)を指定して、依頼したレビューのステータスをキャンセルにします。 レビューに関する詳細については、[レビューについて]()を参照ください。 |
|
| GET | /API/v2/Reports/Reviews/Get/{reviewId} |
レビューIDを指定して、レビュー依頼を取得します。 レビューID(***reviewId***)を指定して、レビュー依頼を取得します。 レビュー依頼が作成されている帳票にアクセス権限を持っている必要があります。 レビューに関する詳細については、[レビューについて]()を参照ください。 |
|
| GET | /API/v2/Reports/Reviews/GetList?tradeNo=!{tradeNo}&reportId=!{reportId}&reviewId=!{reviewId}&statusList=!{statusList} |
検索条件を指定して、レビュー依頼を取得します。 検索条件を指定して、レビュー依頼を取得します。 レビュー依頼が作成されている帳票にアクセス権限を持っている必要があります。 レビューに関する詳細については、[レビューについて]()を参照ください。 |
|
| PATCH | /API/v2/Reports/Reviews/MarkAsRead/{reviewId} |
依頼されているレビューを既読としてマークします。 レビューID(***reviewId***)と組織ID(***organizationId***)を指定して、依頼されているレビューを既読としてマークします。 レビューに関する詳細については、[レビューについて]()を参照ください。 |
|
RootDocumentColumns
ルートドキュメントの項目
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Master/RootDocumentColumns/DeleteAdmin/{columnCode} |
帳票を削除します。 帳票コード(***reportCode***)を指定して、帳票を削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| GET | /API/v2/Master/RootDocumentColumns/Get/{columnCode} |
ルートドキュメントの項目を取得します。 項目コード(***columnCode***)を指定して、ルートドキュメントの項目を取得します。 ルートドキュメントに関する詳細については、[ルートドキュメントについて]()を参照ください。 |
|
| GET | /API/v2/Master/RootDocumentColumns/GetList |
ルートドキュメントの項目を全て取得します。 ルートドキュメントの項目を全て取得します。 ルートドキュメントに関する詳細については、[ルートドキュメントについて]()を参照ください。 |
|
| POST | /API/v2/Master/RootDocumentColumns/RegisterAdmin |
項目を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/Master/RootDocumentColumns/RegisterInternal |
項目を登録します。 内部呼び出し用。 (*For admin) |
|
ScacCodes
船会社コード (SCAC)
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/General/ScacCodes/Get/{scacCode} |
船会社コード(SCAC)を取得します。 船会社(SCAC)コード(***scacCode***)を指定して、船会社コード(SCAC)を取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
|
| GET | /API/v2/General/ScacCodes/GetList?scacCode=!{scacCode}&shippingCompanyName=!{shippingCompanyName}&representativeUserCode=!{representativeUserCode}&isMixedLoading=!{isMixedLoading} |
船会社コード(SCAC)を取得します。 検索条件に該当する船会社コード(SCAC)を全て取得します。 NACCSから連携されるマスターデータに関する詳細については、[NACCSから連携されるマスターデータについて]()を参照ください。 |
|
SearchShortcuts
検索ショートカット
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Trades/SearchShortcuts/Delete/{searchShortcutId} |
検索ショートカットIDを指定して、検索ショートカットを削除します。 検索ショートカットID(***searchShortcutId***)を指定して、検索ショートカットを削除します。 |
|
| GET | /API/v2/Trades/SearchShortcuts/Get/{searchShortcutId} |
検索ショートカットを取得します。 検索ショートカットID(***searchShortcutId***)を指定して、検索ショートカットを取得します。 取引の検索に関する詳細については、[取引の検索について]()を参照ください。 |
|
| GET | /API/v2/Trades/SearchShortcuts/GetList?searchShortcutName=!{searchShortcutName} |
検索ショートカットを全て取得します。 検索ショートカットを全て取得します。 取引の検索に関する詳細については、[取引の検索について]()を参照ください。 |
|
| POST | /API/v2/Trades/SearchShortcuts/Register |
取引の検索条件をショートカットとして登録します。 取引の検索条件をショートカットとして登録します。 取引を検索する条件を、検索ショートカットとして保存します。 検索ショートカットを使用した取引の検索は、***/API/v2/Trades/SeacrhByShortcut/*** を使って行います。 取引の検索に関する詳細については、[取引の検索について]()を参照ください。 |
|
| PATCH | /API/v2/Trades/SearchShortcuts/UpdateDisplayOrder/{searchShortcutId} |
検索ショートカットの表示順を変更します。 検索ショートカットID(***searchShortcutId***)を指定して、検索ショートカットの表示順を変更します。 |
|
SeaWayBills
海上運送状(ウェイビル)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/SeaWayBills/Create |
海上運送状(ウェイビル)を作成します。 海上運送状(ウェイビル)を作成するには、利用者が海上運送状(ウェイビル)を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/SeaWayBills/Delete/{reportId} |
海上運送状(ウェイビル)を削除します。 帳票ID(***reportId***)を指定して、海上運送状(ウェイビル)を削除します。 海上運送状(ウェイビル)を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した海上運送状(ウェイビル)のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/SeaWayBills/DeleteFile/{fileId} |
海上運送状(ウェイビル)の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、海上運送状(ウェイビル)の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/SeaWayBills/Get/{reportId}?historyId=!{historyId} |
海上運送状(ウェイビル)を取得します。 帳票ID(***reportId***)を指定して、海上運送状(ウェイビル)を取得します。 編集が行われていない場合は、ルートドキュメントから最新の海上運送状(ウェイビル)を取得します。 編集中の場合は、先に保存した、海上運送状(ウェイビル)を取得します。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)について]()を参照ください。 |
|
| GET | /API/v2/Reports/SeaWayBills/GetDiff/{reportId}?historyId=!{historyId} |
保存されている海上運送状(ウェイビル)とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する海上運送状(ウェイビル)と、ルートドキュメントの差分を取得します。 比較元を保存されている海上運送状(ウェイビル)、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/SeaWayBills/GetFile/{fileId} |
海上運送状(ウェイビル)に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、海上運送状(ウェイビル)に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/SeaWayBills/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
海上運送状(ウェイビル)を全て取得します。 検索条件に該当する海上運送状(ウェイビル)を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の海上運送状(ウェイビル)を取得します。 編集中の場合は、先に保存した、海上運送状(ウェイビル)を取得します。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/SeaWayBills/Lock/{reportId} |
編集するため、海上運送状(ウェイビル)をロックします 帳票ID(***reportId***)を指定して、海上運送状(ウェイビル)をロックします。 海上運送状(ウェイビル)を作成(***Create***)した時点では、海上運送状(ウェイビル)をロックが掛かりますが、取得(***Get***)したあとで、海上運送状(ウェイビル)を編集する場合は、このメソッドを呼び出して、海上運送状(ウェイビル)をロックします。 ロックされた海上運送状(ウェイビル)は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、海上運送状(ウェイビル)をルートドキュメントから参照できますが、編集中(ロック中)の海上運送状(ウェイビル)は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/SeaWayBills/SetCancel/{reportId} |
海上運送状(ウェイビル)の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、船荷証券(B/L)の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/SeaWayBills/Submit/{reportId} |
海上運送状(ウェイビル)を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した海上運送状(ウェイビル)を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、海上運送状(ウェイビル)が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、海上運送状(ウェイビル)もロックされた状態のままなので、ご注意ください。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)について]()を参照ください。 |
|
| POST | /API/v2/Reports/SeaWayBills/SubmitByPost |
海上運送状(ウェイビル)を提出します。 動作は、海上運送状(ウェイビル)(***/API/v2/Reports/SeaWayBills/Submit***)と同様です。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)]()を参照ください。 |
|
| PATCH | /API/v2/Reports/SeaWayBills/Unlock/{reportId} |
海上運送状(ウェイビル)のロックを解除します 帳票ID(***reportId***)を指定して、海上運送状(ウェイビル)のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/SeaWayBills/Update/{reportId} |
海上運送状(ウェイビル)を更新します。 帳票ID(***reportId***)を指定して、海上運送状(ウェイビル)を更新します。 このメソッドでは、海上運送状(ウェイビル)の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)について]()を参照ください。 |
|
| POST | /API/v2/Reports/SeaWayBills/UpdateByPost |
海上運送状(ウェイビル)を更新します。 動作は、海上運送状(ウェイビル)(***/API/v2/Reports/SeaWayBills/Update***)と同様です。 海上運送状(ウェイビル)に関する詳細については、[海上運送状(ウェイビル)]()を参照ください。 |
|
| POST | /API/v2/Reports/SeaWayBills/UploadFile |
海上運送状(ウェイビル)にファイルを添付します。 指定された海上運送状(ウェイビル)に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
ShippingCodeInquiries
IVK_船舶コード照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ShippingCodeInquiries/Create |
IVKを作成します。 IVKを作成するには、利用者がIVKを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ShippingCodeInquiries/Delete/{reportId} |
IVKを削除します。 帳票ID(***reportId***)を指定して、、IVKを削除します。 IVKを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ShippingCodeInquiries/DeleteFile/{fileId} |
IVKの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、IVKの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ShippingCodeInquiries/Get/{reportId} |
IVKを取得します。 帳票ID(***reportId***)を指定して、IVK取得します。 編集が行われていない場合は、ルートドキュメントから最新のIVKを取得します。 編集中の場合は、先に保存した、IVKを取得します。 |
|
| GET | /API/v2/NaccsReports/ShippingCodeInquiries/GetFile/{fileId} |
IVKに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、IVKに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ShippingCodeInquiries/Lock/{reportId} |
編集するため、IVKをロックします。 帳票ID(***reportId***)を指定して、IVKをロックします。 IVKを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、IVKを編集する場合は、このメソッドを呼び出してロックします。 ロックされたIVKは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、IVKをルートドキュメントから参照できますが、編集中(ロック中)のIVKは参照できません。 |
|
| POST | /API/v2/NaccsReports/ShippingCodeInquiries/SendToNaccs |
IVKをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したIVKをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IVKが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ShippingCodeInquiries/SetCancel/{reportId} |
IVKの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、IVKの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ShippingCodeInquiries/Submit/{reportId} |
IVKを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したIVKを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、IVKが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/ShippingCodeInquiries/Unlock/{reportId} |
IVKのロックを解除します。 帳票ID(***reportId***)を指定して、IVKのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ShippingCodeInquiries/Update/{reportId} |
IVKを更新します。 帳票ID(***reportId***)を指定して、IVKを更新します。 このメソッドでは、IVKの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ShippingCodeInquiries/UploadFile |
IVKにファイルを添付します。 指定されたIVKに、ファイルを添付します。 |
|
ShippingCompanyInstructionCodes
船社指示コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/ShippingCompanyInstructionCodes/DeleteAdmin/{shippingCompanyInstructionCode} |
船社指示コードを削除します。 船社指示コード(***shippingCompanyInstructionCode***)を指定して、船社指示コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/ShippingCompanyInstructionCodes/Get/{shippingCompanyInstructionCode} |
船社指示種別を取得します。 船社指示コード(***shippingCompanyInstructionCode***)を指定して、船社指示種別を取得します。 船社指示コードに関する詳細については、[船社指示コードについて]()を参照ください。 |
|
| GET | /API/v2/General/ShippingCompanyInstructionCodes/GetList |
船社指示種別を全て取得します。 船社指示コードに関する詳細については、[船社指示コードについて]()を参照ください。 |
|
| POST | /API/v2/General/ShippingCompanyInstructionCodes/RegisterAdmin |
船社指示種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/ShippingCompanyInstructionCodes/RegisterInternal |
船社指示種別を登録します。 内部呼び出し用。 (*For admin) |
|
ShippingContainerInquiries
ICI_船積コンテナ情報照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/ShippingContainerInquiries/Create |
ICIを作成します。 ICIを作成するには、利用者がICIを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/ShippingContainerInquiries/Delete/{reportId} |
ICIを削除します。 帳票ID(***reportId***)を指定して、、ICIを削除します。 ICIを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/ShippingContainerInquiries/DeleteFile/{fileId} |
ICIの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、ICIの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/ShippingContainerInquiries/Get/{reportId} |
ICIを取得します。 帳票ID(***reportId***)を指定して、ICI取得します。 編集が行われていない場合は、ルートドキュメントから最新のICIを取得します。 編集中の場合は、先に保存した、ICIを取得します。 |
|
| GET | /API/v2/NaccsReports/ShippingContainerInquiries/GetFile/{fileId} |
ICIに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、ICIに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/ShippingContainerInquiries/Lock/{reportId} |
編集するため、ICIをロックします。 帳票ID(***reportId***)を指定して、ICIをロックします。 ICIを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、ICIを編集する場合は、このメソッドを呼び出してロックします。 ロックされたICIは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、ICIをルートドキュメントから参照できますが、編集中(ロック中)のICIは参照できません。 |
|
| POST | /API/v2/NaccsReports/ShippingContainerInquiries/SendToNaccs |
ICIをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したICIをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ICIが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/ShippingContainerInquiries/SetCancel/{reportId} |
ICIの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、ICIの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/ShippingContainerInquiries/Submit/{reportId} |
ICIを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したICIを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ICIが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/ShippingContainerInquiries/SubmitByPost |
ICIを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/ShippingContainerInquiries/Unlock/{reportId} |
ICIのロックを解除します。 帳票ID(***reportId***)を指定して、ICIのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/ShippingContainerInquiries/Update/{reportId} |
ICIを更新します。 帳票ID(***reportId***)を指定して、ICIを更新します。 このメソッドでは、ICIの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/ShippingContainerInquiries/UpdateByPost |
ICIを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/ShippingContainerInquiries/UploadFile |
ICIにファイルを添付します。 指定されたICIに、ファイルを添付します。 |
|
ShippingInstructions
船積依頼書
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/ShippingInstructions/Create |
船積依頼書を作成します。 船積依頼書を作成するには、利用者が船積依頼書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/ShippingInstructions/Delete/{reportId} |
船積依頼書を削除します。 帳票ID(***reportId***)を指定して、船積依頼書を削除します。 船積依頼書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した船積依頼書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/ShippingInstructions/DeleteFile/{fileId} |
船積依頼書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、船積依頼書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/ShippingInstructions/Get/{reportId}?historyId=!{historyId} |
船積依頼書を取得します。 帳票ID(***reportId***)を指定して、船積依頼書を取得します。 編集が行われていない場合は、ルートドキュメントから最新の船積依頼書を取得します。 編集中の場合は、先に保存した、船積依頼書を取得します。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
| GET | /API/v2/Reports/ShippingInstructions/GetDiff/{reportId}?historyId=!{historyId} |
保存されている船積依頼書とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する船積依頼書と、ルートドキュメントの差分を取得します。 比較元を保存されている船積依頼書、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/ShippingInstructions/GetFile/{fileId} |
船積依頼書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、船積依頼書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/ShippingInstructions/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
船積依頼書を全て取得します。 検索条件に該当する船積依頼書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の船積依頼書を取得します。 編集中の場合は、先に保存した、船積依頼書を取得します。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ShippingInstructions/Lock/{reportId} |
編集するため、船積依頼書をロックします 帳票ID(***reportId***)を指定して、船積依頼書をロックします。 船積依頼書を作成(***Create***)した時点では、船積依頼書をロックが掛かりますが、取得(***Get***)したあとで、船積依頼書を編集する場合は、このメソッドを呼び出して、船積依頼書をロックします。 ロックされた船積依頼書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、船積依頼書をルートドキュメントから参照できますが、編集中(ロック中)の船積依頼書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ShippingInstructions/SetCancel/{reportId} |
船積依頼書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、船積依頼書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ShippingInstructions/Submit/{reportId} |
船積依頼書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した船積依頼書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、船積依頼書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、船積依頼書もロックされた状態のままなので、ご注意ください。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
| POST | /API/v2/Reports/ShippingInstructions/SubmitByPost |
船積依頼書を提出します 動作は、船積依頼書の提出(***/API/v2/Reports/ShippingInstructions/Submit***)と同様です。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ShippingInstructions/Unlock/{reportId} |
船積依頼書のロックを解除します 帳票ID(***reportId***)を指定して、船積依頼書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/ShippingInstructions/Update/{reportId} |
船積依頼書を更新します。 帳票ID(***reportId***)を指定して、船積依頼書を更新します。 このメソッドでは、船積依頼書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
| POST | /API/v2/Reports/ShippingInstructions/UpdateByPost |
船積依頼書を更新します。 動作は、船積依頼書の更新(***/API/v2/Reports/ShippingInstructions/Update***)と同様です。 船積依頼書に関する詳細については、[船積依頼書について]()を参照ください。 |
|
| POST | /API/v2/Reports/ShippingInstructions/UploadFile |
船積依頼書にファイルを添付します。 指定された船積依頼書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
ShippingPurposeCodes
運送目的コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/ShippingPurposeCodes/DeleteAdmin/{shippingPurposeCode} |
運送目的コードを削除します。 運送目的コード(***shippingPurposeCode***)を指定して、運送目的コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/ShippingPurposeCodes/Get/{shippingPurposeCode} |
運送目的種別を取得します。 運送目的コード(***shippingPurposeCode***)を指定して、運送目的種別を取得します。 運送目的コードに関する詳細については、[運送目的コードについて]()を参照ください。 |
|
| GET | /API/v2/General/ShippingPurposeCodes/GetList |
運送目的種別を全て取得します。 運送目的コードに関する詳細については、[運送目的コードについて]()を参照ください。 |
|
| POST | /API/v2/General/ShippingPurposeCodes/RegisterAdmin |
運送目的種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/ShippingPurposeCodes/RegisterInternal |
運送目的種別を登録します。 内部呼び出し用。 (*For admin) |
|
ShippingTypeCodes
運送種別コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/ShippingTypeCodes/DeleteAdmin/{shippingTypeCode} |
運送種別コードを削除します。 運送種別コード(***shippingTypeCode***)を指定して、運送種別コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/ShippingTypeCodes/Get/{shippingTypeCode} |
運送種別を取得します。 運送種別コード(***shippingTypeCode***)を指定して、運送種別を取得します。 運送種別コードに関する詳細については、[運送種別コードについて]()を参照ください。 |
|
| GET | /API/v2/General/ShippingTypeCodes/GetList |
運送種別を全て取得します。 運送種別コードに関する詳細については、[運送種別コードについて]()を参照ください。 |
|
| POST | /API/v2/General/ShippingTypeCodes/RegisterAdmin |
運送種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/ShippingTypeCodes/RegisterInternal |
運送種別を登録します。 内部呼び出し用。 (*For admin) |
|
SimpleCargoRegistrationCalls
SCR11_簡易貨物情報登録呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/SimpleCargoRegistrationCalls/Create |
SCR11を作成します。 SCR11を作成するには、利用者がSCR11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/SimpleCargoRegistrationCalls/Delete/{reportId} |
SCR11を削除します。 帳票ID(***reportId***)を指定して、、SCR11を削除します。 SCR11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/SimpleCargoRegistrationCalls/DeleteFile/{fileId} |
SCR11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、SCR11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/SimpleCargoRegistrationCalls/Get/{reportId} |
SCR11を取得します。 帳票ID(***reportId***)を指定して、SCR11取得します。 編集が行われていない場合は、ルートドキュメントから最新のSCR11を取得します。 編集中の場合は、先に保存した、SCR11を取得します。 |
|
| GET | /API/v2/NaccsReports/SimpleCargoRegistrationCalls/GetFile/{fileId} |
SCR11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、SCR11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/SimpleCargoRegistrationCalls/Lock/{reportId} |
編集するため、SCR11をロックします。 帳票ID(***reportId***)を指定して、SCR11をロックします。 SCR11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、SCR11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたSCR11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、SCR11をルートドキュメントから参照できますが、編集中(ロック中)のSCR11は参照できません。 |
|
| POST | /API/v2/NaccsReports/SimpleCargoRegistrationCalls/SendToNaccs |
SCR11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したSCR11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、SCR11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/SimpleCargoRegistrationCalls/SetCancel/{reportId} |
SCR11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、SCR11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/SimpleCargoRegistrationCalls/Submit/{reportId} |
SCR11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したSCR11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、SCR11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/SimpleCargoRegistrationCalls/Unlock/{reportId} |
SCR11のロックを解除します。 帳票ID(***reportId***)を指定して、SCR11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/SimpleCargoRegistrationCalls/Update/{reportId} |
SCR11を更新します。 帳票ID(***reportId***)を指定して、SCR11を更新します。 このメソッドでは、SCR11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/SimpleCargoRegistrationCalls/UploadFile |
SCR11にファイルを添付します。 指定されたSCR11に、ファイルを添付します。 |
|
SimpleCargoRegistrations
SCR_簡易貨物情報登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/SimpleCargoRegistrations/Create |
SCRを作成します。 SCRを作成するには、利用者がSCRを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/SimpleCargoRegistrations/Delete/{reportId} |
SCRを削除します。 帳票ID(***reportId***)を指定して、、SCRを削除します。 SCRを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/SimpleCargoRegistrations/DeleteFile/{fileId} |
SCRの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、SCRの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/SimpleCargoRegistrations/Get/{reportId} |
SCRを取得します。 帳票ID(***reportId***)を指定して、SCR取得します。 編集が行われていない場合は、ルートドキュメントから最新のSCRを取得します。 編集中の場合は、先に保存した、SCRを取得します。 |
|
| GET | /API/v2/NaccsReports/SimpleCargoRegistrations/GetFile/{fileId} |
SCRに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、SCRに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/SimpleCargoRegistrations/Lock/{reportId} |
編集するため、SCRをロックします。 帳票ID(***reportId***)を指定して、SCRをロックします。 SCRを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、SCRを編集する場合は、このメソッドを呼び出してロックします。 ロックされたSCRは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、SCRをルートドキュメントから参照できますが、編集中(ロック中)のSCRは参照できません。 |
|
| POST | /API/v2/NaccsReports/SimpleCargoRegistrations/SendToNaccs |
SCRをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したSCRをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、SCRが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/SimpleCargoRegistrations/SetCancel/{reportId} |
SCRの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、SCRの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/SimpleCargoRegistrations/Submit/{reportId} |
SCRを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したSCRを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、SCRが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/SimpleCargoRegistrations/SubmitByPost |
SCRを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/SimpleCargoRegistrations/Unlock/{reportId} |
SCRのロックを解除します。 帳票ID(***reportId***)を指定して、SCRのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/SimpleCargoRegistrations/Update/{reportId} |
SCRを更新します。 帳票ID(***reportId***)を指定して、SCRを更新します。 このメソッドでは、SCRの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/SimpleCargoRegistrations/UpdateByPost |
SCRを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/SimpleCargoRegistrations/UploadFile |
SCRにファイルを添付します。 指定されたSCRに、ファイルを添付します。 |
|
SpecialCargoCodes
特殊貨物コード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/SpecialCargoCodes/DeleteAdmin/{specialCargoCode} |
特殊貨物コードを削除します。 特殊貨物コード(***specialCargoCode***)を指定して、特殊貨物コードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/SpecialCargoCodes/Get/{specialCargoCode} |
特殊貨物種別を取得します。 特殊貨物コード(***specialCargoCode***)を指定して、特殊貨物種別を取得します。 特殊貨物コードに関する詳細については、[特殊貨物コードについて]()を参照ください。 |
|
| GET | /API/v2/General/SpecialCargoCodes/GetList |
特殊貨物種別を全て取得します。 特殊貨物コードに関する詳細については、[特殊貨物コードについて]()を参照ください。 |
|
| POST | /API/v2/General/SpecialCargoCodes/RegisterAdmin |
特殊貨物種別を登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/SpecialCargoCodes/RegisterInternal |
特殊貨物種別を登録します。 内部呼び出し用。 (*For admin) |
|
StandardProcesses
標準プロセス
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/Master/StandardProcesses/CanAccept/{processCode}?organizationId={organizationId}&openId={openId} |
指定したプロセスで「帳票を受け取るパートナー」になる権限があるかを判定します。 指定した組織がプロセスで取り扱う全ての帳票に対してR権限以上を持っていれば true, そうでなければ false。 内部呼び出し用 |
|
| GET | /API/v2/Master/StandardProcesses/CanSubmit/{processCode}?organizationId={organizationId}&openId={openId} |
指定したプロセスで「帳票を提出するパートナー」になる権限があるかを判定します。 指定した組織がプロセスで取り扱う全ての帳票に対してRW権限を持っていれば true, そうでなければ false。 内部呼び出し用 |
|
| DELETE | /API/v2/Master/StandardProcesses/DeleteAdmin/{processCode} |
プロセスコードを指定して、標準プロセスを削除します。 プロセスコード(***processCode***)を指定して、標準プロセスを削除します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| GET | /API/v2/Master/StandardProcesses/Get/{processCode}?organizationId=!{organizationId} |
プロセスコードを指定して、標準プロセスを取得します プロセスコード(***processCode***)を指定して、標準プロセスを取得します。 組織ID(***organizationId***)を指定すると、選択可能なプロセス種別(***selectableProcessTypes***)にて、そのプロセスで帳票を提出できる事業者なのか、受け取ることができる事業者なのかが確認できます。 グループ配下のプロセスも含めて、取得する場合は、(***/API/v2/Master/StandardProcesses/GetList***)を使用します。 プロセスに関する詳細については、[プロセスについて]()を参照ください。 |
|
| GET | /API/v2/Master/StandardProcesses/GetList/{tradeType}?processGroupCode=!{processGroupCode}&processCode=!{processCode}&organizationId=!{organizationId} |
標準プロセスを全てを取得します 取引タイプ(***tradeType***)を指定して、プロセスグループ、その配下の標準プロセスを全てを取得します 組織ID(***organizationId***)を指定すると、選択可能なプロセス種別(***selectableProcessTypes***)にて、そのプロセスで帳票を提出できる事業者なのか、受け取ることができる事業者なのかが確認できます。 プロセスに関する詳細については、[プロセスについて]()を参照ください。 |
|
| POST | /API/v2/Master/StandardProcesses/RegisterAdmin |
標準プロセスを登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/Master/StandardProcesses/RegisterInternal |
標準プロセスを登録します。 内部呼び出し用。 (*For admin) |
|
SubmissionBranches
提出先支部
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Master/SubmissionBranches/DeleteAdmin/{submissionBranchCode} |
提出先支部を削除します。 (*For admin) |
|
| GET | /API/v2/Master/SubmissionBranches/GetList |
提出先支部を全て取得します。 |
|
| GET | /API/v2/Master/SubmissionBranches/GetListInternal?submissionBranchCode=!{submissionBranchCode}&includeDummy=!{includeDummy} |
提出先支部を全て取得します。 内部呼び出し用 |
|
| POST | /API/v2/Master/SubmissionBranches/RegisterAdmin |
提出先支部を登録します。 このAPIはシステム管理者しか呼び出せません。 (*For admin) |
|
| POST | /API/v2/Master/SubmissionBranches/RegisterInternal |
提出先支部を登録します。 内部呼び出し用。 (*For admin) |
|
Tasks
タスク
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/Tasks/Assign |
帳票にタスクを割り当てます。 タスクは、取引内の帳票に対して、更新や送信を行う取引内のパートナーを「担当するパートナー」として設定したり、帳票に対して「必須項目」を設定する機能です。 必須項目が設定されたタスクが割り当てられた帳票は、帳票の提出時に、必須項目のチェックが行われ、必須項目が入力されていない場合、帳票の提出は出来なくなります。 タスクの担当となった取引のパートナーは、この必須項目の設定に従い、帳票の項目を入力します。 タスクが割り当てられた帳票の提出に成功すると、そのタスクを担当するパートナーは、タスクを依頼したパートナーに切り替わります。 タスクに関する詳細については、[タスクについて]()を参照ください。 |
|
| GET | /API/v2/Reports/Tasks/Get/{taskId} |
タスクを取得します。 タスクID(***taskId***)を指定して、タスクを取得します。 対象となる取引に、利用者が所属する組織が参加、かつ、タスクが作成されている帳票にアクセス権限を持っている必要があります。 タスクに関する詳細については、[タスクについて]()を参照ください。 |
|
| GET | /API/v2/Reports/Tasks/GetAssignedCount?tradeNo=!{tradeNo}&reportId=!{reportId} |
指定された条件で、利用者が所属する組織が担当となっているタスクの件数を取得します。 取引管理番号(***tradeNo***)や帳票ID(***reportId***)を指定して、利用者が所属する組織が担当となっているタスクの件数を取得します。 タスクに関する詳細については、[タスクについて]()を参照ください。 |
|
| GET | /API/v2/Reports/Tasks/GetList?taskId=!{taskId}&taskTitle=!{taskTitle}&tradeNo=!{tradeNo}&reportId=!{reportId}&reportCode=!{reportCode}&processId=!{processId}&organizationIdAsAssignor=!{organizationIdAsAssignor}&organizationIdAsAssignee=!{organizationIdAsAssignee}&employeeIdAsAssignee=!{employeeIdAsAssignee}&statusList=!{statusList}&assignedToMe=!{assignedToMe} |
検索条件を指定して、該当するタスク全てを取得します。 検索条件を指定して、条件に該当するタスクを全て取得します。 取得できるタスクは、対象となる取引に、利用者が所属する組織が参加、かつ、タスクが割り当てられた帳票にアクセス権限を持っているものに限定されます。 タスクに関する詳細については、[タスクについて]()を参照ください。 |
|
| PATCH | /API/v2/Reports/Tasks/SetAssignee/{taskId} |
取引内でタスクを担当する取引内のパートナーや担当者を変更します。 タスクID(***taskId***)を指定して、タスクを担当するパートナーを変更します。 タスクを担当するパートナーを変更できるのは、その帳票にアクセス権限を持つパートナーに所属する利用者です。 タスクに関する詳細については、[タスクについて]()を参照ください。 |
|
| PATCH | /API/v2/Reports/Tasks/SetRequiredFields/{taskId} |
取引内でタスクの必須項目を更新します。 タスクID(***taskId***)を指定して、タスクの必須項目を更新します。 タスクの必須項目を変更できるのは、その帳票にアクセス権限を持つパートナーに所属する利用者です。 タスクに関する詳細については、[タスクについて]()を参照ください。 |
|
| PATCH | /API/v2/Reports/Tasks/SetStatus/{taskId} |
取引内でタスクのステータスを更新します。 タスクID(***taskId***)を指定して、タスクのステータスを更新します。 タスクのステータスを変更できるのは、その帳票にアクセス権限を持つパートナーに所属する利用者です。 タスクに関する詳細については、[タスクについて]()を参照ください。 |
|
| PATCH | /API/v2/Reports/Tasks/SetTitle/{taskId} |
取引内でタスクのタイトルを更新します。 タスクID(***taskId***)を指定して、タスクのタイトルを更新します。 タスクのタイトルを変更できるのは、そのタスクを依頼にアクセス権限を持つパートナーに所属する利用者です。 タスクに関する詳細については、[タスクについて]()を参照ください。 |
|
TerminalActivationConfirmations
TCC_端末開通確認
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/TerminalActivationConfirmations/Create |
TCCを作成します。 TCCを作成するには、利用者がTCCを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/TerminalActivationConfirmations/Delete/{reportId} |
TCCを削除します。 帳票ID(***reportId***)を指定して、、TCCを削除します。 TCCを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/TerminalActivationConfirmations/DeleteFile/{fileId} |
TCCの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、TCCの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/TerminalActivationConfirmations/Get/{reportId} |
TCCを取得します。 帳票ID(***reportId***)を指定して、TCC取得します。 編集が行われていない場合は、ルートドキュメントから最新のTCCを取得します。 編集中の場合は、先に保存した、TCCを取得します。 |
|
| GET | /API/v2/NaccsReports/TerminalActivationConfirmations/GetFile/{fileId} |
TCCに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、TCCに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/TerminalActivationConfirmations/Lock/{reportId} |
編集するため、TCCをロックします。 帳票ID(***reportId***)を指定して、TCCをロックします。 TCCを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、TCCを編集する場合は、このメソッドを呼び出してロックします。 ロックされたTCCは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、TCCをルートドキュメントから参照できますが、編集中(ロック中)のTCCは参照できません。 |
|
| POST | /API/v2/NaccsReports/TerminalActivationConfirmations/SendToNaccs |
TCCをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したTCCをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、TCCが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/TerminalActivationConfirmations/SetCancel/{reportId} |
TCCの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、TCCの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/TerminalActivationConfirmations/Submit/{reportId} |
TCCを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したTCCを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、TCCが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/TerminalActivationConfirmations/Unlock/{reportId} |
TCCのロックを解除します。 帳票ID(***reportId***)を指定して、TCCのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/TerminalActivationConfirmations/Update/{reportId} |
TCCを更新します。 帳票ID(***reportId***)を指定して、TCCを更新します。 このメソッドでは、TCCの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/TerminalActivationConfirmations/UploadFile |
TCCにファイルを添付します。 指定されたTCCに、ファイルを添付します。 |
|
TerminalInquiries
ターミナル問合せ
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/TerminalInquiries/Create |
ターミナル問合せを作成します。 ターミナル問合せを作成するには、利用者がターミナル問合せを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
| DELETE | /API/v2/Reports/TerminalInquiries/Delete/{reportId} |
ターミナル問合せを削除します。 帳票ID(***reportId***)を指定して、ターミナル問合せを削除します。 ターミナル問合せを削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したターミナル問合せのキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
| DELETE | /API/v2/Reports/TerminalInquiries/DeleteFile/{fileId} |
ターミナル問合せの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、ターミナル問合せの添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/TerminalInquiries/Get/{reportId}?historyId=!{historyId} |
ターミナル問合せを取得します。 帳票ID(***reportId***)を指定して、ターミナル問合せを取得します。 編集が行われていない場合は、ルートドキュメントから最新の搬入確認依頼票を取得します。 編集中の場合は、先に保存した、ターミナル問合せを取得します。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
| GET | /API/v2/Reports/TerminalInquiries/GetDiff/{reportId}?historyId=!{historyId} |
保存されているターミナル問合せとルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当するターミナル問合せと、ルートドキュメントの差分を取得します。 比較元を保存されているターミナル問合せ、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/TerminalInquiries/GetFile/{fileId} |
ターミナル問合せに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、ターミナル問合せに添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/TerminalInquiries/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
ターミナル問合せを全て取得します。 検索条件に該当するターミナル問合せを全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のターミナル問合せを取得します。 編集中の場合は、先に保存した、ターミナル問合せを取得します。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
| PATCH | /API/v2/Reports/TerminalInquiries/Lock/{reportId} |
編集するため、ターミナル問合せをロックします 帳票ID(***reportId***)を指定して、ターミナル問合せをロックします。 ターミナル問合せを作成(***Create***)した時点では、ターミナル問合せをロックが掛かりますが、取得(***Get***)したあとで、ターミナル問合せを編集する場合は、このメソッドを呼び出して、ターミナル問合せをロックします。 ロックされたターミナル問合せは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、ターミナル問合せをルートドキュメントから参照できますが、編集中(ロック中)のターミナル問合せは参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
| PATCH | /API/v2/Reports/TerminalInquiries/SetCancel/{reportId} |
ターミナル問合せの申請種別をキャンセルします 帳票ID(***reportId***)を指定して、ターミナル問合せの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
| PATCH | /API/v2/Reports/TerminalInquiries/Submit/{reportId} |
ターミナル問合せを提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したターミナル問合せを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ターミナル問合せが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ターミナル問合せもロックされた状態のままなので、ご注意ください。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
| POST | /API/v2/Reports/TerminalInquiries/SubmitByPost |
ターミナル問合せを提出します 動作は、ターミナル問合せの提出(***/API/v2/Reports/TerminalInquiries/Submit***)と同様です。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
| PATCH | /API/v2/Reports/TerminalInquiries/Unlock/{reportId} |
ターミナル問合せのロックを解除します 帳票ID(***reportId***)を指定して、ターミナル問合せのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
| PATCH | /API/v2/Reports/TerminalInquiries/Update/{reportId} |
ターミナル問合せを更新します。 帳票ID(***reportId***)を指定して、ターミナル問合せを更新します。 このメソッドでは、ターミナル問合せの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
| POST | /API/v2/Reports/TerminalInquiries/UpdateByPost |
ターミナル問合せを更新します。 動作は、ターミナル問合せの更新(***/API/v2/Reports/TerminalInquiries/Update***)と同様です。 ターミナル問合せに関する詳細については、[ターミナル問合せについて]()を参照ください。 |
|
| POST | /API/v2/Reports/TerminalInquiries/UploadFile |
ターミナル問合せにファイルを添付します。 指定されたターミナル問合せに、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
TerminalNotices
ターミナルからのお知らせ
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Terminals/TerminalNotices/Delete/{terminalNoticeId} |
description="ターミナルからのお知らせを削除します。 |
|
| DELETE | /API/v2/Terminals/TerminalNotices/DeleteFile/{fileId} |
ターミナルからのお知らせに添付されたファイルを削除します。 ファイルID(***fileId***)を指定して、ターミナルからのお知らせに添付されたファイルを削除します。 ターミナルからのお知らせにファイルを削除するには、その利用者が、お知らせを登録するターミナルに対して、ターミナルを運営する組織に所属している必要があります。 |
|
| GET | /API/v2/Terminals/TerminalNotices/Get/{terminalNoticeId} |
ターミナルからのお知らせを取得します。 ターミナルからのお知らせID(***terminalNoticeId***)を指定して、ターミナルからのお知らせを取得します。 ターミナルからのお知らせに関する詳細については、[ターミナルからのお知らせについて]()を参照ください。 |
|
| GET | /API/v2/Terminals/TerminalNotices/GetFile/{fileId} |
ターミナルからのお知らせに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、ターミナルからのお知らせに添付されたファイルを取得します。 ターミナルからのお知らせに関する詳細については、[ターミナルからのお知らせについて]()を参照ください。 |
|
| GET | /API/v2/Terminals/TerminalNotices/GetList?portCode=!{portCode}&terminalCode=!{terminalCode}&importance=!{importance}&onlyCurrent=!{onlyCurrent}&startAt=!{startAt}&endAt=!{endAt} |
検索条件に該当するターミナルからのお知らせを取得します。 検索条件に該当するターミナルからのお知らせを全て取得します。 ターミナルからのお知らせに関する詳細については、[ターミナルからのお知らせについて]()を参照ください。 |
|
| POST | /API/v2/Terminals/TerminalNotices/Register |
ターミナルからのお知らせを登録します。 ターミナルからのお知らせを登録します。 ターミナルからのお知らせを登録するには、その利用者が、お知らせを登録するターミナルに対して、ターミナルを運営する組織に所属している必要があります。 ターミナルからのお知らせに関する詳細については、[ターミナルからのお知らせについて]()を参照ください。 |
|
| PATCH | /API/v2/Terminals/TerminalNotices/Update/{terminalNoticeId} |
ターミナルからのお知らせを更新します。 ターミナルからのお知らせID(***terminalNoticeId***)に該当するターミナルからのお知らせを更新します。 ターミナルからのお知らせを更新するには、その利用者が、お知らせを登録するターミナルに対して、ターミナルを運営する組織に所属している必要があります。 ターミナルからのお知らせに関する詳細については、[ターミナルからのお知らせについて]()を参照ください。 |
|
| POST | /API/v2/Terminals/TerminalNotices/UploadFile |
ターミナルからのお知らせにファイルを添付します。 ターミナルからのお知らせに、ファイルを添付します。 ターミナルからのお知らせにファイルを添付するには、その利用者が、お知らせを登録するターミナルに対して、ターミナルを運営する組織に所属している必要があります。 ターミナルからのお知らせに関する詳細については、[ターミナルからのお知らせについて]()を参照ください。 |
|
TerminalPayments
ターミナル支払申込兼入金通知書
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/TerminalPayments/Create |
ターミナル支払申込兼入金通知書を作成します。 ターミナル支払申込兼入金通知書を作成するには、利用者がターミナル支払申込兼入金通知書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/TerminalPayments/Delete/{reportId} |
ターミナル支払申込兼入金通知書を削除します。 帳票ID(***reportId***)を指定して、ターミナル支払申込兼入金通知書を削除します。 ターミナル支払申込兼入金通知書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したターミナル支払申込兼入金通知書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/TerminalPayments/DeleteFile/{fileId} |
ターミナル支払申込兼入金通知書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、ターミナル支払申込兼入金通知書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/TerminalPayments/Get/{reportId}?historyId=!{historyId} |
ターミナル支払申込兼入金通知書を取得します。 帳票ID(***reportId***)を指定して、ターミナル支払申込兼入金通知書を取得します。 編集が行われていない場合は、ルートドキュメントから最新の搬入確認依頼票を取得します。 編集中の場合は、先に保存した、ターミナル支払申込兼入金通知書を取得します。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
| GET | /API/v2/Reports/TerminalPayments/GetDiff/{reportId}?historyId=!{historyId} |
保存されているターミナル支払申込兼入金通知書とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当するターミナル支払申込兼入金通知書と、ルートドキュメントの差分を取得します。 比較元を保存されているターミナル支払申込兼入金通知書、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/TerminalPayments/GetFile/{fileId} |
ターミナル支払申込兼入金通知書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、ターミナル支払申込兼入金通知書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/TerminalPayments/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
ターミナル支払申込兼入金通知書を全て取得します。 検索条件に該当するターミナル支払申込兼入金通知書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のターミナル支払申込兼入金通知書を取得します。 編集中の場合は、先に保存した、ターミナル支払申込兼入金通知書を取得します。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/TerminalPayments/Lock/{reportId} |
編集するため、ターミナル支払申込兼入金通知書をロックします 帳票ID(***reportId***)を指定して、ターミナル支払申込兼入金通知書をロックします。 ターミナル支払申込兼入金通知書を作成(***Create***)した時点では、ターミナル支払申込兼入金通知書をロックが掛かりますが、取得(***Get***)したあとで、ターミナル支払申込兼入金通知書を編集する場合は、このメソッドを呼び出して、ターミナル支払申込兼入金通知書をロックします。 ロックされたターミナル支払申込兼入金通知書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、ターミナル支払申込兼入金通知書をルートドキュメントから参照できますが、編集中(ロック中)のターミナル支払申込兼入金通知書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/TerminalPayments/SetCancel/{reportId} |
ターミナル支払申込兼入金通知書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、ターミナル支払申込兼入金通知書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/TerminalPayments/Submit/{reportId} |
ターミナル支払申込兼入金通知書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したターミナル支払申込兼入金通知書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、ターミナル問合せが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ターミナル支払申込兼入金通知書もロックされた状態のままなので、ご注意ください。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
| POST | /API/v2/Reports/TerminalPayments/SubmitByPost |
ターミナル支払申込兼入金通知書を提出します 動作は、ターミナル支払申込兼入金通知書の提出(***/API/v2/Reports/TerminalPayments/Submit***)と同様です。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/TerminalPayments/Unlock/{reportId} |
ターミナル支払申込兼入金通知書のロックを解除します 帳票ID(***reportId***)を指定して、ターミナル支払申込兼入金通知書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/TerminalPayments/Update/{reportId} |
ターミナル支払申込兼入金通知書を更新します。 帳票ID(***reportId***)を指定して、ターミナル支払申込兼入金通知書を更新します。 このメソッドでは、ターミナル支払申込兼入金通知書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
| POST | /API/v2/Reports/TerminalPayments/UpdateByPost |
ターミナル支払申込兼入金通知書を更新します。 動作は、ターミナル支払申込兼入金通知書の更新(***/API/v2/Reports/TerminalPayments/Update***)と同様です。 ターミナル支払申込兼入金通知書に関する詳細については、[ターミナル支払申込兼入金通知書について]()を参照ください。 |
|
| POST | /API/v2/Reports/TerminalPayments/UploadFile |
ターミナル支払申込兼入金通知書にファイルを添付します。 指定されたターミナル支払申込兼入金通知書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
Terminals
ターミナル
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/Terminals/Get/{terminalCode} |
ターミナルを取得します。 ターミナルコード(***terminalCode***)を指定して、ターミナルを取得します。 ターミナルに関する詳細については、[ターミナルについて]()を参照ください。 |
|
| GET | /API/v2/Terminals/GetList?portCode=!{portCode}&terminalCode=!{terminalCode}&terminalName=!{terminalName}&terminalNameEn=!{terminalNameEn}&terminalNameCn=!{terminalNameCn}&terminalNameAb=!{terminalNameAb}&operatedByMyCompany=!{operatedByMyCompany}&operatedByMyOrganization=!{operatedByMyOrganization} |
ターミナルを取得します。 検索条件に該当するターミナルを全て取得します。 ターミナルに関する詳細については、[ターミナルについて]()を参照ください。 |
|
Trades
取引
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Trades/Create |
取引を作成します。 サイバーポートで、複数の事業者間で帳票のやり取りを行うには、まずはこのメソッドで取引を作成します。取引は、複数の事業者間と港湾・貿易業務を行う上での共有空間として機能します。 作成された取引には、取引管理番号(***tradeNo***)という一意の番号が附番され、空のルートドキュメントが作成されます。以降、取引は、取引管理番号(***tradeNo***)で一意に識別できます。 取引が作成された時点では、取引のオーナーとして指定した組織に所属する利用者しかアクセス出来ません。他の事業者を取引に参加させ、帳票のやり取りを行うには、作成した取引に対し、取引のパートナーを追加(***/API/v2/Trades/Partners***)を行う必要があります。 取引に関する詳細については、[取引について]()を参照ください。 |
|
| DELETE | /API/v2/Trades/Delete/{tradeNo} |
取引を削除します。 取引管理番号(***tradeNo***)を指定して、取引を削除します。 取引を削除するには、その取引に利用者が所属する組織が参加しており、かつ、その組織が取引のオーナーである必要があります。 ただし、取引に他のパートナーが参加してたり、帳票が作成されている場合は、削除できません。この場合は、取引のステータスを変更してください。 取引に関する詳細については、[取引について]()を参照ください。 |
|
| POST | /API/v2/Trades/Duplicate |
取引を複製します。 複製できる取引は、利用者が所属する組織が参加している取引のみとなります。取引を複製すると、複製元の取引から、取引のパートナーを引き継いだ形で、取引が作成されます。 但し、複製範囲(***organizationScope***)で、追加したパートナーのみとした場合、複製元で利用者が所属する組織が追加したパートナーが複製対象となります。複製元の取引内に存在している帳票は複製対象とはなりません。 また、複製した取引には、パートナーの帳票アクセス権限も含まれます。 取引に関する詳細については、[取引について]()を参照ください。 |
|
| GET | /API/v2/Trades/Get/{tradeNo} |
取引を取得します。 取引管理番号(***tradeNo***)を指定して、利用者が所属する組織が参加している取引を取得します。 取引に関する詳細については、[取引について]()を参照ください。 |
|
| GET | /API/v2/Trades/GetContainerRequests/{tradeNo}?newReportCode=!{newReportCode} |
取引内のコンテナ要求を取得します。 取引管理番号(***tradeNo***)を指定して、各帳票を通して登録された取引内のコンテナ要求を全て取得します。 |
|
| GET | /API/v2/Trades/GetContainers/{tradeNo}?newReportCode=!{newReportCode} |
取引内のコンテナを取得します。 取引管理番号(***tradeNo***)を指定して、各帳票を通して登録された取引内のコンテナを全て取得します。 |
|
| GET | /API/v2/Trades/GetDangerousGoodsProfiles/{tradeNo}?newReportCode=!{newReportCode} |
取引内の危険物商品明細(要約)を取得します。 取引管理番号(***tradeNo***)を指定して、各帳票を通して登録された取引内の危険物商品明細(要約)を全て取得します。 |
|
| GET | /API/v2/Trades/GetDescriptionOfDangerousGoods/{tradeNo} |
取引内の危険物商品明細を取得します。 取引管理番号(***tradeNo***)を指定して、取引内の危険物商品明細を全て取得します。 |
|
| GET | /API/v2/Trades/GetDevannings/{tradeNo} |
取引内のデバンニング場所を取得します。 取引管理番号(***tradeNo***)を指定して、各帳票を通して登録された取引内のデバンニング場所を全て取得します。 |
|
| GET | /API/v2/Trades/GetEmptyContainerPickups/{tradeNo} |
取引内の空コンテナ搬出場所を取得します。 取引管理番号(***tradeNo***)を指定して、各帳票を通して登録された取引内の空コンテナ搬出場所を全て取得します。 |
|
| GET | /API/v2/Trades/GetEmptyContainerReturns/{tradeNo} |
取引内の空コンテナ返却場所を取得します。 取引管理番号(***tradeNo***)を指定して、各帳票を通して登録された取引内の空コンテナ返却場所を全て取得します。 |
|
| GET | /API/v2/Trades/GetExportContainers/{tradeNo} |
取引内の輸出で使用するコンテナを取得します。 取引管理番号(***tradeNo***)を指定して、取引内の輸出で使用するを全て取得します。 取引内に登録されたコンテナについて、以下の情報を取得します。 - コンテナ(基本情報) - 空コンテナ搬出場所 - バンニング場所 - 実入りコンテナ搬入場所 - 照合ステータス - コンテナ貨物搬入票の帳票ID ※作成されていて、かつ、アクセス権限があることが条件。 このAPIは、取引タイプが輸出(***Export***)の場合に有効であり、取引タイプが輸入の取引の場合、取得するコンテナは0件になります。 |
|
| GET | /API/v2/Trades/GetGoodsProfiles/{tradeNo} |
取引内の商品明細(要約)を取得します。 取引管理番号(***tradeNo***)を指定して、各帳票を通して登録された取引内の商品明細(要約)を全て取得します。 |
|
| GET | /API/v2/Trades/GetImportContainers/{tradeNo} |
取引内の輸入で使用するコンテナを取得します。 取引管理番号(***tradeNo***)を指定して、取引内の輸入で使用するを全て取得します。 取引内に登録されたコンテナについて、以下の情報を取得します。 - コンテナ(基本情報) - 実入りコンテナ搬出場所 - デバンニング場所 - 空コンテナ返却場所 このAPIは、取引タイプが輸入(***Import***)の場合に有効であり、取引タイプが輸出の取引の場合、取得するコンテナは0件になります。 |
|
| GET | /API/v2/Trades/GetLoadedContainerDeliveries/{tradeNo} |
取引内の実入りコンテナ搬入場所を取得します。 取引管理番号(***tradeNo***)を指定して、各帳票を通して登録された取引内の実入りコンテナ搬入場所を全て取得します。 |
|
| GET | /API/v2/Trades/GetLoadedContainerPickups/{tradeNo} |
取引内の実入りコンテナ搬出場所を取得します。 取引管理番号(***tradeNo***)を指定して、各帳票を通して登録された取引内の実入りコンテナ搬出場所を全て取得します。 |
|
| GET | /API/v2/Trades/GetNaccsAssignedNo/{tradeNo}/{naccsBusinessCode} |
取引内のNACCS採番番号を取得します。 取引管理番号(***tradeNo***)、NACCS業務コード(***naccsBusinessCode***)を指定して、NACCS採番番号を取得します。 |
|
| GET | /API/v2/Trades/GetResponseToReports/{tradeNo}/{newReportCode} |
取引内の応答となる帳票を取得します。 取引管理番号(***tradeNo***)と作成する帳票の帳票コード(***newReportCode***)指定して、応答となる帳票を全て取得します。 例えば、CFS搬出票の応答として、貨物輸送送り状を作成する場合、このAPIで応答となるCFS搬出票の帳票についての情報が取得できます。 |
|
| GET | /API/v2/Trades/GetVannings/{tradeNo} |
取引内のバンニング場所を取得します。 取引管理番号(***tradeNo***)を指定して、各帳票を通して登録された取引内のバンニング場所を全て取得します。 |
|
| GET | /API/v2/Trades/Search?tradeNo=!{tradeNo}&tradeType=!{tradeType}&tradeName=!{tradeName}&uniqueNo=!{uniqueNo}&parentTradeNo=!{parentTradeNo}&organizationIdAsOwner=!{organizationIdAsOwner}&organizationIdAsPartnerList=!{organizationIdAsPartnerList}&tradeStatus=!{tradeStatus}&createdAtFrom=!{createdAtFrom}&createdAtTo=!{createdAtTo}&createdAtRange=!{createdAtRange}&createdAtRangeUnit=!{createdAtRangeUnit}&updatedAtFrom=!{updatedAtFrom}&updatedAtTo=!{updatedAtTo}&updatedAtRange=!{updatedAtRange}&updatedAtRangeUnit=!{updatedAtRangeUnit}&bookingNo=!{bookingNo}&scacCode=!{scacCode}&callsign=!{callsign}&vesselName=!{vesselName}&voyageNo=!{voyageNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo}&keyword=!{keyword}&cyOpenAtFrom=!{cyOpenAtFrom}&cyOpenAtTo=!{cyOpenAtTo}&cyOpenAtRange=!{cyOpenAtRange}&cyOpenAtRangeUnit=!{cyOpenAtRangeUnit}&cyCutAtFrom=!{cyCutAtFrom}&cyCutAtTo=!{cyCutAtTo}&cyCutAtRange=!{cyCutAtRange}&cyCutAtRangeUnit=!{cyCutAtRangeUnit}&cfsCutAtFrom=!{cfsCutAtFrom}&cfsCutAtTo=!{cfsCutAtTo}&cfsCutAtRange=!{cfsCutAtRange}&cfsCutAtRangeUnit=!{cfsCutAtRangeUnit}&portOfLoadingCode=!{portOfLoadingCode}&portOfLoadingEtaFrom=!{portOfLoadingEtaFrom}&portOfLoadingEtaTo=!{portOfLoadingEtaTo}&portOfLoadingEtaRange=!{portOfLoadingEtaRange}&portOfLoadingEtaRangeUnit=!{portOfLoadingEtaRangeUnit}&portOfLoadingEtdFrom=!{portOfLoadingEtdFrom}&portOfLoadingEtdTo=!{portOfLoadingEtdTo}&portOfLoadingEtdRange=!{portOfLoadingEtdRange}&portOfLoadingEtdRangeUnit=!{portOfLoadingEtdRangeUnit}&portOfDischargeCode=!{portOfDischargeCode}&portOfDischargeEtaFrom=!{portOfDischargeEtaFrom}&portOfDischargeEtaTo=!{portOfDischargeEtaTo}&portOfDischargeEtaRange=!{portOfDischargeEtaRange}&portOfDischargeEtaRangeUnit=!{portOfDischargeEtaRangeUnit}&portOfDischargeEtdFrom=!{portOfDischargeEtdFrom}&portOfDischargeEtdTo=!{portOfDischargeEtdTo}&portOfDischargeEtdRange=!{portOfDischargeEtdRange}&portOfDischargeEtdRangeUnit=!{portOfDischargeEtdRangeUnit} |
取引を全て取得します。 検索条件に該当する、利用者が所属する組織が参加している取引を全て取得します。 取引に関する詳細については、[取引について]()を参照ください。 |
|
| GET | /API/v2/Trades/SearchByShortcut/{searchShortcutId} |
検索ショートカットを指定して、取引を取得します。 検索ショートカットID(***searchShortcutId***)を指定して、ショートカットとして保存した検索条件に該当する、利用者が所属する組織が参加している取引を全て取得します。 取引に関する詳細については、[取引について]()を参照ください。 |
|
| PATCH | /API/v2/Trades/SetOwner/{tradeNo} |
取引のオーナーを設定します。 取引管理番号(***tradeNo***)を指定して、取引のオーナーを設定、変更します。 オーナーを設定、変更をするには、その取引に利用者が所属する組織が参加しており、かつ、その組織が取引のオーナーである必要があります。 取引に関する詳細については、[取引について]()を参照ください。 |
|
| PATCH | /API/v2/Trades/SetParent/{tradeNo} |
親となる取引を設定します。 取引管理番号(***tradeNo***)を指定して、親となる取引を設定、変更します。 親となる取引を設定、変更をするには、その取引に利用者が所属する組織が参加しており、かつ、親となる取引についても同様に、その取引に利用者が所属する組織が参加している必要があります。 取引に関する詳細については、[取引について]()を参照ください。 |
|
| PATCH | /API/v2/Trades/SetStatus/{tradeNo} |
取引のステータスを設定します。 取引管理番号(***tradeNo***)を指定して、取引のステータスを設定、変更します。 取引のステータスを設定、変更をするには、その取引に利用者が所属する組織が参加しており、かつ、その組織が取引のオーナーである必要があります。 取引に関する詳細については、[取引について]()を参照ください。 |
|
| PATCH | /API/v2/Trades/SetTradeName/{tradeNo} |
取引名を設定します。 取引管理番号(***tradeNo***)を指定して、取引名を設定、変更します。 取引名を設定、変更をするには、その取引に利用者が所属する組織が参加しており、かつ、その組織が取引のオーナーである必要があります。 取引に関する詳細については、[取引について]()を参照ください。 |
|
| PATCH | /API/v2/Trades/SetUniqueNo/{tradeNo} |
取引に社内管理番号を設定します。 取引管理番号(***tradeNo***)を指定して、取引に社内管理番号を設定、変更します。 社内管理番号(***uniqueNo***)は、取引管理番号の別名として機能します。社内管理番号は取引に参加している組織・事業種別毎に附番できるので、各組織で任意の文字列による取引の特定が可能になります。 社内管理番号(***uniqueNo***)を設定、変更をするには、その取引に利用者が所属する組織がパートナーとして参加している必要があります。 取引に関する詳細については、[取引について]()を参照ください。 |
|
TradeWaltzDeliveryInstructionHistories
TradeWaltz輸入荷捌依頼データ照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/TradeWaltzDeliveryInstructionHistories/Create |
TradeWaltz輸入荷捌依頼データ照会を作成します。 TradeWaltz輸入荷捌依頼データ照会を作成するには、利用者がTradeWaltz輸入荷捌依頼データ照会を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 TradeWaltz輸入荷捌依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/TradeWaltzDeliveryInstructionHistories/Delete/{reportId} |
TradeWaltz輸入荷捌依頼データ照会を削除します。 帳票ID(***reportId***)を指定して、TradeWaltz輸入荷捌依頼データ照会を削除します。 TradeWaltz輸入荷捌依頼データ照会を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したTradeWaltz輸入荷捌依頼データ照会のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 TradeWaltz輸入荷捌依頼データ照会に関する詳細については、[TradeWaltz輸入荷捌依頼データ照会について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/TradeWaltzDeliveryInstructionHistories/DeleteFile/{fileId} |
TradeWaltz輸入荷捌依頼データ照会の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、TradeWaltz輸入荷捌依頼データ照会の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/TradeWaltzDeliveryInstructionHistories/Get/{reportId}?historyId=!{historyId} |
TradeWaltz輸入荷捌依頼データ照会を取得します。 帳票ID(***reportId***)を指定して、TradeWaltz輸入荷捌依頼データ照会を取得します。 編集が行われていない場合は、ルートドキュメントから最新のTradeWaltz輸入荷捌依頼データ照会を取得します。 編集中の場合は、先に保存した、TradeWaltz輸入荷捌依頼データ照会を取得します。 TradeWaltz輸入荷捌依頼データ照会に関する詳細については、[TradeWaltz輸入荷捌依頼データ照会について]()を参照ください。 |
|
| GET | /API/v2/Reports/TradeWaltzDeliveryInstructionHistories/GetDiff/{reportId}?historyId=!{historyId} |
保存されているTradeWaltz輸入荷捌依頼データ照会とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当するTradeWaltz輸入荷捌依頼データ照会と、ルートドキュメントの差分を取得します。 比較元を保存されているTradeWaltz輸入荷捌依頼データ照会、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/TradeWaltzDeliveryInstructionHistories/GetFile/{fileId} |
TradeWaltz輸入荷捌依頼データ照会に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、TradeWaltz輸入荷捌依頼データ照会に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/TradeWaltzDeliveryInstructionHistories/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
TradeWaltz輸入荷捌依頼データ照会を全て取得します。 検索条件に該当するTradeWaltz輸入荷捌依頼データ照会を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のTradeWaltz輸入荷捌依頼データ照会を取得します。 編集中の場合は、先に保存した、TradeWaltz輸入荷捌依頼データ照会を取得します。 TradeWaltz輸入荷捌依頼データ照会に関する詳細については、[TradeWaltz輸入荷捌依頼データ照会について]()を参照ください。 |
|
| GET | /API/v2/Reports/TradeWaltzDeliveryInstructionHistories/GetTradeWaltzAttachFile?reportId=!{reportId}&linkageSeq=!{linkageSeq}&documentManageId=!{documentManageId} |
TradeWaltzから添付ファイルを取得します。 連携SEQ(***linkageSeq***)とTradeWaltz帳票管理ID(***documentManageId***)を指定して、TradeWaltzから添付ファイルを取得します。 添付ファイルを獲得できるパートナーは、履歴帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 TradeWaltzから添付ファイルを取得するためには、所属する組織がTradeWaltz連携ユーザー(***/API/v2/Organizations/TradeWaltzLinkageUsers***)にて、有効な連携ユーザーID(***linkageUserId***)、連携パスワード(***linkagePassword***)が設定されている必要があります。 |
|
| PATCH | /API/v2/Reports/TradeWaltzDeliveryInstructionHistories/Lock/{reportId} |
編集するため、TradeWaltz輸入荷捌依頼データ照会をロックします 帳票ID(***reportId***)を指定して、TradeWaltz輸入荷捌依頼データ照会をロックします。 TradeWaltz輸入荷捌依頼データ照会を作成(***Create***)した時点では、TradeWaltz輸入荷捌依頼データ照会をロックが掛かりますが、取得(***Get***)したあとで、TradeWaltz輸入荷捌依頼データ照会を編集する場合は、このメソッドを呼び出して、TradeWaltz輸入荷捌依頼データ照会をロックします。 ロックされたTradeWaltz輸入荷捌依頼データ照会は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、TradeWaltz輸入荷捌依頼データ照会をルートドキュメントから参照できますが、編集中(ロック中)の船腹予約確認書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 TradeWaltz輸入荷捌依頼データ照会に関する詳細については、[TradeWaltz輸入荷捌依頼データ照会について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/TradeWaltzDeliveryInstructionHistories/SetCancel/{reportId} |
TradeWaltz輸入荷捌依頼データ照会の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、TradeWaltz輸入荷捌依頼データ照会の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 TradeWaltz輸入荷捌依頼データ照会に関する詳細については、[TradeWaltz輸入荷捌依頼データ照会について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/TradeWaltzDeliveryInstructionHistories/Submit/{reportId} |
TradeWaltz輸入荷捌依頼データ照会を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したTradeWaltz輸入荷捌依頼データ照会を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、TradeWaltz輸入荷捌依頼データ照会が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、TradeWaltz輸入荷捌依頼データ照会もロックされた状態のままなので、ご注意ください。 TradeWaltz輸入荷捌依頼データ照会に関する詳細については、[TradeWaltz輸入荷捌依頼データ照会について]()を参照ください。 |
|
| POST | /API/v2/Reports/TradeWaltzDeliveryInstructionHistories/SubmitByPost |
TradeWaltz輸入荷捌依頼データ照会を提出します 動作は、TradeWaltz輸入荷捌依頼データ照会の提出(***/API/v2/Reports/TradeWaltzDeliveryInstructionHistories/Submit***)と同様です。 TradeWaltz輸入荷捌依頼データ照会に関する詳細については、[TradeWaltz輸入荷捌依頼データ照会について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/TradeWaltzDeliveryInstructionHistories/Unlock/{reportId} |
TradeWaltz輸入荷捌依頼データ照会のロックを解除します 帳票ID(***reportId***)を指定して、TradeWaltz輸入荷捌依頼データ照会のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 TradeWaltz輸入荷捌依頼データ照会に関する詳細については、[TradeWaltz輸入荷捌依頼データ照会について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/TradeWaltzDeliveryInstructionHistories/Update/{reportId} |
TradeWaltz輸入荷捌依頼データ照会を更新します。 帳票ID(***reportId***)を指定して、TradeWaltz輸入荷捌依頼データ照会を更新します。 このメソッドでは、TradeWaltz輸入荷捌依頼データ照会の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 TradeWaltz輸入荷捌依頼データ照会に関する詳細については、[TradeWaltz輸入荷捌依頼データ照会について]()を参照ください。 |
|
| POST | /API/v2/Reports/TradeWaltzDeliveryInstructionHistories/UpdateByPost |
TradeWaltz輸入荷捌依頼データ照会を更新します。 動作は、TradeWaltz輸入荷捌依頼データ照会の更新(***/API/v2/Reports/TradeWaltzDeliveryInstructionHistories/Update***)と同様です。 TradeWaltz輸入荷捌依頼データ照会に関する詳細については、[TradeWaltz輸入荷捌依頼データ照会について]()を参照ください。 |
|
| POST | /API/v2/Reports/TradeWaltzDeliveryInstructionHistories/UploadFile |
TradeWaltz輸入荷捌依頼データ照会にファイルを添付します。 指定されたTradeWaltz輸入荷捌依頼データ照会に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
TradeWaltzShippingInstructionHistories
TradeWaltz輸出船積依頼データ照会
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/TradeWaltzShippingInstructionHistories/Create |
TradeWaltz輸出船積依頼データ照会を作成します。 TradeWaltz輸出船積依頼データ照会を作成するには、利用者がTradeWaltz輸出船積依頼データ照会を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/TradeWaltzShippingInstructionHistories/Delete/{reportId} |
TradeWaltz輸出船積依頼データ照会を削除します。 帳票ID(***reportId***)を指定して、TradeWaltz輸出船積依頼データ照会を削除します。 TradeWaltz輸出船積依頼データ照会を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したTradeWaltz輸出船積依頼データ照会のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/TradeWaltzShippingInstructionHistories/DeleteFile/{fileId} |
TradeWaltz輸出船積依頼データ照会の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、TradeWaltz輸出船積依頼データ照会の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/TradeWaltzShippingInstructionHistories/Get/{reportId}?historyId=!{historyId} |
TradeWaltz輸出船積依頼データ照会を取得します。 帳票ID(***reportId***)を指定して、TradeWaltz輸出船積依頼データ照会を取得します。 編集が行われていない場合は、ルートドキュメントから最新のTradeWaltz輸出船積依頼データ照会を取得します。 編集中の場合は、先に保存した、TradeWaltz輸出船積依頼データ照会を取得します。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。 |
|
| GET | /API/v2/Reports/TradeWaltzShippingInstructionHistories/GetDiff/{reportId}?historyId=!{historyId} |
保存されているTradeWaltz輸出船積依頼データ照会とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当するTradeWaltz輸出船積依頼データ照会と、ルートドキュメントの差分を取得します。 比較元を保存されているTradeWaltz輸出船積依頼データ照会、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/TradeWaltzShippingInstructionHistories/GetFile/{fileId} |
TradeWaltz輸出船積依頼データ照会に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、TradeWaltz輸出船積依頼データ照会に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/TradeWaltzShippingInstructionHistories/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
TradeWaltz輸出船積依頼データ照会を全て取得します。 検索条件に該当するTradeWaltz輸出船積依頼データ照会を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のTradeWaltz輸出船積依頼データ照会を取得します。 編集中の場合は、先に保存した、TradeWaltz輸出船積依頼データ照会を取得します。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。 |
|
| GET | /API/v2/Reports/TradeWaltzShippingInstructionHistories/GetTradeWaltzAttachFile?reportId=!{reportId}&linkageSeq=!{linkageSeq}&documentManageId=!{documentManageId} |
TradeWaltzから添付ファイルを取得します。 連携SEQ(***linkageSeq***)とTradeWaltz帳票管理ID(***documentManageId***)を指定して、TradeWaltzから添付ファイルを取得します。 添付ファイルを獲得できるパートナーは、履歴帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 TradeWaltzから添付ファイルを取得するためには、所属する組織がTradeWaltz連携ユーザー(***/API/v2/Organizations/TradeWaltzLinkageUsers***)にて、有効な連携ユーザーID(***linkageUserId***)、連携パスワード(***linkagePassword***)が設定されている必要があります。 |
|
| PATCH | /API/v2/Reports/TradeWaltzShippingInstructionHistories/Lock/{reportId} |
編集するため、TradeWaltz輸出船積依頼データ照会をロックします 帳票ID(***reportId***)を指定して、TradeWaltz輸出船積依頼データ照会をロックします。 TradeWaltz輸出船積依頼データ照会を作成(***Create***)した時点では、TradeWaltz輸出船積依頼データ照会をロックが掛かりますが、取得(***Get***)したあとで、TradeWaltz輸出船積依頼データ照会を編集する場合は、このメソッドを呼び出して、TradeWaltz輸出船積依頼データ照会をロックします。 ロックされたTradeWaltz輸出船積依頼データ照会は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、TradeWaltz輸出船積依頼データ照会をルートドキュメントから参照できますが、編集中(ロック中)の船腹予約確認書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/TradeWaltzShippingInstructionHistories/SetCancel/{reportId} |
TradeWaltz輸出船積依頼データ照会の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、TradeWaltz輸出船積依頼データ照会の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/TradeWaltzShippingInstructionHistories/Submit/{reportId} |
TradeWaltz輸出船積依頼データ照会を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したTradeWaltz輸出船積依頼データ照会を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、TradeWaltz輸出船積依頼データ照会が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、TradeWaltz輸出船積依頼データ照会もロックされた状態のままなので、ご注意ください。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。 |
|
| POST | /API/v2/Reports/TradeWaltzShippingInstructionHistories/SubmitByPost |
TradeWaltz輸出船積依頼データ照会を提出します 動作は、TradeWaltz輸出船積依頼データ照会の提出(***/API/v2/Reports/TradeWaltzShippingInstructionHistories/Submit***)と同様です。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/TradeWaltzShippingInstructionHistories/Unlock/{reportId} |
TradeWaltz輸出船積依頼データ照会のロックを解除します 帳票ID(***reportId***)を指定して、TradeWaltz輸出船積依頼データ照会のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/TradeWaltzShippingInstructionHistories/Update/{reportId} |
TradeWaltz輸出船積依頼データ照会を更新します。 帳票ID(***reportId***)を指定して、TradeWaltz輸出船積依頼データ照会を更新します。 このメソッドでは、TradeWaltz輸出船積依頼データ照会の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。 |
|
| POST | /API/v2/Reports/TradeWaltzShippingInstructionHistories/UpdateByPost |
TradeWaltz輸出船積依頼データ照会を更新します。 動作は、TradeWaltz輸出船積依頼データ照会の更新(***/API/v2/Reports/TradeWaltzShippingInstructionHistories/Update***)と同様です。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。 |
|
| POST | /API/v2/Reports/TradeWaltzShippingInstructionHistories/UploadFile |
TradeWaltz輸出船積依頼データ照会にファイルを添付します。 指定されたTradeWaltz輸出船積依頼データ照会に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
UnEdifactCodes
UN/EDIFACTコード
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/General/UnEdifactCodes/DeleteAdmin/{unEdifactPKCode} |
UN/EDIFACTコードを削除します。 UN/EDIFACTPKコード(***unEdifactPKCode***)を指定して、UN/EDIFACTコードを削除します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| GET | /API/v2/General/UnEdifactCodes/Get/{unEdifactPKCode} |
UN/EDIFACTコードを取得します。 UN/EDIFACTPKコード(***unEdifactPKCode***)を指定して、UN/EDIFACTコード種別を取得します。 UN/EDIFACTコードに関する詳細については、[UN/EDIFACTコードについて]()を参照ください。 |
|
| GET | /API/v2/General/UnEdifactCodes/GetList |
UN/EDIFACTコード種別を全て取得します。 UN/EDIFACTコードに関する詳細については、UN/EDIFACTコードについて]()を参照ください。 |
|
| GET | /API/v2/General/UnEdifactCodes/GetListByUnEdifactCode/{unEdifactCode} |
UN/EDIFACTコードを取得します。 UN/EDIFACTコード(***unEdifactCode***)を指定して、UN/EDIFACTコード種別を取得します。 UN/EDIFACTコードに関する詳細については、[UN/EDIFACTコードについて]()を参照ください。 |
|
| POST | /API/v2/General/UnEdifactCodes/RegisterAdmin |
UN/EDIFACTコードを登録します。 このメソッドはシステム管理者が利用できます。 (*For admin) |
|
| POST | /API/v2/General/UnEdifactCodes/RegisterInternal |
UN/EDIFACTコードを登録します。 内部呼び出し用。 (*For admin) |
|
UnLoCodes
国連LOCODE
UsageStatistics
会社の利用状況の統計
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/Companies/UsageStatistics/Get/{periodCode} |
会社の利用状況の統計を取得します。 徴収期間コードを指定してログインしている利用者が所属する会社の取引利用状況の統計を取得します。 取引利用状況の統計は、対象期間内の各月について、以下の情報を保持しています。 - NACCS取引外照会の実行数 - その月に初めてアクセスした取引数 - 利用料金 - 利用料金発生の理由 なお、当月の取引利用状況について、NACCS取引外照会の実行数とその月に初めてアクセスした取引数は前日分までの累計、利用料金については取得不可(翌月になってから取得可能)となります。 |
|
| GET | /API/v2/Companies/UsageStatistics/GetTradeFirstAccesses/{targetMonth} |
会社の取引初回アクセス一覧を取得します。 対象月(YYYYMM)を指定してログインしている利用者が所属する会社の取引初回アクセス情報を取得します。 取引初回アクセス情報は、対象月について、以下の情報を保持しています。 - 取引管理番号 - その取引に初めてアクセスした日付 |
|
UsedWebhooks
組織のWebhook設定
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Organizations/UsedWebhooks/Delete/{usedWebhookId} |
組織からWebhook設定を削除します。 組織のWebhook設定ID(***usedWebhookId***)を指定して、組織からWebhook設定を削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。 |
|
| GET | /API/v2/Organizations/UsedWebhooks/Get/{usedWebhookId} |
組織で使用するWebhook設定を取得します。 組織のWebhook設定ID(***usedWebhookId***)を指定して、組織に使用するWebhook設定を取得します。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。 |
|
| GET | /API/v2/Organizations/UsedWebhooks/GetList?webhookId=!{webhookId}&webhookName=!{webhookName}&organizationId=!{organizationId} |
組織に使用するWebhook設定を全て取得します。 組織ID(***organizationId***)を指定して、組織に使用するWebhook設定を全て取得します。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。 |
|
| POST | /API/v2/Organizations/UsedWebhooks/Register |
組織で使用するWebhook設定を登録します。 管理者が所属する会社の組織に、Webhook設定を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。 |
|
UseNaccsUsers
利用者が使用するNACCS利用者
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Employees/UseNaccsUsers/Delete/{useNaccsUserId} |
利用者が使用するNACCS利用者を削除します。 利用者が使用するNACCS利用者ID(***useNaccsUserId***)を指定して、ログインしている利用者が使用するNACCS利用者を削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
| GET | /API/v2/Employees/UseNaccsUsers/Get/{useNaccsUserId} |
利用者が使用するNACCS利用者を取得します。 利用者が使用するNACCS利用者ID(***useNaccsUserId***)を指定して、ログインしている利用者が使用するNACCS利用者を取得します。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
| GET | /API/v2/Employees/UseNaccsUsers/GetList |
自社に登録されている利用者が使用するNACCS利用者を取得します。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
| GET | /API/v2/Employees/UseNaccsUsers/GetMyNaccsUser |
自身のNACCS利用者を取得します。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
| POST | /API/v2/Employees/UseNaccsUsers/Register |
利用者が使用するNACCS利用者を登録します。 管理者が所属する会社の利用者が使用するNACCS利用者を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 NACCS 利用者に関する詳細については、[NACCS 利用者について]()を参照ください。 |
|
VanningCancellations
VAC_バンニング情報取消し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/VanningCancellations/Create |
VACを作成します。 VACを作成するには、利用者がVACを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/VanningCancellations/Delete/{reportId} |
VACを削除します。 帳票ID(***reportId***)を指定して、、VACを削除します。 VACを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/VanningCancellations/DeleteFile/{fileId} |
VACの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、VACの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/VanningCancellations/Get/{reportId} |
VACを取得します。 帳票ID(***reportId***)を指定して、VAC取得します。 編集が行われていない場合は、ルートドキュメントから最新のVACを取得します。 編集中の場合は、先に保存した、VACを取得します。 |
|
| GET | /API/v2/NaccsReports/VanningCancellations/GetFile/{fileId} |
VACに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、VACに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/VanningCancellations/Lock/{reportId} |
編集するため、VACをロックします。 帳票ID(***reportId***)を指定して、VACをロックします。 VACを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、VACを編集する場合は、このメソッドを呼び出してロックします。 ロックされたVACは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、VACをルートドキュメントから参照できますが、編集中(ロック中)のVACは参照できません。 |
|
| POST | /API/v2/NaccsReports/VanningCancellations/SendToNaccs |
VACをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したVACをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、VACが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/VanningCancellations/SetCancel/{reportId} |
VACの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、VACの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/VanningCancellations/Submit/{reportId} |
VACを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したVACを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、VACが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/VanningCancellations/SubmitByPost |
VACを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/VanningCancellations/Unlock/{reportId} |
VACのロックを解除します。 帳票ID(***reportId***)を指定して、VACのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/VanningCancellations/Update/{reportId} |
VACを更新します。 帳票ID(***reportId***)を指定して、VACを更新します。 このメソッドでは、VACの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/VanningCancellations/UpdateByPost |
VACを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/VanningCancellations/UploadFile |
VACにファイルを添付します。 指定されたVACに、ファイルを添付します。 |
|
VanningCyDeliveryConfirmationCalls
VAH11_バンニング・CY搬入情報登録呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/VanningCyDeliveryConfirmationCalls/Create |
VAH11を作成します。 VAH11を作成するには、利用者がVAH11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/VanningCyDeliveryConfirmationCalls/Delete/{reportId} |
VAH11を削除します。 帳票ID(***reportId***)を指定して、、VAH11を削除します。 VAH11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/VanningCyDeliveryConfirmationCalls/DeleteFile/{fileId} |
VAH11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、VAH11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/VanningCyDeliveryConfirmationCalls/Get/{reportId} |
VAH11を取得します。 帳票ID(***reportId***)を指定して、VAH11取得します。 編集が行われていない場合は、ルートドキュメントから最新のVAH11を取得します。 編集中の場合は、先に保存した、VAH11を取得します。 |
|
| GET | /API/v2/NaccsReports/VanningCyDeliveryConfirmationCalls/GetFile/{fileId} |
VAH11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、VAH11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/VanningCyDeliveryConfirmationCalls/Lock/{reportId} |
編集するため、VAH11をロックします。 帳票ID(***reportId***)を指定して、VAH11をロックします。 VAH11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、VAH11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたVAH11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、VAH11をルートドキュメントから参照できますが、編集中(ロック中)のVAH11は参照できません。 |
|
| POST | /API/v2/NaccsReports/VanningCyDeliveryConfirmationCalls/SendToNaccs |
VAH11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したVAH11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、VAH11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/VanningCyDeliveryConfirmationCalls/SetCancel/{reportId} |
VAH11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、VAH11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/VanningCyDeliveryConfirmationCalls/Submit/{reportId} |
VAH11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したVAH11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、VAH11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/VanningCyDeliveryConfirmationCalls/SubmitByPost |
VAH11を提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/VanningCyDeliveryConfirmationCalls/Unlock/{reportId} |
VAH11のロックを解除します。 帳票ID(***reportId***)を指定して、VAH11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/VanningCyDeliveryConfirmationCalls/Update/{reportId} |
VAH11を更新します。 帳票ID(***reportId***)を指定して、VAH11を更新します。 このメソッドでは、VAH11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/VanningCyDeliveryConfirmationCalls/UpdateByPost |
VAH11を更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/VanningCyDeliveryConfirmationCalls/UploadFile |
VAH11にファイルを添付します。 指定されたVAH11に、ファイルを添付します。 |
|
VanningCyDeliveryConfirmations
VAH_バンニング・CY搬入情報登録
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/VanningCyDeliveryConfirmations/Create |
VAHを作成します。 VAHを作成するには、利用者がVAHを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/VanningCyDeliveryConfirmations/Delete/{reportId} |
VAHを削除します。 帳票ID(***reportId***)を指定して、、VAHを削除します。 VAHを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/VanningCyDeliveryConfirmations/DeleteFile/{fileId} |
VAHの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、VAHの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/VanningCyDeliveryConfirmations/Get/{reportId} |
VAHを取得します。 帳票ID(***reportId***)を指定して、VAH取得します。 編集が行われていない場合は、ルートドキュメントから最新のVAHを取得します。 編集中の場合は、先に保存した、VAHを取得します。 |
|
| GET | /API/v2/NaccsReports/VanningCyDeliveryConfirmations/GetFile/{fileId} |
VAHに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、VAHに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/VanningCyDeliveryConfirmations/Lock/{reportId} |
編集するため、VAHをロックします。 帳票ID(***reportId***)を指定して、VAHをロックします。 VAHを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、VAHを編集する場合は、このメソッドを呼び出してロックします。 ロックされたVAHは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、VAHをルートドキュメントから参照できますが、編集中(ロック中)のVAHは参照できません。 |
|
| POST | /API/v2/NaccsReports/VanningCyDeliveryConfirmations/SendToNaccs |
VAHをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したVAHをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、VAHが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/VanningCyDeliveryConfirmations/SetCancel/{reportId} |
VAHの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、VAHの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/VanningCyDeliveryConfirmations/Submit/{reportId} |
VAHを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したVAHを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、VAHが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/VanningCyDeliveryConfirmations/SubmitByPost |
VAHを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/VanningCyDeliveryConfirmations/Unlock/{reportId} |
VAHのロックを解除します。 帳票ID(***reportId***)を指定して、VAHのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/VanningCyDeliveryConfirmations/Update/{reportId} |
VAHを更新します。 帳票ID(***reportId***)を指定して、VAHを更新します。 このメソッドでは、VAHの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/VanningCyDeliveryConfirmations/UpdateByPost |
VAHを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/VanningCyDeliveryConfirmations/UploadFile |
VAHにファイルを添付します。 指定されたVAHに、ファイルを添付します。 |
|
VanningInstructions
バンニング作業依頼書
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/VanningInstructions/Create |
バンニング作業依頼書を作成します。 バンニング作業依頼書を作成するには、利用者がバンニング作業依頼書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/VanningInstructions/Delete/{reportId} |
バンニング作業依頼書を削除します。 帳票ID(***reportId***)を指定して、バンニング作業依頼書を削除します。 バンニング作業依頼書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したバンニング作業依頼書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/VanningInstructions/DeleteFile/{fileId} |
バンニング作業依頼書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、バンニング作業依頼書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/VanningInstructions/Get/{reportId}?historyId=!{historyId} |
バンニング作業依頼書を取得します。 帳票ID(***reportId***)を指定して、バンニング作業依頼書を取得します。 編集が行われていない場合は、ルートドキュメントから最新のバンニング作業依頼書を取得します。 編集中の場合は、先に保存した、バンニング作業依頼書を取得します。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書について]()を参照ください。 |
|
| GET | /API/v2/Reports/VanningInstructions/GetDiff/{reportId}?historyId=!{historyId} |
保存されているバンニング作業依頼書とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当するバンニング作業依頼書と、ルートドキュメントの差分を取得します。 比較元を保存されているバンニング作業依頼書、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/VanningInstructions/GetFile/{fileId} |
バンニング作業依頼書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、バンニング作業依頼書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/VanningInstructions/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
バンニング作業依頼書を全て取得します。 検索条件に該当するバンニング作業依頼書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のバンニング作業依頼書を取得します。 編集中の場合は、先に保存した、バンニング作業依頼書を取得します。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/VanningInstructions/Lock/{reportId} |
編集するため、バンニング作業依頼書をロックします 帳票ID(***reportId***)を指定して、バンニング作業依頼書をロックします。 バンニング作業依頼書を作成(***Create***)した時点では、バンニング作業依頼書をロックが掛かりますが、取得(***Get***)したあとで、バンニング作業依頼書を編集する場合は、このメソッドを呼び出して、バンニング作業依頼書をロックします。 ロックされたバンニング作業依頼書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、バンニング作業依頼書をルートドキュメントから参照できますが、編集中(ロック中)のバンニング作業依頼書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/VanningInstructions/SetCancel/{reportId} |
バンニング作業依頼書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、バンニング作業依頼書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/VanningInstructions/Submit/{reportId} |
バンニング作業依頼書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したバンニング作業依頼書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、バンニング作業依頼書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、バンニング作業依頼書もロックされた状態のままなので、ご注意ください。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書について]()を参照ください。 |
|
| POST | /API/v2/Reports/VanningInstructions/SubmitByPost |
バンニング作業依頼書を提出します。 動作は、バンニング作業依頼書(***/API/v2/Reports/VanningInstructions/Submit***)と同様です。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書]()を参照ください。 |
|
| PATCH | /API/v2/Reports/VanningInstructions/Unlock/{reportId} |
バンニング作業依頼書のロックを解除します 帳票ID(***reportId***)を指定して、バンニング作業依頼書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/VanningInstructions/Update/{reportId} |
バンニング作業依頼書を更新します。 帳票ID(***reportId***)を指定して、バンニング作業依頼書を更新します。 このメソッドでは、バンニング作業依頼書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書について]()を参照ください。 |
|
| POST | /API/v2/Reports/VanningInstructions/UpdateByPost |
バンニング作業依頼書を更新します。 動作は、バンニング作業依頼書(***/API/v2/Reports/VanningInstructions/Update***)と同様です。 バンニング作業依頼書に関する詳細については、[バンニング作業依頼書]()を参照ください。 |
|
| POST | /API/v2/Reports/VanningInstructions/UploadFile |
バンニング作業依頼書にファイルを添付します。 指定されたバンニング作業依頼書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
VanningRegistrationContainerUnitCalls
VAN11_バンニング情報登録(コンテナ単位)呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/VanningRegistrationContainerUnitCalls/Create |
VAN11を作成します。 VAN11を作成するには、利用者がVAN11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/VanningRegistrationContainerUnitCalls/Delete/{reportId} |
VAN11を削除します。 帳票ID(***reportId***)を指定して、、VAN11を削除します。 VAN11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/VanningRegistrationContainerUnitCalls/DeleteFile/{fileId} |
VAN11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、VAN11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/VanningRegistrationContainerUnitCalls/Get/{reportId} |
VAN11を取得します。 帳票ID(***reportId***)を指定して、VAN11取得します。 編集が行われていない場合は、ルートドキュメントから最新のVAN11を取得します。 編集中の場合は、先に保存した、VAN11を取得します。 |
|
| GET | /API/v2/NaccsReports/VanningRegistrationContainerUnitCalls/GetFile/{fileId} |
VAN11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、VAN11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationContainerUnitCalls/Lock/{reportId} |
編集するため、VAN11をロックします。 帳票ID(***reportId***)を指定して、VAN11をロックします。 VAN11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、VAN11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたVAN11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、VAN11をルートドキュメントから参照できますが、編集中(ロック中)のVAN11は参照できません。 |
|
| POST | /API/v2/NaccsReports/VanningRegistrationContainerUnitCalls/SendToNaccs |
VAN11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したVAN11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、VAN11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationContainerUnitCalls/SetCancel/{reportId} |
VAN11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、VAN11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationContainerUnitCalls/Submit/{reportId} |
VAN11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したVAN11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、VAN11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationContainerUnitCalls/Unlock/{reportId} |
VAN11のロックを解除します。 帳票ID(***reportId***)を指定して、VAN11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationContainerUnitCalls/Update/{reportId} |
VAN11を更新します。 帳票ID(***reportId***)を指定して、VAN11を更新します。 このメソッドでは、VAN11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/VanningRegistrationContainerUnitCalls/UploadFile |
VAN11にファイルを添付します。 指定されたVAN11に、ファイルを添付します。 |
|
VanningRegistrationContainerUnits
VAN_バンニング情報登録(コンテナ単位)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/VanningRegistrationContainerUnits/Create |
VANを作成します。 VANを作成するには、利用者がVANを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/VanningRegistrationContainerUnits/Delete/{reportId} |
VANを削除します。 帳票ID(***reportId***)を指定して、、VANを削除します。 VANを削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したVANのキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 |
|
| DELETE | /API/v2/NaccsReports/VanningRegistrationContainerUnits/DeleteFile/{fileId} |
VANの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、VANの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/VanningRegistrationContainerUnits/Get/{reportId} |
VANを取得します。 帳票ID(***reportId***)を指定して、VAN取得します。 編集が行われていない場合は、ルートドキュメントから最新のVANを取得します。 編集中の場合は、先に保存した、VANを取得します。 |
|
| GET | /API/v2/NaccsReports/VanningRegistrationContainerUnits/GetFile/{fileId} |
VANに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、VANに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationContainerUnits/Lock/{reportId} |
編集するため、VANをロックします。 帳票ID(***reportId***)を指定して、VANをロックします。 VANを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、VANを編集する場合は、このメソッドを呼び出してロックします。 ロックされたVANは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、VANをルートドキュメントから参照できますが、編集中(ロック中)のVANは参照できません。 |
|
| POST | /API/v2/NaccsReports/VanningRegistrationContainerUnits/SendToNaccs |
VANをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したVANをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、VANが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationContainerUnits/SetCancel/{reportId} |
VANの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、VANの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationContainerUnits/Submit/{reportId} |
帳票ID(***reportId***)を指定して、更新(***Update***)したVANを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、VANが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/VanningRegistrationContainerUnits/SubmitByPost |
VANを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationContainerUnits/Unlock/{reportId} |
VANのロックを解除します。 帳票ID(***reportId***)を指定して、VANのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationContainerUnits/Update/{reportId} |
VANを更新します。 帳票ID(***reportId***)を指定して、VANを更新します。 このメソッドでは、VANの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/VanningRegistrationContainerUnits/UpdateByPost |
VANを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/VanningRegistrationContainerUnits/UploadFile |
VANにファイルを添付します。 指定されたVANに、ファイルを添付します。 |
|
VanningRegistrationExportNoUnitCalls
VAE11_バンニング情報登録(輸出管理番号単位)呼出し
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/VanningRegistrationExportNoUnitCalls/Create |
VAE11を作成します。 VAE11を作成するには、利用者がVAE11を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/VanningRegistrationExportNoUnitCalls/Delete/{reportId} |
VAE11を削除します。 帳票ID(***reportId***)を指定して、、VAE11を削除します。 VAE11を削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/VanningRegistrationExportNoUnitCalls/DeleteFile/{fileId} |
VAE11の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、VAE11の添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/VanningRegistrationExportNoUnitCalls/Get/{reportId} |
VAE11を取得します。 帳票ID(***reportId***)を指定して、VAE11取得します。 編集が行われていない場合は、ルートドキュメントから最新のVAE11を取得します。 編集中の場合は、先に保存した、VAE11を取得します。 |
|
| GET | /API/v2/NaccsReports/VanningRegistrationExportNoUnitCalls/GetFile/{fileId} |
VAE11に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、VAE11に添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationExportNoUnitCalls/Lock/{reportId} |
編集するため、VAE11をロックします。 帳票ID(***reportId***)を指定して、VAE11をロックします。 VAE11を作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、VAE11を編集する場合は、このメソッドを呼び出してロックします。 ロックされたVAE11は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、VAE11をルートドキュメントから参照できますが、編集中(ロック中)のVAE11は参照できません。 |
|
| POST | /API/v2/NaccsReports/VanningRegistrationExportNoUnitCalls/SendToNaccs |
VAE11をNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したVAE11をNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、VAE11が参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationExportNoUnitCalls/SetCancel/{reportId} |
VAE11の申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、VAE11の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationExportNoUnitCalls/Submit/{reportId} |
VAE11を提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したVAE11を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、VAE11が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationExportNoUnitCalls/Unlock/{reportId} |
VAE11のロックを解除します。 帳票ID(***reportId***)を指定して、VAE11のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationExportNoUnitCalls/Update/{reportId} |
VAE11を更新します。 帳票ID(***reportId***)を指定して、VAE11を更新します。 このメソッドでは、VAE11の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/VanningRegistrationExportNoUnitCalls/UploadFile |
VAE11にファイルを添付します。 指定されたVAE11に、ファイルを添付します。 |
|
VanningRegistrationExportNoUnits
VAE_バンニング情報登録(輸出管理番号単位)
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/NaccsReports/VanningRegistrationExportNoUnits/Create |
VAEを作成します。 VAEを作成するには、利用者がVAEを作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 |
|
| DELETE | /API/v2/NaccsReports/VanningRegistrationExportNoUnits/Delete/{reportId} |
VAEを削除します。 帳票ID(***reportId***)を指定して、、VAEを削除します。 VAEを削除しても、ルートドキュメントの内容までは削除されません。 |
|
| DELETE | /API/v2/NaccsReports/VanningRegistrationExportNoUnits/DeleteFile/{fileId} |
VAEの添付ファイルを削除します。 ファイルID(***fileId***)を指定して、VAEの添付ファイルを削除します。 |
|
| GET | /API/v2/NaccsReports/VanningRegistrationExportNoUnits/Get/{reportId} |
VAEを取得します。 帳票ID(***reportId***)を指定して、VAE取得します。 編集が行われていない場合は、ルートドキュメントから最新のVAEを取得します。 編集中の場合は、先に保存した、VAEを取得します。 |
|
| GET | /API/v2/NaccsReports/VanningRegistrationExportNoUnits/GetFile/{fileId} |
VAEに添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、VAEに添付されたファイルを取得します。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationExportNoUnits/Lock/{reportId} |
編集するため、VAEをロックします。 帳票ID(***reportId***)を指定して、VAEをロックします。 VAEを作成(***Create***)した時点では、ロックが掛かりますが、取得(***Get***)したあとで、VAEを編集する場合は、このメソッドを呼び出してロックします。 ロックされたVAEは、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、VAEをルートドキュメントから参照できますが、編集中(ロック中)のVAEは参照できません。 |
|
| POST | /API/v2/NaccsReports/VanningRegistrationExportNoUnits/SendToNaccs |
VAEをNACCSへ送信します。 取引管理番号(***tradeNo***)、帳票ID(***reportId***)を指定して、更新(***Update***)したVAEをNACCSへ送信します。 このメソッドでは、変更内容をルートドキュメントへ反映し、VAEが参照できる取引内のパートナーに、変更内容を公開することになります。 その後、指定されたパラメータと登録情報をもとにNACCSへ送信を行います。 取引外照会の場合には、取引管理番号(***tradeNo***)、帳票ID(***reportId***)に空文字を指定してください。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationExportNoUnits/SetCancel/{reportId} |
VAEの申請種別をキャンセルします。 帳票ID(***reportId***)を指定して、VAEの申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationExportNoUnits/Submit/{reportId} |
VAEを提出します。 帳票ID(***reportId***)を指定して、更新(***Update***)したVAEを提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、VAEが参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、ロックされた状態のままなのでご注意ください。 |
|
| POST | /API/v2/NaccsReports/VanningRegistrationExportNoUnits/SubmitByPost |
VAEを提出します。 動作は帳票の提出メソッド(***Submit***)と同様です。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationExportNoUnits/Unlock/{reportId} |
VAEのロックを解除します。 帳票ID(***reportId***)を指定して、VAEのロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 |
|
| PATCH | /API/v2/NaccsReports/VanningRegistrationExportNoUnits/Update/{reportId} |
VAEを更新します。 帳票ID(***reportId***)を指定して、VAEを更新します。 このメソッドでは、VAEの更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 |
|
| POST | /API/v2/NaccsReports/VanningRegistrationExportNoUnits/UpdateByPost |
VAEを更新します。 動作は帳票の更新メソッド(***Update***)と同様です。 |
|
| POST | /API/v2/NaccsReports/VanningRegistrationExportNoUnits/UploadFile |
VAEにファイルを添付します。 指定されたVAEに、ファイルを添付します。 |
|
VerifiedGrossMassReports
コンテナ確定重量報告書
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/VerifiedGrossMassReports/Create |
コンテナ確定重量報告書を作成します。 コンテナ確定重量報告書を作成するには、利用者がコンテナ確定重量報告書を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/VerifiedGrossMassReports/Delete/{reportId} |
コンテナ確定重量報告書を削除します。 帳票ID(***reportId***)を指定して、コンテナ確定重量報告書を削除します。 コンテナ確定重量報告書を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成したコンテナ確定重量報告書のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/VerifiedGrossMassReports/DeleteFile/{fileId} |
コンテナ確定重量報告書の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、コンテナ確定重量報告書の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/VerifiedGrossMassReports/Get/{reportId}?historyId=!{historyId} |
コンテナ確定重量報告書を取得します。 帳票ID(***reportId***)を指定して、コンテナ確定重量報告書を取得します。 編集が行われていない場合は、ルートドキュメントから最新のコンテナ確定重量報告書を取得します。 編集中の場合は、先に保存した、コンテナ確定重量報告書を取得します。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書について]()を参照ください。 |
|
| GET | /API/v2/Reports/VerifiedGrossMassReports/GetDiff/{reportId}?historyId=!{historyId} |
保存されているコンテナ確定重量報告書とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当するコンテナ確定重量報告書と、ルートドキュメントの差分を取得します。 比較元を保存されているコンテナ確定重量報告書、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/VerifiedGrossMassReports/GetFile/{fileId} |
コンテナ確定重量報告書に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、コンテナ確定重量報告書に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/VerifiedGrossMassReports/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
コンテナ確定重量報告書を全て取得します。 検索条件に該当するコンテナ確定重量報告書を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新のコンテナ確定重量報告書を取得します。 編集中の場合は、先に保存した、コンテナ確定重量報告書を取得します。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/VerifiedGrossMassReports/Lock/{reportId} |
編集するため、コンテナ確定重量報告書をロックします 帳票ID(***reportId***)を指定して、コンテナ確定重量報告書をロックします。 コンテナ確定重量報告書を作成(***Create***)した時点では、コンテナ確定重量報告書をロックが掛かりますが、取得(***Get***)したあとで、コンテナ確定重量報告書を編集する場合は、このメソッドを呼び出して、コンテナ貨物搬入票をロックします。 ロックされたコンテナ確定重量報告書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、コンテナ確定重量報告書をルートドキュメントから参照できますが、編集中(ロック中)のコンテナ確定重量報告書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/VerifiedGrossMassReports/SetCancel/{reportId} |
コンテナ確定重量報告書の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、コンテナ確定重量報告書の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/VerifiedGrossMassReports/Submit/{reportId} |
コンテナ確定重量報告書を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)したコンテナ確定重量報告書を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、コンテナ確定重量報告書が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、コンテナ確定重量報告書もロックされた状態のままなので、ご注意ください。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書について]()を参照ください。 |
|
| POST | /API/v2/Reports/VerifiedGrossMassReports/SubmitByPost |
コンテナ確定重量報告書を提出します。 動作は、コンテナ確定重量報告書(***/API/v2/Reports/VerifiedGrossMassReports/Submit***)と同様です。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書]()を参照ください。 |
|
| PATCH | /API/v2/Reports/VerifiedGrossMassReports/Unlock/{reportId} |
コンテナ確定重量報告書のロックを解除します 帳票ID(***reportId***)を指定して、コンテナ確定重量報告書のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/VerifiedGrossMassReports/Update/{reportId} |
コンテナ確定重量報告書を更新します。 帳票ID(***reportId***)を指定して、コンテナ確定重量報告書を更新します。 このメソッドでは、コンテナ確定重量報告書の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書について]()を参照ください。 |
|
| POST | /API/v2/Reports/VerifiedGrossMassReports/UpdateByPost |
コンテナ確定重量報告書を更新します。 動作は、コンテナ確定重量報告書(***/API/v2/Reports/VerifiedGrossMassReports/Update***)と同様です。 コンテナ確定重量報告書に関する詳細については、[コンテナ確定重量報告書]()を参照ください。 |
|
| POST | /API/v2/Reports/VerifiedGrossMassReports/UploadFile |
コンテナ確定重量報告書にファイルを添付します。 指定されたコンテナ確定重量報告書に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
VgmCertifiedCompanies
VGM確定事業者
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/General/VgmCertifiedCompanies/GetList?notificationNo=!{notificationNo}®istrationNo=!{registrationNo}&corporateNo=!{corporateNo}&companyName=!{companyName} |
VGM確定事業者を取得します 検索条件に該当するVGM確定事業者を取得します。 VGM確定事業者に関する詳細については、[VGM確定事業者について]()を参照ください。 |
|
| GET | /API/v2/General/VgmCertifiedCompanies/GetListInternal?notificationNo=!{notificationNo}®istrationNo=!{registrationNo}&corporateNo=!{corporateNo}&companyName=!{companyName} |
VGM確定事業者を取得します 検索条件に該当するVGM確定事業者を取得します。 VGM確定事業者に関する詳細については、[VGM確定事業者について]()を参照ください。 |
|
VgmNotificationMembers
届出荷送人
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/General/VgmNotificationMembers/GetList?notificationNo=!{notificationNo}&corporateNo=!{corporateNo} |
届出荷送人を取得します。 届出番号(***notificationNo***)を指定して、届出荷送人を取得します。 このAPIで獲得できる届出荷送人は、[国際海上輸出コンテナ総重量確定制度(改正SOLAS条約関連)](https://www.mlit.go.jp/maritime/maritime_mn8_000008.html)の届出荷送人・登録確定事業者一覧を基にしています。 |
|
VgmRegistrationMembers
登録確定事業者
| API | Description | ||
|---|---|---|---|
| GET | /API/v2/General/VgmRegistrationMembers/GetList?registrationNo=!{registrationNo}&corporateNo=!{corporateNo} |
届出荷送人を取得します。 届出番号(***notificationNo***)を指定して、届出荷送人を取得します。 このAPIで獲得できる届出荷送人は、[国際海上輸出コンテナ総重量確定制度(改正SOLAS条約関連)](https://www.mlit.go.jp/maritime/maritime_mn8_000008.html)の届出荷送人・登録確定事業者一覧を基にしています。 |
|
Warehousings
入庫票
| API | Description | ||
|---|---|---|---|
| POST | /API/v2/Reports/Warehousings/Create |
入庫票を作成します。 入庫票を作成するには、利用者が入庫票を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 入庫票に関する詳細については、[入庫票について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/Warehousings/Delete/{reportId} |
入庫票を削除します。 帳票ID(***reportId***)を指定して、入庫票を削除します。 入庫票を削除しても、ルートドキュメントの内容までは削除されません。 申請種別を使用して、作成した入庫票のキャンセルを伝える場合は、キャンセル(***Cancel***)を実施後、帳票の提出(***Submit***)を実施してください。 入庫票に関する詳細については、[入庫票について]()を参照ください。 |
|
| DELETE | /API/v2/Reports/Warehousings/DeleteFile/{fileId} |
入庫票の添付ファイルを削除します。 ファイルID(***fileId***)を指定して、入庫票の添付ファイルを削除します。 帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/Warehousings/Get/{reportId}?historyId=!{historyId} |
入庫票を取得します。 帳票ID(***reportId***)を指定して、入庫票を取得します。 編集が行われていない場合は、ルートドキュメントから最新の入庫票を取得します。 編集中の場合は、先に保存した、入庫票を取得します。 入庫票に関する詳細については、[入庫票について]()を参照ください。 |
|
| GET | /API/v2/Reports/Warehousings/GetDiff/{reportId}?historyId=!{historyId} |
保存されている入庫票とルートドキュメントの差分を取得します。 帳票ID(***reportId***)に該当する入庫票と、ルートドキュメントの差分を取得します。 比較元を保存されている入庫票、比較先をルートドキュメントとして、差分の取得を行います。 差分は、帳票の差分モデル(***CompareResult***)として返却します。 帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。 |
|
| GET | /API/v2/Reports/Warehousings/GetFile/{fileId} |
入庫票に添付されたファイルを取得します。 ファイルID(***fileId***)を指定して、入庫票に添付されたファイルを取得します。 帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
| GET | /API/v2/Reports/Warehousings/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo} |
入庫票を全て取得します。 検索条件に該当する入庫票を全て取得します。 編集が行われていない場合は、ルートドキュメントから最新の入庫票を取得します。 編集中の場合は、先に保存した、入庫票を取得します。 入庫票に関する詳細については、[入庫票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/Warehousings/Lock/{reportId} |
編集するため、入庫票をロックします 帳票ID(***reportId***)を指定して、入庫票をロックします。 入庫票を作成(***Create***)した時点では、入庫票をロックが掛かりますが、取得(***Get***)したあとで、入庫票を編集する場合は、このメソッドを呼び出して、入庫票をロックします。 ロックされた入庫票は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、入庫票をルートドキュメントから参照できますが、編集中(ロック中)の入庫票は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 入庫票に関する詳細については、[入庫票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/Warehousings/SetCancel/{reportId} |
入庫票の申請種別をキャンセルします 帳票ID(***reportId***)を指定して、入庫票の申請種別(***applyType***)を、キャンセル(CANCEL)にします。 申請種別(***applyType***)が、訂正(AMEND)の場合に、この操作は有効になります。 このメソッドで、申請種別(***applyType***)を、キャンセル(CANCEL)にし、帳票の提出(***Submit***)することで、申請種別が確定します。 入庫票に関する詳細については、[入庫票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/Warehousings/Submit/{reportId} |
入庫票を提出します 帳票ID(***reportId***)を指定して、更新(***Update***)した入庫票を提出します。 このメソッドでは、変更内容をルートドキュメントへ反映し、入庫票が参照できる取引内のパートナーに、変更内容を公開することになります。 帳票の更新(***Update***)しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、入庫票もロックされた状態のままなので、ご注意ください。 入庫票に関する詳細については、[入庫票について]()を参照ください。 |
|
| POST | /API/v2/Reports/Warehousings/SubmitByPost |
入庫票を提出します。 動作は、入庫票(***/API/v2/Reports/Warehousings/Submit***)と同様です。 入庫票に関する詳細については、[入庫票]()を参照ください。 |
|
| PATCH | /API/v2/Reports/Warehousings/Unlock/{reportId} |
入庫票のロックを解除します 帳票ID(***reportId***)を指定して、入庫票のロックを解除します。 更新内容のルートドキュメントへの反映は、帳票の提出(***Submit***)で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 入庫票に関する詳細については、[入庫票について]()を参照ください。 |
|
| PATCH | /API/v2/Reports/Warehousings/Update/{reportId} |
入庫票を更新します。 帳票ID(***reportId***)を指定して、入庫票を更新します。 このメソッドでは、入庫票の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。 ルートドキュメントへの反映は、帳票の提出メソッド(***Submit***)を使用します。 入庫票に関する詳細については、[入庫票について]()を参照ください。 |
|
| POST | /API/v2/Reports/Warehousings/UpdateByPost |
入庫票を更新します。 動作は、入庫票(***/API/v2/Reports/Warehousings/Update***)と同様です。 入庫票に関する詳細については、[入庫票]()を参照ください。 |
|
| POST | /API/v2/Reports/Warehousings/UploadFile |
入庫票にファイルを添付します。 指定された入庫票に、ファイルを添付します。 帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー(***/API/v2/Reports/AccessiblePartners***)にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。 |
|
Webhooks
Webhook設定
| API | Description | ||
|---|---|---|---|
| DELETE | /API/v2/Webhooks/Delete/{webhookId} |
Webhook設定を削除します。 Webhook設定ID(***webhookId***)を指定して、Webhook設定を削除します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。 |
|
| GET | /API/v2/Webhooks/Get/{webhookId} |
Webhook設定を取得します。 Webhook設定ID(***webhookId***)を指定して、Webhook設定を取得します。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。 |
|
| GET | /API/v2/Webhooks/GetList?webhookId=!{webhookId}&webhookName=!{webhookName} |
会社のWebhook設定を全て取得します。 ログインしている利用者が所属する会社配下に登録されている全てのWebhook設定を取得します。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。 |
|
| POST | /API/v2/Webhooks/Register |
所属する会社にWebhook設定を登録します。 管理者が所属する会社に、Webhook設定を登録します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。 |
|
| PATCH | /API/v2/Webhooks/Update/{webhookId} |
Webhook設定を更新します。 Webhook設定ID(***webhookId***)を指定して、Webhook設定を更新します。 このメソッドは会社の管理者(***/API/v2/Companies/Administrators***)として登録された利用者が利用できます。 Webhook設定に関する詳細については、[Webhook設定について]()を参照ください。 |
|