docs.jsonld
type: ApiDocumentation
title: FCMS API
description: API from Feight Contract Management System
entrypoint: /api
supported class: AdditionalCost
supported class: Berth
supported class: Cargo
supported class: Charterer
supported class: Checklist
supported class: Contract
supported class: ContractCargo
supported class: DeliveryNotice
supported class: FinanceConsolidatedBrokerList
supported class: FinanceConsolidatedCargoList
supported class: FinanceConsolidatedChartererList
supported class: FinanceConsolidatedContractList
supported class: FinanceConsolidatedDeptList
supported class: FinanceConsolidatedOwnerList
supported class: FinanceDashboard
supported class: Hire
supported class: MarketRumor
supported class: MarketRumorCargo
supported class: MarketRumorPort
supported class: Media
supported class: OperationDashboard
supported class: OperationIncident
supported class: OperationReport
supported class: Owner
supported class: Payment
supported class: Port
supported class: PortCall
supported class: RedeliveryNotice
supported class: Report
supported class: Task
supported class: User
supported class: Vessel
supported class: Entrypoint
supported class: ConstraintViolation
supported class: ConstraintViolationList

AdditionalCost
type: Class
title: AdditionalCost
supported operation: Retrieves a AdditionalCost resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a AdditionalCost resource.
  returns: AdditionalCost

Berth
type: Class
title: Berth
supported operation: Retrieves a Berth resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Berth resource.
  returns: Berth

Cargo
type: Class
title: Cargo
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cargoType
  title: cargoType
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subtype
  title: subtype
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: observations
  title: observations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contractCargos
  title: contractCargos
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: marketRumorCargos
  title: marketRumorCargos
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
  description: Returns createdAt.
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
  description: Returns updatedAt.
supported operation: Retrieves a Cargo resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Cargo resource.
  returns: Cargo
supported operation: Replaces the Cargo resource.
  type: Operation
  type: ReplaceAction
  expects: Cargo
  method: PUT
  title: Replaces the Cargo resource.
  returns: Cargo
supported operation: Deletes the Cargo resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Cargo resource.
  returns: Nothing

name
type: Property
domain: Cargo
range: string

cargoType
type: Property
domain: Cargo
range: string

subtype
type: Property
domain: Cargo
range: string

observations
type: Property
domain: Cargo
range: string

contractCargos
type: Link
domain: Cargo
range: ContractCargo

marketRumorCargos
type: Link
domain: Cargo
range: MarketRumorCargo

createdAt
type: Property
domain: Cargo
range: dateTime

updatedAt
type: Property
domain: Cargo
range: dateTime

Charterer
type: Class
title: Charterer
supported property: SupportedProperty
  property: companyName
  title: companyName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: addressLine1
  title: addressLine1
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: addressLine2
  title: addressLine2
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: addressLine3
  title: addressLine3
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: charteringEmail
  title: charteringEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: operationsEmail
  title: operationsEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accountingEmail
  title: accountingEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: observations
  title: observations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contracts
  title: contracts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: marketRumors
  title: marketRumors
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: marketRumors2
  title: marketRumors2
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
  description: Returns createdAt.
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
  description: Returns updatedAt.
supported operation: Retrieves a Charterer resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Charterer resource.
  returns: Charterer
supported operation: Replaces the Charterer resource.
  type: Operation
  type: ReplaceAction
  expects: Charterer
  method: PUT
  title: Replaces the Charterer resource.
  returns: Charterer
supported operation: Deletes the Charterer resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Charterer resource.
  returns: Nothing

companyName
type: Property
domain: Charterer
range: string

addressLine1
type: Property
domain: Charterer
range: string

addressLine2
type: Property
domain: Charterer
range: string

addressLine3
type: Property
domain: Charterer
range: string

charteringEmail
type: Property
domain: Charterer
range: string

operationsEmail
type: Property
domain: Charterer
range: string

accountingEmail
type: Property
domain: Charterer
range: string

observations
type: Property
domain: Charterer
range: string

contracts
type: Link
domain: Charterer
range: Contract

marketRumors
type: Link
domain: Charterer
range: MarketRumor

marketRumors2
type: Link
domain: Charterer
range: MarketRumor

createdAt
type: Property
domain: Charterer
range: dateTime

updatedAt
type: Property
domain: Charterer
range: dateTime

Checklist
type: Class
title: Checklist
supported property: SupportedProperty
  property: checklistName
  title: checklistName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: tasks
  title: tasks
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: taskCount
  title: taskCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: notes
  title: notes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contracts
  title: contracts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
  description: Returns createdAt.
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
  description: Returns updatedAt.
supported operation: Retrieves a Checklist resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Checklist resource.
  returns: Checklist
supported operation: Replaces the Checklist resource.
  type: Operation
  type: ReplaceAction
  expects: Checklist
  method: PUT
  title: Replaces the Checklist resource.
  returns: Checklist
supported operation: Deletes the Checklist resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Checklist resource.
  returns: Nothing

checklistName
type: Property
domain: Checklist
range: string

tasks
type: Link
domain: Checklist
range: Task

taskCount
type: Property
domain: Checklist
range: integer

notes
type: Property
domain: Checklist
range: string

contracts
type: Link
domain: Checklist
range: Contract

createdAt
type: Property
domain: Checklist
range: dateTime

updatedAt
type: Property
domain: Checklist
range: dateTime

Contract
type: Class
title: Contract
supported property: SupportedProperty
  property: contractNumber
  title: contractNumber
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contractType
  title: contractType
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: laycanStart
  title: laycanStart
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: laycanStartDate
  title: laycanStartDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: laycanStartTime
  title: laycanStartTime
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: laycanEnd
  title: laycanEnd
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: laycanEndDate
  title: laycanEndDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: laycanEndTime
  title: laycanEndTime
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: vessel
  title: vessel
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: owner
  title: owner
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: charterer
  title: charterer
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: broker
  title: broker
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: operator
  title: operator
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: freightCost
  title: freightCost
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: freightCostCurrency
  title: freightCostCurrency
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: freightType
  title: freightType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: demurragePerDay
  title: demurragePerDay
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: demurragePerDayCurrency
  title: demurragePerDayCurrency
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: additionalCosts
  title: additionalCosts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: addressCommission
  title: addressCommission
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: brokerageCommission
  title: brokerageCommission
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: liftingsMin
  title: liftingsMin
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: liftingsMax
  title: liftingsMax
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: documents
  title: documents
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: portCalls
  title: portCalls
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: operationReports
  title: operationReports
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cargoItems
  title: cargoItems
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: payments
  title: payments
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hires
  title: hires
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: liftings
  title: liftings
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: checklist
  title: checklist
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: checkedTasks
  title: checkedTasks
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Contract resource.
supported operation: Replaces the Contract resource.
supported operation: Deletes the Contract resource.

