Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property

Type

Length

Mandatory

Description

Comments

referenceNo

Integer

referenceNo is set automatically by Dataloy VMS, setting this in the API will have no effect.

vessel

/Vessel

ballastPort

/Port

portCalls

Array of /PortCall

cargos

Array of /Cargo

ballastBonus

Double

ballastBonusCommission

Double

ballastBonusNet

Double

ballastBonusRevenue

Double

tcs

Array of /Tc

canalCost

Double

comments

String

64

commission

Double

commissionAddress

Double

commissionOwnersCost

Double

createdDate

Date

cveTcIn

Double

cveTcOut

Double

daysBallast

Double

daysCanal

Double

daysCleaning

Double

daysDischarging

Double

daysExtraAtSea

Double

daysExtraInPort

Double

daysHeating

Double

daysIdle

Double

daysInertingDo

Double

daysInertingFo

Double

daysLoaded

Double

daysLoading

Double

daysOffhire

Double

daysOffhireCharterer

Double

daysOffhireOwner

Double

daysTotal

Double

daysTotalAtSea

Double

daysTotalInPort

Double

daysWaiting

Double

Calculated if voyage is not estimate, budget or unallocated

demurrage

Double

despatch

Double

dlConsumption

Double

dlCost

Double

dlPrice

Double

doAtSea

Double

doConsumption

Double

doCost

Double

doInerting

Double

doInPort

Double

doInPortWorking

Double

doPrice

Double

estimatedVoyageStartDate

Date

flConsumption

Double

flCost

Double

flPrice

Double

foBallast

Double

foCleaning

Double

foConsumption

Double

foCost

Double

foHeating

Double

foInerting

Double

foInPort

Double

foInPortWorking

Double

foLoaded

Double

foPrice

Double

foPumping

Double

freight

Double

freightCost

Double

grossFreight

Double

handlingCost

Double

ilohcTcIn

Double

ilohcTcOut

Double

isDaysWaitingFixed

Boolean

isInReverseMode

Boolean

If set to true the TCE of the voyage is locked

isTc

Boolean

milesBallast

Integer

milesLoaded

Double

Double since API 3.12.0, before was Integer

netFreight

Double

percentExtraAtSea

Double

portCost

Double

restrictingCubic

Double

robFixed

Double

runningCost

Double

runningCostPerDay

Double

speedBallast

Double

speedLoaded

Double

tabTitle

String

128

tcHireCommission

Double

tcHireNet

Double

tcRate

Double

tcResult

Double

tcResultDay

Double

tdw

Double

utilisationComments

String

64

variousCost

Double

variousRevenue

Double

voyageResult

Double

tcIn

/Tc

voyageCurrency

/Currency

voyageHeader

/VoyageHeader

voyageStatus

String

variouses

Array of /Various

variousCostFixed

Boolean

Available from API version 6.3.

eeoi

Double

co2Ballast

Double

co2Laden

Double

ballastConsumption

Double

ladenConsumption

Double

fleetPlanVoyages

Array of /FleetPlanVoyage

adjustment

Double

Sum of all the cargos' adjustment field on the voyage

Available from API version 6.28

ballastEuEtsCost

Double

Available from API version 6.29

ballastEuEtsEmission

Double

Available from API version 6.29

ladenEuEtsCost

Double

Available from API version 6.29

ladenEuEtsEmission

Double

Available from API version 6.29

Example Response Body

Note

Updated for API version 2.0.0 using the new required date format yyyy-dd-MMThh:mi:ss to conform ISO 8601, (prior versions has date format: yyyy-dd-MM hh:mi:ss)

...