POST /API/v1/Report/SeaWayBills/CreateByBookingNo
ブッキング番号を指定して、帳票:海上運送状を作成します。 ## 概要 ユーザが所属している組織(と事業種別)が作成、または参加している取引の中から、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引に対して、帳票:海上運送状を作成します。 帳票を作成する条件は、Createメソッドと同じく、その帳票を格納する取引を作成、または参加している組織(と事業種別)に所属するユーザであり、かつ、その帳票に対してWrite権限が必要です。 ただし、指定された船社コード(***scacCode***)とブッキング番号(***bookingNo***)に該当する取引が存在しない、または複数存在する場合はエラーとなります。 帳票:海上運送状が取引内にすでに存在する場合は、Getメソッドと同じ動作となりステータスコード:200を返却します。
Request Information
URI Parameters
None.
Body Parameters
CreateReportByBookingNoRequest
CreateReportByBookingNoRequest
Name | Description | Type | Additional information |
---|---|---|---|
bookingNo | ブッキング番号 |
String |
Required |
businessTypeId | 事業種別ID |
String |
Required |
organizationId | 組織ID |
String |
Required |
scacCode | 船社コード |
String |
Required |
Response Information
Resource Description
SeaWayBills
Name | Description | Type | Additional information |
---|---|---|---|
_etag | etag |
String |
Required |
businessTypeId | 事業種別ID |
String |
Required Format : Protect Pattern : ^(?!.*(\?|\$|#|&|,|=)).*$ |
consumptionTax | 消費税 |
Number, Null |
Format : Number(12,0) Maximum : 999999999999 Minimum : 0 |
containers |
Collection, Null of containers |
Format : Reference("/API/v1/Root/Containers/OData?$select=containerId,dealNo,containerLengthCode,containerHeightCode,containerTypeCode,containerNo,sealNo,partitionNo&$filter=dealNo+eq+{value}&$orderby=containerNo",containerId,dealNo,containerLengthCode,containerHeightCode,containerTypeCode,containerNo,sealNo,partitionNo);Protect;Notify |
|
contractNo | 契約番号 |
String, Null |
None. |
dealInformation |
Required |
||
dealReportId | 取引・帳票ID |
String |
Required |
documentNo | ドキュメント番号 |
String, Null |
None. |
exportRemarks | 輸出 摘要 |
String, Null |
None. |
fcCollectTotalFee | フレイトチャージ合計着払金額 |
Number, Null |
Format : Number(12,3) Maximum : 999999999.999 Minimum : 0 |
fcCollectTotalFeeCurrency | フレイトチャージ合計着払通貨 |
String, Null |
None. |
fcPrepaidTotalFee | フレイトチャージ合計先払金額 |
Number, Null |
Format : Number(12,3) Maximum : 999999999.999 Minimum : 0 |
fcPrepaidTotalFeeCurrency | フレイトチャージ合計先払通貨 |
String, Null |
None. |
fcTotalCurrency | フレイトチャージ合計通貨 |
String, Null |
None. |
fcTotalFee | フレイトチャージ合計金額 |
Number, Null |
Format : Number(12,3) Maximum : 999999999.999 Minimum : 0 |
forDeliveryApplyToAddress | 配達提出先_住所 |
String, Null |
None. |
forDeliveryApplyToFax | 配達提出先_FAX番号 |
String, Null |
None. |
forDeliveryApplyToTel | 配達提出先_電話番号 |
String, Null |
None. |
freightAndCharges |
Collection, Null of freightAndCharges |
None. |
|
invoice |
Required |
||
invoiceRegistrationNumber | 適格請求書発行事業者登録番号 |
String, Null |
Min length: 0 Max length: 14 |
ladenOnBoardSignatureOfCaptainBy | 署名(本船船長) |
String, Null |
None. |
merchantsDeclaredValue | 価格申告欄 |
Number, Null |
Format : Number(18,3) Maximum : 1E+15 Minimum : 0 |
note1 | 備考1 |
String, Null |
Min length: 0 Max length: 140 |
note2 | 備考2 |
String, Null |
None. |
note3 | 備考3 |
String, Null |
None. |
organizationId | 組織ID |
String |
Required Format : Protect Pattern : ^(?!.*(\?|\$|#|&|,|=)).*$ |
partitionNo | パーティション番号 |
Integer, Null |
Format : Protect |
printedDate | 書類発行日 |
String, Null |
Format : date |
publisherCompanyName | 書類発行者_会社名 |
String, Null |
None. |
publisherFax | 書類発行者_FAX番号 |
String, Null |
None. |
publisherPersonInCharge | 書類発行者_担当者 |
String, Null |
None. |
publisherTel | 書類発行者_電話番号 |
String, Null |
None. |
receiptDate | 荷受日 |
String, Null |
Format : date |
reference | 荷受人_摘要 |
String, Null |
None. |
remarks | 摘要 |
String, Null |
None. |
representativeCommodities |
Collection, Null of representativeCommodities |
Format : Reference("/API/v1/Root/RepresentativeCommodities/OData?$select=representativeCommodityId,dealNo,sortNo,marksAndNumbers,numberOfContainersOrPackage,packagesType,descriptionOfGoods,hsCode,commodityNetWeight,commodityNetWeightUnitCode,commodityGrossWeight,commodityGrossWeightUnitCode,commodityMeasurement,commodityMeasurementUnitCode,partitionNo&$filter=dealNo+eq+{value}&$orderby=sortNo",representativeCommodityId,dealNo,sortNo,marksAndNumbers,numberOfContainersOrPackage,packagesType,descriptionOfGoods,hsCode,commodityNetWeight,commodityNetWeightUnitCode,commodityGrossWeight,commodityGrossWeightUnitCode,commodityMeasurement,commodityMeasurementUnitCode,partitionNo);Protect;Notify |
|
taxableAmount | 課税対象額 合計 |
Number, Null |
Format : Number(12,3) Maximum : 999999999.999 Minimum : 0 |