contractNumber
type: Property
domain: Contract
range: string

contractType
type: Property
domain: Contract
range: string

laycanStart
type: Property
domain: Contract
range: dateTime

laycanStartDate
type: Property
domain: Contract
range: string

laycanStartTime
type: Property
domain: Contract
range: string

laycanEnd
type: Property
domain: Contract
range: dateTime

laycanEndDate
type: Property
domain: Contract
range: string

laycanEndTime
type: Property
domain: Contract
range: string

vessel
type: Link
domain: Contract
max cardinality: 1
range: Vessel

owner
type: Link
domain: Contract
max cardinality: 1
range: Owner

charterer
type: Link
domain: Contract
max cardinality: 1
range: Charterer

broker
type: Link
domain: Contract
max cardinality: 1
range: User

operator
type: Link
domain: Contract
max cardinality: 1
range: User

status
type: Property
domain: Contract
range: string

freightCost
type: Property
domain: Contract
range: string

freightCostCurrency
type: Property
domain: Contract
range: string

freightType
type: Property
domain: Contract
range: string

demurragePerDay
type: Property
domain: Contract
range: string

demurragePerDayCurrency
type: Property
domain: Contract
range: string

additionalCosts
type: Link
domain: Contract
range: AdditionalCost

addressCommission
type: Property
domain: Contract
range: string

brokerageCommission
type: Property
domain: Contract
range: string

liftingsMin
type: Property
domain: Contract
range: integer

liftingsMax
type: Property
domain: Contract
range: integer

documents
type: Link
domain: Contract
range: Media

portCalls
type: Link
domain: Contract
range: PortCall

operationReports
type: Link
domain: Contract
range: OperationReport

cargoItems
type: Link
domain: Contract
range: ContractCargo

payments
type: Link
domain: Contract
range: Payment

hires
type: Link
domain: Contract
range: Hire

liftings
type: Link
domain: Contract
range: Contract

checklist
type: Link
domain: Contract
max cardinality: 1
range: Checklist

checkedTasks
type: Link
domain: Contract
range: Task

checklistNotes
type: Property
domain: Contract
range: string

demurrageStatus
type: Property
domain: Contract
range: string

demurrageTimeBar
type: Property
domain: Contract
range: integer

demurragePaymentDate
type: Property
domain: Contract
range: dateTime

demurrageClaimDate
type: Property
domain: Contract
range: dateTime

finalDemurrageCost
type: Property
domain: Contract
range: string

finalDemurrageCostCurrency
type: Property
domain: Contract
range: string

demurragePaidByCharterer
type: Property
domain: Contract
range: string

demurragePaidByChartererCurrency
type: Property
domain: Contract
range: string

etaArrival
type: Property
domain: Contract
range: dateTime

etaArrivalDate
type: Property
domain: Contract
range: string

etaArrivalTime
type: Property
domain: Contract
range: string

redeliveryEtaArrival
type: Property
domain: Contract
range: dateTime

redeliveryEtaArrivalDate
type: Property
domain: Contract
range: string

redeliveryEtaArrivalTime
type: Property
domain: Contract
range: string

deliveryAproxNotice1
type: Property
domain: Contract
range: integer

deliveryAproxNotice2
type: Property
domain: Contract
range: integer

deliveryAproxNotice3
type: Property
domain: Contract
range: integer

deliveryAproxNotice4
type: Property
domain: Contract
range: integer

deliveryAproxNotice5
type: Property
domain: Contract
range: integer

deliveryAproxNotice6
type: Property
domain: Contract
range: integer

deliveryAproxNotice7
type: Property
domain: Contract
range: integer

deliveryFirmNotice1
type: Property
domain: Contract
range: integer

deliveryFirmNotice2
type: Property
domain: Contract
range: integer

deliveryFirmNotice3
type: Property
domain: Contract
range: integer

deliveryFirmNotice4
type: Property
domain: Contract
range: integer

deliveryFirmNotice5
type: Property
domain: Contract
range: integer

deliveryFirmNotice6
type: Property
domain: Contract
range: integer

deliveryFirmNotice7
type: Property
domain: Contract
range: integer

redeliveryAproxNotice1
type: Property
domain: Contract
range: integer

redeliveryAproxNotice2
type: Property
domain: Contract
range: integer

redeliveryAproxNotice3
type: Property
domain: Contract
range: integer

redeliveryAproxNotice4
type: Property
domain: Contract
range: integer

redeliveryAproxNotice5
type: Property
domain: Contract
range: integer

redeliveryAproxNotice6
type: Property
domain: Contract
range: integer

redeliveryAproxNotice7
type: Property
domain: Contract
range: integer

redeliveryFirmNotice1
type: Property
domain: Contract
range: integer

redeliveryFirmNotice2
type: Property
domain: Contract
range: integer

redeliveryFirmNotice3
type: Property
domain: Contract
range: integer

redeliveryFirmNotice4
type: Property
domain: Contract
range: integer

redeliveryFirmNotice5
type: Property
domain: Contract
range: integer

redeliveryFirmNotice6
type: Property
domain: Contract
range: integer

redeliveryFirmNotice7
type: Property
domain: Contract
range: integer

deliveryNoticesNotAplicable
type: Property
domain: Contract
range: boolean

redeliveryNoticesNotAplicable
type: Property
domain: Contract
range: boolean

shipDelivered
type: Property
domain: Contract
range: boolean

shipRedelivered
type: Property
domain: Contract
range: boolean

deliveryPort1
type: Link
domain: Contract
max cardinality: 1
range: Port

deliveryPort2
type: Link
domain: Contract
max cardinality: 1
range: Port

redeliveryPort1
type: Link
domain: Contract
max cardinality: 1
range: Port

redeliveryPort2
type: Link
domain: Contract
max cardinality: 1
range: Port

hirePerDay
type: Property
domain: Contract
range: string

hirePerDayCurrency
type: Property
domain: Contract
range: string

period
type: Property
domain: Contract
range: decimal

deliveryNotices
type: Link
domain: Contract
range: DeliveryNotice

redeliveryNotices
type: Link
domain: Contract
range: RedeliveryNotice

