/VoyageHeader

Short Description

Chapter Contents:

Long Description

Supported Methods

GET /VoyageHeader

Get a list of VoyageHeader objects. Filter to avoid huge amounts of data (see Filtering for search parameters).

GET /VoyageHeader/{key}

Get a single VoyageHeader object.

PUT /VoyageHeader/{key}

Update an existing VoyageHeader. Unchanged properties need not be updated.

Properties

Property	Type	Length	Mandatory	Comments
referenceNo	String	16		The referenceNo will be set based on customer specific setup when posting a VoyageHeader, setting referenceNo using the API will have no effect. Properties used for setting up referenceNo's are typically: voyageHeader.vesselCode, voyageHeader.voyageStartYear, voyageHeader.voyageNo
vesselCode	/VesselCode		Yes
voyageSnapshots	Array of /VoyageSnapshot
offhires	Array of /Offhire
bunkersProfitLoss	Float
dlConsumptionOffhire	Float
dlPriceEndOfVoyage	Float
dlPriceVoyageStart	Float
dlProfitLoss	Float
dlProfitLossTcIn	Float
dlRobVoyageStart	Float
dlSulphurPctVoyageStart	Float
doConsumptionOffhire	Float
doPriceEndOfVoyage	Float
doPriceVoyageStart	Float
doProfitLoss	Float
doProfitLossTcIn	Float
doRobVoyageStart	Float
doSulphurPctVoyageStart	Float
flConsumptionOffhire	Float
flIndexPriceAdd	Float
flPriceEndOfVoyage	Float
flPriceVoyageStart	Float
flProfitLoss	Float
flProfitLossTcIn	Float
flRobVoyageStart	Float
flSulphurPctVoyageStart	Float
foConsumptionOffhire	Float
foIndexPriceAdd	Float
foPriceEndOfVoyage	Float
foPriceVoyageStart	Float
foProfitLoss	Float
foProfitLossHedge	Float
foProfitLossTcIn	Float
foRobVoyageStart	Float
foSulphurPctVoyageStart	Float
isBudget	Boolean
isDlPriceFixed	Boolean
isDoFixed	Boolean
isDoPriceFixed	Boolean
isEstimate	Boolean
isFlPriceFixed	Boolean
isFoFixed	Boolean
isFoPriceFixed	Boolean
isLastVoyage	Boolean
isVoyageStartFixed	Boolean
tcBenchmarkPercent	Float
timezoneOffset	Float
tradeVoyageNo	Integer
vesselEarningPoint	Float
voyageNo	Integer
voyageStartDate	Date
voyageStartYear	Integer
budgetVersion	/BudgetVersion
businessUnit	/BusinessUnit
charteringResponsible	/User
accountantResponsible	/User
company	/Company
flIndex	/MarketIndex
foIndex	/MarketIndex
leg	/Leg
master	/Individual
operator	/User
pattern	/Pattern
pool	/Pool
route	/Route
tcBenchmarkIndex	/MarketIndex
voyage	/Voyage		Yes
voyageStatus	/StatusType			With StatusClass "VOY"
isTemplate	Boolean		Yes	Available from version 5.42
templateVoyageHeader	Integer			Available from version 5.42
vcs	Array of /Vc			Available from version 6.19.0
preliminaryVoyage	/Voyage			Available from version 6.21.0
voyageEndDate	Date			The departure date of the last port call of the voyage

Response Body Example

Updated for API version 2.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)

