Versions Compared

Key

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

Short Description

Chapter Contents:

Table of Contents
maxLevel4
minLevel4

Long Description

Properties

Property

Type

Length

Mandatory

Description

Comments

Code Block
cargoPortSequence

 Integer



Cargo Port Sequence:

  • First Load Port (LP)= 1, Second Load Port = 2, etc.

  • First Discharge Port (DP) = 1 , Second Discharcge Port = 2, etc.

Example:

1 load port and 1 discharge port:

  • 1 Load

  • 1 Discharge

Example:

2 load ports and 2 discharge ports:

  • 1 Load

  • 2 Load

  • 1 Discharge

  • 2 Discharge 


port

/Port


Yes



reasonForCall

/ReasonForCall


Yes



cargoQuantity

Double





freightRate

Double





laytimeTermsValue

Double





laytimeTerms

/LaytimeTerms





handlingCostRate

Double





isHandlingCostLumpsum

Boolean





cargo

/Cargo


Yes



isBlActive

Boolean





hcMeasurement

/Measurement





variousCost

Double





variousRevenue

Double





demurrage

Double





despatch

Double





freight

Double





handlingCost

Double





exporter

/BusinessPartner





receiver

/BusinessPartner





terminal

/Terminal





laytimeUsed

Double





isDemurrageFixed

Boolean





isDespatchFixed

Boolean





laytimeAllowed

Double





laytimeExpireDate

Date





laytimeUsedFromDate

Date





laytimeUsedToDate

Date





outturnQuantity

Double





shipFigure

Double





timeNotToCount

Double





timeOnDemurrage

Double





volume

Double





weight

Double





tcRateIndex

/MarketIndex





transshipmentVessel

/Vessel





laytimeCounterpart

/BusinessPartner





isCargoQuantityFixed

Boolean





isFreeDespatch

Boolean





isLaytimeProrated

Boolean





isWorking

Boolean





laytimeQuantity

Double





onDockQuantity

Double





pctOfLaytimeUsed

Double





reversibleMatch

String

1




handlingCostCurrency

/Currency





handlingCostCurrencyAmount

Double





eventLogs

List of EventLog





demurrageTimeBarEvent

/Event





portCall

/PortCall


Yes if the corresponding Cargo is allocated to a Voyage


from 5.11

laytimeCalculation

/LaytimeCalculation





laytimeUsedMinutes

Integer





minutesNotToCount

Integer





laytimeAllowedMinutes

Integer





timeOnDemurrageMinutes

Integer





timeOnDespatchMinutes

Integer





timeOnDespatch

Double





notToCounts

Array of /NotToCount





eeoi

Double

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 version has date format: yyyy-dd-MM hh:mi:ss)

...

Expand
titleExpand to see related content


Wiki Markup
{dynamiccontentbylabel:showLabels=false|showSpace=false}