contractCoa
type: Link
domain: Contract
max cardinality: 1
range: Contract

loadPortsResume
type: Property
domain: Contract
range: string

dischargePortsResume
type: Property
domain: Contract
range: string

cargoResume
type: Property
domain: Contract
range: string

cargoVolumeM3
type: Property
domain: Contract
range: string

cargoVolumeMT
type: Property
domain: Contract
range: string

totalAmount
type: Property
domain: Contract
range: string

totalAmountCurrency
type: Property
domain: Contract
range: string

demurrageDeadline
type: Property
domain: Contract
range: dateTime

demurrageDaysLeft
type: Property
domain: Contract
range: integer

freightInvoiceStatus
type: Property
domain: Contract
range: string

freightInvoiceNumber
type: Property
domain: Contract
range: string

freightInvoiceOwnerNumber
type: Property
domain: Contract
range: string

freightInvoiceTaxAction
type: Property
domain: Contract
range: boolean

freightInvoiceFreightOrHire
type: Property
domain: Contract
range: string

freightInvoiceFreightOrHireCurrency
type: Property
domain: Contract
range: string

freightInvoiceAdditionalCost
type: Property
domain: Contract
range: string

freightInvoiceAdditionalCostCurrency
type: Property
domain: Contract
range: string

freightInvoiceTotalFreightOrHire
type: Property
domain: Contract
range: string

freightInvoiceTotalFreightOrHireCurrency
type: Property
domain: Contract
range: string

freightInvoiceTotalCommission
type: Property
domain: Contract
range: string

freightInvoiceTotalCommissionCurrency
type: Property
domain: Contract
range: string

freightInvoiceCabotagePtax
type: Property
domain: Contract
range: string

freightInvoiceCabotageTotalFreight
type: Property
domain: Contract
range: string

freightInvoiceCabotageTotalFreightCurrency
type: Property
domain: Contract
range: string

freightInvoiceCabotageTotalCommission
type: Property
domain: Contract
range: string

freightInvoiceCabotageTotalCommissionCurrency
type: Property
domain: Contract
range: string

freightInvoiceAmountReceived
type: Property
domain: Contract
range: string

freightInvoiceAmountReceivedCurrency
type: Property
domain: Contract
range: string

freightInvoiceDifference
type: Property
domain: Contract
range: string

freightInvoiceDifferenceCurrency
type: Property
domain: Contract
range: string

freightInvoicePaymentDate
type: Property
domain: Contract
range: dateTime

freightInvoiceDate
type: Property
domain: Contract
range: dateTime

freightInvoicePaymentInvoiceDiff
type: Property
domain: Contract
range: integer

freightInvoiceBankInvoiced
type: Property
domain: Contract
range: string

freightInvoiceComments
type: Property
domain: Contract
range: string

demurrageInvoiceStatus
type: Property
domain: Contract
range: string

demurrageInvoiceNumber
type: Property
domain: Contract
range: string

demurrageInvoiceOwnerNumber
type: Property
domain: Contract
range: string

demurrageInvoiceTaxAction
type: Property
domain: Contract
range: boolean

demurrageInvoiceTotalCommission
type: Property
domain: Contract
range: string

demurrageInvoiceTotalCommissionCurrency
type: Property
domain: Contract
range: string

demurrageInvoiceCabotagePtax
type: Property
domain: Contract
range: string

demurrageInvoiceCabotageTotalDemurrage
type: Property
domain: Contract
range: string

demurrageInvoiceCabotageTotalDemurrageCurrency
type: Property
domain: Contract
range: string

demurrageInvoiceCabotageTotalCommission
type: Property
domain: Contract
range: string

demurrageInvoiceCabotageTotalCommissionCurrency
type: Property
domain: Contract
range: string

demurrageInvoiceAmountReceived
type: Property
domain: Contract
range: string

demurrageInvoiceAmountReceivedCurrency
type: Property
domain: Contract
range: string

demurrageInvoiceDifference
type: Property
domain: Contract
range: string

demurrageInvoiceDifferenceCurrency
type: Property
domain: Contract
range: string

demurrageInvoicePaymentDate
type: Property
domain: Contract
range: dateTime

demurrageInvoiceDate
type: Property
domain: Contract
range: dateTime

demurrageInvoicePaymentInvoiceDiff
type: Property
domain: Contract
range: integer

demurrageInvoiceBankInvoiced
type: Property
domain: Contract
range: string

demurrageInvoiceComments
type: Property
domain: Contract
range: string

createdAt
type: Property
domain: Contract
range: dateTime

updatedAt
type: Property
domain: Contract
range: dateTime

ContractCargo
type: Class
title: ContractCargo
supported operation: Retrieves a ContractCargo resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ContractCargo resource.
  returns: ContractCargo

DeliveryNotice
type: Class
title: DeliveryNotice
supported operation: Retrieves a DeliveryNotice resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a DeliveryNotice resource.
  returns: DeliveryNotice

FinanceConsolidatedBrokerList
type: Class
title: FinanceConsolidatedBrokerList

FinanceConsolidatedCargoList
type: Class
title: FinanceConsolidatedCargoList

FinanceConsolidatedChartererList
type: Class
title: FinanceConsolidatedChartererList

FinanceConsolidatedContractList
type: Class
title: FinanceConsolidatedContractList

FinanceConsolidatedDeptList
type: Class
title: FinanceConsolidatedDeptList

FinanceConsolidatedOwnerList
type: Class
title: FinanceConsolidatedOwnerList

FinanceDashboard
type: Class
title: FinanceDashboard

Hire
type: Class
title: Hire
supported operation: Retrieves a Hire resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Hire resource.
  returns: Hire

MarketRumor
type: Class
title: MarketRumor
supported property: SupportedProperty
  property: registerDate
  title: registerDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: dwt
  title: dwt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: laycanStartDate
  title: laycanStartDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: laycanEndDate
  title: laycanEndDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: vessel
  title: vessel
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: owner
  title: owner
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: charterer
  title: charterer
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: charterer2
  title: charterer2
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: broker
  title: broker
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: freightCost
  title: freightCost
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: freightCostCurrency
  title: freightCostCurrency
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: freightType
  title: freightType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: portCalls
  title: portCalls
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cargoItems
  title: cargoItems
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: notes
  title: notes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: loadPortsResume
  title: loadPortsResume
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: dischargePortsResume
  title: dischargePortsResume
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: cargoResume
  title: cargoResume
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: cargoVolumeM3
  title: cargoVolumeM3
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: cargoVolumeMT
  title: cargoVolumeMT
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
  description: Returns createdAt.
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
  description: Returns updatedAt.