{
    "key": 1106614,
    "self": "http://localhost:8080/ws/rest/VoyageHeader/1106614",
    "voyageStartDate": "2012-08-30T07:43:00",
    "vesselCode": {
        "key": 1089871,
        "self": "http://localhost:8080/ws/rest/VesselCode/1089871",
        "vesselCode": "103"
    },
    "master": null,
    "pool": null,
    "createdDate": "2012-10-01T14:55:00",
    "modifiedDate": "2014-05-22T04:50:04",
    "referenceNo": "1031208",
    "voyageStatus": {
        "key": 1000140,
        "self": "http://localhost:8080/ws/rest/StatusType/1000140",
        "statusTypeCode": "FIN",
        "statusTypeDesc": "Closed"
    },
    "voyageSnapshots": [
        {
            "key": 1106616,
            "self": "http://localhost:8080/ws/rest/VoyageSnapshot/1106616",
            "voyageSnapshotDesc": "Preliminary",
            "voyage": "http://localhost:8080/ws/rest/Voyage/1106572"
        }
    ],
    "doConsumptionOffhire": 0,
    "foConsumptionOffhire": 0,
    "businessUnit": {
        "key": 1063500,
        "self": "http://localhost:8080/ws/rest/BusinessUnit/1063500",
        "businessUnitName": "Africa",
        "businessUnitCode": "AFRICA"
    },
    "voyage": {
        "referenceNo": 188,
        "vessel": {
            "vesselName": "MV Vessel",
            "self": "http://localhost:8080/ws/rest/Vessel/1089713",
            "key": 1089713
        },
        "ballastPort": {
            "portName": "ITAQUI",
            "unLoCode": "BRIQI",
            "country": {
                "countryCode": "BR",
                "countryName": "BRAZIL",
                "key": 410028,
                "self": "http://localhost:8080/ws/rest/Country/410028"
            },
            "isCanal": false,
            "self": "http://localhost:8080/ws/rest/Port/102947",
            "key": 102947
        },
        "portCalls": [
            {
                "key": 1105323,
                "self": "http://localhost:8080/ws/rest/PortCall/1105323"
            },
            {
                "key": 1105331,
                "self": "http://localhost:8080/ws/rest/PortCall/1105331"
            },
            {
                "key": 1105339,
                "self": "http://localhost:8080/ws/rest/PortCall/1105339"
            },
            {
                "key": 1105347,
                "self": "http://localhost:8080/ws/rest/PortCall/1105347"
            }
        ],
        "cargos": [
            {
                "self": "http://localhost:8080/ws/rest/Cargo/1105288",
                "key": 1105288
            }
        ],
        "ballastBonus": 0,
        "ballastBonusCommission": 0,
        "ballastBonusNet": 0,
        "ballastBonusRevenue": 0,
        "canalCost": 0,
        "comments": null,
        "commission": 26723.076923076922,
        "commissionAddress": 0,
        "commissionOwnersCost": 0,
        "cveTcIn": 0,
        "createdDate": "2012-10-01T14:08:20",
        "ilohcTcIn": 0,
        "ilohcTcOut": 0,
        "isTc": false,
        "milesBallast": 2902,
        "milesLoaded": 3252,
        "netFreight": 685892.3076923076,
        "percentExtraAtSea": 0,
        "portCost": 37500,
        "restrictingCubic": 546697,
        "robFixed": 0,
        "runningCost": 0,
        "runningCostPerDay": 0,
        "speedBallast": 11.764705882352942,
        "speedLoaded": 11.764705882352942,
        "tabTitle": null,
        "tcHireCommission": 0,
        "tcHireNet": 0,
        "tcRate": 0,
        "tcResult": 394987.93620318256,
        "tcResultDay": 11672.843149231081,
        "tdw": 12086,
        "utilisationComments": null,
        "variousCost": 35630.76923076923,
        "variousRevenue": 0,
        "voyageResult": 394987.93620318256,
        "tcIn": null,
        "tcs": [],
        "voyageCurrency": {
            "currencyCode": "EUR",
            "currencyName": "Euro",
            "key": 400008,
            "self": "http://localhost:8080/ws/rest/Currency/400008"
        },
        "cveTcOut": 0,
        "daysBallast": 12.554166666666667,
        "daysCanal": 0,
        "daysCleaning": 0,
        "daysDischarging": 4.230555555555555,
        "daysExtraAtSea": 0,
        "daysExtraInPort": 1.5,
        "daysHeating": 0,
        "daysIdle": 0,
        "daysLoaded": 11.8875,
        "daysLoading": 3.6659722222222224,
        "daysOffhire": 0,
        "daysOffhireCharterer": 0,
        "daysOffhireOwner": 0,
        "daysTotal": 33.83819444444445,
        "daysTotalAtSea": 24.441666666666666,
        "daysTotalInPort": 9.396527777777777,
        "daysWaiting": 0,
        "demurrage": 0,
        "despatch": 0,
        "dlConsumption": -93,
        "dlCost": 0,
        "dlPrice": 0,
        "doAtSea": 0,
        "doConsumption": 35.123555555555555,
        "doCost": 27384.951038843723,
        "doInPort": 1.15,
        "doInPortWorking": 3.2,
        "doPrice": 959,
        "estimatedVoyageStartDate": "2012-08-30T07:43:00",
        "flConsumption": -11.721,
        "flCost": -6565.665853658536,
        "flPrice": 689,
        "foBallast": 14,
        "foCleaning": 0,
        "foConsumption": 271.68,
        "foCost": 140699.31707317074,
        "foHeating": 0,
        "foInPort": 0,
        "foInPortWorking": 0,
        "foLoaded": 15,
        "foPrice": 637,
        "foPumping": 0,
        "freight": 712615.3846153846,
        "freightCost": 0,
        "grossFreight": 712615.3846153846,
        "handlingCost": 56255,
        "self": "http://localhost:8080/ws/rest/Voyage/1105287",
        "key": 1105287
    },
    "company": {
        "key": 1063570,
        "self": "http://localhost:8080/ws/rest/Company/1063570",
        "companyCode": "9000",
        "companyName": "Some Company Inc",
        "companyCurrency": {
            "currencyCode": "EUR",
            "currencyName": "Euro",
            "key": 400008,
            "self": "http://localhost:8080/ws/rest/Currency/400008"
        }
    },
    "timezoneOffset": -3,
    "foPriceVoyageStart": 637,
    "foProfitLoss": 0,
    "foProfitLossHedge": 0,
    "foProfitLossTcIn": 0,
    "foRobVoyageStart": 585.6,
    "foSulphurPctVoyageStart": 0,
    "isBudget": false,
    "isDlPriceFixed": true,
    "isDoFixed": false,
    "isDoPriceFixed": true,
    "isEstimate": false,
    "isFlPriceFixed": true,
    "isFoFixed": false,
    "isFoPriceFixed": true,
    "isTemplate": false,
    "isLastVoyage": false,
    "isVoyageStartFixed": true,
    "tcBenchmarkPercent": null,
    "tradeVoyageNo": 1,
    "vesselEarningPoint": null,
    "voyageNo": 8,
    "voyageStartYear": 2012,
    "budgetVersion": null,
    "charteringResponsible": {
        "key": 1063882,
        "self": "http://localhost:8080/ws/rest/User/1063882",
        "userCode": "OZINGA",
        "userName": "Louis Ozinga"
    },
    "accountantResponsible": {
        "key": 1076546,
        "self": "http://localhost:8080/ws/rest/User/1076546",
        "userCode": "RM",
        "userName": "Roger More"
    },
    "flIndex": null,
    "foIndex": null,
    "leg": {
        "key": 1070123,
        "self": "http://localhost:8080/ws/rest/Leg/1070123",
        "legCode": "MEDAFWC",
        "legDesc": "Mediterranean-Africa West Coast"
    },
    "offhires": [],
    "tcBenchmarkIndex": null,
    "bunkersProfitLoss": 0,
    "dlConsumptionOffhire": 0,
    "dlPriceEndOfVoyage": 0,
    "dlPriceVoyageStart": 0,
    "route": {
        "key": 1070062,
        "self": "http://localhost:8080/ws/rest/Route/1070062",
        "routeCode": "R1",
        "routeDesc": "Route1"
    },
	"templateVoyageHeader": null,
    "dlProfitLoss": 0,
    "dlProfitLossTcIn": 0,
    "dlRobVoyageStart": 0,
    "dlSulphurPctVoyageStart": 0,
    "doPriceEndOfVoyage": 959,
    "doPriceVoyageStart": 959,
    "doProfitLoss": 0,
    "doProfitLossTcIn": 0,
    "doRobVoyageStart": 134.4,
    "doSulphurPctVoyageStart": 0,
    "flConsumptionOffhire": 0,
    "flIndexPriceAdd": null,
    "flPriceEndOfVoyage": 689,
    "flPriceVoyageStart": 689,
    "flProfitLoss": 0,
    "flProfitLossTcIn": 0,
    "flRobVoyageStart": 388.032,
    "flSulphurPctVoyageStart": 0,
    "foIndexPriceAdd": null,
    "foPriceEndOfVoyage": 637,
    "operator": {
        "key": 1063882,
        "self": "http://localhost:8080/ws/rest/User/1063882",
        "userCode": "OZINGA",
        "userName": "Louis Ozinga"
    },
    "pattern": {
        "key": 1070124,
        "self": "http://localhost:8080/ws/rest/Pattern/1070124",
        "patternCode": "MEDAFWC",
        "patternDesc": "MED>AFWC"
    },
    "remarks": []
}

Top
Back

Status Code	Description
EST	Estimate
SCU	Unallocated
SCH	Allocated
NOM	Nominated
OPR	Operational
OPC	Operationally Closed
INV	Invoiced
FIN	Closed

/VoyageHeader

Long Description

Supported Methods

Properties

Response Body Example

Related Content