CS
Carrier
Represents a Carrier used by the company for shipping goods or a company's own shipping option. The records of this type are created and edited through the Ship Via Codes (CS207500) form (which corresponds to the CarrierMaint graph). If the FeaturesSet.CarrierIntegration feature is enabled, the corresponding settings and plugins are defined through the Carriers (CS207700) form (which corresponds to the CarrierPluginMaint graph).
View API Entity: ShipVia
/entity/Default/25.200.001/ShipVia| Field Name | Type | Display Name | Foreign Key | |
|---|---|---|---|---|
BaseRate | decimal | Base Rate | - | |
Description:The flat-rate charge, which is added to the freight amount calculated according to the related FreightRate records. This field is relevan only if IsExternal is set to "false". Defaults to "0.0". | ||||
CalcFreightOnReturn | bit | Calculate Freight on Returns | - | |
Description:No description available | ||||
CalcMethod API | char(1) | Calculation Method | - | |
Description:The method used to calculate freight charges using the rate breakdown specified in the related FreightRate records. Allowed values are: ""P"" - Per Unit, ""N"" - Net (flat rates), ""M"" - Manual. Defaults to Manual (""M""). | ||||
CalendarID API | nvarchar(10) | Calendar | CSCalendar | |
Description:The Calendar associated with the carrier, which reflects its work hours and the days when it ships the goods. Corresponds to the CSCalendar.CalendarID field. | ||||
CarrierID API | nvarchar(15) | Ship Via | - | |
Description:Key field. A unique code of a non-integrated carrier, a method of the integrated carrier or a shipping option of the company. | ||||
CarrierPluginID | nvarchar(15) | Carrier | - | |
Description:Identifier of the CarrierPlugin used to provide integration with the carrier for this shipping option. This field is relevant only if IsExternal is set to "true". Corresponds to the CarrierPlugin.CarrierPluginID field. | ||||
ConfirmationRequired | bit | Confirmation for Each Box Is Required | - | |
Description:When set to "true", indicates that to confirm the shipment the system will require confirmation for each package used for shipment with this shipment option. This field is relevant only if IsExternal is set to "true". Defaults to "true". | ||||
CreatedByID | uniqueidentifier | Created By | Users | |
Description:No description available | ||||
CreatedByScreenID | char(8) | - | ||
Description:No description available | ||||
CreatedDateTime | datetime | Created On | - | |
Description:No description available | ||||
DeliveryType | char(1) | Delivery Type | - | |
Description:The delivery type of the ship via code. Allowed values are: - "N": N/A - "P": Parcel - "L": LTL/FTL | ||||
Description API | nvarchar(60) | Description | - | |
Description:The description of the carrier or shipping option. | ||||
FreightExpenseAcctID API | int | Freight Expense Account | Account | |
Description:Identifier of the General Ledger expense Account, that is used to record the freight charges to be paid to the Carrier. | ||||
FreightExpenseSubID API | int | Freight Expense Sub. | Sub | |
Description:Identifier of the General Ledger Subaccount, that is used to record the freight charges to be paid to the Carrier. | ||||
FreightSalesAcctID API | int | Freight Sales Account | Account | |
Description:Identifier of the General Ledger income Account, that is used to record the freight charges to be paid to the company. | ||||
FreightSalesSubID API | int | Freight Sales Sub. | Sub | |
Description:Identifier of the General Ledger Subaccount, that is used to record the freight charges to be paid to the company. | ||||
IsActive | bit | Active | - | |
Description:A Boolean value that indicates whether the ship via code is active and can be used in documents. | ||||
IsCommonCarrier API | bit | Common Carrier | - | |
Description:Indicates whether the carrier is a common carrier. Because common carriers deliver goods from a company branch to the customer location that is a selling point, the value of this field affects the set of taxes that applies to the corresponding invoice. When set to "true", the carrier is considered common and hence the taxes from the customer's tax zone are applied. Otherwise, the system applies the taxes from the taz zone associated with the selling branch. | ||||
IsExternal | bit | External Plug-in | - | |
Description:When set to "true", indicates that the system must use a plugin, specified in the CarrierPluginID field, to provide integration with the carrier for this shipping option. This field is relevant only if the FeaturesSet.CarrierIntegration feature is enabled. Defaults to "false". | ||||
IsExternalShippingApplication | bit | Use External Shipping Application | - | |
Description:No description available | ||||
LastModifiedByID | uniqueidentifier | Last Modified By | Users | |
Description:No description available | ||||
LastModifiedByScreenID | char(8) | - | ||
Description:No description available | ||||
LastModifiedDateTime | datetime | Last Modified On | - | |
Description:No description available | ||||
NoteID | uniqueidentifier | - | ||
Description:Identifier of the Note object, associated with the document. Corresponds to the Note.NoteID field. | ||||
PackageRequired | bit | At least one Package Is Required | - | |
Description:When set to "true", indicates that at least one package must be specified to create (and confirm) a shipment with this shipment option. This field is relevant only if IsExternal is set to "true". Defaults to "true". | ||||
PluginMethod | nvarchar(100) | Service Method | PXBqlTable | |
Description:The code of the Service Method of the Carrier Plugin that is used to provide integration with the carrier for this shipping option. This field is relevant only if IsExternal is set to "true". | ||||
ReturnLabel | bit | Generate Return Label Automatically | - | |
Description:No description available | ||||
ShippingApplicationType | nchar | Shipping Application | - | |
Description:No description available | ||||
TaxCategoryID API | nvarchar(15) | Tax Category | TaxCategory | |
Description:Identifier of the Tax Category to be applied to the freight amount when goods are shipped with this shipping option. Corresponds to the TaxCategory.TaxCategoryID field. | ||||
ValidatePackedQty | bit | Validate Packed Quantities on Shipment Confirmation | - | |
Description:No description available | ||||
tstamp | timestamp | - | ||
Description:No description available | ||||