supported operation: Retrieves a MarketRumor resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a MarketRumor resource.
  returns: MarketRumor
supported operation: Replaces the MarketRumor resource.
  type: Operation
  type: ReplaceAction
  expects: MarketRumor
  method: PUT
  title: Replaces the MarketRumor resource.
  returns: MarketRumor
supported operation: Deletes the MarketRumor resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the MarketRumor resource.
  returns: Nothing

registerDate
type: Property
domain: MarketRumor
range: dateTime

dwt
type: Property
domain: MarketRumor
range: string

laycanStartDate
type: Property
domain: MarketRumor
range: dateTime

laycanEndDate
type: Property
domain: MarketRumor
range: dateTime

vessel
type: Link
domain: MarketRumor
max cardinality: 1
range: Vessel

owner
type: Link
domain: MarketRumor
max cardinality: 1
range: Owner

charterer
type: Link
domain: MarketRumor
max cardinality: 1
range: Charterer

charterer2
type: Link
domain: MarketRumor
max cardinality: 1
range: Charterer

broker
type: Property
domain: MarketRumor
range: string

status
type: Property
domain: MarketRumor
range: string

freightCost
type: Property
domain: MarketRumor
range: string

freightCostCurrency
type: Property
domain: MarketRumor
range: string

freightType
type: Property
domain: MarketRumor
range: string

portCalls
type: Link
domain: MarketRumor
range: MarketRumorPort

cargoItems
type: Link
domain: MarketRumor
range: MarketRumorCargo

notes
type: Property
domain: MarketRumor
range: string

loadPortsResume
type: Property
domain: MarketRumor
range: string

dischargePortsResume
type: Property
domain: MarketRumor
range: string

cargoResume
type: Property
domain: MarketRumor
range: string

cargoVolumeM3
type: Property
domain: MarketRumor
range: string

cargoVolumeMT
type: Property
domain: MarketRumor
range: string

createdAt
type: Property
domain: MarketRumor
range: dateTime

updatedAt
type: Property
domain: MarketRumor
range: dateTime

MarketRumorCargo
type: Class
title: MarketRumorCargo
supported operation: Retrieves a MarketRumorCargo resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a MarketRumorCargo resource.
  returns: MarketRumorCargo

MarketRumorPort
type: Class
title: MarketRumorPort
supported operation: Retrieves a MarketRumorPort resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a MarketRumorPort resource.
  returns: MarketRumorPort

Media
type: Class
title: Media
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contentUrl
  title: contentUrl
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: contentSize
  title: contentSize
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: encodingFormat
  title: encodingFormat
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: uploadDate
  title: uploadDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: genre
  title: genre
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: file
  title: file
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: filePath
  title: filePath
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contract
  title: contract
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
  description: Returns createdAt.
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
  description: Returns updatedAt.
supported operation: Retrieves a Media resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Media resource.
  returns: Media
supported operation: Replaces the Media resource.
  type: Operation
  type: ReplaceAction
  expects: Media
  method: PUT
  title: Replaces the Media resource.
  returns: Media
supported operation: Deletes the Media resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Media resource.
  returns: Nothing

name
type: Property
domain: Media
range: string

contentUrl
type: Property
domain: Media
range: string

contentSize
type: Property
domain: Media
range: string

encodingFormat
type: Property
domain: Media
range: string

uploadDate
type: Property
domain: Media
range: dateTime

genre
type: Property
domain: Media
range: string

file
type: Property
domain: Media

filePath
type: Property
domain: Media
range: string

contract
type: Link
domain: Media
max cardinality: 1
range: Contract

createdAt
type: Property
domain: Media
range: dateTime

updatedAt
type: Property
domain: Media
range: dateTime

OperationDashboard
type: Class
title: OperationDashboard

OperationIncident
type: Class
title: OperationIncident
supported operation: Retrieves a OperationIncident resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a OperationIncident resource.
  returns: OperationIncident

OperationReport
type: Class
title: OperationReport
supported operation: Retrieves a OperationReport resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a OperationReport resource.
  returns: OperationReport

Owner
type: Class
title: Owner
supported property: SupportedProperty
  property: companyName
  title: companyName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: detailedCompanyName
  title: detailedCompanyName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: addressLine1
  title: addressLine1
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: addressLine2
  title: addressLine2
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: addressLine3
  title: addressLine3
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: charteringEmail
  title: charteringEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: operationsEmail
  title: operationsEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accountingEmail
  title: accountingEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: vessels
  title: vessels
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contracts
  title: contracts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: marketRumors
  title: marketRumors
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
  description: Returns createdAt.
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
  description: Returns updatedAt.
supported operation: Retrieves a Owner resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Owner resource.
  returns: Owner
supported operation: Replaces the Owner resource.
  type: Operation
  type: ReplaceAction
  expects: Owner
  method: PUT
  title: Replaces the Owner resource.
  returns: Owner
supported operation: Deletes the Owner resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Owner resource.
  returns: Nothing

companyName
type: Property
domain: Owner
range: string

detailedCompanyName
type: Property
domain: Owner
range: string

addressLine1
type: Property
domain: Owner
range: string

addressLine2
type: Property
domain: Owner
range: string

addressLine3
type: Property
domain: Owner
range: string

charteringEmail
type: Property
domain: Owner
range: string

operationsEmail
type: Property
domain: Owner
range: string

accountingEmail
type: Property
domain: Owner
range: string

vessels
type: Link
domain: Owner
range: Vessel

contracts
type: Link
domain: Owner
range: Contract

marketRumors
type: Link
domain: Owner
range: MarketRumor

createdAt
type: Property
domain: Owner
range: dateTime

updatedAt
type: Property
domain: Owner
range: dateTime

Payment
type: Class
title: Payment
supported operation: Retrieves a Payment resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Payment resource.
  returns: Payment

Port
type: Class
title: Port
supported property: SupportedProperty
  property: portName
  title: portName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: geographicLocation
  title: geographicLocation
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: berths
  title: berths
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: berthCount
  title: berthCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: costInformationSource
  title: costInformationSource
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: country
  title: country
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: portCalls
  title: portCalls
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: operationReports
  title: operationReports
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: deliveryPorts1
  title: deliveryPorts1
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: deliveryPorts2
  title: deliveryPorts2
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: redeliveryPorts1
  title: redeliveryPorts1
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: redeliveryPorts2
  title: redeliveryPorts2
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
  description: Returns createdAt.
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
  description: Returns updatedAt.
