| Name | Description | Type | Additional information |
|---|---|---|---|
| Enabled |
Indicates if the surcharge applies to the shipment. The surcharge applies to the shipment if (1) it applies to the INCOTERM of the forwarder service, and (2) it applies to the package types of the shipment, and (3) the surcharge condition is met. |
boolean |
None. |
| EnabledStateRemarks |
Remarks about the enabled/disabled state. |
string |
None. |
| SurchargeId |
The number that identifies the surcharge. |
integer |
None. |
| SurchargeCode |
The code that identifies the surcharge. |
string |
None. |
| SurchargeCategoryCode |
The code that identifies the category of the surcharge. |
string |
None. |
| SurchargeName |
The name of the surcharge. |
string |
None. |
| SurchargeDescription |
The description of the surcharge. This is generated by the Engine. |
string |
None. |
| FuelSurchargeBasis |
Indicates if the surcharge is part of the fuel surcharge basis. |
boolean |
None. |
| ContractTypeCode |
The code that identifies the type of contract. Possible values include "CUSTOMER", "BUY" and "SELL". |
string |
None. |
| IncotermDutyCode |
The code that identifies the INCOTERM duty. This is used to determine which surcharges are applicable. INCOTERM duties include "load to truck", "transport to destination", "insurance", etc. INCOTERM rules determine which surcharges are applicable, depending on the INCOTERM code of the freight rate, the INCOTERM duty of the surcharge and the INBOUND/OUTBOUND/3RDPARTY value of the shipment. |
string |
None. |
| FileName |
The name of the source surcharge file. |
string |
None. |
| SheetName |
The name of the source surcharge sheet. |
string |
None. |
| SurchargeTypeCode |
The code that identifies the type of surcharge. |
string |
None. |
| SurchargeTypeName |
The name of the type of surcharge. |
string |
None. |
| CurrencyCodeBeforeExchange |
The 3-letter ISO code of the original currency. |
string |
None. |
| SurchargeAmountBeforeExchange |
The calculated surcharge amount (in the original currency). |
decimal number |
None. |
| CurrencyCode |
The 3-letter ISO code of the target currency. |
string |
None. |
| SurchargeAmount |
The calculated surcharge amount (in the target currency). |
decimal number |
None. |
| SurchargeCurrencyExchangeIsOK |
Indicates if the surcharge currency conversion was successful. |
boolean |
None. |
| SurchargeCalculation |
Information about the surcharge calculation process. |
SurchargeCalculation |
None. |
| SurchargeCondition |
Information about the surcharge condition. |
SurchargeCondition |
None. |
| UOMInfo |
Information about the UOMs of the surcharge. |
UOMInfo |
None. |