ShipmentLog.md

@fairfleet/geotab / ShipmentLog

Interface: ShipmentLog

A ShipmentLog is a record of shipment transported by a specified vehicle for a duration of time.

Hierarchy

• EntityWithVersion

  ↳ ShipmentLog

Table of contents

Properties

• activeFrom
• activeTo
• commodity
• dateTime
• device
• documentNumber
• driver
• id
• shipperName
• version

Properties

activeFrom

• activeFrom: Date

Gets or sets the date the shipment was started. Default [UtcNow].

Defined in

src/types/Checkmate/ObjectModel/ShipmentLog.ts:14

---

activeTo

• activeTo: Date

Gets or sets the date the shipment was ended. Default [MaxDate].

Defined in

src/types/Checkmate/ObjectModel/ShipmentLog.ts:16

---

commodity

• commodity: string

Gets or sets the commodity shipped. Maximum length [255] Default [""].

Defined in

src/types/Checkmate/ObjectModel/ShipmentLog.ts:18

---

dateTime

• dateTime: Date

Gets or sets the date and time the log was created.

Defined in

src/types/Checkmate/ObjectModel/ShipmentLog.ts:20

---

device

• device: Device

Gets or sets the Device associated with this log.

Defined in

src/types/Checkmate/ObjectModel/ShipmentLog.ts:22

---

documentNumber

• documentNumber: string

Gets or sets the identifier of the shipment document. Default [""].

Defined in

src/types/Checkmate/ObjectModel/ShipmentLog.ts:24

---

driver

• driver: User

Gets or sets the User who created this log.

Defined in

src/types/Checkmate/ObjectModel/ShipmentLog.ts:26

---

id

• id: string

Gets or sets the unique identifier for the specific Entity object in the Geotab system. See Id.

Inherited from

EntityWithVersion.id

Defined in

src/types/Checkmate/ObjectModel/Entity.ts:14

---

shipperName

• shipperName: string

Gets or sets the name of the shipper. Default [""].

Defined in

src/types/Checkmate/ObjectModel/ShipmentLog.ts:28

---

version

• version: number

Gets or sets the version of the entity.

Inherited from

EntityWithVersion.version

Defined in

src/types/Checkmate/ObjectModel/EntityWithVersion.ts:10