supported operation: Retrieves a Port resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Port resource.
  returns: Port
supported operation: Replaces the Port resource.
  type: Operation
  type: ReplaceAction
  expects: Port
  method: PUT
  title: Replaces the Port resource.
  returns: Port
supported operation: Deletes the Port resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Port resource.
  returns: Nothing

portName
type: Property
domain: Port
range: string

geographicLocation
type: Property
domain: Port
range: string

berths
type: Link
domain: Port
range: Berth

berthCount
type: Property
domain: Port
range: integer

costInformationSource
type: Property
domain: Port
range: string

state
type: Property
domain: Port
range: string

country
type: Property
domain: Port
range: string

portCalls
type: Link
domain: Port
range: PortCall

operationReports
type: Link
domain: Port
range: OperationReport

deliveryPorts1
type: Link
domain: Port
range: Contract

deliveryPorts2
type: Link
domain: Port
range: Contract

redeliveryPorts1
type: Link
domain: Port
range: Contract

redeliveryPorts2
type: Link
domain: Port
range: Contract

createdAt
type: Property
domain: Port
range: dateTime

updatedAt
type: Property
domain: Port
range: dateTime

PortCall
type: Class
title: PortCall
supported operation: Retrieves a PortCall resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a PortCall resource.
  returns: PortCall

RedeliveryNotice
type: Class
title: RedeliveryNotice
supported operation: Retrieves a RedeliveryNotice resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a RedeliveryNotice resource.
  returns: RedeliveryNotice

Report
type: Class
title: Report

Task
type: Class
title: Task
supported operation: Retrieves a Task resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Task resource.
  returns: Task

User
type: Class
title: User
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: password
  title: password
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: plainPassword
  title: plainPassword
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: confirmationToken
  title: confirmationToken
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: avatar
  title: avatar
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: desk
  title: desk
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contracts
  title: contracts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: operations
  title: operations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
  description: Returns createdAt.
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
  description: Returns updatedAt.
supported property: SupportedProperty
  property: userIdentifier
  title: userIdentifier
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User
supported operation: Replaces the User resource.
  type: Operation
  type: ReplaceAction
  expects: User
  method: PUT
  title: Replaces the User resource.
  returns: User
supported operation: Deletes the User resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the User resource.
  returns: Nothing

name
type: Property
domain: User
range: string

email
type: Property
domain: User
range: string

roles
type: Property
domain: User

password
type: Property
domain: User
range: string

plainPassword
type: Property
domain: User
range: string

confirmationToken
type: Property
domain: User
range: string

avatar
type: Link
domain: User
max cardinality: 1
range: Media

desk
type: Property
domain: User
range: string

contracts
type: Link
domain: User
range: Contract

operations
type: Link
domain: User
range: Contract

createdAt
type: Property
domain: User
range: dateTime

updatedAt
type: Property
domain: User
range: dateTime

userIdentifier
type: Property
domain: User
range: string

Vessel
type: Class
title: Vessel
supported property: SupportedProperty
  property: vesselName
  title: vesselName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: imoNumber
  title: imoNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: vesselType
  title: vesselType
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: tankerType
  title: tankerType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: bulkerType
  title: bulkerType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: tankCoating
  title: tankCoating
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: dwt
  title: dwt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: yearBuilt
  title: yearBuilt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: owner
  title: owner
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: observations
  title: observations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: boxShape
  title: boxShape
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: openHatch
  title: openHatch
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nitrogenGenerator
  title: nitrogenGenerator
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: imoClass
  title: imoClass
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contracts
  title: contracts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: marketRumors
  title: marketRumors
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
  description: Returns createdAt.
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
  description: Returns updatedAt.
supported operation: Retrieves a Vessel resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Vessel resource.
  returns: Vessel
supported operation: Replaces the Vessel resource.
  type: Operation
  type: ReplaceAction
  expects: Vessel
  method: PUT
  title: Replaces the Vessel resource.
  returns: Vessel
supported operation: Deletes the Vessel resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Vessel resource.
  returns: Nothing

vesselName
type: Property
domain: Vessel
range: string

imoNumber
type: Property
domain: Vessel
range: string

vesselType
type: Property
domain: Vessel
range: string

tankerType
type: Property
domain: Vessel
range: string

bulkerType
type: Property
domain: Vessel
range: string

tankCoating
type: Property
domain: Vessel
range: string

dwt
type: Property
domain: Vessel
range: string

yearBuilt
type: Property
domain: Vessel
range: integer

owner
type: Link
domain: Vessel
max cardinality: 1
range: Owner

observations
type: Property
domain: Vessel
range: string

boxShape
type: Property
domain: Vessel
range: boolean

openHatch
type: Property
domain: Vessel
range: boolean

nitrogenGenerator
type: Property
domain: Vessel
range: boolean

imoClass
type: Property
domain: Vessel
range: integer

contracts
type: Link
domain: Vessel
range: Contract

marketRumors
type: Link
domain: Vessel
range: MarketRumor

createdAt
type: Property
domain: Vessel
range: dateTime

updatedAt
type: Property
domain: Vessel
range: dateTime

Entrypoint
type: Class
title: The API entrypoint
supported property: SupportedProperty
  property: The collection of Cargo resources
  title: The collection of Cargo resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Charterer resources
  title: The collection of Charterer resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Checklist resources
  title: The collection of Checklist resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Contract resources
  title: The collection of Contract resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of FinanceConsolidatedBrokerList resources
  title: The collection of FinanceConsolidatedBrokerList resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of FinanceConsolidatedCargoList resources
  title: The collection of FinanceConsolidatedCargoList resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of FinanceConsolidatedChartererList resources
  title: The collection of FinanceConsolidatedChartererList resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of FinanceConsolidatedContractList resources
  title: The collection of FinanceConsolidatedContractList resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of FinanceConsolidatedDeptList resources
  title: The collection of FinanceConsolidatedDeptList resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of FinanceConsolidatedOwnerList resources
  title: The collection of FinanceConsolidatedOwnerList resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of FinanceDashboard resources
  title: The collection of FinanceDashboard resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of MarketRumor resources
  title: The collection of MarketRumor resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Media resources
  title: The collection of Media resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of OperationDashboard resources
  title: The collection of OperationDashboard resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Owner resources
  title: The collection of Owner resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Port resources
  title: The collection of Port resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Report resources
  title: The collection of Report resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of User resources
  title: The collection of User resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Vessel resources
  title: The collection of Vessel resources
  readable: true
  writeable: false
supported operation: The API entrypoint.
  type: Operation
  method: GET
  returns: EntryPoint

The collection of Cargo resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Cargo
supported operation: Retrieves the collection of Cargo resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Cargo resources.
  returns: Collection
supported operation: Creates a Cargo resource.
  type: Operation
  type: CreateAction
  expects: Cargo
  method: POST
  title: Creates a Cargo resource.
  returns: Cargo

The collection of Charterer resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Charterer
supported operation: Retrieves the collection of Charterer resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Charterer resources.
  returns: Collection
supported operation: Creates a Charterer resource.
  type: Operation
  type: CreateAction
  expects: Charterer
  method: POST
  title: Creates a Charterer resource.
  returns: Charterer

The collection of Checklist resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Checklist
supported operation: Retrieves the collection of Checklist resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Checklist resources.
  returns: Collection
supported operation: Creates a Checklist resource.
  type: Operation
  type: CreateAction
  expects: Checklist
  method: POST
  title: Creates a Checklist resource.
  returns: Checklist

The collection of Contract resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Contract
supported operation: Retrieves the collection of Contract resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Contract resources.
  returns: Collection
supported operation: Creates a Contract resource.
  type: Operation
  type: CreateAction
  expects: Contract
  method: POST
  title: Creates a Contract resource.
  returns: Contract

The collection of FinanceConsolidatedBrokerList resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: FinanceConsolidatedBrokerList
supported operation: Retrieves the collection of FinanceConsolidatedBrokerList resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of FinanceConsolidatedBrokerList resources.
  returns: Collection

The collection of FinanceConsolidatedCargoList resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: FinanceConsolidatedCargoList
supported operation: Retrieves the collection of FinanceConsolidatedCargoList resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of FinanceConsolidatedCargoList resources.
  returns: Collection

The collection of FinanceConsolidatedChartererList resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: FinanceConsolidatedChartererList
supported operation: Retrieves the collection of FinanceConsolidatedChartererList resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of FinanceConsolidatedChartererList resources.
  returns: Collection

The collection of FinanceConsolidatedContractList resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: FinanceConsolidatedContractList
supported operation: Retrieves the collection of FinanceConsolidatedContractList resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of FinanceConsolidatedContractList resources.
  returns: Collection

The collection of FinanceConsolidatedDeptList resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: FinanceConsolidatedDeptList
supported operation: Retrieves the collection of FinanceConsolidatedDeptList resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of FinanceConsolidatedDeptList resources.
  returns: Collection

The collection of FinanceConsolidatedOwnerList resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: FinanceConsolidatedOwnerList
supported operation: Retrieves the collection of FinanceConsolidatedOwnerList resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of FinanceConsolidatedOwnerList resources.
  returns: Collection

The collection of FinanceDashboard resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: FinanceDashboard
supported operation: Retrieves the collection of FinanceDashboard resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of FinanceDashboard resources.
  returns: Collection

The collection of MarketRumor resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: MarketRumor
supported operation: Retrieves the collection of MarketRumor resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of MarketRumor resources.
  returns: Collection
supported operation: Creates a MarketRumor resource.
  type: Operation
  type: CreateAction
  expects: MarketRumor
  method: POST
  title: Creates a MarketRumor resource.
  returns: MarketRumor

The collection of Media resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Media
supported operation: Retrieves the collection of Media resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Media resources.
  returns: Collection
supported operation: Creates a Media resource.
  type: Operation
  type: CreateAction
  expects: Media
  method: POST
  title: Creates a Media resource.
  returns: Media

The collection of OperationDashboard resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: OperationDashboard
supported operation: Retrieves the collection of OperationDashboard resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of OperationDashboard resources.
  returns: Collection

The collection of Owner resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Owner
supported operation: Retrieves the collection of Owner resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Owner resources.
  returns: Collection
supported operation: Creates a Owner resource.
  type: Operation
  type: CreateAction
  expects: Owner
  method: POST
  title: Creates a Owner resource.
  returns: Owner

The collection of Port resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Port
supported operation: Retrieves the collection of Port resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Port resources.
  returns: Collection
supported operation: Creates a Port resource.
  type: Operation
  type: CreateAction
  expects: Port
  method: POST
  title: Creates a Port resource.
  returns: Port

The collection of Report resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Report
supported operation: Retrieves the collection of Report resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Report resources.
  returns: Collection

The collection of User resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Retrieves the collection of User resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of User resources.
  returns: Collection
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User

The collection of Vessel resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Vessel
supported operation: Retrieves the collection of Vessel resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Vessel resources.
  returns: Collection
supported operation: Creates a Vessel resource.
  type: Operation
  type: CreateAction
  expects: Vessel
  method: POST
  title: Creates a Vessel resource.
  returns: Vessel

ConstraintViolation
type: Class
title: A constraint violation
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolation
range: string

message
type: Property
domain: ConstraintViolation
range: string

ConstraintViolationList
type: Class
subclass of: Error
title: A constraint violation list
supported property: SupportedProperty
  property: violations
  title: violations
  description: The violations
  readable: true
  writeable: false

violations
type: Property
domain: ConstraintViolationList
range: ConstraintViolation

SupportedProperty
property: checklistNotes
title: checklistNotes
required: false
readable: true
writeable: true

SupportedProperty
property: demurrageStatus
title: demurrageStatus
required: false
readable: true
writeable: true

SupportedProperty
property: demurrageTimeBar
title: demurrageTimeBar
required: false
readable: true
writeable: true

SupportedProperty
property: demurragePaymentDate
title: demurragePaymentDate
required: false
readable: true
writeable: true

SupportedProperty
property: demurrageClaimDate
title: demurrageClaimDate
required: false
readable: true
writeable: true

SupportedProperty
property: finalDemurrageCost
title: finalDemurrageCost
required: false
readable: true
writeable: true

SupportedProperty
property: finalDemurrageCostCurrency
title: finalDemurrageCostCurrency
required: false
readable: true
writeable: true

SupportedProperty
property: demurragePaidByCharterer
title: demurragePaidByCharterer
required: false
readable: true
writeable: true

SupportedProperty
property: demurragePaidByChartererCurrency
title: demurragePaidByChartererCurrency
required: false
readable: true
writeable: true

SupportedProperty
property: etaArrival
title: etaArrival
required: false
readable: true
writeable: true

SupportedProperty
property: etaArrivalDate
title: etaArrivalDate
required: false
readable: true
writeable: false

SupportedProperty
property: etaArrivalTime
title: etaArrivalTime
required: false
readable: true
writeable: false

SupportedProperty
property: redeliveryEtaArrival
title: redeliveryEtaArrival
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryEtaArrivalDate
title: redeliveryEtaArrivalDate
required: false
readable: true
writeable: false

SupportedProperty
property: redeliveryEtaArrivalTime
title: redeliveryEtaArrivalTime
required: false
readable: true
writeable: false

SupportedProperty
property: deliveryAproxNotice1
title: deliveryAproxNotice1
required: false
readable: true
writeable: true

SupportedProperty
property: deliveryAproxNotice2
title: deliveryAproxNotice2
required: false
readable: true
writeable: true

SupportedProperty
property: deliveryAproxNotice3
title: deliveryAproxNotice3
required: false
readable: true
writeable: true

SupportedProperty
property: deliveryAproxNotice4
title: deliveryAproxNotice4
required: false
readable: true
writeable: true

SupportedProperty
property: deliveryAproxNotice5
title: deliveryAproxNotice5
required: false
readable: true
writeable: true

SupportedProperty
property: deliveryAproxNotice6
title: deliveryAproxNotice6
required: false
readable: true
writeable: true

SupportedProperty
property: deliveryAproxNotice7
title: deliveryAproxNotice7
required: false
readable: true
writeable: true

SupportedProperty
property: deliveryFirmNotice1
title: deliveryFirmNotice1
required: false
readable: true
writeable: true

SupportedProperty
property: deliveryFirmNotice2
title: deliveryFirmNotice2
required: false
readable: true
writeable: true

SupportedProperty
property: deliveryFirmNotice3
title: deliveryFirmNotice3
required: false
readable: true
writeable: true

SupportedProperty
property: deliveryFirmNotice4
title: deliveryFirmNotice4
required: false
readable: true
writeable: true

SupportedProperty
property: deliveryFirmNotice5
title: deliveryFirmNotice5
required: false
readable: true
writeable: true

SupportedProperty
property: deliveryFirmNotice6
title: deliveryFirmNotice6
required: false
readable: true
writeable: true

SupportedProperty
property: deliveryFirmNotice7
title: deliveryFirmNotice7
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryAproxNotice1
title: redeliveryAproxNotice1
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryAproxNotice2
title: redeliveryAproxNotice2
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryAproxNotice3
title: redeliveryAproxNotice3
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryAproxNotice4
title: redeliveryAproxNotice4
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryAproxNotice5
title: redeliveryAproxNotice5
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryAproxNotice6
title: redeliveryAproxNotice6
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryAproxNotice7
title: redeliveryAproxNotice7
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryFirmNotice1
title: redeliveryFirmNotice1
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryFirmNotice2
title: redeliveryFirmNotice2
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryFirmNotice3
title: redeliveryFirmNotice3
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryFirmNotice4
title: redeliveryFirmNotice4
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryFirmNotice5
title: redeliveryFirmNotice5
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryFirmNotice6
title: redeliveryFirmNotice6
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryFirmNotice7
title: redeliveryFirmNotice7
required: false
readable: true
writeable: true

SupportedProperty
property: deliveryNoticesNotAplicable
title: deliveryNoticesNotAplicable
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryNoticesNotAplicable
title: redeliveryNoticesNotAplicable
required: false
readable: true
writeable: true

SupportedProperty
property: shipDelivered
title: shipDelivered
required: false
readable: true
writeable: true

SupportedProperty
property: shipRedelivered
title: shipRedelivered
required: false
readable: true
writeable: true

SupportedProperty
property: deliveryPort1
title: deliveryPort1
required: false
readable: true
writeable: true

SupportedProperty
property: deliveryPort2
title: deliveryPort2
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryPort1
title: redeliveryPort1
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryPort2
title: redeliveryPort2
required: false
readable: true
writeable: true

SupportedProperty
property: hirePerDay
title: hirePerDay
required: false
readable: true
writeable: true

SupportedProperty
property: hirePerDayCurrency
title: hirePerDayCurrency
required: false
readable: true
writeable: true

SupportedProperty
property: period
title: period
required: false
readable: true
writeable: true

SupportedProperty
property: deliveryNotices
title: deliveryNotices
required: false
readable: true
writeable: true

SupportedProperty
property: redeliveryNotices
title: redeliveryNotices
required: false
readable: true
writeable: true

SupportedProperty
property: contractCoa
title: contractCoa
required: false
readable: true
writeable: true

SupportedProperty
property: loadPortsResume
title: loadPortsResume
required: false
readable: true
writeable: false

SupportedProperty
property: dischargePortsResume
title: dischargePortsResume
required: false
readable: true
writeable: false

SupportedProperty
property: cargoResume
title: cargoResume
required: false
readable: true
writeable: false

SupportedProperty
property: cargoVolumeM3
title: cargoVolumeM3
required: false
readable: true
writeable: false

SupportedProperty
property: cargoVolumeMT
title: cargoVolumeMT
required: false
readable: true
writeable: false

SupportedProperty
property: totalAmount
title: totalAmount
required: false
readable: true
writeable: false

SupportedProperty
property: totalAmountCurrency
title: totalAmountCurrency
required: false
readable: true
writeable: false

SupportedProperty
property: demurrageDeadline
title: demurrageDeadline
required: false
readable: true
writeable: false

SupportedProperty
property: demurrageDaysLeft
title: demurrageDaysLeft
required: false
readable: true
writeable: false

SupportedProperty
property: freightInvoiceStatus
title: freightInvoiceStatus
required: false
readable: true
writeable: true

SupportedProperty
property: freightInvoiceNumber
title: freightInvoiceNumber
required: false
readable: true
writeable: true

SupportedProperty
property: freightInvoiceOwnerNumber
title: freightInvoiceOwnerNumber
required: false
readable: true
writeable: true

SupportedProperty
property: freightInvoiceTaxAction
title: freightInvoiceTaxAction
required: false
readable: true
writeable: true

SupportedProperty
property: freightInvoiceFreightOrHire
title: freightInvoiceFreightOrHire
required: false
readable: true
writeable: false

SupportedProperty
property: freightInvoiceFreightOrHireCurrency
title: freightInvoiceFreightOrHireCurrency
required: false
readable: true
writeable: false

SupportedProperty
property: freightInvoiceAdditionalCost
title: freightInvoiceAdditionalCost
required: false
readable: true
writeable: true

SupportedProperty
property: freightInvoiceAdditionalCostCurrency
title: freightInvoiceAdditionalCostCurrency
required: false
readable: true
writeable: true

SupportedProperty
property: freightInvoiceTotalFreightOrHire
title: freightInvoiceTotalFreightOrHire
required: false
readable: true
writeable: false

SupportedProperty
property: freightInvoiceTotalFreightOrHireCurrency
title: freightInvoiceTotalFreightOrHireCurrency
required: false
readable: true
writeable: false

SupportedProperty
property: freightInvoiceTotalCommission
title: freightInvoiceTotalCommission
required: false
readable: true
writeable: false

SupportedProperty
property: freightInvoiceTotalCommissionCurrency
title: freightInvoiceTotalCommissionCurrency
required: false
readable: true
writeable: true

SupportedProperty
property: freightInvoiceCabotagePtax
title: freightInvoiceCabotagePtax
required: false
readable: true
writeable: true

SupportedProperty
property: freightInvoiceCabotageTotalFreight
title: freightInvoiceCabotageTotalFreight
required: false
readable: true
writeable: false

SupportedProperty
property: freightInvoiceCabotageTotalFreightCurrency
title: freightInvoiceCabotageTotalFreightCurrency
required: false
readable: true
writeable: false

SupportedProperty
property: freightInvoiceCabotageTotalCommission
title: freightInvoiceCabotageTotalCommission
required: false
readable: true
writeable: false

SupportedProperty
property: freightInvoiceCabotageTotalCommissionCurrency
title: freightInvoiceCabotageTotalCommissionCurrency
required: false
readable: true
writeable: false

SupportedProperty
property: freightInvoiceAmountReceived
title: freightInvoiceAmountReceived
required: false
readable: true
writeable: true

SupportedProperty
property: freightInvoiceAmountReceivedCurrency
title: freightInvoiceAmountReceivedCurrency
required: false
readable: true
writeable: true

SupportedProperty
property: freightInvoiceDifference
title: freightInvoiceDifference
required: false
readable: true
writeable: false

SupportedProperty
property: freightInvoiceDifferenceCurrency
title: freightInvoiceDifferenceCurrency
required: false
readable: true
writeable: false

SupportedProperty
property: freightInvoicePaymentDate
title: freightInvoicePaymentDate
required: false
readable: true
writeable: true

SupportedProperty
property: freightInvoiceDate
title: freightInvoiceDate
required: false
readable: true
writeable: true

SupportedProperty
property: freightInvoicePaymentInvoiceDiff
title: freightInvoicePaymentInvoiceDiff
required: false
readable: true
writeable: true

SupportedProperty
property: freightInvoiceBankInvoiced
title: freightInvoiceBankInvoiced
required: false
readable: true
writeable: true

SupportedProperty
property: freightInvoiceComments
title: freightInvoiceComments
required: false
readable: true
writeable: true

SupportedProperty
property: demurrageInvoiceStatus
title: demurrageInvoiceStatus
required: false
readable: true
writeable: true

SupportedProperty
property: demurrageInvoiceNumber
title: demurrageInvoiceNumber
required: false
readable: true
writeable: true

SupportedProperty
property: demurrageInvoiceOwnerNumber
title: demurrageInvoiceOwnerNumber
required: false
readable: true
writeable: true

SupportedProperty
property: demurrageInvoiceTaxAction
title: demurrageInvoiceTaxAction
required: false
readable: true
writeable: true

SupportedProperty
property: demurrageInvoiceTotalCommission
title: demurrageInvoiceTotalCommission
required: false
readable: true
writeable: false

SupportedProperty
property: demurrageInvoiceTotalCommissionCurrency
title: demurrageInvoiceTotalCommissionCurrency
required: false
readable: true
writeable: false

SupportedProperty
property: demurrageInvoiceCabotagePtax
title: demurrageInvoiceCabotagePtax
required: false
readable: true
writeable: true

SupportedProperty
property: demurrageInvoiceCabotageTotalDemurrage
title: demurrageInvoiceCabotageTotalDemurrage
required: false
readable: true
writeable: false

SupportedProperty
property: demurrageInvoiceCabotageTotalDemurrageCurrency
title: demurrageInvoiceCabotageTotalDemurrageCurrency
required: false
readable: true
writeable: false

SupportedProperty
property: demurrageInvoiceCabotageTotalCommission
title: demurrageInvoiceCabotageTotalCommission
required: false
readable: true
writeable: false

SupportedProperty
property: demurrageInvoiceCabotageTotalCommissionCurrency
title: demurrageInvoiceCabotageTotalCommissionCurrency
required: false
readable: true
writeable: false

SupportedProperty
property: demurrageInvoiceAmountReceived
title: demurrageInvoiceAmountReceived
required: false
readable: true
writeable: true

SupportedProperty
property: demurrageInvoiceAmountReceivedCurrency
title: demurrageInvoiceAmountReceivedCurrency
required: false
readable: true
writeable: true

SupportedProperty
property: demurrageInvoiceDifference
title: demurrageInvoiceDifference
required: false
readable: true
writeable: false

SupportedProperty
property: demurrageInvoiceDifferenceCurrency
title: demurrageInvoiceDifferenceCurrency
required: false
readable: true
writeable: false

SupportedProperty
property: demurrageInvoicePaymentDate
title: demurrageInvoicePaymentDate
required: false
readable: true
writeable: true

SupportedProperty
property: demurrageInvoiceDate
title: demurrageInvoiceDate
required: false
readable: true
writeable: true

SupportedProperty
property: demurrageInvoicePaymentInvoiceDiff
title: demurrageInvoicePaymentInvoiceDiff
required: false
readable: true
writeable: true

SupportedProperty
property: demurrageInvoiceBankInvoiced
title: demurrageInvoiceBankInvoiced
required: false
readable: true
writeable: true

SupportedProperty
property: demurrageInvoiceComments
title: demurrageInvoiceComments
required: false
readable: true
writeable: true

SupportedProperty
property: createdAt
title: createdAt
required: false
readable: true
writeable: true
description: Returns createdAt.

SupportedProperty
property: updatedAt
title: updatedAt
required: false
readable: true
writeable: true
description: Returns updatedAt.

Retrieves a Contract resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Contract resource.
returns: Contract

Replaces the Contract resource.
type: Operation
type: ReplaceAction
expects: Contract
method: PUT
title: Replaces the Contract resource.
returns: Contract

Deletes the Contract resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the Contract resource.
returns: Nothing