Veson Nautical GraphQL API Reference
The Veson GraphQL API exposes a comprehensive interface which can be used to programmatically interact with the Veson IMOS Platform (VIP). On this page, you will find documentation and worked examples designed to simplify the process of getting started with our API.
The online documentation provided by this site covers:
For optimal performance, we recommend connecting to the GraphQL endpoint in the same geographic region where your data is located.
Veson welcomes feedback on this documentation. If you would like to suggest an edit, please contact us using the details on the right hand side.
The Veson Engineering Team
Terms of Service
API Endpoints
https://emea.veslink.com/api/graphqlVersion
2.1.3
Authentication and Authorization
The Veson GraphQL API can be accessed using a standard Veslink API token, which is directly tied to a user profile in VIP. The Veslink API token grants the bearer the same rights as the VIP user account it is associated with. Instructions on how to create an API token can be found here.
Once the API token has been created, it should be added to the Authorization header as follows:
Authorization: VesonApiToken <API_TOKEN>
For example:
Authorization: VesonApiToken fc6d3a80ccsdfsdf74ef798be591ee157ecb444
Rate Limiting
To ensure the underlying infrastructure is adequately protected against excessive requests, API rate limiting technology is used by Veson.
In the event that the limit is exceeded, Veson will return a HTTP status code indicating that too many requests have been sent (429 Too Many Requests).
GraphiQL Playground
To interact directly with the GraphQL API, users can navigate to https://emea.veslink.com/app/playground.
Queries
berthSchedule
Response
Returns a BerthScheduleRootQuery
Example
Query
query BerthSchedule {
berthSchedule {
getBerthSchedule {
...BerthScheduleDataResponseFragment
}
}
}
Response
{
"data": {
"berthSchedule": {
"getBerthSchedule": BerthScheduleDataResponse
}
}
}
bunkerPrices
Response
Returns a BunkerPricesRootQuery
Example
Query
query BunkerPrices {
bunkerPrices {
portBunkerPrices {
...PortBunkerPricesFragment
}
}
}
Response
{
"data": {
"bunkerPrices": {
"portBunkerPrices": [PortBunkerPrices]
}
}
}
fleetmap
Response
Returns a FleetmapRootQuery
Example
Query
query Fleetmap {
fleetmap {
vessels {
...FleetmapVesselFragment
}
vessel {
...FleetmapVesselFragment
}
route {
...FleetmapRoutePositionFragment
}
aisRoute {
...FleetmapRoutePositionFragment
}
}
}
Response
{
"data": {
"fleetmap": {
"vessels": [FleetmapVessel],
"vessel": FleetmapVessel,
"route": [FleetmapRoutePosition],
"aisRoute": [FleetmapRoutePosition]
}
}
}
form
Response
Returns a FormRootQuery
Example
Query
query Form {
form {
form {
...ConnectFormFragment
}
forms {
...ConnectFormFragment
}
tags {
...ConnectTagFragment
}
tag {
...ConnectTagFragment
}
}
}
Response
{
"data": {
"form": {
"form": ConnectForm,
"forms": [ConnectForm],
"tags": [ConnectTag],
"tag": ConnectTag
}
}
}
imos
Response
Returns an ImosRootQuery
Example
Query
query Imos {
imos {
_accountAnalysisRelationships {
...AccountAnalysisRelationshipsFragment
}
accountAnalysis {
...AccountAnalysisFragment
}
accountAnalysisList {
...AccountAnalysisFragment
}
_accountingInterfaceSummaryRelationships {
...AccountingInterfaceSummaryRelationshipsFragment
}
accountingInterfaceSummary {
...AccountingInterfaceSummaryFragment
}
accountingInterfaceSummaryList {
...AccountingInterfaceSummaryFragment
}
actDepartment {
...ActDepartmentFragment
}
actDepartmentList {
...ActDepartmentFragment
}
_activityReportBunkerDetailRelationships {
...ActivityReportBunkerDetailRelationshipsFragment
}
activityReportBunkerDetail {
...ActivityReportBunkerDetailFragment
}
activityReportBunkerDetailList {
...ActivityReportBunkerDetailFragment
}
_addressBookRelationships {
...AddressBookRelationshipsFragment
}
addressBook {
...AddressBookFragment
}
addressBookList {
...AddressBookFragment
}
_addressBookAgentPortRelationships {
...AddressBookAgentPortRelationshipsFragment
}
addressBookAgentPort {
...AddressBookAgentPortFragment
}
addressBookAgentPortList {
...AddressBookAgentPortFragment
}
_addressBookBankRelationships {
...AddressBookBankRelationshipsFragment
}
addressBookBank {
...AddressBookBankFragment
}
addressBookBankList {
...AddressBookBankFragment
}
_addressBookContactRelationships {
...AddressBookContactRelationshipsFragment
}
addressBookContact {
...AddressBookContactFragment
}
addressBookContactList {
...AddressBookContactFragment
}
_addressBookExpenseRelationships {
...AddressBookExpenseRelationshipsFragment
}
addressBookExpense {
...AddressBookExpenseFragment
}
addressBookExpenseList {
...AddressBookExpenseFragment
}
_addressBookRegistryAccountRelationships {
...AddressBookRegistryAccountRelationshipsFragment
}
addressBookRegistryAccount {
...AddressBookRegistryAccountFragment
}
addressBookRegistryAccountList {
...AddressBookRegistryAccountFragment
}
_addressBookRemarkRelationships {
...AddressBookRemarkRelationshipsFragment
}
addressBookRemark {
...AddressBookRemarkFragment
}
addressBookRemarkList {
...AddressBookRemarkFragment
}
addressType {
...AddressTypeFragment
}
addressTypeList {
...AddressTypeFragment
}
_agentAppointmentsRelationships {
...AgentAppointmentsRelationshipsFragment
}
agentAppointments {
...AgentAppointmentsFragment
}
agentAppointmentsList {
...AgentAppointmentsFragment
}
agentTypes {
...AgentTypesFragment
}
agentTypesList {
...AgentTypesFragment
}
_agreedDistanceRelationships {
...AgreedDistanceRelationshipsFragment
}
agreedDistance {
...AgreedDistanceFragment
}
agreedDistanceList {
...AgreedDistanceFragment
}
_agreedTransitTimeBunkerRelationships {
...AgreedTransitTimeBunkerRelationshipsFragment
}
agreedTransitTimeBunker {
...AgreedTransitTimeBunkerFragment
}
agreedTransitTimeBunkerList {
...AgreedTransitTimeBunkerFragment
}
_agreedTransitTimeBunkerDetailRelationships {
...AgreedTransitTimeBunkerDetailRelationshipsFragment
}
agreedTransitTimeBunkerDetail {
...AgreedTransitTimeBunkerDetailFragment
}
agreedTransitTimeBunkerDetailList {
...AgreedTransitTimeBunkerDetailFragment
}
_alertRelationships {
...AlertRelationshipsFragment
}
alert {
...AlertFragment
}
alertList {
...AlertFragment
}
attachment {
...AttachmentFragment
}
attachmentList {
...AttachmentFragment
}
_auditRelationships {
...AuditRelationshipsFragment
}
audit {
...AuditFragment
}
auditList {
...AuditFragment
}
_auditActionRelationships {
...AuditActionRelationshipsFragment
}
auditAction {
...AuditActionFragment
}
auditActionList {
...AuditActionFragment
}
_auditDetailRelationships {
...AuditDetailRelationshipsFragment
}
auditDetail {
...AuditDetailFragment
}
auditDetailList {
...AuditDetailFragment
}
_auditRowRelationships {
...AuditRowRelationshipsFragment
}
auditRow {
...AuditRowFragment
}
auditRowList {
...AuditRowFragment
}
_auditTrailRelationships {
...AuditTrailRelationshipsFragment
}
auditTrail {
...AuditTrailFragment
}
auditTrailList {
...AuditTrailFragment
}
_bareboatBrokerRelationships {
...BareboatBrokerRelationshipsFragment
}
bareboatBroker {
...BareboatBrokerFragment
}
bareboatBrokerList {
...BareboatBrokerFragment
}
_bareboatContractRelationships {
...BareboatContractRelationshipsFragment
}
bareboatContract {
...BareboatContractFragment
}
bareboatContractList {
...BareboatContractFragment
}
bareboatExpense {
...BareboatExpenseFragment
}
bareboatExpenseList {
...BareboatExpenseFragment
}
bareboatHire {
...BareboatHireFragment
}
bareboatHireList {
...BareboatHireFragment
}
_bargeRelationships {
...BargeRelationshipsFragment
}
barge {
...BargeFragment
}
bargeList {
...BargeFragment
}
_benchmarkEstimateRelationships {
...BenchmarkEstimateRelationshipsFragment
}
benchmarkEstimate {
...BenchmarkEstimateFragment
}
benchmarkEstimateList {
...BenchmarkEstimateFragment
}
_benchmarkEstimateBunkerRelationships {
...BenchmarkEstimateBunkerRelationshipsFragment
}
benchmarkEstimateBunker {
...BenchmarkEstimateBunkerFragment
}
benchmarkEstimateBunkerList {
...BenchmarkEstimateBunkerFragment
}
_benchmarkResultRelationships {
...BenchmarkResultRelationshipsFragment
}
benchmarkResult {
...BenchmarkResultFragment
}
benchmarkResultList {
...BenchmarkResultFragment
}
_benchmarkResultBunkerRelationships {
...BenchmarkResultBunkerRelationshipsFragment
}
benchmarkResultBunker {
...BenchmarkResultBunkerFragment
}
benchmarkResultBunkerList {
...BenchmarkResultBunkerFragment
}
_benchmarkSensitivityRelationships {
...BenchmarkSensitivityRelationshipsFragment
}
benchmarkSensitivity {
...BenchmarkSensitivityFragment
}
benchmarkSensitivityList {
...BenchmarkSensitivityFragment
}
_benchmarkSensitivityBunkerRelationships {
...BenchmarkSensitivityBunkerRelationshipsFragment
}
benchmarkSensitivityBunker {
...BenchmarkSensitivityBunkerFragment
}
benchmarkSensitivityBunkerList {
...BenchmarkSensitivityBunkerFragment
}
_benchmarkSensitivityCalculationRelationships {
...BenchmarkSensitivityCalculationRelationshipsFragment
}
benchmarkSensitivityCalculation {
...BenchmarkSensitivityCalculationFragment
}
benchmarkSensitivityCalculationList {
...BenchmarkSensitivityCalculationFragment
}
_berthBlockageRelationships {
...BerthBlockageRelationshipsFragment
}
berthBlockage {
...BerthBlockageFragment
}
berthBlockageList {
...BerthBlockageFragment
}
_billViaRelationships {
...BillViaRelationshipsFragment
}
_bunkerExposureRelationships {
...BunkerExposureRelationshipsFragment
}
bunkerExposure {
...BunkerExposureFragment
}
bunkerExposureList {
...BunkerExposureFragment
}
_bunkerInquiriesAndPurchasesRelationships {
...BunkerInquiriesAndPurchasesRelationshipsFragment
}
bunkerInquiriesAndPurchases {
...BunkerInquiriesAndPurchasesFragment
}
bunkerInquiriesAndPurchasesList {
...BunkerInquiriesAndPurchasesFragment
}
_bunkerInquiriesAndPurchasesBunkerRelationships {
...BunkerInquiriesAndPurchasesBunkerRelationshipsFragment
}
bunkerInquiriesAndPurchasesBunker {
...BunkerInquiriesAndPurchasesBunkerFragment
}
bunkerInquiriesAndPurchasesBunkerList {
...BunkerInquiriesAndPurchasesBunkerFragment
}
_bunkerInquiriesAndPurchasesDetailRelationships {
...BunkerInquiriesAndPurchasesDetailRelationshipsFragment
}
bunkerInquiriesAndPurchasesDetail {
...BunkerInquiriesAndPurchasesDetailFragment
}
bunkerInquiriesAndPurchasesDetailList {
...BunkerInquiriesAndPurchasesDetailFragment
}
_bunkerInvoiceRelationships {
...BunkerInvoiceRelationshipsFragment
}
bunkerInvoice {
...BunkerInvoiceFragment
}
bunkerInvoiceList {
...BunkerInvoiceFragment
}
_bunkerInvoiceBunkerRelationships {
...BunkerInvoiceBunkerRelationshipsFragment
}
bunkerInvoiceBunker {
...BunkerInvoiceBunkerFragment
}
bunkerInvoiceBunkerList {
...BunkerInvoiceBunkerFragment
}
_bunkerLiftingDetailRelationships {
...BunkerLiftingDetailRelationshipsFragment
}
bunkerLiftingDetail {
...BunkerLiftingDetailFragment
}
bunkerLiftingDetailList {
...BunkerLiftingDetailFragment
}
_bunkerRequirementRelationships {
...BunkerRequirementRelationshipsFragment
}
bunkerRequirement {
...BunkerRequirementFragment
}
bunkerRequirementList {
...BunkerRequirementFragment
}
_bunkerRequirementBunkerRelationships {
...BunkerRequirementBunkerRelationshipsFragment
}
bunkerRequirementBunker {
...BunkerRequirementBunkerFragment
}
bunkerRequirementBunkerList {
...BunkerRequirementBunkerFragment
}
_businessRuleRelationships {
...BusinessRuleRelationshipsFragment
}
businessRule {
...BusinessRuleFragment
}
businessRuleList {
...BusinessRuleFragment
}
_cargoRelationships {
...CargoRelationshipsFragment
}
cargo {
...CargoFragment
}
cargoList {
...CargoFragment
}
_cargoBookingRelationships {
...CargoBookingRelationshipsFragment
}
cargoBooking {
...CargoBookingFragment
}
cargoBookingList {
...CargoBookingFragment
}
_cargoBookingProjectedLaytimeInvoiceRelationships {
...CargoBookingProjectedLaytimeInvoiceRelationshipsFragment
}
_cargoBookingStowageRelationships {
...CargoBookingStowageRelationshipsFragment
}
cargoBookingStowage {
...CargoBookingStowageFragment
}
cargoBookingStowageList {
...CargoBookingStowageFragment
}
_cargoBrokerRelationships {
...CargoBrokerRelationshipsFragment
}
cargoBroker {
...CargoBrokerFragment
}
cargoBrokerList {
...CargoBrokerFragment
}
_cargoBunkerConsumptionRelationships {
...CargoBunkerConsumptionRelationshipsFragment
}
cargoBunkerConsumption {
...CargoBunkerConsumptionFragment
}
cargoBunkerConsumptionList {
...CargoBunkerConsumptionFragment
}
cargoExposureBunker {
...CargoExposureBunkerFragment
}
cargoExposureBunkerList {
...CargoExposureBunkerFragment
}
_cargoGradesRelationships {
...CargoGradesRelationshipsFragment
}
cargoGrades {
...CargoGradesFragment
}
cargoGradesList {
...CargoGradesFragment
}
cargoHandlingEventType {
...CargoHandlingEventTypeFragment
}
cargoHandlingEventTypeList {
...CargoHandlingEventTypeFragment
}
_cargoItineraryRelationships {
...CargoItineraryRelationshipsFragment
}
cargoItinerary {
...CargoItineraryFragment
}
cargoItineraryList {
...CargoItineraryFragment
}
_cargoLinkedTradeRelationships {
...CargoLinkedTradeRelationshipsFragment
}
cargoLinkedTrade {
...CargoLinkedTradeFragment
}
cargoLinkedTradeList {
...CargoLinkedTradeFragment
}
_cargoLoadDischargeOptionRelationships {
...CargoLoadDischargeOptionRelationshipsFragment
}
cargoLoadDischargeOption {
...CargoLoadDischargeOptionFragment
}
cargoLoadDischargeOptionList {
...CargoLoadDischargeOptionFragment
}
_cargoMatchingProgramRelationships {
...CargoMatchingProgramRelationshipsFragment
}
cargoMatchingProgram {
...CargoMatchingProgramFragment
}
cargoMatchingProgramList {
...CargoMatchingProgramFragment
}
_cargoNameRelationships {
...CargoNameRelationshipsFragment
}
cargoName {
...CargoNameFragment
}
cargoNameList {
...CargoNameFragment
}
_cargoNameAliasRelationships {
...CargoNameAliasRelationshipsFragment
}
cargoNameAlias {
...CargoNameAliasFragment
}
cargoNameAliasList {
...CargoNameAliasFragment
}
_cargoRemarkRelationships {
...CargoRemarkRelationshipsFragment
}
cargoRemark {
...CargoRemarkFragment
}
cargoRemarkList {
...CargoRemarkFragment
}
_cargoRevenueExpenseRelationships {
...CargoRevenueExpenseRelationshipsFragment
}
cargoRevenueExpense {
...CargoRevenueExpenseFragment
}
cargoRevenueExpenseList {
...CargoRevenueExpenseFragment
}
_cargoSupplierReceiverRelationships {
...CargoSupplierReceiverRelationshipsFragment
}
cargoSupplierReceiver {
...CargoSupplierReceiverFragment
}
cargoSupplierReceiverList {
...CargoSupplierReceiverFragment
}
_cargoTimeBarRelationships {
...CargoTimeBarRelationshipsFragment
}
cargoTimeBar {
...CargoTimeBarFragment
}
cargoTimeBarList {
...CargoTimeBarFragment
}
cargoType {
...CargoTypeFragment
}
cargoTypeList {
...CargoTypeFragment
}
_cargoTypeGroupRelationships {
...CargoTypeGroupRelationshipsFragment
}
cargoTypeGroup {
...CargoTypeGroupFragment
}
cargoTypeGroupList {
...CargoTypeGroupFragment
}
_chartOfAccountsRelationships {
...ChartOfAccountsRelationshipsFragment
}
chartOfAccounts {
...ChartOfAccountsFragment
}
chartOfAccountsList {
...ChartOfAccountsFragment
}
_claimRelationships {
...ClaimRelationshipsFragment
}
claim {
...ClaimFragment
}
claimList {
...ClaimFragment
}
_claimLinkedClaimRelationships {
...ClaimLinkedClaimRelationshipsFragment
}
_claimNoteRelationships {
...ClaimNoteRelationshipsFragment
}
claimNote {
...ClaimNoteFragment
}
claimNoteList {
...ClaimNoteFragment
}
_claimProjectedInvoiceRelationships {
...ClaimProjectedInvoiceRelationshipsFragment
}
claimProjectedInvoice {
...ClaimProjectedInvoiceFragment
}
claimProjectedInvoiceList {
...ClaimProjectedInvoiceFragment
}
_coaRelationships {
...COARelationshipsFragment
}
coa {
...COAFragment
}
coaList {
...COAFragment
}
_coaBrokerRelationships {
...CoaBrokerRelationshipsFragment
}
coaBroker {
...CoaBrokerFragment
}
coaBrokerList {
...CoaBrokerFragment
}
_coaDetailsRelationships {
...COADetailsRelationshipsFragment
}
coaDetails {
...COADetailsFragment
}
coaDetailsList {
...COADetailsFragment
}
_coaExtraFreightTermsRelationships {
...COAExtraFreightTermsRelationshipsFragment
}
coaExtraFreightTerms {
...COAExtraFreightTermsFragment
}
coaExtraFreightTermsList {
...COAExtraFreightTermsFragment
}
_coaHierarchyRelationships {
...CoaHierarchyRelationshipsFragment
}
coaHierarchy {
...CoaHierarchyFragment
}
coaHierarchyList {
...CoaHierarchyFragment
}
_coaItineraryRelationships {
...COAItineraryRelationshipsFragment
}
coaItinerary {
...COAItineraryFragment
}
coaItineraryList {
...COAItineraryFragment
}
_coaOptionRelationships {
...COAOptionRelationshipsFragment
}
coaOption {
...COAOptionFragment
}
coaOptionList {
...COAOptionFragment
}
_coaPeriodRelationships {
...CoaPeriodRelationshipsFragment
}
coaPeriod {
...CoaPeriodFragment
}
coaPeriodList {
...CoaPeriodFragment
}
collabStatus {
...CollabStatusFragment
}
collabStatusList {
...CollabStatusFragment
}
_commodityContractRelationships {
...CommodityContractRelationshipsFragment
}
commodityContract {
...CommodityContractFragment
}
commodityContractList {
...CommodityContractFragment
}
_companyRelationships {
...CompanyRelationshipsFragment
}
company {
...CompanyFragment
}
companyList {
...CompanyFragment
}
configOptions {
...ConfigOptionsFragment
}
configOptionsList {
...ConfigOptionsFragment
}
_consModeRelationships {
...ConsModeRelationshipsFragment
}
consMode {
...ConsModeFragment
}
consModeList {
...ConsModeFragment
}
_consModePortConsRelationships {
...ConsModePortConsRelationshipsFragment
}
consModePortCons {
...ConsModePortConsFragment
}
consModePortConsList {
...ConsModePortConsFragment
}
_consModeSeaConsRelationships {
...ConsModeSeaConsRelationshipsFragment
}
consModeSeaCons {
...ConsModeSeaConsFragment
}
consModeSeaConsList {
...ConsModeSeaConsFragment
}
correlationProfile {
...CorrelationProfileFragment
}
correlationProfileList {
...CorrelationProfileFragment
}
country {
...CountryFragment
}
countryList {
...CountryFragment
}
currency {
...CurrencyFragment
}
currencyList {
...CurrencyFragment
}
dataFormView {
...DataFormViewFragment
}
dataFormViewList {
...DataFormViewFragment
}
dataFormViewField {
...DataFormViewFieldFragment
}
dataFormViewFieldList {
...DataFormViewFieldFragment
}
_decisionTableRelationships {
...DecisionTableRelationshipsFragment
}
decisionTable {
...DecisionTableFragment
}
decisionTableList {
...DecisionTableFragment
}
_decisionTableRuleReportRelationships {
...DecisionTableRuleReportRelationshipsFragment
}
decisionTableRuleReport {
...DecisionTableRuleReportFragment
}
decisionTableRuleReportList {
...DecisionTableRuleReportFragment
}
_delayRelationships {
...DelayRelationshipsFragment
}
delay {
...DelayFragment
}
delayList {
...DelayFragment
}
_delayBunkerRelationships {
...DelayBunkerRelationshipsFragment
}
delayBunker {
...DelayBunkerFragment
}
delayBunkerList {
...DelayBunkerFragment
}
_delayReasonRelationships {
...DelayReasonRelationshipsFragment
}
delayReason {
...DelayReasonFragment
}
delayReasonList {
...DelayReasonFragment
}
delayType {
...DelayTypeFragment
}
delayTypeList {
...DelayTypeFragment
}
_demurrageAllocationDetailsRelationships {
...DemurrageAllocationDetailsRelationshipsFragment
}
demurrageAllocationDetails {
...DemurrageAllocationDetailsFragment
}
demurrageAllocationDetailsList {
...DemurrageAllocationDetailsFragment
}
_demurrageTaskLinkedLaytimeRelationships {
...DemurrageTaskLinkedLaytimeRelationshipsFragment
}
department {
...DepartmentFragment
}
departmentList {
...DepartmentFragment
}
equipmentContractHistory {
...EquipmentContractHistoryFragment
}
equipmentContractHistoryList {
...EquipmentContractHistoryFragment
}
_estimateCargoBrokerRelationships {
...EstimateCargoBrokerRelationshipsFragment
}
estimateCargoBroker {
...EstimateCargoBrokerFragment
}
estimateCargoBrokerList {
...EstimateCargoBrokerFragment
}
_estimateCargoBunkerConsumptionRelationships {
...EstimateCargoBunkerConsumptionRelationshipsFragment
}
estimateCargoBunkerConsumption {
...EstimateCargoBunkerConsumptionFragment
}
estimateCargoBunkerConsumptionList {
...EstimateCargoBunkerConsumptionFragment
}
_estimateCargoesRelationships {
...EstimateCargoesRelationshipsFragment
}
estimateCargoes {
...EstimateCargoesFragment
}
estimateCargoesList {
...EstimateCargoesFragment
}
_estimateCargoExtraFreightTermsRelationships {
...EstimateCargoExtraFreightTermsRelationshipsFragment
}
estimateCargoExtraFreightTerms {
...EstimateCargoExtraFreightTermsFragment
}
estimateCargoExtraFreightTermsList {
...EstimateCargoExtraFreightTermsFragment
}
_estimateDelayRelationships {
...EstimateDelayRelationshipsFragment
}
estimateDelay {
...EstimateDelayFragment
}
estimateDelayList {
...EstimateDelayFragment
}
_estimateFuelEuReplacementBunkerRelationships {
...EstimateFuelEuReplacementBunkerRelationshipsFragment
}
estimateFuelEuReplacementBunker {
...EstimateFuelEuReplacementBunkerFragment
}
estimateFuelEuReplacementBunkerList {
...EstimateFuelEuReplacementBunkerFragment
}
_estimateItineraryRelationships {
...EstimateItineraryRelationshipsFragment
}
estimateItinerary {
...EstimateItineraryFragment
}
estimateItineraryList {
...EstimateItineraryFragment
}
_estimateItineraryBunkerRelationships {
...EstimateItineraryBunkerRelationshipsFragment
}
estimateItineraryBunker {
...EstimateItineraryBunkerFragment
}
estimateItineraryBunkerList {
...EstimateItineraryBunkerFragment
}
_estimateItineraryCarbonRelationships {
...EstimateItineraryCarbonRelationshipsFragment
}
estimateItineraryCarbon {
...EstimateItineraryCarbonFragment
}
estimateItineraryCarbonList {
...EstimateItineraryCarbonFragment
}
_estimateItineraryCarbonBunkerRelationships {
...EstimateItineraryCarbonBunkerRelationshipsFragment
}
estimateItineraryCarbonBunker {
...EstimateItineraryCarbonBunkerFragment
}
estimateItineraryCarbonBunkerList {
...EstimateItineraryCarbonBunkerFragment
}
_exchangeRateRelationships {
...ExchangeRateRelationshipsFragment
}
exchangeRate {
...ExchangeRateFragment
}
exchangeRateList {
...ExchangeRateFragment
}
expense {
...ExpenseFragment
}
expenseList {
...ExpenseFragment
}
_extraFreightTermsRelationships {
...ExtraFreightTermsRelationshipsFragment
}
extraFreightTerms {
...ExtraFreightTermsFragment
}
extraFreightTermsList {
...ExtraFreightTermsFragment
}
_financialsAndOperationsInvoiceNotesRelationships {
...FinancialsAndOperationsInvoiceNotesRelationshipsFragment
}
financialsAndOperationsInvoiceNotes {
...FinancialsAndOperationsInvoiceNotesFragment
}
financialsAndOperationsInvoiceNotesList {
...FinancialsAndOperationsInvoiceNotesFragment
}
_financialsInvoiceRelationships {
...FinancialsInvoiceRelationshipsFragment
}
financialsInvoice {
...FinancialsInvoiceFragment
}
financialsInvoiceList {
...FinancialsInvoiceFragment
}
_financialsInvoiceDetailRelationships {
...FinancialsInvoiceDetailRelationshipsFragment
}
financialsInvoiceDetail {
...FinancialsInvoiceDetailFragment
}
financialsInvoiceDetailList {
...FinancialsInvoiceDetailFragment
}
_financialsInvoiceDetailCargoAllocationRelationships {
...FinancialsInvoiceDetailCargoAllocationRelationshipsFragment
}
financialsInvoiceDetailCargoAllocation {
...FinancialsInvoiceDetailCargoAllocationFragment
}
financialsInvoiceDetailCargoAllocationList {
...FinancialsInvoiceDetailCargoAllocationFragment
}
_financialsInvoicePaymentRelationships {
...FinancialsInvoicePaymentRelationshipsFragment
}
financialsInvoicePayment {
...FinancialsInvoicePaymentFragment
}
financialsInvoicePaymentList {
...FinancialsInvoicePaymentFragment
}
_fixtureRelationships {
...FixtureRelationshipsFragment
}
fixture {
...FixtureFragment
}
fixtureList {
...FixtureFragment
}
_fixtureRemarkRelationships {
...FixtureRemarkRelationshipsFragment
}
fixtureRemark {
...FixtureRemarkFragment
}
fixtureRemarkList {
...FixtureRemarkFragment
}
_formRelationships {
...FormRelationshipsFragment
}
form {
...FormFragment
}
formList {
...FormFragment
}
formTemplate {
...FormTemplateFragment
}
formTemplateList {
...FormTemplateFragment
}
_freightInvoiceRelationships {
...FreightInvoiceRelationshipsFragment
}
freightInvoice {
...FreightInvoiceFragment
}
freightInvoiceList {
...FreightInvoiceFragment
}
freightTerm {
...FreightTermFragment
}
freightTermList {
...FreightTermFragment
}
fuelEmissionsFactorsSet {
...FuelEmissionsFactorsSetFragment
}
fuelEmissionsFactorsSetList {
...FuelEmissionsFactorsSetFragment
}
fuelLubeType {
...FuelLubeTypeFragment
}
fuelLubeTypeList {
...FuelLubeTypeFragment
}
_fuelZoneRelationships {
...FuelZoneRelationshipsFragment
}
fuelZone {
...FuelZoneFragment
}
fuelZoneList {
...FuelZoneFragment
}
_fuelZoneSetRelationships {
...FuelZoneSetRelationshipsFragment
}
fuelZoneSet {
...FuelZoneSetFragment
}
fuelZoneSetList {
...FuelZoneSetFragment
}
_groupMemberRelationships {
...GroupMemberRelationshipsFragment
}
groupMember {
...GroupMemberFragment
}
groupMemberList {
...GroupMemberFragment
}
_headFixturePurchaseSaleRelationships {
...HeadFixturePurchaseSaleRelationshipsFragment
}
headFixturePurchaseSale {
...HeadFixturePurchaseSaleFragment
}
headFixturePurchaseSaleList {
...HeadFixturePurchaseSaleFragment
}
_holidayRelationships {
...HolidayRelationshipsFragment
}
holiday {
...HolidayFragment
}
holidayList {
...HolidayFragment
}
imosUser {
...ImosUserFragment
}
imosUserList {
...ImosUserFragment
}
interfaceMessagesAndNotifications {
...InterfaceMessagesAndNotificationsFragment
}
interfaceMessagesAndNotificationsList {
...InterfaceMessagesAndNotificationsFragment
}
_internalFinalFreightStatementVoyageRelationships {
...InternalFinalFreightStatementVoyageRelationshipsFragment
}
_internalIndexHireTimeChartersRelationships {
...InternalIndexHireTimeChartersRelationshipsFragment
}
_invoiceNoteRelationships {
...InvoiceNoteRelationshipsFragment
}
invoiceNote {
...InvoiceNoteFragment
}
invoiceNoteList {
...InvoiceNoteFragment
}
jobStatus {
...JobStatusFragment
}
jobStatusList {
...JobStatusFragment
}
_laytimeRelationships {
...LaytimeRelationshipsFragment
}
laytime {
...LaytimeFragment
}
laytimeList {
...LaytimeFragment
}
_laytimePortActivitiesRelationships {
...LaytimePortActivitiesRelationshipsFragment
}
laytimePortActivities {
...LaytimePortActivitiesFragment
}
laytimePortActivitiesList {
...LaytimePortActivitiesFragment
}
_laytimePortDeductionRelationships {
...LaytimePortDeductionRelationshipsFragment
}
laytimePortDeduction {
...LaytimePortDeductionFragment
}
laytimePortDeductionList {
...LaytimePortDeductionFragment
}
_laytimePortsRelationships {
...LaytimePortsRelationshipsFragment
}
laytimePorts {
...LaytimePortsFragment
}
laytimePortsList {
...LaytimePortsFragment
}
laytimeTerms {
...LaytimeTermsFragment
}
laytimeTermsList {
...LaytimeTermsFragment
}
_loadDischargeStandardRateRelationships {
...LoadDischargeStandardRateRelationshipsFragment
}
loadDischargeStandardRate {
...LoadDischargeStandardRateFragment
}
loadDischargeStandardRateList {
...LoadDischargeStandardRateFragment
}
_loadDischargeTableRatesRelationships {
...LoadDischargeTableRatesRelationshipsFragment
}
loadDischargeTableRates {
...LoadDischargeTableRatesFragment
}
loadDischargeTableRatesList {
...LoadDischargeTableRatesFragment
}
_loadlineZoneRelationships {
...LoadlineZoneRelationshipsFragment
}
loadlineZone {
...LoadlineZoneFragment
}
loadlineZoneList {
...LoadlineZoneFragment
}
_loadlineZoneDetailsRelationships {
...LoadlineZoneDetailsRelationshipsFragment
}
loadlineZoneDetails {
...LoadlineZoneDetailsFragment
}
loadlineZoneDetailsList {
...LoadlineZoneDetailsFragment
}
lob {
...LobFragment
}
lobList {
...LobFragment
}
_marketRelationships {
...MarketRelationshipsFragment
}
market {
...MarketFragment
}
marketList {
...MarketFragment
}
_marketCargoRelationships {
...MarketCargoRelationshipsFragment
}
marketCargo {
...MarketCargoFragment
}
marketCargoList {
...MarketCargoFragment
}
_marketDataRelationships {
...MarketDataRelationshipsFragment
}
marketData {
...MarketDataFragment
}
marketDataList {
...MarketDataFragment
}
_marketPositionRelationships {
...MarketPositionRelationshipsFragment
}
marketPosition {
...MarketPositionFragment
}
marketPositionList {
...MarketPositionFragment
}
_marketPositionSourceRelationships {
...MarketPositionSourceRelationshipsFragment
}
marketPositionSource {
...MarketPositionSourceFragment
}
marketPositionSourceList {
...MarketPositionSourceFragment
}
_masterContractRelationships {
...MasterContractRelationshipsFragment
}
masterContract {
...MasterContractFragment
}
masterContractList {
...MasterContractFragment
}
_masterContractBrokerRelationships {
...MasterContractBrokerRelationshipsFragment
}
_moduleAccessRelationships {
...ModuleAccessRelationshipsFragment
}
moduleAccess {
...ModuleAccessFragment
}
moduleAccessList {
...ModuleAccessFragment
}
notification {
...NotificationFragment
}
notificationList {
...NotificationFragment
}
_objectAccessRelationships {
...ObjectAccessRelationshipsFragment
}
objectAccess {
...ObjectAccessFragment
}
objectAccessList {
...ObjectAccessFragment
}
objectApproval {
...ObjectApprovalFragment
}
objectApprovalList {
...ObjectApprovalFragment
}
_operationsInvoiceRelationships {
...OperationsInvoiceRelationshipsFragment
}
operationsInvoice {
...OperationsInvoiceFragment
}
operationsInvoiceList {
...OperationsInvoiceFragment
}
_operationsInvoiceApprovalRelationships {
...OperationsInvoiceApprovalRelationshipsFragment
}
operationsInvoiceApproval {
...OperationsInvoiceApprovalFragment
}
operationsInvoiceApprovalList {
...OperationsInvoiceApprovalFragment
}
_operationsInvoiceDetailCargoAllocationRelationships {
...OperationsInvoiceDetailCargoAllocationRelationshipsFragment
}
operationsInvoiceDetailCargoAllocation {
...OperationsInvoiceDetailCargoAllocationFragment
}
operationsInvoiceDetailCargoAllocationList {
...OperationsInvoiceDetailCargoAllocationFragment
}
_operationsInvoiceDetailsRelationships {
...OperationsInvoiceDetailsRelationshipsFragment
}
operationsInvoiceDetails {
...OperationsInvoiceDetailsFragment
}
operationsInvoiceDetailsList {
...OperationsInvoiceDetailsFragment
}
_operationsInvoiceNoteRelationships {
...OperationsInvoiceNoteRelationshipsFragment
}
operationsLedger {
...OperationsLedgerFragment
}
operationsLedgerList {
...OperationsLedgerFragment
}
_operationsPaymentDetailsRelationships {
...OperationsPaymentDetailsRelationshipsFragment
}
operationsPaymentDetails {
...OperationsPaymentDetailsFragment
}
operationsPaymentDetailsList {
...OperationsPaymentDetailsFragment
}
_paperTradeRelationships {
...PaperTradeRelationshipsFragment
}
paperTrade {
...PaperTradeFragment
}
paperTradeList {
...PaperTradeFragment
}
_paperTradeExposurePeriodRelationships {
...PaperTradeExposurePeriodRelationshipsFragment
}
paperTradeExposurePeriod {
...PaperTradeExposurePeriodFragment
}
paperTradeExposurePeriodList {
...PaperTradeExposurePeriodFragment
}
_paymentRelationships {
...PaymentRelationshipsFragment
}
payment {
...PaymentFragment
}
paymentList {
...PaymentFragment
}
_paymentBatchRelationships {
...PaymentBatchRelationshipsFragment
}
paymentBatch {
...PaymentBatchFragment
}
paymentBatchList {
...PaymentBatchFragment
}
_paymentBatchDetailsRelationships {
...PaymentBatchDetailsRelationshipsFragment
}
paymentBatchDetails {
...PaymentBatchDetailsFragment
}
paymentBatchDetailsList {
...PaymentBatchDetailsFragment
}
_paymentDetailRelationships {
...PaymentDetailRelationshipsFragment
}
paymentDetail {
...PaymentDetailFragment
}
paymentDetailList {
...PaymentDetailFragment
}
paymentTerm {
...PaymentTermFragment
}
paymentTermList {
...PaymentTermFragment
}
_poolRelationships {
...PoolRelationshipsFragment
}
pool {
...PoolFragment
}
poolList {
...PoolFragment
}
_poolAdminAccountRelationships {
...PoolAdminAccountRelationshipsFragment
}
poolAdminAccount {
...PoolAdminAccountFragment
}
poolAdminAccountList {
...PoolAdminAccountFragment
}
_poolAssignmentRelationships {
...PoolAssignmentRelationshipsFragment
}
poolAssignment {
...PoolAssignmentFragment
}
poolAssignmentList {
...PoolAssignmentFragment
}
_poolAssignmentPremiumRelationships {
...PoolAssignmentPremiumRelationshipsFragment
}
poolAssignmentPremium {
...PoolAssignmentPremiumFragment
}
poolAssignmentPremiumList {
...PoolAssignmentPremiumFragment
}
_poolingDistributionRelationships {
...PoolingDistributionRelationshipsFragment
}
poolingDistribution {
...PoolingDistributionFragment
}
poolingDistributionList {
...PoolingDistributionFragment
}
_poolingDistributionPremiumRelationships {
...PoolingDistributionPremiumRelationshipsFragment
}
poolingDistributionPremium {
...PoolingDistributionPremiumFragment
}
poolingDistributionPremiumList {
...PoolingDistributionPremiumFragment
}
_portRelationships {
...PortRelationshipsFragment
}
port {
...PortFragment
}
portList {
...PortFragment
}
portActivity {
...PortActivityFragment
}
portActivityList {
...PortActivityFragment
}
_portActivityBunkerRelationships {
...PortActivityBunkerRelationshipsFragment
}
portActivityBunker {
...PortActivityBunkerFragment
}
portActivityBunkerList {
...PortActivityBunkerFragment
}
_portAdvanceDaRelationships {
...PortAdvanceDaRelationshipsFragment
}
portArea {
...PortAreaFragment
}
portAreaList {
...PortAreaFragment
}
_portBerthRelationships {
...PortBerthRelationshipsFragment
}
portBerth {
...PortBerthFragment
}
portBerthList {
...PortBerthFragment
}
_portCargoCompatRelationships {
...PortCargoCompatRelationshipsFragment
}
portCargoCompat {
...PortCargoCompatFragment
}
portCargoCompatList {
...PortCargoCompatFragment
}
_portCargoCompatBerthRelationships {
...PortCargoCompatBerthRelationshipsFragment
}
portCargoCompatBerth {
...PortCargoCompatBerthFragment
}
portCargoCompatBerthList {
...PortCargoCompatBerthFragment
}
_portExpenseRelationships {
...PortExpenseRelationshipsFragment
}
portExpense {
...PortExpenseFragment
}
portExpenseList {
...PortExpenseFragment
}
_portExpenseMiscDetailsRelationships {
...PortExpenseMiscDetailsRelationshipsFragment
}
portExpenseMiscDetails {
...PortExpenseMiscDetailsFragment
}
portExpenseMiscDetailsList {
...PortExpenseMiscDetailsFragment
}
_portExpensesStandardRelationships {
...PortExpensesStandardRelationshipsFragment
}
portExpensesStandard {
...PortExpensesStandardFragment
}
portExpensesStandardList {
...PortExpensesStandardFragment
}
_portExpenseStandardDetailRelationships {
...PortExpenseStandardDetailRelationshipsFragment
}
portExpenseStandardDetail {
...PortExpenseStandardDetailFragment
}
portExpenseStandardDetailList {
...PortExpenseStandardDetailFragment
}
_portFuelAvailabilityRelationships {
...PortFuelAvailabilityRelationshipsFragment
}
portFuelAvailability {
...PortFuelAvailabilityFragment
}
portFuelAvailabilityList {
...PortFuelAvailabilityFragment
}
portFunction {
...PortFunctionFragment
}
portFunctionList {
...PortFunctionFragment
}
_portVesselRelationships {
...PortVesselRelationshipsFragment
}
portVessel {
...PortVesselFragment
}
portVesselList {
...PortVesselFragment
}
_portVesselBerthRelationships {
...PortVesselBerthRelationshipsFragment
}
portVesselBerth {
...PortVesselBerthFragment
}
portVesselBerthList {
...PortVesselBerthFragment
}
_positionRelationships {
...PositionRelationshipsFragment
}
position {
...PositionFragment
}
positionList {
...PositionFragment
}
region {
...RegionFragment
}
regionList {
...RegionFragment
}
_reminderRelationships {
...ReminderRelationshipsFragment
}
reminder {
...ReminderFragment
}
reminderList {
...ReminderFragment
}
report {
...ReportFragment
}
reportList {
...ReportFragment
}
_reportUserViewRelationships {
...ReportUserViewRelationshipsFragment
}
reportUserView {
...ReportUserViewFragment
}
reportUserViewList {
...ReportUserViewFragment
}
_reportViewRelationships {
...ReportViewRelationshipsFragment
}
reportView {
...ReportViewFragment
}
reportViewList {
...ReportViewFragment
}
_revisionRelationships {
...RevisionRelationshipsFragment
}
revision {
...RevisionFragment
}
revisionList {
...RevisionFragment
}
revisionPanelContent {
...RevisionPanelContentFragment
}
revisionPanelContentList {
...RevisionPanelContentFragment
}
_revisionRowRelationships {
...RevisionRowRelationshipsFragment
}
revisionRow {
...RevisionRowFragment
}
revisionRowList {
...RevisionRowFragment
}
_scheduleBargeRelationships {
...ScheduleBargeRelationshipsFragment
}
scheduleBarge {
...ScheduleBargeFragment
}
scheduleBargeList {
...ScheduleBargeFragment
}
sharedResources {
...SharedResourcesFragment
}
sharedResourcesList {
...SharedResourcesFragment
}
_standardExpenseRelationships {
...StandardExpenseRelationshipsFragment
}
standardExpense {
...StandardExpenseFragment
}
standardExpenseList {
...StandardExpenseFragment
}
_standardExpenseConditionRelationships {
...StandardExpenseConditionRelationshipsFragment
}
_standardRateRelationships {
...StandardRateRelationshipsFragment
}
standardRate {
...StandardRateFragment
}
standardRateList {
...StandardRateFragment
}
vesonSubscription {
...VesonSubscriptionFragment
}
vesonSubscriptionList {
...VesonSubscriptionFragment
}
_surveyCostDetailsRelationships {
...SurveyCostDetailsRelationshipsFragment
}
surveyCostDetails {
...SurveyCostDetailsFragment
}
surveyCostDetailsList {
...SurveyCostDetailsFragment
}
_surveyCostsBunkersRelationships {
...SurveyCostsBunkersRelationshipsFragment
}
surveyCostsBunkers {
...SurveyCostsBunkersFragment
}
surveyCostsBunkersList {
...SurveyCostsBunkersFragment
}
_tankConditionRelationships {
...TankConditionRelationshipsFragment
}
tankCondition {
...TankConditionFragment
}
tankConditionList {
...TankConditionFragment
}
_taskRelationships {
...TaskRelationshipsFragment
}
task {
...TaskFragment
}
taskList {
...TaskFragment
}
taskGroup {
...TaskGroupFragment
}
taskGroupList {
...TaskGroupFragment
}
taskGroupItem {
...TaskGroupItemFragment
}
taskGroupItemList {
...TaskGroupItemFragment
}
_tasksAndAlertsRelationships {
...TasksAndAlertsRelationshipsFragment
}
tasksAndAlerts {
...TasksAndAlertsFragment
}
tasksAndAlertsList {
...TasksAndAlertsFragment
}
tcDeduction {
...TCDeductionFragment
}
tcDeductionList {
...TCDeductionFragment
}
_teamRelationships {
...TeamRelationshipsFragment
}
team {
...TeamFragment
}
teamList {
...TeamFragment
}
_termRelationships {
...TermRelationshipsFragment
}
term {
...TermFragment
}
termList {
...TermFragment
}
_timeCharterBrokerRelationships {
...TimeCharterBrokerRelationshipsFragment
}
timeCharterBroker {
...TimeCharterBrokerFragment
}
timeCharterBrokerList {
...TimeCharterBrokerFragment
}
_timeCharterBunkerDeliveryRelationships {
...TimeCharterBunkerDeliveryRelationshipsFragment
}
timeCharterBunkerDelivery {
...TimeCharterBunkerDeliveryFragment
}
timeCharterBunkerDeliveryList {
...TimeCharterBunkerDeliveryFragment
}
_timeCharterBunkerExposureRelationships {
...TimeCharterBunkerExposureRelationshipsFragment
}
timeCharterBunkerExposure {
...TimeCharterBunkerExposureFragment
}
timeCharterBunkerExposureList {
...TimeCharterBunkerExposureFragment
}
_timeCharterCOARelationships {
...TimeCharterCOARelationshipsFragment
}
timeCharterCOA {
...TimeCharterCOAFragment
}
timeCharterCOAList {
...TimeCharterCOAFragment
}
_timeCharterCOABrokerRelationships {
...TimeCharterCOABrokerRelationshipsFragment
}
_timeCharterCOADeliveryRedeliveryOptionRelationships {
...TimeCharterCOADeliveryRedeliveryOptionRelationshipsFragment
}
timeCharterCOADeliveryRedeliveryOption {
...TimeCharterCOADeliveryRedeliveryOptionFragment
}
timeCharterCOADeliveryRedeliveryOptionList {
...TimeCharterCOADeliveryRedeliveryOptionFragment
}
_timeCharterCOAExpenseRelationships {
...TimeCharterCOAExpenseRelationshipsFragment
}
_timeCharterCOAHireRelationships {
...TimeCharterCOAHireRelationshipsFragment
}
_timeCharterCOAVesselRelationships {
...TimeCharterCOAVesselRelationshipsFragment
}
timeCharterCOAVessel {
...TimeCharterCOAVesselFragment
}
timeCharterCOAVesselList {
...TimeCharterCOAVesselFragment
}
_timeCharterCOAVesselTypeRelationships {
...TimeCharterCOAVesselTypeRelationshipsFragment
}
timeCharterCOAVesselType {
...TimeCharterCOAVesselTypeFragment
}
timeCharterCOAVesselTypeList {
...TimeCharterCOAVesselTypeFragment
}
_timeCharterContractRelationships {
...TimeCharterContractRelationshipsFragment
}
timeCharterContract {
...TimeCharterContractFragment
}
timeCharterContractList {
...TimeCharterContractFragment
}
_timeCharterExpenseRelationships {
...TimeCharterExpenseRelationshipsFragment
}
timeCharterExpense {
...TimeCharterExpenseFragment
}
timeCharterExpenseList {
...TimeCharterExpenseFragment
}
_timeCharterExposurePeriodRelationships {
...TimeCharterExposurePeriodRelationshipsFragment
}
timeCharterExposurePeriod {
...TimeCharterExposurePeriodFragment
}
timeCharterExposurePeriodList {
...TimeCharterExposurePeriodFragment
}
timeCharterExtra {
...TimeCharterExtraFragment
}
timeCharterExtraList {
...TimeCharterExtraFragment
}
_timeCharterHireRelationships {
...TimeCharterHireRelationshipsFragment
}
timeCharterHire {
...TimeCharterHireFragment
}
timeCharterHireList {
...TimeCharterHireFragment
}
_timeCharterLeaseRelationships {
...TimeCharterLeaseRelationshipsFragment
}
timeCharterLease {
...TimeCharterLeaseFragment
}
timeCharterLeaseList {
...TimeCharterLeaseFragment
}
_timeCharterLiftingOptionRelationships {
...TimeCharterLiftingOptionRelationshipsFragment
}
timeCharterLiftingOption {
...TimeCharterLiftingOptionFragment
}
timeCharterLiftingOptionList {
...TimeCharterLiftingOptionFragment
}
_timeCharterOutDetailsRelationships {
...TimeCharterOutDetailsRelationshipsFragment
}
timeCharterOutDetails {
...TimeCharterOutDetailsFragment
}
timeCharterOutDetailsList {
...TimeCharterOutDetailsFragment
}
_timeCharterPortConsumptionRelationships {
...TimeCharterPortConsumptionRelationshipsFragment
}
timeCharterPortConsumption {
...TimeCharterPortConsumptionFragment
}
timeCharterPortConsumptionList {
...TimeCharterPortConsumptionFragment
}
timeCharterProfitShare {
...TimeCharterProfitShareFragment
}
timeCharterProfitShareList {
...TimeCharterProfitShareFragment
}
_timeCharterProfitShareContractsRelationships {
...TimeCharterProfitShareContractsRelationshipsFragment
}
timeCharterProfitShareContracts {
...TimeCharterProfitShareContractsFragment
}
timeCharterProfitShareContractsList {
...TimeCharterProfitShareContractsFragment
}
_timeCharterProjectedInvoiceRelationships {
...TimeCharterProjectedInvoiceRelationshipsFragment
}
timeCharterProjectedInvoice {
...TimeCharterProjectedInvoiceFragment
}
timeCharterProjectedInvoiceList {
...TimeCharterProjectedInvoiceFragment
}
_timeCharterPurchaseOptionRelationships {
...TimeCharterPurchaseOptionRelationshipsFragment
}
timeCharterPurchaseOption {
...TimeCharterPurchaseOptionFragment
}
timeCharterPurchaseOptionList {
...TimeCharterPurchaseOptionFragment
}
_timeCharterSeaConsumptionRelationships {
...TimeCharterSeaConsumptionRelationshipsFragment
}
timeCharterSeaConsumption {
...TimeCharterSeaConsumptionFragment
}
timeCharterSeaConsumptionList {
...TimeCharterSeaConsumptionFragment
}
_timeCharterSeaConsumptionBunkerRelationships {
...TimeCharterSeaConsumptionBunkerRelationshipsFragment
}
timeCharterSeaConsumptionBunker {
...TimeCharterSeaConsumptionBunkerFragment
}
timeCharterSeaConsumptionBunkerList {
...TimeCharterSeaConsumptionBunkerFragment
}
timeCharterTonnageTax {
...TimeCharterTonnageTaxFragment
}
timeCharterTonnageTaxList {
...TimeCharterTonnageTaxFragment
}
timeCharterWarrantyConsumption {
...TimeCharterWarrantyConsumptionFragment
}
timeCharterWarrantyConsumptionList {
...TimeCharterWarrantyConsumptionFragment
}
_timeCharterWarrantyDelayExclusionRelationships {
...TimeCharterWarrantyDelayExclusionRelationshipsFragment
}
timeCharterWarrantyDelayExclusion {
...TimeCharterWarrantyDelayExclusionFragment
}
timeCharterWarrantyDelayExclusionList {
...TimeCharterWarrantyDelayExclusionFragment
}
timeZoneCodes {
...TimeZoneCodesFragment
}
timeZoneCodesList {
...TimeZoneCodesFragment
}
timeZoneInfo {
...TimeZoneInfoFragment
}
timeZoneInfoList {
...TimeZoneInfoFragment
}
_tradeAreaRelationships {
...TradeAreaRelationshipsFragment
}
tradeArea {
...TradeAreaFragment
}
tradeAreaList {
...TradeAreaFragment
}
_tradeBrokerRelationships {
...TradeBrokerRelationshipsFragment
}
tradeBroker {
...TradeBrokerFragment
}
tradeBrokerList {
...TradeBrokerFragment
}
_tradeContractRelationships {
...TradeContractRelationshipsFragment
}
tradeContract {
...TradeContractFragment
}
tradeContractList {
...TradeContractFragment
}
tradeFilter {
...TradeFilterFragment
}
tradeFilterList {
...TradeFilterFragment
}
_tradeFilterDetailRelationships {
...TradeFilterDetailRelationshipsFragment
}
tradeFilterDetail {
...TradeFilterDetailFragment
}
tradeFilterDetailList {
...TradeFilterDetailFragment
}
_tradeIndexRelationships {
...TradeIndexRelationshipsFragment
}
tradeIndex {
...TradeIndexFragment
}
tradeIndexList {
...TradeIndexFragment
}
_tradePnlRelationships {
...TradePnlRelationshipsFragment
}
tradePnl {
...TradePnlFragment
}
tradePnlList {
...TradePnlFragment
}
_tradePnlDetailRelationships {
...TradePnlDetailRelationshipsFragment
}
tradePnlDetail {
...TradePnlDetailFragment
}
tradePnlDetailList {
...TradePnlDetailFragment
}
_tradeSnapshotRelationships {
...TradeSnapshotRelationshipsFragment
}
tradeSnapshot {
...TradeSnapshotFragment
}
tradeSnapshotList {
...TradeSnapshotFragment
}
_tradeTypeRelationships {
...TradeTypeRelationshipsFragment
}
tradeType {
...TradeTypeFragment
}
tradeTypeList {
...TradeTypeFragment
}
_tradeUnitRelationships {
...TradeUnitRelationshipsFragment
}
tradeUnit {
...TradeUnitFragment
}
tradeUnitList {
...TradeUnitFragment
}
_tradingProfileRelationships {
...TradingProfileRelationshipsFragment
}
tradingProfile {
...TradingProfileFragment
}
tradingProfileList {
...TradingProfileFragment
}
_tradingProfilePropertyRelationships {
...TradingProfilePropertyRelationshipsFragment
}
tradingProfileProperty {
...TradingProfilePropertyFragment
}
tradingProfilePropertyList {
...TradingProfilePropertyFragment
}
_unitOfMeasureRelationships {
...UnitOfMeasureRelationshipsFragment
}
unitOfMeasure {
...UnitOfMeasureFragment
}
unitOfMeasureList {
...UnitOfMeasureFragment
}
_unpricedElementRelationships {
...UnpricedElementRelationshipsFragment
}
unpricedElement {
...UnpricedElementFragment
}
unpricedElementList {
...UnpricedElementFragment
}
_unpricedElementRemarkRelationships {
...UnpricedElementRemarkRelationshipsFragment
}
_unpricedElementStructureRelationships {
...UnpricedElementStructureRelationshipsFragment
}
unpricedElementStructure {
...UnpricedElementStructureFragment
}
unpricedElementStructureList {
...UnpricedElementStructureFragment
}
_userRelationships {
...UserRelationshipsFragment
}
user {
...UserFragment
}
userList {
...UserFragment
}
userField {
...UserFieldFragment
}
userFieldList {
...UserFieldFragment
}
_vesselRelationships {
...VesselRelationshipsFragment
}
vessel {
...VesselFragment
}
vesselList {
...VesselFragment
}
_vesselBoatsRelationships {
...VesselBoatsRelationshipsFragment
}
vesselBoats {
...VesselBoatsFragment
}
vesselBoatsList {
...VesselBoatsFragment
}
_vesselBunkerTankRelationships {
...VesselBunkerTankRelationshipsFragment
}
vesselBunkerTank {
...VesselBunkerTankFragment
}
vesselBunkerTankList {
...VesselBunkerTankFragment
}
_vesselConsModeRelationships {
...VesselConsModeRelationshipsFragment
}
vesselConsMode {
...VesselConsModeFragment
}
vesselConsModeList {
...VesselConsModeFragment
}
_vesselCraneRelationships {
...VesselCraneRelationshipsFragment
}
vesselCrane {
...VesselCraneFragment
}
vesselCraneList {
...VesselCraneFragment
}
_vesselDetailsRelationships {
...VesselDetailsRelationshipsFragment
}
vesselDetails {
...VesselDetailsFragment
}
vesselDetailsList {
...VesselDetailsFragment
}
_vesselDraftRelationships {
...VesselDraftRelationshipsFragment
}
vesselDraft {
...VesselDraftFragment
}
vesselDraftList {
...VesselDraftFragment
}
_vesselDraftMarksRelationships {
...VesselDraftMarksRelationshipsFragment
}
vesselDraftMarks {
...VesselDraftMarksFragment
}
vesselDraftMarksList {
...VesselDraftMarksFragment
}
_vesselEvaluationRelationships {
...VesselEvaluationRelationshipsFragment
}
vesselEvaluation {
...VesselEvaluationFragment
}
vesselEvaluationList {
...VesselEvaluationFragment
}
_vesselFleetMemberRelationships {
...VesselFleetMemberRelationshipsFragment
}
vesselFleetMember {
...VesselFleetMemberFragment
}
vesselFleetMemberList {
...VesselFleetMemberFragment
}
_vesselFleetMemberFullRelationships {
...VesselFleetMemberFullRelationshipsFragment
}
vesselFleetMemberFull {
...VesselFleetMemberFullFragment
}
vesselFleetMemberFullList {
...VesselFleetMemberFullFragment
}
_vesselHatchRelationships {
...VesselHatchRelationshipsFragment
}
vesselHatch {
...VesselHatchFragment
}
vesselHatchList {
...VesselHatchFragment
}
_vesselHoldRelationships {
...VesselHoldRelationshipsFragment
}
vesselHold {
...VesselHoldFragment
}
vesselHoldList {
...VesselHoldFragment
}
_vesselIncidentRelationships {
...VesselIncidentRelationshipsFragment
}
vesselIncident {
...VesselIncidentFragment
}
vesselIncidentList {
...VesselIncidentFragment
}
_vesselInspectionRelationships {
...VesselInspectionRelationshipsFragment
}
vesselInspection {
...VesselInspectionFragment
}
vesselInspectionList {
...VesselInspectionFragment
}
_vesselPortConsRelationships {
...VesselPortConsRelationshipsFragment
}
vesselPortCons {
...VesselPortConsFragment
}
vesselPortConsList {
...VesselPortConsFragment
}
vesselRoute {
...VesselRouteFragment
}
vesselRouteList {
...VesselRouteFragment
}
_vesselsAndBargesRelationships {
...VesselsAndBargesRelationshipsFragment
}
_vesselSeaConsRelationships {
...VesselSeaConsRelationshipsFragment
}
vesselSeaCons {
...VesselSeaConsFragment
}
vesselSeaConsList {
...VesselSeaConsFragment
}
_vesselSeaConsBunkerRelationships {
...VesselSeaConsBunkerRelationshipsFragment
}
vesselSeaConsBunker {
...VesselSeaConsBunkerFragment
}
vesselSeaConsBunkerList {
...VesselSeaConsBunkerFragment
}
_vesselTankRelationships {
...VesselTankRelationshipsFragment
}
vesselTank {
...VesselTankFragment
}
vesselTankList {
...VesselTankFragment
}
_vesselTceTargetRelationships {
...VesselTceTargetRelationshipsFragment
}
vesselTceTarget {
...VesselTceTargetFragment
}
vesselTceTargetList {
...VesselTceTargetFragment
}
_vesselTypeRelationships {
...VesselTypeRelationshipsFragment
}
vesselType {
...VesselTypeFragment
}
vesselTypeList {
...VesselTypeFragment
}
_vesselVariablesRelationships {
...VesselVariablesRelationshipsFragment
}
_vesselVettingRelationships {
...VesselVettingRelationshipsFragment
}
vesselVetting {
...VesselVettingFragment
}
vesselVettingList {
...VesselVettingFragment
}
_voyageRelationships {
...VoyageRelationshipsFragment
}
voyage {
...VoyageFragment
}
voyageList {
...VoyageFragment
}
_voyageActivityReportRelationships {
...VoyageActivityReportRelationshipsFragment
}
voyageActivityReport {
...VoyageActivityReportFragment
}
voyageActivityReportList {
...VoyageActivityReportFragment
}
_voyageAndTcoFixtureRelationships {
...VoyageAndTcoFixtureRelationshipsFragment
}
voyageAndTcoFixture {
...VoyageAndTcoFixtureFragment
}
voyageAndTcoFixtureList {
...VoyageAndTcoFixtureFragment
}
_voyageBunkerInventoryRelationships {
...VoyageBunkerInventoryRelationshipsFragment
}
voyageBunkerInventory {
...VoyageBunkerInventoryFragment
}
voyageBunkerInventoryList {
...VoyageBunkerInventoryFragment
}
_voyageBunkerInventoryDetailRelationships {
...VoyageBunkerInventoryDetailRelationshipsFragment
}
voyageBunkerInventoryDetail {
...VoyageBunkerInventoryDetailFragment
}
voyageBunkerInventoryDetailList {
...VoyageBunkerInventoryDetailFragment
}
_voyageBunkerLiftingRelationships {
...VoyageBunkerLiftingRelationshipsFragment
}
voyageBunkerLifting {
...VoyageBunkerLiftingFragment
}
voyageBunkerLiftingList {
...VoyageBunkerLiftingFragment
}
_voyageBunkerSummaryRelationships {
...VoyageBunkerSummaryRelationshipsFragment
}
voyageBunkerSummary {
...VoyageBunkerSummaryFragment
}
voyageBunkerSummaryList {
...VoyageBunkerSummaryFragment
}
_voyageCargoHandlingRelationships {
...VoyageCargoHandlingRelationshipsFragment
}
voyageCargoHandling {
...VoyageCargoHandlingFragment
}
voyageCargoHandlingList {
...VoyageCargoHandlingFragment
}
_voyageCargoHandlingDocumentRelationships {
...VoyageCargoHandlingDocumentRelationshipsFragment
}
voyageCargoHandlingDocument {
...VoyageCargoHandlingDocumentFragment
}
voyageCargoHandlingDocumentList {
...VoyageCargoHandlingDocumentFragment
}
_voyageCargoHandlingEventRelationships {
...VoyageCargoHandlingEventRelationshipsFragment
}
voyageCargoHandlingEvent {
...VoyageCargoHandlingEventFragment
}
voyageCargoHandlingEventList {
...VoyageCargoHandlingEventFragment
}
_voyageCargoHandlingStowageRelationships {
...VoyageCargoHandlingStowageRelationshipsFragment
}
voyageCargoHandlingStowage {
...VoyageCargoHandlingStowageFragment
}
voyageCargoHandlingStowageList {
...VoyageCargoHandlingStowageFragment
}
_voyageCargoTransferRelationships {
...VoyageCargoTransferRelationshipsFragment
}
voyageCargoTransfer {
...VoyageCargoTransferFragment
}
voyageCargoTransferList {
...VoyageCargoTransferFragment
}
_voyageContactRelationships {
...VoyageContactRelationshipsFragment
}
voyageContact {
...VoyageContactFragment
}
voyageContactList {
...VoyageContactFragment
}
_voyageContactFullRelationships {
...VoyageContactFullRelationshipsFragment
}
_voyageEmissionsRelationships {
...VoyageEmissionsRelationshipsFragment
}
voyageEmissions {
...VoyageEmissionsFragment
}
voyageEmissionsList {
...VoyageEmissionsFragment
}
_voyageEmissionsDetailRelationships {
...VoyageEmissionsDetailRelationshipsFragment
}
voyageEmissionsDetail {
...VoyageEmissionsDetailFragment
}
voyageEmissionsDetailList {
...VoyageEmissionsDetailFragment
}
_voyageEquipmentEventRelationships {
...VoyageEquipmentEventRelationshipsFragment
}
voyageEquipmentEvent {
...VoyageEquipmentEventFragment
}
voyageEquipmentEventList {
...VoyageEquipmentEventFragment
}
_voyageEstimateRelationships {
...VoyageEstimateRelationshipsFragment
}
voyageEstimate {
...VoyageEstimateFragment
}
voyageEstimateList {
...VoyageEstimateFragment
}
_voyageEstimateBunkerRelationships {
...VoyageEstimateBunkerRelationshipsFragment
}
voyageEstimateBunker {
...VoyageEstimateBunkerFragment
}
voyageEstimateBunkerList {
...VoyageEstimateBunkerFragment
}
_voyageEstimateCOACVCAnalysisRelationships {
...VoyageEstimateCOACVCAnalysisRelationshipsFragment
}
voyageEstimateCOACVCAnalysis {
...VoyageEstimateCOACVCAnalysisFragment
}
voyageEstimateCOACVCAnalysisList {
...VoyageEstimateCOACVCAnalysisFragment
}
_voyageEstimateCOACVCAnalysisResultRelationships {
...VoyageEstimateCOACVCAnalysisResultRelationshipsFragment
}
voyageEstimateCOACVCAnalysisResult {
...VoyageEstimateCOACVCAnalysisResultFragment
}
voyageEstimateCOACVCAnalysisResultList {
...VoyageEstimateCOACVCAnalysisResultFragment
}
_voyageEstimateCOACVCAnalysisResultBunkerRelationships {
...VoyageEstimateCOACVCAnalysisResultBunkerRelationshipsFragment
}
voyageEstimateCOACVCAnalysisResultBunker {
...VoyageEstimateCOACVCAnalysisResultBunkerFragment
}
voyageEstimateCOACVCAnalysisResultBunkerList {
...VoyageEstimateCOACVCAnalysisResultBunkerFragment
}
_voyageEstimateMiscExpenseRelationships {
...VoyageEstimateMiscExpenseRelationshipsFragment
}
voyageEstimateMiscExpense {
...VoyageEstimateMiscExpenseFragment
}
voyageEstimateMiscExpenseList {
...VoyageEstimateMiscExpenseFragment
}
_voyageEstimatePortExpenseRelationships {
...VoyageEstimatePortExpenseRelationshipsFragment
}
voyageEstimatePortExpense {
...VoyageEstimatePortExpenseFragment
}
voyageEstimatePortExpenseList {
...VoyageEstimatePortExpenseFragment
}
_voyageEstimateTimeCharterExpenseRelationships {
...VoyageEstimateTimeCharterExpenseRelationshipsFragment
}
voyageEstimateTimeCharterExpense {
...VoyageEstimateTimeCharterExpenseFragment
}
voyageEstimateTimeCharterExpenseList {
...VoyageEstimateTimeCharterExpenseFragment
}
voyageInstruction {
...VoyageInstructionFragment
}
voyageInstructionList {
...VoyageInstructionFragment
}
_voyageItineraryRelationships {
...VoyageItineraryRelationshipsFragment
}
voyageItinerary {
...VoyageItineraryFragment
}
voyageItineraryList {
...VoyageItineraryFragment
}
_voyageItineraryBerthRelationships {
...VoyageItineraryBerthRelationshipsFragment
}
voyageItineraryBerth {
...VoyageItineraryBerthFragment
}
voyageItineraryBerthList {
...VoyageItineraryBerthFragment
}
_voyageItineraryBunkerRelationships {
...VoyageItineraryBunkerRelationshipsFragment
}
voyageItineraryBunker {
...VoyageItineraryBunkerFragment
}
voyageItineraryBunkerList {
...VoyageItineraryBunkerFragment
}
_voyageItineraryCarbonRelationships {
...VoyageItineraryCarbonRelationshipsFragment
}
voyageItineraryCarbon {
...VoyageItineraryCarbonFragment
}
voyageItineraryCarbonList {
...VoyageItineraryCarbonFragment
}
_voyageItineraryCarbonBunkerRelationships {
...VoyageItineraryCarbonBunkerRelationshipsFragment
}
voyageItineraryCarbonBunker {
...VoyageItineraryCarbonBunkerFragment
}
voyageItineraryCarbonBunkerList {
...VoyageItineraryCarbonBunkerFragment
}
_voyageItineraryCargoHandlingRelationships {
...VoyageItineraryCargoHandlingRelationshipsFragment
}
_voyageItineraryProjectedBunkerInvoiceRelationships {
...VoyageItineraryProjectedBunkerInvoiceRelationshipsFragment
}
voyageLegDetails {
...VoyageLegDetailsFragment
}
voyageLegDetailsList {
...VoyageLegDetailsFragment
}
voyageLegSummary {
...VoyageLegSummaryFragment
}
voyageLegSummaryList {
...VoyageLegSummaryFragment
}
_voyagePnlRelationships {
...VoyagePnlRelationshipsFragment
}
voyagePnl {
...VoyagePnlFragment
}
voyagePnlList {
...VoyagePnlFragment
}
_voyagePnlBunkerRelationships {
...VoyagePnlBunkerRelationshipsFragment
}
voyagePnlBunker {
...VoyagePnlBunkerFragment
}
voyagePnlBunkerList {
...VoyagePnlBunkerFragment
}
_voyagePnlBunkerDetailRelationships {
...VoyagePnlBunkerDetailRelationshipsFragment
}
voyagePnlBunkerDetail {
...VoyagePnlBunkerDetailFragment
}
voyagePnlBunkerDetailList {
...VoyagePnlBunkerDetailFragment
}
_voyagePnlCargoRelationships {
...VoyagePnlCargoRelationshipsFragment
}
voyagePnlCargo {
...VoyagePnlCargoFragment
}
voyagePnlCargoList {
...VoyagePnlCargoFragment
}
_voyagePnlDetailRelationships {
...VoyagePnlDetailRelationshipsFragment
}
voyagePnlDetail {
...VoyagePnlDetailFragment
}
voyagePnlDetailList {
...VoyagePnlDetailFragment
}
_voyagePnlDrilldownRelationships {
...VoyagePnlDrilldownRelationshipsFragment
}
voyagePnlDrilldown {
...VoyagePnlDrilldownFragment
}
voyagePnlDrilldownList {
...VoyagePnlDrilldownFragment
}
_voyagePnlItineraryLineRelationships {
...VoyagePnlItineraryLineRelationshipsFragment
}
voyagePnlItineraryLine {
...VoyagePnlItineraryLineFragment
}
voyagePnlItineraryLineList {
...VoyagePnlItineraryLineFragment
}
_voyagePnlItineraryLineBunkerRelationships {
...VoyagePnlItineraryLineBunkerRelationshipsFragment
}
voyagePnlItineraryLineBunker {
...VoyagePnlItineraryLineBunkerFragment
}
voyagePnlItineraryLineBunkerList {
...VoyagePnlItineraryLineBunkerFragment
}
_voyagePnlSummaryRelationships {
...VoyagePnlSummaryRelationshipsFragment
}
voyagePnlSummary {
...VoyagePnlSummaryFragment
}
voyagePnlSummaryList {
...VoyagePnlSummaryFragment
}
_voyagePortActivitiesRelationships {
...VoyagePortActivitiesRelationshipsFragment
}
voyagePortActivities {
...VoyagePortActivitiesFragment
}
voyagePortActivitiesList {
...VoyagePortActivitiesFragment
}
_voyagePortAgentRelationships {
...VoyagePortAgentRelationshipsFragment
}
voyagePortAgent {
...VoyagePortAgentFragment
}
voyagePortAgentList {
...VoyagePortAgentFragment
}
_voyageProfitShareRelationships {
...VoyageProfitShareRelationshipsFragment
}
voyageProfitShare {
...VoyageProfitShareFragment
}
voyageProfitShareList {
...VoyageProfitShareFragment
}
_voyageProjectedInvoiceRelationships {
...VoyageProjectedInvoiceRelationshipsFragment
}
voyageProjectedInvoice {
...VoyageProjectedInvoiceFragment
}
voyageProjectedInvoiceList {
...VoyageProjectedInvoiceFragment
}
_voyageRemarksRelationships {
...VoyageRemarksRelationshipsFragment
}
voyageRemarks {
...VoyageRemarksFragment
}
voyageRemarksList {
...VoyageRemarksFragment
}
_voyageTemplateRelationships {
...VoyageTemplateRelationshipsFragment
}
voyageTemplate {
...VoyageTemplateFragment
}
voyageTemplateList {
...VoyageTemplateFragment
}
_voyageTemplateRecipientRelationships {
...VoyageTemplateRecipientRelationshipsFragment
}
waterway {
...WaterwayFragment
}
waterwayList {
...WaterwayFragment
}
weatherState {
...WeatherStateFragment
}
weatherStateList {
...WeatherStateFragment
}
_worksheetRelationships {
...WorksheetRelationshipsFragment
}
worksheet {
...WorksheetFragment
}
worksheetList {
...WorksheetFragment
}
_worksheetEstimateRelationships {
...WorksheetEstimateRelationshipsFragment
}
worksheetEstimate {
...WorksheetEstimateFragment
}
worksheetEstimateList {
...WorksheetEstimateFragment
}
_worksheetPriceComponentRelationships {
...WorksheetPriceComponentRelationshipsFragment
}
worksheetPriceComponent {
...WorksheetPriceComponentFragment
}
worksheetPriceComponentList {
...WorksheetPriceComponentFragment
}
_worksheetVesselRelationships {
...WorksheetVesselRelationshipsFragment
}
worksheetVessel {
...WorksheetVesselFragment
}
worksheetVesselList {
...WorksheetVesselFragment
}
}
}
Response
{
"data": {
"imos": {
"_accountAnalysisRelationships": AccountAnalysisRelationships,
"accountAnalysis": AccountAnalysis,
"accountAnalysisList": [AccountAnalysis],
"_accountingInterfaceSummaryRelationships": AccountingInterfaceSummaryRelationships,
"accountingInterfaceSummary": AccountingInterfaceSummary,
"accountingInterfaceSummaryList": [
AccountingInterfaceSummary
],
"actDepartment": ActDepartment,
"actDepartmentList": [ActDepartment],
"_activityReportBunkerDetailRelationships": ActivityReportBunkerDetailRelationships,
"activityReportBunkerDetail": ActivityReportBunkerDetail,
"activityReportBunkerDetailList": [
ActivityReportBunkerDetail
],
"_addressBookRelationships": AddressBookRelationships,
"addressBook": AddressBook,
"addressBookList": [AddressBook],
"_addressBookAgentPortRelationships": AddressBookAgentPortRelationships,
"addressBookAgentPort": AddressBookAgentPort,
"addressBookAgentPortList": [AddressBookAgentPort],
"_addressBookBankRelationships": AddressBookBankRelationships,
"addressBookBank": AddressBookBank,
"addressBookBankList": [AddressBookBank],
"_addressBookContactRelationships": AddressBookContactRelationships,
"addressBookContact": AddressBookContact,
"addressBookContactList": [AddressBookContact],
"_addressBookExpenseRelationships": AddressBookExpenseRelationships,
"addressBookExpense": AddressBookExpense,
"addressBookExpenseList": [AddressBookExpense],
"_addressBookRegistryAccountRelationships": AddressBookRegistryAccountRelationships,
"addressBookRegistryAccount": AddressBookRegistryAccount,
"addressBookRegistryAccountList": [
AddressBookRegistryAccount
],
"_addressBookRemarkRelationships": AddressBookRemarkRelationships,
"addressBookRemark": AddressBookRemark,
"addressBookRemarkList": [AddressBookRemark],
"addressType": AddressType,
"addressTypeList": [AddressType],
"_agentAppointmentsRelationships": AgentAppointmentsRelationships,
"agentAppointments": AgentAppointments,
"agentAppointmentsList": [AgentAppointments],
"agentTypes": AgentTypes,
"agentTypesList": [AgentTypes],
"_agreedDistanceRelationships": AgreedDistanceRelationships,
"agreedDistance": AgreedDistance,
"agreedDistanceList": [AgreedDistance],
"_agreedTransitTimeBunkerRelationships": AgreedTransitTimeBunkerRelationships,
"agreedTransitTimeBunker": AgreedTransitTimeBunker,
"agreedTransitTimeBunkerList": [
AgreedTransitTimeBunker
],
"_agreedTransitTimeBunkerDetailRelationships": AgreedTransitTimeBunkerDetailRelationships,
"agreedTransitTimeBunkerDetail": AgreedTransitTimeBunkerDetail,
"agreedTransitTimeBunkerDetailList": [
AgreedTransitTimeBunkerDetail
],
"_alertRelationships": AlertRelationships,
"alert": Alert,
"alertList": [Alert],
"attachment": Attachment,
"attachmentList": [Attachment],
"_auditRelationships": AuditRelationships,
"audit": Audit,
"auditList": [Audit],
"_auditActionRelationships": AuditActionRelationships,
"auditAction": AuditAction,
"auditActionList": [AuditAction],
"_auditDetailRelationships": AuditDetailRelationships,
"auditDetail": AuditDetail,
"auditDetailList": [AuditDetail],
"_auditRowRelationships": AuditRowRelationships,
"auditRow": AuditRow,
"auditRowList": [AuditRow],
"_auditTrailRelationships": AuditTrailRelationships,
"auditTrail": AuditTrail,
"auditTrailList": [AuditTrail],
"_bareboatBrokerRelationships": BareboatBrokerRelationships,
"bareboatBroker": BareboatBroker,
"bareboatBrokerList": [BareboatBroker],
"_bareboatContractRelationships": BareboatContractRelationships,
"bareboatContract": BareboatContract,
"bareboatContractList": [BareboatContract],
"bareboatExpense": BareboatExpense,
"bareboatExpenseList": [BareboatExpense],
"bareboatHire": BareboatHire,
"bareboatHireList": [BareboatHire],
"_bargeRelationships": BargeRelationships,
"barge": Barge,
"bargeList": [Barge],
"_benchmarkEstimateRelationships": BenchmarkEstimateRelationships,
"benchmarkEstimate": BenchmarkEstimate,
"benchmarkEstimateList": [BenchmarkEstimate],
"_benchmarkEstimateBunkerRelationships": BenchmarkEstimateBunkerRelationships,
"benchmarkEstimateBunker": BenchmarkEstimateBunker,
"benchmarkEstimateBunkerList": [
BenchmarkEstimateBunker
],
"_benchmarkResultRelationships": BenchmarkResultRelationships,
"benchmarkResult": BenchmarkResult,
"benchmarkResultList": [BenchmarkResult],
"_benchmarkResultBunkerRelationships": BenchmarkResultBunkerRelationships,
"benchmarkResultBunker": BenchmarkResultBunker,
"benchmarkResultBunkerList": [
BenchmarkResultBunker
],
"_benchmarkSensitivityRelationships": BenchmarkSensitivityRelationships,
"benchmarkSensitivity": BenchmarkSensitivity,
"benchmarkSensitivityList": [BenchmarkSensitivity],
"_benchmarkSensitivityBunkerRelationships": BenchmarkSensitivityBunkerRelationships,
"benchmarkSensitivityBunker": BenchmarkSensitivityBunker,
"benchmarkSensitivityBunkerList": [
BenchmarkSensitivityBunker
],
"_benchmarkSensitivityCalculationRelationships": BenchmarkSensitivityCalculationRelationships,
"benchmarkSensitivityCalculation": BenchmarkSensitivityCalculation,
"benchmarkSensitivityCalculationList": [
BenchmarkSensitivityCalculation
],
"_berthBlockageRelationships": BerthBlockageRelationships,
"berthBlockage": BerthBlockage,
"berthBlockageList": [BerthBlockage],
"_billViaRelationships": BillViaRelationships,
"_bunkerExposureRelationships": BunkerExposureRelationships,
"bunkerExposure": BunkerExposure,
"bunkerExposureList": [BunkerExposure],
"_bunkerInquiriesAndPurchasesRelationships": BunkerInquiriesAndPurchasesRelationships,
"bunkerInquiriesAndPurchases": BunkerInquiriesAndPurchases,
"bunkerInquiriesAndPurchasesList": [
BunkerInquiriesAndPurchases
],
"_bunkerInquiriesAndPurchasesBunkerRelationships": BunkerInquiriesAndPurchasesBunkerRelationships,
"bunkerInquiriesAndPurchasesBunker": BunkerInquiriesAndPurchasesBunker,
"bunkerInquiriesAndPurchasesBunkerList": [
BunkerInquiriesAndPurchasesBunker
],
"_bunkerInquiriesAndPurchasesDetailRelationships": BunkerInquiriesAndPurchasesDetailRelationships,
"bunkerInquiriesAndPurchasesDetail": BunkerInquiriesAndPurchasesDetail,
"bunkerInquiriesAndPurchasesDetailList": [
BunkerInquiriesAndPurchasesDetail
],
"_bunkerInvoiceRelationships": BunkerInvoiceRelationships,
"bunkerInvoice": BunkerInvoice,
"bunkerInvoiceList": [BunkerInvoice],
"_bunkerInvoiceBunkerRelationships": BunkerInvoiceBunkerRelationships,
"bunkerInvoiceBunker": BunkerInvoiceBunker,
"bunkerInvoiceBunkerList": [BunkerInvoiceBunker],
"_bunkerLiftingDetailRelationships": BunkerLiftingDetailRelationships,
"bunkerLiftingDetail": BunkerLiftingDetail,
"bunkerLiftingDetailList": [BunkerLiftingDetail],
"_bunkerRequirementRelationships": BunkerRequirementRelationships,
"bunkerRequirement": BunkerRequirement,
"bunkerRequirementList": [BunkerRequirement],
"_bunkerRequirementBunkerRelationships": BunkerRequirementBunkerRelationships,
"bunkerRequirementBunker": BunkerRequirementBunker,
"bunkerRequirementBunkerList": [
BunkerRequirementBunker
],
"_businessRuleRelationships": BusinessRuleRelationships,
"businessRule": BusinessRule,
"businessRuleList": [BusinessRule],
"_cargoRelationships": CargoRelationships,
"cargo": Cargo,
"cargoList": [Cargo],
"_cargoBookingRelationships": CargoBookingRelationships,
"cargoBooking": CargoBooking,
"cargoBookingList": [CargoBooking],
"_cargoBookingProjectedLaytimeInvoiceRelationships": CargoBookingProjectedLaytimeInvoiceRelationships,
"_cargoBookingStowageRelationships": CargoBookingStowageRelationships,
"cargoBookingStowage": CargoBookingStowage,
"cargoBookingStowageList": [CargoBookingStowage],
"_cargoBrokerRelationships": CargoBrokerRelationships,
"cargoBroker": CargoBroker,
"cargoBrokerList": [CargoBroker],
"_cargoBunkerConsumptionRelationships": CargoBunkerConsumptionRelationships,
"cargoBunkerConsumption": CargoBunkerConsumption,
"cargoBunkerConsumptionList": [
CargoBunkerConsumption
],
"cargoExposureBunker": CargoExposureBunker,
"cargoExposureBunkerList": [CargoExposureBunker],
"_cargoGradesRelationships": CargoGradesRelationships,
"cargoGrades": CargoGrades,
"cargoGradesList": [CargoGrades],
"cargoHandlingEventType": CargoHandlingEventType,
"cargoHandlingEventTypeList": [
CargoHandlingEventType
],
"_cargoItineraryRelationships": CargoItineraryRelationships,
"cargoItinerary": CargoItinerary,
"cargoItineraryList": [CargoItinerary],
"_cargoLinkedTradeRelationships": CargoLinkedTradeRelationships,
"cargoLinkedTrade": CargoLinkedTrade,
"cargoLinkedTradeList": [CargoLinkedTrade],
"_cargoLoadDischargeOptionRelationships": CargoLoadDischargeOptionRelationships,
"cargoLoadDischargeOption": CargoLoadDischargeOption,
"cargoLoadDischargeOptionList": [
CargoLoadDischargeOption
],
"_cargoMatchingProgramRelationships": CargoMatchingProgramRelationships,
"cargoMatchingProgram": CargoMatchingProgram,
"cargoMatchingProgramList": [CargoMatchingProgram],
"_cargoNameRelationships": CargoNameRelationships,
"cargoName": CargoName,
"cargoNameList": [CargoName],
"_cargoNameAliasRelationships": CargoNameAliasRelationships,
"cargoNameAlias": CargoNameAlias,
"cargoNameAliasList": [CargoNameAlias],
"_cargoRemarkRelationships": CargoRemarkRelationships,
"cargoRemark": CargoRemark,
"cargoRemarkList": [CargoRemark],
"_cargoRevenueExpenseRelationships": CargoRevenueExpenseRelationships,
"cargoRevenueExpense": CargoRevenueExpense,
"cargoRevenueExpenseList": [CargoRevenueExpense],
"_cargoSupplierReceiverRelationships": CargoSupplierReceiverRelationships,
"cargoSupplierReceiver": CargoSupplierReceiver,
"cargoSupplierReceiverList": [
CargoSupplierReceiver
],
"_cargoTimeBarRelationships": CargoTimeBarRelationships,
"cargoTimeBar": CargoTimeBar,
"cargoTimeBarList": [CargoTimeBar],
"cargoType": CargoType,
"cargoTypeList": [CargoType],
"_cargoTypeGroupRelationships": CargoTypeGroupRelationships,
"cargoTypeGroup": CargoTypeGroup,
"cargoTypeGroupList": [CargoTypeGroup],
"_chartOfAccountsRelationships": ChartOfAccountsRelationships,
"chartOfAccounts": ChartOfAccounts,
"chartOfAccountsList": [ChartOfAccounts],
"_claimRelationships": ClaimRelationships,
"claim": Claim,
"claimList": [Claim],
"_claimLinkedClaimRelationships": ClaimLinkedClaimRelationships,
"_claimNoteRelationships": ClaimNoteRelationships,
"claimNote": ClaimNote,
"claimNoteList": [ClaimNote],
"_claimProjectedInvoiceRelationships": ClaimProjectedInvoiceRelationships,
"claimProjectedInvoice": ClaimProjectedInvoice,
"claimProjectedInvoiceList": [
ClaimProjectedInvoice
],
"_coaRelationships": COARelationships,
"coa": COA,
"coaList": [COA],
"_coaBrokerRelationships": CoaBrokerRelationships,
"coaBroker": CoaBroker,
"coaBrokerList": [CoaBroker],
"_coaDetailsRelationships": COADetailsRelationships,
"coaDetails": COADetails,
"coaDetailsList": [COADetails],
"_coaExtraFreightTermsRelationships": COAExtraFreightTermsRelationships,
"coaExtraFreightTerms": COAExtraFreightTerms,
"coaExtraFreightTermsList": [COAExtraFreightTerms],
"_coaHierarchyRelationships": CoaHierarchyRelationships,
"coaHierarchy": CoaHierarchy,
"coaHierarchyList": [CoaHierarchy],
"_coaItineraryRelationships": COAItineraryRelationships,
"coaItinerary": COAItinerary,
"coaItineraryList": [COAItinerary],
"_coaOptionRelationships": COAOptionRelationships,
"coaOption": COAOption,
"coaOptionList": [COAOption],
"_coaPeriodRelationships": CoaPeriodRelationships,
"coaPeriod": CoaPeriod,
"coaPeriodList": [CoaPeriod],
"collabStatus": CollabStatus,
"collabStatusList": [CollabStatus],
"_commodityContractRelationships": CommodityContractRelationships,
"commodityContract": CommodityContract,
"commodityContractList": [CommodityContract],
"_companyRelationships": CompanyRelationships,
"company": Company,
"companyList": [Company],
"configOptions": ConfigOptions,
"configOptionsList": [ConfigOptions],
"_consModeRelationships": ConsModeRelationships,
"consMode": ConsMode,
"consModeList": [ConsMode],
"_consModePortConsRelationships": ConsModePortConsRelationships,
"consModePortCons": ConsModePortCons,
"consModePortConsList": [ConsModePortCons],
"_consModeSeaConsRelationships": ConsModeSeaConsRelationships,
"consModeSeaCons": ConsModeSeaCons,
"consModeSeaConsList": [ConsModeSeaCons],
"correlationProfile": CorrelationProfile,
"correlationProfileList": [CorrelationProfile],
"country": Country,
"countryList": [Country],
"currency": Currency,
"currencyList": [Currency],
"dataFormView": DataFormView,
"dataFormViewList": [DataFormView],
"dataFormViewField": DataFormViewField,
"dataFormViewFieldList": [DataFormViewField],
"_decisionTableRelationships": DecisionTableRelationships,
"decisionTable": DecisionTable,
"decisionTableList": [DecisionTable],
"_decisionTableRuleReportRelationships": DecisionTableRuleReportRelationships,
"decisionTableRuleReport": DecisionTableRuleReport,
"decisionTableRuleReportList": [
DecisionTableRuleReport
],
"_delayRelationships": DelayRelationships,
"delay": Delay,
"delayList": [Delay],
"_delayBunkerRelationships": DelayBunkerRelationships,
"delayBunker": DelayBunker,
"delayBunkerList": [DelayBunker],
"_delayReasonRelationships": DelayReasonRelationships,
"delayReason": DelayReason,
"delayReasonList": [DelayReason],
"delayType": DelayType,
"delayTypeList": [DelayType],
"_demurrageAllocationDetailsRelationships": DemurrageAllocationDetailsRelationships,
"demurrageAllocationDetails": DemurrageAllocationDetails,
"demurrageAllocationDetailsList": [
DemurrageAllocationDetails
],
"_demurrageTaskLinkedLaytimeRelationships": DemurrageTaskLinkedLaytimeRelationships,
"department": Department,
"departmentList": [Department],
"equipmentContractHistory": EquipmentContractHistory,
"equipmentContractHistoryList": [
EquipmentContractHistory
],
"_estimateCargoBrokerRelationships": EstimateCargoBrokerRelationships,
"estimateCargoBroker": EstimateCargoBroker,
"estimateCargoBrokerList": [EstimateCargoBroker],
"_estimateCargoBunkerConsumptionRelationships": EstimateCargoBunkerConsumptionRelationships,
"estimateCargoBunkerConsumption": EstimateCargoBunkerConsumption,
"estimateCargoBunkerConsumptionList": [
EstimateCargoBunkerConsumption
],
"_estimateCargoesRelationships": EstimateCargoesRelationships,
"estimateCargoes": EstimateCargoes,
"estimateCargoesList": [EstimateCargoes],
"_estimateCargoExtraFreightTermsRelationships": EstimateCargoExtraFreightTermsRelationships,
"estimateCargoExtraFreightTerms": EstimateCargoExtraFreightTerms,
"estimateCargoExtraFreightTermsList": [
EstimateCargoExtraFreightTerms
],
"_estimateDelayRelationships": EstimateDelayRelationships,
"estimateDelay": EstimateDelay,
"estimateDelayList": [EstimateDelay],
"_estimateFuelEuReplacementBunkerRelationships": EstimateFuelEuReplacementBunkerRelationships,
"estimateFuelEuReplacementBunker": EstimateFuelEuReplacementBunker,
"estimateFuelEuReplacementBunkerList": [
EstimateFuelEuReplacementBunker
],
"_estimateItineraryRelationships": EstimateItineraryRelationships,
"estimateItinerary": EstimateItinerary,
"estimateItineraryList": [EstimateItinerary],
"_estimateItineraryBunkerRelationships": EstimateItineraryBunkerRelationships,
"estimateItineraryBunker": EstimateItineraryBunker,
"estimateItineraryBunkerList": [
EstimateItineraryBunker
],
"_estimateItineraryCarbonRelationships": EstimateItineraryCarbonRelationships,
"estimateItineraryCarbon": EstimateItineraryCarbon,
"estimateItineraryCarbonList": [
EstimateItineraryCarbon
],
"_estimateItineraryCarbonBunkerRelationships": EstimateItineraryCarbonBunkerRelationships,
"estimateItineraryCarbonBunker": EstimateItineraryCarbonBunker,
"estimateItineraryCarbonBunkerList": [
EstimateItineraryCarbonBunker
],
"_exchangeRateRelationships": ExchangeRateRelationships,
"exchangeRate": ExchangeRate,
"exchangeRateList": [ExchangeRate],
"expense": Expense,
"expenseList": [Expense],
"_extraFreightTermsRelationships": ExtraFreightTermsRelationships,
"extraFreightTerms": ExtraFreightTerms,
"extraFreightTermsList": [ExtraFreightTerms],
"_financialsAndOperationsInvoiceNotesRelationships": FinancialsAndOperationsInvoiceNotesRelationships,
"financialsAndOperationsInvoiceNotes": FinancialsAndOperationsInvoiceNotes,
"financialsAndOperationsInvoiceNotesList": [
FinancialsAndOperationsInvoiceNotes
],
"_financialsInvoiceRelationships": FinancialsInvoiceRelationships,
"financialsInvoice": FinancialsInvoice,
"financialsInvoiceList": [FinancialsInvoice],
"_financialsInvoiceDetailRelationships": FinancialsInvoiceDetailRelationships,
"financialsInvoiceDetail": FinancialsInvoiceDetail,
"financialsInvoiceDetailList": [
FinancialsInvoiceDetail
],
"_financialsInvoiceDetailCargoAllocationRelationships": FinancialsInvoiceDetailCargoAllocationRelationships,
"financialsInvoiceDetailCargoAllocation": FinancialsInvoiceDetailCargoAllocation,
"financialsInvoiceDetailCargoAllocationList": [
FinancialsInvoiceDetailCargoAllocation
],
"_financialsInvoicePaymentRelationships": FinancialsInvoicePaymentRelationships,
"financialsInvoicePayment": FinancialsInvoicePayment,
"financialsInvoicePaymentList": [
FinancialsInvoicePayment
],
"_fixtureRelationships": FixtureRelationships,
"fixture": Fixture,
"fixtureList": [Fixture],
"_fixtureRemarkRelationships": FixtureRemarkRelationships,
"fixtureRemark": FixtureRemark,
"fixtureRemarkList": [FixtureRemark],
"_formRelationships": FormRelationships,
"form": Form,
"formList": [Form],
"formTemplate": FormTemplate,
"formTemplateList": [FormTemplate],
"_freightInvoiceRelationships": FreightInvoiceRelationships,
"freightInvoice": FreightInvoice,
"freightInvoiceList": [FreightInvoice],
"freightTerm": FreightTerm,
"freightTermList": [FreightTerm],
"fuelEmissionsFactorsSet": FuelEmissionsFactorsSet,
"fuelEmissionsFactorsSetList": [
FuelEmissionsFactorsSet
],
"fuelLubeType": FuelLubeType,
"fuelLubeTypeList": [FuelLubeType],
"_fuelZoneRelationships": FuelZoneRelationships,
"fuelZone": FuelZone,
"fuelZoneList": [FuelZone],
"_fuelZoneSetRelationships": FuelZoneSetRelationships,
"fuelZoneSet": FuelZoneSet,
"fuelZoneSetList": [FuelZoneSet],
"_groupMemberRelationships": GroupMemberRelationships,
"groupMember": GroupMember,
"groupMemberList": [GroupMember],
"_headFixturePurchaseSaleRelationships": HeadFixturePurchaseSaleRelationships,
"headFixturePurchaseSale": HeadFixturePurchaseSale,
"headFixturePurchaseSaleList": [
HeadFixturePurchaseSale
],
"_holidayRelationships": HolidayRelationships,
"holiday": Holiday,
"holidayList": [Holiday],
"imosUser": ImosUser,
"imosUserList": [ImosUser],
"interfaceMessagesAndNotifications": InterfaceMessagesAndNotifications,
"interfaceMessagesAndNotificationsList": [
InterfaceMessagesAndNotifications
],
"_internalFinalFreightStatementVoyageRelationships": InternalFinalFreightStatementVoyageRelationships,
"_internalIndexHireTimeChartersRelationships": InternalIndexHireTimeChartersRelationships,
"_invoiceNoteRelationships": InvoiceNoteRelationships,
"invoiceNote": InvoiceNote,
"invoiceNoteList": [InvoiceNote],
"jobStatus": JobStatus,
"jobStatusList": [JobStatus],
"_laytimeRelationships": LaytimeRelationships,
"laytime": Laytime,
"laytimeList": [Laytime],
"_laytimePortActivitiesRelationships": LaytimePortActivitiesRelationships,
"laytimePortActivities": LaytimePortActivities,
"laytimePortActivitiesList": [
LaytimePortActivities
],
"_laytimePortDeductionRelationships": LaytimePortDeductionRelationships,
"laytimePortDeduction": LaytimePortDeduction,
"laytimePortDeductionList": [LaytimePortDeduction],
"_laytimePortsRelationships": LaytimePortsRelationships,
"laytimePorts": LaytimePorts,
"laytimePortsList": [LaytimePorts],
"laytimeTerms": LaytimeTerms,
"laytimeTermsList": [LaytimeTerms],
"_loadDischargeStandardRateRelationships": LoadDischargeStandardRateRelationships,
"loadDischargeStandardRate": LoadDischargeStandardRate,
"loadDischargeStandardRateList": [
LoadDischargeStandardRate
],
"_loadDischargeTableRatesRelationships": LoadDischargeTableRatesRelationships,
"loadDischargeTableRates": LoadDischargeTableRates,
"loadDischargeTableRatesList": [
LoadDischargeTableRates
],
"_loadlineZoneRelationships": LoadlineZoneRelationships,
"loadlineZone": LoadlineZone,
"loadlineZoneList": [LoadlineZone],
"_loadlineZoneDetailsRelationships": LoadlineZoneDetailsRelationships,
"loadlineZoneDetails": LoadlineZoneDetails,
"loadlineZoneDetailsList": [LoadlineZoneDetails],
"lob": Lob,
"lobList": [Lob],
"_marketRelationships": MarketRelationships,
"market": Market,
"marketList": [Market],
"_marketCargoRelationships": MarketCargoRelationships,
"marketCargo": MarketCargo,
"marketCargoList": [MarketCargo],
"_marketDataRelationships": MarketDataRelationships,
"marketData": MarketData,
"marketDataList": [MarketData],
"_marketPositionRelationships": MarketPositionRelationships,
"marketPosition": MarketPosition,
"marketPositionList": [MarketPosition],
"_marketPositionSourceRelationships": MarketPositionSourceRelationships,
"marketPositionSource": MarketPositionSource,
"marketPositionSourceList": [MarketPositionSource],
"_masterContractRelationships": MasterContractRelationships,
"masterContract": MasterContract,
"masterContractList": [MasterContract],
"_masterContractBrokerRelationships": MasterContractBrokerRelationships,
"_moduleAccessRelationships": ModuleAccessRelationships,
"moduleAccess": ModuleAccess,
"moduleAccessList": [ModuleAccess],
"notification": Notification,
"notificationList": [Notification],
"_objectAccessRelationships": ObjectAccessRelationships,
"objectAccess": ObjectAccess,
"objectAccessList": [ObjectAccess],
"objectApproval": ObjectApproval,
"objectApprovalList": [ObjectApproval],
"_operationsInvoiceRelationships": OperationsInvoiceRelationships,
"operationsInvoice": OperationsInvoice,
"operationsInvoiceList": [OperationsInvoice],
"_operationsInvoiceApprovalRelationships": OperationsInvoiceApprovalRelationships,
"operationsInvoiceApproval": OperationsInvoiceApproval,
"operationsInvoiceApprovalList": [
OperationsInvoiceApproval
],
"_operationsInvoiceDetailCargoAllocationRelationships": OperationsInvoiceDetailCargoAllocationRelationships,
"operationsInvoiceDetailCargoAllocation": OperationsInvoiceDetailCargoAllocation,
"operationsInvoiceDetailCargoAllocationList": [
OperationsInvoiceDetailCargoAllocation
],
"_operationsInvoiceDetailsRelationships": OperationsInvoiceDetailsRelationships,
"operationsInvoiceDetails": OperationsInvoiceDetails,
"operationsInvoiceDetailsList": [
OperationsInvoiceDetails
],
"_operationsInvoiceNoteRelationships": OperationsInvoiceNoteRelationships,
"operationsLedger": OperationsLedger,
"operationsLedgerList": [OperationsLedger],
"_operationsPaymentDetailsRelationships": OperationsPaymentDetailsRelationships,
"operationsPaymentDetails": OperationsPaymentDetails,
"operationsPaymentDetailsList": [
OperationsPaymentDetails
],
"_paperTradeRelationships": PaperTradeRelationships,
"paperTrade": PaperTrade,
"paperTradeList": [PaperTrade],
"_paperTradeExposurePeriodRelationships": PaperTradeExposurePeriodRelationships,
"paperTradeExposurePeriod": PaperTradeExposurePeriod,
"paperTradeExposurePeriodList": [
PaperTradeExposurePeriod
],
"_paymentRelationships": PaymentRelationships,
"payment": Payment,
"paymentList": [Payment],
"_paymentBatchRelationships": PaymentBatchRelationships,
"paymentBatch": PaymentBatch,
"paymentBatchList": [PaymentBatch],
"_paymentBatchDetailsRelationships": PaymentBatchDetailsRelationships,
"paymentBatchDetails": PaymentBatchDetails,
"paymentBatchDetailsList": [PaymentBatchDetails],
"_paymentDetailRelationships": PaymentDetailRelationships,
"paymentDetail": PaymentDetail,
"paymentDetailList": [PaymentDetail],
"paymentTerm": PaymentTerm,
"paymentTermList": [PaymentTerm],
"_poolRelationships": PoolRelationships,
"pool": Pool,
"poolList": [Pool],
"_poolAdminAccountRelationships": PoolAdminAccountRelationships,
"poolAdminAccount": PoolAdminAccount,
"poolAdminAccountList": [PoolAdminAccount],
"_poolAssignmentRelationships": PoolAssignmentRelationships,
"poolAssignment": PoolAssignment,
"poolAssignmentList": [PoolAssignment],
"_poolAssignmentPremiumRelationships": PoolAssignmentPremiumRelationships,
"poolAssignmentPremium": PoolAssignmentPremium,
"poolAssignmentPremiumList": [
PoolAssignmentPremium
],
"_poolingDistributionRelationships": PoolingDistributionRelationships,
"poolingDistribution": PoolingDistribution,
"poolingDistributionList": [PoolingDistribution],
"_poolingDistributionPremiumRelationships": PoolingDistributionPremiumRelationships,
"poolingDistributionPremium": PoolingDistributionPremium,
"poolingDistributionPremiumList": [
PoolingDistributionPremium
],
"_portRelationships": PortRelationships,
"port": Port,
"portList": [Port],
"portActivity": PortActivity,
"portActivityList": [PortActivity],
"_portActivityBunkerRelationships": PortActivityBunkerRelationships,
"portActivityBunker": PortActivityBunker,
"portActivityBunkerList": [PortActivityBunker],
"_portAdvanceDaRelationships": PortAdvanceDaRelationships,
"portArea": PortArea,
"portAreaList": [PortArea],
"_portBerthRelationships": PortBerthRelationships,
"portBerth": PortBerth,
"portBerthList": [PortBerth],
"_portCargoCompatRelationships": PortCargoCompatRelationships,
"portCargoCompat": PortCargoCompat,
"portCargoCompatList": [PortCargoCompat],
"_portCargoCompatBerthRelationships": PortCargoCompatBerthRelationships,
"portCargoCompatBerth": PortCargoCompatBerth,
"portCargoCompatBerthList": [PortCargoCompatBerth],
"_portExpenseRelationships": PortExpenseRelationships,
"portExpense": PortExpense,
"portExpenseList": [PortExpense],
"_portExpenseMiscDetailsRelationships": PortExpenseMiscDetailsRelationships,
"portExpenseMiscDetails": PortExpenseMiscDetails,
"portExpenseMiscDetailsList": [
PortExpenseMiscDetails
],
"_portExpensesStandardRelationships": PortExpensesStandardRelationships,
"portExpensesStandard": PortExpensesStandard,
"portExpensesStandardList": [PortExpensesStandard],
"_portExpenseStandardDetailRelationships": PortExpenseStandardDetailRelationships,
"portExpenseStandardDetail": PortExpenseStandardDetail,
"portExpenseStandardDetailList": [
PortExpenseStandardDetail
],
"_portFuelAvailabilityRelationships": PortFuelAvailabilityRelationships,
"portFuelAvailability": PortFuelAvailability,
"portFuelAvailabilityList": [PortFuelAvailability],
"portFunction": PortFunction,
"portFunctionList": [PortFunction],
"_portVesselRelationships": PortVesselRelationships,
"portVessel": PortVessel,
"portVesselList": [PortVessel],
"_portVesselBerthRelationships": PortVesselBerthRelationships,
"portVesselBerth": PortVesselBerth,
"portVesselBerthList": [PortVesselBerth],
"_positionRelationships": PositionRelationships,
"position": Position,
"positionList": [Position],
"region": Region,
"regionList": [Region],
"_reminderRelationships": ReminderRelationships,
"reminder": Reminder,
"reminderList": [Reminder],
"report": Report,
"reportList": [Report],
"_reportUserViewRelationships": ReportUserViewRelationships,
"reportUserView": ReportUserView,
"reportUserViewList": [ReportUserView],
"_reportViewRelationships": ReportViewRelationships,
"reportView": ReportView,
"reportViewList": [ReportView],
"_revisionRelationships": RevisionRelationships,
"revision": Revision,
"revisionList": [Revision],
"revisionPanelContent": RevisionPanelContent,
"revisionPanelContentList": [RevisionPanelContent],
"_revisionRowRelationships": RevisionRowRelationships,
"revisionRow": RevisionRow,
"revisionRowList": [RevisionRow],
"_scheduleBargeRelationships": ScheduleBargeRelationships,
"scheduleBarge": ScheduleBarge,
"scheduleBargeList": [ScheduleBarge],
"sharedResources": SharedResources,
"sharedResourcesList": [SharedResources],
"_standardExpenseRelationships": StandardExpenseRelationships,
"standardExpense": StandardExpense,
"standardExpenseList": [StandardExpense],
"_standardExpenseConditionRelationships": StandardExpenseConditionRelationships,
"_standardRateRelationships": StandardRateRelationships,
"standardRate": StandardRate,
"standardRateList": [StandardRate],
"vesonSubscription": VesonSubscription,
"vesonSubscriptionList": [VesonSubscription],
"_surveyCostDetailsRelationships": SurveyCostDetailsRelationships,
"surveyCostDetails": SurveyCostDetails,
"surveyCostDetailsList": [SurveyCostDetails],
"_surveyCostsBunkersRelationships": SurveyCostsBunkersRelationships,
"surveyCostsBunkers": SurveyCostsBunkers,
"surveyCostsBunkersList": [SurveyCostsBunkers],
"_tankConditionRelationships": TankConditionRelationships,
"tankCondition": TankCondition,
"tankConditionList": [TankCondition],
"_taskRelationships": TaskRelationships,
"task": Task,
"taskList": [Task],
"taskGroup": TaskGroup,
"taskGroupList": [TaskGroup],
"taskGroupItem": TaskGroupItem,
"taskGroupItemList": [TaskGroupItem],
"_tasksAndAlertsRelationships": TasksAndAlertsRelationships,
"tasksAndAlerts": TasksAndAlerts,
"tasksAndAlertsList": [TasksAndAlerts],
"tcDeduction": TCDeduction,
"tcDeductionList": [TCDeduction],
"_teamRelationships": TeamRelationships,
"team": Team,
"teamList": [Team],
"_termRelationships": TermRelationships,
"term": Term,
"termList": [Term],
"_timeCharterBrokerRelationships": TimeCharterBrokerRelationships,
"timeCharterBroker": TimeCharterBroker,
"timeCharterBrokerList": [TimeCharterBroker],
"_timeCharterBunkerDeliveryRelationships": TimeCharterBunkerDeliveryRelationships,
"timeCharterBunkerDelivery": TimeCharterBunkerDelivery,
"timeCharterBunkerDeliveryList": [
TimeCharterBunkerDelivery
],
"_timeCharterBunkerExposureRelationships": TimeCharterBunkerExposureRelationships,
"timeCharterBunkerExposure": TimeCharterBunkerExposure,
"timeCharterBunkerExposureList": [
TimeCharterBunkerExposure
],
"_timeCharterCOARelationships": TimeCharterCOARelationships,
"timeCharterCOA": TimeCharterCOA,
"timeCharterCOAList": [TimeCharterCOA],
"_timeCharterCOABrokerRelationships": TimeCharterCOABrokerRelationships,
"_timeCharterCOADeliveryRedeliveryOptionRelationships": TimeCharterCOADeliveryRedeliveryOptionRelationships,
"timeCharterCOADeliveryRedeliveryOption": TimeCharterCOADeliveryRedeliveryOption,
"timeCharterCOADeliveryRedeliveryOptionList": [
TimeCharterCOADeliveryRedeliveryOption
],
"_timeCharterCOAExpenseRelationships": TimeCharterCOAExpenseRelationships,
"_timeCharterCOAHireRelationships": TimeCharterCOAHireRelationships,
"_timeCharterCOAVesselRelationships": TimeCharterCOAVesselRelationships,
"timeCharterCOAVessel": TimeCharterCOAVessel,
"timeCharterCOAVesselList": [TimeCharterCOAVessel],
"_timeCharterCOAVesselTypeRelationships": TimeCharterCOAVesselTypeRelationships,
"timeCharterCOAVesselType": TimeCharterCOAVesselType,
"timeCharterCOAVesselTypeList": [
TimeCharterCOAVesselType
],
"_timeCharterContractRelationships": TimeCharterContractRelationships,
"timeCharterContract": TimeCharterContract,
"timeCharterContractList": [TimeCharterContract],
"_timeCharterExpenseRelationships": TimeCharterExpenseRelationships,
"timeCharterExpense": TimeCharterExpense,
"timeCharterExpenseList": [TimeCharterExpense],
"_timeCharterExposurePeriodRelationships": TimeCharterExposurePeriodRelationships,
"timeCharterExposurePeriod": TimeCharterExposurePeriod,
"timeCharterExposurePeriodList": [
TimeCharterExposurePeriod
],
"timeCharterExtra": TimeCharterExtra,
"timeCharterExtraList": [TimeCharterExtra],
"_timeCharterHireRelationships": TimeCharterHireRelationships,
"timeCharterHire": TimeCharterHire,
"timeCharterHireList": [TimeCharterHire],
"_timeCharterLeaseRelationships": TimeCharterLeaseRelationships,
"timeCharterLease": TimeCharterLease,
"timeCharterLeaseList": [TimeCharterLease],
"_timeCharterLiftingOptionRelationships": TimeCharterLiftingOptionRelationships,
"timeCharterLiftingOption": TimeCharterLiftingOption,
"timeCharterLiftingOptionList": [
TimeCharterLiftingOption
],
"_timeCharterOutDetailsRelationships": TimeCharterOutDetailsRelationships,
"timeCharterOutDetails": TimeCharterOutDetails,
"timeCharterOutDetailsList": [
TimeCharterOutDetails
],
"_timeCharterPortConsumptionRelationships": TimeCharterPortConsumptionRelationships,
"timeCharterPortConsumption": TimeCharterPortConsumption,
"timeCharterPortConsumptionList": [
TimeCharterPortConsumption
],
"timeCharterProfitShare": TimeCharterProfitShare,
"timeCharterProfitShareList": [
TimeCharterProfitShare
],
"_timeCharterProfitShareContractsRelationships": TimeCharterProfitShareContractsRelationships,
"timeCharterProfitShareContracts": TimeCharterProfitShareContracts,
"timeCharterProfitShareContractsList": [
TimeCharterProfitShareContracts
],
"_timeCharterProjectedInvoiceRelationships": TimeCharterProjectedInvoiceRelationships,
"timeCharterProjectedInvoice": TimeCharterProjectedInvoice,
"timeCharterProjectedInvoiceList": [
TimeCharterProjectedInvoice
],
"_timeCharterPurchaseOptionRelationships": TimeCharterPurchaseOptionRelationships,
"timeCharterPurchaseOption": TimeCharterPurchaseOption,
"timeCharterPurchaseOptionList": [
TimeCharterPurchaseOption
],
"_timeCharterSeaConsumptionRelationships": TimeCharterSeaConsumptionRelationships,
"timeCharterSeaConsumption": TimeCharterSeaConsumption,
"timeCharterSeaConsumptionList": [
TimeCharterSeaConsumption
],
"_timeCharterSeaConsumptionBunkerRelationships": TimeCharterSeaConsumptionBunkerRelationships,
"timeCharterSeaConsumptionBunker": TimeCharterSeaConsumptionBunker,
"timeCharterSeaConsumptionBunkerList": [
TimeCharterSeaConsumptionBunker
],
"timeCharterTonnageTax": TimeCharterTonnageTax,
"timeCharterTonnageTaxList": [
TimeCharterTonnageTax
],
"timeCharterWarrantyConsumption": TimeCharterWarrantyConsumption,
"timeCharterWarrantyConsumptionList": [
TimeCharterWarrantyConsumption
],
"_timeCharterWarrantyDelayExclusionRelationships": TimeCharterWarrantyDelayExclusionRelationships,
"timeCharterWarrantyDelayExclusion": TimeCharterWarrantyDelayExclusion,
"timeCharterWarrantyDelayExclusionList": [
TimeCharterWarrantyDelayExclusion
],
"timeZoneCodes": TimeZoneCodes,
"timeZoneCodesList": [TimeZoneCodes],
"timeZoneInfo": TimeZoneInfo,
"timeZoneInfoList": [TimeZoneInfo],
"_tradeAreaRelationships": TradeAreaRelationships,
"tradeArea": TradeArea,
"tradeAreaList": [TradeArea],
"_tradeBrokerRelationships": TradeBrokerRelationships,
"tradeBroker": TradeBroker,
"tradeBrokerList": [TradeBroker],
"_tradeContractRelationships": TradeContractRelationships,
"tradeContract": TradeContract,
"tradeContractList": [TradeContract],
"tradeFilter": TradeFilter,
"tradeFilterList": [TradeFilter],
"_tradeFilterDetailRelationships": TradeFilterDetailRelationships,
"tradeFilterDetail": TradeFilterDetail,
"tradeFilterDetailList": [TradeFilterDetail],
"_tradeIndexRelationships": TradeIndexRelationships,
"tradeIndex": TradeIndex,
"tradeIndexList": [TradeIndex],
"_tradePnlRelationships": TradePnlRelationships,
"tradePnl": TradePnl,
"tradePnlList": [TradePnl],
"_tradePnlDetailRelationships": TradePnlDetailRelationships,
"tradePnlDetail": TradePnlDetail,
"tradePnlDetailList": [TradePnlDetail],
"_tradeSnapshotRelationships": TradeSnapshotRelationships,
"tradeSnapshot": TradeSnapshot,
"tradeSnapshotList": [TradeSnapshot],
"_tradeTypeRelationships": TradeTypeRelationships,
"tradeType": TradeType,
"tradeTypeList": [TradeType],
"_tradeUnitRelationships": TradeUnitRelationships,
"tradeUnit": TradeUnit,
"tradeUnitList": [TradeUnit],
"_tradingProfileRelationships": TradingProfileRelationships,
"tradingProfile": TradingProfile,
"tradingProfileList": [TradingProfile],
"_tradingProfilePropertyRelationships": TradingProfilePropertyRelationships,
"tradingProfileProperty": TradingProfileProperty,
"tradingProfilePropertyList": [
TradingProfileProperty
],
"_unitOfMeasureRelationships": UnitOfMeasureRelationships,
"unitOfMeasure": UnitOfMeasure,
"unitOfMeasureList": [UnitOfMeasure],
"_unpricedElementRelationships": UnpricedElementRelationships,
"unpricedElement": UnpricedElement,
"unpricedElementList": [UnpricedElement],
"_unpricedElementRemarkRelationships": UnpricedElementRemarkRelationships,
"_unpricedElementStructureRelationships": UnpricedElementStructureRelationships,
"unpricedElementStructure": UnpricedElementStructure,
"unpricedElementStructureList": [
UnpricedElementStructure
],
"_userRelationships": UserRelationships,
"user": User,
"userList": [User],
"userField": UserField,
"userFieldList": [UserField],
"_vesselRelationships": VesselRelationships,
"vessel": Vessel,
"vesselList": [Vessel],
"_vesselBoatsRelationships": VesselBoatsRelationships,
"vesselBoats": VesselBoats,
"vesselBoatsList": [VesselBoats],
"_vesselBunkerTankRelationships": VesselBunkerTankRelationships,
"vesselBunkerTank": VesselBunkerTank,
"vesselBunkerTankList": [VesselBunkerTank],
"_vesselConsModeRelationships": VesselConsModeRelationships,
"vesselConsMode": VesselConsMode,
"vesselConsModeList": [VesselConsMode],
"_vesselCraneRelationships": VesselCraneRelationships,
"vesselCrane": VesselCrane,
"vesselCraneList": [VesselCrane],
"_vesselDetailsRelationships": VesselDetailsRelationships,
"vesselDetails": VesselDetails,
"vesselDetailsList": [VesselDetails],
"_vesselDraftRelationships": VesselDraftRelationships,
"vesselDraft": VesselDraft,
"vesselDraftList": [VesselDraft],
"_vesselDraftMarksRelationships": VesselDraftMarksRelationships,
"vesselDraftMarks": VesselDraftMarks,
"vesselDraftMarksList": [VesselDraftMarks],
"_vesselEvaluationRelationships": VesselEvaluationRelationships,
"vesselEvaluation": VesselEvaluation,
"vesselEvaluationList": [VesselEvaluation],
"_vesselFleetMemberRelationships": VesselFleetMemberRelationships,
"vesselFleetMember": VesselFleetMember,
"vesselFleetMemberList": [VesselFleetMember],
"_vesselFleetMemberFullRelationships": VesselFleetMemberFullRelationships,
"vesselFleetMemberFull": VesselFleetMemberFull,
"vesselFleetMemberFullList": [
VesselFleetMemberFull
],
"_vesselHatchRelationships": VesselHatchRelationships,
"vesselHatch": VesselHatch,
"vesselHatchList": [VesselHatch],
"_vesselHoldRelationships": VesselHoldRelationships,
"vesselHold": VesselHold,
"vesselHoldList": [VesselHold],
"_vesselIncidentRelationships": VesselIncidentRelationships,
"vesselIncident": VesselIncident,
"vesselIncidentList": [VesselIncident],
"_vesselInspectionRelationships": VesselInspectionRelationships,
"vesselInspection": VesselInspection,
"vesselInspectionList": [VesselInspection],
"_vesselPortConsRelationships": VesselPortConsRelationships,
"vesselPortCons": VesselPortCons,
"vesselPortConsList": [VesselPortCons],
"vesselRoute": VesselRoute,
"vesselRouteList": [VesselRoute],
"_vesselsAndBargesRelationships": VesselsAndBargesRelationships,
"_vesselSeaConsRelationships": VesselSeaConsRelationships,
"vesselSeaCons": VesselSeaCons,
"vesselSeaConsList": [VesselSeaCons],
"_vesselSeaConsBunkerRelationships": VesselSeaConsBunkerRelationships,
"vesselSeaConsBunker": VesselSeaConsBunker,
"vesselSeaConsBunkerList": [VesselSeaConsBunker],
"_vesselTankRelationships": VesselTankRelationships,
"vesselTank": VesselTank,
"vesselTankList": [VesselTank],
"_vesselTceTargetRelationships": VesselTceTargetRelationships,
"vesselTceTarget": VesselTceTarget,
"vesselTceTargetList": [VesselTceTarget],
"_vesselTypeRelationships": VesselTypeRelationships,
"vesselType": VesselType,
"vesselTypeList": [VesselType],
"_vesselVariablesRelationships": VesselVariablesRelationships,
"_vesselVettingRelationships": VesselVettingRelationships,
"vesselVetting": VesselVetting,
"vesselVettingList": [VesselVetting],
"_voyageRelationships": VoyageRelationships,
"voyage": Voyage,
"voyageList": [Voyage],
"_voyageActivityReportRelationships": VoyageActivityReportRelationships,
"voyageActivityReport": VoyageActivityReport,
"voyageActivityReportList": [VoyageActivityReport],
"_voyageAndTcoFixtureRelationships": VoyageAndTcoFixtureRelationships,
"voyageAndTcoFixture": VoyageAndTcoFixture,
"voyageAndTcoFixtureList": [VoyageAndTcoFixture],
"_voyageBunkerInventoryRelationships": VoyageBunkerInventoryRelationships,
"voyageBunkerInventory": VoyageBunkerInventory,
"voyageBunkerInventoryList": [
VoyageBunkerInventory
],
"_voyageBunkerInventoryDetailRelationships": VoyageBunkerInventoryDetailRelationships,
"voyageBunkerInventoryDetail": VoyageBunkerInventoryDetail,
"voyageBunkerInventoryDetailList": [
VoyageBunkerInventoryDetail
],
"_voyageBunkerLiftingRelationships": VoyageBunkerLiftingRelationships,
"voyageBunkerLifting": VoyageBunkerLifting,
"voyageBunkerLiftingList": [VoyageBunkerLifting],
"_voyageBunkerSummaryRelationships": VoyageBunkerSummaryRelationships,
"voyageBunkerSummary": VoyageBunkerSummary,
"voyageBunkerSummaryList": [VoyageBunkerSummary],
"_voyageCargoHandlingRelationships": VoyageCargoHandlingRelationships,
"voyageCargoHandling": VoyageCargoHandling,
"voyageCargoHandlingList": [VoyageCargoHandling],
"_voyageCargoHandlingDocumentRelationships": VoyageCargoHandlingDocumentRelationships,
"voyageCargoHandlingDocument": VoyageCargoHandlingDocument,
"voyageCargoHandlingDocumentList": [
VoyageCargoHandlingDocument
],
"_voyageCargoHandlingEventRelationships": VoyageCargoHandlingEventRelationships,
"voyageCargoHandlingEvent": VoyageCargoHandlingEvent,
"voyageCargoHandlingEventList": [
VoyageCargoHandlingEvent
],
"_voyageCargoHandlingStowageRelationships": VoyageCargoHandlingStowageRelationships,
"voyageCargoHandlingStowage": VoyageCargoHandlingStowage,
"voyageCargoHandlingStowageList": [
VoyageCargoHandlingStowage
],
"_voyageCargoTransferRelationships": VoyageCargoTransferRelationships,
"voyageCargoTransfer": VoyageCargoTransfer,
"voyageCargoTransferList": [VoyageCargoTransfer],
"_voyageContactRelationships": VoyageContactRelationships,
"voyageContact": VoyageContact,
"voyageContactList": [VoyageContact],
"_voyageContactFullRelationships": VoyageContactFullRelationships,
"_voyageEmissionsRelationships": VoyageEmissionsRelationships,
"voyageEmissions": VoyageEmissions,
"voyageEmissionsList": [VoyageEmissions],
"_voyageEmissionsDetailRelationships": VoyageEmissionsDetailRelationships,
"voyageEmissionsDetail": VoyageEmissionsDetail,
"voyageEmissionsDetailList": [
VoyageEmissionsDetail
],
"_voyageEquipmentEventRelationships": VoyageEquipmentEventRelationships,
"voyageEquipmentEvent": VoyageEquipmentEvent,
"voyageEquipmentEventList": [VoyageEquipmentEvent],
"_voyageEstimateRelationships": VoyageEstimateRelationships,
"voyageEstimate": VoyageEstimate,
"voyageEstimateList": [VoyageEstimate],
"_voyageEstimateBunkerRelationships": VoyageEstimateBunkerRelationships,
"voyageEstimateBunker": VoyageEstimateBunker,
"voyageEstimateBunkerList": [VoyageEstimateBunker],
"_voyageEstimateCOACVCAnalysisRelationships": VoyageEstimateCOACVCAnalysisRelationships,
"voyageEstimateCOACVCAnalysis": VoyageEstimateCOACVCAnalysis,
"voyageEstimateCOACVCAnalysisList": [
VoyageEstimateCOACVCAnalysis
],
"_voyageEstimateCOACVCAnalysisResultRelationships": VoyageEstimateCOACVCAnalysisResultRelationships,
"voyageEstimateCOACVCAnalysisResult": VoyageEstimateCOACVCAnalysisResult,
"voyageEstimateCOACVCAnalysisResultList": [
VoyageEstimateCOACVCAnalysisResult
],
"_voyageEstimateCOACVCAnalysisResultBunkerRelationships": VoyageEstimateCOACVCAnalysisResultBunkerRelationships,
"voyageEstimateCOACVCAnalysisResultBunker": VoyageEstimateCOACVCAnalysisResultBunker,
"voyageEstimateCOACVCAnalysisResultBunkerList": [
VoyageEstimateCOACVCAnalysisResultBunker
],
"_voyageEstimateMiscExpenseRelationships": VoyageEstimateMiscExpenseRelationships,
"voyageEstimateMiscExpense": VoyageEstimateMiscExpense,
"voyageEstimateMiscExpenseList": [
VoyageEstimateMiscExpense
],
"_voyageEstimatePortExpenseRelationships": VoyageEstimatePortExpenseRelationships,
"voyageEstimatePortExpense": VoyageEstimatePortExpense,
"voyageEstimatePortExpenseList": [
VoyageEstimatePortExpense
],
"_voyageEstimateTimeCharterExpenseRelationships": VoyageEstimateTimeCharterExpenseRelationships,
"voyageEstimateTimeCharterExpense": VoyageEstimateTimeCharterExpense,
"voyageEstimateTimeCharterExpenseList": [
VoyageEstimateTimeCharterExpense
],
"voyageInstruction": VoyageInstruction,
"voyageInstructionList": [VoyageInstruction],
"_voyageItineraryRelationships": VoyageItineraryRelationships,
"voyageItinerary": VoyageItinerary,
"voyageItineraryList": [VoyageItinerary],
"_voyageItineraryBerthRelationships": VoyageItineraryBerthRelationships,
"voyageItineraryBerth": VoyageItineraryBerth,
"voyageItineraryBerthList": [VoyageItineraryBerth],
"_voyageItineraryBunkerRelationships": VoyageItineraryBunkerRelationships,
"voyageItineraryBunker": VoyageItineraryBunker,
"voyageItineraryBunkerList": [
VoyageItineraryBunker
],
"_voyageItineraryCarbonRelationships": VoyageItineraryCarbonRelationships,
"voyageItineraryCarbon": VoyageItineraryCarbon,
"voyageItineraryCarbonList": [
VoyageItineraryCarbon
],
"_voyageItineraryCarbonBunkerRelationships": VoyageItineraryCarbonBunkerRelationships,
"voyageItineraryCarbonBunker": VoyageItineraryCarbonBunker,
"voyageItineraryCarbonBunkerList": [
VoyageItineraryCarbonBunker
],
"_voyageItineraryCargoHandlingRelationships": VoyageItineraryCargoHandlingRelationships,
"_voyageItineraryProjectedBunkerInvoiceRelationships": VoyageItineraryProjectedBunkerInvoiceRelationships,
"voyageLegDetails": VoyageLegDetails,
"voyageLegDetailsList": [VoyageLegDetails],
"voyageLegSummary": VoyageLegSummary,
"voyageLegSummaryList": [VoyageLegSummary],
"_voyagePnlRelationships": VoyagePnlRelationships,
"voyagePnl": VoyagePnl,
"voyagePnlList": [VoyagePnl],
"_voyagePnlBunkerRelationships": VoyagePnlBunkerRelationships,
"voyagePnlBunker": VoyagePnlBunker,
"voyagePnlBunkerList": [VoyagePnlBunker],
"_voyagePnlBunkerDetailRelationships": VoyagePnlBunkerDetailRelationships,
"voyagePnlBunkerDetail": VoyagePnlBunkerDetail,
"voyagePnlBunkerDetailList": [
VoyagePnlBunkerDetail
],
"_voyagePnlCargoRelationships": VoyagePnlCargoRelationships,
"voyagePnlCargo": VoyagePnlCargo,
"voyagePnlCargoList": [VoyagePnlCargo],
"_voyagePnlDetailRelationships": VoyagePnlDetailRelationships,
"voyagePnlDetail": VoyagePnlDetail,
"voyagePnlDetailList": [VoyagePnlDetail],
"_voyagePnlDrilldownRelationships": VoyagePnlDrilldownRelationships,
"voyagePnlDrilldown": VoyagePnlDrilldown,
"voyagePnlDrilldownList": [VoyagePnlDrilldown],
"_voyagePnlItineraryLineRelationships": VoyagePnlItineraryLineRelationships,
"voyagePnlItineraryLine": VoyagePnlItineraryLine,
"voyagePnlItineraryLineList": [
VoyagePnlItineraryLine
],
"_voyagePnlItineraryLineBunkerRelationships": VoyagePnlItineraryLineBunkerRelationships,
"voyagePnlItineraryLineBunker": VoyagePnlItineraryLineBunker,
"voyagePnlItineraryLineBunkerList": [
VoyagePnlItineraryLineBunker
],
"_voyagePnlSummaryRelationships": VoyagePnlSummaryRelationships,
"voyagePnlSummary": VoyagePnlSummary,
"voyagePnlSummaryList": [VoyagePnlSummary],
"_voyagePortActivitiesRelationships": VoyagePortActivitiesRelationships,
"voyagePortActivities": VoyagePortActivities,
"voyagePortActivitiesList": [VoyagePortActivities],
"_voyagePortAgentRelationships": VoyagePortAgentRelationships,
"voyagePortAgent": VoyagePortAgent,
"voyagePortAgentList": [VoyagePortAgent],
"_voyageProfitShareRelationships": VoyageProfitShareRelationships,
"voyageProfitShare": VoyageProfitShare,
"voyageProfitShareList": [VoyageProfitShare],
"_voyageProjectedInvoiceRelationships": VoyageProjectedInvoiceRelationships,
"voyageProjectedInvoice": VoyageProjectedInvoice,
"voyageProjectedInvoiceList": [
VoyageProjectedInvoice
],
"_voyageRemarksRelationships": VoyageRemarksRelationships,
"voyageRemarks": VoyageRemarks,
"voyageRemarksList": [VoyageRemarks],
"_voyageTemplateRelationships": VoyageTemplateRelationships,
"voyageTemplate": VoyageTemplate,
"voyageTemplateList": [VoyageTemplate],
"_voyageTemplateRecipientRelationships": VoyageTemplateRecipientRelationships,
"waterway": Waterway,
"waterwayList": [Waterway],
"weatherState": WeatherState,
"weatherStateList": [WeatherState],
"_worksheetRelationships": WorksheetRelationships,
"worksheet": Worksheet,
"worksheetList": [Worksheet],
"_worksheetEstimateRelationships": WorksheetEstimateRelationships,
"worksheetEstimate": WorksheetEstimate,
"worksheetEstimateList": [WorksheetEstimate],
"_worksheetPriceComponentRelationships": WorksheetPriceComponentRelationships,
"worksheetPriceComponent": WorksheetPriceComponent,
"worksheetPriceComponentList": [
WorksheetPriceComponent
],
"_worksheetVesselRelationships": WorksheetVesselRelationships,
"worksheetVessel": WorksheetVessel,
"worksheetVesselList": [WorksheetVessel]
}
}
}
imosapp
Response
Returns an ImosappRootQuery
Example
Query
query Imosapp {
imosapp {
formQuery
getPermissions {
...GetPermissionsResponseFragment
}
systemConfig {
...SystemConfigFragment
}
getConfigFlag
getUserPrefs {
...UserPrefFragment
}
runPortAlertRules {
...RunAlertRulesResponseFragment
}
runVesselAlertRules {
...RunAlertRulesResponseFragment
}
runVoyageEstimateAlertRules {
...RunAlertRulesResponseFragment
}
runVoyageAlertRules {
...RunAlertRulesResponseFragment
}
runCargoNameAlertRules {
...RunAlertRulesResponseFragment
}
runCoaAlertRules {
...RunAlertRulesResponseFragment
}
runTimeCharterContractAlertRules {
...RunAlertRulesResponseFragment
}
}
}
Response
{
"data": {
"imosapp": {
"formQuery": Json,
"getPermissions": GetPermissionsResponse,
"systemConfig": SystemConfig,
"getConfigFlag": Any,
"getUserPrefs": [UserPref],
"runPortAlertRules": RunAlertRulesResponse,
"runVesselAlertRules": RunAlertRulesResponse,
"runVoyageEstimateAlertRules": RunAlertRulesResponse,
"runVoyageAlertRules": RunAlertRulesResponse,
"runCargoNameAlertRules": RunAlertRulesResponse,
"runCoaAlertRules": RunAlertRulesResponse,
"runTimeCharterContractAlertRules": RunAlertRulesResponse
}
}
}
marketPositions
Response
Returns a MarketPositionsRootQuery
Example
Query
query MarketPositions {
marketPositions {
getPositions {
...MarketPositionsResponseFragment
}
}
}
Response
{
"data": {
"marketPositions": {
"getPositions": MarketPositionsResponse
}
}
}
marketPrices
Response
Returns a MarketPricesRootQuery
Example
Query
query MarketPrices {
marketPrices {
getPrice {
...PriceInfoFragment
}
}
}
Response
{"data": {"marketPrices": {"getPrice": PriceInfo}}}
message
Response
Returns a MessageRootQuery
Example
Query
query Message {
message {
getMessages {
...MessageRecordFragment
}
getFlatMessages {
...MessageRecordFragment
}
getMessageHistory {
...MessageRecordFragment
}
getMessageEditHistory {
...MessageRecordFragment
}
getMessage {
...MessageRecordFragment
}
getMessageById {
...MessageRecordFragment
}
autoApprovalSettings {
...AutoApprovalSettingOutputFragment
}
}
}
Response
{
"data": {
"message": {
"getMessages": [MessageRecord],
"getFlatMessages": [MessageRecord],
"getMessageHistory": [MessageRecord],
"getMessageEditHistory": [MessageRecord],
"getMessage": MessageRecord,
"getMessageById": MessageRecord,
"autoApprovalSettings": [AutoApprovalSettingOutput]
}
}
}
reports
Response
Returns a ReportsRootQuery
Example
Query
query Reports {
reports {
sccReport {
...SCCReportFragment
}
}
}
Response
{"data": {"reports": {"sccReport": SCCReport}}}
vessel
Response
Returns a VesselRootQuery
Example
Query
query Vessel {
vessel {
getVessels {
...VesselService_VesselFragment
}
getVesselByPartialNameResults {
...VesselService_VesselFragment
}
getVesselTypeDefinitions {
...VesselTypeDefinitionFragment
}
getHistoricalVesselPositions {
...HistoricalVesselPositionFragment
}
}
}
Response
{
"data": {
"vessel": {
"getVessels": [VesselService_Vessel],
"getVesselByPartialNameResults": [
VesselService_Vessel
],
"getVesselTypeDefinitions": [VesselTypeDefinition],
"getHistoricalVesselPositions": [
HistoricalVesselPosition
]
}
}
}
views
Response
Returns a ViewsRootQuery
Example
Query
query Views {
views {
getViews {
...ViewFragment
}
getView {
...ViewFragment
}
getCurrentView {
...ViewFragment
}
getCurrentViewHistory
}
}
Response
{
"data": {
"views": {
"getViews": [View],
"getView": View,
"getCurrentView": View,
"getCurrentViewHistory": ["abc123"]
}
}
}
voyage
Response
Returns a VoyageRootQuery
Example
Query
query Voyage {
voyage {
processPositionReport {
...ProcessPositionReportResultFragment
}
processEtaEtd {
...ProcessEtaEtdResultFragment
}
processPortActivityList {
...ProcessPortActivityListResultFragment
}
processUpcomingPortsList {
...ProcessUpcomingPortsListResultFragment
}
processDelay {
...ProcessDelayResultFragment
}
processCargoHandlingList {
...ProcessCargoHandlingListResultFragment
}
processVeslinkForm {
...ProcessVeslinkFormResultFragment
}
recalculateVoyage {
...RecalculateVoyageResultFragment
}
}
}
Response
{
"data": {
"voyage": {
"processPositionReport": ProcessPositionReportResult,
"processEtaEtd": ProcessEtaEtdResult,
"processPortActivityList": ProcessPortActivityListResult,
"processUpcomingPortsList": ProcessUpcomingPortsListResult,
"processDelay": ProcessDelayResult,
"processCargoHandlingList": ProcessCargoHandlingListResult,
"processVeslinkForm": ProcessVeslinkFormResult,
"recalculateVoyage": RecalculateVoyageResult
}
}
}
Mutations
chartering_functions
Response
Returns a Chartering_functionsRootMutation
Example
Query
mutation Chartering_functions {
chartering_functions {
cargoUpdate {
...Imosfunctions_CargoUpdateResponseFragment
}
runEstimate {
...Imosfunctions_RunEstimateResponseFragment
}
}
}
Response
{
"data": {
"chartering_functions": {
"cargoUpdate": Imosfunctions_CargoUpdateResponse,
"runEstimate": Imosfunctions_RunEstimateResponse
}
}
}
financials_functions
Response
Returns a Financials_functionsRootMutation
Example
Query
mutation Financials_functions {
financials_functions {
postMonthlyAccrualBill {
...Imosfunctions_PostMonthlyAccrualBillResponseFragment
}
postVoyagePeriodBill {
...Imosfunctions_PostVoyagePeriodBillResponseFragment
}
runVoyageAccruals {
...Imosfunctions_RunVoyageAccrualsResponseFragment
}
runVoyagePeriodJournals {
...Imosfunctions_RunVoyagePeriodJournalsResponseFragment
}
}
}
Response
{
"data": {
"financials_functions": {
"postMonthlyAccrualBill": Imosfunctions_PostMonthlyAccrualBillResponse,
"postVoyagePeriodBill": Imosfunctions_PostVoyagePeriodBillResponse,
"runVoyageAccruals": Imosfunctions_RunVoyageAccrualsResponse,
"runVoyagePeriodJournals": Imosfunctions_RunVoyagePeriodJournalsResponse
}
}
}
form
Response
Returns a FormRootMutation
Example
Query
mutation Form {
form {
publish {
...ConnectFormFragment
}
tagForm {
...ConnectFormFragment
}
untagForm {
...ConnectFormFragment
}
apply {
...ConnectFormFragment
}
reject {
...ConnectFormFragment
}
fail {
...ConnectFormFragment
}
reset {
...ConnectFormFragment
}
deleteDraft
ensureTag {
...ConnectTagFragment
}
}
}
Response
{
"data": {
"form": {
"publish": ConnectForm,
"tagForm": ConnectForm,
"untagForm": ConnectForm,
"apply": ConnectForm,
"reject": ConnectForm,
"fail": ConnectForm,
"reset": ConnectForm,
"deleteDraft": true,
"ensureTag": ConnectTag
}
}
}
imos
Response
Returns an ImosRootMutation
Example
Query
mutation Imos {
imos {
applyUpdateBareboat {
...ApplyUpdateBareboat_resultFragment
}
applyNominateCargo {
...ApplyNominateCargo_resultFragment
}
applyUpdateCargo {
...ApplyUpdateCargo_resultFragment
}
applyAddVoyageCargo {
...ApplyAddVoyageCargo_resultFragment
}
applyUpdateChartOfAccounts {
...ApplyUpdateChartOfAccounts_resultFragment
}
applyCreateLaytimeClaim {
...ApplyCreateLaytimeClaim_resultFragment
}
applyEditLaytimeClaim {
...ApplyEditLaytimeClaim_resultFragment
}
applyGetLaytimePDFReports {
...ApplyGetLaytimePDFReports_resultFragment
}
applyUpdateCOA {
...ApplyUpdateCOA_resultFragment
}
applyDelay {
...ApplyDelay_resultFragment
}
applyPublishInvoice {
...ApplyPublishInvoice_resultFragment
}
applyPortExpenses {
...ApplyPortExpenses_resultFragment
}
applyGetInvoiceReportPdf {
...ApplyGetInvoiceReportPdf_resultFragment
}
applyDeleteInvoice {
...ApplyDeleteInvoice_resultFragment
}
applyRegionTableUpdate {
...ApplyRegionTableUpdate_resultFragment
}
applyUpdateTimeCharterCOA {
...ApplyUpdateTimeCharterCOA_resultFragment
}
applyUpdateEquipmentContract {
...ApplyUpdateEquipmentContract_resultFragment
}
applyUpdateTimeCharter {
...ApplyUpdateTimeCharter_resultFragment
}
applyUpdateEquipment {
...ApplyUpdateEquipment_resultFragment
}
applySCCVoyageEmissions {
...ApplySCCVoyageEmissions_resultFragment
}
applyPublishVoyageUpdate {
...ApplyPublishVoyageUpdate_resultFragment
}
applyScheduleVoyage {
...ApplyScheduleVoyage_resultFragment
}
applyUpdateVoyage {
...ApplyUpdateVoyage_resultFragment
}
applyPublishActivityReport {
...ApplyPublishActivityReport_resultFragment
}
applyPublishPosition {
...ApplyPublishPosition_resultFragment
}
applyPositionReport {
...ApplyPositionReport_resultFragment
}
applyCopyEstimate {
...ApplyCopyEstimate_resultFragment
}
applyUpdateEstimate {
...ApplyUpdateEstimate_resultFragment
}
applyCargoHandlingList {
...ApplyCargoHandlingList_resultFragment
}
applyEtaEtd {
...ApplyEtaEtd_resultFragment
}
applyPortActivityList {
...ApplyPortActivityList_resultFragment
}
applyUpcomingPortsList {
...ApplyUpcomingPortsList_resultFragment
}
applyVeslinkForm {
...ApplyVeslinkForm_resultFragment
}
applyUpdateActivityLog {
...ApplyUpdateActivityLog_resultFragment
}
applyUpdateFreightMatrixQuote {
...ApplyUpdateFreightMatrixQuote_resultFragment
}
applyCalculateVesselValuation {
...ApplyCalculateVesselValuation_resultFragment
}
applyCargo {
...ApplyCargoResultFragment
}
applyNomination {
...ApplyNominationResultFragment
}
applyInvoice {
...ApplyInvoiceResultFragment
}
}
}
Response
{
"data": {
"imos": {
"applyUpdateBareboat": ApplyUpdateBareboat_result,
"applyNominateCargo": ApplyNominateCargo_result,
"applyUpdateCargo": ApplyUpdateCargo_result,
"applyAddVoyageCargo": ApplyAddVoyageCargo_result,
"applyUpdateChartOfAccounts": ApplyUpdateChartOfAccounts_result,
"applyCreateLaytimeClaim": ApplyCreateLaytimeClaim_result,
"applyEditLaytimeClaim": ApplyEditLaytimeClaim_result,
"applyGetLaytimePDFReports": ApplyGetLaytimePDFReports_result,
"applyUpdateCOA": ApplyUpdateCOA_result,
"applyDelay": ApplyDelay_result,
"applyPublishInvoice": ApplyPublishInvoice_result,
"applyPortExpenses": ApplyPortExpenses_result,
"applyGetInvoiceReportPdf": ApplyGetInvoiceReportPdf_result,
"applyDeleteInvoice": ApplyDeleteInvoice_result,
"applyRegionTableUpdate": ApplyRegionTableUpdate_result,
"applyUpdateTimeCharterCOA": ApplyUpdateTimeCharterCOA_result,
"applyUpdateEquipmentContract": ApplyUpdateEquipmentContract_result,
"applyUpdateTimeCharter": ApplyUpdateTimeCharter_result,
"applyUpdateEquipment": ApplyUpdateEquipment_result,
"applySCCVoyageEmissions": ApplySCCVoyageEmissions_result,
"applyPublishVoyageUpdate": ApplyPublishVoyageUpdate_result,
"applyScheduleVoyage": ApplyScheduleVoyage_result,
"applyUpdateVoyage": ApplyUpdateVoyage_result,
"applyPublishActivityReport": ApplyPublishActivityReport_result,
"applyPublishPosition": ApplyPublishPosition_result,
"applyPositionReport": ApplyPositionReport_result,
"applyCopyEstimate": ApplyCopyEstimate_result,
"applyUpdateEstimate": ApplyUpdateEstimate_result,
"applyCargoHandlingList": ApplyCargoHandlingList_result,
"applyEtaEtd": ApplyEtaEtd_result,
"applyPortActivityList": ApplyPortActivityList_result,
"applyUpcomingPortsList": ApplyUpcomingPortsList_result,
"applyVeslinkForm": ApplyVeslinkForm_result,
"applyUpdateActivityLog": ApplyUpdateActivityLog_result,
"applyUpdateFreightMatrixQuote": ApplyUpdateFreightMatrixQuote_result,
"applyCalculateVesselValuation": ApplyCalculateVesselValuation_result,
"applyCargo": ApplyCargoResult,
"applyNomination": ApplyNominationResult,
"applyInvoice": ApplyInvoiceResult
}
}
}
imosapp
Response
Returns an ImosappRootMutation
Example
Query
mutation Imosapp {
imosapp {
updateConfigFlag
setUserPref
deleteUserPref
exec {
...ExecResponseFragment
}
importXml {
...ImportXmlResponseFragment
}
dataFormUpdate
formOperation
}
}
Response
{
"data": {
"imosapp": {
"updateConfigFlag": true,
"setUserPref": false,
"deleteUserPref": false,
"exec": ExecResponse,
"importXml": ImportXmlResponse,
"dataFormUpdate": Json,
"formOperation": false
}
}
}
message
Response
Returns a MessageRootMutation
Example
Query
mutation Message {
message {
apply {
...MessageApplyResponseFragment
}
publish {
...MessageRecordFragment
}
publishById {
...MessageRecordFragment
}
approve {
...MessageRecordFragment
}
approveWithResolution {
...MessageRecordFragment
}
reject {
...MessageRecordFragment
}
setAutoApprovalSettings
publishMessageEdits {
...MessageRecordFragment
}
}
}
Response
{
"data": {
"message": {
"apply": MessageApplyResponse,
"publish": MessageRecord,
"publishById": MessageRecord,
"approve": MessageRecord,
"approveWithResolution": MessageRecord,
"reject": MessageRecord,
"setAutoApprovalSettings": true,
"publishMessageEdits": MessageRecord
}
}
}
operations_functions
Response
Returns an Operations_functionsRootMutation
Example
Query
mutation Operations_functions {
operations_functions {
addBunkerRequirementInquiry {
...Imosfunctions_AddBunkerRequirementInquiryResponseFragment
}
bunkerRequirementConfirm {
...Imosfunctions_BunkerRequirementConfirmResponseFragment
}
bunkerRequirementNominate {
...Imosfunctions_BunkerRequirementNominateResponseFragment
}
claimDelete {
...Imosfunctions_ClaimDeleteResponseFragment
}
claimQuoteUpdate {
...Imosfunctions_ClaimQuoteUpdateResponseFragment
}
claimRemovePortCalls {
...Imosfunctions_ClaimRemovePortCallsResponseFragment
}
createLaytimeClaim {
...Imosfunctions_CreateLaytimeClaimResponseFragment
}
deleteBunkerRequirement {
...Imosfunctions_DeleteBunkerRequirementResponseFragment
}
deleteVoyage {
...Imosfunctions_DeleteVoyageResponseFragment
}
editLaytimeClaim {
...Imosfunctions_EditLaytimeClaimResponseFragment
}
sCCVoyageEmissions {
...Imosfunctions_SCCVoyageEmissionsResponseFragment
}
updateBerthActivities {
...Imosfunctions_UpdateBerthActivitiesResponseFragment
}
updateBunkerRequirement {
...Imosfunctions_UpdateBunkerRequirementResponseFragment
}
updateEquipmentContract {
...Imosfunctions_UpdateEquipmentContractResponseFragment
}
}
}
Response
{
"data": {
"operations_functions": {
"addBunkerRequirementInquiry": Imosfunctions_AddBunkerRequirementInquiryResponse,
"bunkerRequirementConfirm": Imosfunctions_BunkerRequirementConfirmResponse,
"bunkerRequirementNominate": Imosfunctions_BunkerRequirementNominateResponse,
"claimDelete": Imosfunctions_ClaimDeleteResponse,
"claimQuoteUpdate": Imosfunctions_ClaimQuoteUpdateResponse,
"claimRemovePortCalls": Imosfunctions_ClaimRemovePortCallsResponse,
"createLaytimeClaim": Imosfunctions_CreateLaytimeClaimResponse,
"deleteBunkerRequirement": Imosfunctions_DeleteBunkerRequirementResponse,
"deleteVoyage": Imosfunctions_DeleteVoyageResponse,
"editLaytimeClaim": Imosfunctions_EditLaytimeClaimResponse,
"sCCVoyageEmissions": Imosfunctions_SCCVoyageEmissionsResponse,
"updateBerthActivities": Imosfunctions_UpdateBerthActivitiesResponse,
"updateBunkerRequirement": Imosfunctions_UpdateBunkerRequirementResponse,
"updateEquipmentContract": Imosfunctions_UpdateEquipmentContractResponse
}
}
}
trading_functions
Response
Returns a Trading_functionsRootMutation
Example
Query
mutation Trading_functions {
trading_functions {
applyUpdatePaperTrade {
...Imosfunctions_ApplyUpdatePaperTradeResponseFragment
}
compareTradingPnlSnapshots {
...Imosfunctions_CompareTradingPnlSnapshotsResponseFragment
}
deletePaperTrade {
...Imosfunctions_DeletePaperTradeResponseFragment
}
}
}
Response
{
"data": {
"trading_functions": {
"applyUpdatePaperTrade": Imosfunctions_ApplyUpdatePaperTradeResponse,
"compareTradingPnlSnapshots": Imosfunctions_CompareTradingPnlSnapshotsResponse,
"deletePaperTrade": Imosfunctions_DeletePaperTradeResponse
}
}
}
vessel
Response
Returns a VesselRootMutation
Example
Query
mutation Vessel {
vessel {
updateFleetMembers
}
}
Response
{"data": {"vessel": {"updateFleetMembers": true}}}
views
Response
Returns a ViewsRootMutation
Example
Query
mutation Views {
views {
clearCurrentViewHistory
deleteView
clearView {
...ViewFragment
}
updateView {
...ViewFragment
}
createView {
...ViewFragment
}
makeViewPublic {
...ViewFragment
}
setCurrentView {
...ViewFragment
}
}
}
Response
{
"data": {
"views": {
"clearCurrentViewHistory": ["xyz789"],
"deleteView": false,
"clearView": View,
"updateView": View,
"createView": View,
"makeViewPublic": View,
"setCurrentView": View
}
}
}
Types
AccountAnalysis
Fields
| Field Name | Description |
|---|---|
amountBase - Float
|
|
amountCurr - Float
|
|
transNo - String
|
|
openingBalanceDate - Date
|
|
openingBalanceAccountCategory - String
|
|
reversalDate - Date
|
|
originalTransactionDate - Date
|
|
isReversedInPeriod - Boolean
|
|
isReversedAfterPayment - Boolean
|
|
billSubcode - String
|
|
rootTableSqlId - Int
|
|
companyCode - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
departmentName - String
|
|
lobCode - String
|
|
portName - String
|
|
seq - String
|
|
accountCode - String
|
|
counterAccountCode - String
|
|
accountingDate - Date
|
|
invoiceDate - Date
|
|
accountingSource - Int
|
|
accountingType - String
|
|
invoiceTransNo - String
|
|
paymentTransNo - String
|
|
description - String
|
|
vendorCompanyNo - Int
|
|
vendorFullName - String
|
|
vendorType - String
|
|
status - String
|
|
currencyCode - String
|
|
ledgerSign - Int
|
|
amountCurrInternal - Float
|
|
amountBaseInternal - Float
|
|
bankAmountCurr - Float
|
|
rate - Float
|
|
quantity - Float
|
|
aparAccountCode - String
|
|
taxCode - String
|
|
taxRate - Float
|
|
source - String
|
|
subCode - String
|
|
billCode - String
|
|
lastUpdateGmt - Date
|
|
baseTableLastUpdateGmt - Date
|
|
payment - Payment
|
|
invoice - FinancialsInvoice
|
|
counterparty - AddressBook
|
|
aparAccount - ChartOfAccounts
|
|
chartOfAccounts - ChartOfAccounts
|
|
account - ChartOfAccounts
|
|
vessel - Vessel
|
|
company - Company
|
|
voyage - Voyage
|
|
financialsInvoiceDetail - FinancialsInvoiceDetail
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"amountBase": 123.45,
"amountCurr": 123.45,
"transNo": "xyz789",
"openingBalanceDate": "2007-12-03",
"openingBalanceAccountCategory": "xyz789",
"reversalDate": "2007-12-03",
"originalTransactionDate": "2007-12-03",
"isReversedInPeriod": true,
"isReversedAfterPayment": true,
"billSubcode": "abc123",
"rootTableSqlId": 987,
"companyCode": "abc123",
"vesselCode": "xyz789",
"voyageNo": 123,
"departmentName": "abc123",
"lobCode": "abc123",
"portName": "abc123",
"seq": "xyz789",
"accountCode": "abc123",
"counterAccountCode": "abc123",
"accountingDate": "2007-12-03",
"invoiceDate": "2007-12-03",
"accountingSource": 123,
"accountingType": "abc123",
"invoiceTransNo": "xyz789",
"paymentTransNo": "abc123",
"description": "abc123",
"vendorCompanyNo": 123,
"vendorFullName": "abc123",
"vendorType": "abc123",
"status": "abc123",
"currencyCode": "abc123",
"ledgerSign": 987,
"amountCurrInternal": 123.45,
"amountBaseInternal": 987.65,
"bankAmountCurr": 123.45,
"rate": 987.65,
"quantity": 987.65,
"aparAccountCode": "xyz789",
"taxCode": "xyz789",
"taxRate": 987.65,
"source": "abc123",
"subCode": "abc123",
"billCode": "abc123",
"lastUpdateGmt": "2007-12-03",
"baseTableLastUpdateGmt": "2007-12-03",
"payment": Payment,
"invoice": FinancialsInvoice,
"counterparty": AddressBook,
"aparAccount": ChartOfAccounts,
"chartOfAccounts": ChartOfAccounts,
"account": ChartOfAccounts,
"vessel": Vessel,
"company": Company,
"voyage": Voyage,
"financialsInvoiceDetail": FinancialsInvoiceDetail,
"_id": "xyz789",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
AccountAnalysisAccountingTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
AccountAnalysisAccountingTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - AccountAnalysisAccountingTypeEnum
|
|
isNot - AccountAnalysisAccountingTypeEnum
|
|
isIn - [AccountAnalysisAccountingTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
AccountAnalysisFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AccountAnalysisFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AccountAnalysisFormQueryWhere
}
AccountAnalysisFormQueryWhere
Fields
Example
{
"and": [AccountAnalysisFormQueryWhere],
"or": [AccountAnalysisFormQueryWhere],
"rawExpression": "xyz789",
"transNo": StringWhereValueExpression,
"rootTableSqlId": NumberWhereValueExpression,
"companyCode": StringWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"departmentName": StringWhereValueExpression,
"lobCode": StringWhereValueExpression,
"portName": StringWhereValueExpression,
"seq": StringWhereValueExpression,
"accountCode": StringWhereValueExpression,
"counterAccountCode": StringWhereValueExpression,
"accountingDate": DateWhereValueExpression,
"invoiceDate": DateWhereValueExpression,
"accountingSource": NumberWhereValueExpression,
"accountingType": AccountAnalysisAccountingTypeEnumValueExpression,
"invoiceTransNo": StringWhereValueExpression,
"paymentTransNo": StringWhereValueExpression,
"description": StringWhereValueExpression,
"vendorCompanyNo": NumberWhereValueExpression,
"vendorFullName": StringWhereValueExpression,
"vendorType": StringWhereValueExpression,
"status": StringWhereValueExpression,
"currencyCode": StringWhereValueExpression,
"ledgerSign": NumberWhereValueExpression,
"amountCurrInternal": NumberWhereValueExpression,
"amountBaseInternal": NumberWhereValueExpression,
"bankAmountCurr": NumberWhereValueExpression,
"rate": NumberWhereValueExpression,
"quantity": NumberWhereValueExpression,
"aparAccountCode": StringWhereValueExpression,
"taxCode": StringWhereValueExpression,
"taxRate": NumberWhereValueExpression,
"source": AccountAnalysisSourceEnumValueExpression,
"subCode": StringWhereValueExpression,
"billCode": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"baseTableLastUpdateGmt": DateWhereValueExpression,
"payment": PaymentFormQueryWhere,
"invoice": FinancialsInvoiceFormQueryWhere,
"counterparty": AddressBookFormQueryWhere,
"aparAccount": ChartOfAccountsFormQueryWhere,
"chartOfAccounts": ChartOfAccountsFormQueryWhere,
"account": ChartOfAccountsFormQueryWhere,
"vessel": VesselFormQueryWhere,
"company": CompanyFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"financialsInvoiceDetail": FinancialsInvoiceDetailFormQueryWhere
}
AccountAnalysisRelationships
Fields
| Field Name | Description |
|---|---|
payment - RelationshipDefinition
|
|
invoice - RelationshipDefinition
|
|
counterparty - RelationshipDefinition
|
|
aparAccount - RelationshipDefinition
|
|
chartOfAccounts - RelationshipDefinition
|
|
account - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
company - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
financialsInvoiceDetail - RelationshipDefinition
|
|
chartOfAccountsApAr - RelationshipDefinition
|
Example
{
"payment": RelationshipDefinition,
"invoice": RelationshipDefinition,
"counterparty": RelationshipDefinition,
"aparAccount": RelationshipDefinition,
"chartOfAccounts": RelationshipDefinition,
"account": RelationshipDefinition,
"vessel": RelationshipDefinition,
"company": RelationshipDefinition,
"voyage": RelationshipDefinition,
"financialsInvoiceDetail": RelationshipDefinition,
"chartOfAccountsApAr": RelationshipDefinition
}
AccountAnalysisSourceEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
AccountAnalysisSourceEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - AccountAnalysisSourceEnum
|
|
isNot - AccountAnalysisSourceEnum
|
|
isIn - [AccountAnalysisSourceEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
AccountingInterfaceSummary
Fields
| Field Name | Description |
|---|---|
interfaceType - String
|
|
transID - String
|
|
transNo - String
|
|
invoiceNo - String
|
|
vesselName - String
|
|
voyageVesselCode - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
transStatusDescription - String
|
|
transTypeDisplay - String
|
|
transDescription - String
|
|
companyNo - Int
|
|
oprCoordinator - String
|
|
errorNo - String
|
|
errorDescription - String
|
|
billSource - String
|
|
billMemo - String
|
|
billDescription - String
|
|
billCounterpartyShortName - String
|
|
billCurr - String
|
|
billAmountCurr - Float
|
|
billAmountBase - Float
|
|
contractID - String
|
|
userLastUpdate - String
|
|
timeLastUpdate - Date
|
|
sourceTimestamp - Date
|
|
vessel - Vessel
|
|
voyage - Voyage
|
|
financialsInvoice - FinancialsInvoice
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"interfaceType": "abc123",
"transID": "abc123",
"transNo": "xyz789",
"invoiceNo": "abc123",
"vesselName": "abc123",
"voyageVesselCode": "xyz789",
"vesselCode": "abc123",
"voyageNo": 123,
"transStatusDescription": "abc123",
"transTypeDisplay": "abc123",
"transDescription": "xyz789",
"companyNo": 123,
"oprCoordinator": "abc123",
"errorNo": "xyz789",
"errorDescription": "abc123",
"billSource": "xyz789",
"billMemo": "xyz789",
"billDescription": "abc123",
"billCounterpartyShortName": "abc123",
"billCurr": "xyz789",
"billAmountCurr": 987.65,
"billAmountBase": 123.45,
"contractID": "xyz789",
"userLastUpdate": "xyz789",
"timeLastUpdate": "2007-12-03",
"sourceTimestamp": "2007-12-03",
"vessel": Vessel,
"voyage": Voyage,
"financialsInvoice": FinancialsInvoice,
"_id": "abc123",
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
AccountingInterfaceSummaryFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AccountingInterfaceSummaryFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AccountingInterfaceSummaryFormQueryWhere
}
AccountingInterfaceSummaryFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [AccountingInterfaceSummaryFormQueryWhere!]
|
|
or - [AccountingInterfaceSummaryFormQueryWhere!]
|
|
rawExpression - String
|
|
vessel - VesselFormQueryWhere
|
|
voyage - VoyageFormQueryWhere
|
|
financialsInvoice - FinancialsInvoiceFormQueryWhere
|
Example
{
"and": [AccountingInterfaceSummaryFormQueryWhere],
"or": [AccountingInterfaceSummaryFormQueryWhere],
"rawExpression": "abc123",
"vessel": VesselFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"financialsInvoice": FinancialsInvoiceFormQueryWhere
}
AccountingInterfaceSummaryRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
financialsInvoice - RelationshipDefinition
|
Example
{
"vessel": RelationshipDefinition,
"voyage": RelationshipDefinition,
"financialsInvoice": RelationshipDefinition
}
ActDepartment
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
code - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
name - String
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"code": "xyz789",
"customFieldByID": Any,
"customField": Any,
"name": "xyz789",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
ActDepartmentFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ActDepartmentFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ActDepartmentFormQueryWhere
}
ActDepartmentFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [ActDepartmentFormQueryWhere!]
|
|
or - [ActDepartmentFormQueryWhere!]
|
|
rawExpression - String
|
|
code - StringWhereValueExpression
|
|
name - StringWhereValueExpression
|
Example
{
"and": [ActDepartmentFormQueryWhere],
"or": [ActDepartmentFormQueryWhere],
"rawExpression": "abc123",
"code": StringWhereValueExpression,
"name": StringWhereValueExpression
}
ActivityReportBunkerDetail
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
reliq - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
gcuSteam - Float
|
|
meterAdj - Float
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
itinerarySeq - Int
|
|
reportDateGmt - Date
|
|
seq - Int
|
|
fuelType - String
|
|
fuelRob - Float
|
|
fuelReceived - Float
|
|
mainEng - Float
|
|
auxEng - Float
|
|
adjustment - Float
|
|
propulsion - Float
|
|
loadOrDisch - Float
|
|
heat - Float
|
|
clean - Float
|
|
deballast - Float
|
|
maneuver - Float
|
|
others - Float
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
igs - Float
|
|
generator - Float
|
|
lastUserID - String
|
|
isEstimatedRob - Boolean
|
|
isEstimatedRecQty - Boolean
|
|
idleorOn - Float
|
|
idleorOff - Float
|
|
heatPlus - Float
|
|
cooling - Float
|
|
coolingPlus - Float
|
|
heatPlusPlus - Float
|
|
sulfurContentPct_0 - Float
|
|
sulfurContentRob_0 - Float
|
|
sulfurContentPct_1 - Float
|
|
sulfurContentRob_1 - Float
|
|
sulfurContentPct_2 - Float
|
|
sulfurContentRob_2 - Float
|
|
badWeatherConsumption - Float
|
|
boiler - Float
|
|
incinerator - Float
|
|
loadConsumption - Float
|
|
dischargeConsumption - Float
|
|
pilotFlame - Float
|
|
vOC - Float
|
|
fuel - FuelLubeType
|
|
voyageActivityReport - VoyageActivityReport
|
|
vessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"reliq": 987.65,
"customFieldByID": Any,
"customField": Any,
"gcuSteam": 987.65,
"meterAdj": 987.65,
"vesselCode": "abc123",
"voyageNo": 987,
"itinerarySeq": 987,
"reportDateGmt": "2007-12-03",
"seq": 987,
"fuelType": "abc123",
"fuelRob": 123.45,
"fuelReceived": 987.65,
"mainEng": 987.65,
"auxEng": 123.45,
"adjustment": 987.65,
"propulsion": 987.65,
"loadOrDisch": 987.65,
"heat": 123.45,
"clean": 123.45,
"deballast": 987.65,
"maneuver": 987.65,
"others": 987.65,
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"igs": 987.65,
"generator": 123.45,
"lastUserID": "xyz789",
"isEstimatedRob": false,
"isEstimatedRecQty": true,
"idleorOn": 987.65,
"idleorOff": 987.65,
"heatPlus": 987.65,
"cooling": 987.65,
"coolingPlus": 123.45,
"heatPlusPlus": 123.45,
"sulfurContentPct_0": 123.45,
"sulfurContentRob_0": 987.65,
"sulfurContentPct_1": 123.45,
"sulfurContentRob_1": 987.65,
"sulfurContentPct_2": 123.45,
"sulfurContentRob_2": 987.65,
"badWeatherConsumption": 987.65,
"boiler": 987.65,
"incinerator": 987.65,
"loadConsumption": 123.45,
"dischargeConsumption": 123.45,
"pilotFlame": 123.45,
"vOC": 123.45,
"fuel": FuelLubeType,
"voyageActivityReport": VoyageActivityReport,
"vessel": Vessel,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
ActivityReportBunkerDetailFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ActivityReportBunkerDetailFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ActivityReportBunkerDetailFormQueryWhere
}
ActivityReportBunkerDetailFormQueryWhere
Fields
Example
{
"and": [ActivityReportBunkerDetailFormQueryWhere],
"or": [ActivityReportBunkerDetailFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"itinerarySeq": NumberWhereValueExpression,
"reportDateGmt": DateWhereValueExpression,
"seq": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"fuelRob": NumberWhereValueExpression,
"fuelReceived": NumberWhereValueExpression,
"mainEng": NumberWhereValueExpression,
"auxEng": NumberWhereValueExpression,
"adjustment": NumberWhereValueExpression,
"propulsion": NumberWhereValueExpression,
"loadOrDisch": NumberWhereValueExpression,
"heat": NumberWhereValueExpression,
"clean": NumberWhereValueExpression,
"deballast": NumberWhereValueExpression,
"maneuver": NumberWhereValueExpression,
"others": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"igs": NumberWhereValueExpression,
"generator": NumberWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"isEstimatedRob": BoolWhereValueExpression,
"isEstimatedRecQty": BoolWhereValueExpression,
"idleorOn": NumberWhereValueExpression,
"idleorOff": NumberWhereValueExpression,
"heatPlus": NumberWhereValueExpression,
"cooling": NumberWhereValueExpression,
"coolingPlus": NumberWhereValueExpression,
"heatPlusPlus": NumberWhereValueExpression,
"sulfurContentPct_0": NumberWhereValueExpression,
"sulfurContentRob_0": NumberWhereValueExpression,
"sulfurContentPct_1": NumberWhereValueExpression,
"sulfurContentRob_1": NumberWhereValueExpression,
"sulfurContentPct_2": NumberWhereValueExpression,
"sulfurContentRob_2": NumberWhereValueExpression,
"badWeatherConsumption": NumberWhereValueExpression,
"boiler": NumberWhereValueExpression,
"incinerator": NumberWhereValueExpression,
"loadConsumption": NumberWhereValueExpression,
"dischargeConsumption": NumberWhereValueExpression,
"pilotFlame": NumberWhereValueExpression,
"vOC": NumberWhereValueExpression,
"fuel": FuelLubeTypeFormQueryWhere,
"voyageActivityReport": VoyageActivityReportFormQueryWhere,
"vessel": VesselFormQueryWhere
}
ActivityReportBunkerDetailRelationships
Fields
| Field Name | Description |
|---|---|
fuel - RelationshipDefinition
|
|
voyageActivityReport - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
Example
{
"fuel": RelationshipDefinition,
"voyageActivityReport": RelationshipDefinition,
"vessel": RelationshipDefinition
}
AddVoyageCargoInput
Description
This message schedules a cargo on a voyage
Fields
| Input Field | Description |
|---|---|
voyageNo - Int
|
|
cargoExternalRef - String
|
|
vesselCode - String
|
|
voyageCargoHandling - AddVoyageCargo_VoyageCargoHandlingInput
|
Example
{
"voyageNo": 123,
"cargoExternalRef": "xyz789",
"vesselCode": "xyz789",
"voyageCargoHandling": AddVoyageCargo_VoyageCargoHandlingInput
}
AddVoyageCargoMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": false,
"context": ["abc123"],
"timestamp": "xyz789",
"originalTimestamp": "abc123",
"intent": "abc123",
"from": "xyz789",
"to": ["xyz789"],
"fromUser": "abc123",
"status": "abc123",
"approvalStatus": "abc123",
"objectId": "xyz789",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "abc123",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "abc123",
"unmapped": true,
"responseData": Json,
"applyErrors": ["abc123"],
"applyWarnings": ["abc123"],
"parentMessageId": "abc123",
"preResolutionObjectId": "xyz789",
"title": "abc123",
"effectiveDate": "abc123",
"source": "abc123",
"sourceId": "xyz789",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["abc123"],
"isLatest": true,
"threadCount": 987,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
AddVoyageCargo_VoyageCargoHandlingInput
AddressBook
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
countryCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
vATNo - String
|
|
typeDescr - String
|
|
inactive - Boolean
|
|
fullAddress - String
|
|
lastTransactionDate - Date
|
|
emailDomain - String
|
|
sqlID - Int
|
|
type - String
|
|
shortName - String
|
|
fullName - String
|
|
address1 - String
|
|
address2 - String
|
|
address3 - String
|
|
address4 - String
|
|
country - String
|
|
sDN - String
|
|
phone - String
|
|
faxSpd - String
|
|
fax - String
|
|
telex - String
|
|
webPage - String
|
|
crossRefNo - String
|
|
mainContact - String
|
|
curr - String
|
|
creditTerm - Int
|
|
creditLine - Float
|
|
lastUpdateGmt - Date
|
|
companyNo - Int
|
|
legacyInactive - String
|
|
lastUserID - String
|
|
parentCompanyNo - Int
|
|
email - String
|
|
refNo - String
|
|
veslinkID - String
|
|
veslinkCompanyType - String
|
|
paymentTermsCode - String
|
|
aPAccount - String
|
|
aRAccount - String
|
|
internal - Boolean
|
|
internalAddress - Boolean
|
|
marginingPaper - Boolean
|
|
marginingPhysical - Boolean
|
|
nettingPaper - Boolean
|
|
nettingPhysical - Boolean
|
|
preferred - Boolean
|
|
taxCodeRequired - Boolean
|
|
rejectAllVessles - Boolean
|
|
prohibitedParty - Boolean
|
|
ratingDate - Date
|
|
creditRating - String
|
|
demTBDays - Float
|
|
entryDateGmt - Date
|
|
updateTimes - Int
|
|
paymentCompanyNo - Int
|
|
alerts - String
|
|
iCAccount - String
|
|
lobCode - String
|
|
contractSubStatus - String
|
|
actDeptCode - String
|
|
referenceCode - String
|
|
defaultAccount - String
|
|
imoNumber - String
|
|
transshipmentDate - Date
|
|
prohibitedPartyDate - Date
|
|
pOInspDate - Date
|
|
actDepartment - ActDepartment
|
|
addressType - AddressType
|
|
iCCoAData - ChartOfAccounts
|
|
countryData - Country
|
|
parentCompanyData - AddressBook
|
|
paymentCompanyData - AddressBook
|
|
addressBookRemarks - [AddressBookRemark]
|
|
addressBookExpenses - [AddressBookExpense]
|
|
addressBookAgentPorts - [AddressBookAgentPort]
|
|
addressBookContacts - [AddressBookContact]
|
|
addressBookRegistryAccounts - [AddressBookRegistryAccount]
|
|
addressBookBanks - [AddressBookBank]
|
|
operationsInvoice - [OperationsInvoice]
|
|
userDefinedFields - Json
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"countryCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"vATNo": "xyz789",
"typeDescr": "xyz789",
"inactive": false,
"fullAddress": "xyz789",
"lastTransactionDate": "2007-12-03",
"emailDomain": "xyz789",
"sqlID": 123,
"type": "xyz789",
"shortName": "abc123",
"fullName": "xyz789",
"address1": "xyz789",
"address2": "abc123",
"address3": "abc123",
"address4": "abc123",
"country": "abc123",
"sDN": "abc123",
"phone": "abc123",
"faxSpd": "abc123",
"fax": "xyz789",
"telex": "xyz789",
"webPage": "xyz789",
"crossRefNo": "xyz789",
"mainContact": "xyz789",
"curr": "abc123",
"creditTerm": 123,
"creditLine": 987.65,
"lastUpdateGmt": "2007-12-03",
"companyNo": 987,
"legacyInactive": "xyz789",
"lastUserID": "xyz789",
"parentCompanyNo": 123,
"email": "xyz789",
"refNo": "xyz789",
"veslinkID": "xyz789",
"veslinkCompanyType": "abc123",
"paymentTermsCode": "abc123",
"aPAccount": "abc123",
"aRAccount": "abc123",
"internal": true,
"internalAddress": false,
"marginingPaper": true,
"marginingPhysical": false,
"nettingPaper": true,
"nettingPhysical": true,
"preferred": true,
"taxCodeRequired": true,
"rejectAllVessles": false,
"prohibitedParty": false,
"ratingDate": "2007-12-03",
"creditRating": "abc123",
"demTBDays": 987.65,
"entryDateGmt": "2007-12-03",
"updateTimes": 987,
"paymentCompanyNo": 987,
"alerts": "abc123",
"iCAccount": "abc123",
"lobCode": "abc123",
"contractSubStatus": "xyz789",
"actDeptCode": "abc123",
"referenceCode": "abc123",
"defaultAccount": "abc123",
"imoNumber": "abc123",
"transshipmentDate": "2007-12-03",
"prohibitedPartyDate": "2007-12-03",
"pOInspDate": "2007-12-03",
"actDepartment": ActDepartment,
"addressType": AddressType,
"iCCoAData": ChartOfAccounts,
"countryData": Country,
"parentCompanyData": AddressBook,
"paymentCompanyData": AddressBook,
"addressBookRemarks": [AddressBookRemark],
"addressBookExpenses": [AddressBookExpense],
"addressBookAgentPorts": [AddressBookAgentPort],
"addressBookContacts": [AddressBookContact],
"addressBookRegistryAccounts": [
AddressBookRegistryAccount
],
"addressBookBanks": [AddressBookBank],
"operationsInvoice": [OperationsInvoice],
"userDefinedFields": Json,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
AddressBookAgentPort
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
type - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
shortName - String
|
|
portName - String
|
|
portNo - Int
|
|
remarks - String
|
|
addressBook - AddressBook
|
|
port - Port
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"type": "abc123",
"customFieldByID": Any,
"customField": Any,
"shortName": "abc123",
"portName": "abc123",
"portNo": 123,
"remarks": "xyz789",
"addressBook": AddressBook,
"port": Port,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
AddressBookAgentPortFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AddressBookAgentPortFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AddressBookAgentPortFormQueryWhere
}
AddressBookAgentPortFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [AddressBookAgentPortFormQueryWhere!]
|
|
or - [AddressBookAgentPortFormQueryWhere!]
|
|
rawExpression - String
|
|
type - StringWhereValueExpression
|
|
shortName - StringWhereValueExpression
|
|
portName - StringWhereValueExpression
|
|
portNo - NumberWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
addressBook - AddressBookFormQueryWhere
|
|
port - PortFormQueryWhere
|
Example
{
"and": [AddressBookAgentPortFormQueryWhere],
"or": [AddressBookAgentPortFormQueryWhere],
"rawExpression": "xyz789",
"type": StringWhereValueExpression,
"shortName": StringWhereValueExpression,
"portName": StringWhereValueExpression,
"portNo": NumberWhereValueExpression,
"remarks": StringWhereValueExpression,
"addressBook": AddressBookFormQueryWhere,
"port": PortFormQueryWhere
}
AddressBookAgentPortRelationships
Fields
| Field Name | Description |
|---|---|
addressBook - RelationshipDefinition
|
|
port - RelationshipDefinition
|
Example
{
"addressBook": RelationshipDefinition,
"port": RelationshipDefinition
}
AddressBookBank
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
companyNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seqNo - Int
|
|
benCompanyNo - Int
|
|
countryCode - String
|
|
bank - String
|
|
branch - String
|
|
address1 - String
|
|
address2 - String
|
|
swiftCode - String
|
|
fullName - String
|
|
acctNo - String
|
|
aBABSBNo - String
|
|
corCompanyNo - Int
|
|
corCountryCode - String
|
|
corBank - String
|
|
corBranch - String
|
|
corAddress1 - String
|
|
corAddress2 - String
|
|
corSwiftCode - String
|
|
iBANNo - String
|
|
corFullName - String
|
|
corAccountNo - String
|
|
corABABSBNo - String
|
|
corIBANNo - String
|
|
inactive - Boolean
|
|
default - Boolean
|
|
restrictPaymentBatch - Boolean
|
|
curr - String
|
|
subcompanyCode - String
|
|
payMethod - Int
|
|
benBankFullAddress1 - String
|
|
benBankFullAddress2 - String
|
|
benBankFullAddress3 - String
|
|
benBankFullAddress4 - String
|
|
benBankFullAddressCountryCode - String
|
|
benBankExternalRef - String
|
|
remittanceInstructions - String
|
|
virtualBankCompanyNo - Int
|
|
addressBook - AddressBook
|
|
chartOfAccounts - ChartOfAccounts
|
|
virtualBankCompany - AddressBook
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"companyNo": 987,
"customFieldByID": Any,
"customField": Any,
"seqNo": 123,
"benCompanyNo": 123,
"countryCode": "xyz789",
"bank": "abc123",
"branch": "xyz789",
"address1": "xyz789",
"address2": "xyz789",
"swiftCode": "abc123",
"fullName": "xyz789",
"acctNo": "xyz789",
"aBABSBNo": "xyz789",
"corCompanyNo": 123,
"corCountryCode": "abc123",
"corBank": "xyz789",
"corBranch": "xyz789",
"corAddress1": "xyz789",
"corAddress2": "abc123",
"corSwiftCode": "abc123",
"iBANNo": "abc123",
"corFullName": "abc123",
"corAccountNo": "xyz789",
"corABABSBNo": "abc123",
"corIBANNo": "abc123",
"inactive": false,
"default": false,
"restrictPaymentBatch": false,
"curr": "xyz789",
"subcompanyCode": "abc123",
"payMethod": 987,
"benBankFullAddress1": "xyz789",
"benBankFullAddress2": "xyz789",
"benBankFullAddress3": "xyz789",
"benBankFullAddress4": "abc123",
"benBankFullAddressCountryCode": "xyz789",
"benBankExternalRef": "abc123",
"remittanceInstructions": "abc123",
"virtualBankCompanyNo": 123,
"addressBook": AddressBook,
"chartOfAccounts": ChartOfAccounts,
"virtualBankCompany": AddressBook,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
AddressBookBankFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AddressBookBankFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AddressBookBankFormQueryWhere
}
AddressBookBankFormQueryWhere
Fields
Example
{
"and": [AddressBookBankFormQueryWhere],
"or": [AddressBookBankFormQueryWhere],
"rawExpression": "xyz789",
"companyNo": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"benCompanyNo": NumberWhereValueExpression,
"countryCode": StringWhereValueExpression,
"bank": StringWhereValueExpression,
"branch": StringWhereValueExpression,
"address1": StringWhereValueExpression,
"address2": StringWhereValueExpression,
"swiftCode": StringWhereValueExpression,
"fullName": StringWhereValueExpression,
"acctNo": StringWhereValueExpression,
"aBABSBNo": StringWhereValueExpression,
"corCompanyNo": NumberWhereValueExpression,
"corCountryCode": StringWhereValueExpression,
"corBank": StringWhereValueExpression,
"corBranch": StringWhereValueExpression,
"corAddress1": StringWhereValueExpression,
"corAddress2": StringWhereValueExpression,
"corSwiftCode": StringWhereValueExpression,
"iBANNo": StringWhereValueExpression,
"corFullName": StringWhereValueExpression,
"corAccountNo": StringWhereValueExpression,
"corABABSBNo": StringWhereValueExpression,
"corIBANNo": StringWhereValueExpression,
"inactive": BoolWhereValueExpression,
"default": BoolWhereValueExpression,
"restrictPaymentBatch": BoolWhereValueExpression,
"curr": StringWhereValueExpression,
"subcompanyCode": StringWhereValueExpression,
"payMethod": NumberWhereValueExpression,
"benBankFullAddress1": StringWhereValueExpression,
"benBankFullAddress2": StringWhereValueExpression,
"benBankFullAddress3": StringWhereValueExpression,
"benBankFullAddress4": StringWhereValueExpression,
"benBankFullAddressCountryCode": StringWhereValueExpression,
"benBankExternalRef": StringWhereValueExpression,
"remittanceInstructions": StringWhereValueExpression,
"virtualBankCompanyNo": NumberWhereValueExpression,
"addressBook": AddressBookFormQueryWhere,
"chartOfAccounts": ChartOfAccountsFormQueryWhere,
"virtualBankCompany": AddressBookFormQueryWhere
}
AddressBookBankRelationships
Fields
| Field Name | Description |
|---|---|
addressBook - RelationshipDefinition
|
|
chartOfAccounts - RelationshipDefinition
|
|
virtualBankCompany - RelationshipDefinition
|
Example
{
"addressBook": RelationshipDefinition,
"chartOfAccounts": RelationshipDefinition,
"virtualBankCompany": RelationshipDefinition
}
AddressBookContact
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
type - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
shortName - String
|
|
seqNo - Int
|
|
lastName - String
|
|
firstName - String
|
|
middleInit - String
|
|
mrMs - String
|
|
contactDepartment - String
|
|
position - String
|
|
directNo - String
|
|
fax - String
|
|
telex - String
|
|
homeNo - String
|
|
mobileNo - String
|
|
pager - String
|
|
remarks - String
|
|
email - String
|
|
speedDialNumber - String
|
|
receivesDocuments - Boolean
|
|
receivesReports - Boolean
|
|
receivesSccEmails - Boolean
|
|
addressBook - AddressBook
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"type": "xyz789",
"customFieldByID": Any,
"customField": Any,
"shortName": "abc123",
"seqNo": 987,
"lastName": "xyz789",
"firstName": "xyz789",
"middleInit": "abc123",
"mrMs": "abc123",
"contactDepartment": "abc123",
"position": "abc123",
"directNo": "xyz789",
"fax": "abc123",
"telex": "abc123",
"homeNo": "xyz789",
"mobileNo": "xyz789",
"pager": "xyz789",
"remarks": "xyz789",
"email": "abc123",
"speedDialNumber": "abc123",
"receivesDocuments": false,
"receivesReports": false,
"receivesSccEmails": false,
"addressBook": AddressBook,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
AddressBookContactFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AddressBookContactFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AddressBookContactFormQueryWhere
}
AddressBookContactFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [AddressBookContactFormQueryWhere!]
|
|
or - [AddressBookContactFormQueryWhere!]
|
|
rawExpression - String
|
|
type - StringWhereValueExpression
|
|
shortName - StringWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
lastName - StringWhereValueExpression
|
|
firstName - StringWhereValueExpression
|
|
middleInit - StringWhereValueExpression
|
|
mrMs - StringWhereValueExpression
|
|
contactDepartment - StringWhereValueExpression
|
|
position - StringWhereValueExpression
|
|
directNo - StringWhereValueExpression
|
|
fax - StringWhereValueExpression
|
|
telex - StringWhereValueExpression
|
|
homeNo - StringWhereValueExpression
|
|
mobileNo - StringWhereValueExpression
|
|
pager - StringWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
email - StringWhereValueExpression
|
|
speedDialNumber - StringWhereValueExpression
|
|
receivesDocuments - BoolWhereValueExpression
|
|
receivesReports - BoolWhereValueExpression
|
|
receivesSccEmails - BoolWhereValueExpression
|
|
addressBook - AddressBookFormQueryWhere
|
Example
{
"and": [AddressBookContactFormQueryWhere],
"or": [AddressBookContactFormQueryWhere],
"rawExpression": "abc123",
"type": StringWhereValueExpression,
"shortName": StringWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"lastName": StringWhereValueExpression,
"firstName": StringWhereValueExpression,
"middleInit": StringWhereValueExpression,
"mrMs": StringWhereValueExpression,
"contactDepartment": StringWhereValueExpression,
"position": StringWhereValueExpression,
"directNo": StringWhereValueExpression,
"fax": StringWhereValueExpression,
"telex": StringWhereValueExpression,
"homeNo": StringWhereValueExpression,
"mobileNo": StringWhereValueExpression,
"pager": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"email": StringWhereValueExpression,
"speedDialNumber": StringWhereValueExpression,
"receivesDocuments": BoolWhereValueExpression,
"receivesReports": BoolWhereValueExpression,
"receivesSccEmails": BoolWhereValueExpression,
"addressBook": AddressBookFormQueryWhere
}
AddressBookContactRelationships
Fields
| Field Name | Description |
|---|---|
addressBook - RelationshipDefinition
|
Example
{"addressBook": RelationshipDefinition}
AddressBookExpense
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
companyNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
ledgerCode - String
|
|
ledgerExpsCode - Int
|
|
ledgerExpsDesc - String
|
|
expenseType - String
|
|
termsClass - String
|
|
addressBook - AddressBook
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"companyNo": 987,
"customFieldByID": Any,
"customField": Any,
"ledgerCode": "abc123",
"ledgerExpsCode": 987,
"ledgerExpsDesc": "abc123",
"expenseType": "abc123",
"termsClass": "abc123",
"addressBook": AddressBook,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
AddressBookExpenseFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AddressBookExpenseFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AddressBookExpenseFormQueryWhere
}
AddressBookExpenseFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [AddressBookExpenseFormQueryWhere!]
|
|
or - [AddressBookExpenseFormQueryWhere!]
|
|
rawExpression - String
|
|
companyNo - NumberWhereValueExpression
|
|
ledgerCode - StringWhereValueExpression
|
|
ledgerExpsCode - NumberWhereValueExpression
|
|
ledgerExpsDesc - StringWhereValueExpression
|
|
expenseType - StringWhereValueExpression
|
|
termsClass - StringWhereValueExpression
|
|
addressBook - AddressBookFormQueryWhere
|
Example
{
"and": [AddressBookExpenseFormQueryWhere],
"or": [AddressBookExpenseFormQueryWhere],
"rawExpression": "xyz789",
"companyNo": NumberWhereValueExpression,
"ledgerCode": StringWhereValueExpression,
"ledgerExpsCode": NumberWhereValueExpression,
"ledgerExpsDesc": StringWhereValueExpression,
"expenseType": StringWhereValueExpression,
"termsClass": StringWhereValueExpression,
"addressBook": AddressBookFormQueryWhere
}
AddressBookExpenseRelationships
Fields
| Field Name | Description |
|---|---|
addressBook - RelationshipDefinition
|
Example
{"addressBook": RelationshipDefinition}
AddressBookFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AddressBookFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AddressBookFormQueryWhere
}
AddressBookFormQueryWhere
Fields
Example
{
"and": [AddressBookFormQueryWhere],
"or": [AddressBookFormQueryWhere],
"rawExpression": "abc123",
"countryCode": StringWhereValueExpression,
"vATNo": StringWhereValueExpression,
"type": StringWhereValueExpression,
"shortName": StringWhereValueExpression,
"fullName": StringWhereValueExpression,
"address1": StringWhereValueExpression,
"address2": StringWhereValueExpression,
"address3": StringWhereValueExpression,
"address4": StringWhereValueExpression,
"country": StringWhereValueExpression,
"sDN": StringWhereValueExpression,
"phone": StringWhereValueExpression,
"faxSpd": StringWhereValueExpression,
"fax": StringWhereValueExpression,
"telex": StringWhereValueExpression,
"webPage": StringWhereValueExpression,
"crossRefNo": StringWhereValueExpression,
"mainContact": StringWhereValueExpression,
"curr": StringWhereValueExpression,
"creditTerm": NumberWhereValueExpression,
"creditLine": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"companyNo": NumberWhereValueExpression,
"legacyInactive": StringWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"parentCompanyNo": NumberWhereValueExpression,
"email": StringWhereValueExpression,
"refNo": StringWhereValueExpression,
"veslinkID": StringWhereValueExpression,
"veslinkCompanyType": AddressBookVeslinkCompanyTypeEnumValueExpression,
"paymentTermsCode": StringWhereValueExpression,
"aPAccount": StringWhereValueExpression,
"aRAccount": StringWhereValueExpression,
"internal": BoolWhereValueExpression,
"internalAddress": BoolWhereValueExpression,
"marginingPaper": BoolWhereValueExpression,
"marginingPhysical": BoolWhereValueExpression,
"nettingPaper": BoolWhereValueExpression,
"nettingPhysical": BoolWhereValueExpression,
"preferred": BoolWhereValueExpression,
"taxCodeRequired": BoolWhereValueExpression,
"rejectAllVessles": BoolWhereValueExpression,
"prohibitedParty": BoolWhereValueExpression,
"ratingDate": DateWhereValueExpression,
"creditRating": StringWhereValueExpression,
"demTBDays": NumberWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"updateTimes": NumberWhereValueExpression,
"paymentCompanyNo": NumberWhereValueExpression,
"alerts": StringWhereValueExpression,
"iCAccount": StringWhereValueExpression,
"lobCode": StringWhereValueExpression,
"contractSubStatus": StringWhereValueExpression,
"actDeptCode": StringWhereValueExpression,
"referenceCode": StringWhereValueExpression,
"defaultAccount": StringWhereValueExpression,
"imoNumber": StringWhereValueExpression,
"transshipmentDate": DateWhereValueExpression,
"prohibitedPartyDate": DateWhereValueExpression,
"pOInspDate": DateWhereValueExpression,
"actDepartment": ActDepartmentFormQueryWhere,
"addressType": AddressTypeFormQueryWhere,
"iCCoAData": ChartOfAccountsFormQueryWhere,
"countryData": CountryFormQueryWhere,
"parentCompanyData": AddressBookFormQueryWhere,
"paymentCompanyData": AddressBookFormQueryWhere
}
AddressBookRegistryAccount
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
companyNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seqNo - Int
|
|
regionCode - String
|
|
countryCode - String
|
|
registryId - String
|
|
accountHolderName - String
|
|
accountName - String
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
addressBook - AddressBook
|
|
country - Country
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"companyNo": 987,
"customFieldByID": Any,
"customField": Any,
"seqNo": 987,
"regionCode": "xyz789",
"countryCode": "abc123",
"registryId": "xyz789",
"accountHolderName": "xyz789",
"accountName": "xyz789",
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123",
"addressBook": AddressBook,
"country": Country,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
AddressBookRegistryAccountFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AddressBookRegistryAccountFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AddressBookRegistryAccountFormQueryWhere
}
AddressBookRegistryAccountFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [AddressBookRegistryAccountFormQueryWhere!]
|
|
or - [AddressBookRegistryAccountFormQueryWhere!]
|
|
rawExpression - String
|
|
companyNo - NumberWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
regionCode - StringWhereValueExpression
|
|
countryCode - StringWhereValueExpression
|
|
registryId - StringWhereValueExpression
|
|
accountHolderName - StringWhereValueExpression
|
|
accountName - StringWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
addressBook - AddressBookFormQueryWhere
|
|
country - CountryFormQueryWhere
|
Example
{
"and": [AddressBookRegistryAccountFormQueryWhere],
"or": [AddressBookRegistryAccountFormQueryWhere],
"rawExpression": "abc123",
"companyNo": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"regionCode": StringWhereValueExpression,
"countryCode": StringWhereValueExpression,
"registryId": StringWhereValueExpression,
"accountHolderName": StringWhereValueExpression,
"accountName": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"addressBook": AddressBookFormQueryWhere,
"country": CountryFormQueryWhere
}
AddressBookRegistryAccountRelationships
Fields
| Field Name | Description |
|---|---|
addressBook - RelationshipDefinition
|
|
country - RelationshipDefinition
|
Example
{
"addressBook": RelationshipDefinition,
"country": RelationshipDefinition
}
AddressBookRelationships
Fields
| Field Name | Description |
|---|---|
actDepartment - RelationshipDefinition
|
|
addressType - RelationshipDefinition
|
|
iCCoAData - RelationshipDefinition
|
|
countryData - RelationshipDefinition
|
|
parentCompanyData - RelationshipDefinition
|
|
paymentCompanyData - RelationshipDefinition
|
|
addressBookRemarks - RelationshipDefinition
|
|
addressBookExpenses - RelationshipDefinition
|
|
addressBookAgentPorts - RelationshipDefinition
|
|
addressBookContacts - RelationshipDefinition
|
|
addressBookRegistryAccounts - RelationshipDefinition
|
|
addressBookBanks - RelationshipDefinition
|
|
operationsInvoice - RelationshipDefinition
|
Example
{
"actDepartment": RelationshipDefinition,
"addressType": RelationshipDefinition,
"iCCoAData": RelationshipDefinition,
"countryData": RelationshipDefinition,
"parentCompanyData": RelationshipDefinition,
"paymentCompanyData": RelationshipDefinition,
"addressBookRemarks": RelationshipDefinition,
"addressBookExpenses": RelationshipDefinition,
"addressBookAgentPorts": RelationshipDefinition,
"addressBookContacts": RelationshipDefinition,
"addressBookRegistryAccounts": RelationshipDefinition,
"addressBookBanks": RelationshipDefinition,
"operationsInvoice": RelationshipDefinition
}
AddressBookRemark
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
type - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
shortName - String
|
|
seqNo - Int
|
|
remarks - String
|
|
addressBook - AddressBook
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"type": "xyz789",
"customFieldByID": Any,
"customField": Any,
"shortName": "abc123",
"seqNo": 987,
"remarks": "xyz789",
"addressBook": AddressBook,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
AddressBookRemarkFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AddressBookRemarkFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AddressBookRemarkFormQueryWhere
}
AddressBookRemarkFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [AddressBookRemarkFormQueryWhere!]
|
|
or - [AddressBookRemarkFormQueryWhere!]
|
|
rawExpression - String
|
|
type - StringWhereValueExpression
|
|
shortName - StringWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
addressBook - AddressBookFormQueryWhere
|
Example
{
"and": [AddressBookRemarkFormQueryWhere],
"or": [AddressBookRemarkFormQueryWhere],
"rawExpression": "abc123",
"type": StringWhereValueExpression,
"shortName": StringWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"remarks": StringWhereValueExpression,
"addressBook": AddressBookFormQueryWhere
}
AddressBookRemarkRelationships
Fields
| Field Name | Description |
|---|---|
addressBook - RelationshipDefinition
|
Example
{"addressBook": RelationshipDefinition}
AddressBookVeslinkCompanyTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Partner"
AddressBookVeslinkCompanyTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - AddressBookVeslinkCompanyTypeEnum
|
|
isNot - AddressBookVeslinkCompanyTypeEnum
|
|
isIn - [AddressBookVeslinkCompanyTypeEnum]
|
Example
{"is": "Partner", "isNot": "Partner", "isIn": ["Partner"]}
AddressType
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
type - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
description - String
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"type": "xyz789",
"customFieldByID": Any,
"customField": Any,
"description": "xyz789",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
AddressTypeFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AddressTypeFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AddressTypeFormQueryWhere
}
AddressTypeFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [AddressTypeFormQueryWhere!]
|
|
or - [AddressTypeFormQueryWhere!]
|
|
rawExpression - String
|
|
type - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
Example
{
"and": [AddressTypeFormQueryWhere],
"or": [AddressTypeFormQueryWhere],
"rawExpression": "xyz789",
"type": StringWhereValueExpression,
"description": StringWhereValueExpression
}
AgentAppointments
Fields
| Field Name | Description |
|---|---|
recordID - Int
|
|
itemID - Int
|
|
eventDateTimeGmt - Date
|
|
previousAppointedAgent - String
|
|
newAppointedAgent - String
|
|
portCallNo - Int
|
|
agentInsert - Boolean
|
|
agentUpdate - Boolean
|
|
agentDelete - Boolean
|
|
portCallDeleted - Boolean
|
|
previousAppointedAgentAddress - AddressBook
|
|
newAppointedAgentAddress - AddressBook
|
|
agentType - AgentTypes
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"recordID": 987,
"itemID": 123,
"eventDateTimeGmt": "2007-12-03",
"previousAppointedAgent": "abc123",
"newAppointedAgent": "abc123",
"portCallNo": 987,
"agentInsert": false,
"agentUpdate": true,
"agentDelete": true,
"portCallDeleted": false,
"previousAppointedAgentAddress": AddressBook,
"newAppointedAgentAddress": AddressBook,
"agentType": AgentTypes,
"_id": "xyz789",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
AgentAppointmentsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AgentAppointmentsFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AgentAppointmentsFormQueryWhere
}
AgentAppointmentsFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [AgentAppointmentsFormQueryWhere!]
|
|
or - [AgentAppointmentsFormQueryWhere!]
|
|
rawExpression - String
|
|
previousAppointedAgentAddress - AddressBookFormQueryWhere
|
|
newAppointedAgentAddress - AddressBookFormQueryWhere
|
Example
{
"and": [AgentAppointmentsFormQueryWhere],
"or": [AgentAppointmentsFormQueryWhere],
"rawExpression": "abc123",
"previousAppointedAgentAddress": AddressBookFormQueryWhere,
"newAppointedAgentAddress": AddressBookFormQueryWhere
}
AgentAppointmentsRelationships
Fields
| Field Name | Description |
|---|---|
previousAppointedAgentAddress - RelationshipDefinition
|
|
newAppointedAgentAddress - RelationshipDefinition
|
|
agentType - RelationshipDefinition
|
Example
{
"previousAppointedAgentAddress": RelationshipDefinition,
"newAppointedAgentAddress": RelationshipDefinition,
"agentType": RelationshipDefinition
}
AgentTypes
Fields
| Field Name | Description |
|---|---|
itemID - Int
|
|
agentType - String
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"itemID": 123,
"agentType": "xyz789",
"_id": "abc123",
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
AggregateFunction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
AgreedDistance
Fields
| Field Name | Description |
|---|---|
portNameA - String
|
|
portNameB - String
|
|
portNoA - Int
|
|
portNoB - Int
|
|
distance - Int
|
|
portB - Port
|
|
portA - Port
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"portNameA": "xyz789",
"portNameB": "xyz789",
"portNoA": 987,
"portNoB": 987,
"distance": 123,
"portB": Port,
"portA": Port,
"_id": "abc123",
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
AgreedDistanceFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AgreedDistanceFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AgreedDistanceFormQueryWhere
}
AgreedDistanceFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [AgreedDistanceFormQueryWhere!]
|
|
or - [AgreedDistanceFormQueryWhere!]
|
|
rawExpression - String
|
|
portNoA - NumberWhereValueExpression
|
|
portNoB - NumberWhereValueExpression
|
|
distance - NumberWhereValueExpression
|
|
portB - PortFormQueryWhere
|
|
portA - PortFormQueryWhere
|
Example
{
"and": [AgreedDistanceFormQueryWhere],
"or": [AgreedDistanceFormQueryWhere],
"rawExpression": "abc123",
"portNoA": NumberWhereValueExpression,
"portNoB": NumberWhereValueExpression,
"distance": NumberWhereValueExpression,
"portB": PortFormQueryWhere,
"portA": PortFormQueryWhere
}
AgreedDistanceRelationships
Fields
| Field Name | Description |
|---|---|
portB - RelationshipDefinition
|
|
portA - RelationshipDefinition
|
Example
{
"portB": RelationshipDefinition,
"portA": RelationshipDefinition
}
AgreedTransitTimeBunker
Fields
| Field Name | Description |
|---|---|
effectiveFromYear - Int
|
|
loadPortNo - Int
|
|
discPortNo - Int
|
|
counterpartyType - String
|
|
counterpartyShortName - String
|
|
effectiveFromGmt - Date
|
|
effectiveToGmt - Date
|
|
curr - String
|
|
rate - Float
|
|
days - Float
|
|
isInactive - Boolean
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
currency - Currency
|
|
counterparty - AddressBook
|
|
dischargePort - Port
|
|
loadPort - Port
|
|
agreedTransitTimeBunkerDetails - [AgreedTransitTimeBunkerDetail]
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"effectiveFromYear": 987,
"loadPortNo": 123,
"discPortNo": 123,
"counterpartyType": "abc123",
"counterpartyShortName": "abc123",
"effectiveFromGmt": "2007-12-03",
"effectiveToGmt": "2007-12-03",
"curr": "xyz789",
"rate": 987.65,
"days": 987.65,
"isInactive": false,
"entryDateGmt": "2007-12-03",
"lastUser": "abc123",
"lastUpdateGmt": "2007-12-03",
"currency": Currency,
"counterparty": AddressBook,
"dischargePort": Port,
"loadPort": Port,
"agreedTransitTimeBunkerDetails": [
AgreedTransitTimeBunkerDetail
],
"_id": "xyz789",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
AgreedTransitTimeBunkerDetail
Fields
| Field Name | Description |
|---|---|
loadPortNo - Int
|
|
discPortNo - Int
|
|
counterpartyType - String
|
|
counterpartyShortName - String
|
|
effectiveFromGmt - Date
|
|
effectiveToGmt - Date
|
|
fuelType - String
|
|
value - Float
|
|
agreedTransitTimeBunker - AgreedTransitTimeBunker
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"loadPortNo": 123,
"discPortNo": 987,
"counterpartyType": "abc123",
"counterpartyShortName": "abc123",
"effectiveFromGmt": "2007-12-03",
"effectiveToGmt": "2007-12-03",
"fuelType": "abc123",
"value": 123.45,
"agreedTransitTimeBunker": AgreedTransitTimeBunker,
"_id": "xyz789",
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
AgreedTransitTimeBunkerDetailFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AgreedTransitTimeBunkerDetailFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AgreedTransitTimeBunkerDetailFormQueryWhere
}
AgreedTransitTimeBunkerDetailFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [AgreedTransitTimeBunkerDetailFormQueryWhere!]
|
|
or - [AgreedTransitTimeBunkerDetailFormQueryWhere!]
|
|
rawExpression - String
|
|
loadPortNo - NumberWhereValueExpression
|
|
discPortNo - NumberWhereValueExpression
|
|
counterpartyType - StringWhereValueExpression
|
|
counterpartyShortName - StringWhereValueExpression
|
|
effectiveFromGmt - DateWhereValueExpression
|
|
effectiveToGmt - DateWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
value - NumberWhereValueExpression
|
|
agreedTransitTimeBunker - AgreedTransitTimeBunkerFormQueryWhere
|
Example
{
"and": [AgreedTransitTimeBunkerDetailFormQueryWhere],
"or": [AgreedTransitTimeBunkerDetailFormQueryWhere],
"rawExpression": "xyz789",
"loadPortNo": NumberWhereValueExpression,
"discPortNo": NumberWhereValueExpression,
"counterpartyType": StringWhereValueExpression,
"counterpartyShortName": StringWhereValueExpression,
"effectiveFromGmt": DateWhereValueExpression,
"effectiveToGmt": DateWhereValueExpression,
"fuelType": StringWhereValueExpression,
"value": NumberWhereValueExpression,
"agreedTransitTimeBunker": AgreedTransitTimeBunkerFormQueryWhere
}
AgreedTransitTimeBunkerDetailRelationships
Fields
| Field Name | Description |
|---|---|
agreedTransitTimeBunker - RelationshipDefinition
|
Example
{"agreedTransitTimeBunker": RelationshipDefinition}
AgreedTransitTimeBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AgreedTransitTimeBunkerFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AgreedTransitTimeBunkerFormQueryWhere
}
AgreedTransitTimeBunkerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [AgreedTransitTimeBunkerFormQueryWhere!]
|
|
or - [AgreedTransitTimeBunkerFormQueryWhere!]
|
|
rawExpression - String
|
|
loadPortNo - NumberWhereValueExpression
|
|
discPortNo - NumberWhereValueExpression
|
|
counterpartyType - StringWhereValueExpression
|
|
counterpartyShortName - StringWhereValueExpression
|
|
effectiveFromGmt - DateWhereValueExpression
|
|
effectiveToGmt - DateWhereValueExpression
|
|
curr - StringWhereValueExpression
|
|
rate - NumberWhereValueExpression
|
|
days - NumberWhereValueExpression
|
|
isInactive - BoolWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
currency - CurrencyFormQueryWhere
|
|
counterparty - AddressBookFormQueryWhere
|
|
dischargePort - PortFormQueryWhere
|
|
loadPort - PortFormQueryWhere
|
Example
{
"and": [AgreedTransitTimeBunkerFormQueryWhere],
"or": [AgreedTransitTimeBunkerFormQueryWhere],
"rawExpression": "xyz789",
"loadPortNo": NumberWhereValueExpression,
"discPortNo": NumberWhereValueExpression,
"counterpartyType": StringWhereValueExpression,
"counterpartyShortName": StringWhereValueExpression,
"effectiveFromGmt": DateWhereValueExpression,
"effectiveToGmt": DateWhereValueExpression,
"curr": StringWhereValueExpression,
"rate": NumberWhereValueExpression,
"days": NumberWhereValueExpression,
"isInactive": BoolWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"currency": CurrencyFormQueryWhere,
"counterparty": AddressBookFormQueryWhere,
"dischargePort": PortFormQueryWhere,
"loadPort": PortFormQueryWhere
}
AgreedTransitTimeBunkerRelationships
Fields
| Field Name | Description |
|---|---|
currency - RelationshipDefinition
|
|
counterparty - RelationshipDefinition
|
|
dischargePort - RelationshipDefinition
|
|
loadPort - RelationshipDefinition
|
|
agreedTransitTimeBunkerDetails - RelationshipDefinition
|
Example
{
"currency": RelationshipDefinition,
"counterparty": RelationshipDefinition,
"dischargePort": RelationshipDefinition,
"loadPort": RelationshipDefinition,
"agreedTransitTimeBunkerDetails": RelationshipDefinition
}
Alert
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
appliesToID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
objectType - String
|
|
objectID - Int
|
|
alertID - String
|
|
type - String
|
|
value - String
|
|
sourceDecisionTableClassID - String
|
|
sourceDecisionTableID - String
|
|
primaryUser - String
|
|
acknowledgedBy - String
|
|
acknowledgedOnGmt - Date
|
|
acknowledged - Boolean
|
|
isManualOwner - Boolean
|
|
isWebhookResult - Boolean
|
|
isMutationApplied - Boolean
|
|
subObjectID - String
|
|
sourceRuleID - String
|
|
responseData - String
|
|
decisionTable - DecisionTable
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"appliesToID": "abc123",
"customFieldByID": Any,
"customField": Any,
"objectType": "abc123",
"objectID": 987,
"alertID": "abc123",
"type": "abc123",
"value": "abc123",
"sourceDecisionTableClassID": "xyz789",
"sourceDecisionTableID": "abc123",
"primaryUser": "xyz789",
"acknowledgedBy": "xyz789",
"acknowledgedOnGmt": "2007-12-03",
"acknowledged": true,
"isManualOwner": true,
"isWebhookResult": false,
"isMutationApplied": true,
"subObjectID": "xyz789",
"sourceRuleID": "xyz789",
"responseData": "xyz789",
"decisionTable": DecisionTable,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
AlertFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AlertFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AlertFormQueryWhere
}
AlertFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [AlertFormQueryWhere!]
|
|
or - [AlertFormQueryWhere!]
|
|
rawExpression - String
|
|
objectType - AlertObjectTypeEnumValueExpression
|
|
objectID - NumberWhereValueExpression
|
|
alertID - StringWhereValueExpression
|
|
type - AlertTypeEnumValueExpression
|
|
value - StringWhereValueExpression
|
|
sourceDecisionTableClassID - StringWhereValueExpression
|
|
sourceDecisionTableID - StringWhereValueExpression
|
|
primaryUser - StringWhereValueExpression
|
|
acknowledgedBy - StringWhereValueExpression
|
|
acknowledgedOnGmt - DateWhereValueExpression
|
|
acknowledged - BoolWhereValueExpression
|
|
isManualOwner - BoolWhereValueExpression
|
|
isWebhookResult - BoolWhereValueExpression
|
|
isMutationApplied - BoolWhereValueExpression
|
|
subObjectID - StringWhereValueExpression
|
|
sourceRuleID - StringWhereValueExpression
|
|
responseData - StringWhereValueExpression
|
|
decisionTable - DecisionTableFormQueryWhere
|
Example
{
"and": [AlertFormQueryWhere],
"or": [AlertFormQueryWhere],
"rawExpression": "abc123",
"objectType": AlertObjectTypeEnumValueExpression,
"objectID": NumberWhereValueExpression,
"alertID": StringWhereValueExpression,
"type": AlertTypeEnumValueExpression,
"value": StringWhereValueExpression,
"sourceDecisionTableClassID": StringWhereValueExpression,
"sourceDecisionTableID": StringWhereValueExpression,
"primaryUser": StringWhereValueExpression,
"acknowledgedBy": StringWhereValueExpression,
"acknowledgedOnGmt": DateWhereValueExpression,
"acknowledged": BoolWhereValueExpression,
"isManualOwner": BoolWhereValueExpression,
"isWebhookResult": BoolWhereValueExpression,
"isMutationApplied": BoolWhereValueExpression,
"subObjectID": StringWhereValueExpression,
"sourceRuleID": StringWhereValueExpression,
"responseData": StringWhereValueExpression,
"decisionTable": DecisionTableFormQueryWhere
}
AlertObjectTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Unspecified"
AlertObjectTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - AlertObjectTypeEnum
|
|
isNot - AlertObjectTypeEnum
|
|
isIn - [AlertObjectTypeEnum]
|
Example
{"is": "Unspecified", "isNot": "Unspecified", "isIn": ["Unspecified"]}
AlertRelationships
Fields
| Field Name | Description |
|---|---|
decisionTable - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
voyageEstimate - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
timeCharterContract - RelationshipDefinition
|
|
financialsInvoice - RelationshipDefinition
|
Example
{
"decisionTable": RelationshipDefinition,
"cargo": RelationshipDefinition,
"voyageEstimate": RelationshipDefinition,
"voyage": RelationshipDefinition,
"timeCharterContract": RelationshipDefinition,
"financialsInvoice": RelationshipDefinition
}
AlertTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Unspecified"
AlertTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - AlertTypeEnum
|
|
isNot - AlertTypeEnum
|
|
isIn - [AlertTypeEnum]
|
Example
{"is": "Unspecified", "isNot": "Unspecified", "isIn": ["Unspecified"]}
Any
Example
Any
ApplyAddVoyageCargo_result
ApplyCalculateVesselValuation_result
Fields
| Field Name | Description |
|---|---|
additionalData - Json
|
|
debugLog - String
|
|
warnings - [String!]
|
|
errors - [String!]
|
|
worksheetEstimate - CalculateVesselValuationResponse
|
Example
{
"additionalData": Json,
"debugLog": "abc123",
"warnings": ["xyz789"],
"errors": ["abc123"],
"worksheetEstimate": CalculateVesselValuationResponse
}
ApplyCargoHandlingList_result
Example
{
"additionalData": Json,
"debugLog": "abc123",
"warnings": ["xyz789"],
"errors": ["xyz789"],
"voyageItinerary": VoyageItinerary,
"response": Json
}
ApplyCargoResult
ApplyCopyEstimate_result
Example
{
"additionalData": Json,
"debugLog": "abc123",
"warnings": ["abc123"],
"errors": ["xyz789"],
"voyageEstimate": VoyageEstimate,
"response": Json
}
ApplyCreateLaytimeClaim_result
ApplyDelay_result
ApplyDeleteInvoice_result
ApplyEditLaytimeClaim_result
ApplyEtaEtd_result
Example
{
"additionalData": Json,
"debugLog": "xyz789",
"warnings": ["abc123"],
"errors": ["abc123"],
"voyageItinerary": VoyageItinerary,
"response": Json
}
ApplyGetInvoiceReportPdf_result
Example
{
"additionalData": Json,
"debugLog": "abc123",
"warnings": ["abc123"],
"errors": ["xyz789"],
"operationsInvoice": OperationsInvoice,
"response": Json
}
ApplyGetLaytimePDFReports_result
ApplyInvoiceResult
Fields
| Field Name | Description |
|---|---|
additionalData - Json
|
Example
{"additionalData": Json}
ApplyMessageInput
ApplyNominateCargo_result
ApplyNominationResult
Fields
| Field Name | Description |
|---|---|
additionalData - Json
|
Example
{"additionalData": Json}
ApplyPortActivityList_result
Example
{
"additionalData": Json,
"debugLog": "xyz789",
"warnings": ["xyz789"],
"errors": ["abc123"],
"voyageItinerary": VoyageItinerary,
"response": Json
}
ApplyPortExpenses_result
Example
{
"additionalData": Json,
"debugLog": "abc123",
"warnings": ["abc123"],
"errors": ["xyz789"],
"financialsInvoice": FinancialsInvoice,
"response": Json
}
ApplyPositionReport_result
ApplyPublishActivityReport_result
ApplyPublishInvoice_result
ApplyPublishPosition_result
ApplyPublishVoyageUpdate_result
ApplyRegionTableUpdate_result
ApplySCCVoyageEmissions_result
ApplyScheduleVoyage_result
Fields
| Field Name | Description |
|---|---|
additionalData - Json
|
|
debugLog - String
|
|
warnings - [String!]
|
|
errors - [String!]
|
|
response - ScheduleVoyageResponse
|
Example
{
"additionalData": Json,
"debugLog": "abc123",
"warnings": ["abc123"],
"errors": ["xyz789"],
"response": ScheduleVoyageResponse
}
ApplyUpcomingPortsList_result
Example
{
"additionalData": Json,
"debugLog": "abc123",
"warnings": ["abc123"],
"errors": ["xyz789"],
"voyageItinerary": VoyageItinerary,
"response": Json
}
ApplyUpdateActivityLog_result
ApplyUpdateBareboat_result
Example
{
"additionalData": Json,
"debugLog": "xyz789",
"warnings": ["xyz789"],
"errors": ["abc123"],
"bareboatContract": BareboatContract,
"response": Json
}
ApplyUpdateCOA_result
ApplyUpdateCargo_result
ApplyUpdateChartOfAccounts_result
Example
{
"additionalData": Json,
"debugLog": "abc123",
"warnings": ["abc123"],
"errors": ["abc123"],
"chartOfAccounts": ChartOfAccounts,
"response": Json
}
ApplyUpdateEquipmentContract_result
Example
{
"additionalData": Json,
"debugLog": "abc123",
"warnings": ["xyz789"],
"errors": ["abc123"],
"timeCharterContract": TimeCharterContract,
"response": Json
}
ApplyUpdateEquipment_result
ApplyUpdateEstimate_result
Example
{
"additionalData": Json,
"debugLog": "abc123",
"warnings": ["abc123"],
"errors": ["abc123"],
"voyageEstimate": VoyageEstimate,
"response": Json
}
ApplyUpdateFreightMatrixQuote_result
ApplyUpdateTimeCharterCOA_result
Example
{
"additionalData": Json,
"debugLog": "xyz789",
"warnings": ["abc123"],
"errors": ["xyz789"],
"timeCharterCOA": TimeCharterCOA,
"response": Json
}
ApplyUpdateTimeCharter_result
Example
{
"additionalData": Json,
"debugLog": "abc123",
"warnings": ["xyz789"],
"errors": ["abc123"],
"timeCharterContract": TimeCharterContract,
"response": Json
}
ApplyUpdateVoyage_result
ApplyVeslinkForm_result
Attachment
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
objectID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seq - Int
|
|
type - String
|
|
shortName - String
|
|
extension - String
|
|
mimeType - String
|
|
category - String
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"objectID": "xyz789",
"customFieldByID": Any,
"customField": Any,
"seq": 987,
"type": "abc123",
"shortName": "abc123",
"extension": "xyz789",
"mimeType": "abc123",
"category": "abc123",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
AttachmentCategoryEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Logo"
AttachmentCategoryEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - AttachmentCategoryEnum
|
|
isNot - AttachmentCategoryEnum
|
|
isIn - [AttachmentCategoryEnum]
|
Example
{"is": "Logo", "isNot": "Logo", "isIn": ["Logo"]}
AttachmentFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AttachmentFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AttachmentFormQueryWhere
}
AttachmentFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [AttachmentFormQueryWhere!]
|
|
or - [AttachmentFormQueryWhere!]
|
|
rawExpression - String
|
|
objectID - StringWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
type - StringWhereValueExpression
|
|
shortName - StringWhereValueExpression
|
|
extension - StringWhereValueExpression
|
|
mimeType - StringWhereValueExpression
|
|
category - AttachmentCategoryEnumValueExpression
|
Example
{
"and": [AttachmentFormQueryWhere],
"or": [AttachmentFormQueryWhere],
"rawExpression": "xyz789",
"objectID": StringWhereValueExpression,
"seq": NumberWhereValueExpression,
"type": StringWhereValueExpression,
"shortName": StringWhereValueExpression,
"extension": StringWhereValueExpression,
"mimeType": StringWhereValueExpression,
"category": AttachmentCategoryEnumValueExpression
}
Audit
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
userName - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
userMachineId - String
|
|
requestType - String
|
|
responseType - String
|
|
comment - String
|
|
requestTime - Date
|
|
auditDetails - [AuditDetail]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"userName": "xyz789",
"customFieldByID": Any,
"customField": Any,
"userMachineId": "xyz789",
"requestType": "xyz789",
"responseType": "abc123",
"comment": "abc123",
"requestTime": "2007-12-03",
"auditDetails": [AuditDetail],
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
AuditAction
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
appliesToID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
sqlID - Int
|
|
auditActionType - String
|
|
auditActionData - String
|
|
auditActionDescription - String
|
|
objectType - String
|
|
objectID - Int
|
|
hookSourceType - String
|
|
entryDateGmt - Date
|
|
entryUserID - String
|
|
hookSource - String
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"appliesToID": "abc123",
"customFieldByID": Any,
"customField": Any,
"sqlID": 123,
"auditActionType": "xyz789",
"auditActionData": "abc123",
"auditActionDescription": "xyz789",
"objectType": "abc123",
"objectID": 123,
"hookSourceType": "xyz789",
"entryDateGmt": "2007-12-03",
"entryUserID": "abc123",
"hookSource": "abc123",
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
AuditActionAuditActionTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Unspecified"
AuditActionAuditActionTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - AuditActionAuditActionTypeEnum
|
|
isNot - AuditActionAuditActionTypeEnum
|
|
isIn - [AuditActionAuditActionTypeEnum]
|
Example
{"is": "Unspecified", "isNot": "Unspecified", "isIn": ["Unspecified"]}
AuditActionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AuditActionFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AuditActionFormQueryWhere
}
AuditActionFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [AuditActionFormQueryWhere!]
|
|
or - [AuditActionFormQueryWhere!]
|
|
rawExpression - String
|
|
auditActionType - AuditActionAuditActionTypeEnumValueExpression
|
|
auditActionData - StringWhereValueExpression
|
|
auditActionDescription - StringWhereValueExpression
|
|
objectType - AuditActionObjectTypeEnumValueExpression
|
|
objectID - NumberWhereValueExpression
|
|
hookSourceType - AuditActionHookSourceTypeEnumValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
entryUserID - StringWhereValueExpression
|
|
hookSource - StringWhereValueExpression
|
Example
{
"and": [AuditActionFormQueryWhere],
"or": [AuditActionFormQueryWhere],
"rawExpression": "xyz789",
"auditActionType": AuditActionAuditActionTypeEnumValueExpression,
"auditActionData": StringWhereValueExpression,
"auditActionDescription": StringWhereValueExpression,
"objectType": AuditActionObjectTypeEnumValueExpression,
"objectID": NumberWhereValueExpression,
"hookSourceType": AuditActionHookSourceTypeEnumValueExpression,
"entryDateGmt": DateWhereValueExpression,
"entryUserID": StringWhereValueExpression,
"hookSource": StringWhereValueExpression
}
AuditActionHookSourceTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Unspecified"
AuditActionHookSourceTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - AuditActionHookSourceTypeEnum
|
|
isNot - AuditActionHookSourceTypeEnum
|
|
isIn - [AuditActionHookSourceTypeEnum]
|
Example
{"is": "Unspecified", "isNot": "Unspecified", "isIn": ["Unspecified"]}
AuditActionObjectTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Unspecified"
AuditActionObjectTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - AuditActionObjectTypeEnum
|
|
isNot - AuditActionObjectTypeEnum
|
|
isIn - [AuditActionObjectTypeEnum]
|
Example
{"is": "Unspecified", "isNot": "Unspecified", "isIn": ["Unspecified"]}
AuditActionRelationships
Fields
| Field Name | Description |
|---|---|
estimateItinerary - RelationshipDefinition
|
|
voyageEstimate - RelationshipDefinition
|
Example
{
"estimateItinerary": RelationshipDefinition,
"voyageEstimate": RelationshipDefinition
}
AuditDetail
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
userName - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
userMachineId - String
|
|
requestType - String
|
|
requestTime - Date
|
|
seq - Int
|
|
targetUserNo - Int
|
|
subjectType - String
|
|
subjectID - String
|
|
changeType - String
|
|
value - String
|
|
previousValue - String
|
|
audit - Audit
|
|
targetUser - User
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"userName": "abc123",
"customFieldByID": Any,
"customField": Any,
"userMachineId": "xyz789",
"requestType": "abc123",
"requestTime": "2007-12-03",
"seq": 123,
"targetUserNo": 123,
"subjectType": "abc123",
"subjectID": "xyz789",
"changeType": "abc123",
"value": "xyz789",
"previousValue": "abc123",
"audit": Audit,
"targetUser": User,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
AuditDetailChangeTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Add"
AuditDetailChangeTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - AuditDetailChangeTypeEnum
|
|
isNot - AuditDetailChangeTypeEnum
|
|
isIn - [AuditDetailChangeTypeEnum]
|
Example
{"is": "Add", "isNot": "Add", "isIn": ["Add"]}
AuditDetailFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AuditDetailFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AuditDetailFormQueryWhere
}
AuditDetailFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [AuditDetailFormQueryWhere!]
|
|
or - [AuditDetailFormQueryWhere!]
|
|
rawExpression - String
|
|
userName - StringWhereValueExpression
|
|
userMachineId - StringWhereValueExpression
|
|
requestType - StringWhereValueExpression
|
|
requestTime - DateWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
targetUserNo - NumberWhereValueExpression
|
|
subjectType - AuditDetailSubjectTypeEnumValueExpression
|
|
subjectID - StringWhereValueExpression
|
|
changeType - AuditDetailChangeTypeEnumValueExpression
|
|
value - StringWhereValueExpression
|
|
previousValue - StringWhereValueExpression
|
|
audit - AuditFormQueryWhere
|
|
targetUser - UserFormQueryWhere
|
Example
{
"and": [AuditDetailFormQueryWhere],
"or": [AuditDetailFormQueryWhere],
"rawExpression": "abc123",
"userName": StringWhereValueExpression,
"userMachineId": StringWhereValueExpression,
"requestType": StringWhereValueExpression,
"requestTime": DateWhereValueExpression,
"seq": NumberWhereValueExpression,
"targetUserNo": NumberWhereValueExpression,
"subjectType": AuditDetailSubjectTypeEnumValueExpression,
"subjectID": StringWhereValueExpression,
"changeType": AuditDetailChangeTypeEnumValueExpression,
"value": StringWhereValueExpression,
"previousValue": StringWhereValueExpression,
"audit": AuditFormQueryWhere,
"targetUser": UserFormQueryWhere
}
AuditDetailRelationships
Fields
| Field Name | Description |
|---|---|
audit - RelationshipDefinition
|
|
targetUser - RelationshipDefinition
|
Example
{
"audit": RelationshipDefinition,
"targetUser": RelationshipDefinition
}
AuditDetailSubjectTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ObjectRight"
AuditDetailSubjectTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - AuditDetailSubjectTypeEnum
|
|
isNot - AuditDetailSubjectTypeEnum
|
|
isIn - [AuditDetailSubjectTypeEnum]
|
Example
{"is": "ObjectRight", "isNot": "ObjectRight", "isIn": ["ObjectRight"]}
AuditFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AuditFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AuditFormQueryWhere
}
AuditFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [AuditFormQueryWhere!]
|
|
or - [AuditFormQueryWhere!]
|
|
rawExpression - String
|
|
userName - StringWhereValueExpression
|
|
userMachineId - StringWhereValueExpression
|
|
requestType - StringWhereValueExpression
|
|
responseType - StringWhereValueExpression
|
|
comment - StringWhereValueExpression
|
|
requestTime - DateWhereValueExpression
|
Example
{
"and": [AuditFormQueryWhere],
"or": [AuditFormQueryWhere],
"rawExpression": "abc123",
"userName": StringWhereValueExpression,
"userMachineId": StringWhereValueExpression,
"requestType": StringWhereValueExpression,
"responseType": StringWhereValueExpression,
"comment": StringWhereValueExpression,
"requestTime": DateWhereValueExpression
}
AuditRelationships
Fields
| Field Name | Description |
|---|---|
auditDetails - RelationshipDefinition
|
Example
{"auditDetails": RelationshipDefinition}
AuditRow
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
updateTimeGmt - Date
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
transactionNo - Int
|
|
sequenceNo - Int
|
|
tableName - String
|
|
columnName - String
|
|
oldValue - String
|
|
newValue - String
|
|
insert - Boolean
|
|
update - Boolean
|
|
delete - Boolean
|
|
flags - Int
|
|
itemID - Int
|
|
auditTrail - AuditTrail
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"updateTimeGmt": "2007-12-03",
"customFieldByID": Any,
"customField": Any,
"transactionNo": 987,
"sequenceNo": 987,
"tableName": "xyz789",
"columnName": "abc123",
"oldValue": "abc123",
"newValue": "xyz789",
"insert": false,
"update": false,
"delete": true,
"flags": 987,
"itemID": 987,
"auditTrail": AuditTrail,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
AuditRowFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AuditRowFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AuditRowFormQueryWhere
}
AuditRowFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [AuditRowFormQueryWhere!]
|
|
or - [AuditRowFormQueryWhere!]
|
|
rawExpression - String
|
|
transactionNo - NumberWhereValueExpression
|
|
sequenceNo - NumberWhereValueExpression
|
|
tableName - StringWhereValueExpression
|
|
columnName - StringWhereValueExpression
|
|
oldValue - StringWhereValueExpression
|
|
newValue - StringWhereValueExpression
|
|
insert - BoolWhereValueExpression
|
|
update - BoolWhereValueExpression
|
|
delete - BoolWhereValueExpression
|
|
flags - NumberWhereValueExpression
|
|
itemID - NumberWhereValueExpression
|
|
auditTrail - AuditTrailFormQueryWhere
|
Example
{
"and": [AuditRowFormQueryWhere],
"or": [AuditRowFormQueryWhere],
"rawExpression": "xyz789",
"transactionNo": NumberWhereValueExpression,
"sequenceNo": NumberWhereValueExpression,
"tableName": StringWhereValueExpression,
"columnName": StringWhereValueExpression,
"oldValue": StringWhereValueExpression,
"newValue": StringWhereValueExpression,
"insert": BoolWhereValueExpression,
"update": BoolWhereValueExpression,
"delete": BoolWhereValueExpression,
"flags": NumberWhereValueExpression,
"itemID": NumberWhereValueExpression,
"auditTrail": AuditTrailFormQueryWhere
}
AuditRowRelationships
Fields
| Field Name | Description |
|---|---|
auditTrail - RelationshipDefinition
|
Example
{"auditTrail": RelationshipDefinition}
AuditTrail
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
transactionNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
type - String
|
|
windowsUserName - String
|
|
machineID - String
|
|
updateTimeGmt - Date
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
portCallNo - Int
|
|
portNo - Int
|
|
referenceNo - String
|
|
remarks - String
|
|
unacknowledged - Boolean
|
|
bulkUpdate - Boolean
|
|
hideRevision - Boolean
|
|
flags - Int
|
|
berthSequenceNo - Int
|
|
portCargoNo - Int
|
|
parentTransactionNo - Int
|
|
imosUserName - String
|
|
imosUserNo - Int
|
|
updateOffset - Float
|
|
port - Port
|
|
auditRows - [AuditRow]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"transactionNo": 123,
"customFieldByID": Any,
"customField": Any,
"type": "xyz789",
"windowsUserName": "xyz789",
"machineID": "xyz789",
"updateTimeGmt": "2007-12-03",
"vesselCode": "abc123",
"voyageNo": 123,
"portCallNo": 123,
"portNo": 123,
"referenceNo": "xyz789",
"remarks": "xyz789",
"unacknowledged": false,
"bulkUpdate": false,
"hideRevision": true,
"flags": 987,
"berthSequenceNo": 123,
"portCargoNo": 123,
"parentTransactionNo": 123,
"imosUserName": "abc123",
"imosUserNo": 123,
"updateOffset": 123.45,
"port": Port,
"auditRows": [AuditRow],
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
AuditTrailFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - AuditTrailFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": AuditTrailFormQueryWhere
}
AuditTrailFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [AuditTrailFormQueryWhere!]
|
|
or - [AuditTrailFormQueryWhere!]
|
|
rawExpression - String
|
|
transactionNo - NumberWhereValueExpression
|
|
type - StringWhereValueExpression
|
|
windowsUserName - StringWhereValueExpression
|
|
machineID - StringWhereValueExpression
|
|
updateTimeGmt - DateWhereValueExpression
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
portCallNo - NumberWhereValueExpression
|
|
portNo - NumberWhereValueExpression
|
|
referenceNo - StringWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
unacknowledged - BoolWhereValueExpression
|
|
bulkUpdate - BoolWhereValueExpression
|
|
hideRevision - BoolWhereValueExpression
|
|
flags - NumberWhereValueExpression
|
|
berthSequenceNo - NumberWhereValueExpression
|
|
portCargoNo - NumberWhereValueExpression
|
|
parentTransactionNo - NumberWhereValueExpression
|
|
imosUserName - StringWhereValueExpression
|
|
imosUserNo - NumberWhereValueExpression
|
|
updateOffset - NumberWhereValueExpression
|
|
port - PortFormQueryWhere
|
Example
{
"and": [AuditTrailFormQueryWhere],
"or": [AuditTrailFormQueryWhere],
"rawExpression": "abc123",
"transactionNo": NumberWhereValueExpression,
"type": StringWhereValueExpression,
"windowsUserName": StringWhereValueExpression,
"machineID": StringWhereValueExpression,
"updateTimeGmt": DateWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"portCallNo": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"referenceNo": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"unacknowledged": BoolWhereValueExpression,
"bulkUpdate": BoolWhereValueExpression,
"hideRevision": BoolWhereValueExpression,
"flags": NumberWhereValueExpression,
"berthSequenceNo": NumberWhereValueExpression,
"portCargoNo": NumberWhereValueExpression,
"parentTransactionNo": NumberWhereValueExpression,
"imosUserName": StringWhereValueExpression,
"imosUserNo": NumberWhereValueExpression,
"updateOffset": NumberWhereValueExpression,
"port": PortFormQueryWhere
}
AuditTrailRelationships
Fields
| Field Name | Description |
|---|---|
port - RelationshipDefinition
|
|
auditRows - RelationshipDefinition
|
Example
{
"port": RelationshipDefinition,
"auditRows": RelationshipDefinition
}
AutoApprovalSettingInput
AutoApprovalSettingOutput
BareboatBroker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
cpCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
sequenceNo - Int
|
|
brokerShortName - String
|
|
brokerRate - Float
|
|
paymentMethod - String
|
|
dateToGmt - Date
|
|
remarks - String
|
|
addressBook - AddressBook
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"cpCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"sequenceNo": 123,
"brokerShortName": "abc123",
"brokerRate": 987.65,
"paymentMethod": "xyz789",
"dateToGmt": "2007-12-03",
"remarks": "xyz789",
"addressBook": AddressBook,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
BareboatBrokerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BareboatBrokerFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BareboatBrokerFormQueryWhere
}
BareboatBrokerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [BareboatBrokerFormQueryWhere!]
|
|
or - [BareboatBrokerFormQueryWhere!]
|
|
rawExpression - String
|
|
cpCode - StringWhereValueExpression
|
|
sequenceNo - NumberWhereValueExpression
|
|
brokerShortName - StringWhereValueExpression
|
|
brokerRate - NumberWhereValueExpression
|
|
paymentMethod - BareboatBrokerPaymentMethodEnumValueExpression
|
|
dateToGmt - DateWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
addressBook - AddressBookFormQueryWhere
|
Example
{
"and": [BareboatBrokerFormQueryWhere],
"or": [BareboatBrokerFormQueryWhere],
"rawExpression": "abc123",
"cpCode": StringWhereValueExpression,
"sequenceNo": NumberWhereValueExpression,
"brokerShortName": StringWhereValueExpression,
"brokerRate": NumberWhereValueExpression,
"paymentMethod": BareboatBrokerPaymentMethodEnumValueExpression,
"dateToGmt": DateWhereValueExpression,
"remarks": StringWhereValueExpression,
"addressBook": AddressBookFormQueryWhere
}
BareboatBrokerPaymentMethodEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"PayDirectly"
BareboatBrokerPaymentMethodEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - BareboatBrokerPaymentMethodEnum
|
|
isNot - BareboatBrokerPaymentMethodEnum
|
|
isIn - [BareboatBrokerPaymentMethodEnum]
|
Example
{"is": "PayDirectly", "isNot": "PayDirectly", "isIn": ["PayDirectly"]}
BareboatBrokerRelationships
Fields
| Field Name | Description |
|---|---|
addressBook - RelationshipDefinition
|
Example
{"addressBook": RelationshipDefinition}
BareboatContract
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
cpCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
parentTcCode - String
|
|
vesselCode - String
|
|
vesselName - String
|
|
beneficiaryShortName - String
|
|
beneficiaryType - String
|
|
fixtureDate - Date
|
|
startDateGmt - Date
|
|
duration - Float
|
|
curr - String
|
|
exchangeRate - Float
|
|
baseCurr - String
|
|
remarks - String
|
|
endDateGmt - Date
|
|
billPeriodDays - Float
|
|
billingPeriodDesc - String
|
|
companyCode - String
|
|
lobCode - String
|
|
tradeAreaPortNo - Int
|
|
lastUpdateGmt - Date
|
|
opsCoordinator - String
|
|
status - String
|
|
parentTimeCharterContract - TimeCharterContract
|
|
vessel - Vessel
|
|
beneficiary - AddressBook
|
|
tradeArea - TradeArea
|
|
lob - Lob
|
|
company - Company
|
|
expenses - [BareboatExpense]
|
|
brokers - [BareboatBroker]
|
|
hireLines - [BareboatHire]
|
|
operationsInvoice - [OperationsInvoice]
|
|
updateBareboatMessages - [UpdateBareboatMessageRecord]
|
|
Arguments
|
|
changesSinceLast - BareboatContractChangesSinceLast
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"cpCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"parentTcCode": "abc123",
"vesselCode": "abc123",
"vesselName": "abc123",
"beneficiaryShortName": "abc123",
"beneficiaryType": "xyz789",
"fixtureDate": "2007-12-03",
"startDateGmt": "2007-12-03",
"duration": 987.65,
"curr": "abc123",
"exchangeRate": 987.65,
"baseCurr": "xyz789",
"remarks": "xyz789",
"endDateGmt": "2007-12-03",
"billPeriodDays": 987.65,
"billingPeriodDesc": "abc123",
"companyCode": "xyz789",
"lobCode": "xyz789",
"tradeAreaPortNo": 123,
"lastUpdateGmt": "2007-12-03",
"opsCoordinator": "xyz789",
"status": "xyz789",
"parentTimeCharterContract": TimeCharterContract,
"vessel": Vessel,
"beneficiary": AddressBook,
"tradeArea": TradeArea,
"lob": Lob,
"company": Company,
"expenses": [BareboatExpense],
"brokers": [BareboatBroker],
"hireLines": [BareboatHire],
"operationsInvoice": [OperationsInvoice],
"updateBareboatMessages": [UpdateBareboatMessageRecord],
"changesSinceLast": BareboatContractChangesSinceLast,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
BareboatContractChangesSinceLast
Fields
| Field Name | Description |
|---|---|
updateBareboat - MessageUpdateResponse
|
Example
{"updateBareboat": MessageUpdateResponse}
BareboatContractFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BareboatContractFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BareboatContractFormQueryWhere
}
BareboatContractFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [BareboatContractFormQueryWhere!]
|
|
or - [BareboatContractFormQueryWhere!]
|
|
rawExpression - String
|
|
cpCode - StringWhereValueExpression
|
|
parentTcCode - StringWhereValueExpression
|
|
vesselCode - StringWhereValueExpression
|
|
vesselName - StringWhereValueExpression
|
|
beneficiaryShortName - StringWhereValueExpression
|
|
beneficiaryType - StringWhereValueExpression
|
|
fixtureDate - DateWhereValueExpression
|
|
startDateGmt - DateWhereValueExpression
|
|
duration - NumberWhereValueExpression
|
|
curr - StringWhereValueExpression
|
|
exchangeRate - NumberWhereValueExpression
|
|
baseCurr - StringWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
parentTimeCharterContract - TimeCharterContractFormQueryWhere
|
|
vessel - VesselFormQueryWhere
|
|
beneficiary - AddressBookFormQueryWhere
|
|
tradeArea - TradeAreaFormQueryWhere
|
|
lob - LobFormQueryWhere
|
|
company - CompanyFormQueryWhere
|
Example
{
"and": [BareboatContractFormQueryWhere],
"or": [BareboatContractFormQueryWhere],
"rawExpression": "xyz789",
"cpCode": StringWhereValueExpression,
"parentTcCode": StringWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"vesselName": StringWhereValueExpression,
"beneficiaryShortName": StringWhereValueExpression,
"beneficiaryType": StringWhereValueExpression,
"fixtureDate": DateWhereValueExpression,
"startDateGmt": DateWhereValueExpression,
"duration": NumberWhereValueExpression,
"curr": StringWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"baseCurr": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"parentTimeCharterContract": TimeCharterContractFormQueryWhere,
"vessel": VesselFormQueryWhere,
"beneficiary": AddressBookFormQueryWhere,
"tradeArea": TradeAreaFormQueryWhere,
"lob": LobFormQueryWhere,
"company": CompanyFormQueryWhere
}
BareboatContractRelationships
Fields
| Field Name | Description |
|---|---|
parentTimeCharterContract - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
beneficiary - RelationshipDefinition
|
|
tradeArea - RelationshipDefinition
|
|
lob - RelationshipDefinition
|
|
company - RelationshipDefinition
|
|
expenses - RelationshipDefinition
|
|
brokers - RelationshipDefinition
|
|
hireLines - RelationshipDefinition
|
|
operationsInvoice - RelationshipDefinition
|
Example
{
"parentTimeCharterContract": RelationshipDefinition,
"vessel": RelationshipDefinition,
"beneficiary": RelationshipDefinition,
"tradeArea": RelationshipDefinition,
"lob": RelationshipDefinition,
"company": RelationshipDefinition,
"expenses": RelationshipDefinition,
"brokers": RelationshipDefinition,
"hireLines": RelationshipDefinition,
"operationsInvoice": RelationshipDefinition
}
BareboatExpense
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
cpCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
sequenceNo - Int
|
|
description - String
|
|
lastUser - String
|
|
remarks - String
|
|
code - String
|
|
currency - String
|
|
exchangeRate - Float
|
|
rateContractCurr - Float
|
|
rateExpenseCurr - Float
|
|
actRateContractCurr - Float
|
|
actRateExpenseCurr - Float
|
|
useActRate - Boolean
|
|
dateFromGmt - Date
|
|
dateToGmt - Date
|
|
isCommissionableExpense - Boolean
|
|
rateType - String
|
|
exchangeRateInternal - Float
|
|
currencyInternal - String
|
|
subSequence - Int
|
|
billCodeInternal - String
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"cpCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"sequenceNo": 987,
"description": "xyz789",
"lastUser": "xyz789",
"remarks": "xyz789",
"code": "xyz789",
"currency": "abc123",
"exchangeRate": 987.65,
"rateContractCurr": 123.45,
"rateExpenseCurr": 123.45,
"actRateContractCurr": 987.65,
"actRateExpenseCurr": 987.65,
"useActRate": true,
"dateFromGmt": "2007-12-03",
"dateToGmt": "2007-12-03",
"isCommissionableExpense": false,
"rateType": "xyz789",
"exchangeRateInternal": 123.45,
"currencyInternal": "abc123",
"subSequence": 123,
"billCodeInternal": "abc123",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
BareboatExpenseBillCodeInternalEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BALLA"
BareboatExpenseBillCodeInternalEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - BareboatExpenseBillCodeInternalEnum
|
|
isNot - BareboatExpenseBillCodeInternalEnum
|
|
isIn - [BareboatExpenseBillCodeInternalEnum]
|
Example
{"is": "BALLA", "isNot": "BALLA", "isIn": ["BALLA"]}
BareboatExpenseFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BareboatExpenseFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BareboatExpenseFormQueryWhere
}
BareboatExpenseFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [BareboatExpenseFormQueryWhere!]
|
|
or - [BareboatExpenseFormQueryWhere!]
|
|
rawExpression - String
|
|
cpCode - StringWhereValueExpression
|
|
sequenceNo - NumberWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
dateToGmt - DateWhereValueExpression
|
|
exchangeRateInternal - NumberWhereValueExpression
|
|
currencyInternal - StringWhereValueExpression
|
|
subSequence - NumberWhereValueExpression
|
|
billCodeInternal - BareboatExpenseBillCodeInternalEnumValueExpression
|
Example
{
"and": [BareboatExpenseFormQueryWhere],
"or": [BareboatExpenseFormQueryWhere],
"rawExpression": "abc123",
"cpCode": StringWhereValueExpression,
"sequenceNo": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"dateToGmt": DateWhereValueExpression,
"exchangeRateInternal": NumberWhereValueExpression,
"currencyInternal": StringWhereValueExpression,
"subSequence": NumberWhereValueExpression,
"billCodeInternal": BareboatExpenseBillCodeInternalEnumValueExpression
}
BareboatHire
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
hireRateType - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
hireDuration - Float
|
|
hireDurationUnit - String
|
|
comments - String
|
|
cpCode - String
|
|
sequenceNo - Int
|
|
isPeriodDurationHours - Boolean
|
|
isRateTypeHourly - Boolean
|
|
isRateTypeDaily - Boolean
|
|
hireRatePerDay - Float
|
|
remarks - String
|
|
periodDurationDays - Float
|
|
hireFromGmt - Date
|
|
hireToGmt - Date
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"hireRateType": "xyz789",
"customFieldByID": Any,
"customField": Any,
"hireDuration": 123.45,
"hireDurationUnit": "xyz789",
"comments": "abc123",
"cpCode": "abc123",
"sequenceNo": 123,
"isPeriodDurationHours": true,
"isRateTypeHourly": false,
"isRateTypeDaily": false,
"hireRatePerDay": 987.65,
"remarks": "xyz789",
"periodDurationDays": 987.65,
"hireFromGmt": "2007-12-03",
"hireToGmt": "2007-12-03",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
BareboatHireFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BareboatHireFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BareboatHireFormQueryWhere
}
BareboatHireFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [BareboatHireFormQueryWhere!]
|
|
or - [BareboatHireFormQueryWhere!]
|
|
rawExpression - String
|
|
cpCode - StringWhereValueExpression
|
|
sequenceNo - NumberWhereValueExpression
|
|
isPeriodDurationHours - BoolWhereValueExpression
|
|
isRateTypeHourly - BoolWhereValueExpression
|
|
isRateTypeDaily - BoolWhereValueExpression
|
|
hireRatePerDay - NumberWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
periodDurationDays - NumberWhereValueExpression
|
|
hireFromGmt - DateWhereValueExpression
|
|
hireToGmt - DateWhereValueExpression
|
Example
{
"and": [BareboatHireFormQueryWhere],
"or": [BareboatHireFormQueryWhere],
"rawExpression": "xyz789",
"cpCode": StringWhereValueExpression,
"sequenceNo": NumberWhereValueExpression,
"isPeriodDurationHours": BoolWhereValueExpression,
"isRateTypeHourly": BoolWhereValueExpression,
"isRateTypeDaily": BoolWhereValueExpression,
"hireRatePerDay": NumberWhereValueExpression,
"remarks": StringWhereValueExpression,
"periodDurationDays": NumberWhereValueExpression,
"hireFromGmt": DateWhereValueExpression,
"hireToGmt": DateWhereValueExpression
}
Barge
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
isTanker - Boolean
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
isBulker - Boolean
|
|
code - String
|
|
iD - String
|
|
name - String
|
|
type - String
|
|
hullType - String
|
|
hullArrangement - String
|
|
serviceArea - String
|
|
bargeNotes - String
|
|
ownership - String
|
|
yearBuilt - Int
|
|
vapor - Int
|
|
heat - Int
|
|
steam - Int
|
|
inactive - Boolean
|
|
tankerBulkType - String
|
|
vesselTypeCode - String
|
|
referenceNo - String
|
|
opaDate - Date
|
|
length - Float
|
|
width - Float
|
|
height - Float
|
|
towCapacity - Float
|
|
registeredTons - Float
|
|
calibratedBbls - Float
|
|
dailyCost - Float
|
|
ballastSpeed - Float
|
|
ladenSpeed - Float
|
|
power - Float
|
|
vetted - Int
|
|
vettedDate - Date
|
|
vesselType - String
|
|
fleet - String
|
|
heatConsumption - Float
|
|
vesselBoats - [VesselBoats]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"isTanker": true,
"customFieldByID": Any,
"customField": Any,
"isBulker": true,
"code": "xyz789",
"iD": "abc123",
"name": "abc123",
"type": "xyz789",
"hullType": "abc123",
"hullArrangement": "abc123",
"serviceArea": "xyz789",
"bargeNotes": "xyz789",
"ownership": "abc123",
"yearBuilt": 123,
"vapor": 123,
"heat": 987,
"steam": 123,
"inactive": true,
"tankerBulkType": "xyz789",
"vesselTypeCode": "abc123",
"referenceNo": "xyz789",
"opaDate": "2007-12-03",
"length": 123.45,
"width": 123.45,
"height": 987.65,
"towCapacity": 987.65,
"registeredTons": 123.45,
"calibratedBbls": 987.65,
"dailyCost": 987.65,
"ballastSpeed": 123.45,
"ladenSpeed": 987.65,
"power": 987.65,
"vetted": 987,
"vettedDate": "2007-12-03",
"vesselType": "abc123",
"fleet": "xyz789",
"heatConsumption": 987.65,
"vesselBoats": [VesselBoats],
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
BargeFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BargeFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BargeFormQueryWhere
}
BargeFormQueryWhere
Fields
Example
{
"and": [BargeFormQueryWhere],
"or": [BargeFormQueryWhere],
"rawExpression": "abc123",
"code": StringWhereValueExpression,
"iD": StringWhereValueExpression,
"name": StringWhereValueExpression,
"type": StringWhereValueExpression,
"hullType": StringWhereValueExpression,
"hullArrangement": StringWhereValueExpression,
"serviceArea": StringWhereValueExpression,
"bargeNotes": StringWhereValueExpression,
"ownership": StringWhereValueExpression,
"yearBuilt": NumberWhereValueExpression,
"vapor": NumberWhereValueExpression,
"heat": NumberWhereValueExpression,
"steam": NumberWhereValueExpression,
"inactive": BoolWhereValueExpression,
"tankerBulkType": BargeTankerBulkTypeEnumValueExpression,
"vesselTypeCode": BargeVesselTypeCodeEnumValueExpression,
"referenceNo": StringWhereValueExpression,
"opaDate": DateWhereValueExpression,
"length": NumberWhereValueExpression,
"width": NumberWhereValueExpression,
"height": NumberWhereValueExpression,
"towCapacity": NumberWhereValueExpression,
"registeredTons": NumberWhereValueExpression,
"calibratedBbls": NumberWhereValueExpression,
"dailyCost": NumberWhereValueExpression,
"ballastSpeed": NumberWhereValueExpression,
"ladenSpeed": NumberWhereValueExpression,
"power": NumberWhereValueExpression,
"vetted": NumberWhereValueExpression,
"vettedDate": DateWhereValueExpression,
"vesselType": StringWhereValueExpression,
"fleet": StringWhereValueExpression,
"heatConsumption": NumberWhereValueExpression
}
BargeRelationships
Fields
| Field Name | Description |
|---|---|
vesselBoats - RelationshipDefinition
|
Example
{"vesselBoats": RelationshipDefinition}
BargeTankerBulkTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Tanker"
BargeTankerBulkTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - BargeTankerBulkTypeEnum
|
|
isNot - BargeTankerBulkTypeEnum
|
|
isIn - [BargeTankerBulkTypeEnum]
|
Example
{"is": "Tanker", "isNot": "Tanker", "isIn": ["Tanker"]}
BargeVesselTypeCodeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
BargeVesselTypeCodeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - BargeVesselTypeCodeEnum
|
|
isNot - BargeVesselTypeCodeEnum
|
|
isIn - [BargeVesselTypeCodeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
BenchmarkEstimate
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
manualCO2Price - Boolean
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
manualCO2Qty - Boolean
|
|
manualCO2Currency - Boolean
|
|
manualCO2ExchRate - Boolean
|
|
cO2Qty - Float
|
|
cO2Price - Float
|
|
cO2Currency - String
|
|
cO2ExchRate - Float
|
|
contractType - String
|
|
contractID - Int
|
|
seqNo - Int
|
|
estimateID - String
|
|
tcRoute - String
|
|
correlation - Float
|
|
adjustment - Float
|
|
fronthaul - Boolean
|
|
inbound - Boolean
|
|
selected - Boolean
|
|
splitExposureRouteFormula - Boolean
|
|
manualCO2PriceInternal - Boolean
|
|
manualCO2QtyInternal - Boolean
|
|
manualCO2CurrencyInternal - Boolean
|
|
manualCO2ExchRateInternal - Boolean
|
|
offsetMonths - Int
|
|
savedDays - Float
|
|
cO2Symbol - String
|
|
benchmarkCO2Qty - Float
|
|
benchmarkCO2Price - Float
|
|
benchmarkCO2Currency - String
|
|
benchmarkCO2ExchRate - Float
|
|
voyageEstimate - VoyageEstimate
|
|
benchmarkEstimateBunkers - [BenchmarkEstimateBunker]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"manualCO2Price": true,
"customFieldByID": Any,
"customField": Any,
"manualCO2Qty": true,
"manualCO2Currency": false,
"manualCO2ExchRate": false,
"cO2Qty": 123.45,
"cO2Price": 123.45,
"cO2Currency": "abc123",
"cO2ExchRate": 123.45,
"contractType": "xyz789",
"contractID": 123,
"seqNo": 123,
"estimateID": "xyz789",
"tcRoute": "abc123",
"correlation": 123.45,
"adjustment": 987.65,
"fronthaul": true,
"inbound": false,
"selected": false,
"splitExposureRouteFormula": true,
"manualCO2PriceInternal": true,
"manualCO2QtyInternal": false,
"manualCO2CurrencyInternal": true,
"manualCO2ExchRateInternal": true,
"offsetMonths": 123,
"savedDays": 123.45,
"cO2Symbol": "abc123",
"benchmarkCO2Qty": 123.45,
"benchmarkCO2Price": 123.45,
"benchmarkCO2Currency": "xyz789",
"benchmarkCO2ExchRate": 987.65,
"voyageEstimate": VoyageEstimate,
"benchmarkEstimateBunkers": [BenchmarkEstimateBunker],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
BenchmarkEstimateBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
contractType - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
contractID - Int
|
|
seqNo - Int
|
|
fuelType - String
|
|
symbol - String
|
|
correlation - Float
|
|
adjustment - Float
|
|
rate - Float
|
|
offsetMonths - Int
|
|
benchmarkEstimate - BenchmarkEstimate
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"contractType": "abc123",
"customFieldByID": Any,
"customField": Any,
"contractID": 123,
"seqNo": 123,
"fuelType": "abc123",
"symbol": "xyz789",
"correlation": 123.45,
"adjustment": 987.65,
"rate": 123.45,
"offsetMonths": 987,
"benchmarkEstimate": BenchmarkEstimate,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
BenchmarkEstimateBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BenchmarkEstimateBunkerFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BenchmarkEstimateBunkerFormQueryWhere
}
BenchmarkEstimateBunkerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [BenchmarkEstimateBunkerFormQueryWhere!]
|
|
or - [BenchmarkEstimateBunkerFormQueryWhere!]
|
|
rawExpression - String
|
|
contractType - StringWhereValueExpression
|
|
contractID - NumberWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
symbol - StringWhereValueExpression
|
|
correlation - NumberWhereValueExpression
|
|
adjustment - NumberWhereValueExpression
|
|
rate - NumberWhereValueExpression
|
|
offsetMonths - NumberWhereValueExpression
|
|
benchmarkEstimate - BenchmarkEstimateFormQueryWhere
|
Example
{
"and": [BenchmarkEstimateBunkerFormQueryWhere],
"or": [BenchmarkEstimateBunkerFormQueryWhere],
"rawExpression": "xyz789",
"contractType": StringWhereValueExpression,
"contractID": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"symbol": StringWhereValueExpression,
"correlation": NumberWhereValueExpression,
"adjustment": NumberWhereValueExpression,
"rate": NumberWhereValueExpression,
"offsetMonths": NumberWhereValueExpression,
"benchmarkEstimate": BenchmarkEstimateFormQueryWhere
}
BenchmarkEstimateBunkerRelationships
Fields
| Field Name | Description |
|---|---|
benchmarkEstimate - RelationshipDefinition
|
Example
{"benchmarkEstimate": RelationshipDefinition}
BenchmarkEstimateFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BenchmarkEstimateFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BenchmarkEstimateFormQueryWhere
}
BenchmarkEstimateFormQueryWhere
Fields
Example
{
"and": [BenchmarkEstimateFormQueryWhere],
"or": [BenchmarkEstimateFormQueryWhere],
"rawExpression": "xyz789",
"contractType": StringWhereValueExpression,
"contractID": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"estimateID": StringWhereValueExpression,
"tcRoute": StringWhereValueExpression,
"correlation": NumberWhereValueExpression,
"adjustment": NumberWhereValueExpression,
"fronthaul": BoolWhereValueExpression,
"inbound": BoolWhereValueExpression,
"selected": BoolWhereValueExpression,
"splitExposureRouteFormula": BoolWhereValueExpression,
"manualCO2PriceInternal": BoolWhereValueExpression,
"manualCO2QtyInternal": BoolWhereValueExpression,
"manualCO2CurrencyInternal": BoolWhereValueExpression,
"manualCO2ExchRateInternal": BoolWhereValueExpression,
"offsetMonths": NumberWhereValueExpression,
"savedDays": NumberWhereValueExpression,
"cO2Symbol": StringWhereValueExpression,
"benchmarkCO2Qty": NumberWhereValueExpression,
"benchmarkCO2Price": NumberWhereValueExpression,
"benchmarkCO2Currency": StringWhereValueExpression,
"benchmarkCO2ExchRate": NumberWhereValueExpression,
"voyageEstimate": VoyageEstimateFormQueryWhere
}
BenchmarkEstimateRelationships
Fields
| Field Name | Description |
|---|---|
voyageEstimate - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
benchmarkEstimateBunkers - RelationshipDefinition
|
Example
{
"voyageEstimate": RelationshipDefinition,
"cargo": RelationshipDefinition,
"benchmarkEstimateBunkers": RelationshipDefinition
}
BenchmarkResult
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
worksheetID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
orderNo - Int
|
|
vesselCode - String
|
|
vesselName - String
|
|
estimateID - String
|
|
weight - Float
|
|
qty - Float
|
|
freightRate - Float
|
|
days - Float
|
|
tce - Float
|
|
tceToFreight - Float
|
|
delta - Float
|
|
ratio - Float
|
|
seaPrice - Float
|
|
portPrice - Float
|
|
seaConsPerDay - Float
|
|
portConsPerDay - Float
|
|
basis - Boolean
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
cO2MetricTons - Float
|
|
voyageEstimate - VoyageEstimate
|
|
worksheet - Worksheet
|
|
benchmarkResultBunkers - [BenchmarkResultBunker]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"worksheetID": 987,
"customFieldByID": Any,
"customField": Any,
"orderNo": 123,
"vesselCode": "xyz789",
"vesselName": "xyz789",
"estimateID": "abc123",
"weight": 987.65,
"qty": 123.45,
"freightRate": 123.45,
"days": 123.45,
"tce": 123.45,
"tceToFreight": 123.45,
"delta": 987.65,
"ratio": 987.65,
"seaPrice": 987.65,
"portPrice": 987.65,
"seaConsPerDay": 123.45,
"portConsPerDay": 123.45,
"basis": true,
"entryDateGmt": "2007-12-03",
"lastUser": "xyz789",
"lastUpdateGmt": "2007-12-03",
"cO2MetricTons": 987.65,
"voyageEstimate": VoyageEstimate,
"worksheet": Worksheet,
"benchmarkResultBunkers": [BenchmarkResultBunker],
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
BenchmarkResultBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
worksheetID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
orderNo - Int
|
|
fuelType - String
|
|
price - Float
|
|
consPerDay - Float
|
|
benchmarkResult - BenchmarkResult
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"worksheetID": 123,
"customFieldByID": Any,
"customField": Any,
"orderNo": 987,
"fuelType": "abc123",
"price": 987.65,
"consPerDay": 123.45,
"benchmarkResult": BenchmarkResult,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
BenchmarkResultBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BenchmarkResultBunkerFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BenchmarkResultBunkerFormQueryWhere
}
BenchmarkResultBunkerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [BenchmarkResultBunkerFormQueryWhere!]
|
|
or - [BenchmarkResultBunkerFormQueryWhere!]
|
|
rawExpression - String
|
|
worksheetID - NumberWhereValueExpression
|
|
orderNo - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
price - NumberWhereValueExpression
|
|
consPerDay - NumberWhereValueExpression
|
|
benchmarkResult - BenchmarkResultFormQueryWhere
|
Example
{
"and": [BenchmarkResultBunkerFormQueryWhere],
"or": [BenchmarkResultBunkerFormQueryWhere],
"rawExpression": "abc123",
"worksheetID": NumberWhereValueExpression,
"orderNo": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"price": NumberWhereValueExpression,
"consPerDay": NumberWhereValueExpression,
"benchmarkResult": BenchmarkResultFormQueryWhere
}
BenchmarkResultBunkerRelationships
Fields
| Field Name | Description |
|---|---|
benchmarkResult - RelationshipDefinition
|
Example
{"benchmarkResult": RelationshipDefinition}
BenchmarkResultFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BenchmarkResultFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BenchmarkResultFormQueryWhere
}
BenchmarkResultFormQueryWhere
Fields
Example
{
"and": [BenchmarkResultFormQueryWhere],
"or": [BenchmarkResultFormQueryWhere],
"rawExpression": "xyz789",
"worksheetID": NumberWhereValueExpression,
"orderNo": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"vesselName": StringWhereValueExpression,
"estimateID": StringWhereValueExpression,
"weight": NumberWhereValueExpression,
"qty": NumberWhereValueExpression,
"freightRate": NumberWhereValueExpression,
"days": NumberWhereValueExpression,
"tce": NumberWhereValueExpression,
"tceToFreight": NumberWhereValueExpression,
"delta": NumberWhereValueExpression,
"ratio": NumberWhereValueExpression,
"seaPrice": NumberWhereValueExpression,
"portPrice": NumberWhereValueExpression,
"seaConsPerDay": NumberWhereValueExpression,
"portConsPerDay": NumberWhereValueExpression,
"basis": BoolWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"cO2MetricTons": NumberWhereValueExpression,
"voyageEstimate": VoyageEstimateFormQueryWhere,
"worksheet": WorksheetFormQueryWhere
}
BenchmarkResultRelationships
Fields
| Field Name | Description |
|---|---|
voyageEstimate - RelationshipDefinition
|
|
worksheet - RelationshipDefinition
|
|
benchmarkResultBunkers - RelationshipDefinition
|
Example
{
"voyageEstimate": RelationshipDefinition,
"worksheet": RelationshipDefinition,
"benchmarkResultBunkers": RelationshipDefinition
}
BenchmarkSensitivity
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
worksheetID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
estimateID - String
|
|
orderNo - Int
|
|
seaPrice - Float
|
|
portPrice - Float
|
|
header - Boolean
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
voyageEstimate - VoyageEstimate
|
|
worksheet - Worksheet
|
|
benchmarkSensitivityBunkers - [BenchmarkSensitivityBunker]
|
|
benchmarkSensitivityCalculations - [BenchmarkSensitivityCalculation]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"worksheetID": 987,
"customFieldByID": Any,
"customField": Any,
"estimateID": "xyz789",
"orderNo": 987,
"seaPrice": 123.45,
"portPrice": 123.45,
"header": false,
"entryDateGmt": "2007-12-03",
"lastUser": "abc123",
"lastUpdateGmt": "2007-12-03",
"voyageEstimate": VoyageEstimate,
"worksheet": Worksheet,
"benchmarkSensitivityBunkers": [
BenchmarkSensitivityBunker
],
"benchmarkSensitivityCalculations": [
BenchmarkSensitivityCalculation
],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
BenchmarkSensitivityBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
worksheetID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
estimateID - String
|
|
orderNo - Int
|
|
fuelType - String
|
|
price - Float
|
|
benchmarkSensitivity - BenchmarkSensitivity
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"worksheetID": 123,
"customFieldByID": Any,
"customField": Any,
"estimateID": "xyz789",
"orderNo": 987,
"fuelType": "xyz789",
"price": 123.45,
"benchmarkSensitivity": BenchmarkSensitivity,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
BenchmarkSensitivityBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BenchmarkSensitivityBunkerFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BenchmarkSensitivityBunkerFormQueryWhere
}
BenchmarkSensitivityBunkerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [BenchmarkSensitivityBunkerFormQueryWhere!]
|
|
or - [BenchmarkSensitivityBunkerFormQueryWhere!]
|
|
rawExpression - String
|
|
worksheetID - NumberWhereValueExpression
|
|
estimateID - StringWhereValueExpression
|
|
orderNo - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
price - NumberWhereValueExpression
|
|
benchmarkSensitivity - BenchmarkSensitivityFormQueryWhere
|
Example
{
"and": [BenchmarkSensitivityBunkerFormQueryWhere],
"or": [BenchmarkSensitivityBunkerFormQueryWhere],
"rawExpression": "abc123",
"worksheetID": NumberWhereValueExpression,
"estimateID": StringWhereValueExpression,
"orderNo": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"price": NumberWhereValueExpression,
"benchmarkSensitivity": BenchmarkSensitivityFormQueryWhere
}
BenchmarkSensitivityBunkerRelationships
Fields
| Field Name | Description |
|---|---|
benchmarkSensitivity - RelationshipDefinition
|
Example
{"benchmarkSensitivity": RelationshipDefinition}
BenchmarkSensitivityCalculation
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
worksheetID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
estimateID - String
|
|
orderNo - Int
|
|
seq - Int
|
|
tce - Float
|
|
freightRate - Float
|
|
delta - Float
|
|
ratio - Float
|
|
benchmarkSensitivity - BenchmarkSensitivity
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"worksheetID": 123,
"customFieldByID": Any,
"customField": Any,
"estimateID": "xyz789",
"orderNo": 987,
"seq": 987,
"tce": 123.45,
"freightRate": 123.45,
"delta": 123.45,
"ratio": 123.45,
"benchmarkSensitivity": BenchmarkSensitivity,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
BenchmarkSensitivityCalculationFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BenchmarkSensitivityCalculationFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BenchmarkSensitivityCalculationFormQueryWhere
}
BenchmarkSensitivityCalculationFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [BenchmarkSensitivityCalculationFormQueryWhere!]
|
|
or - [BenchmarkSensitivityCalculationFormQueryWhere!]
|
|
rawExpression - String
|
|
worksheetID - NumberWhereValueExpression
|
|
estimateID - StringWhereValueExpression
|
|
orderNo - NumberWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
tce - NumberWhereValueExpression
|
|
freightRate - NumberWhereValueExpression
|
|
delta - NumberWhereValueExpression
|
|
ratio - NumberWhereValueExpression
|
|
benchmarkSensitivity - BenchmarkSensitivityFormQueryWhere
|
Example
{
"and": [BenchmarkSensitivityCalculationFormQueryWhere],
"or": [BenchmarkSensitivityCalculationFormQueryWhere],
"rawExpression": "abc123",
"worksheetID": NumberWhereValueExpression,
"estimateID": StringWhereValueExpression,
"orderNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"tce": NumberWhereValueExpression,
"freightRate": NumberWhereValueExpression,
"delta": NumberWhereValueExpression,
"ratio": NumberWhereValueExpression,
"benchmarkSensitivity": BenchmarkSensitivityFormQueryWhere
}
BenchmarkSensitivityCalculationRelationships
Fields
| Field Name | Description |
|---|---|
benchmarkSensitivity - RelationshipDefinition
|
Example
{"benchmarkSensitivity": RelationshipDefinition}
BenchmarkSensitivityFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BenchmarkSensitivityFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BenchmarkSensitivityFormQueryWhere
}
BenchmarkSensitivityFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [BenchmarkSensitivityFormQueryWhere!]
|
|
or - [BenchmarkSensitivityFormQueryWhere!]
|
|
rawExpression - String
|
|
worksheetID - NumberWhereValueExpression
|
|
estimateID - StringWhereValueExpression
|
|
orderNo - NumberWhereValueExpression
|
|
seaPrice - NumberWhereValueExpression
|
|
portPrice - NumberWhereValueExpression
|
|
header - BoolWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
voyageEstimate - VoyageEstimateFormQueryWhere
|
|
worksheet - WorksheetFormQueryWhere
|
Example
{
"and": [BenchmarkSensitivityFormQueryWhere],
"or": [BenchmarkSensitivityFormQueryWhere],
"rawExpression": "abc123",
"worksheetID": NumberWhereValueExpression,
"estimateID": StringWhereValueExpression,
"orderNo": NumberWhereValueExpression,
"seaPrice": NumberWhereValueExpression,
"portPrice": NumberWhereValueExpression,
"header": BoolWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"voyageEstimate": VoyageEstimateFormQueryWhere,
"worksheet": WorksheetFormQueryWhere
}
BenchmarkSensitivityRelationships
Fields
| Field Name | Description |
|---|---|
voyageEstimate - RelationshipDefinition
|
|
worksheet - RelationshipDefinition
|
|
benchmarkSensitivityBunkers - RelationshipDefinition
|
|
benchmarkSensitivityCalculations - RelationshipDefinition
|
Example
{
"voyageEstimate": RelationshipDefinition,
"worksheet": RelationshipDefinition,
"benchmarkSensitivityBunkers": RelationshipDefinition,
"benchmarkSensitivityCalculations": RelationshipDefinition
}
BerthBlockage
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
periodStartLocal - Date
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
periodEndLocal - Date
|
|
sqlID - Int
|
|
portNo - Int
|
|
berthShortName - String
|
|
periodStartGmt - Date
|
|
periodEndGmt - Date
|
|
reason - String
|
|
userNotes - String
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
port - Port
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"periodStartLocal": "2007-12-03",
"customFieldByID": Any,
"customField": Any,
"periodEndLocal": "2007-12-03",
"sqlID": 123,
"portNo": 987,
"berthShortName": "xyz789",
"periodStartGmt": "2007-12-03",
"periodEndGmt": "2007-12-03",
"reason": "xyz789",
"userNotes": "abc123",
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"port": Port,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
BerthBlockageFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BerthBlockageFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BerthBlockageFormQueryWhere
}
BerthBlockageFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [BerthBlockageFormQueryWhere!]
|
|
or - [BerthBlockageFormQueryWhere!]
|
|
rawExpression - String
|
|
portNo - NumberWhereValueExpression
|
|
berthShortName - StringWhereValueExpression
|
|
periodStartGmt - DateWhereValueExpression
|
|
periodEndGmt - DateWhereValueExpression
|
|
reason - BerthBlockageReasonEnumValueExpression
|
|
userNotes - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
port - PortFormQueryWhere
|
Example
{
"and": [BerthBlockageFormQueryWhere],
"or": [BerthBlockageFormQueryWhere],
"rawExpression": "xyz789",
"portNo": NumberWhereValueExpression,
"berthShortName": StringWhereValueExpression,
"periodStartGmt": DateWhereValueExpression,
"periodEndGmt": DateWhereValueExpression,
"reason": BerthBlockageReasonEnumValueExpression,
"userNotes": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"port": PortFormQueryWhere
}
BerthBlockageReasonEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
BerthBlockageReasonEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - BerthBlockageReasonEnum
|
|
isNot - BerthBlockageReasonEnum
|
|
isIn - [BerthBlockageReasonEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
BerthBlockageRelationships
Fields
| Field Name | Description |
|---|---|
port - RelationshipDefinition
|
Example
{"port": RelationshipDefinition}
BerthScheduleActivity
Possible Types
| BerthScheduleActivity Types |
|---|
Example
{
"startTime": "2007-12-03",
"endTime": "2007-12-03",
"type": "abc123"
}
BerthScheduleBerth
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
activities - [BerthScheduleActivity]
|
Example
{
"name": "abc123",
"activities": [BerthScheduleActivity]
}
BerthScheduleBlockageActivity
BerthScheduleCargoHandling
BerthScheduleDataRequest
BerthScheduleDataResponse
Fields
| Field Name | Description |
|---|---|
portName - String!
|
|
berths - [BerthScheduleBerth]
|
Example
{
"portName": "xyz789",
"berths": [BerthScheduleBerth]
}
BerthScheduleRootQuery
Fields
| Field Name | Description |
|---|---|
getBerthSchedule - BerthScheduleDataResponse
|
|
Arguments
|
|
Example
{"getBerthSchedule": BerthScheduleDataResponse}
BerthScheduleVesselActivity
Example
{
"startTime": "2007-12-03",
"endTime": "2007-12-03",
"type": "abc123",
"vesselCode": "xyz789",
"voyageNo": 987,
"portCallSeq": 123,
"berthSeq": 987,
"vesselName": "abc123",
"cargoHandlings": [BerthScheduleCargoHandling]
}
BillViaRelationships
Fields
| Field Name | Description |
|---|---|
addressBook - RelationshipDefinition
|
Example
{"addressBook": RelationshipDefinition}
BoolWhereValueExpression
Boolean
Description
The Boolean scalar type represents true or false.
BunkerExposure
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
exposureID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
fuelType - String
|
|
bunkerSymbol - String
|
|
percentage - Float
|
|
quantity - Float
|
|
exposureDate - Date
|
|
correlation - Float
|
|
adjustment - Float
|
|
isCorrManuallyUpdated - Boolean
|
|
isAdjManuallyUpdated - Boolean
|
|
cargoID - Int
|
|
tradeID - Int
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUserID - String
|
|
portNo - Int
|
|
portName - String
|
|
basisSymbol - String
|
|
basisRate - Float
|
|
cargo - Cargo
|
|
paperTrade - PaperTrade
|
|
fuelLubeType - FuelLubeType
|
|
tradeType - TradeType
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"exposureID": 123,
"customFieldByID": Any,
"customField": Any,
"fuelType": "xyz789",
"bunkerSymbol": "abc123",
"percentage": 123.45,
"quantity": 123.45,
"exposureDate": "2007-12-03",
"correlation": 123.45,
"adjustment": 123.45,
"isCorrManuallyUpdated": true,
"isAdjManuallyUpdated": false,
"cargoID": 123,
"tradeID": 123,
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUserID": "abc123",
"portNo": 987,
"portName": "abc123",
"basisSymbol": "xyz789",
"basisRate": 987.65,
"cargo": Cargo,
"paperTrade": PaperTrade,
"fuelLubeType": FuelLubeType,
"tradeType": TradeType,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
BunkerExposureFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BunkerExposureFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BunkerExposureFormQueryWhere
}
BunkerExposureFormQueryWhere
Fields
Example
{
"and": [BunkerExposureFormQueryWhere],
"or": [BunkerExposureFormQueryWhere],
"rawExpression": "xyz789",
"exposureID": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"bunkerSymbol": StringWhereValueExpression,
"percentage": NumberWhereValueExpression,
"quantity": NumberWhereValueExpression,
"exposureDate": DateWhereValueExpression,
"correlation": NumberWhereValueExpression,
"adjustment": NumberWhereValueExpression,
"isCorrManuallyUpdated": BoolWhereValueExpression,
"isAdjManuallyUpdated": BoolWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"tradeID": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"portNo": NumberWhereValueExpression,
"portName": StringWhereValueExpression,
"basisSymbol": StringWhereValueExpression,
"basisRate": NumberWhereValueExpression,
"cargo": CargoFormQueryWhere,
"paperTrade": PaperTradeFormQueryWhere,
"fuelLubeType": FuelLubeTypeFormQueryWhere,
"tradeType": TradeTypeFormQueryWhere
}
BunkerExposureRelationships
Fields
| Field Name | Description |
|---|---|
cargo - RelationshipDefinition
|
|
paperTrade - RelationshipDefinition
|
|
fuelLubeType - RelationshipDefinition
|
|
tradeType - RelationshipDefinition
|
Example
{
"cargo": RelationshipDefinition,
"paperTrade": RelationshipDefinition,
"fuelLubeType": RelationshipDefinition,
"tradeType": RelationshipDefinition
}
BunkerInquiriesAndPurchases
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
localUTCOffset - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
purchaseStatus - String
|
|
status - String
|
|
bunkerTypes - String
|
|
bunkerQtys - String
|
|
bunkerMinQtys - String
|
|
bunkerMaxQtys - String
|
|
bunkerCosts - String
|
|
bunkerPrices - String
|
|
bunkerBunkerwireSpotPrices - String
|
|
bunkerBunkerwireBenchmarkPrices - String
|
|
paymentDueDateLocal - Date
|
|
isInquiry - Boolean
|
|
isOrdered - Boolean
|
|
addressCommissionInvoiceNo - String
|
|
addressCommissionAmountBase - Float
|
|
addressCommissionAmountCurr - Float
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
itinerarySeq - Int
|
|
inquiryNo - Int
|
|
parentRequestID - Int
|
|
brokerShortName - String
|
|
vendorShortName - String
|
|
inqBargeRateCurr - Float
|
|
inqBargeCostCurr - Float
|
|
inqTotalCostCurr - Float
|
|
inqTaxPercent - Float
|
|
inqTaxTotalCurr - Float
|
|
inqPortChargesCurr - Float
|
|
inqOtherChargesCurr - Float
|
|
inqGrandChargesCurr - Float
|
|
portNo - Int
|
|
lastUser - String
|
|
specialInstructions - String
|
|
isTrader - Boolean
|
|
isTcoBunkerForOwner - Boolean
|
|
isCommissionByPercent - Boolean
|
|
isCommisionPerTon - Boolean
|
|
isProratedByQty - Boolean
|
|
isFuture - Boolean
|
|
isIndexLinked - Boolean
|
|
statusInternal - String
|
|
requestID - Int
|
|
orderDateLocal - Date
|
|
orderByUser - String
|
|
lastUpdateGmt - Date
|
|
purchaseOrderNo - String
|
|
purchaseType - String
|
|
supplierShortName - String
|
|
brokerType - String
|
|
comments - String
|
|
curr - String
|
|
exchangeRate - Float
|
|
bargingRateCurr - Float
|
|
bargeCostCurr - Float
|
|
totalCurr - Float
|
|
totalTaxCurr - Float
|
|
portChargesCurr - Float
|
|
otherCostCurr - Float
|
|
grandTotalCurr - Float
|
|
paymentTermsCode - String
|
|
windowFromDateLocal - Date
|
|
windowToDateLocal - Date
|
|
thirdPartyType - String
|
|
thirdPartyShortName - String
|
|
externalRef - String
|
|
strategy - String
|
|
tradeAreaNo - Int
|
|
vesselType - String
|
|
fuelFactorSetID - Int
|
|
paymentTerm - PaymentTerm
|
|
broker - AddressBook
|
|
bunkerRequirement - BunkerRequirement
|
|
voyageItinerary - VoyageItinerary
|
|
voyage - Voyage
|
|
vessel - Vessel
|
|
vendor - AddressBook
|
|
supplier - AddressBook
|
|
trader - AddressBook
|
|
bunkerInvoice - BunkerInvoice
|
|
firstOperationsInvoiceDetailsAddComm - OperationsInvoiceDetails
|
|
port - Port
|
|
bunkerInquiriesAndPurchasesDetails - [BunkerInquiriesAndPurchasesDetail]
|
|
voyageBunkerLiftings - [VoyageBunkerLifting]
|
|
bunkerInquiriesAndPurchasesBunkers - [BunkerInquiriesAndPurchasesBunker]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"localUTCOffset": "xyz789",
"customFieldByID": Any,
"customField": Any,
"purchaseStatus": "abc123",
"status": "abc123",
"bunkerTypes": "xyz789",
"bunkerQtys": "abc123",
"bunkerMinQtys": "abc123",
"bunkerMaxQtys": "xyz789",
"bunkerCosts": "abc123",
"bunkerPrices": "xyz789",
"bunkerBunkerwireSpotPrices": "abc123",
"bunkerBunkerwireBenchmarkPrices": "abc123",
"paymentDueDateLocal": "2007-12-03",
"isInquiry": false,
"isOrdered": true,
"addressCommissionInvoiceNo": "xyz789",
"addressCommissionAmountBase": 987.65,
"addressCommissionAmountCurr": 987.65,
"vesselCode": "abc123",
"voyageNo": 987,
"itinerarySeq": 987,
"inquiryNo": 123,
"parentRequestID": 987,
"brokerShortName": "xyz789",
"vendorShortName": "xyz789",
"inqBargeRateCurr": 987.65,
"inqBargeCostCurr": 123.45,
"inqTotalCostCurr": 987.65,
"inqTaxPercent": 123.45,
"inqTaxTotalCurr": 123.45,
"inqPortChargesCurr": 123.45,
"inqOtherChargesCurr": 123.45,
"inqGrandChargesCurr": 987.65,
"portNo": 987,
"lastUser": "xyz789",
"specialInstructions": "xyz789",
"isTrader": false,
"isTcoBunkerForOwner": true,
"isCommissionByPercent": true,
"isCommisionPerTon": false,
"isProratedByQty": false,
"isFuture": false,
"isIndexLinked": false,
"statusInternal": "abc123",
"requestID": 987,
"orderDateLocal": "2007-12-03",
"orderByUser": "xyz789",
"lastUpdateGmt": "2007-12-03",
"purchaseOrderNo": "xyz789",
"purchaseType": "xyz789",
"supplierShortName": "xyz789",
"brokerType": "xyz789",
"comments": "abc123",
"curr": "xyz789",
"exchangeRate": 123.45,
"bargingRateCurr": 987.65,
"bargeCostCurr": 123.45,
"totalCurr": 123.45,
"totalTaxCurr": 123.45,
"portChargesCurr": 123.45,
"otherCostCurr": 123.45,
"grandTotalCurr": 987.65,
"paymentTermsCode": "xyz789",
"windowFromDateLocal": "2007-12-03",
"windowToDateLocal": "2007-12-03",
"thirdPartyType": "xyz789",
"thirdPartyShortName": "xyz789",
"externalRef": "abc123",
"strategy": "abc123",
"tradeAreaNo": 987,
"vesselType": "abc123",
"fuelFactorSetID": 987,
"paymentTerm": PaymentTerm,
"broker": AddressBook,
"bunkerRequirement": BunkerRequirement,
"voyageItinerary": VoyageItinerary,
"voyage": Voyage,
"vessel": Vessel,
"vendor": AddressBook,
"supplier": AddressBook,
"trader": AddressBook,
"bunkerInvoice": BunkerInvoice,
"firstOperationsInvoiceDetailsAddComm": OperationsInvoiceDetails,
"port": Port,
"bunkerInquiriesAndPurchasesDetails": [
BunkerInquiriesAndPurchasesDetail
],
"voyageBunkerLiftings": [VoyageBunkerLifting],
"bunkerInquiriesAndPurchasesBunkers": [
BunkerInquiriesAndPurchasesBunker
],
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
BunkerInquiriesAndPurchasesBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
requestID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
fuelType - String
|
|
cost - Float
|
|
price - Float
|
|
bunkerwireSpotPrice - Float
|
|
bunkerwireBenchmarkPrice - Float
|
|
qty - Float
|
|
minQty - Float
|
|
maxQty - Float
|
|
priceCurr - Float
|
|
costCurr - Float
|
|
bunkerwireSpotPriceCurr - Float
|
|
bunkerwireBenchmarkPriceCurr - Float
|
|
deliveredQty - Float
|
|
bunkeringStartLocal - Date
|
|
bunkeringEndLocal - Date
|
|
cancellationFee - Float
|
|
cancellationFeeCurr - Float
|
|
bunkerInquiriesAndPurchases - BunkerInquiriesAndPurchases
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"requestID": 123,
"customFieldByID": Any,
"customField": Any,
"fuelType": "abc123",
"cost": 123.45,
"price": 987.65,
"bunkerwireSpotPrice": 987.65,
"bunkerwireBenchmarkPrice": 123.45,
"qty": 987.65,
"minQty": 987.65,
"maxQty": 123.45,
"priceCurr": 987.65,
"costCurr": 123.45,
"bunkerwireSpotPriceCurr": 123.45,
"bunkerwireBenchmarkPriceCurr": 123.45,
"deliveredQty": 987.65,
"bunkeringStartLocal": "2007-12-03",
"bunkeringEndLocal": "2007-12-03",
"cancellationFee": 123.45,
"cancellationFeeCurr": 123.45,
"bunkerInquiriesAndPurchases": BunkerInquiriesAndPurchases,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
BunkerInquiriesAndPurchasesBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BunkerInquiriesAndPurchasesBunkerFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BunkerInquiriesAndPurchasesBunkerFormQueryWhere
}
BunkerInquiriesAndPurchasesBunkerFormQueryWhere
Fields
Example
{
"and": [
BunkerInquiriesAndPurchasesBunkerFormQueryWhere
],
"or": [BunkerInquiriesAndPurchasesBunkerFormQueryWhere],
"rawExpression": "xyz789",
"requestID": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"cost": NumberWhereValueExpression,
"price": NumberWhereValueExpression,
"bunkerwireSpotPrice": NumberWhereValueExpression,
"bunkerwireBenchmarkPrice": NumberWhereValueExpression,
"qty": NumberWhereValueExpression,
"minQty": NumberWhereValueExpression,
"maxQty": NumberWhereValueExpression,
"priceCurr": NumberWhereValueExpression,
"costCurr": NumberWhereValueExpression,
"bunkerwireSpotPriceCurr": NumberWhereValueExpression,
"bunkerwireBenchmarkPriceCurr": NumberWhereValueExpression,
"deliveredQty": NumberWhereValueExpression,
"bunkeringStartLocal": DateWhereValueExpression,
"bunkeringEndLocal": DateWhereValueExpression,
"cancellationFee": NumberWhereValueExpression,
"cancellationFeeCurr": NumberWhereValueExpression,
"bunkerInquiriesAndPurchases": BunkerInquiriesAndPurchasesFormQueryWhere
}
BunkerInquiriesAndPurchasesBunkerRelationships
Fields
| Field Name | Description |
|---|---|
bunkerInquiriesAndPurchases - RelationshipDefinition
|
Example
{"bunkerInquiriesAndPurchases": RelationshipDefinition}
BunkerInquiriesAndPurchasesDetail
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
claims - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
fossilQty - Float
|
|
biofuelQty - Float
|
|
requestID - Int
|
|
deliveredQty - Float
|
|
preTestReceivedDate - Date
|
|
density - Float
|
|
bunkeringTime - Int
|
|
bunkeringRate - Float
|
|
densityDifference - Float
|
|
amountDifferenceBase - Float
|
|
claimAmountBase - Float
|
|
bargeName - String
|
|
bargeArrivalDateGmt - Date
|
|
bargeDepartureDateGmt - Date
|
|
bunkeringCommenceDateGmt - Date
|
|
bunkeringCompleteDateGmt - Date
|
|
claimNote - String
|
|
isDensityClaim - Boolean
|
|
isOffspecClaim - Boolean
|
|
isShortageClaim - Boolean
|
|
isDemurrageClaim - Boolean
|
|
isPreTestRequired - Boolean
|
|
isPostTestRequired - Boolean
|
|
isCancelled - Boolean
|
|
fuelType - String
|
|
preTestDays - Int
|
|
postTestDays - Int
|
|
postTestReceivedDate - Date
|
|
cancellationFeeBase - Float
|
|
cancellationFeeCurr - Float
|
|
preTestViscosity - Float
|
|
postTestViscosity - Float
|
|
bunkerInquiriesAndPurchases - BunkerInquiriesAndPurchases
|
|
supplier - AddressBook
|
|
fuelEmissionsFactorsSet - FuelEmissionsFactorsSet
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"claims": "xyz789",
"customFieldByID": Any,
"customField": Any,
"fossilQty": 987.65,
"biofuelQty": 123.45,
"requestID": 987,
"deliveredQty": 987.65,
"preTestReceivedDate": "2007-12-03",
"density": 987.65,
"bunkeringTime": 987,
"bunkeringRate": 123.45,
"densityDifference": 123.45,
"amountDifferenceBase": 987.65,
"claimAmountBase": 987.65,
"bargeName": "xyz789",
"bargeArrivalDateGmt": "2007-12-03",
"bargeDepartureDateGmt": "2007-12-03",
"bunkeringCommenceDateGmt": "2007-12-03",
"bunkeringCompleteDateGmt": "2007-12-03",
"claimNote": "xyz789",
"isDensityClaim": false,
"isOffspecClaim": false,
"isShortageClaim": true,
"isDemurrageClaim": false,
"isPreTestRequired": false,
"isPostTestRequired": false,
"isCancelled": true,
"fuelType": "xyz789",
"preTestDays": 123,
"postTestDays": 987,
"postTestReceivedDate": "2007-12-03",
"cancellationFeeBase": 123.45,
"cancellationFeeCurr": 987.65,
"preTestViscosity": 987.65,
"postTestViscosity": 123.45,
"bunkerInquiriesAndPurchases": BunkerInquiriesAndPurchases,
"supplier": AddressBook,
"fuelEmissionsFactorsSet": FuelEmissionsFactorsSet,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
BunkerInquiriesAndPurchasesDetailFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BunkerInquiriesAndPurchasesDetailFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BunkerInquiriesAndPurchasesDetailFormQueryWhere
}
BunkerInquiriesAndPurchasesDetailFormQueryWhere
Fields
Example
{
"and": [
BunkerInquiriesAndPurchasesDetailFormQueryWhere
],
"or": [BunkerInquiriesAndPurchasesDetailFormQueryWhere],
"rawExpression": "abc123",
"requestID": NumberWhereValueExpression,
"deliveredQty": NumberWhereValueExpression,
"preTestReceivedDate": DateWhereValueExpression,
"density": NumberWhereValueExpression,
"bunkeringTime": NumberWhereValueExpression,
"bunkeringRate": NumberWhereValueExpression,
"densityDifference": NumberWhereValueExpression,
"amountDifferenceBase": NumberWhereValueExpression,
"claimAmountBase": NumberWhereValueExpression,
"bargeName": StringWhereValueExpression,
"bargeArrivalDateGmt": DateWhereValueExpression,
"bargeDepartureDateGmt": DateWhereValueExpression,
"bunkeringCommenceDateGmt": DateWhereValueExpression,
"bunkeringCompleteDateGmt": DateWhereValueExpression,
"claimNote": StringWhereValueExpression,
"isDensityClaim": BoolWhereValueExpression,
"isOffspecClaim": BoolWhereValueExpression,
"isShortageClaim": BoolWhereValueExpression,
"isDemurrageClaim": BoolWhereValueExpression,
"isPreTestRequired": BoolWhereValueExpression,
"isPostTestRequired": BoolWhereValueExpression,
"isCancelled": BoolWhereValueExpression,
"fuelType": StringWhereValueExpression,
"preTestDays": NumberWhereValueExpression,
"postTestDays": NumberWhereValueExpression,
"postTestReceivedDate": DateWhereValueExpression,
"cancellationFeeBase": NumberWhereValueExpression,
"cancellationFeeCurr": NumberWhereValueExpression,
"preTestViscosity": NumberWhereValueExpression,
"postTestViscosity": NumberWhereValueExpression,
"bunkerInquiriesAndPurchases": BunkerInquiriesAndPurchasesFormQueryWhere,
"supplier": AddressBookFormQueryWhere,
"fuelEmissionsFactorsSet": FuelEmissionsFactorsSetFormQueryWhere
}
BunkerInquiriesAndPurchasesDetailRelationships
Fields
| Field Name | Description |
|---|---|
bunkerInquiriesAndPurchases - RelationshipDefinition
|
|
bunkerRequirementBunker - RelationshipDefinition
|
|
bunkerInquiriesAndPurchasesBunker - RelationshipDefinition
|
|
bunkerInvoiceBunker - RelationshipDefinition
|
|
bunkerInvoiceDetailFuelBasic - RelationshipDefinition
|
|
supplier - RelationshipDefinition
|
|
fuelEmissionsFactorsSet - RelationshipDefinition
|
|
bunkerInquiriesAndPurchasesBunkers - RelationshipDefinition
|
Example
{
"bunkerInquiriesAndPurchases": RelationshipDefinition,
"bunkerRequirementBunker": RelationshipDefinition,
"bunkerInquiriesAndPurchasesBunker": RelationshipDefinition,
"bunkerInvoiceBunker": RelationshipDefinition,
"bunkerInvoiceDetailFuelBasic": RelationshipDefinition,
"supplier": RelationshipDefinition,
"fuelEmissionsFactorsSet": RelationshipDefinition,
"bunkerInquiriesAndPurchasesBunkers": RelationshipDefinition
}
BunkerInquiriesAndPurchasesFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BunkerInquiriesAndPurchasesFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BunkerInquiriesAndPurchasesFormQueryWhere
}
BunkerInquiriesAndPurchasesFormQueryWhere
Fields
Example
{
"and": [BunkerInquiriesAndPurchasesFormQueryWhere],
"or": [BunkerInquiriesAndPurchasesFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"itinerarySeq": NumberWhereValueExpression,
"inquiryNo": NumberWhereValueExpression,
"parentRequestID": NumberWhereValueExpression,
"brokerShortName": StringWhereValueExpression,
"vendorShortName": StringWhereValueExpression,
"inqBargeRateCurr": NumberWhereValueExpression,
"inqBargeCostCurr": NumberWhereValueExpression,
"inqTotalCostCurr": NumberWhereValueExpression,
"inqTaxPercent": NumberWhereValueExpression,
"inqTaxTotalCurr": NumberWhereValueExpression,
"inqPortChargesCurr": NumberWhereValueExpression,
"inqOtherChargesCurr": NumberWhereValueExpression,
"inqGrandChargesCurr": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"specialInstructions": StringWhereValueExpression,
"isTrader": BoolWhereValueExpression,
"isTcoBunkerForOwner": BoolWhereValueExpression,
"isCommissionByPercent": BoolWhereValueExpression,
"isCommisionPerTon": BoolWhereValueExpression,
"isProratedByQty": BoolWhereValueExpression,
"isFuture": BoolWhereValueExpression,
"isIndexLinked": BoolWhereValueExpression,
"statusInternal": StringWhereValueExpression,
"requestID": NumberWhereValueExpression,
"orderDateLocal": DateWhereValueExpression,
"orderByUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"purchaseOrderNo": StringWhereValueExpression,
"purchaseType": StringWhereValueExpression,
"supplierShortName": StringWhereValueExpression,
"brokerType": StringWhereValueExpression,
"comments": StringWhereValueExpression,
"curr": StringWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"bargingRateCurr": NumberWhereValueExpression,
"bargeCostCurr": NumberWhereValueExpression,
"totalCurr": NumberWhereValueExpression,
"totalTaxCurr": NumberWhereValueExpression,
"portChargesCurr": NumberWhereValueExpression,
"otherCostCurr": NumberWhereValueExpression,
"grandTotalCurr": NumberWhereValueExpression,
"paymentTermsCode": StringWhereValueExpression,
"windowFromDateLocal": DateWhereValueExpression,
"windowToDateLocal": DateWhereValueExpression,
"thirdPartyType": StringWhereValueExpression,
"thirdPartyShortName": StringWhereValueExpression,
"externalRef": StringWhereValueExpression,
"strategy": StringWhereValueExpression,
"tradeAreaNo": NumberWhereValueExpression,
"vesselType": StringWhereValueExpression,
"fuelFactorSetID": NumberWhereValueExpression,
"paymentTerm": PaymentTermFormQueryWhere,
"broker": AddressBookFormQueryWhere,
"bunkerRequirement": BunkerRequirementFormQueryWhere,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"vessel": VesselFormQueryWhere,
"vendor": AddressBookFormQueryWhere,
"supplier": AddressBookFormQueryWhere,
"trader": AddressBookFormQueryWhere,
"bunkerInvoice": BunkerInvoiceFormQueryWhere,
"firstOperationsInvoiceDetailsAddComm": OperationsInvoiceDetailsFormQueryWhere,
"port": PortFormQueryWhere
}
BunkerInquiriesAndPurchasesRelationships
Fields
| Field Name | Description |
|---|---|
paymentTerm - RelationshipDefinition
|
|
broker - RelationshipDefinition
|
|
bunkerRequirement - RelationshipDefinition
|
|
voyageItinerary - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
vendor - RelationshipDefinition
|
|
supplier - RelationshipDefinition
|
|
trader - RelationshipDefinition
|
|
bunkerInvoice - RelationshipDefinition
|
|
firstOperationsInvoiceDetailsAddComm - RelationshipDefinition
|
|
port - RelationshipDefinition
|
|
bunkerInquiriesAndPurchasesDetails - RelationshipDefinition
|
|
voyageBunkerLiftings - RelationshipDefinition
|
|
bunkerInquiriesAndPurchasesBunkers - RelationshipDefinition
|
Example
{
"paymentTerm": RelationshipDefinition,
"broker": RelationshipDefinition,
"bunkerRequirement": RelationshipDefinition,
"voyageItinerary": RelationshipDefinition,
"voyage": RelationshipDefinition,
"vessel": RelationshipDefinition,
"vendor": RelationshipDefinition,
"supplier": RelationshipDefinition,
"trader": RelationshipDefinition,
"bunkerInvoice": RelationshipDefinition,
"firstOperationsInvoiceDetailsAddComm": RelationshipDefinition,
"port": RelationshipDefinition,
"bunkerInquiriesAndPurchasesDetails": RelationshipDefinition,
"voyageBunkerLiftings": RelationshipDefinition,
"bunkerInquiriesAndPurchasesBunkers": RelationshipDefinition
}
BunkerInvoice
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
invoiceBasicCost - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
invoiceBargingCost - Float
|
|
invoiceOtherCost - Float
|
|
invoiceOtherPrice - Float
|
|
invoicePortCost - Float
|
|
invoiceGstPercent - Float
|
|
invoicePstPercent - Float
|
|
invoiceSalesTax - Float
|
|
hasLinkedBunkerPurchases - Boolean
|
|
companyCode - String
|
|
invoiceDate - Date
|
|
dueDate - Date
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
itinerarySeq - Int
|
|
oprDateGmt - Date
|
|
vendorShortName - String
|
|
transNo - Int
|
|
berthShortName - String
|
|
brokerShortName - String
|
|
payingCompanyShortName - String
|
|
accountNo - String
|
|
lastUpdateGmt - Date
|
|
portNo - Int
|
|
invoiceDateInternal - Date
|
|
deliveryDate - Date
|
|
dueDateInternal - Date
|
|
lastUser - String
|
|
inquiryNo - Int
|
|
requirementID - Int
|
|
operationsInvoice - OperationsInvoice
|
|
port - Port
|
|
voyageItinerary - VoyageItinerary
|
|
voyage - Voyage
|
|
vessel - Vessel
|
|
broker - AddressBook
|
|
vendor - AddressBook
|
|
payingCompany - AddressBook
|
|
bunkerRequirement - BunkerRequirement
|
|
operationsInvoiceVendor - OperationsInvoice
|
|
bunkerInvoiceDetailsGst - OperationsInvoiceDetails
|
|
bunkerInvoiceDetailsPst - OperationsInvoiceDetails
|
|
bunkerInvoiceBunkers - [BunkerInvoiceBunker]
|
|
operationsInvoiceDetailsFuels - [OperationsInvoiceDetails]
|
|
bunkerInvoiceDetailsBasic - [OperationsInvoiceDetails]
|
|
bunkerInvoiceDetailsBarging - [OperationsInvoiceDetails]
|
|
bunkerInvoiceDetailsOther - [OperationsInvoiceDetails]
|
|
bunkerInvoiceDetailsOtherPrice - [OperationsInvoiceDetails]
|
|
bunkerInvoiceDetailsPortCost - [OperationsInvoiceDetails]
|
|
bunkerInvoiceDetailsSalesTax - [OperationsInvoiceDetails]
|
|
linkedBunkerPurchases - [BunkerInquiriesAndPurchases]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"invoiceBasicCost": 123.45,
"customFieldByID": Any,
"customField": Any,
"invoiceBargingCost": 123.45,
"invoiceOtherCost": 987.65,
"invoiceOtherPrice": 123.45,
"invoicePortCost": 987.65,
"invoiceGstPercent": 987.65,
"invoicePstPercent": 123.45,
"invoiceSalesTax": 987.65,
"hasLinkedBunkerPurchases": false,
"companyCode": "abc123",
"invoiceDate": "2007-12-03",
"dueDate": "2007-12-03",
"vesselCode": "xyz789",
"voyageNo": 987,
"itinerarySeq": 987,
"oprDateGmt": "2007-12-03",
"vendorShortName": "xyz789",
"transNo": 123,
"berthShortName": "xyz789",
"brokerShortName": "xyz789",
"payingCompanyShortName": "xyz789",
"accountNo": "xyz789",
"lastUpdateGmt": "2007-12-03",
"portNo": 987,
"invoiceDateInternal": "2007-12-03",
"deliveryDate": "2007-12-03",
"dueDateInternal": "2007-12-03",
"lastUser": "abc123",
"inquiryNo": 987,
"requirementID": 987,
"operationsInvoice": OperationsInvoice,
"port": Port,
"voyageItinerary": VoyageItinerary,
"voyage": Voyage,
"vessel": Vessel,
"broker": AddressBook,
"vendor": AddressBook,
"payingCompany": AddressBook,
"bunkerRequirement": BunkerRequirement,
"operationsInvoiceVendor": OperationsInvoice,
"bunkerInvoiceDetailsGst": OperationsInvoiceDetails,
"bunkerInvoiceDetailsPst": OperationsInvoiceDetails,
"bunkerInvoiceBunkers": [BunkerInvoiceBunker],
"operationsInvoiceDetailsFuels": [
OperationsInvoiceDetails
],
"bunkerInvoiceDetailsBasic": [OperationsInvoiceDetails],
"bunkerInvoiceDetailsBarging": [
OperationsInvoiceDetails
],
"bunkerInvoiceDetailsOther": [OperationsInvoiceDetails],
"bunkerInvoiceDetailsOtherPrice": [
OperationsInvoiceDetails
],
"bunkerInvoiceDetailsPortCost": [
OperationsInvoiceDetails
],
"bunkerInvoiceDetailsSalesTax": [
OperationsInvoiceDetails
],
"linkedBunkerPurchases": [BunkerInquiriesAndPurchases],
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
BunkerInvoiceBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
transNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
fuelType - String
|
|
grade - String
|
|
sulfurPct - Float
|
|
invQty - Float
|
|
chartererQty - Float
|
|
bunkerInvoice - BunkerInvoice
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"transNo": 987,
"customFieldByID": Any,
"customField": Any,
"fuelType": "abc123",
"grade": "xyz789",
"sulfurPct": 123.45,
"invQty": 987.65,
"chartererQty": 987.65,
"bunkerInvoice": BunkerInvoice,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
BunkerInvoiceBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BunkerInvoiceBunkerFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BunkerInvoiceBunkerFormQueryWhere
}
BunkerInvoiceBunkerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [BunkerInvoiceBunkerFormQueryWhere!]
|
|
or - [BunkerInvoiceBunkerFormQueryWhere!]
|
|
rawExpression - String
|
|
transNo - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
grade - StringWhereValueExpression
|
|
sulfurPct - NumberWhereValueExpression
|
|
invQty - NumberWhereValueExpression
|
|
chartererQty - NumberWhereValueExpression
|
|
bunkerInvoice - BunkerInvoiceFormQueryWhere
|
Example
{
"and": [BunkerInvoiceBunkerFormQueryWhere],
"or": [BunkerInvoiceBunkerFormQueryWhere],
"rawExpression": "abc123",
"transNo": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"grade": StringWhereValueExpression,
"sulfurPct": NumberWhereValueExpression,
"invQty": NumberWhereValueExpression,
"chartererQty": NumberWhereValueExpression,
"bunkerInvoice": BunkerInvoiceFormQueryWhere
}
BunkerInvoiceBunkerRelationships
Fields
| Field Name | Description |
|---|---|
bunkerInvoice - RelationshipDefinition
|
Example
{"bunkerInvoice": RelationshipDefinition}
BunkerInvoiceFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BunkerInvoiceFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BunkerInvoiceFormQueryWhere
}
BunkerInvoiceFormQueryWhere
Fields
Example
{
"and": [BunkerInvoiceFormQueryWhere],
"or": [BunkerInvoiceFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"itinerarySeq": NumberWhereValueExpression,
"oprDateGmt": DateWhereValueExpression,
"vendorShortName": StringWhereValueExpression,
"transNo": NumberWhereValueExpression,
"berthShortName": StringWhereValueExpression,
"brokerShortName": StringWhereValueExpression,
"payingCompanyShortName": StringWhereValueExpression,
"accountNo": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"portNo": NumberWhereValueExpression,
"invoiceDateInternal": DateWhereValueExpression,
"deliveryDate": DateWhereValueExpression,
"dueDateInternal": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"inquiryNo": NumberWhereValueExpression,
"requirementID": NumberWhereValueExpression,
"operationsInvoice": OperationsInvoiceFormQueryWhere,
"port": PortFormQueryWhere,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"vessel": VesselFormQueryWhere,
"broker": AddressBookFormQueryWhere,
"vendor": AddressBookFormQueryWhere,
"payingCompany": AddressBookFormQueryWhere,
"bunkerRequirement": BunkerRequirementFormQueryWhere,
"operationsInvoiceVendor": OperationsInvoiceFormQueryWhere,
"bunkerInvoiceDetailsGst": OperationsInvoiceDetailsFormQueryWhere,
"bunkerInvoiceDetailsPst": OperationsInvoiceDetailsFormQueryWhere
}
BunkerInvoiceRelationships
Fields
| Field Name | Description |
|---|---|
operationsInvoice - RelationshipDefinition
|
|
port - RelationshipDefinition
|
|
voyageItinerary - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
broker - RelationshipDefinition
|
|
vendor - RelationshipDefinition
|
|
payingCompany - RelationshipDefinition
|
|
bunkerRequirement - RelationshipDefinition
|
|
operationsInvoiceVendor - RelationshipDefinition
|
|
bunkerInvoiceDetailsGst - RelationshipDefinition
|
|
bunkerInvoiceDetailsPst - RelationshipDefinition
|
|
bunkerInvoiceBunkers - RelationshipDefinition
|
|
operationsInvoiceDetailsFuels - RelationshipDefinition
|
|
bunkerInvoiceDetailsBasic - RelationshipDefinition
|
|
bunkerInvoiceDetailsBarging - RelationshipDefinition
|
|
bunkerInvoiceDetailsOther - RelationshipDefinition
|
|
bunkerInvoiceDetailsOtherPrice - RelationshipDefinition
|
|
bunkerInvoiceDetailsPortCost - RelationshipDefinition
|
|
bunkerInvoiceDetailsSalesTax - RelationshipDefinition
|
|
linkedBunkerPurchases - RelationshipDefinition
|
Example
{
"operationsInvoice": RelationshipDefinition,
"port": RelationshipDefinition,
"voyageItinerary": RelationshipDefinition,
"voyage": RelationshipDefinition,
"vessel": RelationshipDefinition,
"broker": RelationshipDefinition,
"vendor": RelationshipDefinition,
"payingCompany": RelationshipDefinition,
"bunkerRequirement": RelationshipDefinition,
"operationsInvoiceVendor": RelationshipDefinition,
"bunkerInvoiceDetailsGst": RelationshipDefinition,
"bunkerInvoiceDetailsPst": RelationshipDefinition,
"bunkerInvoiceBunkers": RelationshipDefinition,
"operationsInvoiceDetailsFuels": RelationshipDefinition,
"bunkerInvoiceDetailsBasic": RelationshipDefinition,
"bunkerInvoiceDetailsBarging": RelationshipDefinition,
"bunkerInvoiceDetailsOther": RelationshipDefinition,
"bunkerInvoiceDetailsOtherPrice": RelationshipDefinition,
"bunkerInvoiceDetailsPortCost": RelationshipDefinition,
"bunkerInvoiceDetailsSalesTax": RelationshipDefinition,
"linkedBunkerPurchases": RelationshipDefinition
}
BunkerLiftingDetail
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
liftingID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
fuelType - String
|
|
fuelValue - Float
|
|
fuelPrice - Float
|
|
fuelQty - Float
|
|
fuelGrade - String
|
|
priceBase - Float
|
|
voyageBunkerLifting - VoyageBunkerLifting
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"liftingID": 987,
"customFieldByID": Any,
"customField": Any,
"fuelType": "abc123",
"fuelValue": 987.65,
"fuelPrice": 987.65,
"fuelQty": 987.65,
"fuelGrade": "xyz789",
"priceBase": 123.45,
"voyageBunkerLifting": VoyageBunkerLifting,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
BunkerLiftingDetailFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BunkerLiftingDetailFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BunkerLiftingDetailFormQueryWhere
}
BunkerLiftingDetailFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [BunkerLiftingDetailFormQueryWhere!]
|
|
or - [BunkerLiftingDetailFormQueryWhere!]
|
|
rawExpression - String
|
|
liftingID - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
fuelValue - NumberWhereValueExpression
|
|
fuelPrice - NumberWhereValueExpression
|
|
fuelQty - NumberWhereValueExpression
|
|
fuelGrade - StringWhereValueExpression
|
|
priceBase - NumberWhereValueExpression
|
|
voyageBunkerLifting - VoyageBunkerLiftingFormQueryWhere
|
Example
{
"and": [BunkerLiftingDetailFormQueryWhere],
"or": [BunkerLiftingDetailFormQueryWhere],
"rawExpression": "abc123",
"liftingID": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"fuelValue": NumberWhereValueExpression,
"fuelPrice": NumberWhereValueExpression,
"fuelQty": NumberWhereValueExpression,
"fuelGrade": StringWhereValueExpression,
"priceBase": NumberWhereValueExpression,
"voyageBunkerLifting": VoyageBunkerLiftingFormQueryWhere
}
BunkerLiftingDetailRelationships
Fields
| Field Name | Description |
|---|---|
voyageBunkerLifting - RelationshipDefinition
|
Example
{"voyageBunkerLifting": RelationshipDefinition}
BunkerPrice
BunkerPricesRootQuery
Fields
| Field Name | Description |
|---|---|
portBunkerPrices - [PortBunkerPrices]
|
|
Arguments
|
|
Example
{"portBunkerPrices": [PortBunkerPrices]}
BunkerRequirement
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
localUTCOffset - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
fuelTypes - String
|
|
eTA - Date
|
|
eTD - Date
|
|
eTB - Date
|
|
voyagePorts - String
|
|
reqAlert - String
|
|
tradeAreaName - String
|
|
bunkerTypes - String
|
|
bunkerGrades - String
|
|
bunkerReqQtys - String
|
|
bunkerMinReqQtys - String
|
|
bunkerMaxReqQtys - String
|
|
bunkerOprQtys - String
|
|
bunkerAltQtys - String
|
|
bunkerAltUnits - String
|
|
bunkerSulPcnts - String
|
|
sqlID - Int
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
itinerarySeq - Int
|
|
vendorShortName - String
|
|
inquirerShortName - String
|
|
deliveryDateLocal - Date
|
|
lastUser - String
|
|
inspectorShortName - String
|
|
windowFromDateLocal - Date
|
|
windowToDateLocal - Date
|
|
requestID - Int
|
|
portNo - Int
|
|
requestByUser - String
|
|
bunkerManager - String
|
|
requestStatus - String
|
|
procurementStatus - String
|
|
requestNote - String
|
|
bunkeringDetails - String
|
|
lastUpdateGmt - Date
|
|
requestDateLocal - Date
|
|
agentShortName - String
|
|
deliveryType - String
|
|
requestedDeliveryDateLocal - Date
|
|
companyCode - String
|
|
entryDateGmt - Date
|
|
port - Port
|
|
company - Company
|
|
voyageItinerary - VoyageItinerary
|
|
voyage - Voyage
|
|
vessel - Vessel
|
|
tradeArea - TradeArea
|
|
agent - AddressBook
|
|
portActivityFirstAllFast - VoyagePortActivities
|
|
opsCoordinator - ImosUser
|
|
bunkerInquiriesAndPurchases - [BunkerInquiriesAndPurchases]
|
|
voyageItineraries - [VoyageItinerary]
|
|
bunkerRequirementBunkers - [BunkerRequirementBunker]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"localUTCOffset": "abc123",
"customFieldByID": Any,
"customField": Any,
"fuelTypes": "xyz789",
"eTA": "2007-12-03",
"eTD": "2007-12-03",
"eTB": "2007-12-03",
"voyagePorts": "abc123",
"reqAlert": "xyz789",
"tradeAreaName": "xyz789",
"bunkerTypes": "abc123",
"bunkerGrades": "abc123",
"bunkerReqQtys": "abc123",
"bunkerMinReqQtys": "xyz789",
"bunkerMaxReqQtys": "abc123",
"bunkerOprQtys": "abc123",
"bunkerAltQtys": "xyz789",
"bunkerAltUnits": "abc123",
"bunkerSulPcnts": "xyz789",
"sqlID": 987,
"vesselCode": "xyz789",
"voyageNo": 123,
"itinerarySeq": 987,
"vendorShortName": "xyz789",
"inquirerShortName": "abc123",
"deliveryDateLocal": "2007-12-03",
"lastUser": "xyz789",
"inspectorShortName": "xyz789",
"windowFromDateLocal": "2007-12-03",
"windowToDateLocal": "2007-12-03",
"requestID": 987,
"portNo": 987,
"requestByUser": "abc123",
"bunkerManager": "xyz789",
"requestStatus": "xyz789",
"procurementStatus": "xyz789",
"requestNote": "abc123",
"bunkeringDetails": "abc123",
"lastUpdateGmt": "2007-12-03",
"requestDateLocal": "2007-12-03",
"agentShortName": "abc123",
"deliveryType": "xyz789",
"requestedDeliveryDateLocal": "2007-12-03",
"companyCode": "abc123",
"entryDateGmt": "2007-12-03",
"port": Port,
"company": Company,
"voyageItinerary": VoyageItinerary,
"voyage": Voyage,
"vessel": Vessel,
"tradeArea": TradeArea,
"agent": AddressBook,
"portActivityFirstAllFast": VoyagePortActivities,
"opsCoordinator": ImosUser,
"bunkerInquiriesAndPurchases": [
BunkerInquiriesAndPurchases
],
"voyageItineraries": [VoyageItinerary],
"bunkerRequirementBunkers": [BunkerRequirementBunker],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
BunkerRequirementBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
itinerarySeq - Int
|
|
requestID - Int
|
|
fuelType - String
|
|
qty - Float
|
|
seqNo - Int
|
|
price - Float
|
|
unit - String
|
|
isNew - Boolean
|
|
isModified - Boolean
|
|
hasUninvoicedPurch - Boolean
|
|
hasManualCompany - Boolean
|
|
notes - String
|
|
altQty - Float
|
|
altPrice - Float
|
|
altUnit - String
|
|
grade - String
|
|
sulfurPercent - Float
|
|
inqQty - Float
|
|
minQty - Float
|
|
maxQty - Float
|
|
bunkerRequirement - BunkerRequirement
|
|
defaultFuelTypeDetails - FuelLubeType
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 123,
"itinerarySeq": 123,
"requestID": 123,
"fuelType": "xyz789",
"qty": 123.45,
"seqNo": 987,
"price": 123.45,
"unit": "abc123",
"isNew": true,
"isModified": true,
"hasUninvoicedPurch": true,
"hasManualCompany": true,
"notes": "abc123",
"altQty": 123.45,
"altPrice": 123.45,
"altUnit": "abc123",
"grade": "xyz789",
"sulfurPercent": 987.65,
"inqQty": 123.45,
"minQty": 987.65,
"maxQty": 987.65,
"bunkerRequirement": BunkerRequirement,
"defaultFuelTypeDetails": FuelLubeType,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
BunkerRequirementBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BunkerRequirementBunkerFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BunkerRequirementBunkerFormQueryWhere
}
BunkerRequirementBunkerFormQueryWhere
Fields
Example
{
"and": [BunkerRequirementBunkerFormQueryWhere],
"or": [BunkerRequirementBunkerFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"itinerarySeq": NumberWhereValueExpression,
"requestID": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"qty": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"price": NumberWhereValueExpression,
"unit": StringWhereValueExpression,
"isNew": BoolWhereValueExpression,
"isModified": BoolWhereValueExpression,
"hasUninvoicedPurch": BoolWhereValueExpression,
"hasManualCompany": BoolWhereValueExpression,
"notes": StringWhereValueExpression,
"altQty": NumberWhereValueExpression,
"altPrice": NumberWhereValueExpression,
"altUnit": StringWhereValueExpression,
"grade": StringWhereValueExpression,
"sulfurPercent": NumberWhereValueExpression,
"inqQty": NumberWhereValueExpression,
"minQty": NumberWhereValueExpression,
"maxQty": NumberWhereValueExpression,
"bunkerRequirement": BunkerRequirementFormQueryWhere,
"defaultFuelTypeDetails": FuelLubeTypeFormQueryWhere
}
BunkerRequirementBunkerRelationships
Fields
| Field Name | Description |
|---|---|
bunkerRequirement - RelationshipDefinition
|
|
defaultFuelTypeDetails - RelationshipDefinition
|
Example
{
"bunkerRequirement": RelationshipDefinition,
"defaultFuelTypeDetails": RelationshipDefinition
}
BunkerRequirementFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BunkerRequirementFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BunkerRequirementFormQueryWhere
}
BunkerRequirementFormQueryWhere
Fields
Example
{
"and": [BunkerRequirementFormQueryWhere],
"or": [BunkerRequirementFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"itinerarySeq": NumberWhereValueExpression,
"vendorShortName": StringWhereValueExpression,
"inquirerShortName": StringWhereValueExpression,
"deliveryDateLocal": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"inspectorShortName": StringWhereValueExpression,
"windowFromDateLocal": DateWhereValueExpression,
"windowToDateLocal": DateWhereValueExpression,
"requestID": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"requestByUser": StringWhereValueExpression,
"bunkerManager": StringWhereValueExpression,
"requestStatus": BunkerRequirementRequestStatusEnumValueExpression,
"procurementStatus": StringWhereValueExpression,
"requestNote": StringWhereValueExpression,
"bunkeringDetails": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"requestDateLocal": DateWhereValueExpression,
"agentShortName": StringWhereValueExpression,
"deliveryType": StringWhereValueExpression,
"requestedDeliveryDateLocal": DateWhereValueExpression,
"companyCode": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"port": PortFormQueryWhere,
"company": CompanyFormQueryWhere,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"vessel": VesselFormQueryWhere,
"tradeArea": TradeAreaFormQueryWhere,
"agent": AddressBookFormQueryWhere,
"portActivityFirstAllFast": VoyagePortActivitiesFormQueryWhere,
"opsCoordinator": ImosUserFormQueryWhere
}
BunkerRequirementRelationships
Fields
| Field Name | Description |
|---|---|
port - RelationshipDefinition
|
|
company - RelationshipDefinition
|
|
voyageItinerary - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
tradeArea - RelationshipDefinition
|
|
agent - RelationshipDefinition
|
|
portActivityFirstAllFast - RelationshipDefinition
|
|
opsCoordinator - RelationshipDefinition
|
|
firstBunkerRequirementBunker - RelationshipDefinition
|
|
bunkerInquiriesAndPurchases - RelationshipDefinition
|
|
voyageItineraries - RelationshipDefinition
|
|
bunkerRequirementBunkers - RelationshipDefinition
|
Example
{
"port": RelationshipDefinition,
"company": RelationshipDefinition,
"voyageItinerary": RelationshipDefinition,
"voyage": RelationshipDefinition,
"vessel": RelationshipDefinition,
"tradeArea": RelationshipDefinition,
"agent": RelationshipDefinition,
"portActivityFirstAllFast": RelationshipDefinition,
"opsCoordinator": RelationshipDefinition,
"firstBunkerRequirementBunker": RelationshipDefinition,
"bunkerInquiriesAndPurchases": RelationshipDefinition,
"voyageItineraries": RelationshipDefinition,
"bunkerRequirementBunkers": RelationshipDefinition
}
BunkerRequirementRequestStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
BunkerRequirementRequestStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - BunkerRequirementRequestStatusEnum
|
|
isNot - BunkerRequirementRequestStatusEnum
|
|
isIn - [BunkerRequirementRequestStatusEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
BusinessRule
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vendorShortName - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
source - String
|
|
billCode - String
|
|
lobCode - String
|
|
accountCode - String
|
|
creditAccountCode - String
|
|
description - String
|
|
outAccountCode - String
|
|
rebillType - String
|
|
counterpartyCompanyNo - Int
|
|
countryCode - String
|
|
companyNo - Int
|
|
isIntercompany - String
|
|
debitAccountCode - String
|
|
capitalizationAmortization - Boolean
|
|
curr - String
|
|
addressBook - AddressBook
|
|
country - Country
|
|
creditAccount - ChartOfAccounts
|
|
chartOfAccounts - ChartOfAccounts
|
|
lob - Lob
|
|
vendorAddressBook - AddressBook
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vendorShortName": "abc123",
"customFieldByID": Any,
"customField": Any,
"source": "xyz789",
"billCode": "xyz789",
"lobCode": "xyz789",
"accountCode": "abc123",
"creditAccountCode": "abc123",
"description": "abc123",
"outAccountCode": "xyz789",
"rebillType": "abc123",
"counterpartyCompanyNo": 987,
"countryCode": "xyz789",
"companyNo": 123,
"isIntercompany": "xyz789",
"debitAccountCode": "abc123",
"capitalizationAmortization": true,
"curr": "xyz789",
"addressBook": AddressBook,
"country": Country,
"creditAccount": ChartOfAccounts,
"chartOfAccounts": ChartOfAccounts,
"lob": Lob,
"vendorAddressBook": AddressBook,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
BusinessRuleFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - BusinessRuleFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": BusinessRuleFormQueryWhere
}
BusinessRuleFormQueryWhere
Fields
Example
{
"and": [BusinessRuleFormQueryWhere],
"or": [BusinessRuleFormQueryWhere],
"rawExpression": "abc123",
"source": StringWhereValueExpression,
"billCode": StringWhereValueExpression,
"lobCode": StringWhereValueExpression,
"accountCode": StringWhereValueExpression,
"creditAccountCode": StringWhereValueExpression,
"description": StringWhereValueExpression,
"outAccountCode": StringWhereValueExpression,
"rebillType": BusinessRuleRebillTypeEnumValueExpression,
"counterpartyCompanyNo": NumberWhereValueExpression,
"countryCode": StringWhereValueExpression,
"companyNo": NumberWhereValueExpression,
"isIntercompany": StringWhereValueExpression,
"debitAccountCode": StringWhereValueExpression,
"capitalizationAmortization": BoolWhereValueExpression,
"curr": StringWhereValueExpression,
"addressBook": AddressBookFormQueryWhere,
"country": CountryFormQueryWhere,
"creditAccount": ChartOfAccountsFormQueryWhere,
"chartOfAccounts": ChartOfAccountsFormQueryWhere,
"lob": LobFormQueryWhere,
"vendorAddressBook": AddressBookFormQueryWhere
}
BusinessRuleRebillTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Empty"
BusinessRuleRebillTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - BusinessRuleRebillTypeEnum
|
|
isNot - BusinessRuleRebillTypeEnum
|
|
isIn - [BusinessRuleRebillTypeEnum]
|
Example
{"is": "Empty", "isNot": "Empty", "isIn": ["Empty"]}
BusinessRuleRelationships
Fields
| Field Name | Description |
|---|---|
addressBook - RelationshipDefinition
|
|
country - RelationshipDefinition
|
|
creditAccount - RelationshipDefinition
|
|
chartOfAccounts - RelationshipDefinition
|
|
lob - RelationshipDefinition
|
|
vendorAddressBook - RelationshipDefinition
|
Example
{
"addressBook": RelationshipDefinition,
"country": RelationshipDefinition,
"creditAccount": RelationshipDefinition,
"chartOfAccounts": RelationshipDefinition,
"lob": RelationshipDefinition,
"vendorAddressBook": RelationshipDefinition
}
COA
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
coaNo - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
localUTCOffset - String
|
|
statusLabel - String
|
|
vessels - String
|
|
cargos - String
|
|
confirmedLiftings - Int
|
|
unconfirmedLiftings - Int
|
|
undeclaredOptLiftings - Int
|
|
createBookingLabel - String
|
|
unpricedElementRemark - String
|
|
parentCoaID - Int
|
|
contractLevel - String
|
|
sqlID - Int
|
|
cargoShortName - String
|
|
cargoFullName - String
|
|
cpQty - Float
|
|
statusCode - String
|
|
optionPercentage - Float
|
|
optionType - String
|
|
freightType - String
|
|
worldScaleRate - Float
|
|
worldScaleLevel - Float
|
|
freightRate - Float
|
|
lumpsum - Float
|
|
counterpartyShortName - String
|
|
periodFromLocal - Date
|
|
periodToLocal - Date
|
|
demBase - Float
|
|
despatchBase - Float
|
|
demLoadBase - Float
|
|
despatchLoadBase - Float
|
|
contractType - String
|
|
coaID - Int
|
|
saleContractID - Int
|
|
purchaseContractID - Int
|
|
loadPort - String
|
|
dischPort - String
|
|
remarks - String
|
|
supplierShortName - String
|
|
receiverShortName - String
|
|
cargoUnit - String
|
|
curr - String
|
|
annualPriceIndex - Float
|
|
liftings - Int
|
|
lastUpdateGmt - Date
|
|
entryDate - Date
|
|
updateTimes - Int
|
|
lastUser - String
|
|
optionalLiftings - Int
|
|
jobDeliveryPortNo - Int
|
|
scaleTable - Boolean
|
|
useBLDate - Boolean
|
|
useFreightIndexTable - Boolean
|
|
useFreightSurchargeTable - Boolean
|
|
optionFlags - Int
|
|
jobRedeliveryPortNo - Int
|
|
brokerCommPercent - Float
|
|
overtimeRate - Float
|
|
bunkerScaleTable - String
|
|
demScaleTable - String
|
|
laytimeScaleTable - String
|
|
freightScaleTable - String
|
|
masterContractID - String
|
|
optionDateLocal - Date
|
|
tradeAreaNo - Int
|
|
vatNo - String
|
|
vatPercent - Float
|
|
referenceNo - String
|
|
addressCommPercent - Float
|
|
routeCorrelation - Float
|
|
companyCode - String
|
|
cpDate - Date
|
|
cpForm - String
|
|
demCurr - String
|
|
refVoyageRoute - String
|
|
lobCode - String
|
|
minQty - Int
|
|
maxQty - Int
|
|
chtrCoordinator - String
|
|
minLiftings - Int
|
|
liftingPeriod - String
|
|
invoicePercent - Float
|
|
paymentTermsCode - String
|
|
paymentCompanyNo - Int
|
|
paymentCompanySeq - Int
|
|
tradeUnitTemplate - Boolean
|
|
demOnAccountCalendar - Boolean
|
|
transshipmentAppRequired - Boolean
|
|
transshipmentAppReceived - Boolean
|
|
useBookingQtyOnScaleTable - Boolean
|
|
laytimeReversible - Boolean
|
|
isOwnersOption - Boolean
|
|
auxFlags2 - Int
|
|
oblNo - String
|
|
coMingleNo - String
|
|
deadFreightScaleTable - String
|
|
bunkerMarketName - String
|
|
basisEstimateID - String
|
|
trader - String
|
|
timeBarDays - Float
|
|
balancePaymentTermsCode - String
|
|
strategy - String
|
|
norHoursAllowed - Float
|
|
currBase - String
|
|
cpPlace - String
|
|
rebillableWharfage - String
|
|
rebillableDockage - String
|
|
emailSchedule - String
|
|
emailIntervalDays - Int
|
|
segment - String
|
|
departmentNo - Int
|
|
teamNo - Int
|
|
parentMirroredContractID - Int
|
|
childMirroredContractID - Int
|
|
intercompanyContract - Boolean
|
|
intercompanyParentContract - Boolean
|
|
intercompanyChildContract - Boolean
|
|
usesPlanningPeriods - Boolean
|
|
advancedPricing - Boolean
|
|
isParent - Boolean
|
|
isChild - Boolean
|
|
useCommingledQtyOnScaleTable - Boolean
|
|
flags3 - Int
|
|
iCCompanyCode - String
|
|
iCAdjPercent - Float
|
|
actDept - String
|
|
manualTce - Float
|
|
refContract - String
|
|
exposureMethod - String
|
|
contractDays - Float
|
|
routeAdjustment - Float
|
|
benchmarkBasis - String
|
|
bunkerHedging - String
|
|
bunkerHedgedByUser - String
|
|
counterpartyType - String
|
|
initialEstimateID - String
|
|
qtyPerLifting - Float
|
|
mTEquivalentFactor - Float
|
|
contractReference - String
|
|
deadfreightAllowance - Float
|
|
cpDraftInMeter - Float
|
|
correlationProfileName - String
|
|
refBallastPortNo - Int
|
|
refRepositionPortNo - Int
|
|
advancedPricingOverriddenResults - Int
|
|
remittanceBank - String
|
|
entryUserID - String
|
|
cO2Symbol - String
|
|
cO2Qty - Float
|
|
cO2Price - Float
|
|
cO2Currency - String
|
|
cO2ExchRate - Float
|
|
emissionsSettlementType - String
|
|
emissionsBillingPeriod - String
|
|
emissionsPaymentTermsCode - String
|
|
balancePaymentTerm - PaymentTerm
|
|
paymentTerm - PaymentTerm
|
|
refRepositionPort - Port
|
|
refBallastPort - Port
|
|
jobRedeliveryPort - Port
|
|
jobDeliveryPort - Port
|
|
team - Team
|
|
lob - Lob
|
|
company - Company
|
|
initialEstimate - VoyageEstimate
|
|
basisEstimate - VoyageEstimate
|
|
paymentCompany - AddressBookBank
|
|
counterparty - AddressBook
|
|
actDepartment - ActDepartment
|
|
cargoName - CargoName
|
|
tradeArea - TradeArea
|
|
companyAddressBook - AddressBook
|
|
coaUnpricedElementRemark - UnpricedElementRemark
|
|
parentCoa - COA
|
|
unpricedElements - [UnpricedElement]
|
|
coaOptions - [COAOption]
|
|
coaDetails - [COADetails]
|
|
coaItineraries - [COAItinerary]
|
|
coaVessels - [COADetails]
|
|
coaCargos - [COADetails]
|
|
confirmedCargos - [Cargo]
|
|
coaItinLoads - [COAItinerary]
|
|
coaItinDischarges - [COAItinerary]
|
|
coaPeriods - [CoaPeriod]
|
|
benchmarkEstimates - [BenchmarkEstimate]
|
|
coaBrokers - [CoaBroker]
|
|
coaExtraFreightTerms - [COAExtraFreightTerms]
|
|
pricingLines - [StandardRate]
|
|
advancedPricingRuleReport - [DecisionTableRuleReport]
|
|
childCoaLinks - [CoaHierarchy]
|
|
updateCOAMessages - [UpdateCOAMessageRecord]
|
|
Arguments
|
|
changesSinceLast - COAChangesSinceLast
|
|
userDefinedFields - Json
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"coaNo": "xyz789",
"customFieldByID": Any,
"customField": Any,
"localUTCOffset": "abc123",
"statusLabel": "abc123",
"vessels": "abc123",
"cargos": "xyz789",
"confirmedLiftings": 987,
"unconfirmedLiftings": 123,
"undeclaredOptLiftings": 123,
"createBookingLabel": "abc123",
"unpricedElementRemark": "xyz789",
"parentCoaID": 123,
"contractLevel": "xyz789",
"sqlID": 123,
"cargoShortName": "xyz789",
"cargoFullName": "abc123",
"cpQty": 987.65,
"statusCode": "xyz789",
"optionPercentage": 123.45,
"optionType": "xyz789",
"freightType": "xyz789",
"worldScaleRate": 987.65,
"worldScaleLevel": 987.65,
"freightRate": 123.45,
"lumpsum": 987.65,
"counterpartyShortName": "xyz789",
"periodFromLocal": "2007-12-03",
"periodToLocal": "2007-12-03",
"demBase": 123.45,
"despatchBase": 987.65,
"demLoadBase": 123.45,
"despatchLoadBase": 987.65,
"contractType": "xyz789",
"coaID": 987,
"saleContractID": 123,
"purchaseContractID": 123,
"loadPort": "xyz789",
"dischPort": "abc123",
"remarks": "xyz789",
"supplierShortName": "abc123",
"receiverShortName": "xyz789",
"cargoUnit": "xyz789",
"curr": "abc123",
"annualPriceIndex": 123.45,
"liftings": 123,
"lastUpdateGmt": "2007-12-03",
"entryDate": "2007-12-03",
"updateTimes": 123,
"lastUser": "xyz789",
"optionalLiftings": 987,
"jobDeliveryPortNo": 123,
"scaleTable": false,
"useBLDate": true,
"useFreightIndexTable": true,
"useFreightSurchargeTable": true,
"optionFlags": 987,
"jobRedeliveryPortNo": 987,
"brokerCommPercent": 987.65,
"overtimeRate": 123.45,
"bunkerScaleTable": "abc123",
"demScaleTable": "abc123",
"laytimeScaleTable": "abc123",
"freightScaleTable": "abc123",
"masterContractID": "xyz789",
"optionDateLocal": "2007-12-03",
"tradeAreaNo": 987,
"vatNo": "abc123",
"vatPercent": 987.65,
"referenceNo": "abc123",
"addressCommPercent": 123.45,
"routeCorrelation": 123.45,
"companyCode": "abc123",
"cpDate": "2007-12-03",
"cpForm": "xyz789",
"demCurr": "xyz789",
"refVoyageRoute": "abc123",
"lobCode": "xyz789",
"minQty": 987,
"maxQty": 987,
"chtrCoordinator": "abc123",
"minLiftings": 987,
"liftingPeriod": "xyz789",
"invoicePercent": 123.45,
"paymentTermsCode": "abc123",
"paymentCompanyNo": 123,
"paymentCompanySeq": 123,
"tradeUnitTemplate": false,
"demOnAccountCalendar": true,
"transshipmentAppRequired": false,
"transshipmentAppReceived": true,
"useBookingQtyOnScaleTable": false,
"laytimeReversible": false,
"isOwnersOption": false,
"auxFlags2": 123,
"oblNo": "xyz789",
"coMingleNo": "xyz789",
"deadFreightScaleTable": "xyz789",
"bunkerMarketName": "abc123",
"basisEstimateID": "xyz789",
"trader": "xyz789",
"timeBarDays": 123.45,
"balancePaymentTermsCode": "abc123",
"strategy": "abc123",
"norHoursAllowed": 123.45,
"currBase": "xyz789",
"cpPlace": "xyz789",
"rebillableWharfage": "abc123",
"rebillableDockage": "abc123",
"emailSchedule": "xyz789",
"emailIntervalDays": 123,
"segment": "xyz789",
"departmentNo": 987,
"teamNo": 987,
"parentMirroredContractID": 987,
"childMirroredContractID": 987,
"intercompanyContract": false,
"intercompanyParentContract": true,
"intercompanyChildContract": false,
"usesPlanningPeriods": false,
"advancedPricing": true,
"isParent": true,
"isChild": true,
"useCommingledQtyOnScaleTable": false,
"flags3": 987,
"iCCompanyCode": "abc123",
"iCAdjPercent": 987.65,
"actDept": "xyz789",
"manualTce": 123.45,
"refContract": "xyz789",
"exposureMethod": "xyz789",
"contractDays": 123.45,
"routeAdjustment": 123.45,
"benchmarkBasis": "xyz789",
"bunkerHedging": "xyz789",
"bunkerHedgedByUser": "abc123",
"counterpartyType": "xyz789",
"initialEstimateID": "abc123",
"qtyPerLifting": 987.65,
"mTEquivalentFactor": 987.65,
"contractReference": "xyz789",
"deadfreightAllowance": 987.65,
"cpDraftInMeter": 987.65,
"correlationProfileName": "abc123",
"refBallastPortNo": 987,
"refRepositionPortNo": 123,
"advancedPricingOverriddenResults": 987,
"remittanceBank": "xyz789",
"entryUserID": "abc123",
"cO2Symbol": "xyz789",
"cO2Qty": 987.65,
"cO2Price": 123.45,
"cO2Currency": "xyz789",
"cO2ExchRate": 987.65,
"emissionsSettlementType": "abc123",
"emissionsBillingPeriod": "xyz789",
"emissionsPaymentTermsCode": "xyz789",
"balancePaymentTerm": PaymentTerm,
"paymentTerm": PaymentTerm,
"refRepositionPort": Port,
"refBallastPort": Port,
"jobRedeliveryPort": Port,
"jobDeliveryPort": Port,
"team": Team,
"lob": Lob,
"company": Company,
"initialEstimate": VoyageEstimate,
"basisEstimate": VoyageEstimate,
"paymentCompany": AddressBookBank,
"counterparty": AddressBook,
"actDepartment": ActDepartment,
"cargoName": CargoName,
"tradeArea": TradeArea,
"companyAddressBook": AddressBook,
"coaUnpricedElementRemark": UnpricedElementRemark,
"parentCoa": COA,
"unpricedElements": [UnpricedElement],
"coaOptions": [COAOption],
"coaDetails": [COADetails],
"coaItineraries": [COAItinerary],
"coaVessels": [COADetails],
"coaCargos": [COADetails],
"confirmedCargos": [Cargo],
"coaItinLoads": [COAItinerary],
"coaItinDischarges": [COAItinerary],
"coaPeriods": [CoaPeriod],
"benchmarkEstimates": [BenchmarkEstimate],
"coaBrokers": [CoaBroker],
"coaExtraFreightTerms": [COAExtraFreightTerms],
"pricingLines": [StandardRate],
"advancedPricingRuleReport": [DecisionTableRuleReport],
"childCoaLinks": [CoaHierarchy],
"updateCOAMessages": [UpdateCOAMessageRecord],
"changesSinceLast": COAChangesSinceLast,
"userDefinedFields": Json,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
COABenchmarkBasisEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Min"
COABenchmarkBasisEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - COABenchmarkBasisEnum
|
|
isNot - COABenchmarkBasisEnum
|
|
isIn - [COABenchmarkBasisEnum]
|
Example
{"is": "Min", "isNot": "Min", "isIn": ["Min"]}
COAChangesSinceLast
Fields
| Field Name | Description |
|---|---|
updateCOA - MessageUpdateResponse
|
Example
{"updateCOA": MessageUpdateResponse}
COADetails
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
coaID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
type - String
|
|
seqNo - Int
|
|
reference - String
|
|
coa - COA
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"coaID": 987,
"customFieldByID": Any,
"customField": Any,
"type": "abc123",
"seqNo": 987,
"reference": "xyz789",
"coa": COA,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
COADetailsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - COADetailsFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": COADetailsFormQueryWhere
}
COADetailsFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [COADetailsFormQueryWhere!]
|
|
or - [COADetailsFormQueryWhere!]
|
|
rawExpression - String
|
|
coaID - NumberWhereValueExpression
|
|
type - COADetailsTypeEnumValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
reference - StringWhereValueExpression
|
|
coa - COAFormQueryWhere
|
Example
{
"and": [COADetailsFormQueryWhere],
"or": [COADetailsFormQueryWhere],
"rawExpression": "abc123",
"coaID": NumberWhereValueExpression,
"type": COADetailsTypeEnumValueExpression,
"seqNo": NumberWhereValueExpression,
"reference": StringWhereValueExpression,
"coa": COAFormQueryWhere
}
COADetailsRelationships
Fields
| Field Name | Description |
|---|---|
cOA - RelationshipDefinition
|
Example
{"cOA": RelationshipDefinition}
COADetailsTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Undefined"
COADetailsTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - COADetailsTypeEnum
|
|
isNot - COADetailsTypeEnum
|
|
isIn - [COADetailsTypeEnum]
|
Example
{"is": "Undefined", "isNot": "Undefined", "isIn": ["Undefined"]}
COAEmissionsBillingPeriodEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
COAEmissionsBillingPeriodEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - COAEmissionsBillingPeriodEnum
|
|
isNot - COAEmissionsBillingPeriodEnum
|
|
isIn - [COAEmissionsBillingPeriodEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
COAEmissionsSettlementTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NA"
COAEmissionsSettlementTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - COAEmissionsSettlementTypeEnum
|
|
isNot - COAEmissionsSettlementTypeEnum
|
|
isIn - [COAEmissionsSettlementTypeEnum]
|
Example
{"is": "NA", "isNot": "NA", "isIn": ["NA"]}
COAExposureMethodEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"TradeArea"
COAExposureMethodEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - COAExposureMethodEnum
|
|
isNot - COAExposureMethodEnum
|
|
isIn - [COAExposureMethodEnum]
|
Example
{"is": "TradeArea", "isNot": "TradeArea", "isIn": ["TradeArea"]}
COAExtraFreightTerms
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
coaID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
cargoShortName - String
|
|
code - String
|
|
amount - Float
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
priceSeqNo - Int
|
|
scaleTableShortName - String
|
|
scaleTableQtyBasis - String
|
|
coa - COA
|
|
cargoName - CargoName
|
|
freightTerm - FreightTerm
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"coaID": 987,
"customFieldByID": Any,
"customField": Any,
"cargoShortName": "abc123",
"code": "xyz789",
"amount": 123.45,
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123",
"priceSeqNo": 987,
"scaleTableShortName": "abc123",
"scaleTableQtyBasis": "abc123",
"coa": COA,
"cargoName": CargoName,
"freightTerm": FreightTerm,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
COAExtraFreightTermsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - COAExtraFreightTermsFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": COAExtraFreightTermsFormQueryWhere
}
COAExtraFreightTermsFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [COAExtraFreightTermsFormQueryWhere!]
|
|
or - [COAExtraFreightTermsFormQueryWhere!]
|
|
rawExpression - String
|
|
coaID - NumberWhereValueExpression
|
|
cargoShortName - StringWhereValueExpression
|
|
code - StringWhereValueExpression
|
|
amount - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
priceSeqNo - NumberWhereValueExpression
|
|
scaleTableShortName - StringWhereValueExpression
|
|
scaleTableQtyBasis - COAExtraFreightTermsScaleTableQtyBasisEnumValueExpression
|
|
coa - COAFormQueryWhere
|
|
cargoName - CargoNameFormQueryWhere
|
|
freightTerm - FreightTermFormQueryWhere
|
Example
{
"and": [COAExtraFreightTermsFormQueryWhere],
"or": [COAExtraFreightTermsFormQueryWhere],
"rawExpression": "abc123",
"coaID": NumberWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"code": StringWhereValueExpression,
"amount": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"priceSeqNo": NumberWhereValueExpression,
"scaleTableShortName": StringWhereValueExpression,
"scaleTableQtyBasis": COAExtraFreightTermsScaleTableQtyBasisEnumValueExpression,
"coa": COAFormQueryWhere,
"cargoName": CargoNameFormQueryWhere,
"freightTerm": FreightTermFormQueryWhere
}
COAExtraFreightTermsRelationships
Fields
| Field Name | Description |
|---|---|
cOA - RelationshipDefinition
|
|
cargoName - RelationshipDefinition
|
|
freightTerm - RelationshipDefinition
|
Example
{
"cOA": RelationshipDefinition,
"cargoName": RelationshipDefinition,
"freightTerm": RelationshipDefinition
}
COAExtraFreightTermsScaleTableQtyBasisEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CPQty"
COAExtraFreightTermsScaleTableQtyBasisEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - COAExtraFreightTermsScaleTableQtyBasisEnum
|
|
isNot - COAExtraFreightTermsScaleTableQtyBasisEnum
|
|
isIn - [COAExtraFreightTermsScaleTableQtyBasisEnum]
|
Example
{"is": "CPQty", "isNot": "CPQty", "isIn": ["CPQty"]}
COAFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - COAFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": COAFormQueryWhere
}
COAFormQueryWhere
Fields
Example
{
"and": [COAFormQueryWhere],
"or": [COAFormQueryWhere],
"rawExpression": "xyz789",
"coaNo": StringWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"cargoFullName": StringWhereValueExpression,
"cpQty": NumberWhereValueExpression,
"statusCode": COAStatusCodeEnumValueExpression,
"optionPercentage": NumberWhereValueExpression,
"optionType": StringWhereValueExpression,
"freightType": StringWhereValueExpression,
"worldScaleRate": NumberWhereValueExpression,
"worldScaleLevel": NumberWhereValueExpression,
"freightRate": NumberWhereValueExpression,
"lumpsum": NumberWhereValueExpression,
"counterpartyShortName": StringWhereValueExpression,
"periodFromLocal": DateWhereValueExpression,
"periodToLocal": DateWhereValueExpression,
"demBase": NumberWhereValueExpression,
"despatchBase": NumberWhereValueExpression,
"demLoadBase": NumberWhereValueExpression,
"despatchLoadBase": NumberWhereValueExpression,
"contractType": StringWhereValueExpression,
"coaID": NumberWhereValueExpression,
"saleContractID": NumberWhereValueExpression,
"purchaseContractID": NumberWhereValueExpression,
"loadPort": StringWhereValueExpression,
"dischPort": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"supplierShortName": StringWhereValueExpression,
"receiverShortName": StringWhereValueExpression,
"cargoUnit": StringWhereValueExpression,
"curr": StringWhereValueExpression,
"annualPriceIndex": NumberWhereValueExpression,
"liftings": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDate": DateWhereValueExpression,
"updateTimes": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"optionalLiftings": NumberWhereValueExpression,
"jobDeliveryPortNo": NumberWhereValueExpression,
"scaleTable": BoolWhereValueExpression,
"useBLDate": BoolWhereValueExpression,
"useFreightIndexTable": BoolWhereValueExpression,
"useFreightSurchargeTable": BoolWhereValueExpression,
"optionFlags": NumberWhereValueExpression,
"jobRedeliveryPortNo": NumberWhereValueExpression,
"brokerCommPercent": NumberWhereValueExpression,
"overtimeRate": NumberWhereValueExpression,
"bunkerScaleTable": StringWhereValueExpression,
"demScaleTable": StringWhereValueExpression,
"laytimeScaleTable": StringWhereValueExpression,
"freightScaleTable": StringWhereValueExpression,
"masterContractID": StringWhereValueExpression,
"optionDateLocal": DateWhereValueExpression,
"tradeAreaNo": NumberWhereValueExpression,
"vatNo": StringWhereValueExpression,
"vatPercent": NumberWhereValueExpression,
"referenceNo": StringWhereValueExpression,
"addressCommPercent": NumberWhereValueExpression,
"routeCorrelation": NumberWhereValueExpression,
"companyCode": StringWhereValueExpression,
"cpDate": DateWhereValueExpression,
"cpForm": StringWhereValueExpression,
"demCurr": StringWhereValueExpression,
"refVoyageRoute": StringWhereValueExpression,
"lobCode": StringWhereValueExpression,
"minQty": NumberWhereValueExpression,
"maxQty": NumberWhereValueExpression,
"chtrCoordinator": StringWhereValueExpression,
"minLiftings": NumberWhereValueExpression,
"liftingPeriod": COALiftingPeriodEnumValueExpression,
"invoicePercent": NumberWhereValueExpression,
"paymentTermsCode": StringWhereValueExpression,
"paymentCompanyNo": NumberWhereValueExpression,
"paymentCompanySeq": NumberWhereValueExpression,
"tradeUnitTemplate": BoolWhereValueExpression,
"demOnAccountCalendar": BoolWhereValueExpression,
"transshipmentAppRequired": BoolWhereValueExpression,
"transshipmentAppReceived": BoolWhereValueExpression,
"useBookingQtyOnScaleTable": BoolWhereValueExpression,
"laytimeReversible": BoolWhereValueExpression,
"isOwnersOption": BoolWhereValueExpression,
"auxFlags2": NumberWhereValueExpression,
"oblNo": StringWhereValueExpression,
"coMingleNo": StringWhereValueExpression,
"deadFreightScaleTable": StringWhereValueExpression,
"bunkerMarketName": StringWhereValueExpression,
"basisEstimateID": StringWhereValueExpression,
"trader": StringWhereValueExpression,
"timeBarDays": NumberWhereValueExpression,
"balancePaymentTermsCode": StringWhereValueExpression,
"strategy": StringWhereValueExpression,
"norHoursAllowed": NumberWhereValueExpression,
"currBase": StringWhereValueExpression,
"cpPlace": StringWhereValueExpression,
"rebillableWharfage": StringWhereValueExpression,
"rebillableDockage": StringWhereValueExpression,
"emailSchedule": StringWhereValueExpression,
"emailIntervalDays": NumberWhereValueExpression,
"segment": StringWhereValueExpression,
"departmentNo": NumberWhereValueExpression,
"teamNo": NumberWhereValueExpression,
"parentMirroredContractID": NumberWhereValueExpression,
"childMirroredContractID": NumberWhereValueExpression,
"intercompanyContract": BoolWhereValueExpression,
"intercompanyParentContract": BoolWhereValueExpression,
"intercompanyChildContract": BoolWhereValueExpression,
"usesPlanningPeriods": BoolWhereValueExpression,
"advancedPricing": BoolWhereValueExpression,
"isParent": BoolWhereValueExpression,
"isChild": BoolWhereValueExpression,
"useCommingledQtyOnScaleTable": BoolWhereValueExpression,
"flags3": NumberWhereValueExpression,
"iCCompanyCode": StringWhereValueExpression,
"iCAdjPercent": NumberWhereValueExpression,
"actDept": StringWhereValueExpression,
"manualTce": NumberWhereValueExpression,
"refContract": StringWhereValueExpression,
"exposureMethod": COAExposureMethodEnumValueExpression,
"contractDays": NumberWhereValueExpression,
"routeAdjustment": NumberWhereValueExpression,
"benchmarkBasis": COABenchmarkBasisEnumValueExpression,
"bunkerHedging": StringWhereValueExpression,
"bunkerHedgedByUser": StringWhereValueExpression,
"counterpartyType": StringWhereValueExpression,
"initialEstimateID": StringWhereValueExpression,
"qtyPerLifting": NumberWhereValueExpression,
"mTEquivalentFactor": NumberWhereValueExpression,
"contractReference": StringWhereValueExpression,
"deadfreightAllowance": NumberWhereValueExpression,
"cpDraftInMeter": NumberWhereValueExpression,
"correlationProfileName": StringWhereValueExpression,
"refBallastPortNo": NumberWhereValueExpression,
"refRepositionPortNo": NumberWhereValueExpression,
"advancedPricingOverriddenResults": NumberWhereValueExpression,
"remittanceBank": StringWhereValueExpression,
"entryUserID": StringWhereValueExpression,
"cO2Symbol": StringWhereValueExpression,
"cO2Qty": NumberWhereValueExpression,
"cO2Price": NumberWhereValueExpression,
"cO2Currency": StringWhereValueExpression,
"cO2ExchRate": NumberWhereValueExpression,
"emissionsSettlementType": COAEmissionsSettlementTypeEnumValueExpression,
"emissionsBillingPeriod": COAEmissionsBillingPeriodEnumValueExpression,
"emissionsPaymentTermsCode": StringWhereValueExpression,
"balancePaymentTerm": PaymentTermFormQueryWhere,
"paymentTerm": PaymentTermFormQueryWhere,
"refRepositionPort": PortFormQueryWhere,
"refBallastPort": PortFormQueryWhere,
"jobRedeliveryPort": PortFormQueryWhere,
"jobDeliveryPort": PortFormQueryWhere,
"team": TeamFormQueryWhere,
"lob": LobFormQueryWhere,
"company": CompanyFormQueryWhere,
"initialEstimate": VoyageEstimateFormQueryWhere,
"basisEstimate": VoyageEstimateFormQueryWhere,
"paymentCompany": AddressBookBankFormQueryWhere,
"counterparty": AddressBookFormQueryWhere,
"actDepartment": ActDepartmentFormQueryWhere,
"cargoName": CargoNameFormQueryWhere,
"tradeArea": TradeAreaFormQueryWhere,
"companyAddressBook": AddressBookFormQueryWhere,
"parentCoa": COAFormQueryWhere
}
COAItinerary
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
coaID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seqNo - Int
|
|
portNo - Int
|
|
berthShortName - String
|
|
draft - Float
|
|
salinity - Float
|
|
cargoShortName - String
|
|
portFunc - String
|
|
cargoQty - Float
|
|
terms - String
|
|
loadDiscRate - Float
|
|
termsFactor - Float
|
|
rateUnit - String
|
|
portDays - Float
|
|
extraPortDays - Float
|
|
api - Float
|
|
grainBale - String
|
|
boardToBoard - String
|
|
portExpAmountBase - Int
|
|
otherExpAmountBase - Int
|
|
lastUpdateGmt - Date
|
|
entryDateLocal - Date
|
|
lastUser - String
|
|
cargoUnit - String
|
|
cargoDescription - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
heated - Boolean
|
|
transShipment - Boolean
|
|
interService - Boolean
|
|
manualLDRate - Boolean
|
|
manualTurntime - Boolean
|
|
useCrane - Boolean
|
|
gradeSeqNo - Int
|
|
optionType - String
|
|
agentShortName - String
|
|
seaVesselCode - String
|
|
etaLocal - Date
|
|
etrLocal - Date
|
|
remarks - String
|
|
supplierReceiver - String
|
|
boardToBoardVesselName - String
|
|
internalBU - String
|
|
portExpCurr - String
|
|
portExpAmountCurr - Int
|
|
exchangeRate - Float
|
|
norHours - Float
|
|
etsLocal - Date
|
|
demDespDays - Float
|
|
idleDays - Float
|
|
reletLoadDiscRate - Float
|
|
reletLoadDiscUnit - String
|
|
reletTurntimeHours - Float
|
|
reletTerms - String
|
|
reletFactor - Float
|
|
draftBasis - String
|
|
reletDemDays - Float
|
|
option - String
|
|
optionPercent - Float
|
|
minQty - Int
|
|
maxQty - Int
|
|
coa - COA
|
|
cargoName - CargoName
|
|
vessel - Vessel
|
|
port - Port
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"coaID": 987,
"customFieldByID": Any,
"customField": Any,
"seqNo": 987,
"portNo": 987,
"berthShortName": "xyz789",
"draft": 987.65,
"salinity": 123.45,
"cargoShortName": "xyz789",
"portFunc": "xyz789",
"cargoQty": 987.65,
"terms": "xyz789",
"loadDiscRate": 987.65,
"termsFactor": 987.65,
"rateUnit": "xyz789",
"portDays": 987.65,
"extraPortDays": 123.45,
"api": 123.45,
"grainBale": "xyz789",
"boardToBoard": "xyz789",
"portExpAmountBase": 987,
"otherExpAmountBase": 123,
"lastUpdateGmt": "2007-12-03",
"entryDateLocal": "2007-12-03",
"lastUser": "xyz789",
"cargoUnit": "abc123",
"cargoDescription": "xyz789",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"heated": true,
"transShipment": true,
"interService": false,
"manualLDRate": true,
"manualTurntime": false,
"useCrane": false,
"gradeSeqNo": 987,
"optionType": "xyz789",
"agentShortName": "abc123",
"seaVesselCode": "abc123",
"etaLocal": "2007-12-03",
"etrLocal": "2007-12-03",
"remarks": "xyz789",
"supplierReceiver": "abc123",
"boardToBoardVesselName": "abc123",
"internalBU": "xyz789",
"portExpCurr": "xyz789",
"portExpAmountCurr": 987,
"exchangeRate": 987.65,
"norHours": 123.45,
"etsLocal": "2007-12-03",
"demDespDays": 123.45,
"idleDays": 987.65,
"reletLoadDiscRate": 123.45,
"reletLoadDiscUnit": "xyz789",
"reletTurntimeHours": 123.45,
"reletTerms": "abc123",
"reletFactor": 123.45,
"draftBasis": "xyz789",
"reletDemDays": 987.65,
"option": "abc123",
"optionPercent": 123.45,
"minQty": 987,
"maxQty": 123,
"coa": COA,
"cargoName": CargoName,
"vessel": Vessel,
"port": Port,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
COAItineraryFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - COAItineraryFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": COAItineraryFormQueryWhere
}
COAItineraryFormQueryWhere
Fields
Example
{
"and": [COAItineraryFormQueryWhere],
"or": [COAItineraryFormQueryWhere],
"rawExpression": "abc123",
"coaID": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"berthShortName": StringWhereValueExpression,
"draft": NumberWhereValueExpression,
"salinity": NumberWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"portFunc": StringWhereValueExpression,
"cargoQty": NumberWhereValueExpression,
"terms": StringWhereValueExpression,
"loadDiscRate": NumberWhereValueExpression,
"termsFactor": NumberWhereValueExpression,
"rateUnit": StringWhereValueExpression,
"portDays": NumberWhereValueExpression,
"extraPortDays": NumberWhereValueExpression,
"api": NumberWhereValueExpression,
"grainBale": StringWhereValueExpression,
"boardToBoard": StringWhereValueExpression,
"portExpAmountBase": NumberWhereValueExpression,
"otherExpAmountBase": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateLocal": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"cargoUnit": StringWhereValueExpression,
"cargoDescription": StringWhereValueExpression,
"laycanFromLocal": DateWhereValueExpression,
"laycanToLocal": DateWhereValueExpression,
"heated": BoolWhereValueExpression,
"transShipment": BoolWhereValueExpression,
"interService": BoolWhereValueExpression,
"manualLDRate": BoolWhereValueExpression,
"manualTurntime": BoolWhereValueExpression,
"useCrane": BoolWhereValueExpression,
"gradeSeqNo": NumberWhereValueExpression,
"optionType": StringWhereValueExpression,
"agentShortName": StringWhereValueExpression,
"seaVesselCode": StringWhereValueExpression,
"etaLocal": DateWhereValueExpression,
"etrLocal": DateWhereValueExpression,
"remarks": StringWhereValueExpression,
"supplierReceiver": StringWhereValueExpression,
"boardToBoardVesselName": StringWhereValueExpression,
"internalBU": StringWhereValueExpression,
"portExpCurr": StringWhereValueExpression,
"portExpAmountCurr": NumberWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"norHours": NumberWhereValueExpression,
"etsLocal": DateWhereValueExpression,
"demDespDays": NumberWhereValueExpression,
"idleDays": NumberWhereValueExpression,
"reletLoadDiscRate": NumberWhereValueExpression,
"reletLoadDiscUnit": StringWhereValueExpression,
"reletTurntimeHours": NumberWhereValueExpression,
"reletTerms": StringWhereValueExpression,
"reletFactor": NumberWhereValueExpression,
"draftBasis": StringWhereValueExpression,
"reletDemDays": NumberWhereValueExpression,
"option": StringWhereValueExpression,
"optionPercent": NumberWhereValueExpression,
"minQty": NumberWhereValueExpression,
"maxQty": NumberWhereValueExpression,
"coa": COAFormQueryWhere,
"cargoName": CargoNameFormQueryWhere,
"vessel": VesselFormQueryWhere,
"port": PortFormQueryWhere
}
COAItineraryRelationships
Fields
| Field Name | Description |
|---|---|
cOA - RelationshipDefinition
|
|
cargoName - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
port - RelationshipDefinition
|
Example
{
"cOA": RelationshipDefinition,
"cargoName": RelationshipDefinition,
"vessel": RelationshipDefinition,
"port": RelationshipDefinition
}
COALiftingPeriodEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PerMonth"
COALiftingPeriodEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - COALiftingPeriodEnum
|
|
isNot - COALiftingPeriodEnum
|
|
isIn - [COALiftingPeriodEnum]
|
Example
{"is": "PerMonth", "isNot": "PerMonth", "isIn": ["PerMonth"]}
COAOption
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
coaID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seqNo - Int
|
|
portNo - Int
|
|
draft - Float
|
|
cargoShortName - String
|
|
portFunc - String
|
|
terms - String
|
|
loadDiscRate - Float
|
|
rateUnit - String
|
|
portExpAmountBase - Int
|
|
portExpCurr - String
|
|
portExpAmountCurr - Int
|
|
exchangeRate - Float
|
|
norHours - Float
|
|
coa - COA
|
|
cargoName - CargoName
|
|
port - Port
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"coaID": 987,
"customFieldByID": Any,
"customField": Any,
"seqNo": 987,
"portNo": 987,
"draft": 987.65,
"cargoShortName": "xyz789",
"portFunc": "abc123",
"terms": "xyz789",
"loadDiscRate": 987.65,
"rateUnit": "abc123",
"portExpAmountBase": 987,
"portExpCurr": "abc123",
"portExpAmountCurr": 123,
"exchangeRate": 987.65,
"norHours": 123.45,
"coa": COA,
"cargoName": CargoName,
"port": Port,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
COAOptionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - COAOptionFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": COAOptionFormQueryWhere
}
COAOptionFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [COAOptionFormQueryWhere!]
|
|
or - [COAOptionFormQueryWhere!]
|
|
rawExpression - String
|
|
coaID - NumberWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
portNo - NumberWhereValueExpression
|
|
draft - NumberWhereValueExpression
|
|
cargoShortName - StringWhereValueExpression
|
|
portFunc - StringWhereValueExpression
|
|
terms - StringWhereValueExpression
|
|
loadDiscRate - NumberWhereValueExpression
|
|
rateUnit - StringWhereValueExpression
|
|
portExpAmountBase - NumberWhereValueExpression
|
|
portExpCurr - StringWhereValueExpression
|
|
portExpAmountCurr - NumberWhereValueExpression
|
|
exchangeRate - NumberWhereValueExpression
|
|
norHours - NumberWhereValueExpression
|
|
coa - COAFormQueryWhere
|
|
cargoName - CargoNameFormQueryWhere
|
|
port - PortFormQueryWhere
|
Example
{
"and": [COAOptionFormQueryWhere],
"or": [COAOptionFormQueryWhere],
"rawExpression": "xyz789",
"coaID": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"draft": NumberWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"portFunc": StringWhereValueExpression,
"terms": StringWhereValueExpression,
"loadDiscRate": NumberWhereValueExpression,
"rateUnit": StringWhereValueExpression,
"portExpAmountBase": NumberWhereValueExpression,
"portExpCurr": StringWhereValueExpression,
"portExpAmountCurr": NumberWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"norHours": NumberWhereValueExpression,
"coa": COAFormQueryWhere,
"cargoName": CargoNameFormQueryWhere,
"port": PortFormQueryWhere
}
COAOptionRelationships
Fields
| Field Name | Description |
|---|---|
cOA - RelationshipDefinition
|
|
cargoName - RelationshipDefinition
|
|
port - RelationshipDefinition
|
Example
{
"cOA": RelationshipDefinition,
"cargoName": RelationshipDefinition,
"port": RelationshipDefinition
}
COARelationships
Fields
Example
{
"balancePaymentTerm": RelationshipDefinition,
"paymentTerm": RelationshipDefinition,
"refRepositionPort": RelationshipDefinition,
"refBallastPort": RelationshipDefinition,
"jobRedeliveryPort": RelationshipDefinition,
"jobDeliveryPort": RelationshipDefinition,
"team": RelationshipDefinition,
"lob": RelationshipDefinition,
"company": RelationshipDefinition,
"initialEstimate": RelationshipDefinition,
"basisEstimate": RelationshipDefinition,
"paymentCompany": RelationshipDefinition,
"counterparty": RelationshipDefinition,
"actDepartment": RelationshipDefinition,
"cargoName": RelationshipDefinition,
"tradeArea": RelationshipDefinition,
"companyAddressBook": RelationshipDefinition,
"cOAUnpricedElementRemark": RelationshipDefinition,
"parentCoaLink": RelationshipDefinition,
"parentCoa": RelationshipDefinition,
"unpricedElements": RelationshipDefinition,
"cOAOptions": RelationshipDefinition,
"cOADetails": RelationshipDefinition,
"cOAItineraries": RelationshipDefinition,
"cOAVessels": RelationshipDefinition,
"cOACargos": RelationshipDefinition,
"confirmedCargos": RelationshipDefinition,
"cOAItinLoads": RelationshipDefinition,
"cOAItinDischarges": RelationshipDefinition,
"coaPeriods": RelationshipDefinition,
"benchmarkEstimates": RelationshipDefinition,
"coaBrokers": RelationshipDefinition,
"cOAExtraFreightTerms": RelationshipDefinition,
"pricingLines": RelationshipDefinition,
"advancedPricingRuleReport": RelationshipDefinition,
"childCoaLinks": RelationshipDefinition
}
COAStatusCodeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Pending"
COAStatusCodeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - COAStatusCodeEnum
|
|
isNot - COAStatusCodeEnum
|
|
isIn - [COAStatusCodeEnum]
|
Example
{"is": "Pending", "isNot": "Pending", "isIn": ["Pending"]}
CalculateVesselValuationInput
Fields
| Input Field | Description |
|---|---|
sourceMatrix - String
|
|
vessels - [CalculateVesselValuation_VesselsInput]!
|
|
tceTarget - CalculateVesselValuation_TceTargetInput
|
|
seaBunkers - CalculateVesselValuation_SeaBunkersInput
|
|
portBunkers - CalculateVesselValuation_PortBunkersInput
|
Example
{
"sourceMatrix": "xyz789",
"vessels": [CalculateVesselValuation_VesselsInput],
"tceTarget": CalculateVesselValuation_TceTargetInput,
"seaBunkers": CalculateVesselValuation_SeaBunkersInput,
"portBunkers": CalculateVesselValuation_PortBunkersInput
}
CalculateVesselValuationMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": false,
"context": ["abc123"],
"timestamp": "xyz789",
"originalTimestamp": "abc123",
"intent": "xyz789",
"from": "abc123",
"to": ["xyz789"],
"fromUser": "xyz789",
"status": "xyz789",
"approvalStatus": "abc123",
"objectId": "xyz789",
"type": "xyz789",
"data": Json,
"applyTriggeredOn": "abc123",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "xyz789",
"unmapped": false,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["xyz789"],
"parentMessageId": "xyz789",
"preResolutionObjectId": "abc123",
"title": "abc123",
"effectiveDate": "abc123",
"source": "xyz789",
"sourceId": "xyz789",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["abc123"],
"isLatest": true,
"threadCount": 987,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
CalculateVesselValuationResponse
Fields
| Field Name | Description |
|---|---|
benchmarkResults - [CalculateVesselValuationResponse_BenchmarkResults]
|
Example
{
"benchmarkResults": [
CalculateVesselValuationResponse_BenchmarkResults
]
}
CalculateVesselValuationResponse_BenchmarkResults
Example
{
"vesselCode": "xyz789",
"vesselName": "abc123",
"weight": 123.45,
"cO2MetricTons": 123.45,
"freightRate": 123.45,
"qty": 123.45,
"days": 987.65,
"tce": 987.65,
"ratio": 987.65,
"estimateId": "abc123"
}
CalculateVesselValuation_PortBunkersInput
CalculateVesselValuation_SeaBunkersInput
CalculateVesselValuation_TceTargetInput
CalculateVesselValuation_VesselsInput
Cargo
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
cargoID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
coaNo - String
|
|
cpQtyString - String
|
|
qtyUnit - String
|
|
optionPercentageString - String
|
|
cargoQtyPlus - String
|
|
rateSold - String
|
|
cargoGrades - String
|
|
brokersList - String
|
|
status - String
|
|
loadCommercialIDs - String
|
|
discCommercialIDs - String
|
|
buyOrSell - String
|
|
isFOBCargo - Boolean
|
|
fOBRefVesselName - String
|
|
freightRateCurr - Float
|
|
freightValue - Float
|
|
freightCalculated - Float
|
|
lumpsumValue - Float
|
|
wSCFlat - Float
|
|
wSCPct - Float
|
|
indexLinkedFrtType - Boolean
|
|
bunkerSurchargeType - String
|
|
tradeAreaName - String
|
|
firstLoadPortName - String
|
|
firstLoadPortNo - Int
|
|
firstLoadSeqNo - Int
|
|
lastDiscPortName - String
|
|
lastDiscPortNo - Int
|
|
lastDiscSeqNo - Int
|
|
tSLTPort - String
|
|
tSLTBerth - String
|
|
tSLTPortArea - String
|
|
tSLTVesselName - String
|
|
tSLTLaycanFrom - Date
|
|
tSLTLaycanTo - Date
|
|
tSLTStatus - String
|
|
tSLTCounterparty - String
|
|
tSLTDemRate - Float
|
|
tSLTDemCurr - String
|
|
tSLTEstCost - Float
|
|
tSLTLump - Float
|
|
tSLTFixtureNo - String
|
|
tSLTVoyageNo - Int
|
|
tSLTBaseDays - Float
|
|
tSLTFreightType - String
|
|
tSLTFreightCurr - String
|
|
tSLTAppRequired - Boolean
|
|
tSLTAppReceived - Boolean
|
|
tSLTRemarks - String
|
|
tSLTETAL - Date
|
|
tSLTETAD - Date
|
|
tSLTFunc - String
|
|
tSLTExchangeRate - Float
|
|
tSDTPort - String
|
|
tSDTBerth - String
|
|
tSDTPortArea - String
|
|
tSDTVesselName - String
|
|
tSDTLaycanFrom - Date
|
|
tSDTLaycanTo - Date
|
|
tSDTStatus - String
|
|
tSDTCounterparty - String
|
|
tSDTDemRate - Float
|
|
tSDTDemCurr - String
|
|
tSDTEstCost - Float
|
|
tSDTLump - Float
|
|
tSDTFixtureNo - String
|
|
tSDTVoyageNo - Int
|
|
tSDTBaseDays - Float
|
|
tSDTFreightType - String
|
|
tSDTFreightCurr - String
|
|
tSDTAppRequired - Boolean
|
|
tSDTAppReceived - Boolean
|
|
tSDTRemarks - String
|
|
tSDTETAL - Date
|
|
tSDTETAD - Date
|
|
tSDTFunc - String
|
|
tSDTExchangeRate - Float
|
|
linkedTrades - String
|
|
linkedBunkerPurchases - String
|
|
vesselName - String
|
|
voyageStatus - String
|
|
cpCargoVolume - Float
|
|
density - Float
|
|
billBy - String
|
|
cpQtyMT - Float
|
|
cpQtyM3 - Float
|
|
minQtyMT - Float
|
|
unpricedElementRemark - String
|
|
hasTransshipmentLiftings - Boolean
|
|
taskProgress - String
|
|
coaRefBallastPort - String
|
|
coaRefRepositionPort - String
|
|
freightViaShortName - String
|
|
demurrageViaShortName - String
|
|
laytimeAllowedUnit - String
|
|
laytimeRateUnit - String
|
|
demurrageOnAccountBasis - String
|
|
laycanFromGmt - Date
|
|
laycanToGmt - Date
|
|
laycanRangeGmt - String
|
|
laycanRangeLocal - String
|
|
freightType - String
|
|
bafSymbol - String
|
|
bafAdjQty - Float
|
|
bafAdjPrice - Float
|
|
baf - Float
|
|
emissionsPaymentTermsRemarks - String
|
|
sqlID - Int
|
|
cargoShortName - String
|
|
templateName - String
|
|
cpQty - Float
|
|
cargoAssigned - Int
|
|
optionPercentage - Float
|
|
optionType - String
|
|
worldScaleRate - Float
|
|
worldScaleLevel - Float
|
|
freightRate - Float
|
|
lumpsum - Float
|
|
counterpartyShortName - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
dischDemurrageBase - Float
|
|
dischDespatchBase - Float
|
|
loadDemurrageBase - Float
|
|
loadDespatchBase - Float
|
|
contractType - String
|
|
estimateID - String
|
|
fixtureNo - String
|
|
vslCode - String
|
|
voyageNo - Int
|
|
coaID - Int
|
|
saleContractID - Int
|
|
purchaseContractID - Int
|
|
loadPort - String
|
|
dischPort - String
|
|
remarks - String
|
|
supplierShortName - String
|
|
receiverShortName - String
|
|
cargoUnit - String
|
|
curr - String
|
|
api - Float
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
exchangeRate - Float
|
|
lastUserID - String
|
|
fixtureCargoSeq - Int
|
|
scaleTable - Boolean
|
|
isLaytimeRateHourly - Boolean
|
|
partCargo - Boolean
|
|
useFreightIndexTable - Boolean
|
|
hasFreightIndexTable - Boolean
|
|
useFreightSurchargeTable - Boolean
|
|
hasFreightSurchargeTable - Boolean
|
|
useBunkerCapCollarTable - Boolean
|
|
hasBunkerCapCollarTable - Boolean
|
|
inheritCoa - Boolean
|
|
onSubjects - Boolean
|
|
flag1 - Int
|
|
template - Boolean
|
|
demoaCalendar - Boolean
|
|
tSApprovalRequired - Boolean
|
|
tSApprovalReceived - Boolean
|
|
tSLoadOption - Boolean
|
|
tSDischargeOption - Boolean
|
|
transShipment - Boolean
|
|
option - Boolean
|
|
useBookingQtyOnScaleTable - Boolean
|
|
inheritCoaExposure - Boolean
|
|
demurrageOnAccount - Boolean
|
|
laytimeReversible - Boolean
|
|
persistent - Boolean
|
|
sellerOption - Boolean
|
|
inbound - Boolean
|
|
additionalFlags - Int
|
|
finalDestinationPortNo - Int
|
|
vatNo - String
|
|
internalBU - String
|
|
minInvoiceQty - Float
|
|
draft - Float
|
|
laytimeAllowedHours - Float
|
|
freightTaxBase - Float
|
|
companyCode - String
|
|
externalRef - String
|
|
chtrCoordinator - String
|
|
bookingNo - String
|
|
bunkerScaleTable - String
|
|
demScaleTable - String
|
|
laytimeScaleTable - String
|
|
freightRateTable - String
|
|
demPct - Float
|
|
lossPrice - Float
|
|
basisEstimateID - String
|
|
routeCorrelation - Float
|
|
minQty - Int
|
|
maxQty - Int
|
|
cpDate - Date
|
|
cpForm - String
|
|
demCurr - String
|
|
loadDemRateCurr - Float
|
|
discDemRateCurr - Float
|
|
loadDespatchRateCurr - Float
|
|
discDespatchRateCurr - Float
|
|
demExchangeRate - Float
|
|
tradeAreaNo - Int
|
|
vesselType - String
|
|
lobCode - String
|
|
worldscaleYear - Int
|
|
paymentTermsCode - String
|
|
invoicePercent - Float
|
|
baseDays - Float
|
|
laytimeNOROffset - Float
|
|
laytimeAllowed - Float
|
|
laytimeAllowedUnitCode - String
|
|
laytimeAllowedTerms - String
|
|
laytimeAllowedFactor - Float
|
|
refVoyageRoute - String
|
|
oblNo - String
|
|
coMingleNo - String
|
|
trader - String
|
|
commercialScheduler - String
|
|
timeBarDays - Float
|
|
balancePaymentTermsCode - String
|
|
strategy - String
|
|
nominatedQty - Float
|
|
optionStatus - Int
|
|
basisPrice_0 - Float
|
|
basisQty_0 - Float
|
|
basisSymbol_0 - String
|
|
basisBAF_0 - Float
|
|
basisPrice_1 - Float
|
|
basisQty_1 - Float
|
|
basisSymbol_1 - String
|
|
basisBAF_1 - Float
|
|
basisPrice_2 - Float
|
|
basisQty_2 - Float
|
|
basisSymbol_2 - String
|
|
basisBAF_2 - Float
|
|
basisPrice_3 - Float
|
|
basisQty_3 - Float
|
|
basisSymbol_3 - String
|
|
basisBAF_3 - Float
|
|
basisPrice_4 - Float
|
|
basisQty_4 - Float
|
|
basisSymbol_4 - String
|
|
basisBAF_4 - Float
|
|
basisPrice_5 - Float
|
|
basisQty_5 - Float
|
|
basisSymbol_5 - String
|
|
basisBAF_5 - Float
|
|
fobRefVoyageNo - Int
|
|
currBase - String
|
|
coaSeqNo - Int
|
|
cpPlace - String
|
|
rebillableWharfage - String
|
|
rebillableDockage - String
|
|
demurrageOnAccountBillingDays - Float
|
|
isHeatingConsumptionEnabled - Boolean
|
|
isHeatingPlusConsumptionEnabled - Boolean
|
|
isHeatingPlusPlusConsumptionEnabled - Boolean
|
|
isCoolingConsumptionEnabled - Boolean
|
|
isStandardIGSConsumptionEnabled - Boolean
|
|
isAutoLoadCleaningConsumptionEnabled - Boolean
|
|
isAutoDischargeCleaningConsumptionEnabled - Boolean
|
|
isManualCleaningConsumptionEnabled - Boolean
|
|
isAutoDischargeIGSConsumptionEnabled - Boolean
|
|
segment - String
|
|
departmentNo - Int
|
|
teamNo - Int
|
|
refCompanyNo - Int
|
|
parentMirroredContractID - Int
|
|
childMirroredContractID - Int
|
|
intercompany - Boolean
|
|
intercompanyParent - Boolean
|
|
intercompanyChild - Boolean
|
|
hasUnpricedFreight - Boolean
|
|
hasUnpricedBaf - Boolean
|
|
laycanConfirmed - Boolean
|
|
overageAsDeadfreight - Boolean
|
|
coaPricingTemplate - Boolean
|
|
deadfreightByTonnage - Boolean
|
|
deadfreightByDraft - Boolean
|
|
allocFreightToDiscVoy - Boolean
|
|
isMarketCargo - Boolean
|
|
hasUnacknowledgedRevisions - Boolean
|
|
coaBaseTemplate - Boolean
|
|
laytimeFloorCeiling - Boolean
|
|
multiCargoFob - Boolean
|
|
isVCOVHeadFixture - Boolean
|
|
useFirmQtyOnScaleTable - Boolean
|
|
isManualPartCargoFactor - Boolean
|
|
useCommingledQtyOnScaleTable - Boolean
|
|
isManualCO2ExchRate - Boolean
|
|
isTradeUnit - Boolean
|
|
isManualEmissionsSettlementType - Boolean
|
|
isManualEmissionsBillingPeriod - Boolean
|
|
isManualEmissionsPaymentTerms - Boolean
|
|
emissionsBillPerLadenLeg - Boolean
|
|
includePendingAllowanceInvoicesInPnL - Boolean
|
|
isManualCarbonPricingMethod - Boolean
|
|
additionalFlags4 - Int
|
|
optionDeclarationDate - Date
|
|
manualTce - Float
|
|
iCCompanyCode - String
|
|
iCAdjPercent - Float
|
|
actDept - String
|
|
agreedTemperature - Float
|
|
refContract - String
|
|
initialEstimateID - String
|
|
agreedTemperatureUnit - String
|
|
exposureMethod - String
|
|
contractDays - Float
|
|
routeAdjustment - Float
|
|
benchmarkBasis - String
|
|
optionDeclaredDate - Date
|
|
exposureRefDate - Date
|
|
exposureBasisDate - Date
|
|
mTEquivalentFactor - Float
|
|
vesselRef - String
|
|
bunkerHedging - String
|
|
bunkerHedgedByUser - String
|
|
invoicedQty - Float
|
|
counterpartyType - String
|
|
primaryCargoID - Int
|
|
coLoad - Boolean
|
|
billByCPQty - Boolean
|
|
billByOutturnQty - Boolean
|
|
billByInvoiceQty - Boolean
|
|
advancedPricing - Boolean
|
|
usedFallbackFreight - Boolean
|
|
fixFlags - Int
|
|
linerTerms - String
|
|
confirmationDateGmt - Date
|
|
coaPeriodSeqNo - Int
|
|
qtyAsPerformed - Float
|
|
contractReference - String
|
|
deadfreightAllowance - Float
|
|
cpDraftInMeter - Float
|
|
referenceTcCode - String
|
|
profitSharePercent - Float
|
|
correlationProfileName - String
|
|
advancedPricingEstimateOnlyResults - Int
|
|
advancedPricingOverriddenResults - Int
|
|
salePriceBase - Float
|
|
saleCurr - String
|
|
saleExchangeRate - Float
|
|
remittanceBank - String
|
|
entryUserID - String
|
|
firmedCPQty - Float
|
|
partCargoFactor - Float
|
|
cO2Symbol - String
|
|
cO2Qty - Float
|
|
cO2Price - Float
|
|
cO2Currency - String
|
|
cO2ExchRate - Float
|
|
emissionsSettlementType - String
|
|
emissionsBillingPeriod - String
|
|
emissionsPaymentTermsCode - String
|
|
docHolderName - String
|
|
docHolderType - String
|
|
allowanceDefaultPriceMode - String
|
|
fuelEUCalcDefault - String
|
|
emissionPaymentTerms - PaymentTerm
|
|
childMirroredCargo - Cargo
|
|
parentMirroredCargo - Cargo
|
|
cargoBooking - CargoBooking
|
|
balancePaymentTerm - PaymentTerm
|
|
paymentTerm - PaymentTerm
|
|
addressBook - AddressBook
|
|
team - Team
|
|
lob - Lob
|
|
voyage - Voyage
|
|
actDepartment - ActDepartment
|
|
basisEstimate - VoyageEstimate
|
|
tradeArea - TradeArea
|
|
fixture - Fixture
|
|
voyageEstimate - VoyageEstimate
|
|
counterparty - AddressBook
|
|
coa - COA
|
|
cargoName - CargoName
|
|
company - AddressBook
|
|
vessel - Vessel
|
|
benchmarkEstimate - BenchmarkEstimate
|
|
firstLoadCargoHandling - VoyageCargoHandling
|
|
firstDiscCargoHandling - VoyageCargoHandling
|
|
firstLoadCargoHandlingRelet - VoyageCargoHandling
|
|
firstDiscCargoHandlingRelet - VoyageCargoHandling
|
|
lastLoadCargoHandling - VoyageCargoHandling
|
|
lastDiscCargoHandling - VoyageCargoHandling
|
|
firstCargoLoadItin - CargoItinerary
|
|
firstCargoDiscItin - CargoItinerary
|
|
lastCargoDiscItin - CargoItinerary
|
|
firstCargoTSLoadItin - CargoItinerary
|
|
firstCargoTSDiscItin - CargoItinerary
|
|
chtrBroker - CargoBroker
|
|
ownerBroker - CargoBroker
|
|
firstBroker - CargoBroker
|
|
saleCargo - Cargo
|
|
purchaseCargo - Cargo
|
|
cargoUnpricedElementRemark - UnpricedElementRemark
|
|
requiredVesselType - VesselType
|
|
chtrCoordinatorUser - ImosUser
|
|
cargoBunkerConsumptions - [CargoBunkerConsumption]
|
|
cargoLoadDischargeOptions - [CargoLoadDischargeOption]
|
|
unpricedElements - [UnpricedElement]
|
|
cargoSupplierReceivers - [CargoSupplierReceiver]
|
|
cargoRemarks - [CargoRemark]
|
|
cargoTimeBars - [CargoTimeBar]
|
|
cargoBrokers - [CargoBroker]
|
|
cargoRevenueExpenses - [CargoRevenueExpense]
|
|
pricingLines - [StandardRate]
|
|
bunkerExposures - [BunkerExposure]
|
|
loadCommercialCargoItineraries - [CargoItinerary]
|
|
loadCargoItineraries - [CargoItinerary]
|
|
cargoItineraries - [CargoItinerary]
|
|
discCommercialCargoItineraries - [CargoItinerary]
|
|
discCargoItineraries - [CargoItinerary]
|
|
voyageCargoHandlings - [VoyageCargoHandling]
|
|
loadVoyageCargoHandlings - [VoyageCargoHandling]
|
|
discVoyageCargoHandlings - [VoyageCargoHandling]
|
|
cargoLinkedTrades - [CargoLinkedTrade]
|
|
tasks - [Task]
|
|
extraFreightTerms - [ExtraFreightTerms]
|
|
benchmarkEstimates - [BenchmarkEstimate]
|
|
alerts - [Alert]
|
|
advancedPricingRuleReport - [DecisionTableRuleReport]
|
|
mirroredCargos - [Cargo]
|
|
cargoExposureBunker - [CargoExposureBunker]
|
|
commodityContract - [CommodityContract]
|
|
operationsInvoice - [OperationsInvoice]
|
|
nominateCargoMessages - [NominateCargoMessageRecord]
|
|
Arguments
|
|
updateCargoMessages - [UpdateCargoMessageRecord]
|
|
Arguments
|
|
addVoyageCargoMessages - [AddVoyageCargoMessageRecord]
|
|
Arguments
|
|
changesSinceLast - CargoChangesSinceLast
|
|
userDefinedFields - Json
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"cargoID": 987,
"customFieldByID": Any,
"customField": Any,
"coaNo": "abc123",
"cpQtyString": "abc123",
"qtyUnit": "abc123",
"optionPercentageString": "abc123",
"cargoQtyPlus": "abc123",
"rateSold": "abc123",
"cargoGrades": "xyz789",
"brokersList": "xyz789",
"status": "abc123",
"loadCommercialIDs": "xyz789",
"discCommercialIDs": "xyz789",
"buyOrSell": "xyz789",
"isFOBCargo": false,
"fOBRefVesselName": "abc123",
"freightRateCurr": 123.45,
"freightValue": 987.65,
"freightCalculated": 123.45,
"lumpsumValue": 123.45,
"wSCFlat": 987.65,
"wSCPct": 987.65,
"indexLinkedFrtType": true,
"bunkerSurchargeType": "abc123",
"tradeAreaName": "abc123",
"firstLoadPortName": "xyz789",
"firstLoadPortNo": 987,
"firstLoadSeqNo": 123,
"lastDiscPortName": "abc123",
"lastDiscPortNo": 987,
"lastDiscSeqNo": 987,
"tSLTPort": "abc123",
"tSLTBerth": "abc123",
"tSLTPortArea": "abc123",
"tSLTVesselName": "xyz789",
"tSLTLaycanFrom": "2007-12-03",
"tSLTLaycanTo": "2007-12-03",
"tSLTStatus": "xyz789",
"tSLTCounterparty": "abc123",
"tSLTDemRate": 123.45,
"tSLTDemCurr": "abc123",
"tSLTEstCost": 123.45,
"tSLTLump": 987.65,
"tSLTFixtureNo": "abc123",
"tSLTVoyageNo": 987,
"tSLTBaseDays": 123.45,
"tSLTFreightType": "abc123",
"tSLTFreightCurr": "xyz789",
"tSLTAppRequired": true,
"tSLTAppReceived": false,
"tSLTRemarks": "abc123",
"tSLTETAL": "2007-12-03",
"tSLTETAD": "2007-12-03",
"tSLTFunc": "abc123",
"tSLTExchangeRate": 987.65,
"tSDTPort": "abc123",
"tSDTBerth": "abc123",
"tSDTPortArea": "xyz789",
"tSDTVesselName": "abc123",
"tSDTLaycanFrom": "2007-12-03",
"tSDTLaycanTo": "2007-12-03",
"tSDTStatus": "abc123",
"tSDTCounterparty": "abc123",
"tSDTDemRate": 123.45,
"tSDTDemCurr": "abc123",
"tSDTEstCost": 987.65,
"tSDTLump": 987.65,
"tSDTFixtureNo": "abc123",
"tSDTVoyageNo": 987,
"tSDTBaseDays": 987.65,
"tSDTFreightType": "xyz789",
"tSDTFreightCurr": "abc123",
"tSDTAppRequired": true,
"tSDTAppReceived": true,
"tSDTRemarks": "xyz789",
"tSDTETAL": "2007-12-03",
"tSDTETAD": "2007-12-03",
"tSDTFunc": "abc123",
"tSDTExchangeRate": 123.45,
"linkedTrades": "abc123",
"linkedBunkerPurchases": "xyz789",
"vesselName": "abc123",
"voyageStatus": "xyz789",
"cpCargoVolume": 987.65,
"density": 987.65,
"billBy": "abc123",
"cpQtyMT": 987.65,
"cpQtyM3": 987.65,
"minQtyMT": 987.65,
"unpricedElementRemark": "abc123",
"hasTransshipmentLiftings": true,
"taskProgress": "abc123",
"coaRefBallastPort": "xyz789",
"coaRefRepositionPort": "xyz789",
"freightViaShortName": "xyz789",
"demurrageViaShortName": "xyz789",
"laytimeAllowedUnit": "xyz789",
"laytimeRateUnit": "xyz789",
"demurrageOnAccountBasis": "xyz789",
"laycanFromGmt": "2007-12-03",
"laycanToGmt": "2007-12-03",
"laycanRangeGmt": "xyz789",
"laycanRangeLocal": "xyz789",
"freightType": "abc123",
"bafSymbol": "abc123",
"bafAdjQty": 987.65,
"bafAdjPrice": 987.65,
"baf": 123.45,
"emissionsPaymentTermsRemarks": "xyz789",
"sqlID": 987,
"cargoShortName": "abc123",
"templateName": "xyz789",
"cpQty": 987.65,
"cargoAssigned": 123,
"optionPercentage": 123.45,
"optionType": "xyz789",
"worldScaleRate": 123.45,
"worldScaleLevel": 987.65,
"freightRate": 987.65,
"lumpsum": 987.65,
"counterpartyShortName": "xyz789",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"dischDemurrageBase": 123.45,
"dischDespatchBase": 123.45,
"loadDemurrageBase": 987.65,
"loadDespatchBase": 987.65,
"contractType": "xyz789",
"estimateID": "xyz789",
"fixtureNo": "xyz789",
"vslCode": "abc123",
"voyageNo": 123,
"coaID": 987,
"saleContractID": 123,
"purchaseContractID": 987,
"loadPort": "xyz789",
"dischPort": "abc123",
"remarks": "abc123",
"supplierShortName": "abc123",
"receiverShortName": "abc123",
"cargoUnit": "abc123",
"curr": "xyz789",
"api": 987.65,
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"exchangeRate": 987.65,
"lastUserID": "abc123",
"fixtureCargoSeq": 987,
"scaleTable": true,
"isLaytimeRateHourly": false,
"partCargo": false,
"useFreightIndexTable": true,
"hasFreightIndexTable": true,
"useFreightSurchargeTable": true,
"hasFreightSurchargeTable": true,
"useBunkerCapCollarTable": false,
"hasBunkerCapCollarTable": true,
"inheritCoa": true,
"onSubjects": true,
"flag1": 987,
"template": false,
"demoaCalendar": false,
"tSApprovalRequired": false,
"tSApprovalReceived": false,
"tSLoadOption": true,
"tSDischargeOption": false,
"transShipment": true,
"option": false,
"useBookingQtyOnScaleTable": true,
"inheritCoaExposure": false,
"demurrageOnAccount": false,
"laytimeReversible": true,
"persistent": true,
"sellerOption": true,
"inbound": false,
"additionalFlags": 123,
"finalDestinationPortNo": 123,
"vatNo": "xyz789",
"internalBU": "xyz789",
"minInvoiceQty": 987.65,
"draft": 987.65,
"laytimeAllowedHours": 987.65,
"freightTaxBase": 987.65,
"companyCode": "abc123",
"externalRef": "abc123",
"chtrCoordinator": "xyz789",
"bookingNo": "xyz789",
"bunkerScaleTable": "xyz789",
"demScaleTable": "abc123",
"laytimeScaleTable": "abc123",
"freightRateTable": "xyz789",
"demPct": 987.65,
"lossPrice": 987.65,
"basisEstimateID": "abc123",
"routeCorrelation": 123.45,
"minQty": 123,
"maxQty": 123,
"cpDate": "2007-12-03",
"cpForm": "abc123",
"demCurr": "xyz789",
"loadDemRateCurr": 123.45,
"discDemRateCurr": 123.45,
"loadDespatchRateCurr": 987.65,
"discDespatchRateCurr": 987.65,
"demExchangeRate": 987.65,
"tradeAreaNo": 123,
"vesselType": "xyz789",
"lobCode": "xyz789",
"worldscaleYear": 987,
"paymentTermsCode": "xyz789",
"invoicePercent": 123.45,
"baseDays": 123.45,
"laytimeNOROffset": 123.45,
"laytimeAllowed": 987.65,
"laytimeAllowedUnitCode": "abc123",
"laytimeAllowedTerms": "abc123",
"laytimeAllowedFactor": 987.65,
"refVoyageRoute": "xyz789",
"oblNo": "xyz789",
"coMingleNo": "xyz789",
"trader": "xyz789",
"commercialScheduler": "abc123",
"timeBarDays": 987.65,
"balancePaymentTermsCode": "abc123",
"strategy": "xyz789",
"nominatedQty": 987.65,
"optionStatus": 123,
"basisPrice_0": 987.65,
"basisQty_0": 987.65,
"basisSymbol_0": "xyz789",
"basisBAF_0": 987.65,
"basisPrice_1": 123.45,
"basisQty_1": 987.65,
"basisSymbol_1": "abc123",
"basisBAF_1": 987.65,
"basisPrice_2": 123.45,
"basisQty_2": 987.65,
"basisSymbol_2": "abc123",
"basisBAF_2": 987.65,
"basisPrice_3": 987.65,
"basisQty_3": 987.65,
"basisSymbol_3": "xyz789",
"basisBAF_3": 987.65,
"basisPrice_4": 987.65,
"basisQty_4": 123.45,
"basisSymbol_4": "xyz789",
"basisBAF_4": 123.45,
"basisPrice_5": 123.45,
"basisQty_5": 987.65,
"basisSymbol_5": "abc123",
"basisBAF_5": 987.65,
"fobRefVoyageNo": 123,
"currBase": "abc123",
"coaSeqNo": 987,
"cpPlace": "xyz789",
"rebillableWharfage": "abc123",
"rebillableDockage": "abc123",
"demurrageOnAccountBillingDays": 987.65,
"isHeatingConsumptionEnabled": true,
"isHeatingPlusConsumptionEnabled": false,
"isHeatingPlusPlusConsumptionEnabled": true,
"isCoolingConsumptionEnabled": false,
"isStandardIGSConsumptionEnabled": false,
"isAutoLoadCleaningConsumptionEnabled": false,
"isAutoDischargeCleaningConsumptionEnabled": true,
"isManualCleaningConsumptionEnabled": true,
"isAutoDischargeIGSConsumptionEnabled": false,
"segment": "xyz789",
"departmentNo": 123,
"teamNo": 123,
"refCompanyNo": 987,
"parentMirroredContractID": 987,
"childMirroredContractID": 987,
"intercompany": true,
"intercompanyParent": false,
"intercompanyChild": false,
"hasUnpricedFreight": true,
"hasUnpricedBaf": true,
"laycanConfirmed": true,
"overageAsDeadfreight": false,
"coaPricingTemplate": true,
"deadfreightByTonnage": false,
"deadfreightByDraft": false,
"allocFreightToDiscVoy": false,
"isMarketCargo": false,
"hasUnacknowledgedRevisions": false,
"coaBaseTemplate": true,
"laytimeFloorCeiling": true,
"multiCargoFob": false,
"isVCOVHeadFixture": false,
"useFirmQtyOnScaleTable": true,
"isManualPartCargoFactor": false,
"useCommingledQtyOnScaleTable": false,
"isManualCO2ExchRate": true,
"isTradeUnit": false,
"isManualEmissionsSettlementType": false,
"isManualEmissionsBillingPeriod": false,
"isManualEmissionsPaymentTerms": false,
"emissionsBillPerLadenLeg": true,
"includePendingAllowanceInvoicesInPnL": true,
"isManualCarbonPricingMethod": true,
"additionalFlags4": 123,
"optionDeclarationDate": "2007-12-03",
"manualTce": 123.45,
"iCCompanyCode": "xyz789",
"iCAdjPercent": 987.65,
"actDept": "abc123",
"agreedTemperature": 987.65,
"refContract": "xyz789",
"initialEstimateID": "xyz789",
"agreedTemperatureUnit": "abc123",
"exposureMethod": "xyz789",
"contractDays": 987.65,
"routeAdjustment": 123.45,
"benchmarkBasis": "xyz789",
"optionDeclaredDate": "2007-12-03",
"exposureRefDate": "2007-12-03",
"exposureBasisDate": "2007-12-03",
"mTEquivalentFactor": 987.65,
"vesselRef": "xyz789",
"bunkerHedging": "xyz789",
"bunkerHedgedByUser": "xyz789",
"invoicedQty": 987.65,
"counterpartyType": "xyz789",
"primaryCargoID": 987,
"coLoad": true,
"billByCPQty": false,
"billByOutturnQty": false,
"billByInvoiceQty": true,
"advancedPricing": false,
"usedFallbackFreight": false,
"fixFlags": 123,
"linerTerms": "abc123",
"confirmationDateGmt": "2007-12-03",
"coaPeriodSeqNo": 987,
"qtyAsPerformed": 987.65,
"contractReference": "abc123",
"deadfreightAllowance": 123.45,
"cpDraftInMeter": 987.65,
"referenceTcCode": "abc123",
"profitSharePercent": 987.65,
"correlationProfileName": "xyz789",
"advancedPricingEstimateOnlyResults": 123,
"advancedPricingOverriddenResults": 987,
"salePriceBase": 123.45,
"saleCurr": "abc123",
"saleExchangeRate": 123.45,
"remittanceBank": "xyz789",
"entryUserID": "xyz789",
"firmedCPQty": 123.45,
"partCargoFactor": 987.65,
"cO2Symbol": "abc123",
"cO2Qty": 987.65,
"cO2Price": 987.65,
"cO2Currency": "xyz789",
"cO2ExchRate": 987.65,
"emissionsSettlementType": "abc123",
"emissionsBillingPeriod": "abc123",
"emissionsPaymentTermsCode": "abc123",
"docHolderName": "abc123",
"docHolderType": "abc123",
"allowanceDefaultPriceMode": "xyz789",
"fuelEUCalcDefault": "abc123",
"emissionPaymentTerms": PaymentTerm,
"childMirroredCargo": Cargo,
"parentMirroredCargo": Cargo,
"cargoBooking": CargoBooking,
"balancePaymentTerm": PaymentTerm,
"paymentTerm": PaymentTerm,
"addressBook": AddressBook,
"team": Team,
"lob": Lob,
"voyage": Voyage,
"actDepartment": ActDepartment,
"basisEstimate": VoyageEstimate,
"tradeArea": TradeArea,
"fixture": Fixture,
"voyageEstimate": VoyageEstimate,
"counterparty": AddressBook,
"coa": COA,
"cargoName": CargoName,
"company": AddressBook,
"vessel": Vessel,
"benchmarkEstimate": BenchmarkEstimate,
"firstLoadCargoHandling": VoyageCargoHandling,
"firstDiscCargoHandling": VoyageCargoHandling,
"firstLoadCargoHandlingRelet": VoyageCargoHandling,
"firstDiscCargoHandlingRelet": VoyageCargoHandling,
"lastLoadCargoHandling": VoyageCargoHandling,
"lastDiscCargoHandling": VoyageCargoHandling,
"firstCargoLoadItin": CargoItinerary,
"firstCargoDiscItin": CargoItinerary,
"lastCargoDiscItin": CargoItinerary,
"firstCargoTSLoadItin": CargoItinerary,
"firstCargoTSDiscItin": CargoItinerary,
"chtrBroker": CargoBroker,
"ownerBroker": CargoBroker,
"firstBroker": CargoBroker,
"saleCargo": Cargo,
"purchaseCargo": Cargo,
"cargoUnpricedElementRemark": UnpricedElementRemark,
"requiredVesselType": VesselType,
"chtrCoordinatorUser": ImosUser,
"cargoBunkerConsumptions": [CargoBunkerConsumption],
"cargoLoadDischargeOptions": [CargoLoadDischargeOption],
"unpricedElements": [UnpricedElement],
"cargoSupplierReceivers": [CargoSupplierReceiver],
"cargoRemarks": [CargoRemark],
"cargoTimeBars": [CargoTimeBar],
"cargoBrokers": [CargoBroker],
"cargoRevenueExpenses": [CargoRevenueExpense],
"pricingLines": [StandardRate],
"bunkerExposures": [BunkerExposure],
"loadCommercialCargoItineraries": [CargoItinerary],
"loadCargoItineraries": [CargoItinerary],
"cargoItineraries": [CargoItinerary],
"discCommercialCargoItineraries": [CargoItinerary],
"discCargoItineraries": [CargoItinerary],
"voyageCargoHandlings": [VoyageCargoHandling],
"loadVoyageCargoHandlings": [VoyageCargoHandling],
"discVoyageCargoHandlings": [VoyageCargoHandling],
"cargoLinkedTrades": [CargoLinkedTrade],
"tasks": [Task],
"extraFreightTerms": [ExtraFreightTerms],
"benchmarkEstimates": [BenchmarkEstimate],
"alerts": [Alert],
"advancedPricingRuleReport": [DecisionTableRuleReport],
"mirroredCargos": [Cargo],
"cargoExposureBunker": [CargoExposureBunker],
"commodityContract": [CommodityContract],
"operationsInvoice": [OperationsInvoice],
"nominateCargoMessages": [NominateCargoMessageRecord],
"updateCargoMessages": [UpdateCargoMessageRecord],
"addVoyageCargoMessages": [AddVoyageCargoMessageRecord],
"changesSinceLast": CargoChangesSinceLast,
"userDefinedFields": Json,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
CargoAllowanceDefaultPriceModeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PurchasePrice"
CargoAllowanceDefaultPriceModeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoAllowanceDefaultPriceModeEnum
|
|
isNot - CargoAllowanceDefaultPriceModeEnum
|
|
isIn - [CargoAllowanceDefaultPriceModeEnum]
|
Example
{"is": "PurchasePrice", "isNot": "PurchasePrice", "isIn": ["PurchasePrice"]}
CargoBenchmarkBasisEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Min"
CargoBenchmarkBasisEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoBenchmarkBasisEnum
|
|
isNot - CargoBenchmarkBasisEnum
|
|
isIn - [CargoBenchmarkBasisEnum]
|
Example
{"is": "Min", "isNot": "Min", "isIn": ["Min"]}
CargoBooking
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
isCargoBooking - Boolean
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
isVcInBooking - Boolean
|
|
loadPorts - String
|
|
discPorts - String
|
|
cargo - String
|
|
counterpartyShortName - String
|
|
bookingNo - String
|
|
loadPortNo - Int
|
|
discPortNo - Int
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
periodBasis - String
|
|
totalCPQty - Float
|
|
cpUnit - String
|
|
status - String
|
|
cargoShortName - String
|
|
coaID - Int
|
|
externalRef - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUserID - String
|
|
bookingLumpsum - Float
|
|
loadRate - Float
|
|
discRate - Float
|
|
lDRateUnit - String
|
|
nominationReceivedDate - Date
|
|
finalCPDate - Date
|
|
loadDemRateCurr - Float
|
|
discDemRateCurr - Float
|
|
loadDespatchRateCurr - Float
|
|
discDespatchRateCurr - Float
|
|
terms - String
|
|
contractType - String
|
|
nominationStatus - String
|
|
coa - COA
|
|
cargoName - CargoName
|
|
dischargePort - Port
|
|
loadPort - Port
|
|
counterpartyAddressBook - AddressBook
|
|
cargoBookingStowages - [CargoBookingStowage]
|
|
cargoBookingCargos - [Cargo]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"isCargoBooking": false,
"customFieldByID": Any,
"customField": Any,
"isVcInBooking": false,
"loadPorts": "xyz789",
"discPorts": "xyz789",
"cargo": "xyz789",
"counterpartyShortName": "abc123",
"bookingNo": "abc123",
"loadPortNo": 123,
"discPortNo": 123,
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"periodBasis": "abc123",
"totalCPQty": 987.65,
"cpUnit": "abc123",
"status": "xyz789",
"cargoShortName": "xyz789",
"coaID": 123,
"externalRef": "abc123",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUserID": "xyz789",
"bookingLumpsum": 123.45,
"loadRate": 987.65,
"discRate": 987.65,
"lDRateUnit": "xyz789",
"nominationReceivedDate": "2007-12-03",
"finalCPDate": "2007-12-03",
"loadDemRateCurr": 123.45,
"discDemRateCurr": 987.65,
"loadDespatchRateCurr": 123.45,
"discDespatchRateCurr": 123.45,
"terms": "xyz789",
"contractType": "abc123",
"nominationStatus": "xyz789",
"coa": COA,
"cargoName": CargoName,
"dischargePort": Port,
"loadPort": Port,
"counterpartyAddressBook": AddressBook,
"cargoBookingStowages": [CargoBookingStowage],
"cargoBookingCargos": [Cargo],
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
CargoBookingFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CargoBookingFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CargoBookingFormQueryWhere
}
CargoBookingFormQueryWhere
Fields
Example
{
"and": [CargoBookingFormQueryWhere],
"or": [CargoBookingFormQueryWhere],
"rawExpression": "abc123",
"counterpartyShortName": StringWhereValueExpression,
"bookingNo": StringWhereValueExpression,
"loadPortNo": NumberWhereValueExpression,
"discPortNo": NumberWhereValueExpression,
"laycanFromLocal": DateWhereValueExpression,
"laycanToLocal": DateWhereValueExpression,
"periodBasis": StringWhereValueExpression,
"totalCPQty": NumberWhereValueExpression,
"cpUnit": StringWhereValueExpression,
"status": StringWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"coaID": NumberWhereValueExpression,
"externalRef": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"bookingLumpsum": NumberWhereValueExpression,
"loadRate": NumberWhereValueExpression,
"discRate": NumberWhereValueExpression,
"lDRateUnit": StringWhereValueExpression,
"nominationReceivedDate": DateWhereValueExpression,
"finalCPDate": DateWhereValueExpression,
"loadDemRateCurr": NumberWhereValueExpression,
"discDemRateCurr": NumberWhereValueExpression,
"loadDespatchRateCurr": NumberWhereValueExpression,
"discDespatchRateCurr": NumberWhereValueExpression,
"terms": StringWhereValueExpression,
"contractType": StringWhereValueExpression,
"nominationStatus": CargoBookingNominationStatusEnumValueExpression,
"coa": COAFormQueryWhere,
"cargoName": CargoNameFormQueryWhere,
"dischargePort": PortFormQueryWhere,
"loadPort": PortFormQueryWhere,
"counterpartyAddressBook": AddressBookFormQueryWhere
}
CargoBookingNominationStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Inquiry"
CargoBookingNominationStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoBookingNominationStatusEnum
|
|
isNot - CargoBookingNominationStatusEnum
|
|
isIn - [CargoBookingNominationStatusEnum]
|
Example
{"is": "Inquiry", "isNot": "Inquiry", "isIn": ["Inquiry"]}
CargoBookingProjectedLaytimeInvoiceRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
bookingAddressBook - RelationshipDefinition
|
|
laytime - RelationshipDefinition
|
|
cargoBooking - RelationshipDefinition
|
Example
{
"vessel": RelationshipDefinition,
"voyage": RelationshipDefinition,
"bookingAddressBook": RelationshipDefinition,
"laytime": RelationshipDefinition,
"cargoBooking": RelationshipDefinition
}
CargoBookingRelationships
Fields
| Field Name | Description |
|---|---|
cOA - RelationshipDefinition
|
|
cargoName - RelationshipDefinition
|
|
dischargePort - RelationshipDefinition
|
|
loadPort - RelationshipDefinition
|
|
counterpartyAddressBook - RelationshipDefinition
|
|
cargoBookingStowages - RelationshipDefinition
|
|
cargoBookingCargos - RelationshipDefinition
|
Example
{
"cOA": RelationshipDefinition,
"cargoName": RelationshipDefinition,
"dischargePort": RelationshipDefinition,
"loadPort": RelationshipDefinition,
"counterpartyAddressBook": RelationshipDefinition,
"cargoBookingStowages": RelationshipDefinition,
"cargoBookingCargos": RelationshipDefinition
}
CargoBookingStowage
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tankName - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
bookingNo - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
seq - Int
|
|
orderNo - Int
|
|
cargoID - Int
|
|
tankNameInternal - String
|
|
approved - String
|
|
inspection - String
|
|
purging - String
|
|
prevCargoFirst - String
|
|
prevCargoSecond - String
|
|
prevCargoThird - String
|
|
comments - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUserID - String
|
|
inspectionStatus - String
|
|
purgingStatus - String
|
|
coating - String
|
|
cargo - Cargo
|
|
voyage - Voyage
|
|
cargoBooking - CargoBooking
|
|
vesselTank - VesselTank
|
|
vessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"tankName": "xyz789",
"customFieldByID": Any,
"customField": Any,
"bookingNo": "abc123",
"vesselCode": "abc123",
"voyageNo": 123,
"seq": 987,
"orderNo": 123,
"cargoID": 987,
"tankNameInternal": "xyz789",
"approved": "xyz789",
"inspection": "xyz789",
"purging": "abc123",
"prevCargoFirst": "abc123",
"prevCargoSecond": "abc123",
"prevCargoThird": "xyz789",
"comments": "abc123",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUserID": "abc123",
"inspectionStatus": "xyz789",
"purgingStatus": "abc123",
"coating": "xyz789",
"cargo": Cargo,
"voyage": Voyage,
"cargoBooking": CargoBooking,
"vesselTank": VesselTank,
"vessel": Vessel,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
CargoBookingStowageApprovedEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
CargoBookingStowageApprovedEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoBookingStowageApprovedEnum
|
|
isNot - CargoBookingStowageApprovedEnum
|
|
isIn - [CargoBookingStowageApprovedEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
CargoBookingStowageFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CargoBookingStowageFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CargoBookingStowageFormQueryWhere
}
CargoBookingStowageFormQueryWhere
Fields
Example
{
"and": [CargoBookingStowageFormQueryWhere],
"or": [CargoBookingStowageFormQueryWhere],
"rawExpression": "xyz789",
"bookingNo": StringWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"orderNo": NumberWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"tankNameInternal": StringWhereValueExpression,
"approved": CargoBookingStowageApprovedEnumValueExpression,
"inspection": CargoBookingStowageInspectionEnumValueExpression,
"purging": CargoBookingStowagePurgingEnumValueExpression,
"prevCargoFirst": StringWhereValueExpression,
"prevCargoSecond": StringWhereValueExpression,
"prevCargoThird": StringWhereValueExpression,
"comments": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"inspectionStatus": CargoBookingStowageInspectionStatusEnumValueExpression,
"purgingStatus": CargoBookingStowagePurgingStatusEnumValueExpression,
"coating": StringWhereValueExpression,
"cargo": CargoFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"cargoBooking": CargoBookingFormQueryWhere,
"vesselTank": VesselTankFormQueryWhere,
"vessel": VesselFormQueryWhere
}
CargoBookingStowageInspectionEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
CargoBookingStowageInspectionEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoBookingStowageInspectionEnum
|
|
isNot - CargoBookingStowageInspectionEnum
|
|
isIn - [CargoBookingStowageInspectionEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
CargoBookingStowageInspectionStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"None"
CargoBookingStowageInspectionStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoBookingStowageInspectionStatusEnum
|
|
isNot - CargoBookingStowageInspectionStatusEnum
|
|
isIn - [CargoBookingStowageInspectionStatusEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
CargoBookingStowagePurgingEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
CargoBookingStowagePurgingEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoBookingStowagePurgingEnum
|
|
isNot - CargoBookingStowagePurgingEnum
|
|
isIn - [CargoBookingStowagePurgingEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
CargoBookingStowagePurgingStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"None"
CargoBookingStowagePurgingStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoBookingStowagePurgingStatusEnum
|
|
isNot - CargoBookingStowagePurgingStatusEnum
|
|
isIn - [CargoBookingStowagePurgingStatusEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
CargoBookingStowageRelationships
Fields
| Field Name | Description |
|---|---|
cargo - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
cargoBooking - RelationshipDefinition
|
|
vesselTank - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
Example
{
"cargo": RelationshipDefinition,
"voyage": RelationshipDefinition,
"cargoBooking": RelationshipDefinition,
"vesselTank": RelationshipDefinition,
"vessel": RelationshipDefinition
}
CargoBroker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
claimSetting - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
cargoID - Int
|
|
seqNo - Int
|
|
cargoShortName - String
|
|
brokerShortName - String
|
|
commission - Float
|
|
invoicingOptions - String
|
|
alternateQty - Float
|
|
alternateUnit - String
|
|
brokerType - String
|
|
alternateRate - Float
|
|
commissionType - String
|
|
commissionOrRebate - String
|
|
isOwnerBroker - Boolean
|
|
partialCommissionsEnabled - Boolean
|
|
billVia - Boolean
|
|
ruleGenerated - Boolean
|
|
freightInvoiceSetting - String
|
|
demurrageSetting - String
|
|
internalCounterpartyShortName - String
|
|
internalCounterpartySequenceNo - Int
|
|
addressBook - AddressBook
|
|
cargo - Cargo
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"claimSetting": "xyz789",
"customFieldByID": Any,
"customField": Any,
"cargoID": 123,
"seqNo": 987,
"cargoShortName": "xyz789",
"brokerShortName": "xyz789",
"commission": 123.45,
"invoicingOptions": "abc123",
"alternateQty": 123.45,
"alternateUnit": "xyz789",
"brokerType": "xyz789",
"alternateRate": 123.45,
"commissionType": "abc123",
"commissionOrRebate": "xyz789",
"isOwnerBroker": true,
"partialCommissionsEnabled": true,
"billVia": false,
"ruleGenerated": true,
"freightInvoiceSetting": "xyz789",
"demurrageSetting": "xyz789",
"internalCounterpartyShortName": "xyz789",
"internalCounterpartySequenceNo": 987,
"addressBook": AddressBook,
"cargo": Cargo,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
CargoBrokerCommissionOrRebateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CargoBrokerCommissionOrRebateEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoBrokerCommissionOrRebateEnum
|
|
isNot - CargoBrokerCommissionOrRebateEnum
|
|
isIn - [CargoBrokerCommissionOrRebateEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
CargoBrokerDemurrageSettingEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CargoBrokerDemurrageSettingEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoBrokerDemurrageSettingEnum
|
|
isNot - CargoBrokerDemurrageSettingEnum
|
|
isIn - [CargoBrokerDemurrageSettingEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
CargoBrokerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CargoBrokerFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CargoBrokerFormQueryWhere
}
CargoBrokerFormQueryWhere
Fields
Example
{
"and": [CargoBrokerFormQueryWhere],
"or": [CargoBrokerFormQueryWhere],
"rawExpression": "abc123",
"cargoID": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"brokerShortName": StringWhereValueExpression,
"commission": NumberWhereValueExpression,
"invoicingOptions": StringWhereValueExpression,
"alternateQty": NumberWhereValueExpression,
"alternateUnit": StringWhereValueExpression,
"brokerType": StringWhereValueExpression,
"alternateRate": NumberWhereValueExpression,
"commissionType": StringWhereValueExpression,
"commissionOrRebate": CargoBrokerCommissionOrRebateEnumValueExpression,
"isOwnerBroker": BoolWhereValueExpression,
"partialCommissionsEnabled": BoolWhereValueExpression,
"billVia": BoolWhereValueExpression,
"ruleGenerated": BoolWhereValueExpression,
"freightInvoiceSetting": CargoBrokerFreightInvoiceSettingEnumValueExpression,
"demurrageSetting": CargoBrokerDemurrageSettingEnumValueExpression,
"internalCounterpartyShortName": StringWhereValueExpression,
"internalCounterpartySequenceNo": NumberWhereValueExpression,
"addressBook": AddressBookFormQueryWhere,
"cargo": CargoFormQueryWhere
}
CargoBrokerFreightInvoiceSettingEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CargoBrokerFreightInvoiceSettingEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoBrokerFreightInvoiceSettingEnum
|
|
isNot - CargoBrokerFreightInvoiceSettingEnum
|
|
isIn - [CargoBrokerFreightInvoiceSettingEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
CargoBrokerRelationships
Fields
| Field Name | Description |
|---|---|
addressBook - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
childBroker - RelationshipDefinition
|
|
childBrokers - RelationshipDefinition
|
Example
{
"addressBook": RelationshipDefinition,
"cargo": RelationshipDefinition,
"childBroker": RelationshipDefinition,
"childBrokers": RelationshipDefinition
}
CargoBunkerConsumption
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
cargoID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
fuelType - String
|
|
heatingRate - Float
|
|
heatingDays - Float
|
|
isHeatingRateManual - Boolean
|
|
isHeatingDaysManual - Boolean
|
|
coolingRate - Float
|
|
coolingDays - Float
|
|
isCoolingRateManual - Boolean
|
|
isCoolingDaysManual - Boolean
|
|
iGSRate - Float
|
|
iGSDays - Float
|
|
isIGSRateManual - Boolean
|
|
isIGSDaysManual - Boolean
|
|
cleaningRate - Float
|
|
cleaningDays - Float
|
|
isCleaningRateManual - Boolean
|
|
isCleaningDaysManual - Boolean
|
|
cargo - Cargo
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"cargoID": 987,
"customFieldByID": Any,
"customField": Any,
"fuelType": "abc123",
"heatingRate": 987.65,
"heatingDays": 123.45,
"isHeatingRateManual": false,
"isHeatingDaysManual": true,
"coolingRate": 123.45,
"coolingDays": 123.45,
"isCoolingRateManual": true,
"isCoolingDaysManual": false,
"iGSRate": 987.65,
"iGSDays": 987.65,
"isIGSRateManual": false,
"isIGSDaysManual": false,
"cleaningRate": 987.65,
"cleaningDays": 987.65,
"isCleaningRateManual": false,
"isCleaningDaysManual": true,
"cargo": Cargo,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
CargoBunkerConsumptionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CargoBunkerConsumptionFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CargoBunkerConsumptionFormQueryWhere
}
CargoBunkerConsumptionFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CargoBunkerConsumptionFormQueryWhere!]
|
|
or - [CargoBunkerConsumptionFormQueryWhere!]
|
|
rawExpression - String
|
|
cargoID - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
heatingRate - NumberWhereValueExpression
|
|
heatingDays - NumberWhereValueExpression
|
|
isHeatingRateManual - BoolWhereValueExpression
|
|
isHeatingDaysManual - BoolWhereValueExpression
|
|
coolingRate - NumberWhereValueExpression
|
|
coolingDays - NumberWhereValueExpression
|
|
isCoolingRateManual - BoolWhereValueExpression
|
|
isCoolingDaysManual - BoolWhereValueExpression
|
|
iGSRate - NumberWhereValueExpression
|
|
iGSDays - NumberWhereValueExpression
|
|
isIGSRateManual - BoolWhereValueExpression
|
|
isIGSDaysManual - BoolWhereValueExpression
|
|
cleaningRate - NumberWhereValueExpression
|
|
cleaningDays - NumberWhereValueExpression
|
|
isCleaningRateManual - BoolWhereValueExpression
|
|
isCleaningDaysManual - BoolWhereValueExpression
|
|
cargo - CargoFormQueryWhere
|
Example
{
"and": [CargoBunkerConsumptionFormQueryWhere],
"or": [CargoBunkerConsumptionFormQueryWhere],
"rawExpression": "xyz789",
"cargoID": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"heatingRate": NumberWhereValueExpression,
"heatingDays": NumberWhereValueExpression,
"isHeatingRateManual": BoolWhereValueExpression,
"isHeatingDaysManual": BoolWhereValueExpression,
"coolingRate": NumberWhereValueExpression,
"coolingDays": NumberWhereValueExpression,
"isCoolingRateManual": BoolWhereValueExpression,
"isCoolingDaysManual": BoolWhereValueExpression,
"iGSRate": NumberWhereValueExpression,
"iGSDays": NumberWhereValueExpression,
"isIGSRateManual": BoolWhereValueExpression,
"isIGSDaysManual": BoolWhereValueExpression,
"cleaningRate": NumberWhereValueExpression,
"cleaningDays": NumberWhereValueExpression,
"isCleaningRateManual": BoolWhereValueExpression,
"isCleaningDaysManual": BoolWhereValueExpression,
"cargo": CargoFormQueryWhere
}
CargoBunkerConsumptionRelationships
Fields
| Field Name | Description |
|---|---|
cargo - RelationshipDefinition
|
Example
{"cargo": RelationshipDefinition}
CargoChangesSinceLast
Fields
| Field Name | Description |
|---|---|
nominateCargo - MessageUpdateResponse
|
|
updateCargo - MessageUpdateResponse
|
|
addVoyageCargo - MessageUpdateResponse
|
Example
{
"nominateCargo": MessageUpdateResponse,
"updateCargo": MessageUpdateResponse,
"addVoyageCargo": MessageUpdateResponse
}
CargoEmissionsBillingPeriodEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
CargoEmissionsBillingPeriodEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoEmissionsBillingPeriodEnum
|
|
isNot - CargoEmissionsBillingPeriodEnum
|
|
isIn - [CargoEmissionsBillingPeriodEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
CargoEmissionsSettlementTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NA"
CargoEmissionsSettlementTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoEmissionsSettlementTypeEnum
|
|
isNot - CargoEmissionsSettlementTypeEnum
|
|
isIn - [CargoEmissionsSettlementTypeEnum]
|
Example
{"is": "NA", "isNot": "NA", "isIn": ["NA"]}
CargoExposureBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
cargoID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seq - Int
|
|
bunkerSymbol - String
|
|
quantity - Float
|
|
price - Float
|
|
correlation - Float
|
|
adjustment - Float
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"cargoID": 987,
"customFieldByID": Any,
"customField": Any,
"seq": 123,
"bunkerSymbol": "abc123",
"quantity": 987.65,
"price": 123.45,
"correlation": 123.45,
"adjustment": 123.45,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
CargoExposureMethodEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Invalid"
CargoExposureMethodEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoExposureMethodEnum
|
|
isNot - CargoExposureMethodEnum
|
|
isIn - [CargoExposureMethodEnum]
|
Example
{"is": "Invalid", "isNot": "Invalid", "isIn": ["Invalid"]}
CargoFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CargoFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CargoFormQueryWhere
}
CargoFormQueryWhere
Fields
Example
{
"and": [CargoFormQueryWhere],
"or": [CargoFormQueryWhere],
"rawExpression": "xyz789",
"cargoID": NumberWhereValueExpression,
"coaNo": StringWhereValueExpression,
"freightType": StringWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"templateName": StringWhereValueExpression,
"cpQty": NumberWhereValueExpression,
"cargoAssigned": NumberWhereValueExpression,
"optionPercentage": NumberWhereValueExpression,
"optionType": StringWhereValueExpression,
"worldScaleRate": NumberWhereValueExpression,
"worldScaleLevel": NumberWhereValueExpression,
"freightRate": NumberWhereValueExpression,
"lumpsum": NumberWhereValueExpression,
"counterpartyShortName": StringWhereValueExpression,
"laycanFromLocal": DateWhereValueExpression,
"laycanToLocal": DateWhereValueExpression,
"dischDemurrageBase": NumberWhereValueExpression,
"dischDespatchBase": NumberWhereValueExpression,
"loadDemurrageBase": NumberWhereValueExpression,
"loadDespatchBase": NumberWhereValueExpression,
"contractType": StringWhereValueExpression,
"estimateID": StringWhereValueExpression,
"fixtureNo": StringWhereValueExpression,
"vslCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"coaID": NumberWhereValueExpression,
"saleContractID": NumberWhereValueExpression,
"purchaseContractID": NumberWhereValueExpression,
"loadPort": StringWhereValueExpression,
"dischPort": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"supplierShortName": StringWhereValueExpression,
"receiverShortName": StringWhereValueExpression,
"cargoUnit": StringWhereValueExpression,
"curr": StringWhereValueExpression,
"api": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"fixtureCargoSeq": NumberWhereValueExpression,
"scaleTable": BoolWhereValueExpression,
"isLaytimeRateHourly": BoolWhereValueExpression,
"partCargo": BoolWhereValueExpression,
"useFreightIndexTable": BoolWhereValueExpression,
"hasFreightIndexTable": BoolWhereValueExpression,
"useFreightSurchargeTable": BoolWhereValueExpression,
"hasFreightSurchargeTable": BoolWhereValueExpression,
"useBunkerCapCollarTable": BoolWhereValueExpression,
"hasBunkerCapCollarTable": BoolWhereValueExpression,
"inheritCoa": BoolWhereValueExpression,
"onSubjects": BoolWhereValueExpression,
"flag1": NumberWhereValueExpression,
"template": BoolWhereValueExpression,
"demoaCalendar": BoolWhereValueExpression,
"tSApprovalRequired": BoolWhereValueExpression,
"tSApprovalReceived": BoolWhereValueExpression,
"tSLoadOption": BoolWhereValueExpression,
"tSDischargeOption": BoolWhereValueExpression,
"transShipment": BoolWhereValueExpression,
"option": BoolWhereValueExpression,
"useBookingQtyOnScaleTable": BoolWhereValueExpression,
"inheritCoaExposure": BoolWhereValueExpression,
"demurrageOnAccount": BoolWhereValueExpression,
"laytimeReversible": BoolWhereValueExpression,
"persistent": BoolWhereValueExpression,
"sellerOption": BoolWhereValueExpression,
"inbound": BoolWhereValueExpression,
"additionalFlags": NumberWhereValueExpression,
"finalDestinationPortNo": NumberWhereValueExpression,
"vatNo": StringWhereValueExpression,
"internalBU": StringWhereValueExpression,
"minInvoiceQty": NumberWhereValueExpression,
"draft": NumberWhereValueExpression,
"laytimeAllowedHours": NumberWhereValueExpression,
"freightTaxBase": NumberWhereValueExpression,
"companyCode": StringWhereValueExpression,
"externalRef": StringWhereValueExpression,
"chtrCoordinator": StringWhereValueExpression,
"bookingNo": StringWhereValueExpression,
"bunkerScaleTable": StringWhereValueExpression,
"demScaleTable": StringWhereValueExpression,
"laytimeScaleTable": StringWhereValueExpression,
"freightRateTable": StringWhereValueExpression,
"demPct": NumberWhereValueExpression,
"lossPrice": NumberWhereValueExpression,
"basisEstimateID": StringWhereValueExpression,
"routeCorrelation": NumberWhereValueExpression,
"minQty": NumberWhereValueExpression,
"maxQty": NumberWhereValueExpression,
"cpDate": DateWhereValueExpression,
"cpForm": StringWhereValueExpression,
"demCurr": StringWhereValueExpression,
"loadDemRateCurr": NumberWhereValueExpression,
"discDemRateCurr": NumberWhereValueExpression,
"loadDespatchRateCurr": NumberWhereValueExpression,
"discDespatchRateCurr": NumberWhereValueExpression,
"demExchangeRate": NumberWhereValueExpression,
"tradeAreaNo": NumberWhereValueExpression,
"vesselType": StringWhereValueExpression,
"lobCode": StringWhereValueExpression,
"worldscaleYear": NumberWhereValueExpression,
"paymentTermsCode": StringWhereValueExpression,
"invoicePercent": NumberWhereValueExpression,
"baseDays": NumberWhereValueExpression,
"laytimeNOROffset": NumberWhereValueExpression,
"laytimeAllowed": NumberWhereValueExpression,
"laytimeAllowedUnitCode": StringWhereValueExpression,
"laytimeAllowedTerms": StringWhereValueExpression,
"laytimeAllowedFactor": NumberWhereValueExpression,
"refVoyageRoute": StringWhereValueExpression,
"oblNo": StringWhereValueExpression,
"coMingleNo": StringWhereValueExpression,
"trader": StringWhereValueExpression,
"commercialScheduler": StringWhereValueExpression,
"timeBarDays": NumberWhereValueExpression,
"balancePaymentTermsCode": StringWhereValueExpression,
"strategy": StringWhereValueExpression,
"nominatedQty": NumberWhereValueExpression,
"optionStatus": NumberWhereValueExpression,
"basisPrice_0": NumberWhereValueExpression,
"basisQty_0": NumberWhereValueExpression,
"basisSymbol_0": StringWhereValueExpression,
"basisBAF_0": NumberWhereValueExpression,
"basisPrice_1": NumberWhereValueExpression,
"basisQty_1": NumberWhereValueExpression,
"basisSymbol_1": StringWhereValueExpression,
"basisBAF_1": NumberWhereValueExpression,
"basisPrice_2": NumberWhereValueExpression,
"basisQty_2": NumberWhereValueExpression,
"basisSymbol_2": StringWhereValueExpression,
"basisBAF_2": NumberWhereValueExpression,
"basisPrice_3": NumberWhereValueExpression,
"basisQty_3": NumberWhereValueExpression,
"basisSymbol_3": StringWhereValueExpression,
"basisBAF_3": NumberWhereValueExpression,
"basisPrice_4": NumberWhereValueExpression,
"basisQty_4": NumberWhereValueExpression,
"basisSymbol_4": StringWhereValueExpression,
"basisBAF_4": NumberWhereValueExpression,
"basisPrice_5": NumberWhereValueExpression,
"basisQty_5": NumberWhereValueExpression,
"basisSymbol_5": StringWhereValueExpression,
"basisBAF_5": NumberWhereValueExpression,
"fobRefVoyageNo": NumberWhereValueExpression,
"currBase": StringWhereValueExpression,
"coaSeqNo": NumberWhereValueExpression,
"cpPlace": StringWhereValueExpression,
"rebillableWharfage": StringWhereValueExpression,
"rebillableDockage": StringWhereValueExpression,
"demurrageOnAccountBillingDays": NumberWhereValueExpression,
"isHeatingConsumptionEnabled": BoolWhereValueExpression,
"isHeatingPlusConsumptionEnabled": BoolWhereValueExpression,
"isHeatingPlusPlusConsumptionEnabled": BoolWhereValueExpression,
"isCoolingConsumptionEnabled": BoolWhereValueExpression,
"isStandardIGSConsumptionEnabled": BoolWhereValueExpression,
"isAutoLoadCleaningConsumptionEnabled": BoolWhereValueExpression,
"isAutoDischargeCleaningConsumptionEnabled": BoolWhereValueExpression,
"isManualCleaningConsumptionEnabled": BoolWhereValueExpression,
"isAutoDischargeIGSConsumptionEnabled": BoolWhereValueExpression,
"segment": StringWhereValueExpression,
"departmentNo": NumberWhereValueExpression,
"teamNo": NumberWhereValueExpression,
"refCompanyNo": NumberWhereValueExpression,
"parentMirroredContractID": NumberWhereValueExpression,
"childMirroredContractID": NumberWhereValueExpression,
"intercompany": BoolWhereValueExpression,
"intercompanyParent": BoolWhereValueExpression,
"intercompanyChild": BoolWhereValueExpression,
"hasUnpricedFreight": BoolWhereValueExpression,
"hasUnpricedBaf": BoolWhereValueExpression,
"laycanConfirmed": BoolWhereValueExpression,
"overageAsDeadfreight": BoolWhereValueExpression,
"coaPricingTemplate": BoolWhereValueExpression,
"deadfreightByTonnage": BoolWhereValueExpression,
"deadfreightByDraft": BoolWhereValueExpression,
"allocFreightToDiscVoy": BoolWhereValueExpression,
"isMarketCargo": BoolWhereValueExpression,
"hasUnacknowledgedRevisions": BoolWhereValueExpression,
"coaBaseTemplate": BoolWhereValueExpression,
"laytimeFloorCeiling": BoolWhereValueExpression,
"multiCargoFob": BoolWhereValueExpression,
"isVCOVHeadFixture": BoolWhereValueExpression,
"useFirmQtyOnScaleTable": BoolWhereValueExpression,
"isManualPartCargoFactor": BoolWhereValueExpression,
"useCommingledQtyOnScaleTable": BoolWhereValueExpression,
"isManualCO2ExchRate": BoolWhereValueExpression,
"isTradeUnit": BoolWhereValueExpression,
"isManualEmissionsSettlementType": BoolWhereValueExpression,
"isManualEmissionsBillingPeriod": BoolWhereValueExpression,
"isManualEmissionsPaymentTerms": BoolWhereValueExpression,
"emissionsBillPerLadenLeg": BoolWhereValueExpression,
"includePendingAllowanceInvoicesInPnL": BoolWhereValueExpression,
"isManualCarbonPricingMethod": BoolWhereValueExpression,
"additionalFlags4": NumberWhereValueExpression,
"optionDeclarationDate": DateWhereValueExpression,
"manualTce": NumberWhereValueExpression,
"iCCompanyCode": StringWhereValueExpression,
"iCAdjPercent": NumberWhereValueExpression,
"actDept": StringWhereValueExpression,
"agreedTemperature": NumberWhereValueExpression,
"refContract": StringWhereValueExpression,
"initialEstimateID": StringWhereValueExpression,
"agreedTemperatureUnit": StringWhereValueExpression,
"exposureMethod": CargoExposureMethodEnumValueExpression,
"contractDays": NumberWhereValueExpression,
"routeAdjustment": NumberWhereValueExpression,
"benchmarkBasis": CargoBenchmarkBasisEnumValueExpression,
"optionDeclaredDate": DateWhereValueExpression,
"exposureRefDate": DateWhereValueExpression,
"exposureBasisDate": DateWhereValueExpression,
"mTEquivalentFactor": NumberWhereValueExpression,
"vesselRef": StringWhereValueExpression,
"bunkerHedging": StringWhereValueExpression,
"bunkerHedgedByUser": StringWhereValueExpression,
"invoicedQty": NumberWhereValueExpression,
"counterpartyType": StringWhereValueExpression,
"primaryCargoID": NumberWhereValueExpression,
"coLoad": BoolWhereValueExpression,
"billByCPQty": BoolWhereValueExpression,
"billByOutturnQty": BoolWhereValueExpression,
"billByInvoiceQty": BoolWhereValueExpression,
"advancedPricing": BoolWhereValueExpression,
"usedFallbackFreight": BoolWhereValueExpression,
"fixFlags": NumberWhereValueExpression,
"linerTerms": CargoLinerTermsEnumValueExpression,
"confirmationDateGmt": DateWhereValueExpression,
"coaPeriodSeqNo": NumberWhereValueExpression,
"qtyAsPerformed": NumberWhereValueExpression,
"contractReference": StringWhereValueExpression,
"deadfreightAllowance": NumberWhereValueExpression,
"cpDraftInMeter": NumberWhereValueExpression,
"referenceTcCode": StringWhereValueExpression,
"profitSharePercent": NumberWhereValueExpression,
"correlationProfileName": StringWhereValueExpression,
"advancedPricingEstimateOnlyResults": NumberWhereValueExpression,
"advancedPricingOverriddenResults": NumberWhereValueExpression,
"salePriceBase": NumberWhereValueExpression,
"saleCurr": StringWhereValueExpression,
"saleExchangeRate": NumberWhereValueExpression,
"remittanceBank": StringWhereValueExpression,
"entryUserID": StringWhereValueExpression,
"firmedCPQty": NumberWhereValueExpression,
"partCargoFactor": NumberWhereValueExpression,
"cO2Symbol": StringWhereValueExpression,
"cO2Qty": NumberWhereValueExpression,
"cO2Price": NumberWhereValueExpression,
"cO2Currency": StringWhereValueExpression,
"cO2ExchRate": NumberWhereValueExpression,
"emissionsSettlementType": CargoEmissionsSettlementTypeEnumValueExpression,
"emissionsBillingPeriod": CargoEmissionsBillingPeriodEnumValueExpression,
"emissionsPaymentTermsCode": StringWhereValueExpression,
"docHolderName": StringWhereValueExpression,
"docHolderType": StringWhereValueExpression,
"allowanceDefaultPriceMode": CargoAllowanceDefaultPriceModeEnumValueExpression,
"fuelEUCalcDefault": CargoFuelEUCalcDefaultEnumValueExpression,
"emissionPaymentTerms": PaymentTermFormQueryWhere,
"childMirroredCargo": CargoFormQueryWhere,
"parentMirroredCargo": CargoFormQueryWhere,
"cargoBooking": CargoBookingFormQueryWhere,
"balancePaymentTerm": PaymentTermFormQueryWhere,
"paymentTerm": PaymentTermFormQueryWhere,
"addressBook": AddressBookFormQueryWhere,
"team": TeamFormQueryWhere,
"lob": LobFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"actDepartment": ActDepartmentFormQueryWhere,
"basisEstimate": VoyageEstimateFormQueryWhere,
"tradeArea": TradeAreaFormQueryWhere,
"fixture": FixtureFormQueryWhere,
"voyageEstimate": VoyageEstimateFormQueryWhere,
"counterparty": AddressBookFormQueryWhere,
"coa": COAFormQueryWhere,
"cargoName": CargoNameFormQueryWhere,
"company": AddressBookFormQueryWhere,
"vessel": VesselFormQueryWhere,
"benchmarkEstimate": BenchmarkEstimateFormQueryWhere,
"firstLoadCargoHandling": VoyageCargoHandlingFormQueryWhere,
"firstDiscCargoHandling": VoyageCargoHandlingFormQueryWhere,
"firstLoadCargoHandlingRelet": VoyageCargoHandlingFormQueryWhere,
"firstDiscCargoHandlingRelet": VoyageCargoHandlingFormQueryWhere,
"lastLoadCargoHandling": VoyageCargoHandlingFormQueryWhere,
"lastDiscCargoHandling": VoyageCargoHandlingFormQueryWhere,
"firstCargoLoadItin": CargoItineraryFormQueryWhere,
"firstCargoDiscItin": CargoItineraryFormQueryWhere,
"lastCargoDiscItin": CargoItineraryFormQueryWhere,
"firstCargoTSLoadItin": CargoItineraryFormQueryWhere,
"firstCargoTSDiscItin": CargoItineraryFormQueryWhere,
"chtrBroker": CargoBrokerFormQueryWhere,
"ownerBroker": CargoBrokerFormQueryWhere,
"firstBroker": CargoBrokerFormQueryWhere,
"saleCargo": CargoFormQueryWhere,
"purchaseCargo": CargoFormQueryWhere,
"requiredVesselType": VesselTypeFormQueryWhere,
"chtrCoordinatorUser": ImosUserFormQueryWhere
}
CargoFuelEUCalcDefaultEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NA"
CargoFuelEUCalcDefaultEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoFuelEUCalcDefaultEnum
|
|
isNot - CargoFuelEUCalcDefaultEnum
|
|
isIn - [CargoFuelEUCalcDefaultEnum]
|
Example
{"is": "NA", "isNot": "NA", "isIn": ["NA"]}
CargoGrades
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
loadPorts - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
dischargePorts - String
|
|
loadCargoQuantities - String
|
|
dischargeCargoQuantities - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
cargoGrade - String
|
|
cargoGroup - String
|
|
charterer - String
|
|
fixtureCargoSeq - Int
|
|
voyage - [Voyage]
|
|
voyageCargoHandlings - [VoyageCargoHandling]
|
|
loadCargoHandlings - [VoyageCargoHandling]
|
|
discCargoHandlings - [VoyageCargoHandling]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"loadPorts": "xyz789",
"customFieldByID": Any,
"customField": Any,
"dischargePorts": "abc123",
"loadCargoQuantities": "xyz789",
"dischargeCargoQuantities": "xyz789",
"vesselCode": "xyz789",
"voyageNo": 987,
"cargoGrade": "abc123",
"cargoGroup": "abc123",
"charterer": "abc123",
"fixtureCargoSeq": 123,
"voyage": [Voyage],
"voyageCargoHandlings": [VoyageCargoHandling],
"loadCargoHandlings": [VoyageCargoHandling],
"discCargoHandlings": [VoyageCargoHandling],
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
CargoGradesRelationships
Fields
| Field Name | Description |
|---|---|
voyage - RelationshipDefinition
|
|
voyageCargoHandlings - RelationshipDefinition
|
|
loadCargoHandlings - RelationshipDefinition
|
|
discCargoHandlings - RelationshipDefinition
|
Example
{
"voyage": RelationshipDefinition,
"voyageCargoHandlings": RelationshipDefinition,
"loadCargoHandlings": RelationshipDefinition,
"discCargoHandlings": RelationshipDefinition
}
CargoHandlingEventType
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
id - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
name - String
|
|
startCode - String
|
|
endCode - String
|
|
orderNo - Int
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
createdByUser - String
|
|
lastUserID - String
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"id": 987,
"customFieldByID": Any,
"customField": Any,
"name": "xyz789",
"startCode": "abc123",
"endCode": "xyz789",
"orderNo": 123,
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"createdByUser": "xyz789",
"lastUserID": "xyz789",
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
CargoHandlingEventTypeFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CargoHandlingEventTypeFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CargoHandlingEventTypeFormQueryWhere
}
CargoHandlingEventTypeFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CargoHandlingEventTypeFormQueryWhere!]
|
|
or - [CargoHandlingEventTypeFormQueryWhere!]
|
|
rawExpression - String
|
|
id - NumberWhereValueExpression
|
|
name - StringWhereValueExpression
|
|
startCode - StringWhereValueExpression
|
|
endCode - StringWhereValueExpression
|
|
orderNo - NumberWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
createdByUser - StringWhereValueExpression
|
|
lastUserID - StringWhereValueExpression
|
Example
{
"and": [CargoHandlingEventTypeFormQueryWhere],
"or": [CargoHandlingEventTypeFormQueryWhere],
"rawExpression": "xyz789",
"id": NumberWhereValueExpression,
"name": StringWhereValueExpression,
"startCode": StringWhereValueExpression,
"endCode": StringWhereValueExpression,
"orderNo": NumberWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"createdByUser": StringWhereValueExpression,
"lastUserID": StringWhereValueExpression
}
CargoHandlingListInput
Description
Submits a veslink CargoHandlingList transaction
Fields
| Input Field | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
|
seq - Int
|
|
voyageCargoHandlings - [CargoHandlingList_VoyageCargoHandlingsInput]!
|
|
referenceDate - Date
|
Reference date for this message, used to infer which voyage itinerary leg to submit against if no seq is specified. |
Example
{
"vesselCode": "xyz789",
"voyageNo": 123,
"seq": 987,
"voyageCargoHandlings": [
CargoHandlingList_VoyageCargoHandlingsInput
],
"referenceDate": "2007-12-03"
}
CargoHandlingListMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": false,
"context": ["xyz789"],
"timestamp": "abc123",
"originalTimestamp": "xyz789",
"intent": "xyz789",
"from": "xyz789",
"to": ["abc123"],
"fromUser": "abc123",
"status": "abc123",
"approvalStatus": "xyz789",
"objectId": "xyz789",
"type": "xyz789",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "abc123",
"unmapped": false,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["xyz789"],
"parentMessageId": "xyz789",
"preResolutionObjectId": "abc123",
"title": "xyz789",
"effectiveDate": "xyz789",
"source": "abc123",
"sourceId": "abc123",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": false,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
CargoHandlingList_VoyageCargoHandlingsInput
Fields
| Input Field | Description |
|---|---|
cargoShortName - String
|
|
functionCode - String
|
|
cargoID - Int
|
|
seqNo - Int
|
|
berthSeqNo - Int
|
|
blCode - String
|
|
blDate - Date
|
|
cpUnit - String
|
|
blQuantity - Float
|
|
shipGross - Float
|
|
blDraft - Float
|
|
shipLTemp - Float
|
|
apiShip - Float
|
|
gsvShore - Float
|
|
altCPUnit - String
|
|
altBLGross - Float
|
|
altShipGross - Float
|
|
isLopFiled - Boolean
|
|
isWarrantyConditionsMet - Boolean
|
|
voyageCargoHandlingDocuments - [CargoHandlingList_VoyageCargoHandlingsInput_VoyageCargoHandlingDocumentsInput]!
|
|
voyageCargoHandlingStowages - [CargoHandlingList_VoyageCargoHandlingsInput_VoyageCargoHandlingStowagesInput]!
|
|
berthShortName - String
|
|
blDraftUnit - String
|
Example
{
"cargoShortName": "abc123",
"functionCode": "xyz789",
"cargoID": 987,
"seqNo": 123,
"berthSeqNo": 987,
"blCode": "xyz789",
"blDate": "2007-12-03",
"cpUnit": "xyz789",
"blQuantity": 123.45,
"shipGross": 123.45,
"blDraft": 123.45,
"shipLTemp": 123.45,
"apiShip": 123.45,
"gsvShore": 123.45,
"altCPUnit": "xyz789",
"altBLGross": 123.45,
"altShipGross": 123.45,
"isLopFiled": true,
"isWarrantyConditionsMet": false,
"voyageCargoHandlingDocuments": [
CargoHandlingList_VoyageCargoHandlingsInput_VoyageCargoHandlingDocumentsInput
],
"voyageCargoHandlingStowages": [
CargoHandlingList_VoyageCargoHandlingsInput_VoyageCargoHandlingStowagesInput
],
"berthShortName": "xyz789",
"blDraftUnit": "xyz789"
}
CargoHandlingList_VoyageCargoHandlingsInput_VoyageCargoHandlingDocumentsInput
CargoHandlingList_VoyageCargoHandlingsInput_VoyageCargoHandlingStowagesInput
CargoItinerary
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
cargoQtyString - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
cargoLoad - String
|
|
etaGmt - Date
|
|
etrGmt - Date
|
|
etbLocal - Date
|
|
etbPilotBerthLocal - Date
|
|
firmingEtaLocal - Date
|
|
firmingEtdLocal - Date
|
|
portName - String
|
|
optionTypeDescription - String
|
|
cargoID - Int
|
|
seqNo - Int
|
|
portNo - Int
|
|
berthShortName - String
|
|
salinity - Float
|
|
cargoShortName - String
|
|
portFunc - String
|
|
cargoQty - Float
|
|
terms - String
|
|
loadDiscRate - Float
|
|
termsFactor - Float
|
|
rateUnit - String
|
|
portDays - Float
|
|
extraPortDays - Float
|
|
api - Float
|
|
grainBale - String
|
|
boardToBoard - String
|
|
portExpAmountBase - Int
|
|
otherExpAmountBase - Int
|
|
lastUpdateGmt - Date
|
|
cargoUnit - String
|
|
cargoDescription - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
heated - Boolean
|
|
transShipment - Boolean
|
|
interService - Boolean
|
|
manualLDRate - Boolean
|
|
manualTurntime - Boolean
|
|
useCrane - Boolean
|
|
gradeSeqNo - Int
|
|
commercialID - String
|
|
optionType - String
|
|
agentShortName - String
|
|
vesselCode - String
|
|
etaLocal - Date
|
|
etrLocal - Date
|
|
remarks - String
|
|
supplierReceiver - String
|
|
boardToBoardVesselName - String
|
|
internalBU - String
|
|
portExpCurr - String
|
|
portExpAmountCurr - Int
|
|
exchangeRate - Float
|
|
norHours - Float
|
|
etsLocal - Date
|
|
demDespDays - Float
|
|
idleDays - Float
|
|
reletLoadDiscRate - Float
|
|
reletLoadDiscUnit - String
|
|
reletTurntimeHours - Float
|
|
reletTerms - String
|
|
reletFactor - Float
|
|
draftBasis - String
|
|
reletDemDays - Float
|
|
option - String
|
|
optionPercent - Float
|
|
minQty - Int
|
|
maxQty - Int
|
|
timebarBasisDate - Date
|
|
transShipmentCargoID - Int
|
|
transShipmentPortNo - Int
|
|
transShipmentFreightRate - Float
|
|
transShipmentFreightType - String
|
|
altQty - Float
|
|
altUnit - String
|
|
commercialScheduler - String
|
|
trader - String
|
|
shipToShipTransferVesselCode - String
|
|
externalRef - String
|
|
shipToShipLighteringVesselName - String
|
|
qtyDescription - String
|
|
gracePeriodHours - Float
|
|
btuQty - Float
|
|
stevedoringExpAmountBase - Float
|
|
stevedoringExpAmountCurr - Float
|
|
conversionFactor - Float
|
|
transshipmentCPLoadDiscRate - Float
|
|
transshipmentCPRateUnit - String
|
|
transshipmentCPTerms - String
|
|
transshipmentCPNorHours - Float
|
|
firmingEtaGmt - Date
|
|
firmingEtdGmt - Date
|
|
commodityContractId - Int
|
|
commodityContract - CommodityContract
|
|
transShipmentCargo - Cargo
|
|
vessel - Vessel
|
|
agent - AddressBook
|
|
cargoName - CargoName
|
|
port - Port
|
|
cargo - Cargo
|
|
portBerth - PortBerth
|
|
portFunction - PortFunction
|
|
voyageCargoHandling - VoyageCargoHandling
|
|
voyageItinerary - VoyageItinerary
|
|
laytimeTerms - LaytimeTerms
|
|
userDefinedFields - Json
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"cargoQtyString": "xyz789",
"customFieldByID": Any,
"customField": Any,
"cargoLoad": "abc123",
"etaGmt": "2007-12-03",
"etrGmt": "2007-12-03",
"etbLocal": "2007-12-03",
"etbPilotBerthLocal": "2007-12-03",
"firmingEtaLocal": "2007-12-03",
"firmingEtdLocal": "2007-12-03",
"portName": "abc123",
"optionTypeDescription": "abc123",
"cargoID": 123,
"seqNo": 987,
"portNo": 123,
"berthShortName": "abc123",
"salinity": 987.65,
"cargoShortName": "abc123",
"portFunc": "abc123",
"cargoQty": 987.65,
"terms": "abc123",
"loadDiscRate": 987.65,
"termsFactor": 123.45,
"rateUnit": "abc123",
"portDays": 987.65,
"extraPortDays": 123.45,
"api": 123.45,
"grainBale": "abc123",
"boardToBoard": "abc123",
"portExpAmountBase": 987,
"otherExpAmountBase": 987,
"lastUpdateGmt": "2007-12-03",
"cargoUnit": "xyz789",
"cargoDescription": "abc123",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"heated": true,
"transShipment": true,
"interService": false,
"manualLDRate": true,
"manualTurntime": false,
"useCrane": true,
"gradeSeqNo": 987,
"commercialID": "xyz789",
"optionType": "abc123",
"agentShortName": "abc123",
"vesselCode": "xyz789",
"etaLocal": "2007-12-03",
"etrLocal": "2007-12-03",
"remarks": "abc123",
"supplierReceiver": "abc123",
"boardToBoardVesselName": "abc123",
"internalBU": "xyz789",
"portExpCurr": "abc123",
"portExpAmountCurr": 987,
"exchangeRate": 987.65,
"norHours": 987.65,
"etsLocal": "2007-12-03",
"demDespDays": 987.65,
"idleDays": 123.45,
"reletLoadDiscRate": 987.65,
"reletLoadDiscUnit": "xyz789",
"reletTurntimeHours": 987.65,
"reletTerms": "xyz789",
"reletFactor": 123.45,
"draftBasis": "xyz789",
"reletDemDays": 123.45,
"option": "abc123",
"optionPercent": 123.45,
"minQty": 123,
"maxQty": 987,
"timebarBasisDate": "2007-12-03",
"transShipmentCargoID": 987,
"transShipmentPortNo": 123,
"transShipmentFreightRate": 987.65,
"transShipmentFreightType": "abc123",
"altQty": 123.45,
"altUnit": "abc123",
"commercialScheduler": "abc123",
"trader": "xyz789",
"shipToShipTransferVesselCode": "abc123",
"externalRef": "abc123",
"shipToShipLighteringVesselName": "xyz789",
"qtyDescription": "xyz789",
"gracePeriodHours": 987.65,
"btuQty": 123.45,
"stevedoringExpAmountBase": 987.65,
"stevedoringExpAmountCurr": 987.65,
"conversionFactor": 123.45,
"transshipmentCPLoadDiscRate": 987.65,
"transshipmentCPRateUnit": "xyz789",
"transshipmentCPTerms": "abc123",
"transshipmentCPNorHours": 123.45,
"firmingEtaGmt": "2007-12-03",
"firmingEtdGmt": "2007-12-03",
"commodityContractId": 123,
"commodityContract": CommodityContract,
"transShipmentCargo": Cargo,
"vessel": Vessel,
"agent": AddressBook,
"cargoName": CargoName,
"port": Port,
"cargo": Cargo,
"portBerth": PortBerth,
"portFunction": PortFunction,
"voyageCargoHandling": VoyageCargoHandling,
"voyageItinerary": VoyageItinerary,
"laytimeTerms": LaytimeTerms,
"userDefinedFields": Json,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
CargoItineraryFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CargoItineraryFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CargoItineraryFormQueryWhere
}
CargoItineraryFormQueryWhere
Fields
Example
{
"and": [CargoItineraryFormQueryWhere],
"or": [CargoItineraryFormQueryWhere],
"rawExpression": "abc123",
"cargoID": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"berthShortName": StringWhereValueExpression,
"salinity": NumberWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"portFunc": StringWhereValueExpression,
"cargoQty": NumberWhereValueExpression,
"terms": StringWhereValueExpression,
"loadDiscRate": NumberWhereValueExpression,
"termsFactor": NumberWhereValueExpression,
"rateUnit": StringWhereValueExpression,
"portDays": NumberWhereValueExpression,
"extraPortDays": NumberWhereValueExpression,
"api": NumberWhereValueExpression,
"grainBale": StringWhereValueExpression,
"boardToBoard": StringWhereValueExpression,
"portExpAmountBase": NumberWhereValueExpression,
"otherExpAmountBase": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"cargoUnit": StringWhereValueExpression,
"cargoDescription": StringWhereValueExpression,
"laycanFromLocal": DateWhereValueExpression,
"laycanToLocal": DateWhereValueExpression,
"heated": BoolWhereValueExpression,
"transShipment": BoolWhereValueExpression,
"interService": BoolWhereValueExpression,
"manualLDRate": BoolWhereValueExpression,
"manualTurntime": BoolWhereValueExpression,
"useCrane": BoolWhereValueExpression,
"gradeSeqNo": NumberWhereValueExpression,
"commercialID": StringWhereValueExpression,
"optionType": StringWhereValueExpression,
"agentShortName": StringWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"etaLocal": DateWhereValueExpression,
"etrLocal": DateWhereValueExpression,
"remarks": StringWhereValueExpression,
"supplierReceiver": StringWhereValueExpression,
"boardToBoardVesselName": StringWhereValueExpression,
"internalBU": StringWhereValueExpression,
"portExpCurr": StringWhereValueExpression,
"portExpAmountCurr": NumberWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"norHours": NumberWhereValueExpression,
"etsLocal": DateWhereValueExpression,
"demDespDays": NumberWhereValueExpression,
"idleDays": NumberWhereValueExpression,
"reletLoadDiscRate": NumberWhereValueExpression,
"reletLoadDiscUnit": StringWhereValueExpression,
"reletTurntimeHours": NumberWhereValueExpression,
"reletTerms": StringWhereValueExpression,
"reletFactor": NumberWhereValueExpression,
"draftBasis": StringWhereValueExpression,
"reletDemDays": NumberWhereValueExpression,
"option": StringWhereValueExpression,
"optionPercent": NumberWhereValueExpression,
"minQty": NumberWhereValueExpression,
"maxQty": NumberWhereValueExpression,
"timebarBasisDate": DateWhereValueExpression,
"transShipmentCargoID": NumberWhereValueExpression,
"transShipmentPortNo": NumberWhereValueExpression,
"transShipmentFreightRate": NumberWhereValueExpression,
"transShipmentFreightType": StringWhereValueExpression,
"altQty": NumberWhereValueExpression,
"altUnit": StringWhereValueExpression,
"commercialScheduler": StringWhereValueExpression,
"trader": StringWhereValueExpression,
"shipToShipTransferVesselCode": StringWhereValueExpression,
"externalRef": StringWhereValueExpression,
"shipToShipLighteringVesselName": StringWhereValueExpression,
"qtyDescription": StringWhereValueExpression,
"gracePeriodHours": NumberWhereValueExpression,
"btuQty": NumberWhereValueExpression,
"stevedoringExpAmountBase": NumberWhereValueExpression,
"stevedoringExpAmountCurr": NumberWhereValueExpression,
"conversionFactor": NumberWhereValueExpression,
"transshipmentCPLoadDiscRate": NumberWhereValueExpression,
"transshipmentCPRateUnit": StringWhereValueExpression,
"transshipmentCPTerms": StringWhereValueExpression,
"transshipmentCPNorHours": NumberWhereValueExpression,
"firmingEtaGmt": DateWhereValueExpression,
"firmingEtdGmt": DateWhereValueExpression,
"commodityContractId": NumberWhereValueExpression,
"commodityContract": CommodityContractFormQueryWhere,
"transShipmentCargo": CargoFormQueryWhere,
"vessel": VesselFormQueryWhere,
"agent": AddressBookFormQueryWhere,
"cargoName": CargoNameFormQueryWhere,
"port": PortFormQueryWhere,
"cargo": CargoFormQueryWhere,
"portBerth": PortBerthFormQueryWhere,
"portFunction": PortFunctionFormQueryWhere,
"voyageCargoHandling": VoyageCargoHandlingFormQueryWhere,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"laytimeTerms": LaytimeTermsFormQueryWhere
}
CargoItineraryRelationships
Fields
| Field Name | Description |
|---|---|
commodityContract - RelationshipDefinition
|
|
transShipmentCargo - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
agent - RelationshipDefinition
|
|
cargoName - RelationshipDefinition
|
|
port - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
portBerth - RelationshipDefinition
|
|
portFunction - RelationshipDefinition
|
|
voyageCargoHandling - RelationshipDefinition
|
|
voyageItinerary - RelationshipDefinition
|
|
laytimeTerms - RelationshipDefinition
|
Example
{
"commodityContract": RelationshipDefinition,
"transShipmentCargo": RelationshipDefinition,
"vessel": RelationshipDefinition,
"agent": RelationshipDefinition,
"cargoName": RelationshipDefinition,
"port": RelationshipDefinition,
"cargo": RelationshipDefinition,
"portBerth": RelationshipDefinition,
"portFunction": RelationshipDefinition,
"voyageCargoHandling": RelationshipDefinition,
"voyageItinerary": RelationshipDefinition,
"laytimeTerms": RelationshipDefinition
}
CargoLinerTermsEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CargoLinerTermsEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoLinerTermsEnum
|
|
isNot - CargoLinerTermsEnum
|
|
isIn - [CargoLinerTermsEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
CargoLinkedTrade
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
qty - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
rateUnit - String
|
|
sqlID - Int
|
|
cargoID - Int
|
|
tradeID - Int
|
|
monthIndex - Int
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
isManualQty - Boolean
|
|
isSellCarbonAllowanceAllocation - Boolean
|
|
tcCode - String
|
|
linkedTradeID - Int
|
|
bunkerPurchaseID - Int
|
|
bunkerPurchaseFuelType - String
|
|
bunkerInquiriesAndPurchases - BunkerInquiriesAndPurchases
|
|
linkedTrade - PaperTrade
|
|
paperTrade - PaperTrade
|
|
cargo - Cargo
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"qty": 123.45,
"customFieldByID": Any,
"customField": Any,
"rateUnit": "abc123",
"sqlID": 123,
"cargoID": 987,
"tradeID": 987,
"monthIndex": 987,
"lastUser": "abc123",
"lastUpdateGmt": "2007-12-03",
"isManualQty": true,
"isSellCarbonAllowanceAllocation": true,
"tcCode": "xyz789",
"linkedTradeID": 123,
"bunkerPurchaseID": 123,
"bunkerPurchaseFuelType": "xyz789",
"bunkerInquiriesAndPurchases": BunkerInquiriesAndPurchases,
"linkedTrade": PaperTrade,
"paperTrade": PaperTrade,
"cargo": Cargo,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
CargoLinkedTradeFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CargoLinkedTradeFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CargoLinkedTradeFormQueryWhere
}
CargoLinkedTradeFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CargoLinkedTradeFormQueryWhere!]
|
|
or - [CargoLinkedTradeFormQueryWhere!]
|
|
rawExpression - String
|
|
cargoID - NumberWhereValueExpression
|
|
tradeID - NumberWhereValueExpression
|
|
monthIndex - NumberWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
isManualQty - BoolWhereValueExpression
|
|
isSellCarbonAllowanceAllocation - BoolWhereValueExpression
|
|
tcCode - StringWhereValueExpression
|
|
linkedTradeID - NumberWhereValueExpression
|
|
bunkerPurchaseID - NumberWhereValueExpression
|
|
bunkerPurchaseFuelType - StringWhereValueExpression
|
|
bunkerInquiriesAndPurchases - BunkerInquiriesAndPurchasesFormQueryWhere
|
|
linkedTrade - PaperTradeFormQueryWhere
|
|
paperTrade - PaperTradeFormQueryWhere
|
|
cargo - CargoFormQueryWhere
|
Example
{
"and": [CargoLinkedTradeFormQueryWhere],
"or": [CargoLinkedTradeFormQueryWhere],
"rawExpression": "abc123",
"cargoID": NumberWhereValueExpression,
"tradeID": NumberWhereValueExpression,
"monthIndex": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"isManualQty": BoolWhereValueExpression,
"isSellCarbonAllowanceAllocation": BoolWhereValueExpression,
"tcCode": StringWhereValueExpression,
"linkedTradeID": NumberWhereValueExpression,
"bunkerPurchaseID": NumberWhereValueExpression,
"bunkerPurchaseFuelType": StringWhereValueExpression,
"bunkerInquiriesAndPurchases": BunkerInquiriesAndPurchasesFormQueryWhere,
"linkedTrade": PaperTradeFormQueryWhere,
"paperTrade": PaperTradeFormQueryWhere,
"cargo": CargoFormQueryWhere
}
CargoLinkedTradeRelationships
Fields
| Field Name | Description |
|---|---|
bunkerInquiriesAndPurchases - RelationshipDefinition
|
|
linkedTrade - RelationshipDefinition
|
|
paperTrade - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
Example
{
"bunkerInquiriesAndPurchases": RelationshipDefinition,
"linkedTrade": RelationshipDefinition,
"paperTrade": RelationshipDefinition,
"cargo": RelationshipDefinition
}
CargoLoadDischargeOption
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
cargoID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seqNo - Int
|
|
portNo - Int
|
|
portFunc - String
|
|
terms - String
|
|
loadDiscRate - Float
|
|
rateUnit - String
|
|
norHours - Float
|
|
portExpAmountBase - Int
|
|
portExpCurr - String
|
|
portExpAmountCurr - Int
|
|
exchangeRate - Float
|
|
berthShortName - String
|
|
cargo - Cargo
|
|
port - Port
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"cargoID": 987,
"customFieldByID": Any,
"customField": Any,
"seqNo": 987,
"portNo": 123,
"portFunc": "abc123",
"terms": "xyz789",
"loadDiscRate": 987.65,
"rateUnit": "xyz789",
"norHours": 987.65,
"portExpAmountBase": 123,
"portExpCurr": "xyz789",
"portExpAmountCurr": 987,
"exchangeRate": 123.45,
"berthShortName": "xyz789",
"cargo": Cargo,
"port": Port,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
CargoLoadDischargeOptionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CargoLoadDischargeOptionFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CargoLoadDischargeOptionFormQueryWhere
}
CargoLoadDischargeOptionFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CargoLoadDischargeOptionFormQueryWhere!]
|
|
or - [CargoLoadDischargeOptionFormQueryWhere!]
|
|
rawExpression - String
|
|
cargoID - NumberWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
portNo - NumberWhereValueExpression
|
|
portFunc - StringWhereValueExpression
|
|
terms - StringWhereValueExpression
|
|
loadDiscRate - NumberWhereValueExpression
|
|
rateUnit - StringWhereValueExpression
|
|
norHours - NumberWhereValueExpression
|
|
portExpAmountBase - NumberWhereValueExpression
|
|
portExpCurr - StringWhereValueExpression
|
|
portExpAmountCurr - NumberWhereValueExpression
|
|
exchangeRate - NumberWhereValueExpression
|
|
berthShortName - StringWhereValueExpression
|
|
cargo - CargoFormQueryWhere
|
|
port - PortFormQueryWhere
|
Example
{
"and": [CargoLoadDischargeOptionFormQueryWhere],
"or": [CargoLoadDischargeOptionFormQueryWhere],
"rawExpression": "abc123",
"cargoID": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"portFunc": StringWhereValueExpression,
"terms": StringWhereValueExpression,
"loadDiscRate": NumberWhereValueExpression,
"rateUnit": StringWhereValueExpression,
"norHours": NumberWhereValueExpression,
"portExpAmountBase": NumberWhereValueExpression,
"portExpCurr": StringWhereValueExpression,
"portExpAmountCurr": NumberWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"berthShortName": StringWhereValueExpression,
"cargo": CargoFormQueryWhere,
"port": PortFormQueryWhere
}
CargoLoadDischargeOptionRelationships
Fields
| Field Name | Description |
|---|---|
cargo - RelationshipDefinition
|
|
port - RelationshipDefinition
|
Example
{
"cargo": RelationshipDefinition,
"port": RelationshipDefinition
}
CargoMatchingProgram
Fields
| Field Name | Description |
|---|---|
programID - String
|
|
programType - String
|
|
programName - String
|
|
programXML - String
|
|
baseViewID - String
|
|
baseViewType - String
|
|
owner - String
|
|
hiddenProgram - Boolean
|
|
flags - Int
|
|
cargoMatchingProgram - CargoMatchingProgram
|
|
user - User
|
|
cargoMatchingPrograms - [CargoMatchingProgram]
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"programID": "abc123",
"programType": "abc123",
"programName": "xyz789",
"programXML": "xyz789",
"baseViewID": "abc123",
"baseViewType": "xyz789",
"owner": "abc123",
"hiddenProgram": true,
"flags": 987,
"cargoMatchingProgram": CargoMatchingProgram,
"user": User,
"cargoMatchingPrograms": [CargoMatchingProgram],
"_id": "xyz789",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
CargoMatchingProgramBaseViewTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CargoMatchingProgramBaseViewTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoMatchingProgramBaseViewTypeEnum
|
|
isNot - CargoMatchingProgramBaseViewTypeEnum
|
|
isIn - [CargoMatchingProgramBaseViewTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
CargoMatchingProgramFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CargoMatchingProgramFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CargoMatchingProgramFormQueryWhere
}
CargoMatchingProgramFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CargoMatchingProgramFormQueryWhere!]
|
|
or - [CargoMatchingProgramFormQueryWhere!]
|
|
rawExpression - String
|
|
programID - StringWhereValueExpression
|
|
programType - CargoMatchingProgramProgramTypeEnumValueExpression
|
|
programName - StringWhereValueExpression
|
|
programXML - StringWhereValueExpression
|
|
baseViewID - StringWhereValueExpression
|
|
baseViewType - CargoMatchingProgramBaseViewTypeEnumValueExpression
|
|
owner - StringWhereValueExpression
|
|
hiddenProgram - BoolWhereValueExpression
|
|
flags - NumberWhereValueExpression
|
|
cargoMatchingProgram - CargoMatchingProgramFormQueryWhere
|
|
user - UserFormQueryWhere
|
Example
{
"and": [CargoMatchingProgramFormQueryWhere],
"or": [CargoMatchingProgramFormQueryWhere],
"rawExpression": "abc123",
"programID": StringWhereValueExpression,
"programType": CargoMatchingProgramProgramTypeEnumValueExpression,
"programName": StringWhereValueExpression,
"programXML": StringWhereValueExpression,
"baseViewID": StringWhereValueExpression,
"baseViewType": CargoMatchingProgramBaseViewTypeEnumValueExpression,
"owner": StringWhereValueExpression,
"hiddenProgram": BoolWhereValueExpression,
"flags": NumberWhereValueExpression,
"cargoMatchingProgram": CargoMatchingProgramFormQueryWhere,
"user": UserFormQueryWhere
}
CargoMatchingProgramProgramTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CargoMatchingProgramProgramTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoMatchingProgramProgramTypeEnum
|
|
isNot - CargoMatchingProgramProgramTypeEnum
|
|
isIn - [CargoMatchingProgramProgramTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
CargoMatchingProgramRelationships
Fields
| Field Name | Description |
|---|---|
cargoMatchingProgram - RelationshipDefinition
|
|
user - RelationshipDefinition
|
|
cargoMatchingPrograms - RelationshipDefinition
|
Example
{
"cargoMatchingProgram": RelationshipDefinition,
"user": RelationshipDefinition,
"cargoMatchingPrograms": RelationshipDefinition
}
CargoName
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
capacityBasisString - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
cargoGroup - String
|
|
stowFactorFt3 - Float
|
|
isActive - Boolean
|
|
description - String
|
|
billBy - String
|
|
sqlID - Int
|
|
shortName - String
|
|
fullName - String
|
|
description1 - String
|
|
description2 - String
|
|
description3 - String
|
|
description4 - String
|
|
description5 - String
|
|
description6 - String
|
|
description7 - String
|
|
description8 - String
|
|
description9 - String
|
|
productCode - String
|
|
lastUpdateGmt - Date
|
|
api - Float
|
|
type - String
|
|
lastUserID - String
|
|
isDangerous - Boolean
|
|
isInactive - Boolean
|
|
isPreClearance - Boolean
|
|
isCapBasisGrain - Boolean
|
|
isCapBasisBale - Boolean
|
|
mTBE - Boolean
|
|
fAME - Boolean
|
|
eTBE - Boolean
|
|
isPersistent - Boolean
|
|
billByCPQty - Boolean
|
|
billByInvoiceQty - Boolean
|
|
billByOutturnQty - Boolean
|
|
isSpecialHandlingRequired - Boolean
|
|
imoName - String
|
|
unNum - String
|
|
unClass - String
|
|
bcCodeGroup - String
|
|
cpUnit - String
|
|
liftUnit - String
|
|
altLiftUnit - String
|
|
bcCode - String
|
|
onshoreProductUrl - String
|
|
onboardProductUrl - String
|
|
uSCGName - String
|
|
mARPOLCategory - String
|
|
imoShipType - String
|
|
sGTempBasisDegree - Float
|
|
sGTempCoefficient - Float
|
|
sGTempScale - String
|
|
meltingPoint - Float
|
|
meltingPointTempScale - String
|
|
boilingPoint - Float
|
|
boilingPointTempScale - String
|
|
imoClass - String
|
|
adnrEniClass - String
|
|
uSCGGrade - String
|
|
uSCGSubchapter - String
|
|
uSCGCargoName - String
|
|
cargoType - CargoType
|
|
cpUnitData - UnitOfMeasure
|
|
liftUnitData - UnitOfMeasure
|
|
altLiftUnitData - UnitOfMeasure
|
|
userDefinedFields - Json
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"capacityBasisString": "xyz789",
"customFieldByID": Any,
"customField": Any,
"cargoGroup": "xyz789",
"stowFactorFt3": 987.65,
"isActive": false,
"description": "xyz789",
"billBy": "xyz789",
"sqlID": 123,
"shortName": "xyz789",
"fullName": "abc123",
"description1": "abc123",
"description2": "xyz789",
"description3": "abc123",
"description4": "abc123",
"description5": "xyz789",
"description6": "abc123",
"description7": "abc123",
"description8": "xyz789",
"description9": "xyz789",
"productCode": "abc123",
"lastUpdateGmt": "2007-12-03",
"api": 123.45,
"type": "xyz789",
"lastUserID": "abc123",
"isDangerous": true,
"isInactive": true,
"isPreClearance": false,
"isCapBasisGrain": true,
"isCapBasisBale": false,
"mTBE": true,
"fAME": true,
"eTBE": false,
"isPersistent": false,
"billByCPQty": false,
"billByInvoiceQty": true,
"billByOutturnQty": false,
"isSpecialHandlingRequired": false,
"imoName": "xyz789",
"unNum": "xyz789",
"unClass": "abc123",
"bcCodeGroup": "abc123",
"cpUnit": "abc123",
"liftUnit": "xyz789",
"altLiftUnit": "xyz789",
"bcCode": "xyz789",
"onshoreProductUrl": "xyz789",
"onboardProductUrl": "abc123",
"uSCGName": "xyz789",
"mARPOLCategory": "abc123",
"imoShipType": "xyz789",
"sGTempBasisDegree": 987.65,
"sGTempCoefficient": 987.65,
"sGTempScale": "abc123",
"meltingPoint": 987.65,
"meltingPointTempScale": "xyz789",
"boilingPoint": 123.45,
"boilingPointTempScale": "abc123",
"imoClass": "xyz789",
"adnrEniClass": "abc123",
"uSCGGrade": "abc123",
"uSCGSubchapter": "abc123",
"uSCGCargoName": "xyz789",
"cargoType": CargoType,
"cpUnitData": UnitOfMeasure,
"liftUnitData": UnitOfMeasure,
"altLiftUnitData": UnitOfMeasure,
"userDefinedFields": Json,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
CargoNameAlertRulesRequest
CargoNameAlias
Fields
| Field Name | Description |
|---|---|
alias - String
|
|
shortName - String
|
|
lastUser - String
|
|
cargoName - CargoName
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"alias": "abc123",
"shortName": "xyz789",
"lastUser": "abc123",
"cargoName": CargoName,
"_id": "abc123",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
CargoNameAliasFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CargoNameAliasFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CargoNameAliasFormQueryWhere
}
CargoNameAliasFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CargoNameAliasFormQueryWhere!]
|
|
or - [CargoNameAliasFormQueryWhere!]
|
|
rawExpression - String
|
|
alias - StringWhereValueExpression
|
|
shortName - StringWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
cargoName - CargoNameFormQueryWhere
|
Example
{
"and": [CargoNameAliasFormQueryWhere],
"or": [CargoNameAliasFormQueryWhere],
"rawExpression": "abc123",
"alias": StringWhereValueExpression,
"shortName": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"cargoName": CargoNameFormQueryWhere
}
CargoNameAliasRelationships
Fields
| Field Name | Description |
|---|---|
cargoName - RelationshipDefinition
|
Example
{"cargoName": RelationshipDefinition}
CargoNameFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CargoNameFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CargoNameFormQueryWhere
}
CargoNameFormQueryWhere
Fields
Example
{
"and": [CargoNameFormQueryWhere],
"or": [CargoNameFormQueryWhere],
"rawExpression": "abc123",
"shortName": StringWhereValueExpression,
"fullName": StringWhereValueExpression,
"description1": StringWhereValueExpression,
"description2": StringWhereValueExpression,
"description3": StringWhereValueExpression,
"description4": StringWhereValueExpression,
"description5": StringWhereValueExpression,
"description6": StringWhereValueExpression,
"description7": StringWhereValueExpression,
"description8": StringWhereValueExpression,
"description9": StringWhereValueExpression,
"productCode": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"api": NumberWhereValueExpression,
"type": StringWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"isDangerous": BoolWhereValueExpression,
"isInactive": BoolWhereValueExpression,
"isPreClearance": BoolWhereValueExpression,
"isCapBasisGrain": BoolWhereValueExpression,
"isCapBasisBale": BoolWhereValueExpression,
"mTBE": BoolWhereValueExpression,
"fAME": BoolWhereValueExpression,
"eTBE": BoolWhereValueExpression,
"isPersistent": BoolWhereValueExpression,
"billByCPQty": BoolWhereValueExpression,
"billByInvoiceQty": BoolWhereValueExpression,
"billByOutturnQty": BoolWhereValueExpression,
"isSpecialHandlingRequired": BoolWhereValueExpression,
"imoName": StringWhereValueExpression,
"unNum": StringWhereValueExpression,
"unClass": StringWhereValueExpression,
"bcCodeGroup": StringWhereValueExpression,
"cpUnit": StringWhereValueExpression,
"liftUnit": StringWhereValueExpression,
"altLiftUnit": StringWhereValueExpression,
"bcCode": StringWhereValueExpression,
"onshoreProductUrl": StringWhereValueExpression,
"onboardProductUrl": StringWhereValueExpression,
"uSCGName": StringWhereValueExpression,
"mARPOLCategory": StringWhereValueExpression,
"imoShipType": StringWhereValueExpression,
"sGTempBasisDegree": NumberWhereValueExpression,
"sGTempCoefficient": NumberWhereValueExpression,
"sGTempScale": StringWhereValueExpression,
"meltingPoint": NumberWhereValueExpression,
"meltingPointTempScale": StringWhereValueExpression,
"boilingPoint": NumberWhereValueExpression,
"boilingPointTempScale": StringWhereValueExpression,
"imoClass": StringWhereValueExpression,
"adnrEniClass": StringWhereValueExpression,
"uSCGGrade": StringWhereValueExpression,
"uSCGSubchapter": StringWhereValueExpression,
"uSCGCargoName": StringWhereValueExpression,
"cargoType": CargoTypeFormQueryWhere,
"cpUnitData": UnitOfMeasureFormQueryWhere,
"liftUnitData": UnitOfMeasureFormQueryWhere,
"altLiftUnitData": UnitOfMeasureFormQueryWhere
}
CargoNameRelationships
Fields
| Field Name | Description |
|---|---|
cargoType - RelationshipDefinition
|
|
cpUnitData - RelationshipDefinition
|
|
liftUnitData - RelationshipDefinition
|
|
altLiftUnitData - RelationshipDefinition
|
|
cargoNameAlias - RelationshipDefinition
|
Example
{
"cargoType": RelationshipDefinition,
"cpUnitData": RelationshipDefinition,
"liftUnitData": RelationshipDefinition,
"altLiftUnitData": RelationshipDefinition,
"cargoNameAlias": RelationshipDefinition
}
CargoRelationships
Fields
Example
{
"emissionPaymentTerms": RelationshipDefinition,
"childMirroredCargo": RelationshipDefinition,
"parentMirroredCargo": RelationshipDefinition,
"cargoBooking": RelationshipDefinition,
"balancePaymentTerm": RelationshipDefinition,
"paymentTerm": RelationshipDefinition,
"addressBook": RelationshipDefinition,
"team": RelationshipDefinition,
"lob": RelationshipDefinition,
"voyage": RelationshipDefinition,
"actDepartment": RelationshipDefinition,
"basisEstimate": RelationshipDefinition,
"tradeArea": RelationshipDefinition,
"fixture": RelationshipDefinition,
"voyageEstimate": RelationshipDefinition,
"counterparty": RelationshipDefinition,
"cOA": RelationshipDefinition,
"cargoName": RelationshipDefinition,
"company": RelationshipDefinition,
"vessel": RelationshipDefinition,
"benchmarkEstimate": RelationshipDefinition,
"primaryCargo": RelationshipDefinition,
"primaryCargoVcovRelt": RelationshipDefinition,
"firstSalesCargoVcovRelt": RelationshipDefinition,
"firstLoadCargoHandling": RelationshipDefinition,
"firstDiscCargoHandling": RelationshipDefinition,
"firstLoadCargoHandlingRelet": RelationshipDefinition,
"firstDiscCargoHandlingRelet": RelationshipDefinition,
"lastLoadCargoHandling": RelationshipDefinition,
"lastDiscCargoHandling": RelationshipDefinition,
"firstCargoLoadItin": RelationshipDefinition,
"firstCargoDiscItin": RelationshipDefinition,
"lastCargoDiscItin": RelationshipDefinition,
"firstCargoLoadItinWithTransshipment": RelationshipDefinition,
"firstCargoDiscItinWithTransshipment": RelationshipDefinition,
"firstCargoTSLoadItin": RelationshipDefinition,
"firstCargoTSLoadItinDisc": RelationshipDefinition,
"firstCargoTSDiscItin": RelationshipDefinition,
"firstCargoTSDiscItinLoad": RelationshipDefinition,
"firstCargoItinLighteringJob": RelationshipDefinition,
"lighteringJobVessel": RelationshipDefinition,
"chtrBroker": RelationshipDefinition,
"ownerBroker": RelationshipDefinition,
"firstBroker": RelationshipDefinition,
"saleCargo": RelationshipDefinition,
"purchaseCargo": RelationshipDefinition,
"cargoUnpricedElementRemark": RelationshipDefinition,
"freightBillVia": RelationshipDefinition,
"demBillVia": RelationshipDefinition,
"requiredVesselType": RelationshipDefinition,
"chtrCoordinatorUser": RelationshipDefinition,
"cargoBunkerConsumptions": RelationshipDefinition,
"cargoLoadDischargeOptions": RelationshipDefinition,
"unpricedElements": RelationshipDefinition,
"cargoSupplierReceivers": RelationshipDefinition,
"cargoRemarks": RelationshipDefinition,
"cargoTimeBars": RelationshipDefinition,
"cargoBrokers": RelationshipDefinition,
"cargoRevenueExpenses": RelationshipDefinition,
"pricingLines": RelationshipDefinition,
"bunkerExposures": RelationshipDefinition,
"loadCommercialCargoItineraries": RelationshipDefinition,
"loadCargoItineraries": RelationshipDefinition,
"cargoItineraries": RelationshipDefinition,
"discCommercialCargoItineraries": RelationshipDefinition,
"discCargoItineraries": RelationshipDefinition,
"voyageCargoHandlings": RelationshipDefinition,
"loadVoyageCargoHandlings": RelationshipDefinition,
"discVoyageCargoHandlings": RelationshipDefinition,
"cargoLinkedTrades": RelationshipDefinition,
"cargoLinkedTradesInternal": RelationshipDefinition,
"cargoLinkedBunkerPurchasesInternal": RelationshipDefinition,
"tasks": RelationshipDefinition,
"extraFreightTerms": RelationshipDefinition,
"benchmarkEstimates": RelationshipDefinition,
"alerts": RelationshipDefinition,
"advancedPricingRuleReport": RelationshipDefinition,
"mirroredCargos": RelationshipDefinition,
"cargoExposureBunker": RelationshipDefinition,
"commodityContractCargoItineraries": RelationshipDefinition,
"commodityContract": RelationshipDefinition,
"operationsInvoice": RelationshipDefinition
}
CargoRemark
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
cargoID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
type - String
|
|
remark - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
cargo - Cargo
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"cargoID": 123,
"customFieldByID": Any,
"customField": Any,
"type": "abc123",
"remark": "xyz789",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUser": "xyz789",
"cargo": Cargo,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
CargoRemarkFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CargoRemarkFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CargoRemarkFormQueryWhere
}
CargoRemarkFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CargoRemarkFormQueryWhere!]
|
|
or - [CargoRemarkFormQueryWhere!]
|
|
rawExpression - String
|
|
cargoID - NumberWhereValueExpression
|
|
type - CargoRemarkTypeEnumValueExpression
|
|
remark - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
cargo - CargoFormQueryWhere
|
Example
{
"and": [CargoRemarkFormQueryWhere],
"or": [CargoRemarkFormQueryWhere],
"rawExpression": "abc123",
"cargoID": NumberWhereValueExpression,
"type": CargoRemarkTypeEnumValueExpression,
"remark": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"cargo": CargoFormQueryWhere
}
CargoRemarkRelationships
Fields
| Field Name | Description |
|---|---|
cargo - RelationshipDefinition
|
Example
{"cargo": RelationshipDefinition}
CargoRemarkTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CargoRemarkTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoRemarkTypeEnum
|
|
isNot - CargoRemarkTypeEnum
|
|
isIn - [CargoRemarkTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
CargoRevenueExpense
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
cargoQtyPerBasis - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
rateType - String
|
|
rate - Float
|
|
amountCurr - Float
|
|
amountBase - Float
|
|
cargoID - Int
|
|
type - String
|
|
seqNo - Int
|
|
description - String
|
|
amountCurrInternal - Float
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
curr - String
|
|
amountBaseInternal - Float
|
|
exchRate - Float
|
|
rateUnitInternal - String
|
|
billCode - String
|
|
provisional - Boolean
|
|
basis - String
|
|
vendorType - String
|
|
vendorShortName - String
|
|
addressBook - AddressBook
|
|
cargo - Cargo
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"cargoQtyPerBasis": 123,
"customFieldByID": Any,
"customField": Any,
"rateType": "xyz789",
"rate": 123.45,
"amountCurr": 123.45,
"amountBase": 123.45,
"cargoID": 123,
"type": "xyz789",
"seqNo": 123,
"description": "abc123",
"amountCurrInternal": 123.45,
"lastUser": "xyz789",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"curr": "abc123",
"amountBaseInternal": 123.45,
"exchRate": 987.65,
"rateUnitInternal": "xyz789",
"billCode": "abc123",
"provisional": false,
"basis": "xyz789",
"vendorType": "abc123",
"vendorShortName": "abc123",
"addressBook": AddressBook,
"cargo": Cargo,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
CargoRevenueExpenseBasisEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CPQty"
CargoRevenueExpenseBasisEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoRevenueExpenseBasisEnum
|
|
isNot - CargoRevenueExpenseBasisEnum
|
|
isIn - [CargoRevenueExpenseBasisEnum]
|
Example
{"is": "CPQty", "isNot": "CPQty", "isIn": ["CPQty"]}
CargoRevenueExpenseFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CargoRevenueExpenseFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CargoRevenueExpenseFormQueryWhere
}
CargoRevenueExpenseFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CargoRevenueExpenseFormQueryWhere!]
|
|
or - [CargoRevenueExpenseFormQueryWhere!]
|
|
rawExpression - String
|
|
cargoID - NumberWhereValueExpression
|
|
type - CargoRevenueExpenseTypeEnumValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
amountCurrInternal - NumberWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
curr - StringWhereValueExpression
|
|
amountBaseInternal - NumberWhereValueExpression
|
|
exchRate - NumberWhereValueExpression
|
|
rateUnitInternal - StringWhereValueExpression
|
|
billCode - StringWhereValueExpression
|
|
provisional - BoolWhereValueExpression
|
|
basis - CargoRevenueExpenseBasisEnumValueExpression
|
|
vendorType - StringWhereValueExpression
|
|
vendorShortName - StringWhereValueExpression
|
|
addressBook - AddressBookFormQueryWhere
|
|
cargo - CargoFormQueryWhere
|
Example
{
"and": [CargoRevenueExpenseFormQueryWhere],
"or": [CargoRevenueExpenseFormQueryWhere],
"rawExpression": "xyz789",
"cargoID": NumberWhereValueExpression,
"type": CargoRevenueExpenseTypeEnumValueExpression,
"seqNo": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"amountCurrInternal": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"curr": StringWhereValueExpression,
"amountBaseInternal": NumberWhereValueExpression,
"exchRate": NumberWhereValueExpression,
"rateUnitInternal": StringWhereValueExpression,
"billCode": StringWhereValueExpression,
"provisional": BoolWhereValueExpression,
"basis": CargoRevenueExpenseBasisEnumValueExpression,
"vendorType": StringWhereValueExpression,
"vendorShortName": StringWhereValueExpression,
"addressBook": AddressBookFormQueryWhere,
"cargo": CargoFormQueryWhere
}
CargoRevenueExpenseRelationships
Fields
| Field Name | Description |
|---|---|
addressBook - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
loadCargoItineraries - RelationshipDefinition
|
|
loadVoyageCargoHandlings - RelationshipDefinition
|
Example
{
"addressBook": RelationshipDefinition,
"cargo": RelationshipDefinition,
"loadCargoItineraries": RelationshipDefinition,
"loadVoyageCargoHandlings": RelationshipDefinition
}
CargoRevenueExpenseTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CargoRevenueExpenseTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoRevenueExpenseTypeEnum
|
|
isNot - CargoRevenueExpenseTypeEnum
|
|
isIn - [CargoRevenueExpenseTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
CargoSupplierReceiver
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
amountCurr - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
cargoID - Int
|
|
type - String
|
|
seqNo - Int
|
|
quantity - Int
|
|
optionPercentage - Float
|
|
optionType - String
|
|
curr - String
|
|
exchangeRate - Float
|
|
freightType - String
|
|
worldScaleRate - Float
|
|
worldScaleLevel - Float
|
|
freightRate - Float
|
|
lumpsum - Float
|
|
supplierReceiverShortName - String
|
|
supplierReceiverType - String
|
|
addressBook - AddressBook
|
|
cargo - Cargo
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"amountCurr": 987.65,
"customFieldByID": Any,
"customField": Any,
"cargoID": 987,
"type": "abc123",
"seqNo": 123,
"quantity": 987,
"optionPercentage": 123.45,
"optionType": "xyz789",
"curr": "abc123",
"exchangeRate": 123.45,
"freightType": "abc123",
"worldScaleRate": 123.45,
"worldScaleLevel": 987.65,
"freightRate": 123.45,
"lumpsum": 123.45,
"supplierReceiverShortName": "abc123",
"supplierReceiverType": "xyz789",
"addressBook": AddressBook,
"cargo": Cargo,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
CargoSupplierReceiverFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CargoSupplierReceiverFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CargoSupplierReceiverFormQueryWhere
}
CargoSupplierReceiverFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CargoSupplierReceiverFormQueryWhere!]
|
|
or - [CargoSupplierReceiverFormQueryWhere!]
|
|
rawExpression - String
|
|
cargoID - NumberWhereValueExpression
|
|
type - CargoSupplierReceiverTypeEnumValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
quantity - NumberWhereValueExpression
|
|
optionPercentage - NumberWhereValueExpression
|
|
optionType - StringWhereValueExpression
|
|
curr - StringWhereValueExpression
|
|
exchangeRate - NumberWhereValueExpression
|
|
freightType - CargoSupplierReceiverFreightTypeEnumValueExpression
|
|
worldScaleRate - NumberWhereValueExpression
|
|
worldScaleLevel - NumberWhereValueExpression
|
|
freightRate - NumberWhereValueExpression
|
|
lumpsum - NumberWhereValueExpression
|
|
supplierReceiverShortName - StringWhereValueExpression
|
|
supplierReceiverType - StringWhereValueExpression
|
|
addressBook - AddressBookFormQueryWhere
|
|
cargo - CargoFormQueryWhere
|
Example
{
"and": [CargoSupplierReceiverFormQueryWhere],
"or": [CargoSupplierReceiverFormQueryWhere],
"rawExpression": "abc123",
"cargoID": NumberWhereValueExpression,
"type": CargoSupplierReceiverTypeEnumValueExpression,
"seqNo": NumberWhereValueExpression,
"quantity": NumberWhereValueExpression,
"optionPercentage": NumberWhereValueExpression,
"optionType": StringWhereValueExpression,
"curr": StringWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"freightType": CargoSupplierReceiverFreightTypeEnumValueExpression,
"worldScaleRate": NumberWhereValueExpression,
"worldScaleLevel": NumberWhereValueExpression,
"freightRate": NumberWhereValueExpression,
"lumpsum": NumberWhereValueExpression,
"supplierReceiverShortName": StringWhereValueExpression,
"supplierReceiverType": StringWhereValueExpression,
"addressBook": AddressBookFormQueryWhere,
"cargo": CargoFormQueryWhere
}
CargoSupplierReceiverFreightTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CargoSupplierReceiverFreightTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoSupplierReceiverFreightTypeEnum
|
|
isNot - CargoSupplierReceiverFreightTypeEnum
|
|
isIn - [CargoSupplierReceiverFreightTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
CargoSupplierReceiverRelationships
Fields
| Field Name | Description |
|---|---|
addressBook - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
Example
{
"addressBook": RelationshipDefinition,
"cargo": RelationshipDefinition
}
CargoSupplierReceiverTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CargoSupplierReceiverTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoSupplierReceiverTypeEnum
|
|
isNot - CargoSupplierReceiverTypeEnum
|
|
isIn - [CargoSupplierReceiverTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
CargoTimeBar
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
cargoID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seq - Int
|
|
counterpartyType - String
|
|
counterpartyShortName - String
|
|
basis - String
|
|
timebarDays - Float
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
cargo - Cargo
|
|
counterparty - AddressBook
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"cargoID": 123,
"customFieldByID": Any,
"customField": Any,
"seq": 123,
"counterpartyType": "abc123",
"counterpartyShortName": "xyz789",
"basis": "abc123",
"timebarDays": 123.45,
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123",
"cargo": Cargo,
"counterparty": AddressBook,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
CargoTimeBarBasisEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"None"
CargoTimeBarBasisEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoTimeBarBasisEnum
|
|
isNot - CargoTimeBarBasisEnum
|
|
isIn - [CargoTimeBarBasisEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
CargoTimeBarFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CargoTimeBarFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CargoTimeBarFormQueryWhere
}
CargoTimeBarFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CargoTimeBarFormQueryWhere!]
|
|
or - [CargoTimeBarFormQueryWhere!]
|
|
rawExpression - String
|
|
cargoID - NumberWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
counterpartyType - StringWhereValueExpression
|
|
counterpartyShortName - StringWhereValueExpression
|
|
basis - CargoTimeBarBasisEnumValueExpression
|
|
timebarDays - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
cargo - CargoFormQueryWhere
|
|
counterparty - AddressBookFormQueryWhere
|
Example
{
"and": [CargoTimeBarFormQueryWhere],
"or": [CargoTimeBarFormQueryWhere],
"rawExpression": "xyz789",
"cargoID": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"counterpartyType": StringWhereValueExpression,
"counterpartyShortName": StringWhereValueExpression,
"basis": CargoTimeBarBasisEnumValueExpression,
"timebarDays": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"cargo": CargoFormQueryWhere,
"counterparty": AddressBookFormQueryWhere
}
CargoTimeBarRelationships
Fields
| Field Name | Description |
|---|---|
cargo - RelationshipDefinition
|
|
counterparty - RelationshipDefinition
|
Example
{
"cargo": RelationshipDefinition,
"counterparty": RelationshipDefinition
}
CargoType
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
type - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
cargoGroup - String
|
|
cargoClass - String
|
|
cpUnit - String
|
|
liftUnit - String
|
|
altLiftUnit - String
|
|
lastUpdateGmt - Date
|
|
marketPrice - Float
|
|
currency - String
|
|
priceUnit - String
|
|
defaultCargoLossRate - Float
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"type": "abc123",
"customFieldByID": Any,
"customField": Any,
"cargoGroup": "xyz789",
"cargoClass": "xyz789",
"cpUnit": "xyz789",
"liftUnit": "xyz789",
"altLiftUnit": "abc123",
"lastUpdateGmt": "2007-12-03",
"marketPrice": 987.65,
"currency": "xyz789",
"priceUnit": "xyz789",
"defaultCargoLossRate": 123.45,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
CargoTypeCargoClassEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NotSet"
CargoTypeCargoClassEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CargoTypeCargoClassEnum
|
|
isNot - CargoTypeCargoClassEnum
|
|
isIn - [CargoTypeCargoClassEnum]
|
Example
{"is": "NotSet", "isNot": "NotSet", "isIn": ["NotSet"]}
CargoTypeFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CargoTypeFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CargoTypeFormQueryWhere
}
CargoTypeFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CargoTypeFormQueryWhere!]
|
|
or - [CargoTypeFormQueryWhere!]
|
|
rawExpression - String
|
|
type - StringWhereValueExpression
|
|
cargoGroup - StringWhereValueExpression
|
|
cargoClass - CargoTypeCargoClassEnumValueExpression
|
|
cpUnit - StringWhereValueExpression
|
|
liftUnit - StringWhereValueExpression
|
|
altLiftUnit - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
marketPrice - NumberWhereValueExpression
|
|
currency - StringWhereValueExpression
|
|
priceUnit - StringWhereValueExpression
|
|
defaultCargoLossRate - NumberWhereValueExpression
|
Example
{
"and": [CargoTypeFormQueryWhere],
"or": [CargoTypeFormQueryWhere],
"rawExpression": "abc123",
"type": StringWhereValueExpression,
"cargoGroup": StringWhereValueExpression,
"cargoClass": CargoTypeCargoClassEnumValueExpression,
"cpUnit": StringWhereValueExpression,
"liftUnit": StringWhereValueExpression,
"altLiftUnit": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"marketPrice": NumberWhereValueExpression,
"currency": StringWhereValueExpression,
"priceUnit": StringWhereValueExpression,
"defaultCargoLossRate": NumberWhereValueExpression
}
CargoTypeGroup
Fields
| Field Name | Description |
|---|---|
parentGroupId - String
|
|
memberGroupId - String
|
|
memberCargoTypeData - CargoType
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"parentGroupId": "abc123",
"memberGroupId": "abc123",
"memberCargoTypeData": CargoType,
"_id": "xyz789",
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
CargoTypeGroupFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CargoTypeGroupFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CargoTypeGroupFormQueryWhere
}
CargoTypeGroupFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CargoTypeGroupFormQueryWhere!]
|
|
or - [CargoTypeGroupFormQueryWhere!]
|
|
rawExpression - String
|
|
parentGroupId - StringWhereValueExpression
|
|
memberGroupId - StringWhereValueExpression
|
|
memberCargoTypeData - CargoTypeFormQueryWhere
|
Example
{
"and": [CargoTypeGroupFormQueryWhere],
"or": [CargoTypeGroupFormQueryWhere],
"rawExpression": "xyz789",
"parentGroupId": StringWhereValueExpression,
"memberGroupId": StringWhereValueExpression,
"memberCargoTypeData": CargoTypeFormQueryWhere
}
CargoTypeGroupRelationships
Fields
| Field Name | Description |
|---|---|
memberCargoTypeData - RelationshipDefinition
|
Example
{"memberCargoTypeData": RelationshipDefinition}
ChartOfAccounts
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
category - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
code - String
|
|
type - Int
|
|
accountName - String
|
|
appliesToLobs - Boolean
|
|
appliesToVessels - Boolean
|
|
appliesToVoyages - Boolean
|
|
appliesToPorts - Boolean
|
|
appliesToBanks - Boolean
|
|
appliesToDepts - Boolean
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
appliesToIntercompany - Boolean
|
|
legacyCategory - String
|
|
article - Boolean
|
|
serviceFee - Boolean
|
|
aP - Boolean
|
|
aR - Boolean
|
|
poolMgt - Boolean
|
|
runningCost - Boolean
|
|
leaseCost - Boolean
|
|
accountGroupCode - String
|
|
parentAccount - String
|
|
poolAdminAccounts - [PoolAdminAccount]
|
|
updateChartOfAccountsMessages - [UpdateChartOfAccountsMessageRecord]
|
|
Arguments
|
|
changesSinceLast - ChartOfAccountsChangesSinceLast
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"category": "abc123",
"customFieldByID": Any,
"customField": Any,
"code": "abc123",
"type": 987,
"accountName": "abc123",
"appliesToLobs": true,
"appliesToVessels": true,
"appliesToVoyages": true,
"appliesToPorts": true,
"appliesToBanks": false,
"appliesToDepts": true,
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUser": "abc123",
"appliesToIntercompany": false,
"legacyCategory": "abc123",
"article": false,
"serviceFee": false,
"aP": false,
"aR": false,
"poolMgt": false,
"runningCost": false,
"leaseCost": false,
"accountGroupCode": "abc123",
"parentAccount": "abc123",
"poolAdminAccounts": [PoolAdminAccount],
"updateChartOfAccountsMessages": [
UpdateChartOfAccountsMessageRecord
],
"changesSinceLast": ChartOfAccountsChangesSinceLast,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
ChartOfAccountsChangesSinceLast
Fields
| Field Name | Description |
|---|---|
updateChartOfAccounts - MessageUpdateResponse
|
Example
{"updateChartOfAccounts": MessageUpdateResponse}
ChartOfAccountsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ChartOfAccountsFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ChartOfAccountsFormQueryWhere
}
ChartOfAccountsFormQueryWhere
Fields
Example
{
"and": [ChartOfAccountsFormQueryWhere],
"or": [ChartOfAccountsFormQueryWhere],
"rawExpression": "abc123",
"code": StringWhereValueExpression,
"type": NumberWhereValueExpression,
"accountName": StringWhereValueExpression,
"appliesToLobs": BoolWhereValueExpression,
"appliesToVessels": BoolWhereValueExpression,
"appliesToVoyages": BoolWhereValueExpression,
"appliesToPorts": BoolWhereValueExpression,
"appliesToBanks": BoolWhereValueExpression,
"appliesToDepts": BoolWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"appliesToIntercompany": BoolWhereValueExpression,
"legacyCategory": ChartOfAccountsLegacyCategoryEnumValueExpression,
"article": BoolWhereValueExpression,
"serviceFee": BoolWhereValueExpression,
"aP": BoolWhereValueExpression,
"aR": BoolWhereValueExpression,
"poolMgt": BoolWhereValueExpression,
"runningCost": BoolWhereValueExpression,
"leaseCost": BoolWhereValueExpression,
"accountGroupCode": StringWhereValueExpression,
"parentAccount": StringWhereValueExpression
}
ChartOfAccountsLegacyCategoryEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Unknown"
ChartOfAccountsLegacyCategoryEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - ChartOfAccountsLegacyCategoryEnum
|
|
isNot - ChartOfAccountsLegacyCategoryEnum
|
|
isIn - [ChartOfAccountsLegacyCategoryEnum]
|
Example
{"is": "Unknown", "isNot": "Unknown", "isIn": ["Unknown"]}
ChartOfAccountsRelationships
Fields
| Field Name | Description |
|---|---|
poolAdminAccounts - RelationshipDefinition
|
Example
{"poolAdminAccounts": RelationshipDefinition}
Chartering_functionsRootMutation
Fields
| Field Name | Description |
|---|---|
cargoUpdate - Imosfunctions_CargoUpdateResponse
|
|
Arguments
|
|
runEstimate - Imosfunctions_RunEstimateResponse
|
|
Arguments
|
|
Example
{
"cargoUpdate": Imosfunctions_CargoUpdateResponse,
"runEstimate": Imosfunctions_RunEstimateResponse
}
Claim
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
iD - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
claimID - String
|
|
isFobCargo - Boolean
|
|
rebillOption - String
|
|
lastAction - String
|
|
lastActionDate - Date
|
|
lastActionRemarks - String
|
|
type - String
|
|
laytimeClaimType - String
|
|
portID - Int
|
|
itinerarySeq - Int
|
|
coalescedCompanyCode - String
|
|
agreedAmountCurr - Float
|
|
invoicedAmount - Float
|
|
timebarDays - Float
|
|
chtrSpecialist - String
|
|
opsCoordinator - String
|
|
voyageStatus - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
seq - Int
|
|
claimDate - Date
|
|
timebarDate - Date
|
|
portIDInternal - Int
|
|
cargoSeq - Int
|
|
typeInternal - String
|
|
analyst - String
|
|
status - String
|
|
differenceReason - String
|
|
description - String
|
|
claimantShortName - String
|
|
claimantType - String
|
|
currency - String
|
|
exchangeRate - Float
|
|
amountCurr - Float
|
|
amountBase - Float
|
|
blCode - String
|
|
settledDate - Date
|
|
claimAgreedAmountCurr - Float
|
|
onDeck - Boolean
|
|
underDeck - Boolean
|
|
courtCase - Boolean
|
|
pending - Boolean
|
|
rebillable - Boolean
|
|
includeInPnl - Boolean
|
|
miscellaneous - Boolean
|
|
rebillableCheck - Boolean
|
|
reviewed - Boolean
|
|
approved - Boolean
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
updateTimes - Int
|
|
lastUser - String
|
|
internalBU - String
|
|
originalAmountCurr - Float
|
|
targetDate - Date
|
|
lastActionInternal - String
|
|
lastActionDateInternal - Date
|
|
transNo - Int
|
|
laytimeCalcID - Int
|
|
typeCode - String
|
|
companyCode - String
|
|
aPAR - String
|
|
cpReference - String
|
|
referenceNo - String
|
|
cpForm - String
|
|
cpDate - Date
|
|
referenceID - String
|
|
openedDate - Date
|
|
basisDate - Date
|
|
claimTimebarDays - Float
|
|
followupDate - Date
|
|
estAmountCurr - Float
|
|
estDate - Date
|
|
targetDays - Float
|
|
statusCode - String
|
|
outOfPocketAmountCurr - Float
|
|
pniClubShortName - String
|
|
pniClubType - String
|
|
mirrorClaimID - Int
|
|
amountPaidToOwnerCurr - Float
|
|
cargoID - Int
|
|
subType - String
|
|
claimCreatedOrReceivedDate - Date
|
|
laytimeClaimTypeInternal - String
|
|
reviewedBy - String
|
|
approvedBy - String
|
|
reviewedOnGmt - Date
|
|
approvedOnGmt - Date
|
|
submissionDate - Date
|
|
insuranceStatus - String
|
|
operationsInvoice - OperationsInvoice
|
|
laytime - Laytime
|
|
cargo - Cargo
|
|
pniClub - AddressBook
|
|
counterparty - AddressBook
|
|
company - AddressBook
|
|
voyageItinerary - VoyageItinerary
|
|
firstCargoHandling - VoyageCargoHandling
|
|
firstCargo - Cargo
|
|
regularVoyage - Voyage
|
|
fobVoyage - Voyage
|
|
regularVessel - Vessel
|
|
fobVessel - Vessel
|
|
latestClaimOperationsInvoice - OperationsInvoice
|
|
claimTypeTerm - Term
|
|
laytimeClaimTypeTerm - Term
|
|
analystUser - User
|
|
claimNotes - [ClaimNote]
|
|
claimLinkedClaims - [ClaimLinkedClaim]
|
|
claimInvoices - [OperationsInvoice]
|
|
claimInvoicesRelated - [OperationsInvoice]
|
|
claimInvoicesDirect - [OperationsInvoice]
|
|
linkedClaims - [Claim]
|
|
claimProjectedInvoice - [ClaimProjectedInvoice]
|
|
createLaytimeClaimMessages - [CreateLaytimeClaimMessageRecord]
|
|
Arguments
|
|
editLaytimeClaimMessages - [EditLaytimeClaimMessageRecord]
|
|
Arguments
|
|
getLaytimePDFReportsMessages - [GetLaytimePDFReportsMessageRecord]
|
|
Arguments
|
|
changesSinceLast - ClaimChangesSinceLast
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"iD": 123,
"customFieldByID": Any,
"customField": Any,
"claimID": "xyz789",
"isFobCargo": true,
"rebillOption": "xyz789",
"lastAction": "xyz789",
"lastActionDate": "2007-12-03",
"lastActionRemarks": "xyz789",
"type": "abc123",
"laytimeClaimType": "abc123",
"portID": 987,
"itinerarySeq": 987,
"coalescedCompanyCode": "abc123",
"agreedAmountCurr": 987.65,
"invoicedAmount": 987.65,
"timebarDays": 987.65,
"chtrSpecialist": "xyz789",
"opsCoordinator": "xyz789",
"voyageStatus": "xyz789",
"vesselCode": "xyz789",
"voyageNo": 123,
"seq": 987,
"claimDate": "2007-12-03",
"timebarDate": "2007-12-03",
"portIDInternal": 123,
"cargoSeq": 987,
"typeInternal": "abc123",
"analyst": "abc123",
"status": "xyz789",
"differenceReason": "xyz789",
"description": "abc123",
"claimantShortName": "abc123",
"claimantType": "abc123",
"currency": "abc123",
"exchangeRate": 987.65,
"amountCurr": 987.65,
"amountBase": 987.65,
"blCode": "xyz789",
"settledDate": "2007-12-03",
"claimAgreedAmountCurr": 123.45,
"onDeck": false,
"underDeck": false,
"courtCase": true,
"pending": false,
"rebillable": false,
"includeInPnl": false,
"miscellaneous": false,
"rebillableCheck": false,
"reviewed": true,
"approved": false,
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"updateTimes": 123,
"lastUser": "xyz789",
"internalBU": "xyz789",
"originalAmountCurr": 123.45,
"targetDate": "2007-12-03",
"lastActionInternal": "xyz789",
"lastActionDateInternal": "2007-12-03",
"transNo": 987,
"laytimeCalcID": 123,
"typeCode": "abc123",
"companyCode": "xyz789",
"aPAR": "xyz789",
"cpReference": "abc123",
"referenceNo": "xyz789",
"cpForm": "xyz789",
"cpDate": "2007-12-03",
"referenceID": "xyz789",
"openedDate": "2007-12-03",
"basisDate": "2007-12-03",
"claimTimebarDays": 123.45,
"followupDate": "2007-12-03",
"estAmountCurr": 123.45,
"estDate": "2007-12-03",
"targetDays": 123.45,
"statusCode": "abc123",
"outOfPocketAmountCurr": 987.65,
"pniClubShortName": "abc123",
"pniClubType": "abc123",
"mirrorClaimID": 123,
"amountPaidToOwnerCurr": 123.45,
"cargoID": 987,
"subType": "abc123",
"claimCreatedOrReceivedDate": "2007-12-03",
"laytimeClaimTypeInternal": "xyz789",
"reviewedBy": "abc123",
"approvedBy": "xyz789",
"reviewedOnGmt": "2007-12-03",
"approvedOnGmt": "2007-12-03",
"submissionDate": "2007-12-03",
"insuranceStatus": "xyz789",
"operationsInvoice": OperationsInvoice,
"laytime": Laytime,
"cargo": Cargo,
"pniClub": AddressBook,
"counterparty": AddressBook,
"company": AddressBook,
"voyageItinerary": VoyageItinerary,
"firstCargoHandling": VoyageCargoHandling,
"firstCargo": Cargo,
"regularVoyage": Voyage,
"fobVoyage": Voyage,
"regularVessel": Vessel,
"fobVessel": Vessel,
"latestClaimOperationsInvoice": OperationsInvoice,
"claimTypeTerm": Term,
"laytimeClaimTypeTerm": Term,
"analystUser": User,
"claimNotes": [ClaimNote],
"claimLinkedClaims": [ClaimLinkedClaim],
"claimInvoices": [OperationsInvoice],
"claimInvoicesRelated": [OperationsInvoice],
"claimInvoicesDirect": [OperationsInvoice],
"linkedClaims": [Claim],
"claimProjectedInvoice": [ClaimProjectedInvoice],
"createLaytimeClaimMessages": [
CreateLaytimeClaimMessageRecord
],
"editLaytimeClaimMessages": [
EditLaytimeClaimMessageRecord
],
"getLaytimePDFReportsMessages": [
GetLaytimePDFReportsMessageRecord
],
"changesSinceLast": ClaimChangesSinceLast,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
ClaimAPAREnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"AP"
ClaimAPAREnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - ClaimAPAREnum
|
|
isNot - ClaimAPAREnum
|
|
isIn - [ClaimAPAREnum]
|
Example
{"is": "AP", "isNot": "AP", "isIn": ["AP"]}
ClaimChangesSinceLast
Fields
| Field Name | Description |
|---|---|
createLaytimeClaim - MessageUpdateResponse
|
|
editLaytimeClaim - MessageUpdateResponse
|
|
getLaytimePDFReports - MessageUpdateResponse
|
Example
{
"createLaytimeClaim": MessageUpdateResponse,
"editLaytimeClaim": MessageUpdateResponse,
"getLaytimePDFReports": MessageUpdateResponse
}
ClaimFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ClaimFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ClaimFormQueryWhere
}
ClaimFormQueryWhere
Fields
Example
{
"and": [ClaimFormQueryWhere],
"or": [ClaimFormQueryWhere],
"rawExpression": "xyz789",
"iD": NumberWhereValueExpression,
"claimID": StringWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"claimDate": DateWhereValueExpression,
"timebarDate": DateWhereValueExpression,
"portIDInternal": NumberWhereValueExpression,
"cargoSeq": NumberWhereValueExpression,
"typeInternal": StringWhereValueExpression,
"analyst": StringWhereValueExpression,
"status": StringWhereValueExpression,
"differenceReason": StringWhereValueExpression,
"description": StringWhereValueExpression,
"claimantShortName": StringWhereValueExpression,
"claimantType": StringWhereValueExpression,
"currency": StringWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"amountCurr": NumberWhereValueExpression,
"amountBase": NumberWhereValueExpression,
"blCode": StringWhereValueExpression,
"settledDate": DateWhereValueExpression,
"claimAgreedAmountCurr": NumberWhereValueExpression,
"onDeck": BoolWhereValueExpression,
"underDeck": BoolWhereValueExpression,
"courtCase": BoolWhereValueExpression,
"pending": BoolWhereValueExpression,
"rebillable": BoolWhereValueExpression,
"includeInPnl": BoolWhereValueExpression,
"miscellaneous": BoolWhereValueExpression,
"rebillableCheck": BoolWhereValueExpression,
"reviewed": BoolWhereValueExpression,
"approved": BoolWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"updateTimes": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"internalBU": StringWhereValueExpression,
"originalAmountCurr": NumberWhereValueExpression,
"targetDate": DateWhereValueExpression,
"lastActionInternal": StringWhereValueExpression,
"lastActionDateInternal": DateWhereValueExpression,
"transNo": NumberWhereValueExpression,
"laytimeCalcID": NumberWhereValueExpression,
"typeCode": ClaimTypeCodeEnumValueExpression,
"companyCode": StringWhereValueExpression,
"aPAR": ClaimAPAREnumValueExpression,
"cpReference": StringWhereValueExpression,
"referenceNo": StringWhereValueExpression,
"cpForm": StringWhereValueExpression,
"cpDate": DateWhereValueExpression,
"referenceID": StringWhereValueExpression,
"openedDate": DateWhereValueExpression,
"basisDate": DateWhereValueExpression,
"claimTimebarDays": NumberWhereValueExpression,
"followupDate": DateWhereValueExpression,
"estAmountCurr": NumberWhereValueExpression,
"estDate": DateWhereValueExpression,
"targetDays": NumberWhereValueExpression,
"statusCode": ClaimStatusCodeEnumValueExpression,
"outOfPocketAmountCurr": NumberWhereValueExpression,
"pniClubShortName": StringWhereValueExpression,
"pniClubType": StringWhereValueExpression,
"mirrorClaimID": NumberWhereValueExpression,
"amountPaidToOwnerCurr": NumberWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"subType": StringWhereValueExpression,
"claimCreatedOrReceivedDate": DateWhereValueExpression,
"laytimeClaimTypeInternal": StringWhereValueExpression,
"reviewedBy": StringWhereValueExpression,
"approvedBy": StringWhereValueExpression,
"reviewedOnGmt": DateWhereValueExpression,
"approvedOnGmt": DateWhereValueExpression,
"submissionDate": DateWhereValueExpression,
"insuranceStatus": ClaimInsuranceStatusEnumValueExpression,
"operationsInvoice": OperationsInvoiceFormQueryWhere,
"laytime": LaytimeFormQueryWhere,
"cargo": CargoFormQueryWhere,
"pniClub": AddressBookFormQueryWhere,
"counterparty": AddressBookFormQueryWhere,
"company": AddressBookFormQueryWhere,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"firstCargoHandling": VoyageCargoHandlingFormQueryWhere,
"firstCargo": CargoFormQueryWhere,
"regularVoyage": VoyageFormQueryWhere,
"fobVoyage": VoyageFormQueryWhere,
"regularVessel": VesselFormQueryWhere,
"fobVessel": VesselFormQueryWhere,
"latestClaimOperationsInvoice": OperationsInvoiceFormQueryWhere,
"claimTypeTerm": TermFormQueryWhere,
"laytimeClaimTypeTerm": TermFormQueryWhere,
"analystUser": UserFormQueryWhere
}
ClaimInsuranceStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
ClaimInsuranceStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - ClaimInsuranceStatusEnum
|
|
isNot - ClaimInsuranceStatusEnum
|
|
isIn - [ClaimInsuranceStatusEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
ClaimLinkedClaim
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
iD - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
linkedClaimID - Int
|
|
claim - Claim
|
|
_keys - [String]
|
|
_intents - [String]
|
|
Example
{
"_id": "xyz789",
"iD": 123,
"customFieldByID": Any,
"customField": Any,
"linkedClaimID": 987,
"claim": Claim,
"_keys": ["abc123"],
"_intents": ["xyz789"]
}
ClaimLinkedClaimRelationships
Fields
| Field Name | Description |
|---|---|
claim - RelationshipDefinition
|
Example
{"claim": RelationshipDefinition}
ClaimNote
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
category - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
claimID - Int
|
|
seq - Int
|
|
date - Date
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
note - String
|
|
entryDateGmt - Date
|
|
inactive - Boolean
|
|
isDateGmt - Boolean
|
|
categoryCode - Int
|
|
priority - String
|
|
action - String
|
|
claim - Claim
|
|
claimNoteCategory - Term
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"category": "xyz789",
"customFieldByID": Any,
"customField": Any,
"claimID": 123,
"seq": 987,
"date": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123",
"note": "abc123",
"entryDateGmt": "2007-12-03",
"inactive": true,
"isDateGmt": false,
"categoryCode": 123,
"priority": "xyz789",
"action": "abc123",
"claim": Claim,
"claimNoteCategory": Term,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
ClaimNoteFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ClaimNoteFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ClaimNoteFormQueryWhere
}
ClaimNoteFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [ClaimNoteFormQueryWhere!]
|
|
or - [ClaimNoteFormQueryWhere!]
|
|
rawExpression - String
|
|
claimID - NumberWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
date - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
note - StringWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
inactive - BoolWhereValueExpression
|
|
isDateGmt - BoolWhereValueExpression
|
|
categoryCode - NumberWhereValueExpression
|
|
priority - ClaimNotePriorityEnumValueExpression
|
|
action - StringWhereValueExpression
|
|
claim - ClaimFormQueryWhere
|
|
claimNoteCategory - TermFormQueryWhere
|
Example
{
"and": [ClaimNoteFormQueryWhere],
"or": [ClaimNoteFormQueryWhere],
"rawExpression": "xyz789",
"claimID": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"date": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"note": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"inactive": BoolWhereValueExpression,
"isDateGmt": BoolWhereValueExpression,
"categoryCode": NumberWhereValueExpression,
"priority": ClaimNotePriorityEnumValueExpression,
"action": StringWhereValueExpression,
"claim": ClaimFormQueryWhere,
"claimNoteCategory": TermFormQueryWhere
}
ClaimNotePriorityEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"High"
ClaimNotePriorityEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - ClaimNotePriorityEnum
|
|
isNot - ClaimNotePriorityEnum
|
|
isIn - [ClaimNotePriorityEnum]
|
Example
{"is": "High", "isNot": "High", "isIn": ["High"]}
ClaimNoteRelationships
Fields
| Field Name | Description |
|---|---|
claim - RelationshipDefinition
|
|
claimNoteCategory - RelationshipDefinition
|
Example
{
"claim": RelationshipDefinition,
"claimNoteCategory": RelationshipDefinition
}
ClaimProjectedInvoice
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
iD - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
companyCode - String
|
|
claimDate - Date
|
|
claimStatus - String
|
|
invoiceType - String
|
|
description - String
|
|
counterpartyType - String
|
|
counterpartyShortName - String
|
|
source - String
|
|
lastUpdateGmt - Date
|
|
actualAmountBaseInternal - Float
|
|
invoicedAmountBaseInternal - Float
|
|
outstandingBalanceBaseInternal - Float
|
|
claim - Claim
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"iD": 987,
"customFieldByID": Any,
"customField": Any,
"companyCode": "abc123",
"claimDate": "2007-12-03",
"claimStatus": "xyz789",
"invoiceType": "abc123",
"description": "abc123",
"counterpartyType": "xyz789",
"counterpartyShortName": "abc123",
"source": "xyz789",
"lastUpdateGmt": "2007-12-03",
"actualAmountBaseInternal": 987.65,
"invoicedAmountBaseInternal": 987.65,
"outstandingBalanceBaseInternal": 123.45,
"claim": Claim,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
ClaimProjectedInvoiceFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ClaimProjectedInvoiceFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ClaimProjectedInvoiceFormQueryWhere
}
ClaimProjectedInvoiceFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [ClaimProjectedInvoiceFormQueryWhere!]
|
|
or - [ClaimProjectedInvoiceFormQueryWhere!]
|
|
rawExpression - String
|
|
claim - ClaimFormQueryWhere
|
Example
{
"and": [ClaimProjectedInvoiceFormQueryWhere],
"or": [ClaimProjectedInvoiceFormQueryWhere],
"rawExpression": "xyz789",
"claim": ClaimFormQueryWhere
}
ClaimProjectedInvoiceRelationships
Fields
| Field Name | Description |
|---|---|
claim - RelationshipDefinition
|
Example
{"claim": RelationshipDefinition}
ClaimRelationships
Fields
Example
{
"operationsInvoice": RelationshipDefinition,
"laytime": RelationshipDefinition,
"cargo": RelationshipDefinition,
"pniClub": RelationshipDefinition,
"counterparty": RelationshipDefinition,
"company": RelationshipDefinition,
"lastClaimAction": RelationshipDefinition,
"voyageItinerary": RelationshipDefinition,
"fobPort": RelationshipDefinition,
"firstCargoHandling": RelationshipDefinition,
"firstCargo": RelationshipDefinition,
"regularVoyage": RelationshipDefinition,
"fobVoyage": RelationshipDefinition,
"regularVessel": RelationshipDefinition,
"fobVessel": RelationshipDefinition,
"fobFirstCargoHandling": RelationshipDefinition,
"latestClaimOperationsInvoice": RelationshipDefinition,
"claimTypeTerm": RelationshipDefinition,
"laytimeClaimTypeTerm": RelationshipDefinition,
"analystUser": RelationshipDefinition,
"claimNotes": RelationshipDefinition,
"claimLinkedClaims": RelationshipDefinition,
"claimInvoices": RelationshipDefinition,
"claimInvoicesRelated": RelationshipDefinition,
"claimInvoicesDirect": RelationshipDefinition,
"linkedClaims": RelationshipDefinition,
"claimProjectedInvoice": RelationshipDefinition
}
ClaimStatusCodeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
ClaimStatusCodeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - ClaimStatusCodeEnum
|
|
isNot - ClaimStatusCodeEnum
|
|
isIn - [ClaimStatusCodeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
ClaimTypeCodeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"None"
ClaimTypeCodeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - ClaimTypeCodeEnum
|
|
isNot - ClaimTypeCodeEnum
|
|
isIn - [ClaimTypeCodeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
CoaAlertRulesRequest
CoaBroker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
claimSetting - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
coaID - Int
|
|
seq - Int
|
|
brokerShortName - String
|
|
commissionAmount - Float
|
|
invoicingOptions - String
|
|
brokerType - String
|
|
commissionType - String
|
|
isOwnerBroker - Boolean
|
|
partialCommissionsEnabled - Boolean
|
|
billVia - Boolean
|
|
freightInvoiceSetting - String
|
|
demurrageSetting - String
|
|
addressBook - AddressBook
|
|
coa - COA
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"claimSetting": "xyz789",
"customFieldByID": Any,
"customField": Any,
"coaID": 987,
"seq": 987,
"brokerShortName": "abc123",
"commissionAmount": 123.45,
"invoicingOptions": "xyz789",
"brokerType": "abc123",
"commissionType": "abc123",
"isOwnerBroker": false,
"partialCommissionsEnabled": false,
"billVia": true,
"freightInvoiceSetting": "xyz789",
"demurrageSetting": "abc123",
"addressBook": AddressBook,
"coa": COA,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
CoaBrokerCommissionTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CoaBrokerCommissionTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CoaBrokerCommissionTypeEnum
|
|
isNot - CoaBrokerCommissionTypeEnum
|
|
isIn - [CoaBrokerCommissionTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
CoaBrokerDemurrageSettingEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CoaBrokerDemurrageSettingEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CoaBrokerDemurrageSettingEnum
|
|
isNot - CoaBrokerDemurrageSettingEnum
|
|
isIn - [CoaBrokerDemurrageSettingEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
CoaBrokerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CoaBrokerFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CoaBrokerFormQueryWhere
}
CoaBrokerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CoaBrokerFormQueryWhere!]
|
|
or - [CoaBrokerFormQueryWhere!]
|
|
rawExpression - String
|
|
coaID - NumberWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
brokerShortName - StringWhereValueExpression
|
|
commissionAmount - NumberWhereValueExpression
|
|
invoicingOptions - StringWhereValueExpression
|
|
brokerType - StringWhereValueExpression
|
|
commissionType - CoaBrokerCommissionTypeEnumValueExpression
|
|
isOwnerBroker - BoolWhereValueExpression
|
|
partialCommissionsEnabled - BoolWhereValueExpression
|
|
billVia - BoolWhereValueExpression
|
|
freightInvoiceSetting - CoaBrokerFreightInvoiceSettingEnumValueExpression
|
|
demurrageSetting - CoaBrokerDemurrageSettingEnumValueExpression
|
|
addressBook - AddressBookFormQueryWhere
|
|
coa - COAFormQueryWhere
|
Example
{
"and": [CoaBrokerFormQueryWhere],
"or": [CoaBrokerFormQueryWhere],
"rawExpression": "xyz789",
"coaID": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"brokerShortName": StringWhereValueExpression,
"commissionAmount": NumberWhereValueExpression,
"invoicingOptions": StringWhereValueExpression,
"brokerType": StringWhereValueExpression,
"commissionType": CoaBrokerCommissionTypeEnumValueExpression,
"isOwnerBroker": BoolWhereValueExpression,
"partialCommissionsEnabled": BoolWhereValueExpression,
"billVia": BoolWhereValueExpression,
"freightInvoiceSetting": CoaBrokerFreightInvoiceSettingEnumValueExpression,
"demurrageSetting": CoaBrokerDemurrageSettingEnumValueExpression,
"addressBook": AddressBookFormQueryWhere,
"coa": COAFormQueryWhere
}
CoaBrokerFreightInvoiceSettingEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CoaBrokerFreightInvoiceSettingEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CoaBrokerFreightInvoiceSettingEnum
|
|
isNot - CoaBrokerFreightInvoiceSettingEnum
|
|
isIn - [CoaBrokerFreightInvoiceSettingEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
CoaBrokerRelationships
Fields
| Field Name | Description |
|---|---|
addressBook - RelationshipDefinition
|
|
cOA - RelationshipDefinition
|
Example
{
"addressBook": RelationshipDefinition,
"cOA": RelationshipDefinition
}
CoaHierarchy
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
parentID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
childID - Int
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
createdByUser - String
|
|
childCoa - COA
|
|
parentCoa - COA
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"parentID": 123,
"customFieldByID": Any,
"customField": Any,
"childID": 123,
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUser": "abc123",
"createdByUser": "xyz789",
"childCoa": COA,
"parentCoa": COA,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
CoaHierarchyFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CoaHierarchyFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CoaHierarchyFormQueryWhere
}
CoaHierarchyFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CoaHierarchyFormQueryWhere!]
|
|
or - [CoaHierarchyFormQueryWhere!]
|
|
rawExpression - String
|
|
parentID - NumberWhereValueExpression
|
|
childID - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
createdByUser - StringWhereValueExpression
|
|
childCoa - COAFormQueryWhere
|
|
parentCoa - COAFormQueryWhere
|
Example
{
"and": [CoaHierarchyFormQueryWhere],
"or": [CoaHierarchyFormQueryWhere],
"rawExpression": "abc123",
"parentID": NumberWhereValueExpression,
"childID": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"createdByUser": StringWhereValueExpression,
"childCoa": COAFormQueryWhere,
"parentCoa": COAFormQueryWhere
}
CoaHierarchyRelationships
Fields
| Field Name | Description |
|---|---|
childCoa - RelationshipDefinition
|
|
parentCoa - RelationshipDefinition
|
Example
{
"childCoa": RelationshipDefinition,
"parentCoa": RelationshipDefinition
}
CoaPeriod
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
performedQty - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
performedLiftings - Int
|
|
fixedQty - Float
|
|
fixedLiftings - Int
|
|
remainingQty - Float
|
|
remainingLiftings - Int
|
|
coaID - Int
|
|
seqNo - Int
|
|
orderNo - Int
|
|
fromGmt - Date
|
|
toGmt - Date
|
|
plannedQty - Float
|
|
minQty - Float
|
|
maxQty - Float
|
|
agreedQty - Float
|
|
minLiftings - Int
|
|
maxLiftings - Int
|
|
agreedLiftings - Int
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
periodTemplateCargo - Cargo
|
|
periodCargos - [Cargo]
|
|
pricingLines - [StandardRate]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"performedQty": 123.45,
"customFieldByID": Any,
"customField": Any,
"performedLiftings": 123,
"fixedQty": 987.65,
"fixedLiftings": 987,
"remainingQty": 987.65,
"remainingLiftings": 123,
"coaID": 987,
"seqNo": 123,
"orderNo": 123,
"fromGmt": "2007-12-03",
"toGmt": "2007-12-03",
"plannedQty": 987.65,
"minQty": 987.65,
"maxQty": 123.45,
"agreedQty": 123.45,
"minLiftings": 123,
"maxLiftings": 123,
"agreedLiftings": 987,
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"periodTemplateCargo": Cargo,
"periodCargos": [Cargo],
"pricingLines": [StandardRate],
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
CoaPeriodFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CoaPeriodFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CoaPeriodFormQueryWhere
}
CoaPeriodFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CoaPeriodFormQueryWhere!]
|
|
or - [CoaPeriodFormQueryWhere!]
|
|
rawExpression - String
|
|
coaID - NumberWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
orderNo - NumberWhereValueExpression
|
|
fromGmt - DateWhereValueExpression
|
|
toGmt - DateWhereValueExpression
|
|
plannedQty - NumberWhereValueExpression
|
|
minQty - NumberWhereValueExpression
|
|
maxQty - NumberWhereValueExpression
|
|
agreedQty - NumberWhereValueExpression
|
|
minLiftings - NumberWhereValueExpression
|
|
maxLiftings - NumberWhereValueExpression
|
|
agreedLiftings - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
periodTemplateCargo - CargoFormQueryWhere
|
Example
{
"and": [CoaPeriodFormQueryWhere],
"or": [CoaPeriodFormQueryWhere],
"rawExpression": "xyz789",
"coaID": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"orderNo": NumberWhereValueExpression,
"fromGmt": DateWhereValueExpression,
"toGmt": DateWhereValueExpression,
"plannedQty": NumberWhereValueExpression,
"minQty": NumberWhereValueExpression,
"maxQty": NumberWhereValueExpression,
"agreedQty": NumberWhereValueExpression,
"minLiftings": NumberWhereValueExpression,
"maxLiftings": NumberWhereValueExpression,
"agreedLiftings": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"periodTemplateCargo": CargoFormQueryWhere
}
CoaPeriodRelationships
Fields
| Field Name | Description |
|---|---|
periodTemplateCargo - RelationshipDefinition
|
|
periodCargos - RelationshipDefinition
|
|
pricingLines - RelationshipDefinition
|
Example
{
"periodTemplateCargo": RelationshipDefinition,
"periodCargos": RelationshipDefinition,
"pricingLines": RelationshipDefinition
}
CollabStatus
Fields
| Field Name | Description |
|---|---|
rootForm - String
|
|
baseViewId - String
|
|
id - String
|
|
color - String
|
|
text - String
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"rootForm": "xyz789",
"baseViewId": "abc123",
"id": "abc123",
"color": "abc123",
"text": "xyz789",
"_id": "abc123",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
CollabStatusColorEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"White"
CollabStatusColorEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CollabStatusColorEnum
|
|
isNot - CollabStatusColorEnum
|
|
isIn - [CollabStatusColorEnum]
|
Example
{"is": "White", "isNot": "White", "isIn": ["White"]}
CollabStatusFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CollabStatusFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CollabStatusFormQueryWhere
}
CollabStatusFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CollabStatusFormQueryWhere!]
|
|
or - [CollabStatusFormQueryWhere!]
|
|
rawExpression - String
|
|
rootForm - StringWhereValueExpression
|
|
baseViewId - StringWhereValueExpression
|
|
id - StringWhereValueExpression
|
|
color - CollabStatusColorEnumValueExpression
|
|
text - StringWhereValueExpression
|
Example
{
"and": [CollabStatusFormQueryWhere],
"or": [CollabStatusFormQueryWhere],
"rawExpression": "xyz789",
"rootForm": StringWhereValueExpression,
"baseViewId": StringWhereValueExpression,
"id": StringWhereValueExpression,
"color": CollabStatusColorEnumValueExpression,
"text": StringWhereValueExpression
}
CommodityContract
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
commodityContractId - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
sqlID - Int
|
|
saleOrPurchase - String
|
|
status - String
|
|
counterpartyShortName - String
|
|
counterpartyType - String
|
|
companyCode - String
|
|
lobCode - String
|
|
tradeDate - Date
|
|
product - String
|
|
qty - Float
|
|
qtyUnit - String
|
|
price - Float
|
|
priceUnit - String
|
|
priceCurrency - String
|
|
exchRate - Float
|
|
deliveryPortNo - Int
|
|
deliveryPeriodFrom - Date
|
|
deliveryPeriodTo - Date
|
|
departmentNo - Int
|
|
teamNo - Int
|
|
trader - String
|
|
tradeAreaNo - Int
|
|
strategy - String
|
|
iNCOTerms - String
|
|
loiDate - Date
|
|
brokerShortName - String
|
|
brokerType - String
|
|
commissionType - String
|
|
commissionValue - Float
|
|
commissionPaymentType - String
|
|
lCType - String
|
|
issuingBankShortName - String
|
|
advisingBankShortName - String
|
|
lCExpiration - Date
|
|
isLcIssued - Boolean
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUserID - String
|
|
departmentCode - String
|
|
externalRef - String
|
|
refContract - String
|
|
reference - String
|
|
remarks - String
|
|
optionPercentage - Float
|
|
optionType - String
|
|
lCId - String
|
|
paymentTermsCode - String
|
|
paymentTerm - PaymentTerm
|
|
department - ActDepartment
|
|
deliveryPort - Port
|
|
cargoName - CargoName
|
|
lob - Lob
|
|
tradeArea - TradeArea
|
|
traderUser - User
|
|
broker - AddressBook
|
|
counterparty - AddressBook
|
|
issuingBankAddressBook - AddressBook
|
|
advisingBankAddressBook - AddressBook
|
|
linkedTradeUnits - [Cargo]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"commodityContractId": 123,
"customFieldByID": Any,
"customField": Any,
"sqlID": 123,
"saleOrPurchase": "abc123",
"status": "abc123",
"counterpartyShortName": "xyz789",
"counterpartyType": "xyz789",
"companyCode": "xyz789",
"lobCode": "xyz789",
"tradeDate": "2007-12-03",
"product": "xyz789",
"qty": 123.45,
"qtyUnit": "xyz789",
"price": 123.45,
"priceUnit": "xyz789",
"priceCurrency": "xyz789",
"exchRate": 987.65,
"deliveryPortNo": 987,
"deliveryPeriodFrom": "2007-12-03",
"deliveryPeriodTo": "2007-12-03",
"departmentNo": 123,
"teamNo": 123,
"trader": "xyz789",
"tradeAreaNo": 987,
"strategy": "xyz789",
"iNCOTerms": "xyz789",
"loiDate": "2007-12-03",
"brokerShortName": "abc123",
"brokerType": "xyz789",
"commissionType": "xyz789",
"commissionValue": 123.45,
"commissionPaymentType": "abc123",
"lCType": "xyz789",
"issuingBankShortName": "abc123",
"advisingBankShortName": "xyz789",
"lCExpiration": "2007-12-03",
"isLcIssued": true,
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUserID": "abc123",
"departmentCode": "xyz789",
"externalRef": "abc123",
"refContract": "xyz789",
"reference": "xyz789",
"remarks": "xyz789",
"optionPercentage": 987.65,
"optionType": "abc123",
"lCId": "abc123",
"paymentTermsCode": "abc123",
"paymentTerm": PaymentTerm,
"department": ActDepartment,
"deliveryPort": Port,
"cargoName": CargoName,
"lob": Lob,
"tradeArea": TradeArea,
"traderUser": User,
"broker": AddressBook,
"counterparty": AddressBook,
"issuingBankAddressBook": AddressBook,
"advisingBankAddressBook": AddressBook,
"linkedTradeUnits": [Cargo],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
CommodityContractCommissionPaymentTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CommodityContractCommissionPaymentTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CommodityContractCommissionPaymentTypeEnum
|
|
isNot - CommodityContractCommissionPaymentTypeEnum
|
|
isIn - [CommodityContractCommissionPaymentTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
CommodityContractCommissionTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CommodityContractCommissionTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CommodityContractCommissionTypeEnum
|
|
isNot - CommodityContractCommissionTypeEnum
|
|
isIn - [CommodityContractCommissionTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
CommodityContractFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CommodityContractFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CommodityContractFormQueryWhere
}
CommodityContractFormQueryWhere
Fields
Example
{
"and": [CommodityContractFormQueryWhere],
"or": [CommodityContractFormQueryWhere],
"rawExpression": "xyz789",
"commodityContractId": NumberWhereValueExpression,
"saleOrPurchase": CommodityContractSaleOrPurchaseEnumValueExpression,
"status": CommodityContractStatusEnumValueExpression,
"counterpartyShortName": StringWhereValueExpression,
"counterpartyType": StringWhereValueExpression,
"companyCode": StringWhereValueExpression,
"lobCode": StringWhereValueExpression,
"tradeDate": DateWhereValueExpression,
"product": StringWhereValueExpression,
"qty": NumberWhereValueExpression,
"qtyUnit": StringWhereValueExpression,
"price": NumberWhereValueExpression,
"priceUnit": StringWhereValueExpression,
"priceCurrency": StringWhereValueExpression,
"exchRate": NumberWhereValueExpression,
"deliveryPortNo": NumberWhereValueExpression,
"deliveryPeriodFrom": DateWhereValueExpression,
"deliveryPeriodTo": DateWhereValueExpression,
"departmentNo": NumberWhereValueExpression,
"teamNo": NumberWhereValueExpression,
"trader": StringWhereValueExpression,
"tradeAreaNo": NumberWhereValueExpression,
"strategy": StringWhereValueExpression,
"iNCOTerms": StringWhereValueExpression,
"loiDate": DateWhereValueExpression,
"brokerShortName": StringWhereValueExpression,
"brokerType": StringWhereValueExpression,
"commissionType": CommodityContractCommissionTypeEnumValueExpression,
"commissionValue": NumberWhereValueExpression,
"commissionPaymentType": CommodityContractCommissionPaymentTypeEnumValueExpression,
"lCType": CommodityContractLCTypeEnumValueExpression,
"issuingBankShortName": StringWhereValueExpression,
"advisingBankShortName": StringWhereValueExpression,
"lCExpiration": DateWhereValueExpression,
"isLcIssued": BoolWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"departmentCode": StringWhereValueExpression,
"externalRef": StringWhereValueExpression,
"refContract": StringWhereValueExpression,
"reference": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"optionPercentage": NumberWhereValueExpression,
"optionType": CommodityContractOptionTypeEnumValueExpression,
"lCId": StringWhereValueExpression,
"paymentTermsCode": StringWhereValueExpression,
"paymentTerm": PaymentTermFormQueryWhere,
"department": ActDepartmentFormQueryWhere,
"deliveryPort": PortFormQueryWhere,
"cargoName": CargoNameFormQueryWhere,
"lob": LobFormQueryWhere,
"tradeArea": TradeAreaFormQueryWhere,
"traderUser": UserFormQueryWhere,
"broker": AddressBookFormQueryWhere,
"counterparty": AddressBookFormQueryWhere,
"issuingBankAddressBook": AddressBookFormQueryWhere,
"advisingBankAddressBook": AddressBookFormQueryWhere
}
CommodityContractLCTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CommodityContractLCTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CommodityContractLCTypeEnum
|
|
isNot - CommodityContractLCTypeEnum
|
|
isIn - [CommodityContractLCTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
CommodityContractOptionTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CommodityContractOptionTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CommodityContractOptionTypeEnum
|
|
isNot - CommodityContractOptionTypeEnum
|
|
isIn - [CommodityContractOptionTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
CommodityContractRelationships
Fields
| Field Name | Description |
|---|---|
paymentTerm - RelationshipDefinition
|
|
department - RelationshipDefinition
|
|
deliveryPort - RelationshipDefinition
|
|
cargoName - RelationshipDefinition
|
|
lob - RelationshipDefinition
|
|
tradeArea - RelationshipDefinition
|
|
traderUser - RelationshipDefinition
|
|
broker - RelationshipDefinition
|
|
counterparty - RelationshipDefinition
|
|
issuingBankAddressBook - RelationshipDefinition
|
|
advisingBankAddressBook - RelationshipDefinition
|
|
commodityContractCargoItineraries - RelationshipDefinition
|
|
linkedTradeUnits - RelationshipDefinition
|
Example
{
"paymentTerm": RelationshipDefinition,
"department": RelationshipDefinition,
"deliveryPort": RelationshipDefinition,
"cargoName": RelationshipDefinition,
"lob": RelationshipDefinition,
"tradeArea": RelationshipDefinition,
"traderUser": RelationshipDefinition,
"broker": RelationshipDefinition,
"counterparty": RelationshipDefinition,
"issuingBankAddressBook": RelationshipDefinition,
"advisingBankAddressBook": RelationshipDefinition,
"commodityContractCargoItineraries": RelationshipDefinition,
"linkedTradeUnits": RelationshipDefinition
}
CommodityContractSaleOrPurchaseEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CommodityContractSaleOrPurchaseEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CommodityContractSaleOrPurchaseEnum
|
|
isNot - CommodityContractSaleOrPurchaseEnum
|
|
isIn - [CommodityContractSaleOrPurchaseEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
CommodityContractStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
CommodityContractStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CommodityContractStatusEnum
|
|
isNot - CommodityContractStatusEnum
|
|
isIn - [CommodityContractStatusEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
Company
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
code - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
parentCode - String
|
|
name - String
|
|
forVessel - Boolean
|
|
companyAddressBook - Int
|
|
addressBook - AddressBook
|
|
companyCodeAddressBook - AddressBook
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"code": "abc123",
"customFieldByID": Any,
"customField": Any,
"parentCode": "abc123",
"name": "abc123",
"forVessel": false,
"companyAddressBook": 123,
"addressBook": AddressBook,
"companyCodeAddressBook": AddressBook,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
CompanyFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CompanyFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CompanyFormQueryWhere
}
CompanyFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CompanyFormQueryWhere!]
|
|
or - [CompanyFormQueryWhere!]
|
|
rawExpression - String
|
|
code - StringWhereValueExpression
|
|
parentCode - StringWhereValueExpression
|
|
name - StringWhereValueExpression
|
|
forVessel - BoolWhereValueExpression
|
|
companyAddressBook - NumberWhereValueExpression
|
|
addressBook - AddressBookFormQueryWhere
|
|
companyCodeAddressBook - AddressBookFormQueryWhere
|
Example
{
"and": [CompanyFormQueryWhere],
"or": [CompanyFormQueryWhere],
"rawExpression": "abc123",
"code": StringWhereValueExpression,
"parentCode": StringWhereValueExpression,
"name": StringWhereValueExpression,
"forVessel": BoolWhereValueExpression,
"companyAddressBook": NumberWhereValueExpression,
"addressBook": AddressBookFormQueryWhere,
"companyCodeAddressBook": AddressBookFormQueryWhere
}
CompanyRelationships
Fields
| Field Name | Description |
|---|---|
addressBook - RelationshipDefinition
|
|
companyCodeAddressBook - RelationshipDefinition
|
Example
{
"addressBook": RelationshipDefinition,
"companyCodeAddressBook": RelationshipDefinition
}
ConfigOptions
Fields
| Field Name | Description |
|---|---|
userNo - Int
|
|
moduleName - String
|
|
preferenceId - String
|
|
xmlSettings - String
|
|
flags - Int
|
|
entryDate - Date
|
|
lastUpdateGmt - Date
|
|
updateTimes - Int
|
|
lastUser - String
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"userNo": 987,
"moduleName": "abc123",
"preferenceId": "xyz789",
"xmlSettings": "xyz789",
"flags": 123,
"entryDate": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"updateTimes": 123,
"lastUser": "abc123",
"_id": "abc123",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
ConfigOptionsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ConfigOptionsFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ConfigOptionsFormQueryWhere
}
ConfigOptionsFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [ConfigOptionsFormQueryWhere!]
|
|
or - [ConfigOptionsFormQueryWhere!]
|
|
rawExpression - String
|
|
userNo - NumberWhereValueExpression
|
|
moduleName - StringWhereValueExpression
|
|
preferenceId - StringWhereValueExpression
|
|
xmlSettings - StringWhereValueExpression
|
|
flags - NumberWhereValueExpression
|
|
entryDate - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
updateTimes - NumberWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
Example
{
"and": [ConfigOptionsFormQueryWhere],
"or": [ConfigOptionsFormQueryWhere],
"rawExpression": "xyz789",
"userNo": NumberWhereValueExpression,
"moduleName": StringWhereValueExpression,
"preferenceId": StringWhereValueExpression,
"xmlSettings": StringWhereValueExpression,
"flags": NumberWhereValueExpression,
"entryDate": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"updateTimes": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression
}
ConnectForm
Fields
| Field Name | Description |
|---|---|
formId - String!
|
|
type - ConnectFormType!
|
|
senderTenantId - String
|
|
senderTenantName - String
|
|
targetTenantId - String!
|
|
targetTenantName - String!
|
|
assignedTo - [String!]
|
|
submitToTenantId - String
|
|
public - Boolean!
|
|
status - ConnectFormStatus!
|
|
lastUpdate - Date!
|
|
created - Date!
|
|
tags - [ConnectTag!]
|
|
title - String
|
|
comment - String
|
|
data - Json!
|
|
applyMetadata - ConnectFormApplyMetadata
|
|
source - String
|
|
sourceId - String
|
|
publishedBy - String
|
|
lastUser - String
|
Example
{
"formId": "abc123",
"type": "BunkerRequirementImport",
"senderTenantId": "abc123",
"senderTenantName": "xyz789",
"targetTenantId": "abc123",
"targetTenantName": "xyz789",
"assignedTo": ["abc123"],
"submitToTenantId": "xyz789",
"public": true,
"status": "pending",
"lastUpdate": "2007-12-03",
"created": "2007-12-03",
"tags": [ConnectTag],
"title": "xyz789",
"comment": "xyz789",
"data": Json,
"applyMetadata": ConnectFormApplyMetadata,
"source": "xyz789",
"sourceId": "abc123",
"publishedBy": "abc123",
"lastUser": "xyz789"
}
ConnectFormApplyInput
Fields
| Input Field | Description |
|---|---|
formId - String!
|
Example
{"formId": "xyz789"}
ConnectFormApplyMetadata
ConnectFormFailInput
Fields
| Input Field | Description |
|---|---|
formId - String!
|
|
errors - [String!]!
|
Example
{
"formId": "xyz789",
"errors": ["xyz789"]
}
ConnectFormPublishInput
Example
{
"type": "BunkerRequirementImport",
"tags": ["abc123"],
"title": "xyz789",
"comment": "abc123",
"public": true,
"draft": false,
"assignedTo": ["xyz789"],
"data": Json,
"targetTenantId": "xyz789",
"formId": "abc123",
"source": "xyz789",
"sourceId": "xyz789",
"submitToTenantId": "abc123"
}
ConnectFormQuery
Fields
| Input Field | Description |
|---|---|
ids - [String!]
|
|
type - ConnectFormType
|
|
status - [ConnectFormStatus!]
|
|
tags - [String!]
|
|
objectId - String
|
|
assignedTo - [String!]
|
|
sent - Boolean
|
|
offset - Int
|
|
limit - Int
|
Example
{
"ids": ["xyz789"],
"type": "BunkerRequirementImport",
"status": ["pending"],
"tags": ["xyz789"],
"objectId": "xyz789",
"assignedTo": ["xyz789"],
"sent": true,
"offset": 987,
"limit": 123
}
ConnectFormRejectInput
ConnectFormResetInput
Fields
| Input Field | Description |
|---|---|
formId - String!
|
Example
{"formId": "xyz789"}
ConnectFormStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"pending"
ConnectFormType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BunkerRequirementImport"
ConnectTag
ConnectTagQuery
ConsMode
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
consModeID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
consModeName - String
|
|
isInactive - Boolean
|
|
consModePortCons - [ConsModePortCons]
|
|
consModeSeaCons - [ConsModeSeaCons]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"consModeID": 987,
"customFieldByID": Any,
"customField": Any,
"consModeName": "abc123",
"isInactive": true,
"consModePortCons": [ConsModePortCons],
"consModeSeaCons": [ConsModeSeaCons],
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
ConsModeFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ConsModeFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ConsModeFormQueryWhere
}
ConsModeFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [ConsModeFormQueryWhere!]
|
|
or - [ConsModeFormQueryWhere!]
|
|
rawExpression - String
|
|
consModeID - NumberWhereValueExpression
|
|
consModeName - StringWhereValueExpression
|
|
isInactive - BoolWhereValueExpression
|
Example
{
"and": [ConsModeFormQueryWhere],
"or": [ConsModeFormQueryWhere],
"rawExpression": "abc123",
"consModeID": NumberWhereValueExpression,
"consModeName": StringWhereValueExpression,
"isInactive": BoolWhereValueExpression
}
ConsModePortCons
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
consModeID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
index - Int
|
|
lineNo - Int
|
|
fuelType - String
|
|
loadFuel - Float
|
|
dischargeFuel - Float
|
|
idle - Float
|
|
hotel - Float
|
|
heat - Float
|
|
clean - Float
|
|
margin - Float
|
|
capacity - Float
|
|
unit - String
|
|
isFuelGradeHighSulfur - Boolean
|
|
isFuelGradeLowSulfur - Boolean
|
|
isFuelAsFoe - Boolean
|
|
isFuelInactive - Boolean
|
|
heatPlus - Float
|
|
auxiliary - Float
|
|
maneuver - Float
|
|
igs - Float
|
|
cool - Float
|
|
coolPlus - Float
|
|
heatPlusPlus - Float
|
|
gradeCode - Int
|
|
boiler - Float
|
|
incinerator - Float
|
|
consMode - ConsMode
|
|
fuel - FuelLubeType
|
|
units - UnitOfMeasure
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"consModeID": 123,
"customFieldByID": Any,
"customField": Any,
"index": 987,
"lineNo": 987,
"fuelType": "abc123",
"loadFuel": 987.65,
"dischargeFuel": 987.65,
"idle": 987.65,
"hotel": 987.65,
"heat": 987.65,
"clean": 987.65,
"margin": 123.45,
"capacity": 987.65,
"unit": "abc123",
"isFuelGradeHighSulfur": true,
"isFuelGradeLowSulfur": false,
"isFuelAsFoe": true,
"isFuelInactive": true,
"heatPlus": 987.65,
"auxiliary": 987.65,
"maneuver": 987.65,
"igs": 987.65,
"cool": 123.45,
"coolPlus": 123.45,
"heatPlusPlus": 987.65,
"gradeCode": 123,
"boiler": 123.45,
"incinerator": 987.65,
"consMode": ConsMode,
"fuel": FuelLubeType,
"units": UnitOfMeasure,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
ConsModePortConsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ConsModePortConsFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ConsModePortConsFormQueryWhere
}
ConsModePortConsFormQueryWhere
Fields
Example
{
"and": [ConsModePortConsFormQueryWhere],
"or": [ConsModePortConsFormQueryWhere],
"rawExpression": "abc123",
"consModeID": NumberWhereValueExpression,
"index": NumberWhereValueExpression,
"lineNo": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"loadFuel": NumberWhereValueExpression,
"dischargeFuel": NumberWhereValueExpression,
"idle": NumberWhereValueExpression,
"hotel": NumberWhereValueExpression,
"heat": NumberWhereValueExpression,
"clean": NumberWhereValueExpression,
"margin": NumberWhereValueExpression,
"capacity": NumberWhereValueExpression,
"unit": StringWhereValueExpression,
"isFuelGradeHighSulfur": BoolWhereValueExpression,
"isFuelGradeLowSulfur": BoolWhereValueExpression,
"isFuelAsFoe": BoolWhereValueExpression,
"isFuelInactive": BoolWhereValueExpression,
"heatPlus": NumberWhereValueExpression,
"auxiliary": NumberWhereValueExpression,
"maneuver": NumberWhereValueExpression,
"igs": NumberWhereValueExpression,
"cool": NumberWhereValueExpression,
"coolPlus": NumberWhereValueExpression,
"heatPlusPlus": NumberWhereValueExpression,
"gradeCode": NumberWhereValueExpression,
"boiler": NumberWhereValueExpression,
"incinerator": NumberWhereValueExpression,
"consMode": ConsModeFormQueryWhere,
"fuel": FuelLubeTypeFormQueryWhere,
"units": UnitOfMeasureFormQueryWhere
}
ConsModePortConsRelationships
Fields
| Field Name | Description |
|---|---|
consMode - RelationshipDefinition
|
|
fuel - RelationshipDefinition
|
|
units - RelationshipDefinition
|
Example
{
"consMode": RelationshipDefinition,
"fuel": RelationshipDefinition,
"units": RelationshipDefinition
}
ConsModeRelationships
Fields
| Field Name | Description |
|---|---|
consModePortCons - RelationshipDefinition
|
|
consModeSeaCons - RelationshipDefinition
|
Example
{
"consModePortCons": RelationshipDefinition,
"consModeSeaCons": RelationshipDefinition
}
ConsModeSeaCons
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
consModeID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
speed - Float
|
|
isCpSpeed - Boolean
|
|
engineLoad - Float
|
|
type - String
|
|
description - String
|
|
consMode - ConsMode
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"consModeID": 123,
"customFieldByID": Any,
"customField": Any,
"speed": 987.65,
"isCpSpeed": true,
"engineLoad": 123.45,
"type": "abc123",
"description": "xyz789",
"consMode": ConsMode,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
ConsModeSeaConsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ConsModeSeaConsFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ConsModeSeaConsFormQueryWhere
}
ConsModeSeaConsFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [ConsModeSeaConsFormQueryWhere!]
|
|
or - [ConsModeSeaConsFormQueryWhere!]
|
|
rawExpression - String
|
|
consModeID - NumberWhereValueExpression
|
|
speed - NumberWhereValueExpression
|
|
isCpSpeed - BoolWhereValueExpression
|
|
engineLoad - NumberWhereValueExpression
|
|
type - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
consMode - ConsModeFormQueryWhere
|
Example
{
"and": [ConsModeSeaConsFormQueryWhere],
"or": [ConsModeSeaConsFormQueryWhere],
"rawExpression": "xyz789",
"consModeID": NumberWhereValueExpression,
"speed": NumberWhereValueExpression,
"isCpSpeed": BoolWhereValueExpression,
"engineLoad": NumberWhereValueExpression,
"type": StringWhereValueExpression,
"description": StringWhereValueExpression,
"consMode": ConsModeFormQueryWhere
}
ConsModeSeaConsRelationships
Fields
| Field Name | Description |
|---|---|
consMode - RelationshipDefinition
|
Example
{"consMode": RelationshipDefinition}
ContractInfo
Example
{
"contractID": "abc123",
"date": "2007-12-03",
"type": "xyz789",
"currentlyEmployed": false,
"openUnderEmployment": false,
"prevVoyageNo": 987,
"currVoyageNo": 987,
"nextVoyageNo": 987
}
Coordinates
CopyEstimateInput
CopyEstimateMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": true,
"context": ["xyz789"],
"timestamp": "xyz789",
"originalTimestamp": "abc123",
"intent": "xyz789",
"from": "xyz789",
"to": ["xyz789"],
"fromUser": "abc123",
"status": "abc123",
"approvalStatus": "xyz789",
"objectId": "xyz789",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "abc123",
"applyTriggeredBy": "abc123",
"previousData": Json,
"comment": "abc123",
"unmapped": false,
"responseData": Json,
"applyErrors": ["abc123"],
"applyWarnings": ["abc123"],
"parentMessageId": "xyz789",
"preResolutionObjectId": "abc123",
"title": "xyz789",
"effectiveDate": "xyz789",
"source": "abc123",
"sourceId": "abc123",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["abc123"],
"isLatest": false,
"threadCount": 987,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
CorrelationProfile
Fields
| Field Name | Description |
|---|---|
profileName - String
|
|
type - String
|
|
monthIndex - Int
|
|
correlation - Float
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"profileName": "xyz789",
"type": "xyz789",
"monthIndex": 987,
"correlation": 123.45,
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"_id": "xyz789",
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
CorrelationProfileFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CorrelationProfileFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CorrelationProfileFormQueryWhere
}
CorrelationProfileFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CorrelationProfileFormQueryWhere!]
|
|
or - [CorrelationProfileFormQueryWhere!]
|
|
rawExpression - String
|
|
profileName - StringWhereValueExpression
|
|
type - CorrelationProfileTypeEnumValueExpression
|
|
monthIndex - NumberWhereValueExpression
|
|
correlation - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
Example
{
"and": [CorrelationProfileFormQueryWhere],
"or": [CorrelationProfileFormQueryWhere],
"rawExpression": "xyz789",
"profileName": StringWhereValueExpression,
"type": CorrelationProfileTypeEnumValueExpression,
"monthIndex": NumberWhereValueExpression,
"correlation": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression
}
CorrelationProfileTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EnumEmpty"
CorrelationProfileTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - CorrelationProfileTypeEnum
|
|
isNot - CorrelationProfileTypeEnum
|
|
isIn - [CorrelationProfileTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
Country
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
sqlID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
countryNo - Int
|
|
digraph - String
|
|
unName - String
|
|
unCode - String
|
|
lastUser - String
|
|
isWarRisk - Boolean
|
|
isEnoa - Boolean
|
|
isAms - Boolean
|
|
isSiscarga - Boolean
|
|
isFreightTax - Boolean
|
|
isIcs - Boolean
|
|
lastUpdateGmt - Date
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"sqlID": 123,
"customFieldByID": Any,
"customField": Any,
"countryNo": 987,
"digraph": "xyz789",
"unName": "xyz789",
"unCode": "abc123",
"lastUser": "abc123",
"isWarRisk": true,
"isEnoa": true,
"isAms": true,
"isSiscarga": false,
"isFreightTax": true,
"isIcs": true,
"lastUpdateGmt": "2007-12-03",
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
CountryFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CountryFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CountryFormQueryWhere
}
CountryFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CountryFormQueryWhere!]
|
|
or - [CountryFormQueryWhere!]
|
|
rawExpression - String
|
|
countryNo - NumberWhereValueExpression
|
|
digraph - StringWhereValueExpression
|
|
unName - StringWhereValueExpression
|
|
unCode - StringWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
isWarRisk - BoolWhereValueExpression
|
|
isEnoa - BoolWhereValueExpression
|
|
isAms - BoolWhereValueExpression
|
|
isSiscarga - BoolWhereValueExpression
|
|
isFreightTax - BoolWhereValueExpression
|
|
isIcs - BoolWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
Example
{
"and": [CountryFormQueryWhere],
"or": [CountryFormQueryWhere],
"rawExpression": "xyz789",
"countryNo": NumberWhereValueExpression,
"digraph": StringWhereValueExpression,
"unName": StringWhereValueExpression,
"unCode": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"isWarRisk": BoolWhereValueExpression,
"isEnoa": BoolWhereValueExpression,
"isAms": BoolWhereValueExpression,
"isSiscarga": BoolWhereValueExpression,
"isFreightTax": BoolWhereValueExpression,
"isIcs": BoolWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression
}
CreateLaytimeClaimInput
Fields
| Input Field | Description |
|---|---|
isReversible - Boolean
|
IsReversible |
onceOnAlwaysOn - Boolean
|
OnceOnAlwaysOn |
isOnAccount - Boolean
|
IsOnAccount |
includeInPnl - Boolean
|
IncludeInPnl |
noRebill - Boolean
|
NoRebill |
vesselCode - String
|
VesselCode |
voyageNo - Float
|
VoyageNo |
counterpartyShortName - String
|
CounterpartyShortName |
counterpartyType - String
|
CounterpartyType |
analyst - String
|
Analyst |
invoiceNo - String
|
InvoiceNo |
cargoId - Float
|
CargoId |
taskId - Float
|
TaskId |
status - String
|
Status |
subStatus - String
|
SubStatus |
calcRemarks - String
|
CalcRemarks |
currency - String
|
Currency |
originalAmountCurr - Float
|
OriginalAmountCurr |
agreedAmountCurr - Float
|
AgreedAmountCurr |
ratePerDay - Float
|
RatePerDay |
aPAROverride - CreateLaytimeClaim_APAROverride
|
|
claimCreatedOrReceivedDate - Date
|
ClaimCreatedOrReceivedDate |
openedDate - Date
|
OpenedDate |
timeBarDate - Date
|
TimeBarDate |
settledDate - Date
|
SettledDate |
externalRef - String
|
ExternalRef |
type - String
|
Type |
subType - String
|
SubType |
lastAction - String
|
LastAction |
lastActionDate - Date
|
LastActionDate |
skipImport - Boolean
|
SkipImport |
skipActDedValidation - Boolean
|
SkipActDedValidation |
itineraries - [CreateLaytimeClaim_ItinerariesInput]
|
|
portActivities - [CreateLaytimeClaim_PortActivitiesInput]
|
|
deductions - [CreateLaytimeClaim_DeductionsInput]
|
Example
{
"isReversible": false,
"onceOnAlwaysOn": true,
"isOnAccount": false,
"includeInPnl": true,
"noRebill": false,
"vesselCode": "abc123",
"voyageNo": 123.45,
"counterpartyShortName": "xyz789",
"counterpartyType": "xyz789",
"analyst": "abc123",
"invoiceNo": "xyz789",
"cargoId": 987.65,
"taskId": 987.65,
"status": "abc123",
"subStatus": "abc123",
"calcRemarks": "abc123",
"currency": "xyz789",
"originalAmountCurr": 987.65,
"agreedAmountCurr": 123.45,
"ratePerDay": 987.65,
"aPAROverride": "AP",
"claimCreatedOrReceivedDate": "2007-12-03",
"openedDate": "2007-12-03",
"timeBarDate": "2007-12-03",
"settledDate": "2007-12-03",
"externalRef": "xyz789",
"type": "xyz789",
"subType": "abc123",
"lastAction": "abc123",
"lastActionDate": "2007-12-03",
"skipImport": true,
"skipActDedValidation": false,
"itineraries": [CreateLaytimeClaim_ItinerariesInput],
"portActivities": [
CreateLaytimeClaim_PortActivitiesInput
],
"deductions": [CreateLaytimeClaim_DeductionsInput]
}
CreateLaytimeClaimMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": true,
"context": ["abc123"],
"timestamp": "xyz789",
"originalTimestamp": "xyz789",
"intent": "abc123",
"from": "abc123",
"to": ["xyz789"],
"fromUser": "abc123",
"status": "abc123",
"approvalStatus": "abc123",
"objectId": "abc123",
"type": "xyz789",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "abc123",
"previousData": Json,
"comment": "abc123",
"unmapped": false,
"responseData": Json,
"applyErrors": ["abc123"],
"applyWarnings": ["abc123"],
"parentMessageId": "xyz789",
"preResolutionObjectId": "abc123",
"title": "xyz789",
"effectiveDate": "abc123",
"source": "xyz789",
"sourceId": "xyz789",
"threadId": "xyz789",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": false,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
CreateLaytimeClaim_APAROverride
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"AP"
CreateLaytimeClaim_DeductionsInput
Example
{
"itinSeq": 987.65,
"portSeqNo": 987.65,
"laytimeSeq": 123.45,
"fromDateLocal": "2007-12-03",
"toDateLocal": "2007-12-03",
"remarks": "abc123",
"duration": "abc123",
"percent": 123.45,
"dedName": "abc123"
}
CreateLaytimeClaim_ItinerariesInput
Fields
| Input Field | Description |
|---|---|
itinSeq - Float
|
ItinSeq |
portSeqNo - Float
|
PortSeqNo |
cargoID - Float
|
CargoID |
portcarSeq - Float
|
PortcarSeq |
demRate - Float
|
DemRate |
desRate - Float
|
DesRate |
allowed - String
|
Allowed |
used - String
|
Used |
quantity - Float
|
Quantity |
loadDiscRate - Float
|
LoadDiscRate |
terms - String
|
Terms |
Example
{
"itinSeq": 987.65,
"portSeqNo": 123.45,
"cargoID": 987.65,
"portcarSeq": 123.45,
"demRate": 123.45,
"desRate": 123.45,
"allowed": "abc123",
"used": "abc123",
"quantity": 123.45,
"loadDiscRate": 123.45,
"terms": "abc123"
}
CreateLaytimeClaim_PortActivitiesInput
Example
{
"itinSeq": 123.45,
"portSeqNo": 123.45,
"laytimeSeq": 123.45,
"startLocal": "2007-12-03",
"remarks": "abc123",
"actName": "xyz789",
"activityType": "abc123",
"berthShortName": "abc123"
}
CreateViewRequest
Currency
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
currencyCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
description - String
|
|
symbol - String
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"currencyCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"description": "abc123",
"symbol": "xyz789",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
CurrencyFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - CurrencyFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": CurrencyFormQueryWhere
}
CurrencyFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [CurrencyFormQueryWhere!]
|
|
or - [CurrencyFormQueryWhere!]
|
|
rawExpression - String
|
|
currencyCode - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
symbol - StringWhereValueExpression
|
Example
{
"and": [CurrencyFormQueryWhere],
"or": [CurrencyFormQueryWhere],
"rawExpression": "xyz789",
"currencyCode": StringWhereValueExpression,
"description": StringWhereValueExpression,
"symbol": StringWhereValueExpression
}
DataAggregator
Fields
| Input Field | Description |
|---|---|
aggregateOver - String
|
|
targetFieldID - String
|
|
dataAggregation - AggregateFunction
|
|
as - String
|
|
applyAfterFilters - Boolean
|
Example
{
"aggregateOver": "xyz789",
"targetFieldID": "abc123",
"dataAggregation": "None",
"as": "xyz789",
"applyAfterFilters": true
}
DataFormView
Fields
| Field Name | Description |
|---|---|
viewID - Int
|
|
viewName - String
|
|
ownerUserNo - Int
|
|
isDefault - Boolean
|
|
flags - Int
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"viewID": 123,
"viewName": "abc123",
"ownerUserNo": 123,
"isDefault": false,
"flags": 123,
"_id": "abc123",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
DataFormViewField
Fields
| Field Name | Description |
|---|---|
viewID - Int
|
|
fieldID - String
|
|
stateJson - String
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"viewID": 123,
"fieldID": "abc123",
"stateJson": "abc123",
"_id": "xyz789",
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
DataFormViewFieldFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - DataFormViewFieldFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": DataFormViewFieldFormQueryWhere
}
DataFormViewFieldFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [DataFormViewFieldFormQueryWhere!]
|
|
or - [DataFormViewFieldFormQueryWhere!]
|
|
rawExpression - String
|
|
viewID - NumberWhereValueExpression
|
|
fieldID - StringWhereValueExpression
|
|
stateJson - StringWhereValueExpression
|
Example
{
"and": [DataFormViewFieldFormQueryWhere],
"or": [DataFormViewFieldFormQueryWhere],
"rawExpression": "xyz789",
"viewID": NumberWhereValueExpression,
"fieldID": StringWhereValueExpression,
"stateJson": StringWhereValueExpression
}
DataFormViewFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - DataFormViewFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": DataFormViewFormQueryWhere
}
DataFormViewFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [DataFormViewFormQueryWhere!]
|
|
or - [DataFormViewFormQueryWhere!]
|
|
rawExpression - String
|
|
viewID - NumberWhereValueExpression
|
|
viewName - StringWhereValueExpression
|
|
ownerUserNo - NumberWhereValueExpression
|
|
isDefault - BoolWhereValueExpression
|
|
flags - NumberWhereValueExpression
|
Example
{
"and": [DataFormViewFormQueryWhere],
"or": [DataFormViewFormQueryWhere],
"rawExpression": "abc123",
"viewID": NumberWhereValueExpression,
"viewName": StringWhereValueExpression,
"ownerUserNo": NumberWhereValueExpression,
"isDefault": BoolWhereValueExpression,
"flags": NumberWhereValueExpression
}
Date
Example
"2007-12-03"
DateWhereValueExpression
DecisionTable
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
classID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
tableID - String
|
|
tableXml - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
createdByUser - String
|
|
inactive - Boolean
|
|
alerts - [Alert]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"classID": "xyz789",
"customFieldByID": Any,
"customField": Any,
"tableID": "xyz789",
"tableXml": "abc123",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUser": "xyz789",
"createdByUser": "abc123",
"inactive": true,
"alerts": [Alert],
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
DecisionTableAlert
DecisionTableFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - DecisionTableFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": DecisionTableFormQueryWhere
}
DecisionTableFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [DecisionTableFormQueryWhere!]
|
|
or - [DecisionTableFormQueryWhere!]
|
|
rawExpression - String
|
|
classID - StringWhereValueExpression
|
|
tableID - StringWhereValueExpression
|
|
tableXml - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
createdByUser - StringWhereValueExpression
|
|
inactive - BoolWhereValueExpression
|
Example
{
"and": [DecisionTableFormQueryWhere],
"or": [DecisionTableFormQueryWhere],
"rawExpression": "xyz789",
"classID": StringWhereValueExpression,
"tableID": StringWhereValueExpression,
"tableXml": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"createdByUser": StringWhereValueExpression,
"inactive": BoolWhereValueExpression
}
DecisionTableRelationships
Fields
| Field Name | Description |
|---|---|
tableXml_Table - RelationshipDefinition
|
|
alerts - RelationshipDefinition
|
Example
{
"tableXml_Table": RelationshipDefinition,
"alerts": RelationshipDefinition
}
DecisionTableRuleReport
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
classID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
tableID - String
|
|
orderNo - Int
|
|
name - String
|
|
conditions - String
|
|
results - String
|
|
stopIfTrue - Boolean
|
|
decisionTable - DecisionTable
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"classID": "abc123",
"customFieldByID": Any,
"customField": Any,
"tableID": "xyz789",
"orderNo": 123,
"name": "abc123",
"conditions": "xyz789",
"results": "xyz789",
"stopIfTrue": false,
"decisionTable": DecisionTable,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
DecisionTableRuleReportFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - DecisionTableRuleReportFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": DecisionTableRuleReportFormQueryWhere
}
DecisionTableRuleReportFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [DecisionTableRuleReportFormQueryWhere!]
|
|
or - [DecisionTableRuleReportFormQueryWhere!]
|
|
rawExpression - String
|
|
classID - StringWhereValueExpression
|
|
tableID - StringWhereValueExpression
|
|
orderNo - NumberWhereValueExpression
|
|
name - StringWhereValueExpression
|
|
conditions - StringWhereValueExpression
|
|
results - StringWhereValueExpression
|
|
stopIfTrue - BoolWhereValueExpression
|
|
decisionTable - DecisionTableFormQueryWhere
|
Example
{
"and": [DecisionTableRuleReportFormQueryWhere],
"or": [DecisionTableRuleReportFormQueryWhere],
"rawExpression": "xyz789",
"classID": StringWhereValueExpression,
"tableID": StringWhereValueExpression,
"orderNo": NumberWhereValueExpression,
"name": StringWhereValueExpression,
"conditions": StringWhereValueExpression,
"results": StringWhereValueExpression,
"stopIfTrue": BoolWhereValueExpression,
"decisionTable": DecisionTableFormQueryWhere
}
DecisionTableRuleReportRelationships
Fields
| Field Name | Description |
|---|---|
decisionTable - RelationshipDefinition
|
Example
{"decisionTable": RelationshipDefinition}
DecisionTableTask
Example
{
"id": "abc123",
"subject": "abc123",
"description": "xyz789",
"category": "xyz789",
"priority": "abc123",
"owner": "xyz789",
"startDateGmt": "2007-12-03",
"dueDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03"
}
Delay
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
delayEndGmt - Date
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
tciLumpsumSettlement - Float
|
|
tcoLumpsumSettlement - Float
|
|
tciOffhireBunkersCost - Float
|
|
tcoOffhireBunkersCost - Float
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
itinerarySeq - Int
|
|
seq - Int
|
|
delayStartGmt - Date
|
|
delayStartLocal - Date
|
|
delayEndLocal - Date
|
|
hours - Float
|
|
miles - Int
|
|
activity - String
|
|
reason - String
|
|
lastUserID - String
|
|
remarks - String
|
|
tciPercent - Float
|
|
tcoPercent - Float
|
|
isOffhire - Boolean
|
|
useLastInvoicePrice - Boolean
|
|
hiddenForTci - Boolean
|
|
hiddenForTco - Boolean
|
|
gmtIsFormDate - Boolean
|
|
includeInEstPnl - Boolean
|
|
importedFromVoyage - Boolean
|
|
addToHireTco - Boolean
|
|
addToHireTci - Boolean
|
|
delaySeq - Int
|
|
tciDailyCost - Float
|
|
tcoDailyCost - Float
|
|
tciDeductHours - Float
|
|
tcoDeductHours - Float
|
|
cargoID - Int
|
|
rateDiff - String
|
|
contract - String
|
|
equipmentCode - String
|
|
lastUpdateGmt - Date
|
|
tciLumpsumSettlementInternal - Float
|
|
tcoLumpsumSettlementInternal - Float
|
|
tciClaimID - Int
|
|
tcoClaimID - Int
|
|
tcoClaim - Claim
|
|
tciClaim - Claim
|
|
delayReason - DelayReason
|
|
delayType - DelayType
|
|
voyage - Voyage
|
|
voyageItinerary - VoyageItinerary
|
|
operationsInvoiceDetails - [OperationsInvoiceDetails]
|
|
delayBunkers - [DelayBunker]
|
|
delayMessages - [DelayMessageRecord]
|
|
Arguments
|
|
changesSinceLast - DelayChangesSinceLast
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"delayEndGmt": "2007-12-03",
"customFieldByID": Any,
"customField": Any,
"tciLumpsumSettlement": 123.45,
"tcoLumpsumSettlement": 123.45,
"tciOffhireBunkersCost": 123.45,
"tcoOffhireBunkersCost": 123.45,
"vesselCode": "xyz789",
"voyageNo": 123,
"itinerarySeq": 987,
"seq": 123,
"delayStartGmt": "2007-12-03",
"delayStartLocal": "2007-12-03",
"delayEndLocal": "2007-12-03",
"hours": 123.45,
"miles": 987,
"activity": "xyz789",
"reason": "abc123",
"lastUserID": "abc123",
"remarks": "abc123",
"tciPercent": 987.65,
"tcoPercent": 987.65,
"isOffhire": false,
"useLastInvoicePrice": true,
"hiddenForTci": true,
"hiddenForTco": false,
"gmtIsFormDate": false,
"includeInEstPnl": false,
"importedFromVoyage": false,
"addToHireTco": false,
"addToHireTci": false,
"delaySeq": 987,
"tciDailyCost": 987.65,
"tcoDailyCost": 987.65,
"tciDeductHours": 123.45,
"tcoDeductHours": 987.65,
"cargoID": 123,
"rateDiff": "abc123",
"contract": "xyz789",
"equipmentCode": "abc123",
"lastUpdateGmt": "2007-12-03",
"tciLumpsumSettlementInternal": 123.45,
"tcoLumpsumSettlementInternal": 123.45,
"tciClaimID": 123,
"tcoClaimID": 987,
"tcoClaim": Claim,
"tciClaim": Claim,
"delayReason": DelayReason,
"delayType": DelayType,
"voyage": Voyage,
"voyageItinerary": VoyageItinerary,
"operationsInvoiceDetails": [OperationsInvoiceDetails],
"delayBunkers": [DelayBunker],
"delayMessages": [DelayMessageRecord],
"changesSinceLast": DelayChangesSinceLast,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
DelayBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tciFuelCost - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
tcoFuelCost - Float
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
itinerarySeq - Int
|
|
delayGmt - Date
|
|
delayStartLocal - Date
|
|
delaySeqNo - Int
|
|
fuelType - String
|
|
qty - Float
|
|
price - Float
|
|
priceTco - Float
|
|
rob - Float
|
|
delay - Delay
|
|
timeCharterInBunker - TimeCharterBunkerDelivery
|
|
timeCharterOutBunker - TimeCharterBunkerDelivery
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"tciFuelCost": 123.45,
"customFieldByID": Any,
"customField": Any,
"tcoFuelCost": 987.65,
"vesselCode": "xyz789",
"voyageNo": 987,
"itinerarySeq": 123,
"delayGmt": "2007-12-03",
"delayStartLocal": "2007-12-03",
"delaySeqNo": 987,
"fuelType": "abc123",
"qty": 123.45,
"price": 123.45,
"priceTco": 123.45,
"rob": 987.65,
"delay": Delay,
"timeCharterInBunker": TimeCharterBunkerDelivery,
"timeCharterOutBunker": TimeCharterBunkerDelivery,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
DelayBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - DelayBunkerFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": DelayBunkerFormQueryWhere
}
DelayBunkerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [DelayBunkerFormQueryWhere!]
|
|
or - [DelayBunkerFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
itinerarySeq - NumberWhereValueExpression
|
|
delayGmt - DateWhereValueExpression
|
|
delayStartLocal - DateWhereValueExpression
|
|
delaySeqNo - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
qty - NumberWhereValueExpression
|
|
price - NumberWhereValueExpression
|
|
priceTco - NumberWhereValueExpression
|
|
rob - NumberWhereValueExpression
|
|
delay - DelayFormQueryWhere
|
|
timeCharterInBunker - TimeCharterBunkerDeliveryFormQueryWhere
|
|
timeCharterOutBunker - TimeCharterBunkerDeliveryFormQueryWhere
|
Example
{
"and": [DelayBunkerFormQueryWhere],
"or": [DelayBunkerFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"itinerarySeq": NumberWhereValueExpression,
"delayGmt": DateWhereValueExpression,
"delayStartLocal": DateWhereValueExpression,
"delaySeqNo": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"qty": NumberWhereValueExpression,
"price": NumberWhereValueExpression,
"priceTco": NumberWhereValueExpression,
"rob": NumberWhereValueExpression,
"delay": DelayFormQueryWhere,
"timeCharterInBunker": TimeCharterBunkerDeliveryFormQueryWhere,
"timeCharterOutBunker": TimeCharterBunkerDeliveryFormQueryWhere
}
DelayBunkerRelationships
Fields
| Field Name | Description |
|---|---|
delay - RelationshipDefinition
|
|
timeCharterInBunker - RelationshipDefinition
|
|
timeCharterOutBunker - RelationshipDefinition
|
Example
{
"delay": RelationshipDefinition,
"timeCharterInBunker": RelationshipDefinition,
"timeCharterOutBunker": RelationshipDefinition
}
DelayChangesSinceLast
Fields
| Field Name | Description |
|---|---|
delay - MessageUpdateResponse
|
Example
{"delay": MessageUpdateResponse}
DelayFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - DelayFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": DelayFormQueryWhere
}
DelayFormQueryWhere
Fields
Example
{
"and": [DelayFormQueryWhere],
"or": [DelayFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"itinerarySeq": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"delayStartGmt": DateWhereValueExpression,
"delayStartLocal": DateWhereValueExpression,
"delayEndLocal": DateWhereValueExpression,
"hours": NumberWhereValueExpression,
"miles": NumberWhereValueExpression,
"activity": StringWhereValueExpression,
"reason": StringWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"tciPercent": NumberWhereValueExpression,
"tcoPercent": NumberWhereValueExpression,
"isOffhire": BoolWhereValueExpression,
"useLastInvoicePrice": BoolWhereValueExpression,
"hiddenForTci": BoolWhereValueExpression,
"hiddenForTco": BoolWhereValueExpression,
"gmtIsFormDate": BoolWhereValueExpression,
"includeInEstPnl": BoolWhereValueExpression,
"importedFromVoyage": BoolWhereValueExpression,
"addToHireTco": BoolWhereValueExpression,
"addToHireTci": BoolWhereValueExpression,
"delaySeq": NumberWhereValueExpression,
"tciDailyCost": NumberWhereValueExpression,
"tcoDailyCost": NumberWhereValueExpression,
"tciDeductHours": NumberWhereValueExpression,
"tcoDeductHours": NumberWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"rateDiff": StringWhereValueExpression,
"contract": StringWhereValueExpression,
"equipmentCode": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"tciLumpsumSettlementInternal": NumberWhereValueExpression,
"tcoLumpsumSettlementInternal": NumberWhereValueExpression,
"tciClaimID": NumberWhereValueExpression,
"tcoClaimID": NumberWhereValueExpression,
"tcoClaim": ClaimFormQueryWhere,
"tciClaim": ClaimFormQueryWhere,
"delayReason": DelayReasonFormQueryWhere,
"delayType": DelayTypeFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"voyageItinerary": VoyageItineraryFormQueryWhere
}
DelayInput
Description
Submits a veslink Delay transaction
Fields
| Input Field | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
|
seq - Int
|
|
remarks - String
|
|
delayStartGmt - Date
|
|
delayEndGmt - Date
|
|
hours - Float
|
|
miles - Int
|
|
delayType - Delay_DelayTypeInput!
|
|
delayBunkers - [Delay_DelayBunkersInput]
|
|
delayReasonName - String
|
Longform reason name, this is what the user will see. |
Example
{
"vesselCode": "abc123",
"voyageNo": 123,
"seq": 123,
"remarks": "xyz789",
"delayStartGmt": "2007-12-03",
"delayEndGmt": "2007-12-03",
"hours": 123.45,
"miles": 123,
"delayType": Delay_DelayTypeInput,
"delayBunkers": [Delay_DelayBunkersInput],
"delayReasonName": "xyz789"
}
DelayMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": true,
"context": ["xyz789"],
"timestamp": "abc123",
"originalTimestamp": "xyz789",
"intent": "xyz789",
"from": "xyz789",
"to": ["abc123"],
"fromUser": "abc123",
"status": "abc123",
"approvalStatus": "xyz789",
"objectId": "xyz789",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "abc123",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "abc123",
"unmapped": false,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["xyz789"],
"parentMessageId": "abc123",
"preResolutionObjectId": "abc123",
"title": "xyz789",
"effectiveDate": "abc123",
"source": "xyz789",
"sourceId": "xyz789",
"threadId": "xyz789",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": true,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
DelayReason
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
seqNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
reason - String
|
|
property - String
|
|
lastUser - String
|
|
parentReasonSeqNo - Int
|
|
delayTypeSeqNo - Int
|
|
lastUpdateGmt - Date
|
|
uISeqNo - Int
|
|
delayReason - DelayReason
|
|
delayType - DelayType
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"seqNo": 987,
"customFieldByID": Any,
"customField": Any,
"reason": "xyz789",
"property": "abc123",
"lastUser": "xyz789",
"parentReasonSeqNo": 987,
"delayTypeSeqNo": 123,
"lastUpdateGmt": "2007-12-03",
"uISeqNo": 123,
"delayReason": DelayReason,
"delayType": DelayType,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
DelayReasonFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - DelayReasonFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": DelayReasonFormQueryWhere
}
DelayReasonFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [DelayReasonFormQueryWhere!]
|
|
or - [DelayReasonFormQueryWhere!]
|
|
rawExpression - String
|
|
seqNo - NumberWhereValueExpression
|
|
reason - StringWhereValueExpression
|
|
property - DelayReasonPropertyEnumValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
parentReasonSeqNo - NumberWhereValueExpression
|
|
delayTypeSeqNo - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
uISeqNo - NumberWhereValueExpression
|
|
delayReason - DelayReasonFormQueryWhere
|
|
delayType - DelayTypeFormQueryWhere
|
Example
{
"and": [DelayReasonFormQueryWhere],
"or": [DelayReasonFormQueryWhere],
"rawExpression": "abc123",
"seqNo": NumberWhereValueExpression,
"reason": StringWhereValueExpression,
"property": DelayReasonPropertyEnumValueExpression,
"lastUser": StringWhereValueExpression,
"parentReasonSeqNo": NumberWhereValueExpression,
"delayTypeSeqNo": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"uISeqNo": NumberWhereValueExpression,
"delayReason": DelayReasonFormQueryWhere,
"delayType": DelayTypeFormQueryWhere
}
DelayReasonPropertyEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"None"
DelayReasonPropertyEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - DelayReasonPropertyEnum
|
|
isNot - DelayReasonPropertyEnum
|
|
isIn - [DelayReasonPropertyEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
DelayReasonRelationships
Fields
| Field Name | Description |
|---|---|
delayReason - RelationshipDefinition
|
|
delayType - RelationshipDefinition
|
Example
{
"delayReason": RelationshipDefinition,
"delayType": RelationshipDefinition
}
DelayRelationships
Fields
| Field Name | Description |
|---|---|
tCOClaim - RelationshipDefinition
|
|
tCIClaim - RelationshipDefinition
|
|
delayReason - RelationshipDefinition
|
|
delayType - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
voyageItinerary - RelationshipDefinition
|
|
operationsInvoiceDetails - RelationshipDefinition
|
|
delayBunkers - RelationshipDefinition
|
Example
{
"tCOClaim": RelationshipDefinition,
"tCIClaim": RelationshipDefinition,
"delayReason": RelationshipDefinition,
"delayType": RelationshipDefinition,
"voyage": RelationshipDefinition,
"voyageItinerary": RelationshipDefinition,
"operationsInvoiceDetails": RelationshipDefinition,
"delayBunkers": RelationshipDefinition
}
DelayType
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
performanceCalculation - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
laytime - String
|
|
seqNo - Int
|
|
description - String
|
|
isTimeDoesNotCountForPerf - Boolean
|
|
isTimeDoesNotCountForLaytime - Boolean
|
|
isTimeCountsFiftyPercentForLaytime - Boolean
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
code - String
|
|
orderNo - Int
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"performanceCalculation": "abc123",
"customFieldByID": Any,
"customField": Any,
"laytime": "xyz789",
"seqNo": 123,
"description": "xyz789",
"isTimeDoesNotCountForPerf": false,
"isTimeDoesNotCountForLaytime": true,
"isTimeCountsFiftyPercentForLaytime": true,
"lastUser": "xyz789",
"lastUpdateGmt": "2007-12-03",
"code": "abc123",
"orderNo": 123,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
DelayTypeFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - DelayTypeFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": DelayTypeFormQueryWhere
}
DelayTypeFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [DelayTypeFormQueryWhere!]
|
|
or - [DelayTypeFormQueryWhere!]
|
|
rawExpression - String
|
|
seqNo - NumberWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
isTimeDoesNotCountForPerf - BoolWhereValueExpression
|
|
isTimeDoesNotCountForLaytime - BoolWhereValueExpression
|
|
isTimeCountsFiftyPercentForLaytime - BoolWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
code - StringWhereValueExpression
|
|
orderNo - NumberWhereValueExpression
|
Example
{
"and": [DelayTypeFormQueryWhere],
"or": [DelayTypeFormQueryWhere],
"rawExpression": "abc123",
"seqNo": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"isTimeDoesNotCountForPerf": BoolWhereValueExpression,
"isTimeDoesNotCountForLaytime": BoolWhereValueExpression,
"isTimeCountsFiftyPercentForLaytime": BoolWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"code": StringWhereValueExpression,
"orderNo": NumberWhereValueExpression
}
Delay_DelayBunkersInput
Delay_DelayTypeInput
Fields
| Input Field | Description |
|---|---|
description - String
|
Example
{"description": "xyz789"}
DeleteInvoiceInput
DeleteInvoiceMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "abc123",
"debug": false,
"context": ["abc123"],
"timestamp": "xyz789",
"originalTimestamp": "abc123",
"intent": "xyz789",
"from": "xyz789",
"to": ["xyz789"],
"fromUser": "abc123",
"status": "xyz789",
"approvalStatus": "abc123",
"objectId": "abc123",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "abc123",
"applyTriggeredBy": "abc123",
"previousData": Json,
"comment": "abc123",
"unmapped": true,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["abc123"],
"parentMessageId": "xyz789",
"preResolutionObjectId": "abc123",
"title": "abc123",
"effectiveDate": "abc123",
"source": "abc123",
"sourceId": "abc123",
"threadId": "xyz789",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": false,
"threadCount": 987,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
DeleteUserPref
DemurrageAllocationDetails
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
transNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seq - Int
|
|
cargoID - Int
|
|
commercialID - String
|
|
internalBU - String
|
|
rootCause - String
|
|
amount - Float
|
|
percent - Float
|
|
cargoQty - Float
|
|
portName - String
|
|
cargo - Cargo
|
|
port - Port
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"transNo": 123,
"customFieldByID": Any,
"customField": Any,
"seq": 123,
"cargoID": 123,
"commercialID": "abc123",
"internalBU": "xyz789",
"rootCause": "xyz789",
"amount": 987.65,
"percent": 987.65,
"cargoQty": 123.45,
"portName": "xyz789",
"cargo": Cargo,
"port": Port,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
DemurrageAllocationDetailsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - DemurrageAllocationDetailsFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": DemurrageAllocationDetailsFormQueryWhere
}
DemurrageAllocationDetailsFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [DemurrageAllocationDetailsFormQueryWhere!]
|
|
or - [DemurrageAllocationDetailsFormQueryWhere!]
|
|
rawExpression - String
|
|
transNo - NumberWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
cargoID - NumberWhereValueExpression
|
|
commercialID - StringWhereValueExpression
|
|
internalBU - StringWhereValueExpression
|
|
rootCause - StringWhereValueExpression
|
|
amount - NumberWhereValueExpression
|
|
percent - NumberWhereValueExpression
|
|
cargo - CargoFormQueryWhere
|
|
port - PortFormQueryWhere
|
Example
{
"and": [DemurrageAllocationDetailsFormQueryWhere],
"or": [DemurrageAllocationDetailsFormQueryWhere],
"rawExpression": "xyz789",
"transNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"commercialID": StringWhereValueExpression,
"internalBU": StringWhereValueExpression,
"rootCause": StringWhereValueExpression,
"amount": NumberWhereValueExpression,
"percent": NumberWhereValueExpression,
"cargo": CargoFormQueryWhere,
"port": PortFormQueryWhere
}
DemurrageAllocationDetailsRelationships
Fields
| Field Name | Description |
|---|---|
cargo - RelationshipDefinition
|
|
laytime - RelationshipDefinition
|
|
laytimePort - RelationshipDefinition
|
|
port - RelationshipDefinition
|
Example
{
"cargo": RelationshipDefinition,
"laytime": RelationshipDefinition,
"laytimePort": RelationshipDefinition,
"port": RelationshipDefinition
}
DemurrageTaskLinkedLaytimeRelationships
Fields
| Field Name | Description |
|---|---|
task - RelationshipDefinition
|
|
laytime - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
claim - RelationshipDefinition
|
Example
{
"task": RelationshipDefinition,
"laytime": RelationshipDefinition,
"voyage": RelationshipDefinition,
"claim": RelationshipDefinition
}
Department
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
departmentID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
name - String
|
|
createDateTimeGmt - Date
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"departmentID": 987,
"customFieldByID": Any,
"customField": Any,
"name": "abc123",
"createDateTimeGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
DepartmentFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - DepartmentFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": DepartmentFormQueryWhere
}
DepartmentFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [DepartmentFormQueryWhere!]
|
|
or - [DepartmentFormQueryWhere!]
|
|
rawExpression - String
|
|
departmentID - NumberWhereValueExpression
|
|
name - StringWhereValueExpression
|
|
createDateTimeGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
Example
{
"and": [DepartmentFormQueryWhere],
"or": [DepartmentFormQueryWhere],
"rawExpression": "xyz789",
"departmentID": NumberWhereValueExpression,
"name": StringWhereValueExpression,
"createDateTimeGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression
}
EditLaytimeClaimInput
Fields
| Input Field | Description |
|---|---|
claimId - Float
|
ClaimId |
isReversible - Boolean
|
IsReversible |
onceOnAlwaysOn - Boolean
|
OnceOnAlwaysOn |
isContinuousLaytime - Boolean
|
IsContinuousLaytime |
showDemurrageStart - Boolean
|
ShowDemurrageStart |
isOnAccount - Boolean
|
IsOnAccount |
includeInPnl - Boolean
|
IncludeInPnl |
noRebill - Boolean
|
NoRebill |
status - String
|
Status |
subStatus - String
|
SubStatus |
diffReason - String
|
DiffReason |
calcRemarks - String
|
CalcRemarks |
analyst - String
|
Analyst |
invoiceNo - String
|
InvoiceNo |
invoiceStatus - String
|
InvoiceStatus |
currency - String
|
Currency |
originalAmountCurr - Float
|
OriginalAmountCurr |
agreedAmountCurr - Float
|
AgreedAmountCurr |
ratePerDay - Float
|
RatePerDay |
lastAction - String
|
LastAction |
lastActionDate - Date
|
LastActionDate |
claimDate - Date
|
ClaimDate |
openedDate - Date
|
OpenedDate |
timeBarDate - Date
|
TimeBarDate |
settledDate - Date
|
SettledDate |
externalRef - String
|
ExternalRef |
type - String
|
Type |
subType - String
|
SubType |
importFromFile - Boolean
|
ImportFromFile |
skipActDedValidation - Boolean
|
SkipActDedValidation |
itineraries - [EditLaytimeClaim_ItinerariesInput]
|
|
portActivities - [EditLaytimeClaim_PortActivitiesInput]
|
|
deductions - [EditLaytimeClaim_DeductionsInput]
|
Example
{
"claimId": 123.45,
"isReversible": false,
"onceOnAlwaysOn": true,
"isContinuousLaytime": true,
"showDemurrageStart": true,
"isOnAccount": true,
"includeInPnl": false,
"noRebill": false,
"status": "xyz789",
"subStatus": "xyz789",
"diffReason": "xyz789",
"calcRemarks": "abc123",
"analyst": "abc123",
"invoiceNo": "abc123",
"invoiceStatus": "xyz789",
"currency": "xyz789",
"originalAmountCurr": 123.45,
"agreedAmountCurr": 123.45,
"ratePerDay": 987.65,
"lastAction": "xyz789",
"lastActionDate": "2007-12-03",
"claimDate": "2007-12-03",
"openedDate": "2007-12-03",
"timeBarDate": "2007-12-03",
"settledDate": "2007-12-03",
"externalRef": "xyz789",
"type": "xyz789",
"subType": "abc123",
"importFromFile": false,
"skipActDedValidation": false,
"itineraries": [EditLaytimeClaim_ItinerariesInput],
"portActivities": [
EditLaytimeClaim_PortActivitiesInput
],
"deductions": [EditLaytimeClaim_DeductionsInput]
}
EditLaytimeClaimMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": false,
"context": ["xyz789"],
"timestamp": "xyz789",
"originalTimestamp": "xyz789",
"intent": "abc123",
"from": "abc123",
"to": ["xyz789"],
"fromUser": "abc123",
"status": "xyz789",
"approvalStatus": "xyz789",
"objectId": "abc123",
"type": "xyz789",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "abc123",
"unmapped": false,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["abc123"],
"parentMessageId": "xyz789",
"preResolutionObjectId": "abc123",
"title": "xyz789",
"effectiveDate": "abc123",
"source": "xyz789",
"sourceId": "xyz789",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": true,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "xyz789"
}
EditLaytimeClaim_DeductionsInput
Example
{
"itinSeq": 987.65,
"portSeqNo": 123.45,
"laytimeSeq": 123.45,
"fromDateLocal": "2007-12-03",
"toDateLocal": "2007-12-03",
"remarks": "abc123",
"duration": "abc123",
"percent": 123.45,
"dedName": "abc123"
}
EditLaytimeClaim_ItinerariesInput
Fields
| Input Field | Description |
|---|---|
itinSeq - Float
|
ItinSeq |
portSeqNo - Float
|
PortSeqNo |
cargoID - Float
|
CargoID |
portcarSeq - Float
|
PortcarSeq |
demRate - Float
|
DemRate |
desRate - Float
|
DesRate |
allowed - String
|
Allowed |
used - String
|
Used |
quantity - Float
|
Quantity |
loadDiscRate - Float
|
LoadDiscRate |
terms - String
|
Terms |
Example
{
"itinSeq": 987.65,
"portSeqNo": 987.65,
"cargoID": 123.45,
"portcarSeq": 987.65,
"demRate": 123.45,
"desRate": 123.45,
"allowed": "xyz789",
"used": "xyz789",
"quantity": 123.45,
"loadDiscRate": 987.65,
"terms": "abc123"
}
EditLaytimeClaim_PortActivitiesInput
Example
{
"itinSeq": 987.65,
"portSeqNo": 987.65,
"laytimeSeq": 123.45,
"startLocal": "2007-12-03",
"remarks": "xyz789",
"actName": "xyz789",
"activityType": "abc123",
"berthShortName": "xyz789"
}
EditedMessageInput
EquipmentContractHistory
Fields
| Field Name | Description |
|---|---|
contractID - String
|
|
contractType - String
|
|
equipmentName - String
|
|
equipmentType - String
|
|
deliveredGmt - Date
|
|
redeliveredGmt - Date
|
|
joinedGmt - Date
|
|
departedGmt - Date
|
|
gap - String
|
|
towName - String
|
|
voyageNo - Int
|
|
commenceDateGmt - Date
|
|
completeDateGmt - Date
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"contractID": "xyz789",
"contractType": "abc123",
"equipmentName": "abc123",
"equipmentType": "abc123",
"deliveredGmt": "2007-12-03",
"redeliveredGmt": "2007-12-03",
"joinedGmt": "2007-12-03",
"departedGmt": "2007-12-03",
"gap": "xyz789",
"towName": "abc123",
"voyageNo": 123,
"commenceDateGmt": "2007-12-03",
"completeDateGmt": "2007-12-03",
"_id": "xyz789",
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
EstimateCargoBroker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
estimateID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
status - String
|
|
seqNo - Int
|
|
brokerShortName - String
|
|
commission - Float
|
|
lastUser - String
|
|
brokerType - String
|
|
commissionType - String
|
|
commissionOrRebate - String
|
|
cargoSeq - Int
|
|
isOwnerBroker - Boolean
|
|
isPartialCommissionsEnabled - Boolean
|
|
isBillVia - Boolean
|
|
freightInvoiceSetting - String
|
|
demurrageSetting - String
|
|
estimateCargoes - EstimateCargoes
|
|
addressBook - AddressBook
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"estimateID": "xyz789",
"customFieldByID": Any,
"customField": Any,
"status": "xyz789",
"seqNo": 123,
"brokerShortName": "xyz789",
"commission": 123.45,
"lastUser": "abc123",
"brokerType": "xyz789",
"commissionType": "xyz789",
"commissionOrRebate": "xyz789",
"cargoSeq": 987,
"isOwnerBroker": true,
"isPartialCommissionsEnabled": true,
"isBillVia": true,
"freightInvoiceSetting": "xyz789",
"demurrageSetting": "abc123",
"estimateCargoes": EstimateCargoes,
"addressBook": AddressBook,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
EstimateCargoBrokerCommissionOrRebateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
EstimateCargoBrokerCommissionOrRebateEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - EstimateCargoBrokerCommissionOrRebateEnum
|
|
isNot - EstimateCargoBrokerCommissionOrRebateEnum
|
|
isIn - [EstimateCargoBrokerCommissionOrRebateEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
EstimateCargoBrokerCommissionTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
EstimateCargoBrokerCommissionTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - EstimateCargoBrokerCommissionTypeEnum
|
|
isNot - EstimateCargoBrokerCommissionTypeEnum
|
|
isIn - [EstimateCargoBrokerCommissionTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
EstimateCargoBrokerDemurrageSettingEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
EstimateCargoBrokerDemurrageSettingEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - EstimateCargoBrokerDemurrageSettingEnum
|
|
isNot - EstimateCargoBrokerDemurrageSettingEnum
|
|
isIn - [EstimateCargoBrokerDemurrageSettingEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
EstimateCargoBrokerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - EstimateCargoBrokerFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": EstimateCargoBrokerFormQueryWhere
}
EstimateCargoBrokerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [EstimateCargoBrokerFormQueryWhere!]
|
|
or - [EstimateCargoBrokerFormQueryWhere!]
|
|
rawExpression - String
|
|
estimateID - StringWhereValueExpression
|
|
status - StringWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
brokerShortName - StringWhereValueExpression
|
|
commission - NumberWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
brokerType - StringWhereValueExpression
|
|
commissionType - EstimateCargoBrokerCommissionTypeEnumValueExpression
|
|
commissionOrRebate - EstimateCargoBrokerCommissionOrRebateEnumValueExpression
|
|
cargoSeq - NumberWhereValueExpression
|
|
isOwnerBroker - BoolWhereValueExpression
|
|
isPartialCommissionsEnabled - BoolWhereValueExpression
|
|
isBillVia - BoolWhereValueExpression
|
|
freightInvoiceSetting - EstimateCargoBrokerFreightInvoiceSettingEnumValueExpression
|
|
demurrageSetting - EstimateCargoBrokerDemurrageSettingEnumValueExpression
|
|
estimateCargoes - EstimateCargoesFormQueryWhere
|
|
addressBook - AddressBookFormQueryWhere
|
Example
{
"and": [EstimateCargoBrokerFormQueryWhere],
"or": [EstimateCargoBrokerFormQueryWhere],
"rawExpression": "xyz789",
"estimateID": StringWhereValueExpression,
"status": StringWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"brokerShortName": StringWhereValueExpression,
"commission": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"brokerType": StringWhereValueExpression,
"commissionType": EstimateCargoBrokerCommissionTypeEnumValueExpression,
"commissionOrRebate": EstimateCargoBrokerCommissionOrRebateEnumValueExpression,
"cargoSeq": NumberWhereValueExpression,
"isOwnerBroker": BoolWhereValueExpression,
"isPartialCommissionsEnabled": BoolWhereValueExpression,
"isBillVia": BoolWhereValueExpression,
"freightInvoiceSetting": EstimateCargoBrokerFreightInvoiceSettingEnumValueExpression,
"demurrageSetting": EstimateCargoBrokerDemurrageSettingEnumValueExpression,
"estimateCargoes": EstimateCargoesFormQueryWhere,
"addressBook": AddressBookFormQueryWhere
}
EstimateCargoBrokerFreightInvoiceSettingEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
EstimateCargoBrokerFreightInvoiceSettingEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - EstimateCargoBrokerFreightInvoiceSettingEnum
|
|
isNot - EstimateCargoBrokerFreightInvoiceSettingEnum
|
|
isIn - [EstimateCargoBrokerFreightInvoiceSettingEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
EstimateCargoBrokerRelationships
Fields
| Field Name | Description |
|---|---|
estimateCargoes - RelationshipDefinition
|
|
addressBook - RelationshipDefinition
|
Example
{
"estimateCargoes": RelationshipDefinition,
"addressBook": RelationshipDefinition
}
EstimateCargoBunkerConsumption
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
status - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
estimateID - String
|
|
cargoSeq - Int
|
|
fuelType - String
|
|
heatingRate - Float
|
|
heatingDays - Float
|
|
isHeatingRateManual - Boolean
|
|
isHeatingDaysManual - Boolean
|
|
coolingRate - Float
|
|
coolingDays - Float
|
|
isCoolingRateManual - Boolean
|
|
isCoolingDaysManual - Boolean
|
|
iGSRate - Float
|
|
iGSDays - Float
|
|
isIGSRateManual - Boolean
|
|
isIGSDaysManual - Boolean
|
|
cleaningRate - Float
|
|
cleaningDays - Float
|
|
isCleaningRateManual - Boolean
|
|
isCleaningDaysManual - Boolean
|
|
estimateCargoes - EstimateCargoes
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"status": "xyz789",
"customFieldByID": Any,
"customField": Any,
"estimateID": "xyz789",
"cargoSeq": 987,
"fuelType": "abc123",
"heatingRate": 123.45,
"heatingDays": 123.45,
"isHeatingRateManual": false,
"isHeatingDaysManual": false,
"coolingRate": 123.45,
"coolingDays": 987.65,
"isCoolingRateManual": false,
"isCoolingDaysManual": false,
"iGSRate": 123.45,
"iGSDays": 123.45,
"isIGSRateManual": true,
"isIGSDaysManual": true,
"cleaningRate": 987.65,
"cleaningDays": 987.65,
"isCleaningRateManual": false,
"isCleaningDaysManual": false,
"estimateCargoes": EstimateCargoes,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
EstimateCargoBunkerConsumptionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - EstimateCargoBunkerConsumptionFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": EstimateCargoBunkerConsumptionFormQueryWhere
}
EstimateCargoBunkerConsumptionFormQueryWhere
Fields
Example
{
"and": [EstimateCargoBunkerConsumptionFormQueryWhere],
"or": [EstimateCargoBunkerConsumptionFormQueryWhere],
"rawExpression": "xyz789",
"status": StringWhereValueExpression,
"estimateID": StringWhereValueExpression,
"cargoSeq": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"heatingRate": NumberWhereValueExpression,
"heatingDays": NumberWhereValueExpression,
"isHeatingRateManual": BoolWhereValueExpression,
"isHeatingDaysManual": BoolWhereValueExpression,
"coolingRate": NumberWhereValueExpression,
"coolingDays": NumberWhereValueExpression,
"isCoolingRateManual": BoolWhereValueExpression,
"isCoolingDaysManual": BoolWhereValueExpression,
"iGSRate": NumberWhereValueExpression,
"iGSDays": NumberWhereValueExpression,
"isIGSRateManual": BoolWhereValueExpression,
"isIGSDaysManual": BoolWhereValueExpression,
"cleaningRate": NumberWhereValueExpression,
"cleaningDays": NumberWhereValueExpression,
"isCleaningRateManual": BoolWhereValueExpression,
"isCleaningDaysManual": BoolWhereValueExpression,
"estimateCargoes": EstimateCargoesFormQueryWhere
}
EstimateCargoBunkerConsumptionRelationships
Fields
| Field Name | Description |
|---|---|
estimateCargoes - RelationshipDefinition
|
Example
{"estimateCargoes": RelationshipDefinition}
EstimateCargoExtraFreightTerms
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
cargoSeq - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
estimateID - String
|
|
code - String
|
|
reletFlag - Int
|
|
amount - Float
|
|
lastUpdateGmt - Date
|
|
description - String
|
|
lastUser - String
|
|
cargoSeqInternal - Int
|
|
priceMatrixSeq - Int
|
|
scaleTableShortName - String
|
|
scaleTableQtyBasis - String
|
|
freightTerm - FreightTerm
|
|
voyageEstimate - VoyageEstimate
|
|
estimateCargo - EstimateCargoes
|
|
scaleTable - [StandardRate]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"cargoSeq": 123,
"customFieldByID": Any,
"customField": Any,
"estimateID": "xyz789",
"code": "xyz789",
"reletFlag": 987,
"amount": 123.45,
"lastUpdateGmt": "2007-12-03",
"description": "xyz789",
"lastUser": "xyz789",
"cargoSeqInternal": 123,
"priceMatrixSeq": 123,
"scaleTableShortName": "xyz789",
"scaleTableQtyBasis": "abc123",
"freightTerm": FreightTerm,
"voyageEstimate": VoyageEstimate,
"estimateCargo": EstimateCargoes,
"scaleTable": [StandardRate],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
EstimateCargoExtraFreightTermsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - EstimateCargoExtraFreightTermsFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": EstimateCargoExtraFreightTermsFormQueryWhere
}
EstimateCargoExtraFreightTermsFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [EstimateCargoExtraFreightTermsFormQueryWhere!]
|
|
or - [EstimateCargoExtraFreightTermsFormQueryWhere!]
|
|
rawExpression - String
|
|
estimateID - StringWhereValueExpression
|
|
code - StringWhereValueExpression
|
|
reletFlag - NumberWhereValueExpression
|
|
amount - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
cargoSeqInternal - NumberWhereValueExpression
|
|
priceMatrixSeq - NumberWhereValueExpression
|
|
scaleTableShortName - StringWhereValueExpression
|
|
scaleTableQtyBasis - EstimateCargoExtraFreightTermsScaleTableQtyBasisEnumValueExpression
|
|
freightTerm - FreightTermFormQueryWhere
|
|
voyageEstimate - VoyageEstimateFormQueryWhere
|
|
estimateCargo - EstimateCargoesFormQueryWhere
|
Example
{
"and": [EstimateCargoExtraFreightTermsFormQueryWhere],
"or": [EstimateCargoExtraFreightTermsFormQueryWhere],
"rawExpression": "abc123",
"estimateID": StringWhereValueExpression,
"code": StringWhereValueExpression,
"reletFlag": NumberWhereValueExpression,
"amount": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"description": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"cargoSeqInternal": NumberWhereValueExpression,
"priceMatrixSeq": NumberWhereValueExpression,
"scaleTableShortName": StringWhereValueExpression,
"scaleTableQtyBasis": EstimateCargoExtraFreightTermsScaleTableQtyBasisEnumValueExpression,
"freightTerm": FreightTermFormQueryWhere,
"voyageEstimate": VoyageEstimateFormQueryWhere,
"estimateCargo": EstimateCargoesFormQueryWhere
}
EstimateCargoExtraFreightTermsRelationships
Fields
| Field Name | Description |
|---|---|
freightTerm - RelationshipDefinition
|
|
voyageEstimate - RelationshipDefinition
|
|
estimateCargo - RelationshipDefinition
|
|
scaleTable - RelationshipDefinition
|
Example
{
"freightTerm": RelationshipDefinition,
"voyageEstimate": RelationshipDefinition,
"estimateCargo": RelationshipDefinition,
"scaleTable": RelationshipDefinition
}
EstimateCargoExtraFreightTermsScaleTableQtyBasisEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CPQty"
EstimateCargoExtraFreightTermsScaleTableQtyBasisEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - EstimateCargoExtraFreightTermsScaleTableQtyBasisEnum
|
|
isNot - EstimateCargoExtraFreightTermsScaleTableQtyBasisEnum
|
|
isIn - [EstimateCargoExtraFreightTermsScaleTableQtyBasisEnum]
|
Example
{"is": "CPQty", "isNot": "CPQty", "isIn": ["CPQty"]}
EstimateCargoes
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
firstLoadPortNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
lastDischargePortNo - Int
|
|
freightValue - Float
|
|
lumpsumValue - Float
|
|
wSCFlat - Float
|
|
wSCPct - Float
|
|
laycanFromGmt - Date
|
|
laycanToGmt - Date
|
|
estimateID - String
|
|
status - String
|
|
cargoShortName - String
|
|
chartererShortName - String
|
|
cpQty - Int
|
|
freightRateBase - Float
|
|
cargoUnit - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
optionType - String
|
|
optionPercentage - Float
|
|
cargoID - Int
|
|
isDemurrageHourly - Boolean
|
|
isNorOffset - Boolean
|
|
needsDeviationCargoSync - Boolean
|
|
isBunkerOptimizationCargo - Boolean
|
|
freightType - String
|
|
worldScaleRate - Float
|
|
worldScaleLevel - Float
|
|
lumpsumBase - Float
|
|
freightTaxBase - Float
|
|
curr - String
|
|
exchangeRate - Float
|
|
minQty - Int
|
|
maxQty - Int
|
|
cpDate - Date
|
|
cpForm - String
|
|
demurrageCurrency - String
|
|
loadDemurrageRateCurr - Float
|
|
loadDemurrageRate - Float
|
|
dischargeDemurrageRate - Float
|
|
loadDespatchRate - Float
|
|
dischargeDespatchRate - Float
|
|
demurrageExchangeRate - Float
|
|
cargoSeq - Int
|
|
laytimeAllowed - Float
|
|
laytimeAllowedUnitCode - String
|
|
laytimeAllowedTerms - String
|
|
laytimeAllowedFactor - Float
|
|
templateName - String
|
|
cargoAssigned - Int
|
|
coaNo - String
|
|
saleContractID - Int
|
|
purchaseContractID - Int
|
|
supplierShortName - String
|
|
receiverShortName - String
|
|
companyCode - String
|
|
lobCode - String
|
|
vatNo - String
|
|
chtrCoordinator - String
|
|
bookingNo - String
|
|
bunkerScaleTable - String
|
|
demScaleTable - String
|
|
laytimeScaleTable - String
|
|
freightRateTable - String
|
|
demPct - Float
|
|
draft - Float
|
|
tradeAreaNo - Int
|
|
vesselType - String
|
|
oblNo - String
|
|
coMingleNo - String
|
|
commercialScheduler - String
|
|
timeBarDays - Float
|
|
balancePaymentTermsCode - String
|
|
nominatedQty - Float
|
|
invoicedQty - Float
|
|
isHeatingConsumptionEnabled - Boolean
|
|
isHeatingPlusConsumptionEnabled - Boolean
|
|
isHeatingPlusPlusConsumptionEnabled - Boolean
|
|
isCoolingConsumptionEnabled - Boolean
|
|
isStandardIGSConsumptionEnabled - Boolean
|
|
isAutoLoadCleaningConsumptionEnabled - Boolean
|
|
isAutoDischargeCleaningConsumptionEnabled - Boolean
|
|
isManualCleaningConsumptionEnabled - Boolean
|
|
isAutoDischargeIGSConsumptionEnabled - Boolean
|
|
agreedTemperature - Float
|
|
agreedTemperatureUnit - String
|
|
contractType - String
|
|
primaryCargoSeq - Int
|
|
counterpartyType - String
|
|
advancedPricingOverriddenResults - Int
|
|
emissionsSettlementType - String
|
|
emissionsBillingPeriod - String
|
|
emissionsPaymentTermsCode - String
|
|
docHolderName - String
|
|
docHolderType - String
|
|
fuelEUCalcDefault - String
|
|
cargo - Cargo
|
|
addressBook - AddressBook
|
|
cargoName - CargoName
|
|
voyageEstimate - VoyageEstimate
|
|
estimateCargoBunkerConsumptions - [EstimateCargoBunkerConsumption]
|
|
estimateCargoBrokers - [EstimateCargoBroker]
|
|
loadCargoItineraries - [EstimateItinerary]
|
|
discCargoItineraries - [EstimateItinerary]
|
|
estimateCargoExtraFreightTerms - [EstimateCargoExtraFreightTerms]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"firstLoadPortNo": 123,
"customFieldByID": Any,
"customField": Any,
"lastDischargePortNo": 123,
"freightValue": 123.45,
"lumpsumValue": 987.65,
"wSCFlat": 123.45,
"wSCPct": 123.45,
"laycanFromGmt": "2007-12-03",
"laycanToGmt": "2007-12-03",
"estimateID": "xyz789",
"status": "xyz789",
"cargoShortName": "xyz789",
"chartererShortName": "xyz789",
"cpQty": 987,
"freightRateBase": 987.65,
"cargoUnit": "xyz789",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"optionType": "abc123",
"optionPercentage": 987.65,
"cargoID": 123,
"isDemurrageHourly": false,
"isNorOffset": false,
"needsDeviationCargoSync": true,
"isBunkerOptimizationCargo": false,
"freightType": "xyz789",
"worldScaleRate": 123.45,
"worldScaleLevel": 123.45,
"lumpsumBase": 987.65,
"freightTaxBase": 123.45,
"curr": "abc123",
"exchangeRate": 123.45,
"minQty": 987,
"maxQty": 987,
"cpDate": "2007-12-03",
"cpForm": "abc123",
"demurrageCurrency": "abc123",
"loadDemurrageRateCurr": 123.45,
"loadDemurrageRate": 987.65,
"dischargeDemurrageRate": 987.65,
"loadDespatchRate": 123.45,
"dischargeDespatchRate": 123.45,
"demurrageExchangeRate": 987.65,
"cargoSeq": 123,
"laytimeAllowed": 987.65,
"laytimeAllowedUnitCode": "abc123",
"laytimeAllowedTerms": "xyz789",
"laytimeAllowedFactor": 987.65,
"templateName": "abc123",
"cargoAssigned": 987,
"coaNo": "abc123",
"saleContractID": 123,
"purchaseContractID": 987,
"supplierShortName": "xyz789",
"receiverShortName": "xyz789",
"companyCode": "abc123",
"lobCode": "abc123",
"vatNo": "abc123",
"chtrCoordinator": "abc123",
"bookingNo": "abc123",
"bunkerScaleTable": "xyz789",
"demScaleTable": "xyz789",
"laytimeScaleTable": "abc123",
"freightRateTable": "xyz789",
"demPct": 987.65,
"draft": 123.45,
"tradeAreaNo": 123,
"vesselType": "abc123",
"oblNo": "xyz789",
"coMingleNo": "xyz789",
"commercialScheduler": "xyz789",
"timeBarDays": 123.45,
"balancePaymentTermsCode": "abc123",
"nominatedQty": 123.45,
"invoicedQty": 987.65,
"isHeatingConsumptionEnabled": false,
"isHeatingPlusConsumptionEnabled": false,
"isHeatingPlusPlusConsumptionEnabled": true,
"isCoolingConsumptionEnabled": true,
"isStandardIGSConsumptionEnabled": true,
"isAutoLoadCleaningConsumptionEnabled": true,
"isAutoDischargeCleaningConsumptionEnabled": false,
"isManualCleaningConsumptionEnabled": false,
"isAutoDischargeIGSConsumptionEnabled": false,
"agreedTemperature": 123.45,
"agreedTemperatureUnit": "abc123",
"contractType": "xyz789",
"primaryCargoSeq": 987,
"counterpartyType": "xyz789",
"advancedPricingOverriddenResults": 987,
"emissionsSettlementType": "abc123",
"emissionsBillingPeriod": "xyz789",
"emissionsPaymentTermsCode": "abc123",
"docHolderName": "abc123",
"docHolderType": "xyz789",
"fuelEUCalcDefault": "abc123",
"cargo": Cargo,
"addressBook": AddressBook,
"cargoName": CargoName,
"voyageEstimate": VoyageEstimate,
"estimateCargoBunkerConsumptions": [
EstimateCargoBunkerConsumption
],
"estimateCargoBrokers": [EstimateCargoBroker],
"loadCargoItineraries": [EstimateItinerary],
"discCargoItineraries": [EstimateItinerary],
"estimateCargoExtraFreightTerms": [
EstimateCargoExtraFreightTerms
],
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
EstimateCargoesEmissionsBillingPeriodEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
EstimateCargoesEmissionsBillingPeriodEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - EstimateCargoesEmissionsBillingPeriodEnum
|
|
isNot - EstimateCargoesEmissionsBillingPeriodEnum
|
|
isIn - [EstimateCargoesEmissionsBillingPeriodEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
EstimateCargoesEmissionsSettlementTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NA"
EstimateCargoesEmissionsSettlementTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - EstimateCargoesEmissionsSettlementTypeEnum
|
|
isNot - EstimateCargoesEmissionsSettlementTypeEnum
|
|
isIn - [EstimateCargoesEmissionsSettlementTypeEnum]
|
Example
{"is": "NA", "isNot": "NA", "isIn": ["NA"]}
EstimateCargoesFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - EstimateCargoesFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": EstimateCargoesFormQueryWhere
}
EstimateCargoesFormQueryWhere
Fields
Example
{
"and": [EstimateCargoesFormQueryWhere],
"or": [EstimateCargoesFormQueryWhere],
"rawExpression": "xyz789",
"estimateID": StringWhereValueExpression,
"status": StringWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"chartererShortName": StringWhereValueExpression,
"cpQty": NumberWhereValueExpression,
"freightRateBase": NumberWhereValueExpression,
"cargoUnit": StringWhereValueExpression,
"laycanFromLocal": DateWhereValueExpression,
"laycanToLocal": DateWhereValueExpression,
"optionType": EstimateCargoesOptionTypeEnumValueExpression,
"optionPercentage": NumberWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"isDemurrageHourly": BoolWhereValueExpression,
"isNorOffset": BoolWhereValueExpression,
"needsDeviationCargoSync": BoolWhereValueExpression,
"isBunkerOptimizationCargo": BoolWhereValueExpression,
"freightType": StringWhereValueExpression,
"worldScaleRate": NumberWhereValueExpression,
"worldScaleLevel": NumberWhereValueExpression,
"lumpsumBase": NumberWhereValueExpression,
"freightTaxBase": NumberWhereValueExpression,
"curr": StringWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"minQty": NumberWhereValueExpression,
"maxQty": NumberWhereValueExpression,
"cpDate": DateWhereValueExpression,
"cpForm": StringWhereValueExpression,
"demurrageCurrency": StringWhereValueExpression,
"loadDemurrageRateCurr": NumberWhereValueExpression,
"loadDemurrageRate": NumberWhereValueExpression,
"dischargeDemurrageRate": NumberWhereValueExpression,
"loadDespatchRate": NumberWhereValueExpression,
"dischargeDespatchRate": NumberWhereValueExpression,
"demurrageExchangeRate": NumberWhereValueExpression,
"cargoSeq": NumberWhereValueExpression,
"laytimeAllowed": NumberWhereValueExpression,
"laytimeAllowedUnitCode": StringWhereValueExpression,
"laytimeAllowedTerms": StringWhereValueExpression,
"laytimeAllowedFactor": NumberWhereValueExpression,
"templateName": StringWhereValueExpression,
"cargoAssigned": NumberWhereValueExpression,
"coaNo": StringWhereValueExpression,
"saleContractID": NumberWhereValueExpression,
"purchaseContractID": NumberWhereValueExpression,
"supplierShortName": StringWhereValueExpression,
"receiverShortName": StringWhereValueExpression,
"companyCode": StringWhereValueExpression,
"lobCode": StringWhereValueExpression,
"vatNo": StringWhereValueExpression,
"chtrCoordinator": StringWhereValueExpression,
"bookingNo": StringWhereValueExpression,
"bunkerScaleTable": StringWhereValueExpression,
"demScaleTable": StringWhereValueExpression,
"laytimeScaleTable": StringWhereValueExpression,
"freightRateTable": StringWhereValueExpression,
"demPct": NumberWhereValueExpression,
"draft": NumberWhereValueExpression,
"tradeAreaNo": NumberWhereValueExpression,
"vesselType": StringWhereValueExpression,
"oblNo": StringWhereValueExpression,
"coMingleNo": StringWhereValueExpression,
"commercialScheduler": StringWhereValueExpression,
"timeBarDays": NumberWhereValueExpression,
"balancePaymentTermsCode": StringWhereValueExpression,
"nominatedQty": NumberWhereValueExpression,
"invoicedQty": NumberWhereValueExpression,
"isHeatingConsumptionEnabled": BoolWhereValueExpression,
"isHeatingPlusConsumptionEnabled": BoolWhereValueExpression,
"isHeatingPlusPlusConsumptionEnabled": BoolWhereValueExpression,
"isCoolingConsumptionEnabled": BoolWhereValueExpression,
"isStandardIGSConsumptionEnabled": BoolWhereValueExpression,
"isAutoLoadCleaningConsumptionEnabled": BoolWhereValueExpression,
"isAutoDischargeCleaningConsumptionEnabled": BoolWhereValueExpression,
"isManualCleaningConsumptionEnabled": BoolWhereValueExpression,
"isAutoDischargeIGSConsumptionEnabled": BoolWhereValueExpression,
"agreedTemperature": NumberWhereValueExpression,
"agreedTemperatureUnit": StringWhereValueExpression,
"contractType": StringWhereValueExpression,
"primaryCargoSeq": NumberWhereValueExpression,
"counterpartyType": StringWhereValueExpression,
"advancedPricingOverriddenResults": NumberWhereValueExpression,
"emissionsSettlementType": EstimateCargoesEmissionsSettlementTypeEnumValueExpression,
"emissionsBillingPeriod": EstimateCargoesEmissionsBillingPeriodEnumValueExpression,
"emissionsPaymentTermsCode": StringWhereValueExpression,
"docHolderName": StringWhereValueExpression,
"docHolderType": StringWhereValueExpression,
"fuelEUCalcDefault": EstimateCargoesFuelEUCalcDefaultEnumValueExpression,
"cargo": CargoFormQueryWhere,
"addressBook": AddressBookFormQueryWhere,
"cargoName": CargoNameFormQueryWhere,
"voyageEstimate": VoyageEstimateFormQueryWhere
}
EstimateCargoesFuelEUCalcDefaultEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NA"
EstimateCargoesFuelEUCalcDefaultEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - EstimateCargoesFuelEUCalcDefaultEnum
|
|
isNot - EstimateCargoesFuelEUCalcDefaultEnum
|
|
isIn - [EstimateCargoesFuelEUCalcDefaultEnum]
|
Example
{"is": "NA", "isNot": "NA", "isIn": ["NA"]}
EstimateCargoesOptionTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NOOPT"
EstimateCargoesOptionTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - EstimateCargoesOptionTypeEnum
|
|
isNot - EstimateCargoesOptionTypeEnum
|
|
isIn - [EstimateCargoesOptionTypeEnum]
|
Example
{"is": "NOOPT", "isNot": "NOOPT", "isIn": ["NOOPT"]}
EstimateCargoesRelationships
Fields
| Field Name | Description |
|---|---|
cargo - RelationshipDefinition
|
|
addressBook - RelationshipDefinition
|
|
cargoName - RelationshipDefinition
|
|
voyageEstimate - RelationshipDefinition
|
|
firstLoadCargoItinerary - RelationshipDefinition
|
|
lastDiscCargoItinerary - RelationshipDefinition
|
|
firstLoadCargoItineraryPort - RelationshipDefinition
|
|
lastDiscCargoItineraryPort - RelationshipDefinition
|
|
estimateCargoBunkerConsumptions - RelationshipDefinition
|
|
estimateCargoBrokers - RelationshipDefinition
|
|
loadCargoItineraries - RelationshipDefinition
|
|
discCargoItineraries - RelationshipDefinition
|
|
estimateCargoExtraFreightTerms - RelationshipDefinition
|
Example
{
"cargo": RelationshipDefinition,
"addressBook": RelationshipDefinition,
"cargoName": RelationshipDefinition,
"voyageEstimate": RelationshipDefinition,
"firstLoadCargoItinerary": RelationshipDefinition,
"lastDiscCargoItinerary": RelationshipDefinition,
"firstLoadCargoItineraryPort": RelationshipDefinition,
"lastDiscCargoItineraryPort": RelationshipDefinition,
"estimateCargoBunkerConsumptions": RelationshipDefinition,
"estimateCargoBrokers": RelationshipDefinition,
"loadCargoItineraries": RelationshipDefinition,
"discCargoItineraries": RelationshipDefinition,
"estimateCargoExtraFreightTerms": RelationshipDefinition
}
EstimateDelay
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
estimateID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
delaySeq - Int
|
|
delayStartGmt - Date
|
|
delayStartGmtOffset - Float
|
|
delayEndGmt - Date
|
|
delayEndGmtOffset - Float
|
|
hours - Float
|
|
activity - String
|
|
reason - String
|
|
includeInEstPnl - Boolean
|
|
importedFromVoyage - Boolean
|
|
voyageEstimate - VoyageEstimate
|
|
delayType - DelayType
|
|
delayReason - DelayReason
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"estimateID": "xyz789",
"customFieldByID": Any,
"customField": Any,
"delaySeq": 123,
"delayStartGmt": "2007-12-03",
"delayStartGmtOffset": 987.65,
"delayEndGmt": "2007-12-03",
"delayEndGmtOffset": 123.45,
"hours": 123.45,
"activity": "abc123",
"reason": "xyz789",
"includeInEstPnl": false,
"importedFromVoyage": true,
"voyageEstimate": VoyageEstimate,
"delayType": DelayType,
"delayReason": DelayReason,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
EstimateDelayFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - EstimateDelayFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": EstimateDelayFormQueryWhere
}
EstimateDelayFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [EstimateDelayFormQueryWhere!]
|
|
or - [EstimateDelayFormQueryWhere!]
|
|
rawExpression - String
|
|
estimateID - StringWhereValueExpression
|
|
delaySeq - NumberWhereValueExpression
|
|
delayStartGmt - DateWhereValueExpression
|
|
delayStartGmtOffset - NumberWhereValueExpression
|
|
delayEndGmt - DateWhereValueExpression
|
|
delayEndGmtOffset - NumberWhereValueExpression
|
|
hours - NumberWhereValueExpression
|
|
activity - StringWhereValueExpression
|
|
reason - StringWhereValueExpression
|
|
includeInEstPnl - BoolWhereValueExpression
|
|
importedFromVoyage - BoolWhereValueExpression
|
|
voyageEstimate - VoyageEstimateFormQueryWhere
|
|
delayType - DelayTypeFormQueryWhere
|
|
delayReason - DelayReasonFormQueryWhere
|
Example
{
"and": [EstimateDelayFormQueryWhere],
"or": [EstimateDelayFormQueryWhere],
"rawExpression": "abc123",
"estimateID": StringWhereValueExpression,
"delaySeq": NumberWhereValueExpression,
"delayStartGmt": DateWhereValueExpression,
"delayStartGmtOffset": NumberWhereValueExpression,
"delayEndGmt": DateWhereValueExpression,
"delayEndGmtOffset": NumberWhereValueExpression,
"hours": NumberWhereValueExpression,
"activity": StringWhereValueExpression,
"reason": StringWhereValueExpression,
"includeInEstPnl": BoolWhereValueExpression,
"importedFromVoyage": BoolWhereValueExpression,
"voyageEstimate": VoyageEstimateFormQueryWhere,
"delayType": DelayTypeFormQueryWhere,
"delayReason": DelayReasonFormQueryWhere
}
EstimateDelayRelationships
Fields
| Field Name | Description |
|---|---|
voyageEstimate - RelationshipDefinition
|
|
delayType - RelationshipDefinition
|
|
delayReason - RelationshipDefinition
|
Example
{
"voyageEstimate": RelationshipDefinition,
"delayType": RelationshipDefinition,
"delayReason": RelationshipDefinition
}
EstimateFuelEuReplacementBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
estimateID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
fuelType - String
|
|
fuelPrice - Float
|
|
voyageEstimate - VoyageEstimate
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"estimateID": "abc123",
"customFieldByID": Any,
"customField": Any,
"fuelType": "abc123",
"fuelPrice": 987.65,
"voyageEstimate": VoyageEstimate,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
EstimateFuelEuReplacementBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - EstimateFuelEuReplacementBunkerFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": EstimateFuelEuReplacementBunkerFormQueryWhere
}
EstimateFuelEuReplacementBunkerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [EstimateFuelEuReplacementBunkerFormQueryWhere!]
|
|
or - [EstimateFuelEuReplacementBunkerFormQueryWhere!]
|
|
rawExpression - String
|
|
estimateID - StringWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
fuelPrice - NumberWhereValueExpression
|
|
voyageEstimate - VoyageEstimateFormQueryWhere
|
Example
{
"and": [EstimateFuelEuReplacementBunkerFormQueryWhere],
"or": [EstimateFuelEuReplacementBunkerFormQueryWhere],
"rawExpression": "xyz789",
"estimateID": StringWhereValueExpression,
"fuelType": StringWhereValueExpression,
"fuelPrice": NumberWhereValueExpression,
"voyageEstimate": VoyageEstimateFormQueryWhere
}
EstimateFuelEuReplacementBunkerRelationships
Fields
| Field Name | Description |
|---|---|
voyageEstimate - RelationshipDefinition
|
Example
{"voyageEstimate": RelationshipDefinition}
EstimateItinerary
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
sqlID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
estimateID - String
|
|
seq - Int
|
|
portName - String
|
|
berth - String
|
|
miles - Int
|
|
portFunction - String
|
|
cargoShortName - String
|
|
loadDischargeQuantity - Int
|
|
terms - String
|
|
loadDischargeRate - Float
|
|
termsFactor - Float
|
|
seaDays - Float
|
|
extraSeaDays - Float
|
|
portDays - Float
|
|
extraPortDays - Float
|
|
idleDays - Float
|
|
portExpensesBase - Int
|
|
linerExpensesBase - Int
|
|
demurrageDays - Float
|
|
draft - Float
|
|
salinity - Float
|
|
portNo - Int
|
|
speed - Float
|
|
weatherFactorPercentage - Float
|
|
base - Float
|
|
useCranes - Boolean
|
|
rateUnit - String
|
|
currency - String
|
|
lowSulfurSeaDays - Float
|
|
lowSulfurPortDays - Float
|
|
supplierReceiver - String
|
|
cargoSeq - Int
|
|
norHours - Float
|
|
draftBasis - String
|
|
lSMiles - Int
|
|
portEcaID - Int
|
|
seaEcaID - Int
|
|
seaConsMode - String
|
|
portConsMode - String
|
|
etaLocal - Date
|
|
etaGmt - Date
|
|
etdLocal - Date
|
|
etdGmt - Date
|
|
referencePortNo - Int
|
|
seaEcaIDPort - Port
|
|
portEcaIDPort - Port
|
|
cargoName - CargoName
|
|
portBerth - PortBerth
|
|
port - Port
|
|
voyageEstimate - VoyageEstimate
|
|
estimateCargo - EstimateCargoes
|
|
supplierReceiverAddressBook - AddressBook
|
|
estimateItineraryBunkers - [EstimateItineraryBunker]
|
|
estimateItineraryCarbons - [EstimateItineraryCarbon]
|
|
auditAction - [AuditAction]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"sqlID": 123,
"customFieldByID": Any,
"customField": Any,
"estimateID": "abc123",
"seq": 987,
"portName": "xyz789",
"berth": "abc123",
"miles": 987,
"portFunction": "abc123",
"cargoShortName": "xyz789",
"loadDischargeQuantity": 123,
"terms": "xyz789",
"loadDischargeRate": 987.65,
"termsFactor": 987.65,
"seaDays": 123.45,
"extraSeaDays": 987.65,
"portDays": 123.45,
"extraPortDays": 123.45,
"idleDays": 987.65,
"portExpensesBase": 123,
"linerExpensesBase": 123,
"demurrageDays": 987.65,
"draft": 123.45,
"salinity": 123.45,
"portNo": 987,
"speed": 123.45,
"weatherFactorPercentage": 123.45,
"base": 987.65,
"useCranes": false,
"rateUnit": "abc123",
"currency": "xyz789",
"lowSulfurSeaDays": 987.65,
"lowSulfurPortDays": 987.65,
"supplierReceiver": "xyz789",
"cargoSeq": 987,
"norHours": 987.65,
"draftBasis": "xyz789",
"lSMiles": 987,
"portEcaID": 123,
"seaEcaID": 987,
"seaConsMode": "xyz789",
"portConsMode": "xyz789",
"etaLocal": "2007-12-03",
"etaGmt": "2007-12-03",
"etdLocal": "2007-12-03",
"etdGmt": "2007-12-03",
"referencePortNo": 987,
"seaEcaIDPort": Port,
"portEcaIDPort": Port,
"cargoName": CargoName,
"portBerth": PortBerth,
"port": Port,
"voyageEstimate": VoyageEstimate,
"estimateCargo": EstimateCargoes,
"supplierReceiverAddressBook": AddressBook,
"estimateItineraryBunkers": [EstimateItineraryBunker],
"estimateItineraryCarbons": [EstimateItineraryCarbon],
"auditAction": [AuditAction],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
EstimateItineraryBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
estimateID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seq - Int
|
|
fuelType - String
|
|
price - Float
|
|
receivedQty - Float
|
|
robArrival - Float
|
|
robDeparture - Float
|
|
isReceivedBunkerQtyManual - Boolean
|
|
isROBArrivalQtyManual - Boolean
|
|
isROBDepartureQtyManual - Boolean
|
|
estimateItinerary - EstimateItinerary
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"estimateID": "abc123",
"customFieldByID": Any,
"customField": Any,
"seq": 987,
"fuelType": "abc123",
"price": 987.65,
"receivedQty": 987.65,
"robArrival": 123.45,
"robDeparture": 987.65,
"isReceivedBunkerQtyManual": false,
"isROBArrivalQtyManual": true,
"isROBDepartureQtyManual": true,
"estimateItinerary": EstimateItinerary,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
EstimateItineraryBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - EstimateItineraryBunkerFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": EstimateItineraryBunkerFormQueryWhere
}
EstimateItineraryBunkerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [EstimateItineraryBunkerFormQueryWhere!]
|
|
or - [EstimateItineraryBunkerFormQueryWhere!]
|
|
rawExpression - String
|
|
estimateID - StringWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
price - NumberWhereValueExpression
|
|
receivedQty - NumberWhereValueExpression
|
|
robArrival - NumberWhereValueExpression
|
|
robDeparture - NumberWhereValueExpression
|
|
isReceivedBunkerQtyManual - BoolWhereValueExpression
|
|
isROBArrivalQtyManual - BoolWhereValueExpression
|
|
isROBDepartureQtyManual - BoolWhereValueExpression
|
|
estimateItinerary - EstimateItineraryFormQueryWhere
|
Example
{
"and": [EstimateItineraryBunkerFormQueryWhere],
"or": [EstimateItineraryBunkerFormQueryWhere],
"rawExpression": "xyz789",
"estimateID": StringWhereValueExpression,
"seq": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"price": NumberWhereValueExpression,
"receivedQty": NumberWhereValueExpression,
"robArrival": NumberWhereValueExpression,
"robDeparture": NumberWhereValueExpression,
"isReceivedBunkerQtyManual": BoolWhereValueExpression,
"isROBArrivalQtyManual": BoolWhereValueExpression,
"isROBDepartureQtyManual": BoolWhereValueExpression,
"estimateItinerary": EstimateItineraryFormQueryWhere
}
EstimateItineraryBunkerRelationships
Fields
| Field Name | Description |
|---|---|
estimateItinerary - RelationshipDefinition
|
Example
{"estimateItinerary": RelationshipDefinition}
EstimateItineraryCarbon
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
totalEmissions - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
regulatedEmissions - Float
|
|
estimateID - String
|
|
itinSeq - Int
|
|
manualSeaPercent - Boolean
|
|
manualPortPercent - Boolean
|
|
manualPhaseInPercent - Boolean
|
|
manualSeaEtsEmission - Boolean
|
|
manualPortEtsEmission - Boolean
|
|
entryUserID - String
|
|
entryDate - Date
|
|
updateTimes - Int
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
seaPercentage - Float
|
|
portPercentage - Float
|
|
regulationScheme - String
|
|
phaseInPercentage - Float
|
|
year - Int
|
|
totalSeaEmissions - Float
|
|
totalPortEmissions - Float
|
|
regulatedSeaEmissions - Float
|
|
regulatedPortEmissions - Float
|
|
seqNo - Int
|
|
seaTimeStart - Date
|
|
seaTimeEnd - Date
|
|
portTimeStart - Date
|
|
portTimeEnd - Date
|
|
estimateItinerary - EstimateItinerary
|
|
estimateItineraryCarbonBunkers - [EstimateItineraryCarbonBunker]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"totalEmissions": 123.45,
"customFieldByID": Any,
"customField": Any,
"regulatedEmissions": 987.65,
"estimateID": "xyz789",
"itinSeq": 987,
"manualSeaPercent": true,
"manualPortPercent": false,
"manualPhaseInPercent": false,
"manualSeaEtsEmission": true,
"manualPortEtsEmission": false,
"entryUserID": "xyz789",
"entryDate": "2007-12-03",
"updateTimes": 123,
"lastUser": "abc123",
"lastUpdateGmt": "2007-12-03",
"seaPercentage": 123.45,
"portPercentage": 987.65,
"regulationScheme": "abc123",
"phaseInPercentage": 987.65,
"year": 123,
"totalSeaEmissions": 123.45,
"totalPortEmissions": 987.65,
"regulatedSeaEmissions": 123.45,
"regulatedPortEmissions": 987.65,
"seqNo": 123,
"seaTimeStart": "2007-12-03",
"seaTimeEnd": "2007-12-03",
"portTimeStart": "2007-12-03",
"portTimeEnd": "2007-12-03",
"estimateItinerary": EstimateItinerary,
"estimateItineraryCarbonBunkers": [
EstimateItineraryCarbonBunker
],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
EstimateItineraryCarbonBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
estimateID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
regulationScheme - String
|
|
seqNo - Int
|
|
fuelType - String
|
|
seaCons - Float
|
|
portCons - Float
|
|
seaEmissions - Float
|
|
portEmissions - Float
|
|
estimateItineraryCarbon - EstimateItineraryCarbon
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"estimateID": "xyz789",
"customFieldByID": Any,
"customField": Any,
"regulationScheme": "xyz789",
"seqNo": 123,
"fuelType": "abc123",
"seaCons": 987.65,
"portCons": 123.45,
"seaEmissions": 987.65,
"portEmissions": 987.65,
"estimateItineraryCarbon": EstimateItineraryCarbon,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
EstimateItineraryCarbonBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - EstimateItineraryCarbonBunkerFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": EstimateItineraryCarbonBunkerFormQueryWhere
}
EstimateItineraryCarbonBunkerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [EstimateItineraryCarbonBunkerFormQueryWhere!]
|
|
or - [EstimateItineraryCarbonBunkerFormQueryWhere!]
|
|
rawExpression - String
|
|
estimateID - StringWhereValueExpression
|
|
regulationScheme - EstimateItineraryCarbonBunkerRegulationSchemeEnumValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
seaCons - NumberWhereValueExpression
|
|
portCons - NumberWhereValueExpression
|
|
seaEmissions - NumberWhereValueExpression
|
|
portEmissions - NumberWhereValueExpression
|
|
estimateItineraryCarbon - EstimateItineraryCarbonFormQueryWhere
|
Example
{
"and": [EstimateItineraryCarbonBunkerFormQueryWhere],
"or": [EstimateItineraryCarbonBunkerFormQueryWhere],
"rawExpression": "abc123",
"estimateID": StringWhereValueExpression,
"regulationScheme": EstimateItineraryCarbonBunkerRegulationSchemeEnumValueExpression,
"seqNo": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"seaCons": NumberWhereValueExpression,
"portCons": NumberWhereValueExpression,
"seaEmissions": NumberWhereValueExpression,
"portEmissions": NumberWhereValueExpression,
"estimateItineraryCarbon": EstimateItineraryCarbonFormQueryWhere
}
EstimateItineraryCarbonBunkerRegulationSchemeEnum
Values
| Enum Value | Description |
|---|---|
|
|
Example
"EU"
EstimateItineraryCarbonBunkerRegulationSchemeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - EstimateItineraryCarbonBunkerRegulationSchemeEnum
|
|
isNot - EstimateItineraryCarbonBunkerRegulationSchemeEnum
|
|
isIn - [EstimateItineraryCarbonBunkerRegulationSchemeEnum]
|
Example
{"is": "EU", "isNot": "EU", "isIn": ["EU"]}
EstimateItineraryCarbonBunkerRelationships
Fields
| Field Name | Description |
|---|---|
estimateItineraryCarbon - RelationshipDefinition
|
Example
{"estimateItineraryCarbon": RelationshipDefinition}
EstimateItineraryCarbonFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - EstimateItineraryCarbonFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": EstimateItineraryCarbonFormQueryWhere
}
EstimateItineraryCarbonFormQueryWhere
Fields
Example
{
"and": [EstimateItineraryCarbonFormQueryWhere],
"or": [EstimateItineraryCarbonFormQueryWhere],
"rawExpression": "xyz789",
"estimateID": StringWhereValueExpression,
"itinSeq": NumberWhereValueExpression,
"manualSeaPercent": BoolWhereValueExpression,
"manualPortPercent": BoolWhereValueExpression,
"manualPhaseInPercent": BoolWhereValueExpression,
"manualSeaEtsEmission": BoolWhereValueExpression,
"manualPortEtsEmission": BoolWhereValueExpression,
"entryUserID": StringWhereValueExpression,
"entryDate": DateWhereValueExpression,
"updateTimes": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"seaPercentage": NumberWhereValueExpression,
"portPercentage": NumberWhereValueExpression,
"regulationScheme": EstimateItineraryCarbonRegulationSchemeEnumValueExpression,
"phaseInPercentage": NumberWhereValueExpression,
"year": NumberWhereValueExpression,
"totalSeaEmissions": NumberWhereValueExpression,
"totalPortEmissions": NumberWhereValueExpression,
"regulatedSeaEmissions": NumberWhereValueExpression,
"regulatedPortEmissions": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"seaTimeStart": DateWhereValueExpression,
"seaTimeEnd": DateWhereValueExpression,
"portTimeStart": DateWhereValueExpression,
"portTimeEnd": DateWhereValueExpression,
"estimateItinerary": EstimateItineraryFormQueryWhere
}
EstimateItineraryCarbonRegulationSchemeEnum
Values
| Enum Value | Description |
|---|---|
|
|
Example
"EU"
EstimateItineraryCarbonRegulationSchemeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - EstimateItineraryCarbonRegulationSchemeEnum
|
|
isNot - EstimateItineraryCarbonRegulationSchemeEnum
|
|
isIn - [EstimateItineraryCarbonRegulationSchemeEnum]
|
Example
{"is": "EU", "isNot": "EU", "isIn": ["EU"]}
EstimateItineraryCarbonRelationships
Fields
| Field Name | Description |
|---|---|
estimateItinerary - RelationshipDefinition
|
|
estimateItineraryCarbonBunkers - RelationshipDefinition
|
Example
{
"estimateItinerary": RelationshipDefinition,
"estimateItineraryCarbonBunkers": RelationshipDefinition
}
EstimateItineraryFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - EstimateItineraryFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": EstimateItineraryFormQueryWhere
}
EstimateItineraryFormQueryWhere
Fields
Example
{
"and": [EstimateItineraryFormQueryWhere],
"or": [EstimateItineraryFormQueryWhere],
"rawExpression": "xyz789",
"estimateID": StringWhereValueExpression,
"seq": NumberWhereValueExpression,
"portName": StringWhereValueExpression,
"berth": StringWhereValueExpression,
"miles": NumberWhereValueExpression,
"portFunction": StringWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"loadDischargeQuantity": NumberWhereValueExpression,
"terms": StringWhereValueExpression,
"loadDischargeRate": NumberWhereValueExpression,
"termsFactor": NumberWhereValueExpression,
"seaDays": NumberWhereValueExpression,
"extraSeaDays": NumberWhereValueExpression,
"portDays": NumberWhereValueExpression,
"extraPortDays": NumberWhereValueExpression,
"idleDays": NumberWhereValueExpression,
"portExpensesBase": NumberWhereValueExpression,
"linerExpensesBase": NumberWhereValueExpression,
"demurrageDays": NumberWhereValueExpression,
"draft": NumberWhereValueExpression,
"salinity": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"speed": NumberWhereValueExpression,
"weatherFactorPercentage": NumberWhereValueExpression,
"base": NumberWhereValueExpression,
"useCranes": BoolWhereValueExpression,
"rateUnit": StringWhereValueExpression,
"currency": StringWhereValueExpression,
"lowSulfurSeaDays": NumberWhereValueExpression,
"lowSulfurPortDays": NumberWhereValueExpression,
"supplierReceiver": StringWhereValueExpression,
"cargoSeq": NumberWhereValueExpression,
"norHours": NumberWhereValueExpression,
"draftBasis": StringWhereValueExpression,
"lSMiles": NumberWhereValueExpression,
"portEcaID": NumberWhereValueExpression,
"seaEcaID": NumberWhereValueExpression,
"seaConsMode": EstimateItinerarySeaConsModeEnumValueExpression,
"portConsMode": EstimateItineraryPortConsModeEnumValueExpression,
"etaLocal": DateWhereValueExpression,
"etaGmt": DateWhereValueExpression,
"etdLocal": DateWhereValueExpression,
"etdGmt": DateWhereValueExpression,
"referencePortNo": NumberWhereValueExpression,
"seaEcaIDPort": PortFormQueryWhere,
"portEcaIDPort": PortFormQueryWhere,
"cargoName": CargoNameFormQueryWhere,
"portBerth": PortBerthFormQueryWhere,
"port": PortFormQueryWhere,
"voyageEstimate": VoyageEstimateFormQueryWhere,
"estimateCargo": EstimateCargoesFormQueryWhere,
"supplierReceiverAddressBook": AddressBookFormQueryWhere
}
EstimateItineraryPortConsModeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Automatic"
EstimateItineraryPortConsModeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - EstimateItineraryPortConsModeEnum
|
|
isNot - EstimateItineraryPortConsModeEnum
|
|
isIn - [EstimateItineraryPortConsModeEnum]
|
Example
{"is": "Automatic", "isNot": "Automatic", "isIn": ["Automatic"]}
EstimateItineraryRelationships
Fields
| Field Name | Description |
|---|---|
seaEcaIDPort - RelationshipDefinition
|
|
portEcaIDPort - RelationshipDefinition
|
|
cargoName - RelationshipDefinition
|
|
portBerth - RelationshipDefinition
|
|
port - RelationshipDefinition
|
|
voyageEstimate - RelationshipDefinition
|
|
estimateCargo - RelationshipDefinition
|
|
supplierReceiverAddressBook - RelationshipDefinition
|
|
estimateItineraryBunkers - RelationshipDefinition
|
|
estimateItineraryCarbons - RelationshipDefinition
|
|
auditAction - RelationshipDefinition
|
Example
{
"seaEcaIDPort": RelationshipDefinition,
"portEcaIDPort": RelationshipDefinition,
"cargoName": RelationshipDefinition,
"portBerth": RelationshipDefinition,
"port": RelationshipDefinition,
"voyageEstimate": RelationshipDefinition,
"estimateCargo": RelationshipDefinition,
"supplierReceiverAddressBook": RelationshipDefinition,
"estimateItineraryBunkers": RelationshipDefinition,
"estimateItineraryCarbons": RelationshipDefinition,
"auditAction": RelationshipDefinition
}
EstimateItinerarySeaConsModeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Automatic"
EstimateItinerarySeaConsModeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - EstimateItinerarySeaConsModeEnum
|
|
isNot - EstimateItinerarySeaConsModeEnum
|
|
isIn - [EstimateItinerarySeaConsModeEnum]
|
Example
{"is": "Automatic", "isNot": "Automatic", "isIn": ["Automatic"]}
EstimatePriceInfo
EtaEtdInput
Description
Submits an ETA or ETD update for a portcall
Fields
| Input Field | Description |
|---|---|
vesselCode - String
|
The vessel code of the vessel, required on submission unless imoNo is specified |
voyageNo - Int
|
|
seq - Int
|
|
etaGmt - Date
|
|
etdGmt - Date
|
|
port - EtaEtd_PortInput
|
|
referenceDate - Date
|
Reference date for this message, can be used for portcall inference if no seq is specified. Should usually be left blank to allow inference using ETA or ETD instead. |
imoNo - String
|
The IMO number of the vessel, used for vessel inference if no vesselCode is specified |
Example
{
"vesselCode": "xyz789",
"voyageNo": 123,
"seq": 123,
"etaGmt": "2007-12-03",
"etdGmt": "2007-12-03",
"port": EtaEtd_PortInput,
"referenceDate": "2007-12-03",
"imoNo": "abc123"
}
EtaEtdMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": true,
"context": ["xyz789"],
"timestamp": "abc123",
"originalTimestamp": "abc123",
"intent": "abc123",
"from": "xyz789",
"to": ["abc123"],
"fromUser": "abc123",
"status": "xyz789",
"approvalStatus": "xyz789",
"objectId": "xyz789",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "abc123",
"previousData": Json,
"comment": "abc123",
"unmapped": false,
"responseData": Json,
"applyErrors": ["abc123"],
"applyWarnings": ["xyz789"],
"parentMessageId": "abc123",
"preResolutionObjectId": "xyz789",
"title": "abc123",
"effectiveDate": "abc123",
"source": "abc123",
"sourceId": "abc123",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": false,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "xyz789"
}
EtaEtd_PortInput
ExchangeRate
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
baseCurrencyCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
targetCurrencyCode - String
|
|
effectiveDate - Date
|
|
rate - Float
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
baseCurrency - Currency
|
|
targetCurrency - Currency
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"baseCurrencyCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"targetCurrencyCode": "xyz789",
"effectiveDate": "2007-12-03",
"rate": 123.45,
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123",
"baseCurrency": Currency,
"targetCurrency": Currency,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
ExchangeRateFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ExchangeRateFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ExchangeRateFormQueryWhere
}
ExchangeRateFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [ExchangeRateFormQueryWhere!]
|
|
or - [ExchangeRateFormQueryWhere!]
|
|
rawExpression - String
|
|
baseCurrencyCode - StringWhereValueExpression
|
|
targetCurrencyCode - StringWhereValueExpression
|
|
effectiveDate - DateWhereValueExpression
|
|
rate - NumberWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
baseCurrency - CurrencyFormQueryWhere
|
|
targetCurrency - CurrencyFormQueryWhere
|
Example
{
"and": [ExchangeRateFormQueryWhere],
"or": [ExchangeRateFormQueryWhere],
"rawExpression": "abc123",
"baseCurrencyCode": StringWhereValueExpression,
"targetCurrencyCode": StringWhereValueExpression,
"effectiveDate": DateWhereValueExpression,
"rate": NumberWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"baseCurrency": CurrencyFormQueryWhere,
"targetCurrency": CurrencyFormQueryWhere
}
ExchangeRateRelationships
Fields
| Field Name | Description |
|---|---|
baseCurrency - RelationshipDefinition
|
|
targetCurrency - RelationshipDefinition
|
Example
{
"baseCurrency": RelationshipDefinition,
"targetCurrency": RelationshipDefinition
}
ExecRequest
ExecResponse
Expense
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
ledgerCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
code - Int
|
|
description - String
|
|
type - String
|
|
class - String
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"ledgerCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"code": 987,
"description": "abc123",
"type": "abc123",
"class": "abc123",
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
ExpenseFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ExpenseFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ExpenseFormQueryWhere
}
ExpenseFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [ExpenseFormQueryWhere!]
|
|
or - [ExpenseFormQueryWhere!]
|
|
rawExpression - String
|
|
ledgerCode - StringWhereValueExpression
|
|
code - NumberWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
type - StringWhereValueExpression
|
|
class - StringWhereValueExpression
|
Example
{
"and": [ExpenseFormQueryWhere],
"or": [ExpenseFormQueryWhere],
"rawExpression": "xyz789",
"ledgerCode": StringWhereValueExpression,
"code": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"type": StringWhereValueExpression,
"class": StringWhereValueExpression
}
ExtraFreightTerms
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
cargoID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
cargoShortName - String
|
|
code - String
|
|
amount - Float
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
description - String
|
|
priceSeqNo - Int
|
|
scaleTableShortName - String
|
|
scaleTableQtyBasis - String
|
|
freightTerm - FreightTerm
|
|
cargoName - CargoName
|
|
cargo - Cargo
|
|
scaleTable - [StandardRate]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"cargoID": 987,
"customFieldByID": Any,
"customField": Any,
"cargoShortName": "abc123",
"code": "xyz789",
"amount": 123.45,
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"description": "abc123",
"priceSeqNo": 123,
"scaleTableShortName": "abc123",
"scaleTableQtyBasis": "xyz789",
"freightTerm": FreightTerm,
"cargoName": CargoName,
"cargo": Cargo,
"scaleTable": [StandardRate],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
ExtraFreightTermsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ExtraFreightTermsFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ExtraFreightTermsFormQueryWhere
}
ExtraFreightTermsFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [ExtraFreightTermsFormQueryWhere!]
|
|
or - [ExtraFreightTermsFormQueryWhere!]
|
|
rawExpression - String
|
|
cargoID - NumberWhereValueExpression
|
|
cargoShortName - StringWhereValueExpression
|
|
code - StringWhereValueExpression
|
|
amount - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
priceSeqNo - NumberWhereValueExpression
|
|
scaleTableShortName - StringWhereValueExpression
|
|
scaleTableQtyBasis - ExtraFreightTermsScaleTableQtyBasisEnumValueExpression
|
|
freightTerm - FreightTermFormQueryWhere
|
|
cargoName - CargoNameFormQueryWhere
|
|
cargo - CargoFormQueryWhere
|
Example
{
"and": [ExtraFreightTermsFormQueryWhere],
"or": [ExtraFreightTermsFormQueryWhere],
"rawExpression": "xyz789",
"cargoID": NumberWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"code": StringWhereValueExpression,
"amount": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"description": StringWhereValueExpression,
"priceSeqNo": NumberWhereValueExpression,
"scaleTableShortName": StringWhereValueExpression,
"scaleTableQtyBasis": ExtraFreightTermsScaleTableQtyBasisEnumValueExpression,
"freightTerm": FreightTermFormQueryWhere,
"cargoName": CargoNameFormQueryWhere,
"cargo": CargoFormQueryWhere
}
ExtraFreightTermsRelationships
Fields
| Field Name | Description |
|---|---|
freightTerm - RelationshipDefinition
|
|
cargoName - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
scaleTable - RelationshipDefinition
|
Example
{
"freightTerm": RelationshipDefinition,
"cargoName": RelationshipDefinition,
"cargo": RelationshipDefinition,
"scaleTable": RelationshipDefinition
}
ExtraFreightTermsScaleTableQtyBasisEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CPQty"
ExtraFreightTermsScaleTableQtyBasisEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - ExtraFreightTermsScaleTableQtyBasisEnum
|
|
isNot - ExtraFreightTermsScaleTableQtyBasisEnum
|
|
isIn - [ExtraFreightTermsScaleTableQtyBasisEnum]
|
Example
{"is": "CPQty", "isNot": "CPQty", "isIn": ["CPQty"]}
FinancialsAndOperationsInvoiceNotes
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
source - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
invoiceTransNo - String
|
|
transNo - Int
|
|
seq - Int
|
|
action - String
|
|
memo - String
|
|
actionDate - Date
|
|
paidAmountCurr - Float
|
|
outstandingAmountCurr - Float
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
followUpDays - Int
|
|
financialsInvoice - FinancialsInvoice
|
|
operationsInvoice - OperationsInvoice
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"source": "abc123",
"customFieldByID": Any,
"customField": Any,
"invoiceTransNo": "xyz789",
"transNo": 987,
"seq": 987,
"action": "abc123",
"memo": "xyz789",
"actionDate": "2007-12-03",
"paidAmountCurr": 123.45,
"outstandingAmountCurr": 987.65,
"lastUser": "xyz789",
"lastUpdateGmt": "2007-12-03",
"followUpDays": 987,
"financialsInvoice": FinancialsInvoice,
"operationsInvoice": OperationsInvoice,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
FinancialsAndOperationsInvoiceNotesFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - FinancialsAndOperationsInvoiceNotesFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": FinancialsAndOperationsInvoiceNotesFormQueryWhere
}
FinancialsAndOperationsInvoiceNotesFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [FinancialsAndOperationsInvoiceNotesFormQueryWhere!]
|
|
or - [FinancialsAndOperationsInvoiceNotesFormQueryWhere!]
|
|
rawExpression - String
|
|
financialsInvoice - FinancialsInvoiceFormQueryWhere
|
|
operationsInvoice - OperationsInvoiceFormQueryWhere
|
Example
{
"and": [
FinancialsAndOperationsInvoiceNotesFormQueryWhere
],
"or": [
FinancialsAndOperationsInvoiceNotesFormQueryWhere
],
"rawExpression": "xyz789",
"financialsInvoice": FinancialsInvoiceFormQueryWhere,
"operationsInvoice": OperationsInvoiceFormQueryWhere
}
FinancialsAndOperationsInvoiceNotesRelationships
Fields
| Field Name | Description |
|---|---|
financialsInvoice - RelationshipDefinition
|
|
operationsInvoice - RelationshipDefinition
|
Example
{
"financialsInvoice": RelationshipDefinition,
"operationsInvoice": RelationshipDefinition
}
FinancialsInvoice
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
transNo - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
companyCode - String
|
|
totalAmountPaidThroughDateCurr - Float
|
|
totalAmountPaidCurr - Float
|
|
totalAmountPaidBase - Float
|
|
originalInvoiceAmountBase - Float
|
|
originalInvoiceAmountCurr - Float
|
|
originalInvoiceCurr - String
|
|
originalInvoiceNo - String
|
|
originalInvoiceTransNo - String
|
|
originalInvoiceDueDate - Date
|
|
originalInvoiceDate - Date
|
|
paymentTermsCode - String
|
|
sqlID - Int
|
|
statusCode - String
|
|
transType - String
|
|
vendorCompanyNo - Int
|
|
vendorFullName - String
|
|
invoiceDate - Date
|
|
invoiceNo - String
|
|
amountCurr - Float
|
|
curr - String
|
|
amountBase - Float
|
|
purchaseOrderNo - String
|
|
accountingDate - Date
|
|
dueDate - Date
|
|
note - String
|
|
approvalNote - String
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
creditAccountCode - String
|
|
paymentTransID - String
|
|
paymentTransNo - String
|
|
amountPaidCurr - Float
|
|
exchangeRate - Float
|
|
lastUser - String
|
|
billTransNo - Int
|
|
paymentTermsCodeInternal - String
|
|
firstReminderDate - Date
|
|
secondReminderDate - Date
|
|
thirdReminderDate - Date
|
|
claimsDueDate - Date
|
|
isActual - Boolean
|
|
useLocalExchangeRate - Boolean
|
|
isReadyToPay - Boolean
|
|
isIntercompanyJournalEntry - Boolean
|
|
isMirrorParent - Boolean
|
|
isMirrorChild - Boolean
|
|
isFinal - Boolean
|
|
flags - Int
|
|
externalRef - String
|
|
serviceDate - Date
|
|
receivedDate - Date
|
|
remittanceSeq - Int
|
|
remittanceCompanyNo - Int
|
|
docNo - String
|
|
originalTransNo - String
|
|
parentTransNo - String
|
|
originalBillTrans - Int
|
|
billViaVompanyNo - Int
|
|
paymentTermsDescription - String
|
|
remarks - String
|
|
baseCurr - String
|
|
reversalReasonCode - String
|
|
exchangeRateDate - Date
|
|
billSource - String
|
|
subType - String
|
|
mirrorInvoiceTransNo - String
|
|
mirrorBillTransNo - Int
|
|
statementNo - Int
|
|
delayReason - String
|
|
vatCurrency - String
|
|
vatExchangeRate - Float
|
|
vatExchangeRateDate - Date
|
|
reversalApprovalStatus - String
|
|
createdByUser - String
|
|
eURegistryTransactionID - String
|
|
mirrorOperationsInvoice - OperationsInvoice
|
|
mirrorFinancialsInvoice - FinancialsInvoice
|
|
apArAccount - ChartOfAccounts
|
|
operationsInvoice - OperationsInvoice
|
|
firstInvoiceDetail - FinancialsInvoiceDetail
|
|
financialsOriginalInvoice - FinancialsInvoice
|
|
lastInvoiceNote - InvoiceNote
|
|
addressBook - AddressBook
|
|
beneficiaryAddressBook - AddressBook
|
|
remittanceBank - AddressBookBank
|
|
paymentTerm - PaymentTerm
|
|
invoiceNotes - [InvoiceNote]
|
|
paymentDetails - [PaymentDetail]
|
|
financialsInvoiceDetails - [FinancialsInvoiceDetail]
|
|
paymentBatchDetails - [PaymentBatchDetails]
|
|
financialsAndOperationsInvoiceNotes - [FinancialsAndOperationsInvoiceNotes]
|
|
alerts - [Alert]
|
|
publishInvoiceMessages - [PublishInvoiceMessageRecord]
|
|
Arguments
|
|
portExpensesMessages - [PortExpensesMessageRecord]
|
|
Arguments
|
|
changesSinceLast - FinancialsInvoiceChangesSinceLast
|
|
userDefinedFields - Json
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"transNo": "abc123",
"customFieldByID": Any,
"customField": Any,
"companyCode": "xyz789",
"totalAmountPaidThroughDateCurr": 987.65,
"totalAmountPaidCurr": 123.45,
"totalAmountPaidBase": 123.45,
"originalInvoiceAmountBase": 123.45,
"originalInvoiceAmountCurr": 987.65,
"originalInvoiceCurr": "xyz789",
"originalInvoiceNo": "abc123",
"originalInvoiceTransNo": "abc123",
"originalInvoiceDueDate": "2007-12-03",
"originalInvoiceDate": "2007-12-03",
"paymentTermsCode": "xyz789",
"sqlID": 123,
"statusCode": "xyz789",
"transType": "abc123",
"vendorCompanyNo": 987,
"vendorFullName": "xyz789",
"invoiceDate": "2007-12-03",
"invoiceNo": "xyz789",
"amountCurr": 123.45,
"curr": "abc123",
"amountBase": 987.65,
"purchaseOrderNo": "xyz789",
"accountingDate": "2007-12-03",
"dueDate": "2007-12-03",
"note": "abc123",
"approvalNote": "xyz789",
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"creditAccountCode": "xyz789",
"paymentTransID": "abc123",
"paymentTransNo": "xyz789",
"amountPaidCurr": 987.65,
"exchangeRate": 123.45,
"lastUser": "abc123",
"billTransNo": 123,
"paymentTermsCodeInternal": "abc123",
"firstReminderDate": "2007-12-03",
"secondReminderDate": "2007-12-03",
"thirdReminderDate": "2007-12-03",
"claimsDueDate": "2007-12-03",
"isActual": true,
"useLocalExchangeRate": false,
"isReadyToPay": false,
"isIntercompanyJournalEntry": true,
"isMirrorParent": true,
"isMirrorChild": true,
"isFinal": true,
"flags": 123,
"externalRef": "xyz789",
"serviceDate": "2007-12-03",
"receivedDate": "2007-12-03",
"remittanceSeq": 987,
"remittanceCompanyNo": 987,
"docNo": "abc123",
"originalTransNo": "abc123",
"parentTransNo": "abc123",
"originalBillTrans": 987,
"billViaVompanyNo": 123,
"paymentTermsDescription": "xyz789",
"remarks": "abc123",
"baseCurr": "xyz789",
"reversalReasonCode": "abc123",
"exchangeRateDate": "2007-12-03",
"billSource": "xyz789",
"subType": "xyz789",
"mirrorInvoiceTransNo": "xyz789",
"mirrorBillTransNo": 123,
"statementNo": 123,
"delayReason": "xyz789",
"vatCurrency": "abc123",
"vatExchangeRate": 123.45,
"vatExchangeRateDate": "2007-12-03",
"reversalApprovalStatus": "xyz789",
"createdByUser": "xyz789",
"eURegistryTransactionID": "xyz789",
"mirrorOperationsInvoice": OperationsInvoice,
"mirrorFinancialsInvoice": FinancialsInvoice,
"apArAccount": ChartOfAccounts,
"operationsInvoice": OperationsInvoice,
"firstInvoiceDetail": FinancialsInvoiceDetail,
"financialsOriginalInvoice": FinancialsInvoice,
"lastInvoiceNote": InvoiceNote,
"addressBook": AddressBook,
"beneficiaryAddressBook": AddressBook,
"remittanceBank": AddressBookBank,
"paymentTerm": PaymentTerm,
"invoiceNotes": [InvoiceNote],
"paymentDetails": [PaymentDetail],
"financialsInvoiceDetails": [FinancialsInvoiceDetail],
"paymentBatchDetails": [PaymentBatchDetails],
"financialsAndOperationsInvoiceNotes": [
FinancialsAndOperationsInvoiceNotes
],
"alerts": [Alert],
"publishInvoiceMessages": [PublishInvoiceMessageRecord],
"portExpensesMessages": [PortExpensesMessageRecord],
"changesSinceLast": FinancialsInvoiceChangesSinceLast,
"userDefinedFields": Json,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
FinancialsInvoiceBillSourceEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
FinancialsInvoiceBillSourceEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - FinancialsInvoiceBillSourceEnum
|
|
isNot - FinancialsInvoiceBillSourceEnum
|
|
isIn - [FinancialsInvoiceBillSourceEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
FinancialsInvoiceChangesSinceLast
Fields
| Field Name | Description |
|---|---|
publishInvoice - MessageUpdateResponse
|
|
portExpenses - MessageUpdateResponse
|
Example
{
"publishInvoice": MessageUpdateResponse,
"portExpenses": MessageUpdateResponse
}
FinancialsInvoiceDetail
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
companyCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
linkedItinerarySeq - Int
|
|
transNo - String
|
|
seqLegacyInternal - String
|
|
vesselCode - String
|
|
legacyVoyage - String
|
|
ledgerCode - String
|
|
accountingDate - Date
|
|
portName - String
|
|
amountCurr - Float
|
|
description - String
|
|
lastUpdateGmt - Date
|
|
creditAccountCode - String
|
|
amountBase - Float
|
|
lobCode - String
|
|
invoiceType - Int
|
|
counterpartyNo - Int
|
|
counterpartyShortName - String
|
|
portNo - Int
|
|
productCode - String
|
|
exchangeRate - Float
|
|
rate - Float
|
|
departmentName - String
|
|
lastUserID - String
|
|
taxCode - String
|
|
voyageNo - Int
|
|
operationsInvoiceSeq - Int
|
|
operationsInvoiceCode - String
|
|
quantity - Float
|
|
unit - String
|
|
codeDescription - String
|
|
fixtureCargoSeq - Int
|
|
brokerageType - String
|
|
internalBrokerageType - String
|
|
intercompanyNo - Int
|
|
intercompanyCode - String
|
|
supplierShortName - String
|
|
supplierType - String
|
|
operationBillSource - String
|
|
seq - Int
|
|
operationBillCode - String
|
|
operationSubCode - String
|
|
operationBillRef - Int
|
|
operationBillRefSeq - Int
|
|
refSeqNo - Int
|
|
exchangeRateDate - Date
|
|
currency - String
|
|
actDepartment - ActDepartment
|
|
counterparty - AddressBook
|
|
port - Port
|
|
lob - Lob
|
|
chartOfAccounts - ChartOfAccounts
|
|
vessel - Vessel
|
|
voyage - Voyage
|
|
financialsInvoice - FinancialsInvoice
|
|
company - AddressBook
|
|
companyByNo - AddressBook
|
|
companyByCode - AddressBook
|
|
cargo - Cargo
|
|
financialsInvoiceDetailCargoAllocations - [FinancialsInvoiceDetailCargoAllocation]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"companyCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"linkedItinerarySeq": 987,
"transNo": "xyz789",
"seqLegacyInternal": "abc123",
"vesselCode": "xyz789",
"legacyVoyage": "xyz789",
"ledgerCode": "abc123",
"accountingDate": "2007-12-03",
"portName": "abc123",
"amountCurr": 123.45,
"description": "abc123",
"lastUpdateGmt": "2007-12-03",
"creditAccountCode": "abc123",
"amountBase": 987.65,
"lobCode": "abc123",
"invoiceType": 123,
"counterpartyNo": 123,
"counterpartyShortName": "abc123",
"portNo": 123,
"productCode": "abc123",
"exchangeRate": 123.45,
"rate": 987.65,
"departmentName": "xyz789",
"lastUserID": "xyz789",
"taxCode": "xyz789",
"voyageNo": 123,
"operationsInvoiceSeq": 123,
"operationsInvoiceCode": "abc123",
"quantity": 123.45,
"unit": "abc123",
"codeDescription": "abc123",
"fixtureCargoSeq": 987,
"brokerageType": "abc123",
"internalBrokerageType": "xyz789",
"intercompanyNo": 123,
"intercompanyCode": "abc123",
"supplierShortName": "xyz789",
"supplierType": "abc123",
"operationBillSource": "abc123",
"seq": 987,
"operationBillCode": "xyz789",
"operationSubCode": "xyz789",
"operationBillRef": 987,
"operationBillRefSeq": 987,
"refSeqNo": 123,
"exchangeRateDate": "2007-12-03",
"currency": "abc123",
"actDepartment": ActDepartment,
"counterparty": AddressBook,
"port": Port,
"lob": Lob,
"chartOfAccounts": ChartOfAccounts,
"vessel": Vessel,
"voyage": Voyage,
"financialsInvoice": FinancialsInvoice,
"company": AddressBook,
"companyByNo": AddressBook,
"companyByCode": AddressBook,
"cargo": Cargo,
"financialsInvoiceDetailCargoAllocations": [
FinancialsInvoiceDetailCargoAllocation
],
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
FinancialsInvoiceDetailCargoAllocation
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
cargoItinPortName - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
transNo - String
|
|
invoiceDetailSeqNo - Int
|
|
cargoID - Int
|
|
cargoItinSeqNo - Int
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
voyageItinerarySeq - Int
|
|
voyageCargoHandlingSeq - Int
|
|
cpQuantity - Float
|
|
altUnitCPQty - Float
|
|
blQuantity - Float
|
|
altUnitBLQty - Float
|
|
cargoUnit - String
|
|
altCargoUnit - String
|
|
allocationPercent - Float
|
|
proratedAmountBase - Float
|
|
proratedAmountCurr - Float
|
|
cargoCounterpartyType - String
|
|
cargoCounerpartyShortName - String
|
|
cargoShortName - String
|
|
cargoLaycanFromLocal - Date
|
|
cargoLaycanToLocal - Date
|
|
cargoItinShortName - String
|
|
cargoItinGradeSeq - Int
|
|
cargoExternalRef - String
|
|
cargoItinExternalRef - String
|
|
cargoItinCommercialID - String
|
|
cargoItinPortNo - Int
|
|
cargoItinBerth - String
|
|
cargoItinPortFunc - String
|
|
cargoItinLaycanFromLocal - Date
|
|
cargoItinLaycanToLocal - Date
|
|
selectedForAllocation - Boolean
|
|
lastUser - String
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
altBLQtyUnit - String
|
|
rootCause - String
|
|
voyage - Voyage
|
|
cargoItinerary - CargoItinerary
|
|
cargo - Cargo
|
|
cargoItinPort - Port
|
|
financialsInvoiceDetail - FinancialsInvoiceDetail
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"cargoItinPortName": "abc123",
"customFieldByID": Any,
"customField": Any,
"transNo": "xyz789",
"invoiceDetailSeqNo": 987,
"cargoID": 987,
"cargoItinSeqNo": 123,
"vesselCode": "abc123",
"voyageNo": 123,
"voyageItinerarySeq": 987,
"voyageCargoHandlingSeq": 987,
"cpQuantity": 987.65,
"altUnitCPQty": 987.65,
"blQuantity": 987.65,
"altUnitBLQty": 987.65,
"cargoUnit": "abc123",
"altCargoUnit": "abc123",
"allocationPercent": 123.45,
"proratedAmountBase": 123.45,
"proratedAmountCurr": 987.65,
"cargoCounterpartyType": "abc123",
"cargoCounerpartyShortName": "abc123",
"cargoShortName": "abc123",
"cargoLaycanFromLocal": "2007-12-03",
"cargoLaycanToLocal": "2007-12-03",
"cargoItinShortName": "xyz789",
"cargoItinGradeSeq": 987,
"cargoExternalRef": "xyz789",
"cargoItinExternalRef": "abc123",
"cargoItinCommercialID": "xyz789",
"cargoItinPortNo": 987,
"cargoItinBerth": "abc123",
"cargoItinPortFunc": "xyz789",
"cargoItinLaycanFromLocal": "2007-12-03",
"cargoItinLaycanToLocal": "2007-12-03",
"selectedForAllocation": false,
"lastUser": "xyz789",
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"altBLQtyUnit": "abc123",
"rootCause": "xyz789",
"voyage": Voyage,
"cargoItinerary": CargoItinerary,
"cargo": Cargo,
"cargoItinPort": Port,
"financialsInvoiceDetail": FinancialsInvoiceDetail,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
FinancialsInvoiceDetailCargoAllocationFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - FinancialsInvoiceDetailCargoAllocationFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": FinancialsInvoiceDetailCargoAllocationFormQueryWhere
}
FinancialsInvoiceDetailCargoAllocationFormQueryWhere
Fields
Example
{
"and": [
FinancialsInvoiceDetailCargoAllocationFormQueryWhere
],
"or": [
FinancialsInvoiceDetailCargoAllocationFormQueryWhere
],
"rawExpression": "xyz789",
"transNo": StringWhereValueExpression,
"invoiceDetailSeqNo": NumberWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"cargoItinSeqNo": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"voyageItinerarySeq": NumberWhereValueExpression,
"voyageCargoHandlingSeq": NumberWhereValueExpression,
"cpQuantity": NumberWhereValueExpression,
"altUnitCPQty": NumberWhereValueExpression,
"blQuantity": NumberWhereValueExpression,
"altUnitBLQty": NumberWhereValueExpression,
"cargoUnit": StringWhereValueExpression,
"altCargoUnit": StringWhereValueExpression,
"allocationPercent": NumberWhereValueExpression,
"proratedAmountBase": NumberWhereValueExpression,
"proratedAmountCurr": NumberWhereValueExpression,
"cargoCounterpartyType": StringWhereValueExpression,
"cargoCounerpartyShortName": StringWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"cargoLaycanFromLocal": DateWhereValueExpression,
"cargoLaycanToLocal": DateWhereValueExpression,
"cargoItinShortName": StringWhereValueExpression,
"cargoItinGradeSeq": NumberWhereValueExpression,
"cargoExternalRef": StringWhereValueExpression,
"cargoItinExternalRef": StringWhereValueExpression,
"cargoItinCommercialID": StringWhereValueExpression,
"cargoItinPortNo": NumberWhereValueExpression,
"cargoItinBerth": StringWhereValueExpression,
"cargoItinPortFunc": StringWhereValueExpression,
"cargoItinLaycanFromLocal": DateWhereValueExpression,
"cargoItinLaycanToLocal": DateWhereValueExpression,
"selectedForAllocation": BoolWhereValueExpression,
"lastUser": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"altBLQtyUnit": StringWhereValueExpression,
"rootCause": StringWhereValueExpression,
"voyage": VoyageFormQueryWhere,
"cargoItinerary": CargoItineraryFormQueryWhere,
"cargo": CargoFormQueryWhere,
"cargoItinPort": PortFormQueryWhere,
"financialsInvoiceDetail": FinancialsInvoiceDetailFormQueryWhere
}
FinancialsInvoiceDetailCargoAllocationRelationships
Fields
| Field Name | Description |
|---|---|
voyage - RelationshipDefinition
|
|
cargoItinerary - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
cargoItinPort - RelationshipDefinition
|
|
financialsInvoiceDetail - RelationshipDefinition
|
Example
{
"voyage": RelationshipDefinition,
"cargoItinerary": RelationshipDefinition,
"cargo": RelationshipDefinition,
"cargoItinPort": RelationshipDefinition,
"financialsInvoiceDetail": RelationshipDefinition
}
FinancialsInvoiceDetailFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - FinancialsInvoiceDetailFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": FinancialsInvoiceDetailFormQueryWhere
}
FinancialsInvoiceDetailFormQueryWhere
Fields
Example
{
"and": [FinancialsInvoiceDetailFormQueryWhere],
"or": [FinancialsInvoiceDetailFormQueryWhere],
"rawExpression": "abc123",
"companyCode": StringWhereValueExpression,
"linkedItinerarySeq": NumberWhereValueExpression,
"transNo": StringWhereValueExpression,
"seqLegacyInternal": StringWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"legacyVoyage": StringWhereValueExpression,
"ledgerCode": StringWhereValueExpression,
"accountingDate": DateWhereValueExpression,
"portName": StringWhereValueExpression,
"amountCurr": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"creditAccountCode": StringWhereValueExpression,
"amountBase": NumberWhereValueExpression,
"lobCode": StringWhereValueExpression,
"invoiceType": NumberWhereValueExpression,
"counterpartyNo": NumberWhereValueExpression,
"counterpartyShortName": StringWhereValueExpression,
"portNo": NumberWhereValueExpression,
"productCode": StringWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"rate": NumberWhereValueExpression,
"departmentName": StringWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"taxCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"operationsInvoiceSeq": NumberWhereValueExpression,
"operationsInvoiceCode": StringWhereValueExpression,
"quantity": NumberWhereValueExpression,
"unit": StringWhereValueExpression,
"codeDescription": StringWhereValueExpression,
"fixtureCargoSeq": NumberWhereValueExpression,
"brokerageType": StringWhereValueExpression,
"internalBrokerageType": StringWhereValueExpression,
"intercompanyNo": NumberWhereValueExpression,
"intercompanyCode": StringWhereValueExpression,
"supplierShortName": StringWhereValueExpression,
"supplierType": StringWhereValueExpression,
"operationBillSource": StringWhereValueExpression,
"seq": NumberWhereValueExpression,
"operationBillCode": StringWhereValueExpression,
"operationSubCode": StringWhereValueExpression,
"operationBillRef": NumberWhereValueExpression,
"operationBillRefSeq": NumberWhereValueExpression,
"refSeqNo": NumberWhereValueExpression,
"exchangeRateDate": DateWhereValueExpression,
"currency": StringWhereValueExpression,
"actDepartment": ActDepartmentFormQueryWhere,
"counterparty": AddressBookFormQueryWhere,
"port": PortFormQueryWhere,
"lob": LobFormQueryWhere,
"chartOfAccounts": ChartOfAccountsFormQueryWhere,
"vessel": VesselFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"financialsInvoice": FinancialsInvoiceFormQueryWhere,
"company": AddressBookFormQueryWhere,
"companyByNo": AddressBookFormQueryWhere,
"companyByCode": AddressBookFormQueryWhere,
"cargo": CargoFormQueryWhere
}
FinancialsInvoiceDetailRelationships
Fields
| Field Name | Description |
|---|---|
actDepartment - RelationshipDefinition
|
|
counterparty - RelationshipDefinition
|
|
port - RelationshipDefinition
|
|
lob - RelationshipDefinition
|
|
chartOfAccounts - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
financialsInvoice - RelationshipDefinition
|
|
financialCompany - RelationshipDefinition
|
|
company - RelationshipDefinition
|
|
companyByNo - RelationshipDefinition
|
|
companyByCode - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
linkedVoyageItinerary - RelationshipDefinition
|
|
financialsInvoiceDetailCargoAllocations - RelationshipDefinition
|
Example
{
"actDepartment": RelationshipDefinition,
"counterparty": RelationshipDefinition,
"port": RelationshipDefinition,
"lob": RelationshipDefinition,
"chartOfAccounts": RelationshipDefinition,
"vessel": RelationshipDefinition,
"voyage": RelationshipDefinition,
"financialsInvoice": RelationshipDefinition,
"financialCompany": RelationshipDefinition,
"company": RelationshipDefinition,
"companyByNo": RelationshipDefinition,
"companyByCode": RelationshipDefinition,
"cargo": RelationshipDefinition,
"linkedVoyageItinerary": RelationshipDefinition,
"financialsInvoiceDetailCargoAllocations": RelationshipDefinition
}
FinancialsInvoiceFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - FinancialsInvoiceFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": FinancialsInvoiceFormQueryWhere
}
FinancialsInvoiceFormQueryWhere
Fields
Example
{
"and": [FinancialsInvoiceFormQueryWhere],
"or": [FinancialsInvoiceFormQueryWhere],
"rawExpression": "abc123",
"transNo": StringWhereValueExpression,
"statusCode": StringWhereValueExpression,
"transType": FinancialsInvoiceTransTypeEnumValueExpression,
"vendorCompanyNo": NumberWhereValueExpression,
"vendorFullName": StringWhereValueExpression,
"invoiceDate": DateWhereValueExpression,
"invoiceNo": StringWhereValueExpression,
"amountCurr": NumberWhereValueExpression,
"curr": StringWhereValueExpression,
"amountBase": NumberWhereValueExpression,
"purchaseOrderNo": StringWhereValueExpression,
"accountingDate": DateWhereValueExpression,
"dueDate": DateWhereValueExpression,
"note": StringWhereValueExpression,
"approvalNote": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"creditAccountCode": StringWhereValueExpression,
"paymentTransID": StringWhereValueExpression,
"paymentTransNo": StringWhereValueExpression,
"amountPaidCurr": NumberWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"billTransNo": NumberWhereValueExpression,
"paymentTermsCodeInternal": StringWhereValueExpression,
"firstReminderDate": DateWhereValueExpression,
"secondReminderDate": DateWhereValueExpression,
"thirdReminderDate": DateWhereValueExpression,
"claimsDueDate": DateWhereValueExpression,
"isActual": BoolWhereValueExpression,
"useLocalExchangeRate": BoolWhereValueExpression,
"isReadyToPay": BoolWhereValueExpression,
"isIntercompanyJournalEntry": BoolWhereValueExpression,
"isMirrorParent": BoolWhereValueExpression,
"isMirrorChild": BoolWhereValueExpression,
"isFinal": BoolWhereValueExpression,
"flags": NumberWhereValueExpression,
"externalRef": StringWhereValueExpression,
"serviceDate": DateWhereValueExpression,
"receivedDate": DateWhereValueExpression,
"remittanceSeq": NumberWhereValueExpression,
"remittanceCompanyNo": NumberWhereValueExpression,
"docNo": StringWhereValueExpression,
"originalTransNo": StringWhereValueExpression,
"parentTransNo": StringWhereValueExpression,
"originalBillTrans": NumberWhereValueExpression,
"billViaVompanyNo": NumberWhereValueExpression,
"paymentTermsDescription": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"baseCurr": StringWhereValueExpression,
"reversalReasonCode": StringWhereValueExpression,
"exchangeRateDate": DateWhereValueExpression,
"billSource": FinancialsInvoiceBillSourceEnumValueExpression,
"subType": StringWhereValueExpression,
"mirrorInvoiceTransNo": StringWhereValueExpression,
"mirrorBillTransNo": NumberWhereValueExpression,
"statementNo": NumberWhereValueExpression,
"delayReason": StringWhereValueExpression,
"vatCurrency": StringWhereValueExpression,
"vatExchangeRate": NumberWhereValueExpression,
"vatExchangeRateDate": DateWhereValueExpression,
"reversalApprovalStatus": FinancialsInvoiceReversalApprovalStatusEnumValueExpression,
"createdByUser": StringWhereValueExpression,
"eURegistryTransactionID": StringWhereValueExpression,
"mirrorOperationsInvoice": OperationsInvoiceFormQueryWhere,
"mirrorFinancialsInvoice": FinancialsInvoiceFormQueryWhere,
"apArAccount": ChartOfAccountsFormQueryWhere,
"operationsInvoice": OperationsInvoiceFormQueryWhere,
"firstInvoiceDetail": FinancialsInvoiceDetailFormQueryWhere,
"financialsOriginalInvoice": FinancialsInvoiceFormQueryWhere,
"lastInvoiceNote": InvoiceNoteFormQueryWhere,
"addressBook": AddressBookFormQueryWhere,
"beneficiaryAddressBook": AddressBookFormQueryWhere,
"remittanceBank": AddressBookBankFormQueryWhere,
"paymentTerm": PaymentTermFormQueryWhere
}
FinancialsInvoicePayment
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
invTransNo - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
payTransNo - String
|
|
amount - Float
|
|
amountUSD - Float
|
|
payDate - Date
|
|
entryDateGmt - Date
|
|
transType - Int
|
|
paymentModeNo - String
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
payment - Payment
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"invTransNo": "xyz789",
"customFieldByID": Any,
"customField": Any,
"payTransNo": "xyz789",
"amount": 123.45,
"amountUSD": 987.65,
"payDate": "2007-12-03",
"entryDateGmt": "2007-12-03",
"transType": 987,
"paymentModeNo": "xyz789",
"lastUser": "abc123",
"lastUpdateGmt": "2007-12-03",
"payment": Payment,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
FinancialsInvoicePaymentFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - FinancialsInvoicePaymentFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": FinancialsInvoicePaymentFormQueryWhere
}
FinancialsInvoicePaymentFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [FinancialsInvoicePaymentFormQueryWhere!]
|
|
or - [FinancialsInvoicePaymentFormQueryWhere!]
|
|
rawExpression - String
|
|
invTransNo - StringWhereValueExpression
|
|
payTransNo - StringWhereValueExpression
|
|
amount - NumberWhereValueExpression
|
|
amountUSD - NumberWhereValueExpression
|
|
payDate - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
transType - NumberWhereValueExpression
|
|
paymentModeNo - StringWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
payment - PaymentFormQueryWhere
|
Example
{
"and": [FinancialsInvoicePaymentFormQueryWhere],
"or": [FinancialsInvoicePaymentFormQueryWhere],
"rawExpression": "abc123",
"invTransNo": StringWhereValueExpression,
"payTransNo": StringWhereValueExpression,
"amount": NumberWhereValueExpression,
"amountUSD": NumberWhereValueExpression,
"payDate": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"transType": NumberWhereValueExpression,
"paymentModeNo": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"payment": PaymentFormQueryWhere
}
FinancialsInvoicePaymentRelationships
Fields
| Field Name | Description |
|---|---|
payment - RelationshipDefinition
|
Example
{"payment": RelationshipDefinition}
FinancialsInvoiceRelationships
Fields
| Field Name | Description |
|---|---|
mirrorOperationsInvoice - RelationshipDefinition
|
|
mirrorFinancialsInvoice - RelationshipDefinition
|
|
apArAccount - RelationshipDefinition
|
|
operationsInvoice - RelationshipDefinition
|
|
firstInvoiceDetail - RelationshipDefinition
|
|
financialsOriginalInvoiceForReversals - RelationshipDefinition
|
|
financialsOriginalInvoice - RelationshipDefinition
|
|
financialsOriginalInvoice2 - RelationshipDefinition
|
|
financialsOriginalInvoice3 - RelationshipDefinition
|
|
financialsOriginalInvoice4 - RelationshipDefinition
|
|
financialsOriginalInvoice5 - RelationshipDefinition
|
|
financialsOriginalInvoice6 - RelationshipDefinition
|
|
lastInvoiceNote - RelationshipDefinition
|
|
addressBook - RelationshipDefinition
|
|
beneficiaryAddressBook - RelationshipDefinition
|
|
remittanceBank - RelationshipDefinition
|
|
paymentTerm - RelationshipDefinition
|
|
invoiceNotes - RelationshipDefinition
|
|
paymentDetails - RelationshipDefinition
|
|
financialsInvoiceDetails - RelationshipDefinition
|
|
paymentBatchDetails - RelationshipDefinition
|
|
paymentDetailsFiltered - RelationshipDefinition
|
|
financialsInvoicePayments - RelationshipDefinition
|
|
financialsAndOperationsInvoiceNotes - RelationshipDefinition
|
|
alerts - RelationshipDefinition
|
Example
{
"mirrorOperationsInvoice": RelationshipDefinition,
"mirrorFinancialsInvoice": RelationshipDefinition,
"apArAccount": RelationshipDefinition,
"operationsInvoice": RelationshipDefinition,
"firstInvoiceDetail": RelationshipDefinition,
"financialsOriginalInvoiceForReversals": RelationshipDefinition,
"financialsOriginalInvoice": RelationshipDefinition,
"financialsOriginalInvoice2": RelationshipDefinition,
"financialsOriginalInvoice3": RelationshipDefinition,
"financialsOriginalInvoice4": RelationshipDefinition,
"financialsOriginalInvoice5": RelationshipDefinition,
"financialsOriginalInvoice6": RelationshipDefinition,
"lastInvoiceNote": RelationshipDefinition,
"addressBook": RelationshipDefinition,
"beneficiaryAddressBook": RelationshipDefinition,
"remittanceBank": RelationshipDefinition,
"paymentTerm": RelationshipDefinition,
"invoiceNotes": RelationshipDefinition,
"paymentDetails": RelationshipDefinition,
"financialsInvoiceDetails": RelationshipDefinition,
"paymentBatchDetails": RelationshipDefinition,
"paymentDetailsFiltered": RelationshipDefinition,
"financialsInvoicePayments": RelationshipDefinition,
"financialsAndOperationsInvoiceNotes": RelationshipDefinition,
"alerts": RelationshipDefinition
}
FinancialsInvoiceReversalApprovalStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Unapproved"
FinancialsInvoiceReversalApprovalStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - FinancialsInvoiceReversalApprovalStatusEnum
|
|
isNot - FinancialsInvoiceReversalApprovalStatusEnum
|
|
isIn - [FinancialsInvoiceReversalApprovalStatusEnum]
|
Example
{"is": "Unapproved", "isNot": "Unapproved", "isIn": ["Unapproved"]}
FinancialsInvoiceTransTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
FinancialsInvoiceTransTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - FinancialsInvoiceTransTypeEnum
|
|
isNot - FinancialsInvoiceTransTypeEnum
|
|
isIn - [FinancialsInvoiceTransTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
Financials_functionsRootMutation
Fields
| Field Name | Description |
|---|---|
postMonthlyAccrualBill - Imosfunctions_PostMonthlyAccrualBillResponse
|
|
Arguments |
|
postVoyagePeriodBill - Imosfunctions_PostVoyagePeriodBillResponse
|
|
Arguments |
|
runVoyageAccruals - Imosfunctions_RunVoyageAccrualsResponse
|
|
Arguments
|
|
runVoyagePeriodJournals - Imosfunctions_RunVoyagePeriodJournalsResponse
|
|
Arguments |
|
Example
{
"postMonthlyAccrualBill": Imosfunctions_PostMonthlyAccrualBillResponse,
"postVoyagePeriodBill": Imosfunctions_PostVoyagePeriodBillResponse,
"runVoyageAccruals": Imosfunctions_RunVoyageAccrualsResponse,
"runVoyagePeriodJournals": Imosfunctions_RunVoyagePeriodJournalsResponse
}
Fixture
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
lighteringVoyageNoString - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
lighteringInfo - String
|
|
fixtureNo - String
|
|
fixtureDate - Date
|
|
estimateID - String
|
|
charterPartyDate - Date
|
|
vesselCode - String
|
|
voyRef - String
|
|
commenceGmt - Date
|
|
schedulingStatus - String
|
|
oprType - String
|
|
portExpCap - Float
|
|
chartererShortName - String
|
|
cargo - String
|
|
lighteringVoyageNo - Int
|
|
oCNonSurplus - Boolean
|
|
oCSurplus - Boolean
|
|
cOPBackhaul - Boolean
|
|
coLoad - Boolean
|
|
vettingFlags - Int
|
|
companyCode - String
|
|
charteringCoordinator - String
|
|
useCOAFreight - Boolean
|
|
lockTCE - Boolean
|
|
autoCalcByLiftQty - Boolean
|
|
useVschedItin - Boolean
|
|
tcoEstimate - Boolean
|
|
lowSulfurOnly - Boolean
|
|
capNoRebills - Boolean
|
|
consecutive - Boolean
|
|
bunkerOwner - Boolean
|
|
manualDailyCost - Boolean
|
|
manualAddCommRate - Boolean
|
|
fifoBunkers - Boolean
|
|
benchmark - Boolean
|
|
fixBunkers - Boolean
|
|
cancelled - Boolean
|
|
transshipment - Boolean
|
|
vettingFail - Boolean
|
|
addCommInclOPA - Boolean
|
|
forwardCurve - Boolean
|
|
thirdParty - Boolean
|
|
onSubs - Boolean
|
|
tcoExchRateManual - Boolean
|
|
lockProfit - Boolean
|
|
devTceCalc - Boolean
|
|
inProgressEst - Boolean
|
|
piracyDisabled - Boolean
|
|
piracyEnabled - Boolean
|
|
estTemplate - Boolean
|
|
estDeviation - Boolean
|
|
tcoEstTripTc - Boolean
|
|
lastTciVoyage - Boolean
|
|
isDeviationBaseline - Boolean
|
|
voyageNo - Int
|
|
vesselLaycanFrom - Date
|
|
vesselLaycanTo - Date
|
|
fuelZoneSetID - Int
|
|
enableFNCoaComponentCalc - Boolean
|
|
tceFromTarget - Boolean
|
|
openEstimate - Boolean
|
|
disableBackupFuelTypes - Boolean
|
|
waitForLaycan - Boolean
|
|
useScrubbers - Boolean
|
|
hasManualTciCommRate - Boolean
|
|
hasManuallyOverriddenMarketTcRate - Boolean
|
|
tcoBenchmark - Boolean
|
|
isLocked - Boolean
|
|
nominationDate - Date
|
|
fuelZoneSet - FuelZoneSet
|
|
cargoName - CargoName
|
|
vessel - Vessel
|
|
voyageEstimate - VoyageEstimate
|
|
counterparty - AddressBook
|
|
voyage - Voyage
|
|
vesselVettings - [VesselVetting]
|
|
cargos - [Cargo]
|
|
fixtureRemarks - [FixtureRemark]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"lighteringVoyageNoString": "abc123",
"customFieldByID": Any,
"customField": Any,
"lighteringInfo": "abc123",
"fixtureNo": "abc123",
"fixtureDate": "2007-12-03",
"estimateID": "abc123",
"charterPartyDate": "2007-12-03",
"vesselCode": "abc123",
"voyRef": "xyz789",
"commenceGmt": "2007-12-03",
"schedulingStatus": "xyz789",
"oprType": "abc123",
"portExpCap": 987.65,
"chartererShortName": "abc123",
"cargo": "abc123",
"lighteringVoyageNo": 123,
"oCNonSurplus": true,
"oCSurplus": true,
"cOPBackhaul": true,
"coLoad": false,
"vettingFlags": 123,
"companyCode": "abc123",
"charteringCoordinator": "abc123",
"useCOAFreight": true,
"lockTCE": false,
"autoCalcByLiftQty": true,
"useVschedItin": false,
"tcoEstimate": true,
"lowSulfurOnly": true,
"capNoRebills": true,
"consecutive": true,
"bunkerOwner": false,
"manualDailyCost": false,
"manualAddCommRate": false,
"fifoBunkers": false,
"benchmark": true,
"fixBunkers": false,
"cancelled": true,
"transshipment": true,
"vettingFail": false,
"addCommInclOPA": true,
"forwardCurve": true,
"thirdParty": false,
"onSubs": true,
"tcoExchRateManual": true,
"lockProfit": false,
"devTceCalc": false,
"inProgressEst": true,
"piracyDisabled": false,
"piracyEnabled": false,
"estTemplate": false,
"estDeviation": false,
"tcoEstTripTc": true,
"lastTciVoyage": false,
"isDeviationBaseline": true,
"voyageNo": 123,
"vesselLaycanFrom": "2007-12-03",
"vesselLaycanTo": "2007-12-03",
"fuelZoneSetID": 123,
"enableFNCoaComponentCalc": false,
"tceFromTarget": false,
"openEstimate": true,
"disableBackupFuelTypes": true,
"waitForLaycan": true,
"useScrubbers": true,
"hasManualTciCommRate": false,
"hasManuallyOverriddenMarketTcRate": true,
"tcoBenchmark": true,
"isLocked": true,
"nominationDate": "2007-12-03",
"fuelZoneSet": FuelZoneSet,
"cargoName": CargoName,
"vessel": Vessel,
"voyageEstimate": VoyageEstimate,
"counterparty": AddressBook,
"voyage": Voyage,
"vesselVettings": [VesselVetting],
"cargos": [Cargo],
"fixtureRemarks": [FixtureRemark],
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
FixtureFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - FixtureFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": FixtureFormQueryWhere
}
FixtureFormQueryWhere
Fields
Example
{
"and": [FixtureFormQueryWhere],
"or": [FixtureFormQueryWhere],
"rawExpression": "abc123",
"fixtureNo": StringWhereValueExpression,
"fixtureDate": DateWhereValueExpression,
"estimateID": StringWhereValueExpression,
"charterPartyDate": DateWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"voyRef": StringWhereValueExpression,
"commenceGmt": DateWhereValueExpression,
"schedulingStatus": StringWhereValueExpression,
"oprType": StringWhereValueExpression,
"portExpCap": NumberWhereValueExpression,
"chartererShortName": StringWhereValueExpression,
"cargo": StringWhereValueExpression,
"lighteringVoyageNo": NumberWhereValueExpression,
"oCNonSurplus": BoolWhereValueExpression,
"oCSurplus": BoolWhereValueExpression,
"cOPBackhaul": BoolWhereValueExpression,
"coLoad": BoolWhereValueExpression,
"vettingFlags": NumberWhereValueExpression,
"companyCode": StringWhereValueExpression,
"charteringCoordinator": StringWhereValueExpression,
"useCOAFreight": BoolWhereValueExpression,
"lockTCE": BoolWhereValueExpression,
"autoCalcByLiftQty": BoolWhereValueExpression,
"useVschedItin": BoolWhereValueExpression,
"tcoEstimate": BoolWhereValueExpression,
"lowSulfurOnly": BoolWhereValueExpression,
"capNoRebills": BoolWhereValueExpression,
"consecutive": BoolWhereValueExpression,
"bunkerOwner": BoolWhereValueExpression,
"manualDailyCost": BoolWhereValueExpression,
"manualAddCommRate": BoolWhereValueExpression,
"fifoBunkers": BoolWhereValueExpression,
"benchmark": BoolWhereValueExpression,
"fixBunkers": BoolWhereValueExpression,
"cancelled": BoolWhereValueExpression,
"transshipment": BoolWhereValueExpression,
"vettingFail": BoolWhereValueExpression,
"addCommInclOPA": BoolWhereValueExpression,
"forwardCurve": BoolWhereValueExpression,
"thirdParty": BoolWhereValueExpression,
"onSubs": BoolWhereValueExpression,
"tcoExchRateManual": BoolWhereValueExpression,
"lockProfit": BoolWhereValueExpression,
"devTceCalc": BoolWhereValueExpression,
"inProgressEst": BoolWhereValueExpression,
"piracyDisabled": BoolWhereValueExpression,
"piracyEnabled": BoolWhereValueExpression,
"estTemplate": BoolWhereValueExpression,
"estDeviation": BoolWhereValueExpression,
"tcoEstTripTc": BoolWhereValueExpression,
"lastTciVoyage": BoolWhereValueExpression,
"isDeviationBaseline": BoolWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"vesselLaycanFrom": DateWhereValueExpression,
"vesselLaycanTo": DateWhereValueExpression,
"fuelZoneSetID": NumberWhereValueExpression,
"enableFNCoaComponentCalc": BoolWhereValueExpression,
"tceFromTarget": BoolWhereValueExpression,
"openEstimate": BoolWhereValueExpression,
"disableBackupFuelTypes": BoolWhereValueExpression,
"waitForLaycan": BoolWhereValueExpression,
"useScrubbers": BoolWhereValueExpression,
"hasManualTciCommRate": BoolWhereValueExpression,
"hasManuallyOverriddenMarketTcRate": BoolWhereValueExpression,
"tcoBenchmark": BoolWhereValueExpression,
"isLocked": BoolWhereValueExpression,
"nominationDate": DateWhereValueExpression,
"fuelZoneSet": FuelZoneSetFormQueryWhere,
"cargoName": CargoNameFormQueryWhere,
"vessel": VesselFormQueryWhere,
"voyageEstimate": VoyageEstimateFormQueryWhere,
"counterparty": AddressBookFormQueryWhere,
"voyage": VoyageFormQueryWhere
}
FixtureRelationships
Fields
| Field Name | Description |
|---|---|
fuelZoneSet - RelationshipDefinition
|
|
cargoName - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
voyageEstimate - RelationshipDefinition
|
|
counterparty - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
vesselVettings - RelationshipDefinition
|
|
cargos - RelationshipDefinition
|
|
fixtureRemarks - RelationshipDefinition
|
Example
{
"fuelZoneSet": RelationshipDefinition,
"cargoName": RelationshipDefinition,
"vessel": RelationshipDefinition,
"voyageEstimate": RelationshipDefinition,
"counterparty": RelationshipDefinition,
"voyage": RelationshipDefinition,
"vesselVettings": RelationshipDefinition,
"cargos": RelationshipDefinition,
"fixtureRemarks": RelationshipDefinition
}
FixtureRemark
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
fixtureNo - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
categoryInternal - String
|
|
type - String
|
|
subTypeInternal - Int
|
|
remark - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
fixture - Fixture
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"fixtureNo": "abc123",
"customFieldByID": Any,
"customField": Any,
"categoryInternal": "abc123",
"type": "xyz789",
"subTypeInternal": 123,
"remark": "xyz789",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUser": "xyz789",
"fixture": Fixture,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
FixtureRemarkCategoryInternalEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
FixtureRemarkCategoryInternalEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - FixtureRemarkCategoryInternalEnum
|
|
isNot - FixtureRemarkCategoryInternalEnum
|
|
isIn - [FixtureRemarkCategoryInternalEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
FixtureRemarkFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - FixtureRemarkFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": FixtureRemarkFormQueryWhere
}
FixtureRemarkFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [FixtureRemarkFormQueryWhere!]
|
|
or - [FixtureRemarkFormQueryWhere!]
|
|
rawExpression - String
|
|
fixtureNo - StringWhereValueExpression
|
|
categoryInternal - FixtureRemarkCategoryInternalEnumValueExpression
|
|
type - FixtureRemarkTypeEnumValueExpression
|
|
subTypeInternal - NumberWhereValueExpression
|
|
remark - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
fixture - FixtureFormQueryWhere
|
Example
{
"and": [FixtureRemarkFormQueryWhere],
"or": [FixtureRemarkFormQueryWhere],
"rawExpression": "abc123",
"fixtureNo": StringWhereValueExpression,
"categoryInternal": FixtureRemarkCategoryInternalEnumValueExpression,
"type": FixtureRemarkTypeEnumValueExpression,
"subTypeInternal": NumberWhereValueExpression,
"remark": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"fixture": FixtureFormQueryWhere
}
FixtureRemarkRelationships
Fields
| Field Name | Description |
|---|---|
fixture - RelationshipDefinition
|
Example
{"fixture": RelationshipDefinition}
FixtureRemarkTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
FixtureRemarkTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - FixtureRemarkTypeEnum
|
|
isNot - FixtureRemarkTypeEnum
|
|
isIn - [FixtureRemarkTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
FleetMemberUpdateRequest
FleetmapCoordinates
FleetmapRootQuery
Fields
| Field Name | Description |
|---|---|
vessels - [FleetmapVessel]
|
|
Arguments
|
|
vessel - FleetmapVessel
|
|
Arguments
|
|
route - [FleetmapRoutePosition]
|
|
Arguments
|
|
aisRoute - [FleetmapRoutePosition]
|
|
Arguments
|
|
Example
{
"vessels": [FleetmapVessel],
"vessel": FleetmapVessel,
"route": [FleetmapRoutePosition],
"aisRoute": [FleetmapRoutePosition]
}
FleetmapRoutePosition
Example
{
"type": "abc123",
"coordinates": FleetmapCoordinates,
"timestamp": "xyz789",
"voyageNo": 987,
"portNo": 123,
"portName": "abc123",
"portFunc": "abc123",
"heading": 123.45
}
FleetmapVessel
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
vesselCode - String!
|
|
voyageNo - Int!
|
|
imo - String
|
|
coordinates - FleetmapCoordinates!
|
|
timestamp - String!
|
|
heading - Float
|
|
source - String!
|
|
loadPorts - [String]
|
|
dischargePorts - [String]
|
|
nextPort - String
|
|
nextPortArrivalLocal - String
|
|
status - String!
|
|
cargoShortNamesList - String
|
|
blCargoQuantity - Float
|
|
cargoUnit - String
|
|
voyageCommenceLocal - String
|
|
voyageCompleteLocal - String
|
|
counterparty - String
|
|
oprType - String
|
|
cargoes - [FleetmapVesselCargo]
|
Example
{
"name": "xyz789",
"vesselCode": "xyz789",
"voyageNo": 123,
"imo": "abc123",
"coordinates": FleetmapCoordinates,
"timestamp": "xyz789",
"heading": 123.45,
"source": "xyz789",
"loadPorts": ["abc123"],
"dischargePorts": ["abc123"],
"nextPort": "xyz789",
"nextPortArrivalLocal": "abc123",
"status": "abc123",
"cargoShortNamesList": "abc123",
"blCargoQuantity": 123.45,
"cargoUnit": "abc123",
"voyageCommenceLocal": "xyz789",
"voyageCompleteLocal": "xyz789",
"counterparty": "xyz789",
"oprType": "abc123",
"cargoes": [FleetmapVesselCargo]
}
FleetmapVesselCargo
FleetmapVesselCounterparty
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
Form
Fields
| Field Name | Description |
|---|---|
statusLabel - String
|
|
formGUID - String
|
|
formTemplateGUID - String
|
|
portOrPassage - String
|
|
submitTime - Date
|
|
date - Date
|
|
lastUser - String
|
|
formData - String
|
|
formErrors - String
|
|
status - String
|
|
hasErrors - Int
|
|
history - String
|
|
receivedGMT - Date
|
|
voyageNo - Int
|
|
portNo - Int
|
|
validateNewItineraryLen - Boolean
|
|
showAllUpcomingPorts - Boolean
|
|
allowItineraryUpdate - Boolean
|
|
lockVoyageLeg - Boolean
|
|
batchApproval - Boolean
|
|
preNotified - Boolean
|
|
modifiedOnboard - Boolean
|
|
hasShareError - Boolean
|
|
appliedLocally - Boolean
|
|
runBasicValidation - Boolean
|
|
formGroupFlags - Int
|
|
vesselCode - String
|
|
portCallSeq - Int
|
|
contextInfo - String
|
|
lastUpdateGMT - Date
|
|
portData - Port
|
|
vesselData - Vessel
|
|
itineraryLine - VoyageItinerary
|
|
template - FormTemplate
|
|
voyageData - Voyage
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"statusLabel": "abc123",
"formGUID": "xyz789",
"formTemplateGUID": "xyz789",
"portOrPassage": "xyz789",
"submitTime": "2007-12-03",
"date": "2007-12-03",
"lastUser": "xyz789",
"formData": "abc123",
"formErrors": "xyz789",
"status": "xyz789",
"hasErrors": 123,
"history": "xyz789",
"receivedGMT": "2007-12-03",
"voyageNo": 123,
"portNo": 987,
"validateNewItineraryLen": true,
"showAllUpcomingPorts": false,
"allowItineraryUpdate": true,
"lockVoyageLeg": false,
"batchApproval": true,
"preNotified": true,
"modifiedOnboard": true,
"hasShareError": true,
"appliedLocally": false,
"runBasicValidation": false,
"formGroupFlags": 987,
"vesselCode": "abc123",
"portCallSeq": 987,
"contextInfo": "abc123",
"lastUpdateGMT": "2007-12-03",
"portData": Port,
"vesselData": Vessel,
"itineraryLine": VoyageItinerary,
"template": FormTemplate,
"voyageData": Voyage,
"_id": "abc123",
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
FormCommitAction
Description
The type of action to take for this dataform operation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Merge"
FormFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - FormFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": FormFormQueryWhere
}
FormFormQueryWhere
Fields
Example
{
"and": [FormFormQueryWhere],
"or": [FormFormQueryWhere],
"rawExpression": "xyz789",
"formGUID": StringWhereValueExpression,
"formTemplateGUID": StringWhereValueExpression,
"portOrPassage": FormPortOrPassageEnumValueExpression,
"submitTime": DateWhereValueExpression,
"date": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"formData": StringWhereValueExpression,
"formErrors": StringWhereValueExpression,
"status": FormStatusEnumValueExpression,
"hasErrors": NumberWhereValueExpression,
"history": StringWhereValueExpression,
"receivedGMT": DateWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"validateNewItineraryLen": BoolWhereValueExpression,
"showAllUpcomingPorts": BoolWhereValueExpression,
"allowItineraryUpdate": BoolWhereValueExpression,
"lockVoyageLeg": BoolWhereValueExpression,
"batchApproval": BoolWhereValueExpression,
"preNotified": BoolWhereValueExpression,
"modifiedOnboard": BoolWhereValueExpression,
"hasShareError": BoolWhereValueExpression,
"appliedLocally": BoolWhereValueExpression,
"runBasicValidation": BoolWhereValueExpression,
"formGroupFlags": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"portCallSeq": NumberWhereValueExpression,
"contextInfo": StringWhereValueExpression,
"lastUpdateGMT": DateWhereValueExpression,
"portData": PortFormQueryWhere,
"vesselData": VesselFormQueryWhere,
"itineraryLine": VoyageItineraryFormQueryWhere,
"template": FormTemplateFormQueryWhere,
"voyageData": VoyageFormQueryWhere
}
FormOperationRequest
Fields
| Input Field | Description |
|---|---|
formId - String
|
|
key - [Any]
|
|
commitAction - FormCommitAction
|
|
values - Json
|
Example
{
"formId": "xyz789",
"key": [Any],
"commitAction": "Merge",
"values": Json
}
FormPortOrPassageEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
FormPortOrPassageEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - FormPortOrPassageEnum
|
|
isNot - FormPortOrPassageEnum
|
|
isIn - [FormPortOrPassageEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
FormQueryRequest
Fields
| Input Field | Description |
|---|---|
rootFormId - String!
|
|
fields - [String]
|
|
filterExpression - String
|
|
limit - Int
|
|
offset - Int
|
|
ordering - [Ordering]
|
|
querySettings - Json
|
|
datalakeSchema - Boolean
|
|
formulaFields - [FormulaField]
|
|
aggregators - [DataAggregator]
|
Example
{
"rootFormId": "xyz789",
"fields": ["abc123"],
"filterExpression": "abc123",
"limit": 987,
"offset": 987,
"ordering": [Ordering],
"querySettings": Json,
"datalakeSchema": false,
"formulaFields": [FormulaField],
"aggregators": [DataAggregator]
}
FormRelationships
Fields
| Field Name | Description |
|---|---|
portData - RelationshipDefinition
|
|
vesselData - RelationshipDefinition
|
|
itineraryLine - RelationshipDefinition
|
|
template - RelationshipDefinition
|
|
voyageData - RelationshipDefinition
|
|
currentCommencedVoyage - RelationshipDefinition
|
Example
{
"portData": RelationshipDefinition,
"vesselData": RelationshipDefinition,
"itineraryLine": RelationshipDefinition,
"template": RelationshipDefinition,
"voyageData": RelationshipDefinition,
"currentCommencedVoyage": RelationshipDefinition
}
FormRootMutation
Fields
| Field Name | Description |
|---|---|
publish - ConnectForm
|
|
Arguments
|
|
tagForm - ConnectForm
|
|
Arguments
|
|
untagForm - ConnectForm
|
|
Arguments
|
|
apply - ConnectForm
|
|
Arguments
|
|
reject - ConnectForm
|
|
Arguments
|
|
fail - ConnectForm
|
|
Arguments
|
|
reset - ConnectForm
|
|
Arguments
|
|
deleteDraft - Boolean!
|
|
Arguments
|
|
ensureTag - ConnectTag
|
|
Arguments
|
|
Example
{
"publish": ConnectForm,
"tagForm": ConnectForm,
"untagForm": ConnectForm,
"apply": ConnectForm,
"reject": ConnectForm,
"fail": ConnectForm,
"reset": ConnectForm,
"deleteDraft": true,
"ensureTag": ConnectTag
}
FormRootQuery
Fields
| Field Name | Description |
|---|---|
form - ConnectForm
|
|
Arguments
|
|
forms - [ConnectForm]
|
|
Arguments
|
|
tags - [ConnectTag!]
|
|
Arguments
|
|
tag - ConnectTag
|
|
Arguments
|
|
Example
{
"form": ConnectForm,
"forms": [ConnectForm],
"tags": [ConnectTag],
"tag": ConnectTag
}
FormStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Pending"
FormStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - FormStatusEnum
|
|
isNot - FormStatusEnum
|
|
isIn - [FormStatusEnum]
|
Example
{"is": "Pending", "isNot": "Pending", "isIn": ["Pending"]}
FormTagInput
Fields
| Input Field | Description |
|---|---|
formId - String!
|
|
tags - [String!]!
|
Example
{
"formId": "xyz789",
"tags": ["xyz789"]
}
FormTemplate
Fields
| Field Name | Description |
|---|---|
formTemplateGUID - String
|
|
title - String
|
|
portOrPassage - String
|
|
approvalRequired - Int
|
|
formDefinition - String
|
|
reportDefinition - String
|
|
disallowResubmit - Int
|
|
listField - String
|
|
hidden - Int
|
|
submitBeforeCommence - Int
|
|
allowEarlySubmit - Boolean
|
|
agentOnly - Boolean
|
|
isRequired - Boolean
|
|
isBerthLevel - Boolean
|
|
isCargoLevel - Boolean
|
|
allowMultiple - Boolean
|
|
takeSnapshotOnSubmission - Boolean
|
|
keepHiddenFieldPosition - Boolean
|
|
isFobVoyageInstruction - Boolean
|
|
flags - Int
|
|
displayChiefEngineer - Int
|
|
masterIdentifier - String
|
|
standardForm - Int
|
|
standardFormVersionNo - String
|
|
reportType - String
|
|
lastUpdateGMT - Date
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"formTemplateGUID": "abc123",
"title": "xyz789",
"portOrPassage": "xyz789",
"approvalRequired": 987,
"formDefinition": "abc123",
"reportDefinition": "xyz789",
"disallowResubmit": 987,
"listField": "abc123",
"hidden": 987,
"submitBeforeCommence": 123,
"allowEarlySubmit": false,
"agentOnly": true,
"isRequired": false,
"isBerthLevel": false,
"isCargoLevel": false,
"allowMultiple": true,
"takeSnapshotOnSubmission": false,
"keepHiddenFieldPosition": true,
"isFobVoyageInstruction": false,
"flags": 123,
"displayChiefEngineer": 123,
"masterIdentifier": "xyz789",
"standardForm": 123,
"standardFormVersionNo": "abc123",
"reportType": "abc123",
"lastUpdateGMT": "2007-12-03",
"_id": "xyz789",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
FormTemplateFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - FormTemplateFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": FormTemplateFormQueryWhere
}
FormTemplateFormQueryWhere
Fields
Example
{
"and": [FormTemplateFormQueryWhere],
"or": [FormTemplateFormQueryWhere],
"rawExpression": "abc123",
"formTemplateGUID": StringWhereValueExpression,
"title": StringWhereValueExpression,
"portOrPassage": FormTemplatePortOrPassageEnumValueExpression,
"approvalRequired": NumberWhereValueExpression,
"formDefinition": StringWhereValueExpression,
"reportDefinition": StringWhereValueExpression,
"disallowResubmit": NumberWhereValueExpression,
"listField": StringWhereValueExpression,
"hidden": NumberWhereValueExpression,
"submitBeforeCommence": NumberWhereValueExpression,
"allowEarlySubmit": BoolWhereValueExpression,
"agentOnly": BoolWhereValueExpression,
"isRequired": BoolWhereValueExpression,
"isBerthLevel": BoolWhereValueExpression,
"isCargoLevel": BoolWhereValueExpression,
"allowMultiple": BoolWhereValueExpression,
"takeSnapshotOnSubmission": BoolWhereValueExpression,
"keepHiddenFieldPosition": BoolWhereValueExpression,
"isFobVoyageInstruction": BoolWhereValueExpression,
"flags": NumberWhereValueExpression,
"displayChiefEngineer": NumberWhereValueExpression,
"masterIdentifier": StringWhereValueExpression,
"standardForm": NumberWhereValueExpression,
"standardFormVersionNo": StringWhereValueExpression,
"reportType": FormTemplateReportTypeEnumValueExpression,
"lastUpdateGMT": DateWhereValueExpression
}
FormTemplatePortOrPassageEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
FormTemplatePortOrPassageEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - FormTemplatePortOrPassageEnum
|
|
isNot - FormTemplatePortOrPassageEnum
|
|
isIn - [FormTemplatePortOrPassageEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
FormTemplateReportTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Other"
FormTemplateReportTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - FormTemplateReportTypeEnum
|
|
isNot - FormTemplateReportTypeEnum
|
|
isIn - [FormTemplateReportTypeEnum]
|
Example
{"is": "Other", "isNot": "Other", "isIn": ["Other"]}
FormsQueryType
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator]
}
FormulaField
FreightInvoice
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
transNo - Int
|
|
referenceName - String
|
|
marketFuelPrice - Float
|
|
operationsInvoice - OperationsInvoice
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 123,
"transNo": 987,
"referenceName": "xyz789",
"marketFuelPrice": 123.45,
"operationsInvoice": OperationsInvoice,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
FreightInvoiceFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - FreightInvoiceFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": FreightInvoiceFormQueryWhere
}
FreightInvoiceFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [FreightInvoiceFormQueryWhere!]
|
|
or - [FreightInvoiceFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
transNo - NumberWhereValueExpression
|
|
referenceName - StringWhereValueExpression
|
|
marketFuelPrice - NumberWhereValueExpression
|
|
operationsInvoice - OperationsInvoiceFormQueryWhere
|
Example
{
"and": [FreightInvoiceFormQueryWhere],
"or": [FreightInvoiceFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"transNo": NumberWhereValueExpression,
"referenceName": StringWhereValueExpression,
"marketFuelPrice": NumberWhereValueExpression,
"operationsInvoice": OperationsInvoiceFormQueryWhere
}
FreightInvoiceRelationships
Fields
| Field Name | Description |
|---|---|
operationsInvoice - RelationshipDefinition
|
Example
{"operationsInvoice": RelationshipDefinition}
FreightTerm
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
type - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
isInactive - Boolean
|
|
code - String
|
|
description - String
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
status - String
|
|
isRate - Boolean
|
|
isLumpsum - Boolean
|
|
isPercent - Boolean
|
|
onOutturn - Boolean
|
|
onDeadfreight - Boolean
|
|
onBooking - Boolean
|
|
isScaleTable - Boolean
|
|
flags - Int
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"type": "abc123",
"customFieldByID": Any,
"customField": Any,
"isInactive": true,
"code": "xyz789",
"description": "xyz789",
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"status": "abc123",
"isRate": true,
"isLumpsum": true,
"isPercent": false,
"onOutturn": false,
"onDeadfreight": false,
"onBooking": true,
"isScaleTable": false,
"flags": 987,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
FreightTermFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - FreightTermFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": FreightTermFormQueryWhere
}
FreightTermFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [FreightTermFormQueryWhere!]
|
|
or - [FreightTermFormQueryWhere!]
|
|
rawExpression - String
|
|
code - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
status - StringWhereValueExpression
|
|
isRate - BoolWhereValueExpression
|
|
isLumpsum - BoolWhereValueExpression
|
|
isPercent - BoolWhereValueExpression
|
|
onOutturn - BoolWhereValueExpression
|
|
onDeadfreight - BoolWhereValueExpression
|
|
onBooking - BoolWhereValueExpression
|
|
isScaleTable - BoolWhereValueExpression
|
|
flags - NumberWhereValueExpression
|
Example
{
"and": [FreightTermFormQueryWhere],
"or": [FreightTermFormQueryWhere],
"rawExpression": "abc123",
"code": StringWhereValueExpression,
"description": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"status": StringWhereValueExpression,
"isRate": BoolWhereValueExpression,
"isLumpsum": BoolWhereValueExpression,
"isPercent": BoolWhereValueExpression,
"onOutturn": BoolWhereValueExpression,
"onDeadfreight": BoolWhereValueExpression,
"onBooking": BoolWhereValueExpression,
"isScaleTable": BoolWhereValueExpression,
"flags": NumberWhereValueExpression
}
FuelEmissionsFactorsSet
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
iD - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
fuelType - String
|
|
productWtTCO2EqEmissionsByEnergy - Float
|
|
productTtWCO2EqEmissionsByMass - Float
|
|
productTtWCO2EmissionsByMass - Float
|
|
productLowerCalorificValue - Float
|
|
biofuelWtTCO2EqEmissionsByEnergy - Float
|
|
biofuelTtWCO2EqEmissionsByMass - Float
|
|
biofuelTtWCO2EmissionsByMass - Float
|
|
biofuelLowerCalorificValue - Float
|
|
biofuelQtyPercent - Float
|
|
fossilWtTCO2EqEmissionsByEnergy - Float
|
|
fossilTtWCO2EqEmissionsByMass - Float
|
|
fossilTtWCO2EmissionsByMass - Float
|
|
fossilLowerCalorificValue - Float
|
|
fossilQtyPercent - Float
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"iD": 987,
"customFieldByID": Any,
"customField": Any,
"fuelType": "abc123",
"productWtTCO2EqEmissionsByEnergy": 123.45,
"productTtWCO2EqEmissionsByMass": 987.65,
"productTtWCO2EmissionsByMass": 123.45,
"productLowerCalorificValue": 123.45,
"biofuelWtTCO2EqEmissionsByEnergy": 123.45,
"biofuelTtWCO2EqEmissionsByMass": 123.45,
"biofuelTtWCO2EmissionsByMass": 123.45,
"biofuelLowerCalorificValue": 123.45,
"biofuelQtyPercent": 987.65,
"fossilWtTCO2EqEmissionsByEnergy": 987.65,
"fossilTtWCO2EqEmissionsByMass": 987.65,
"fossilTtWCO2EmissionsByMass": 987.65,
"fossilLowerCalorificValue": 987.65,
"fossilQtyPercent": 123.45,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
FuelEmissionsFactorsSetFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - FuelEmissionsFactorsSetFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": FuelEmissionsFactorsSetFormQueryWhere
}
FuelEmissionsFactorsSetFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [FuelEmissionsFactorsSetFormQueryWhere!]
|
|
or - [FuelEmissionsFactorsSetFormQueryWhere!]
|
|
rawExpression - String
|
|
iD - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
productWtTCO2EqEmissionsByEnergy - NumberWhereValueExpression
|
|
productTtWCO2EqEmissionsByMass - NumberWhereValueExpression
|
|
productTtWCO2EmissionsByMass - NumberWhereValueExpression
|
|
productLowerCalorificValue - NumberWhereValueExpression
|
|
biofuelWtTCO2EqEmissionsByEnergy - NumberWhereValueExpression
|
|
biofuelTtWCO2EqEmissionsByMass - NumberWhereValueExpression
|
|
biofuelTtWCO2EmissionsByMass - NumberWhereValueExpression
|
|
biofuelLowerCalorificValue - NumberWhereValueExpression
|
|
biofuelQtyPercent - NumberWhereValueExpression
|
|
fossilWtTCO2EqEmissionsByEnergy - NumberWhereValueExpression
|
|
fossilTtWCO2EqEmissionsByMass - NumberWhereValueExpression
|
|
fossilTtWCO2EmissionsByMass - NumberWhereValueExpression
|
|
fossilLowerCalorificValue - NumberWhereValueExpression
|
|
fossilQtyPercent - NumberWhereValueExpression
|
Example
{
"and": [FuelEmissionsFactorsSetFormQueryWhere],
"or": [FuelEmissionsFactorsSetFormQueryWhere],
"rawExpression": "xyz789",
"iD": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"productWtTCO2EqEmissionsByEnergy": NumberWhereValueExpression,
"productTtWCO2EqEmissionsByMass": NumberWhereValueExpression,
"productTtWCO2EmissionsByMass": NumberWhereValueExpression,
"productLowerCalorificValue": NumberWhereValueExpression,
"biofuelWtTCO2EqEmissionsByEnergy": NumberWhereValueExpression,
"biofuelTtWCO2EqEmissionsByMass": NumberWhereValueExpression,
"biofuelTtWCO2EmissionsByMass": NumberWhereValueExpression,
"biofuelLowerCalorificValue": NumberWhereValueExpression,
"biofuelQtyPercent": NumberWhereValueExpression,
"fossilWtTCO2EqEmissionsByEnergy": NumberWhereValueExpression,
"fossilTtWCO2EqEmissionsByMass": NumberWhereValueExpression,
"fossilTtWCO2EmissionsByMass": NumberWhereValueExpression,
"fossilLowerCalorificValue": NumberWhereValueExpression,
"fossilQtyPercent": NumberWhereValueExpression
}
FuelLubeType
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
sqlID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
code - String
|
|
description - String
|
|
type - String
|
|
group - Int
|
|
trackSulfurPercentage - Int
|
|
calorificValue - Float
|
|
fuelSulfurGrade - String
|
|
cO2EmissionsFactor - Float
|
|
extraFreightRateTerm - String
|
|
extraFreightLumpsumTerm - String
|
|
backupFuelType - String
|
|
tankToWakeCH4EmissionsFactor - Float
|
|
tankToWakeN2OEmissionsFactor - Float
|
|
lowerCalorificValue - Float
|
|
wellToTankCO2Equivalent - Float
|
|
tankToWakeCO2Equivalent - Float
|
|
lngEquivalent - Boolean
|
|
supportLiftingFactors - Boolean
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"sqlID": 987,
"customFieldByID": Any,
"customField": Any,
"code": "xyz789",
"description": "xyz789",
"type": "xyz789",
"group": 123,
"trackSulfurPercentage": 123,
"calorificValue": 987.65,
"fuelSulfurGrade": "xyz789",
"cO2EmissionsFactor": 123.45,
"extraFreightRateTerm": "xyz789",
"extraFreightLumpsumTerm": "abc123",
"backupFuelType": "xyz789",
"tankToWakeCH4EmissionsFactor": 123.45,
"tankToWakeN2OEmissionsFactor": 123.45,
"lowerCalorificValue": 123.45,
"wellToTankCO2Equivalent": 123.45,
"tankToWakeCO2Equivalent": 987.65,
"lngEquivalent": true,
"supportLiftingFactors": false,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
FuelLubeTypeFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - FuelLubeTypeFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": FuelLubeTypeFormQueryWhere
}
FuelLubeTypeFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [FuelLubeTypeFormQueryWhere!]
|
|
or - [FuelLubeTypeFormQueryWhere!]
|
|
rawExpression - String
|
|
code - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
type - StringWhereValueExpression
|
|
group - NumberWhereValueExpression
|
|
trackSulfurPercentage - NumberWhereValueExpression
|
|
calorificValue - NumberWhereValueExpression
|
|
fuelSulfurGrade - StringWhereValueExpression
|
|
cO2EmissionsFactor - NumberWhereValueExpression
|
|
extraFreightRateTerm - StringWhereValueExpression
|
|
extraFreightLumpsumTerm - StringWhereValueExpression
|
|
backupFuelType - StringWhereValueExpression
|
|
tankToWakeCH4EmissionsFactor - NumberWhereValueExpression
|
|
tankToWakeN2OEmissionsFactor - NumberWhereValueExpression
|
|
lowerCalorificValue - NumberWhereValueExpression
|
|
wellToTankCO2Equivalent - NumberWhereValueExpression
|
|
tankToWakeCO2Equivalent - NumberWhereValueExpression
|
|
lngEquivalent - BoolWhereValueExpression
|
|
supportLiftingFactors - BoolWhereValueExpression
|
Example
{
"and": [FuelLubeTypeFormQueryWhere],
"or": [FuelLubeTypeFormQueryWhere],
"rawExpression": "xyz789",
"code": StringWhereValueExpression,
"description": StringWhereValueExpression,
"type": StringWhereValueExpression,
"group": NumberWhereValueExpression,
"trackSulfurPercentage": NumberWhereValueExpression,
"calorificValue": NumberWhereValueExpression,
"fuelSulfurGrade": StringWhereValueExpression,
"cO2EmissionsFactor": NumberWhereValueExpression,
"extraFreightRateTerm": StringWhereValueExpression,
"extraFreightLumpsumTerm": StringWhereValueExpression,
"backupFuelType": StringWhereValueExpression,
"tankToWakeCH4EmissionsFactor": NumberWhereValueExpression,
"tankToWakeN2OEmissionsFactor": NumberWhereValueExpression,
"lowerCalorificValue": NumberWhereValueExpression,
"wellToTankCO2Equivalent": NumberWhereValueExpression,
"tankToWakeCO2Equivalent": NumberWhereValueExpression,
"lngEquivalent": BoolWhereValueExpression,
"supportLiftingFactors": BoolWhereValueExpression
}
FuelZone
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
sqlID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
ecaID - Int
|
|
fuelType - String
|
|
consumptionType - String
|
|
orderNo - Int
|
|
consRateOnly - Boolean
|
|
inactive - Boolean
|
|
scrubber - Boolean
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
vesselType - String
|
|
vesselCode - String
|
|
fuelZoneSetID - Int
|
|
fuelZoneSet - FuelZoneSet
|
|
port - Port
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"sqlID": 123,
"customFieldByID": Any,
"customField": Any,
"ecaID": 987,
"fuelType": "xyz789",
"consumptionType": "abc123",
"orderNo": 987,
"consRateOnly": true,
"inactive": false,
"scrubber": false,
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"vesselType": "xyz789",
"vesselCode": "xyz789",
"fuelZoneSetID": 987,
"fuelZoneSet": FuelZoneSet,
"port": Port,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
FuelZoneConsumptionTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
FuelZoneConsumptionTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - FuelZoneConsumptionTypeEnum
|
|
isNot - FuelZoneConsumptionTypeEnum
|
|
isIn - [FuelZoneConsumptionTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
FuelZoneFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - FuelZoneFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": FuelZoneFormQueryWhere
}
FuelZoneFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [FuelZoneFormQueryWhere!]
|
|
or - [FuelZoneFormQueryWhere!]
|
|
rawExpression - String
|
|
ecaID - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
consumptionType - FuelZoneConsumptionTypeEnumValueExpression
|
|
orderNo - NumberWhereValueExpression
|
|
consRateOnly - BoolWhereValueExpression
|
|
inactive - BoolWhereValueExpression
|
|
scrubber - BoolWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
vesselType - StringWhereValueExpression
|
|
vesselCode - StringWhereValueExpression
|
|
fuelZoneSetID - NumberWhereValueExpression
|
|
fuelZoneSet - FuelZoneSetFormQueryWhere
|
|
port - PortFormQueryWhere
|
Example
{
"and": [FuelZoneFormQueryWhere],
"or": [FuelZoneFormQueryWhere],
"rawExpression": "abc123",
"ecaID": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"consumptionType": FuelZoneConsumptionTypeEnumValueExpression,
"orderNo": NumberWhereValueExpression,
"consRateOnly": BoolWhereValueExpression,
"inactive": BoolWhereValueExpression,
"scrubber": BoolWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"vesselType": StringWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"fuelZoneSetID": NumberWhereValueExpression,
"fuelZoneSet": FuelZoneSetFormQueryWhere,
"port": PortFormQueryWhere
}
FuelZoneRelationships
Fields
| Field Name | Description |
|---|---|
fuelZoneSet - RelationshipDefinition
|
|
port - RelationshipDefinition
|
Example
{
"fuelZoneSet": RelationshipDefinition,
"port": RelationshipDefinition
}
FuelZoneSet
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
iD - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
name - String
|
|
description - String
|
|
inactive - Boolean
|
|
default - Boolean
|
|
imo2020 - Boolean
|
|
fuelZones - [FuelZone]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"iD": 123,
"customFieldByID": Any,
"customField": Any,
"name": "xyz789",
"description": "abc123",
"inactive": false,
"default": false,
"imo2020": true,
"fuelZones": [FuelZone],
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
FuelZoneSetFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - FuelZoneSetFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": FuelZoneSetFormQueryWhere
}
FuelZoneSetFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [FuelZoneSetFormQueryWhere!]
|
|
or - [FuelZoneSetFormQueryWhere!]
|
|
rawExpression - String
|
|
iD - NumberWhereValueExpression
|
|
name - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
inactive - BoolWhereValueExpression
|
|
default - BoolWhereValueExpression
|
|
imo2020 - BoolWhereValueExpression
|
Example
{
"and": [FuelZoneSetFormQueryWhere],
"or": [FuelZoneSetFormQueryWhere],
"rawExpression": "abc123",
"iD": NumberWhereValueExpression,
"name": StringWhereValueExpression,
"description": StringWhereValueExpression,
"inactive": BoolWhereValueExpression,
"default": BoolWhereValueExpression,
"imo2020": BoolWhereValueExpression
}
FuelZoneSetRelationships
Fields
| Field Name | Description |
|---|---|
fuelZones - RelationshipDefinition
|
Example
{"fuelZones": RelationshipDefinition}
GetFleetmapRouteRequest
GetFleetmapVesselRequest
GetFleetmapVesselsRequest
Fields
| Input Field | Description |
|---|---|
referenceDate - Date
|
|
vesselCodes - [String]
|
|
cargoShortNames - [String]
|
|
tradeAreas - [String]
|
|
counterParties - [FleetmapVesselCounterparty]
|
|
vesselTypes - [String]
|
|
voyageStatusCodes - [String]
|
|
voyageOperationTypes - [String]
|
|
portNos - [Int]
|
|
portAreaRefPortNos - [Int]
|
|
atSea - Boolean
|
|
hoursOutsideEta - Float
|
|
portFuncs - [String]
|
|
disableAisService - Boolean
|
Example
{
"referenceDate": "2007-12-03",
"vesselCodes": ["xyz789"],
"cargoShortNames": ["xyz789"],
"tradeAreas": ["xyz789"],
"counterParties": [FleetmapVesselCounterparty],
"vesselTypes": ["xyz789"],
"voyageStatusCodes": ["abc123"],
"voyageOperationTypes": ["abc123"],
"portNos": [123],
"portAreaRefPortNos": [123],
"atSea": true,
"hoursOutsideEta": 123.45,
"portFuncs": ["xyz789"],
"disableAisService": true
}
GetHistoricalVesselPositionsRequest
Fields
| Input Field | Description |
|---|---|
imo - String!
|
|
hourlyRangeUTC - HistoricalDateRange
|
|
dailyRangeUTC - HistoricalDateRange
|
Example
{
"imo": "xyz789",
"hourlyRangeUTC": HistoricalDateRange,
"dailyRangeUTC": HistoricalDateRange
}
GetInvoiceReportPdfInput
GetInvoiceReportPdfMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": true,
"context": ["xyz789"],
"timestamp": "xyz789",
"originalTimestamp": "abc123",
"intent": "abc123",
"from": "xyz789",
"to": ["xyz789"],
"fromUser": "abc123",
"status": "xyz789",
"approvalStatus": "xyz789",
"objectId": "xyz789",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "abc123",
"previousData": Json,
"comment": "xyz789",
"unmapped": false,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["abc123"],
"parentMessageId": "abc123",
"preResolutionObjectId": "abc123",
"title": "abc123",
"effectiveDate": "xyz789",
"source": "xyz789",
"sourceId": "xyz789",
"threadId": "xyz789",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": true,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
GetLaytimePDFReportsInput
Example
{
"claimId": 987.65,
"includeCalcReport": false,
"includePortDetailsReport": true,
"includeInvoiceReport": false,
"retryCount": 123.45
}
GetLaytimePDFReportsMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "abc123",
"debug": true,
"context": ["abc123"],
"timestamp": "abc123",
"originalTimestamp": "abc123",
"intent": "xyz789",
"from": "abc123",
"to": ["abc123"],
"fromUser": "abc123",
"status": "xyz789",
"approvalStatus": "xyz789",
"objectId": "abc123",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "abc123",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "abc123",
"unmapped": true,
"responseData": Json,
"applyErrors": ["abc123"],
"applyWarnings": ["abc123"],
"parentMessageId": "xyz789",
"preResolutionObjectId": "xyz789",
"title": "abc123",
"effectiveDate": "xyz789",
"source": "abc123",
"sourceId": "xyz789",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": false,
"threadCount": 987,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
GetPermissionsRequest
Fields
| Input Field | Description |
|---|---|
configFlags - [ImosConfigFlags]
|
|
moduleLicenses - [String]
|
|
modulePermissions - [String]
|
Example
{
"configFlags": ["AECompanyName"],
"moduleLicenses": ["xyz789"],
"modulePermissions": ["abc123"]
}
GetPermissionsResponse
Example
{
"moduleConfigFlags": Json,
"moduleLicenses": ["abc123"],
"modulePermissions": [Permission],
"isAdmin": true,
"imosDBSchemaVersion": 987,
"initials": "xyz789"
}
GetPortBunkerPricesRequest
Fields
| Input Field | Description |
|---|---|
portNo - Int!
|
Example
{"portNo": 987}
GetUserPrefs
GetVesselByPartialNameResultsRequest
Fields
| Input Field | Description |
|---|---|
partialVesselName - String
|
Example
{"partialVesselName": "abc123"}
GetVesselsRequest
Example
{
"imos": ["abc123"],
"minLastUpdateUtc": "xyz789",
"maxLastUpdateUtc": "xyz789",
"minDeadweight": 123.45,
"updateRightshipScores": false,
"vesselNames": ["abc123"]
}
GroupMember
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
userNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
groupNo - Int
|
|
user - User
|
|
group - User
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"userNo": 987,
"customFieldByID": Any,
"customField": Any,
"groupNo": 123,
"user": User,
"group": User,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
GroupMemberFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - GroupMemberFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": GroupMemberFormQueryWhere
}
GroupMemberFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [GroupMemberFormQueryWhere!]
|
|
or - [GroupMemberFormQueryWhere!]
|
|
rawExpression - String
|
|
userNo - NumberWhereValueExpression
|
|
groupNo - NumberWhereValueExpression
|
|
user - UserFormQueryWhere
|
|
group - UserFormQueryWhere
|
Example
{
"and": [GroupMemberFormQueryWhere],
"or": [GroupMemberFormQueryWhere],
"rawExpression": "xyz789",
"userNo": NumberWhereValueExpression,
"groupNo": NumberWhereValueExpression,
"user": UserFormQueryWhere,
"group": UserFormQueryWhere
}
GroupMemberRelationships
Fields
| Field Name | Description |
|---|---|
user - RelationshipDefinition
|
|
group - RelationshipDefinition
|
Example
{
"user": RelationshipDefinition,
"group": RelationshipDefinition
}
HeadFixturePurchaseSale
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tcCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
type - String
|
|
counterpartyCompanyNo - Int
|
|
contractDateLocal - Date
|
|
estimatedNetProfit - Float
|
|
vesselDeliveryDateLocal - Date
|
|
paymentTermsCode - String
|
|
paymentDateLocal - Date
|
|
curr - String
|
|
amountCurr - Float
|
|
amountBase - Float
|
|
exchangeRate - Float
|
|
brokerCompanyNo - Int
|
|
commRateType - String
|
|
commRate - Float
|
|
commPaymentDateLocal - Date
|
|
notes - String
|
|
actual - Boolean
|
|
sequenceNo - Int
|
|
counterparty - AddressBook
|
|
broker - AddressBook
|
|
paymentTerm - PaymentTerm
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"tcCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"type": "abc123",
"counterpartyCompanyNo": 987,
"contractDateLocal": "2007-12-03",
"estimatedNetProfit": 987.65,
"vesselDeliveryDateLocal": "2007-12-03",
"paymentTermsCode": "xyz789",
"paymentDateLocal": "2007-12-03",
"curr": "abc123",
"amountCurr": 987.65,
"amountBase": 123.45,
"exchangeRate": 123.45,
"brokerCompanyNo": 987,
"commRateType": "abc123",
"commRate": 987.65,
"commPaymentDateLocal": "2007-12-03",
"notes": "abc123",
"actual": true,
"sequenceNo": 123,
"counterparty": AddressBook,
"broker": AddressBook,
"paymentTerm": PaymentTerm,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
HeadFixturePurchaseSaleCommRateTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
HeadFixturePurchaseSaleCommRateTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - HeadFixturePurchaseSaleCommRateTypeEnum
|
|
isNot - HeadFixturePurchaseSaleCommRateTypeEnum
|
|
isIn - [HeadFixturePurchaseSaleCommRateTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
HeadFixturePurchaseSaleFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - HeadFixturePurchaseSaleFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": HeadFixturePurchaseSaleFormQueryWhere
}
HeadFixturePurchaseSaleFormQueryWhere
Fields
Example
{
"and": [HeadFixturePurchaseSaleFormQueryWhere],
"or": [HeadFixturePurchaseSaleFormQueryWhere],
"rawExpression": "abc123",
"tcCode": StringWhereValueExpression,
"type": HeadFixturePurchaseSaleTypeEnumValueExpression,
"counterpartyCompanyNo": NumberWhereValueExpression,
"contractDateLocal": DateWhereValueExpression,
"estimatedNetProfit": NumberWhereValueExpression,
"vesselDeliveryDateLocal": DateWhereValueExpression,
"paymentTermsCode": StringWhereValueExpression,
"paymentDateLocal": DateWhereValueExpression,
"curr": StringWhereValueExpression,
"amountCurr": NumberWhereValueExpression,
"amountBase": NumberWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"brokerCompanyNo": NumberWhereValueExpression,
"commRateType": HeadFixturePurchaseSaleCommRateTypeEnumValueExpression,
"commRate": NumberWhereValueExpression,
"commPaymentDateLocal": DateWhereValueExpression,
"notes": StringWhereValueExpression,
"actual": BoolWhereValueExpression,
"sequenceNo": NumberWhereValueExpression,
"counterparty": AddressBookFormQueryWhere,
"broker": AddressBookFormQueryWhere,
"paymentTerm": PaymentTermFormQueryWhere
}
HeadFixturePurchaseSaleRelationships
Fields
| Field Name | Description |
|---|---|
counterparty - RelationshipDefinition
|
|
broker - RelationshipDefinition
|
|
paymentTerm - RelationshipDefinition
|
Example
{
"counterparty": RelationshipDefinition,
"broker": RelationshipDefinition,
"paymentTerm": RelationshipDefinition
}
HeadFixturePurchaseSaleTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
HeadFixturePurchaseSaleTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - HeadFixturePurchaseSaleTypeEnum
|
|
isNot - HeadFixturePurchaseSaleTypeEnum
|
|
isIn - [HeadFixturePurchaseSaleTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
HistoricalDateRange
HistoricalVesselPosition
Example
{
"name": "abc123",
"draught": 123.45,
"moveStatus": "xyz789",
"imo": "abc123",
"destination": "abc123",
"destinationTidied": "xyz789",
"coordinates": Coordinates,
"timestamp": "xyz789",
"heading": 987.65,
"speed": 987.65,
"type": "abc123"
}
Holiday
Fields
| Field Name | Description |
|---|---|
year - Int
|
|
code - String
|
|
startDateLocal - Date
|
|
endDateLocal - Date
|
|
countryUNCode - String
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
countryNo - Int
|
|
country - Country
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"year": 987,
"code": "abc123",
"startDateLocal": "2007-12-03",
"endDateLocal": "2007-12-03",
"countryUNCode": "abc123",
"lastUser": "xyz789",
"lastUpdateGmt": "2007-12-03",
"countryNo": 987,
"country": Country,
"_id": "abc123",
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
HolidayFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - HolidayFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": HolidayFormQueryWhere
}
HolidayFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [HolidayFormQueryWhere!]
|
|
or - [HolidayFormQueryWhere!]
|
|
rawExpression - String
|
|
year - NumberWhereValueExpression
|
|
code - StringWhereValueExpression
|
|
startDateLocal - DateWhereValueExpression
|
|
endDateLocal - DateWhereValueExpression
|
|
countryUNCode - StringWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
countryNo - NumberWhereValueExpression
|
|
country - CountryFormQueryWhere
|
Example
{
"and": [HolidayFormQueryWhere],
"or": [HolidayFormQueryWhere],
"rawExpression": "xyz789",
"year": NumberWhereValueExpression,
"code": StringWhereValueExpression,
"startDateLocal": DateWhereValueExpression,
"endDateLocal": DateWhereValueExpression,
"countryUNCode": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"countryNo": NumberWhereValueExpression,
"country": CountryFormQueryWhere
}
HolidayRelationships
Fields
| Field Name | Description |
|---|---|
country - RelationshipDefinition
|
Example
{"country": RelationshipDefinition}
ImosConfigFlags
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AECompanyName"
ImosRootMutation
Fields
| Field Name | Description |
|---|---|
applyUpdateBareboat - ApplyUpdateBareboat_result
|
|
Arguments
|
|
applyNominateCargo - ApplyNominateCargo_result
|
This message publishes a cargo nomination to the specified party |
Arguments
|
|
applyUpdateCargo - ApplyUpdateCargo_result
|
This message publishes cargo handling ETA/ETD updates to the specified party |
Arguments
|
|
applyAddVoyageCargo - ApplyAddVoyageCargo_result
|
This message schedules a cargo on a voyage |
Arguments
|
|
applyUpdateChartOfAccounts - ApplyUpdateChartOfAccounts_result
|
|
Arguments
|
|
applyCreateLaytimeClaim - ApplyCreateLaytimeClaim_result
|
|
Arguments
|
|
applyEditLaytimeClaim - ApplyEditLaytimeClaim_result
|
|
Arguments
|
|
applyGetLaytimePDFReports - ApplyGetLaytimePDFReports_result
|
|
Arguments
|
|
applyUpdateCOA - ApplyUpdateCOA_result
|
|
Arguments
|
|
applyDelay - ApplyDelay_result
|
Submits a veslink Delay transaction |
Arguments
|
|
applyPublishInvoice - ApplyPublishInvoice_result
|
|
Arguments
|
|
applyPortExpenses - ApplyPortExpenses_result
|
Submits a PortExpenses transaction |
Arguments
|
|
applyGetInvoiceReportPdf - ApplyGetInvoiceReportPdf_result
|
|
Arguments
|
|
applyDeleteInvoice - ApplyDeleteInvoice_result
|
|
Arguments
|
|
applyRegionTableUpdate - ApplyRegionTableUpdate_result
|
The message is for updating region data |
Arguments
|
|
applyUpdateTimeCharterCOA - ApplyUpdateTimeCharterCOA_result
|
|
Arguments
|
|
applyUpdateEquipmentContract - ApplyUpdateEquipmentContract_result
|
|
Arguments
|
|
applyUpdateTimeCharter - ApplyUpdateTimeCharter_result
|
|
Arguments
|
|
applyUpdateEquipment - ApplyUpdateEquipment_result
|
A data point representing the current known information about a piece of equipment |
Arguments
|
|
applySCCVoyageEmissions - ApplySCCVoyageEmissions_result
|
|
Arguments
|
|
applyPublishVoyageUpdate - ApplyPublishVoyageUpdate_result
|
The message is for publishing current voyage information to the specified party |
Arguments
|
|
applyScheduleVoyage - ApplyScheduleVoyage_result
|
|
Arguments
|
|
applyUpdateVoyage - ApplyUpdateVoyage_result
|
|
Arguments
|
|
applyPublishActivityReport - ApplyPublishActivityReport_result
|
This message publishes an activity report to the specified party |
Arguments
|
|
applyPublishPosition - ApplyPublishPosition_result
|
|
Arguments
|
|
applyPositionReport - ApplyPositionReport_result
|
Submits a Veslink PositionReport transaction |
Arguments
|
|
applyCopyEstimate - ApplyCopyEstimate_result
|
|
Arguments
|
|
applyUpdateEstimate - ApplyUpdateEstimate_result
|
|
Arguments
|
|
applyCargoHandlingList - ApplyCargoHandlingList_result
|
Submits a veslink CargoHandlingList transaction |
Arguments
|
|
applyEtaEtd - ApplyEtaEtd_result
|
Submits an ETA or ETD update for a portcall |
Arguments
|
|
applyPortActivityList - ApplyPortActivityList_result
|
Submits a veslink PortActivityList transaction |
Arguments
|
|
applyUpcomingPortsList - ApplyUpcomingPortsList_result
|
Submits a veslink UpcomingPortsList transaction |
Arguments
|
|
applyVeslinkForm - ApplyVeslinkForm_result
|
Represents a Veslink form submission |
Arguments
|
|
applyUpdateActivityLog - ApplyUpdateActivityLog_result
|
|
Arguments
|
|
applyUpdateFreightMatrixQuote - ApplyUpdateFreightMatrixQuote_result
|
|
Arguments |
|
applyCalculateVesselValuation - ApplyCalculateVesselValuation_result
|
|
Arguments |
|
applyCargo - ApplyCargoResult
|
|
Arguments
|
|
applyNomination - ApplyNominationResult
|
|
Arguments
|
|
applyInvoice - ApplyInvoiceResult
|
|
Arguments
|
|
Example
{
"applyUpdateBareboat": ApplyUpdateBareboat_result,
"applyNominateCargo": ApplyNominateCargo_result,
"applyUpdateCargo": ApplyUpdateCargo_result,
"applyAddVoyageCargo": ApplyAddVoyageCargo_result,
"applyUpdateChartOfAccounts": ApplyUpdateChartOfAccounts_result,
"applyCreateLaytimeClaim": ApplyCreateLaytimeClaim_result,
"applyEditLaytimeClaim": ApplyEditLaytimeClaim_result,
"applyGetLaytimePDFReports": ApplyGetLaytimePDFReports_result,
"applyUpdateCOA": ApplyUpdateCOA_result,
"applyDelay": ApplyDelay_result,
"applyPublishInvoice": ApplyPublishInvoice_result,
"applyPortExpenses": ApplyPortExpenses_result,
"applyGetInvoiceReportPdf": ApplyGetInvoiceReportPdf_result,
"applyDeleteInvoice": ApplyDeleteInvoice_result,
"applyRegionTableUpdate": ApplyRegionTableUpdate_result,
"applyUpdateTimeCharterCOA": ApplyUpdateTimeCharterCOA_result,
"applyUpdateEquipmentContract": ApplyUpdateEquipmentContract_result,
"applyUpdateTimeCharter": ApplyUpdateTimeCharter_result,
"applyUpdateEquipment": ApplyUpdateEquipment_result,
"applySCCVoyageEmissions": ApplySCCVoyageEmissions_result,
"applyPublishVoyageUpdate": ApplyPublishVoyageUpdate_result,
"applyScheduleVoyage": ApplyScheduleVoyage_result,
"applyUpdateVoyage": ApplyUpdateVoyage_result,
"applyPublishActivityReport": ApplyPublishActivityReport_result,
"applyPublishPosition": ApplyPublishPosition_result,
"applyPositionReport": ApplyPositionReport_result,
"applyCopyEstimate": ApplyCopyEstimate_result,
"applyUpdateEstimate": ApplyUpdateEstimate_result,
"applyCargoHandlingList": ApplyCargoHandlingList_result,
"applyEtaEtd": ApplyEtaEtd_result,
"applyPortActivityList": ApplyPortActivityList_result,
"applyUpcomingPortsList": ApplyUpcomingPortsList_result,
"applyVeslinkForm": ApplyVeslinkForm_result,
"applyUpdateActivityLog": ApplyUpdateActivityLog_result,
"applyUpdateFreightMatrixQuote": ApplyUpdateFreightMatrixQuote_result,
"applyCalculateVesselValuation": ApplyCalculateVesselValuation_result,
"applyCargo": ApplyCargoResult,
"applyNomination": ApplyNominationResult,
"applyInvoice": ApplyInvoiceResult
}
ImosRootQuery
Fields
| Field Name | Description |
|---|---|
_accountAnalysisRelationships - AccountAnalysisRelationships
|
|
accountAnalysis - AccountAnalysis
|
|
Arguments
|
|
accountAnalysisList - [AccountAnalysis]
|
|
Arguments
|
|
_accountingInterfaceSummaryRelationships - AccountingInterfaceSummaryRelationships
|
|
accountingInterfaceSummary - AccountingInterfaceSummary
|
|
Arguments
|
|
accountingInterfaceSummaryList - [AccountingInterfaceSummary]
|
|
Arguments |
|
actDepartment - ActDepartment
|
|
Arguments
|
|
actDepartmentList - [ActDepartment]
|
|
Arguments
|
|
_activityReportBunkerDetailRelationships - ActivityReportBunkerDetailRelationships
|
|
activityReportBunkerDetail - ActivityReportBunkerDetail
|
|
Arguments
|
|
activityReportBunkerDetailList - [ActivityReportBunkerDetail]
|
|
Arguments |
|
_addressBookRelationships - AddressBookRelationships
|
|
addressBook - AddressBook
|
|
Arguments
|
|
addressBookList - [AddressBook]
|
|
Arguments
|
|
_addressBookAgentPortRelationships - AddressBookAgentPortRelationships
|
|
addressBookAgentPort - AddressBookAgentPort
|
|
Arguments
|
|
addressBookAgentPortList - [AddressBookAgentPort]
|
|
Arguments
|
|
_addressBookBankRelationships - AddressBookBankRelationships
|
|
addressBookBank - AddressBookBank
|
|
Arguments
|
|
addressBookBankList - [AddressBookBank]
|
|
Arguments
|
|
_addressBookContactRelationships - AddressBookContactRelationships
|
|
addressBookContact - AddressBookContact
|
|
Arguments
|
|
addressBookContactList - [AddressBookContact]
|
|
Arguments
|
|
_addressBookExpenseRelationships - AddressBookExpenseRelationships
|
|
addressBookExpense - AddressBookExpense
|
|
Arguments
|
|
addressBookExpenseList - [AddressBookExpense]
|
|
Arguments
|
|
_addressBookRegistryAccountRelationships - AddressBookRegistryAccountRelationships
|
|
addressBookRegistryAccount - AddressBookRegistryAccount
|
|
Arguments
|
|
addressBookRegistryAccountList - [AddressBookRegistryAccount]
|
|
Arguments |
|
_addressBookRemarkRelationships - AddressBookRemarkRelationships
|
|
addressBookRemark - AddressBookRemark
|
|
Arguments
|
|
addressBookRemarkList - [AddressBookRemark]
|
|
Arguments
|
|
addressType - AddressType
|
|
Arguments
|
|
addressTypeList - [AddressType]
|
|
Arguments
|
|
_agentAppointmentsRelationships - AgentAppointmentsRelationships
|
|
agentAppointments - AgentAppointments
|
|
Arguments
|
|
agentAppointmentsList - [AgentAppointments]
|
|
Arguments
|
|
agentTypes - AgentTypes
|
|
Arguments
|
|
agentTypesList - [AgentTypes]
|
|
Arguments
|
|
_agreedDistanceRelationships - AgreedDistanceRelationships
|
|
agreedDistance - AgreedDistance
|
|
Arguments
|
|
agreedDistanceList - [AgreedDistance]
|
|
Arguments
|
|
_agreedTransitTimeBunkerRelationships - AgreedTransitTimeBunkerRelationships
|
|
agreedTransitTimeBunker - AgreedTransitTimeBunker
|
|
Arguments
|
|
agreedTransitTimeBunkerList - [AgreedTransitTimeBunker]
|
|
Arguments
|
|
_agreedTransitTimeBunkerDetailRelationships - AgreedTransitTimeBunkerDetailRelationships
|
|
agreedTransitTimeBunkerDetail - AgreedTransitTimeBunkerDetail
|
|
Arguments
|
|
agreedTransitTimeBunkerDetailList - [AgreedTransitTimeBunkerDetail]
|
|
Arguments |
|
_alertRelationships - AlertRelationships
|
|
alert - Alert
|
|
Arguments
|
|
alertList - [Alert]
|
|
Arguments
|
|
attachment - Attachment
|
|
Arguments
|
|
attachmentList - [Attachment]
|
|
Arguments
|
|
_auditRelationships - AuditRelationships
|
|
audit - Audit
|
|
Arguments
|
|
auditList - [Audit]
|
|
Arguments
|
|
_auditActionRelationships - AuditActionRelationships
|
|
auditAction - AuditAction
|
|
Arguments
|
|
auditActionList - [AuditAction]
|
|
Arguments
|
|
_auditDetailRelationships - AuditDetailRelationships
|
|
auditDetail - AuditDetail
|
|
Arguments
|
|
auditDetailList - [AuditDetail]
|
|
Arguments
|
|
_auditRowRelationships - AuditRowRelationships
|
|
auditRow - AuditRow
|
|
Arguments
|
|
auditRowList - [AuditRow]
|
|
Arguments
|
|
_auditTrailRelationships - AuditTrailRelationships
|
|
auditTrail - AuditTrail
|
|
Arguments
|
|
auditTrailList - [AuditTrail]
|
|
Arguments
|
|
_bareboatBrokerRelationships - BareboatBrokerRelationships
|
|
bareboatBroker - BareboatBroker
|
|
Arguments
|
|
bareboatBrokerList - [BareboatBroker]
|
|
Arguments
|
|
_bareboatContractRelationships - BareboatContractRelationships
|
|
bareboatContract - BareboatContract
|
|
Arguments
|
|
bareboatContractList - [BareboatContract]
|
|
Arguments
|
|
bareboatExpense - BareboatExpense
|
|
Arguments
|
|
bareboatExpenseList - [BareboatExpense]
|
|
Arguments
|
|
bareboatHire - BareboatHire
|
|
Arguments
|
|
bareboatHireList - [BareboatHire]
|
|
Arguments
|
|
_bargeRelationships - BargeRelationships
|
|
barge - Barge
|
|
Arguments
|
|
bargeList - [Barge]
|
|
Arguments
|
|
_benchmarkEstimateRelationships - BenchmarkEstimateRelationships
|
|
benchmarkEstimate - BenchmarkEstimate
|
|
Arguments
|
|
benchmarkEstimateList - [BenchmarkEstimate]
|
|
Arguments
|
|
_benchmarkEstimateBunkerRelationships - BenchmarkEstimateBunkerRelationships
|
|
benchmarkEstimateBunker - BenchmarkEstimateBunker
|
|
Arguments
|
|
benchmarkEstimateBunkerList - [BenchmarkEstimateBunker]
|
|
Arguments
|
|
_benchmarkResultRelationships - BenchmarkResultRelationships
|
|
benchmarkResult - BenchmarkResult
|
|
Arguments
|
|
benchmarkResultList - [BenchmarkResult]
|
|
Arguments
|
|
_benchmarkResultBunkerRelationships - BenchmarkResultBunkerRelationships
|
|
benchmarkResultBunker - BenchmarkResultBunker
|
|
Arguments
|
|
benchmarkResultBunkerList - [BenchmarkResultBunker]
|
|
Arguments
|
|
_benchmarkSensitivityRelationships - BenchmarkSensitivityRelationships
|
|
benchmarkSensitivity - BenchmarkSensitivity
|
|
Arguments
|
|
benchmarkSensitivityList - [BenchmarkSensitivity]
|
|
Arguments
|
|
_benchmarkSensitivityBunkerRelationships - BenchmarkSensitivityBunkerRelationships
|
|
benchmarkSensitivityBunker - BenchmarkSensitivityBunker
|
|
Arguments
|
|
benchmarkSensitivityBunkerList - [BenchmarkSensitivityBunker]
|
|
Arguments |
|
_benchmarkSensitivityCalculationRelationships - BenchmarkSensitivityCalculationRelationships
|
|
benchmarkSensitivityCalculation - BenchmarkSensitivityCalculation
|
|
Arguments
|
|
benchmarkSensitivityCalculationList - [BenchmarkSensitivityCalculation]
|
|
Arguments |
|
_berthBlockageRelationships - BerthBlockageRelationships
|
|
berthBlockage - BerthBlockage
|
|
Arguments
|
|
berthBlockageList - [BerthBlockage]
|
|
Arguments
|
|
_billViaRelationships - BillViaRelationships
|
|
_bunkerExposureRelationships - BunkerExposureRelationships
|
|
bunkerExposure - BunkerExposure
|
|
Arguments
|
|
bunkerExposureList - [BunkerExposure]
|
|
Arguments
|
|
_bunkerInquiriesAndPurchasesRelationships - BunkerInquiriesAndPurchasesRelationships
|
|
bunkerInquiriesAndPurchases - BunkerInquiriesAndPurchases
|
|
Arguments
|
|
bunkerInquiriesAndPurchasesList - [BunkerInquiriesAndPurchases]
|
|
Arguments |
|
_bunkerInquiriesAndPurchasesBunkerRelationships - BunkerInquiriesAndPurchasesBunkerRelationships
|
|
bunkerInquiriesAndPurchasesBunker - BunkerInquiriesAndPurchasesBunker
|
|
Arguments
|
|
bunkerInquiriesAndPurchasesBunkerList - [BunkerInquiriesAndPurchasesBunker]
|
|
Arguments |
|
_bunkerInquiriesAndPurchasesDetailRelationships - BunkerInquiriesAndPurchasesDetailRelationships
|
|
bunkerInquiriesAndPurchasesDetail - BunkerInquiriesAndPurchasesDetail
|
|
Arguments
|
|
bunkerInquiriesAndPurchasesDetailList - [BunkerInquiriesAndPurchasesDetail]
|
|
Arguments |
|
_bunkerInvoiceRelationships - BunkerInvoiceRelationships
|
|
bunkerInvoice - BunkerInvoice
|
|
Arguments
|
|
bunkerInvoiceList - [BunkerInvoice]
|
|
Arguments
|
|
_bunkerInvoiceBunkerRelationships - BunkerInvoiceBunkerRelationships
|
|
bunkerInvoiceBunker - BunkerInvoiceBunker
|
|
Arguments
|
|
bunkerInvoiceBunkerList - [BunkerInvoiceBunker]
|
|
Arguments
|
|
_bunkerLiftingDetailRelationships - BunkerLiftingDetailRelationships
|
|
bunkerLiftingDetail - BunkerLiftingDetail
|
|
Arguments
|
|
bunkerLiftingDetailList - [BunkerLiftingDetail]
|
|
Arguments
|
|
_bunkerRequirementRelationships - BunkerRequirementRelationships
|
|
bunkerRequirement - BunkerRequirement
|
|
Arguments
|
|
bunkerRequirementList - [BunkerRequirement]
|
|
Arguments
|
|
_bunkerRequirementBunkerRelationships - BunkerRequirementBunkerRelationships
|
|
bunkerRequirementBunker - BunkerRequirementBunker
|
|
Arguments
|
|
bunkerRequirementBunkerList - [BunkerRequirementBunker]
|
|
Arguments
|
|
_businessRuleRelationships - BusinessRuleRelationships
|
|
businessRule - BusinessRule
|
|
Arguments
|
|
businessRuleList - [BusinessRule]
|
|
Arguments
|
|
_cargoRelationships - CargoRelationships
|
|
cargo - Cargo
|
|
Arguments
|
|
cargoList - [Cargo]
|
|
Arguments
|
|
_cargoBookingRelationships - CargoBookingRelationships
|
|
cargoBooking - CargoBooking
|
|
Arguments
|
|
cargoBookingList - [CargoBooking]
|
|
Arguments
|
|
_cargoBookingProjectedLaytimeInvoiceRelationships - CargoBookingProjectedLaytimeInvoiceRelationships
|
|
_cargoBookingStowageRelationships - CargoBookingStowageRelationships
|
|
cargoBookingStowage - CargoBookingStowage
|
|
Arguments
|
|
cargoBookingStowageList - [CargoBookingStowage]
|
|
Arguments
|
|
_cargoBrokerRelationships - CargoBrokerRelationships
|
|
cargoBroker - CargoBroker
|
|
Arguments
|
|
cargoBrokerList - [CargoBroker]
|
|
Arguments
|
|
_cargoBunkerConsumptionRelationships - CargoBunkerConsumptionRelationships
|
|
cargoBunkerConsumption - CargoBunkerConsumption
|
|
Arguments
|
|
cargoBunkerConsumptionList - [CargoBunkerConsumption]
|
|
Arguments
|
|
cargoExposureBunker - CargoExposureBunker
|
|
Arguments
|
|
cargoExposureBunkerList - [CargoExposureBunker]
|
|
Arguments
|
|
_cargoGradesRelationships - CargoGradesRelationships
|
|
cargoGrades - CargoGrades
|
|
Arguments
|
|
cargoGradesList - [CargoGrades]
|
|
Arguments
|
|
cargoHandlingEventType - CargoHandlingEventType
|
|
Arguments
|
|
cargoHandlingEventTypeList - [CargoHandlingEventType]
|
|
Arguments
|
|
_cargoItineraryRelationships - CargoItineraryRelationships
|
|
cargoItinerary - CargoItinerary
|
|
Arguments
|
|
cargoItineraryList - [CargoItinerary]
|
|
Arguments
|
|
_cargoLinkedTradeRelationships - CargoLinkedTradeRelationships
|
|
cargoLinkedTrade - CargoLinkedTrade
|
|
Arguments
|
|
cargoLinkedTradeList - [CargoLinkedTrade]
|
|
Arguments
|
|
_cargoLoadDischargeOptionRelationships - CargoLoadDischargeOptionRelationships
|
|
cargoLoadDischargeOption - CargoLoadDischargeOption
|
|
Arguments
|
|
cargoLoadDischargeOptionList - [CargoLoadDischargeOption]
|
|
Arguments |
|
_cargoMatchingProgramRelationships - CargoMatchingProgramRelationships
|
|
cargoMatchingProgram - CargoMatchingProgram
|
|
Arguments
|
|
cargoMatchingProgramList - [CargoMatchingProgram]
|
|
Arguments
|
|
_cargoNameRelationships - CargoNameRelationships
|
|
cargoName - CargoName
|
|
Arguments
|
|
cargoNameList - [CargoName]
|
|
Arguments
|
|
_cargoNameAliasRelationships - CargoNameAliasRelationships
|
|
cargoNameAlias - CargoNameAlias
|
|
Arguments
|
|
cargoNameAliasList - [CargoNameAlias]
|
|
Arguments
|
|
_cargoRemarkRelationships - CargoRemarkRelationships
|
|
cargoRemark - CargoRemark
|
|
Arguments
|
|
cargoRemarkList - [CargoRemark]
|
|
Arguments
|
|
_cargoRevenueExpenseRelationships - CargoRevenueExpenseRelationships
|
|
cargoRevenueExpense - CargoRevenueExpense
|
|
Arguments
|
|
cargoRevenueExpenseList - [CargoRevenueExpense]
|
|
Arguments
|
|
_cargoSupplierReceiverRelationships - CargoSupplierReceiverRelationships
|
|
cargoSupplierReceiver - CargoSupplierReceiver
|
|
Arguments
|
|
cargoSupplierReceiverList - [CargoSupplierReceiver]
|
|
Arguments
|
|
_cargoTimeBarRelationships - CargoTimeBarRelationships
|
|
cargoTimeBar - CargoTimeBar
|
|
Arguments
|
|
cargoTimeBarList - [CargoTimeBar]
|
|
Arguments
|
|
cargoType - CargoType
|
|
Arguments
|
|
cargoTypeList - [CargoType]
|
|
Arguments
|
|
_cargoTypeGroupRelationships - CargoTypeGroupRelationships
|
|
cargoTypeGroup - CargoTypeGroup
|
|
Arguments
|
|
cargoTypeGroupList - [CargoTypeGroup]
|
|
Arguments
|
|
_chartOfAccountsRelationships - ChartOfAccountsRelationships
|
|
chartOfAccounts - ChartOfAccounts
|
|
Arguments
|
|
chartOfAccountsList - [ChartOfAccounts]
|
|
Arguments
|
|
_claimRelationships - ClaimRelationships
|
|
claim - Claim
|
|
Arguments
|
|
claimList - [Claim]
|
|
Arguments
|
|
_claimLinkedClaimRelationships - ClaimLinkedClaimRelationships
|
|
_claimNoteRelationships - ClaimNoteRelationships
|
|
claimNote - ClaimNote
|
|
Arguments
|
|
claimNoteList - [ClaimNote]
|
|
Arguments
|
|
_claimProjectedInvoiceRelationships - ClaimProjectedInvoiceRelationships
|
|
claimProjectedInvoice - ClaimProjectedInvoice
|
|
Arguments
|
|
claimProjectedInvoiceList - [ClaimProjectedInvoice]
|
|
Arguments
|
|
_coaRelationships - COARelationships
|
|
coa - COA
|
|
Arguments
|
|
coaList - [COA]
|
|
Arguments
|
|
_coaBrokerRelationships - CoaBrokerRelationships
|
|
coaBroker - CoaBroker
|
|
Arguments
|
|
coaBrokerList - [CoaBroker]
|
|
Arguments
|
|
_coaDetailsRelationships - COADetailsRelationships
|
|
coaDetails - COADetails
|
|
Arguments
|
|
coaDetailsList - [COADetails]
|
|
Arguments
|
|
_coaExtraFreightTermsRelationships - COAExtraFreightTermsRelationships
|
|
coaExtraFreightTerms - COAExtraFreightTerms
|
|
Arguments
|
|
coaExtraFreightTermsList - [COAExtraFreightTerms]
|
|
Arguments
|
|
_coaHierarchyRelationships - CoaHierarchyRelationships
|
|
coaHierarchy - CoaHierarchy
|
|
Arguments
|
|
coaHierarchyList - [CoaHierarchy]
|
|
Arguments
|
|
_coaItineraryRelationships - COAItineraryRelationships
|
|
coaItinerary - COAItinerary
|
|
Arguments
|
|
coaItineraryList - [COAItinerary]
|
|
Arguments
|
|
_coaOptionRelationships - COAOptionRelationships
|
|
coaOption - COAOption
|
|
Arguments
|
|
coaOptionList - [COAOption]
|
|
Arguments
|
|
_coaPeriodRelationships - CoaPeriodRelationships
|
|
coaPeriod - CoaPeriod
|
|
Arguments
|
|
coaPeriodList - [CoaPeriod]
|
|
Arguments
|
|
collabStatus - CollabStatus
|
|
Arguments
|
|
collabStatusList - [CollabStatus]
|
|
Arguments
|
|
_commodityContractRelationships - CommodityContractRelationships
|
|
commodityContract - CommodityContract
|
|
Arguments
|
|
commodityContractList - [CommodityContract]
|
|
Arguments
|
|
_companyRelationships - CompanyRelationships
|
|
company - Company
|
|
Arguments
|
|
companyList - [Company]
|
|
Arguments
|
|
configOptions - ConfigOptions
|
|
Arguments
|
|
configOptionsList - [ConfigOptions]
|
|
Arguments
|
|
_consModeRelationships - ConsModeRelationships
|
|
consMode - ConsMode
|
|
Arguments
|
|
consModeList - [ConsMode]
|
|
Arguments
|
|
_consModePortConsRelationships - ConsModePortConsRelationships
|
|
consModePortCons - ConsModePortCons
|
|
Arguments
|
|
consModePortConsList - [ConsModePortCons]
|
|
Arguments
|
|
_consModeSeaConsRelationships - ConsModeSeaConsRelationships
|
|
consModeSeaCons - ConsModeSeaCons
|
|
Arguments
|
|
consModeSeaConsList - [ConsModeSeaCons]
|
|
Arguments
|
|
correlationProfile - CorrelationProfile
|
|
Arguments
|
|
correlationProfileList - [CorrelationProfile]
|
|
Arguments
|
|
country - Country
|
|
Arguments
|
|
countryList - [Country]
|
|
Arguments
|
|
currency - Currency
|
|
Arguments
|
|
currencyList - [Currency]
|
|
Arguments
|
|
dataFormView - DataFormView
|
|
Arguments
|
|
dataFormViewList - [DataFormView]
|
|
Arguments
|
|
dataFormViewField - DataFormViewField
|
|
Arguments
|
|
dataFormViewFieldList - [DataFormViewField]
|
|
Arguments
|
|
_decisionTableRelationships - DecisionTableRelationships
|
|
decisionTable - DecisionTable
|
|
Arguments
|
|
decisionTableList - [DecisionTable]
|
|
Arguments
|
|
_decisionTableRuleReportRelationships - DecisionTableRuleReportRelationships
|
|
decisionTableRuleReport - DecisionTableRuleReport
|
|
Arguments
|
|
decisionTableRuleReportList - [DecisionTableRuleReport]
|
|
Arguments
|
|
_delayRelationships - DelayRelationships
|
|
delay - Delay
|
|
Arguments
|
|
delayList - [Delay]
|
|
Arguments
|
|
_delayBunkerRelationships - DelayBunkerRelationships
|
|
delayBunker - DelayBunker
|
|
Arguments
|
|
delayBunkerList - [DelayBunker]
|
|
Arguments
|
|
_delayReasonRelationships - DelayReasonRelationships
|
|
delayReason - DelayReason
|
|
Arguments
|
|
delayReasonList - [DelayReason]
|
|
Arguments
|
|
delayType - DelayType
|
|
Arguments
|
|
delayTypeList - [DelayType]
|
|
Arguments
|
|
_demurrageAllocationDetailsRelationships - DemurrageAllocationDetailsRelationships
|
|
demurrageAllocationDetails - DemurrageAllocationDetails
|
|
Arguments
|
|
demurrageAllocationDetailsList - [DemurrageAllocationDetails]
|
|
Arguments |
|
_demurrageTaskLinkedLaytimeRelationships - DemurrageTaskLinkedLaytimeRelationships
|
|
department - Department
|
|
Arguments
|
|
departmentList - [Department]
|
|
Arguments
|
|
equipmentContractHistory - EquipmentContractHistory
|
|
Arguments
|
|
equipmentContractHistoryList - [EquipmentContractHistory]
|
|
Arguments
|
|
_estimateCargoBrokerRelationships - EstimateCargoBrokerRelationships
|
|
estimateCargoBroker - EstimateCargoBroker
|
|
Arguments
|
|
estimateCargoBrokerList - [EstimateCargoBroker]
|
|
Arguments
|
|
_estimateCargoBunkerConsumptionRelationships - EstimateCargoBunkerConsumptionRelationships
|
|
estimateCargoBunkerConsumption - EstimateCargoBunkerConsumption
|
|
Arguments
|
|
estimateCargoBunkerConsumptionList - [EstimateCargoBunkerConsumption]
|
|
Arguments |
|
_estimateCargoesRelationships - EstimateCargoesRelationships
|
|
estimateCargoes - EstimateCargoes
|
|
Arguments
|
|
estimateCargoesList - [EstimateCargoes]
|
|
Arguments
|
|
_estimateCargoExtraFreightTermsRelationships - EstimateCargoExtraFreightTermsRelationships
|
|
estimateCargoExtraFreightTerms - EstimateCargoExtraFreightTerms
|
|
Arguments
|
|
estimateCargoExtraFreightTermsList - [EstimateCargoExtraFreightTerms]
|
|
Arguments |
|
_estimateDelayRelationships - EstimateDelayRelationships
|
|
estimateDelay - EstimateDelay
|
|
Arguments
|
|
estimateDelayList - [EstimateDelay]
|
|
Arguments
|
|
_estimateFuelEuReplacementBunkerRelationships - EstimateFuelEuReplacementBunkerRelationships
|
|
estimateFuelEuReplacementBunker - EstimateFuelEuReplacementBunker
|
|
Arguments
|
|
estimateFuelEuReplacementBunkerList - [EstimateFuelEuReplacementBunker]
|
|
Arguments |
|
_estimateItineraryRelationships - EstimateItineraryRelationships
|
|
estimateItinerary - EstimateItinerary
|
|
Arguments
|
|
estimateItineraryList - [EstimateItinerary]
|
|
Arguments
|
|
_estimateItineraryBunkerRelationships - EstimateItineraryBunkerRelationships
|
|
estimateItineraryBunker - EstimateItineraryBunker
|
|
Arguments
|
|
estimateItineraryBunkerList - [EstimateItineraryBunker]
|
|
Arguments
|
|
_estimateItineraryCarbonRelationships - EstimateItineraryCarbonRelationships
|
|
estimateItineraryCarbon - EstimateItineraryCarbon
|
|
Arguments
|
|
estimateItineraryCarbonList - [EstimateItineraryCarbon]
|
|
Arguments
|
|
_estimateItineraryCarbonBunkerRelationships - EstimateItineraryCarbonBunkerRelationships
|
|
estimateItineraryCarbonBunker - EstimateItineraryCarbonBunker
|
|
Arguments
|
|
estimateItineraryCarbonBunkerList - [EstimateItineraryCarbonBunker]
|
|
Arguments |
|
_exchangeRateRelationships - ExchangeRateRelationships
|
|
exchangeRate - ExchangeRate
|
|
Arguments
|
|
exchangeRateList - [ExchangeRate]
|
|
Arguments
|
|
expense - Expense
|
|
Arguments
|
|
expenseList - [Expense]
|
|
Arguments
|
|
_extraFreightTermsRelationships - ExtraFreightTermsRelationships
|
|
extraFreightTerms - ExtraFreightTerms
|
|
Arguments
|
|
extraFreightTermsList - [ExtraFreightTerms]
|
|
Arguments
|
|
_financialsAndOperationsInvoiceNotesRelationships - FinancialsAndOperationsInvoiceNotesRelationships
|
|
financialsAndOperationsInvoiceNotes - FinancialsAndOperationsInvoiceNotes
|
|
Arguments
|
|
financialsAndOperationsInvoiceNotesList - [FinancialsAndOperationsInvoiceNotes]
|
|
Arguments |
|
_financialsInvoiceRelationships - FinancialsInvoiceRelationships
|
|
financialsInvoice - FinancialsInvoice
|
|
Arguments
|
|
financialsInvoiceList - [FinancialsInvoice]
|
|
Arguments
|
|
_financialsInvoiceDetailRelationships - FinancialsInvoiceDetailRelationships
|
|
financialsInvoiceDetail - FinancialsInvoiceDetail
|
|
Arguments
|
|
financialsInvoiceDetailList - [FinancialsInvoiceDetail]
|
|
Arguments
|
|
_financialsInvoiceDetailCargoAllocationRelationships - FinancialsInvoiceDetailCargoAllocationRelationships
|
|
financialsInvoiceDetailCargoAllocation - FinancialsInvoiceDetailCargoAllocation
|
|
Arguments
|
|
financialsInvoiceDetailCargoAllocationList - [FinancialsInvoiceDetailCargoAllocation]
|
|
Arguments |
|
_financialsInvoicePaymentRelationships - FinancialsInvoicePaymentRelationships
|
|
financialsInvoicePayment - FinancialsInvoicePayment
|
|
Arguments
|
|
financialsInvoicePaymentList - [FinancialsInvoicePayment]
|
|
Arguments |
|
_fixtureRelationships - FixtureRelationships
|
|
fixture - Fixture
|
|
Arguments
|
|
fixtureList - [Fixture]
|
|
Arguments
|
|
_fixtureRemarkRelationships - FixtureRemarkRelationships
|
|
fixtureRemark - FixtureRemark
|
|
Arguments
|
|
fixtureRemarkList - [FixtureRemark]
|
|
Arguments
|
|
_formRelationships - FormRelationships
|
|
form - Form
|
|
Arguments
|
|
formList - [Form]
|
|
Arguments
|
|
formTemplate - FormTemplate
|
|
Arguments
|
|
formTemplateList - [FormTemplate]
|
|
Arguments
|
|
_freightInvoiceRelationships - FreightInvoiceRelationships
|
|
freightInvoice - FreightInvoice
|
|
Arguments
|
|
freightInvoiceList - [FreightInvoice]
|
|
Arguments
|
|
freightTerm - FreightTerm
|
|
Arguments
|
|
freightTermList - [FreightTerm]
|
|
Arguments
|
|
fuelEmissionsFactorsSet - FuelEmissionsFactorsSet
|
|
Arguments
|
|
fuelEmissionsFactorsSetList - [FuelEmissionsFactorsSet]
|
|
Arguments
|
|
fuelLubeType - FuelLubeType
|
|
Arguments
|
|
fuelLubeTypeList - [FuelLubeType]
|
|
Arguments
|
|
_fuelZoneRelationships - FuelZoneRelationships
|
|
fuelZone - FuelZone
|
|
Arguments
|
|
fuelZoneList - [FuelZone]
|
|
Arguments
|
|
_fuelZoneSetRelationships - FuelZoneSetRelationships
|
|
fuelZoneSet - FuelZoneSet
|
|
Arguments
|
|
fuelZoneSetList - [FuelZoneSet]
|
|
Arguments
|
|
_groupMemberRelationships - GroupMemberRelationships
|
|
groupMember - GroupMember
|
|
Arguments
|
|
groupMemberList - [GroupMember]
|
|
Arguments
|
|
_headFixturePurchaseSaleRelationships - HeadFixturePurchaseSaleRelationships
|
|
headFixturePurchaseSale - HeadFixturePurchaseSale
|
|
Arguments
|
|
headFixturePurchaseSaleList - [HeadFixturePurchaseSale]
|
|
Arguments
|
|
_holidayRelationships - HolidayRelationships
|
|
holiday - Holiday
|
|
Arguments
|
|
holidayList - [Holiday]
|
|
Arguments
|
|
imosUser - ImosUser
|
|
Arguments
|
|
imosUserList - [ImosUser]
|
|
Arguments
|
|
interfaceMessagesAndNotifications - InterfaceMessagesAndNotifications
|
|
Arguments
|
|
interfaceMessagesAndNotificationsList - [InterfaceMessagesAndNotifications]
|
|
Arguments
|
|
_internalFinalFreightStatementVoyageRelationships - InternalFinalFreightStatementVoyageRelationships
|
|
_internalIndexHireTimeChartersRelationships - InternalIndexHireTimeChartersRelationships
|
|
_invoiceNoteRelationships - InvoiceNoteRelationships
|
|
invoiceNote - InvoiceNote
|
|
Arguments
|
|
invoiceNoteList - [InvoiceNote]
|
|
Arguments
|
|
jobStatus - JobStatus
|
|
Arguments
|
|
jobStatusList - [JobStatus]
|
|
Arguments
|
|
_laytimeRelationships - LaytimeRelationships
|
|
laytime - Laytime
|
|
Arguments
|
|
laytimeList - [Laytime]
|
|
Arguments
|
|
_laytimePortActivitiesRelationships - LaytimePortActivitiesRelationships
|
|
laytimePortActivities - LaytimePortActivities
|
|
Arguments
|
|
laytimePortActivitiesList - [LaytimePortActivities]
|
|
Arguments
|
|
_laytimePortDeductionRelationships - LaytimePortDeductionRelationships
|
|
laytimePortDeduction - LaytimePortDeduction
|
|
Arguments
|
|
laytimePortDeductionList - [LaytimePortDeduction]
|
|
Arguments
|
|
_laytimePortsRelationships - LaytimePortsRelationships
|
|
laytimePorts - LaytimePorts
|
|
Arguments
|
|
laytimePortsList - [LaytimePorts]
|
|
Arguments
|
|
laytimeTerms - LaytimeTerms
|
|
Arguments
|
|
laytimeTermsList - [LaytimeTerms]
|
|
Arguments
|
|
_loadDischargeStandardRateRelationships - LoadDischargeStandardRateRelationships
|
|
loadDischargeStandardRate - LoadDischargeStandardRate
|
|
Arguments
|
|
loadDischargeStandardRateList - [LoadDischargeStandardRate]
|
|
Arguments |
|
_loadDischargeTableRatesRelationships - LoadDischargeTableRatesRelationships
|
|
loadDischargeTableRates - LoadDischargeTableRates
|
|
Arguments
|
|
loadDischargeTableRatesList - [LoadDischargeTableRates]
|
|
Arguments
|
|
_loadlineZoneRelationships - LoadlineZoneRelationships
|
|
loadlineZone - LoadlineZone
|
|
Arguments
|
|
loadlineZoneList - [LoadlineZone]
|
|
Arguments
|
|
_loadlineZoneDetailsRelationships - LoadlineZoneDetailsRelationships
|
|
loadlineZoneDetails - LoadlineZoneDetails
|
|
Arguments
|
|
loadlineZoneDetailsList - [LoadlineZoneDetails]
|
|
Arguments
|
|
lob - Lob
|
|
Arguments
|
|
lobList - [Lob]
|
|
Arguments
|
|
_marketRelationships - MarketRelationships
|
|
market - Market
|
|
Arguments
|
|
marketList - [Market]
|
|
Arguments
|
|
_marketCargoRelationships - MarketCargoRelationships
|
|
marketCargo - MarketCargo
|
|
Arguments
|
|
marketCargoList - [MarketCargo]
|
|
Arguments
|
|
_marketDataRelationships - MarketDataRelationships
|
|
marketData - MarketData
|
|
Arguments
|
|
marketDataList - [MarketData]
|
|
Arguments
|
|
_marketPositionRelationships - MarketPositionRelationships
|
|
marketPosition - MarketPosition
|
|
Arguments
|
|
marketPositionList - [MarketPosition]
|
|
Arguments
|
|
_marketPositionSourceRelationships - MarketPositionSourceRelationships
|
|
marketPositionSource - MarketPositionSource
|
|
Arguments
|
|
marketPositionSourceList - [MarketPositionSource]
|
|
Arguments
|
|
_masterContractRelationships - MasterContractRelationships
|
|
masterContract - MasterContract
|
|
Arguments
|
|
masterContractList - [MasterContract]
|
|
Arguments
|
|
_masterContractBrokerRelationships - MasterContractBrokerRelationships
|
|
_moduleAccessRelationships - ModuleAccessRelationships
|
|
moduleAccess - ModuleAccess
|
|
Arguments
|
|
moduleAccessList - [ModuleAccess]
|
|
Arguments
|
|
notification - Notification
|
|
Arguments
|
|
notificationList - [Notification]
|
|
Arguments
|
|
_objectAccessRelationships - ObjectAccessRelationships
|
|
objectAccess - ObjectAccess
|
|
Arguments
|
|
objectAccessList - [ObjectAccess]
|
|
Arguments
|
|
objectApproval - ObjectApproval
|
|
Arguments
|
|
objectApprovalList - [ObjectApproval]
|
|
Arguments
|
|
_operationsInvoiceRelationships - OperationsInvoiceRelationships
|
|
operationsInvoice - OperationsInvoice
|
|
Arguments
|
|
operationsInvoiceList - [OperationsInvoice]
|
|
Arguments
|
|
_operationsInvoiceApprovalRelationships - OperationsInvoiceApprovalRelationships
|
|
operationsInvoiceApproval - OperationsInvoiceApproval
|
|
Arguments
|
|
operationsInvoiceApprovalList - [OperationsInvoiceApproval]
|
|
Arguments |
|
_operationsInvoiceDetailCargoAllocationRelationships - OperationsInvoiceDetailCargoAllocationRelationships
|
|
operationsInvoiceDetailCargoAllocation - OperationsInvoiceDetailCargoAllocation
|
|
Arguments
|
|
operationsInvoiceDetailCargoAllocationList - [OperationsInvoiceDetailCargoAllocation]
|
|
Arguments |
|
_operationsInvoiceDetailsRelationships - OperationsInvoiceDetailsRelationships
|
|
operationsInvoiceDetails - OperationsInvoiceDetails
|
|
Arguments
|
|
operationsInvoiceDetailsList - [OperationsInvoiceDetails]
|
|
Arguments |
|
_operationsInvoiceNoteRelationships - OperationsInvoiceNoteRelationships
|
|
operationsLedger - OperationsLedger
|
|
Arguments
|
|
operationsLedgerList - [OperationsLedger]
|
|
Arguments
|
|
_operationsPaymentDetailsRelationships - OperationsPaymentDetailsRelationships
|
|
operationsPaymentDetails - OperationsPaymentDetails
|
|
Arguments
|
|
operationsPaymentDetailsList - [OperationsPaymentDetails]
|
|
Arguments |
|
_paperTradeRelationships - PaperTradeRelationships
|
|
paperTrade - PaperTrade
|
|
Arguments
|
|
paperTradeList - [PaperTrade]
|
|
Arguments
|
|
_paperTradeExposurePeriodRelationships - PaperTradeExposurePeriodRelationships
|
|
paperTradeExposurePeriod - PaperTradeExposurePeriod
|
|
Arguments
|
|
paperTradeExposurePeriodList - [PaperTradeExposurePeriod]
|
|
Arguments |
|
_paymentRelationships - PaymentRelationships
|
|
payment - Payment
|
|
Arguments
|
|
paymentList - [Payment]
|
|
Arguments
|
|
_paymentBatchRelationships - PaymentBatchRelationships
|
|
paymentBatch - PaymentBatch
|
|
Arguments
|
|
paymentBatchList - [PaymentBatch]
|
|
Arguments
|
|
_paymentBatchDetailsRelationships - PaymentBatchDetailsRelationships
|
|
paymentBatchDetails - PaymentBatchDetails
|
|
Arguments
|
|
paymentBatchDetailsList - [PaymentBatchDetails]
|
|
Arguments
|
|
_paymentDetailRelationships - PaymentDetailRelationships
|
|
paymentDetail - PaymentDetail
|
|
Arguments
|
|
paymentDetailList - [PaymentDetail]
|
|
Arguments
|
|
paymentTerm - PaymentTerm
|
|
Arguments
|
|
paymentTermList - [PaymentTerm]
|
|
Arguments
|
|
_poolRelationships - PoolRelationships
|
|
pool - Pool
|
|
Arguments
|
|
poolList - [Pool]
|
|
Arguments
|
|
_poolAdminAccountRelationships - PoolAdminAccountRelationships
|
|
poolAdminAccount - PoolAdminAccount
|
|
Arguments
|
|
poolAdminAccountList - [PoolAdminAccount]
|
|
Arguments
|
|
_poolAssignmentRelationships - PoolAssignmentRelationships
|
|
poolAssignment - PoolAssignment
|
|
Arguments
|
|
poolAssignmentList - [PoolAssignment]
|
|
Arguments
|
|
_poolAssignmentPremiumRelationships - PoolAssignmentPremiumRelationships
|
|
poolAssignmentPremium - PoolAssignmentPremium
|
|
Arguments
|
|
poolAssignmentPremiumList - [PoolAssignmentPremium]
|
|
Arguments
|
|
_poolingDistributionRelationships - PoolingDistributionRelationships
|
|
poolingDistribution - PoolingDistribution
|
|
Arguments
|
|
poolingDistributionList - [PoolingDistribution]
|
|
Arguments
|
|
_poolingDistributionPremiumRelationships - PoolingDistributionPremiumRelationships
|
|
poolingDistributionPremium - PoolingDistributionPremium
|
|
Arguments
|
|
poolingDistributionPremiumList - [PoolingDistributionPremium]
|
|
Arguments |
|
_portRelationships - PortRelationships
|
|
port - Port
|
|
Arguments
|
|
portList - [Port]
|
|
Arguments
|
|
portActivity - PortActivity
|
|
Arguments
|
|
portActivityList - [PortActivity]
|
|
Arguments
|
|
_portActivityBunkerRelationships - PortActivityBunkerRelationships
|
|
portActivityBunker - PortActivityBunker
|
|
Arguments
|
|
portActivityBunkerList - [PortActivityBunker]
|
|
Arguments
|
|
_portAdvanceDaRelationships - PortAdvanceDaRelationships
|
|
portArea - PortArea
|
|
Arguments
|
|
portAreaList - [PortArea]
|
|
Arguments
|
|
_portBerthRelationships - PortBerthRelationships
|
|
portBerth - PortBerth
|
|
Arguments
|
|
portBerthList - [PortBerth]
|
|
Arguments
|
|
_portCargoCompatRelationships - PortCargoCompatRelationships
|
|
portCargoCompat - PortCargoCompat
|
|
Arguments
|
|
portCargoCompatList - [PortCargoCompat]
|
|
Arguments
|
|
_portCargoCompatBerthRelationships - PortCargoCompatBerthRelationships
|
|
portCargoCompatBerth - PortCargoCompatBerth
|
|
Arguments
|
|
portCargoCompatBerthList - [PortCargoCompatBerth]
|
|
Arguments
|
|
_portExpenseRelationships - PortExpenseRelationships
|
|
portExpense - PortExpense
|
|
Arguments
|
|
portExpenseList - [PortExpense]
|
|
Arguments
|
|
_portExpenseMiscDetailsRelationships - PortExpenseMiscDetailsRelationships
|
|
portExpenseMiscDetails - PortExpenseMiscDetails
|
|
Arguments
|
|
portExpenseMiscDetailsList - [PortExpenseMiscDetails]
|
|
Arguments
|
|
_portExpensesStandardRelationships - PortExpensesStandardRelationships
|
|
portExpensesStandard - PortExpensesStandard
|
|
Arguments
|
|
portExpensesStandardList - [PortExpensesStandard]
|
|
Arguments
|
|
_portExpenseStandardDetailRelationships - PortExpenseStandardDetailRelationships
|
|
portExpenseStandardDetail - PortExpenseStandardDetail
|
|
Arguments
|
|
portExpenseStandardDetailList - [PortExpenseStandardDetail]
|
|
Arguments |
|
_portFuelAvailabilityRelationships - PortFuelAvailabilityRelationships
|
|
portFuelAvailability - PortFuelAvailability
|
|
Arguments
|
|
portFuelAvailabilityList - [PortFuelAvailability]
|
|
Arguments
|
|
portFunction - PortFunction
|
|
Arguments
|
|
portFunctionList - [PortFunction]
|
|
Arguments
|
|
_portVesselRelationships - PortVesselRelationships
|
|
portVessel - PortVessel
|
|
Arguments
|
|
portVesselList - [PortVessel]
|
|
Arguments
|
|
_portVesselBerthRelationships - PortVesselBerthRelationships
|
|
portVesselBerth - PortVesselBerth
|
|
Arguments
|
|
portVesselBerthList - [PortVesselBerth]
|
|
Arguments
|
|
_positionRelationships - PositionRelationships
|
|
position - Position
|
|
Arguments
|
|
positionList - [Position]
|
|
Arguments
|
|
region - Region
|
|
Arguments
|
|
regionList - [Region]
|
|
Arguments
|
|
_reminderRelationships - ReminderRelationships
|
|
reminder - Reminder
|
|
Arguments
|
|
reminderList - [Reminder]
|
|
Arguments
|
|
report - Report
|
|
Arguments
|
|
reportList - [Report]
|
|
Arguments
|
|
_reportUserViewRelationships - ReportUserViewRelationships
|
|
reportUserView - ReportUserView
|
|
Arguments
|
|
reportUserViewList - [ReportUserView]
|
|
Arguments
|
|
_reportViewRelationships - ReportViewRelationships
|
|
reportView - ReportView
|
|
Arguments
|
|
reportViewList - [ReportView]
|
|
Arguments
|
|
_revisionRelationships - RevisionRelationships
|
|
revision - Revision
|
|
Arguments
|
|
revisionList - [Revision]
|
|
Arguments
|
|
revisionPanelContent - RevisionPanelContent
|
|
Arguments
|
|
revisionPanelContentList - [RevisionPanelContent]
|
|
Arguments
|
|
_revisionRowRelationships - RevisionRowRelationships
|
|
revisionRow - RevisionRow
|
|
Arguments
|
|
revisionRowList - [RevisionRow]
|
|
Arguments
|
|
_scheduleBargeRelationships - ScheduleBargeRelationships
|
|
scheduleBarge - ScheduleBarge
|
|
Arguments
|
|
scheduleBargeList - [ScheduleBarge]
|
|
Arguments
|
|
sharedResources - SharedResources
|
|
Arguments
|
|
sharedResourcesList - [SharedResources]
|
|
Arguments
|
|
_standardExpenseRelationships - StandardExpenseRelationships
|
|
standardExpense - StandardExpense
|
|
Arguments
|
|
standardExpenseList - [StandardExpense]
|
|
Arguments
|
|
_standardExpenseConditionRelationships - StandardExpenseConditionRelationships
|
|
_standardRateRelationships - StandardRateRelationships
|
|
standardRate - StandardRate
|
|
Arguments
|
|
standardRateList - [StandardRate]
|
|
Arguments
|
|
vesonSubscription - VesonSubscription
|
|
Arguments
|
|
vesonSubscriptionList - [VesonSubscription]
|
|
Arguments
|
|
_surveyCostDetailsRelationships - SurveyCostDetailsRelationships
|
|
surveyCostDetails - SurveyCostDetails
|
|
Arguments
|
|
surveyCostDetailsList - [SurveyCostDetails]
|
|
Arguments
|
|
_surveyCostsBunkersRelationships - SurveyCostsBunkersRelationships
|
|
surveyCostsBunkers - SurveyCostsBunkers
|
|
Arguments
|
|
surveyCostsBunkersList - [SurveyCostsBunkers]
|
|
Arguments
|
|
_tankConditionRelationships - TankConditionRelationships
|
|
tankCondition - TankCondition
|
|
Arguments
|
|
tankConditionList - [TankCondition]
|
|
Arguments
|
|
_taskRelationships - TaskRelationships
|
|
task - Task
|
|
Arguments
|
|
taskList - [Task]
|
|
Arguments
|
|
taskGroup - TaskGroup
|
|
Arguments
|
|
taskGroupList - [TaskGroup]
|
|
Arguments
|
|
taskGroupItem - TaskGroupItem
|
|
Arguments
|
|
taskGroupItemList - [TaskGroupItem]
|
|
Arguments
|
|
_tasksAndAlertsRelationships - TasksAndAlertsRelationships
|
|
tasksAndAlerts - TasksAndAlerts
|
|
Arguments
|
|
tasksAndAlertsList - [TasksAndAlerts]
|
|
Arguments
|
|
tcDeduction - TCDeduction
|
|
Arguments
|
|
tcDeductionList - [TCDeduction]
|
|
Arguments
|
|
_teamRelationships - TeamRelationships
|
|
team - Team
|
|
Arguments
|
|
teamList - [Team]
|
|
Arguments
|
|
_termRelationships - TermRelationships
|
|
term - Term
|
|
Arguments
|
|
termList - [Term]
|
|
Arguments
|
|
_timeCharterBrokerRelationships - TimeCharterBrokerRelationships
|
|
timeCharterBroker - TimeCharterBroker
|
|
Arguments
|
|
timeCharterBrokerList - [TimeCharterBroker]
|
|
Arguments
|
|
_timeCharterBunkerDeliveryRelationships - TimeCharterBunkerDeliveryRelationships
|
|
timeCharterBunkerDelivery - TimeCharterBunkerDelivery
|
|
Arguments
|
|
timeCharterBunkerDeliveryList - [TimeCharterBunkerDelivery]
|
|
Arguments |
|
_timeCharterBunkerExposureRelationships - TimeCharterBunkerExposureRelationships
|
|
timeCharterBunkerExposure - TimeCharterBunkerExposure
|
|
Arguments
|
|
timeCharterBunkerExposureList - [TimeCharterBunkerExposure]
|
|
Arguments |
|
_timeCharterCOARelationships - TimeCharterCOARelationships
|
|
timeCharterCOA - TimeCharterCOA
|
|
Arguments
|
|
timeCharterCOAList - [TimeCharterCOA]
|
|
Arguments
|
|
_timeCharterCOABrokerRelationships - TimeCharterCOABrokerRelationships
|
|
_timeCharterCOADeliveryRedeliveryOptionRelationships - TimeCharterCOADeliveryRedeliveryOptionRelationships
|
|
timeCharterCOADeliveryRedeliveryOption - TimeCharterCOADeliveryRedeliveryOption
|
|
Arguments
|
|
timeCharterCOADeliveryRedeliveryOptionList - [TimeCharterCOADeliveryRedeliveryOption]
|
|
Arguments |
|
_timeCharterCOAExpenseRelationships - TimeCharterCOAExpenseRelationships
|
|
_timeCharterCOAHireRelationships - TimeCharterCOAHireRelationships
|
|
_timeCharterCOAVesselRelationships - TimeCharterCOAVesselRelationships
|
|
timeCharterCOAVessel - TimeCharterCOAVessel
|
|
Arguments
|
|
timeCharterCOAVesselList - [TimeCharterCOAVessel]
|
|
Arguments
|
|
_timeCharterCOAVesselTypeRelationships - TimeCharterCOAVesselTypeRelationships
|
|
timeCharterCOAVesselType - TimeCharterCOAVesselType
|
|
Arguments
|
|
timeCharterCOAVesselTypeList - [TimeCharterCOAVesselType]
|
|
Arguments |
|
_timeCharterContractRelationships - TimeCharterContractRelationships
|
|
timeCharterContract - TimeCharterContract
|
|
Arguments
|
|
timeCharterContractList - [TimeCharterContract]
|
|
Arguments
|
|
_timeCharterExpenseRelationships - TimeCharterExpenseRelationships
|
|
timeCharterExpense - TimeCharterExpense
|
|
Arguments
|
|
timeCharterExpenseList - [TimeCharterExpense]
|
|
Arguments
|
|
_timeCharterExposurePeriodRelationships - TimeCharterExposurePeriodRelationships
|
|
timeCharterExposurePeriod - TimeCharterExposurePeriod
|
|
Arguments
|
|
timeCharterExposurePeriodList - [TimeCharterExposurePeriod]
|
|
Arguments |
|
timeCharterExtra - TimeCharterExtra
|
|
Arguments
|
|
timeCharterExtraList - [TimeCharterExtra]
|
|
Arguments
|
|
_timeCharterHireRelationships - TimeCharterHireRelationships
|
|
timeCharterHire - TimeCharterHire
|
|
Arguments
|
|
timeCharterHireList - [TimeCharterHire]
|
|
Arguments
|
|
_timeCharterLeaseRelationships - TimeCharterLeaseRelationships
|
|
timeCharterLease - TimeCharterLease
|
|
Arguments
|
|
timeCharterLeaseList - [TimeCharterLease]
|
|
Arguments
|
|
_timeCharterLiftingOptionRelationships - TimeCharterLiftingOptionRelationships
|
|
timeCharterLiftingOption - TimeCharterLiftingOption
|
|
Arguments
|
|
timeCharterLiftingOptionList - [TimeCharterLiftingOption]
|
|
Arguments |
|
_timeCharterOutDetailsRelationships - TimeCharterOutDetailsRelationships
|
|
timeCharterOutDetails - TimeCharterOutDetails
|
|
Arguments
|
|
timeCharterOutDetailsList - [TimeCharterOutDetails]
|
|
Arguments
|
|
_timeCharterPortConsumptionRelationships - TimeCharterPortConsumptionRelationships
|
|
timeCharterPortConsumption - TimeCharterPortConsumption
|
|
Arguments
|
|
timeCharterPortConsumptionList - [TimeCharterPortConsumption]
|
|
Arguments |
|
timeCharterProfitShare - TimeCharterProfitShare
|
|
Arguments
|
|
timeCharterProfitShareList - [TimeCharterProfitShare]
|
|
Arguments
|
|
_timeCharterProfitShareContractsRelationships - TimeCharterProfitShareContractsRelationships
|
|
timeCharterProfitShareContracts - TimeCharterProfitShareContracts
|
|
Arguments
|
|
timeCharterProfitShareContractsList - [TimeCharterProfitShareContracts]
|
|
Arguments |
|
_timeCharterProjectedInvoiceRelationships - TimeCharterProjectedInvoiceRelationships
|
|
timeCharterProjectedInvoice - TimeCharterProjectedInvoice
|
|
Arguments
|
|
timeCharterProjectedInvoiceList - [TimeCharterProjectedInvoice]
|
|
Arguments |
|
_timeCharterPurchaseOptionRelationships - TimeCharterPurchaseOptionRelationships
|
|
timeCharterPurchaseOption - TimeCharterPurchaseOption
|
|
Arguments
|
|
timeCharterPurchaseOptionList - [TimeCharterPurchaseOption]
|
|
Arguments |
|
_timeCharterSeaConsumptionRelationships - TimeCharterSeaConsumptionRelationships
|
|
timeCharterSeaConsumption - TimeCharterSeaConsumption
|
|
Arguments
|
|
timeCharterSeaConsumptionList - [TimeCharterSeaConsumption]
|
|
Arguments |
|
_timeCharterSeaConsumptionBunkerRelationships - TimeCharterSeaConsumptionBunkerRelationships
|
|
timeCharterSeaConsumptionBunker - TimeCharterSeaConsumptionBunker
|
|
Arguments
|
|
timeCharterSeaConsumptionBunkerList - [TimeCharterSeaConsumptionBunker]
|
|
Arguments |
|
timeCharterTonnageTax - TimeCharterTonnageTax
|
|
Arguments
|
|
timeCharterTonnageTaxList - [TimeCharterTonnageTax]
|
|
Arguments
|
|
timeCharterWarrantyConsumption - TimeCharterWarrantyConsumption
|
|
Arguments
|
|
timeCharterWarrantyConsumptionList - [TimeCharterWarrantyConsumption]
|
|
Arguments |
|
_timeCharterWarrantyDelayExclusionRelationships - TimeCharterWarrantyDelayExclusionRelationships
|
|
timeCharterWarrantyDelayExclusion - TimeCharterWarrantyDelayExclusion
|
|
Arguments
|
|
timeCharterWarrantyDelayExclusionList - [TimeCharterWarrantyDelayExclusion]
|
|
Arguments |
|
timeZoneCodes - TimeZoneCodes
|
|
Arguments
|
|
timeZoneCodesList - [TimeZoneCodes]
|
|
Arguments
|
|
timeZoneInfo - TimeZoneInfo
|
|
Arguments
|
|
timeZoneInfoList - [TimeZoneInfo]
|
|
Arguments
|
|
_tradeAreaRelationships - TradeAreaRelationships
|
|
tradeArea - TradeArea
|
|
Arguments
|
|
tradeAreaList - [TradeArea]
|
|
Arguments
|
|
_tradeBrokerRelationships - TradeBrokerRelationships
|
|
tradeBroker - TradeBroker
|
|
Arguments
|
|
tradeBrokerList - [TradeBroker]
|
|
Arguments
|
|
_tradeContractRelationships - TradeContractRelationships
|
|
tradeContract - TradeContract
|
|
Arguments
|
|
tradeContractList - [TradeContract]
|
|
Arguments
|
|
tradeFilter - TradeFilter
|
|
Arguments
|
|
tradeFilterList - [TradeFilter]
|
|
Arguments
|
|
_tradeFilterDetailRelationships - TradeFilterDetailRelationships
|
|
tradeFilterDetail - TradeFilterDetail
|
|
Arguments
|
|
tradeFilterDetailList - [TradeFilterDetail]
|
|
Arguments
|
|
_tradeIndexRelationships - TradeIndexRelationships
|
|
tradeIndex - TradeIndex
|
|
Arguments
|
|
tradeIndexList - [TradeIndex]
|
|
Arguments
|
|
_tradePnlRelationships - TradePnlRelationships
|
|
tradePnl - TradePnl
|
|
Arguments
|
|
tradePnlList - [TradePnl]
|
|
Arguments
|
|
_tradePnlDetailRelationships - TradePnlDetailRelationships
|
|
tradePnlDetail - TradePnlDetail
|
|
Arguments
|
|
tradePnlDetailList - [TradePnlDetail]
|
|
Arguments
|
|
_tradeSnapshotRelationships - TradeSnapshotRelationships
|
|
tradeSnapshot - TradeSnapshot
|
|
Arguments
|
|
tradeSnapshotList - [TradeSnapshot]
|
|
Arguments
|
|
_tradeTypeRelationships - TradeTypeRelationships
|
|
tradeType - TradeType
|
|
Arguments
|
|
tradeTypeList - [TradeType]
|
|
Arguments
|
|
_tradeUnitRelationships - TradeUnitRelationships
|
|
tradeUnit - TradeUnit
|
|
Arguments
|
|
tradeUnitList - [TradeUnit]
|
|
Arguments
|
|
_tradingProfileRelationships - TradingProfileRelationships
|
|
tradingProfile - TradingProfile
|
|
Arguments
|
|
tradingProfileList - [TradingProfile]
|
|
Arguments
|
|
_tradingProfilePropertyRelationships - TradingProfilePropertyRelationships
|
|
tradingProfileProperty - TradingProfileProperty
|
|
Arguments
|
|
tradingProfilePropertyList - [TradingProfileProperty]
|
|
Arguments
|
|
_unitOfMeasureRelationships - UnitOfMeasureRelationships
|
|
unitOfMeasure - UnitOfMeasure
|
|
Arguments
|
|
unitOfMeasureList - [UnitOfMeasure]
|
|
Arguments
|
|
_unpricedElementRelationships - UnpricedElementRelationships
|
|
unpricedElement - UnpricedElement
|
|
Arguments
|
|
unpricedElementList - [UnpricedElement]
|
|
Arguments
|
|
_unpricedElementRemarkRelationships - UnpricedElementRemarkRelationships
|
|
_unpricedElementStructureRelationships - UnpricedElementStructureRelationships
|
|
unpricedElementStructure - UnpricedElementStructure
|
|
Arguments
|
|
unpricedElementStructureList - [UnpricedElementStructure]
|
|
Arguments |
|
_userRelationships - UserRelationships
|
|
user - User
|
|
Arguments
|
|
userList - [User]
|
|
Arguments
|
|
userField - UserField
|
|
Arguments
|
|
userFieldList - [UserField]
|
|
Arguments
|
|
_vesselRelationships - VesselRelationships
|
|
vessel - Vessel
|
|
Arguments
|
|
vesselList - [Vessel]
|
|
Arguments
|
|
_vesselBoatsRelationships - VesselBoatsRelationships
|
|
vesselBoats - VesselBoats
|
|
Arguments
|
|
vesselBoatsList - [VesselBoats]
|
|
Arguments
|
|
_vesselBunkerTankRelationships - VesselBunkerTankRelationships
|
|
vesselBunkerTank - VesselBunkerTank
|
|
Arguments
|
|
vesselBunkerTankList - [VesselBunkerTank]
|
|
Arguments
|
|
_vesselConsModeRelationships - VesselConsModeRelationships
|
|
vesselConsMode - VesselConsMode
|
|
Arguments
|
|
vesselConsModeList - [VesselConsMode]
|
|
Arguments
|
|
_vesselCraneRelationships - VesselCraneRelationships
|
|
vesselCrane - VesselCrane
|
|
Arguments
|
|
vesselCraneList - [VesselCrane]
|
|
Arguments
|
|
_vesselDetailsRelationships - VesselDetailsRelationships
|
|
vesselDetails - VesselDetails
|
|
Arguments
|
|
vesselDetailsList - [VesselDetails]
|
|
Arguments
|
|
_vesselDraftRelationships - VesselDraftRelationships
|
|
vesselDraft - VesselDraft
|
|
Arguments
|
|
vesselDraftList - [VesselDraft]
|
|
Arguments
|
|
_vesselDraftMarksRelationships - VesselDraftMarksRelationships
|
|
vesselDraftMarks - VesselDraftMarks
|
|
Arguments
|
|
vesselDraftMarksList - [VesselDraftMarks]
|
|
Arguments
|
|
_vesselEvaluationRelationships - VesselEvaluationRelationships
|
|
vesselEvaluation - VesselEvaluation
|
|
Arguments
|
|
vesselEvaluationList - [VesselEvaluation]
|
|
Arguments
|
|
_vesselFleetMemberRelationships - VesselFleetMemberRelationships
|
|
vesselFleetMember - VesselFleetMember
|
|
Arguments
|
|
vesselFleetMemberList - [VesselFleetMember]
|
|
Arguments
|
|
_vesselFleetMemberFullRelationships - VesselFleetMemberFullRelationships
|
|
vesselFleetMemberFull - VesselFleetMemberFull
|
|
Arguments
|
|
vesselFleetMemberFullList - [VesselFleetMemberFull]
|
|
Arguments
|
|
_vesselHatchRelationships - VesselHatchRelationships
|
|
vesselHatch - VesselHatch
|
|
Arguments
|
|
vesselHatchList - [VesselHatch]
|
|
Arguments
|
|
_vesselHoldRelationships - VesselHoldRelationships
|
|
vesselHold - VesselHold
|
|
Arguments
|
|
vesselHoldList - [VesselHold]
|
|
Arguments
|
|
_vesselIncidentRelationships - VesselIncidentRelationships
|
|
vesselIncident - VesselIncident
|
|
Arguments
|
|
vesselIncidentList - [VesselIncident]
|
|
Arguments
|
|
_vesselInspectionRelationships - VesselInspectionRelationships
|
|
vesselInspection - VesselInspection
|
|
Arguments
|
|
vesselInspectionList - [VesselInspection]
|
|
Arguments
|
|
_vesselPortConsRelationships - VesselPortConsRelationships
|
|
vesselPortCons - VesselPortCons
|
|
Arguments
|
|
vesselPortConsList - [VesselPortCons]
|
|
Arguments
|
|
vesselRoute - VesselRoute
|
|
Arguments
|
|
vesselRouteList - [VesselRoute]
|
|
Arguments
|
|
_vesselsAndBargesRelationships - VesselsAndBargesRelationships
|
|
_vesselSeaConsRelationships - VesselSeaConsRelationships
|
|
vesselSeaCons - VesselSeaCons
|
|
Arguments
|
|
vesselSeaConsList - [VesselSeaCons]
|
|
Arguments
|
|
_vesselSeaConsBunkerRelationships - VesselSeaConsBunkerRelationships
|
|
vesselSeaConsBunker - VesselSeaConsBunker
|
|
Arguments
|
|
vesselSeaConsBunkerList - [VesselSeaConsBunker]
|
|
Arguments
|
|
_vesselTankRelationships - VesselTankRelationships
|
|
vesselTank - VesselTank
|
|
Arguments
|
|
vesselTankList - [VesselTank]
|
|
Arguments
|
|
_vesselTceTargetRelationships - VesselTceTargetRelationships
|
|
vesselTceTarget - VesselTceTarget
|
|
Arguments
|
|
vesselTceTargetList - [VesselTceTarget]
|
|
Arguments
|
|
_vesselTypeRelationships - VesselTypeRelationships
|
|
vesselType - VesselType
|
|
Arguments
|
|
vesselTypeList - [VesselType]
|
|
Arguments
|
|
_vesselVariablesRelationships - VesselVariablesRelationships
|
|
_vesselVettingRelationships - VesselVettingRelationships
|
|
vesselVetting - VesselVetting
|
|
Arguments
|
|
vesselVettingList - [VesselVetting]
|
|
Arguments
|
|
_voyageRelationships - VoyageRelationships
|
|
voyage - Voyage
|
|
Arguments
|
|
voyageList - [Voyage]
|
|
Arguments
|
|
_voyageActivityReportRelationships - VoyageActivityReportRelationships
|
|
voyageActivityReport - VoyageActivityReport
|
|
Arguments
|
|
voyageActivityReportList - [VoyageActivityReport]
|
|
Arguments
|
|
_voyageAndTcoFixtureRelationships - VoyageAndTcoFixtureRelationships
|
|
voyageAndTcoFixture - VoyageAndTcoFixture
|
|
Arguments
|
|
voyageAndTcoFixtureList - [VoyageAndTcoFixture]
|
|
Arguments
|
|
_voyageBunkerInventoryRelationships - VoyageBunkerInventoryRelationships
|
|
voyageBunkerInventory - VoyageBunkerInventory
|
|
Arguments
|
|
voyageBunkerInventoryList - [VoyageBunkerInventory]
|
|
Arguments
|
|
_voyageBunkerInventoryDetailRelationships - VoyageBunkerInventoryDetailRelationships
|
|
voyageBunkerInventoryDetail - VoyageBunkerInventoryDetail
|
|
Arguments
|
|
voyageBunkerInventoryDetailList - [VoyageBunkerInventoryDetail]
|
|
Arguments |
|
_voyageBunkerLiftingRelationships - VoyageBunkerLiftingRelationships
|
|
voyageBunkerLifting - VoyageBunkerLifting
|
|
Arguments
|
|
voyageBunkerLiftingList - [VoyageBunkerLifting]
|
|
Arguments
|
|
_voyageBunkerSummaryRelationships - VoyageBunkerSummaryRelationships
|
|
voyageBunkerSummary - VoyageBunkerSummary
|
|
Arguments
|
|
voyageBunkerSummaryList - [VoyageBunkerSummary]
|
|
Arguments
|
|
_voyageCargoHandlingRelationships - VoyageCargoHandlingRelationships
|
|
voyageCargoHandling - VoyageCargoHandling
|
|
Arguments
|
|
voyageCargoHandlingList - [VoyageCargoHandling]
|
|
Arguments
|
|
_voyageCargoHandlingDocumentRelationships - VoyageCargoHandlingDocumentRelationships
|
|
voyageCargoHandlingDocument - VoyageCargoHandlingDocument
|
|
Arguments
|
|
voyageCargoHandlingDocumentList - [VoyageCargoHandlingDocument]
|
|
Arguments |
|
_voyageCargoHandlingEventRelationships - VoyageCargoHandlingEventRelationships
|
|
voyageCargoHandlingEvent - VoyageCargoHandlingEvent
|
|
Arguments
|
|
voyageCargoHandlingEventList - [VoyageCargoHandlingEvent]
|
|
Arguments |
|
_voyageCargoHandlingStowageRelationships - VoyageCargoHandlingStowageRelationships
|
|
voyageCargoHandlingStowage - VoyageCargoHandlingStowage
|
|
Arguments
|
|
voyageCargoHandlingStowageList - [VoyageCargoHandlingStowage]
|
|
Arguments |
|
_voyageCargoTransferRelationships - VoyageCargoTransferRelationships
|
|
voyageCargoTransfer - VoyageCargoTransfer
|
|
Arguments
|
|
voyageCargoTransferList - [VoyageCargoTransfer]
|
|
Arguments
|
|
_voyageContactRelationships - VoyageContactRelationships
|
|
voyageContact - VoyageContact
|
|
Arguments
|
|
voyageContactList - [VoyageContact]
|
|
Arguments
|
|
_voyageContactFullRelationships - VoyageContactFullRelationships
|
|
_voyageEmissionsRelationships - VoyageEmissionsRelationships
|
|
voyageEmissions - VoyageEmissions
|
|
Arguments
|
|
voyageEmissionsList - [VoyageEmissions]
|
|
Arguments
|
|
_voyageEmissionsDetailRelationships - VoyageEmissionsDetailRelationships
|
|
voyageEmissionsDetail - VoyageEmissionsDetail
|
|
Arguments
|
|
voyageEmissionsDetailList - [VoyageEmissionsDetail]
|
|
Arguments
|
|
_voyageEquipmentEventRelationships - VoyageEquipmentEventRelationships
|
|
voyageEquipmentEvent - VoyageEquipmentEvent
|
|
Arguments
|
|
voyageEquipmentEventList - [VoyageEquipmentEvent]
|
|
Arguments
|
|
_voyageEstimateRelationships - VoyageEstimateRelationships
|
|
voyageEstimate - VoyageEstimate
|
|
Arguments
|
|
voyageEstimateList - [VoyageEstimate]
|
|
Arguments
|
|
_voyageEstimateBunkerRelationships - VoyageEstimateBunkerRelationships
|
|
voyageEstimateBunker - VoyageEstimateBunker
|
|
Arguments
|
|
voyageEstimateBunkerList - [VoyageEstimateBunker]
|
|
Arguments
|
|
_voyageEstimateCOACVCAnalysisRelationships - VoyageEstimateCOACVCAnalysisRelationships
|
|
voyageEstimateCOACVCAnalysis - VoyageEstimateCOACVCAnalysis
|
|
Arguments
|
|
voyageEstimateCOACVCAnalysisList - [VoyageEstimateCOACVCAnalysis]
|
|
Arguments |
|
_voyageEstimateCOACVCAnalysisResultRelationships - VoyageEstimateCOACVCAnalysisResultRelationships
|
|
voyageEstimateCOACVCAnalysisResult - VoyageEstimateCOACVCAnalysisResult
|
|
Arguments
|
|
voyageEstimateCOACVCAnalysisResultList - [VoyageEstimateCOACVCAnalysisResult]
|
|
Arguments |
|
_voyageEstimateCOACVCAnalysisResultBunkerRelationships - VoyageEstimateCOACVCAnalysisResultBunkerRelationships
|
|
voyageEstimateCOACVCAnalysisResultBunker - VoyageEstimateCOACVCAnalysisResultBunker
|
|
Arguments
|
|
voyageEstimateCOACVCAnalysisResultBunkerList - [VoyageEstimateCOACVCAnalysisResultBunker]
|
|
Arguments |
|
_voyageEstimateMiscExpenseRelationships - VoyageEstimateMiscExpenseRelationships
|
|
voyageEstimateMiscExpense - VoyageEstimateMiscExpense
|
|
Arguments
|
|
voyageEstimateMiscExpenseList - [VoyageEstimateMiscExpense]
|
|
Arguments |
|
_voyageEstimatePortExpenseRelationships - VoyageEstimatePortExpenseRelationships
|
|
voyageEstimatePortExpense - VoyageEstimatePortExpense
|
|
Arguments
|
|
voyageEstimatePortExpenseList - [VoyageEstimatePortExpense]
|
|
Arguments |
|
_voyageEstimateTimeCharterExpenseRelationships - VoyageEstimateTimeCharterExpenseRelationships
|
|
voyageEstimateTimeCharterExpense - VoyageEstimateTimeCharterExpense
|
|
Arguments
|
|
voyageEstimateTimeCharterExpenseList - [VoyageEstimateTimeCharterExpense]
|
|
Arguments |
|
voyageInstruction - VoyageInstruction
|
|
Arguments
|
|
voyageInstructionList - [VoyageInstruction]
|
|
Arguments
|
|
_voyageItineraryRelationships - VoyageItineraryRelationships
|
|
voyageItinerary - VoyageItinerary
|
|
Arguments
|
|
voyageItineraryList - [VoyageItinerary]
|
|
Arguments
|
|
_voyageItineraryBerthRelationships - VoyageItineraryBerthRelationships
|
|
voyageItineraryBerth - VoyageItineraryBerth
|
|
Arguments
|
|
voyageItineraryBerthList - [VoyageItineraryBerth]
|
|
Arguments
|
|
_voyageItineraryBunkerRelationships - VoyageItineraryBunkerRelationships
|
|
voyageItineraryBunker - VoyageItineraryBunker
|
|
Arguments
|
|
voyageItineraryBunkerList - [VoyageItineraryBunker]
|
|
Arguments
|
|
_voyageItineraryCarbonRelationships - VoyageItineraryCarbonRelationships
|
|
voyageItineraryCarbon - VoyageItineraryCarbon
|
|
Arguments
|
|
voyageItineraryCarbonList - [VoyageItineraryCarbon]
|
|
Arguments
|
|
_voyageItineraryCarbonBunkerRelationships - VoyageItineraryCarbonBunkerRelationships
|
|
voyageItineraryCarbonBunker - VoyageItineraryCarbonBunker
|
|
Arguments
|
|
voyageItineraryCarbonBunkerList - [VoyageItineraryCarbonBunker]
|
|
Arguments |
|
_voyageItineraryCargoHandlingRelationships - VoyageItineraryCargoHandlingRelationships
|
|
_voyageItineraryProjectedBunkerInvoiceRelationships - VoyageItineraryProjectedBunkerInvoiceRelationships
|
|
voyageLegDetails - VoyageLegDetails
|
|
Arguments
|
|
voyageLegDetailsList - [VoyageLegDetails]
|
|
Arguments
|
|
voyageLegSummary - VoyageLegSummary
|
|
Arguments
|
|
voyageLegSummaryList - [VoyageLegSummary]
|
|
Arguments
|
|
_voyagePnlRelationships - VoyagePnlRelationships
|
|
voyagePnl - VoyagePnl
|
|
Arguments
|
|
voyagePnlList - [VoyagePnl]
|
|
Arguments
|
|
_voyagePnlBunkerRelationships - VoyagePnlBunkerRelationships
|
|
voyagePnlBunker - VoyagePnlBunker
|
|
Arguments
|
|
voyagePnlBunkerList - [VoyagePnlBunker]
|
|
Arguments
|
|
_voyagePnlBunkerDetailRelationships - VoyagePnlBunkerDetailRelationships
|
|
voyagePnlBunkerDetail - VoyagePnlBunkerDetail
|
|
Arguments
|
|
voyagePnlBunkerDetailList - [VoyagePnlBunkerDetail]
|
|
Arguments
|
|
_voyagePnlCargoRelationships - VoyagePnlCargoRelationships
|
|
voyagePnlCargo - VoyagePnlCargo
|
|
Arguments
|
|
voyagePnlCargoList - [VoyagePnlCargo]
|
|
Arguments
|
|
_voyagePnlDetailRelationships - VoyagePnlDetailRelationships
|
|
voyagePnlDetail - VoyagePnlDetail
|
|
Arguments
|
|
voyagePnlDetailList - [VoyagePnlDetail]
|
|
Arguments
|
|
_voyagePnlDrilldownRelationships - VoyagePnlDrilldownRelationships
|
|
voyagePnlDrilldown - VoyagePnlDrilldown
|
|
Arguments
|
|
voyagePnlDrilldownList - [VoyagePnlDrilldown]
|
|
Arguments
|
|
_voyagePnlItineraryLineRelationships - VoyagePnlItineraryLineRelationships
|
|
voyagePnlItineraryLine - VoyagePnlItineraryLine
|
|
Arguments
|
|
voyagePnlItineraryLineList - [VoyagePnlItineraryLine]
|
|
Arguments
|
|
_voyagePnlItineraryLineBunkerRelationships - VoyagePnlItineraryLineBunkerRelationships
|
|
voyagePnlItineraryLineBunker - VoyagePnlItineraryLineBunker
|
|
Arguments
|
|
voyagePnlItineraryLineBunkerList - [VoyagePnlItineraryLineBunker]
|
|
Arguments |
|
_voyagePnlSummaryRelationships - VoyagePnlSummaryRelationships
|
|
voyagePnlSummary - VoyagePnlSummary
|
|
Arguments
|
|
voyagePnlSummaryList - [VoyagePnlSummary]
|
|
Arguments
|
|
_voyagePortActivitiesRelationships - VoyagePortActivitiesRelationships
|
|
voyagePortActivities - VoyagePortActivities
|
|
Arguments
|
|
voyagePortActivitiesList - [VoyagePortActivities]
|
|
Arguments
|
|
_voyagePortAgentRelationships - VoyagePortAgentRelationships
|
|
voyagePortAgent - VoyagePortAgent
|
|
Arguments
|
|
voyagePortAgentList - [VoyagePortAgent]
|
|
Arguments
|
|
_voyageProfitShareRelationships - VoyageProfitShareRelationships
|
|
voyageProfitShare - VoyageProfitShare
|
|
Arguments
|
|
voyageProfitShareList - [VoyageProfitShare]
|
|
Arguments
|
|
_voyageProjectedInvoiceRelationships - VoyageProjectedInvoiceRelationships
|
|
voyageProjectedInvoice - VoyageProjectedInvoice
|
|
Arguments
|
|
voyageProjectedInvoiceList - [VoyageProjectedInvoice]
|
|
Arguments
|
|
_voyageRemarksRelationships - VoyageRemarksRelationships
|
|
voyageRemarks - VoyageRemarks
|
|
Arguments
|
|
voyageRemarksList - [VoyageRemarks]
|
|
Arguments
|
|
_voyageTemplateRelationships - VoyageTemplateRelationships
|
|
voyageTemplate - VoyageTemplate
|
|
Arguments
|
|
voyageTemplateList - [VoyageTemplate]
|
|
Arguments
|
|
_voyageTemplateRecipientRelationships - VoyageTemplateRecipientRelationships
|
|
waterway - Waterway
|
|
Arguments
|
|
waterwayList - [Waterway]
|
|
Arguments
|
|
weatherState - WeatherState
|
|
Arguments
|
|
weatherStateList - [WeatherState]
|
|
Arguments
|
|
_worksheetRelationships - WorksheetRelationships
|
|
worksheet - Worksheet
|
|
Arguments
|
|
worksheetList - [Worksheet]
|
|
Arguments
|
|
_worksheetEstimateRelationships - WorksheetEstimateRelationships
|
|
worksheetEstimate - WorksheetEstimate
|
|
Arguments
|
|
worksheetEstimateList - [WorksheetEstimate]
|
|
Arguments
|
|
_worksheetPriceComponentRelationships - WorksheetPriceComponentRelationships
|
|
worksheetPriceComponent - WorksheetPriceComponent
|
|
Arguments
|
|
worksheetPriceComponentList - [WorksheetPriceComponent]
|
|
Arguments
|
|
_worksheetVesselRelationships - WorksheetVesselRelationships
|
|
worksheetVessel - WorksheetVessel
|
|
Arguments
|
|
worksheetVesselList - [WorksheetVessel]
|
|
Arguments
|
|
Example
{
"_accountAnalysisRelationships": AccountAnalysisRelationships,
"accountAnalysis": AccountAnalysis,
"accountAnalysisList": [AccountAnalysis],
"_accountingInterfaceSummaryRelationships": AccountingInterfaceSummaryRelationships,
"accountingInterfaceSummary": AccountingInterfaceSummary,
"accountingInterfaceSummaryList": [
AccountingInterfaceSummary
],
"actDepartment": ActDepartment,
"actDepartmentList": [ActDepartment],
"_activityReportBunkerDetailRelationships": ActivityReportBunkerDetailRelationships,
"activityReportBunkerDetail": ActivityReportBunkerDetail,
"activityReportBunkerDetailList": [
ActivityReportBunkerDetail
],
"_addressBookRelationships": AddressBookRelationships,
"addressBook": AddressBook,
"addressBookList": [AddressBook],
"_addressBookAgentPortRelationships": AddressBookAgentPortRelationships,
"addressBookAgentPort": AddressBookAgentPort,
"addressBookAgentPortList": [AddressBookAgentPort],
"_addressBookBankRelationships": AddressBookBankRelationships,
"addressBookBank": AddressBookBank,
"addressBookBankList": [AddressBookBank],
"_addressBookContactRelationships": AddressBookContactRelationships,
"addressBookContact": AddressBookContact,
"addressBookContactList": [AddressBookContact],
"_addressBookExpenseRelationships": AddressBookExpenseRelationships,
"addressBookExpense": AddressBookExpense,
"addressBookExpenseList": [AddressBookExpense],
"_addressBookRegistryAccountRelationships": AddressBookRegistryAccountRelationships,
"addressBookRegistryAccount": AddressBookRegistryAccount,
"addressBookRegistryAccountList": [
AddressBookRegistryAccount
],
"_addressBookRemarkRelationships": AddressBookRemarkRelationships,
"addressBookRemark": AddressBookRemark,
"addressBookRemarkList": [AddressBookRemark],
"addressType": AddressType,
"addressTypeList": [AddressType],
"_agentAppointmentsRelationships": AgentAppointmentsRelationships,
"agentAppointments": AgentAppointments,
"agentAppointmentsList": [AgentAppointments],
"agentTypes": AgentTypes,
"agentTypesList": [AgentTypes],
"_agreedDistanceRelationships": AgreedDistanceRelationships,
"agreedDistance": AgreedDistance,
"agreedDistanceList": [AgreedDistance],
"_agreedTransitTimeBunkerRelationships": AgreedTransitTimeBunkerRelationships,
"agreedTransitTimeBunker": AgreedTransitTimeBunker,
"agreedTransitTimeBunkerList": [
AgreedTransitTimeBunker
],
"_agreedTransitTimeBunkerDetailRelationships": AgreedTransitTimeBunkerDetailRelationships,
"agreedTransitTimeBunkerDetail": AgreedTransitTimeBunkerDetail,
"agreedTransitTimeBunkerDetailList": [
AgreedTransitTimeBunkerDetail
],
"_alertRelationships": AlertRelationships,
"alert": Alert,
"alertList": [Alert],
"attachment": Attachment,
"attachmentList": [Attachment],
"_auditRelationships": AuditRelationships,
"audit": Audit,
"auditList": [Audit],
"_auditActionRelationships": AuditActionRelationships,
"auditAction": AuditAction,
"auditActionList": [AuditAction],
"_auditDetailRelationships": AuditDetailRelationships,
"auditDetail": AuditDetail,
"auditDetailList": [AuditDetail],
"_auditRowRelationships": AuditRowRelationships,
"auditRow": AuditRow,
"auditRowList": [AuditRow],
"_auditTrailRelationships": AuditTrailRelationships,
"auditTrail": AuditTrail,
"auditTrailList": [AuditTrail],
"_bareboatBrokerRelationships": BareboatBrokerRelationships,
"bareboatBroker": BareboatBroker,
"bareboatBrokerList": [BareboatBroker],
"_bareboatContractRelationships": BareboatContractRelationships,
"bareboatContract": BareboatContract,
"bareboatContractList": [BareboatContract],
"bareboatExpense": BareboatExpense,
"bareboatExpenseList": [BareboatExpense],
"bareboatHire": BareboatHire,
"bareboatHireList": [BareboatHire],
"_bargeRelationships": BargeRelationships,
"barge": Barge,
"bargeList": [Barge],
"_benchmarkEstimateRelationships": BenchmarkEstimateRelationships,
"benchmarkEstimate": BenchmarkEstimate,
"benchmarkEstimateList": [BenchmarkEstimate],
"_benchmarkEstimateBunkerRelationships": BenchmarkEstimateBunkerRelationships,
"benchmarkEstimateBunker": BenchmarkEstimateBunker,
"benchmarkEstimateBunkerList": [
BenchmarkEstimateBunker
],
"_benchmarkResultRelationships": BenchmarkResultRelationships,
"benchmarkResult": BenchmarkResult,
"benchmarkResultList": [BenchmarkResult],
"_benchmarkResultBunkerRelationships": BenchmarkResultBunkerRelationships,
"benchmarkResultBunker": BenchmarkResultBunker,
"benchmarkResultBunkerList": [BenchmarkResultBunker],
"_benchmarkSensitivityRelationships": BenchmarkSensitivityRelationships,
"benchmarkSensitivity": BenchmarkSensitivity,
"benchmarkSensitivityList": [BenchmarkSensitivity],
"_benchmarkSensitivityBunkerRelationships": BenchmarkSensitivityBunkerRelationships,
"benchmarkSensitivityBunker": BenchmarkSensitivityBunker,
"benchmarkSensitivityBunkerList": [
BenchmarkSensitivityBunker
],
"_benchmarkSensitivityCalculationRelationships": BenchmarkSensitivityCalculationRelationships,
"benchmarkSensitivityCalculation": BenchmarkSensitivityCalculation,
"benchmarkSensitivityCalculationList": [
BenchmarkSensitivityCalculation
],
"_berthBlockageRelationships": BerthBlockageRelationships,
"berthBlockage": BerthBlockage,
"berthBlockageList": [BerthBlockage],
"_billViaRelationships": BillViaRelationships,
"_bunkerExposureRelationships": BunkerExposureRelationships,
"bunkerExposure": BunkerExposure,
"bunkerExposureList": [BunkerExposure],
"_bunkerInquiriesAndPurchasesRelationships": BunkerInquiriesAndPurchasesRelationships,
"bunkerInquiriesAndPurchases": BunkerInquiriesAndPurchases,
"bunkerInquiriesAndPurchasesList": [
BunkerInquiriesAndPurchases
],
"_bunkerInquiriesAndPurchasesBunkerRelationships": BunkerInquiriesAndPurchasesBunkerRelationships,
"bunkerInquiriesAndPurchasesBunker": BunkerInquiriesAndPurchasesBunker,
"bunkerInquiriesAndPurchasesBunkerList": [
BunkerInquiriesAndPurchasesBunker
],
"_bunkerInquiriesAndPurchasesDetailRelationships": BunkerInquiriesAndPurchasesDetailRelationships,
"bunkerInquiriesAndPurchasesDetail": BunkerInquiriesAndPurchasesDetail,
"bunkerInquiriesAndPurchasesDetailList": [
BunkerInquiriesAndPurchasesDetail
],
"_bunkerInvoiceRelationships": BunkerInvoiceRelationships,
"bunkerInvoice": BunkerInvoice,
"bunkerInvoiceList": [BunkerInvoice],
"_bunkerInvoiceBunkerRelationships": BunkerInvoiceBunkerRelationships,
"bunkerInvoiceBunker": BunkerInvoiceBunker,
"bunkerInvoiceBunkerList": [BunkerInvoiceBunker],
"_bunkerLiftingDetailRelationships": BunkerLiftingDetailRelationships,
"bunkerLiftingDetail": BunkerLiftingDetail,
"bunkerLiftingDetailList": [BunkerLiftingDetail],
"_bunkerRequirementRelationships": BunkerRequirementRelationships,
"bunkerRequirement": BunkerRequirement,
"bunkerRequirementList": [BunkerRequirement],
"_bunkerRequirementBunkerRelationships": BunkerRequirementBunkerRelationships,
"bunkerRequirementBunker": BunkerRequirementBunker,
"bunkerRequirementBunkerList": [
BunkerRequirementBunker
],
"_businessRuleRelationships": BusinessRuleRelationships,
"businessRule": BusinessRule,
"businessRuleList": [BusinessRule],
"_cargoRelationships": CargoRelationships,
"cargo": Cargo,
"cargoList": [Cargo],
"_cargoBookingRelationships": CargoBookingRelationships,
"cargoBooking": CargoBooking,
"cargoBookingList": [CargoBooking],
"_cargoBookingProjectedLaytimeInvoiceRelationships": CargoBookingProjectedLaytimeInvoiceRelationships,
"_cargoBookingStowageRelationships": CargoBookingStowageRelationships,
"cargoBookingStowage": CargoBookingStowage,
"cargoBookingStowageList": [CargoBookingStowage],
"_cargoBrokerRelationships": CargoBrokerRelationships,
"cargoBroker": CargoBroker,
"cargoBrokerList": [CargoBroker],
"_cargoBunkerConsumptionRelationships": CargoBunkerConsumptionRelationships,
"cargoBunkerConsumption": CargoBunkerConsumption,
"cargoBunkerConsumptionList": [CargoBunkerConsumption],
"cargoExposureBunker": CargoExposureBunker,
"cargoExposureBunkerList": [CargoExposureBunker],
"_cargoGradesRelationships": CargoGradesRelationships,
"cargoGrades": CargoGrades,
"cargoGradesList": [CargoGrades],
"cargoHandlingEventType": CargoHandlingEventType,
"cargoHandlingEventTypeList": [CargoHandlingEventType],
"_cargoItineraryRelationships": CargoItineraryRelationships,
"cargoItinerary": CargoItinerary,
"cargoItineraryList": [CargoItinerary],
"_cargoLinkedTradeRelationships": CargoLinkedTradeRelationships,
"cargoLinkedTrade": CargoLinkedTrade,
"cargoLinkedTradeList": [CargoLinkedTrade],
"_cargoLoadDischargeOptionRelationships": CargoLoadDischargeOptionRelationships,
"cargoLoadDischargeOption": CargoLoadDischargeOption,
"cargoLoadDischargeOptionList": [
CargoLoadDischargeOption
],
"_cargoMatchingProgramRelationships": CargoMatchingProgramRelationships,
"cargoMatchingProgram": CargoMatchingProgram,
"cargoMatchingProgramList": [CargoMatchingProgram],
"_cargoNameRelationships": CargoNameRelationships,
"cargoName": CargoName,
"cargoNameList": [CargoName],
"_cargoNameAliasRelationships": CargoNameAliasRelationships,
"cargoNameAlias": CargoNameAlias,
"cargoNameAliasList": [CargoNameAlias],
"_cargoRemarkRelationships": CargoRemarkRelationships,
"cargoRemark": CargoRemark,
"cargoRemarkList": [CargoRemark],
"_cargoRevenueExpenseRelationships": CargoRevenueExpenseRelationships,
"cargoRevenueExpense": CargoRevenueExpense,
"cargoRevenueExpenseList": [CargoRevenueExpense],
"_cargoSupplierReceiverRelationships": CargoSupplierReceiverRelationships,
"cargoSupplierReceiver": CargoSupplierReceiver,
"cargoSupplierReceiverList": [CargoSupplierReceiver],
"_cargoTimeBarRelationships": CargoTimeBarRelationships,
"cargoTimeBar": CargoTimeBar,
"cargoTimeBarList": [CargoTimeBar],
"cargoType": CargoType,
"cargoTypeList": [CargoType],
"_cargoTypeGroupRelationships": CargoTypeGroupRelationships,
"cargoTypeGroup": CargoTypeGroup,
"cargoTypeGroupList": [CargoTypeGroup],
"_chartOfAccountsRelationships": ChartOfAccountsRelationships,
"chartOfAccounts": ChartOfAccounts,
"chartOfAccountsList": [ChartOfAccounts],
"_claimRelationships": ClaimRelationships,
"claim": Claim,
"claimList": [Claim],
"_claimLinkedClaimRelationships": ClaimLinkedClaimRelationships,
"_claimNoteRelationships": ClaimNoteRelationships,
"claimNote": ClaimNote,
"claimNoteList": [ClaimNote],
"_claimProjectedInvoiceRelationships": ClaimProjectedInvoiceRelationships,
"claimProjectedInvoice": ClaimProjectedInvoice,
"claimProjectedInvoiceList": [ClaimProjectedInvoice],
"_coaRelationships": COARelationships,
"coa": COA,
"coaList": [COA],
"_coaBrokerRelationships": CoaBrokerRelationships,
"coaBroker": CoaBroker,
"coaBrokerList": [CoaBroker],
"_coaDetailsRelationships": COADetailsRelationships,
"coaDetails": COADetails,
"coaDetailsList": [COADetails],
"_coaExtraFreightTermsRelationships": COAExtraFreightTermsRelationships,
"coaExtraFreightTerms": COAExtraFreightTerms,
"coaExtraFreightTermsList": [COAExtraFreightTerms],
"_coaHierarchyRelationships": CoaHierarchyRelationships,
"coaHierarchy": CoaHierarchy,
"coaHierarchyList": [CoaHierarchy],
"_coaItineraryRelationships": COAItineraryRelationships,
"coaItinerary": COAItinerary,
"coaItineraryList": [COAItinerary],
"_coaOptionRelationships": COAOptionRelationships,
"coaOption": COAOption,
"coaOptionList": [COAOption],
"_coaPeriodRelationships": CoaPeriodRelationships,
"coaPeriod": CoaPeriod,
"coaPeriodList": [CoaPeriod],
"collabStatus": CollabStatus,
"collabStatusList": [CollabStatus],
"_commodityContractRelationships": CommodityContractRelationships,
"commodityContract": CommodityContract,
"commodityContractList": [CommodityContract],
"_companyRelationships": CompanyRelationships,
"company": Company,
"companyList": [Company],
"configOptions": ConfigOptions,
"configOptionsList": [ConfigOptions],
"_consModeRelationships": ConsModeRelationships,
"consMode": ConsMode,
"consModeList": [ConsMode],
"_consModePortConsRelationships": ConsModePortConsRelationships,
"consModePortCons": ConsModePortCons,
"consModePortConsList": [ConsModePortCons],
"_consModeSeaConsRelationships": ConsModeSeaConsRelationships,
"consModeSeaCons": ConsModeSeaCons,
"consModeSeaConsList": [ConsModeSeaCons],
"correlationProfile": CorrelationProfile,
"correlationProfileList": [CorrelationProfile],
"country": Country,
"countryList": [Country],
"currency": Currency,
"currencyList": [Currency],
"dataFormView": DataFormView,
"dataFormViewList": [DataFormView],
"dataFormViewField": DataFormViewField,
"dataFormViewFieldList": [DataFormViewField],
"_decisionTableRelationships": DecisionTableRelationships,
"decisionTable": DecisionTable,
"decisionTableList": [DecisionTable],
"_decisionTableRuleReportRelationships": DecisionTableRuleReportRelationships,
"decisionTableRuleReport": DecisionTableRuleReport,
"decisionTableRuleReportList": [
DecisionTableRuleReport
],
"_delayRelationships": DelayRelationships,
"delay": Delay,
"delayList": [Delay],
"_delayBunkerRelationships": DelayBunkerRelationships,
"delayBunker": DelayBunker,
"delayBunkerList": [DelayBunker],
"_delayReasonRelationships": DelayReasonRelationships,
"delayReason": DelayReason,
"delayReasonList": [DelayReason],
"delayType": DelayType,
"delayTypeList": [DelayType],
"_demurrageAllocationDetailsRelationships": DemurrageAllocationDetailsRelationships,
"demurrageAllocationDetails": DemurrageAllocationDetails,
"demurrageAllocationDetailsList": [
DemurrageAllocationDetails
],
"_demurrageTaskLinkedLaytimeRelationships": DemurrageTaskLinkedLaytimeRelationships,
"department": Department,
"departmentList": [Department],
"equipmentContractHistory": EquipmentContractHistory,
"equipmentContractHistoryList": [
EquipmentContractHistory
],
"_estimateCargoBrokerRelationships": EstimateCargoBrokerRelationships,
"estimateCargoBroker": EstimateCargoBroker,
"estimateCargoBrokerList": [EstimateCargoBroker],
"_estimateCargoBunkerConsumptionRelationships": EstimateCargoBunkerConsumptionRelationships,
"estimateCargoBunkerConsumption": EstimateCargoBunkerConsumption,
"estimateCargoBunkerConsumptionList": [
EstimateCargoBunkerConsumption
],
"_estimateCargoesRelationships": EstimateCargoesRelationships,
"estimateCargoes": EstimateCargoes,
"estimateCargoesList": [EstimateCargoes],
"_estimateCargoExtraFreightTermsRelationships": EstimateCargoExtraFreightTermsRelationships,
"estimateCargoExtraFreightTerms": EstimateCargoExtraFreightTerms,
"estimateCargoExtraFreightTermsList": [
EstimateCargoExtraFreightTerms
],
"_estimateDelayRelationships": EstimateDelayRelationships,
"estimateDelay": EstimateDelay,
"estimateDelayList": [EstimateDelay],
"_estimateFuelEuReplacementBunkerRelationships": EstimateFuelEuReplacementBunkerRelationships,
"estimateFuelEuReplacementBunker": EstimateFuelEuReplacementBunker,
"estimateFuelEuReplacementBunkerList": [
EstimateFuelEuReplacementBunker
],
"_estimateItineraryRelationships": EstimateItineraryRelationships,
"estimateItinerary": EstimateItinerary,
"estimateItineraryList": [EstimateItinerary],
"_estimateItineraryBunkerRelationships": EstimateItineraryBunkerRelationships,
"estimateItineraryBunker": EstimateItineraryBunker,
"estimateItineraryBunkerList": [
EstimateItineraryBunker
],
"_estimateItineraryCarbonRelationships": EstimateItineraryCarbonRelationships,
"estimateItineraryCarbon": EstimateItineraryCarbon,
"estimateItineraryCarbonList": [
EstimateItineraryCarbon
],
"_estimateItineraryCarbonBunkerRelationships": EstimateItineraryCarbonBunkerRelationships,
"estimateItineraryCarbonBunker": EstimateItineraryCarbonBunker,
"estimateItineraryCarbonBunkerList": [
EstimateItineraryCarbonBunker
],
"_exchangeRateRelationships": ExchangeRateRelationships,
"exchangeRate": ExchangeRate,
"exchangeRateList": [ExchangeRate],
"expense": Expense,
"expenseList": [Expense],
"_extraFreightTermsRelationships": ExtraFreightTermsRelationships,
"extraFreightTerms": ExtraFreightTerms,
"extraFreightTermsList": [ExtraFreightTerms],
"_financialsAndOperationsInvoiceNotesRelationships": FinancialsAndOperationsInvoiceNotesRelationships,
"financialsAndOperationsInvoiceNotes": FinancialsAndOperationsInvoiceNotes,
"financialsAndOperationsInvoiceNotesList": [
FinancialsAndOperationsInvoiceNotes
],
"_financialsInvoiceRelationships": FinancialsInvoiceRelationships,
"financialsInvoice": FinancialsInvoice,
"financialsInvoiceList": [FinancialsInvoice],
"_financialsInvoiceDetailRelationships": FinancialsInvoiceDetailRelationships,
"financialsInvoiceDetail": FinancialsInvoiceDetail,
"financialsInvoiceDetailList": [
FinancialsInvoiceDetail
],
"_financialsInvoiceDetailCargoAllocationRelationships": FinancialsInvoiceDetailCargoAllocationRelationships,
"financialsInvoiceDetailCargoAllocation": FinancialsInvoiceDetailCargoAllocation,
"financialsInvoiceDetailCargoAllocationList": [
FinancialsInvoiceDetailCargoAllocation
],
"_financialsInvoicePaymentRelationships": FinancialsInvoicePaymentRelationships,
"financialsInvoicePayment": FinancialsInvoicePayment,
"financialsInvoicePaymentList": [
FinancialsInvoicePayment
],
"_fixtureRelationships": FixtureRelationships,
"fixture": Fixture,
"fixtureList": [Fixture],
"_fixtureRemarkRelationships": FixtureRemarkRelationships,
"fixtureRemark": FixtureRemark,
"fixtureRemarkList": [FixtureRemark],
"_formRelationships": FormRelationships,
"form": Form,
"formList": [Form],
"formTemplate": FormTemplate,
"formTemplateList": [FormTemplate],
"_freightInvoiceRelationships": FreightInvoiceRelationships,
"freightInvoice": FreightInvoice,
"freightInvoiceList": [FreightInvoice],
"freightTerm": FreightTerm,
"freightTermList": [FreightTerm],
"fuelEmissionsFactorsSet": FuelEmissionsFactorsSet,
"fuelEmissionsFactorsSetList": [
FuelEmissionsFactorsSet
],
"fuelLubeType": FuelLubeType,
"fuelLubeTypeList": [FuelLubeType],
"_fuelZoneRelationships": FuelZoneRelationships,
"fuelZone": FuelZone,
"fuelZoneList": [FuelZone],
"_fuelZoneSetRelationships": FuelZoneSetRelationships,
"fuelZoneSet": FuelZoneSet,
"fuelZoneSetList": [FuelZoneSet],
"_groupMemberRelationships": GroupMemberRelationships,
"groupMember": GroupMember,
"groupMemberList": [GroupMember],
"_headFixturePurchaseSaleRelationships": HeadFixturePurchaseSaleRelationships,
"headFixturePurchaseSale": HeadFixturePurchaseSale,
"headFixturePurchaseSaleList": [
HeadFixturePurchaseSale
],
"_holidayRelationships": HolidayRelationships,
"holiday": Holiday,
"holidayList": [Holiday],
"imosUser": ImosUser,
"imosUserList": [ImosUser],
"interfaceMessagesAndNotifications": InterfaceMessagesAndNotifications,
"interfaceMessagesAndNotificationsList": [
InterfaceMessagesAndNotifications
],
"_internalFinalFreightStatementVoyageRelationships": InternalFinalFreightStatementVoyageRelationships,
"_internalIndexHireTimeChartersRelationships": InternalIndexHireTimeChartersRelationships,
"_invoiceNoteRelationships": InvoiceNoteRelationships,
"invoiceNote": InvoiceNote,
"invoiceNoteList": [InvoiceNote],
"jobStatus": JobStatus,
"jobStatusList": [JobStatus],
"_laytimeRelationships": LaytimeRelationships,
"laytime": Laytime,
"laytimeList": [Laytime],
"_laytimePortActivitiesRelationships": LaytimePortActivitiesRelationships,
"laytimePortActivities": LaytimePortActivities,
"laytimePortActivitiesList": [LaytimePortActivities],
"_laytimePortDeductionRelationships": LaytimePortDeductionRelationships,
"laytimePortDeduction": LaytimePortDeduction,
"laytimePortDeductionList": [LaytimePortDeduction],
"_laytimePortsRelationships": LaytimePortsRelationships,
"laytimePorts": LaytimePorts,
"laytimePortsList": [LaytimePorts],
"laytimeTerms": LaytimeTerms,
"laytimeTermsList": [LaytimeTerms],
"_loadDischargeStandardRateRelationships": LoadDischargeStandardRateRelationships,
"loadDischargeStandardRate": LoadDischargeStandardRate,
"loadDischargeStandardRateList": [
LoadDischargeStandardRate
],
"_loadDischargeTableRatesRelationships": LoadDischargeTableRatesRelationships,
"loadDischargeTableRates": LoadDischargeTableRates,
"loadDischargeTableRatesList": [
LoadDischargeTableRates
],
"_loadlineZoneRelationships": LoadlineZoneRelationships,
"loadlineZone": LoadlineZone,
"loadlineZoneList": [LoadlineZone],
"_loadlineZoneDetailsRelationships": LoadlineZoneDetailsRelationships,
"loadlineZoneDetails": LoadlineZoneDetails,
"loadlineZoneDetailsList": [LoadlineZoneDetails],
"lob": Lob,
"lobList": [Lob],
"_marketRelationships": MarketRelationships,
"market": Market,
"marketList": [Market],
"_marketCargoRelationships": MarketCargoRelationships,
"marketCargo": MarketCargo,
"marketCargoList": [MarketCargo],
"_marketDataRelationships": MarketDataRelationships,
"marketData": MarketData,
"marketDataList": [MarketData],
"_marketPositionRelationships": MarketPositionRelationships,
"marketPosition": MarketPosition,
"marketPositionList": [MarketPosition],
"_marketPositionSourceRelationships": MarketPositionSourceRelationships,
"marketPositionSource": MarketPositionSource,
"marketPositionSourceList": [MarketPositionSource],
"_masterContractRelationships": MasterContractRelationships,
"masterContract": MasterContract,
"masterContractList": [MasterContract],
"_masterContractBrokerRelationships": MasterContractBrokerRelationships,
"_moduleAccessRelationships": ModuleAccessRelationships,
"moduleAccess": ModuleAccess,
"moduleAccessList": [ModuleAccess],
"notification": Notification,
"notificationList": [Notification],
"_objectAccessRelationships": ObjectAccessRelationships,
"objectAccess": ObjectAccess,
"objectAccessList": [ObjectAccess],
"objectApproval": ObjectApproval,
"objectApprovalList": [ObjectApproval],
"_operationsInvoiceRelationships": OperationsInvoiceRelationships,
"operationsInvoice": OperationsInvoice,
"operationsInvoiceList": [OperationsInvoice],
"_operationsInvoiceApprovalRelationships": OperationsInvoiceApprovalRelationships,
"operationsInvoiceApproval": OperationsInvoiceApproval,
"operationsInvoiceApprovalList": [
OperationsInvoiceApproval
],
"_operationsInvoiceDetailCargoAllocationRelationships": OperationsInvoiceDetailCargoAllocationRelationships,
"operationsInvoiceDetailCargoAllocation": OperationsInvoiceDetailCargoAllocation,
"operationsInvoiceDetailCargoAllocationList": [
OperationsInvoiceDetailCargoAllocation
],
"_operationsInvoiceDetailsRelationships": OperationsInvoiceDetailsRelationships,
"operationsInvoiceDetails": OperationsInvoiceDetails,
"operationsInvoiceDetailsList": [
OperationsInvoiceDetails
],
"_operationsInvoiceNoteRelationships": OperationsInvoiceNoteRelationships,
"operationsLedger": OperationsLedger,
"operationsLedgerList": [OperationsLedger],
"_operationsPaymentDetailsRelationships": OperationsPaymentDetailsRelationships,
"operationsPaymentDetails": OperationsPaymentDetails,
"operationsPaymentDetailsList": [
OperationsPaymentDetails
],
"_paperTradeRelationships": PaperTradeRelationships,
"paperTrade": PaperTrade,
"paperTradeList": [PaperTrade],
"_paperTradeExposurePeriodRelationships": PaperTradeExposurePeriodRelationships,
"paperTradeExposurePeriod": PaperTradeExposurePeriod,
"paperTradeExposurePeriodList": [
PaperTradeExposurePeriod
],
"_paymentRelationships": PaymentRelationships,
"payment": Payment,
"paymentList": [Payment],
"_paymentBatchRelationships": PaymentBatchRelationships,
"paymentBatch": PaymentBatch,
"paymentBatchList": [PaymentBatch],
"_paymentBatchDetailsRelationships": PaymentBatchDetailsRelationships,
"paymentBatchDetails": PaymentBatchDetails,
"paymentBatchDetailsList": [PaymentBatchDetails],
"_paymentDetailRelationships": PaymentDetailRelationships,
"paymentDetail": PaymentDetail,
"paymentDetailList": [PaymentDetail],
"paymentTerm": PaymentTerm,
"paymentTermList": [PaymentTerm],
"_poolRelationships": PoolRelationships,
"pool": Pool,
"poolList": [Pool],
"_poolAdminAccountRelationships": PoolAdminAccountRelationships,
"poolAdminAccount": PoolAdminAccount,
"poolAdminAccountList": [PoolAdminAccount],
"_poolAssignmentRelationships": PoolAssignmentRelationships,
"poolAssignment": PoolAssignment,
"poolAssignmentList": [PoolAssignment],
"_poolAssignmentPremiumRelationships": PoolAssignmentPremiumRelationships,
"poolAssignmentPremium": PoolAssignmentPremium,
"poolAssignmentPremiumList": [PoolAssignmentPremium],
"_poolingDistributionRelationships": PoolingDistributionRelationships,
"poolingDistribution": PoolingDistribution,
"poolingDistributionList": [PoolingDistribution],
"_poolingDistributionPremiumRelationships": PoolingDistributionPremiumRelationships,
"poolingDistributionPremium": PoolingDistributionPremium,
"poolingDistributionPremiumList": [
PoolingDistributionPremium
],
"_portRelationships": PortRelationships,
"port": Port,
"portList": [Port],
"portActivity": PortActivity,
"portActivityList": [PortActivity],
"_portActivityBunkerRelationships": PortActivityBunkerRelationships,
"portActivityBunker": PortActivityBunker,
"portActivityBunkerList": [PortActivityBunker],
"_portAdvanceDaRelationships": PortAdvanceDaRelationships,
"portArea": PortArea,
"portAreaList": [PortArea],
"_portBerthRelationships": PortBerthRelationships,
"portBerth": PortBerth,
"portBerthList": [PortBerth],
"_portCargoCompatRelationships": PortCargoCompatRelationships,
"portCargoCompat": PortCargoCompat,
"portCargoCompatList": [PortCargoCompat],
"_portCargoCompatBerthRelationships": PortCargoCompatBerthRelationships,
"portCargoCompatBerth": PortCargoCompatBerth,
"portCargoCompatBerthList": [PortCargoCompatBerth],
"_portExpenseRelationships": PortExpenseRelationships,
"portExpense": PortExpense,
"portExpenseList": [PortExpense],
"_portExpenseMiscDetailsRelationships": PortExpenseMiscDetailsRelationships,
"portExpenseMiscDetails": PortExpenseMiscDetails,
"portExpenseMiscDetailsList": [PortExpenseMiscDetails],
"_portExpensesStandardRelationships": PortExpensesStandardRelationships,
"portExpensesStandard": PortExpensesStandard,
"portExpensesStandardList": [PortExpensesStandard],
"_portExpenseStandardDetailRelationships": PortExpenseStandardDetailRelationships,
"portExpenseStandardDetail": PortExpenseStandardDetail,
"portExpenseStandardDetailList": [
PortExpenseStandardDetail
],
"_portFuelAvailabilityRelationships": PortFuelAvailabilityRelationships,
"portFuelAvailability": PortFuelAvailability,
"portFuelAvailabilityList": [PortFuelAvailability],
"portFunction": PortFunction,
"portFunctionList": [PortFunction],
"_portVesselRelationships": PortVesselRelationships,
"portVessel": PortVessel,
"portVesselList": [PortVessel],
"_portVesselBerthRelationships": PortVesselBerthRelationships,
"portVesselBerth": PortVesselBerth,
"portVesselBerthList": [PortVesselBerth],
"_positionRelationships": PositionRelationships,
"position": Position,
"positionList": [Position],
"region": Region,
"regionList": [Region],
"_reminderRelationships": ReminderRelationships,
"reminder": Reminder,
"reminderList": [Reminder],
"report": Report,
"reportList": [Report],
"_reportUserViewRelationships": ReportUserViewRelationships,
"reportUserView": ReportUserView,
"reportUserViewList": [ReportUserView],
"_reportViewRelationships": ReportViewRelationships,
"reportView": ReportView,
"reportViewList": [ReportView],
"_revisionRelationships": RevisionRelationships,
"revision": Revision,
"revisionList": [Revision],
"revisionPanelContent": RevisionPanelContent,
"revisionPanelContentList": [RevisionPanelContent],
"_revisionRowRelationships": RevisionRowRelationships,
"revisionRow": RevisionRow,
"revisionRowList": [RevisionRow],
"_scheduleBargeRelationships": ScheduleBargeRelationships,
"scheduleBarge": ScheduleBarge,
"scheduleBargeList": [ScheduleBarge],
"sharedResources": SharedResources,
"sharedResourcesList": [SharedResources],
"_standardExpenseRelationships": StandardExpenseRelationships,
"standardExpense": StandardExpense,
"standardExpenseList": [StandardExpense],
"_standardExpenseConditionRelationships": StandardExpenseConditionRelationships,
"_standardRateRelationships": StandardRateRelationships,
"standardRate": StandardRate,
"standardRateList": [StandardRate],
"vesonSubscription": VesonSubscription,
"vesonSubscriptionList": [VesonSubscription],
"_surveyCostDetailsRelationships": SurveyCostDetailsRelationships,
"surveyCostDetails": SurveyCostDetails,
"surveyCostDetailsList": [SurveyCostDetails],
"_surveyCostsBunkersRelationships": SurveyCostsBunkersRelationships,
"surveyCostsBunkers": SurveyCostsBunkers,
"surveyCostsBunkersList": [SurveyCostsBunkers],
"_tankConditionRelationships": TankConditionRelationships,
"tankCondition": TankCondition,
"tankConditionList": [TankCondition],
"_taskRelationships": TaskRelationships,
"task": Task,
"taskList": [Task],
"taskGroup": TaskGroup,
"taskGroupList": [TaskGroup],
"taskGroupItem": TaskGroupItem,
"taskGroupItemList": [TaskGroupItem],
"_tasksAndAlertsRelationships": TasksAndAlertsRelationships,
"tasksAndAlerts": TasksAndAlerts,
"tasksAndAlertsList": [TasksAndAlerts],
"tcDeduction": TCDeduction,
"tcDeductionList": [TCDeduction],
"_teamRelationships": TeamRelationships,
"team": Team,
"teamList": [Team],
"_termRelationships": TermRelationships,
"term": Term,
"termList": [Term],
"_timeCharterBrokerRelationships": TimeCharterBrokerRelationships,
"timeCharterBroker": TimeCharterBroker,
"timeCharterBrokerList": [TimeCharterBroker],
"_timeCharterBunkerDeliveryRelationships": TimeCharterBunkerDeliveryRelationships,
"timeCharterBunkerDelivery": TimeCharterBunkerDelivery,
"timeCharterBunkerDeliveryList": [
TimeCharterBunkerDelivery
],
"_timeCharterBunkerExposureRelationships": TimeCharterBunkerExposureRelationships,
"timeCharterBunkerExposure": TimeCharterBunkerExposure,
"timeCharterBunkerExposureList": [
TimeCharterBunkerExposure
],
"_timeCharterCOARelationships": TimeCharterCOARelationships,
"timeCharterCOA": TimeCharterCOA,
"timeCharterCOAList": [TimeCharterCOA],
"_timeCharterCOABrokerRelationships": TimeCharterCOABrokerRelationships,
"_timeCharterCOADeliveryRedeliveryOptionRelationships": TimeCharterCOADeliveryRedeliveryOptionRelationships,
"timeCharterCOADeliveryRedeliveryOption": TimeCharterCOADeliveryRedeliveryOption,
"timeCharterCOADeliveryRedeliveryOptionList": [
TimeCharterCOADeliveryRedeliveryOption
],
"_timeCharterCOAExpenseRelationships": TimeCharterCOAExpenseRelationships,
"_timeCharterCOAHireRelationships": TimeCharterCOAHireRelationships,
"_timeCharterCOAVesselRelationships": TimeCharterCOAVesselRelationships,
"timeCharterCOAVessel": TimeCharterCOAVessel,
"timeCharterCOAVesselList": [TimeCharterCOAVessel],
"_timeCharterCOAVesselTypeRelationships": TimeCharterCOAVesselTypeRelationships,
"timeCharterCOAVesselType": TimeCharterCOAVesselType,
"timeCharterCOAVesselTypeList": [
TimeCharterCOAVesselType
],
"_timeCharterContractRelationships": TimeCharterContractRelationships,
"timeCharterContract": TimeCharterContract,
"timeCharterContractList": [TimeCharterContract],
"_timeCharterExpenseRelationships": TimeCharterExpenseRelationships,
"timeCharterExpense": TimeCharterExpense,
"timeCharterExpenseList": [TimeCharterExpense],
"_timeCharterExposurePeriodRelationships": TimeCharterExposurePeriodRelationships,
"timeCharterExposurePeriod": TimeCharterExposurePeriod,
"timeCharterExposurePeriodList": [
TimeCharterExposurePeriod
],
"timeCharterExtra": TimeCharterExtra,
"timeCharterExtraList": [TimeCharterExtra],
"_timeCharterHireRelationships": TimeCharterHireRelationships,
"timeCharterHire": TimeCharterHire,
"timeCharterHireList": [TimeCharterHire],
"_timeCharterLeaseRelationships": TimeCharterLeaseRelationships,
"timeCharterLease": TimeCharterLease,
"timeCharterLeaseList": [TimeCharterLease],
"_timeCharterLiftingOptionRelationships": TimeCharterLiftingOptionRelationships,
"timeCharterLiftingOption": TimeCharterLiftingOption,
"timeCharterLiftingOptionList": [
TimeCharterLiftingOption
],
"_timeCharterOutDetailsRelationships": TimeCharterOutDetailsRelationships,
"timeCharterOutDetails": TimeCharterOutDetails,
"timeCharterOutDetailsList": [TimeCharterOutDetails],
"_timeCharterPortConsumptionRelationships": TimeCharterPortConsumptionRelationships,
"timeCharterPortConsumption": TimeCharterPortConsumption,
"timeCharterPortConsumptionList": [
TimeCharterPortConsumption
],
"timeCharterProfitShare": TimeCharterProfitShare,
"timeCharterProfitShareList": [TimeCharterProfitShare],
"_timeCharterProfitShareContractsRelationships": TimeCharterProfitShareContractsRelationships,
"timeCharterProfitShareContracts": TimeCharterProfitShareContracts,
"timeCharterProfitShareContractsList": [
TimeCharterProfitShareContracts
],
"_timeCharterProjectedInvoiceRelationships": TimeCharterProjectedInvoiceRelationships,
"timeCharterProjectedInvoice": TimeCharterProjectedInvoice,
"timeCharterProjectedInvoiceList": [
TimeCharterProjectedInvoice
],
"_timeCharterPurchaseOptionRelationships": TimeCharterPurchaseOptionRelationships,
"timeCharterPurchaseOption": TimeCharterPurchaseOption,
"timeCharterPurchaseOptionList": [
TimeCharterPurchaseOption
],
"_timeCharterSeaConsumptionRelationships": TimeCharterSeaConsumptionRelationships,
"timeCharterSeaConsumption": TimeCharterSeaConsumption,
"timeCharterSeaConsumptionList": [
TimeCharterSeaConsumption
],
"_timeCharterSeaConsumptionBunkerRelationships": TimeCharterSeaConsumptionBunkerRelationships,
"timeCharterSeaConsumptionBunker": TimeCharterSeaConsumptionBunker,
"timeCharterSeaConsumptionBunkerList": [
TimeCharterSeaConsumptionBunker
],
"timeCharterTonnageTax": TimeCharterTonnageTax,
"timeCharterTonnageTaxList": [TimeCharterTonnageTax],
"timeCharterWarrantyConsumption": TimeCharterWarrantyConsumption,
"timeCharterWarrantyConsumptionList": [
TimeCharterWarrantyConsumption
],
"_timeCharterWarrantyDelayExclusionRelationships": TimeCharterWarrantyDelayExclusionRelationships,
"timeCharterWarrantyDelayExclusion": TimeCharterWarrantyDelayExclusion,
"timeCharterWarrantyDelayExclusionList": [
TimeCharterWarrantyDelayExclusion
],
"timeZoneCodes": TimeZoneCodes,
"timeZoneCodesList": [TimeZoneCodes],
"timeZoneInfo": TimeZoneInfo,
"timeZoneInfoList": [TimeZoneInfo],
"_tradeAreaRelationships": TradeAreaRelationships,
"tradeArea": TradeArea,
"tradeAreaList": [TradeArea],
"_tradeBrokerRelationships": TradeBrokerRelationships,
"tradeBroker": TradeBroker,
"tradeBrokerList": [TradeBroker],
"_tradeContractRelationships": TradeContractRelationships,
"tradeContract": TradeContract,
"tradeContractList": [TradeContract],
"tradeFilter": TradeFilter,
"tradeFilterList": [TradeFilter],
"_tradeFilterDetailRelationships": TradeFilterDetailRelationships,
"tradeFilterDetail": TradeFilterDetail,
"tradeFilterDetailList": [TradeFilterDetail],
"_tradeIndexRelationships": TradeIndexRelationships,
"tradeIndex": TradeIndex,
"tradeIndexList": [TradeIndex],
"_tradePnlRelationships": TradePnlRelationships,
"tradePnl": TradePnl,
"tradePnlList": [TradePnl],
"_tradePnlDetailRelationships": TradePnlDetailRelationships,
"tradePnlDetail": TradePnlDetail,
"tradePnlDetailList": [TradePnlDetail],
"_tradeSnapshotRelationships": TradeSnapshotRelationships,
"tradeSnapshot": TradeSnapshot,
"tradeSnapshotList": [TradeSnapshot],
"_tradeTypeRelationships": TradeTypeRelationships,
"tradeType": TradeType,
"tradeTypeList": [TradeType],
"_tradeUnitRelationships": TradeUnitRelationships,
"tradeUnit": TradeUnit,
"tradeUnitList": [TradeUnit],
"_tradingProfileRelationships": TradingProfileRelationships,
"tradingProfile": TradingProfile,
"tradingProfileList": [TradingProfile],
"_tradingProfilePropertyRelationships": TradingProfilePropertyRelationships,
"tradingProfileProperty": TradingProfileProperty,
"tradingProfilePropertyList": [TradingProfileProperty],
"_unitOfMeasureRelationships": UnitOfMeasureRelationships,
"unitOfMeasure": UnitOfMeasure,
"unitOfMeasureList": [UnitOfMeasure],
"_unpricedElementRelationships": UnpricedElementRelationships,
"unpricedElement": UnpricedElement,
"unpricedElementList": [UnpricedElement],
"_unpricedElementRemarkRelationships": UnpricedElementRemarkRelationships,
"_unpricedElementStructureRelationships": UnpricedElementStructureRelationships,
"unpricedElementStructure": UnpricedElementStructure,
"unpricedElementStructureList": [
UnpricedElementStructure
],
"_userRelationships": UserRelationships,
"user": User,
"userList": [User],
"userField": UserField,
"userFieldList": [UserField],
"_vesselRelationships": VesselRelationships,
"vessel": Vessel,
"vesselList": [Vessel],
"_vesselBoatsRelationships": VesselBoatsRelationships,
"vesselBoats": VesselBoats,
"vesselBoatsList": [VesselBoats],
"_vesselBunkerTankRelationships": VesselBunkerTankRelationships,
"vesselBunkerTank": VesselBunkerTank,
"vesselBunkerTankList": [VesselBunkerTank],
"_vesselConsModeRelationships": VesselConsModeRelationships,
"vesselConsMode": VesselConsMode,
"vesselConsModeList": [VesselConsMode],
"_vesselCraneRelationships": VesselCraneRelationships,
"vesselCrane": VesselCrane,
"vesselCraneList": [VesselCrane],
"_vesselDetailsRelationships": VesselDetailsRelationships,
"vesselDetails": VesselDetails,
"vesselDetailsList": [VesselDetails],
"_vesselDraftRelationships": VesselDraftRelationships,
"vesselDraft": VesselDraft,
"vesselDraftList": [VesselDraft],
"_vesselDraftMarksRelationships": VesselDraftMarksRelationships,
"vesselDraftMarks": VesselDraftMarks,
"vesselDraftMarksList": [VesselDraftMarks],
"_vesselEvaluationRelationships": VesselEvaluationRelationships,
"vesselEvaluation": VesselEvaluation,
"vesselEvaluationList": [VesselEvaluation],
"_vesselFleetMemberRelationships": VesselFleetMemberRelationships,
"vesselFleetMember": VesselFleetMember,
"vesselFleetMemberList": [VesselFleetMember],
"_vesselFleetMemberFullRelationships": VesselFleetMemberFullRelationships,
"vesselFleetMemberFull": VesselFleetMemberFull,
"vesselFleetMemberFullList": [VesselFleetMemberFull],
"_vesselHatchRelationships": VesselHatchRelationships,
"vesselHatch": VesselHatch,
"vesselHatchList": [VesselHatch],
"_vesselHoldRelationships": VesselHoldRelationships,
"vesselHold": VesselHold,
"vesselHoldList": [VesselHold],
"_vesselIncidentRelationships": VesselIncidentRelationships,
"vesselIncident": VesselIncident,
"vesselIncidentList": [VesselIncident],
"_vesselInspectionRelationships": VesselInspectionRelationships,
"vesselInspection": VesselInspection,
"vesselInspectionList": [VesselInspection],
"_vesselPortConsRelationships": VesselPortConsRelationships,
"vesselPortCons": VesselPortCons,
"vesselPortConsList": [VesselPortCons],
"vesselRoute": VesselRoute,
"vesselRouteList": [VesselRoute],
"_vesselsAndBargesRelationships": VesselsAndBargesRelationships,
"_vesselSeaConsRelationships": VesselSeaConsRelationships,
"vesselSeaCons": VesselSeaCons,
"vesselSeaConsList": [VesselSeaCons],
"_vesselSeaConsBunkerRelationships": VesselSeaConsBunkerRelationships,
"vesselSeaConsBunker": VesselSeaConsBunker,
"vesselSeaConsBunkerList": [VesselSeaConsBunker],
"_vesselTankRelationships": VesselTankRelationships,
"vesselTank": VesselTank,
"vesselTankList": [VesselTank],
"_vesselTceTargetRelationships": VesselTceTargetRelationships,
"vesselTceTarget": VesselTceTarget,
"vesselTceTargetList": [VesselTceTarget],
"_vesselTypeRelationships": VesselTypeRelationships,
"vesselType": VesselType,
"vesselTypeList": [VesselType],
"_vesselVariablesRelationships": VesselVariablesRelationships,
"_vesselVettingRelationships": VesselVettingRelationships,
"vesselVetting": VesselVetting,
"vesselVettingList": [VesselVetting],
"_voyageRelationships": VoyageRelationships,
"voyage": Voyage,
"voyageList": [Voyage],
"_voyageActivityReportRelationships": VoyageActivityReportRelationships,
"voyageActivityReport": VoyageActivityReport,
"voyageActivityReportList": [VoyageActivityReport],
"_voyageAndTcoFixtureRelationships": VoyageAndTcoFixtureRelationships,
"voyageAndTcoFixture": VoyageAndTcoFixture,
"voyageAndTcoFixtureList": [VoyageAndTcoFixture],
"_voyageBunkerInventoryRelationships": VoyageBunkerInventoryRelationships,
"voyageBunkerInventory": VoyageBunkerInventory,
"voyageBunkerInventoryList": [VoyageBunkerInventory],
"_voyageBunkerInventoryDetailRelationships": VoyageBunkerInventoryDetailRelationships,
"voyageBunkerInventoryDetail": VoyageBunkerInventoryDetail,
"voyageBunkerInventoryDetailList": [
VoyageBunkerInventoryDetail
],
"_voyageBunkerLiftingRelationships": VoyageBunkerLiftingRelationships,
"voyageBunkerLifting": VoyageBunkerLifting,
"voyageBunkerLiftingList": [VoyageBunkerLifting],
"_voyageBunkerSummaryRelationships": VoyageBunkerSummaryRelationships,
"voyageBunkerSummary": VoyageBunkerSummary,
"voyageBunkerSummaryList": [VoyageBunkerSummary],
"_voyageCargoHandlingRelationships": VoyageCargoHandlingRelationships,
"voyageCargoHandling": VoyageCargoHandling,
"voyageCargoHandlingList": [VoyageCargoHandling],
"_voyageCargoHandlingDocumentRelationships": VoyageCargoHandlingDocumentRelationships,
"voyageCargoHandlingDocument": VoyageCargoHandlingDocument,
"voyageCargoHandlingDocumentList": [
VoyageCargoHandlingDocument
],
"_voyageCargoHandlingEventRelationships": VoyageCargoHandlingEventRelationships,
"voyageCargoHandlingEvent": VoyageCargoHandlingEvent,
"voyageCargoHandlingEventList": [
VoyageCargoHandlingEvent
],
"_voyageCargoHandlingStowageRelationships": VoyageCargoHandlingStowageRelationships,
"voyageCargoHandlingStowage": VoyageCargoHandlingStowage,
"voyageCargoHandlingStowageList": [
VoyageCargoHandlingStowage
],
"_voyageCargoTransferRelationships": VoyageCargoTransferRelationships,
"voyageCargoTransfer": VoyageCargoTransfer,
"voyageCargoTransferList": [VoyageCargoTransfer],
"_voyageContactRelationships": VoyageContactRelationships,
"voyageContact": VoyageContact,
"voyageContactList": [VoyageContact],
"_voyageContactFullRelationships": VoyageContactFullRelationships,
"_voyageEmissionsRelationships": VoyageEmissionsRelationships,
"voyageEmissions": VoyageEmissions,
"voyageEmissionsList": [VoyageEmissions],
"_voyageEmissionsDetailRelationships": VoyageEmissionsDetailRelationships,
"voyageEmissionsDetail": VoyageEmissionsDetail,
"voyageEmissionsDetailList": [VoyageEmissionsDetail],
"_voyageEquipmentEventRelationships": VoyageEquipmentEventRelationships,
"voyageEquipmentEvent": VoyageEquipmentEvent,
"voyageEquipmentEventList": [VoyageEquipmentEvent],
"_voyageEstimateRelationships": VoyageEstimateRelationships,
"voyageEstimate": VoyageEstimate,
"voyageEstimateList": [VoyageEstimate],
"_voyageEstimateBunkerRelationships": VoyageEstimateBunkerRelationships,
"voyageEstimateBunker": VoyageEstimateBunker,
"voyageEstimateBunkerList": [VoyageEstimateBunker],
"_voyageEstimateCOACVCAnalysisRelationships": VoyageEstimateCOACVCAnalysisRelationships,
"voyageEstimateCOACVCAnalysis": VoyageEstimateCOACVCAnalysis,
"voyageEstimateCOACVCAnalysisList": [
VoyageEstimateCOACVCAnalysis
],
"_voyageEstimateCOACVCAnalysisResultRelationships": VoyageEstimateCOACVCAnalysisResultRelationships,
"voyageEstimateCOACVCAnalysisResult": VoyageEstimateCOACVCAnalysisResult,
"voyageEstimateCOACVCAnalysisResultList": [
VoyageEstimateCOACVCAnalysisResult
],
"_voyageEstimateCOACVCAnalysisResultBunkerRelationships": VoyageEstimateCOACVCAnalysisResultBunkerRelationships,
"voyageEstimateCOACVCAnalysisResultBunker": VoyageEstimateCOACVCAnalysisResultBunker,
"voyageEstimateCOACVCAnalysisResultBunkerList": [
VoyageEstimateCOACVCAnalysisResultBunker
],
"_voyageEstimateMiscExpenseRelationships": VoyageEstimateMiscExpenseRelationships,
"voyageEstimateMiscExpense": VoyageEstimateMiscExpense,
"voyageEstimateMiscExpenseList": [
VoyageEstimateMiscExpense
],
"_voyageEstimatePortExpenseRelationships": VoyageEstimatePortExpenseRelationships,
"voyageEstimatePortExpense": VoyageEstimatePortExpense,
"voyageEstimatePortExpenseList": [
VoyageEstimatePortExpense
],
"_voyageEstimateTimeCharterExpenseRelationships": VoyageEstimateTimeCharterExpenseRelationships,
"voyageEstimateTimeCharterExpense": VoyageEstimateTimeCharterExpense,
"voyageEstimateTimeCharterExpenseList": [
VoyageEstimateTimeCharterExpense
],
"voyageInstruction": VoyageInstruction,
"voyageInstructionList": [VoyageInstruction],
"_voyageItineraryRelationships": VoyageItineraryRelationships,
"voyageItinerary": VoyageItinerary,
"voyageItineraryList": [VoyageItinerary],
"_voyageItineraryBerthRelationships": VoyageItineraryBerthRelationships,
"voyageItineraryBerth": VoyageItineraryBerth,
"voyageItineraryBerthList": [VoyageItineraryBerth],
"_voyageItineraryBunkerRelationships": VoyageItineraryBunkerRelationships,
"voyageItineraryBunker": VoyageItineraryBunker,
"voyageItineraryBunkerList": [VoyageItineraryBunker],
"_voyageItineraryCarbonRelationships": VoyageItineraryCarbonRelationships,
"voyageItineraryCarbon": VoyageItineraryCarbon,
"voyageItineraryCarbonList": [VoyageItineraryCarbon],
"_voyageItineraryCarbonBunkerRelationships": VoyageItineraryCarbonBunkerRelationships,
"voyageItineraryCarbonBunker": VoyageItineraryCarbonBunker,
"voyageItineraryCarbonBunkerList": [
VoyageItineraryCarbonBunker
],
"_voyageItineraryCargoHandlingRelationships": VoyageItineraryCargoHandlingRelationships,
"_voyageItineraryProjectedBunkerInvoiceRelationships": VoyageItineraryProjectedBunkerInvoiceRelationships,
"voyageLegDetails": VoyageLegDetails,
"voyageLegDetailsList": [VoyageLegDetails],
"voyageLegSummary": VoyageLegSummary,
"voyageLegSummaryList": [VoyageLegSummary],
"_voyagePnlRelationships": VoyagePnlRelationships,
"voyagePnl": VoyagePnl,
"voyagePnlList": [VoyagePnl],
"_voyagePnlBunkerRelationships": VoyagePnlBunkerRelationships,
"voyagePnlBunker": VoyagePnlBunker,
"voyagePnlBunkerList": [VoyagePnlBunker],
"_voyagePnlBunkerDetailRelationships": VoyagePnlBunkerDetailRelationships,
"voyagePnlBunkerDetail": VoyagePnlBunkerDetail,
"voyagePnlBunkerDetailList": [VoyagePnlBunkerDetail],
"_voyagePnlCargoRelationships": VoyagePnlCargoRelationships,
"voyagePnlCargo": VoyagePnlCargo,
"voyagePnlCargoList": [VoyagePnlCargo],
"_voyagePnlDetailRelationships": VoyagePnlDetailRelationships,
"voyagePnlDetail": VoyagePnlDetail,
"voyagePnlDetailList": [VoyagePnlDetail],
"_voyagePnlDrilldownRelationships": VoyagePnlDrilldownRelationships,
"voyagePnlDrilldown": VoyagePnlDrilldown,
"voyagePnlDrilldownList": [VoyagePnlDrilldown],
"_voyagePnlItineraryLineRelationships": VoyagePnlItineraryLineRelationships,
"voyagePnlItineraryLine": VoyagePnlItineraryLine,
"voyagePnlItineraryLineList": [VoyagePnlItineraryLine],
"_voyagePnlItineraryLineBunkerRelationships": VoyagePnlItineraryLineBunkerRelationships,
"voyagePnlItineraryLineBunker": VoyagePnlItineraryLineBunker,
"voyagePnlItineraryLineBunkerList": [
VoyagePnlItineraryLineBunker
],
"_voyagePnlSummaryRelationships": VoyagePnlSummaryRelationships,
"voyagePnlSummary": VoyagePnlSummary,
"voyagePnlSummaryList": [VoyagePnlSummary],
"_voyagePortActivitiesRelationships": VoyagePortActivitiesRelationships,
"voyagePortActivities": VoyagePortActivities,
"voyagePortActivitiesList": [VoyagePortActivities],
"_voyagePortAgentRelationships": VoyagePortAgentRelationships,
"voyagePortAgent": VoyagePortAgent,
"voyagePortAgentList": [VoyagePortAgent],
"_voyageProfitShareRelationships": VoyageProfitShareRelationships,
"voyageProfitShare": VoyageProfitShare,
"voyageProfitShareList": [VoyageProfitShare],
"_voyageProjectedInvoiceRelationships": VoyageProjectedInvoiceRelationships,
"voyageProjectedInvoice": VoyageProjectedInvoice,
"voyageProjectedInvoiceList": [VoyageProjectedInvoice],
"_voyageRemarksRelationships": VoyageRemarksRelationships,
"voyageRemarks": VoyageRemarks,
"voyageRemarksList": [VoyageRemarks],
"_voyageTemplateRelationships": VoyageTemplateRelationships,
"voyageTemplate": VoyageTemplate,
"voyageTemplateList": [VoyageTemplate],
"_voyageTemplateRecipientRelationships": VoyageTemplateRecipientRelationships,
"waterway": Waterway,
"waterwayList": [Waterway],
"weatherState": WeatherState,
"weatherStateList": [WeatherState],
"_worksheetRelationships": WorksheetRelationships,
"worksheet": Worksheet,
"worksheetList": [Worksheet],
"_worksheetEstimateRelationships": WorksheetEstimateRelationships,
"worksheetEstimate": WorksheetEstimate,
"worksheetEstimateList": [WorksheetEstimate],
"_worksheetPriceComponentRelationships": WorksheetPriceComponentRelationships,
"worksheetPriceComponent": WorksheetPriceComponent,
"worksheetPriceComponentList": [
WorksheetPriceComponent
],
"_worksheetVesselRelationships": WorksheetVesselRelationships,
"worksheetVessel": WorksheetVessel,
"worksheetVesselList": [WorksheetVessel]
}
ImosUser
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
userNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
userName - String
|
|
userInitials - String
|
|
userFullName - String
|
|
userEmail - String
|
|
userPhoneNo - String
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"userNo": 987,
"customFieldByID": Any,
"customField": Any,
"userName": "abc123",
"userInitials": "xyz789",
"userFullName": "abc123",
"userEmail": "xyz789",
"userPhoneNo": "xyz789",
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
ImosUserFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ImosUserFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ImosUserFormQueryWhere
}
ImosUserFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [ImosUserFormQueryWhere!]
|
|
or - [ImosUserFormQueryWhere!]
|
|
rawExpression - String
|
|
userNo - NumberWhereValueExpression
|
|
userName - StringWhereValueExpression
|
|
userInitials - StringWhereValueExpression
|
|
userFullName - StringWhereValueExpression
|
|
userEmail - StringWhereValueExpression
|
|
userPhoneNo - StringWhereValueExpression
|
Example
{
"and": [ImosUserFormQueryWhere],
"or": [ImosUserFormQueryWhere],
"rawExpression": "abc123",
"userNo": NumberWhereValueExpression,
"userName": StringWhereValueExpression,
"userInitials": StringWhereValueExpression,
"userFullName": StringWhereValueExpression,
"userEmail": StringWhereValueExpression,
"userPhoneNo": StringWhereValueExpression
}
ImosappRootMutation
Fields
| Field Name | Description |
|---|---|
updateConfigFlag - Boolean
|
|
Arguments
|
|
setUserPref - Boolean
|
|
Arguments
|
|
deleteUserPref - Boolean
|
|
Arguments
|
|
exec - ExecResponse
|
|
Arguments
|
|
importXml - ImportXmlResponse
|
|
Arguments
|
|
dataFormUpdate - Json
|
|
Arguments
|
|
formOperation - Boolean
|
|
Arguments
|
|
Example
{
"updateConfigFlag": false,
"setUserPref": true,
"deleteUserPref": false,
"exec": ExecResponse,
"importXml": ImportXmlResponse,
"dataFormUpdate": Json,
"formOperation": true
}
ImosappRootQuery
Fields
| Field Name | Description |
|---|---|
formQuery - Json
|
|
Arguments
|
|
getPermissions - GetPermissionsResponse
|
|
Arguments
|
|
systemConfig - SystemConfig
|
|
getConfigFlag - Any
|
|
Arguments
|
|
getUserPrefs - [UserPref]
|
|
Arguments
|
|
runPortAlertRules - RunAlertRulesResponse
|
|
Arguments
|
|
runVesselAlertRules - RunAlertRulesResponse
|
|
Arguments
|
|
runVoyageEstimateAlertRules - RunAlertRulesResponse
|
|
Arguments
|
|
runVoyageAlertRules - RunAlertRulesResponse
|
|
Arguments
|
|
runCargoNameAlertRules - RunAlertRulesResponse
|
|
Arguments
|
|
runCoaAlertRules - RunAlertRulesResponse
|
|
Arguments
|
|
runTimeCharterContractAlertRules - RunAlertRulesResponse
|
|
Arguments |
|
Example
{
"formQuery": Json,
"getPermissions": GetPermissionsResponse,
"systemConfig": SystemConfig,
"getConfigFlag": Any,
"getUserPrefs": [UserPref],
"runPortAlertRules": RunAlertRulesResponse,
"runVesselAlertRules": RunAlertRulesResponse,
"runVoyageEstimateAlertRules": RunAlertRulesResponse,
"runVoyageAlertRules": RunAlertRulesResponse,
"runCargoNameAlertRules": RunAlertRulesResponse,
"runCoaAlertRules": RunAlertRulesResponse,
"runTimeCharterContractAlertRules": RunAlertRulesResponse
}
Imosfunctions_AddBunkerRequirementInquiryRequest
Fields
| Input Field | Description |
|---|---|
requestID - Int
|
|
inquiries - [Imosfunctions_BunkerRequirementInquiry]
|
Example
{
"requestID": 987,
"inquiries": [Imosfunctions_BunkerRequirementInquiry]
}
Imosfunctions_AddBunkerRequirementInquiryResponse
Imosfunctions_ApplyUpdatePaperTradeRequest
Fields
| Input Field | Description |
|---|---|
id - Int
|
|
type - String
|
|
buySell - String
|
|
brokerConfNo - String
|
|
route - String
|
|
tradeDate - Date
|
|
startDate - Date
|
|
endDate - Date
|
|
period - String
|
|
counterparty - String
|
|
clearinghouse - String
|
|
lob - String
|
|
tradeAreaNumber - Int
|
|
remarks - String
|
|
referenceContract - String
|
|
vesselType - String
|
|
actDepartmentCode - String
|
|
volume - Float
|
|
portion - Float
|
|
rateType - String
|
|
usePercentage - Boolean
|
|
intercompany - Boolean
|
|
intercompanyCompany - String
|
|
intercompanyAdjustment - Float
|
|
externalIC - Boolean
|
|
currency - String
|
|
exchangeRate - Float
|
|
strike - Float
|
|
premium - Float
|
|
contractRate - Float
|
|
wsPercent - Float
|
|
optionSymbol - String
|
|
batch - String
|
|
strategy - String
|
|
lastUpdate - Date
|
|
settlement - String
|
|
company - String
|
|
contractType - String
|
|
trader - String
|
|
counterpartyType - String
|
|
reference - String
|
|
status - String
|
|
groupName - String
|
|
carbonCommodityTrade - Boolean
|
|
commissions - [Imosfunctions_ApplyUpdatePaperTradeRequest_Brokers]
|
Example
{
"id": 123,
"type": "xyz789",
"buySell": "abc123",
"brokerConfNo": "xyz789",
"route": "xyz789",
"tradeDate": "2007-12-03",
"startDate": "2007-12-03",
"endDate": "2007-12-03",
"period": "xyz789",
"counterparty": "xyz789",
"clearinghouse": "abc123",
"lob": "xyz789",
"tradeAreaNumber": 987,
"remarks": "xyz789",
"referenceContract": "abc123",
"vesselType": "abc123",
"actDepartmentCode": "xyz789",
"volume": 987.65,
"portion": 987.65,
"rateType": "xyz789",
"usePercentage": false,
"intercompany": true,
"intercompanyCompany": "abc123",
"intercompanyAdjustment": 987.65,
"externalIC": true,
"currency": "xyz789",
"exchangeRate": 987.65,
"strike": 123.45,
"premium": 123.45,
"contractRate": 987.65,
"wsPercent": 987.65,
"optionSymbol": "abc123",
"batch": "xyz789",
"strategy": "abc123",
"lastUpdate": "2007-12-03",
"settlement": "xyz789",
"company": "xyz789",
"contractType": "xyz789",
"trader": "xyz789",
"counterpartyType": "xyz789",
"reference": "xyz789",
"status": "xyz789",
"groupName": "abc123",
"carbonCommodityTrade": true,
"commissions": [
Imosfunctions_ApplyUpdatePaperTradeRequest_Brokers
]
}
Imosfunctions_ApplyUpdatePaperTradeRequest_Brokers
Imosfunctions_ApplyUpdatePaperTradeResponse
Imosfunctions_BunkerRequirementConfirmRequest
Imosfunctions_BunkerRequirementConfirmResponse
Imosfunctions_BunkerRequirementInquiry
Fields
| Input Field | Description |
|---|---|
inquiryId - Int
|
|
externalReference - String
|
|
portNo - Int
|
|
vendorShortName - String
|
|
status - String
|
|
orderDateLocal - Date
|
|
paymentTermsCode - String
|
|
currency - String
|
|
exchangeRate - Float
|
|
bargingRateCurr - Float
|
|
bargeCostCurr - Float
|
|
portChargesCurr - Float
|
|
otherCostCurr - Float
|
|
inqTaxPercent - Float
|
|
comments - String
|
|
purchaseOrderNo - String
|
|
windowFromDateLocal - Date
|
|
windowToDateLocal - Date
|
|
specialInstructions - String
|
|
bunkers - [Imosfunctions_BunkerRequirementInquiry_Bunkers]
|
Example
{
"inquiryId": 987,
"externalReference": "abc123",
"portNo": 987,
"vendorShortName": "abc123",
"status": "abc123",
"orderDateLocal": "2007-12-03",
"paymentTermsCode": "abc123",
"currency": "xyz789",
"exchangeRate": 987.65,
"bargingRateCurr": 987.65,
"bargeCostCurr": 987.65,
"portChargesCurr": 123.45,
"otherCostCurr": 987.65,
"inqTaxPercent": 987.65,
"comments": "abc123",
"purchaseOrderNo": "abc123",
"windowFromDateLocal": "2007-12-03",
"windowToDateLocal": "2007-12-03",
"specialInstructions": "abc123",
"bunkers": [
Imosfunctions_BunkerRequirementInquiry_Bunkers
]
}
Imosfunctions_BunkerRequirementInquiry_Bunkers
Example
{
"type": "abc123",
"grade": "xyz789",
"price": 123.45,
"priceCurr": 123.45,
"quantity": 123.45,
"minQuantity": 123.45,
"maxQuantity": 123.45,
"bunkerwireSpotPrice": 987.65
}
Imosfunctions_BunkerRequirementNominateRequest
Imosfunctions_BunkerRequirementNominateResponse
Imosfunctions_CargoUpdateRequest
Fields
| Input Field | Description |
|---|---|
cargoID - Int
|
|
fullName - String
|
|
companyCode - String
|
|
contractType - String
|
|
counterpartyShortName - String
|
|
freightRate - Float
|
|
freightType - String
|
|
cPQty - Float
|
|
cargoUnit - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
laytimeAllowed - Float
|
|
laytimeAllowedUnitCode - String
|
|
laytimeNOROffset - Float
|
|
loadPort - String
|
|
dischPort - String
|
|
iNCOTerms - String
|
|
loadDemurrageBase - Float
|
|
dischDemurrageBase - Float
|
|
status - String
|
|
vessel - Imosfunctions_CargoUpdateRequest_Vessel
|
|
voyageNo - Int
|
Example
{
"cargoID": 123,
"fullName": "abc123",
"companyCode": "abc123",
"contractType": "xyz789",
"counterpartyShortName": "xyz789",
"freightRate": 987.65,
"freightType": "xyz789",
"cPQty": 987.65,
"cargoUnit": "abc123",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"laytimeAllowed": 987.65,
"laytimeAllowedUnitCode": "xyz789",
"laytimeNOROffset": 123.45,
"loadPort": "xyz789",
"dischPort": "xyz789",
"iNCOTerms": "xyz789",
"loadDemurrageBase": 123.45,
"dischDemurrageBase": 123.45,
"status": "xyz789",
"vessel": Imosfunctions_CargoUpdateRequest_Vessel,
"voyageNo": 123
}
Imosfunctions_CargoUpdateRequest_Vessel
Imosfunctions_CargoUpdateResponse
Imosfunctions_ClaimDeleteRequest
Fields
| Input Field | Description |
|---|---|
claimId - Int
|
Example
{"claimId": 987}
Imosfunctions_ClaimDeleteResponse
Imosfunctions_ClaimQuoteUpdateRequest
Fields
| Input Field | Description |
|---|---|
claimID - Int
|
|
agreedAmountCurr - Float
|
|
amountCurr - Float
|
|
aPAR - aPAR
|
|
cargo - Imosfunctions_ClaimQuoteUpdateRequest_Cargo
|
|
counterparty - Imosfunctions_ClaimQuoteUpdateRequest_Counterparty
|
|
laytime - Imosfunctions_ClaimQuoteUpdateRequest_Laytime
|
|
regularVessel - Imosfunctions_ClaimQuoteUpdateRequest_RegularVessel
|
|
fobVessel - Imosfunctions_ClaimQuoteUpdateRequest_FobVessel
|
|
voyageNo - Int
|
|
vesselCode - String
|
Example
{
"claimID": 123,
"agreedAmountCurr": 123.45,
"amountCurr": 123.45,
"aPAR": "AP",
"cargo": Imosfunctions_ClaimQuoteUpdateRequest_Cargo,
"counterparty": Imosfunctions_ClaimQuoteUpdateRequest_Counterparty,
"laytime": Imosfunctions_ClaimQuoteUpdateRequest_Laytime,
"regularVessel": Imosfunctions_ClaimQuoteUpdateRequest_RegularVessel,
"fobVessel": Imosfunctions_ClaimQuoteUpdateRequest_FobVessel,
"voyageNo": 123,
"vesselCode": "abc123"
}
Imosfunctions_ClaimQuoteUpdateRequest_Cargo
Imosfunctions_ClaimQuoteUpdateRequest_Counterparty
Fields
| Input Field | Description |
|---|---|
counterpartyShortName - String
|
Example
{"counterpartyShortName": "xyz789"}
Imosfunctions_ClaimQuoteUpdateRequest_FobVessel
Imosfunctions_ClaimQuoteUpdateRequest_Laytime
Example
{
"calculatedAmountCurr": 987,
"laytimePorts": [
Imosfunctions_ClaimQuoteUpdateRequest_Laytime_LaytimePorts
],
"ratePerDay": 123.45,
"remarks": "abc123",
"settledAmt": 987.65,
"totalAllowedTimeMinutes": 123,
"totalUsedTimeMinutes": 123
}
Imosfunctions_ClaimQuoteUpdateRequest_Laytime_LaytimePorts
Fields
| Input Field | Description |
|---|---|
allowedTimeMinutes - Int
|
|
allowedTotalTimeMinutes - Int
|
|
cargo - Imosfunctions_ClaimQuoteUpdateRequest_Laytime_LaytimePorts_Cargo
|
|
demurrageRate - Float
|
|
laytimeCommencedLocal - String
|
|
laytimeCompletedLocal - String
|
|
laytimePortActivities - [Imosfunctions_ClaimQuoteUpdateRequest_Laytime_LaytimePorts_LaytimePortActivities]
|
|
laytimePortDeductions - [Imosfunctions_ClaimQuoteUpdateRequest_Laytime_LaytimePorts_LaytimePortDeductions]
|
|
port - Imosfunctions_ClaimQuoteUpdateRequest_Laytime_LaytimePorts_Port
|
|
portFunc - String
|
|
usedTimeMinutes - Int
|
|
voyageItinerary - Imosfunctions_ClaimQuoteUpdateRequest_Laytime_LaytimePorts_VoyageItinerary
|
Example
{
"allowedTimeMinutes": 123,
"allowedTotalTimeMinutes": 987,
"cargo": Imosfunctions_ClaimQuoteUpdateRequest_Laytime_LaytimePorts_Cargo,
"demurrageRate": 123.45,
"laytimeCommencedLocal": "xyz789",
"laytimeCompletedLocal": "xyz789",
"laytimePortActivities": [
Imosfunctions_ClaimQuoteUpdateRequest_Laytime_LaytimePorts_LaytimePortActivities
],
"laytimePortDeductions": [
Imosfunctions_ClaimQuoteUpdateRequest_Laytime_LaytimePorts_LaytimePortDeductions
],
"port": Imosfunctions_ClaimQuoteUpdateRequest_Laytime_LaytimePorts_Port,
"portFunc": "abc123",
"usedTimeMinutes": 987,
"voyageItinerary": Imosfunctions_ClaimQuoteUpdateRequest_Laytime_LaytimePorts_VoyageItinerary
}
Imosfunctions_ClaimQuoteUpdateRequest_Laytime_LaytimePorts_Cargo
Imosfunctions_ClaimQuoteUpdateRequest_Laytime_LaytimePorts_LaytimePortActivities
Example
{
"activity": "abc123",
"activityType": "xyz789",
"berthShortName": "abc123",
"endLocal": "abc123",
"remarks": "xyz789",
"startLocal": "abc123"
}
Imosfunctions_ClaimQuoteUpdateRequest_Laytime_LaytimePorts_LaytimePortDeductions
Imosfunctions_ClaimQuoteUpdateRequest_Laytime_LaytimePorts_Port
Fields
| Input Field | Description |
|---|---|
name - String
|
Example
{"name": "xyz789"}
Imosfunctions_ClaimQuoteUpdateRequest_Laytime_LaytimePorts_VoyageItinerary
Imosfunctions_ClaimQuoteUpdateRequest_RegularVessel
Imosfunctions_ClaimQuoteUpdateResponse
Imosfunctions_ClaimRemovePortCallsRequest
Fields
| Input Field | Description |
|---|---|
claimId - Int
|
|
portCalls - [Imosfunctions_ClaimRemovePortCallsRequest_PortCalls]
|
Example
{
"claimId": 987,
"portCalls": [
Imosfunctions_ClaimRemovePortCallsRequest_PortCalls
]
}
Imosfunctions_ClaimRemovePortCallsRequest_PortCalls
Imosfunctions_ClaimRemovePortCallsResponse
Imosfunctions_CompareTradingPnlSnapshotsRequest
Imosfunctions_CompareTradingPnlSnapshotsResponse
Fields
| Field Name | Description |
|---|---|
changes - [Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes]
|
|
errorMessage - String
|
Example
{
"changes": [
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes
],
"errorMessage": "xyz789"
}
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes
Fields
| Field Name | Description |
|---|---|
contractType - String
|
|
contractId - String
|
|
added - Boolean
|
|
removed - Boolean
|
|
voyageScheduled - Boolean
|
|
voyageUnscheduled - Boolean
|
|
realizedPnl - Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_RealizedPnl
|
|
unrealizedPnl - Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_UnrealizedPnl
|
|
route - Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_Route
|
|
laycan - Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_Laycan
|
|
openDate - Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_OpenDate
|
|
periodChanges - [Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges]
|
Example
{
"contractType": "xyz789",
"contractId": "abc123",
"added": false,
"removed": false,
"voyageScheduled": false,
"voyageUnscheduled": true,
"realizedPnl": Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_RealizedPnl,
"unrealizedPnl": Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_UnrealizedPnl,
"route": Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_Route,
"laycan": Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_Laycan,
"openDate": Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_OpenDate,
"periodChanges": [
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges
]
}
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_Laycan
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_OpenDate
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges
Fields
| Field Name | Description |
|---|---|
date - Date
|
|
added - Boolean
|
|
removed - Boolean
|
|
realizedPnl - Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_RealizedPnl
|
|
unrealizedPnl - Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_UnrealizedPnl
|
|
itemizedChanges - [Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges]
|
Example
{
"date": "2007-12-03",
"added": true,
"removed": true,
"realizedPnl": Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_RealizedPnl,
"unrealizedPnl": Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_UnrealizedPnl,
"itemizedChanges": [
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges
]
}
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges
Fields
Example
{
"category": "abc123",
"subType": "xyz789",
"periodFrom": "2007-12-03",
"periodTo": "2007-12-03",
"added": false,
"removed": false,
"realizedPnl": Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_RealizedPnl,
"unrealizedPnl": Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_UnrealizedPnl,
"route": Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_Route,
"marketRate": Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_MarketRate,
"contractRate": Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_ContractRate,
"days": Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_Days,
"tons": Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_Tons,
"settled": Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_Settled,
"correlation": Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_Correlation,
"adjustment": Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_Adjustment
}
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_Adjustment
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_ContractRate
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_Correlation
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_Days
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_MarketRate
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_RealizedPnl
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_Route
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_Settled
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_Tons
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_ItemizedChanges_UnrealizedPnl
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_RealizedPnl
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_PeriodChanges_UnrealizedPnl
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_RealizedPnl
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_Route
Imosfunctions_CompareTradingPnlSnapshotsResponse_Changes_UnrealizedPnl
Imosfunctions_CreateLaytimeClaimRequest
Fields
| Input Field | Description |
|---|---|
isReversible - Boolean
|
|
onceOnAlwaysOn - Boolean
|
|
isOnAccount - Boolean
|
|
includeInPnl - Boolean
|
|
noRebill - Boolean
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
counterpartyShortName - String
|
|
counterpartyType - String
|
|
analyst - String
|
|
invoiceNo - String
|
|
cargoId - Int
|
|
taskId - Int
|
|
status - String
|
|
subStatus - String
|
|
calcRemarks - String
|
|
currency - String
|
|
originalAmountCurr - Float
|
|
agreedAmountCurr - Float
|
|
ratePerDay - Float
|
|
aPAROverride - aPAROverride
|
|
claimCreatedOrReceivedDate - Date
|
|
openedDate - Date
|
|
timeBarDate - Date
|
|
settledDate - Date
|
|
externalRef - String
|
|
type - String
|
|
subType - String
|
|
lastAction - String
|
|
lastActionDate - Date
|
|
skipImport - Boolean
|
|
skipActDedValidation - Boolean
|
|
itineraries - [Imosfunctions_LaytimeClaimItinerary]
|
|
portActivities - [Imosfunctions_LaytimeClaimPortActivity]
|
|
deductions - [Imosfunctions_LaytimeClaimDeduction]
|
Example
{
"isReversible": false,
"onceOnAlwaysOn": false,
"isOnAccount": true,
"includeInPnl": true,
"noRebill": true,
"vesselCode": "abc123",
"voyageNo": 987,
"counterpartyShortName": "xyz789",
"counterpartyType": "xyz789",
"analyst": "xyz789",
"invoiceNo": "xyz789",
"cargoId": 987,
"taskId": 123,
"status": "xyz789",
"subStatus": "xyz789",
"calcRemarks": "abc123",
"currency": "xyz789",
"originalAmountCurr": 987.65,
"agreedAmountCurr": 987.65,
"ratePerDay": 123.45,
"aPAROverride": "AP",
"claimCreatedOrReceivedDate": "2007-12-03",
"openedDate": "2007-12-03",
"timeBarDate": "2007-12-03",
"settledDate": "2007-12-03",
"externalRef": "xyz789",
"type": "xyz789",
"subType": "xyz789",
"lastAction": "abc123",
"lastActionDate": "2007-12-03",
"skipImport": true,
"skipActDedValidation": false,
"itineraries": [Imosfunctions_LaytimeClaimItinerary],
"portActivities": [
Imosfunctions_LaytimeClaimPortActivity
],
"deductions": [Imosfunctions_LaytimeClaimDeduction]
}
Imosfunctions_CreateLaytimeClaimResponse
Imosfunctions_DeleteBunkerRequirementRequest
Fields
| Input Field | Description |
|---|---|
requestID - Int
|
Example
{"requestID": 123}
Imosfunctions_DeleteBunkerRequirementResponse
Imosfunctions_DeletePaperTradeRequest
Fields
| Input Field | Description |
|---|---|
id - Int
|
Example
{"id": 987}
Imosfunctions_DeletePaperTradeResponse
Imosfunctions_DeleteVoyageRequest
Imosfunctions_DeleteVoyageResponse
Imosfunctions_EditLaytimeClaimRequest
Fields
| Input Field | Description |
|---|---|
claimId - Int
|
|
isReversible - Boolean
|
|
onceOnAlwaysOn - Boolean
|
|
isContinuousLaytime - Boolean
|
|
showDemurrageStart - Boolean
|
|
isOnAccount - Boolean
|
|
includeInPnl - Boolean
|
|
noRebill - Boolean
|
|
status - String
|
|
subStatus - String
|
|
diffReason - String
|
|
calcRemarks - String
|
|
analyst - String
|
|
invoiceNo - String
|
|
invoiceStatus - String
|
|
currency - String
|
|
originalAmountCurr - Float
|
|
agreedAmountCurr - Float
|
|
ratePerDay - Float
|
|
lastAction - String
|
|
lastActionDate - Date
|
|
claimDate - Date
|
|
openedDate - Date
|
|
timeBarDate - Date
|
|
settledDate - Date
|
|
externalRef - String
|
|
type - String
|
|
subType - String
|
|
importFromFile - Boolean
|
|
skipActDedValidation - Boolean
|
|
itineraries - [Imosfunctions_LaytimeClaimItinerary]
|
|
portActivities - [Imosfunctions_LaytimeClaimPortActivity]
|
|
deductions - [Imosfunctions_LaytimeClaimDeduction]
|
Example
{
"claimId": 123,
"isReversible": true,
"onceOnAlwaysOn": false,
"isContinuousLaytime": true,
"showDemurrageStart": true,
"isOnAccount": true,
"includeInPnl": true,
"noRebill": false,
"status": "xyz789",
"subStatus": "xyz789",
"diffReason": "abc123",
"calcRemarks": "abc123",
"analyst": "abc123",
"invoiceNo": "xyz789",
"invoiceStatus": "xyz789",
"currency": "xyz789",
"originalAmountCurr": 987.65,
"agreedAmountCurr": 987.65,
"ratePerDay": 987.65,
"lastAction": "xyz789",
"lastActionDate": "2007-12-03",
"claimDate": "2007-12-03",
"openedDate": "2007-12-03",
"timeBarDate": "2007-12-03",
"settledDate": "2007-12-03",
"externalRef": "xyz789",
"type": "xyz789",
"subType": "abc123",
"importFromFile": false,
"skipActDedValidation": true,
"itineraries": [Imosfunctions_LaytimeClaimItinerary],
"portActivities": [
Imosfunctions_LaytimeClaimPortActivity
],
"deductions": [Imosfunctions_LaytimeClaimDeduction]
}
Imosfunctions_EditLaytimeClaimResponse
Imosfunctions_LaytimeClaimDeduction
Example
{
"itinSeq": 123,
"portSeqNo": 123,
"laytimeSeq": 987,
"fromDateLocal": "2007-12-03",
"toDateLocal": "2007-12-03",
"remarks": "abc123",
"duration": "abc123",
"percent": 123.45,
"dedName": "xyz789"
}
Imosfunctions_LaytimeClaimItinerary
Example
{
"itinSeq": 987,
"portSeqNo": 123,
"cargoID": 123,
"portcarSeq": 123,
"demRate": 123.45,
"desRate": 987.65,
"allowed": "abc123",
"used": "abc123",
"quantity": 123.45,
"loadDiscRate": 987.65,
"terms": "abc123"
}
Imosfunctions_LaytimeClaimPortActivity
Example
{
"itinSeq": 123,
"portSeqNo": 123,
"laytimeSeq": 987,
"startLocal": "2007-12-03",
"remarks": "xyz789",
"actName": "abc123",
"activityType": "abc123",
"berthShortName": "xyz789"
}
Imosfunctions_PostMonthlyAccrualBillRequest
Fields
| Input Field | Description |
|---|---|
transNo - Int
|
Example
{"transNo": 987}
Imosfunctions_PostMonthlyAccrualBillResponse
Imosfunctions_PostVoyagePeriodBillRequest
Fields
| Input Field | Description |
|---|---|
transNo - Int
|
Example
{"transNo": 987}
Imosfunctions_PostVoyagePeriodBillResponse
Imosfunctions_RunEstimateRequest
Fields
| Input Field | Description |
|---|---|
itineraries - [Imosfunctions_RunEstimateRequest_Itineraries]
|
|
cargoTerms - [Imosfunctions_RunEstimateRequest_CargoTerms]
|
|
initialBunkers - [Imosfunctions_RunEstimateRequest_InitialBunkers]
|
Example
{
"itineraries": [
Imosfunctions_RunEstimateRequest_Itineraries
],
"cargoTerms": [
Imosfunctions_RunEstimateRequest_CargoTerms
],
"initialBunkers": [
Imosfunctions_RunEstimateRequest_InitialBunkers
]
}
Imosfunctions_RunEstimateRequest_CargoTerms
Imosfunctions_RunEstimateRequest_InitialBunkers
Example
{
"fuelType": "xyz789",
"seaBallast": 987.65,
"seaLaden": 987.65,
"portLoad": 123.45,
"portDisch": 123.45,
"price": 123.45,
"quantity": 123.45
}
Imosfunctions_RunEstimateRequest_Itineraries
Imosfunctions_RunEstimateResponse
Imosfunctions_RunVoyageAccrualsRequest
Fields
| Input Field | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
|
accountGroupCode - String
|
|
year - Int
|
|
month - Int
|
|
day - Int
|
|
lowerValueLimit - Float
|
|
snapshotDate - Date
|
|
snapshotType - String
|
|
applyHireToPeriod - Boolean
|
|
applyOffhireToPeriod - Boolean
|
|
applyBallastBonusToPeriod - Boolean
|
|
adjustPortionForOffHire - Boolean
|
|
adjustPortionForWaiting - Boolean
|
|
adjustPortionForBallastDays - Boolean
|
|
adjustPortionForDemurrageDays - Boolean
|
|
applyBunkerToPeriod - Boolean
|
|
excludeRunningCost - Boolean
|
|
applyTCBunkerAdjustmentToPeriod - Boolean
|
|
applyAdditionalHireToPeriod - Boolean
|
|
applyTCExpensesToPeriod - Boolean
|
|
applyOtherRevAndExpToPeriod - Boolean
|
|
applyPortExpensesToPeriod - Boolean
|
|
applyDemurrageToPeriod - Boolean
|
|
applyTCRebillToPeriod - Boolean
|
|
applyInternalFreightRevToPeriod - Boolean
|
|
applyCarbonToPeriod - Boolean
|
|
reconcileBunkerROBForCurrentVoyage - Boolean
|
|
excludeHireRelatedItemsForLongTCO - Boolean
|
|
accrueLinkedTradesUponSettlement - Boolean
|
|
capitalizeAndAmortizePriorToPerformingPeriod - Boolean
|
Example
{
"vesselCode": "abc123",
"voyageNo": 987,
"accountGroupCode": "abc123",
"year": 123,
"month": 987,
"day": 987,
"lowerValueLimit": 123.45,
"snapshotDate": "2007-12-03",
"snapshotType": "xyz789",
"applyHireToPeriod": false,
"applyOffhireToPeriod": false,
"applyBallastBonusToPeriod": true,
"adjustPortionForOffHire": false,
"adjustPortionForWaiting": false,
"adjustPortionForBallastDays": true,
"adjustPortionForDemurrageDays": true,
"applyBunkerToPeriod": true,
"excludeRunningCost": true,
"applyTCBunkerAdjustmentToPeriod": true,
"applyAdditionalHireToPeriod": true,
"applyTCExpensesToPeriod": true,
"applyOtherRevAndExpToPeriod": false,
"applyPortExpensesToPeriod": true,
"applyDemurrageToPeriod": true,
"applyTCRebillToPeriod": true,
"applyInternalFreightRevToPeriod": false,
"applyCarbonToPeriod": true,
"reconcileBunkerROBForCurrentVoyage": true,
"excludeHireRelatedItemsForLongTCO": false,
"accrueLinkedTradesUponSettlement": true,
"capitalizeAndAmortizePriorToPerformingPeriod": false
}
Imosfunctions_RunVoyageAccrualsResponse
Fields
| Field Name | Description |
|---|---|
succeeded - Boolean
|
|
createdJournals - [Imosfunctions_RunVoyageAccrualsResponse_CreatedJournals]
|
|
errorMessage - String
|
Example
{
"succeeded": true,
"createdJournals": [
Imosfunctions_RunVoyageAccrualsResponse_CreatedJournals
],
"errorMessage": "xyz789"
}
Imosfunctions_RunVoyageAccrualsResponse_CreatedJournals
Imosfunctions_RunVoyagePeriodJournalsRequest
Fields
| Input Field | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
|
source - String
|
|
periodThroughDate - Date
|
|
lowerValueLimit - Float
|
|
snapshotDate - Date
|
|
snapshotType - String
|
|
applyHireToPeriod - Boolean
|
|
applyOffhireToPeriod - Boolean
|
|
applyBallastBonusToPeriod - Boolean
|
|
adjustPortionForOffHire - Boolean
|
|
adjustPortionForWaiting - Boolean
|
|
adjustPortionForBallastDays - Boolean
|
|
applyBunkerToPeriod - Boolean
|
|
excludeRunningCost - Boolean
|
|
applyTCBunkerAdjustmentToPeriod - Boolean
|
|
applyAdditionalHireToPeriod - Boolean
|
|
accountVarianceMode - Boolean
|
Example
{
"vesselCode": "abc123",
"voyageNo": 987,
"source": "abc123",
"periodThroughDate": "2007-12-03",
"lowerValueLimit": 987.65,
"snapshotDate": "2007-12-03",
"snapshotType": "xyz789",
"applyHireToPeriod": false,
"applyOffhireToPeriod": true,
"applyBallastBonusToPeriod": true,
"adjustPortionForOffHire": true,
"adjustPortionForWaiting": true,
"adjustPortionForBallastDays": true,
"applyBunkerToPeriod": false,
"excludeRunningCost": false,
"applyTCBunkerAdjustmentToPeriod": false,
"applyAdditionalHireToPeriod": false,
"accountVarianceMode": true
}
Imosfunctions_RunVoyagePeriodJournalsResponse
Fields
| Field Name | Description |
|---|---|
succeeded - Boolean
|
|
errorMessage - String
|
|
records - [Imosfunctions_RunVoyagePeriodJournalsResponse_Records]
|
Example
{
"succeeded": false,
"errorMessage": "xyz789",
"records": [
Imosfunctions_RunVoyagePeriodJournalsResponse_Records
]
}
Imosfunctions_RunVoyagePeriodJournalsResponse_Records
Fields
| Field Name | Description |
|---|---|
operationsInvoice - Imosfunctions_RunVoyagePeriodJournalsResponse_Records_Bill
|
|
operationsInvoiceDetails - [Imosfunctions_RunVoyagePeriodJournalsResponse_Records_Billdets]
|
|
deleteRecord - Boolean
|
Example
{
"operationsInvoice": Imosfunctions_RunVoyagePeriodJournalsResponse_Records_Bill,
"operationsInvoiceDetails": [
Imosfunctions_RunVoyagePeriodJournalsResponse_Records_Billdets
],
"deleteRecord": false
}
Imosfunctions_RunVoyagePeriodJournalsResponse_Records_Bill
Fields
| Field Name | Description |
|---|---|
sqlID - Int
|
|
transNo - Int
|
|
source - String
|
|
statusCode - String
|
|
type - Int
|
|
billDate - Date
|
|
invoiceNo - String
|
|
billAmountCurr - Float
|
|
currency - String
|
|
billAmountBase - Float
|
|
refNo - String
|
|
invoiceDescription - String
|
|
userId - Int
|
|
vendorType - String
|
|
vendorShortName - String
|
|
entryDateLocal - Date
|
|
lastUpdateGmt - Date
|
|
updateTimes - Int
|
|
invTransNo - String
|
|
postDate - Date
|
|
additionalFlags - Int
|
|
invoiceReferenceForTC - String
|
|
lastUser - String
|
|
serviceDate - Date
|
|
receivedDate - Date
|
|
approvalStatus - String
|
|
approvalComment - String
|
|
approvalUser - String
|
|
approvalDateGmt - Date
|
|
voyBond - String
|
|
invoiceDocNo - String
|
|
cap - Float
|
|
remittanceCompanyNo - Int
|
|
remittanceSeq - Int
|
|
contactPerson - String
|
|
companyCode - String
|
|
printCount - Int
|
|
flags - Int
|
|
dueDate - Date
|
|
paymentTermsCodeInternal - String
|
|
approvalUser2 - String
|
|
contactPhone - String
|
|
billViaCompanyNo - Int
|
|
vendorContactSeq - Int
|
|
deductionDays - Float
|
|
externalRef - String
|
|
pONo - String
|
|
payTermsDescription - String
|
|
remarks - String
|
|
targetDate - Date
|
|
timebarDate - Date
|
|
billReference - Int
|
|
viaCompanyCode - String
|
|
serviceNo - String
|
|
counterPartyBU - String
|
|
companyBU - String
|
|
baseCurr - String
|
|
exchangeRate - Float
|
|
accrualPercentage - Float
|
|
claimID - Int
|
|
commPcnt - Float
|
|
exchangeRateDate - Date
|
|
addXcRate - Float
|
|
paymentCompanyNo - Int
|
|
paymentLinkSeq - Int
|
|
paymentMode - String
|
|
icLedger - String
|
|
approvalComment2 - String
|
|
approvalDate2Gmt - Date
|
|
approvalUser3 - String
|
|
approvalComment3 - String
|
|
approvalDate3Gmt - Date
|
|
subCode - String
|
|
subType - String
|
|
personInCharge - String
|
|
autoreverseDate - Date
|
|
recurringJournalPostDay - Int
|
|
recurringJournalReversalDay - Int
|
|
recurringJournalStopDate - Date
|
|
mirrorTransNo - Int
|
|
extraRemarks - String
|
|
headerAddress1 - String
|
|
headerAddress2 - String
|
|
headerAddress3 - String
|
|
headerPOBox - String
|
|
headerCountryCode - String
|
|
provisionalTransNo - Int
|
|
vatCurrency - String
|
|
vatExchangeRate - Float
|
|
vatExchangeRateDate - Date
|
|
receivableStatusInternal - String
|
|
legalSpecialist - String
|
|
intraVoyageMirrorTransNo - Int
|
|
createdByUser - String
|
|
registryAccountCompanyNo - Int
|
|
registryAccountSeq - Int
|
Example
{
"sqlID": 123,
"transNo": 123,
"source": "xyz789",
"statusCode": "abc123",
"type": 987,
"billDate": "2007-12-03",
"invoiceNo": "abc123",
"billAmountCurr": 123.45,
"currency": "xyz789",
"billAmountBase": 987.65,
"refNo": "abc123",
"invoiceDescription": "xyz789",
"userId": 123,
"vendorType": "abc123",
"vendorShortName": "xyz789",
"entryDateLocal": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"updateTimes": 123,
"invTransNo": "abc123",
"postDate": "2007-12-03",
"additionalFlags": 123,
"invoiceReferenceForTC": "abc123",
"lastUser": "abc123",
"serviceDate": "2007-12-03",
"receivedDate": "2007-12-03",
"approvalStatus": "abc123",
"approvalComment": "xyz789",
"approvalUser": "xyz789",
"approvalDateGmt": "2007-12-03",
"voyBond": "abc123",
"invoiceDocNo": "xyz789",
"cap": 987.65,
"remittanceCompanyNo": 123,
"remittanceSeq": 987,
"contactPerson": "xyz789",
"companyCode": "abc123",
"printCount": 123,
"flags": 987,
"dueDate": "2007-12-03",
"paymentTermsCodeInternal": "xyz789",
"approvalUser2": "abc123",
"contactPhone": "xyz789",
"billViaCompanyNo": 123,
"vendorContactSeq": 123,
"deductionDays": 123.45,
"externalRef": "abc123",
"pONo": "abc123",
"payTermsDescription": "xyz789",
"remarks": "xyz789",
"targetDate": "2007-12-03",
"timebarDate": "2007-12-03",
"billReference": 987,
"viaCompanyCode": "abc123",
"serviceNo": "xyz789",
"counterPartyBU": "abc123",
"companyBU": "abc123",
"baseCurr": "abc123",
"exchangeRate": 987.65,
"accrualPercentage": 123.45,
"claimID": 987,
"commPcnt": 123.45,
"exchangeRateDate": "2007-12-03",
"addXcRate": 987.65,
"paymentCompanyNo": 987,
"paymentLinkSeq": 987,
"paymentMode": "xyz789",
"icLedger": "xyz789",
"approvalComment2": "xyz789",
"approvalDate2Gmt": "2007-12-03",
"approvalUser3": "abc123",
"approvalComment3": "xyz789",
"approvalDate3Gmt": "2007-12-03",
"subCode": "xyz789",
"subType": "abc123",
"personInCharge": "xyz789",
"autoreverseDate": "2007-12-03",
"recurringJournalPostDay": 123,
"recurringJournalReversalDay": 987,
"recurringJournalStopDate": "2007-12-03",
"mirrorTransNo": 123,
"extraRemarks": "abc123",
"headerAddress1": "xyz789",
"headerAddress2": "xyz789",
"headerAddress3": "abc123",
"headerPOBox": "abc123",
"headerCountryCode": "abc123",
"provisionalTransNo": 987,
"vatCurrency": "abc123",
"vatExchangeRate": 123.45,
"vatExchangeRateDate": "2007-12-03",
"receivableStatusInternal": "abc123",
"legalSpecialist": "abc123",
"intraVoyageMirrorTransNo": 123,
"createdByUser": "xyz789",
"registryAccountCompanyNo": 987,
"registryAccountSeq": 123
}
Imosfunctions_RunVoyagePeriodJournalsResponse_Records_Billdets
Fields
| Field Name | Description |
|---|---|
_sqlid - Int
|
|
transNo - Int
|
|
seq - Int
|
|
billSourceCode - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
portSeqNo - Int
|
|
portNo - Int
|
|
billPeriodFromLocal - Date
|
|
billPeriodToLocal - Date
|
|
qty - Float
|
|
rateBase - Float
|
|
billCode - String
|
|
amountCurr - Float
|
|
amountBase - Float
|
|
description - String
|
|
vendorType - String
|
|
vendorShortName - String
|
|
entryDateLocal - Date
|
|
lastUpdateGmt - Date
|
|
updateTimes - Int
|
|
auxDataInternal - String
|
|
lastUser - String
|
|
remarks - String
|
|
taxCode - String
|
|
taxRate - Float
|
|
rateUnit - String
|
|
billRefNo - Int
|
|
flags - Int
|
|
companyCode - String
|
|
lobCode - String
|
|
routeCode - String
|
|
subCode - String
|
|
subSeq - Int
|
|
billedPercentage - Float
|
|
rateUnitAux - String
|
|
qtyUnit - String
|
|
brokerageType - String
|
|
internalBrkType - String
|
|
exchangeRate - Float
|
|
subSource - String
|
|
refNo - String
|
|
billRefSeq - Int
|
|
commissionPercent - Float
|
|
acctCode - String
|
|
creditAcctCode - String
|
|
actDeptCode - String
|
|
tradeAreaNo - Int
|
|
cargoID - Int
|
|
costCode - Int
|
|
rebillTransNo - Int
|
|
rebillSeq - Int
|
|
rebillFlags - Int
|
|
marketRate - Float
|
|
marketDateLocal - Date
|
|
cargoShortName - String
|
|
gradeSeqNo - Int
|
|
orderSeqNo - Int
|
|
flags2 - Int
|
|
agreedDist - Float
|
|
basisCode - String
|
|
cargoRevexpSeq - Int
|
|
exchangeRateDate - Date
|
|
refSeq - Int
|
|
tcHireSeq - Int
|
|
currency - String
|
|
laytimeInvoiceTransNo - Int
|
|
provisionalInvoiceTransNo - Int
|
|
linkedItinerarySeq - Int
|
Example
{
"_sqlid": 987,
"transNo": 987,
"seq": 123,
"billSourceCode": "abc123",
"vesselCode": "xyz789",
"voyageNo": 123,
"portSeqNo": 987,
"portNo": 987,
"billPeriodFromLocal": "2007-12-03",
"billPeriodToLocal": "2007-12-03",
"qty": 123.45,
"rateBase": 123.45,
"billCode": "xyz789",
"amountCurr": 987.65,
"amountBase": 123.45,
"description": "xyz789",
"vendorType": "abc123",
"vendorShortName": "abc123",
"entryDateLocal": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"updateTimes": 987,
"auxDataInternal": "xyz789",
"lastUser": "abc123",
"remarks": "xyz789",
"taxCode": "xyz789",
"taxRate": 987.65,
"rateUnit": "xyz789",
"billRefNo": 987,
"flags": 987,
"companyCode": "xyz789",
"lobCode": "xyz789",
"routeCode": "xyz789",
"subCode": "abc123",
"subSeq": 987,
"billedPercentage": 987.65,
"rateUnitAux": "abc123",
"qtyUnit": "abc123",
"brokerageType": "xyz789",
"internalBrkType": "xyz789",
"exchangeRate": 987.65,
"subSource": "xyz789",
"refNo": "xyz789",
"billRefSeq": 123,
"commissionPercent": 123.45,
"acctCode": "xyz789",
"creditAcctCode": "abc123",
"actDeptCode": "abc123",
"tradeAreaNo": 123,
"cargoID": 987,
"costCode": 987,
"rebillTransNo": 987,
"rebillSeq": 123,
"rebillFlags": 123,
"marketRate": 987.65,
"marketDateLocal": "2007-12-03",
"cargoShortName": "xyz789",
"gradeSeqNo": 123,
"orderSeqNo": 123,
"flags2": 123,
"agreedDist": 123.45,
"basisCode": "xyz789",
"cargoRevexpSeq": 987,
"exchangeRateDate": "2007-12-03",
"refSeq": 987,
"tcHireSeq": 123,
"currency": "abc123",
"laytimeInvoiceTransNo": 987,
"provisionalInvoiceTransNo": 123,
"linkedItinerarySeq": 123
}
Imosfunctions_SCCVoyageEmissionsRequest
Fields
| Input Field | Description |
|---|---|
voyageNo - Int
|
|
vesselCode - String
|
|
chartererVoyageID - String
|
|
voyageType - voyageType
|
|
contactName - String
|
|
contactEmail - String
|
|
vessel - Imosfunctions_SCCVoyageEmissionsRequest_Vessel
|
|
emissionDetails - [Imosfunctions_SCCVoyageEmissionsRequest_EmissionDetails]
|
Example
{
"voyageNo": 987,
"vesselCode": "abc123",
"chartererVoyageID": "abc123",
"voyageType": "TimeCharter",
"contactName": "abc123",
"contactEmail": "abc123",
"vessel": Imosfunctions_SCCVoyageEmissionsRequest_Vessel,
"emissionDetails": [
Imosfunctions_SCCVoyageEmissionsRequest_EmissionDetails
]
}
Imosfunctions_SCCVoyageEmissionsRequest_EmissionDetails
Fields
| Input Field | Description |
|---|---|
ballastLaden - ballastLaden
|
|
portName - String
|
|
fromPortName - String
|
|
toPortName - String
|
|
portUNCode - String
|
|
fromPortUNCode - String
|
|
toPortUNCode - String
|
|
fromDate - Date
|
|
toDate - Date
|
|
cargoQuantityMT - Float
|
|
chartererCargoQuantityMT - Float
|
|
distanceNauticalMiles - Float
|
|
legType - legType
|
|
consumption - [Imosfunctions_SCCVoyageEmissionsRequest_EmissionDetails_Consumption]
|
Example
{
"ballastLaden": "Ballast",
"portName": "abc123",
"fromPortName": "xyz789",
"toPortName": "xyz789",
"portUNCode": "abc123",
"fromPortUNCode": "xyz789",
"toPortUNCode": "xyz789",
"fromDate": "2007-12-03",
"toDate": "2007-12-03",
"cargoQuantityMT": 987.65,
"chartererCargoQuantityMT": 123.45,
"distanceNauticalMiles": 123.45,
"legType": "Port",
"consumption": [
Imosfunctions_SCCVoyageEmissionsRequest_EmissionDetails_Consumption
]
}
Imosfunctions_SCCVoyageEmissionsRequest_EmissionDetails_Consumption
Imosfunctions_SCCVoyageEmissionsRequest_Vessel
Imosfunctions_SCCVoyageEmissionsResponse
Imosfunctions_UpdateBerthActivitiesRequest
Fields
| Input Field | Description |
|---|---|
cargoID - Int
|
|
seq - Int
|
|
plannedActivities - [Imosfunctions_UpdateBerthActivitiesRequest_PlannedActivities]
|
Example
{
"cargoID": 987,
"seq": 123,
"plannedActivities": [
Imosfunctions_UpdateBerthActivitiesRequest_PlannedActivities
]
}
Imosfunctions_UpdateBerthActivitiesRequest_PlannedActivities
Imosfunctions_UpdateBerthActivitiesResponse
Imosfunctions_UpdateBunkerRequirementRequest
Fields
| Input Field | Description |
|---|---|
requestID - Int
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
itinerarySeq - Int
|
|
requestStatus - String
|
|
portNo - Int
|
|
companyCode - String
|
|
windowFromDateLocal - Date
|
|
windowToDateLocal - Date
|
|
requestByUser - String
|
|
requestNote - String
|
|
bunkeringDetails - String
|
|
requestedDeliveryDateLocal - Date
|
|
deliveryDateLocal - Date
|
|
procurementStatus - String
|
|
plannedLiftings - [Imosfunctions_UpdateBunkerRequirementRequest_PlannedLiftings]
|
|
inquiries - [Imosfunctions_BunkerRequirementInquiry]
|
Example
{
"requestID": 123,
"vesselCode": "xyz789",
"voyageNo": 987,
"itinerarySeq": 987,
"requestStatus": "xyz789",
"portNo": 123,
"companyCode": "xyz789",
"windowFromDateLocal": "2007-12-03",
"windowToDateLocal": "2007-12-03",
"requestByUser": "abc123",
"requestNote": "xyz789",
"bunkeringDetails": "xyz789",
"requestedDeliveryDateLocal": "2007-12-03",
"deliveryDateLocal": "2007-12-03",
"procurementStatus": "abc123",
"plannedLiftings": [
Imosfunctions_UpdateBunkerRequirementRequest_PlannedLiftings
],
"inquiries": [Imosfunctions_BunkerRequirementInquiry]
}
Imosfunctions_UpdateBunkerRequirementRequest_PlannedLiftings
Imosfunctions_UpdateBunkerRequirementResponse
Imosfunctions_UpdateEquipmentContractRequest
Fields
| Input Field | Description |
|---|---|
contractType - String
|
|
counterpartyShortName - String
|
|
contractID - String
|
|
currency - String
|
|
description - String
|
|
fixtureDate - Date
|
|
fixedBy - String
|
|
estDeliveryDateGmt - Date
|
|
estRedeliveryDateGmt - Date
|
|
companyCode - String
|
|
status - String
|
|
billingPeriod - String
|
|
tradeAreaName - String
|
|
deliveryPort - Imosfunctions_UpdateEquipmentContractRequest_DeliveryPort
|
|
redeliveryPort - Imosfunctions_UpdateEquipmentContractRequest_RedeliveryPort
|
|
hires - [Imosfunctions_UpdateEquipmentContractRequest_Hires]
|
Example
{
"contractType": "abc123",
"counterpartyShortName": "abc123",
"contractID": "xyz789",
"currency": "xyz789",
"description": "xyz789",
"fixtureDate": "2007-12-03",
"fixedBy": "xyz789",
"estDeliveryDateGmt": "2007-12-03",
"estRedeliveryDateGmt": "2007-12-03",
"companyCode": "abc123",
"status": "abc123",
"billingPeriod": "abc123",
"tradeAreaName": "abc123",
"deliveryPort": Imosfunctions_UpdateEquipmentContractRequest_DeliveryPort,
"redeliveryPort": Imosfunctions_UpdateEquipmentContractRequest_RedeliveryPort,
"hires": [
Imosfunctions_UpdateEquipmentContractRequest_Hires
]
}
Imosfunctions_UpdateEquipmentContractRequest_DeliveryPort
Imosfunctions_UpdateEquipmentContractRequest_Hires
Example
{
"equipmentType": "abc123",
"equipmentQuantity": 987,
"hireFromGmt": "2007-12-03",
"hireToGmt": "2007-12-03",
"hireRate": 123.45,
"remarks": "xyz789"
}
Imosfunctions_UpdateEquipmentContractRequest_RedeliveryPort
Imosfunctions_UpdateEquipmentContractResponse
ImportXmlResponse
Input_Cargo
Fields
| Input Field | Description |
|---|---|
action - String
|
|
cargoID - Int
|
|
vcInID - Int
|
|
externalRef - String
|
|
cargoShortName - String
|
|
counterpartyShortName - String
|
|
cPDate - Date
|
|
cpDate - Date
|
|
cPForm - String
|
|
cpForm - String
|
|
cargoUnit - String
|
|
cPQty - Float
|
|
cpQty - Float
|
|
minQty - Int
|
|
maxQty - Int
|
|
optionType - String
|
|
remarks - String
|
|
curr - String
|
|
manualTce - Float
|
|
freightType - String
|
|
freightRate - Float
|
|
lumpsum - Float
|
|
worldScaleRate - Float
|
|
worldScaleLevel - Float
|
|
loadDemRateCurr - Float
|
|
loadDespatchRateCurr - Float
|
|
contractType - String
|
|
supplierShortName - String
|
|
receiverShortName - String
|
|
vesselRef - String
|
|
bookingNo - String
|
|
refContract - String
|
|
contractReference - String
|
|
companyCode - String
|
|
lobCode - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
laycanFromGmt - Date
|
|
laycanToGmt - Date
|
|
refVoyageRoute - String
|
|
vslCode - String
|
|
mTEquivalentFactor - Float
|
|
fobRefVoyageNo - Int
|
|
discDemRateCurr - Float
|
|
discDespatchRateCurr - Float
|
|
optionPercentage - Float
|
|
coaNo - String
|
|
status - String
|
|
commercialScheduler - String
|
|
tradeAreaNo - Int
|
|
chtrCoordinator - String
|
|
vesselType - String
|
|
voyageNo - Int
|
|
api - Float
|
|
initialEstimateID - String
|
|
exposureMethod - String
|
|
partCargo - Boolean
|
|
partCargoFactor - Float
|
|
option - Boolean
|
|
optionStatus - String
|
|
isOwnersOption - Boolean
|
|
optionPremium - Float
|
|
optionDeclaredDate - Date
|
|
optionDeclarationDate - Date
|
|
exposureBasisDate - Date
|
|
contractDays - Int
|
|
coaSeqNo - Int
|
|
benchmarkEstimates - [Input_Cargo_benchmarkEstimates]
|
|
linkedTrades - [Input_Cargo_linkedTrades]
|
|
trader - String
|
|
cargoTimeBar - Input_Cargo_cargoTimeBar
|
|
cargoItineraries - [Input_Cargo_CargoItineraries]
|
|
loadPort - Input_Cargo_LoadPort
|
|
firstBroker - Input_Cargo_firstBroker
|
|
cargoBrokers - [Input_Cargo_cargoBrokers]
|
|
xfrt - Input_Cargo_xfrt
|
|
userProperties - [Input_Cargo_userProperties]
|
|
cargoBooking - Input_Cargo_cargoBooking
|
|
loadOption - Input_Cargo_loadOption
|
|
dischargeOption - Input_Cargo_dischargeOption
|
|
pricing - Input_Cargo_pricing
|
|
bunkerExposures - [Input_Cargo_bunkerExposures]
|
Example
{
"action": "xyz789",
"cargoID": 123,
"vcInID": 123,
"externalRef": "abc123",
"cargoShortName": "xyz789",
"counterpartyShortName": "abc123",
"cPDate": "2007-12-03",
"cpDate": "2007-12-03",
"cPForm": "abc123",
"cpForm": "abc123",
"cargoUnit": "abc123",
"cPQty": 987.65,
"cpQty": 987.65,
"minQty": 123,
"maxQty": 123,
"optionType": "xyz789",
"remarks": "abc123",
"curr": "abc123",
"manualTce": 123.45,
"freightType": "abc123",
"freightRate": 987.65,
"lumpsum": 987.65,
"worldScaleRate": 987.65,
"worldScaleLevel": 123.45,
"loadDemRateCurr": 123.45,
"loadDespatchRateCurr": 123.45,
"contractType": "xyz789",
"supplierShortName": "abc123",
"receiverShortName": "xyz789",
"vesselRef": "xyz789",
"bookingNo": "xyz789",
"refContract": "abc123",
"contractReference": "xyz789",
"companyCode": "xyz789",
"lobCode": "abc123",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"laycanFromGmt": "2007-12-03",
"laycanToGmt": "2007-12-03",
"refVoyageRoute": "abc123",
"vslCode": "xyz789",
"mTEquivalentFactor": 123.45,
"fobRefVoyageNo": 123,
"discDemRateCurr": 987.65,
"discDespatchRateCurr": 123.45,
"optionPercentage": 987.65,
"coaNo": "xyz789",
"status": "xyz789",
"commercialScheduler": "xyz789",
"tradeAreaNo": 987,
"chtrCoordinator": "xyz789",
"vesselType": "abc123",
"voyageNo": 123,
"api": 123.45,
"initialEstimateID": "abc123",
"exposureMethod": "abc123",
"partCargo": false,
"partCargoFactor": 123.45,
"option": false,
"optionStatus": "abc123",
"isOwnersOption": true,
"optionPremium": 123.45,
"optionDeclaredDate": "2007-12-03",
"optionDeclarationDate": "2007-12-03",
"exposureBasisDate": "2007-12-03",
"contractDays": 123,
"coaSeqNo": 123,
"benchmarkEstimates": [Input_Cargo_benchmarkEstimates],
"linkedTrades": [Input_Cargo_linkedTrades],
"trader": "xyz789",
"cargoTimeBar": Input_Cargo_cargoTimeBar,
"cargoItineraries": [Input_Cargo_CargoItineraries],
"loadPort": Input_Cargo_LoadPort,
"firstBroker": Input_Cargo_firstBroker,
"cargoBrokers": [Input_Cargo_cargoBrokers],
"xfrt": Input_Cargo_xfrt,
"userProperties": [Input_Cargo_userProperties],
"cargoBooking": Input_Cargo_cargoBooking,
"loadOption": Input_Cargo_loadOption,
"dischargeOption": Input_Cargo_dischargeOption,
"pricing": Input_Cargo_pricing,
"bunkerExposures": [Input_Cargo_bunkerExposures]
}
Input_Cargo_CargoItineraries
Fields
| Input Field | Description |
|---|---|
externalRef - String
|
|
cargoShortName - String
|
|
gradeSeqNo - Int
|
|
portFunc - String
|
|
portNo - Int
|
|
cargoQty - Float
|
|
berthShortName - String
|
|
terms - String
|
|
loadDiscRate - Float
|
|
rateUnit - String
|
|
commercialID - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
cargoUnit - String
|
|
supplierReceiver - String
|
|
etaLocal - Date
|
|
etrLocal - Date
|
|
norHours - Float
|
|
portExpAmountCurr - Int
|
|
conversionFactor - Float
|
|
btuQty - Float
|
|
portDays - Float
|
|
extraPortDays - Float
|
Example
{
"externalRef": "xyz789",
"cargoShortName": "abc123",
"gradeSeqNo": 987,
"portFunc": "xyz789",
"portNo": 123,
"cargoQty": 987.65,
"berthShortName": "xyz789",
"terms": "xyz789",
"loadDiscRate": 987.65,
"rateUnit": "xyz789",
"commercialID": "abc123",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"cargoUnit": "abc123",
"supplierReceiver": "abc123",
"etaLocal": "2007-12-03",
"etrLocal": "2007-12-03",
"norHours": 987.65,
"portExpAmountCurr": 123,
"conversionFactor": 987.65,
"btuQty": 987.65,
"portDays": 987.65,
"extraPortDays": 123.45
}
Input_Cargo_LoadPort
Fields
| Input Field | Description |
|---|---|
externalRef - String
|
|
cargoShortName - String
|
|
gradeSeqNo - Int
|
|
portFunc - String
|
|
portNo - Int
|
|
cargoQty - Float
|
|
berthShortName - String
|
|
terms - String
|
|
loadDiscRate - Float
|
|
rateUnit - String
|
|
commercialID - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
cargoUnit - String
|
|
supplierReceiver - String
|
|
etaLocal - Date
|
|
etrLocal - Date
|
|
norHours - Float
|
|
portExpAmountCurr - Int
|
|
conversionFactor - Float
|
|
btuQty - Float
|
|
portDays - Float
|
|
extraPortDays - Float
|
Example
{
"externalRef": "xyz789",
"cargoShortName": "abc123",
"gradeSeqNo": 123,
"portFunc": "xyz789",
"portNo": 123,
"cargoQty": 123.45,
"berthShortName": "xyz789",
"terms": "abc123",
"loadDiscRate": 987.65,
"rateUnit": "xyz789",
"commercialID": "abc123",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"cargoUnit": "xyz789",
"supplierReceiver": "abc123",
"etaLocal": "2007-12-03",
"etrLocal": "2007-12-03",
"norHours": 123.45,
"portExpAmountCurr": 987,
"conversionFactor": 987.65,
"btuQty": 987.65,
"portDays": 987.65,
"extraPortDays": 987.65
}
Input_Cargo_benchmarkEstimates
Fields
| Input Field | Description |
|---|---|
estimateID - String
|
|
route - String
|
|
benchmarkEstimateBunkers - [Input_Cargo_benchmarkEstimates_BenchmarkEstimateBunkers]
|
Example
{
"estimateID": "abc123",
"route": "xyz789",
"benchmarkEstimateBunkers": [
Input_Cargo_benchmarkEstimates_BenchmarkEstimateBunkers
]
}
Input_Cargo_benchmarkEstimates_BenchmarkEstimateBunkers
Input_Cargo_bunkerExposures
Input_Cargo_cargoBooking
Fields
| Input Field | Description |
|---|---|
bookingNo - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
status - String
|
|
cargoBookingStowage - Input_Cargo_cargoBooking_cargoBookingStowage
|
Example
{
"bookingNo": "abc123",
"vesselCode": "xyz789",
"voyageNo": 123,
"status": "xyz789",
"cargoBookingStowage": Input_Cargo_cargoBooking_cargoBookingStowage
}
Input_Cargo_cargoBooking_cargoBookingStowage
Example
{
"tankNameInternal": "abc123",
"cargoID": 123,
"prevCargoFirst": "abc123",
"prevCargoSecond": "xyz789",
"prevCargoThird": "xyz789",
"comments": "abc123"
}
Input_Cargo_cargoBrokers
Example
{
"brokerShortName": "xyz789",
"commission": 123.45,
"commissionType": "abc123",
"freightInvoiceSetting": "xyz789",
"demurrageSetting": "abc123"
}
Input_Cargo_cargoTimeBar
Input_Cargo_dischargeOption
Example
{
"portFunc": "abc123",
"portNo": 987,
"terms": "xyz789",
"loadDiscRate": 123.45,
"rateUnit": "abc123",
"norHours": 987.65,
"portExpAmountBase": 123
}
Input_Cargo_firstBroker
Example
{
"brokerShortName": "abc123",
"commission": 987.65,
"commissionType": "xyz789",
"freightInvoiceSetting": "abc123",
"demurrageSetting": "xyz789"
}
Input_Cargo_linkedTrades
Input_Cargo_loadOption
Example
{
"portFunc": "abc123",
"portNo": 987,
"terms": "xyz789",
"loadDiscRate": 123.45,
"rateUnit": "xyz789",
"norHours": 123.45,
"portExpAmountBase": 123
}
Input_Cargo_pricing
Example
{
"loadPort0No": 987,
"dischargePort0No": 123,
"internalReference": "abc123",
"rate": 123.45,
"tableOrIndex": "abc123",
"basis": "abc123",
"bunkerAdjustSymbol": "xyz789",
"bunkerAdjustQty": 987.65,
"bunkerAdjustPrice": 123.45,
"bunkerAdjustBAF": 987.65
}
Input_Cargo_userProperties
Input_Cargo_xfrt
Input_Invoice
Fields
| Input Field | Description |
|---|---|
action - String
|
|
statusCode - String
|
|
transNo - String
|
|
transType - String
|
|
externalRef - String
|
|
vendorCompanyNo - Int
|
|
invoiceNo - String
|
|
purchaseOrderNo - String
|
|
statementNo - Int
|
|
note - String
|
|
approvalNote - String
|
|
paymentTermsCode - String
|
|
invoiceDate - Date
|
|
accountingDate - Date
|
|
dueDate - Date
|
|
exchangeRateDate - Date
|
|
receivedDate - Date
|
|
creditAccountCode - String
|
|
amountCurr - Float
|
|
curr - String
|
|
amountBase - Float
|
|
baseCurr - String
|
|
billSource - String
|
|
remittanceSeq - Int
|
|
remittanceCompanyNo - Int
|
|
docNo - String
|
|
lastUser - String
|
|
serviceDate - Date
|
|
exchangeRate - Float
|
|
operationsInvoice - Input_Invoice_operationsInvoice
|
|
financialsInvoiceDetails - Input_Invoice_financialsInvoiceDetails
|
|
cargo - Input_Invoice_Cargo
|
Example
{
"action": "abc123",
"statusCode": "xyz789",
"transNo": "abc123",
"transType": "xyz789",
"externalRef": "abc123",
"vendorCompanyNo": 987,
"invoiceNo": "abc123",
"purchaseOrderNo": "xyz789",
"statementNo": 987,
"note": "xyz789",
"approvalNote": "xyz789",
"paymentTermsCode": "abc123",
"invoiceDate": "2007-12-03",
"accountingDate": "2007-12-03",
"dueDate": "2007-12-03",
"exchangeRateDate": "2007-12-03",
"receivedDate": "2007-12-03",
"creditAccountCode": "xyz789",
"amountCurr": 987.65,
"curr": "abc123",
"amountBase": 123.45,
"baseCurr": "abc123",
"billSource": "xyz789",
"remittanceSeq": 123,
"remittanceCompanyNo": 987,
"docNo": "xyz789",
"lastUser": "xyz789",
"serviceDate": "2007-12-03",
"exchangeRate": 123.45,
"operationsInvoice": Input_Invoice_operationsInvoice,
"financialsInvoiceDetails": Input_Invoice_financialsInvoiceDetails,
"cargo": Input_Invoice_Cargo
}
Input_Invoice_Cargo
Fields
| Input Field | Description |
|---|---|
cargoShortName - String
|
|
cargoUnit - String
|
|
dischDemurrageBase - Float
|
|
loadDemurrageBase - Float
|
|
dischDespatchBase - Float
|
|
loadDespatchBase - Float
|
|
curr - String
|
|
freightRate - Float
|
|
lumpsum - Float
|
|
worldScaleRate - Float
|
|
worldScaleLevel - Float
|
|
freightType - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
cargoBroker - Input_Invoice_Cargo_CargoBroker
|
|
extraFreightTerms - Input_Invoice_Cargo_ExtraFreightTerms
|
Example
{
"cargoShortName": "xyz789",
"cargoUnit": "abc123",
"dischDemurrageBase": 123.45,
"loadDemurrageBase": 123.45,
"dischDespatchBase": 987.65,
"loadDespatchBase": 987.65,
"curr": "xyz789",
"freightRate": 123.45,
"lumpsum": 987.65,
"worldScaleRate": 123.45,
"worldScaleLevel": 987.65,
"freightType": "xyz789",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"cargoBroker": Input_Invoice_Cargo_CargoBroker,
"extraFreightTerms": Input_Invoice_Cargo_ExtraFreightTerms
}
Input_Invoice_Cargo_CargoBroker
Input_Invoice_Cargo_ExtraFreightTerms
Input_Invoice_financialsInvoiceDetails
Fields
| Input Field | Description |
|---|---|
transNo - String
|
|
seq - String
|
|
lobCode - String
|
|
departmentName - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
operationsInvoiceSeq - Int
|
|
portName - String
|
|
portNo - Int
|
|
ledgerCode - String
|
|
creditAccountCode - String
|
|
accountingDate - Date
|
|
operationBillCode - String
|
|
operationSubCode - String
|
|
description - String
|
|
amountCurr - Float
|
|
amountBase - Float
|
|
rate - Float
|
|
quantity - Float
|
|
taxCode - String
|
|
lastUserID - String
|
|
lastUpdateGmt - Date
|
|
productCode - String
|
|
codeDescription - String
|
|
companyCode - String
|
|
intercompanyCode - String
|
Example
{
"transNo": "xyz789",
"seq": "abc123",
"lobCode": "xyz789",
"departmentName": "xyz789",
"vesselCode": "xyz789",
"voyageNo": 123,
"operationsInvoiceSeq": 987,
"portName": "xyz789",
"portNo": 987,
"ledgerCode": "xyz789",
"creditAccountCode": "xyz789",
"accountingDate": "2007-12-03",
"operationBillCode": "xyz789",
"operationSubCode": "abc123",
"description": "xyz789",
"amountCurr": 987.65,
"amountBase": 987.65,
"rate": 123.45,
"quantity": 123.45,
"taxCode": "abc123",
"lastUserID": "abc123",
"lastUpdateGmt": "2007-12-03",
"productCode": "abc123",
"codeDescription": "xyz789",
"companyCode": "xyz789",
"intercompanyCode": "abc123"
}
Input_Invoice_operationsInvoice
Input_Nomination
Fields
| Input Field | Description |
|---|---|
action - String
|
|
nominationRef - String
|
|
hasVoyage - String
|
|
vesselCode - String
|
|
vesselIMONo - String
|
|
vesselRefNo - String
|
|
messageID - String
|
|
cargo - Input_Nomination_Cargo
|
|
voyage - Input_Nomination_Voyage
|
Example
{
"action": "abc123",
"nominationRef": "abc123",
"hasVoyage": "abc123",
"vesselCode": "abc123",
"vesselIMONo": "xyz789",
"vesselRefNo": "abc123",
"messageID": "xyz789",
"cargo": Input_Nomination_Cargo,
"voyage": Input_Nomination_Voyage
}
Input_Nomination_Cargo
Fields
| Input Field | Description |
|---|---|
action - String
|
|
cargoID - Int
|
|
vcInID - Int
|
|
externalRef - String
|
|
cargoShortName - String
|
|
counterpartyShortName - String
|
|
cPDate - Date
|
|
cpDate - Date
|
|
cPForm - String
|
|
cpForm - String
|
|
cargoUnit - String
|
|
cPQty - Float
|
|
cpQty - Float
|
|
minQty - Int
|
|
maxQty - Int
|
|
optionType - String
|
|
remarks - String
|
|
curr - String
|
|
manualTce - Float
|
|
freightType - String
|
|
freightRate - Float
|
|
lumpsum - Float
|
|
worldScaleRate - Float
|
|
worldScaleLevel - Float
|
|
loadDemRateCurr - Float
|
|
loadDespatchRateCurr - Float
|
|
contractType - String
|
|
supplierShortName - String
|
|
receiverShortName - String
|
|
vesselRef - String
|
|
bookingNo - String
|
|
refContract - String
|
|
contractReference - String
|
|
companyCode - String
|
|
lobCode - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
laycanFromGmt - Date
|
|
laycanToGmt - Date
|
|
refVoyageRoute - String
|
|
vslCode - String
|
|
mTEquivalentFactor - Float
|
|
fobRefVoyageNo - Int
|
|
discDemRateCurr - Float
|
|
discDespatchRateCurr - Float
|
|
optionPercentage - Float
|
|
coaNo - String
|
|
status - String
|
|
commercialScheduler - String
|
|
tradeAreaNo - Int
|
|
chtrCoordinator - String
|
|
vesselType - String
|
|
voyageNo - Int
|
|
api - Float
|
|
initialEstimateID - String
|
|
exposureMethod - String
|
|
partCargo - Boolean
|
|
partCargoFactor - Float
|
|
option - Boolean
|
|
optionStatus - String
|
|
isOwnersOption - Boolean
|
|
optionPremium - Float
|
|
optionDeclaredDate - Date
|
|
optionDeclarationDate - Date
|
|
exposureBasisDate - Date
|
|
contractDays - Int
|
|
coaSeqNo - Int
|
|
benchmarkEstimates - [Input_Nomination_Cargo_benchmarkEstimates]
|
|
linkedTrades - [Input_Nomination_Cargo_linkedTrades]
|
|
trader - String
|
|
cargoTimeBar - Input_Nomination_Cargo_cargoTimeBar
|
|
cargoItineraries - [Input_Nomination_Cargo_CargoItineraries]
|
|
loadPort - Input_Nomination_Cargo_LoadPort
|
|
firstBroker - Input_Nomination_Cargo_firstBroker
|
|
cargoBrokers - [Input_Nomination_Cargo_cargoBrokers]
|
|
xfrt - Input_Nomination_Cargo_xfrt
|
|
userProperties - [Input_Nomination_Cargo_userProperties]
|
|
cargoBooking - Input_Nomination_Cargo_cargoBooking
|
|
loadOption - Input_Nomination_Cargo_loadOption
|
|
dischargeOption - Input_Nomination_Cargo_dischargeOption
|
|
pricing - Input_Nomination_Cargo_pricing
|
|
bunkerExposures - [Input_Nomination_Cargo_bunkerExposures]
|
Example
{
"action": "xyz789",
"cargoID": 123,
"vcInID": 123,
"externalRef": "xyz789",
"cargoShortName": "abc123",
"counterpartyShortName": "xyz789",
"cPDate": "2007-12-03",
"cpDate": "2007-12-03",
"cPForm": "xyz789",
"cpForm": "xyz789",
"cargoUnit": "xyz789",
"cPQty": 987.65,
"cpQty": 123.45,
"minQty": 123,
"maxQty": 123,
"optionType": "abc123",
"remarks": "xyz789",
"curr": "xyz789",
"manualTce": 123.45,
"freightType": "abc123",
"freightRate": 123.45,
"lumpsum": 123.45,
"worldScaleRate": 987.65,
"worldScaleLevel": 123.45,
"loadDemRateCurr": 987.65,
"loadDespatchRateCurr": 123.45,
"contractType": "xyz789",
"supplierShortName": "xyz789",
"receiverShortName": "abc123",
"vesselRef": "abc123",
"bookingNo": "xyz789",
"refContract": "xyz789",
"contractReference": "xyz789",
"companyCode": "xyz789",
"lobCode": "abc123",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"laycanFromGmt": "2007-12-03",
"laycanToGmt": "2007-12-03",
"refVoyageRoute": "abc123",
"vslCode": "xyz789",
"mTEquivalentFactor": 987.65,
"fobRefVoyageNo": 987,
"discDemRateCurr": 123.45,
"discDespatchRateCurr": 123.45,
"optionPercentage": 987.65,
"coaNo": "xyz789",
"status": "xyz789",
"commercialScheduler": "abc123",
"tradeAreaNo": 123,
"chtrCoordinator": "xyz789",
"vesselType": "xyz789",
"voyageNo": 123,
"api": 987.65,
"initialEstimateID": "abc123",
"exposureMethod": "abc123",
"partCargo": false,
"partCargoFactor": 987.65,
"option": false,
"optionStatus": "xyz789",
"isOwnersOption": true,
"optionPremium": 123.45,
"optionDeclaredDate": "2007-12-03",
"optionDeclarationDate": "2007-12-03",
"exposureBasisDate": "2007-12-03",
"contractDays": 987,
"coaSeqNo": 123,
"benchmarkEstimates": [
Input_Nomination_Cargo_benchmarkEstimates
],
"linkedTrades": [Input_Nomination_Cargo_linkedTrades],
"trader": "abc123",
"cargoTimeBar": Input_Nomination_Cargo_cargoTimeBar,
"cargoItineraries": [
Input_Nomination_Cargo_CargoItineraries
],
"loadPort": Input_Nomination_Cargo_LoadPort,
"firstBroker": Input_Nomination_Cargo_firstBroker,
"cargoBrokers": [Input_Nomination_Cargo_cargoBrokers],
"xfrt": Input_Nomination_Cargo_xfrt,
"userProperties": [
Input_Nomination_Cargo_userProperties
],
"cargoBooking": Input_Nomination_Cargo_cargoBooking,
"loadOption": Input_Nomination_Cargo_loadOption,
"dischargeOption": Input_Nomination_Cargo_dischargeOption,
"pricing": Input_Nomination_Cargo_pricing,
"bunkerExposures": [
Input_Nomination_Cargo_bunkerExposures
]
}
Input_Nomination_Cargo_CargoItineraries
Fields
| Input Field | Description |
|---|---|
externalRef - String
|
|
cargoShortName - String
|
|
gradeSeqNo - Int
|
|
portFunc - String
|
|
portNo - Int
|
|
cargoQty - Float
|
|
berthShortName - String
|
|
terms - String
|
|
loadDiscRate - Float
|
|
rateUnit - String
|
|
commercialID - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
cargoUnit - String
|
|
supplierReceiver - String
|
|
etaLocal - Date
|
|
etrLocal - Date
|
|
norHours - Float
|
|
portExpAmountCurr - Int
|
|
conversionFactor - Float
|
|
btuQty - Float
|
|
portDays - Float
|
|
extraPortDays - Float
|
Example
{
"externalRef": "xyz789",
"cargoShortName": "xyz789",
"gradeSeqNo": 123,
"portFunc": "abc123",
"portNo": 123,
"cargoQty": 987.65,
"berthShortName": "abc123",
"terms": "abc123",
"loadDiscRate": 123.45,
"rateUnit": "abc123",
"commercialID": "xyz789",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"cargoUnit": "xyz789",
"supplierReceiver": "abc123",
"etaLocal": "2007-12-03",
"etrLocal": "2007-12-03",
"norHours": 987.65,
"portExpAmountCurr": 987,
"conversionFactor": 987.65,
"btuQty": 987.65,
"portDays": 123.45,
"extraPortDays": 987.65
}
Input_Nomination_Cargo_LoadPort
Fields
| Input Field | Description |
|---|---|
externalRef - String
|
|
cargoShortName - String
|
|
gradeSeqNo - Int
|
|
portFunc - String
|
|
portNo - Int
|
|
cargoQty - Float
|
|
berthShortName - String
|
|
terms - String
|
|
loadDiscRate - Float
|
|
rateUnit - String
|
|
commercialID - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
cargoUnit - String
|
|
supplierReceiver - String
|
|
etaLocal - Date
|
|
etrLocal - Date
|
|
norHours - Float
|
|
portExpAmountCurr - Int
|
|
conversionFactor - Float
|
|
btuQty - Float
|
|
portDays - Float
|
|
extraPortDays - Float
|
Example
{
"externalRef": "xyz789",
"cargoShortName": "xyz789",
"gradeSeqNo": 987,
"portFunc": "xyz789",
"portNo": 987,
"cargoQty": 987.65,
"berthShortName": "xyz789",
"terms": "abc123",
"loadDiscRate": 123.45,
"rateUnit": "xyz789",
"commercialID": "xyz789",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"cargoUnit": "xyz789",
"supplierReceiver": "abc123",
"etaLocal": "2007-12-03",
"etrLocal": "2007-12-03",
"norHours": 987.65,
"portExpAmountCurr": 123,
"conversionFactor": 123.45,
"btuQty": 987.65,
"portDays": 987.65,
"extraPortDays": 987.65
}
Input_Nomination_Cargo_benchmarkEstimates
Fields
| Input Field | Description |
|---|---|
estimateID - String
|
|
route - String
|
|
benchmarkEstimateBunkers - [Input_Nomination_Cargo_benchmarkEstimates_BenchmarkEstimateBunkers]
|
Example
{
"estimateID": "abc123",
"route": "xyz789",
"benchmarkEstimateBunkers": [
Input_Nomination_Cargo_benchmarkEstimates_BenchmarkEstimateBunkers
]
}
Input_Nomination_Cargo_benchmarkEstimates_BenchmarkEstimateBunkers
Input_Nomination_Cargo_bunkerExposures
Input_Nomination_Cargo_cargoBooking
Fields
| Input Field | Description |
|---|---|
bookingNo - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
status - String
|
|
cargoBookingStowage - Input_Nomination_Cargo_cargoBooking_cargoBookingStowage
|
Example
{
"bookingNo": "abc123",
"vesselCode": "xyz789",
"voyageNo": 987,
"status": "abc123",
"cargoBookingStowage": Input_Nomination_Cargo_cargoBooking_cargoBookingStowage
}
Input_Nomination_Cargo_cargoBooking_cargoBookingStowage
Example
{
"tankNameInternal": "abc123",
"cargoID": 123,
"prevCargoFirst": "xyz789",
"prevCargoSecond": "xyz789",
"prevCargoThird": "abc123",
"comments": "xyz789"
}
Input_Nomination_Cargo_cargoBrokers
Example
{
"brokerShortName": "xyz789",
"commission": 123.45,
"commissionType": "abc123",
"freightInvoiceSetting": "abc123",
"demurrageSetting": "abc123"
}
Input_Nomination_Cargo_cargoTimeBar
Input_Nomination_Cargo_dischargeOption
Example
{
"portFunc": "abc123",
"portNo": 987,
"terms": "abc123",
"loadDiscRate": 987.65,
"rateUnit": "xyz789",
"norHours": 987.65,
"portExpAmountBase": 123
}
Input_Nomination_Cargo_firstBroker
Example
{
"brokerShortName": "xyz789",
"commission": 123.45,
"commissionType": "xyz789",
"freightInvoiceSetting": "abc123",
"demurrageSetting": "abc123"
}
Input_Nomination_Cargo_linkedTrades
Input_Nomination_Cargo_loadOption
Example
{
"portFunc": "abc123",
"portNo": 123,
"terms": "xyz789",
"loadDiscRate": 987.65,
"rateUnit": "abc123",
"norHours": 123.45,
"portExpAmountBase": 123
}
Input_Nomination_Cargo_pricing
Example
{
"loadPort0No": 123,
"dischargePort0No": 123,
"internalReference": "xyz789",
"rate": 123.45,
"tableOrIndex": "abc123",
"basis": "abc123",
"bunkerAdjustSymbol": "xyz789",
"bunkerAdjustQty": 123.45,
"bunkerAdjustPrice": 123.45,
"bunkerAdjustBAF": 987.65
}
Input_Nomination_Cargo_userProperties
Input_Nomination_Cargo_xfrt
Input_Nomination_Voyage
Fields
| Input Field | Description |
|---|---|
consecutive - Boolean
|
|
oprType - String
|
|
voyageItineraries - [Input_Nomination_Voyage_VoyageItineraries]
|
|
userProperties - [Input_Nomination_Voyage_userProperties]
|
Example
{
"consecutive": true,
"oprType": "xyz789",
"voyageItineraries": [
Input_Nomination_Voyage_VoyageItineraries
],
"userProperties": [
Input_Nomination_Voyage_userProperties
]
}
Input_Nomination_Voyage_VoyageItineraries
Fields
| Input Field | Description |
|---|---|
portNo - Int
|
|
portFunc - String
|
|
voyageItineraryBerths - [Input_Nomination_Voyage_VoyageItineraries_voyageItineraryBerths]
|
Example
{
"portNo": 987,
"portFunc": "xyz789",
"voyageItineraryBerths": [
Input_Nomination_Voyage_VoyageItineraries_voyageItineraryBerths
]
}
Input_Nomination_Voyage_VoyageItineraries_voyageItineraryBerths
Fields
| Input Field | Description |
|---|---|
voyageCargoHandlings - [Input_Nomination_Voyage_VoyageItineraries_voyageItineraryBerths_voyageCargoHandlings]
|
Example
{
"voyageCargoHandlings": [
Input_Nomination_Voyage_VoyageItineraries_voyageItineraryBerths_voyageCargoHandlings
]
}
Input_Nomination_Voyage_VoyageItineraries_voyageItineraryBerths_voyageCargoHandlings
Fields
| Input Field | Description |
|---|---|
cargoID - Int
|
Example
{"cargoID": 123}
Input_Nomination_Voyage_userProperties
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
InterfaceMessagesAndNotifications
Fields
| Field Name | Description |
|---|---|
iD - String
|
|
itemType - String
|
|
typeInternal - String
|
|
assignee - String
|
|
lastUpdateGmt - Date
|
|
errorCode - String
|
|
errorDescription - String
|
|
refNo - String
|
|
content - String
|
|
log - String
|
|
status - String
|
|
incomingOrOutgoing - String
|
|
type - String
|
|
messageOrNotification - String
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"iD": "xyz789",
"itemType": "xyz789",
"typeInternal": "xyz789",
"assignee": "xyz789",
"lastUpdateGmt": "2007-12-03",
"errorCode": "xyz789",
"errorDescription": "abc123",
"refNo": "xyz789",
"content": "xyz789",
"log": "xyz789",
"status": "xyz789",
"incomingOrOutgoing": "abc123",
"type": "abc123",
"messageOrNotification": "abc123",
"_id": "xyz789",
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
InternalFinalFreightStatementVoyageRelationships
Fields
| Field Name | Description |
|---|---|
voyage - RelationshipDefinition
|
|
counterparty - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
Example
{
"voyage": RelationshipDefinition,
"counterparty": RelationshipDefinition,
"cargo": RelationshipDefinition
}
InternalIndexHireTimeChartersRelationships
Fields
| Field Name | Description |
|---|---|
timeCharterContract - RelationshipDefinition
|
Example
{"timeCharterContract": RelationshipDefinition}
InvoiceNote
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
followUpDays - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
transNo - String
|
|
seq - Int
|
|
action - String
|
|
memo - String
|
|
actionDate - Date
|
|
paidAmount - Float
|
|
outstandingAmount - Float
|
|
lastUser - String
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
financialsInvoice - FinancialsInvoice
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"followUpDays": 987,
"customFieldByID": Any,
"customField": Any,
"transNo": "abc123",
"seq": 123,
"action": "xyz789",
"memo": "xyz789",
"actionDate": "2007-12-03",
"paidAmount": 987.65,
"outstandingAmount": 123.45,
"lastUser": "abc123",
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"financialsInvoice": FinancialsInvoice,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
InvoiceNoteFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - InvoiceNoteFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": InvoiceNoteFormQueryWhere
}
InvoiceNoteFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [InvoiceNoteFormQueryWhere!]
|
|
or - [InvoiceNoteFormQueryWhere!]
|
|
rawExpression - String
|
|
transNo - StringWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
action - StringWhereValueExpression
|
|
memo - StringWhereValueExpression
|
|
actionDate - DateWhereValueExpression
|
|
paidAmount - NumberWhereValueExpression
|
|
outstandingAmount - NumberWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
financialsInvoice - FinancialsInvoiceFormQueryWhere
|
Example
{
"and": [InvoiceNoteFormQueryWhere],
"or": [InvoiceNoteFormQueryWhere],
"rawExpression": "xyz789",
"transNo": StringWhereValueExpression,
"seq": NumberWhereValueExpression,
"action": StringWhereValueExpression,
"memo": StringWhereValueExpression,
"actionDate": DateWhereValueExpression,
"paidAmount": NumberWhereValueExpression,
"outstandingAmount": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"financialsInvoice": FinancialsInvoiceFormQueryWhere
}
InvoiceNoteRelationships
Fields
| Field Name | Description |
|---|---|
financialsInvoice - RelationshipDefinition
|
Example
{"financialsInvoice": RelationshipDefinition}
JobStatus
Fields
| Field Name | Description |
|---|---|
jobStatusID - String
|
|
sourceJobStatusID - String
|
|
status - String
|
|
startedGmt - Date
|
|
finishGmt - Date
|
|
runningActionNumber - Int
|
|
group - String
|
|
executionLog - String
|
|
errorCount - Int
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"jobStatusID": "xyz789",
"sourceJobStatusID": "abc123",
"status": "xyz789",
"startedGmt": "2007-12-03",
"finishGmt": "2007-12-03",
"runningActionNumber": 123,
"group": "xyz789",
"executionLog": "xyz789",
"errorCount": 987,
"_id": "abc123",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
JobStatusFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - JobStatusFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": JobStatusFormQueryWhere
}
JobStatusFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [JobStatusFormQueryWhere!]
|
|
or - [JobStatusFormQueryWhere!]
|
|
rawExpression - String
|
|
jobStatusID - StringWhereValueExpression
|
|
sourceJobStatusID - StringWhereValueExpression
|
|
status - JobStatusStatusEnumValueExpression
|
|
startedGmt - DateWhereValueExpression
|
|
finishGmt - DateWhereValueExpression
|
|
runningActionNumber - NumberWhereValueExpression
|
|
group - StringWhereValueExpression
|
|
executionLog - StringWhereValueExpression
|
|
errorCount - NumberWhereValueExpression
|
Example
{
"and": [JobStatusFormQueryWhere],
"or": [JobStatusFormQueryWhere],
"rawExpression": "abc123",
"jobStatusID": StringWhereValueExpression,
"sourceJobStatusID": StringWhereValueExpression,
"status": JobStatusStatusEnumValueExpression,
"startedGmt": DateWhereValueExpression,
"finishGmt": DateWhereValueExpression,
"runningActionNumber": NumberWhereValueExpression,
"group": StringWhereValueExpression,
"executionLog": StringWhereValueExpression,
"errorCount": NumberWhereValueExpression
}
JobStatusStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NotStarted"
JobStatusStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - JobStatusStatusEnum
|
|
isNot - JobStatusStatusEnum
|
|
isIn - [JobStatusStatusEnum]
|
Example
{"is": "NotStarted", "isNot": "NotStarted", "isIn": ["NotStarted"]}
Json
Example
Json
LatestVesselEvaluation
Example
{
"imo": "xyz789",
"rating": 123,
"ghgRating": "abc123",
"ghgRatingVerified": "xyz789",
"lastUpdated": "2007-12-03",
"inspectionDate": "2007-12-03"
}
Laytime
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
action - Any
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
claimID - Int
|
|
companyCode - String
|
|
isIncremental - Boolean
|
|
isFinal - Boolean
|
|
lastIncrementalLaytimeID - Int
|
|
amtUSD - Float
|
|
invDate - Date
|
|
demDes - String
|
|
calculationStatusDescription - String
|
|
currentCalculationStatusDescription - String
|
|
totalClaimAmountCurr - Float
|
|
claimCompany - String
|
|
isEstimatedDemurrage - Boolean
|
|
estimatedPnlAmountBase - Float
|
|
estimatedAmountBase - Float
|
|
estimatedOnDate - Date
|
|
estimatedCalculatedAmountBase - Float
|
|
estimatedSettledAmountBase - Float
|
|
claimStatus - String
|
|
includeInPnl - Boolean
|
|
differenceReason - String
|
|
laytimeClaimType - String
|
|
claimReviewed - Boolean
|
|
claimApproved - Boolean
|
|
claimReviewedBy - String
|
|
claimApprovedBy - String
|
|
claimReviewedOnGmt - Date
|
|
claimApprovedOnGmt - Date
|
|
cargoIDs - String
|
|
vCIns - String
|
|
typeCode - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
counterpartyFullName - String
|
|
demDesInternal - String
|
|
counterpartyShortName - String
|
|
vschedSeqNo - Int
|
|
portNo - Int
|
|
cpForm - String
|
|
cpDate - Date
|
|
totalAllowedTimeMinutes - Float
|
|
ratePerDay - Float
|
|
totalUsedTimeMinutes - Float
|
|
curr - String
|
|
remarks - String
|
|
settledAmt - Float
|
|
invDateInternal - Date
|
|
calculationSubcode - String
|
|
calculationShortName - String
|
|
footerCalculationSubcode - String
|
|
footerCalculationShortName - String
|
|
calculationStatus - String
|
|
counterpartyType - String
|
|
amountBaseInternal - Float
|
|
exchRate - Float
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUpdatedBy - String
|
|
transNo - Int
|
|
demAnalyst - String
|
|
followUpDate - Date
|
|
claimRemarks - String
|
|
internalBU - String
|
|
laytimeID - Int
|
|
isReversible - Boolean
|
|
isContinuous - Boolean
|
|
isNoRebill - Boolean
|
|
isCalculationExcludedFromVoyPnl - Boolean
|
|
isDemurrageOnAccount - Boolean
|
|
isDemurrageOnAccountFinalInvoice - Boolean
|
|
isEstimatedDemurrageProvisional - Boolean
|
|
isAlwaysOnDemurrage - Boolean
|
|
isAverage - Boolean
|
|
isOfficialCalculation - Boolean
|
|
isEstimatedDemurrageAutoUpdateEnabled - Boolean
|
|
calculationMethod - String
|
|
transactionType - String
|
|
estimatedAccrualPct - Float
|
|
refNo - String
|
|
originalCalcId - Int
|
|
incrementalSeqInternal - Int
|
|
calculatedAmountCurr - Float
|
|
deductionFromDaysUsed - Float
|
|
footerAddress - AddressBook
|
|
headerAddress - AddressBook
|
|
currency - Currency
|
|
port - Port
|
|
addressBook - AddressBook
|
|
voyage - Voyage
|
|
claim - Claim
|
|
operationsInvoice - [OperationsInvoice]
|
|
demurrageAllocationDetails - [DemurrageAllocationDetails]
|
|
laytimeCargoRootCauseAllocationDetails - [OperationsInvoiceDetailCargoAllocation]
|
|
claimNotes - [ClaimNote]
|
|
laytimePorts - [LaytimePorts]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"action": Any,
"customFieldByID": Any,
"customField": Any,
"claimID": 987,
"companyCode": "xyz789",
"isIncremental": true,
"isFinal": true,
"lastIncrementalLaytimeID": 123,
"amtUSD": 123.45,
"invDate": "2007-12-03",
"demDes": "abc123",
"calculationStatusDescription": "abc123",
"currentCalculationStatusDescription": "abc123",
"totalClaimAmountCurr": 987.65,
"claimCompany": "xyz789",
"isEstimatedDemurrage": false,
"estimatedPnlAmountBase": 123.45,
"estimatedAmountBase": 123.45,
"estimatedOnDate": "2007-12-03",
"estimatedCalculatedAmountBase": 987.65,
"estimatedSettledAmountBase": 123.45,
"claimStatus": "xyz789",
"includeInPnl": true,
"differenceReason": "xyz789",
"laytimeClaimType": "xyz789",
"claimReviewed": false,
"claimApproved": false,
"claimReviewedBy": "abc123",
"claimApprovedBy": "xyz789",
"claimReviewedOnGmt": "2007-12-03",
"claimApprovedOnGmt": "2007-12-03",
"cargoIDs": "abc123",
"vCIns": "xyz789",
"typeCode": "abc123",
"vesselCode": "xyz789",
"voyageNo": 123,
"counterpartyFullName": "abc123",
"demDesInternal": "xyz789",
"counterpartyShortName": "abc123",
"vschedSeqNo": 123,
"portNo": 123,
"cpForm": "abc123",
"cpDate": "2007-12-03",
"totalAllowedTimeMinutes": 123.45,
"ratePerDay": 123.45,
"totalUsedTimeMinutes": 123.45,
"curr": "xyz789",
"remarks": "xyz789",
"settledAmt": 987.65,
"invDateInternal": "2007-12-03",
"calculationSubcode": "xyz789",
"calculationShortName": "xyz789",
"footerCalculationSubcode": "xyz789",
"footerCalculationShortName": "abc123",
"calculationStatus": "xyz789",
"counterpartyType": "xyz789",
"amountBaseInternal": 987.65,
"exchRate": 123.45,
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUpdatedBy": "abc123",
"transNo": 987,
"demAnalyst": "abc123",
"followUpDate": "2007-12-03",
"claimRemarks": "xyz789",
"internalBU": "abc123",
"laytimeID": 123,
"isReversible": true,
"isContinuous": false,
"isNoRebill": true,
"isCalculationExcludedFromVoyPnl": true,
"isDemurrageOnAccount": false,
"isDemurrageOnAccountFinalInvoice": true,
"isEstimatedDemurrageProvisional": false,
"isAlwaysOnDemurrage": true,
"isAverage": true,
"isOfficialCalculation": false,
"isEstimatedDemurrageAutoUpdateEnabled": true,
"calculationMethod": "xyz789",
"transactionType": "abc123",
"estimatedAccrualPct": 987.65,
"refNo": "abc123",
"originalCalcId": 987,
"incrementalSeqInternal": 123,
"calculatedAmountCurr": 987.65,
"deductionFromDaysUsed": 987.65,
"footerAddress": AddressBook,
"headerAddress": AddressBook,
"currency": Currency,
"port": Port,
"addressBook": AddressBook,
"voyage": Voyage,
"claim": Claim,
"operationsInvoice": [OperationsInvoice],
"demurrageAllocationDetails": [
DemurrageAllocationDetails
],
"laytimeCargoRootCauseAllocationDetails": [
OperationsInvoiceDetailCargoAllocation
],
"claimNotes": [ClaimNote],
"laytimePorts": [LaytimePorts],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
LaytimeCalculationMethodEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
LaytimeCalculationMethodEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - LaytimeCalculationMethodEnum
|
|
isNot - LaytimeCalculationMethodEnum
|
|
isIn - [LaytimeCalculationMethodEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
LaytimeFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - LaytimeFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": LaytimeFormQueryWhere
}
LaytimeFormQueryWhere
Fields
Example
{
"and": [LaytimeFormQueryWhere],
"or": [LaytimeFormQueryWhere],
"rawExpression": "xyz789",
"typeCode": StringWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"counterpartyFullName": StringWhereValueExpression,
"demDesInternal": StringWhereValueExpression,
"counterpartyShortName": StringWhereValueExpression,
"vschedSeqNo": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"cpForm": StringWhereValueExpression,
"cpDate": DateWhereValueExpression,
"totalAllowedTimeMinutes": NumberWhereValueExpression,
"ratePerDay": NumberWhereValueExpression,
"totalUsedTimeMinutes": NumberWhereValueExpression,
"curr": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"settledAmt": NumberWhereValueExpression,
"invDateInternal": DateWhereValueExpression,
"calculationSubcode": StringWhereValueExpression,
"calculationShortName": StringWhereValueExpression,
"footerCalculationSubcode": StringWhereValueExpression,
"footerCalculationShortName": StringWhereValueExpression,
"calculationStatus": StringWhereValueExpression,
"counterpartyType": StringWhereValueExpression,
"amountBaseInternal": NumberWhereValueExpression,
"exchRate": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdatedBy": StringWhereValueExpression,
"transNo": NumberWhereValueExpression,
"demAnalyst": StringWhereValueExpression,
"followUpDate": DateWhereValueExpression,
"claimRemarks": StringWhereValueExpression,
"internalBU": StringWhereValueExpression,
"laytimeID": NumberWhereValueExpression,
"isReversible": BoolWhereValueExpression,
"isContinuous": BoolWhereValueExpression,
"isNoRebill": BoolWhereValueExpression,
"isCalculationExcludedFromVoyPnl": BoolWhereValueExpression,
"isDemurrageOnAccount": BoolWhereValueExpression,
"isDemurrageOnAccountFinalInvoice": BoolWhereValueExpression,
"isEstimatedDemurrageProvisional": BoolWhereValueExpression,
"isAlwaysOnDemurrage": BoolWhereValueExpression,
"isAverage": BoolWhereValueExpression,
"isOfficialCalculation": BoolWhereValueExpression,
"isEstimatedDemurrageAutoUpdateEnabled": BoolWhereValueExpression,
"calculationMethod": LaytimeCalculationMethodEnumValueExpression,
"transactionType": LaytimeTransactionTypeEnumValueExpression,
"estimatedAccrualPct": NumberWhereValueExpression,
"refNo": StringWhereValueExpression,
"originalCalcId": NumberWhereValueExpression,
"incrementalSeqInternal": NumberWhereValueExpression,
"calculatedAmountCurr": NumberWhereValueExpression,
"deductionFromDaysUsed": NumberWhereValueExpression,
"footerAddress": AddressBookFormQueryWhere,
"headerAddress": AddressBookFormQueryWhere,
"currency": CurrencyFormQueryWhere,
"port": PortFormQueryWhere,
"addressBook": AddressBookFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"claim": ClaimFormQueryWhere
}
LaytimePortActivities
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
laytimePercent - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
warranty - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
counterpartyShortName - String
|
|
portSeqNo - Int
|
|
itinSeq - Int
|
|
seq - Int
|
|
type - String
|
|
activity - String
|
|
startLocal - Date
|
|
endLocal - Date
|
|
laytimePercentMultiple - Int
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
bargeCode - String
|
|
laytimeID - Int
|
|
isTimeDoesNotCountForLaytime - Boolean
|
|
isTimeCountsFiftyPercentForLaytime - Boolean
|
|
hasAllBargesSelected - Boolean
|
|
isManuallySetPercent - Boolean
|
|
isWarrantyStart - Boolean
|
|
isWarrantyEnd - Boolean
|
|
isSealibsGenerated - Boolean
|
|
remarks - String
|
|
blCode - String
|
|
berthShortName - String
|
|
activityType - String
|
|
laytimePorts - LaytimePorts
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"laytimePercent": 123.45,
"customFieldByID": Any,
"customField": Any,
"warranty": "xyz789",
"vesselCode": "xyz789",
"voyageNo": 987,
"counterpartyShortName": "abc123",
"portSeqNo": 987,
"itinSeq": 123,
"seq": 123,
"type": "xyz789",
"activity": "xyz789",
"startLocal": "2007-12-03",
"endLocal": "2007-12-03",
"laytimePercentMultiple": 123,
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUser": "xyz789",
"bargeCode": "abc123",
"laytimeID": 987,
"isTimeDoesNotCountForLaytime": false,
"isTimeCountsFiftyPercentForLaytime": true,
"hasAllBargesSelected": false,
"isManuallySetPercent": false,
"isWarrantyStart": false,
"isWarrantyEnd": false,
"isSealibsGenerated": false,
"remarks": "xyz789",
"blCode": "xyz789",
"berthShortName": "xyz789",
"activityType": "xyz789",
"laytimePorts": LaytimePorts,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
LaytimePortActivitiesFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - LaytimePortActivitiesFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": LaytimePortActivitiesFormQueryWhere
}
LaytimePortActivitiesFormQueryWhere
Fields
Example
{
"and": [LaytimePortActivitiesFormQueryWhere],
"or": [LaytimePortActivitiesFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"counterpartyShortName": StringWhereValueExpression,
"portSeqNo": NumberWhereValueExpression,
"itinSeq": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"type": LaytimePortActivitiesTypeEnumValueExpression,
"activity": StringWhereValueExpression,
"startLocal": DateWhereValueExpression,
"endLocal": DateWhereValueExpression,
"laytimePercentMultiple": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"bargeCode": StringWhereValueExpression,
"laytimeID": NumberWhereValueExpression,
"isTimeDoesNotCountForLaytime": BoolWhereValueExpression,
"isTimeCountsFiftyPercentForLaytime": BoolWhereValueExpression,
"hasAllBargesSelected": BoolWhereValueExpression,
"isManuallySetPercent": BoolWhereValueExpression,
"isWarrantyStart": BoolWhereValueExpression,
"isWarrantyEnd": BoolWhereValueExpression,
"isSealibsGenerated": BoolWhereValueExpression,
"remarks": StringWhereValueExpression,
"blCode": StringWhereValueExpression,
"berthShortName": StringWhereValueExpression,
"activityType": StringWhereValueExpression,
"laytimePorts": LaytimePortsFormQueryWhere
}
LaytimePortActivitiesRelationships
Fields
| Field Name | Description |
|---|---|
laytimePorts - RelationshipDefinition
|
Example
{"laytimePorts": RelationshipDefinition}
LaytimePortActivitiesTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PortActivity"
LaytimePortActivitiesTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - LaytimePortActivitiesTypeEnum
|
|
isNot - LaytimePortActivitiesTypeEnum
|
|
isIn - [LaytimePortActivitiesTypeEnum]
|
Example
{"is": "PortActivity", "isNot": "PortActivity", "isIn": ["PortActivity"]}
LaytimePortDeduction
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
laytimeID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
portSeqNo - Int
|
|
itinSeq - Int
|
|
seq - Int
|
|
activity - String
|
|
fromDateLocal - Date
|
|
toDateLocal - Date
|
|
deductionPercent - Float
|
|
hoursTotal - Float
|
|
hoursDeduction - Float
|
|
remarks - String
|
|
isDeductionPercentManuallySet - Boolean
|
|
warranty - String
|
|
day - String
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
laytime - Laytime
|
|
laytimePorts - LaytimePorts
|
|
vessel - Vessel
|
|
voyage - Voyage
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"laytimeID": 987,
"customFieldByID": Any,
"customField": Any,
"vesselCode": "abc123",
"voyageNo": 987,
"portSeqNo": 123,
"itinSeq": 987,
"seq": 123,
"activity": "xyz789",
"fromDateLocal": "2007-12-03",
"toDateLocal": "2007-12-03",
"deductionPercent": 123.45,
"hoursTotal": 123.45,
"hoursDeduction": 987.65,
"remarks": "xyz789",
"isDeductionPercentManuallySet": false,
"warranty": "xyz789",
"day": "xyz789",
"lastUser": "xyz789",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"laytime": Laytime,
"laytimePorts": LaytimePorts,
"vessel": Vessel,
"voyage": Voyage,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
LaytimePortDeductionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - LaytimePortDeductionFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": LaytimePortDeductionFormQueryWhere
}
LaytimePortDeductionFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [LaytimePortDeductionFormQueryWhere!]
|
|
or - [LaytimePortDeductionFormQueryWhere!]
|
|
rawExpression - String
|
|
laytime - LaytimeFormQueryWhere
|
|
laytimePorts - LaytimePortsFormQueryWhere
|
|
vessel - VesselFormQueryWhere
|
|
voyage - VoyageFormQueryWhere
|
Example
{
"and": [LaytimePortDeductionFormQueryWhere],
"or": [LaytimePortDeductionFormQueryWhere],
"rawExpression": "abc123",
"laytime": LaytimeFormQueryWhere,
"laytimePorts": LaytimePortsFormQueryWhere,
"vessel": VesselFormQueryWhere,
"voyage": VoyageFormQueryWhere
}
LaytimePortDeductionRelationships
Fields
| Field Name | Description |
|---|---|
laytime - RelationshipDefinition
|
|
laytimePorts - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
Example
{
"laytime": RelationshipDefinition,
"laytimePorts": RelationshipDefinition,
"vessel": RelationshipDefinition,
"voyage": RelationshipDefinition
}
LaytimePorts
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
arrivalLocal - Date
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
departureLocal - Date
|
|
laytimeCompletedLocal - Date
|
|
gracePortTimeMinutes - Float
|
|
allowedTotalTimeMinutes - Float
|
|
usedNetTimeMinutes - Float
|
|
groupInvoiceTransNo - Int
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
counterpartyShortName - String
|
|
itinerarySeq - Int
|
|
seq - Int
|
|
portFunc - String
|
|
portNo - Int
|
|
allowedTimeMinutes - Float
|
|
usedTimeMinutes - Float
|
|
demDesRatePerDay - Float
|
|
laytimeTerms - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
laytimeID - Int
|
|
cargoID - Int
|
|
totalLaytimeDeducted - Float
|
|
cargoQty - Float
|
|
lDRatePD - Float
|
|
demurrageRate - Float
|
|
despatchRate - Float
|
|
norTenderedLocal - Date
|
|
laytimeCommencedLocal - Date
|
|
counterpartyQtyUsed - Float
|
|
counterpartyQtyAllowed - Float
|
|
totalQtyUsed - Float
|
|
totalQtyAllowed - Float
|
|
minAllowedTimeMinutes - Float
|
|
graceTimeMinutes - Float
|
|
gracePortTimeHoursInternal - Float
|
|
groupNo - Int
|
|
groupNoSeq - Int
|
|
transNoInternal - Int
|
|
remarks - String
|
|
laytimeCompletedLocalActual - Date
|
|
externalCargoReference - String
|
|
voyageItinerary - VoyageItinerary
|
|
voyage - Voyage
|
|
cargo - Cargo
|
|
port - Port
|
|
laytime - Laytime
|
|
loadDischargeTableRates - [LoadDischargeTableRates]
|
|
laytimePortActivities - [LaytimePortActivities]
|
|
laytimePortDeductions - [LaytimePortDeduction]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"arrivalLocal": "2007-12-03",
"customFieldByID": Any,
"customField": Any,
"departureLocal": "2007-12-03",
"laytimeCompletedLocal": "2007-12-03",
"gracePortTimeMinutes": 987.65,
"allowedTotalTimeMinutes": 987.65,
"usedNetTimeMinutes": 123.45,
"groupInvoiceTransNo": 987,
"vesselCode": "xyz789",
"voyageNo": 123,
"counterpartyShortName": "abc123",
"itinerarySeq": 123,
"seq": 123,
"portFunc": "abc123",
"portNo": 987,
"allowedTimeMinutes": 987.65,
"usedTimeMinutes": 123.45,
"demDesRatePerDay": 123.45,
"laytimeTerms": "xyz789",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUser": "abc123",
"laytimeID": 987,
"cargoID": 987,
"totalLaytimeDeducted": 987.65,
"cargoQty": 987.65,
"lDRatePD": 123.45,
"demurrageRate": 987.65,
"despatchRate": 123.45,
"norTenderedLocal": "2007-12-03",
"laytimeCommencedLocal": "2007-12-03",
"counterpartyQtyUsed": 123.45,
"counterpartyQtyAllowed": 123.45,
"totalQtyUsed": 987.65,
"totalQtyAllowed": 123.45,
"minAllowedTimeMinutes": 987.65,
"graceTimeMinutes": 987.65,
"gracePortTimeHoursInternal": 987.65,
"groupNo": 123,
"groupNoSeq": 123,
"transNoInternal": 987,
"remarks": "abc123",
"laytimeCompletedLocalActual": "2007-12-03",
"externalCargoReference": "xyz789",
"voyageItinerary": VoyageItinerary,
"voyage": Voyage,
"cargo": Cargo,
"port": Port,
"laytime": Laytime,
"loadDischargeTableRates": [LoadDischargeTableRates],
"laytimePortActivities": [LaytimePortActivities],
"laytimePortDeductions": [LaytimePortDeduction],
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
LaytimePortsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - LaytimePortsFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": LaytimePortsFormQueryWhere
}
LaytimePortsFormQueryWhere
Fields
Example
{
"and": [LaytimePortsFormQueryWhere],
"or": [LaytimePortsFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"counterpartyShortName": StringWhereValueExpression,
"itinerarySeq": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"portFunc": StringWhereValueExpression,
"portNo": NumberWhereValueExpression,
"allowedTimeMinutes": NumberWhereValueExpression,
"usedTimeMinutes": NumberWhereValueExpression,
"demDesRatePerDay": NumberWhereValueExpression,
"laytimeTerms": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"laytimeID": NumberWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"totalLaytimeDeducted": NumberWhereValueExpression,
"cargoQty": NumberWhereValueExpression,
"lDRatePD": NumberWhereValueExpression,
"demurrageRate": NumberWhereValueExpression,
"despatchRate": NumberWhereValueExpression,
"norTenderedLocal": DateWhereValueExpression,
"laytimeCommencedLocal": DateWhereValueExpression,
"counterpartyQtyUsed": NumberWhereValueExpression,
"counterpartyQtyAllowed": NumberWhereValueExpression,
"totalQtyUsed": NumberWhereValueExpression,
"totalQtyAllowed": NumberWhereValueExpression,
"minAllowedTimeMinutes": NumberWhereValueExpression,
"graceTimeMinutes": NumberWhereValueExpression,
"gracePortTimeHoursInternal": NumberWhereValueExpression,
"groupNo": NumberWhereValueExpression,
"groupNoSeq": NumberWhereValueExpression,
"transNoInternal": NumberWhereValueExpression,
"remarks": StringWhereValueExpression,
"laytimeCompletedLocalActual": DateWhereValueExpression,
"externalCargoReference": StringWhereValueExpression,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"cargo": CargoFormQueryWhere,
"port": PortFormQueryWhere,
"laytime": LaytimeFormQueryWhere
}
LaytimePortsRelationships
Fields
| Field Name | Description |
|---|---|
voyageItinerary - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
port - RelationshipDefinition
|
|
laytime - RelationshipDefinition
|
|
firstGroupLaytimePort - RelationshipDefinition
|
|
groupOperationsInvoice - RelationshipDefinition
|
|
loadDischargeTableRates - RelationshipDefinition
|
|
laytimePortActivities - RelationshipDefinition
|
|
laytimePortDeductions - RelationshipDefinition
|
Example
{
"voyageItinerary": RelationshipDefinition,
"voyage": RelationshipDefinition,
"cargo": RelationshipDefinition,
"port": RelationshipDefinition,
"laytime": RelationshipDefinition,
"firstGroupLaytimePort": RelationshipDefinition,
"groupOperationsInvoice": RelationshipDefinition,
"loadDischargeTableRates": RelationshipDefinition,
"laytimePortActivities": RelationshipDefinition,
"laytimePortDeductions": RelationshipDefinition
}
LaytimeRelationships
Fields
| Field Name | Description |
|---|---|
footerAddress - RelationshipDefinition
|
|
headerAddress - RelationshipDefinition
|
|
currency - RelationshipDefinition
|
|
port - RelationshipDefinition
|
|
addressBook - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
laytimeLastIncremental - RelationshipDefinition
|
|
operationsInvoiceNonChemical - RelationshipDefinition
|
|
claim - RelationshipDefinition
|
|
finalLaytimeOnAccount - RelationshipDefinition
|
|
estimatedLaytime - RelationshipDefinition
|
|
operationsInvoicesChemical - RelationshipDefinition
|
|
operationsInvoice - RelationshipDefinition
|
|
demurrageAllocationDetails - RelationshipDefinition
|
|
laytimeCargoRootCauseAllocationDetails - RelationshipDefinition
|
|
laytimeAll - RelationshipDefinition
|
|
claimNotes - RelationshipDefinition
|
|
laytimePorts - RelationshipDefinition
|
|
laytimePortsByCargoId - RelationshipDefinition
|
Example
{
"footerAddress": RelationshipDefinition,
"headerAddress": RelationshipDefinition,
"currency": RelationshipDefinition,
"port": RelationshipDefinition,
"addressBook": RelationshipDefinition,
"voyage": RelationshipDefinition,
"laytimeLastIncremental": RelationshipDefinition,
"operationsInvoiceNonChemical": RelationshipDefinition,
"claim": RelationshipDefinition,
"finalLaytimeOnAccount": RelationshipDefinition,
"estimatedLaytime": RelationshipDefinition,
"operationsInvoicesChemical": RelationshipDefinition,
"operationsInvoice": RelationshipDefinition,
"demurrageAllocationDetails": RelationshipDefinition,
"laytimeCargoRootCauseAllocationDetails": RelationshipDefinition,
"laytimeAll": RelationshipDefinition,
"claimNotes": RelationshipDefinition,
"laytimePorts": RelationshipDefinition,
"laytimePortsByCargoId": RelationshipDefinition
}
LaytimeTerms
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
code - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
name - String
|
|
description - String
|
|
factor - Float
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"code": 987,
"customFieldByID": Any,
"customField": Any,
"name": "xyz789",
"description": "xyz789",
"factor": 123.45,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
LaytimeTermsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - LaytimeTermsFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": LaytimeTermsFormQueryWhere
}
LaytimeTermsFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [LaytimeTermsFormQueryWhere!]
|
|
or - [LaytimeTermsFormQueryWhere!]
|
|
rawExpression - String
|
|
code - NumberWhereValueExpression
|
|
name - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
factor - NumberWhereValueExpression
|
Example
{
"and": [LaytimeTermsFormQueryWhere],
"or": [LaytimeTermsFormQueryWhere],
"rawExpression": "xyz789",
"code": NumberWhereValueExpression,
"name": StringWhereValueExpression,
"description": StringWhereValueExpression,
"factor": NumberWhereValueExpression
}
LaytimeTransactionTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
LaytimeTransactionTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - LaytimeTransactionTypeEnum
|
|
isNot - LaytimeTransactionTypeEnum
|
|
isIn - [LaytimeTransactionTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
LoadDiscDetails
LoadDischargeStandardRate
Fields
| Field Name | Description |
|---|---|
hiddenVesselType - String
|
|
hiddenVesselTypeType - String
|
|
hiddenCargoGroup - String
|
|
hiddenCargoGroupCode - String
|
|
hiddenCargoTypeCargoGroup - String
|
|
hiddenCargoTypeCargoGroupCode - String
|
|
cargoGroupName - String
|
|
iD - Int
|
|
vesselCode - String
|
|
vesselType - String
|
|
portNo - Int
|
|
berthShortName - String
|
|
cargoShortName - String
|
|
cargoTypeCode - String
|
|
portFunction - String
|
|
rate - Float
|
|
rateUnit - String
|
|
quantityUnit - String
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
cargoType - CargoType
|
|
cargoName - CargoName
|
|
vesselTypeType - VesselType
|
|
vessel - Vessel
|
|
portBerth - PortBerth
|
|
port - Port
|
|
lDPortFunction - PortFunction
|
|
qtyUnit - UnitOfMeasure
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"hiddenVesselType": "xyz789",
"hiddenVesselTypeType": "xyz789",
"hiddenCargoGroup": "xyz789",
"hiddenCargoGroupCode": "abc123",
"hiddenCargoTypeCargoGroup": "abc123",
"hiddenCargoTypeCargoGroupCode": "abc123",
"cargoGroupName": "abc123",
"iD": 123,
"vesselCode": "abc123",
"vesselType": "xyz789",
"portNo": 123,
"berthShortName": "xyz789",
"cargoShortName": "abc123",
"cargoTypeCode": "xyz789",
"portFunction": "abc123",
"rate": 987.65,
"rateUnit": "xyz789",
"quantityUnit": "xyz789",
"lastUser": "abc123",
"lastUpdateGmt": "2007-12-03",
"cargoType": CargoType,
"cargoName": CargoName,
"vesselTypeType": VesselType,
"vessel": Vessel,
"portBerth": PortBerth,
"port": Port,
"lDPortFunction": PortFunction,
"qtyUnit": UnitOfMeasure,
"_id": "abc123",
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
LoadDischargeStandardRateFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - LoadDischargeStandardRateFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": LoadDischargeStandardRateFormQueryWhere
}
LoadDischargeStandardRateFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [LoadDischargeStandardRateFormQueryWhere!]
|
|
or - [LoadDischargeStandardRateFormQueryWhere!]
|
|
rawExpression - String
|
|
iD - NumberWhereValueExpression
|
|
vesselCode - StringWhereValueExpression
|
|
vesselType - StringWhereValueExpression
|
|
portNo - NumberWhereValueExpression
|
|
berthShortName - StringWhereValueExpression
|
|
cargoShortName - StringWhereValueExpression
|
|
cargoTypeCode - StringWhereValueExpression
|
|
portFunction - StringWhereValueExpression
|
|
rate - NumberWhereValueExpression
|
|
rateUnit - LoadDischargeStandardRateRateUnitEnumValueExpression
|
|
quantityUnit - StringWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
cargoType - CargoTypeFormQueryWhere
|
|
cargoName - CargoNameFormQueryWhere
|
|
vesselTypeType - VesselTypeFormQueryWhere
|
|
vessel - VesselFormQueryWhere
|
|
portBerth - PortBerthFormQueryWhere
|
|
port - PortFormQueryWhere
|
|
lDPortFunction - PortFunctionFormQueryWhere
|
|
qtyUnit - UnitOfMeasureFormQueryWhere
|
Example
{
"and": [LoadDischargeStandardRateFormQueryWhere],
"or": [LoadDischargeStandardRateFormQueryWhere],
"rawExpression": "abc123",
"iD": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"vesselType": StringWhereValueExpression,
"portNo": NumberWhereValueExpression,
"berthShortName": StringWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"cargoTypeCode": StringWhereValueExpression,
"portFunction": StringWhereValueExpression,
"rate": NumberWhereValueExpression,
"rateUnit": LoadDischargeStandardRateRateUnitEnumValueExpression,
"quantityUnit": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"cargoType": CargoTypeFormQueryWhere,
"cargoName": CargoNameFormQueryWhere,
"vesselTypeType": VesselTypeFormQueryWhere,
"vessel": VesselFormQueryWhere,
"portBerth": PortBerthFormQueryWhere,
"port": PortFormQueryWhere,
"lDPortFunction": PortFunctionFormQueryWhere,
"qtyUnit": UnitOfMeasureFormQueryWhere
}
LoadDischargeStandardRateRateUnitEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PerDay"
LoadDischargeStandardRateRateUnitEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - LoadDischargeStandardRateRateUnitEnum
|
|
isNot - LoadDischargeStandardRateRateUnitEnum
|
|
isIn - [LoadDischargeStandardRateRateUnitEnum]
|
Example
{"is": "PerDay", "isNot": "PerDay", "isIn": ["PerDay"]}
LoadDischargeStandardRateRelationships
Fields
| Field Name | Description |
|---|---|
cargoType - RelationshipDefinition
|
|
cargoName - RelationshipDefinition
|
|
vesselTypeType - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
portBerth - RelationshipDefinition
|
|
port - RelationshipDefinition
|
|
lDPortFunction - RelationshipDefinition
|
|
qtyUnit - RelationshipDefinition
|
Example
{
"cargoType": RelationshipDefinition,
"cargoName": RelationshipDefinition,
"vesselTypeType": RelationshipDefinition,
"vessel": RelationshipDefinition,
"portBerth": RelationshipDefinition,
"port": RelationshipDefinition,
"lDPortFunction": RelationshipDefinition,
"qtyUnit": RelationshipDefinition
}
LoadDischargeTableRates
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
laytimeID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
demItinSeq - Int
|
|
tableSeq - Int
|
|
quantity - Float
|
|
lDRate - Float
|
|
remarks - String
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
laytimePorts - LaytimePorts
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"laytimeID": 123,
"customFieldByID": Any,
"customField": Any,
"demItinSeq": 123,
"tableSeq": 123,
"quantity": 987.65,
"lDRate": 987.65,
"remarks": "abc123",
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"laytimePorts": LaytimePorts,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
LoadDischargeTableRatesFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - LoadDischargeTableRatesFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": LoadDischargeTableRatesFormQueryWhere
}
LoadDischargeTableRatesFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [LoadDischargeTableRatesFormQueryWhere!]
|
|
or - [LoadDischargeTableRatesFormQueryWhere!]
|
|
rawExpression - String
|
|
laytimeID - NumberWhereValueExpression
|
|
demItinSeq - NumberWhereValueExpression
|
|
tableSeq - NumberWhereValueExpression
|
|
quantity - NumberWhereValueExpression
|
|
lDRate - NumberWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
laytimePorts - LaytimePortsFormQueryWhere
|
Example
{
"and": [LoadDischargeTableRatesFormQueryWhere],
"or": [LoadDischargeTableRatesFormQueryWhere],
"rawExpression": "xyz789",
"laytimeID": NumberWhereValueExpression,
"demItinSeq": NumberWhereValueExpression,
"tableSeq": NumberWhereValueExpression,
"quantity": NumberWhereValueExpression,
"lDRate": NumberWhereValueExpression,
"remarks": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"laytimePorts": LaytimePortsFormQueryWhere
}
LoadDischargeTableRatesRelationships
Fields
| Field Name | Description |
|---|---|
laytimePorts - RelationshipDefinition
|
Example
{"laytimePorts": RelationshipDefinition}
LoadlineZone
Fields
| Field Name | Description |
|---|---|
name - String
|
|
description - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
loadlineZoneDetails - [LoadlineZoneDetails]
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"name": "abc123",
"description": "xyz789",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUser": "abc123",
"loadlineZoneDetails": [LoadlineZoneDetails],
"_id": "abc123",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
LoadlineZoneDetails
Fields
| Field Name | Description |
|---|---|
name - String
|
|
iD - Int
|
|
season - String
|
|
startMonth - String
|
|
startDay - Int
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
loadlineZone - LoadlineZone
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"name": "xyz789",
"iD": 123,
"season": "abc123",
"startMonth": "xyz789",
"startDay": 123,
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUser": "xyz789",
"loadlineZone": LoadlineZone,
"_id": "abc123",
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
LoadlineZoneDetailsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - LoadlineZoneDetailsFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": LoadlineZoneDetailsFormQueryWhere
}
LoadlineZoneDetailsFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [LoadlineZoneDetailsFormQueryWhere!]
|
|
or - [LoadlineZoneDetailsFormQueryWhere!]
|
|
rawExpression - String
|
|
name - StringWhereValueExpression
|
|
iD - NumberWhereValueExpression
|
|
season - LoadlineZoneDetailsSeasonEnumValueExpression
|
|
startMonth - LoadlineZoneDetailsStartMonthEnumValueExpression
|
|
startDay - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
loadlineZone - LoadlineZoneFormQueryWhere
|
Example
{
"and": [LoadlineZoneDetailsFormQueryWhere],
"or": [LoadlineZoneDetailsFormQueryWhere],
"rawExpression": "xyz789",
"name": StringWhereValueExpression,
"iD": NumberWhereValueExpression,
"season": LoadlineZoneDetailsSeasonEnumValueExpression,
"startMonth": LoadlineZoneDetailsStartMonthEnumValueExpression,
"startDay": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"loadlineZone": LoadlineZoneFormQueryWhere
}
LoadlineZoneDetailsRelationships
Fields
| Field Name | Description |
|---|---|
loadlineZone - RelationshipDefinition
|
Example
{"loadlineZone": RelationshipDefinition}
LoadlineZoneDetailsSeasonEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Summer"
LoadlineZoneDetailsSeasonEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - LoadlineZoneDetailsSeasonEnum
|
|
isNot - LoadlineZoneDetailsSeasonEnum
|
|
isIn - [LoadlineZoneDetailsSeasonEnum]
|
Example
{"is": "Summer", "isNot": "Summer", "isIn": ["Summer"]}
LoadlineZoneDetailsStartMonthEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"January"
LoadlineZoneDetailsStartMonthEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - LoadlineZoneDetailsStartMonthEnum
|
|
isNot - LoadlineZoneDetailsStartMonthEnum
|
|
isIn - [LoadlineZoneDetailsStartMonthEnum]
|
Example
{"is": "January", "isNot": "January", "isIn": ["January"]}
LoadlineZoneFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - LoadlineZoneFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": LoadlineZoneFormQueryWhere
}
LoadlineZoneFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [LoadlineZoneFormQueryWhere!]
|
|
or - [LoadlineZoneFormQueryWhere!]
|
|
rawExpression - String
|
|
name - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
Example
{
"and": [LoadlineZoneFormQueryWhere],
"or": [LoadlineZoneFormQueryWhere],
"rawExpression": "xyz789",
"name": StringWhereValueExpression,
"description": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression
}
LoadlineZoneRelationships
Fields
| Field Name | Description |
|---|---|
loadlineZoneDetails - RelationshipDefinition
|
Example
{"loadlineZoneDetails": RelationshipDefinition}
Lob
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
sqlID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
lobCode - String
|
|
name - String
|
|
inactive - Boolean
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"sqlID": 123,
"customFieldByID": Any,
"customField": Any,
"lobCode": "xyz789",
"name": "abc123",
"inactive": true,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
LobFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - LobFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": LobFormQueryWhere
}
LobFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [LobFormQueryWhere!]
|
|
or - [LobFormQueryWhere!]
|
|
rawExpression - String
|
|
lobCode - StringWhereValueExpression
|
|
name - StringWhereValueExpression
|
|
inactive - BoolWhereValueExpression
|
Example
{
"and": [LobFormQueryWhere],
"or": [LobFormQueryWhere],
"rawExpression": "abc123",
"lobCode": StringWhereValueExpression,
"name": StringWhereValueExpression,
"inactive": BoolWhereValueExpression
}
Market
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
name - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
type - String
|
|
marketDatas - [MarketData]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"name": "xyz789",
"customFieldByID": Any,
"customField": Any,
"type": "abc123",
"marketDatas": [MarketData],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
MarketCargo
Fields
| Field Name | Description |
|---|---|
cargoID - Int
|
|
basis - String
|
|
marketCargoID - String
|
|
cargoShortName - String
|
|
marketPositionID - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
firstLoadPortNo - Int
|
|
firstDiscPortNo - Int
|
|
quantity - Float
|
|
lastUpdateGmt - Date
|
|
firstDiscPort - Port
|
|
firstLoadPort - Port
|
|
marketPosition - MarketPosition
|
|
cargo - Cargo
|
|
cargoName - CargoName
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"cargoID": 987,
"basis": "xyz789",
"marketCargoID": "xyz789",
"cargoShortName": "xyz789",
"marketPositionID": "xyz789",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"firstLoadPortNo": 123,
"firstDiscPortNo": 987,
"quantity": 987.65,
"lastUpdateGmt": "2007-12-03",
"firstDiscPort": Port,
"firstLoadPort": Port,
"marketPosition": MarketPosition,
"cargo": Cargo,
"cargoName": CargoName,
"_id": "xyz789",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
MarketCargoBasisEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Undefined"
MarketCargoBasisEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - MarketCargoBasisEnum
|
|
isNot - MarketCargoBasisEnum
|
|
isIn - [MarketCargoBasisEnum]
|
Example
{"is": "Undefined", "isNot": "Undefined", "isIn": ["Undefined"]}
MarketCargoFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - MarketCargoFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": MarketCargoFormQueryWhere
}
MarketCargoFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [MarketCargoFormQueryWhere!]
|
|
or - [MarketCargoFormQueryWhere!]
|
|
rawExpression - String
|
|
cargoID - NumberWhereValueExpression
|
|
basis - MarketCargoBasisEnumValueExpression
|
|
marketCargoID - StringWhereValueExpression
|
|
cargoShortName - StringWhereValueExpression
|
|
marketPositionID - StringWhereValueExpression
|
|
laycanFromLocal - DateWhereValueExpression
|
|
laycanToLocal - DateWhereValueExpression
|
|
firstLoadPortNo - NumberWhereValueExpression
|
|
firstDiscPortNo - NumberWhereValueExpression
|
|
quantity - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
firstDiscPort - PortFormQueryWhere
|
|
firstLoadPort - PortFormQueryWhere
|
|
marketPosition - MarketPositionFormQueryWhere
|
|
cargo - CargoFormQueryWhere
|
|
cargoName - CargoNameFormQueryWhere
|
Example
{
"and": [MarketCargoFormQueryWhere],
"or": [MarketCargoFormQueryWhere],
"rawExpression": "xyz789",
"cargoID": NumberWhereValueExpression,
"basis": MarketCargoBasisEnumValueExpression,
"marketCargoID": StringWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"marketPositionID": StringWhereValueExpression,
"laycanFromLocal": DateWhereValueExpression,
"laycanToLocal": DateWhereValueExpression,
"firstLoadPortNo": NumberWhereValueExpression,
"firstDiscPortNo": NumberWhereValueExpression,
"quantity": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"firstDiscPort": PortFormQueryWhere,
"firstLoadPort": PortFormQueryWhere,
"marketPosition": MarketPositionFormQueryWhere,
"cargo": CargoFormQueryWhere,
"cargoName": CargoNameFormQueryWhere
}
MarketCargoRelationships
Fields
| Field Name | Description |
|---|---|
firstDiscPort - RelationshipDefinition
|
|
firstLoadPort - RelationshipDefinition
|
|
marketPosition - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
cargoName - RelationshipDefinition
|
Example
{
"firstDiscPort": RelationshipDefinition,
"firstLoadPort": RelationshipDefinition,
"marketPosition": RelationshipDefinition,
"cargo": RelationshipDefinition,
"cargoName": RelationshipDefinition
}
MarketData
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
periodInfo - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
basisSymbol - String
|
|
currency - String
|
|
date - Date
|
|
route - String
|
|
amount - Float
|
|
description - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
settlementTerms - String
|
|
marketName - String
|
|
type - String
|
|
referenceDate - Date
|
|
period - String
|
|
lastUser - String
|
|
basisSymbolInternal - String
|
|
periodInfoInternal - String
|
|
externalRef - String
|
|
volatilityCoeffInTheMoney - Float
|
|
volatilityCoeffOutOfTheMoney - Float
|
|
market - Market
|
|
tradeType - TradeType
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"periodInfo": "abc123",
"customFieldByID": Any,
"customField": Any,
"basisSymbol": "abc123",
"currency": "xyz789",
"date": "2007-12-03",
"route": "abc123",
"amount": 123.45,
"description": "abc123",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"settlementTerms": "xyz789",
"marketName": "xyz789",
"type": "abc123",
"referenceDate": "2007-12-03",
"period": "abc123",
"lastUser": "xyz789",
"basisSymbolInternal": "xyz789",
"periodInfoInternal": "abc123",
"externalRef": "xyz789",
"volatilityCoeffInTheMoney": 123.45,
"volatilityCoeffOutOfTheMoney": 987.65,
"market": Market,
"tradeType": TradeType,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
MarketDataFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - MarketDataFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": MarketDataFormQueryWhere
}
MarketDataFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [MarketDataFormQueryWhere!]
|
|
or - [MarketDataFormQueryWhere!]
|
|
rawExpression - String
|
|
date - DateWhereValueExpression
|
|
route - StringWhereValueExpression
|
|
amount - NumberWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
settlementTerms - MarketDataSettlementTermsEnumValueExpression
|
|
marketName - StringWhereValueExpression
|
|
type - MarketDataTypeEnumValueExpression
|
|
referenceDate - DateWhereValueExpression
|
|
period - MarketDataPeriodEnumValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
basisSymbolInternal - StringWhereValueExpression
|
|
periodInfoInternal - StringWhereValueExpression
|
|
externalRef - StringWhereValueExpression
|
|
volatilityCoeffInTheMoney - NumberWhereValueExpression
|
|
volatilityCoeffOutOfTheMoney - NumberWhereValueExpression
|
|
market - MarketFormQueryWhere
|
|
tradeType - TradeTypeFormQueryWhere
|
Example
{
"and": [MarketDataFormQueryWhere],
"or": [MarketDataFormQueryWhere],
"rawExpression": "xyz789",
"date": DateWhereValueExpression,
"route": StringWhereValueExpression,
"amount": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"settlementTerms": MarketDataSettlementTermsEnumValueExpression,
"marketName": StringWhereValueExpression,
"type": MarketDataTypeEnumValueExpression,
"referenceDate": DateWhereValueExpression,
"period": MarketDataPeriodEnumValueExpression,
"lastUser": StringWhereValueExpression,
"basisSymbolInternal": StringWhereValueExpression,
"periodInfoInternal": StringWhereValueExpression,
"externalRef": StringWhereValueExpression,
"volatilityCoeffInTheMoney": NumberWhereValueExpression,
"volatilityCoeffOutOfTheMoney": NumberWhereValueExpression,
"market": MarketFormQueryWhere,
"tradeType": TradeTypeFormQueryWhere
}
MarketDataPeriodEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
MarketDataPeriodEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - MarketDataPeriodEnum
|
|
isNot - MarketDataPeriodEnum
|
|
isIn - [MarketDataPeriodEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
MarketDataRelationships
Fields
| Field Name | Description |
|---|---|
market - RelationshipDefinition
|
|
tradeType - RelationshipDefinition
|
Example
{
"market": RelationshipDefinition,
"tradeType": RelationshipDefinition
}
MarketDataSettlementTermsEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
MarketDataSettlementTermsEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - MarketDataSettlementTermsEnum
|
|
isNot - MarketDataSettlementTermsEnum
|
|
isIn - [MarketDataSettlementTermsEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
MarketDataTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Freight"
MarketDataTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - MarketDataTypeEnum
|
|
isNot - MarketDataTypeEnum
|
|
isIn - [MarketDataTypeEnum]
|
Example
{"is": "Freight", "isNot": "Freight", "isIn": ["Freight"]}
MarketFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - MarketFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": MarketFormQueryWhere
}
MarketFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [MarketFormQueryWhere!]
|
|
or - [MarketFormQueryWhere!]
|
|
rawExpression - String
|
|
name - StringWhereValueExpression
|
|
type - MarketTypeEnumValueExpression
|
Example
{
"and": [MarketFormQueryWhere],
"or": [MarketFormQueryWhere],
"rawExpression": "xyz789",
"name": StringWhereValueExpression,
"type": MarketTypeEnumValueExpression
}
MarketInboxPositionInfo
MarketPosition
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
positionID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
sourceID - String
|
|
positionType - String
|
|
sourceSpanIndex - Int
|
|
sourceSpanLength - Int
|
|
vslCode - String
|
|
vslName - String
|
|
voyageNo - Int
|
|
cargoID - Int
|
|
cargoShort - String
|
|
locationType - String
|
|
locationRefID - String
|
|
locationLatitude - Float
|
|
locationLongitude - Float
|
|
locationSpanIndex - Int
|
|
locationSpanLength - Int
|
|
locationPortNo - Int
|
|
locationPortName - String
|
|
locationHeading - Float
|
|
openTonnage - String
|
|
dateFrom - Date
|
|
dateTo - Date
|
|
dateFromSpanIndex - Int
|
|
dateFromSpanLength - Int
|
|
dateToSpanIndex - Int
|
|
dateToSpanLength - Int
|
|
lastUpdate - Date
|
|
objectSeqNo - Int
|
|
isRead - Boolean
|
|
read - Int
|
|
imoNo - String
|
|
vesselType - String
|
|
showInCargoMatching - Int
|
|
flags - Int
|
|
cargoAmount - Float
|
|
discPortNo - Int
|
|
dWT - Float
|
|
yearBuilt - Int
|
|
ballastSpeed - Float
|
|
ladenSpeed - Float
|
|
ownership - String
|
|
vesselTypeData - VesselType
|
|
cargo - Cargo
|
|
vessel - Vessel
|
|
discPort - Port
|
|
locationPort - Port
|
|
marketPositionSource - MarketPositionSource
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"positionID": "abc123",
"customFieldByID": Any,
"customField": Any,
"sourceID": "xyz789",
"positionType": "abc123",
"sourceSpanIndex": 123,
"sourceSpanLength": 987,
"vslCode": "xyz789",
"vslName": "abc123",
"voyageNo": 123,
"cargoID": 123,
"cargoShort": "abc123",
"locationType": "xyz789",
"locationRefID": "xyz789",
"locationLatitude": 987.65,
"locationLongitude": 123.45,
"locationSpanIndex": 123,
"locationSpanLength": 987,
"locationPortNo": 123,
"locationPortName": "abc123",
"locationHeading": 987.65,
"openTonnage": "xyz789",
"dateFrom": "2007-12-03",
"dateTo": "2007-12-03",
"dateFromSpanIndex": 123,
"dateFromSpanLength": 987,
"dateToSpanIndex": 123,
"dateToSpanLength": 123,
"lastUpdate": "2007-12-03",
"objectSeqNo": 123,
"isRead": false,
"read": 987,
"imoNo": "xyz789",
"vesselType": "xyz789",
"showInCargoMatching": 123,
"flags": 987,
"cargoAmount": 123.45,
"discPortNo": 123,
"dWT": 987.65,
"yearBuilt": 123,
"ballastSpeed": 123.45,
"ladenSpeed": 987.65,
"ownership": "xyz789",
"vesselTypeData": VesselType,
"cargo": Cargo,
"vessel": Vessel,
"discPort": Port,
"locationPort": Port,
"marketPositionSource": MarketPositionSource,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
MarketPositionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - MarketPositionFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": MarketPositionFormQueryWhere
}
MarketPositionFormQueryWhere
Fields
Example
{
"and": [MarketPositionFormQueryWhere],
"or": [MarketPositionFormQueryWhere],
"rawExpression": "abc123",
"positionID": StringWhereValueExpression,
"sourceID": StringWhereValueExpression,
"positionType": MarketPositionPositionTypeEnumValueExpression,
"sourceSpanIndex": NumberWhereValueExpression,
"sourceSpanLength": NumberWhereValueExpression,
"vslCode": StringWhereValueExpression,
"vslName": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"cargoShort": StringWhereValueExpression,
"locationType": MarketPositionLocationTypeEnumValueExpression,
"locationRefID": StringWhereValueExpression,
"locationLatitude": NumberWhereValueExpression,
"locationLongitude": NumberWhereValueExpression,
"locationSpanIndex": NumberWhereValueExpression,
"locationSpanLength": NumberWhereValueExpression,
"locationPortNo": NumberWhereValueExpression,
"locationPortName": StringWhereValueExpression,
"locationHeading": NumberWhereValueExpression,
"openTonnage": StringWhereValueExpression,
"dateFrom": DateWhereValueExpression,
"dateTo": DateWhereValueExpression,
"dateFromSpanIndex": NumberWhereValueExpression,
"dateFromSpanLength": NumberWhereValueExpression,
"dateToSpanIndex": NumberWhereValueExpression,
"dateToSpanLength": NumberWhereValueExpression,
"lastUpdate": DateWhereValueExpression,
"objectSeqNo": NumberWhereValueExpression,
"isRead": BoolWhereValueExpression,
"read": NumberWhereValueExpression,
"imoNo": StringWhereValueExpression,
"vesselType": StringWhereValueExpression,
"showInCargoMatching": NumberWhereValueExpression,
"flags": NumberWhereValueExpression,
"cargoAmount": NumberWhereValueExpression,
"discPortNo": NumberWhereValueExpression,
"dWT": NumberWhereValueExpression,
"yearBuilt": NumberWhereValueExpression,
"ballastSpeed": NumberWhereValueExpression,
"ladenSpeed": NumberWhereValueExpression,
"ownership": MarketPositionOwnershipEnumValueExpression,
"vesselTypeData": VesselTypeFormQueryWhere,
"cargo": CargoFormQueryWhere,
"vessel": VesselFormQueryWhere,
"discPort": PortFormQueryWhere,
"locationPort": PortFormQueryWhere,
"marketPositionSource": MarketPositionSourceFormQueryWhere
}
MarketPositionLocationTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
MarketPositionLocationTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - MarketPositionLocationTypeEnum
|
|
isNot - MarketPositionLocationTypeEnum
|
|
isIn - [MarketPositionLocationTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
MarketPositionOwnershipEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
MarketPositionOwnershipEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - MarketPositionOwnershipEnum
|
|
isNot - MarketPositionOwnershipEnum
|
|
isIn - [MarketPositionOwnershipEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
MarketPositionPositionTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
MarketPositionPositionTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - MarketPositionPositionTypeEnum
|
|
isNot - MarketPositionPositionTypeEnum
|
|
isIn - [MarketPositionPositionTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
MarketPositionRelationships
Fields
| Field Name | Description |
|---|---|
openTonnage_Port - RelationshipDefinition
|
|
openTonnage_Date - RelationshipDefinition
|
|
openTonnage_Vessel - RelationshipDefinition
|
|
openTonnage_OpenCargo - RelationshipDefinition
|
|
vesselTypeData - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
discPort - RelationshipDefinition
|
|
locationPort - RelationshipDefinition
|
|
marketPositionSource - RelationshipDefinition
|
Example
{
"openTonnage_Port": RelationshipDefinition,
"openTonnage_Date": RelationshipDefinition,
"openTonnage_Vessel": RelationshipDefinition,
"openTonnage_OpenCargo": RelationshipDefinition,
"vesselTypeData": RelationshipDefinition,
"cargo": RelationshipDefinition,
"vessel": RelationshipDefinition,
"discPort": RelationshipDefinition,
"locationPort": RelationshipDefinition,
"marketPositionSource": RelationshipDefinition
}
MarketPositionSource
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
fromEmailDomain - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
sourceID - String
|
|
dateTime - Date
|
|
fromEmail - String
|
|
body - String
|
|
dataSourceType - String
|
|
dataSourceRefID - String
|
|
dataProviderURI - String
|
|
fromEmailAddress - String
|
|
emailSubject - String
|
|
quarantined - Boolean
|
|
isQuarantined - Int
|
|
broker - AddressBook
|
|
marketPositions - [MarketPosition]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"fromEmailDomain": "abc123",
"customFieldByID": Any,
"customField": Any,
"sourceID": "xyz789",
"dateTime": "2007-12-03",
"fromEmail": "xyz789",
"body": "abc123",
"dataSourceType": "abc123",
"dataSourceRefID": "xyz789",
"dataProviderURI": "abc123",
"fromEmailAddress": "abc123",
"emailSubject": "abc123",
"quarantined": true,
"isQuarantined": 987,
"broker": AddressBook,
"marketPositions": [MarketPosition],
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
MarketPositionSourceDataSourceTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
MarketPositionSourceDataSourceTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - MarketPositionSourceDataSourceTypeEnum
|
|
isNot - MarketPositionSourceDataSourceTypeEnum
|
|
isIn - [MarketPositionSourceDataSourceTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
MarketPositionSourceFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - MarketPositionSourceFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": MarketPositionSourceFormQueryWhere
}
MarketPositionSourceFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [MarketPositionSourceFormQueryWhere!]
|
|
or - [MarketPositionSourceFormQueryWhere!]
|
|
rawExpression - String
|
|
sourceID - StringWhereValueExpression
|
|
dateTime - DateWhereValueExpression
|
|
fromEmail - StringWhereValueExpression
|
|
body - StringWhereValueExpression
|
|
dataSourceType - MarketPositionSourceDataSourceTypeEnumValueExpression
|
|
dataSourceRefID - StringWhereValueExpression
|
|
dataProviderURI - StringWhereValueExpression
|
|
fromEmailAddress - StringWhereValueExpression
|
|
emailSubject - StringWhereValueExpression
|
|
quarantined - BoolWhereValueExpression
|
|
isQuarantined - NumberWhereValueExpression
|
|
broker - AddressBookFormQueryWhere
|
Example
{
"and": [MarketPositionSourceFormQueryWhere],
"or": [MarketPositionSourceFormQueryWhere],
"rawExpression": "xyz789",
"sourceID": StringWhereValueExpression,
"dateTime": DateWhereValueExpression,
"fromEmail": StringWhereValueExpression,
"body": StringWhereValueExpression,
"dataSourceType": MarketPositionSourceDataSourceTypeEnumValueExpression,
"dataSourceRefID": StringWhereValueExpression,
"dataProviderURI": StringWhereValueExpression,
"fromEmailAddress": StringWhereValueExpression,
"emailSubject": StringWhereValueExpression,
"quarantined": BoolWhereValueExpression,
"isQuarantined": NumberWhereValueExpression,
"broker": AddressBookFormQueryWhere
}
MarketPositionSourceRelationships
Fields
| Field Name | Description |
|---|---|
broker - RelationshipDefinition
|
|
marketPositions - RelationshipDefinition
|
Example
{
"broker": RelationshipDefinition,
"marketPositions": RelationshipDefinition
}
MarketPositionsEstimate
Fields
| Field Name | Description |
|---|---|
atSeaCost - Float
|
|
dischargePortDays - Float
|
|
eta - Date
|
|
idleDays - Float
|
|
inPortCost - Float
|
|
loadPortDays - Float
|
|
maxLift - Float
|
|
pnl - Float
|
|
seaDays - Float
|
|
tce - Float
|
|
tceSymbolPriceInfo - EstimatePriceInfo
|
|
totalVoyageDays - Float
|
|
atSeaBallastCons - Float
|
|
atSeaLadenCons - Float
|
Example
{
"atSeaCost": 123.45,
"dischargePortDays": 987.65,
"eta": "2007-12-03",
"idleDays": 987.65,
"inPortCost": 987.65,
"loadPortDays": 123.45,
"maxLift": 987.65,
"pnl": 987.65,
"seaDays": 987.65,
"tce": 987.65,
"tceSymbolPriceInfo": EstimatePriceInfo,
"totalVoyageDays": 987.65,
"atSeaBallastCons": 987.65,
"atSeaLadenCons": 123.45
}
MarketPositionsRequest
Fields
| Input Field | Description |
|---|---|
imos - [String]
|
|
vesselCodes - [String]
|
|
buildYear - MinMaxRange
|
|
deadweight - MinMaxRange
|
|
etaWindow - StartEndRange
|
|
heading - [String]
|
|
lastReportedDaysAgo - Int
|
|
moveStatus - [String]
|
|
portIds - [String]
|
|
regionIds - [String]
|
|
distanceFromPort - Float
|
|
vesselTypes - [String]
|
|
destinationPortIds - [String]
|
|
includeLaden - Boolean
|
|
ghgRatingMinimum - String
|
|
ratingMinimum - Int
|
|
scrubberTypes - [String]
|
|
fleet - String
|
|
mustMatchAllGeoFilters - Boolean
|
|
laycanRange - StartEndRange
|
|
maxLoadWaitTimeDays - Float
|
|
estDischargeHours - Int
|
|
cpQty - Float
|
|
cargoClass - String
|
|
freightCalculated - Float
|
|
loadDetails - LoadDiscDetails
|
|
discDetails - LoadDiscDetails
|
|
cargoMaxDraft - Float
|
|
atSeaBunkerPrice - Float
|
|
inPortBunkerPrice - Float
|
|
freightBasisDate - String
|
|
freightSymbol - String
|
|
miscExpenses - Float
|
|
ladenThreshold - Float
|
|
runTasksAndAlerts - Boolean
|
|
calculateEstimates - Boolean
|
|
positionSources - [String]
|
|
updateRightshipScores - Boolean
|
|
count - Int
|
|
positionsSnapshot - String
|
A date string indicating the datetime snapshot for positions data. Allows for querying vessel positions "as-of" a particular date if a snapshot of the data was made. |
Example
{
"imos": ["xyz789"],
"vesselCodes": ["abc123"],
"buildYear": MinMaxRange,
"deadweight": MinMaxRange,
"etaWindow": StartEndRange,
"heading": ["xyz789"],
"lastReportedDaysAgo": 987,
"moveStatus": ["abc123"],
"portIds": ["abc123"],
"regionIds": ["xyz789"],
"distanceFromPort": 123.45,
"vesselTypes": ["xyz789"],
"destinationPortIds": ["abc123"],
"includeLaden": true,
"ghgRatingMinimum": "abc123",
"ratingMinimum": 123,
"scrubberTypes": ["xyz789"],
"fleet": "xyz789",
"mustMatchAllGeoFilters": false,
"laycanRange": StartEndRange,
"maxLoadWaitTimeDays": 123.45,
"estDischargeHours": 123,
"cpQty": 123.45,
"cargoClass": "xyz789",
"freightCalculated": 987.65,
"loadDetails": LoadDiscDetails,
"discDetails": LoadDiscDetails,
"cargoMaxDraft": 123.45,
"atSeaBunkerPrice": 987.65,
"inPortBunkerPrice": 987.65,
"freightBasisDate": "xyz789",
"freightSymbol": "abc123",
"miscExpenses": 987.65,
"ladenThreshold": 987.65,
"runTasksAndAlerts": true,
"calculateEstimates": false,
"positionSources": ["xyz789"],
"updateRightshipScores": true,
"count": 987,
"positionsSnapshot": "xyz789"
}
MarketPositionsResponse
Fields
| Field Name | Description |
|---|---|
trace - [ResultsTrace!]!
|
|
positions - [MarketVesselPosition!]!
|
Example
{
"trace": [ResultsTrace],
"positions": [MarketVesselPosition]
}
MarketPositionsRootQuery
Fields
| Field Name | Description |
|---|---|
getPositions - MarketPositionsResponse
|
|
Arguments
|
|
Example
{"getPositions": MarketPositionsResponse}
MarketPricesRootQuery
Fields
| Field Name | Description |
|---|---|
getPrice - PriceInfo
|
|
Arguments
|
|
Example
{"getPrice": PriceInfo}
MarketRelationships
Fields
| Field Name | Description |
|---|---|
marketDatas - RelationshipDefinition
|
Example
{"marketDatas": RelationshipDefinition}
MarketTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Freight"
MarketTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - MarketTypeEnum
|
|
isNot - MarketTypeEnum
|
|
isIn - [MarketTypeEnum]
|
Example
{"is": "Freight", "isNot": "Freight", "isIn": ["Freight"]}
MarketVesselPosition
Fields
| Field Name | Description |
|---|---|
vessel - VesselService_Vessel!
|
|
name - String
|
|
draught - Float
|
|
maxDraught - Float
|
|
moveStatus - String
|
|
imo - String!
|
|
destination - String
|
|
destinationTidied - String
|
|
coordinates - Coordinates!
|
|
beam - Float
|
|
length - Float
|
|
mmsi - String
|
|
unitTypeCode - String
|
|
timestamp - Date!
|
|
heading - Float!
|
|
dwt - Float!
|
|
eta - Date
|
|
etaToDestination - Date
|
|
speed - Float
|
|
yob - Int!
|
|
age - String!
|
|
ladenPercent - Float
|
|
laden - Boolean
|
|
ballast - Boolean
|
|
ballastLaden - String
|
|
portDistance - PortDistance
|
|
direction - String
|
|
openDate - Date
|
|
openPort - String
|
|
estimate - MarketPositionsEstimate
|
|
lastContract - ContractInfo
|
|
openContract - OpenContractInfo
|
|
alerts - [DecisionTableAlert!]
|
|
marketInboxPosition - MarketInboxPositionInfo
|
|
positionSource - String!
|
Example
{
"vessel": VesselService_Vessel,
"name": "abc123",
"draught": 987.65,
"maxDraught": 123.45,
"moveStatus": "abc123",
"imo": "xyz789",
"destination": "xyz789",
"destinationTidied": "xyz789",
"coordinates": Coordinates,
"beam": 123.45,
"length": 987.65,
"mmsi": "xyz789",
"unitTypeCode": "abc123",
"timestamp": "2007-12-03",
"heading": 123.45,
"dwt": 123.45,
"eta": "2007-12-03",
"etaToDestination": "2007-12-03",
"speed": 987.65,
"yob": 987,
"age": "xyz789",
"ladenPercent": 987.65,
"laden": true,
"ballast": false,
"ballastLaden": "xyz789",
"portDistance": PortDistance,
"direction": "abc123",
"openDate": "2007-12-03",
"openPort": "xyz789",
"estimate": MarketPositionsEstimate,
"lastContract": ContractInfo,
"openContract": OpenContractInfo,
"alerts": [DecisionTableAlert],
"marketInboxPosition": MarketInboxPositionInfo,
"positionSource": "xyz789"
}
MasterContract
Fields
| Field Name | Description |
|---|---|
reference - String
|
|
contractNo - String
|
|
sNRefNo - String
|
|
counterpartyShortName - String
|
|
type - String
|
|
validFromGmt - Date
|
|
validToGmt - Date
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
isBunkersOnChartererAccount - Boolean
|
|
isInvoiceBaseCpQty - Boolean
|
|
isInvoiceBaseBlQty - Boolean
|
|
isInvoiceBaseOutturn - Boolean
|
|
isEtaNotification - Boolean
|
|
isReversibleAllPorts - Boolean
|
|
useBookingQty - Boolean
|
|
companyCode - String
|
|
company - Company
|
|
counterparty - AddressBook
|
|
masterContractBrokers - [MasterContractBroker]
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"reference": "abc123",
"contractNo": "abc123",
"sNRefNo": "xyz789",
"counterpartyShortName": "xyz789",
"type": "xyz789",
"validFromGmt": "2007-12-03",
"validToGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUser": "xyz789",
"isBunkersOnChartererAccount": true,
"isInvoiceBaseCpQty": false,
"isInvoiceBaseBlQty": false,
"isInvoiceBaseOutturn": false,
"isEtaNotification": true,
"isReversibleAllPorts": false,
"useBookingQty": false,
"companyCode": "xyz789",
"company": Company,
"counterparty": AddressBook,
"masterContractBrokers": [MasterContractBroker],
"_id": "abc123",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
MasterContractBroker
Example
{
"contractNo": "abc123",
"seqNo": 123,
"brokerShortName": "abc123",
"commission": 123.45,
"lastUser": "xyz789",
"brokerType": "xyz789",
"commissionType": "xyz789",
"addressBook": AddressBook,
"masterContract": MasterContract,
"_id": "abc123",
"_keys": ["abc123"],
"_intents": ["abc123"]
}
MasterContractBrokerRelationships
Fields
| Field Name | Description |
|---|---|
addressBook - RelationshipDefinition
|
|
masterContract - RelationshipDefinition
|
Example
{
"addressBook": RelationshipDefinition,
"masterContract": RelationshipDefinition
}
MasterContractFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - MasterContractFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": MasterContractFormQueryWhere
}
MasterContractFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [MasterContractFormQueryWhere!]
|
|
or - [MasterContractFormQueryWhere!]
|
|
rawExpression - String
|
|
contractNo - StringWhereValueExpression
|
|
sNRefNo - StringWhereValueExpression
|
|
counterpartyShortName - StringWhereValueExpression
|
|
type - MasterContractTypeEnumValueExpression
|
|
validFromGmt - DateWhereValueExpression
|
|
validToGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
isBunkersOnChartererAccount - BoolWhereValueExpression
|
|
isInvoiceBaseCpQty - BoolWhereValueExpression
|
|
isInvoiceBaseBlQty - BoolWhereValueExpression
|
|
isInvoiceBaseOutturn - BoolWhereValueExpression
|
|
isEtaNotification - BoolWhereValueExpression
|
|
isReversibleAllPorts - BoolWhereValueExpression
|
|
useBookingQty - BoolWhereValueExpression
|
|
companyCode - StringWhereValueExpression
|
|
company - CompanyFormQueryWhere
|
|
counterparty - AddressBookFormQueryWhere
|
Example
{
"and": [MasterContractFormQueryWhere],
"or": [MasterContractFormQueryWhere],
"rawExpression": "abc123",
"contractNo": StringWhereValueExpression,
"sNRefNo": StringWhereValueExpression,
"counterpartyShortName": StringWhereValueExpression,
"type": MasterContractTypeEnumValueExpression,
"validFromGmt": DateWhereValueExpression,
"validToGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"isBunkersOnChartererAccount": BoolWhereValueExpression,
"isInvoiceBaseCpQty": BoolWhereValueExpression,
"isInvoiceBaseBlQty": BoolWhereValueExpression,
"isInvoiceBaseOutturn": BoolWhereValueExpression,
"isEtaNotification": BoolWhereValueExpression,
"isReversibleAllPorts": BoolWhereValueExpression,
"useBookingQty": BoolWhereValueExpression,
"companyCode": StringWhereValueExpression,
"company": CompanyFormQueryWhere,
"counterparty": AddressBookFormQueryWhere
}
MasterContractRelationships
Fields
| Field Name | Description |
|---|---|
company - RelationshipDefinition
|
|
counterparty - RelationshipDefinition
|
|
masterContractBrokers - RelationshipDefinition
|
Example
{
"company": RelationshipDefinition,
"counterparty": RelationshipDefinition,
"masterContractBrokers": RelationshipDefinition
}
MasterContractTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Cargo"
MasterContractTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - MasterContractTypeEnum
|
|
isNot - MasterContractTypeEnum
|
|
isIn - [MasterContractTypeEnum]
|
Example
{"is": "Cargo", "isNot": "Cargo", "isIn": ["Cargo"]}
MessageApplyResponse
Example
{
"response": Json,
"requestMessage": MessageRecord,
"returnObject": Json,
"debugLog": "abc123",
"errors": ["abc123"],
"warnings": ["xyz789"]
}
MessageLinkInput
MessageLinkOutput
MessageQuery
Fields
| Input Field | Description |
|---|---|
intent - String
|
|
from - String
|
|
to - String
|
|
with - String
|
|
status - String
|
|
type - String
|
|
limit - Int
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
since - Date
|
|
until - Date
|
|
effectiveSince - Date
|
|
effectiveUntil - Date
|
|
sinceDaysAgo - Int
|
|
resolveIds - Boolean
|
|
parentMessageId - String
|
|
source - String
|
|
sourceId - String
|
|
threadIds - [String]
|
|
onlyLatest - Boolean
|
Example
{
"intent": "abc123",
"from": "xyz789",
"to": "abc123",
"with": "abc123",
"status": "xyz789",
"type": "xyz789",
"limit": 987,
"approvalStatus": "abc123",
"since": "2007-12-03",
"until": "2007-12-03",
"effectiveSince": "2007-12-03",
"effectiveUntil": "2007-12-03",
"sinceDaysAgo": 987,
"resolveIds": false,
"parentMessageId": "abc123",
"source": "xyz789",
"sourceId": "xyz789",
"threadIds": ["abc123"],
"onlyLatest": true
}
MessageQueryWithId
Fields
| Input Field | Description |
|---|---|
intent - String
|
|
from - String
|
|
to - String
|
|
with - String
|
|
status - String
|
|
objectId - String
|
|
type - String
|
|
effectiveSince - Date
|
|
effectiveUntil - Date
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
since - Date
|
|
until - Date
|
|
sinceDaysAgo - Int
|
|
resolveIds - Boolean
|
|
parentMessageId - String
|
|
source - String
|
|
sourceId - String
|
|
threadIds - [String]
|
|
onlyLatest - Boolean
|
Example
{
"intent": "xyz789",
"from": "abc123",
"to": "abc123",
"with": "abc123",
"status": "xyz789",
"objectId": "abc123",
"type": "xyz789",
"effectiveSince": "2007-12-03",
"effectiveUntil": "2007-12-03",
"approvalStatus": "xyz789",
"since": "2007-12-03",
"until": "2007-12-03",
"sinceDaysAgo": 123,
"resolveIds": true,
"parentMessageId": "xyz789",
"source": "abc123",
"sourceId": "abc123",
"threadIds": ["abc123"],
"onlyLatest": false
}
MessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": true,
"context": ["xyz789"],
"timestamp": "xyz789",
"originalTimestamp": "xyz789",
"intent": "abc123",
"from": "abc123",
"to": ["xyz789"],
"fromUser": "abc123",
"status": "xyz789",
"approvalStatus": "abc123",
"objectId": "abc123",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "xyz789",
"unmapped": false,
"responseData": Json,
"applyErrors": ["abc123"],
"applyWarnings": ["xyz789"],
"parentMessageId": "xyz789",
"preResolutionObjectId": "abc123",
"title": "abc123",
"effectiveDate": "abc123",
"source": "xyz789",
"sourceId": "abc123",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["abc123"],
"isLatest": false,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
MessageRecordInput
Fields
| Input Field | Description |
|---|---|
intent - String
|
|
context - [String]
|
|
comment - String
|
|
debug - Boolean
|
|
data - Json
|
|
to - [String!]!
|
|
title - String
|
|
source - String
|
|
sourceId - String
|
|
links - [MessageLinkInput]
|
|
tags - [MessageTagInput]
|
|
fromUser - String
|
Example
{
"intent": "xyz789",
"context": ["xyz789"],
"comment": "abc123",
"debug": true,
"data": Json,
"to": ["abc123"],
"title": "xyz789",
"source": "xyz789",
"sourceId": "abc123",
"links": [MessageLinkInput],
"tags": [MessageTagInput],
"fromUser": "xyz789"
}
MessageRootMutation
Fields
| Field Name | Description |
|---|---|
apply - MessageApplyResponse
|
|
Arguments
|
|
publish - MessageRecord
|
|
Arguments
|
|
publishById - MessageRecord
|
|
Arguments
|
|
approve - MessageRecord
|
|
Arguments
|
|
approveWithResolution - MessageRecord
|
|
Arguments
|
|
reject - MessageRecord
|
|
Arguments
|
|
setAutoApprovalSettings - Boolean
|
|
Arguments
|
|
publishMessageEdits - MessageRecord
|
|
Arguments
|
|
Example
{
"apply": MessageApplyResponse,
"publish": MessageRecord,
"publishById": MessageRecord,
"approve": MessageRecord,
"approveWithResolution": MessageRecord,
"reject": MessageRecord,
"setAutoApprovalSettings": false,
"publishMessageEdits": MessageRecord
}
MessageRootQuery
Fields
| Field Name | Description |
|---|---|
getMessages - [MessageRecord]
|
|
Arguments
|
|
getFlatMessages - [MessageRecord]
|
|
Arguments
|
|
getMessageHistory - [MessageRecord]
|
|
Arguments
|
|
getMessageEditHistory - [MessageRecord]
|
|
Arguments
|
|
getMessage - MessageRecord
|
|
Arguments
|
|
getMessageById - MessageRecord
|
|
Arguments
|
|
autoApprovalSettings - [AutoApprovalSettingOutput]
|
|
Example
{
"getMessages": [MessageRecord],
"getFlatMessages": [MessageRecord],
"getMessageHistory": [MessageRecord],
"getMessageEditHistory": [MessageRecord],
"getMessage": MessageRecord,
"getMessageById": MessageRecord,
"autoApprovalSettings": [AutoApprovalSettingOutput]
}
MessageTag
MessageTagInput
MessageUpdateResponse
MinMaxRange
ModuleAccess
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
moduleAccessDescription - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
moduleDescription - String
|
|
userNo - Int
|
|
moduleAccessID - String
|
|
execute - Boolean
|
|
read - Boolean
|
|
update - Boolean
|
|
delete - Boolean
|
|
denyExecute - Boolean
|
|
denyRead - Boolean
|
|
denyUpdate - Boolean
|
|
denyDelete - Boolean
|
|
user - User
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"moduleAccessDescription": "abc123",
"customFieldByID": Any,
"customField": Any,
"moduleDescription": "abc123",
"userNo": 123,
"moduleAccessID": "abc123",
"execute": true,
"read": true,
"update": true,
"delete": false,
"denyExecute": true,
"denyRead": false,
"denyUpdate": false,
"denyDelete": false,
"user": User,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
ModuleAccessFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ModuleAccessFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ModuleAccessFormQueryWhere
}
ModuleAccessFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [ModuleAccessFormQueryWhere!]
|
|
or - [ModuleAccessFormQueryWhere!]
|
|
rawExpression - String
|
|
userNo - NumberWhereValueExpression
|
|
moduleAccessID - StringWhereValueExpression
|
|
execute - BoolWhereValueExpression
|
|
read - BoolWhereValueExpression
|
|
update - BoolWhereValueExpression
|
|
delete - BoolWhereValueExpression
|
|
denyExecute - BoolWhereValueExpression
|
|
denyRead - BoolWhereValueExpression
|
|
denyUpdate - BoolWhereValueExpression
|
|
denyDelete - BoolWhereValueExpression
|
|
user - UserFormQueryWhere
|
Example
{
"and": [ModuleAccessFormQueryWhere],
"or": [ModuleAccessFormQueryWhere],
"rawExpression": "abc123",
"userNo": NumberWhereValueExpression,
"moduleAccessID": StringWhereValueExpression,
"execute": BoolWhereValueExpression,
"read": BoolWhereValueExpression,
"update": BoolWhereValueExpression,
"delete": BoolWhereValueExpression,
"denyExecute": BoolWhereValueExpression,
"denyRead": BoolWhereValueExpression,
"denyUpdate": BoolWhereValueExpression,
"denyDelete": BoolWhereValueExpression,
"user": UserFormQueryWhere
}
ModuleAccessRelationships
Fields
| Field Name | Description |
|---|---|
user - RelationshipDefinition
|
Example
{"user": RelationshipDefinition}
NominateCargoInput
Description
This message publishes a cargo nomination to the specified party
Fields
| Input Field | Description |
|---|---|
bookingNo - String
|
|
cargoID - Int
|
|
cargoShortName - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
optionPercentage - Float
|
|
cpQty - Float
|
|
cpDate - Date
|
|
chtrCoordinator - String
|
|
optionType - String
|
|
minQty - Int
|
|
maxQty - Int
|
|
counterpartyShortName - String
|
|
tradeAreaName - String
|
|
companyCode - String
|
|
remarks - String
|
|
cargoItineraries - [NominateCargo_CargoItinerariesInput]!
|
Example
{
"bookingNo": "xyz789",
"cargoID": 987,
"cargoShortName": "abc123",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"optionPercentage": 987.65,
"cpQty": 123.45,
"cpDate": "2007-12-03",
"chtrCoordinator": "xyz789",
"optionType": "xyz789",
"minQty": 123,
"maxQty": 123,
"counterpartyShortName": "xyz789",
"tradeAreaName": "xyz789",
"companyCode": "abc123",
"remarks": "abc123",
"cargoItineraries": [
NominateCargo_CargoItinerariesInput
]
}
NominateCargoMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "abc123",
"debug": false,
"context": ["xyz789"],
"timestamp": "abc123",
"originalTimestamp": "xyz789",
"intent": "abc123",
"from": "xyz789",
"to": ["abc123"],
"fromUser": "abc123",
"status": "xyz789",
"approvalStatus": "abc123",
"objectId": "xyz789",
"type": "xyz789",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "abc123",
"previousData": Json,
"comment": "xyz789",
"unmapped": true,
"responseData": Json,
"applyErrors": ["abc123"],
"applyWarnings": ["xyz789"],
"parentMessageId": "abc123",
"preResolutionObjectId": "xyz789",
"title": "xyz789",
"effectiveDate": "xyz789",
"source": "xyz789",
"sourceId": "abc123",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["abc123"],
"isLatest": false,
"threadCount": 987,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
NominateCargo_CargoItinerariesInput
Example
{
"seqNo": 987,
"portNo": 987,
"portName": "xyz789",
"portFunc": "abc123",
"cargoQty": 987.65,
"cargoUnit": "abc123",
"minQty": 123,
"maxQty": 123
}
Notification
Fields
| Field Name | Description |
|---|---|
notificationID - String
|
|
type - String
|
|
body - String
|
|
seq - Int
|
|
lastUpdateGmt - Date
|
|
fileName - String
|
|
referenceNo - String
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"notificationID": "xyz789",
"type": "abc123",
"body": "xyz789",
"seq": 123,
"lastUpdateGmt": "2007-12-03",
"fileName": "xyz789",
"referenceNo": "xyz789",
"_id": "xyz789",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
NotificationFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - NotificationFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": NotificationFormQueryWhere
}
NotificationFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [NotificationFormQueryWhere!]
|
|
or - [NotificationFormQueryWhere!]
|
|
rawExpression - String
|
|
notificationID - StringWhereValueExpression
|
|
type - StringWhereValueExpression
|
|
body - StringWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
fileName - StringWhereValueExpression
|
|
referenceNo - StringWhereValueExpression
|
Example
{
"and": [NotificationFormQueryWhere],
"or": [NotificationFormQueryWhere],
"rawExpression": "abc123",
"notificationID": StringWhereValueExpression,
"type": StringWhereValueExpression,
"body": StringWhereValueExpression,
"seq": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"fileName": StringWhereValueExpression,
"referenceNo": StringWhereValueExpression
}
NumberWhereValueExpression
Example
{
"is": 123.45,
"isIn": [123.45],
"isNot": 987.65,
"isGreaterThan": 123.45,
"isGreaterThanOrEqualTo": 987.65,
"isLessThan": 123.45,
"isLessThanOrEqualTo": 123.45
}
ObjectAccess
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
userNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
objectID - String
|
|
objectType - String
|
|
execute - Boolean
|
|
read - Boolean
|
|
update - Boolean
|
|
delete - Boolean
|
|
denyExecute - Boolean
|
|
denyRead - Boolean
|
|
denyUpdate - Boolean
|
|
denyDelete - Boolean
|
|
user - User
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"userNo": 123,
"customFieldByID": Any,
"customField": Any,
"objectID": "xyz789",
"objectType": "xyz789",
"execute": false,
"read": false,
"update": true,
"delete": true,
"denyExecute": true,
"denyRead": false,
"denyUpdate": false,
"denyDelete": false,
"user": User,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
ObjectAccessFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ObjectAccessFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ObjectAccessFormQueryWhere
}
ObjectAccessFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [ObjectAccessFormQueryWhere!]
|
|
or - [ObjectAccessFormQueryWhere!]
|
|
rawExpression - String
|
|
userNo - NumberWhereValueExpression
|
|
objectID - StringWhereValueExpression
|
|
objectType - StringWhereValueExpression
|
|
execute - BoolWhereValueExpression
|
|
read - BoolWhereValueExpression
|
|
update - BoolWhereValueExpression
|
|
delete - BoolWhereValueExpression
|
|
denyExecute - BoolWhereValueExpression
|
|
denyRead - BoolWhereValueExpression
|
|
denyUpdate - BoolWhereValueExpression
|
|
denyDelete - BoolWhereValueExpression
|
|
user - UserFormQueryWhere
|
Example
{
"and": [ObjectAccessFormQueryWhere],
"or": [ObjectAccessFormQueryWhere],
"rawExpression": "xyz789",
"userNo": NumberWhereValueExpression,
"objectID": StringWhereValueExpression,
"objectType": StringWhereValueExpression,
"execute": BoolWhereValueExpression,
"read": BoolWhereValueExpression,
"update": BoolWhereValueExpression,
"delete": BoolWhereValueExpression,
"denyExecute": BoolWhereValueExpression,
"denyRead": BoolWhereValueExpression,
"denyUpdate": BoolWhereValueExpression,
"denyDelete": BoolWhereValueExpression,
"user": UserFormQueryWhere
}
ObjectAccessRelationships
Fields
| Field Name | Description |
|---|---|
user - RelationshipDefinition
|
Example
{"user": RelationshipDefinition}
ObjectApproval
Fields
| Field Name | Description |
|---|---|
objectType - String
|
|
objectID - String
|
|
seqNo - Int
|
|
activity - String
|
|
action - String
|
|
actionTimeStampGmt - Date
|
|
user - String
|
|
comment - String
|
|
lastUser - String
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"objectType": "xyz789",
"objectID": "abc123",
"seqNo": 987,
"activity": "abc123",
"action": "abc123",
"actionTimeStampGmt": "2007-12-03",
"user": "xyz789",
"comment": "abc123",
"lastUser": "abc123",
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"_id": "xyz789",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
ObjectApprovalActionEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Unknown"
ObjectApprovalActionEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - ObjectApprovalActionEnum
|
|
isNot - ObjectApprovalActionEnum
|
|
isIn - [ObjectApprovalActionEnum]
|
Example
{"is": "Unknown", "isNot": "Unknown", "isIn": ["Unknown"]}
ObjectApprovalActivityEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Unknown"
ObjectApprovalActivityEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - ObjectApprovalActivityEnum
|
|
isNot - ObjectApprovalActivityEnum
|
|
isIn - [ObjectApprovalActivityEnum]
|
Example
{"is": "Unknown", "isNot": "Unknown", "isIn": ["Unknown"]}
ObjectApprovalFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ObjectApprovalFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ObjectApprovalFormQueryWhere
}
ObjectApprovalFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [ObjectApprovalFormQueryWhere!]
|
|
or - [ObjectApprovalFormQueryWhere!]
|
|
rawExpression - String
|
|
objectType - ObjectApprovalObjectTypeEnumValueExpression
|
|
objectID - StringWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
activity - ObjectApprovalActivityEnumValueExpression
|
|
action - ObjectApprovalActionEnumValueExpression
|
|
actionTimeStampGmt - DateWhereValueExpression
|
|
user - StringWhereValueExpression
|
|
comment - StringWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
Example
{
"and": [ObjectApprovalFormQueryWhere],
"or": [ObjectApprovalFormQueryWhere],
"rawExpression": "abc123",
"objectType": ObjectApprovalObjectTypeEnumValueExpression,
"objectID": StringWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"activity": ObjectApprovalActivityEnumValueExpression,
"action": ObjectApprovalActionEnumValueExpression,
"actionTimeStampGmt": DateWhereValueExpression,
"user": StringWhereValueExpression,
"comment": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression
}
ObjectApprovalObjectTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Unknown"
ObjectApprovalObjectTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - ObjectApprovalObjectTypeEnum
|
|
isNot - ObjectApprovalObjectTypeEnum
|
|
isIn - [ObjectApprovalObjectTypeEnum]
|
Example
{"is": "Unknown", "isNot": "Unknown", "isIn": ["Unknown"]}
OpenContractInfo
OperationsInvoice
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
sourceString - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
lastCargoDischargeDate - Date
|
|
lastCargoLoadDate - Date
|
|
dueDateCalculated - Date
|
|
invoiceOverdueBasis - Date
|
|
ageDays - Int
|
|
calculatedAgeDays - Int
|
|
daysOverdueCalculated - Int
|
|
daysOverdue - Int
|
|
ageGroup - String
|
|
calculatedAgeGroup - String
|
|
amountFinalCurr - Float
|
|
amountPaidCurr - Float
|
|
amountFinalUSD - Float
|
|
amountPaidUSD - Float
|
|
outstandingBalanceCurr - Float
|
|
outstandingBalanceUSD - Float
|
|
paymentBatchOrderedTotalCurr - Float
|
|
outstandingToOrderCurr - Float
|
|
thirdReminderDateString - String
|
|
secondReminderDateString - String
|
|
firstReminderDateString - String
|
|
lastReminder - String
|
|
brokerList - String
|
|
brokerListAll - String
|
|
tcContractBrokerList - String
|
|
bookingNo - String
|
|
outstandingBalancePercent - Float
|
|
charterPartyDate - Date
|
|
cargoCOASequence - Int
|
|
lastPaidValueDate - Date
|
|
lastPaidDate - Date
|
|
finalPaymentPastDueDays - Float
|
|
typeCode - Int
|
|
status - String
|
|
statusDescription - String
|
|
billSubCode - String
|
|
approvalStatusDescription - String
|
|
tradeAreaNo - Int
|
|
tradeArea - String
|
|
amountBase - Float
|
|
amountCurr - Float
|
|
coalescedCompanyCode - String
|
|
companyName - String
|
|
lobCode - String
|
|
lobName - String
|
|
description - String
|
|
invoiceType - String
|
|
amountPosted - Float
|
|
balance - Float
|
|
daysClosedSinceStart - Float
|
|
daysClosedSinceEnd - Float
|
|
autoDesc - String
|
|
freightTypeDesc - String
|
|
invoiceReference - String
|
|
paymentStatus - String
|
|
invoicePaymentStatus - String
|
|
businessRuleAccountCompanyBasedRules - String
|
|
businessRuleAccountNoCompanyBasedRules - String
|
|
businessRulesInvoiceDetailsAccount - String
|
|
freightInvoiceType - String
|
|
hirePaymentType - String
|
|
invoiceCompanyCode - String
|
|
ledgerCodes - String
|
|
contractId - String
|
|
writeOffAmount - Float
|
|
aPRAmountCurr - Float
|
|
aPRAmountBase - Float
|
|
rejectReason - String
|
|
receivableStatus - String
|
|
statusCode - String
|
|
isNonAccountingInvoice - Boolean
|
|
postedReversedByUser - String
|
|
paymentTermsCode - String
|
|
vendorTypeDescription - String
|
|
allowanceID - Int
|
|
allowanceTransferTransNo - Int
|
|
sqlID - Int
|
|
transNo - Int
|
|
source - String
|
|
type - String
|
|
billDate - Date
|
|
invoiceNo - String
|
|
billAmountCurr - Float
|
|
currency - String
|
|
billAmountBase - Float
|
|
refNo - String
|
|
invoiceDescription - String
|
|
vendorType - String
|
|
vendorShortName - String
|
|
entryDateLocal - Date
|
|
lastUpdateGmt - Date
|
|
invTransNo - String
|
|
isCableMonthly - Boolean
|
|
isReissueInvoice - Boolean
|
|
isTemplate - Boolean
|
|
isBillPartiallyPaid - Boolean
|
|
isBillFullyPaid - Boolean
|
|
additionalFlags - Int
|
|
invoiceReferenceForTC - String
|
|
lastUser - String
|
|
serviceDate - Date
|
|
receivedDate - Date
|
|
approvalStatus - String
|
|
approvalComment - String
|
|
approvalUser - String
|
|
approvalDateGmt - Date
|
|
invoiceDocNo - String
|
|
remittanceCompanyNo - Int
|
|
remittanceSeq - Int
|
|
companyCode - String
|
|
isFinalInvoice - Boolean
|
|
isIncrementalInvoice - Boolean
|
|
isProvisionalInvoice - Boolean
|
|
isSpecialInvoice - Boolean
|
|
isSDAInvoice - Boolean
|
|
isEstimatedDemurrage - Boolean
|
|
dueDate - Date
|
|
paymentTermsCodeInternal - String
|
|
approvalUser2 - String
|
|
billViaCompanyNo - Int
|
|
externalRef - String
|
|
pONo - String
|
|
payTermsDescription - String
|
|
remarks - String
|
|
billReference - Int
|
|
viaCompanyCode - String
|
|
exchangeRate - Float
|
|
accrualPercentage - Float
|
|
claimID - Int
|
|
exchangeRateDate - Date
|
|
approvalComment2 - String
|
|
approvalDate2Gmt - Date
|
|
approvalUser3 - String
|
|
approvalComment3 - String
|
|
approvalDate3Gmt - Date
|
|
personInCharge - String
|
|
mirrorTransNo - Int
|
|
provisionalTransNo - Int
|
|
vatCurrency - String
|
|
vatExchangeRate - Float
|
|
vatExchangeRateDate - Date
|
|
receivableStatusInternal - String
|
|
legalSpecialist - String
|
|
intraVoyageMirrorTransNo - Int
|
|
createdByUser - String
|
|
registryAccountCompanyNo - Int
|
|
registryAccountSeq - Int
|
|
registryAccount - AddressBookRegistryAccount
|
|
intraVoyageMirrorOperationsInvoice - OperationsInvoice
|
|
mirrorOperationsInvoice - OperationsInvoice
|
|
provisionalInvoice - OperationsInvoice
|
|
company - Company
|
|
remittanceBank - AddressBookBank
|
|
financialsInvoice - FinancialsInvoice
|
|
firstDetails - OperationsInvoiceDetails
|
|
operationsPaymentDetails - OperationsPaymentDetails
|
|
firstFinancialsInvoiceDetails - FinancialsInvoiceDetail
|
|
companyAddressBook - AddressBook
|
|
billViaCompany - AddressBook
|
|
vendor - AddressBook
|
|
freightInvoice - FreightInvoice
|
|
invoicePayments - FinancialsInvoicePayment
|
|
timeCharterContract - TimeCharterContract
|
|
lastInvoicePayment - FinancialsInvoicePayment
|
|
firstPaymentBatchDetails - PaymentBatchDetails
|
|
secondPaymentBatchDetails - PaymentBatchDetails
|
|
laytimeCalculation - Laytime
|
|
claim - Claim
|
|
paymentTerm - PaymentTerm
|
|
commodityContract - CommodityContract
|
|
allowanceTransferParentOperationsInvoice - OperationsInvoice
|
|
operationsInvoiceNotes - [OperationsInvoiceNote]
|
|
details - [OperationsInvoiceDetails]
|
|
paymentBatchOrderedDetails - [PaymentBatchDetails]
|
|
laytimes - [Laytime]
|
|
financialsAndOperationsInvoiceNotes - [FinancialsAndOperationsInvoiceNotes]
|
|
surveyCostsBunkers - [SurveyCostsBunkers]
|
|
surveyCostDetails - [SurveyCostDetails]
|
|
operationsInvoiceApprovals - [OperationsInvoiceApproval]
|
|
getInvoiceReportPdfMessages - [GetInvoiceReportPdfMessageRecord]
|
|
Arguments
|
|
deleteInvoiceMessages - [DeleteInvoiceMessageRecord]
|
|
Arguments
|
|
changesSinceLast - OperationsInvoiceChangesSinceLast
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"sourceString": "xyz789",
"customFieldByID": Any,
"customField": Any,
"lastCargoDischargeDate": "2007-12-03",
"lastCargoLoadDate": "2007-12-03",
"dueDateCalculated": "2007-12-03",
"invoiceOverdueBasis": "2007-12-03",
"ageDays": 123,
"calculatedAgeDays": 987,
"daysOverdueCalculated": 987,
"daysOverdue": 123,
"ageGroup": "xyz789",
"calculatedAgeGroup": "abc123",
"amountFinalCurr": 123.45,
"amountPaidCurr": 987.65,
"amountFinalUSD": 987.65,
"amountPaidUSD": 987.65,
"outstandingBalanceCurr": 987.65,
"outstandingBalanceUSD": 987.65,
"paymentBatchOrderedTotalCurr": 123.45,
"outstandingToOrderCurr": 987.65,
"thirdReminderDateString": "abc123",
"secondReminderDateString": "xyz789",
"firstReminderDateString": "abc123",
"lastReminder": "xyz789",
"brokerList": "abc123",
"brokerListAll": "abc123",
"tcContractBrokerList": "xyz789",
"bookingNo": "abc123",
"outstandingBalancePercent": 123.45,
"charterPartyDate": "2007-12-03",
"cargoCOASequence": 123,
"lastPaidValueDate": "2007-12-03",
"lastPaidDate": "2007-12-03",
"finalPaymentPastDueDays": 987.65,
"typeCode": 123,
"status": "abc123",
"statusDescription": "xyz789",
"billSubCode": "xyz789",
"approvalStatusDescription": "abc123",
"tradeAreaNo": 123,
"tradeArea": "abc123",
"amountBase": 123.45,
"amountCurr": 987.65,
"coalescedCompanyCode": "abc123",
"companyName": "abc123",
"lobCode": "xyz789",
"lobName": "xyz789",
"description": "xyz789",
"invoiceType": "abc123",
"amountPosted": 123.45,
"balance": 123.45,
"daysClosedSinceStart": 987.65,
"daysClosedSinceEnd": 123.45,
"autoDesc": "abc123",
"freightTypeDesc": "abc123",
"invoiceReference": "abc123",
"paymentStatus": "abc123",
"invoicePaymentStatus": "xyz789",
"businessRuleAccountCompanyBasedRules": "xyz789",
"businessRuleAccountNoCompanyBasedRules": "xyz789",
"businessRulesInvoiceDetailsAccount": "abc123",
"freightInvoiceType": "abc123",
"hirePaymentType": "xyz789",
"invoiceCompanyCode": "xyz789",
"ledgerCodes": "abc123",
"contractId": "xyz789",
"writeOffAmount": 123.45,
"aPRAmountCurr": 123.45,
"aPRAmountBase": 123.45,
"rejectReason": "abc123",
"receivableStatus": "abc123",
"statusCode": "abc123",
"isNonAccountingInvoice": true,
"postedReversedByUser": "abc123",
"paymentTermsCode": "xyz789",
"vendorTypeDescription": "abc123",
"allowanceID": 123,
"allowanceTransferTransNo": 123,
"sqlID": 987,
"transNo": 123,
"source": "xyz789",
"type": "xyz789",
"billDate": "2007-12-03",
"invoiceNo": "abc123",
"billAmountCurr": 123.45,
"currency": "abc123",
"billAmountBase": 987.65,
"refNo": "abc123",
"invoiceDescription": "abc123",
"vendorType": "xyz789",
"vendorShortName": "abc123",
"entryDateLocal": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"invTransNo": "abc123",
"isCableMonthly": false,
"isReissueInvoice": true,
"isTemplate": true,
"isBillPartiallyPaid": false,
"isBillFullyPaid": false,
"additionalFlags": 987,
"invoiceReferenceForTC": "abc123",
"lastUser": "xyz789",
"serviceDate": "2007-12-03",
"receivedDate": "2007-12-03",
"approvalStatus": "xyz789",
"approvalComment": "xyz789",
"approvalUser": "xyz789",
"approvalDateGmt": "2007-12-03",
"invoiceDocNo": "xyz789",
"remittanceCompanyNo": 987,
"remittanceSeq": 987,
"companyCode": "abc123",
"isFinalInvoice": true,
"isIncrementalInvoice": true,
"isProvisionalInvoice": false,
"isSpecialInvoice": true,
"isSDAInvoice": false,
"isEstimatedDemurrage": false,
"dueDate": "2007-12-03",
"paymentTermsCodeInternal": "abc123",
"approvalUser2": "abc123",
"billViaCompanyNo": 123,
"externalRef": "xyz789",
"pONo": "abc123",
"payTermsDescription": "xyz789",
"remarks": "abc123",
"billReference": 987,
"viaCompanyCode": "abc123",
"exchangeRate": 123.45,
"accrualPercentage": 987.65,
"claimID": 987,
"exchangeRateDate": "2007-12-03",
"approvalComment2": "xyz789",
"approvalDate2Gmt": "2007-12-03",
"approvalUser3": "xyz789",
"approvalComment3": "abc123",
"approvalDate3Gmt": "2007-12-03",
"personInCharge": "abc123",
"mirrorTransNo": 123,
"provisionalTransNo": 123,
"vatCurrency": "abc123",
"vatExchangeRate": 987.65,
"vatExchangeRateDate": "2007-12-03",
"receivableStatusInternal": "abc123",
"legalSpecialist": "abc123",
"intraVoyageMirrorTransNo": 987,
"createdByUser": "abc123",
"registryAccountCompanyNo": 123,
"registryAccountSeq": 123,
"registryAccount": AddressBookRegistryAccount,
"intraVoyageMirrorOperationsInvoice": OperationsInvoice,
"mirrorOperationsInvoice": OperationsInvoice,
"provisionalInvoice": OperationsInvoice,
"company": Company,
"remittanceBank": AddressBookBank,
"financialsInvoice": FinancialsInvoice,
"firstDetails": OperationsInvoiceDetails,
"operationsPaymentDetails": OperationsPaymentDetails,
"firstFinancialsInvoiceDetails": FinancialsInvoiceDetail,
"companyAddressBook": AddressBook,
"billViaCompany": AddressBook,
"vendor": AddressBook,
"freightInvoice": FreightInvoice,
"invoicePayments": FinancialsInvoicePayment,
"timeCharterContract": TimeCharterContract,
"lastInvoicePayment": FinancialsInvoicePayment,
"firstPaymentBatchDetails": PaymentBatchDetails,
"secondPaymentBatchDetails": PaymentBatchDetails,
"laytimeCalculation": Laytime,
"claim": Claim,
"paymentTerm": PaymentTerm,
"commodityContract": CommodityContract,
"allowanceTransferParentOperationsInvoice": OperationsInvoice,
"operationsInvoiceNotes": [OperationsInvoiceNote],
"details": [OperationsInvoiceDetails],
"paymentBatchOrderedDetails": [PaymentBatchDetails],
"laytimes": [Laytime],
"financialsAndOperationsInvoiceNotes": [
FinancialsAndOperationsInvoiceNotes
],
"surveyCostsBunkers": [SurveyCostsBunkers],
"surveyCostDetails": [SurveyCostDetails],
"operationsInvoiceApprovals": [
OperationsInvoiceApproval
],
"getInvoiceReportPdfMessages": [
GetInvoiceReportPdfMessageRecord
],
"deleteInvoiceMessages": [DeleteInvoiceMessageRecord],
"changesSinceLast": OperationsInvoiceChangesSinceLast,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
OperationsInvoiceApproval
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
auditTransNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seq - Int
|
|
oldValue - String
|
|
newValue - String
|
|
approvalField - String
|
|
dbAction - String
|
|
auditTrail - AuditTrail
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"auditTransNo": 123,
"customFieldByID": Any,
"customField": Any,
"seq": 987,
"oldValue": "xyz789",
"newValue": "xyz789",
"approvalField": "xyz789",
"dbAction": "abc123",
"auditTrail": AuditTrail,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
OperationsInvoiceApprovalFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - OperationsInvoiceApprovalFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": OperationsInvoiceApprovalFormQueryWhere
}
OperationsInvoiceApprovalFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [OperationsInvoiceApprovalFormQueryWhere!]
|
|
or - [OperationsInvoiceApprovalFormQueryWhere!]
|
|
rawExpression - String
|
|
auditTrail - AuditTrailFormQueryWhere
|
Example
{
"and": [OperationsInvoiceApprovalFormQueryWhere],
"or": [OperationsInvoiceApprovalFormQueryWhere],
"rawExpression": "abc123",
"auditTrail": AuditTrailFormQueryWhere
}
OperationsInvoiceApprovalRelationships
Fields
| Field Name | Description |
|---|---|
auditTrail - RelationshipDefinition
|
Example
{"auditTrail": RelationshipDefinition}
OperationsInvoiceChangesSinceLast
Fields
| Field Name | Description |
|---|---|
getInvoiceReportPdf - MessageUpdateResponse
|
|
deleteInvoice - MessageUpdateResponse
|
Example
{
"getInvoiceReportPdf": MessageUpdateResponse,
"deleteInvoice": MessageUpdateResponse
}
OperationsInvoiceDetailCargoAllocation
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
voyageItinerarySeqNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
portName - String
|
|
transNo - Int
|
|
invoiceDetailSeqNo - Int
|
|
cargoID - Int
|
|
cargoItinSeqNo - Int
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
voyageCargoHandlingSeqNo - Int
|
|
selectedForAllocation - Boolean
|
|
amountCurr - Float
|
|
allocationPercent - Float
|
|
rootCause - String
|
|
commercialID - String
|
|
lastUser - String
|
|
entryDateLocal - Date
|
|
lastUpdateGmt - Date
|
|
laytimeID - Int
|
|
cargoQty - Float
|
|
laytime - Laytime
|
|
voyage - Voyage
|
|
cargoItinerary - CargoItinerary
|
|
cargo - Cargo
|
|
operationsInvoiceDetails - OperationsInvoiceDetails
|
|
voyageItinerary - VoyageItinerary
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"voyageItinerarySeqNo": 987,
"customFieldByID": Any,
"customField": Any,
"portName": "abc123",
"transNo": 123,
"invoiceDetailSeqNo": 987,
"cargoID": 123,
"cargoItinSeqNo": 987,
"vesselCode": "xyz789",
"voyageNo": 987,
"voyageCargoHandlingSeqNo": 123,
"selectedForAllocation": false,
"amountCurr": 123.45,
"allocationPercent": 123.45,
"rootCause": "abc123",
"commercialID": "xyz789",
"lastUser": "xyz789",
"entryDateLocal": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"laytimeID": 123,
"cargoQty": 987.65,
"laytime": Laytime,
"voyage": Voyage,
"cargoItinerary": CargoItinerary,
"cargo": Cargo,
"operationsInvoiceDetails": OperationsInvoiceDetails,
"voyageItinerary": VoyageItinerary,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
OperationsInvoiceDetailCargoAllocationFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - OperationsInvoiceDetailCargoAllocationFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": OperationsInvoiceDetailCargoAllocationFormQueryWhere
}
OperationsInvoiceDetailCargoAllocationFormQueryWhere
Fields
Example
{
"and": [
OperationsInvoiceDetailCargoAllocationFormQueryWhere
],
"or": [
OperationsInvoiceDetailCargoAllocationFormQueryWhere
],
"rawExpression": "xyz789",
"voyageItinerarySeqNo": NumberWhereValueExpression,
"transNo": NumberWhereValueExpression,
"invoiceDetailSeqNo": NumberWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"cargoItinSeqNo": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"voyageCargoHandlingSeqNo": NumberWhereValueExpression,
"selectedForAllocation": BoolWhereValueExpression,
"amountCurr": NumberWhereValueExpression,
"allocationPercent": NumberWhereValueExpression,
"rootCause": StringWhereValueExpression,
"commercialID": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"entryDateLocal": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"laytimeID": NumberWhereValueExpression,
"cargoQty": NumberWhereValueExpression,
"laytime": LaytimeFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"cargoItinerary": CargoItineraryFormQueryWhere,
"cargo": CargoFormQueryWhere,
"operationsInvoiceDetails": OperationsInvoiceDetailsFormQueryWhere,
"voyageItinerary": VoyageItineraryFormQueryWhere
}
OperationsInvoiceDetailCargoAllocationRelationships
Fields
| Field Name | Description |
|---|---|
laytime - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
cargoItinerary - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
operationsInvoiceDetails - RelationshipDefinition
|
|
voyageItinerary - RelationshipDefinition
|
Example
{
"laytime": RelationshipDefinition,
"voyage": RelationshipDefinition,
"cargoItinerary": RelationshipDefinition,
"cargo": RelationshipDefinition,
"operationsInvoiceDetails": RelationshipDefinition,
"voyageItinerary": RelationshipDefinition
}
OperationsInvoiceDetails
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
subCodeDesc - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
periodDurationDays - Float
|
|
periodDurationDaysPlusOne - Float
|
|
useSubCode - Boolean
|
|
businessRulesSourceCode - String
|
|
businessRulesBillCode - String
|
|
vATGSTRate - Float
|
|
pSTRate - Float
|
|
rebillType - String
|
|
expenseSeq - Int
|
|
portSeqNo - Int
|
|
demurrageCostAllocationRootCause - String
|
|
isFrtAdjCommissionable - Boolean
|
|
linkedItinerarySeq - Int
|
|
transNo - Int
|
|
seq - Int
|
|
billSourceCode - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
portNo - Int
|
|
billPeriodFromLocal - Date
|
|
billPeriodToLocal - Date
|
|
qty - Float
|
|
rateBase - Float
|
|
billCode - String
|
|
amountCurr - Float
|
|
amountBase - Float
|
|
description - String
|
|
vendorType - String
|
|
vendorShortName - String
|
|
entryDateLocal - Date
|
|
lastUpdateGmt - Date
|
|
auxDataInternal - String
|
|
lastUser - String
|
|
remarks - String
|
|
taxCode - String
|
|
taxRate - Float
|
|
rateUnit - String
|
|
billRefNo - Int
|
|
isFrtOutturnAdj - Boolean
|
|
isFrtPrevFrtAdj - Boolean
|
|
isFrtAdjFromPrevFrt - Boolean
|
|
isNoPnl - Boolean
|
|
isRebillable - Boolean
|
|
isNotRebillable - Boolean
|
|
commissionable - Boolean
|
|
taxable - Boolean
|
|
indexLinkedHire - Boolean
|
|
companyCode - String
|
|
lobCode - String
|
|
routeCode - String
|
|
subCode - String
|
|
subSeq - Int
|
|
billedPercentage - Float
|
|
rateUnitAux - String
|
|
exchangeRate - Float
|
|
refNo - String
|
|
billRefSeq - Int
|
|
commissionPercent - Float
|
|
acctCode - String
|
|
creditAcctCode - String
|
|
actDeptCode - String
|
|
tradeAreaNo - Int
|
|
cargoID - Int
|
|
costCode - Int
|
|
rebillTransNo - Int
|
|
rebillSeq - Int
|
|
isHiddenViaExpense - Boolean
|
|
manual_Rebillable_Type - Boolean
|
|
marketRate - Float
|
|
marketDateLocal - Date
|
|
cargoShortName - String
|
|
gradeSeqNo - Int
|
|
orderSeqNo - Int
|
|
isDemurrageCargoAllocation - Boolean
|
|
exchangeRateDate - Date
|
|
currency - String
|
|
laytimeInvoiceTransNo - Int
|
|
provisionalInvoiceTransNo - Int
|
|
actDepartment - ActDepartment
|
|
cargo - Cargo
|
|
lob - Lob
|
|
tradeArea - TradeArea
|
|
addressBook - AddressBook
|
|
voyage - Voyage
|
|
vessel - Vessel
|
|
operationsInvoice - OperationsInvoice
|
|
businessRule - BusinessRule
|
|
subBusinessRule - BusinessRule
|
|
voyageItinerary - VoyageItinerary
|
|
expense - Expense
|
|
originalOperationsInvoiceDetail - OperationsInvoiceDetails
|
|
operationsInvoiceDetailCargoAllocations - [OperationsInvoiceDetailCargoAllocation]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"subCodeDesc": "abc123",
"customFieldByID": Any,
"customField": Any,
"periodDurationDays": 123.45,
"periodDurationDaysPlusOne": 123.45,
"useSubCode": false,
"businessRulesSourceCode": "xyz789",
"businessRulesBillCode": "xyz789",
"vATGSTRate": 987.65,
"pSTRate": 123.45,
"rebillType": "abc123",
"expenseSeq": 987,
"portSeqNo": 987,
"demurrageCostAllocationRootCause": "xyz789",
"isFrtAdjCommissionable": true,
"linkedItinerarySeq": 987,
"transNo": 123,
"seq": 123,
"billSourceCode": "abc123",
"vesselCode": "abc123",
"voyageNo": 987,
"portNo": 987,
"billPeriodFromLocal": "2007-12-03",
"billPeriodToLocal": "2007-12-03",
"qty": 987.65,
"rateBase": 987.65,
"billCode": "xyz789",
"amountCurr": 123.45,
"amountBase": 987.65,
"description": "xyz789",
"vendorType": "xyz789",
"vendorShortName": "abc123",
"entryDateLocal": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"auxDataInternal": "abc123",
"lastUser": "xyz789",
"remarks": "xyz789",
"taxCode": "abc123",
"taxRate": 987.65,
"rateUnit": "abc123",
"billRefNo": 123,
"isFrtOutturnAdj": false,
"isFrtPrevFrtAdj": true,
"isFrtAdjFromPrevFrt": true,
"isNoPnl": false,
"isRebillable": true,
"isNotRebillable": false,
"commissionable": false,
"taxable": false,
"indexLinkedHire": false,
"companyCode": "xyz789",
"lobCode": "xyz789",
"routeCode": "abc123",
"subCode": "abc123",
"subSeq": 987,
"billedPercentage": 987.65,
"rateUnitAux": "abc123",
"exchangeRate": 987.65,
"refNo": "xyz789",
"billRefSeq": 987,
"commissionPercent": 123.45,
"acctCode": "abc123",
"creditAcctCode": "xyz789",
"actDeptCode": "xyz789",
"tradeAreaNo": 123,
"cargoID": 123,
"costCode": 987,
"rebillTransNo": 987,
"rebillSeq": 987,
"isHiddenViaExpense": true,
"manual_Rebillable_Type": true,
"marketRate": 123.45,
"marketDateLocal": "2007-12-03",
"cargoShortName": "abc123",
"gradeSeqNo": 123,
"orderSeqNo": 123,
"isDemurrageCargoAllocation": true,
"exchangeRateDate": "2007-12-03",
"currency": "abc123",
"laytimeInvoiceTransNo": 123,
"provisionalInvoiceTransNo": 123,
"actDepartment": ActDepartment,
"cargo": Cargo,
"lob": Lob,
"tradeArea": TradeArea,
"addressBook": AddressBook,
"voyage": Voyage,
"vessel": Vessel,
"operationsInvoice": OperationsInvoice,
"businessRule": BusinessRule,
"subBusinessRule": BusinessRule,
"voyageItinerary": VoyageItinerary,
"expense": Expense,
"originalOperationsInvoiceDetail": OperationsInvoiceDetails,
"operationsInvoiceDetailCargoAllocations": [
OperationsInvoiceDetailCargoAllocation
],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
OperationsInvoiceDetailsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - OperationsInvoiceDetailsFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": OperationsInvoiceDetailsFormQueryWhere
}
OperationsInvoiceDetailsFormQueryWhere
Fields
Example
{
"and": [OperationsInvoiceDetailsFormQueryWhere],
"or": [OperationsInvoiceDetailsFormQueryWhere],
"rawExpression": "xyz789",
"portSeqNo": NumberWhereValueExpression,
"linkedItinerarySeq": NumberWhereValueExpression,
"transNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"billSourceCode": StringWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"billPeriodFromLocal": DateWhereValueExpression,
"billPeriodToLocal": DateWhereValueExpression,
"qty": NumberWhereValueExpression,
"rateBase": NumberWhereValueExpression,
"billCode": StringWhereValueExpression,
"amountCurr": NumberWhereValueExpression,
"amountBase": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"vendorType": StringWhereValueExpression,
"vendorShortName": StringWhereValueExpression,
"entryDateLocal": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"auxDataInternal": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"taxCode": StringWhereValueExpression,
"taxRate": NumberWhereValueExpression,
"rateUnit": StringWhereValueExpression,
"billRefNo": NumberWhereValueExpression,
"isFrtOutturnAdj": BoolWhereValueExpression,
"isFrtPrevFrtAdj": BoolWhereValueExpression,
"isFrtAdjFromPrevFrt": BoolWhereValueExpression,
"isNoPnl": BoolWhereValueExpression,
"isRebillable": BoolWhereValueExpression,
"isNotRebillable": BoolWhereValueExpression,
"commissionable": BoolWhereValueExpression,
"taxable": BoolWhereValueExpression,
"indexLinkedHire": BoolWhereValueExpression,
"companyCode": StringWhereValueExpression,
"lobCode": StringWhereValueExpression,
"routeCode": StringWhereValueExpression,
"subCode": StringWhereValueExpression,
"subSeq": NumberWhereValueExpression,
"billedPercentage": NumberWhereValueExpression,
"rateUnitAux": StringWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"refNo": StringWhereValueExpression,
"billRefSeq": NumberWhereValueExpression,
"commissionPercent": NumberWhereValueExpression,
"acctCode": StringWhereValueExpression,
"creditAcctCode": StringWhereValueExpression,
"actDeptCode": StringWhereValueExpression,
"tradeAreaNo": NumberWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"costCode": NumberWhereValueExpression,
"rebillTransNo": NumberWhereValueExpression,
"rebillSeq": NumberWhereValueExpression,
"isHiddenViaExpense": BoolWhereValueExpression,
"manual_Rebillable_Type": BoolWhereValueExpression,
"marketRate": NumberWhereValueExpression,
"marketDateLocal": DateWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"gradeSeqNo": NumberWhereValueExpression,
"orderSeqNo": NumberWhereValueExpression,
"isDemurrageCargoAllocation": BoolWhereValueExpression,
"exchangeRateDate": DateWhereValueExpression,
"currency": StringWhereValueExpression,
"laytimeInvoiceTransNo": NumberWhereValueExpression,
"provisionalInvoiceTransNo": NumberWhereValueExpression,
"actDepartment": ActDepartmentFormQueryWhere,
"cargo": CargoFormQueryWhere,
"lob": LobFormQueryWhere,
"tradeArea": TradeAreaFormQueryWhere,
"addressBook": AddressBookFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"vessel": VesselFormQueryWhere,
"operationsInvoice": OperationsInvoiceFormQueryWhere,
"businessRule": BusinessRuleFormQueryWhere,
"subBusinessRule": BusinessRuleFormQueryWhere,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"expense": ExpenseFormQueryWhere,
"originalOperationsInvoiceDetail": OperationsInvoiceDetailsFormQueryWhere
}
OperationsInvoiceDetailsRelationships
Fields
| Field Name | Description |
|---|---|
actDepartment - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
lob - RelationshipDefinition
|
|
tradeArea - RelationshipDefinition
|
|
addressBook - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
operationsInvoice - RelationshipDefinition
|
|
businessRule - RelationshipDefinition
|
|
subBusinessRule - RelationshipDefinition
|
|
latestCargoDischarge - RelationshipDefinition
|
|
latestCargoLoad - RelationshipDefinition
|
|
firstBookingCargo - RelationshipDefinition
|
|
voyageItinerary - RelationshipDefinition
|
|
expense - RelationshipDefinition
|
|
originalOperationsInvoiceDetail - RelationshipDefinition
|
|
linkedVoyageItinerary - RelationshipDefinition
|
|
operationsInvoiceDetailCargoAllocations - RelationshipDefinition
|
|
bookingCargos - RelationshipDefinition
|
Example
{
"actDepartment": RelationshipDefinition,
"cargo": RelationshipDefinition,
"lob": RelationshipDefinition,
"tradeArea": RelationshipDefinition,
"addressBook": RelationshipDefinition,
"voyage": RelationshipDefinition,
"vessel": RelationshipDefinition,
"operationsInvoice": RelationshipDefinition,
"businessRule": RelationshipDefinition,
"subBusinessRule": RelationshipDefinition,
"latestCargoDischarge": RelationshipDefinition,
"latestCargoLoad": RelationshipDefinition,
"firstBookingCargo": RelationshipDefinition,
"voyageItinerary": RelationshipDefinition,
"expense": RelationshipDefinition,
"originalOperationsInvoiceDetail": RelationshipDefinition,
"linkedVoyageItinerary": RelationshipDefinition,
"operationsInvoiceDetailCargoAllocations": RelationshipDefinition,
"bookingCargos": RelationshipDefinition
}
OperationsInvoiceFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - OperationsInvoiceFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": OperationsInvoiceFormQueryWhere
}
OperationsInvoiceFormQueryWhere
Fields
Example
{
"and": [OperationsInvoiceFormQueryWhere],
"or": [OperationsInvoiceFormQueryWhere],
"rawExpression": "xyz789",
"statusCode": StringWhereValueExpression,
"transNo": NumberWhereValueExpression,
"source": OperationsInvoiceSourceEnumValueExpression,
"type": OperationsInvoiceTypeEnumValueExpression,
"billDate": DateWhereValueExpression,
"invoiceNo": StringWhereValueExpression,
"billAmountCurr": NumberWhereValueExpression,
"currency": StringWhereValueExpression,
"billAmountBase": NumberWhereValueExpression,
"refNo": StringWhereValueExpression,
"invoiceDescription": StringWhereValueExpression,
"vendorType": StringWhereValueExpression,
"vendorShortName": StringWhereValueExpression,
"entryDateLocal": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"invTransNo": StringWhereValueExpression,
"isCableMonthly": BoolWhereValueExpression,
"isReissueInvoice": BoolWhereValueExpression,
"isTemplate": BoolWhereValueExpression,
"isBillPartiallyPaid": BoolWhereValueExpression,
"isBillFullyPaid": BoolWhereValueExpression,
"additionalFlags": NumberWhereValueExpression,
"invoiceReferenceForTC": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"serviceDate": DateWhereValueExpression,
"receivedDate": DateWhereValueExpression,
"approvalStatus": StringWhereValueExpression,
"approvalComment": StringWhereValueExpression,
"approvalUser": StringWhereValueExpression,
"approvalDateGmt": DateWhereValueExpression,
"invoiceDocNo": StringWhereValueExpression,
"remittanceCompanyNo": NumberWhereValueExpression,
"remittanceSeq": NumberWhereValueExpression,
"companyCode": StringWhereValueExpression,
"isFinalInvoice": BoolWhereValueExpression,
"isIncrementalInvoice": BoolWhereValueExpression,
"isProvisionalInvoice": BoolWhereValueExpression,
"isSpecialInvoice": BoolWhereValueExpression,
"isSDAInvoice": BoolWhereValueExpression,
"isEstimatedDemurrage": BoolWhereValueExpression,
"dueDate": DateWhereValueExpression,
"paymentTermsCodeInternal": StringWhereValueExpression,
"approvalUser2": StringWhereValueExpression,
"billViaCompanyNo": NumberWhereValueExpression,
"externalRef": StringWhereValueExpression,
"pONo": StringWhereValueExpression,
"payTermsDescription": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"billReference": NumberWhereValueExpression,
"viaCompanyCode": StringWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"accrualPercentage": NumberWhereValueExpression,
"claimID": NumberWhereValueExpression,
"exchangeRateDate": DateWhereValueExpression,
"approvalComment2": StringWhereValueExpression,
"approvalDate2Gmt": DateWhereValueExpression,
"approvalUser3": StringWhereValueExpression,
"approvalComment3": StringWhereValueExpression,
"approvalDate3Gmt": DateWhereValueExpression,
"personInCharge": StringWhereValueExpression,
"mirrorTransNo": NumberWhereValueExpression,
"provisionalTransNo": NumberWhereValueExpression,
"vatCurrency": StringWhereValueExpression,
"vatExchangeRate": NumberWhereValueExpression,
"vatExchangeRateDate": DateWhereValueExpression,
"receivableStatusInternal": StringWhereValueExpression,
"legalSpecialist": StringWhereValueExpression,
"intraVoyageMirrorTransNo": NumberWhereValueExpression,
"createdByUser": StringWhereValueExpression,
"registryAccountCompanyNo": NumberWhereValueExpression,
"registryAccountSeq": NumberWhereValueExpression,
"registryAccount": AddressBookRegistryAccountFormQueryWhere,
"intraVoyageMirrorOperationsInvoice": OperationsInvoiceFormQueryWhere,
"mirrorOperationsInvoice": OperationsInvoiceFormQueryWhere,
"provisionalInvoice": OperationsInvoiceFormQueryWhere,
"company": CompanyFormQueryWhere,
"remittanceBank": AddressBookBankFormQueryWhere,
"financialsInvoice": FinancialsInvoiceFormQueryWhere,
"firstDetails": OperationsInvoiceDetailsFormQueryWhere,
"operationsPaymentDetails": OperationsPaymentDetailsFormQueryWhere,
"firstFinancialsInvoiceDetails": FinancialsInvoiceDetailFormQueryWhere,
"companyAddressBook": AddressBookFormQueryWhere,
"billViaCompany": AddressBookFormQueryWhere,
"vendor": AddressBookFormQueryWhere,
"freightInvoice": FreightInvoiceFormQueryWhere,
"invoicePayments": FinancialsInvoicePaymentFormQueryWhere,
"timeCharterContract": TimeCharterContractFormQueryWhere,
"lastInvoicePayment": FinancialsInvoicePaymentFormQueryWhere,
"firstPaymentBatchDetails": PaymentBatchDetailsFormQueryWhere,
"secondPaymentBatchDetails": PaymentBatchDetailsFormQueryWhere,
"laytimeCalculation": LaytimeFormQueryWhere,
"claim": ClaimFormQueryWhere,
"paymentTerm": PaymentTermFormQueryWhere,
"commodityContract": CommodityContractFormQueryWhere,
"allowanceTransferParentOperationsInvoice": OperationsInvoiceFormQueryWhere
}
OperationsInvoiceNote
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
followUpDays - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
transNo - Int
|
|
seq - Int
|
|
action - String
|
|
memo - String
|
|
actionDate - Date
|
|
paidAmount - Float
|
|
outstandingAmount - Float
|
|
lastUser - String
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
operationsInvoice - OperationsInvoice
|
|
_keys - [String]
|
|
_intents - [String]
|
|
Example
{
"_id": "abc123",
"followUpDays": 123,
"customFieldByID": Any,
"customField": Any,
"transNo": 123,
"seq": 987,
"action": "xyz789",
"memo": "xyz789",
"actionDate": "2007-12-03",
"paidAmount": 123.45,
"outstandingAmount": 123.45,
"lastUser": "xyz789",
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"operationsInvoice": OperationsInvoice,
"_keys": ["xyz789"],
"_intents": ["xyz789"]
}
OperationsInvoiceNoteRelationships
Fields
| Field Name | Description |
|---|---|
operationsInvoice - RelationshipDefinition
|
Example
{"operationsInvoice": RelationshipDefinition}
OperationsInvoiceRelationships
Fields
| Field Name | Description |
|---|---|
registryAccount - RelationshipDefinition
|
|
intraVoyageMirrorOperationsInvoice - RelationshipDefinition
|
|
mirrorOperationsInvoice - RelationshipDefinition
|
|
provisionalInvoice - RelationshipDefinition
|
|
company - RelationshipDefinition
|
|
remittanceBank - RelationshipDefinition
|
|
financialsInvoice - RelationshipDefinition
|
|
firstDetails - RelationshipDefinition
|
|
firstReletSpotOperationsInvoiceDetail - RelationshipDefinition
|
|
operationsPaymentDetails - RelationshipDefinition
|
|
firstFinancialsInvoiceDetails - RelationshipDefinition
|
|
lastInvoiceNote - RelationshipDefinition
|
|
lastOperationsInvoiceNote - RelationshipDefinition
|
|
companyAddressBook - RelationshipDefinition
|
|
billViaCompany - RelationshipDefinition
|
|
vendor - RelationshipDefinition
|
|
freightInvoice - RelationshipDefinition
|
|
invoicePayments - RelationshipDefinition
|
|
timeCharterContract - RelationshipDefinition
|
|
bareboatContract - RelationshipDefinition
|
|
timeCharterCompanyAddressBook - RelationshipDefinition
|
|
bareboatCompanyAddressBook - RelationshipDefinition
|
|
lastInvoicePayment - RelationshipDefinition
|
|
firstPaymentBatchDetails - RelationshipDefinition
|
|
secondPaymentBatchDetails - RelationshipDefinition
|
|
laytimeCalculation - RelationshipDefinition
|
|
receivableStatusTerm - RelationshipDefinition
|
|
claim - RelationshipDefinition
|
|
primaryCargoCommBroker - RelationshipDefinition
|
|
primaryTimeCharterCommBroker - RelationshipDefinition
|
|
lastReversedInvoice - RelationshipDefinition
|
|
paymentTerm - RelationshipDefinition
|
|
commodityContract - RelationshipDefinition
|
|
allowanceTransferParentOperationsInvoice - RelationshipDefinition
|
|
allowanceTransferOperationsInvoice - RelationshipDefinition
|
|
operationsInvoiceNotes - RelationshipDefinition
|
|
details - RelationshipDefinition
|
|
voyageRevExpDetails - RelationshipDefinition
|
|
freightInvoiceDetails - RelationshipDefinition
|
|
laytimeInvoiceDetails - RelationshipDefinition
|
|
dAInvoiceDetails - RelationshipDefinition
|
|
dAInvoiceAdvAdjDetails - RelationshipDefinition
|
|
paymentBatchOrderedDetails - RelationshipDefinition
|
|
laytimes - RelationshipDefinition
|
|
paymentDetails - RelationshipDefinition
|
|
writeOffPaymentDetails - RelationshipDefinition
|
|
financialsAndOperationsInvoiceNotes - RelationshipDefinition
|
|
surveyCostsBunkers - RelationshipDefinition
|
|
surveyCostDetails - RelationshipDefinition
|
|
operationsInvoiceApprovals - RelationshipDefinition
|
Example
{
"registryAccount": RelationshipDefinition,
"intraVoyageMirrorOperationsInvoice": RelationshipDefinition,
"mirrorOperationsInvoice": RelationshipDefinition,
"provisionalInvoice": RelationshipDefinition,
"company": RelationshipDefinition,
"remittanceBank": RelationshipDefinition,
"financialsInvoice": RelationshipDefinition,
"firstDetails": RelationshipDefinition,
"firstReletSpotOperationsInvoiceDetail": RelationshipDefinition,
"operationsPaymentDetails": RelationshipDefinition,
"firstFinancialsInvoiceDetails": RelationshipDefinition,
"lastInvoiceNote": RelationshipDefinition,
"lastOperationsInvoiceNote": RelationshipDefinition,
"companyAddressBook": RelationshipDefinition,
"billViaCompany": RelationshipDefinition,
"vendor": RelationshipDefinition,
"freightInvoice": RelationshipDefinition,
"invoicePayments": RelationshipDefinition,
"timeCharterContract": RelationshipDefinition,
"bareboatContract": RelationshipDefinition,
"timeCharterCompanyAddressBook": RelationshipDefinition,
"bareboatCompanyAddressBook": RelationshipDefinition,
"lastInvoicePayment": RelationshipDefinition,
"firstPaymentBatchDetails": RelationshipDefinition,
"secondPaymentBatchDetails": RelationshipDefinition,
"laytimeCalculation": RelationshipDefinition,
"receivableStatusTerm": RelationshipDefinition,
"claim": RelationshipDefinition,
"primaryCargoCommBroker": RelationshipDefinition,
"primaryTimeCharterCommBroker": RelationshipDefinition,
"lastReversedInvoice": RelationshipDefinition,
"paymentTerm": RelationshipDefinition,
"commodityContract": RelationshipDefinition,
"allowanceTransferParentOperationsInvoice": RelationshipDefinition,
"allowanceTransferOperationsInvoice": RelationshipDefinition,
"operationsInvoiceNotes": RelationshipDefinition,
"details": RelationshipDefinition,
"voyageRevExpDetails": RelationshipDefinition,
"freightInvoiceDetails": RelationshipDefinition,
"laytimeInvoiceDetails": RelationshipDefinition,
"dAInvoiceDetails": RelationshipDefinition,
"dAInvoiceAdvAdjDetails": RelationshipDefinition,
"paymentBatchOrderedDetails": RelationshipDefinition,
"laytimes": RelationshipDefinition,
"paymentDetails": RelationshipDefinition,
"writeOffPaymentDetails": RelationshipDefinition,
"financialsAndOperationsInvoiceNotes": RelationshipDefinition,
"surveyCostsBunkers": RelationshipDefinition,
"surveyCostDetails": RelationshipDefinition,
"operationsInvoiceApprovals": RelationshipDefinition
}
OperationsInvoiceSourceEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
OperationsInvoiceSourceEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - OperationsInvoiceSourceEnum
|
|
isNot - OperationsInvoiceSourceEnum
|
|
isIn - [OperationsInvoiceSourceEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
OperationsInvoiceTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
OperationsInvoiceTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - OperationsInvoiceTypeEnum
|
|
isNot - OperationsInvoiceTypeEnum
|
|
isIn - [OperationsInvoiceTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
OperationsLedger
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
rebillType - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
code - String
|
|
description - String
|
|
category - String
|
|
taxOnTax - Boolean
|
|
inactive - Boolean
|
|
rebillOwner - Boolean
|
|
rebillCharterer - Boolean
|
|
commissionable - Boolean
|
|
expType - String
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"rebillType": "xyz789",
"customFieldByID": Any,
"customField": Any,
"code": "xyz789",
"description": "abc123",
"category": "xyz789",
"taxOnTax": true,
"inactive": true,
"rebillOwner": true,
"rebillCharterer": false,
"commissionable": false,
"expType": "abc123",
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
OperationsLedgerExpTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
OperationsLedgerExpTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - OperationsLedgerExpTypeEnum
|
|
isNot - OperationsLedgerExpTypeEnum
|
|
isIn - [OperationsLedgerExpTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
OperationsLedgerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - OperationsLedgerFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": OperationsLedgerFormQueryWhere
}
OperationsLedgerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [OperationsLedgerFormQueryWhere!]
|
|
or - [OperationsLedgerFormQueryWhere!]
|
|
rawExpression - String
|
|
code - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
category - StringWhereValueExpression
|
|
taxOnTax - BoolWhereValueExpression
|
|
inactive - BoolWhereValueExpression
|
|
rebillOwner - BoolWhereValueExpression
|
|
rebillCharterer - BoolWhereValueExpression
|
|
commissionable - BoolWhereValueExpression
|
|
expType - OperationsLedgerExpTypeEnumValueExpression
|
Example
{
"and": [OperationsLedgerFormQueryWhere],
"or": [OperationsLedgerFormQueryWhere],
"rawExpression": "abc123",
"code": StringWhereValueExpression,
"description": StringWhereValueExpression,
"category": StringWhereValueExpression,
"taxOnTax": BoolWhereValueExpression,
"inactive": BoolWhereValueExpression,
"rebillOwner": BoolWhereValueExpression,
"rebillCharterer": BoolWhereValueExpression,
"commissionable": BoolWhereValueExpression,
"expType": OperationsLedgerExpTypeEnumValueExpression
}
OperationsPaymentDetails
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
transNo - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
billTransNo - Int
|
|
amountCurr - Float
|
|
amountBase - Float
|
|
invoiceType - String
|
|
amountPaidCurr - Float
|
|
firstReminderDateLocal - Date
|
|
secondReminderDateLocal - Date
|
|
thirdReminderDateLocal - Date
|
|
claimsDueDateLocal - Date
|
|
isActual - Boolean
|
|
useLocalExchangeRate - Boolean
|
|
isReadyToPay - Boolean
|
|
isIntercompanyJournalEntry - Boolean
|
|
isMirrorParent - Boolean
|
|
isMirrorChild - Boolean
|
|
isFinal - Boolean
|
|
accountingDateLocal - Date
|
|
dueDateLocal - Date
|
|
invoiceNo - String
|
|
lastUpdateGmt - Date
|
|
invoice - FinancialsInvoice
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"transNo": "abc123",
"customFieldByID": Any,
"customField": Any,
"billTransNo": 123,
"amountCurr": 987.65,
"amountBase": 987.65,
"invoiceType": "abc123",
"amountPaidCurr": 987.65,
"firstReminderDateLocal": "2007-12-03",
"secondReminderDateLocal": "2007-12-03",
"thirdReminderDateLocal": "2007-12-03",
"claimsDueDateLocal": "2007-12-03",
"isActual": true,
"useLocalExchangeRate": false,
"isReadyToPay": false,
"isIntercompanyJournalEntry": true,
"isMirrorParent": true,
"isMirrorChild": false,
"isFinal": false,
"accountingDateLocal": "2007-12-03",
"dueDateLocal": "2007-12-03",
"invoiceNo": "xyz789",
"lastUpdateGmt": "2007-12-03",
"invoice": FinancialsInvoice,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
OperationsPaymentDetailsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - OperationsPaymentDetailsFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": OperationsPaymentDetailsFormQueryWhere
}
OperationsPaymentDetailsFormQueryWhere
Fields
Example
{
"and": [OperationsPaymentDetailsFormQueryWhere],
"or": [OperationsPaymentDetailsFormQueryWhere],
"rawExpression": "xyz789",
"transNo": StringWhereValueExpression,
"billTransNo": NumberWhereValueExpression,
"amountCurr": NumberWhereValueExpression,
"amountBase": NumberWhereValueExpression,
"invoiceType": OperationsPaymentDetailsInvoiceTypeEnumValueExpression,
"amountPaidCurr": NumberWhereValueExpression,
"firstReminderDateLocal": DateWhereValueExpression,
"secondReminderDateLocal": DateWhereValueExpression,
"thirdReminderDateLocal": DateWhereValueExpression,
"claimsDueDateLocal": DateWhereValueExpression,
"isActual": BoolWhereValueExpression,
"useLocalExchangeRate": BoolWhereValueExpression,
"isReadyToPay": BoolWhereValueExpression,
"isIntercompanyJournalEntry": BoolWhereValueExpression,
"isMirrorParent": BoolWhereValueExpression,
"isMirrorChild": BoolWhereValueExpression,
"isFinal": BoolWhereValueExpression,
"accountingDateLocal": DateWhereValueExpression,
"dueDateLocal": DateWhereValueExpression,
"invoiceNo": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"invoice": FinancialsInvoiceFormQueryWhere
}
OperationsPaymentDetailsInvoiceTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
OperationsPaymentDetailsInvoiceTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - OperationsPaymentDetailsInvoiceTypeEnum
|
|
isNot - OperationsPaymentDetailsInvoiceTypeEnum
|
|
isIn - [OperationsPaymentDetailsInvoiceTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
OperationsPaymentDetailsRelationships
Fields
| Field Name | Description |
|---|---|
invoice - RelationshipDefinition
|
Example
{"invoice": RelationshipDefinition}
Operations_functionsRootMutation
Fields
Example
{
"addBunkerRequirementInquiry": Imosfunctions_AddBunkerRequirementInquiryResponse,
"bunkerRequirementConfirm": Imosfunctions_BunkerRequirementConfirmResponse,
"bunkerRequirementNominate": Imosfunctions_BunkerRequirementNominateResponse,
"claimDelete": Imosfunctions_ClaimDeleteResponse,
"claimQuoteUpdate": Imosfunctions_ClaimQuoteUpdateResponse,
"claimRemovePortCalls": Imosfunctions_ClaimRemovePortCallsResponse,
"createLaytimeClaim": Imosfunctions_CreateLaytimeClaimResponse,
"deleteBunkerRequirement": Imosfunctions_DeleteBunkerRequirementResponse,
"deleteVoyage": Imosfunctions_DeleteVoyageResponse,
"editLaytimeClaim": Imosfunctions_EditLaytimeClaimResponse,
"sCCVoyageEmissions": Imosfunctions_SCCVoyageEmissionsResponse,
"updateBerthActivities": Imosfunctions_UpdateBerthActivitiesResponse,
"updateBunkerRequirement": Imosfunctions_UpdateBunkerRequirementResponse,
"updateEquipmentContract": Imosfunctions_UpdateEquipmentContractResponse
}
Ordering
PageableMessageQuery
Fields
| Input Field | Description |
|---|---|
intent - String
|
|
from - String
|
|
to - String
|
|
with - String
|
|
status - String
|
|
type - String
|
|
limit - Int
|
|
offset - Int
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
since - Date
|
|
until - Date
|
|
effectiveSince - Date
|
|
effectiveUntil - Date
|
|
sinceDaysAgo - Int
|
|
resolveIds - Boolean
|
|
parentMessageId - String
|
|
sort - PageableMessageQuerySort
|
|
source - String
|
|
sourceId - String
|
|
threadIds - [String]
|
|
onlyLatest - Boolean
|
|
includeThreadCount - Boolean
|
Example
{
"intent": "abc123",
"from": "xyz789",
"to": "abc123",
"with": "abc123",
"status": "abc123",
"type": "abc123",
"limit": 987,
"offset": 123,
"approvalStatus": "xyz789",
"since": "2007-12-03",
"until": "2007-12-03",
"effectiveSince": "2007-12-03",
"effectiveUntil": "2007-12-03",
"sinceDaysAgo": 987,
"resolveIds": true,
"parentMessageId": "abc123",
"sort": PageableMessageQuerySort,
"source": "xyz789",
"sourceId": "xyz789",
"threadIds": ["abc123"],
"onlyLatest": false,
"includeThreadCount": false
}
PageableMessageQuerySort
Fields
| Input Field | Description |
|---|---|
timestamp - SortDirection
|
|
originalTimestamp - SortDirection
|
|
effectiveDate - SortDirection
|
Example
{"timestamp": "asc", "originalTimestamp": "asc", "effectiveDate": "asc"}
PageableMessageQueryWithId
Fields
| Input Field | Description |
|---|---|
intent - String
|
|
from - String
|
|
to - String
|
|
with - String
|
|
status - String
|
|
objectId - String
|
|
type - String
|
|
limit - Int
|
|
offset - Int
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
since - Date
|
|
until - Date
|
|
effectiveSince - Date
|
|
effectiveUntil - Date
|
|
sinceDaysAgo - Int
|
|
resolveIds - Boolean
|
|
parentMessageId - String
|
|
sort - PageableMessageQuerySort
|
|
source - String
|
|
sourceId - String
|
|
threadIds - [String]
|
|
onlyLatest - Boolean
|
|
includeThreadCount - Boolean
|
|
generateTags - Boolean
|
Example
{
"intent": "xyz789",
"from": "xyz789",
"to": "abc123",
"with": "xyz789",
"status": "xyz789",
"objectId": "xyz789",
"type": "abc123",
"limit": 123,
"offset": 123,
"approvalStatus": "abc123",
"since": "2007-12-03",
"until": "2007-12-03",
"effectiveSince": "2007-12-03",
"effectiveUntil": "2007-12-03",
"sinceDaysAgo": 987,
"resolveIds": true,
"parentMessageId": "abc123",
"sort": PageableMessageQuerySort,
"source": "xyz789",
"sourceId": "xyz789",
"threadIds": ["xyz789"],
"onlyLatest": false,
"includeThreadCount": true,
"generateTags": false
}
PaperTrade
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tradeID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
periodDurationDays - Float
|
|
periodDurationMonths - Float
|
|
settledRate - String
|
|
statusSettlement - String
|
|
brokersList - String
|
|
startMonthDesc - String
|
|
endMonthDesc - String
|
|
tradeLinkedCargoIds - String
|
|
tradeLinkedTradeIds - String
|
|
tradeLinkedCOAIds - String
|
|
tradeLinkedCargoVessels - String
|
|
tradeLinkedCargoVoyages - String
|
|
transferredQty - Float
|
|
preAllocatedQty - Float
|
|
remainingQty - Float
|
|
sqlID - Int
|
|
type - String
|
|
tradeDate - Date
|
|
periodFrom - Date
|
|
route - String
|
|
counterpartyShortName - String
|
|
brokerShortName - String
|
|
contractType - String
|
|
rateType - String
|
|
qty - Float
|
|
rate - Float
|
|
commissionRate - Float
|
|
remarks - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUserID - String
|
|
periodTo - Date
|
|
statusCode - String
|
|
externalRef - String
|
|
batch - String
|
|
tradeAreaNo - Int
|
|
currency - String
|
|
companyCode - String
|
|
trader - String
|
|
wSC - Float
|
|
strikeWSC - Float
|
|
premiumWSC - Float
|
|
strategy - String
|
|
period - String
|
|
settlement - String
|
|
buyOrSell - String
|
|
settlementDate - Date
|
|
percentageOrDaysPerMonth - Float
|
|
routeIndex - Int
|
|
opportunity - Boolean
|
|
intercompany - Boolean
|
|
intercompanyMaster - Boolean
|
|
intercompanyChild - Boolean
|
|
co2Trade - Boolean
|
|
transferred - Boolean
|
|
closedTrade - Boolean
|
|
flags - Int
|
|
reference - String
|
|
counterpartyType - String
|
|
tradeGroup - String
|
|
realizedPnl - Float
|
|
exposure - Float
|
|
statusIndex - Int
|
|
optionExpirationDate - Date
|
|
lobCode - String
|
|
clearingHouseShortName - String
|
|
vesselType - String
|
|
settlementMarketName - String
|
|
departmentNo - Int
|
|
teamNo - Int
|
|
refCompanyNo - Int
|
|
parentMirroredContractID - Int
|
|
childMirroredContractID - Int
|
|
icCompany - String
|
|
icAdjAmt - Float
|
|
actDept - String
|
|
refContract - String
|
|
currRate - Float
|
|
currStrike - Float
|
|
currPremium - Float
|
|
exchRate - Float
|
|
optionSymbol - String
|
|
faceValue - Float
|
|
totalDays - Float
|
|
totalTons - Float
|
|
entryUserID - String
|
|
vesselCode - String
|
|
referenceTradeID - Int
|
|
referenceTradeMonthIndex - Int
|
|
dueDate - Date
|
|
optionSymbolRoute - TradeType
|
|
company - Company
|
|
tradeArea - TradeArea
|
|
refCompany - AddressBook
|
|
addressBook - AddressBook
|
|
counterparty - AddressBook
|
|
tradeType - TradeType
|
|
lob - Lob
|
|
department - Department
|
|
team - Team
|
|
actDepartment - ActDepartment
|
|
vessel - Vessel
|
|
firstTradeSettlementInvoice - OperationsInvoiceDetails
|
|
tradeIndex - TradeIndex
|
|
clearingHouse - AddressBook
|
|
broker - AddressBook
|
|
latestTradeSnapshot - TradeSnapshot
|
|
lastTradePnlSnapshotFfa - TradePnl
|
|
lastTradePnlSnapshotBunkerSwap - TradePnl
|
|
lastTradePnlSnapshotCommodity - TradePnl
|
|
paperTradeExposurePeriods - [PaperTradeExposurePeriod]
|
|
tradeBrokers - [TradeBroker]
|
|
bunkerExposures - [BunkerExposure]
|
|
tradeSettlementInvoices - [OperationsInvoiceDetails]
|
|
postedCarbonTradeSettlementInvoices - [OperationsInvoice]
|
|
brokers - [TradeBroker]
|
|
tradeLinkedCargos - [CargoLinkedTrade]
|
|
tradePnl - [TradePnl]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"tradeID": 987,
"customFieldByID": Any,
"customField": Any,
"periodDurationDays": 123.45,
"periodDurationMonths": 987.65,
"settledRate": "xyz789",
"statusSettlement": "abc123",
"brokersList": "xyz789",
"startMonthDesc": "abc123",
"endMonthDesc": "xyz789",
"tradeLinkedCargoIds": "xyz789",
"tradeLinkedTradeIds": "xyz789",
"tradeLinkedCOAIds": "abc123",
"tradeLinkedCargoVessels": "xyz789",
"tradeLinkedCargoVoyages": "abc123",
"transferredQty": 987.65,
"preAllocatedQty": 987.65,
"remainingQty": 987.65,
"sqlID": 123,
"type": "abc123",
"tradeDate": "2007-12-03",
"periodFrom": "2007-12-03",
"route": "xyz789",
"counterpartyShortName": "abc123",
"brokerShortName": "abc123",
"contractType": "xyz789",
"rateType": "abc123",
"qty": 123.45,
"rate": 987.65,
"commissionRate": 987.65,
"remarks": "abc123",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUserID": "xyz789",
"periodTo": "2007-12-03",
"statusCode": "abc123",
"externalRef": "abc123",
"batch": "abc123",
"tradeAreaNo": 123,
"currency": "xyz789",
"companyCode": "xyz789",
"trader": "xyz789",
"wSC": 123.45,
"strikeWSC": 123.45,
"premiumWSC": 987.65,
"strategy": "abc123",
"period": "abc123",
"settlement": "xyz789",
"buyOrSell": "abc123",
"settlementDate": "2007-12-03",
"percentageOrDaysPerMonth": 123.45,
"routeIndex": 123,
"opportunity": true,
"intercompany": true,
"intercompanyMaster": true,
"intercompanyChild": false,
"co2Trade": false,
"transferred": false,
"closedTrade": false,
"flags": 123,
"reference": "abc123",
"counterpartyType": "abc123",
"tradeGroup": "xyz789",
"realizedPnl": 123.45,
"exposure": 987.65,
"statusIndex": 987,
"optionExpirationDate": "2007-12-03",
"lobCode": "xyz789",
"clearingHouseShortName": "xyz789",
"vesselType": "xyz789",
"settlementMarketName": "xyz789",
"departmentNo": 123,
"teamNo": 987,
"refCompanyNo": 987,
"parentMirroredContractID": 123,
"childMirroredContractID": 987,
"icCompany": "abc123",
"icAdjAmt": 123.45,
"actDept": "abc123",
"refContract": "xyz789",
"currRate": 987.65,
"currStrike": 123.45,
"currPremium": 123.45,
"exchRate": 987.65,
"optionSymbol": "xyz789",
"faceValue": 123.45,
"totalDays": 123.45,
"totalTons": 987.65,
"entryUserID": "xyz789",
"vesselCode": "abc123",
"referenceTradeID": 987,
"referenceTradeMonthIndex": 987,
"dueDate": "2007-12-03",
"optionSymbolRoute": TradeType,
"company": Company,
"tradeArea": TradeArea,
"refCompany": AddressBook,
"addressBook": AddressBook,
"counterparty": AddressBook,
"tradeType": TradeType,
"lob": Lob,
"department": Department,
"team": Team,
"actDepartment": ActDepartment,
"vessel": Vessel,
"firstTradeSettlementInvoice": OperationsInvoiceDetails,
"tradeIndex": TradeIndex,
"clearingHouse": AddressBook,
"broker": AddressBook,
"latestTradeSnapshot": TradeSnapshot,
"lastTradePnlSnapshotFfa": TradePnl,
"lastTradePnlSnapshotBunkerSwap": TradePnl,
"lastTradePnlSnapshotCommodity": TradePnl,
"paperTradeExposurePeriods": [PaperTradeExposurePeriod],
"tradeBrokers": [TradeBroker],
"bunkerExposures": [BunkerExposure],
"tradeSettlementInvoices": [OperationsInvoiceDetails],
"postedCarbonTradeSettlementInvoices": [
OperationsInvoice
],
"brokers": [TradeBroker],
"tradeLinkedCargos": [CargoLinkedTrade],
"tradePnl": [TradePnl],
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
PaperTradeExposurePeriod
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
period - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
tradeID - Int
|
|
monthIndex - Int
|
|
daysOrQty - Float
|
|
isManualQty - Boolean
|
|
lastUserID - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
paperTrade - PaperTrade
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"period": "xyz789",
"customFieldByID": Any,
"customField": Any,
"tradeID": 123,
"monthIndex": 987,
"daysOrQty": 987.65,
"isManualQty": false,
"lastUserID": "xyz789",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"paperTrade": PaperTrade,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
PaperTradeExposurePeriodFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PaperTradeExposurePeriodFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PaperTradeExposurePeriodFormQueryWhere
}
PaperTradeExposurePeriodFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PaperTradeExposurePeriodFormQueryWhere!]
|
|
or - [PaperTradeExposurePeriodFormQueryWhere!]
|
|
rawExpression - String
|
|
tradeID - NumberWhereValueExpression
|
|
monthIndex - NumberWhereValueExpression
|
|
daysOrQty - NumberWhereValueExpression
|
|
isManualQty - BoolWhereValueExpression
|
|
lastUserID - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
paperTrade - PaperTradeFormQueryWhere
|
Example
{
"and": [PaperTradeExposurePeriodFormQueryWhere],
"or": [PaperTradeExposurePeriodFormQueryWhere],
"rawExpression": "abc123",
"tradeID": NumberWhereValueExpression,
"monthIndex": NumberWhereValueExpression,
"daysOrQty": NumberWhereValueExpression,
"isManualQty": BoolWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"paperTrade": PaperTradeFormQueryWhere
}
PaperTradeExposurePeriodRelationships
Fields
| Field Name | Description |
|---|---|
paperTrade - RelationshipDefinition
|
Example
{"paperTrade": RelationshipDefinition}
PaperTradeFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PaperTradeFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PaperTradeFormQueryWhere
}
PaperTradeFormQueryWhere
Fields
Example
{
"and": [PaperTradeFormQueryWhere],
"or": [PaperTradeFormQueryWhere],
"rawExpression": "abc123",
"tradeID": NumberWhereValueExpression,
"type": PaperTradeTypeEnumValueExpression,
"tradeDate": DateWhereValueExpression,
"periodFrom": DateWhereValueExpression,
"route": StringWhereValueExpression,
"counterpartyShortName": StringWhereValueExpression,
"brokerShortName": StringWhereValueExpression,
"contractType": StringWhereValueExpression,
"rateType": PaperTradeRateTypeEnumValueExpression,
"qty": NumberWhereValueExpression,
"rate": NumberWhereValueExpression,
"commissionRate": NumberWhereValueExpression,
"remarks": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"periodTo": DateWhereValueExpression,
"statusCode": PaperTradeStatusCodeEnumValueExpression,
"externalRef": StringWhereValueExpression,
"batch": StringWhereValueExpression,
"tradeAreaNo": NumberWhereValueExpression,
"currency": StringWhereValueExpression,
"companyCode": StringWhereValueExpression,
"trader": StringWhereValueExpression,
"wSC": NumberWhereValueExpression,
"strikeWSC": NumberWhereValueExpression,
"premiumWSC": NumberWhereValueExpression,
"strategy": StringWhereValueExpression,
"period": StringWhereValueExpression,
"settlement": StringWhereValueExpression,
"buyOrSell": StringWhereValueExpression,
"settlementDate": DateWhereValueExpression,
"percentageOrDaysPerMonth": NumberWhereValueExpression,
"routeIndex": NumberWhereValueExpression,
"opportunity": BoolWhereValueExpression,
"intercompany": BoolWhereValueExpression,
"intercompanyMaster": BoolWhereValueExpression,
"intercompanyChild": BoolWhereValueExpression,
"co2Trade": BoolWhereValueExpression,
"transferred": BoolWhereValueExpression,
"closedTrade": BoolWhereValueExpression,
"flags": NumberWhereValueExpression,
"reference": StringWhereValueExpression,
"counterpartyType": StringWhereValueExpression,
"tradeGroup": StringWhereValueExpression,
"realizedPnl": NumberWhereValueExpression,
"exposure": NumberWhereValueExpression,
"statusIndex": NumberWhereValueExpression,
"optionExpirationDate": DateWhereValueExpression,
"lobCode": StringWhereValueExpression,
"clearingHouseShortName": StringWhereValueExpression,
"vesselType": StringWhereValueExpression,
"settlementMarketName": StringWhereValueExpression,
"departmentNo": NumberWhereValueExpression,
"teamNo": NumberWhereValueExpression,
"refCompanyNo": NumberWhereValueExpression,
"parentMirroredContractID": NumberWhereValueExpression,
"childMirroredContractID": NumberWhereValueExpression,
"icCompany": StringWhereValueExpression,
"icAdjAmt": NumberWhereValueExpression,
"actDept": StringWhereValueExpression,
"refContract": StringWhereValueExpression,
"currRate": NumberWhereValueExpression,
"currStrike": NumberWhereValueExpression,
"currPremium": NumberWhereValueExpression,
"exchRate": NumberWhereValueExpression,
"optionSymbol": StringWhereValueExpression,
"faceValue": NumberWhereValueExpression,
"totalDays": NumberWhereValueExpression,
"totalTons": NumberWhereValueExpression,
"entryUserID": StringWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"referenceTradeID": NumberWhereValueExpression,
"referenceTradeMonthIndex": NumberWhereValueExpression,
"dueDate": DateWhereValueExpression,
"optionSymbolRoute": TradeTypeFormQueryWhere,
"company": CompanyFormQueryWhere,
"tradeArea": TradeAreaFormQueryWhere,
"refCompany": AddressBookFormQueryWhere,
"addressBook": AddressBookFormQueryWhere,
"counterparty": AddressBookFormQueryWhere,
"tradeType": TradeTypeFormQueryWhere,
"lob": LobFormQueryWhere,
"department": DepartmentFormQueryWhere,
"team": TeamFormQueryWhere,
"actDepartment": ActDepartmentFormQueryWhere,
"vessel": VesselFormQueryWhere,
"firstTradeSettlementInvoice": OperationsInvoiceDetailsFormQueryWhere,
"tradeIndex": TradeIndexFormQueryWhere,
"clearingHouse": AddressBookFormQueryWhere,
"broker": AddressBookFormQueryWhere,
"latestTradeSnapshot": TradeSnapshotFormQueryWhere,
"lastTradePnlSnapshotFfa": TradePnlFormQueryWhere,
"lastTradePnlSnapshotBunkerSwap": TradePnlFormQueryWhere,
"lastTradePnlSnapshotCommodity": TradePnlFormQueryWhere
}
PaperTradeRateTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
PaperTradeRateTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - PaperTradeRateTypeEnum
|
|
isNot - PaperTradeRateTypeEnum
|
|
isIn - [PaperTradeRateTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
PaperTradeRelationships
Fields
Example
{
"optionSymbolRoute": RelationshipDefinition,
"company": RelationshipDefinition,
"tradeArea": RelationshipDefinition,
"refCompany": RelationshipDefinition,
"addressBook": RelationshipDefinition,
"counterparty": RelationshipDefinition,
"tradeType": RelationshipDefinition,
"lob": RelationshipDefinition,
"department": RelationshipDefinition,
"team": RelationshipDefinition,
"actDepartment": RelationshipDefinition,
"vessel": RelationshipDefinition,
"firstTradeSettlementInvoice": RelationshipDefinition,
"tradeIndex": RelationshipDefinition,
"clearingHouse": RelationshipDefinition,
"broker": RelationshipDefinition,
"latestTradeSnapshot": RelationshipDefinition,
"lastTradePnlSnapshotFfa": RelationshipDefinition,
"lastTradePnlSnapshotBunkerSwap": RelationshipDefinition,
"lastTradePnlSnapshotCommodity": RelationshipDefinition,
"paperTradeExposurePeriods": RelationshipDefinition,
"tradeBrokers": RelationshipDefinition,
"bunkerExposures": RelationshipDefinition,
"tradeSettlementInvoices": RelationshipDefinition,
"postedCarbonTradeSettlementInvoices": RelationshipDefinition,
"brokers": RelationshipDefinition,
"tradeLinkedCargos": RelationshipDefinition,
"tradePnl": RelationshipDefinition
}
PaperTradeStatusCodeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
PaperTradeStatusCodeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - PaperTradeStatusCodeEnum
|
|
isNot - PaperTradeStatusCodeEnum
|
|
isIn - [PaperTradeStatusCodeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
PaperTradeTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
PaperTradeTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - PaperTradeTypeEnum
|
|
isNot - PaperTradeTypeEnum
|
|
isIn - [PaperTradeTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
Payment
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
isAdvance - Boolean
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
advAllocAmtCurr - Float
|
|
advAllocAmtBase - Float
|
|
bankCharges - Float
|
|
otherCharges - Float
|
|
exchgDiff - Float
|
|
paymentTransNo - String
|
|
bankCode - String
|
|
payDate - Date
|
|
payMode - String
|
|
checkOrWireNo - String
|
|
amountPaidCurr - Float
|
|
amountPaidBase - Float
|
|
memo - String
|
|
userInitials - String
|
|
payType - String
|
|
cashDate - Date
|
|
counterpartyNo - Int
|
|
entryDateGmt - Date
|
|
advancePaymentTransNo - String
|
|
thirdPartyNo - Int
|
|
companyCode - String
|
|
lastUser - String
|
|
bankAmountCurr - Float
|
|
bankCurr - String
|
|
advanceIndicator - Int
|
|
reference - String
|
|
isIntercompanyPayment - Boolean
|
|
isXDiffToVoyage - Boolean
|
|
isReleaseToInterface - Boolean
|
|
exchangeRate - Float
|
|
curr - String
|
|
lastUpdateGmt - Date
|
|
advancePayment - Payment
|
|
chartOfAccounts - ChartOfAccounts
|
|
paymentDetails - [PaymentDetail]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"isAdvance": true,
"customFieldByID": Any,
"customField": Any,
"advAllocAmtCurr": 123.45,
"advAllocAmtBase": 987.65,
"bankCharges": 987.65,
"otherCharges": 987.65,
"exchgDiff": 123.45,
"paymentTransNo": "xyz789",
"bankCode": "abc123",
"payDate": "2007-12-03",
"payMode": "abc123",
"checkOrWireNo": "xyz789",
"amountPaidCurr": 123.45,
"amountPaidBase": 123.45,
"memo": "xyz789",
"userInitials": "abc123",
"payType": "abc123",
"cashDate": "2007-12-03",
"counterpartyNo": 123,
"entryDateGmt": "2007-12-03",
"advancePaymentTransNo": "xyz789",
"thirdPartyNo": 123,
"companyCode": "xyz789",
"lastUser": "xyz789",
"bankAmountCurr": 123.45,
"bankCurr": "xyz789",
"advanceIndicator": 987,
"reference": "abc123",
"isIntercompanyPayment": false,
"isXDiffToVoyage": true,
"isReleaseToInterface": true,
"exchangeRate": 123.45,
"curr": "xyz789",
"lastUpdateGmt": "2007-12-03",
"advancePayment": Payment,
"chartOfAccounts": ChartOfAccounts,
"paymentDetails": [PaymentDetail],
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
PaymentBatch
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
statusString - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
bTGStatusString - String
|
|
errorString - String
|
|
batchID - String
|
|
bankCompanyNo - Int
|
|
description - String
|
|
memo - String
|
|
dueDateLocal - Date
|
|
postDateLocal - Date
|
|
isPosted - Boolean
|
|
isStarted - Boolean
|
|
isComplete - Boolean
|
|
isAccepted - Boolean
|
|
isRejected - Boolean
|
|
isAmended - Boolean
|
|
lastUser - String
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
approvalStatus - String
|
|
remittanceInstructions - String
|
|
bankAddressBook - AddressBook
|
|
paymentBatchDetails - [PaymentBatchDetails]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"statusString": "xyz789",
"customFieldByID": Any,
"customField": Any,
"bTGStatusString": "xyz789",
"errorString": "abc123",
"batchID": "abc123",
"bankCompanyNo": 123,
"description": "xyz789",
"memo": "abc123",
"dueDateLocal": "2007-12-03",
"postDateLocal": "2007-12-03",
"isPosted": false,
"isStarted": true,
"isComplete": false,
"isAccepted": true,
"isRejected": false,
"isAmended": false,
"lastUser": "xyz789",
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"approvalStatus": "xyz789",
"remittanceInstructions": "xyz789",
"bankAddressBook": AddressBook,
"paymentBatchDetails": [PaymentBatchDetails],
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
PaymentBatchApprovalStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Unknown"
PaymentBatchApprovalStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - PaymentBatchApprovalStatusEnum
|
|
isNot - PaymentBatchApprovalStatusEnum
|
|
isIn - [PaymentBatchApprovalStatusEnum]
|
Example
{"is": "Unknown", "isNot": "Unknown", "isIn": ["Unknown"]}
PaymentBatchDetails
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
batchID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
invoiceTransNo - String
|
|
paymentTransNo - String
|
|
paymentMethod - Int
|
|
paymentDate - Date
|
|
paymentAmountCurr - Float
|
|
bankAccountNo - String
|
|
receiverBankSeq - Int
|
|
receiverBankName - String
|
|
receiverBankAccountNo - String
|
|
lastUser - String
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
amountBase - Float
|
|
exchangeRate - Float
|
|
seqNo - Int
|
|
batchItemStatus - String
|
|
batchItemErrorMessage - String
|
|
batchItemExternalRef - String
|
|
batchItemRefId - String
|
|
bankSeq - Int
|
|
financialsInvoice - FinancialsInvoice
|
|
payment - Payment
|
|
paymentBatch - PaymentBatch
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"batchID": "abc123",
"customFieldByID": Any,
"customField": Any,
"invoiceTransNo": "abc123",
"paymentTransNo": "abc123",
"paymentMethod": 123,
"paymentDate": "2007-12-03",
"paymentAmountCurr": 987.65,
"bankAccountNo": "xyz789",
"receiverBankSeq": 987,
"receiverBankName": "xyz789",
"receiverBankAccountNo": "xyz789",
"lastUser": "xyz789",
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"amountBase": 987.65,
"exchangeRate": 123.45,
"seqNo": 987,
"batchItemStatus": "xyz789",
"batchItemErrorMessage": "xyz789",
"batchItemExternalRef": "abc123",
"batchItemRefId": "xyz789",
"bankSeq": 987,
"financialsInvoice": FinancialsInvoice,
"payment": Payment,
"paymentBatch": PaymentBatch,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
PaymentBatchDetailsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PaymentBatchDetailsFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PaymentBatchDetailsFormQueryWhere
}
PaymentBatchDetailsFormQueryWhere
Fields
Example
{
"and": [PaymentBatchDetailsFormQueryWhere],
"or": [PaymentBatchDetailsFormQueryWhere],
"rawExpression": "abc123",
"batchID": StringWhereValueExpression,
"invoiceTransNo": StringWhereValueExpression,
"paymentTransNo": StringWhereValueExpression,
"paymentMethod": NumberWhereValueExpression,
"paymentDate": DateWhereValueExpression,
"paymentAmountCurr": NumberWhereValueExpression,
"bankAccountNo": StringWhereValueExpression,
"receiverBankSeq": NumberWhereValueExpression,
"receiverBankName": StringWhereValueExpression,
"receiverBankAccountNo": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"amountBase": NumberWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"batchItemStatus": StringWhereValueExpression,
"batchItemErrorMessage": StringWhereValueExpression,
"batchItemExternalRef": StringWhereValueExpression,
"batchItemRefId": StringWhereValueExpression,
"bankSeq": NumberWhereValueExpression,
"financialsInvoice": FinancialsInvoiceFormQueryWhere,
"payment": PaymentFormQueryWhere,
"paymentBatch": PaymentBatchFormQueryWhere
}
PaymentBatchDetailsRelationships
Fields
| Field Name | Description |
|---|---|
financialsInvoice - RelationshipDefinition
|
|
payment - RelationshipDefinition
|
|
paymentBatch - RelationshipDefinition
|
Example
{
"financialsInvoice": RelationshipDefinition,
"payment": RelationshipDefinition,
"paymentBatch": RelationshipDefinition
}
PaymentBatchFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PaymentBatchFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PaymentBatchFormQueryWhere
}
PaymentBatchFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PaymentBatchFormQueryWhere!]
|
|
or - [PaymentBatchFormQueryWhere!]
|
|
rawExpression - String
|
|
batchID - StringWhereValueExpression
|
|
bankCompanyNo - NumberWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
memo - StringWhereValueExpression
|
|
dueDateLocal - DateWhereValueExpression
|
|
postDateLocal - DateWhereValueExpression
|
|
isPosted - BoolWhereValueExpression
|
|
isStarted - BoolWhereValueExpression
|
|
isComplete - BoolWhereValueExpression
|
|
isAccepted - BoolWhereValueExpression
|
|
isRejected - BoolWhereValueExpression
|
|
isAmended - BoolWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
approvalStatus - PaymentBatchApprovalStatusEnumValueExpression
|
|
remittanceInstructions - StringWhereValueExpression
|
|
bankAddressBook - AddressBookFormQueryWhere
|
Example
{
"and": [PaymentBatchFormQueryWhere],
"or": [PaymentBatchFormQueryWhere],
"rawExpression": "abc123",
"batchID": StringWhereValueExpression,
"bankCompanyNo": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"memo": StringWhereValueExpression,
"dueDateLocal": DateWhereValueExpression,
"postDateLocal": DateWhereValueExpression,
"isPosted": BoolWhereValueExpression,
"isStarted": BoolWhereValueExpression,
"isComplete": BoolWhereValueExpression,
"isAccepted": BoolWhereValueExpression,
"isRejected": BoolWhereValueExpression,
"isAmended": BoolWhereValueExpression,
"lastUser": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"approvalStatus": PaymentBatchApprovalStatusEnumValueExpression,
"remittanceInstructions": StringWhereValueExpression,
"bankAddressBook": AddressBookFormQueryWhere
}
PaymentBatchRelationships
Fields
| Field Name | Description |
|---|---|
bankAddressBook - RelationshipDefinition
|
|
firstPaymentBatchDetail - RelationshipDefinition
|
|
paymentBatchDetails - RelationshipDefinition
|
Example
{
"bankAddressBook": RelationshipDefinition,
"firstPaymentBatchDetail": RelationshipDefinition,
"paymentBatchDetails": RelationshipDefinition
}
PaymentDetail
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
paymentTransNo - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
invoiceTransNo - String
|
|
bankCode - String
|
|
companyCode - String
|
|
amountCurr - Float
|
|
amountBase - Float
|
|
paymentAccountingDate - Date
|
|
entryDateLocal - Date
|
|
creditAccount - String
|
|
vesselCode - String
|
|
bankAmountCurr - Float
|
|
voyageNo - Int
|
|
exchRate - Float
|
|
bankExchRate - Float
|
|
isBankCharge - Boolean
|
|
isOtherCharge - Boolean
|
|
isExchgDiff - Boolean
|
|
isInvoiceExchgDiff - Boolean
|
|
isExchgDiffCharge - Boolean
|
|
isAdvAllocReverse - Boolean
|
|
seqNo - Int
|
|
refSeqNo - Int
|
|
lastUpdateGmt - Date
|
|
vessel - Vessel
|
|
financialsInvoice - FinancialsInvoice
|
|
payment - Payment
|
|
voyage - Voyage
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"paymentTransNo": "abc123",
"customFieldByID": Any,
"customField": Any,
"invoiceTransNo": "xyz789",
"bankCode": "xyz789",
"companyCode": "abc123",
"amountCurr": 123.45,
"amountBase": 123.45,
"paymentAccountingDate": "2007-12-03",
"entryDateLocal": "2007-12-03",
"creditAccount": "abc123",
"vesselCode": "xyz789",
"bankAmountCurr": 987.65,
"voyageNo": 123,
"exchRate": 987.65,
"bankExchRate": 123.45,
"isBankCharge": true,
"isOtherCharge": false,
"isExchgDiff": false,
"isInvoiceExchgDiff": false,
"isExchgDiffCharge": true,
"isAdvAllocReverse": false,
"seqNo": 123,
"refSeqNo": 123,
"lastUpdateGmt": "2007-12-03",
"vessel": Vessel,
"financialsInvoice": FinancialsInvoice,
"payment": Payment,
"voyage": Voyage,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
PaymentDetailFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PaymentDetailFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PaymentDetailFormQueryWhere
}
PaymentDetailFormQueryWhere
Fields
Example
{
"and": [PaymentDetailFormQueryWhere],
"or": [PaymentDetailFormQueryWhere],
"rawExpression": "xyz789",
"paymentTransNo": StringWhereValueExpression,
"invoiceTransNo": StringWhereValueExpression,
"bankCode": StringWhereValueExpression,
"companyCode": StringWhereValueExpression,
"amountCurr": NumberWhereValueExpression,
"amountBase": NumberWhereValueExpression,
"paymentAccountingDate": DateWhereValueExpression,
"entryDateLocal": DateWhereValueExpression,
"creditAccount": StringWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"bankAmountCurr": NumberWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"exchRate": NumberWhereValueExpression,
"bankExchRate": NumberWhereValueExpression,
"isBankCharge": BoolWhereValueExpression,
"isOtherCharge": BoolWhereValueExpression,
"isExchgDiff": BoolWhereValueExpression,
"isInvoiceExchgDiff": BoolWhereValueExpression,
"isExchgDiffCharge": BoolWhereValueExpression,
"isAdvAllocReverse": BoolWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"refSeqNo": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"vessel": VesselFormQueryWhere,
"financialsInvoice": FinancialsInvoiceFormQueryWhere,
"payment": PaymentFormQueryWhere,
"voyage": VoyageFormQueryWhere
}
PaymentDetailRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
|
financialsInvoice - RelationshipDefinition
|
|
payment - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
Example
{
"vessel": RelationshipDefinition,
"financialsInvoice": RelationshipDefinition,
"payment": RelationshipDefinition,
"voyage": RelationshipDefinition
}
PaymentFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PaymentFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PaymentFormQueryWhere
}
PaymentFormQueryWhere
Fields
Example
{
"and": [PaymentFormQueryWhere],
"or": [PaymentFormQueryWhere],
"rawExpression": "xyz789",
"paymentTransNo": StringWhereValueExpression,
"bankCode": StringWhereValueExpression,
"payDate": DateWhereValueExpression,
"payMode": PaymentPayModeEnumValueExpression,
"checkOrWireNo": StringWhereValueExpression,
"amountPaidCurr": NumberWhereValueExpression,
"amountPaidBase": NumberWhereValueExpression,
"memo": StringWhereValueExpression,
"userInitials": StringWhereValueExpression,
"payType": PaymentPayTypeEnumValueExpression,
"cashDate": DateWhereValueExpression,
"counterpartyNo": NumberWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"advancePaymentTransNo": StringWhereValueExpression,
"thirdPartyNo": NumberWhereValueExpression,
"companyCode": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"bankAmountCurr": NumberWhereValueExpression,
"bankCurr": StringWhereValueExpression,
"advanceIndicator": NumberWhereValueExpression,
"reference": StringWhereValueExpression,
"isIntercompanyPayment": BoolWhereValueExpression,
"isXDiffToVoyage": BoolWhereValueExpression,
"isReleaseToInterface": BoolWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"curr": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"advancePayment": PaymentFormQueryWhere,
"chartOfAccounts": ChartOfAccountsFormQueryWhere
}
PaymentPayModeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
PaymentPayModeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - PaymentPayModeEnum
|
|
isNot - PaymentPayModeEnum
|
|
isIn - [PaymentPayModeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
PaymentPayTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
PaymentPayTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - PaymentPayTypeEnum
|
|
isNot - PaymentPayTypeEnum
|
|
isIn - [PaymentPayTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
PaymentRelationships
Fields
| Field Name | Description |
|---|---|
advancePayment - RelationshipDefinition
|
|
chartOfAccounts - RelationshipDefinition
|
|
paymentDetails - RelationshipDefinition
|
|
advAllocPaysFltCurr - RelationshipDefinition
|
|
advAllocPaysFltBase - RelationshipDefinition
|
|
advAllocPayDetails - RelationshipDefinition
|
|
bankChargePayDetails - RelationshipDefinition
|
|
otherChargePayDetails - RelationshipDefinition
|
|
exchgDiffPayDetails - RelationshipDefinition
|
Example
{
"advancePayment": RelationshipDefinition,
"chartOfAccounts": RelationshipDefinition,
"paymentDetails": RelationshipDefinition,
"advAllocPaysFltCurr": RelationshipDefinition,
"advAllocPaysFltBase": RelationshipDefinition,
"advAllocPayDetails": RelationshipDefinition,
"bankChargePayDetails": RelationshipDefinition,
"otherChargePayDetails": RelationshipDefinition,
"exchgDiffPayDetails": RelationshipDefinition
}
PaymentTerm
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
code - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
description - String
|
|
period - Int
|
|
periodBasis - String
|
|
isCycle - Boolean
|
|
isSkipHoliday - Boolean
|
|
isSkipWeekend - Boolean
|
|
isLockOpsInvDueDate - Boolean
|
|
isLockFinInvDueDate - Boolean
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
lastUserID - String
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"code": "xyz789",
"customFieldByID": Any,
"customField": Any,
"description": "xyz789",
"period": 123,
"periodBasis": "abc123",
"isCycle": true,
"isSkipHoliday": true,
"isSkipWeekend": true,
"isLockOpsInvDueDate": true,
"isLockFinInvDueDate": false,
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"lastUserID": "abc123",
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
PaymentTermFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PaymentTermFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PaymentTermFormQueryWhere
}
PaymentTermFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PaymentTermFormQueryWhere!]
|
|
or - [PaymentTermFormQueryWhere!]
|
|
rawExpression - String
|
|
code - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
period - NumberWhereValueExpression
|
|
periodBasis - PaymentTermPeriodBasisEnumValueExpression
|
|
isCycle - BoolWhereValueExpression
|
|
isSkipHoliday - BoolWhereValueExpression
|
|
isSkipWeekend - BoolWhereValueExpression
|
|
isLockOpsInvDueDate - BoolWhereValueExpression
|
|
isLockFinInvDueDate - BoolWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUserID - StringWhereValueExpression
|
Example
{
"and": [PaymentTermFormQueryWhere],
"or": [PaymentTermFormQueryWhere],
"rawExpression": "xyz789",
"code": StringWhereValueExpression,
"description": StringWhereValueExpression,
"period": NumberWhereValueExpression,
"periodBasis": PaymentTermPeriodBasisEnumValueExpression,
"isCycle": BoolWhereValueExpression,
"isSkipHoliday": BoolWhereValueExpression,
"isSkipWeekend": BoolWhereValueExpression,
"isLockOpsInvDueDate": BoolWhereValueExpression,
"isLockFinInvDueDate": BoolWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUserID": StringWhereValueExpression
}
PaymentTermPeriodBasisEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Manual"
PaymentTermPeriodBasisEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - PaymentTermPeriodBasisEnum
|
|
isNot - PaymentTermPeriodBasisEnum
|
|
isIn - [PaymentTermPeriodBasisEnum]
|
Example
{"is": "Manual", "isNot": "Manual", "isIn": ["Manual"]}
Permission
Fields
| Field Name | Description |
|---|---|
permission - String
|
|
type - PermissionType
|
Example
{"permission": "xyz789", "type": "read"}
PermissionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"read"
Pool
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
poolName - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
dwt - Float
|
|
mgtFeePercentage - Float
|
|
mgtFeePerDay - Float
|
|
description - String
|
|
poolID - Int
|
|
companyCode - String
|
|
calculationStartDate - Date
|
|
poolAdminAccounts - [PoolAdminAccount]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"poolName": "abc123",
"customFieldByID": Any,
"customField": Any,
"dwt": 123.45,
"mgtFeePercentage": 987.65,
"mgtFeePerDay": 123.45,
"description": "abc123",
"poolID": 123,
"companyCode": "abc123",
"calculationStartDate": "2007-12-03",
"poolAdminAccounts": [PoolAdminAccount],
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
PoolAdminAccount
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
poolID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
accountCode - String
|
|
order - Int
|
|
pool - Pool
|
|
chartOfAccounts - ChartOfAccounts
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"poolID": 987,
"customFieldByID": Any,
"customField": Any,
"accountCode": "xyz789",
"order": 987,
"pool": Pool,
"chartOfAccounts": ChartOfAccounts,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
PoolAdminAccountFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PoolAdminAccountFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PoolAdminAccountFormQueryWhere
}
PoolAdminAccountFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PoolAdminAccountFormQueryWhere!]
|
|
or - [PoolAdminAccountFormQueryWhere!]
|
|
rawExpression - String
|
|
poolID - NumberWhereValueExpression
|
|
accountCode - StringWhereValueExpression
|
|
order - NumberWhereValueExpression
|
|
pool - PoolFormQueryWhere
|
|
chartOfAccounts - ChartOfAccountsFormQueryWhere
|
Example
{
"and": [PoolAdminAccountFormQueryWhere],
"or": [PoolAdminAccountFormQueryWhere],
"rawExpression": "xyz789",
"poolID": NumberWhereValueExpression,
"accountCode": StringWhereValueExpression,
"order": NumberWhereValueExpression,
"pool": PoolFormQueryWhere,
"chartOfAccounts": ChartOfAccountsFormQueryWhere
}
PoolAdminAccountRelationships
Fields
| Field Name | Description |
|---|---|
pool - RelationshipDefinition
|
|
chartOfAccounts - RelationshipDefinition
|
Example
{
"pool": RelationshipDefinition,
"chartOfAccounts": RelationshipDefinition
}
PoolAssignment
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
isPremium - Boolean
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
year - Int
|
|
poolID - Int
|
|
vesselCode - String
|
|
netDailyPlan - Float
|
|
vesselPoints - Float
|
|
poolEntryDateGmt - Date
|
|
poolExitDateGmt - Date
|
|
mgtFeePercentage - Float
|
|
mgtFeePerDay - Float
|
|
premiumInternal - Boolean
|
|
participantCompanyNo - Int
|
|
participantCompany - AddressBook
|
|
vessel - Vessel
|
|
pool - Pool
|
|
firstPoolAssignmentPremium - PoolAssignmentPremium
|
|
poolAssignmentPremiums - [PoolAssignmentPremium]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"isPremium": true,
"customFieldByID": Any,
"customField": Any,
"year": 123,
"poolID": 123,
"vesselCode": "xyz789",
"netDailyPlan": 123.45,
"vesselPoints": 123.45,
"poolEntryDateGmt": "2007-12-03",
"poolExitDateGmt": "2007-12-03",
"mgtFeePercentage": 987.65,
"mgtFeePerDay": 123.45,
"premiumInternal": true,
"participantCompanyNo": 123,
"participantCompany": AddressBook,
"vessel": Vessel,
"pool": Pool,
"firstPoolAssignmentPremium": PoolAssignmentPremium,
"poolAssignmentPremiums": [PoolAssignmentPremium],
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
PoolAssignmentFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PoolAssignmentFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PoolAssignmentFormQueryWhere
}
PoolAssignmentFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PoolAssignmentFormQueryWhere!]
|
|
or - [PoolAssignmentFormQueryWhere!]
|
|
rawExpression - String
|
|
year - NumberWhereValueExpression
|
|
poolID - NumberWhereValueExpression
|
|
vesselCode - StringWhereValueExpression
|
|
netDailyPlan - NumberWhereValueExpression
|
|
vesselPoints - NumberWhereValueExpression
|
|
poolEntryDateGmt - DateWhereValueExpression
|
|
poolExitDateGmt - DateWhereValueExpression
|
|
mgtFeePercentage - NumberWhereValueExpression
|
|
mgtFeePerDay - NumberWhereValueExpression
|
|
premiumInternal - BoolWhereValueExpression
|
|
participantCompanyNo - NumberWhereValueExpression
|
|
participantCompany - AddressBookFormQueryWhere
|
|
vessel - VesselFormQueryWhere
|
|
pool - PoolFormQueryWhere
|
|
firstPoolAssignmentPremium - PoolAssignmentPremiumFormQueryWhere
|
Example
{
"and": [PoolAssignmentFormQueryWhere],
"or": [PoolAssignmentFormQueryWhere],
"rawExpression": "abc123",
"year": NumberWhereValueExpression,
"poolID": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"netDailyPlan": NumberWhereValueExpression,
"vesselPoints": NumberWhereValueExpression,
"poolEntryDateGmt": DateWhereValueExpression,
"poolExitDateGmt": DateWhereValueExpression,
"mgtFeePercentage": NumberWhereValueExpression,
"mgtFeePerDay": NumberWhereValueExpression,
"premiumInternal": BoolWhereValueExpression,
"participantCompanyNo": NumberWhereValueExpression,
"participantCompany": AddressBookFormQueryWhere,
"vessel": VesselFormQueryWhere,
"pool": PoolFormQueryWhere,
"firstPoolAssignmentPremium": PoolAssignmentPremiumFormQueryWhere
}
PoolAssignmentPremium
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
year - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
poolID - Int
|
|
vesselCode - String
|
|
poolEntryDateGmt - Date
|
|
premiumCode - String
|
|
poolAssignment - PoolAssignment
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"year": 987,
"customFieldByID": Any,
"customField": Any,
"poolID": 123,
"vesselCode": "abc123",
"poolEntryDateGmt": "2007-12-03",
"premiumCode": "xyz789",
"poolAssignment": PoolAssignment,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
PoolAssignmentPremiumFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PoolAssignmentPremiumFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PoolAssignmentPremiumFormQueryWhere
}
PoolAssignmentPremiumFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PoolAssignmentPremiumFormQueryWhere!]
|
|
or - [PoolAssignmentPremiumFormQueryWhere!]
|
|
rawExpression - String
|
|
year - NumberWhereValueExpression
|
|
poolID - NumberWhereValueExpression
|
|
vesselCode - StringWhereValueExpression
|
|
poolEntryDateGmt - DateWhereValueExpression
|
|
premiumCode - StringWhereValueExpression
|
|
poolAssignment - PoolAssignmentFormQueryWhere
|
Example
{
"and": [PoolAssignmentPremiumFormQueryWhere],
"or": [PoolAssignmentPremiumFormQueryWhere],
"rawExpression": "abc123",
"year": NumberWhereValueExpression,
"poolID": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"poolEntryDateGmt": DateWhereValueExpression,
"premiumCode": StringWhereValueExpression,
"poolAssignment": PoolAssignmentFormQueryWhere
}
PoolAssignmentPremiumRelationships
Fields
| Field Name | Description |
|---|---|
poolAssignment - RelationshipDefinition
|
Example
{"poolAssignment": RelationshipDefinition}
PoolAssignmentRelationships
Fields
| Field Name | Description |
|---|---|
participantCompany - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
pool - RelationshipDefinition
|
|
firstPoolAssignmentPremium - RelationshipDefinition
|
|
poolAssignmentPremiums - RelationshipDefinition
|
Example
{
"participantCompany": RelationshipDefinition,
"vessel": RelationshipDefinition,
"pool": RelationshipDefinition,
"firstPoolAssignmentPremium": RelationshipDefinition,
"poolAssignmentPremiums": RelationshipDefinition
}
PoolFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PoolFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PoolFormQueryWhere
}
PoolFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PoolFormQueryWhere!]
|
|
or - [PoolFormQueryWhere!]
|
|
rawExpression - String
|
|
poolName - StringWhereValueExpression
|
|
dwt - NumberWhereValueExpression
|
|
mgtFeePercentage - NumberWhereValueExpression
|
|
mgtFeePerDay - NumberWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
poolID - NumberWhereValueExpression
|
|
companyCode - StringWhereValueExpression
|
|
calculationStartDate - DateWhereValueExpression
|
Example
{
"and": [PoolFormQueryWhere],
"or": [PoolFormQueryWhere],
"rawExpression": "abc123",
"poolName": StringWhereValueExpression,
"dwt": NumberWhereValueExpression,
"mgtFeePercentage": NumberWhereValueExpression,
"mgtFeePerDay": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"poolID": NumberWhereValueExpression,
"companyCode": StringWhereValueExpression,
"calculationStartDate": DateWhereValueExpression
}
PoolRelationships
Fields
| Field Name | Description |
|---|---|
poolAdminAccounts - RelationshipDefinition
|
Example
{"poolAdminAccounts": RelationshipDefinition}
PoolingDistribution
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
incomeBPIncrement - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
incomeAPIncrement - Float
|
|
adminIncomeBPIncrement - Float
|
|
adminIncomeAPIncrement - Float
|
|
premiumBPIncrement - Float
|
|
premiumAPIncrement - Float
|
|
onHireDaysIncrement - Float
|
|
offHireDaysIncrement - Float
|
|
prevPeriodFromGmt - Date
|
|
prevPeriodToGmt - Date
|
|
prevDistribPeriodFromGmt - Date
|
|
prevDistribPeriodToGmt - Date
|
|
poolingDistributionID - Int
|
|
poolID - Int
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
participantShortName - String
|
|
participantType - String
|
|
periodFromGmt - Date
|
|
periodToGmt - Date
|
|
distributionPeriodFromGmt - Date
|
|
distributionPeriodToGmt - Date
|
|
incomeBP - Float
|
|
onHireDays - Float
|
|
offHireDays - Float
|
|
poolPoints - Float
|
|
incomeAP - Float
|
|
mgtFeeDistribution - Float
|
|
premiumAP - Float
|
|
poolEntryDateGmt - Date
|
|
poolExitDateGmt - Date
|
|
mgtFeePercentage - Float
|
|
adminIncomeBP - Float
|
|
adminIncomeAP - Float
|
|
premiumBP - Float
|
|
grossIncome - Float
|
|
dailyMgtFeeDistribution - Float
|
|
voyage - Voyage
|
|
pool - Pool
|
|
poolingDistributionPremiums - [PoolingDistributionPremium]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"incomeBPIncrement": 987.65,
"customFieldByID": Any,
"customField": Any,
"incomeAPIncrement": 123.45,
"adminIncomeBPIncrement": 123.45,
"adminIncomeAPIncrement": 123.45,
"premiumBPIncrement": 123.45,
"premiumAPIncrement": 987.65,
"onHireDaysIncrement": 987.65,
"offHireDaysIncrement": 987.65,
"prevPeriodFromGmt": "2007-12-03",
"prevPeriodToGmt": "2007-12-03",
"prevDistribPeriodFromGmt": "2007-12-03",
"prevDistribPeriodToGmt": "2007-12-03",
"poolingDistributionID": 987,
"poolID": 987,
"vesselCode": "abc123",
"voyageNo": 123,
"participantShortName": "abc123",
"participantType": "abc123",
"periodFromGmt": "2007-12-03",
"periodToGmt": "2007-12-03",
"distributionPeriodFromGmt": "2007-12-03",
"distributionPeriodToGmt": "2007-12-03",
"incomeBP": 987.65,
"onHireDays": 987.65,
"offHireDays": 123.45,
"poolPoints": 123.45,
"incomeAP": 987.65,
"mgtFeeDistribution": 123.45,
"premiumAP": 987.65,
"poolEntryDateGmt": "2007-12-03",
"poolExitDateGmt": "2007-12-03",
"mgtFeePercentage": 123.45,
"adminIncomeBP": 987.65,
"adminIncomeAP": 987.65,
"premiumBP": 123.45,
"grossIncome": 987.65,
"dailyMgtFeeDistribution": 123.45,
"voyage": Voyage,
"pool": Pool,
"poolingDistributionPremiums": [
PoolingDistributionPremium
],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
PoolingDistributionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PoolingDistributionFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PoolingDistributionFormQueryWhere
}
PoolingDistributionFormQueryWhere
Fields
Example
{
"and": [PoolingDistributionFormQueryWhere],
"or": [PoolingDistributionFormQueryWhere],
"rawExpression": "abc123",
"poolingDistributionID": NumberWhereValueExpression,
"poolID": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"participantShortName": StringWhereValueExpression,
"participantType": StringWhereValueExpression,
"periodFromGmt": DateWhereValueExpression,
"periodToGmt": DateWhereValueExpression,
"distributionPeriodFromGmt": DateWhereValueExpression,
"distributionPeriodToGmt": DateWhereValueExpression,
"incomeBP": NumberWhereValueExpression,
"onHireDays": NumberWhereValueExpression,
"offHireDays": NumberWhereValueExpression,
"poolPoints": NumberWhereValueExpression,
"incomeAP": NumberWhereValueExpression,
"mgtFeeDistribution": NumberWhereValueExpression,
"premiumAP": NumberWhereValueExpression,
"poolEntryDateGmt": DateWhereValueExpression,
"poolExitDateGmt": DateWhereValueExpression,
"mgtFeePercentage": NumberWhereValueExpression,
"adminIncomeBP": NumberWhereValueExpression,
"adminIncomeAP": NumberWhereValueExpression,
"premiumBP": NumberWhereValueExpression,
"grossIncome": NumberWhereValueExpression,
"dailyMgtFeeDistribution": NumberWhereValueExpression,
"voyage": VoyageFormQueryWhere,
"pool": PoolFormQueryWhere
}
PoolingDistributionPremium
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
poolingDistributionID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
premiumCode - String
|
|
premiumBP - Float
|
|
premiumAP - Float
|
|
poolingDistribution - PoolingDistribution
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"poolingDistributionID": 987,
"customFieldByID": Any,
"customField": Any,
"premiumCode": "xyz789",
"premiumBP": 123.45,
"premiumAP": 123.45,
"poolingDistribution": PoolingDistribution,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
PoolingDistributionPremiumFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PoolingDistributionPremiumFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PoolingDistributionPremiumFormQueryWhere
}
PoolingDistributionPremiumFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PoolingDistributionPremiumFormQueryWhere!]
|
|
or - [PoolingDistributionPremiumFormQueryWhere!]
|
|
rawExpression - String
|
|
poolingDistributionID - NumberWhereValueExpression
|
|
premiumCode - StringWhereValueExpression
|
|
premiumBP - NumberWhereValueExpression
|
|
premiumAP - NumberWhereValueExpression
|
|
poolingDistribution - PoolingDistributionFormQueryWhere
|
Example
{
"and": [PoolingDistributionPremiumFormQueryWhere],
"or": [PoolingDistributionPremiumFormQueryWhere],
"rawExpression": "abc123",
"poolingDistributionID": NumberWhereValueExpression,
"premiumCode": StringWhereValueExpression,
"premiumBP": NumberWhereValueExpression,
"premiumAP": NumberWhereValueExpression,
"poolingDistribution": PoolingDistributionFormQueryWhere
}
PoolingDistributionPremiumRelationships
Fields
| Field Name | Description |
|---|---|
poolingDistribution - RelationshipDefinition
|
Example
{"poolingDistribution": RelationshipDefinition}
PoolingDistributionRelationships
Fields
| Field Name | Description |
|---|---|
voyage - RelationshipDefinition
|
|
pool - RelationshipDefinition
|
|
previousPoolingDistribution - RelationshipDefinition
|
|
poolingDistributionPremiums - RelationshipDefinition
|
Example
{
"voyage": RelationshipDefinition,
"pool": RelationshipDefinition,
"previousPoolingDistribution": RelationshipDefinition,
"poolingDistributionPremiums": RelationshipDefinition
}
Port
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
type - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
aliasPortList - String
|
|
status - String
|
|
portAgents - String
|
|
waterwayFlag - Boolean
|
|
isActive - Boolean
|
|
currentDateLocal - Date
|
|
fuelZoneName - String
|
|
latitudeDecimal - Float
|
|
longitudeDecimal - Float
|
|
sqlID - Int
|
|
portNo - Int
|
|
vesonID - Int
|
|
fairplayID - Int
|
|
country - String
|
|
name - String
|
|
longitude - String
|
|
latitude - String
|
|
altNo - Int
|
|
lastUser - String
|
|
state - String
|
|
timeZoneCode - String
|
|
unCode - String
|
|
bunkerPort - Boolean
|
|
singleBerth - Boolean
|
|
remarks - String
|
|
dist50Area - String
|
|
portRegion - String
|
|
area - String
|
|
waterwaySystem - String
|
|
externalRef - String
|
|
waterwayCode - String
|
|
waterwayMarker - Int
|
|
regionCode - String
|
|
inactive - Boolean
|
|
rangePort - Boolean
|
|
countryPort - Boolean
|
|
noDist - Boolean
|
|
lowSulfur - Boolean
|
|
lighterPort - Boolean
|
|
piracyArea - Boolean
|
|
projectionPort - Boolean
|
|
isEcaZone - Boolean
|
|
isPilotageArea - Boolean
|
|
highSulfurOverride - Boolean
|
|
ecaInPortOnly - Boolean
|
|
hidePassingPointEta - Boolean
|
|
isPilotStation - Boolean
|
|
isEuEtsPortOfCall - Boolean
|
|
isOutermostRegion - Boolean
|
|
isEuEtsExclusion - Boolean
|
|
flags - Int
|
|
minBodyLength - Float
|
|
maxDisplacement - Float
|
|
lastUpdateGmt - Date
|
|
operatorEmail - String
|
|
operatorCompanyNo - Int
|
|
alerts - String
|
|
nextPortNo - Int
|
|
bargeComments - String
|
|
productComments - String
|
|
portComments - String
|
|
city - String
|
|
holidayCode - String
|
|
loadlineZone - String
|
|
longitudeSeconds - Float
|
|
latitudeSeconds - Float
|
|
supportedScrubberType - String
|
|
parentCountry - String
|
|
operatorCompanyData - AddressBook
|
|
countryData - Country
|
|
timeZoneData - TimeZoneCodes
|
|
waterway - Waterway
|
|
aliasParentPort - Port
|
|
portVesselBerths - [PortVesselBerth]
|
|
portVessels - [PortVessel]
|
|
portFuelAvailabilities - [PortFuelAvailability]
|
|
portCargoCompatBerths - [PortCargoCompatBerth]
|
|
portCargoCompats - [PortCargoCompat]
|
|
voyageActivityReports - [VoyageActivityReport]
|
|
berthBlockages - [BerthBlockage]
|
|
portBerths - [PortBerth]
|
|
aliasPorts - [Port]
|
|
addressBookAgentPorts - [AddressBookAgentPort]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"type": "abc123",
"customFieldByID": Any,
"customField": Any,
"aliasPortList": "xyz789",
"status": "abc123",
"portAgents": "abc123",
"waterwayFlag": false,
"isActive": true,
"currentDateLocal": "2007-12-03",
"fuelZoneName": "xyz789",
"latitudeDecimal": 987.65,
"longitudeDecimal": 987.65,
"sqlID": 123,
"portNo": 987,
"vesonID": 123,
"fairplayID": 123,
"country": "xyz789",
"name": "xyz789",
"longitude": "xyz789",
"latitude": "xyz789",
"altNo": 123,
"lastUser": "abc123",
"state": "xyz789",
"timeZoneCode": "abc123",
"unCode": "abc123",
"bunkerPort": true,
"singleBerth": false,
"remarks": "abc123",
"dist50Area": "abc123",
"portRegion": "xyz789",
"area": "abc123",
"waterwaySystem": "abc123",
"externalRef": "abc123",
"waterwayCode": "abc123",
"waterwayMarker": 987,
"regionCode": "abc123",
"inactive": true,
"rangePort": true,
"countryPort": true,
"noDist": true,
"lowSulfur": false,
"lighterPort": true,
"piracyArea": false,
"projectionPort": true,
"isEcaZone": false,
"isPilotageArea": false,
"highSulfurOverride": false,
"ecaInPortOnly": false,
"hidePassingPointEta": true,
"isPilotStation": false,
"isEuEtsPortOfCall": false,
"isOutermostRegion": false,
"isEuEtsExclusion": false,
"flags": 987,
"minBodyLength": 987.65,
"maxDisplacement": 987.65,
"lastUpdateGmt": "2007-12-03",
"operatorEmail": "abc123",
"operatorCompanyNo": 987,
"alerts": "xyz789",
"nextPortNo": 987,
"bargeComments": "xyz789",
"productComments": "abc123",
"portComments": "xyz789",
"city": "xyz789",
"holidayCode": "abc123",
"loadlineZone": "abc123",
"longitudeSeconds": 123.45,
"latitudeSeconds": 123.45,
"supportedScrubberType": "xyz789",
"parentCountry": "abc123",
"operatorCompanyData": AddressBook,
"countryData": Country,
"timeZoneData": TimeZoneCodes,
"waterway": Waterway,
"aliasParentPort": Port,
"portVesselBerths": [PortVesselBerth],
"portVessels": [PortVessel],
"portFuelAvailabilities": [PortFuelAvailability],
"portCargoCompatBerths": [PortCargoCompatBerth],
"portCargoCompats": [PortCargoCompat],
"voyageActivityReports": [VoyageActivityReport],
"berthBlockages": [BerthBlockage],
"portBerths": [PortBerth],
"aliasPorts": [Port],
"addressBookAgentPorts": [AddressBookAgentPort],
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
PortActivity
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
functionCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
iD - Int
|
|
activity - String
|
|
remarks - String
|
|
lightering - Boolean
|
|
cargo - Boolean
|
|
berth - Boolean
|
|
excluded - Boolean
|
|
rob - Boolean
|
|
charterer - Boolean
|
|
sOFPrintout - Boolean
|
|
robRequired - Boolean
|
|
actionType - String
|
|
voyageType - Int
|
|
code - String
|
|
parentCode - String
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"functionCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"iD": 123,
"activity": "abc123",
"remarks": "xyz789",
"lightering": true,
"cargo": true,
"berth": false,
"excluded": false,
"rob": true,
"charterer": false,
"sOFPrintout": true,
"robRequired": true,
"actionType": "xyz789",
"voyageType": 123,
"code": "xyz789",
"parentCode": "abc123",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
PortActivityBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
itinerarySeq - Int
|
|
seq - Int
|
|
activityTimeLocal - Date
|
|
equipmentCode - String
|
|
cargoHandlingSeqNo - Int
|
|
fuelType - String
|
|
fuelRob - Float
|
|
voyagePortActivities - VoyagePortActivities
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 123,
"itinerarySeq": 987,
"seq": 123,
"activityTimeLocal": "2007-12-03",
"equipmentCode": "xyz789",
"cargoHandlingSeqNo": 987,
"fuelType": "xyz789",
"fuelRob": 987.65,
"voyagePortActivities": VoyagePortActivities,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
PortActivityBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PortActivityBunkerFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PortActivityBunkerFormQueryWhere
}
PortActivityBunkerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PortActivityBunkerFormQueryWhere!]
|
|
or - [PortActivityBunkerFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
itinerarySeq - NumberWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
activityTimeLocal - DateWhereValueExpression
|
|
equipmentCode - StringWhereValueExpression
|
|
cargoHandlingSeqNo - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
fuelRob - NumberWhereValueExpression
|
|
voyagePortActivities - VoyagePortActivitiesFormQueryWhere
|
Example
{
"and": [PortActivityBunkerFormQueryWhere],
"or": [PortActivityBunkerFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"itinerarySeq": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"activityTimeLocal": DateWhereValueExpression,
"equipmentCode": StringWhereValueExpression,
"cargoHandlingSeqNo": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"fuelRob": NumberWhereValueExpression,
"voyagePortActivities": VoyagePortActivitiesFormQueryWhere
}
PortActivityBunkerRelationships
Fields
| Field Name | Description |
|---|---|
voyagePortActivities - RelationshipDefinition
|
Example
{"voyagePortActivities": RelationshipDefinition}
PortActivityFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PortActivityFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PortActivityFormQueryWhere
}
PortActivityFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PortActivityFormQueryWhere!]
|
|
or - [PortActivityFormQueryWhere!]
|
|
rawExpression - String
|
|
functionCode - StringWhereValueExpression
|
|
iD - NumberWhereValueExpression
|
|
activity - StringWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
lightering - BoolWhereValueExpression
|
|
cargo - BoolWhereValueExpression
|
|
berth - BoolWhereValueExpression
|
|
excluded - BoolWhereValueExpression
|
|
rob - BoolWhereValueExpression
|
|
charterer - BoolWhereValueExpression
|
|
sOFPrintout - BoolWhereValueExpression
|
|
robRequired - BoolWhereValueExpression
|
|
actionType - StringWhereValueExpression
|
|
voyageType - NumberWhereValueExpression
|
|
code - StringWhereValueExpression
|
|
parentCode - StringWhereValueExpression
|
Example
{
"and": [PortActivityFormQueryWhere],
"or": [PortActivityFormQueryWhere],
"rawExpression": "abc123",
"functionCode": StringWhereValueExpression,
"iD": NumberWhereValueExpression,
"activity": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"lightering": BoolWhereValueExpression,
"cargo": BoolWhereValueExpression,
"berth": BoolWhereValueExpression,
"excluded": BoolWhereValueExpression,
"rob": BoolWhereValueExpression,
"charterer": BoolWhereValueExpression,
"sOFPrintout": BoolWhereValueExpression,
"robRequired": BoolWhereValueExpression,
"actionType": StringWhereValueExpression,
"voyageType": NumberWhereValueExpression,
"code": StringWhereValueExpression,
"parentCode": StringWhereValueExpression
}
PortActivityListInput
Description
Submits a veslink PortActivityList transaction
Fields
| Input Field | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
|
seq - Int
|
|
voyagePortActivities - [PortActivityList_VoyagePortActivitiesInput]!
|
|
port - PortActivityList_PortInput
|
|
importMode - PortActivityList_ImportMode
|
Update - If there is an overlap of the incoming and existing voyagePortActivities, it will update the activityTime or delete the port activity if there is no time Append - Add the incoming voyagePortActivities to the existing voyagePortActivities |
referenceDate - Date
|
Reference date for this message, used to infer which voyage itinerary leg to submit against if no seq is specified. |
Example
{
"vesselCode": "xyz789",
"voyageNo": 123,
"seq": 987,
"voyagePortActivities": [
PortActivityList_VoyagePortActivitiesInput
],
"port": PortActivityList_PortInput,
"importMode": "Overwrite",
"referenceDate": "2007-12-03"
}
PortActivityListMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "abc123",
"debug": false,
"context": ["abc123"],
"timestamp": "xyz789",
"originalTimestamp": "xyz789",
"intent": "abc123",
"from": "abc123",
"to": ["xyz789"],
"fromUser": "xyz789",
"status": "xyz789",
"approvalStatus": "xyz789",
"objectId": "abc123",
"type": "xyz789",
"data": Json,
"applyTriggeredOn": "abc123",
"applyTriggeredBy": "abc123",
"previousData": Json,
"comment": "xyz789",
"unmapped": true,
"responseData": Json,
"applyErrors": ["abc123"],
"applyWarnings": ["xyz789"],
"parentMessageId": "abc123",
"preResolutionObjectId": "xyz789",
"title": "xyz789",
"effectiveDate": "xyz789",
"source": "abc123",
"sourceId": "abc123",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": false,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
PortActivityList_ImportMode
Description
Overwrite (default) - Completely replaces the existing voyagePortActivities with the incoming voyagePortActivities Update - If there is an overlap of the incoming and existing voyagePortActivities, it will update the activityTime or delete the port activity if there is no time Append - Add the incoming voyagePortActivities to the existing voyagePortActivities
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Overwrite"
PortActivityList_PortInput
PortActivityList_VoyagePortActivitiesInput
Fields
| Input Field | Description |
|---|---|
activityName - String
|
The name of this activity from the set of predefined activities |
activityType - String
|
Overrides the two letter code of the activity for this instance for special case handling |
remarks - String
|
|
activityTimeGmt - Date
|
|
activityTimeLocal - Date
|
|
berthShortName - String
|
|
cargoShortName - String
|
|
cargoHandlingSeqNo - Int
|
|
portActivityBunkers - [PortActivityList_VoyagePortActivitiesInput_PortActivityBunkersInput]
|
|
berthSeqNo - Int
|
Example
{
"activityName": "abc123",
"activityType": "abc123",
"remarks": "abc123",
"activityTimeGmt": "2007-12-03",
"activityTimeLocal": "2007-12-03",
"berthShortName": "xyz789",
"cargoShortName": "xyz789",
"cargoHandlingSeqNo": 123,
"portActivityBunkers": [
PortActivityList_VoyagePortActivitiesInput_PortActivityBunkersInput
],
"berthSeqNo": 987
}
PortActivityList_VoyagePortActivitiesInput_PortActivityBunkersInput
PortAdvanceDaRelationships
Fields
| Field Name | Description |
|---|---|
voyage - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
vendor - RelationshipDefinition
|
|
firstAdvanceInvoiceDetails - RelationshipDefinition
|
|
firstAdvanceInvoice - RelationshipDefinition
|
|
firstFinalInvoiceDetails - RelationshipDefinition
|
|
firstFinalInvoice - RelationshipDefinition
|
|
advanceInvoiceDetails - RelationshipDefinition
|
|
finalInvoiceDetails - RelationshipDefinition
|
|
finalPayDetails - RelationshipDefinition
|
Example
{
"voyage": RelationshipDefinition,
"vessel": RelationshipDefinition,
"vendor": RelationshipDefinition,
"firstAdvanceInvoiceDetails": RelationshipDefinition,
"firstAdvanceInvoice": RelationshipDefinition,
"firstFinalInvoiceDetails": RelationshipDefinition,
"firstFinalInvoice": RelationshipDefinition,
"advanceInvoiceDetails": RelationshipDefinition,
"finalInvoiceDetails": RelationshipDefinition,
"finalPayDetails": RelationshipDefinition
}
PortAlertRulesRequest
PortArea
Fields
| Field Name | Description |
|---|---|
areaNo - Int
|
|
portNo - Int
|
|
portRank - Int
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"areaNo": 987,
"portNo": 123,
"portRank": 987,
"_id": "abc123",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
PortAreaFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PortAreaFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PortAreaFormQueryWhere
}
PortAreaFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PortAreaFormQueryWhere!]
|
|
or - [PortAreaFormQueryWhere!]
|
|
rawExpression - String
|
|
areaNo - NumberWhereValueExpression
|
|
portNo - NumberWhereValueExpression
|
|
portRank - NumberWhereValueExpression
|
Example
{
"and": [PortAreaFormQueryWhere],
"or": [PortAreaFormQueryWhere],
"rawExpression": "xyz789",
"areaNo": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"portRank": NumberWhereValueExpression
}
PortBerth
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
portNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
shortName - String
|
|
fullName - String
|
|
bunkerBerth - Boolean
|
|
maxDraft - Float
|
|
salinity - Float
|
|
maxLOA - Float
|
|
maxBeam - Float
|
|
maxAirDraft - Float
|
|
maxHatchDraft - Float
|
|
maxDWT - Int
|
|
singleVessel - Boolean
|
|
inventoryBerth - Boolean
|
|
hoursFrom - Int
|
|
hoursTo - Int
|
|
distance - Float
|
|
pilotBerthHours - Float
|
|
berthPilotHours - Float
|
|
storageCapacity - String
|
|
dailyPerformance - String
|
|
workingDays - String
|
|
normalWorkHours - String
|
|
hoseQuantity - Int
|
|
hoseSize - Float
|
|
alongsideHours - Float
|
|
externalRef - String
|
|
inactive - Boolean
|
|
lowFlash - Boolean
|
|
maxBow - Boolean
|
|
stern - Boolean
|
|
latitude - Float
|
|
longitude - Float
|
|
minBodyLength - Float
|
|
maxDisplacement - Float
|
|
draftBasis - String
|
|
port - Port
|
|
userDefinedFields - Json
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"portNo": 987,
"customFieldByID": Any,
"customField": Any,
"shortName": "xyz789",
"fullName": "abc123",
"bunkerBerth": false,
"maxDraft": 123.45,
"salinity": 987.65,
"maxLOA": 123.45,
"maxBeam": 123.45,
"maxAirDraft": 123.45,
"maxHatchDraft": 987.65,
"maxDWT": 987,
"singleVessel": false,
"inventoryBerth": true,
"hoursFrom": 123,
"hoursTo": 987,
"distance": 987.65,
"pilotBerthHours": 987.65,
"berthPilotHours": 987.65,
"storageCapacity": "abc123",
"dailyPerformance": "xyz789",
"workingDays": "xyz789",
"normalWorkHours": "xyz789",
"hoseQuantity": 987,
"hoseSize": 123.45,
"alongsideHours": 987.65,
"externalRef": "abc123",
"inactive": false,
"lowFlash": false,
"maxBow": true,
"stern": false,
"latitude": 987.65,
"longitude": 987.65,
"minBodyLength": 987.65,
"maxDisplacement": 987.65,
"draftBasis": "xyz789",
"port": Port,
"userDefinedFields": Json,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
PortBerthFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PortBerthFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PortBerthFormQueryWhere
}
PortBerthFormQueryWhere
Fields
Example
{
"and": [PortBerthFormQueryWhere],
"or": [PortBerthFormQueryWhere],
"rawExpression": "abc123",
"portNo": NumberWhereValueExpression,
"shortName": StringWhereValueExpression,
"fullName": StringWhereValueExpression,
"bunkerBerth": BoolWhereValueExpression,
"maxDraft": NumberWhereValueExpression,
"salinity": NumberWhereValueExpression,
"maxLOA": NumberWhereValueExpression,
"maxBeam": NumberWhereValueExpression,
"maxAirDraft": NumberWhereValueExpression,
"maxHatchDraft": NumberWhereValueExpression,
"maxDWT": NumberWhereValueExpression,
"singleVessel": BoolWhereValueExpression,
"inventoryBerth": BoolWhereValueExpression,
"hoursFrom": NumberWhereValueExpression,
"hoursTo": NumberWhereValueExpression,
"distance": NumberWhereValueExpression,
"pilotBerthHours": NumberWhereValueExpression,
"berthPilotHours": NumberWhereValueExpression,
"storageCapacity": StringWhereValueExpression,
"dailyPerformance": StringWhereValueExpression,
"workingDays": StringWhereValueExpression,
"normalWorkHours": StringWhereValueExpression,
"hoseQuantity": NumberWhereValueExpression,
"hoseSize": NumberWhereValueExpression,
"alongsideHours": NumberWhereValueExpression,
"externalRef": StringWhereValueExpression,
"inactive": BoolWhereValueExpression,
"lowFlash": BoolWhereValueExpression,
"maxBow": BoolWhereValueExpression,
"stern": BoolWhereValueExpression,
"latitude": NumberWhereValueExpression,
"longitude": NumberWhereValueExpression,
"minBodyLength": NumberWhereValueExpression,
"maxDisplacement": NumberWhereValueExpression,
"draftBasis": StringWhereValueExpression,
"port": PortFormQueryWhere
}
PortBerthRelationships
Fields
| Field Name | Description |
|---|---|
port - RelationshipDefinition
|
Example
{"port": RelationshipDefinition}
PortBunkerPrices
Fields
| Field Name | Description |
|---|---|
source - String!
|
|
timestamp - String!
|
|
prices - [BunkerPrice]
|
Example
{
"source": "xyz789",
"timestamp": "abc123",
"prices": [BunkerPrice]
}
PortCargoCompat
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
portNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
cargoShortName - String
|
|
status - String
|
|
referenceDate - Date
|
|
remarks - String
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
endReferenceDate - Date
|
|
port - Port
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"portNo": 987,
"customFieldByID": Any,
"customField": Any,
"cargoShortName": "abc123",
"status": "xyz789",
"referenceDate": "2007-12-03",
"remarks": "abc123",
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"endReferenceDate": "2007-12-03",
"port": Port,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
PortCargoCompatBerth
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
portNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
cargoShortName - String
|
|
status - String
|
|
referenceDate - Date
|
|
berthShortName - String
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
endReferenceDate - Date
|
|
port - Port
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"portNo": 123,
"customFieldByID": Any,
"customField": Any,
"cargoShortName": "xyz789",
"status": "abc123",
"referenceDate": "2007-12-03",
"berthShortName": "xyz789",
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"endReferenceDate": "2007-12-03",
"port": Port,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
PortCargoCompatBerthFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PortCargoCompatBerthFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PortCargoCompatBerthFormQueryWhere
}
PortCargoCompatBerthFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PortCargoCompatBerthFormQueryWhere!]
|
|
or - [PortCargoCompatBerthFormQueryWhere!]
|
|
rawExpression - String
|
|
portNo - NumberWhereValueExpression
|
|
cargoShortName - StringWhereValueExpression
|
|
status - PortCargoCompatBerthStatusEnumValueExpression
|
|
referenceDate - DateWhereValueExpression
|
|
berthShortName - StringWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
endReferenceDate - DateWhereValueExpression
|
|
port - PortFormQueryWhere
|
Example
{
"and": [PortCargoCompatBerthFormQueryWhere],
"or": [PortCargoCompatBerthFormQueryWhere],
"rawExpression": "abc123",
"portNo": NumberWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"status": PortCargoCompatBerthStatusEnumValueExpression,
"referenceDate": DateWhereValueExpression,
"berthShortName": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"endReferenceDate": DateWhereValueExpression,
"port": PortFormQueryWhere
}
PortCargoCompatBerthRelationships
Fields
| Field Name | Description |
|---|---|
port - RelationshipDefinition
|
Example
{"port": RelationshipDefinition}
PortCargoCompatBerthStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
PortCargoCompatBerthStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - PortCargoCompatBerthStatusEnum
|
|
isNot - PortCargoCompatBerthStatusEnum
|
|
isIn - [PortCargoCompatBerthStatusEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
PortCargoCompatFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PortCargoCompatFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PortCargoCompatFormQueryWhere
}
PortCargoCompatFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PortCargoCompatFormQueryWhere!]
|
|
or - [PortCargoCompatFormQueryWhere!]
|
|
rawExpression - String
|
|
portNo - NumberWhereValueExpression
|
|
cargoShortName - StringWhereValueExpression
|
|
status - PortCargoCompatStatusEnumValueExpression
|
|
referenceDate - DateWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
endReferenceDate - DateWhereValueExpression
|
|
port - PortFormQueryWhere
|
Example
{
"and": [PortCargoCompatFormQueryWhere],
"or": [PortCargoCompatFormQueryWhere],
"rawExpression": "xyz789",
"portNo": NumberWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"status": PortCargoCompatStatusEnumValueExpression,
"referenceDate": DateWhereValueExpression,
"remarks": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"endReferenceDate": DateWhereValueExpression,
"port": PortFormQueryWhere
}
PortCargoCompatRelationships
Fields
| Field Name | Description |
|---|---|
port - RelationshipDefinition
|
Example
{"port": RelationshipDefinition}
PortCargoCompatStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
PortCargoCompatStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - PortCargoCompatStatusEnum
|
|
isNot - PortCargoCompatStatusEnum
|
|
isIn - [PortCargoCompatStatusEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
PortDistance
PortExpense
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
localUTCOffset - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
advancePaidCurr - Float
|
|
finalPaidCurr - Float
|
|
advanceTotalCurr - Float
|
|
finalTotalCurr - Float
|
|
finalPaymentCurr - Float
|
|
finalOutstandingCurr - Float
|
|
isRebillable - Boolean
|
|
actualAmountBaseAdjusted - Float
|
|
advInvoiceOprTransNo - Int
|
|
actualInvoiceOprTransNo - Int
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
portSeqNo - Int
|
|
vendorShortName - String
|
|
arrivalLocal - Date
|
|
departureLocal - Date
|
|
portNo - Int
|
|
portName - String
|
|
berthShortName - String
|
|
berthDays - Float
|
|
portFunc - String
|
|
cargoShortName - String
|
|
vendorCompanyNo - Int
|
|
advDateLocal - Date
|
|
actualDateLocal - Date
|
|
curr - String
|
|
advExchangeRate - Float
|
|
advAmountCurr - Float
|
|
advAmountBase - Float
|
|
actualAmountCurr - Float
|
|
actualAmountBase - Float
|
|
entryDateLocal - Date
|
|
lastUpdateGmt - Date
|
|
actualExchangeRate - Float
|
|
vendorType - String
|
|
lastUser - String
|
|
advanceAmountPaidCurr - Float
|
|
agentDueAmountCurr - Float
|
|
payeeShortName - String
|
|
cargoName - CargoName
|
|
vendor - AddressBook
|
|
voyageItinerary - VoyageItinerary
|
|
voyage - Voyage
|
|
vessel - Vessel
|
|
payee - AddressBook
|
|
portAgent - VoyagePortAgent
|
|
firstAdvanceInvoiceDetails - OperationsInvoiceDetails
|
|
firstAdvanceInvoice - OperationsInvoice
|
|
firstAdvancePayDetails - OperationsPaymentDetails
|
|
firstFinalInvoiceDetails - OperationsInvoiceDetails
|
|
firstFinalInvoice - OperationsInvoice
|
|
firstFinalPayDetails - OperationsPaymentDetails
|
|
advanceInvoiceDetails - [OperationsInvoiceDetails]
|
|
advancePayDetails - [OperationsPaymentDetails]
|
|
finalInvoiceDetails - [OperationsInvoiceDetails]
|
|
finalPayDetails - [OperationsPaymentDetails]
|
|
portExpenseMiscDetails - [PortExpenseMiscDetails]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"localUTCOffset": "abc123",
"customFieldByID": Any,
"customField": Any,
"advancePaidCurr": 123.45,
"finalPaidCurr": 123.45,
"advanceTotalCurr": 123.45,
"finalTotalCurr": 123.45,
"finalPaymentCurr": 987.65,
"finalOutstandingCurr": 987.65,
"isRebillable": false,
"actualAmountBaseAdjusted": 987.65,
"advInvoiceOprTransNo": 987,
"actualInvoiceOprTransNo": 123,
"vesselCode": "xyz789",
"voyageNo": 123,
"portSeqNo": 123,
"vendorShortName": "abc123",
"arrivalLocal": "2007-12-03",
"departureLocal": "2007-12-03",
"portNo": 123,
"portName": "xyz789",
"berthShortName": "xyz789",
"berthDays": 987.65,
"portFunc": "xyz789",
"cargoShortName": "abc123",
"vendorCompanyNo": 123,
"advDateLocal": "2007-12-03",
"actualDateLocal": "2007-12-03",
"curr": "xyz789",
"advExchangeRate": 123.45,
"advAmountCurr": 123.45,
"advAmountBase": 987.65,
"actualAmountCurr": 123.45,
"actualAmountBase": 123.45,
"entryDateLocal": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"actualExchangeRate": 123.45,
"vendorType": "xyz789",
"lastUser": "abc123",
"advanceAmountPaidCurr": 123.45,
"agentDueAmountCurr": 987.65,
"payeeShortName": "xyz789",
"cargoName": CargoName,
"vendor": AddressBook,
"voyageItinerary": VoyageItinerary,
"voyage": Voyage,
"vessel": Vessel,
"payee": AddressBook,
"portAgent": VoyagePortAgent,
"firstAdvanceInvoiceDetails": OperationsInvoiceDetails,
"firstAdvanceInvoice": OperationsInvoice,
"firstAdvancePayDetails": OperationsPaymentDetails,
"firstFinalInvoiceDetails": OperationsInvoiceDetails,
"firstFinalInvoice": OperationsInvoice,
"firstFinalPayDetails": OperationsPaymentDetails,
"advanceInvoiceDetails": [OperationsInvoiceDetails],
"advancePayDetails": [OperationsPaymentDetails],
"finalInvoiceDetails": [OperationsInvoiceDetails],
"finalPayDetails": [OperationsPaymentDetails],
"portExpenseMiscDetails": [PortExpenseMiscDetails],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
PortExpenseFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PortExpenseFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PortExpenseFormQueryWhere
}
PortExpenseFormQueryWhere
Fields
Example
{
"and": [PortExpenseFormQueryWhere],
"or": [PortExpenseFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"portSeqNo": NumberWhereValueExpression,
"vendorShortName": StringWhereValueExpression,
"arrivalLocal": DateWhereValueExpression,
"departureLocal": DateWhereValueExpression,
"portNo": NumberWhereValueExpression,
"portName": StringWhereValueExpression,
"berthShortName": StringWhereValueExpression,
"berthDays": NumberWhereValueExpression,
"portFunc": StringWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"vendorCompanyNo": NumberWhereValueExpression,
"advDateLocal": DateWhereValueExpression,
"actualDateLocal": DateWhereValueExpression,
"curr": StringWhereValueExpression,
"advExchangeRate": NumberWhereValueExpression,
"advAmountCurr": NumberWhereValueExpression,
"advAmountBase": NumberWhereValueExpression,
"actualAmountCurr": NumberWhereValueExpression,
"actualAmountBase": NumberWhereValueExpression,
"entryDateLocal": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"actualExchangeRate": NumberWhereValueExpression,
"vendorType": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"advanceAmountPaidCurr": NumberWhereValueExpression,
"agentDueAmountCurr": NumberWhereValueExpression,
"payeeShortName": StringWhereValueExpression,
"cargoName": CargoNameFormQueryWhere,
"vendor": AddressBookFormQueryWhere,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"vessel": VesselFormQueryWhere,
"payee": AddressBookFormQueryWhere,
"portAgent": VoyagePortAgentFormQueryWhere,
"firstAdvanceInvoiceDetails": OperationsInvoiceDetailsFormQueryWhere,
"firstAdvanceInvoice": OperationsInvoiceFormQueryWhere,
"firstAdvancePayDetails": OperationsPaymentDetailsFormQueryWhere,
"firstFinalInvoiceDetails": OperationsInvoiceDetailsFormQueryWhere,
"firstFinalInvoice": OperationsInvoiceFormQueryWhere,
"firstFinalPayDetails": OperationsPaymentDetailsFormQueryWhere
}
PortExpenseMiscDetails
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
estimatedTax - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
actualTax - Float
|
|
invoiceDetailsSeq - Int
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
portSeqNo - Int
|
|
aPRAmount1 - Float
|
|
aPRAmount2 - Float
|
|
aPRAmount3 - Float
|
|
aPRAmount4 - Float
|
|
cargo1 - String
|
|
cargo2 - String
|
|
cargo3 - String
|
|
cargo4 - String
|
|
cargo5 - String
|
|
cargo6 - String
|
|
cargo7 - String
|
|
cargo8 - String
|
|
cargo9 - String
|
|
pDAAmount - Float
|
|
actualAmount - Float
|
|
estimatedTaxRate - Float
|
|
actualTaxRate - Float
|
|
description - String
|
|
comment - String
|
|
seqNo - Int
|
|
subSeqNo - Int
|
|
lastUpdateGmt - Date
|
|
voyageItinerary - VoyageItinerary
|
|
firstOperationsInvoiceDetails - OperationsInvoiceDetails
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"estimatedTax": 123.45,
"customFieldByID": Any,
"customField": Any,
"actualTax": 987.65,
"invoiceDetailsSeq": 987,
"vesselCode": "xyz789",
"voyageNo": 987,
"portSeqNo": 987,
"aPRAmount1": 123.45,
"aPRAmount2": 987.65,
"aPRAmount3": 987.65,
"aPRAmount4": 123.45,
"cargo1": "abc123",
"cargo2": "abc123",
"cargo3": "xyz789",
"cargo4": "abc123",
"cargo5": "xyz789",
"cargo6": "xyz789",
"cargo7": "xyz789",
"cargo8": "abc123",
"cargo9": "xyz789",
"pDAAmount": 987.65,
"actualAmount": 987.65,
"estimatedTaxRate": 987.65,
"actualTaxRate": 123.45,
"description": "xyz789",
"comment": "xyz789",
"seqNo": 123,
"subSeqNo": 987,
"lastUpdateGmt": "2007-12-03",
"voyageItinerary": VoyageItinerary,
"firstOperationsInvoiceDetails": OperationsInvoiceDetails,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
PortExpenseMiscDetailsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PortExpenseMiscDetailsFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PortExpenseMiscDetailsFormQueryWhere
}
PortExpenseMiscDetailsFormQueryWhere
Fields
Example
{
"and": [PortExpenseMiscDetailsFormQueryWhere],
"or": [PortExpenseMiscDetailsFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"portSeqNo": NumberWhereValueExpression,
"aPRAmount1": NumberWhereValueExpression,
"aPRAmount2": NumberWhereValueExpression,
"aPRAmount3": NumberWhereValueExpression,
"aPRAmount4": NumberWhereValueExpression,
"cargo1": StringWhereValueExpression,
"cargo2": StringWhereValueExpression,
"cargo3": StringWhereValueExpression,
"cargo4": StringWhereValueExpression,
"cargo5": StringWhereValueExpression,
"cargo6": StringWhereValueExpression,
"cargo7": StringWhereValueExpression,
"cargo8": StringWhereValueExpression,
"cargo9": StringWhereValueExpression,
"pDAAmount": NumberWhereValueExpression,
"actualAmount": NumberWhereValueExpression,
"estimatedTaxRate": NumberWhereValueExpression,
"actualTaxRate": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"comment": StringWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"subSeqNo": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"firstOperationsInvoiceDetails": OperationsInvoiceDetailsFormQueryWhere
}
PortExpenseMiscDetailsRelationships
Fields
| Field Name | Description |
|---|---|
voyageItinerary - RelationshipDefinition
|
|
firstOperationsInvoiceDetails - RelationshipDefinition
|
Example
{
"voyageItinerary": RelationshipDefinition,
"firstOperationsInvoiceDetails": RelationshipDefinition
}
PortExpenseRelationships
Fields
| Field Name | Description |
|---|---|
cargoName - RelationshipDefinition
|
|
vendor - RelationshipDefinition
|
|
voyageItinerary - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
payee - RelationshipDefinition
|
|
portAgent - RelationshipDefinition
|
|
firstAdvanceInvoiceDetails - RelationshipDefinition
|
|
firstAdvanceInvoice - RelationshipDefinition
|
|
firstAdvancePayDetails - RelationshipDefinition
|
|
firstFinalInvoiceDetails - RelationshipDefinition
|
|
firstFinalInvoice - RelationshipDefinition
|
|
firstFinalPayDetails - RelationshipDefinition
|
|
advanceInvoiceDetails - RelationshipDefinition
|
|
advancePayDetails - RelationshipDefinition
|
|
finalInvoiceDetails - RelationshipDefinition
|
|
finalPayDetails - RelationshipDefinition
|
|
portExpenseMiscDetails - RelationshipDefinition
|
Example
{
"cargoName": RelationshipDefinition,
"vendor": RelationshipDefinition,
"voyageItinerary": RelationshipDefinition,
"voyage": RelationshipDefinition,
"vessel": RelationshipDefinition,
"payee": RelationshipDefinition,
"portAgent": RelationshipDefinition,
"firstAdvanceInvoiceDetails": RelationshipDefinition,
"firstAdvanceInvoice": RelationshipDefinition,
"firstAdvancePayDetails": RelationshipDefinition,
"firstFinalInvoiceDetails": RelationshipDefinition,
"firstFinalInvoice": RelationshipDefinition,
"firstFinalPayDetails": RelationshipDefinition,
"advanceInvoiceDetails": RelationshipDefinition,
"advancePayDetails": RelationshipDefinition,
"finalInvoiceDetails": RelationshipDefinition,
"finalPayDetails": RelationshipDefinition,
"portExpenseMiscDetails": RelationshipDefinition
}
PortExpenseStandardDetail
Fields
| Field Name | Description |
|---|---|
iD - Int
|
|
orderNo - Int
|
|
ledgerCode - String
|
|
expenseCode - Int
|
|
rate - Float
|
|
rateCurrency - String
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
minAmount - Float
|
|
maxAmount - Float
|
|
vesselLaden - String
|
|
currency - Currency
|
|
expense - Expense
|
|
portExpensesStandard - PortExpensesStandard
|
|
ledger - OperationsLedger
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"iD": 123,
"orderNo": 987,
"ledgerCode": "xyz789",
"expenseCode": 987,
"rate": 123.45,
"rateCurrency": "abc123",
"lastUser": "xyz789",
"lastUpdateGmt": "2007-12-03",
"minAmount": 987.65,
"maxAmount": 987.65,
"vesselLaden": "abc123",
"currency": Currency,
"expense": Expense,
"portExpensesStandard": PortExpensesStandard,
"ledger": OperationsLedger,
"_id": "xyz789",
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
PortExpenseStandardDetailFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PortExpenseStandardDetailFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PortExpenseStandardDetailFormQueryWhere
}
PortExpenseStandardDetailFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PortExpenseStandardDetailFormQueryWhere!]
|
|
or - [PortExpenseStandardDetailFormQueryWhere!]
|
|
rawExpression - String
|
|
iD - NumberWhereValueExpression
|
|
orderNo - NumberWhereValueExpression
|
|
ledgerCode - StringWhereValueExpression
|
|
expenseCode - NumberWhereValueExpression
|
|
rate - NumberWhereValueExpression
|
|
rateCurrency - StringWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
minAmount - NumberWhereValueExpression
|
|
maxAmount - NumberWhereValueExpression
|
|
vesselLaden - PortExpenseStandardDetailVesselLadenEnumValueExpression
|
|
currency - CurrencyFormQueryWhere
|
|
expense - ExpenseFormQueryWhere
|
|
portExpensesStandard - PortExpensesStandardFormQueryWhere
|
|
ledger - OperationsLedgerFormQueryWhere
|
Example
{
"and": [PortExpenseStandardDetailFormQueryWhere],
"or": [PortExpenseStandardDetailFormQueryWhere],
"rawExpression": "abc123",
"iD": NumberWhereValueExpression,
"orderNo": NumberWhereValueExpression,
"ledgerCode": StringWhereValueExpression,
"expenseCode": NumberWhereValueExpression,
"rate": NumberWhereValueExpression,
"rateCurrency": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"minAmount": NumberWhereValueExpression,
"maxAmount": NumberWhereValueExpression,
"vesselLaden": PortExpenseStandardDetailVesselLadenEnumValueExpression,
"currency": CurrencyFormQueryWhere,
"expense": ExpenseFormQueryWhere,
"portExpensesStandard": PortExpensesStandardFormQueryWhere,
"ledger": OperationsLedgerFormQueryWhere
}
PortExpenseStandardDetailRelationships
Fields
| Field Name | Description |
|---|---|
currency - RelationshipDefinition
|
|
expense - RelationshipDefinition
|
|
portExpensesStandard - RelationshipDefinition
|
|
ledger - RelationshipDefinition
|
Example
{
"currency": RelationshipDefinition,
"expense": RelationshipDefinition,
"portExpensesStandard": RelationshipDefinition,
"ledger": RelationshipDefinition
}
PortExpenseStandardDetailVesselLadenEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BallastOrLaden"
PortExpenseStandardDetailVesselLadenEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - PortExpenseStandardDetailVesselLadenEnum
|
|
isNot - PortExpenseStandardDetailVesselLadenEnum
|
|
isIn - [PortExpenseStandardDetailVesselLadenEnum]
|
Example
{"is": "BallastOrLaden", "isNot": "BallastOrLaden", "isIn": ["BallastOrLaden"]}
PortExpensesInput
Description
Submits a PortExpenses transaction
Fields
| Input Field | Description |
|---|---|
invoiceNo - String
|
|
invoiceDate - Date
|
|
accountingDate - Date
|
|
dueDate - Date
|
|
curr - String
|
|
exchangeRate - Float
|
|
amountCurr - Float
|
|
remarks - String
|
|
paymentTermsCode - String
|
|
financialsInvoiceDetails - [PortExpenses_FinancialsInvoiceDetailsInput]!
|
|
voyageNo - Float
|
|
vesselCode - String
|
|
portCallSeq - Float
|
|
agentCompanyIdentifier - String
|
|
portExpensesStatus - PortExpenses_PortExpensesStatus
|
|
reference - String
|
|
autoPost - Boolean
|
|
state - String
|
|
invoiceType - String
|
|
simplePayment - [PortExpenses_SimplePaymentInput]
|
Example
{
"invoiceNo": "xyz789",
"invoiceDate": "2007-12-03",
"accountingDate": "2007-12-03",
"dueDate": "2007-12-03",
"curr": "xyz789",
"exchangeRate": 123.45,
"amountCurr": 123.45,
"remarks": "abc123",
"paymentTermsCode": "xyz789",
"financialsInvoiceDetails": [
PortExpenses_FinancialsInvoiceDetailsInput
],
"voyageNo": 987.65,
"vesselCode": "xyz789",
"portCallSeq": 987.65,
"agentCompanyIdentifier": "abc123",
"portExpensesStatus": "Advance",
"reference": "abc123",
"autoPost": false,
"state": "xyz789",
"invoiceType": "abc123",
"simplePayment": [PortExpenses_SimplePaymentInput]
}
PortExpensesMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "abc123",
"debug": true,
"context": ["abc123"],
"timestamp": "abc123",
"originalTimestamp": "abc123",
"intent": "xyz789",
"from": "xyz789",
"to": ["abc123"],
"fromUser": "xyz789",
"status": "xyz789",
"approvalStatus": "xyz789",
"objectId": "abc123",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "abc123",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "abc123",
"unmapped": true,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["abc123"],
"parentMessageId": "xyz789",
"preResolutionObjectId": "abc123",
"title": "abc123",
"effectiveDate": "xyz789",
"source": "abc123",
"sourceId": "xyz789",
"threadId": "xyz789",
"links": [MessageLinkOutput],
"retrieveWarnings": ["abc123"],
"isLatest": true,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
PortExpensesStandard
Fields
| Field Name | Description |
|---|---|
portNameStr - String
|
|
expenseType - String
|
|
iD - Int
|
|
portNo - Int
|
|
berthShortName - String
|
|
vesselType - String
|
|
portFuncCode - String
|
|
cargoGroupType - String
|
|
effectiveFromGmt - Date
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
cargoType - CargoType
|
|
portFunction - PortFunction
|
|
portBerth - PortBerth
|
|
port - Port
|
|
vesselTypeType - VesselType
|
|
lDIPPortFunction - PortFunction
|
|
portExpenseStandardDetails - [PortExpenseStandardDetail]
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"portNameStr": "xyz789",
"expenseType": "abc123",
"iD": 987,
"portNo": 123,
"berthShortName": "xyz789",
"vesselType": "abc123",
"portFuncCode": "xyz789",
"cargoGroupType": "abc123",
"effectiveFromGmt": "2007-12-03",
"lastUser": "xyz789",
"lastUpdateGmt": "2007-12-03",
"cargoType": CargoType,
"portFunction": PortFunction,
"portBerth": PortBerth,
"port": Port,
"vesselTypeType": VesselType,
"lDIPPortFunction": PortFunction,
"portExpenseStandardDetails": [
PortExpenseStandardDetail
],
"_id": "abc123",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
PortExpensesStandardFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PortExpensesStandardFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PortExpensesStandardFormQueryWhere
}
PortExpensesStandardFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PortExpensesStandardFormQueryWhere!]
|
|
or - [PortExpensesStandardFormQueryWhere!]
|
|
rawExpression - String
|
|
iD - NumberWhereValueExpression
|
|
portNo - NumberWhereValueExpression
|
|
berthShortName - StringWhereValueExpression
|
|
vesselType - StringWhereValueExpression
|
|
portFuncCode - StringWhereValueExpression
|
|
cargoGroupType - StringWhereValueExpression
|
|
effectiveFromGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
cargoType - CargoTypeFormQueryWhere
|
|
portFunction - PortFunctionFormQueryWhere
|
|
portBerth - PortBerthFormQueryWhere
|
|
port - PortFormQueryWhere
|
|
vesselTypeType - VesselTypeFormQueryWhere
|
|
lDIPPortFunction - PortFunctionFormQueryWhere
|
Example
{
"and": [PortExpensesStandardFormQueryWhere],
"or": [PortExpensesStandardFormQueryWhere],
"rawExpression": "abc123",
"iD": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"berthShortName": StringWhereValueExpression,
"vesselType": StringWhereValueExpression,
"portFuncCode": StringWhereValueExpression,
"cargoGroupType": StringWhereValueExpression,
"effectiveFromGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"cargoType": CargoTypeFormQueryWhere,
"portFunction": PortFunctionFormQueryWhere,
"portBerth": PortBerthFormQueryWhere,
"port": PortFormQueryWhere,
"vesselTypeType": VesselTypeFormQueryWhere,
"lDIPPortFunction": PortFunctionFormQueryWhere
}
PortExpensesStandardRelationships
Fields
| Field Name | Description |
|---|---|
cargoType - RelationshipDefinition
|
|
portFunction - RelationshipDefinition
|
|
portBerth - RelationshipDefinition
|
|
port - RelationshipDefinition
|
|
vesselTypeType - RelationshipDefinition
|
|
lDIPPortFunction - RelationshipDefinition
|
|
portExpenseStandardDetails - RelationshipDefinition
|
Example
{
"cargoType": RelationshipDefinition,
"portFunction": RelationshipDefinition,
"portBerth": RelationshipDefinition,
"port": RelationshipDefinition,
"vesselTypeType": RelationshipDefinition,
"lDIPPortFunction": RelationshipDefinition,
"portExpenseStandardDetails": RelationshipDefinition
}
PortExpenses_FinancialsInvoiceDetailsInput
PortExpenses_PortExpensesStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Advance"
PortExpenses_SimplePaymentInput
PortFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PortFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PortFormQueryWhere
}
PortFormQueryWhere
Fields
Example
{
"and": [PortFormQueryWhere],
"or": [PortFormQueryWhere],
"rawExpression": "xyz789",
"portNo": NumberWhereValueExpression,
"vesonID": NumberWhereValueExpression,
"fairplayID": NumberWhereValueExpression,
"country": StringWhereValueExpression,
"name": StringWhereValueExpression,
"longitude": StringWhereValueExpression,
"latitude": StringWhereValueExpression,
"altNo": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"state": StringWhereValueExpression,
"timeZoneCode": StringWhereValueExpression,
"unCode": StringWhereValueExpression,
"bunkerPort": BoolWhereValueExpression,
"singleBerth": BoolWhereValueExpression,
"remarks": StringWhereValueExpression,
"dist50Area": StringWhereValueExpression,
"portRegion": StringWhereValueExpression,
"area": StringWhereValueExpression,
"waterwaySystem": StringWhereValueExpression,
"externalRef": StringWhereValueExpression,
"waterwayCode": StringWhereValueExpression,
"waterwayMarker": NumberWhereValueExpression,
"regionCode": StringWhereValueExpression,
"inactive": BoolWhereValueExpression,
"rangePort": BoolWhereValueExpression,
"countryPort": BoolWhereValueExpression,
"noDist": BoolWhereValueExpression,
"lowSulfur": BoolWhereValueExpression,
"lighterPort": BoolWhereValueExpression,
"piracyArea": BoolWhereValueExpression,
"projectionPort": BoolWhereValueExpression,
"isEcaZone": BoolWhereValueExpression,
"isPilotageArea": BoolWhereValueExpression,
"highSulfurOverride": BoolWhereValueExpression,
"ecaInPortOnly": BoolWhereValueExpression,
"hidePassingPointEta": BoolWhereValueExpression,
"isPilotStation": BoolWhereValueExpression,
"isEuEtsPortOfCall": BoolWhereValueExpression,
"isOutermostRegion": BoolWhereValueExpression,
"isEuEtsExclusion": BoolWhereValueExpression,
"flags": NumberWhereValueExpression,
"minBodyLength": NumberWhereValueExpression,
"maxDisplacement": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"operatorEmail": StringWhereValueExpression,
"operatorCompanyNo": NumberWhereValueExpression,
"alerts": StringWhereValueExpression,
"nextPortNo": NumberWhereValueExpression,
"bargeComments": StringWhereValueExpression,
"productComments": StringWhereValueExpression,
"portComments": StringWhereValueExpression,
"city": StringWhereValueExpression,
"holidayCode": StringWhereValueExpression,
"loadlineZone": StringWhereValueExpression,
"longitudeSeconds": NumberWhereValueExpression,
"latitudeSeconds": NumberWhereValueExpression,
"supportedScrubberType": PortSupportedScrubberTypeEnumValueExpression,
"parentCountry": StringWhereValueExpression,
"operatorCompanyData": AddressBookFormQueryWhere,
"countryData": CountryFormQueryWhere,
"timeZoneData": TimeZoneCodesFormQueryWhere,
"waterway": WaterwayFormQueryWhere,
"aliasParentPort": PortFormQueryWhere
}
PortFuelAvailability
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
fuelGradeCode - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
portNo - Int
|
|
fuelType - String
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
fuelLubeType - FuelLubeType
|
|
port - Port
|
|
fuelGrade - Term
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"fuelGradeCode": 123,
"customFieldByID": Any,
"customField": Any,
"portNo": 123,
"fuelType": "abc123",
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"fuelLubeType": FuelLubeType,
"port": Port,
"fuelGrade": Term,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
PortFuelAvailabilityFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PortFuelAvailabilityFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PortFuelAvailabilityFormQueryWhere
}
PortFuelAvailabilityFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PortFuelAvailabilityFormQueryWhere!]
|
|
or - [PortFuelAvailabilityFormQueryWhere!]
|
|
rawExpression - String
|
|
fuelGradeCode - NumberWhereValueExpression
|
|
portNo - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
fuelLubeType - FuelLubeTypeFormQueryWhere
|
|
port - PortFormQueryWhere
|
|
fuelGrade - TermFormQueryWhere
|
Example
{
"and": [PortFuelAvailabilityFormQueryWhere],
"or": [PortFuelAvailabilityFormQueryWhere],
"rawExpression": "abc123",
"fuelGradeCode": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"fuelLubeType": FuelLubeTypeFormQueryWhere,
"port": PortFormQueryWhere,
"fuelGrade": TermFormQueryWhere
}
PortFuelAvailabilityRelationships
Fields
| Field Name | Description |
|---|---|
fuelLubeType - RelationshipDefinition
|
|
port - RelationshipDefinition
|
|
fuelGrade - RelationshipDefinition
|
Example
{
"fuelLubeType": RelationshipDefinition,
"port": RelationshipDefinition,
"fuelGrade": RelationshipDefinition
}
PortFunction
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
name - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
code - String
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"name": "xyz789",
"customFieldByID": Any,
"customField": Any,
"code": "xyz789",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
PortFunctionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PortFunctionFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PortFunctionFormQueryWhere
}
PortFunctionFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PortFunctionFormQueryWhere!]
|
|
or - [PortFunctionFormQueryWhere!]
|
|
rawExpression - String
|
|
name - StringWhereValueExpression
|
|
code - StringWhereValueExpression
|
Example
{
"and": [PortFunctionFormQueryWhere],
"or": [PortFunctionFormQueryWhere],
"rawExpression": "abc123",
"name": StringWhereValueExpression,
"code": StringWhereValueExpression
}
PortRelationships
Fields
| Field Name | Description |
|---|---|
operatorCompanyData - RelationshipDefinition
|
|
countryData - RelationshipDefinition
|
|
timeZoneData - RelationshipDefinition
|
|
waterway - RelationshipDefinition
|
|
aliasParentPort - RelationshipDefinition
|
|
portVesselBerths - RelationshipDefinition
|
|
portVessels - RelationshipDefinition
|
|
portFuelAvailabilities - RelationshipDefinition
|
|
portCargoCompatBerths - RelationshipDefinition
|
|
portCargoCompats - RelationshipDefinition
|
|
voyageActivityReports - RelationshipDefinition
|
|
berthBlockages - RelationshipDefinition
|
|
portBerths - RelationshipDefinition
|
|
aliasPorts - RelationshipDefinition
|
|
addressBookAgentPorts - RelationshipDefinition
|
Example
{
"operatorCompanyData": RelationshipDefinition,
"countryData": RelationshipDefinition,
"timeZoneData": RelationshipDefinition,
"waterway": RelationshipDefinition,
"aliasParentPort": RelationshipDefinition,
"portVesselBerths": RelationshipDefinition,
"portVessels": RelationshipDefinition,
"portFuelAvailabilities": RelationshipDefinition,
"portCargoCompatBerths": RelationshipDefinition,
"portCargoCompats": RelationshipDefinition,
"voyageActivityReports": RelationshipDefinition,
"berthBlockages": RelationshipDefinition,
"portBerths": RelationshipDefinition,
"aliasPorts": RelationshipDefinition,
"addressBookAgentPorts": RelationshipDefinition
}
PortSupportedScrubberTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"InfoNotAvailable"
PortSupportedScrubberTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - PortSupportedScrubberTypeEnum
|
|
isNot - PortSupportedScrubberTypeEnum
|
|
isIn - [PortSupportedScrubberTypeEnum]
|
Example
{
"is": "InfoNotAvailable",
"isNot": "InfoNotAvailable",
"isIn": ["InfoNotAvailable"]
}
PortVessel
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
portNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
vesselCode - String
|
|
referenceDate - Date
|
|
status - String
|
|
remarks - String
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
port - Port
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"portNo": 987,
"customFieldByID": Any,
"customField": Any,
"vesselCode": "xyz789",
"referenceDate": "2007-12-03",
"status": "xyz789",
"remarks": "abc123",
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"port": Port,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
PortVesselBerth
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
portNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
vesselCode - String
|
|
berthShortName - String
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
port - Port
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"portNo": 123,
"customFieldByID": Any,
"customField": Any,
"vesselCode": "xyz789",
"berthShortName": "xyz789",
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"port": Port,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
PortVesselBerthFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PortVesselBerthFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PortVesselBerthFormQueryWhere
}
PortVesselBerthFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PortVesselBerthFormQueryWhere!]
|
|
or - [PortVesselBerthFormQueryWhere!]
|
|
rawExpression - String
|
|
portNo - NumberWhereValueExpression
|
|
vesselCode - StringWhereValueExpression
|
|
berthShortName - StringWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
port - PortFormQueryWhere
|
Example
{
"and": [PortVesselBerthFormQueryWhere],
"or": [PortVesselBerthFormQueryWhere],
"rawExpression": "xyz789",
"portNo": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"berthShortName": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"port": PortFormQueryWhere
}
PortVesselBerthRelationships
Fields
| Field Name | Description |
|---|---|
port - RelationshipDefinition
|
Example
{"port": RelationshipDefinition}
PortVesselFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PortVesselFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PortVesselFormQueryWhere
}
PortVesselFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PortVesselFormQueryWhere!]
|
|
or - [PortVesselFormQueryWhere!]
|
|
rawExpression - String
|
|
portNo - NumberWhereValueExpression
|
|
vesselCode - StringWhereValueExpression
|
|
referenceDate - DateWhereValueExpression
|
|
status - PortVesselStatusEnumValueExpression
|
|
remarks - StringWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
port - PortFormQueryWhere
|
Example
{
"and": [PortVesselFormQueryWhere],
"or": [PortVesselFormQueryWhere],
"rawExpression": "xyz789",
"portNo": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"referenceDate": DateWhereValueExpression,
"status": PortVesselStatusEnumValueExpression,
"remarks": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"port": PortFormQueryWhere
}
PortVesselRelationships
Fields
| Field Name | Description |
|---|---|
port - RelationshipDefinition
|
Example
{"port": RelationshipDefinition}
PortVesselStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
PortVesselStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - PortVesselStatusEnum
|
|
isNot - PortVesselStatusEnum
|
|
isIn - [PortVesselStatusEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
Position
Fields
| Field Name | Description |
|---|---|
positionBasis - String
|
|
vesselName - String
|
|
vesselCode - String
|
|
vesselType - String
|
|
openVoyageNo - Int
|
|
openPortNo - Int
|
|
openDateLocal - Date
|
|
tcCode - String
|
|
companyCode - String
|
|
estimateID - String
|
|
worksheetID - Int
|
|
marketPositionID - String
|
|
worksheet - Worksheet
|
|
estimate - VoyageEstimate
|
|
openPort - Port
|
|
voyage - Voyage
|
|
timeCharter - TimeCharterContract
|
|
vessel - Vessel
|
|
vesselDetails - VesselDetails
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"positionBasis": "xyz789",
"vesselName": "xyz789",
"vesselCode": "xyz789",
"vesselType": "xyz789",
"openVoyageNo": 987,
"openPortNo": 123,
"openDateLocal": "2007-12-03",
"tcCode": "xyz789",
"companyCode": "abc123",
"estimateID": "abc123",
"worksheetID": 987,
"marketPositionID": "xyz789",
"worksheet": Worksheet,
"estimate": VoyageEstimate,
"openPort": Port,
"voyage": Voyage,
"timeCharter": TimeCharterContract,
"vessel": Vessel,
"vesselDetails": VesselDetails,
"_id": "xyz789",
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
PositionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - PositionFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": PositionFormQueryWhere
}
PositionFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [PositionFormQueryWhere!]
|
|
or - [PositionFormQueryWhere!]
|
|
rawExpression - String
|
|
positionBasis - PositionPositionBasisEnumValueExpression
|
|
vesselName - StringWhereValueExpression
|
|
vesselCode - StringWhereValueExpression
|
|
vesselType - StringWhereValueExpression
|
|
openVoyageNo - NumberWhereValueExpression
|
|
openPortNo - NumberWhereValueExpression
|
|
openDateLocal - DateWhereValueExpression
|
|
tcCode - StringWhereValueExpression
|
|
companyCode - StringWhereValueExpression
|
|
estimateID - StringWhereValueExpression
|
|
worksheetID - NumberWhereValueExpression
|
|
marketPositionID - StringWhereValueExpression
|
|
worksheet - WorksheetFormQueryWhere
|
|
estimate - VoyageEstimateFormQueryWhere
|
|
openPort - PortFormQueryWhere
|
|
voyage - VoyageFormQueryWhere
|
|
timeCharter - TimeCharterContractFormQueryWhere
|
|
vessel - VesselFormQueryWhere
|
|
vesselDetails - VesselDetailsFormQueryWhere
|
Example
{
"and": [PositionFormQueryWhere],
"or": [PositionFormQueryWhere],
"rawExpression": "xyz789",
"positionBasis": PositionPositionBasisEnumValueExpression,
"vesselName": StringWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"vesselType": StringWhereValueExpression,
"openVoyageNo": NumberWhereValueExpression,
"openPortNo": NumberWhereValueExpression,
"openDateLocal": DateWhereValueExpression,
"tcCode": StringWhereValueExpression,
"companyCode": StringWhereValueExpression,
"estimateID": StringWhereValueExpression,
"worksheetID": NumberWhereValueExpression,
"marketPositionID": StringWhereValueExpression,
"worksheet": WorksheetFormQueryWhere,
"estimate": VoyageEstimateFormQueryWhere,
"openPort": PortFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"timeCharter": TimeCharterContractFormQueryWhere,
"vessel": VesselFormQueryWhere,
"vesselDetails": VesselDetailsFormQueryWhere
}
PositionPositionBasisEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Undefined"
PositionPositionBasisEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - PositionPositionBasisEnum
|
|
isNot - PositionPositionBasisEnum
|
|
isIn - [PositionPositionBasisEnum]
|
Example
{"is": "Undefined", "isNot": "Undefined", "isIn": ["Undefined"]}
PositionRelationships
Fields
| Field Name | Description |
|---|---|
worksheet - RelationshipDefinition
|
|
estimate - RelationshipDefinition
|
|
openPort - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
timeCharter - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
vesselDetails - RelationshipDefinition
|
Example
{
"worksheet": RelationshipDefinition,
"estimate": RelationshipDefinition,
"openPort": RelationshipDefinition,
"voyage": RelationshipDefinition,
"timeCharter": RelationshipDefinition,
"vessel": RelationshipDefinition,
"vesselDetails": RelationshipDefinition
}
PositionReportInput
Description
Submits a Veslink PositionReport transaction
Fields
| Input Field | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
|
itinerarySeq - Int
|
|
reportType - String
|
|
latitude - String
|
|
longitude - String
|
|
remarks - String
|
|
reportedSpeed - Float
|
|
projectedSpeed - Float
|
|
orderedSpeed - Float
|
|
observedDistance - Int
|
|
distanceToGo - Int
|
|
averageSpeed - Float
|
|
badWeatherHours - Float
|
|
badWeatherDistance - Float
|
|
dwt - Float
|
|
headingDegrees - Int
|
|
headingDirection - String
|
|
engineDistance - Float
|
|
slippagePercentage - Float
|
|
engineLoadPercentage - Float
|
|
reportedSlipPercentage - Float
|
|
averageBhp - Float
|
|
averageRpm - Float
|
|
mainEngineHours - Float
|
|
mainEngineKwhr - Float
|
|
maxLdIndicator - Float
|
|
steamingHours - Float
|
|
boilerHours - Float
|
|
incineratorHours - Float
|
|
generator1Hrs - Float
|
|
generator2Hrs - Float
|
|
generator3Hrs - Float
|
|
generator4Hrs - Float
|
|
generator1Kwhr - Float
|
|
generator2Kwhr - Float
|
|
generator3Kwhr - Float
|
|
generator4Kwhr - Float
|
|
fwGeneratorHours - Float
|
|
freshWaterCons - Float
|
|
freshWaterRec - Float
|
|
freshWaterRob - Float
|
|
distilledWaterCons - Float
|
|
distilledWaterProd - Float
|
|
distilledWaterRec - Float
|
|
distilledWaterRob - Float
|
|
slopRec - Float
|
|
slopRob - Float
|
|
beaufortScaleNo - Int
|
|
windDirection - String
|
|
seaState - Int
|
|
seaDirection - String
|
|
seaTemp - String
|
|
seaHeight - Float
|
|
seaSwell - Int
|
|
swellDirection - String
|
|
swellHeight - Float
|
|
airTemp - String
|
|
barometricPressure - String
|
|
barometricMovement - String
|
|
currentSpeed - Float
|
|
currentDirection - String
|
|
currentLocationGaugeName - String
|
|
currentLocationWaterLevel - Float
|
|
currentLocationUOM - String
|
|
restrictedLocationGaugeName - String
|
|
restrictedLocationWaterLevel - Float
|
|
restrictedLocationUOM - String
|
|
displacement - Float
|
|
fwdDraft - Float
|
|
aftDraft - Float
|
|
midDraft - Float
|
|
portFwdDraft - Float
|
|
portAftDraft - Float
|
|
portMidDraft - Float
|
|
starboardFwdDraft - Float
|
|
starboardAftDraft - Float
|
|
starboardMidDraft - Float
|
|
salinity - Float
|
|
ballast - Float
|
|
crewStores - Float
|
|
lubes - Float
|
|
constant - Float
|
|
numberOfTugs - Int
|
|
positionNote - String
|
|
waterwayCode - String
|
|
cpStatus - Int
|
|
lngReadingType - String
|
|
isForcedBoilOff - Boolean
|
|
totalRevs - Float
|
|
masterLastName - String
|
|
masterFirstName - String
|
|
engineerLastName - String
|
|
engineerFirstName - String
|
|
fuelConsMode - String
|
|
gmsControlMode - String
|
|
loggedDistance - Float
|
|
cargoTempUnit - String
|
|
cargoTemperature - Float
|
|
draftUnit - String
|
|
itineraryPort - PositionReport_ItineraryPortInput
|
|
activityReportBunkerDetails - [PositionReport_ActivityReportBunkerDetailsInput]!
|
|
reportDate - Date
|
|
nextPortEta - Date
|
|
noonReportType - String
|
|
refPortName - String
|
|
isBunkering - Boolean
|
Example
{
"vesselCode": "abc123",
"voyageNo": 987,
"itinerarySeq": 987,
"reportType": "abc123",
"latitude": "abc123",
"longitude": "xyz789",
"remarks": "xyz789",
"reportedSpeed": 123.45,
"projectedSpeed": 123.45,
"orderedSpeed": 123.45,
"observedDistance": 123,
"distanceToGo": 123,
"averageSpeed": 123.45,
"badWeatherHours": 123.45,
"badWeatherDistance": 987.65,
"dwt": 987.65,
"headingDegrees": 123,
"headingDirection": "xyz789",
"engineDistance": 987.65,
"slippagePercentage": 987.65,
"engineLoadPercentage": 123.45,
"reportedSlipPercentage": 987.65,
"averageBhp": 123.45,
"averageRpm": 987.65,
"mainEngineHours": 123.45,
"mainEngineKwhr": 123.45,
"maxLdIndicator": 987.65,
"steamingHours": 987.65,
"boilerHours": 987.65,
"incineratorHours": 987.65,
"generator1Hrs": 123.45,
"generator2Hrs": 123.45,
"generator3Hrs": 123.45,
"generator4Hrs": 987.65,
"generator1Kwhr": 123.45,
"generator2Kwhr": 987.65,
"generator3Kwhr": 987.65,
"generator4Kwhr": 987.65,
"fwGeneratorHours": 987.65,
"freshWaterCons": 987.65,
"freshWaterRec": 987.65,
"freshWaterRob": 123.45,
"distilledWaterCons": 123.45,
"distilledWaterProd": 123.45,
"distilledWaterRec": 123.45,
"distilledWaterRob": 123.45,
"slopRec": 987.65,
"slopRob": 123.45,
"beaufortScaleNo": 987,
"windDirection": "abc123",
"seaState": 123,
"seaDirection": "abc123",
"seaTemp": "xyz789",
"seaHeight": 123.45,
"seaSwell": 987,
"swellDirection": "abc123",
"swellHeight": 987.65,
"airTemp": "abc123",
"barometricPressure": "xyz789",
"barometricMovement": "abc123",
"currentSpeed": 123.45,
"currentDirection": "xyz789",
"currentLocationGaugeName": "xyz789",
"currentLocationWaterLevel": 987.65,
"currentLocationUOM": "xyz789",
"restrictedLocationGaugeName": "abc123",
"restrictedLocationWaterLevel": 987.65,
"restrictedLocationUOM": "xyz789",
"displacement": 987.65,
"fwdDraft": 123.45,
"aftDraft": 987.65,
"midDraft": 987.65,
"portFwdDraft": 123.45,
"portAftDraft": 987.65,
"portMidDraft": 123.45,
"starboardFwdDraft": 987.65,
"starboardAftDraft": 987.65,
"starboardMidDraft": 987.65,
"salinity": 123.45,
"ballast": 987.65,
"crewStores": 987.65,
"lubes": 123.45,
"constant": 987.65,
"numberOfTugs": 123,
"positionNote": "abc123",
"waterwayCode": "xyz789",
"cpStatus": 123,
"lngReadingType": "xyz789",
"isForcedBoilOff": false,
"totalRevs": 123.45,
"masterLastName": "abc123",
"masterFirstName": "xyz789",
"engineerLastName": "xyz789",
"engineerFirstName": "abc123",
"fuelConsMode": "abc123",
"gmsControlMode": "xyz789",
"loggedDistance": 123.45,
"cargoTempUnit": "abc123",
"cargoTemperature": 123.45,
"draftUnit": "xyz789",
"itineraryPort": PositionReport_ItineraryPortInput,
"activityReportBunkerDetails": [
PositionReport_ActivityReportBunkerDetailsInput
],
"reportDate": "2007-12-03",
"nextPortEta": "2007-12-03",
"noonReportType": "abc123",
"refPortName": "xyz789",
"isBunkering": false
}
PositionReportMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "abc123",
"debug": false,
"context": ["abc123"],
"timestamp": "abc123",
"originalTimestamp": "abc123",
"intent": "abc123",
"from": "abc123",
"to": ["abc123"],
"fromUser": "xyz789",
"status": "abc123",
"approvalStatus": "xyz789",
"objectId": "xyz789",
"type": "xyz789",
"data": Json,
"applyTriggeredOn": "abc123",
"applyTriggeredBy": "abc123",
"previousData": Json,
"comment": "xyz789",
"unmapped": false,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["abc123"],
"parentMessageId": "xyz789",
"preResolutionObjectId": "xyz789",
"title": "xyz789",
"effectiveDate": "abc123",
"source": "xyz789",
"sourceId": "abc123",
"threadId": "xyz789",
"links": [MessageLinkOutput],
"retrieveWarnings": ["abc123"],
"isLatest": false,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "xyz789"
}
PositionReport_ActivityReportBunkerDetailsInput
Fields
| Input Field | Description |
|---|---|
fuelType - String
|
|
fuelRob - Float
|
|
fuelReceived - Float
|
|
mainEng - Float
|
|
auxEng - Float
|
|
badWeatherConsumption - Float
|
|
loadOrDisch - Float
|
|
maneuver - Float
|
|
propulsion - Float
|
|
deballast - Float
|
|
igs - Float
|
|
generator - Float
|
|
heat - Float
|
|
boiler - Float
|
|
incinerator - Float
|
|
others - Float
|
|
clean - Float
|
|
heatPlus - Float
|
|
heatPlusPlus - Float
|
|
cooling - Float
|
|
idleorOn - Float
|
|
idleorOff - Float
|
|
pilotFlame - Float
|
|
sulfurContentPct_0 - Float
|
|
sulfurContentRob_0 - Float
|
|
sulfurContentPct_1 - Float
|
|
sulfurContentRob_1 - Float
|
|
sulfurContentPct_2 - Float
|
|
sulfurContentRob_2 - Float
|
|
fuelConsumed - Float
|
Example
{
"fuelType": "xyz789",
"fuelRob": 987.65,
"fuelReceived": 987.65,
"mainEng": 987.65,
"auxEng": 987.65,
"badWeatherConsumption": 123.45,
"loadOrDisch": 123.45,
"maneuver": 987.65,
"propulsion": 123.45,
"deballast": 987.65,
"igs": 123.45,
"generator": 987.65,
"heat": 987.65,
"boiler": 987.65,
"incinerator": 123.45,
"others": 987.65,
"clean": 987.65,
"heatPlus": 123.45,
"heatPlusPlus": 987.65,
"cooling": 987.65,
"idleorOn": 123.45,
"idleorOff": 123.45,
"pilotFlame": 123.45,
"sulfurContentPct_0": 123.45,
"sulfurContentRob_0": 987.65,
"sulfurContentPct_1": 123.45,
"sulfurContentRob_1": 123.45,
"sulfurContentPct_2": 987.65,
"sulfurContentRob_2": 987.65,
"fuelConsumed": 123.45
}
PositionReport_ItineraryPortInput
PriceInfo
PriceRequest
ProcessCargoHandlingListRequest
Fields
| Input Field | Description |
|---|---|
cargoHandlingList - CargoHandlingListInput
|
|
voyage - VoyageApiVoyageInput
|
Example
{
"cargoHandlingList": CargoHandlingListInput,
"voyage": VoyageApiVoyageInput
}
ProcessCargoHandlingListResult
Fields
| Field Name | Description |
|---|---|
result - VoyageApiVoyage
|
|
errors - [String!]
|
|
warnings - [String!]
|
Example
{
"result": VoyageApiVoyage,
"errors": ["abc123"],
"warnings": ["abc123"]
}
ProcessDelayRequest
Fields
| Input Field | Description |
|---|---|
delay - DelayInput
|
|
voyage - VoyageApiVoyageInput
|
Example
{
"delay": DelayInput,
"voyage": VoyageApiVoyageInput
}
ProcessDelayResult
Fields
| Field Name | Description |
|---|---|
result - VoyageApiVoyage
|
|
errors - [String!]
|
|
warnings - [String!]
|
Example
{
"result": VoyageApiVoyage,
"errors": ["abc123"],
"warnings": ["abc123"]
}
ProcessEtaEtdRequest
Fields
| Input Field | Description |
|---|---|
etaEtd - EtaEtdInput
|
|
voyage - VoyageApiVoyageInput
|
Example
{
"etaEtd": EtaEtdInput,
"voyage": VoyageApiVoyageInput
}
ProcessEtaEtdResult
Fields
| Field Name | Description |
|---|---|
result - VoyageApiVoyage
|
|
errors - [String!]
|
|
warnings - [String!]
|
Example
{
"result": VoyageApiVoyage,
"errors": ["xyz789"],
"warnings": ["abc123"]
}
ProcessPortActivityListRequest
Fields
| Input Field | Description |
|---|---|
portActivityList - PortActivityListInput
|
|
voyage - VoyageApiVoyageInput
|
Example
{
"portActivityList": PortActivityListInput,
"voyage": VoyageApiVoyageInput
}
ProcessPortActivityListResult
Fields
| Field Name | Description |
|---|---|
result - VoyageApiVoyage
|
|
errors - [String!]
|
|
warnings - [String!]
|
Example
{
"result": VoyageApiVoyage,
"errors": ["abc123"],
"warnings": ["abc123"]
}
ProcessPositionReportRequest
Fields
| Input Field | Description |
|---|---|
positionReport - VoyageApiPositionReportInput
|
|
voyage - VoyageApiVoyageInput
|
Example
{
"positionReport": VoyageApiPositionReportInput,
"voyage": VoyageApiVoyageInput
}
ProcessPositionReportResult
Fields
| Field Name | Description |
|---|---|
result - VoyageApiVoyage
|
|
errors - [String!]
|
|
warnings - [String!]
|
Example
{
"result": VoyageApiVoyage,
"errors": ["abc123"],
"warnings": ["abc123"]
}
ProcessUpcomingPortsListRequest
Fields
| Input Field | Description |
|---|---|
upcomingPortsList - VoyageApi_UpcomingPortsListInput
|
|
voyage - VoyageApiVoyageInput
|
Example
{
"upcomingPortsList": VoyageApi_UpcomingPortsListInput,
"voyage": VoyageApiVoyageInput
}
ProcessUpcomingPortsListResult
Fields
| Field Name | Description |
|---|---|
result - VoyageApiVoyage
|
|
errors - [String!]
|
|
warnings - [String!]
|
Example
{
"result": VoyageApiVoyage,
"errors": ["abc123"],
"warnings": ["xyz789"]
}
ProcessVeslinkFormRequest
Fields
| Input Field | Description |
|---|---|
veslinkForm - VoyageApiVeslinkFormInput
|
|
voyage - VoyageApiVoyageInput
|
Example
{
"veslinkForm": VoyageApiVeslinkFormInput,
"voyage": VoyageApiVoyageInput
}
ProcessVeslinkFormResult
Fields
| Field Name | Description |
|---|---|
result - VoyageApiVoyage
|
|
errors - [String!]
|
|
warnings - [String!]
|
Example
{
"result": VoyageApiVoyage,
"errors": ["abc123"],
"warnings": ["abc123"]
}
PublishActivityReportInput
Description
This message publishes an activity report to the specified party
Fields
| Input Field | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
|
reportType - String
|
|
reportDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
reportedSpeed - Float
|
|
averageSpeed - Float
|
|
distanceToGo - Int
|
|
engineDistance - Float
|
|
fwdDraft - Float
|
|
aftDraft - Float
|
|
latitude - String
|
|
longitude - String
|
|
headingDegrees - Int
|
|
windDirection - String
|
|
beaufortScaleNo - Int
|
|
seaTemp - String
|
|
seaSwell - Int
|
|
seaHeight - Float
|
|
seaDirection - String
|
|
currentSpeed - Float
|
|
currentDirection - String
|
|
currentLocationGaugeName - String
|
|
currentLocationWaterLevel - Float
|
|
currentLocationUOM - String
|
|
observedDistance - Int
|
|
projectedSpeed - Float
|
|
averageRpm - Float
|
|
engineLoadPercentage - Float
|
|
vessel - PublishActivityReport_VesselInput
|
|
activityReportBunkerDetails - [PublishActivityReport_ActivityReportBunkerDetailsInput]
|
Example
{
"vesselCode": "abc123",
"voyageNo": 987,
"reportType": "abc123",
"reportDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"reportedSpeed": 987.65,
"averageSpeed": 987.65,
"distanceToGo": 987,
"engineDistance": 987.65,
"fwdDraft": 987.65,
"aftDraft": 987.65,
"latitude": "abc123",
"longitude": "abc123",
"headingDegrees": 123,
"windDirection": "abc123",
"beaufortScaleNo": 987,
"seaTemp": "abc123",
"seaSwell": 123,
"seaHeight": 987.65,
"seaDirection": "abc123",
"currentSpeed": 987.65,
"currentDirection": "abc123",
"currentLocationGaugeName": "xyz789",
"currentLocationWaterLevel": 123.45,
"currentLocationUOM": "abc123",
"observedDistance": 123,
"projectedSpeed": 123.45,
"averageRpm": 123.45,
"engineLoadPercentage": 123.45,
"vessel": PublishActivityReport_VesselInput,
"activityReportBunkerDetails": [
PublishActivityReport_ActivityReportBunkerDetailsInput
]
}
PublishActivityReportMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "abc123",
"debug": false,
"context": ["xyz789"],
"timestamp": "abc123",
"originalTimestamp": "xyz789",
"intent": "xyz789",
"from": "abc123",
"to": ["abc123"],
"fromUser": "xyz789",
"status": "xyz789",
"approvalStatus": "abc123",
"objectId": "abc123",
"type": "xyz789",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "abc123",
"previousData": Json,
"comment": "xyz789",
"unmapped": true,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["xyz789"],
"parentMessageId": "abc123",
"preResolutionObjectId": "xyz789",
"title": "xyz789",
"effectiveDate": "abc123",
"source": "xyz789",
"sourceId": "xyz789",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["abc123"],
"isLatest": true,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
PublishActivityReport_ActivityReportBunkerDetailsInput
PublishActivityReport_VesselInput
PublishByIdInput
PublishInvoiceInput
Fields
| Input Field | Description |
|---|---|
vendorCompanyNo - Int
|
|
vendorFullName - String
|
|
invoiceNo - String
|
|
invoiceDate - Date
|
|
dueDate - Date
|
|
amountCurr - Float
|
|
exchangeRate - Float
|
|
exchangeRateDate - Date
|
|
externalRef - String
|
|
accountingDate - Date
|
|
curr - String
|
|
statusCode - String
|
|
paymentTermsCode - String
|
|
purchaseOrderNo - String
|
|
baseCurr - String
|
|
operationsInvoice - PublishInvoice_OperationsInvoiceInput!
|
|
financialsInvoiceDetails - [PublishInvoice_FinancialsInvoiceDetailsInput]!
|
|
attachments - [PublishInvoice_AttachmentsInput]
|
|
invoiceType - PublishInvoice_InvoiceType
|
|
billViaCompanyNo - Float
|
Example
{
"vendorCompanyNo": 123,
"vendorFullName": "xyz789",
"invoiceNo": "xyz789",
"invoiceDate": "2007-12-03",
"dueDate": "2007-12-03",
"amountCurr": 987.65,
"exchangeRate": 123.45,
"exchangeRateDate": "2007-12-03",
"externalRef": "xyz789",
"accountingDate": "2007-12-03",
"curr": "xyz789",
"statusCode": "xyz789",
"paymentTermsCode": "abc123",
"purchaseOrderNo": "abc123",
"baseCurr": "xyz789",
"operationsInvoice": PublishInvoice_OperationsInvoiceInput,
"financialsInvoiceDetails": [
PublishInvoice_FinancialsInvoiceDetailsInput
],
"attachments": [PublishInvoice_AttachmentsInput],
"invoiceType": "Freight",
"billViaCompanyNo": 987.65
}
PublishInvoiceMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": false,
"context": ["xyz789"],
"timestamp": "xyz789",
"originalTimestamp": "abc123",
"intent": "abc123",
"from": "abc123",
"to": ["abc123"],
"fromUser": "xyz789",
"status": "abc123",
"approvalStatus": "abc123",
"objectId": "abc123",
"type": "xyz789",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "abc123",
"previousData": Json,
"comment": "xyz789",
"unmapped": true,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["abc123"],
"parentMessageId": "abc123",
"preResolutionObjectId": "xyz789",
"title": "xyz789",
"effectiveDate": "xyz789",
"source": "xyz789",
"sourceId": "xyz789",
"threadId": "xyz789",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": false,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
PublishInvoice_AttachmentsInput
PublishInvoice_FinancialsInvoiceDetailsInput
Fields
| Input Field | Description |
|---|---|
seq - Int
|
|
operationBillCode - String
|
|
operationSubCode - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
portNo - Int
|
|
description - String
|
|
amountCurr - Float
|
|
amountBase - Float
|
|
companyCode - String
|
|
taxCode - String
|
|
portCallSeq - Float
|
|
ledgerExpenseCode - String
|
|
billedPercentage - Float
|
|
cargo - PublishInvoice_FinancialsInvoiceDetailsInput_CargoInput
|
|
departmentCode - String
|
Example
{
"seq": 987,
"operationBillCode": "abc123",
"operationSubCode": "xyz789",
"vesselCode": "xyz789",
"voyageNo": 123,
"portNo": 987,
"description": "xyz789",
"amountCurr": 123.45,
"amountBase": 987.65,
"companyCode": "xyz789",
"taxCode": "abc123",
"portCallSeq": 987.65,
"ledgerExpenseCode": "abc123",
"billedPercentage": 987.65,
"cargo": PublishInvoice_FinancialsInvoiceDetailsInput_CargoInput,
"departmentCode": "xyz789"
}
PublishInvoice_FinancialsInvoiceDetailsInput_CargoInput
PublishInvoice_InvoiceType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Freight"
PublishInvoice_OperationsInvoiceInput
Fields
| Input Field | Description |
|---|---|
statusCode - String
|
|
approvalStatus - String
|
|
remarks - String
|
|
approvalCode - PublishInvoice_OperationsInvoiceInput_ApprovalCode
|
Example
{
"statusCode": "xyz789",
"approvalStatus": "xyz789",
"remarks": "xyz789",
"approvalCode": "A"
}
PublishInvoice_OperationsInvoiceInput_ApprovalCode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"A"
PublishPositionInput
Fields
| Input Field | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
|
distanceToGo - Int
|
|
projectedSpeed - Float
|
|
latitude - String
|
|
longitude - String
|
|
headingDegrees - Int
|
|
waterwayCode - String
|
|
waterwayMarker - Int
|
|
voyageItinerary - PublishPosition_VoyageItineraryInput!
|
|
reportDate - Date
|
|
moveStatus - String
|
Example
{
"vesselCode": "xyz789",
"voyageNo": 987,
"distanceToGo": 123,
"projectedSpeed": 123.45,
"latitude": "abc123",
"longitude": "abc123",
"headingDegrees": 123,
"waterwayCode": "xyz789",
"waterwayMarker": 123,
"voyageItinerary": PublishPosition_VoyageItineraryInput,
"reportDate": "2007-12-03",
"moveStatus": "abc123"
}
PublishPositionMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": true,
"context": ["abc123"],
"timestamp": "xyz789",
"originalTimestamp": "abc123",
"intent": "xyz789",
"from": "abc123",
"to": ["xyz789"],
"fromUser": "xyz789",
"status": "xyz789",
"approvalStatus": "xyz789",
"objectId": "abc123",
"type": "xyz789",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "xyz789",
"unmapped": false,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["xyz789"],
"parentMessageId": "xyz789",
"preResolutionObjectId": "abc123",
"title": "abc123",
"effectiveDate": "abc123",
"source": "xyz789",
"sourceId": "xyz789",
"threadId": "xyz789",
"links": [MessageLinkOutput],
"retrieveWarnings": ["abc123"],
"isLatest": false,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "xyz789"
}
PublishPosition_VoyageItineraryInput
Fields
| Input Field | Description |
|---|---|
seq - Int
|
|
portNo - Int
|
|
portName - String
|
|
vessel - PublishPosition_VoyageItineraryInput_VesselInput
|
|
eta - Date
|
Example
{
"seq": 123,
"portNo": 123,
"portName": "abc123",
"vessel": PublishPosition_VoyageItineraryInput_VesselInput,
"eta": "2007-12-03"
}
PublishPosition_VoyageItineraryInput_VesselInput
Fields
| Input Field | Description |
|---|---|
imoNo - String
|
Example
{"imoNo": "abc123"}
PublishVoyageUpdateInput
Description
The message is for publishing current voyage information to the specified party
Fields
| Input Field | Description |
|---|---|
voyageNo - Int
|
|
vesselCode - String
|
|
commenceDateGmt - Date
|
|
completeDateGmt - Date
|
|
oprType - String
|
|
voyageStatus - String
|
|
vessel - PublishVoyageUpdate_VesselInput!
|
|
voyageItineraries - [PublishVoyageUpdate_VoyageItinerariesInput]!
|
Example
{
"voyageNo": 123,
"vesselCode": "xyz789",
"commenceDateGmt": "2007-12-03",
"completeDateGmt": "2007-12-03",
"oprType": "abc123",
"voyageStatus": "xyz789",
"vessel": PublishVoyageUpdate_VesselInput,
"voyageItineraries": [
PublishVoyageUpdate_VoyageItinerariesInput
]
}
PublishVoyageUpdateMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "abc123",
"debug": true,
"context": ["abc123"],
"timestamp": "abc123",
"originalTimestamp": "abc123",
"intent": "abc123",
"from": "abc123",
"to": ["xyz789"],
"fromUser": "xyz789",
"status": "abc123",
"approvalStatus": "xyz789",
"objectId": "xyz789",
"type": "xyz789",
"data": Json,
"applyTriggeredOn": "abc123",
"applyTriggeredBy": "abc123",
"previousData": Json,
"comment": "xyz789",
"unmapped": false,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["abc123"],
"parentMessageId": "abc123",
"preResolutionObjectId": "xyz789",
"title": "abc123",
"effectiveDate": "xyz789",
"source": "abc123",
"sourceId": "abc123",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": false,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "xyz789"
}
PublishVoyageUpdate_VesselInput
PublishVoyageUpdate_VoyageItinerariesInput
Fields
| Input Field | Description |
|---|---|
portNo - Int
|
|
portName - String
|
|
portFunc - String
|
|
seq - Int
|
|
order - Int
|
|
etaGmt - Date
|
|
etdGmt - Date
|
|
arrivalLocal - Date
|
|
departureLocal - Date
|
|
arrDepStatus - String
|
|
ballastLadenToPort - String
|
|
ballastLadenFromPort - String
|
|
voyageCargoHandlings - [PublishVoyageUpdate_VoyageItinerariesInput_VoyageCargoHandlingsInput]!
|
|
voyageItineraryBunkers - [PublishVoyageUpdate_VoyageItinerariesInput_VoyageItineraryBunkersInput]!
|
|
voyageItineraryBerths - [PublishVoyageUpdate_VoyageItinerariesInput_VoyageItineraryBerthsInput]!
|
Example
{
"portNo": 987,
"portName": "abc123",
"portFunc": "xyz789",
"seq": 987,
"order": 987,
"etaGmt": "2007-12-03",
"etdGmt": "2007-12-03",
"arrivalLocal": "2007-12-03",
"departureLocal": "2007-12-03",
"arrDepStatus": "xyz789",
"ballastLadenToPort": "abc123",
"ballastLadenFromPort": "abc123",
"voyageCargoHandlings": [
PublishVoyageUpdate_VoyageItinerariesInput_VoyageCargoHandlingsInput
],
"voyageItineraryBunkers": [
PublishVoyageUpdate_VoyageItinerariesInput_VoyageItineraryBunkersInput
],
"voyageItineraryBerths": [
PublishVoyageUpdate_VoyageItinerariesInput_VoyageItineraryBerthsInput
]
}
PublishVoyageUpdate_VoyageItinerariesInput_VoyageCargoHandlingsInput
Example
{
"cargoID": 987,
"cargoShortName": "xyz789",
"laycanToLocal": "2007-12-03",
"laycanFromLocal": "2007-12-03",
"terms": "abc123",
"blQuantity": 123.45
}
PublishVoyageUpdate_VoyageItinerariesInput_VoyageItineraryBerthsInput
PublishVoyageUpdate_VoyageItinerariesInput_VoyageItineraryBunkersInput
RecalculateVoyageRequest
Fields
| Input Field | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
|
voyage - VoyageApiVoyageInput
|
Example
{
"vesselCode": "xyz789",
"voyageNo": 123,
"voyage": VoyageApiVoyageInput
}
RecalculateVoyageResult
Fields
| Field Name | Description |
|---|---|
result - RecalculateVoyageResultVoyage
|
|
errors - [String!]
|
|
warnings - [String!]
|
Example
{
"result": RecalculateVoyageResultVoyage,
"errors": ["abc123"],
"warnings": ["abc123"]
}
RecalculateVoyageResultVoyage
Fields
| Field Name | Description |
|---|---|
initialVoyage - VoyageApiVoyage
|
|
updatedVoyage - VoyageApiVoyage
|
Example
{
"initialVoyage": VoyageApiVoyage,
"updatedVoyage": VoyageApiVoyage
}
Region
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
regionGUID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
regionTableUpdateMessages - [RegionTableUpdateMessageRecord]
|
|
Arguments
|
|
regionName - String
|
|
regionDefinitionJson - String
|
|
ownerUserNo - Int
|
|
changesSinceLast - RegionChangesSinceLast
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"regionGUID": "abc123",
"customFieldByID": Any,
"customField": Any,
"regionTableUpdateMessages": [
RegionTableUpdateMessageRecord
],
"regionName": "abc123",
"regionDefinitionJson": "abc123",
"ownerUserNo": 987,
"changesSinceLast": RegionChangesSinceLast,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
RegionChangesSinceLast
Fields
| Field Name | Description |
|---|---|
regionTableUpdate - MessageUpdateResponse
|
Example
{"regionTableUpdate": MessageUpdateResponse}
RegionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - RegionFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": RegionFormQueryWhere
}
RegionFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [RegionFormQueryWhere!]
|
|
or - [RegionFormQueryWhere!]
|
|
rawExpression - String
|
|
regionGUID - StringWhereValueExpression
|
|
regionName - StringWhereValueExpression
|
|
regionDefinitionJson - StringWhereValueExpression
|
|
ownerUserNo - NumberWhereValueExpression
|
Example
{
"and": [RegionFormQueryWhere],
"or": [RegionFormQueryWhere],
"rawExpression": "xyz789",
"regionGUID": StringWhereValueExpression,
"regionName": StringWhereValueExpression,
"regionDefinitionJson": StringWhereValueExpression,
"ownerUserNo": NumberWhereValueExpression
}
RegionTableUpdateInput
RegionTableUpdateMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "abc123",
"debug": true,
"context": ["abc123"],
"timestamp": "abc123",
"originalTimestamp": "xyz789",
"intent": "xyz789",
"from": "abc123",
"to": ["abc123"],
"fromUser": "abc123",
"status": "abc123",
"approvalStatus": "xyz789",
"objectId": "xyz789",
"type": "xyz789",
"data": Json,
"applyTriggeredOn": "abc123",
"applyTriggeredBy": "abc123",
"previousData": Json,
"comment": "abc123",
"unmapped": false,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["abc123"],
"parentMessageId": "abc123",
"preResolutionObjectId": "abc123",
"title": "xyz789",
"effectiveDate": "xyz789",
"source": "abc123",
"sourceId": "xyz789",
"threadId": "xyz789",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": true,
"threadCount": 987,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "xyz789"
}
RelationshipDefinition
Reminder
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tcCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
iD - String
|
|
type - String
|
|
recipients - String
|
|
contents - String
|
|
status - String
|
|
entryDateGmt - Date
|
|
lastUserID - String
|
|
lastUpdateGmt - Date
|
|
timeCharterContract - TimeCharterContract
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"tcCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"iD": "xyz789",
"type": "abc123",
"recipients": "abc123",
"contents": "xyz789",
"status": "abc123",
"entryDateGmt": "2007-12-03",
"lastUserID": "xyz789",
"lastUpdateGmt": "2007-12-03",
"timeCharterContract": TimeCharterContract,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
ReminderFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ReminderFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ReminderFormQueryWhere
}
ReminderFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [ReminderFormQueryWhere!]
|
|
or - [ReminderFormQueryWhere!]
|
|
rawExpression - String
|
|
iD - StringWhereValueExpression
|
|
type - ReminderTypeEnumValueExpression
|
|
recipients - StringWhereValueExpression
|
|
contents - StringWhereValueExpression
|
|
status - ReminderStatusEnumValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUserID - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
timeCharterContract - TimeCharterContractFormQueryWhere
|
Example
{
"and": [ReminderFormQueryWhere],
"or": [ReminderFormQueryWhere],
"rawExpression": "xyz789",
"iD": StringWhereValueExpression,
"type": ReminderTypeEnumValueExpression,
"recipients": StringWhereValueExpression,
"contents": StringWhereValueExpression,
"status": ReminderStatusEnumValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"timeCharterContract": TimeCharterContractFormQueryWhere
}
ReminderRelationships
Fields
| Field Name | Description |
|---|---|
timeCharterContract - RelationshipDefinition
|
Example
{"timeCharterContract": RelationshipDefinition}
ReminderStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Unsent"
ReminderStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - ReminderStatusEnum
|
|
isNot - ReminderStatusEnum
|
|
isIn - [ReminderStatusEnum]
|
Example
{"is": "Unsent", "isNot": "Unsent", "isIn": ["Unsent"]}
ReminderTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
ReminderTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - ReminderTypeEnum
|
|
isNot - ReminderTypeEnum
|
|
isIn - [ReminderTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
Report
Fields
| Field Name | Description |
|---|---|
reportID - String
|
|
title - String
|
|
subtitle - String
|
|
description - String
|
|
public - Int
|
|
module - String
|
|
dataSetName - String
|
|
body - String
|
|
ownerID - String
|
|
lastUpdateGmt - Date
|
|
lastRunGmt - Date
|
|
lastUserID - String
|
|
specImport - Int
|
|
specImportID - String
|
|
useAsTemplate - Boolean
|
|
batchID - String
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"reportID": "xyz789",
"title": "xyz789",
"subtitle": "abc123",
"description": "xyz789",
"public": 987,
"module": "xyz789",
"dataSetName": "xyz789",
"body": "abc123",
"ownerID": "abc123",
"lastUpdateGmt": "2007-12-03",
"lastRunGmt": "2007-12-03",
"lastUserID": "abc123",
"specImport": 987,
"specImportID": "xyz789",
"useAsTemplate": false,
"batchID": "abc123",
"_id": "xyz789",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
ReportFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ReportFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ReportFormQueryWhere
}
ReportFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [ReportFormQueryWhere!]
|
|
or - [ReportFormQueryWhere!]
|
|
rawExpression - String
|
|
reportID - StringWhereValueExpression
|
|
title - StringWhereValueExpression
|
|
subtitle - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
public - NumberWhereValueExpression
|
|
module - StringWhereValueExpression
|
|
dataSetName - StringWhereValueExpression
|
|
body - StringWhereValueExpression
|
|
ownerID - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastRunGmt - DateWhereValueExpression
|
|
lastUserID - StringWhereValueExpression
|
|
specImport - NumberWhereValueExpression
|
|
specImportID - StringWhereValueExpression
|
|
useAsTemplate - BoolWhereValueExpression
|
|
batchID - StringWhereValueExpression
|
Example
{
"and": [ReportFormQueryWhere],
"or": [ReportFormQueryWhere],
"rawExpression": "abc123",
"reportID": StringWhereValueExpression,
"title": StringWhereValueExpression,
"subtitle": StringWhereValueExpression,
"description": StringWhereValueExpression,
"public": NumberWhereValueExpression,
"module": StringWhereValueExpression,
"dataSetName": StringWhereValueExpression,
"body": StringWhereValueExpression,
"ownerID": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastRunGmt": DateWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"specImport": NumberWhereValueExpression,
"specImportID": StringWhereValueExpression,
"useAsTemplate": BoolWhereValueExpression,
"batchID": StringWhereValueExpression
}
ReportUserView
Fields
| Field Name | Description |
|---|---|
viewOwnerName - String
|
|
userViewID - String
|
|
baseViewID - String
|
|
viewOwner - Int
|
|
title - String
|
|
description - String
|
|
viewXml - String
|
|
isDefault - Boolean
|
|
isPublic - Boolean
|
|
isGroupAccess - Boolean
|
|
isVeslinkShare - Boolean
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
updateTimes - Int
|
|
user - User
|
|
reportView - ReportView
|
|
owner - User
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"viewOwnerName": "xyz789",
"userViewID": "xyz789",
"baseViewID": "abc123",
"viewOwner": 123,
"title": "xyz789",
"description": "xyz789",
"viewXml": "abc123",
"isDefault": true,
"isPublic": true,
"isGroupAccess": false,
"isVeslinkShare": true,
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"updateTimes": 987,
"user": User,
"reportView": ReportView,
"owner": User,
"_id": "xyz789",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
ReportUserViewFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ReportUserViewFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ReportUserViewFormQueryWhere
}
ReportUserViewFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [ReportUserViewFormQueryWhere!]
|
|
or - [ReportUserViewFormQueryWhere!]
|
|
rawExpression - String
|
|
userViewID - StringWhereValueExpression
|
|
baseViewID - StringWhereValueExpression
|
|
viewOwner - NumberWhereValueExpression
|
|
title - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
viewXml - StringWhereValueExpression
|
|
isDefault - BoolWhereValueExpression
|
|
isPublic - BoolWhereValueExpression
|
|
isGroupAccess - BoolWhereValueExpression
|
|
isVeslinkShare - BoolWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
updateTimes - NumberWhereValueExpression
|
|
user - UserFormQueryWhere
|
|
reportView - ReportViewFormQueryWhere
|
|
owner - UserFormQueryWhere
|
Example
{
"and": [ReportUserViewFormQueryWhere],
"or": [ReportUserViewFormQueryWhere],
"rawExpression": "xyz789",
"userViewID": StringWhereValueExpression,
"baseViewID": StringWhereValueExpression,
"viewOwner": NumberWhereValueExpression,
"title": StringWhereValueExpression,
"description": StringWhereValueExpression,
"viewXml": StringWhereValueExpression,
"isDefault": BoolWhereValueExpression,
"isPublic": BoolWhereValueExpression,
"isGroupAccess": BoolWhereValueExpression,
"isVeslinkShare": BoolWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"updateTimes": NumberWhereValueExpression,
"user": UserFormQueryWhere,
"reportView": ReportViewFormQueryWhere,
"owner": UserFormQueryWhere
}
ReportUserViewRelationships
Fields
| Field Name | Description |
|---|---|
user - RelationshipDefinition
|
|
reportView - RelationshipDefinition
|
|
owner - RelationshipDefinition
|
Example
{
"user": RelationshipDefinition,
"reportView": RelationshipDefinition,
"owner": RelationshipDefinition
}
ReportView
Fields
| Field Name | Description |
|---|---|
viewOwnerName - String
|
|
viewID - String
|
|
viewOwner - Int
|
|
title - String
|
|
description - String
|
|
viewXml - String
|
|
isDefault - Boolean
|
|
isPublic - Boolean
|
|
isEditable - Boolean
|
|
includeDescInPrintOut - Boolean
|
|
isGroupAccess - Boolean
|
|
isVeslinkFormsInImosReport - Boolean
|
|
isVeslinkShare - Boolean
|
|
isMiniSchemaReport - Boolean
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
updateTimes - Int
|
|
lastViewGmt - Date
|
|
subtitle - String
|
|
builtInReportName - String
|
|
refViewID - String
|
|
reportView - ReportView
|
|
user - User
|
|
owner - User
|
|
reportUserViews - [ReportUserView]
|
|
reportViews - [ReportView]
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"viewOwnerName": "xyz789",
"viewID": "xyz789",
"viewOwner": 123,
"title": "abc123",
"description": "abc123",
"viewXml": "abc123",
"isDefault": true,
"isPublic": true,
"isEditable": true,
"includeDescInPrintOut": true,
"isGroupAccess": true,
"isVeslinkFormsInImosReport": false,
"isVeslinkShare": false,
"isMiniSchemaReport": false,
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123",
"updateTimes": 123,
"lastViewGmt": "2007-12-03",
"subtitle": "xyz789",
"builtInReportName": "xyz789",
"refViewID": "xyz789",
"reportView": ReportView,
"user": User,
"owner": User,
"reportUserViews": [ReportUserView],
"reportViews": [ReportView],
"_id": "abc123",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
ReportViewFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ReportViewFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ReportViewFormQueryWhere
}
ReportViewFormQueryWhere
Fields
Example
{
"and": [ReportViewFormQueryWhere],
"or": [ReportViewFormQueryWhere],
"rawExpression": "xyz789",
"viewID": StringWhereValueExpression,
"viewOwner": NumberWhereValueExpression,
"title": StringWhereValueExpression,
"description": StringWhereValueExpression,
"viewXml": StringWhereValueExpression,
"isDefault": BoolWhereValueExpression,
"isPublic": BoolWhereValueExpression,
"isEditable": BoolWhereValueExpression,
"includeDescInPrintOut": BoolWhereValueExpression,
"isGroupAccess": BoolWhereValueExpression,
"isVeslinkFormsInImosReport": BoolWhereValueExpression,
"isVeslinkShare": BoolWhereValueExpression,
"isMiniSchemaReport": BoolWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"updateTimes": NumberWhereValueExpression,
"lastViewGmt": DateWhereValueExpression,
"subtitle": StringWhereValueExpression,
"builtInReportName": StringWhereValueExpression,
"refViewID": StringWhereValueExpression,
"reportView": ReportViewFormQueryWhere,
"user": UserFormQueryWhere,
"owner": UserFormQueryWhere
}
ReportViewRelationships
Fields
| Field Name | Description |
|---|---|
reportView - RelationshipDefinition
|
|
user - RelationshipDefinition
|
|
owner - RelationshipDefinition
|
|
reportUserViews - RelationshipDefinition
|
|
reportViews - RelationshipDefinition
|
Example
{
"reportView": RelationshipDefinition,
"user": RelationshipDefinition,
"owner": RelationshipDefinition,
"reportUserViews": RelationshipDefinition,
"reportViews": RelationshipDefinition
}
ReportsRootQuery
Fields
| Field Name | Description |
|---|---|
sccReport - SCCReport
|
|
Arguments
|
|
Example
{"sccReport": SCCReport}
ResultsTrace
Revision
Fields
| Field Name | Description |
|---|---|
transactionNo - Int
|
|
type - String
|
|
windowsUserName - String
|
|
machineID - String
|
|
updateTimeGmt - Date
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
portCallNo - Int
|
|
portNo - Int
|
|
referenceNo - String
|
|
remarks - String
|
|
unacknowledged - Boolean
|
|
bulkUpdate - Boolean
|
|
hideRevision - Boolean
|
|
berthSequenceNo - Int
|
|
portCargoNo - Int
|
|
parentTransactionNo - Int
|
|
imosUserName - String
|
|
imosUserNo - Int
|
|
updateOffset - Float
|
|
revisionRows - [RevisionRow]
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"transactionNo": 987,
"type": "abc123",
"windowsUserName": "xyz789",
"machineID": "abc123",
"updateTimeGmt": "2007-12-03",
"vesselCode": "abc123",
"voyageNo": 987,
"portCallNo": 987,
"portNo": 987,
"referenceNo": "xyz789",
"remarks": "abc123",
"unacknowledged": false,
"bulkUpdate": false,
"hideRevision": true,
"berthSequenceNo": 123,
"portCargoNo": 987,
"parentTransactionNo": 987,
"imosUserName": "xyz789",
"imosUserNo": 987,
"updateOffset": 123.45,
"revisionRows": [RevisionRow],
"_id": "abc123",
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
RevisionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - RevisionFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": RevisionFormQueryWhere
}
RevisionFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [RevisionFormQueryWhere!]
|
|
or - [RevisionFormQueryWhere!]
|
|
rawExpression - String
|
|
transactionNo - NumberWhereValueExpression
|
|
type - StringWhereValueExpression
|
|
windowsUserName - StringWhereValueExpression
|
|
machineID - StringWhereValueExpression
|
|
updateTimeGmt - DateWhereValueExpression
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
portCallNo - NumberWhereValueExpression
|
|
portNo - NumberWhereValueExpression
|
|
referenceNo - StringWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
unacknowledged - BoolWhereValueExpression
|
|
bulkUpdate - BoolWhereValueExpression
|
|
hideRevision - BoolWhereValueExpression
|
|
berthSequenceNo - NumberWhereValueExpression
|
|
portCargoNo - NumberWhereValueExpression
|
|
parentTransactionNo - NumberWhereValueExpression
|
|
imosUserName - StringWhereValueExpression
|
|
imosUserNo - NumberWhereValueExpression
|
|
updateOffset - NumberWhereValueExpression
|
Example
{
"and": [RevisionFormQueryWhere],
"or": [RevisionFormQueryWhere],
"rawExpression": "abc123",
"transactionNo": NumberWhereValueExpression,
"type": StringWhereValueExpression,
"windowsUserName": StringWhereValueExpression,
"machineID": StringWhereValueExpression,
"updateTimeGmt": DateWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"portCallNo": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"referenceNo": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"unacknowledged": BoolWhereValueExpression,
"bulkUpdate": BoolWhereValueExpression,
"hideRevision": BoolWhereValueExpression,
"berthSequenceNo": NumberWhereValueExpression,
"portCargoNo": NumberWhereValueExpression,
"parentTransactionNo": NumberWhereValueExpression,
"imosUserName": StringWhereValueExpression,
"imosUserNo": NumberWhereValueExpression,
"updateOffset": NumberWhereValueExpression
}
RevisionPanelContent
Fields
| Field Name | Description |
|---|---|
transactionNo - Int
|
|
updateTimeGmt - Date
|
|
referenceNo - String
|
|
imosUserName - String
|
|
objectType - String
|
|
revisionNo - Int
|
|
actionString - String
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"transactionNo": 123,
"updateTimeGmt": "2007-12-03",
"referenceNo": "abc123",
"imosUserName": "abc123",
"objectType": "xyz789",
"revisionNo": 987,
"actionString": "abc123",
"_id": "xyz789",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
RevisionPanelContentFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - RevisionPanelContentFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": RevisionPanelContentFormQueryWhere
}
RevisionPanelContentFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [RevisionPanelContentFormQueryWhere!]
|
|
or - [RevisionPanelContentFormQueryWhere!]
|
|
rawExpression - String
|
|
transactionNo - NumberWhereValueExpression
|
|
updateTimeGmt - DateWhereValueExpression
|
|
referenceNo - StringWhereValueExpression
|
|
imosUserName - StringWhereValueExpression
|
Example
{
"and": [RevisionPanelContentFormQueryWhere],
"or": [RevisionPanelContentFormQueryWhere],
"rawExpression": "abc123",
"transactionNo": NumberWhereValueExpression,
"updateTimeGmt": DateWhereValueExpression,
"referenceNo": StringWhereValueExpression,
"imosUserName": StringWhereValueExpression
}
RevisionRelationships
Fields
| Field Name | Description |
|---|---|
revisionRows - RelationshipDefinition
|
Example
{"revisionRows": RelationshipDefinition}
RevisionRow
Fields
| Field Name | Description |
|---|---|
transactionNo - Int
|
|
sequenceNo - Int
|
|
tableName - String
|
|
columnName - String
|
|
itemID - Int
|
|
action - String
|
|
mapName - String
|
|
mapFieldName - String
|
|
mapOldValue - String
|
|
mapNewValue - String
|
|
revision - Revision
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"transactionNo": 123,
"sequenceNo": 123,
"tableName": "abc123",
"columnName": "abc123",
"itemID": 987,
"action": "xyz789",
"mapName": "xyz789",
"mapFieldName": "abc123",
"mapOldValue": "abc123",
"mapNewValue": "xyz789",
"revision": Revision,
"_id": "xyz789",
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
RevisionRowFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - RevisionRowFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": RevisionRowFormQueryWhere
}
RevisionRowFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [RevisionRowFormQueryWhere!]
|
|
or - [RevisionRowFormQueryWhere!]
|
|
rawExpression - String
|
|
transactionNo - NumberWhereValueExpression
|
|
sequenceNo - NumberWhereValueExpression
|
|
tableName - StringWhereValueExpression
|
|
columnName - StringWhereValueExpression
|
|
itemID - NumberWhereValueExpression
|
|
revision - RevisionFormQueryWhere
|
Example
{
"and": [RevisionRowFormQueryWhere],
"or": [RevisionRowFormQueryWhere],
"rawExpression": "xyz789",
"transactionNo": NumberWhereValueExpression,
"sequenceNo": NumberWhereValueExpression,
"tableName": StringWhereValueExpression,
"columnName": StringWhereValueExpression,
"itemID": NumberWhereValueExpression,
"revision": RevisionFormQueryWhere
}
RevisionRowRelationships
Fields
| Field Name | Description |
|---|---|
revision - RelationshipDefinition
|
Example
{"revision": RelationshipDefinition}
RunAlertRulesResponse
Fields
| Field Name | Description |
|---|---|
alerts - [DecisionTableAlert]
|
|
tasks - [DecisionTableTask]
|
Example
{
"alerts": [DecisionTableAlert],
"tasks": [DecisionTableTask]
}
SCCReport
Fields
| Field Name | Description |
|---|---|
report - [SCCReportItem]
|
Example
{"report": [SCCReportItem]}
SCCReportInput
SCCReportItem
Example
{
"imoNo": "xyz789",
"messageLink": "xyz789",
"voyage": "xyz789",
"requiredCo2Intensity": 123.45,
"alignment": 123.45,
"co2": 987.65,
"co2Intensity": 123.45,
"transportWork": 987.65,
"deadweightMT": 987.65,
"sizeCategory": 123,
"vesselType": "xyz789"
}
SCCVoyageEmissionsInput
Fields
| Input Field | Description |
|---|---|
voyageNo - Float
|
|
vesselCode - String
|
|
chartererVoyageID - String
|
|
voyageType - SCCVoyageEmissions_VoyageType
|
|
contactName - String
|
|
contactEmail - String
|
|
vessel - SCCVoyageEmissions_VesselInput
|
|
emissionDetails - [SCCVoyageEmissions_EmissionDetailsInput]
|
Example
{
"voyageNo": 987.65,
"vesselCode": "xyz789",
"chartererVoyageID": "xyz789",
"voyageType": "TimeCharter",
"contactName": "xyz789",
"contactEmail": "xyz789",
"vessel": SCCVoyageEmissions_VesselInput,
"emissionDetails": [
SCCVoyageEmissions_EmissionDetailsInput
]
}
SCCVoyageEmissionsMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "abc123",
"debug": true,
"context": ["xyz789"],
"timestamp": "abc123",
"originalTimestamp": "xyz789",
"intent": "abc123",
"from": "xyz789",
"to": ["abc123"],
"fromUser": "abc123",
"status": "xyz789",
"approvalStatus": "abc123",
"objectId": "xyz789",
"type": "xyz789",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "abc123",
"previousData": Json,
"comment": "xyz789",
"unmapped": false,
"responseData": Json,
"applyErrors": ["abc123"],
"applyWarnings": ["xyz789"],
"parentMessageId": "abc123",
"preResolutionObjectId": "xyz789",
"title": "xyz789",
"effectiveDate": "abc123",
"source": "xyz789",
"sourceId": "xyz789",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["abc123"],
"isLatest": true,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "xyz789"
}
SCCVoyageEmissions_EmissionDetailsInput
Fields
| Input Field | Description |
|---|---|
ballastLaden - SCCVoyageEmissions_EmissionDetailsInput_BallastLaden
|
|
portName - String
|
|
fromPortName - String
|
|
toPortName - String
|
|
portUNCode - String
|
|
fromPortUNCode - String
|
|
toPortUNCode - String
|
|
fromDate - Date
|
|
toDate - Date
|
|
cargoQuantityMT - Float
|
|
chartererCargoQuantityMT - Float
|
|
distanceNauticalMiles - Float
|
|
legType - SCCVoyageEmissions_EmissionDetailsInput_LegType
|
|
consumption - [SCCVoyageEmissions_EmissionDetailsInput_ConsumptionInput]
|
Example
{
"ballastLaden": "Ballast",
"portName": "abc123",
"fromPortName": "abc123",
"toPortName": "abc123",
"portUNCode": "abc123",
"fromPortUNCode": "abc123",
"toPortUNCode": "xyz789",
"fromDate": "2007-12-03",
"toDate": "2007-12-03",
"cargoQuantityMT": 987.65,
"chartererCargoQuantityMT": 987.65,
"distanceNauticalMiles": 123.45,
"legType": "Port",
"consumption": [
SCCVoyageEmissions_EmissionDetailsInput_ConsumptionInput
]
}
SCCVoyageEmissions_EmissionDetailsInput_BallastLaden
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Ballast"
SCCVoyageEmissions_EmissionDetailsInput_ConsumptionInput
Fields
| Input Field | Description |
|---|---|
fuelType - SCCVoyageEmissions_EmissionDetailsInput_ConsumptionInput_FuelType
|
|
quantityMT - Float
|
|
cO2Factor - Float
|
Example
{"fuelType": "HFO", "quantityMT": 123.45, "cO2Factor": 123.45}
SCCVoyageEmissions_EmissionDetailsInput_ConsumptionInput_FuelType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"HFO"
SCCVoyageEmissions_EmissionDetailsInput_LegType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Port"
SCCVoyageEmissions_VesselInput
Fields
| Input Field | Description |
|---|---|
vesselCode - String
|
|
imoNo - String
|
|
name - String
|
|
type - SCCVoyageEmissions_VesselInput_Type
|
|
deadweightMT - Float
|
Example
{
"vesselCode": "abc123",
"imoNo": "xyz789",
"name": "abc123",
"type": "BulkCarrier",
"deadweightMT": 123.45
}
SCCVoyageEmissions_VesselInput_Type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BulkCarrier"
SCCVoyageEmissions_VoyageType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TimeCharter"
ScheduleBarge
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
voyageSeqNo - Int
|
|
berthSeqNo - Int
|
|
cargoHandlingSeqNo - Int
|
|
seq - Int
|
|
fixtureNo - String
|
|
bargeID - String
|
|
cargoShortName - String
|
|
portNo - Int
|
|
portFunc - String
|
|
qty - Float
|
|
name - String
|
|
voyageItinerary - VoyageItinerary
|
|
cargoName - CargoName
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 987,
"voyageSeqNo": 987,
"berthSeqNo": 987,
"cargoHandlingSeqNo": 987,
"seq": 123,
"fixtureNo": "xyz789",
"bargeID": "xyz789",
"cargoShortName": "abc123",
"portNo": 987,
"portFunc": "xyz789",
"qty": 987.65,
"name": "xyz789",
"voyageItinerary": VoyageItinerary,
"cargoName": CargoName,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
ScheduleBargeFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - ScheduleBargeFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": ScheduleBargeFormQueryWhere
}
ScheduleBargeFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [ScheduleBargeFormQueryWhere!]
|
|
or - [ScheduleBargeFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
voyageSeqNo - NumberWhereValueExpression
|
|
berthSeqNo - NumberWhereValueExpression
|
|
cargoHandlingSeqNo - NumberWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
fixtureNo - StringWhereValueExpression
|
|
bargeID - StringWhereValueExpression
|
|
cargoShortName - StringWhereValueExpression
|
|
portNo - NumberWhereValueExpression
|
|
portFunc - StringWhereValueExpression
|
|
qty - NumberWhereValueExpression
|
|
name - StringWhereValueExpression
|
|
voyageItinerary - VoyageItineraryFormQueryWhere
|
|
cargoName - CargoNameFormQueryWhere
|
Example
{
"and": [ScheduleBargeFormQueryWhere],
"or": [ScheduleBargeFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"voyageSeqNo": NumberWhereValueExpression,
"berthSeqNo": NumberWhereValueExpression,
"cargoHandlingSeqNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"fixtureNo": StringWhereValueExpression,
"bargeID": StringWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"portNo": NumberWhereValueExpression,
"portFunc": StringWhereValueExpression,
"qty": NumberWhereValueExpression,
"name": StringWhereValueExpression,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"cargoName": CargoNameFormQueryWhere
}
ScheduleBargeRelationships
Fields
| Field Name | Description |
|---|---|
voyageItinerary - RelationshipDefinition
|
|
cargoName - RelationshipDefinition
|
Example
{
"voyageItinerary": RelationshipDefinition,
"cargoName": RelationshipDefinition
}
ScheduleVoyageInput
Fields
| Input Field | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
If a voyage number is provided and already exists, this indicates that the voyage should be rescheduled with the given new information |
externalRef - String
|
|
voyageReference - String
|
|
opsCoordinator - String
|
|
opsCoordinator2 - String
|
|
voyageItineraries - [ScheduleVoyage_VoyageItinerariesInput]!
|
|
cargos - [ScheduleVoyage_CargosInput]!
|
Example
{
"vesselCode": "xyz789",
"voyageNo": 987,
"externalRef": "abc123",
"voyageReference": "xyz789",
"opsCoordinator": "xyz789",
"opsCoordinator2": "abc123",
"voyageItineraries": [
ScheduleVoyage_VoyageItinerariesInput
],
"cargos": [ScheduleVoyage_CargosInput]
}
ScheduleVoyageMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": false,
"context": ["abc123"],
"timestamp": "abc123",
"originalTimestamp": "xyz789",
"intent": "abc123",
"from": "xyz789",
"to": ["xyz789"],
"fromUser": "xyz789",
"status": "xyz789",
"approvalStatus": "xyz789",
"objectId": "abc123",
"type": "xyz789",
"data": Json,
"applyTriggeredOn": "abc123",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "xyz789",
"unmapped": true,
"responseData": Json,
"applyErrors": ["abc123"],
"applyWarnings": ["abc123"],
"parentMessageId": "xyz789",
"preResolutionObjectId": "xyz789",
"title": "abc123",
"effectiveDate": "xyz789",
"source": "xyz789",
"sourceId": "xyz789",
"threadId": "xyz789",
"links": [MessageLinkOutput],
"retrieveWarnings": ["abc123"],
"isLatest": true,
"threadCount": 987,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "xyz789"
}
ScheduleVoyageResponse
Fields
| Field Name | Description |
|---|---|
voyageNo - Int
|
|
vesselCode - String
|
|
vesselName - String
|
|
voyageStatus - String
|
|
vessel - ScheduleVoyageResponse_Vessel
|
|
firstCargo - ScheduleVoyageResponse_FirstCargo
|
|
voyageItineraries - [ScheduleVoyageResponse_VoyageItineraries]
|
|
opsCoordinator - String
|
|
opsCoordinator2 - String
|
|
vesselRef - String
|
|
cargoID - Float
|
|
bookingNo - String
|
Example
{
"voyageNo": 123,
"vesselCode": "xyz789",
"vesselName": "abc123",
"voyageStatus": "xyz789",
"vessel": ScheduleVoyageResponse_Vessel,
"firstCargo": ScheduleVoyageResponse_FirstCargo,
"voyageItineraries": [
ScheduleVoyageResponse_VoyageItineraries
],
"opsCoordinator": "abc123",
"opsCoordinator2": "xyz789",
"vesselRef": "abc123",
"cargoID": 123.45,
"bookingNo": "abc123"
}
ScheduleVoyageResponse_FirstCargo
ScheduleVoyageResponse_Vessel
Fields
| Field Name | Description |
|---|---|
refNo - String
|
Example
{"refNo": "abc123"}
ScheduleVoyageResponse_VoyageItineraries
ScheduleVoyage_CargosInput
Fields
| Input Field | Description |
|---|---|
cargoID - Int
|
|
cargoBooking - ScheduleVoyage_CargosInput_CargoBookingInput
|
Example
{
"cargoID": 123,
"cargoBooking": ScheduleVoyage_CargosInput_CargoBookingInput
}
ScheduleVoyage_CargosInput_CargoBookingInput
Fields
| Input Field | Description |
|---|---|
cargoBookingStowages - [ScheduleVoyage_CargosInput_CargoBookingInput_CargoBookingStowagesInput]
|
Example
{
"cargoBookingStowages": [
ScheduleVoyage_CargosInput_CargoBookingInput_CargoBookingStowagesInput
]
}
ScheduleVoyage_CargosInput_CargoBookingInput_CargoBookingStowagesInput
Example
{
"tankName": "abc123",
"prevCargoFirst": "abc123",
"prevCargoSecond": "abc123",
"prevCargoThird": "abc123",
"approved": "xyz789",
"inspection": "abc123",
"purging": "abc123",
"inspectionStatus": "xyz789",
"purgingStatus": "xyz789",
"comments": "xyz789"
}
ScheduleVoyage_VoyageItinerariesInput
Example
{
"seq": 987,
"externalRef": "xyz789",
"portFunc": "xyz789",
"portNo": 123,
"portName": "xyz789",
"voyageItineraryBerths": [
ScheduleVoyage_VoyageItinerariesInput_VoyageItineraryBerthsInput
],
"eta": "2007-12-03",
"etd": "2007-12-03"
}
ScheduleVoyage_VoyageItinerariesInput_VoyageItineraryBerthsInput
Fields
| Input Field | Description |
|---|---|
berthShortName - String
|
|
voyageCargoHandlings - ScheduleVoyage_VoyageItinerariesInput_VoyageItineraryBerthsInput_VoyageCargoHandlingsInput!
|
|
etb - Date
|
Estimated berth arrival time |
etd - Date
|
Example
{
"berthShortName": "abc123",
"voyageCargoHandlings": ScheduleVoyage_VoyageItinerariesInput_VoyageItineraryBerthsInput_VoyageCargoHandlingsInput,
"etb": "2007-12-03",
"etd": "2007-12-03"
}
ScheduleVoyage_VoyageItinerariesInput_VoyageItineraryBerthsInput_VoyageCargoHandlingsInput
SetUserPref
Example
{
"moduleName": "xyz789",
"preferenceID": "xyz789",
"preferenceValue": "abc123",
"isPublic": false,
"previousPreferenceValue": "abc123",
"flags": 987
}
SortDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"asc"
StandardExpense
Fields
| Field Name | Description |
|---|---|
ports - String
|
|
berths - String
|
|
vesselTypes - String
|
|
portFunctions - String
|
|
cargoGroups - String
|
|
ballastOrLaden - String
|
|
ledgerCodeDescription - String
|
|
iD - Int
|
|
type - String
|
|
ledgerCode - String
|
|
expenseCode - Int
|
|
amountCurr - Float
|
|
curr - String
|
|
minAmount - Float
|
|
maxAmount - Float
|
|
effectiveFromGmt - Date
|
|
effectiveToGmt - Date
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
currency - Currency
|
|
expense - Expense
|
|
firstBLStandardExpenseCondition - StandardExpenseCondition
|
|
operationsLedger - OperationsLedger
|
|
standardExpenseConditions - [StandardExpenseCondition]
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"ports": "abc123",
"berths": "xyz789",
"vesselTypes": "abc123",
"portFunctions": "abc123",
"cargoGroups": "abc123",
"ballastOrLaden": "abc123",
"ledgerCodeDescription": "abc123",
"iD": 987,
"type": "abc123",
"ledgerCode": "xyz789",
"expenseCode": 123,
"amountCurr": 123.45,
"curr": "abc123",
"minAmount": 123.45,
"maxAmount": 123.45,
"effectiveFromGmt": "2007-12-03",
"effectiveToGmt": "2007-12-03",
"lastUser": "abc123",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"currency": Currency,
"expense": Expense,
"firstBLStandardExpenseCondition": StandardExpenseCondition,
"operationsLedger": OperationsLedger,
"standardExpenseConditions": [StandardExpenseCondition],
"_id": "xyz789",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
StandardExpenseCondition
Fields
| Field Name | Description |
|---|---|
sqlID - Int
|
|
expenseID - Int
|
|
conditionType - String
|
|
stringValue - String
|
|
intValue - Int
|
|
standardExpense - StandardExpense
|
|
port - Port
|
|
berth - PortBerth
|
|
portFunction - PortFunction
|
|
cargoType - CargoType
|
|
vesselType - VesselType
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
Example
{
"sqlID": 987,
"expenseID": 987,
"conditionType": "abc123",
"stringValue": "xyz789",
"intValue": 123,
"standardExpense": StandardExpense,
"port": Port,
"berth": PortBerth,
"portFunction": PortFunction,
"cargoType": CargoType,
"vesselType": VesselType,
"_id": "xyz789",
"_keys": ["abc123"],
"_intents": ["abc123"]
}
StandardExpenseConditionRelationships
Fields
| Field Name | Description |
|---|---|
standardExpense - RelationshipDefinition
|
|
port - RelationshipDefinition
|
|
berth - RelationshipDefinition
|
|
portFunction - RelationshipDefinition
|
|
cargoType - RelationshipDefinition
|
|
vesselType - RelationshipDefinition
|
Example
{
"standardExpense": RelationshipDefinition,
"port": RelationshipDefinition,
"berth": RelationshipDefinition,
"portFunction": RelationshipDefinition,
"cargoType": RelationshipDefinition,
"vesselType": RelationshipDefinition
}
StandardExpenseFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - StandardExpenseFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": StandardExpenseFormQueryWhere
}
StandardExpenseFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [StandardExpenseFormQueryWhere!]
|
|
or - [StandardExpenseFormQueryWhere!]
|
|
rawExpression - String
|
|
iD - NumberWhereValueExpression
|
|
type - StandardExpenseTypeEnumValueExpression
|
|
ledgerCode - StringWhereValueExpression
|
|
expenseCode - NumberWhereValueExpression
|
|
amountCurr - NumberWhereValueExpression
|
|
curr - StringWhereValueExpression
|
|
minAmount - NumberWhereValueExpression
|
|
maxAmount - NumberWhereValueExpression
|
|
effectiveFromGmt - DateWhereValueExpression
|
|
effectiveToGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
currency - CurrencyFormQueryWhere
|
|
expense - ExpenseFormQueryWhere
|
|
operationsLedger - OperationsLedgerFormQueryWhere
|
Example
{
"and": [StandardExpenseFormQueryWhere],
"or": [StandardExpenseFormQueryWhere],
"rawExpression": "xyz789",
"iD": NumberWhereValueExpression,
"type": StandardExpenseTypeEnumValueExpression,
"ledgerCode": StringWhereValueExpression,
"expenseCode": NumberWhereValueExpression,
"amountCurr": NumberWhereValueExpression,
"curr": StringWhereValueExpression,
"minAmount": NumberWhereValueExpression,
"maxAmount": NumberWhereValueExpression,
"effectiveFromGmt": DateWhereValueExpression,
"effectiveToGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"currency": CurrencyFormQueryWhere,
"expense": ExpenseFormQueryWhere,
"operationsLedger": OperationsLedgerFormQueryWhere
}
StandardExpenseRelationships
Fields
| Field Name | Description |
|---|---|
currency - RelationshipDefinition
|
|
expense - RelationshipDefinition
|
|
firstBLStandardExpenseCondition - RelationshipDefinition
|
|
operationsLedger - RelationshipDefinition
|
|
standardExpenseConditions - RelationshipDefinition
|
Example
{
"currency": RelationshipDefinition,
"expense": RelationshipDefinition,
"firstBLStandardExpenseCondition": RelationshipDefinition,
"operationsLedger": RelationshipDefinition,
"standardExpenseConditions": RelationshipDefinition
}
StandardExpenseTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Undefined"
StandardExpenseTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - StandardExpenseTypeEnum
|
|
isNot - StandardExpenseTypeEnum
|
|
isIn - [StandardExpenseTypeEnum]
|
Example
{"is": "Undefined", "isNot": "Undefined", "isIn": ["Undefined"]}
StandardRate
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
rateUnit - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
basis - String
|
|
cargo - String
|
|
hasExtraFrtTerms - Boolean
|
|
loadPorts - String
|
|
dischargePorts - String
|
|
bafFuelType - String
|
|
bafSymbol - String
|
|
bafAdjQty - Float
|
|
bafAdjPrice - Float
|
|
baf - Float
|
|
shortName - String
|
|
seqNo - Int
|
|
type - String
|
|
qty - Float
|
|
qtyUnit - String
|
|
rate - Float
|
|
rateUnitInternal - String
|
|
lumpsum - Float
|
|
tableOrIndex - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
isBasisBlQty - Boolean
|
|
isBasisCpQty - Boolean
|
|
isBasisManual - Boolean
|
|
useExtraFrtTerms - Boolean
|
|
internalField1 - Int
|
|
internalField2 - Int
|
|
loadPort0No - Int
|
|
dischargePort0No - Int
|
|
internalReference - String
|
|
fuelType_0 - String
|
|
price_0 - Float
|
|
qty_0 - Float
|
|
bAF_0 - Float
|
|
symbol_0 - String
|
|
fuelType_1 - String
|
|
price_1 - Float
|
|
qty_1 - Float
|
|
bAF_1 - Float
|
|
symbol_1 - String
|
|
fuelType_2 - String
|
|
price_2 - Float
|
|
qty_2 - Float
|
|
bAF_2 - Float
|
|
symbol_2 - String
|
|
fuelType_3 - String
|
|
price_3 - Float
|
|
qty_3 - Float
|
|
bAF_3 - Float
|
|
symbol_3 - String
|
|
fuelType_4 - String
|
|
price_4 - Float
|
|
qty_4 - Float
|
|
bAF_4 - Float
|
|
symbol_4 - String
|
|
fuelType_5 - String
|
|
price_5 - Float
|
|
qty_5 - Float
|
|
bAF_5 - Float
|
|
symbol_5 - String
|
|
loadPort1No - Int
|
|
loadPort2No - Int
|
|
loadPort3No - Int
|
|
dischargePort1No - Int
|
|
dischargePort2No - Int
|
|
dischargePort3No - Int
|
|
loadPort4No - Int
|
|
dischargePort4No - Int
|
|
coaPricingLineExtraFreightTerms - [COAExtraFreightTerms]
|
|
cargoPricingLineExtraFreightTerms - [ExtraFreightTerms]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"rateUnit": "xyz789",
"customFieldByID": Any,
"customField": Any,
"basis": "xyz789",
"cargo": "xyz789",
"hasExtraFrtTerms": false,
"loadPorts": "xyz789",
"dischargePorts": "abc123",
"bafFuelType": "xyz789",
"bafSymbol": "xyz789",
"bafAdjQty": 987.65,
"bafAdjPrice": 987.65,
"baf": 987.65,
"shortName": "xyz789",
"seqNo": 123,
"type": "xyz789",
"qty": 123.45,
"qtyUnit": "xyz789",
"rate": 987.65,
"rateUnitInternal": "xyz789",
"lumpsum": 987.65,
"tableOrIndex": "xyz789",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUser": "abc123",
"isBasisBlQty": true,
"isBasisCpQty": true,
"isBasisManual": true,
"useExtraFrtTerms": false,
"internalField1": 987,
"internalField2": 123,
"loadPort0No": 123,
"dischargePort0No": 987,
"internalReference": "abc123",
"fuelType_0": "abc123",
"price_0": 987.65,
"qty_0": 987.65,
"bAF_0": 987.65,
"symbol_0": "xyz789",
"fuelType_1": "abc123",
"price_1": 987.65,
"qty_1": 123.45,
"bAF_1": 987.65,
"symbol_1": "abc123",
"fuelType_2": "abc123",
"price_2": 123.45,
"qty_2": 123.45,
"bAF_2": 123.45,
"symbol_2": "abc123",
"fuelType_3": "xyz789",
"price_3": 123.45,
"qty_3": 123.45,
"bAF_3": 987.65,
"symbol_3": "abc123",
"fuelType_4": "xyz789",
"price_4": 123.45,
"qty_4": 987.65,
"bAF_4": 987.65,
"symbol_4": "xyz789",
"fuelType_5": "abc123",
"price_5": 123.45,
"qty_5": 987.65,
"bAF_5": 123.45,
"symbol_5": "xyz789",
"loadPort1No": 987,
"loadPort2No": 987,
"loadPort3No": 987,
"dischargePort1No": 987,
"dischargePort2No": 987,
"dischargePort3No": 987,
"loadPort4No": 123,
"dischargePort4No": 123,
"coaPricingLineExtraFreightTerms": [
COAExtraFreightTerms
],
"cargoPricingLineExtraFreightTerms": [
ExtraFreightTerms
],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
StandardRateFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - StandardRateFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": StandardRateFormQueryWhere
}
StandardRateFormQueryWhere
Fields
Example
{
"and": [StandardRateFormQueryWhere],
"or": [StandardRateFormQueryWhere],
"rawExpression": "abc123",
"shortName": StringWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"type": StandardRateTypeEnumValueExpression,
"qty": NumberWhereValueExpression,
"qtyUnit": StringWhereValueExpression,
"rate": NumberWhereValueExpression,
"rateUnitInternal": StringWhereValueExpression,
"lumpsum": NumberWhereValueExpression,
"tableOrIndex": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"isBasisBlQty": BoolWhereValueExpression,
"isBasisCpQty": BoolWhereValueExpression,
"isBasisManual": BoolWhereValueExpression,
"useExtraFrtTerms": BoolWhereValueExpression,
"internalField1": NumberWhereValueExpression,
"internalField2": NumberWhereValueExpression,
"loadPort0No": NumberWhereValueExpression,
"dischargePort0No": NumberWhereValueExpression,
"internalReference": StringWhereValueExpression,
"fuelType_0": StringWhereValueExpression,
"price_0": NumberWhereValueExpression,
"qty_0": NumberWhereValueExpression,
"bAF_0": NumberWhereValueExpression,
"symbol_0": StringWhereValueExpression,
"fuelType_1": StringWhereValueExpression,
"price_1": NumberWhereValueExpression,
"qty_1": NumberWhereValueExpression,
"bAF_1": NumberWhereValueExpression,
"symbol_1": StringWhereValueExpression,
"fuelType_2": StringWhereValueExpression,
"price_2": NumberWhereValueExpression,
"qty_2": NumberWhereValueExpression,
"bAF_2": NumberWhereValueExpression,
"symbol_2": StringWhereValueExpression,
"fuelType_3": StringWhereValueExpression,
"price_3": NumberWhereValueExpression,
"qty_3": NumberWhereValueExpression,
"bAF_3": NumberWhereValueExpression,
"symbol_3": StringWhereValueExpression,
"fuelType_4": StringWhereValueExpression,
"price_4": NumberWhereValueExpression,
"qty_4": NumberWhereValueExpression,
"bAF_4": NumberWhereValueExpression,
"symbol_4": StringWhereValueExpression,
"fuelType_5": StringWhereValueExpression,
"price_5": NumberWhereValueExpression,
"qty_5": NumberWhereValueExpression,
"bAF_5": NumberWhereValueExpression,
"symbol_5": StringWhereValueExpression,
"loadPort1No": NumberWhereValueExpression,
"loadPort2No": NumberWhereValueExpression,
"loadPort3No": NumberWhereValueExpression,
"dischargePort1No": NumberWhereValueExpression,
"dischargePort2No": NumberWhereValueExpression,
"dischargePort3No": NumberWhereValueExpression,
"loadPort4No": NumberWhereValueExpression,
"dischargePort4No": NumberWhereValueExpression
}
StandardRateRelationships
Fields
| Field Name | Description |
|---|---|
cOAPricingLineExtraFreightTerms - RelationshipDefinition
|
|
cargoPricingLineExtraFreightTerms - RelationshipDefinition
|
Example
{
"cOAPricingLineExtraFreightTerms": RelationshipDefinition,
"cargoPricingLineExtraFreightTerms": RelationshipDefinition
}
StandardRateTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
StandardRateTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - StandardRateTypeEnum
|
|
isNot - StandardRateTypeEnum
|
|
isIn - [StandardRateTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
StartEndRange
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
StringWhereValueExpression
SurveyCostDetails
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
transNo - Int
|
|
surveyDate - Date
|
|
vendorShortName - String
|
|
surveyType - String
|
|
incidentType - String
|
|
isIncidentReported - Boolean
|
|
isIncidentReportedToAuthorities - Boolean
|
|
entryUserID - String
|
|
entryDate - Date
|
|
updateTimes - Int
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
voyage - Voyage
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 987,
"transNo": 987,
"surveyDate": "2007-12-03",
"vendorShortName": "abc123",
"surveyType": "abc123",
"incidentType": "xyz789",
"isIncidentReported": false,
"isIncidentReportedToAuthorities": false,
"entryUserID": "abc123",
"entryDate": "2007-12-03",
"updateTimes": 987,
"lastUser": "abc123",
"lastUpdateGmt": "2007-12-03",
"voyage": Voyage,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
SurveyCostDetailsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - SurveyCostDetailsFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": SurveyCostDetailsFormQueryWhere
}
SurveyCostDetailsFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [SurveyCostDetailsFormQueryWhere!]
|
|
or - [SurveyCostDetailsFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
transNo - NumberWhereValueExpression
|
|
surveyDate - DateWhereValueExpression
|
|
vendorShortName - StringWhereValueExpression
|
|
surveyType - SurveyCostDetailsSurveyTypeEnumValueExpression
|
|
incidentType - SurveyCostDetailsIncidentTypeEnumValueExpression
|
|
isIncidentReported - BoolWhereValueExpression
|
|
isIncidentReportedToAuthorities - BoolWhereValueExpression
|
|
entryUserID - StringWhereValueExpression
|
|
entryDate - DateWhereValueExpression
|
|
updateTimes - NumberWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
voyage - VoyageFormQueryWhere
|
Example
{
"and": [SurveyCostDetailsFormQueryWhere],
"or": [SurveyCostDetailsFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"transNo": NumberWhereValueExpression,
"surveyDate": DateWhereValueExpression,
"vendorShortName": StringWhereValueExpression,
"surveyType": SurveyCostDetailsSurveyTypeEnumValueExpression,
"incidentType": SurveyCostDetailsIncidentTypeEnumValueExpression,
"isIncidentReported": BoolWhereValueExpression,
"isIncidentReportedToAuthorities": BoolWhereValueExpression,
"entryUserID": StringWhereValueExpression,
"entryDate": DateWhereValueExpression,
"updateTimes": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"voyage": VoyageFormQueryWhere
}
SurveyCostDetailsIncidentTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
SurveyCostDetailsIncidentTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - SurveyCostDetailsIncidentTypeEnum
|
|
isNot - SurveyCostDetailsIncidentTypeEnum
|
|
isIn - [SurveyCostDetailsIncidentTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
SurveyCostDetailsRelationships
Fields
| Field Name | Description |
|---|---|
voyage - RelationshipDefinition
|
Example
{"voyage": RelationshipDefinition}
SurveyCostDetailsSurveyTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Rob"
SurveyCostDetailsSurveyTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - SurveyCostDetailsSurveyTypeEnum
|
|
isNot - SurveyCostDetailsSurveyTypeEnum
|
|
isIn - [SurveyCostDetailsSurveyTypeEnum]
|
Example
{"is": "Rob", "isNot": "Rob", "isIn": ["Rob"]}
SurveyCostsBunkers
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
transNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seq - Int
|
|
robSurveyQty - Float
|
|
price - Float
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
fuelType - String
|
|
robPreSurveyQty - Float
|
|
fuelGrade - String
|
|
supplierShortName - String
|
|
bargeName - String
|
|
operationsInvoice - OperationsInvoice
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"transNo": 123,
"customFieldByID": Any,
"customField": Any,
"seq": 987,
"robSurveyQty": 987.65,
"price": 123.45,
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUser": "xyz789",
"fuelType": "abc123",
"robPreSurveyQty": 123.45,
"fuelGrade": "xyz789",
"supplierShortName": "abc123",
"bargeName": "abc123",
"operationsInvoice": OperationsInvoice,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
SurveyCostsBunkersFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - SurveyCostsBunkersFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": SurveyCostsBunkersFormQueryWhere
}
SurveyCostsBunkersFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [SurveyCostsBunkersFormQueryWhere!]
|
|
or - [SurveyCostsBunkersFormQueryWhere!]
|
|
rawExpression - String
|
|
transNo - NumberWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
robSurveyQty - NumberWhereValueExpression
|
|
price - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
robPreSurveyQty - NumberWhereValueExpression
|
|
fuelGrade - StringWhereValueExpression
|
|
supplierShortName - StringWhereValueExpression
|
|
bargeName - StringWhereValueExpression
|
|
operationsInvoice - OperationsInvoiceFormQueryWhere
|
Example
{
"and": [SurveyCostsBunkersFormQueryWhere],
"or": [SurveyCostsBunkersFormQueryWhere],
"rawExpression": "xyz789",
"transNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"robSurveyQty": NumberWhereValueExpression,
"price": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"fuelType": StringWhereValueExpression,
"robPreSurveyQty": NumberWhereValueExpression,
"fuelGrade": StringWhereValueExpression,
"supplierShortName": StringWhereValueExpression,
"bargeName": StringWhereValueExpression,
"operationsInvoice": OperationsInvoiceFormQueryWhere
}
SurveyCostsBunkersRelationships
Fields
| Field Name | Description |
|---|---|
operationsInvoice - RelationshipDefinition
|
Example
{"operationsInvoice": RelationshipDefinition}
SystemConfig
TCDeduction
Fields
| Field Name | Description |
|---|---|
tcCode - String
|
|
seq - Int
|
|
year - Int
|
|
month - Int
|
|
activity - String
|
|
days - Float
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
startDate - Date
|
|
endDate - Date
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"tcCode": "xyz789",
"seq": 123,
"year": 123,
"month": 987,
"activity": "abc123",
"days": 987.65,
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"startDate": "2007-12-03",
"endDate": "2007-12-03",
"_id": "xyz789",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
TCDeductionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TCDeductionFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TCDeductionFormQueryWhere
}
TCDeductionFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TCDeductionFormQueryWhere!]
|
|
or - [TCDeductionFormQueryWhere!]
|
|
rawExpression - String
|
|
tcCode - StringWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
year - NumberWhereValueExpression
|
|
month - NumberWhereValueExpression
|
|
activity - StringWhereValueExpression
|
|
days - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
startDate - DateWhereValueExpression
|
|
endDate - DateWhereValueExpression
|
Example
{
"and": [TCDeductionFormQueryWhere],
"or": [TCDeductionFormQueryWhere],
"rawExpression": "xyz789",
"tcCode": StringWhereValueExpression,
"seq": NumberWhereValueExpression,
"year": NumberWhereValueExpression,
"month": NumberWhereValueExpression,
"activity": StringWhereValueExpression,
"days": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"startDate": DateWhereValueExpression,
"endDate": DateWhereValueExpression
}
TagInput
TankCondition
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
itinerarySeq - Int
|
|
reportDateGmt - Date
|
|
tankType - String
|
|
tankName - String
|
|
pressureKpa - Float
|
|
temperatureC - Float
|
|
condition - String
|
|
voyageActivityReport - VoyageActivityReport
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 987,
"itinerarySeq": 987,
"reportDateGmt": "2007-12-03",
"tankType": "abc123",
"tankName": "abc123",
"pressureKpa": 123.45,
"temperatureC": 987.65,
"condition": "abc123",
"voyageActivityReport": VoyageActivityReport,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
TankConditionConditionEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
TankConditionConditionEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TankConditionConditionEnum
|
|
isNot - TankConditionConditionEnum
|
|
isIn - [TankConditionConditionEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
TankConditionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TankConditionFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TankConditionFormQueryWhere
}
TankConditionFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TankConditionFormQueryWhere!]
|
|
or - [TankConditionFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
itinerarySeq - NumberWhereValueExpression
|
|
reportDateGmt - DateWhereValueExpression
|
|
tankType - StringWhereValueExpression
|
|
tankName - StringWhereValueExpression
|
|
pressureKpa - NumberWhereValueExpression
|
|
temperatureC - NumberWhereValueExpression
|
|
condition - TankConditionConditionEnumValueExpression
|
|
voyageActivityReport - VoyageActivityReportFormQueryWhere
|
Example
{
"and": [TankConditionFormQueryWhere],
"or": [TankConditionFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"itinerarySeq": NumberWhereValueExpression,
"reportDateGmt": DateWhereValueExpression,
"tankType": StringWhereValueExpression,
"tankName": StringWhereValueExpression,
"pressureKpa": NumberWhereValueExpression,
"temperatureC": NumberWhereValueExpression,
"condition": TankConditionConditionEnumValueExpression,
"voyageActivityReport": VoyageActivityReportFormQueryWhere
}
TankConditionRelationships
Fields
| Field Name | Description |
|---|---|
voyageActivityReport - RelationshipDefinition
|
Example
{"voyageActivityReport": RelationshipDefinition}
Task
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
taskFunction - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
taskStatusLabel - String
|
|
taskProgressLabel - String
|
|
priority - String
|
|
taskBarges - String
|
|
taskLaytimeCalcStatus - String
|
|
taskClaimStatus - String
|
|
internalBUs - String
|
|
cargoGrades - String
|
|
outcharter - Boolean
|
|
timebarDays - Float
|
|
targetDays - Float
|
|
isTaskCompleted - Boolean
|
|
isFobTask - Boolean
|
|
counterparty - String
|
|
demTaskCounterparty - String
|
|
demTaskCounterpartyType - String
|
|
vettingVesselCode - String
|
|
targetDateGmtConverted - Date
|
|
timebarDateGmtConverted - Date
|
|
startDateGmtConverted - Date
|
|
tradesList - String
|
|
appliesTo - String
|
|
appliesToID - String
|
|
iD - Int
|
|
subject - String
|
|
targetDateGmt - Date
|
|
timeBarDateGmt - Date
|
|
startDateGmt - Date
|
|
type - String
|
|
aPAR - String
|
|
calcID - Int
|
|
transNo - Int
|
|
statusCode - String
|
|
remarks - String
|
|
description - String
|
|
externalRef - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
portID - Int
|
|
analyst - String
|
|
cargoID - Int
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
claimID - Int
|
|
originalClaimID - Int
|
|
aPClaimCreated - Boolean
|
|
isFOBCargo - Boolean
|
|
noDueDateUpdate - Boolean
|
|
isDateGmt - Boolean
|
|
isManualStatus - Boolean
|
|
isManualSubject - Boolean
|
|
isManualCategory - Boolean
|
|
isManualPriority - Boolean
|
|
isManualDescription - Boolean
|
|
isManualStartDate - Boolean
|
|
isManualDueDate - Boolean
|
|
isManualOwner - Boolean
|
|
unread - Boolean
|
|
isTimebarTaskPerVoyage - Boolean
|
|
seqNo - Int
|
|
subtype - Int
|
|
functionCode - String
|
|
scheduler - String
|
|
trader - String
|
|
tcCode - String
|
|
tcDelNoticeSeq - Int
|
|
tcRedelNoticeSeq - Int
|
|
estimateID - String
|
|
category - String
|
|
priorityInternal - String
|
|
taskGroupName - String
|
|
coaID - Int
|
|
actionType - Int
|
|
sourceDecisionTableClassID - String
|
|
sourceDecisionTableID - String
|
|
sourceDecisionTableResultID - String
|
|
secondaryVesselCode - String
|
|
secondaryVessel - Vessel
|
|
laytime - Laytime
|
|
voyageEstimate - VoyageEstimate
|
|
coa - COA
|
|
operationsInvoice - OperationsInvoice
|
|
cargo - Cargo
|
|
vessel - Vessel
|
|
voyage - Voyage
|
|
voyageItinerary - VoyageItinerary
|
|
port - Port
|
|
portFunction - PortFunction
|
|
originalClaim - Claim
|
|
claim - Claim
|
|
timeCharter - TimeCharterContract
|
|
vettingVessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"taskFunction": "abc123",
"customFieldByID": Any,
"customField": Any,
"taskStatusLabel": "abc123",
"taskProgressLabel": "xyz789",
"priority": "abc123",
"taskBarges": "abc123",
"taskLaytimeCalcStatus": "abc123",
"taskClaimStatus": "xyz789",
"internalBUs": "abc123",
"cargoGrades": "xyz789",
"outcharter": false,
"timebarDays": 123.45,
"targetDays": 123.45,
"isTaskCompleted": false,
"isFobTask": true,
"counterparty": "abc123",
"demTaskCounterparty": "xyz789",
"demTaskCounterpartyType": "abc123",
"vettingVesselCode": "abc123",
"targetDateGmtConverted": "2007-12-03",
"timebarDateGmtConverted": "2007-12-03",
"startDateGmtConverted": "2007-12-03",
"tradesList": "abc123",
"appliesTo": "xyz789",
"appliesToID": "abc123",
"iD": 987,
"subject": "xyz789",
"targetDateGmt": "2007-12-03",
"timeBarDateGmt": "2007-12-03",
"startDateGmt": "2007-12-03",
"type": "xyz789",
"aPAR": "xyz789",
"calcID": 987,
"transNo": 123,
"statusCode": "abc123",
"remarks": "xyz789",
"description": "xyz789",
"externalRef": "xyz789",
"vesselCode": "abc123",
"voyageNo": 987,
"portID": 987,
"analyst": "abc123",
"cargoID": 987,
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"claimID": 123,
"originalClaimID": 987,
"aPClaimCreated": true,
"isFOBCargo": true,
"noDueDateUpdate": false,
"isDateGmt": true,
"isManualStatus": true,
"isManualSubject": false,
"isManualCategory": true,
"isManualPriority": true,
"isManualDescription": true,
"isManualStartDate": false,
"isManualDueDate": false,
"isManualOwner": true,
"unread": true,
"isTimebarTaskPerVoyage": true,
"seqNo": 123,
"subtype": 987,
"functionCode": "xyz789",
"scheduler": "abc123",
"trader": "xyz789",
"tcCode": "xyz789",
"tcDelNoticeSeq": 123,
"tcRedelNoticeSeq": 123,
"estimateID": "abc123",
"category": "xyz789",
"priorityInternal": "abc123",
"taskGroupName": "xyz789",
"coaID": 987,
"actionType": 987,
"sourceDecisionTableClassID": "xyz789",
"sourceDecisionTableID": "xyz789",
"sourceDecisionTableResultID": "xyz789",
"secondaryVesselCode": "xyz789",
"secondaryVessel": Vessel,
"laytime": Laytime,
"voyageEstimate": VoyageEstimate,
"coa": COA,
"operationsInvoice": OperationsInvoice,
"cargo": Cargo,
"vessel": Vessel,
"voyage": Voyage,
"voyageItinerary": VoyageItinerary,
"port": Port,
"portFunction": PortFunction,
"originalClaim": Claim,
"claim": Claim,
"timeCharter": TimeCharterContract,
"vettingVessel": Vessel,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
TaskAPAREnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
TaskAPAREnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TaskAPAREnum
|
|
isNot - TaskAPAREnum
|
|
isIn - [TaskAPAREnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
TaskFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TaskFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TaskFormQueryWhere
}
TaskFormQueryWhere
Fields
Example
{
"and": [TaskFormQueryWhere],
"or": [TaskFormQueryWhere],
"rawExpression": "xyz789",
"iD": NumberWhereValueExpression,
"subject": StringWhereValueExpression,
"targetDateGmt": DateWhereValueExpression,
"timeBarDateGmt": DateWhereValueExpression,
"startDateGmt": DateWhereValueExpression,
"type": TaskTypeEnumValueExpression,
"aPAR": TaskAPAREnumValueExpression,
"calcID": NumberWhereValueExpression,
"transNo": NumberWhereValueExpression,
"statusCode": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"description": StringWhereValueExpression,
"externalRef": StringWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"portID": NumberWhereValueExpression,
"analyst": StringWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"claimID": NumberWhereValueExpression,
"originalClaimID": NumberWhereValueExpression,
"aPClaimCreated": BoolWhereValueExpression,
"isFOBCargo": BoolWhereValueExpression,
"noDueDateUpdate": BoolWhereValueExpression,
"isDateGmt": BoolWhereValueExpression,
"isManualStatus": BoolWhereValueExpression,
"isManualSubject": BoolWhereValueExpression,
"isManualCategory": BoolWhereValueExpression,
"isManualPriority": BoolWhereValueExpression,
"isManualDescription": BoolWhereValueExpression,
"isManualStartDate": BoolWhereValueExpression,
"isManualDueDate": BoolWhereValueExpression,
"isManualOwner": BoolWhereValueExpression,
"unread": BoolWhereValueExpression,
"isTimebarTaskPerVoyage": BoolWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"subtype": NumberWhereValueExpression,
"functionCode": StringWhereValueExpression,
"scheduler": StringWhereValueExpression,
"trader": StringWhereValueExpression,
"tcCode": StringWhereValueExpression,
"tcDelNoticeSeq": NumberWhereValueExpression,
"tcRedelNoticeSeq": NumberWhereValueExpression,
"estimateID": StringWhereValueExpression,
"category": StringWhereValueExpression,
"priorityInternal": TaskPriorityInternalEnumValueExpression,
"taskGroupName": StringWhereValueExpression,
"coaID": NumberWhereValueExpression,
"actionType": NumberWhereValueExpression,
"sourceDecisionTableClassID": StringWhereValueExpression,
"sourceDecisionTableID": StringWhereValueExpression,
"sourceDecisionTableResultID": StringWhereValueExpression,
"secondaryVesselCode": StringWhereValueExpression,
"secondaryVessel": VesselFormQueryWhere,
"laytime": LaytimeFormQueryWhere,
"voyageEstimate": VoyageEstimateFormQueryWhere,
"coa": COAFormQueryWhere,
"operationsInvoice": OperationsInvoiceFormQueryWhere,
"cargo": CargoFormQueryWhere,
"vessel": VesselFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"port": PortFormQueryWhere,
"portFunction": PortFunctionFormQueryWhere,
"originalClaim": ClaimFormQueryWhere,
"claim": ClaimFormQueryWhere,
"timeCharter": TimeCharterContractFormQueryWhere,
"vettingVessel": VesselFormQueryWhere
}
TaskGroup
Fields
| Field Name | Description |
|---|---|
name - String
|
|
description - String
|
|
cargo - Boolean
|
|
voyageEstimate - Boolean
|
|
voyage - Boolean
|
|
objectType - Int
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
updateTimes - Int
|
|
lastUser - String
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"name": "xyz789",
"description": "xyz789",
"cargo": true,
"voyageEstimate": false,
"voyage": false,
"objectType": 987,
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"updateTimes": 123,
"lastUser": "abc123",
"_id": "xyz789",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
TaskGroupFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TaskGroupFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TaskGroupFormQueryWhere
}
TaskGroupFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TaskGroupFormQueryWhere!]
|
|
or - [TaskGroupFormQueryWhere!]
|
|
rawExpression - String
|
|
name - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
cargo - BoolWhereValueExpression
|
|
voyageEstimate - BoolWhereValueExpression
|
|
voyage - BoolWhereValueExpression
|
|
objectType - NumberWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
updateTimes - NumberWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
Example
{
"and": [TaskGroupFormQueryWhere],
"or": [TaskGroupFormQueryWhere],
"rawExpression": "abc123",
"name": StringWhereValueExpression,
"description": StringWhereValueExpression,
"cargo": BoolWhereValueExpression,
"voyageEstimate": BoolWhereValueExpression,
"voyage": BoolWhereValueExpression,
"objectType": NumberWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"updateTimes": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression
}
TaskGroupItem
Fields
| Field Name | Description |
|---|---|
groupName - String
|
|
seqNo - Int
|
|
name - String
|
|
category - String
|
|
priority - String
|
|
description - String
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
updateTimes - Int
|
|
lastUser - String
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"groupName": "abc123",
"seqNo": 123,
"name": "xyz789",
"category": "xyz789",
"priority": "xyz789",
"description": "abc123",
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"updateTimes": 987,
"lastUser": "xyz789",
"_id": "abc123",
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
TaskGroupItemFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TaskGroupItemFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TaskGroupItemFormQueryWhere
}
TaskGroupItemFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TaskGroupItemFormQueryWhere!]
|
|
or - [TaskGroupItemFormQueryWhere!]
|
|
rawExpression - String
|
|
groupName - StringWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
name - StringWhereValueExpression
|
|
category - StringWhereValueExpression
|
|
priority - TaskGroupItemPriorityEnumValueExpression
|
|
description - StringWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
updateTimes - NumberWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
Example
{
"and": [TaskGroupItemFormQueryWhere],
"or": [TaskGroupItemFormQueryWhere],
"rawExpression": "xyz789",
"groupName": StringWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"name": StringWhereValueExpression,
"category": StringWhereValueExpression,
"priority": TaskGroupItemPriorityEnumValueExpression,
"description": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"updateTimes": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression
}
TaskGroupItemPriorityEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Unspecified"
TaskGroupItemPriorityEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TaskGroupItemPriorityEnum
|
|
isNot - TaskGroupItemPriorityEnum
|
|
isIn - [TaskGroupItemPriorityEnum]
|
Example
{"is": "Unspecified", "isNot": "Unspecified", "isIn": ["Unspecified"]}
TaskPriorityInternalEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Unspecified"
TaskPriorityInternalEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TaskPriorityInternalEnum
|
|
isNot - TaskPriorityInternalEnum
|
|
isIn - [TaskPriorityInternalEnum]
|
Example
{"is": "Unspecified", "isNot": "Unspecified", "isIn": ["Unspecified"]}
TaskRelationships
Fields
| Field Name | Description |
|---|---|
secondaryVessel - RelationshipDefinition
|
|
laytime - RelationshipDefinition
|
|
voyageEstimate - RelationshipDefinition
|
|
cOA - RelationshipDefinition
|
|
operationsInvoice - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
voyageItinerary - RelationshipDefinition
|
|
firstVoyageCargoHandling - RelationshipDefinition
|
|
firstCargoItinerary - RelationshipDefinition
|
|
port - RelationshipDefinition
|
|
portFunction - RelationshipDefinition
|
|
firstDemTaskCargo - RelationshipDefinition
|
|
firstCargoTaskCargo - RelationshipDefinition
|
|
originalClaim - RelationshipDefinition
|
|
claim - RelationshipDefinition
|
|
lastHosesOffActivity - RelationshipDefinition
|
|
timeCharterDeliveryNotice - RelationshipDefinition
|
|
timeCharterRedeliveryNotice - RelationshipDefinition
|
|
timeCharter - RelationshipDefinition
|
|
spotCoLoadCargo - RelationshipDefinition
|
|
fobFirstCargoHandling - RelationshipDefinition
|
|
firstVoyageEstimatedLaytime - RelationshipDefinition
|
|
vettingVessel - RelationshipDefinition
|
|
allVoyageCargoHandlings - RelationshipDefinition
|
|
demTaskCargoGradesRegular - RelationshipDefinition
|
|
demTaskCargoItinerariesFob - RelationshipDefinition
|
|
demTaskCargoItinerariesFobInternalBu - RelationshipDefinition
|
|
voyageBargePortActivities - RelationshipDefinition
|
|
voyageCargoTradeNoHandlings - RelationshipDefinition
|
|
externalCpartyCargos - RelationshipDefinition
|
|
demurrageTaskLinkedLaytimeCalcs - RelationshipDefinition
|
Example
{
"secondaryVessel": RelationshipDefinition,
"laytime": RelationshipDefinition,
"voyageEstimate": RelationshipDefinition,
"cOA": RelationshipDefinition,
"operationsInvoice": RelationshipDefinition,
"cargo": RelationshipDefinition,
"vessel": RelationshipDefinition,
"voyage": RelationshipDefinition,
"voyageItinerary": RelationshipDefinition,
"firstVoyageCargoHandling": RelationshipDefinition,
"firstCargoItinerary": RelationshipDefinition,
"port": RelationshipDefinition,
"portFunction": RelationshipDefinition,
"firstDemTaskCargo": RelationshipDefinition,
"firstCargoTaskCargo": RelationshipDefinition,
"originalClaim": RelationshipDefinition,
"claim": RelationshipDefinition,
"lastHosesOffActivity": RelationshipDefinition,
"timeCharterDeliveryNotice": RelationshipDefinition,
"timeCharterRedeliveryNotice": RelationshipDefinition,
"timeCharter": RelationshipDefinition,
"spotCoLoadCargo": RelationshipDefinition,
"fobFirstCargoHandling": RelationshipDefinition,
"firstVoyageEstimatedLaytime": RelationshipDefinition,
"vettingVessel": RelationshipDefinition,
"allVoyageCargoHandlings": RelationshipDefinition,
"demTaskCargoGradesRegular": RelationshipDefinition,
"demTaskCargoItinerariesFob": RelationshipDefinition,
"demTaskCargoItinerariesFobInternalBu": RelationshipDefinition,
"voyageBargePortActivities": RelationshipDefinition,
"voyageCargoTradeNoHandlings": RelationshipDefinition,
"externalCpartyCargos": RelationshipDefinition,
"demurrageTaskLinkedLaytimeCalcs": RelationshipDefinition
}
TaskTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
TaskTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TaskTypeEnum
|
|
isNot - TaskTypeEnum
|
|
isIn - [TaskTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
TasksAndAlerts
Fields
| Field Name | Description |
|---|---|
taskID - Int
|
|
objectType - Int
|
|
objectID - Int
|
|
alertID - String
|
|
owner - String
|
|
priority - String
|
|
status - String
|
|
subject - String
|
|
appliesTo - String
|
|
appliesToID - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
orderNo - Int
|
|
colorCode - String
|
|
taskTypeFilter - String
|
|
task - Task
|
|
alert - Alert
|
|
voyage - Voyage
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"taskID": 987,
"objectType": 987,
"objectID": 123,
"alertID": "xyz789",
"owner": "xyz789",
"priority": "xyz789",
"status": "abc123",
"subject": "xyz789",
"appliesTo": "abc123",
"appliesToID": "xyz789",
"vesselCode": "abc123",
"voyageNo": 987,
"orderNo": 123,
"colorCode": "xyz789",
"taskTypeFilter": "xyz789",
"task": Task,
"alert": Alert,
"voyage": Voyage,
"_id": "abc123",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
TasksAndAlertsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TasksAndAlertsFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TasksAndAlertsFormQueryWhere
}
TasksAndAlertsFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TasksAndAlertsFormQueryWhere!]
|
|
or - [TasksAndAlertsFormQueryWhere!]
|
|
rawExpression - String
|
|
task - TaskFormQueryWhere
|
|
alert - AlertFormQueryWhere
|
|
voyage - VoyageFormQueryWhere
|
Example
{
"and": [TasksAndAlertsFormQueryWhere],
"or": [TasksAndAlertsFormQueryWhere],
"rawExpression": "abc123",
"task": TaskFormQueryWhere,
"alert": AlertFormQueryWhere,
"voyage": VoyageFormQueryWhere
}
TasksAndAlertsRelationships
Fields
| Field Name | Description |
|---|---|
task - RelationshipDefinition
|
|
alert - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
Example
{
"task": RelationshipDefinition,
"alert": RelationshipDefinition,
"voyage": RelationshipDefinition
}
Team
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
departmentInfo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
teamID - Int
|
|
name - String
|
|
createDateTimeGmt - Date
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
department - Department
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"departmentInfo": 987,
"customFieldByID": Any,
"customField": Any,
"teamID": 987,
"name": "abc123",
"createDateTimeGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"department": Department,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
TeamFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TeamFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TeamFormQueryWhere
}
TeamFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TeamFormQueryWhere!]
|
|
or - [TeamFormQueryWhere!]
|
|
rawExpression - String
|
|
departmentInfo - NumberWhereValueExpression
|
|
teamID - NumberWhereValueExpression
|
|
name - StringWhereValueExpression
|
|
createDateTimeGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
department - DepartmentFormQueryWhere
|
Example
{
"and": [TeamFormQueryWhere],
"or": [TeamFormQueryWhere],
"rawExpression": "abc123",
"departmentInfo": NumberWhereValueExpression,
"teamID": NumberWhereValueExpression,
"name": StringWhereValueExpression,
"createDateTimeGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"department": DepartmentFormQueryWhere
}
TeamRelationships
Fields
| Field Name | Description |
|---|---|
department - RelationshipDefinition
|
Example
{"department": RelationshipDefinition}
Term
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
type - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
code - Int
|
|
name - String
|
|
description - String
|
|
lastUser - String
|
|
inactive - Boolean
|
|
text - String
|
|
group - String
|
|
lastUpdateGmt - Date
|
|
refType - String
|
|
refName - String
|
|
fuelFactorSetID - Int
|
|
fuelEmissionsFactorsSet - FuelEmissionsFactorsSet
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"type": "xyz789",
"customFieldByID": Any,
"customField": Any,
"code": 987,
"name": "abc123",
"description": "abc123",
"lastUser": "abc123",
"inactive": false,
"text": "abc123",
"group": "abc123",
"lastUpdateGmt": "2007-12-03",
"refType": "abc123",
"refName": "abc123",
"fuelFactorSetID": 987,
"fuelEmissionsFactorsSet": FuelEmissionsFactorsSet,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
TermFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TermFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TermFormQueryWhere
}
TermFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TermFormQueryWhere!]
|
|
or - [TermFormQueryWhere!]
|
|
rawExpression - String
|
|
type - TermTypeEnumValueExpression
|
|
code - NumberWhereValueExpression
|
|
name - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
inactive - BoolWhereValueExpression
|
|
text - StringWhereValueExpression
|
|
group - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
refType - TermRefTypeEnumValueExpression
|
|
refName - StringWhereValueExpression
|
|
fuelFactorSetID - NumberWhereValueExpression
|
|
fuelEmissionsFactorsSet - FuelEmissionsFactorsSetFormQueryWhere
|
Example
{
"and": [TermFormQueryWhere],
"or": [TermFormQueryWhere],
"rawExpression": "xyz789",
"type": TermTypeEnumValueExpression,
"code": NumberWhereValueExpression,
"name": StringWhereValueExpression,
"description": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"inactive": BoolWhereValueExpression,
"text": StringWhereValueExpression,
"group": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"refType": TermRefTypeEnumValueExpression,
"refName": StringWhereValueExpression,
"fuelFactorSetID": NumberWhereValueExpression,
"fuelEmissionsFactorsSet": FuelEmissionsFactorsSetFormQueryWhere
}
TermRefTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
TermRefTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TermRefTypeEnum
|
|
isNot - TermRefTypeEnum
|
|
isIn - [TermRefTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
TermRelationships
Fields
| Field Name | Description |
|---|---|
fuelEmissionsFactorsSet - RelationshipDefinition
|
Example
{"fuelEmissionsFactorsSet": RelationshipDefinition}
TermTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
TermTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TermTypeEnum
|
|
isNot - TermTypeEnum
|
|
isIn - [TermTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
TimeCharterBroker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tcCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
sequenceNo - Int
|
|
brokerShortName - String
|
|
brokerRate - Float
|
|
paymentMethod - String
|
|
commissionType - String
|
|
dateToGmt - Date
|
|
remarks - String
|
|
internalCounterpartyShortName - String
|
|
internalCounterpartySequenceNo - Int
|
|
lastUpdateGmt - Date
|
|
currency - String
|
|
exchangeRateDate - Date
|
|
exchangeRate - Float
|
|
addressBook - AddressBook
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"tcCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"sequenceNo": 987,
"brokerShortName": "abc123",
"brokerRate": 123.45,
"paymentMethod": "abc123",
"commissionType": "abc123",
"dateToGmt": "2007-12-03",
"remarks": "xyz789",
"internalCounterpartyShortName": "abc123",
"internalCounterpartySequenceNo": 987,
"lastUpdateGmt": "2007-12-03",
"currency": "xyz789",
"exchangeRateDate": "2007-12-03",
"exchangeRate": 123.45,
"addressBook": AddressBook,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
TimeCharterBrokerCommissionTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Lump"
TimeCharterBrokerCommissionTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterBrokerCommissionTypeEnum
|
|
isNot - TimeCharterBrokerCommissionTypeEnum
|
|
isIn - [TimeCharterBrokerCommissionTypeEnum]
|
Example
{"is": "Lump", "isNot": "Lump", "isIn": ["Lump"]}
TimeCharterBrokerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterBrokerFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterBrokerFormQueryWhere
}
TimeCharterBrokerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TimeCharterBrokerFormQueryWhere!]
|
|
or - [TimeCharterBrokerFormQueryWhere!]
|
|
rawExpression - String
|
|
tcCode - StringWhereValueExpression
|
|
sequenceNo - NumberWhereValueExpression
|
|
brokerShortName - StringWhereValueExpression
|
|
brokerRate - NumberWhereValueExpression
|
|
paymentMethod - TimeCharterBrokerPaymentMethodEnumValueExpression
|
|
commissionType - TimeCharterBrokerCommissionTypeEnumValueExpression
|
|
dateToGmt - DateWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
internalCounterpartyShortName - StringWhereValueExpression
|
|
internalCounterpartySequenceNo - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
currency - StringWhereValueExpression
|
|
exchangeRateDate - DateWhereValueExpression
|
|
exchangeRate - NumberWhereValueExpression
|
|
addressBook - AddressBookFormQueryWhere
|
Example
{
"and": [TimeCharterBrokerFormQueryWhere],
"or": [TimeCharterBrokerFormQueryWhere],
"rawExpression": "abc123",
"tcCode": StringWhereValueExpression,
"sequenceNo": NumberWhereValueExpression,
"brokerShortName": StringWhereValueExpression,
"brokerRate": NumberWhereValueExpression,
"paymentMethod": TimeCharterBrokerPaymentMethodEnumValueExpression,
"commissionType": TimeCharterBrokerCommissionTypeEnumValueExpression,
"dateToGmt": DateWhereValueExpression,
"remarks": StringWhereValueExpression,
"internalCounterpartyShortName": StringWhereValueExpression,
"internalCounterpartySequenceNo": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"currency": StringWhereValueExpression,
"exchangeRateDate": DateWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"addressBook": AddressBookFormQueryWhere
}
TimeCharterBrokerPaymentMethodEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
TimeCharterBrokerPaymentMethodEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterBrokerPaymentMethodEnum
|
|
isNot - TimeCharterBrokerPaymentMethodEnum
|
|
isIn - [TimeCharterBrokerPaymentMethodEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
TimeCharterBrokerRelationships
Fields
| Field Name | Description |
|---|---|
addressBook - RelationshipDefinition
|
|
childBroker - RelationshipDefinition
|
|
childBrokers - RelationshipDefinition
|
Example
{
"addressBook": RelationshipDefinition,
"childBroker": RelationshipDefinition,
"childBrokers": RelationshipDefinition
}
TimeCharterBunkerDelivery
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
lNGEstDeliveryCV - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
lNGEstRedeliveryCV - Float
|
|
lNGEstDeliveryMMBTUQty - Float
|
|
lNGEstRedeliveryMMBTUQty - Float
|
|
lNGEstDeliveryMMBTUPrc - Float
|
|
lNGEstRedeliveryMMBTUPrc - Float
|
|
lNGActualDeliveryCV - Float
|
|
lNGActualRedeliveryCV - Float
|
|
lNGActualDeliveryMMBTUQty - Float
|
|
lNGActualOrProjectedRedeliveryMMBTUQty - Float
|
|
tcCode - String
|
|
fuelType - String
|
|
estDeliveryQty - Float
|
|
estDeliveryPrice - Float
|
|
actualDeliveryQty - Float
|
|
estRedeliveryQty - Float
|
|
estRedeliveryPrice - Float
|
|
actualOrProjectedRedeliveryQty - Float
|
|
prePurchasedByChartererQty - Float
|
|
prePurchasedByChartererPrice - Float
|
|
forOwnerQty - Float
|
|
forOwnerPrice - Float
|
|
paidByOwnerQty - Float
|
|
paidByOwnerPrice - Float
|
|
supplementToDeliveryQty - Float
|
|
supplementToDeliveryPrice - Float
|
|
isManualBallastPrice - Boolean
|
|
isManualBallastQty - Boolean
|
|
isManualBallastDate - Boolean
|
|
fuelGradeInactive - Boolean
|
|
fuelLubeType - FuelLubeType
|
|
timeCharterContract - TimeCharterContract
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"lNGEstDeliveryCV": 123.45,
"customFieldByID": Any,
"customField": Any,
"lNGEstRedeliveryCV": 123.45,
"lNGEstDeliveryMMBTUQty": 987.65,
"lNGEstRedeliveryMMBTUQty": 123.45,
"lNGEstDeliveryMMBTUPrc": 123.45,
"lNGEstRedeliveryMMBTUPrc": 123.45,
"lNGActualDeliveryCV": 987.65,
"lNGActualRedeliveryCV": 123.45,
"lNGActualDeliveryMMBTUQty": 123.45,
"lNGActualOrProjectedRedeliveryMMBTUQty": 987.65,
"tcCode": "xyz789",
"fuelType": "abc123",
"estDeliveryQty": 987.65,
"estDeliveryPrice": 987.65,
"actualDeliveryQty": 123.45,
"estRedeliveryQty": 123.45,
"estRedeliveryPrice": 987.65,
"actualOrProjectedRedeliveryQty": 123.45,
"prePurchasedByChartererQty": 123.45,
"prePurchasedByChartererPrice": 987.65,
"forOwnerQty": 987.65,
"forOwnerPrice": 987.65,
"paidByOwnerQty": 123.45,
"paidByOwnerPrice": 123.45,
"supplementToDeliveryQty": 123.45,
"supplementToDeliveryPrice": 987.65,
"isManualBallastPrice": false,
"isManualBallastQty": true,
"isManualBallastDate": false,
"fuelGradeInactive": true,
"fuelLubeType": FuelLubeType,
"timeCharterContract": TimeCharterContract,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
TimeCharterBunkerDeliveryFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterBunkerDeliveryFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterBunkerDeliveryFormQueryWhere
}
TimeCharterBunkerDeliveryFormQueryWhere
Fields
Example
{
"and": [TimeCharterBunkerDeliveryFormQueryWhere],
"or": [TimeCharterBunkerDeliveryFormQueryWhere],
"rawExpression": "abc123",
"tcCode": StringWhereValueExpression,
"fuelType": StringWhereValueExpression,
"estDeliveryQty": NumberWhereValueExpression,
"estDeliveryPrice": NumberWhereValueExpression,
"actualDeliveryQty": NumberWhereValueExpression,
"estRedeliveryQty": NumberWhereValueExpression,
"estRedeliveryPrice": NumberWhereValueExpression,
"actualOrProjectedRedeliveryQty": NumberWhereValueExpression,
"prePurchasedByChartererQty": NumberWhereValueExpression,
"prePurchasedByChartererPrice": NumberWhereValueExpression,
"forOwnerQty": NumberWhereValueExpression,
"forOwnerPrice": NumberWhereValueExpression,
"paidByOwnerQty": NumberWhereValueExpression,
"paidByOwnerPrice": NumberWhereValueExpression,
"supplementToDeliveryQty": NumberWhereValueExpression,
"supplementToDeliveryPrice": NumberWhereValueExpression,
"isManualBallastPrice": BoolWhereValueExpression,
"isManualBallastQty": BoolWhereValueExpression,
"isManualBallastDate": BoolWhereValueExpression,
"fuelGradeInactive": BoolWhereValueExpression,
"fuelLubeType": FuelLubeTypeFormQueryWhere,
"timeCharterContract": TimeCharterContractFormQueryWhere
}
TimeCharterBunkerDeliveryRelationships
Fields
| Field Name | Description |
|---|---|
fuelLubeType - RelationshipDefinition
|
|
timeCharterContract - RelationshipDefinition
|
Example
{
"fuelLubeType": RelationshipDefinition,
"timeCharterContract": RelationshipDefinition
}
TimeCharterBunkerExposure
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tcCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
fuelType - String
|
|
delSymbol - String
|
|
redelSymbol - String
|
|
seq - Int
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
timeCharterContract - TimeCharterContract
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"tcCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"fuelType": "abc123",
"delSymbol": "xyz789",
"redelSymbol": "xyz789",
"seq": 987,
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"timeCharterContract": TimeCharterContract,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
TimeCharterBunkerExposureFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterBunkerExposureFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterBunkerExposureFormQueryWhere
}
TimeCharterBunkerExposureFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TimeCharterBunkerExposureFormQueryWhere!]
|
|
or - [TimeCharterBunkerExposureFormQueryWhere!]
|
|
rawExpression - String
|
|
timeCharterContract - TimeCharterContractFormQueryWhere
|
Example
{
"and": [TimeCharterBunkerExposureFormQueryWhere],
"or": [TimeCharterBunkerExposureFormQueryWhere],
"rawExpression": "xyz789",
"timeCharterContract": TimeCharterContractFormQueryWhere
}
TimeCharterBunkerExposureRelationships
Fields
| Field Name | Description |
|---|---|
timeCharterContract - RelationshipDefinition
|
Example
{"timeCharterContract": RelationshipDefinition}
TimeCharterCOA
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
statusCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
iD - String
|
|
contractType - String
|
|
status - String
|
|
counterpartyType - String
|
|
counterpartyShortName - String
|
|
companyCode - String
|
|
actDepartmentCode - String
|
|
tradeAreaNo - Int
|
|
fixtureDate - Date
|
|
fixedBy - String
|
|
startGmt - Date
|
|
endGmt - Date
|
|
shipments - Int
|
|
optionalShipments - Int
|
|
completedShipments - Int
|
|
remainingShipments - Int
|
|
optionDateLocal - Date
|
|
externalRef - String
|
|
refContract - String
|
|
paymentTermsCode - String
|
|
billingPeriod - String
|
|
billingSchedule - String
|
|
shipmentDuration - Float
|
|
shipmentDurationUnit - String
|
|
rebillableAdminFeePct - Float
|
|
curr - String
|
|
exchangeRate - Float
|
|
currBase - String
|
|
confirmationDateGmt - Date
|
|
beneficiaryShortName - String
|
|
beneficiaryType - String
|
|
route - String
|
|
vesselTurnover - Float
|
|
vesselTypeCorrelation - Float
|
|
vesselTypeAdjustment - Float
|
|
strategy - String
|
|
exclRunningCostsFromVoyPnl - Boolean
|
|
isOwnVessel - Boolean
|
|
applyAdjAfterCorrelation - Boolean
|
|
masterContractID - String
|
|
lastUserID - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
beneficiary - AddressBook
|
|
currency - Currency
|
|
paymentTerm - PaymentTerm
|
|
tradeArea - TradeArea
|
|
actDepartment - ActDepartment
|
|
company - Company
|
|
counterparty - AddressBook
|
|
timeCharterCOAVesselTypes - [TimeCharterCOAVesselType]
|
|
timeCharterCOAVessels - [TimeCharterCOAVessel]
|
|
timeCharterCOAHires - [TimeCharterCOAHire]
|
|
timeCharterCOADeliveryRedeliveryOptions - [TimeCharterCOADeliveryRedeliveryOption]
|
|
timeCharterCOAExpenses - [TimeCharterCOAExpense]
|
|
timeCharterCOABrokers - [TimeCharterCOABroker]
|
|
updateTimeCharterCOAMessages - [UpdateTimeCharterCOAMessageRecord]
|
|
Arguments
|
|
changesSinceLast - TimeCharterCOAChangesSinceLast
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"statusCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"iD": "xyz789",
"contractType": "abc123",
"status": "xyz789",
"counterpartyType": "xyz789",
"counterpartyShortName": "xyz789",
"companyCode": "abc123",
"actDepartmentCode": "abc123",
"tradeAreaNo": 123,
"fixtureDate": "2007-12-03",
"fixedBy": "abc123",
"startGmt": "2007-12-03",
"endGmt": "2007-12-03",
"shipments": 987,
"optionalShipments": 123,
"completedShipments": 123,
"remainingShipments": 987,
"optionDateLocal": "2007-12-03",
"externalRef": "xyz789",
"refContract": "abc123",
"paymentTermsCode": "xyz789",
"billingPeriod": "xyz789",
"billingSchedule": "abc123",
"shipmentDuration": 123.45,
"shipmentDurationUnit": "abc123",
"rebillableAdminFeePct": 123.45,
"curr": "abc123",
"exchangeRate": 987.65,
"currBase": "xyz789",
"confirmationDateGmt": "2007-12-03",
"beneficiaryShortName": "abc123",
"beneficiaryType": "abc123",
"route": "xyz789",
"vesselTurnover": 123.45,
"vesselTypeCorrelation": 987.65,
"vesselTypeAdjustment": 123.45,
"strategy": "xyz789",
"exclRunningCostsFromVoyPnl": true,
"isOwnVessel": false,
"applyAdjAfterCorrelation": false,
"masterContractID": "abc123",
"lastUserID": "xyz789",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"beneficiary": AddressBook,
"currency": Currency,
"paymentTerm": PaymentTerm,
"tradeArea": TradeArea,
"actDepartment": ActDepartment,
"company": Company,
"counterparty": AddressBook,
"timeCharterCOAVesselTypes": [TimeCharterCOAVesselType],
"timeCharterCOAVessels": [TimeCharterCOAVessel],
"timeCharterCOAHires": [TimeCharterCOAHire],
"timeCharterCOADeliveryRedeliveryOptions": [
TimeCharterCOADeliveryRedeliveryOption
],
"timeCharterCOAExpenses": [TimeCharterCOAExpense],
"timeCharterCOABrokers": [TimeCharterCOABroker],
"updateTimeCharterCOAMessages": [
UpdateTimeCharterCOAMessageRecord
],
"changesSinceLast": TimeCharterCOAChangesSinceLast,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
TimeCharterCOABillingPeriodEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
TimeCharterCOABillingPeriodEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterCOABillingPeriodEnum
|
|
isNot - TimeCharterCOABillingPeriodEnum
|
|
isIn - [TimeCharterCOABillingPeriodEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
TimeCharterCOABillingScheduleEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"InAdvance"
TimeCharterCOABillingScheduleEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterCOABillingScheduleEnum
|
|
isNot - TimeCharterCOABillingScheduleEnum
|
|
isIn - [TimeCharterCOABillingScheduleEnum]
|
Example
{"is": "InAdvance", "isNot": "InAdvance", "isIn": ["InAdvance"]}
TimeCharterCOABroker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
contractID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seqNo - Int
|
|
brokerShortName - String
|
|
brokerType - String
|
|
brokerRate - Float
|
|
paymentMethod - String
|
|
commissionType - String
|
|
claimCommissionType - String
|
|
effectiveFromGmt - Date
|
|
remarks - String
|
|
internalCounterpartyShortName - String
|
|
internalCounterpartySequenceNo - Int
|
|
lastUserID - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
broker - AddressBook
|
|
timeCharterCOA - TimeCharterCOA
|
|
_keys - [String]
|
|
_intents - [String]
|
|
Example
{
"_id": "xyz789",
"contractID": "abc123",
"customFieldByID": Any,
"customField": Any,
"seqNo": 987,
"brokerShortName": "abc123",
"brokerType": "xyz789",
"brokerRate": 123.45,
"paymentMethod": "abc123",
"commissionType": "abc123",
"claimCommissionType": "abc123",
"effectiveFromGmt": "2007-12-03",
"remarks": "abc123",
"internalCounterpartyShortName": "abc123",
"internalCounterpartySequenceNo": 123,
"lastUserID": "abc123",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"broker": AddressBook,
"timeCharterCOA": TimeCharterCOA,
"_keys": ["xyz789"],
"_intents": ["abc123"]
}
TimeCharterCOABrokerRelationships
Fields
| Field Name | Description |
|---|---|
broker - RelationshipDefinition
|
|
timeCharterCOA - RelationshipDefinition
|
Example
{
"broker": RelationshipDefinition,
"timeCharterCOA": RelationshipDefinition
}
TimeCharterCOAChangesSinceLast
Fields
| Field Name | Description |
|---|---|
updateTimeCharterCOA - MessageUpdateResponse
|
Example
{"updateTimeCharterCOA": MessageUpdateResponse}
TimeCharterCOAContractTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
TimeCharterCOAContractTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterCOAContractTypeEnum
|
|
isNot - TimeCharterCOAContractTypeEnum
|
|
isIn - [TimeCharterCOAContractTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
TimeCharterCOADeliveryRedeliveryOption
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
contractID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
type - String
|
|
seqNo - Int
|
|
portNo - Int
|
|
lastUserID - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
port - Port
|
|
timeCharterCOA - TimeCharterCOA
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"contractID": "xyz789",
"customFieldByID": Any,
"customField": Any,
"type": "abc123",
"seqNo": 987,
"portNo": 123,
"lastUserID": "abc123",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"port": Port,
"timeCharterCOA": TimeCharterCOA,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
TimeCharterCOADeliveryRedeliveryOptionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterCOADeliveryRedeliveryOptionFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterCOADeliveryRedeliveryOptionFormQueryWhere
}
TimeCharterCOADeliveryRedeliveryOptionFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TimeCharterCOADeliveryRedeliveryOptionFormQueryWhere!]
|
|
or - [TimeCharterCOADeliveryRedeliveryOptionFormQueryWhere!]
|
|
rawExpression - String
|
|
contractID - StringWhereValueExpression
|
|
type - TimeCharterCOADeliveryRedeliveryOptionTypeEnumValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
portNo - NumberWhereValueExpression
|
|
lastUserID - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
port - PortFormQueryWhere
|
|
timeCharterCOA - TimeCharterCOAFormQueryWhere
|
Example
{
"and": [
TimeCharterCOADeliveryRedeliveryOptionFormQueryWhere
],
"or": [
TimeCharterCOADeliveryRedeliveryOptionFormQueryWhere
],
"rawExpression": "abc123",
"contractID": StringWhereValueExpression,
"type": TimeCharterCOADeliveryRedeliveryOptionTypeEnumValueExpression,
"seqNo": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"port": PortFormQueryWhere,
"timeCharterCOA": TimeCharterCOAFormQueryWhere
}
TimeCharterCOADeliveryRedeliveryOptionRelationships
Fields
| Field Name | Description |
|---|---|
port - RelationshipDefinition
|
|
timeCharterCOA - RelationshipDefinition
|
Example
{
"port": RelationshipDefinition,
"timeCharterCOA": RelationshipDefinition
}
TimeCharterCOADeliveryRedeliveryOptionTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Delivery"
TimeCharterCOADeliveryRedeliveryOptionTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterCOADeliveryRedeliveryOptionTypeEnum
|
|
isNot - TimeCharterCOADeliveryRedeliveryOptionTypeEnum
|
|
isIn - [TimeCharterCOADeliveryRedeliveryOptionTypeEnum]
|
Example
{"is": "Delivery", "isNot": "Delivery", "isIn": ["Delivery"]}
TimeCharterCOAExpense
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
contractID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seqNo - Int
|
|
billCode - String
|
|
description - String
|
|
rate - Float
|
|
rateType - String
|
|
isCommissionable - Boolean
|
|
dateFromGmtInternal - Date
|
|
dateToGmt - Date
|
|
remarks - String
|
|
lastUserID - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
timeCharterCOA - TimeCharterCOA
|
|
_keys - [String]
|
|
_intents - [String]
|
|
Example
{
"_id": "abc123",
"contractID": "xyz789",
"customFieldByID": Any,
"customField": Any,
"seqNo": 987,
"billCode": "abc123",
"description": "abc123",
"rate": 987.65,
"rateType": "xyz789",
"isCommissionable": true,
"dateFromGmtInternal": "2007-12-03",
"dateToGmt": "2007-12-03",
"remarks": "xyz789",
"lastUserID": "abc123",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"timeCharterCOA": TimeCharterCOA,
"_keys": ["abc123"],
"_intents": ["xyz789"]
}
TimeCharterCOAExpenseRelationships
Fields
| Field Name | Description |
|---|---|
timeCharterCOA - RelationshipDefinition
|
Example
{"timeCharterCOA": RelationshipDefinition}
TimeCharterCOAFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterCOAFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterCOAFormQueryWhere
}
TimeCharterCOAFormQueryWhere
Fields
Example
{
"and": [TimeCharterCOAFormQueryWhere],
"or": [TimeCharterCOAFormQueryWhere],
"rawExpression": "abc123",
"iD": StringWhereValueExpression,
"contractType": TimeCharterCOAContractTypeEnumValueExpression,
"status": TimeCharterCOAStatusEnumValueExpression,
"counterpartyType": StringWhereValueExpression,
"counterpartyShortName": StringWhereValueExpression,
"companyCode": StringWhereValueExpression,
"actDepartmentCode": StringWhereValueExpression,
"tradeAreaNo": NumberWhereValueExpression,
"fixtureDate": DateWhereValueExpression,
"fixedBy": StringWhereValueExpression,
"startGmt": DateWhereValueExpression,
"endGmt": DateWhereValueExpression,
"shipments": NumberWhereValueExpression,
"optionalShipments": NumberWhereValueExpression,
"completedShipments": NumberWhereValueExpression,
"remainingShipments": NumberWhereValueExpression,
"optionDateLocal": DateWhereValueExpression,
"externalRef": StringWhereValueExpression,
"refContract": StringWhereValueExpression,
"paymentTermsCode": StringWhereValueExpression,
"billingPeriod": TimeCharterCOABillingPeriodEnumValueExpression,
"billingSchedule": TimeCharterCOABillingScheduleEnumValueExpression,
"shipmentDuration": NumberWhereValueExpression,
"shipmentDurationUnit": TimeCharterCOAShipmentDurationUnitEnumValueExpression,
"rebillableAdminFeePct": NumberWhereValueExpression,
"curr": StringWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"currBase": StringWhereValueExpression,
"confirmationDateGmt": DateWhereValueExpression,
"beneficiaryShortName": StringWhereValueExpression,
"beneficiaryType": StringWhereValueExpression,
"route": StringWhereValueExpression,
"vesselTurnover": NumberWhereValueExpression,
"vesselTypeCorrelation": NumberWhereValueExpression,
"vesselTypeAdjustment": NumberWhereValueExpression,
"strategy": StringWhereValueExpression,
"exclRunningCostsFromVoyPnl": BoolWhereValueExpression,
"isOwnVessel": BoolWhereValueExpression,
"applyAdjAfterCorrelation": BoolWhereValueExpression,
"masterContractID": StringWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"beneficiary": AddressBookFormQueryWhere,
"currency": CurrencyFormQueryWhere,
"paymentTerm": PaymentTermFormQueryWhere,
"tradeArea": TradeAreaFormQueryWhere,
"actDepartment": ActDepartmentFormQueryWhere,
"company": CompanyFormQueryWhere,
"counterparty": AddressBookFormQueryWhere
}
TimeCharterCOAHire
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
contractID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seqNo - Int
|
|
hireRate - Float
|
|
writeOffRate - Float
|
|
hireRateUnit - String
|
|
lockType - String
|
|
hireFromGmt - Date
|
|
hireToGmt - Date
|
|
periodDurationDays - Float
|
|
customDuration - Boolean
|
|
periodDurationUnit - String
|
|
tclInsRate - Float
|
|
remarks - String
|
|
indexMarket - String
|
|
indexRoute - String
|
|
indexAdjustmentPercent - Float
|
|
indexAdjustmentAmountBase - Float
|
|
indexRateCeiling - Float
|
|
indexRateFloor - Float
|
|
indexBillingMethod - String
|
|
indexBillingDaysFrom - Int
|
|
indexBillingDaysTo - Int
|
|
lastUserID - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
timeCharterCOA - TimeCharterCOA
|
|
_keys - [String]
|
|
_intents - [String]
|
|
Example
{
"_id": "xyz789",
"contractID": "abc123",
"customFieldByID": Any,
"customField": Any,
"seqNo": 123,
"hireRate": 987.65,
"writeOffRate": 987.65,
"hireRateUnit": "xyz789",
"lockType": "xyz789",
"hireFromGmt": "2007-12-03",
"hireToGmt": "2007-12-03",
"periodDurationDays": 123.45,
"customDuration": true,
"periodDurationUnit": "abc123",
"tclInsRate": 987.65,
"remarks": "xyz789",
"indexMarket": "abc123",
"indexRoute": "xyz789",
"indexAdjustmentPercent": 987.65,
"indexAdjustmentAmountBase": 987.65,
"indexRateCeiling": 987.65,
"indexRateFloor": 987.65,
"indexBillingMethod": "xyz789",
"indexBillingDaysFrom": 123,
"indexBillingDaysTo": 987,
"lastUserID": "abc123",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"timeCharterCOA": TimeCharterCOA,
"_keys": ["abc123"],
"_intents": ["xyz789"]
}
TimeCharterCOAHireRelationships
Fields
| Field Name | Description |
|---|---|
timeCharterCOA - RelationshipDefinition
|
Example
{"timeCharterCOA": RelationshipDefinition}
TimeCharterCOARelationships
Fields
| Field Name | Description |
|---|---|
beneficiary - RelationshipDefinition
|
|
currency - RelationshipDefinition
|
|
paymentTerm - RelationshipDefinition
|
|
tradeArea - RelationshipDefinition
|
|
actDepartment - RelationshipDefinition
|
|
company - RelationshipDefinition
|
|
counterparty - RelationshipDefinition
|
|
timeCharterCOAVesselTypes - RelationshipDefinition
|
|
timeCharterCOAVessels - RelationshipDefinition
|
|
timeCharterCOAHires - RelationshipDefinition
|
|
timeCharterCOADeliveryRedeliveryOptions - RelationshipDefinition
|
|
timeCharterCOAExpenses - RelationshipDefinition
|
|
timeCharterCOABrokers - RelationshipDefinition
|
Example
{
"beneficiary": RelationshipDefinition,
"currency": RelationshipDefinition,
"paymentTerm": RelationshipDefinition,
"tradeArea": RelationshipDefinition,
"actDepartment": RelationshipDefinition,
"company": RelationshipDefinition,
"counterparty": RelationshipDefinition,
"timeCharterCOAVesselTypes": RelationshipDefinition,
"timeCharterCOAVessels": RelationshipDefinition,
"timeCharterCOAHires": RelationshipDefinition,
"timeCharterCOADeliveryRedeliveryOptions": RelationshipDefinition,
"timeCharterCOAExpenses": RelationshipDefinition,
"timeCharterCOABrokers": RelationshipDefinition
}
TimeCharterCOAShipmentDurationUnitEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Days"
TimeCharterCOAShipmentDurationUnitEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterCOAShipmentDurationUnitEnum
|
|
isNot - TimeCharterCOAShipmentDurationUnitEnum
|
|
isIn - [TimeCharterCOAShipmentDurationUnitEnum]
|
Example
{"is": "Days", "isNot": "Days", "isIn": ["Days"]}
TimeCharterCOAStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Opportunity"
TimeCharterCOAStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterCOAStatusEnum
|
|
isNot - TimeCharterCOAStatusEnum
|
|
isIn - [TimeCharterCOAStatusEnum]
|
Example
{"is": "Opportunity", "isNot": "Opportunity", "isIn": ["Opportunity"]}
TimeCharterCOAVessel
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
contractID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seqNo - Int
|
|
vesselCode - String
|
|
lastUserID - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
vessel - Vessel
|
|
timeCharterCOA - TimeCharterCOA
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"contractID": "abc123",
"customFieldByID": Any,
"customField": Any,
"seqNo": 123,
"vesselCode": "xyz789",
"lastUserID": "abc123",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"vessel": Vessel,
"timeCharterCOA": TimeCharterCOA,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
TimeCharterCOAVesselFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterCOAVesselFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterCOAVesselFormQueryWhere
}
TimeCharterCOAVesselFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TimeCharterCOAVesselFormQueryWhere!]
|
|
or - [TimeCharterCOAVesselFormQueryWhere!]
|
|
rawExpression - String
|
|
contractID - StringWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
vesselCode - StringWhereValueExpression
|
|
lastUserID - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
vessel - VesselFormQueryWhere
|
|
timeCharterCOA - TimeCharterCOAFormQueryWhere
|
Example
{
"and": [TimeCharterCOAVesselFormQueryWhere],
"or": [TimeCharterCOAVesselFormQueryWhere],
"rawExpression": "xyz789",
"contractID": StringWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"vessel": VesselFormQueryWhere,
"timeCharterCOA": TimeCharterCOAFormQueryWhere
}
TimeCharterCOAVesselRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
|
timeCharterCOA - RelationshipDefinition
|
Example
{
"vessel": RelationshipDefinition,
"timeCharterCOA": RelationshipDefinition
}
TimeCharterCOAVesselType
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
contractID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seqNo - Int
|
|
vesselType - String
|
|
lastUserID - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
timeCharterCOA - TimeCharterCOA
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"contractID": "xyz789",
"customFieldByID": Any,
"customField": Any,
"seqNo": 123,
"vesselType": "xyz789",
"lastUserID": "abc123",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"timeCharterCOA": TimeCharterCOA,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
TimeCharterCOAVesselTypeFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterCOAVesselTypeFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterCOAVesselTypeFormQueryWhere
}
TimeCharterCOAVesselTypeFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TimeCharterCOAVesselTypeFormQueryWhere!]
|
|
or - [TimeCharterCOAVesselTypeFormQueryWhere!]
|
|
rawExpression - String
|
|
contractID - StringWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
vesselType - StringWhereValueExpression
|
|
lastUserID - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
timeCharterCOA - TimeCharterCOAFormQueryWhere
|
Example
{
"and": [TimeCharterCOAVesselTypeFormQueryWhere],
"or": [TimeCharterCOAVesselTypeFormQueryWhere],
"rawExpression": "abc123",
"contractID": StringWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"vesselType": StringWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"timeCharterCOA": TimeCharterCOAFormQueryWhere
}
TimeCharterCOAVesselTypeRelationships
Fields
| Field Name | Description |
|---|---|
timeCharterCOA - RelationshipDefinition
|
Example
{"timeCharterCOA": RelationshipDefinition}
TimeCharterContract
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tcCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
vesselCode - String
|
|
vesselName - String
|
|
counterpartyShortName - String
|
|
fixtureDate - Date
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
beaufortScaleNo - Int
|
|
legacyDeliveryTimeGmt - Date
|
|
tcType - String
|
|
vendorType - String
|
|
timeCharterTcForm_LastUser - String
|
|
charteringCoordinatorName - String
|
|
vesselSpeedLaden - Float
|
|
vesselSpeedBallast - Float
|
|
maxDuration - Float
|
|
minDuration - Float
|
|
durationUnit - String
|
|
beneficiaryShortName - String
|
|
beneficiaryType - String
|
|
heavy - Boolean
|
|
intermediate - Boolean
|
|
light - Boolean
|
|
timeCharterTcForm_Opportunity - Boolean
|
|
subject - Boolean
|
|
fixed - Boolean
|
|
started - Boolean
|
|
finished - Boolean
|
|
closed - Boolean
|
|
counterpartyType - String
|
|
curr - String
|
|
exchangeRate - Float
|
|
paymentTermsCode - String
|
|
paymentTermsRemarks - String
|
|
maxBoilOffBallast - Float
|
|
maxBoilOffLaden - Float
|
|
strategy - String
|
|
opsCoordinator - String
|
|
seaForceNo - Int
|
|
swellStateNo - Int
|
|
departmentNo - Int
|
|
teamNo - Int
|
|
baseCurr - String
|
|
minLessDays - Float
|
|
minMoreDays - Float
|
|
maxLessDays - Float
|
|
maxMoreDays - Float
|
|
badWeatherHours - Float
|
|
parentMirroredContractID - String
|
|
childMirroredContractID - String
|
|
iCCompanyCode - String
|
|
iCAdjPercent - Float
|
|
actDepartmentCode - String
|
|
controller - String
|
|
financeCoordinator - String
|
|
invoiceCurr - String
|
|
invoiceCurrExchangeRate - Float
|
|
minRedeliveryDateGmt - Date
|
|
maxRedeliveryDateGmt - Date
|
|
confirmationDateGmt - Date
|
|
vesselRef - String
|
|
referenceContract - String
|
|
deliveryDate - Date
|
|
redeliveryDate - Date
|
|
billPeriodDays - Float
|
|
minRedelDate - Date
|
|
maxRedelDate - Date
|
|
status - String
|
|
durationHours - Float
|
|
billingPeriodDesc - String
|
|
billingScheduleDesc - String
|
|
optionsCount - Int
|
|
profitShareCount - Int
|
|
hasProfitSharing - Boolean
|
|
contractType - String
|
|
vesselHeadOwner - String
|
|
hFPurchaseCommRateType - String
|
|
hFSaleCommRateType - String
|
|
hFPurchaseStatus - String
|
|
hFSaleStatus - String
|
|
age - Int
|
|
bunkerTypes - String
|
|
bunkerEstDelQtys - String
|
|
bunkerActDelQtys - String
|
|
bunkerEstRedelQtys - String
|
|
bunkerActOrProjRedelQtys - String
|
|
tciVoyageCount - Int
|
|
tcoVoyageCount - Int
|
|
deliveryDateLocal - Date
|
|
redeliveryDateLocal - Date
|
|
minRedelDateLocal - Date
|
|
maxRedelDateLocal - Date
|
|
minRedelDays - Float
|
|
maxRedelDays - Float
|
|
unpricedElementRemark - String
|
|
fixedBy - String
|
|
hasPurchaseOptionReminder - Boolean
|
|
purchaseOptionReminderText - String
|
|
purchaseOptionReminderRecipients - String
|
|
hasLiftingOptionReminder - Boolean
|
|
liftingOptionReminderText - String
|
|
liftingOptionReminderRecipients - String
|
|
rebillableAdminFee - Float
|
|
deliveryNotice - String
|
|
redeliveryNotice - String
|
|
deliveryRedeliveryNoticeSyncSetting - String
|
|
tradeAreaName - String
|
|
leaseTransitionDate - Date
|
|
valuationWorksheetName - Any
|
|
brokersList - String
|
|
emissionsPaymentTermsRemarks - String
|
|
sqlID - Int
|
|
notesToOperations - String
|
|
deliveryPortName - String
|
|
redeliveryPortName - String
|
|
deliveryPortNo - Int
|
|
redeliveryPortNo - Int
|
|
statusCode - Int
|
|
bonusCommissionable - Int
|
|
estDeliveryDateGmt - Date
|
|
projActDeliveryDateGmt - Date
|
|
estRedeliveryDateGmt - Date
|
|
projActRedeliveryDateGmt - Date
|
|
gratuitiesPer30Days - Float
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
liftingOptionDays - Int
|
|
companyCode - String
|
|
externalRef - String
|
|
tradeAreaPortNo - Int
|
|
route - String
|
|
vesselTypeCorrelation - Float
|
|
tripTC - Boolean
|
|
bunkerOnConsumption - Boolean
|
|
hasGratuitiesPer30Days - Boolean
|
|
gratuitiesAvgMonthly - Boolean
|
|
gratuitiesMonthly - Boolean
|
|
bunkerOwner - Boolean
|
|
bunkerRebillable - Boolean
|
|
onSubjects - Boolean
|
|
durationBasisMin - Boolean
|
|
durationBasisMax - Boolean
|
|
extendRedelivery - Boolean
|
|
opportunity - Boolean
|
|
deliveryRobFromSurvey - Boolean
|
|
redeliveryRobFromSurvey - Boolean
|
|
durationBasisOption - Boolean
|
|
durationBasisMid - Boolean
|
|
userOverwriteEstRedel - Boolean
|
|
vslTypeCorrOverriden - Boolean
|
|
manualDeliveryInfo - Boolean
|
|
manualRedeliveryInfo - Boolean
|
|
longTermTC - Boolean
|
|
ownVessel - Boolean
|
|
intercompany - Boolean
|
|
intercompanyMaster - Boolean
|
|
intercompanySlave - Boolean
|
|
useDeliveryBunkerLast - Boolean
|
|
unpricedBunkers - Boolean
|
|
lockPorts - Boolean
|
|
lockDates - Boolean
|
|
lockBunkers - Boolean
|
|
headFixture - Boolean
|
|
exposureBasisOpenDate - Boolean
|
|
flags - Int
|
|
optionStartDateLocal - Date
|
|
lobCode - String
|
|
coaID - Int
|
|
billingPeriod - String
|
|
deliveryRemarks - String
|
|
redeliveryRemarks - String
|
|
remarks - String
|
|
cpOffhireDays - Float
|
|
cpOffhireUnit - String
|
|
vesselTurnover - Float
|
|
segment - String
|
|
purchaseOptionDeclaredDate - Date
|
|
purchaseOptionReminderWindowDays - Float
|
|
purchaseOptionType - String
|
|
purchaseOptionCurrSpreadHigh - Float
|
|
purchaseOptionCurrSpreadLow - Float
|
|
shareInContract - Float
|
|
statusUnderConstruction - Boolean
|
|
statusPurchasedNotDelivered - Boolean
|
|
statusSoldNotRedelivered - Boolean
|
|
statusCancelled - Boolean
|
|
statusWithdrawn - Boolean
|
|
manualMinRedelivery - Boolean
|
|
manualMaxRedelivery - Boolean
|
|
useLocalTime - Boolean
|
|
billingScheduleInArrears - Boolean
|
|
laycanConfirmed - Boolean
|
|
excludeHireFromVoyagePnl - Boolean
|
|
enableVoyageDataFlowToMirror - Boolean
|
|
bareboat - Boolean
|
|
allocatePnlToMirroredTcoVoyage - Boolean
|
|
syncNoticeDatesWithEstDates - Boolean
|
|
syncNoticeDatesWithActualDates - Boolean
|
|
childReletContract - Boolean
|
|
childReletContractMirror - Boolean
|
|
leaseAccounting - Boolean
|
|
leaseAccountingManuallySet - Boolean
|
|
applyAdjustmentAfterCorrelation - Boolean
|
|
basisExcludesOptionPeriod - Boolean
|
|
isExposureDaysManual - Boolean
|
|
isExposureTceManual - Boolean
|
|
splitExposureRouteFormula - Boolean
|
|
liftingOptionReminderWindowDays - Float
|
|
monthlyMRAllowance - Float
|
|
vesselTypeAdjustment - Float
|
|
warrantyAllowanceHours - Float
|
|
fuelWarrantyAtAnchorage - Float
|
|
warrantyLoadHours - Float
|
|
warrantyDiscHours - Float
|
|
reliqWarrantyThreshold - Float
|
|
warrantyLoadFuel - Float
|
|
warrantyDiscFuel - Float
|
|
entryUserID - String
|
|
benchmarkEstimateID - String
|
|
tcCoaContractID - String
|
|
valuationID - Int
|
|
lNGEstDeliveryCV - Float
|
|
lNGEstRedeliveryCV - Float
|
|
lNGActualDeliveryCV - Float
|
|
lNGActualRedeliveryCV - Float
|
|
emissionsSettlementType - String
|
|
emissionsBillingPeriod - String
|
|
emissionsPaymentTermsCode - String
|
|
disableUseOfDeclarationDateAsExp - Boolean
|
|
enableUseOfDeclarationDateAsExp - Boolean
|
|
includePendingAllowanceInvoicesInPnL - Boolean
|
|
isManualCarbonPricingMethod - Boolean
|
|
additionalFlags2 - Int
|
|
docHolderName - String
|
|
docHolderType - String
|
|
allowanceDefaultPriceMode - String
|
|
fuelEUCalcDefault - String
|
|
emissionPaymentTerms - PaymentTerm
|
|
benchmarkEstimate - VoyageEstimate
|
|
valuationWorksheet - Worksheet
|
|
timeCharterCOA - TimeCharterCOA
|
|
redeliveryPort - Port
|
|
deliveryPort - Port
|
|
tradeArea - TradeArea
|
|
lob - Lob
|
|
vessel - Vessel
|
|
actDepartment - ActDepartment
|
|
addressBook - AddressBook
|
|
addressBookBeneficiary - AddressBook
|
|
department - Department
|
|
team - Team
|
|
company - Company
|
|
firstTcBroker - TimeCharterBroker
|
|
currentVoyage - Voyage
|
|
previousVoyage - Voyage
|
|
nextVoyage - Voyage
|
|
adminFee - TimeCharterExpense
|
|
firstIndexLinkedHire - TimeCharterHire
|
|
firstLiftingOption - TimeCharterLiftingOption
|
|
hFPurchase - HeadFixturePurchaseSale
|
|
hFPurchaseFirstPayment - HeadFixturePurchaseSale
|
|
hFPurchaseFirstBroker - HeadFixturePurchaseSale
|
|
hFSale - HeadFixturePurchaseSale
|
|
hFSaleFirstPayment - HeadFixturePurchaseSale
|
|
hFSaleFirstBroker - HeadFixturePurchaseSale
|
|
tcUnpricedElementRemark - UnpricedElementRemark
|
|
purchaseOptionReminder - Reminder
|
|
liftingOptionReminder - Reminder
|
|
parentMirroredContract - TimeCharterContract
|
|
childMirroredContract - TimeCharterContract
|
|
timeCharterTonnageTaxs - [TimeCharterTonnageTax]
|
|
timeCharterSeaConsumptions - [TimeCharterSeaConsumption]
|
|
timeCharterPurchaseOptions - [TimeCharterPurchaseOption]
|
|
timeCharterProfitShareContracts - [TimeCharterProfitShareContracts]
|
|
timeCharterWarrantyDelayExclusions - [TimeCharterWarrantyDelayExclusion]
|
|
timeCharterWarrantyConsumptions - [TimeCharterWarrantyConsumption]
|
|
timeCharterPortConsumptions - [TimeCharterPortConsumption]
|
|
timeCharterProfitShares - [TimeCharterProfitShare]
|
|
timeCharterExposurePeriods - [TimeCharterExposurePeriod]
|
|
unpricedElements - [UnpricedElement]
|
|
headFixturePurchaseSales - [HeadFixturePurchaseSale]
|
|
firstTcHire - [TimeCharterHire]
|
|
timeCharterExpenses - [TimeCharterExpense]
|
|
tcBrokers - [TimeCharterBroker]
|
|
timeCharterHires - [TimeCharterHire]
|
|
timeCharterLiftingOptions - [TimeCharterLiftingOption]
|
|
timeCharterBunkerDeliveries - [TimeCharterBunkerDelivery]
|
|
voyages - [Voyage]
|
|
cargoLinkedTrades - [CargoLinkedTrade]
|
|
deliveryNoticeHeaders - [TimeCharterExtra]
|
|
redeliveryNoticeHeaders - [TimeCharterExtra]
|
|
otherInformation - [TimeCharterExtra]
|
|
tciVoyages - [Voyage]
|
|
tcoVoyages - [Voyage]
|
|
alerts - [Alert]
|
|
tasks - [Task]
|
|
operationsInvoice - [OperationsInvoice]
|
|
timeCharterProjectedInvoice - [TimeCharterProjectedInvoice]
|
|
timeCharterLeaseServiceSchedule - [TimeCharterExpense]
|
|
timeCharterLease - [TimeCharterLease]
|
|
timeCharterBunkerExposure - [TimeCharterBunkerExposure]
|
|
mirroredContracts - [TimeCharterContract]
|
|
bareboatContracts - [BareboatContract]
|
|
updateEquipmentContractMessages - [UpdateEquipmentContractMessageRecord]
|
|
Arguments
|
|
updateTimeCharterMessages - [UpdateTimeCharterMessageRecord]
|
|
Arguments
|
|
changesSinceLast - TimeCharterContractChangesSinceLast
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"tcCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"vesselCode": "abc123",
"vesselName": "abc123",
"counterpartyShortName": "xyz789",
"fixtureDate": "2007-12-03",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"beaufortScaleNo": 123,
"legacyDeliveryTimeGmt": "2007-12-03",
"tcType": "abc123",
"vendorType": "abc123",
"timeCharterTcForm_LastUser": "abc123",
"charteringCoordinatorName": "abc123",
"vesselSpeedLaden": 987.65,
"vesselSpeedBallast": 987.65,
"maxDuration": 123.45,
"minDuration": 123.45,
"durationUnit": "xyz789",
"beneficiaryShortName": "abc123",
"beneficiaryType": "abc123",
"heavy": true,
"intermediate": false,
"light": false,
"timeCharterTcForm_Opportunity": true,
"subject": false,
"fixed": true,
"started": true,
"finished": true,
"closed": true,
"counterpartyType": "abc123",
"curr": "abc123",
"exchangeRate": 123.45,
"paymentTermsCode": "abc123",
"paymentTermsRemarks": "xyz789",
"maxBoilOffBallast": 123.45,
"maxBoilOffLaden": 987.65,
"strategy": "abc123",
"opsCoordinator": "xyz789",
"seaForceNo": 123,
"swellStateNo": 123,
"departmentNo": 123,
"teamNo": 123,
"baseCurr": "abc123",
"minLessDays": 123.45,
"minMoreDays": 123.45,
"maxLessDays": 987.65,
"maxMoreDays": 987.65,
"badWeatherHours": 123.45,
"parentMirroredContractID": "abc123",
"childMirroredContractID": "xyz789",
"iCCompanyCode": "xyz789",
"iCAdjPercent": 987.65,
"actDepartmentCode": "abc123",
"controller": "xyz789",
"financeCoordinator": "xyz789",
"invoiceCurr": "abc123",
"invoiceCurrExchangeRate": 987.65,
"minRedeliveryDateGmt": "2007-12-03",
"maxRedeliveryDateGmt": "2007-12-03",
"confirmationDateGmt": "2007-12-03",
"vesselRef": "xyz789",
"referenceContract": "abc123",
"deliveryDate": "2007-12-03",
"redeliveryDate": "2007-12-03",
"billPeriodDays": 987.65,
"minRedelDate": "2007-12-03",
"maxRedelDate": "2007-12-03",
"status": "xyz789",
"durationHours": 123.45,
"billingPeriodDesc": "abc123",
"billingScheduleDesc": "xyz789",
"optionsCount": 123,
"profitShareCount": 987,
"hasProfitSharing": false,
"contractType": "xyz789",
"vesselHeadOwner": "abc123",
"hFPurchaseCommRateType": "abc123",
"hFSaleCommRateType": "abc123",
"hFPurchaseStatus": "xyz789",
"hFSaleStatus": "abc123",
"age": 987,
"bunkerTypes": "abc123",
"bunkerEstDelQtys": "xyz789",
"bunkerActDelQtys": "abc123",
"bunkerEstRedelQtys": "abc123",
"bunkerActOrProjRedelQtys": "xyz789",
"tciVoyageCount": 123,
"tcoVoyageCount": 987,
"deliveryDateLocal": "2007-12-03",
"redeliveryDateLocal": "2007-12-03",
"minRedelDateLocal": "2007-12-03",
"maxRedelDateLocal": "2007-12-03",
"minRedelDays": 123.45,
"maxRedelDays": 123.45,
"unpricedElementRemark": "abc123",
"fixedBy": "xyz789",
"hasPurchaseOptionReminder": true,
"purchaseOptionReminderText": "abc123",
"purchaseOptionReminderRecipients": "xyz789",
"hasLiftingOptionReminder": false,
"liftingOptionReminderText": "xyz789",
"liftingOptionReminderRecipients": "xyz789",
"rebillableAdminFee": 123.45,
"deliveryNotice": "xyz789",
"redeliveryNotice": "abc123",
"deliveryRedeliveryNoticeSyncSetting": "abc123",
"tradeAreaName": "xyz789",
"leaseTransitionDate": "2007-12-03",
"valuationWorksheetName": Any,
"brokersList": "xyz789",
"emissionsPaymentTermsRemarks": "abc123",
"sqlID": 123,
"notesToOperations": "abc123",
"deliveryPortName": "abc123",
"redeliveryPortName": "abc123",
"deliveryPortNo": 123,
"redeliveryPortNo": 987,
"statusCode": 123,
"bonusCommissionable": 987,
"estDeliveryDateGmt": "2007-12-03",
"projActDeliveryDateGmt": "2007-12-03",
"estRedeliveryDateGmt": "2007-12-03",
"projActRedeliveryDateGmt": "2007-12-03",
"gratuitiesPer30Days": 123.45,
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUser": "xyz789",
"liftingOptionDays": 987,
"companyCode": "abc123",
"externalRef": "xyz789",
"tradeAreaPortNo": 123,
"route": "xyz789",
"vesselTypeCorrelation": 123.45,
"tripTC": true,
"bunkerOnConsumption": false,
"hasGratuitiesPer30Days": true,
"gratuitiesAvgMonthly": true,
"gratuitiesMonthly": false,
"bunkerOwner": false,
"bunkerRebillable": false,
"onSubjects": true,
"durationBasisMin": false,
"durationBasisMax": true,
"extendRedelivery": true,
"opportunity": false,
"deliveryRobFromSurvey": false,
"redeliveryRobFromSurvey": false,
"durationBasisOption": true,
"durationBasisMid": false,
"userOverwriteEstRedel": false,
"vslTypeCorrOverriden": false,
"manualDeliveryInfo": true,
"manualRedeliveryInfo": false,
"longTermTC": true,
"ownVessel": false,
"intercompany": false,
"intercompanyMaster": true,
"intercompanySlave": true,
"useDeliveryBunkerLast": false,
"unpricedBunkers": false,
"lockPorts": false,
"lockDates": false,
"lockBunkers": true,
"headFixture": true,
"exposureBasisOpenDate": false,
"flags": 123,
"optionStartDateLocal": "2007-12-03",
"lobCode": "xyz789",
"coaID": 987,
"billingPeriod": "xyz789",
"deliveryRemarks": "xyz789",
"redeliveryRemarks": "abc123",
"remarks": "xyz789",
"cpOffhireDays": 123.45,
"cpOffhireUnit": "xyz789",
"vesselTurnover": 123.45,
"segment": "xyz789",
"purchaseOptionDeclaredDate": "2007-12-03",
"purchaseOptionReminderWindowDays": 123.45,
"purchaseOptionType": "xyz789",
"purchaseOptionCurrSpreadHigh": 987.65,
"purchaseOptionCurrSpreadLow": 987.65,
"shareInContract": 123.45,
"statusUnderConstruction": true,
"statusPurchasedNotDelivered": true,
"statusSoldNotRedelivered": true,
"statusCancelled": true,
"statusWithdrawn": false,
"manualMinRedelivery": false,
"manualMaxRedelivery": true,
"useLocalTime": false,
"billingScheduleInArrears": true,
"laycanConfirmed": false,
"excludeHireFromVoyagePnl": false,
"enableVoyageDataFlowToMirror": false,
"bareboat": true,
"allocatePnlToMirroredTcoVoyage": false,
"syncNoticeDatesWithEstDates": true,
"syncNoticeDatesWithActualDates": false,
"childReletContract": false,
"childReletContractMirror": false,
"leaseAccounting": false,
"leaseAccountingManuallySet": true,
"applyAdjustmentAfterCorrelation": false,
"basisExcludesOptionPeriod": true,
"isExposureDaysManual": false,
"isExposureTceManual": false,
"splitExposureRouteFormula": true,
"liftingOptionReminderWindowDays": 123.45,
"monthlyMRAllowance": 987.65,
"vesselTypeAdjustment": 123.45,
"warrantyAllowanceHours": 987.65,
"fuelWarrantyAtAnchorage": 987.65,
"warrantyLoadHours": 987.65,
"warrantyDiscHours": 987.65,
"reliqWarrantyThreshold": 123.45,
"warrantyLoadFuel": 987.65,
"warrantyDiscFuel": 987.65,
"entryUserID": "xyz789",
"benchmarkEstimateID": "abc123",
"tcCoaContractID": "xyz789",
"valuationID": 123,
"lNGEstDeliveryCV": 123.45,
"lNGEstRedeliveryCV": 987.65,
"lNGActualDeliveryCV": 123.45,
"lNGActualRedeliveryCV": 123.45,
"emissionsSettlementType": "xyz789",
"emissionsBillingPeriod": "xyz789",
"emissionsPaymentTermsCode": "abc123",
"disableUseOfDeclarationDateAsExp": true,
"enableUseOfDeclarationDateAsExp": true,
"includePendingAllowanceInvoicesInPnL": false,
"isManualCarbonPricingMethod": true,
"additionalFlags2": 987,
"docHolderName": "xyz789",
"docHolderType": "abc123",
"allowanceDefaultPriceMode": "abc123",
"fuelEUCalcDefault": "abc123",
"emissionPaymentTerms": PaymentTerm,
"benchmarkEstimate": VoyageEstimate,
"valuationWorksheet": Worksheet,
"timeCharterCOA": TimeCharterCOA,
"redeliveryPort": Port,
"deliveryPort": Port,
"tradeArea": TradeArea,
"lob": Lob,
"vessel": Vessel,
"actDepartment": ActDepartment,
"addressBook": AddressBook,
"addressBookBeneficiary": AddressBook,
"department": Department,
"team": Team,
"company": Company,
"firstTcBroker": TimeCharterBroker,
"currentVoyage": Voyage,
"previousVoyage": Voyage,
"nextVoyage": Voyage,
"adminFee": TimeCharterExpense,
"firstIndexLinkedHire": TimeCharterHire,
"firstLiftingOption": TimeCharterLiftingOption,
"hFPurchase": HeadFixturePurchaseSale,
"hFPurchaseFirstPayment": HeadFixturePurchaseSale,
"hFPurchaseFirstBroker": HeadFixturePurchaseSale,
"hFSale": HeadFixturePurchaseSale,
"hFSaleFirstPayment": HeadFixturePurchaseSale,
"hFSaleFirstBroker": HeadFixturePurchaseSale,
"tcUnpricedElementRemark": UnpricedElementRemark,
"purchaseOptionReminder": Reminder,
"liftingOptionReminder": Reminder,
"parentMirroredContract": TimeCharterContract,
"childMirroredContract": TimeCharterContract,
"timeCharterTonnageTaxs": [TimeCharterTonnageTax],
"timeCharterSeaConsumptions": [
TimeCharterSeaConsumption
],
"timeCharterPurchaseOptions": [
TimeCharterPurchaseOption
],
"timeCharterProfitShareContracts": [
TimeCharterProfitShareContracts
],
"timeCharterWarrantyDelayExclusions": [
TimeCharterWarrantyDelayExclusion
],
"timeCharterWarrantyConsumptions": [
TimeCharterWarrantyConsumption
],
"timeCharterPortConsumptions": [
TimeCharterPortConsumption
],
"timeCharterProfitShares": [TimeCharterProfitShare],
"timeCharterExposurePeriods": [
TimeCharterExposurePeriod
],
"unpricedElements": [UnpricedElement],
"headFixturePurchaseSales": [HeadFixturePurchaseSale],
"firstTcHire": [TimeCharterHire],
"timeCharterExpenses": [TimeCharterExpense],
"tcBrokers": [TimeCharterBroker],
"timeCharterHires": [TimeCharterHire],
"timeCharterLiftingOptions": [TimeCharterLiftingOption],
"timeCharterBunkerDeliveries": [
TimeCharterBunkerDelivery
],
"voyages": [Voyage],
"cargoLinkedTrades": [CargoLinkedTrade],
"deliveryNoticeHeaders": [TimeCharterExtra],
"redeliveryNoticeHeaders": [TimeCharterExtra],
"otherInformation": [TimeCharterExtra],
"tciVoyages": [Voyage],
"tcoVoyages": [Voyage],
"alerts": [Alert],
"tasks": [Task],
"operationsInvoice": [OperationsInvoice],
"timeCharterProjectedInvoice": [
TimeCharterProjectedInvoice
],
"timeCharterLeaseServiceSchedule": [TimeCharterExpense],
"timeCharterLease": [TimeCharterLease],
"timeCharterBunkerExposure": [
TimeCharterBunkerExposure
],
"mirroredContracts": [TimeCharterContract],
"bareboatContracts": [BareboatContract],
"updateEquipmentContractMessages": [
UpdateEquipmentContractMessageRecord
],
"updateTimeCharterMessages": [
UpdateTimeCharterMessageRecord
],
"changesSinceLast": TimeCharterContractChangesSinceLast,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
TimeCharterContractAlertRulesRequest
TimeCharterContractAllowanceDefaultPriceModeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PurchasePrice"
TimeCharterContractAllowanceDefaultPriceModeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterContractAllowanceDefaultPriceModeEnum
|
|
isNot - TimeCharterContractAllowanceDefaultPriceModeEnum
|
|
isIn - [TimeCharterContractAllowanceDefaultPriceModeEnum]
|
Example
{"is": "PurchasePrice", "isNot": "PurchasePrice", "isIn": ["PurchasePrice"]}
TimeCharterContractBillingPeriodEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
TimeCharterContractBillingPeriodEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterContractBillingPeriodEnum
|
|
isNot - TimeCharterContractBillingPeriodEnum
|
|
isIn - [TimeCharterContractBillingPeriodEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
TimeCharterContractChangesSinceLast
Fields
| Field Name | Description |
|---|---|
updateEquipmentContract - MessageUpdateResponse
|
|
updateTimeCharter - MessageUpdateResponse
|
Example
{
"updateEquipmentContract": MessageUpdateResponse,
"updateTimeCharter": MessageUpdateResponse
}
TimeCharterContractDurationUnitEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Days"
TimeCharterContractDurationUnitEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterContractDurationUnitEnum
|
|
isNot - TimeCharterContractDurationUnitEnum
|
|
isIn - [TimeCharterContractDurationUnitEnum]
|
Example
{"is": "Days", "isNot": "Days", "isIn": ["Days"]}
TimeCharterContractEmissionsBillingPeriodEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
TimeCharterContractEmissionsBillingPeriodEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterContractEmissionsBillingPeriodEnum
|
|
isNot - TimeCharterContractEmissionsBillingPeriodEnum
|
|
isIn - [TimeCharterContractEmissionsBillingPeriodEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
TimeCharterContractEmissionsSettlementTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NA"
TimeCharterContractEmissionsSettlementTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterContractEmissionsSettlementTypeEnum
|
|
isNot - TimeCharterContractEmissionsSettlementTypeEnum
|
|
isIn - [TimeCharterContractEmissionsSettlementTypeEnum]
|
Example
{"is": "NA", "isNot": "NA", "isIn": ["NA"]}
TimeCharterContractFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterContractFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterContractFormQueryWhere
}
TimeCharterContractFormQueryWhere
Fields
Example
{
"and": [TimeCharterContractFormQueryWhere],
"or": [TimeCharterContractFormQueryWhere],
"rawExpression": "xyz789",
"tcCode": StringWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"vesselName": StringWhereValueExpression,
"counterpartyShortName": StringWhereValueExpression,
"fixtureDate": DateWhereValueExpression,
"laycanFromLocal": DateWhereValueExpression,
"laycanToLocal": DateWhereValueExpression,
"beaufortScaleNo": NumberWhereValueExpression,
"legacyDeliveryTimeGmt": DateWhereValueExpression,
"tcType": TimeCharterContractTcTypeEnumValueExpression,
"vendorType": StringWhereValueExpression,
"timeCharterTcForm_LastUser": StringWhereValueExpression,
"charteringCoordinatorName": StringWhereValueExpression,
"vesselSpeedLaden": NumberWhereValueExpression,
"vesselSpeedBallast": NumberWhereValueExpression,
"maxDuration": NumberWhereValueExpression,
"minDuration": NumberWhereValueExpression,
"durationUnit": TimeCharterContractDurationUnitEnumValueExpression,
"beneficiaryShortName": StringWhereValueExpression,
"beneficiaryType": StringWhereValueExpression,
"heavy": BoolWhereValueExpression,
"intermediate": BoolWhereValueExpression,
"light": BoolWhereValueExpression,
"timeCharterTcForm_Opportunity": BoolWhereValueExpression,
"subject": BoolWhereValueExpression,
"fixed": BoolWhereValueExpression,
"started": BoolWhereValueExpression,
"finished": BoolWhereValueExpression,
"closed": BoolWhereValueExpression,
"counterpartyType": StringWhereValueExpression,
"curr": StringWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"paymentTermsCode": StringWhereValueExpression,
"paymentTermsRemarks": StringWhereValueExpression,
"maxBoilOffBallast": NumberWhereValueExpression,
"maxBoilOffLaden": NumberWhereValueExpression,
"strategy": StringWhereValueExpression,
"opsCoordinator": StringWhereValueExpression,
"seaForceNo": NumberWhereValueExpression,
"swellStateNo": NumberWhereValueExpression,
"departmentNo": NumberWhereValueExpression,
"teamNo": NumberWhereValueExpression,
"baseCurr": StringWhereValueExpression,
"minLessDays": NumberWhereValueExpression,
"minMoreDays": NumberWhereValueExpression,
"maxLessDays": NumberWhereValueExpression,
"maxMoreDays": NumberWhereValueExpression,
"badWeatherHours": NumberWhereValueExpression,
"parentMirroredContractID": StringWhereValueExpression,
"childMirroredContractID": StringWhereValueExpression,
"iCCompanyCode": StringWhereValueExpression,
"iCAdjPercent": NumberWhereValueExpression,
"actDepartmentCode": StringWhereValueExpression,
"controller": StringWhereValueExpression,
"financeCoordinator": StringWhereValueExpression,
"invoiceCurr": StringWhereValueExpression,
"invoiceCurrExchangeRate": NumberWhereValueExpression,
"minRedeliveryDateGmt": DateWhereValueExpression,
"maxRedeliveryDateGmt": DateWhereValueExpression,
"confirmationDateGmt": DateWhereValueExpression,
"vesselRef": StringWhereValueExpression,
"referenceContract": StringWhereValueExpression,
"notesToOperations": StringWhereValueExpression,
"deliveryPortName": StringWhereValueExpression,
"redeliveryPortName": StringWhereValueExpression,
"deliveryPortNo": NumberWhereValueExpression,
"redeliveryPortNo": NumberWhereValueExpression,
"statusCode": NumberWhereValueExpression,
"bonusCommissionable": NumberWhereValueExpression,
"estDeliveryDateGmt": DateWhereValueExpression,
"projActDeliveryDateGmt": DateWhereValueExpression,
"estRedeliveryDateGmt": DateWhereValueExpression,
"projActRedeliveryDateGmt": DateWhereValueExpression,
"gratuitiesPer30Days": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"liftingOptionDays": NumberWhereValueExpression,
"companyCode": StringWhereValueExpression,
"externalRef": StringWhereValueExpression,
"tradeAreaPortNo": NumberWhereValueExpression,
"route": StringWhereValueExpression,
"vesselTypeCorrelation": NumberWhereValueExpression,
"tripTC": BoolWhereValueExpression,
"bunkerOnConsumption": BoolWhereValueExpression,
"hasGratuitiesPer30Days": BoolWhereValueExpression,
"gratuitiesAvgMonthly": BoolWhereValueExpression,
"gratuitiesMonthly": BoolWhereValueExpression,
"bunkerOwner": BoolWhereValueExpression,
"bunkerRebillable": BoolWhereValueExpression,
"onSubjects": BoolWhereValueExpression,
"durationBasisMin": BoolWhereValueExpression,
"durationBasisMax": BoolWhereValueExpression,
"extendRedelivery": BoolWhereValueExpression,
"opportunity": BoolWhereValueExpression,
"deliveryRobFromSurvey": BoolWhereValueExpression,
"redeliveryRobFromSurvey": BoolWhereValueExpression,
"durationBasisOption": BoolWhereValueExpression,
"durationBasisMid": BoolWhereValueExpression,
"userOverwriteEstRedel": BoolWhereValueExpression,
"vslTypeCorrOverriden": BoolWhereValueExpression,
"manualDeliveryInfo": BoolWhereValueExpression,
"manualRedeliveryInfo": BoolWhereValueExpression,
"longTermTC": BoolWhereValueExpression,
"ownVessel": BoolWhereValueExpression,
"intercompany": BoolWhereValueExpression,
"intercompanyMaster": BoolWhereValueExpression,
"intercompanySlave": BoolWhereValueExpression,
"useDeliveryBunkerLast": BoolWhereValueExpression,
"unpricedBunkers": BoolWhereValueExpression,
"lockPorts": BoolWhereValueExpression,
"lockDates": BoolWhereValueExpression,
"lockBunkers": BoolWhereValueExpression,
"headFixture": BoolWhereValueExpression,
"exposureBasisOpenDate": BoolWhereValueExpression,
"flags": NumberWhereValueExpression,
"optionStartDateLocal": DateWhereValueExpression,
"lobCode": StringWhereValueExpression,
"coaID": NumberWhereValueExpression,
"billingPeriod": TimeCharterContractBillingPeriodEnumValueExpression,
"deliveryRemarks": StringWhereValueExpression,
"redeliveryRemarks": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"cpOffhireDays": NumberWhereValueExpression,
"cpOffhireUnit": StringWhereValueExpression,
"vesselTurnover": NumberWhereValueExpression,
"segment": StringWhereValueExpression,
"purchaseOptionDeclaredDate": DateWhereValueExpression,
"purchaseOptionReminderWindowDays": NumberWhereValueExpression,
"purchaseOptionType": StringWhereValueExpression,
"purchaseOptionCurrSpreadHigh": NumberWhereValueExpression,
"purchaseOptionCurrSpreadLow": NumberWhereValueExpression,
"shareInContract": NumberWhereValueExpression,
"statusUnderConstruction": BoolWhereValueExpression,
"statusPurchasedNotDelivered": BoolWhereValueExpression,
"statusSoldNotRedelivered": BoolWhereValueExpression,
"statusCancelled": BoolWhereValueExpression,
"statusWithdrawn": BoolWhereValueExpression,
"manualMinRedelivery": BoolWhereValueExpression,
"manualMaxRedelivery": BoolWhereValueExpression,
"useLocalTime": BoolWhereValueExpression,
"billingScheduleInArrears": BoolWhereValueExpression,
"laycanConfirmed": BoolWhereValueExpression,
"excludeHireFromVoyagePnl": BoolWhereValueExpression,
"enableVoyageDataFlowToMirror": BoolWhereValueExpression,
"bareboat": BoolWhereValueExpression,
"allocatePnlToMirroredTcoVoyage": BoolWhereValueExpression,
"syncNoticeDatesWithEstDates": BoolWhereValueExpression,
"syncNoticeDatesWithActualDates": BoolWhereValueExpression,
"childReletContract": BoolWhereValueExpression,
"childReletContractMirror": BoolWhereValueExpression,
"leaseAccounting": BoolWhereValueExpression,
"leaseAccountingManuallySet": BoolWhereValueExpression,
"applyAdjustmentAfterCorrelation": BoolWhereValueExpression,
"basisExcludesOptionPeriod": BoolWhereValueExpression,
"isExposureDaysManual": BoolWhereValueExpression,
"isExposureTceManual": BoolWhereValueExpression,
"splitExposureRouteFormula": BoolWhereValueExpression,
"liftingOptionReminderWindowDays": NumberWhereValueExpression,
"monthlyMRAllowance": NumberWhereValueExpression,
"vesselTypeAdjustment": NumberWhereValueExpression,
"warrantyAllowanceHours": NumberWhereValueExpression,
"fuelWarrantyAtAnchorage": NumberWhereValueExpression,
"warrantyLoadHours": NumberWhereValueExpression,
"warrantyDiscHours": NumberWhereValueExpression,
"reliqWarrantyThreshold": NumberWhereValueExpression,
"warrantyLoadFuel": NumberWhereValueExpression,
"warrantyDiscFuel": NumberWhereValueExpression,
"entryUserID": StringWhereValueExpression,
"benchmarkEstimateID": StringWhereValueExpression,
"tcCoaContractID": StringWhereValueExpression,
"valuationID": NumberWhereValueExpression,
"lNGEstDeliveryCV": NumberWhereValueExpression,
"lNGEstRedeliveryCV": NumberWhereValueExpression,
"lNGActualDeliveryCV": NumberWhereValueExpression,
"lNGActualRedeliveryCV": NumberWhereValueExpression,
"emissionsSettlementType": TimeCharterContractEmissionsSettlementTypeEnumValueExpression,
"emissionsBillingPeriod": TimeCharterContractEmissionsBillingPeriodEnumValueExpression,
"emissionsPaymentTermsCode": StringWhereValueExpression,
"disableUseOfDeclarationDateAsExp": BoolWhereValueExpression,
"enableUseOfDeclarationDateAsExp": BoolWhereValueExpression,
"includePendingAllowanceInvoicesInPnL": BoolWhereValueExpression,
"isManualCarbonPricingMethod": BoolWhereValueExpression,
"additionalFlags2": NumberWhereValueExpression,
"docHolderName": StringWhereValueExpression,
"docHolderType": StringWhereValueExpression,
"allowanceDefaultPriceMode": TimeCharterContractAllowanceDefaultPriceModeEnumValueExpression,
"fuelEUCalcDefault": TimeCharterContractFuelEUCalcDefaultEnumValueExpression,
"emissionPaymentTerms": PaymentTermFormQueryWhere,
"benchmarkEstimate": VoyageEstimateFormQueryWhere,
"valuationWorksheet": WorksheetFormQueryWhere,
"timeCharterCOA": TimeCharterCOAFormQueryWhere,
"redeliveryPort": PortFormQueryWhere,
"deliveryPort": PortFormQueryWhere,
"tradeArea": TradeAreaFormQueryWhere,
"lob": LobFormQueryWhere,
"vessel": VesselFormQueryWhere,
"actDepartment": ActDepartmentFormQueryWhere,
"addressBook": AddressBookFormQueryWhere,
"addressBookBeneficiary": AddressBookFormQueryWhere,
"department": DepartmentFormQueryWhere,
"team": TeamFormQueryWhere,
"company": CompanyFormQueryWhere,
"firstTcBroker": TimeCharterBrokerFormQueryWhere,
"currentVoyage": VoyageFormQueryWhere,
"previousVoyage": VoyageFormQueryWhere,
"nextVoyage": VoyageFormQueryWhere,
"adminFee": TimeCharterExpenseFormQueryWhere,
"firstIndexLinkedHire": TimeCharterHireFormQueryWhere,
"firstLiftingOption": TimeCharterLiftingOptionFormQueryWhere,
"hFPurchase": HeadFixturePurchaseSaleFormQueryWhere,
"hFPurchaseFirstPayment": HeadFixturePurchaseSaleFormQueryWhere,
"hFPurchaseFirstBroker": HeadFixturePurchaseSaleFormQueryWhere,
"hFSale": HeadFixturePurchaseSaleFormQueryWhere,
"hFSaleFirstPayment": HeadFixturePurchaseSaleFormQueryWhere,
"hFSaleFirstBroker": HeadFixturePurchaseSaleFormQueryWhere,
"purchaseOptionReminder": ReminderFormQueryWhere,
"liftingOptionReminder": ReminderFormQueryWhere,
"parentMirroredContract": TimeCharterContractFormQueryWhere,
"childMirroredContract": TimeCharterContractFormQueryWhere
}
TimeCharterContractFuelEUCalcDefaultEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NA"
TimeCharterContractFuelEUCalcDefaultEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterContractFuelEUCalcDefaultEnum
|
|
isNot - TimeCharterContractFuelEUCalcDefaultEnum
|
|
isIn - [TimeCharterContractFuelEUCalcDefaultEnum]
|
Example
{"is": "NA", "isNot": "NA", "isIn": ["NA"]}
TimeCharterContractRelationships
Fields
Example
{
"emissionPaymentTerms": RelationshipDefinition,
"benchmarkEstimate": RelationshipDefinition,
"valuationWorksheet": RelationshipDefinition,
"timeCharterCOA": RelationshipDefinition,
"redeliveryPort": RelationshipDefinition,
"deliveryPort": RelationshipDefinition,
"tradeArea": RelationshipDefinition,
"lob": RelationshipDefinition,
"vessel": RelationshipDefinition,
"actDepartment": RelationshipDefinition,
"addressBook": RelationshipDefinition,
"addressBookBeneficiary": RelationshipDefinition,
"department": RelationshipDefinition,
"team": RelationshipDefinition,
"company": RelationshipDefinition,
"firstTcBroker": RelationshipDefinition,
"currentVoyage": RelationshipDefinition,
"previousVoyage": RelationshipDefinition,
"nextVoyage": RelationshipDefinition,
"adminFee": RelationshipDefinition,
"firstIndexLinkedHire": RelationshipDefinition,
"nextDelNotice": RelationshipDefinition,
"nextRedelNotice": RelationshipDefinition,
"fixedByUser": RelationshipDefinition,
"deliveryNoticeTCExtra": RelationshipDefinition,
"redeliveryNoticeTCExtra": RelationshipDefinition,
"firstLiftingOption": RelationshipDefinition,
"hFPurchase": RelationshipDefinition,
"hFPurchaseFirstPayment": RelationshipDefinition,
"hFPurchaseFirstBroker": RelationshipDefinition,
"hFSale": RelationshipDefinition,
"hFSaleFirstPayment": RelationshipDefinition,
"hFSaleFirstBroker": RelationshipDefinition,
"tCUnpricedElementRemark": RelationshipDefinition,
"purchaseOptionReminder": RelationshipDefinition,
"liftingOptionReminder": RelationshipDefinition,
"parentMirroredContract": RelationshipDefinition,
"childMirroredContract": RelationshipDefinition,
"timeCharterTonnageTaxs": RelationshipDefinition,
"timeCharterSeaConsumptions": RelationshipDefinition,
"timeCharterPurchaseOptions": RelationshipDefinition,
"timeCharterProfitShareContracts": RelationshipDefinition,
"timeCharterWarrantyDelayExclusions": RelationshipDefinition,
"timeCharterWarrantyConsumptions": RelationshipDefinition,
"timeCharterPortConsumptions": RelationshipDefinition,
"timeCharterProfitShares": RelationshipDefinition,
"timeCharterExposurePeriods": RelationshipDefinition,
"unpricedElements": RelationshipDefinition,
"headFixturePurchaseSales": RelationshipDefinition,
"firstTcHire": RelationshipDefinition,
"timeCharterExpenses": RelationshipDefinition,
"tcBrokers": RelationshipDefinition,
"timeCharterHires": RelationshipDefinition,
"timeCharterLiftingOptions": RelationshipDefinition,
"timeCharterBunkerDeliveries": RelationshipDefinition,
"voyages": RelationshipDefinition,
"cargoLinkedTrades": RelationshipDefinition,
"deliveryNoticeHeaders": RelationshipDefinition,
"redeliveryNoticeHeaders": RelationshipDefinition,
"otherInformation": RelationshipDefinition,
"tCIVoyages": RelationshipDefinition,
"tCOVoyages": RelationshipDefinition,
"alerts": RelationshipDefinition,
"tasks": RelationshipDefinition,
"operationsInvoice": RelationshipDefinition,
"timeCharterProjectedInvoice": RelationshipDefinition,
"timeCharterLeaseServiceSchedule": RelationshipDefinition,
"timeCharterLease": RelationshipDefinition,
"timeCharterBunkerExposure": RelationshipDefinition,
"mirroredContracts": RelationshipDefinition,
"bareboatContracts": RelationshipDefinition
}
TimeCharterContractTcTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"In"
TimeCharterContractTcTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterContractTcTypeEnum
|
|
isNot - TimeCharterContractTcTypeEnum
|
|
isIn - [TimeCharterContractTcTypeEnum]
|
Example
{"is": "In", "isNot": "In", "isIn": ["In"]}
TimeCharterExpense
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
rateType - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
isCommissionableExpense - Boolean
|
|
dateFromGmt - Date
|
|
profitSplitPercentage - Float
|
|
interestRate - Float
|
|
serviceRate - Float
|
|
serviceRateType - String
|
|
sqlID - Int
|
|
tcCode - String
|
|
type - String
|
|
sequenceNo - Int
|
|
description - String
|
|
legacyAmount - Float
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
billCode - String
|
|
rateInternal - Float
|
|
periodDays - Float
|
|
dateFromGmtInternal - Date
|
|
dateToGmt - Date
|
|
isMonthlyRateType - Boolean
|
|
isMonthlyAvgRateType - Boolean
|
|
isDailyRateType - Boolean
|
|
isPrepayment - Boolean
|
|
isPerContractType - Boolean
|
|
isCommissionable - Boolean
|
|
isUseActRateEnabled - Boolean
|
|
isLumpsumProvisional - Boolean
|
|
isOffHireDisabled - Boolean
|
|
flags - Int
|
|
remarks - String
|
|
currency - String
|
|
exchangeRateDate - Date
|
|
exchangeRate - Float
|
|
tceEarning - Float
|
|
subCode - String
|
|
subSequence - Int
|
|
timeCharterContract - TimeCharterContract
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"rateType": "xyz789",
"customFieldByID": Any,
"customField": Any,
"isCommissionableExpense": true,
"dateFromGmt": "2007-12-03",
"profitSplitPercentage": 987.65,
"interestRate": 987.65,
"serviceRate": 987.65,
"serviceRateType": "abc123",
"sqlID": 987,
"tcCode": "xyz789",
"type": "abc123",
"sequenceNo": 987,
"description": "abc123",
"legacyAmount": 123.45,
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUser": "xyz789",
"billCode": "xyz789",
"rateInternal": 987.65,
"periodDays": 123.45,
"dateFromGmtInternal": "2007-12-03",
"dateToGmt": "2007-12-03",
"isMonthlyRateType": false,
"isMonthlyAvgRateType": true,
"isDailyRateType": true,
"isPrepayment": false,
"isPerContractType": true,
"isCommissionable": false,
"isUseActRateEnabled": true,
"isLumpsumProvisional": false,
"isOffHireDisabled": false,
"flags": 123,
"remarks": "abc123",
"currency": "abc123",
"exchangeRateDate": "2007-12-03",
"exchangeRate": 987.65,
"tceEarning": 987.65,
"subCode": "abc123",
"subSequence": 987,
"timeCharterContract": TimeCharterContract,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
TimeCharterExpenseBillCodeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BallastBonus"
TimeCharterExpenseBillCodeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterExpenseBillCodeEnum
|
|
isNot - TimeCharterExpenseBillCodeEnum
|
|
isIn - [TimeCharterExpenseBillCodeEnum]
|
Example
{"is": "BallastBonus", "isNot": "BallastBonus", "isIn": ["BallastBonus"]}
TimeCharterExpenseFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterExpenseFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterExpenseFormQueryWhere
}
TimeCharterExpenseFormQueryWhere
Fields
Example
{
"and": [TimeCharterExpenseFormQueryWhere],
"or": [TimeCharterExpenseFormQueryWhere],
"rawExpression": "xyz789",
"tcCode": StringWhereValueExpression,
"type": TimeCharterExpenseTypeEnumValueExpression,
"sequenceNo": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"legacyAmount": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"billCode": TimeCharterExpenseBillCodeEnumValueExpression,
"rateInternal": NumberWhereValueExpression,
"periodDays": NumberWhereValueExpression,
"dateFromGmtInternal": DateWhereValueExpression,
"dateToGmt": DateWhereValueExpression,
"isMonthlyRateType": BoolWhereValueExpression,
"isMonthlyAvgRateType": BoolWhereValueExpression,
"isDailyRateType": BoolWhereValueExpression,
"isPrepayment": BoolWhereValueExpression,
"isPerContractType": BoolWhereValueExpression,
"isCommissionable": BoolWhereValueExpression,
"isUseActRateEnabled": BoolWhereValueExpression,
"isLumpsumProvisional": BoolWhereValueExpression,
"isOffHireDisabled": BoolWhereValueExpression,
"flags": NumberWhereValueExpression,
"remarks": StringWhereValueExpression,
"currency": StringWhereValueExpression,
"exchangeRateDate": DateWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"tceEarning": NumberWhereValueExpression,
"subCode": StringWhereValueExpression,
"subSequence": NumberWhereValueExpression,
"timeCharterContract": TimeCharterContractFormQueryWhere
}
TimeCharterExpenseRelationships
Fields
| Field Name | Description |
|---|---|
timeCharterContract - RelationshipDefinition
|
Example
{"timeCharterContract": RelationshipDefinition}
TimeCharterExpenseTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
TimeCharterExpenseTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterExpenseTypeEnum
|
|
isNot - TimeCharterExpenseTypeEnum
|
|
isIn - [TimeCharterExpenseTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
TimeCharterExposurePeriod
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
basis - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
tcCode - String
|
|
seq - Int
|
|
duration - Float
|
|
durationUnit - String
|
|
route - String
|
|
correlation - Float
|
|
exposureOnStartMonth - Boolean
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
tradeType - TradeType
|
|
timeCharterContract - TimeCharterContract
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"basis": "abc123",
"customFieldByID": Any,
"customField": Any,
"tcCode": "abc123",
"seq": 123,
"duration": 987.65,
"durationUnit": "abc123",
"route": "xyz789",
"correlation": 987.65,
"exposureOnStartMonth": true,
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123",
"tradeType": TradeType,
"timeCharterContract": TimeCharterContract,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
TimeCharterExposurePeriodDurationUnitEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"None"
TimeCharterExposurePeriodDurationUnitEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterExposurePeriodDurationUnitEnum
|
|
isNot - TimeCharterExposurePeriodDurationUnitEnum
|
|
isIn - [TimeCharterExposurePeriodDurationUnitEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
TimeCharterExposurePeriodFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterExposurePeriodFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterExposurePeriodFormQueryWhere
}
TimeCharterExposurePeriodFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TimeCharterExposurePeriodFormQueryWhere!]
|
|
or - [TimeCharterExposurePeriodFormQueryWhere!]
|
|
rawExpression - String
|
|
tcCode - StringWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
duration - NumberWhereValueExpression
|
|
durationUnit - TimeCharterExposurePeriodDurationUnitEnumValueExpression
|
|
route - StringWhereValueExpression
|
|
correlation - NumberWhereValueExpression
|
|
exposureOnStartMonth - BoolWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
tradeType - TradeTypeFormQueryWhere
|
|
timeCharterContract - TimeCharterContractFormQueryWhere
|
Example
{
"and": [TimeCharterExposurePeriodFormQueryWhere],
"or": [TimeCharterExposurePeriodFormQueryWhere],
"rawExpression": "abc123",
"tcCode": StringWhereValueExpression,
"seq": NumberWhereValueExpression,
"duration": NumberWhereValueExpression,
"durationUnit": TimeCharterExposurePeriodDurationUnitEnumValueExpression,
"route": StringWhereValueExpression,
"correlation": NumberWhereValueExpression,
"exposureOnStartMonth": BoolWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"tradeType": TradeTypeFormQueryWhere,
"timeCharterContract": TimeCharterContractFormQueryWhere
}
TimeCharterExposurePeriodRelationships
Fields
| Field Name | Description |
|---|---|
tradeType - RelationshipDefinition
|
|
timeCharterContract - RelationshipDefinition
|
Example
{
"tradeType": RelationshipDefinition,
"timeCharterContract": RelationshipDefinition
}
TimeCharterExtra
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tentativeFirmStatus - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
otherInformationItemType - String
|
|
otherInformationItemDescription - String
|
|
tcCode - String
|
|
itemType - String
|
|
itemSeqNo - Int
|
|
itemText - String
|
|
delRedelNoticeStatusInternal - String
|
|
delRedelNotice - String
|
|
delRedelNoticeDateLocal - Date
|
|
delRedelEstDateLocal - Date
|
|
monthly - Boolean
|
|
averageMonthly - Boolean
|
|
noticeSent - Boolean
|
|
delRedelNoticeShowDateLocal - Date
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"tentativeFirmStatus": "abc123",
"customFieldByID": Any,
"customField": Any,
"otherInformationItemType": "xyz789",
"otherInformationItemDescription": "abc123",
"tcCode": "abc123",
"itemType": "xyz789",
"itemSeqNo": 123,
"itemText": "abc123",
"delRedelNoticeStatusInternal": "xyz789",
"delRedelNotice": "xyz789",
"delRedelNoticeDateLocal": "2007-12-03",
"delRedelEstDateLocal": "2007-12-03",
"monthly": true,
"averageMonthly": true,
"noticeSent": true,
"delRedelNoticeShowDateLocal": "2007-12-03",
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
TimeCharterExtraFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterExtraFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterExtraFormQueryWhere
}
TimeCharterExtraFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TimeCharterExtraFormQueryWhere!]
|
|
or - [TimeCharterExtraFormQueryWhere!]
|
|
rawExpression - String
|
|
tcCode - StringWhereValueExpression
|
|
itemType - TimeCharterExtraItemTypeEnumValueExpression
|
|
itemSeqNo - NumberWhereValueExpression
|
|
itemText - StringWhereValueExpression
|
|
delRedelNoticeStatusInternal - StringWhereValueExpression
|
|
delRedelNotice - StringWhereValueExpression
|
|
delRedelNoticeDateLocal - DateWhereValueExpression
|
|
delRedelEstDateLocal - DateWhereValueExpression
|
|
monthly - BoolWhereValueExpression
|
|
averageMonthly - BoolWhereValueExpression
|
|
noticeSent - BoolWhereValueExpression
|
|
delRedelNoticeShowDateLocal - DateWhereValueExpression
|
Example
{
"and": [TimeCharterExtraFormQueryWhere],
"or": [TimeCharterExtraFormQueryWhere],
"rawExpression": "abc123",
"tcCode": StringWhereValueExpression,
"itemType": TimeCharterExtraItemTypeEnumValueExpression,
"itemSeqNo": NumberWhereValueExpression,
"itemText": StringWhereValueExpression,
"delRedelNoticeStatusInternal": StringWhereValueExpression,
"delRedelNotice": StringWhereValueExpression,
"delRedelNoticeDateLocal": DateWhereValueExpression,
"delRedelEstDateLocal": DateWhereValueExpression,
"monthly": BoolWhereValueExpression,
"averageMonthly": BoolWhereValueExpression,
"noticeSent": BoolWhereValueExpression,
"delRedelNoticeShowDateLocal": DateWhereValueExpression
}
TimeCharterExtraItemTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Unspecified"
TimeCharterExtraItemTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterExtraItemTypeEnum
|
|
isNot - TimeCharterExtraItemTypeEnum
|
|
isIn - [TimeCharterExtraItemTypeEnum]
|
Example
{"is": "Unspecified", "isNot": "Unspecified", "isIn": ["Unspecified"]}
TimeCharterHire
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
hireRateType - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
hireDuration - Float
|
|
hireDurationPeriod - String
|
|
comments - String
|
|
lockType - String
|
|
hireFromLocal - Date
|
|
hireToLocal - Date
|
|
sqlID - Int
|
|
tcCode - String
|
|
sequenceNo - Int
|
|
isRateTypeHourly - Boolean
|
|
isPeriodDurationHours - Boolean
|
|
isRateTypeIndex - Boolean
|
|
isRateTypeDaily - Boolean
|
|
isRateTypeMonthly - Boolean
|
|
isLockToDate - Boolean
|
|
flags2 - Int
|
|
tclRate - Float
|
|
hireRate - Float
|
|
remarks - String
|
|
periodDurationDays - Float
|
|
hireFromGmt - Date
|
|
hireToGmt - Date
|
|
indexRoute - String
|
|
indexAdjustmentPercent - Float
|
|
indexRateCeiling - Float
|
|
indexRateFloor - Float
|
|
accountCode - String
|
|
indexAdjustmentAmountBase - Float
|
|
equipmentQuantity - Int
|
|
equipmentType - String
|
|
lastUpdateGmt - Date
|
|
currency - String
|
|
exchangeRateDate - Date
|
|
exchangeRate - Float
|
|
exposurePercent - Float
|
|
timeCharterContract - TimeCharterContract
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"hireRateType": "abc123",
"customFieldByID": Any,
"customField": Any,
"hireDuration": 123.45,
"hireDurationPeriod": "xyz789",
"comments": "abc123",
"lockType": "xyz789",
"hireFromLocal": "2007-12-03",
"hireToLocal": "2007-12-03",
"sqlID": 987,
"tcCode": "abc123",
"sequenceNo": 987,
"isRateTypeHourly": false,
"isPeriodDurationHours": false,
"isRateTypeIndex": false,
"isRateTypeDaily": true,
"isRateTypeMonthly": false,
"isLockToDate": false,
"flags2": 123,
"tclRate": 123.45,
"hireRate": 123.45,
"remarks": "abc123",
"periodDurationDays": 987.65,
"hireFromGmt": "2007-12-03",
"hireToGmt": "2007-12-03",
"indexRoute": "xyz789",
"indexAdjustmentPercent": 123.45,
"indexRateCeiling": 987.65,
"indexRateFloor": 987.65,
"accountCode": "xyz789",
"indexAdjustmentAmountBase": 987.65,
"equipmentQuantity": 123,
"equipmentType": "xyz789",
"lastUpdateGmt": "2007-12-03",
"currency": "xyz789",
"exchangeRateDate": "2007-12-03",
"exchangeRate": 123.45,
"exposurePercent": 123.45,
"timeCharterContract": TimeCharterContract,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
TimeCharterHireFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterHireFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterHireFormQueryWhere
}
TimeCharterHireFormQueryWhere
Fields
Example
{
"and": [TimeCharterHireFormQueryWhere],
"or": [TimeCharterHireFormQueryWhere],
"rawExpression": "xyz789",
"tcCode": StringWhereValueExpression,
"sequenceNo": NumberWhereValueExpression,
"isRateTypeHourly": BoolWhereValueExpression,
"isPeriodDurationHours": BoolWhereValueExpression,
"isRateTypeIndex": BoolWhereValueExpression,
"isRateTypeDaily": BoolWhereValueExpression,
"isRateTypeMonthly": BoolWhereValueExpression,
"isLockToDate": BoolWhereValueExpression,
"flags2": NumberWhereValueExpression,
"tclRate": NumberWhereValueExpression,
"hireRate": NumberWhereValueExpression,
"remarks": StringWhereValueExpression,
"periodDurationDays": NumberWhereValueExpression,
"hireFromGmt": DateWhereValueExpression,
"hireToGmt": DateWhereValueExpression,
"indexRoute": StringWhereValueExpression,
"indexAdjustmentPercent": NumberWhereValueExpression,
"indexRateCeiling": NumberWhereValueExpression,
"indexRateFloor": NumberWhereValueExpression,
"accountCode": StringWhereValueExpression,
"indexAdjustmentAmountBase": NumberWhereValueExpression,
"equipmentQuantity": NumberWhereValueExpression,
"equipmentType": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"currency": StringWhereValueExpression,
"exchangeRateDate": DateWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"exposurePercent": NumberWhereValueExpression,
"timeCharterContract": TimeCharterContractFormQueryWhere
}
TimeCharterHireRelationships
Fields
| Field Name | Description |
|---|---|
timeCharterContract - RelationshipDefinition
|
Example
{"timeCharterContract": RelationshipDefinition}
TimeCharterLease
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tcCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
assetROU - Float
|
|
leaseLiability - Float
|
|
leaseDuration - Float
|
|
depreciationRate - Float
|
|
transitionDate - Date
|
|
transitionPriorDays - Float
|
|
transitionAccumulatedDepreciation - Float
|
|
periodNo - Int
|
|
periodFrom - Date
|
|
periodTo - Date
|
|
periodDuration - Float
|
|
periodHireRate - Float
|
|
periodServiceFee - Float
|
|
periodLeasePayment - Float
|
|
periodLeaseInterest - Float
|
|
periodInterestPercent - Float
|
|
periodDepreciationExpense - Float
|
|
timeCharterContract - TimeCharterContract
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"tcCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"assetROU": 987.65,
"leaseLiability": 123.45,
"leaseDuration": 987.65,
"depreciationRate": 123.45,
"transitionDate": "2007-12-03",
"transitionPriorDays": 123.45,
"transitionAccumulatedDepreciation": 987.65,
"periodNo": 123,
"periodFrom": "2007-12-03",
"periodTo": "2007-12-03",
"periodDuration": 123.45,
"periodHireRate": 987.65,
"periodServiceFee": 123.45,
"periodLeasePayment": 987.65,
"periodLeaseInterest": 123.45,
"periodInterestPercent": 987.65,
"periodDepreciationExpense": 987.65,
"timeCharterContract": TimeCharterContract,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
TimeCharterLeaseFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterLeaseFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterLeaseFormQueryWhere
}
TimeCharterLeaseFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TimeCharterLeaseFormQueryWhere!]
|
|
or - [TimeCharterLeaseFormQueryWhere!]
|
|
rawExpression - String
|
|
timeCharterContract - TimeCharterContractFormQueryWhere
|
Example
{
"and": [TimeCharterLeaseFormQueryWhere],
"or": [TimeCharterLeaseFormQueryWhere],
"rawExpression": "xyz789",
"timeCharterContract": TimeCharterContractFormQueryWhere
}
TimeCharterLeaseRelationships
Fields
| Field Name | Description |
|---|---|
timeCharterContract - RelationshipDefinition
|
Example
{"timeCharterContract": RelationshipDefinition}
TimeCharterLiftingOption
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
status - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
tcCode - String
|
|
sequenceNo - Int
|
|
duration - Float
|
|
durationUnit - String
|
|
lessDays - Float
|
|
moreDays - Float
|
|
declarationDateLocal - Date
|
|
statusCode - String
|
|
isRateTypeHourly - Boolean
|
|
isPeriodDurationHours - Boolean
|
|
isRateTypeIndex - Boolean
|
|
isRateTypeDaily - Boolean
|
|
isRateTypeMonthly - Boolean
|
|
isLockToDate - Boolean
|
|
remarks - String
|
|
hireRate - Float
|
|
hireRateUnit - String
|
|
indexRoute - String
|
|
indexAdjustmentPercent - Float
|
|
indexRateCeiling - Float
|
|
indexRateFloor - Float
|
|
indexPaymentType - Int
|
|
paymentFromDays - Int
|
|
paymentToDays - Int
|
|
indexAdjustmentAmountBase - Float
|
|
declaredDateLocal - Date
|
|
deltaPercent - Float
|
|
maxDuration - Float
|
|
maxDurationLessDays - Float
|
|
maxDurationMoreDays - Float
|
|
minDuration - Float
|
|
minDurationLessDays - Float
|
|
minDurationMoreDays - Float
|
|
optionRedeliveryDateGmt - Date
|
|
optionStartDateGmt - Date
|
|
timeCharterContract - TimeCharterContract
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"status": "xyz789",
"customFieldByID": Any,
"customField": Any,
"tcCode": "abc123",
"sequenceNo": 987,
"duration": 123.45,
"durationUnit": "abc123",
"lessDays": 987.65,
"moreDays": 987.65,
"declarationDateLocal": "2007-12-03",
"statusCode": "abc123",
"isRateTypeHourly": false,
"isPeriodDurationHours": true,
"isRateTypeIndex": false,
"isRateTypeDaily": false,
"isRateTypeMonthly": true,
"isLockToDate": true,
"remarks": "abc123",
"hireRate": 987.65,
"hireRateUnit": "abc123",
"indexRoute": "xyz789",
"indexAdjustmentPercent": 123.45,
"indexRateCeiling": 987.65,
"indexRateFloor": 123.45,
"indexPaymentType": 123,
"paymentFromDays": 123,
"paymentToDays": 987,
"indexAdjustmentAmountBase": 987.65,
"declaredDateLocal": "2007-12-03",
"deltaPercent": 987.65,
"maxDuration": 123.45,
"maxDurationLessDays": 123.45,
"maxDurationMoreDays": 987.65,
"minDuration": 123.45,
"minDurationLessDays": 987.65,
"minDurationMoreDays": 987.65,
"optionRedeliveryDateGmt": "2007-12-03",
"optionStartDateGmt": "2007-12-03",
"timeCharterContract": TimeCharterContract,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
TimeCharterLiftingOptionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterLiftingOptionFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterLiftingOptionFormQueryWhere
}
TimeCharterLiftingOptionFormQueryWhere
Fields
Example
{
"and": [TimeCharterLiftingOptionFormQueryWhere],
"or": [TimeCharterLiftingOptionFormQueryWhere],
"rawExpression": "xyz789",
"tcCode": StringWhereValueExpression,
"sequenceNo": NumberWhereValueExpression,
"duration": NumberWhereValueExpression,
"durationUnit": StringWhereValueExpression,
"lessDays": NumberWhereValueExpression,
"moreDays": NumberWhereValueExpression,
"declarationDateLocal": DateWhereValueExpression,
"statusCode": TimeCharterLiftingOptionStatusCodeEnumValueExpression,
"isRateTypeHourly": BoolWhereValueExpression,
"isPeriodDurationHours": BoolWhereValueExpression,
"isRateTypeIndex": BoolWhereValueExpression,
"isRateTypeDaily": BoolWhereValueExpression,
"isRateTypeMonthly": BoolWhereValueExpression,
"isLockToDate": BoolWhereValueExpression,
"remarks": StringWhereValueExpression,
"hireRate": NumberWhereValueExpression,
"hireRateUnit": StringWhereValueExpression,
"indexRoute": StringWhereValueExpression,
"indexAdjustmentPercent": NumberWhereValueExpression,
"indexRateCeiling": NumberWhereValueExpression,
"indexRateFloor": NumberWhereValueExpression,
"indexPaymentType": NumberWhereValueExpression,
"paymentFromDays": NumberWhereValueExpression,
"paymentToDays": NumberWhereValueExpression,
"indexAdjustmentAmountBase": NumberWhereValueExpression,
"declaredDateLocal": DateWhereValueExpression,
"deltaPercent": NumberWhereValueExpression,
"maxDuration": NumberWhereValueExpression,
"maxDurationLessDays": NumberWhereValueExpression,
"maxDurationMoreDays": NumberWhereValueExpression,
"minDuration": NumberWhereValueExpression,
"minDurationLessDays": NumberWhereValueExpression,
"minDurationMoreDays": NumberWhereValueExpression,
"optionRedeliveryDateGmt": DateWhereValueExpression,
"optionStartDateGmt": DateWhereValueExpression,
"timeCharterContract": TimeCharterContractFormQueryWhere
}
TimeCharterLiftingOptionRelationships
Fields
| Field Name | Description |
|---|---|
timeCharterContract - RelationshipDefinition
|
Example
{"timeCharterContract": RelationshipDefinition}
TimeCharterLiftingOptionStatusCodeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Pending"
TimeCharterLiftingOptionStatusCodeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterLiftingOptionStatusCodeEnum
|
|
isNot - TimeCharterLiftingOptionStatusCodeEnum
|
|
isIn - [TimeCharterLiftingOptionStatusCodeEnum]
|
Example
{"is": "Pending", "isNot": "Pending", "isIn": ["Pending"]}
TimeCharterOutDetails
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
voyageCount - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
minRedelDate - Date
|
|
maxRedelDate - Date
|
|
minRedelDays - Float
|
|
maxRedelDays - Float
|
|
tcoEstimateID - String
|
|
vesselCode - String
|
|
deliveryDateGmt - Date
|
|
tcCode - String
|
|
estimateID - String
|
|
voyageEstimate - VoyageEstimate
|
|
vessel - Vessel
|
|
timeCharterContract - TimeCharterContract
|
|
voyages - [Voyage]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"voyageCount": 987,
"customFieldByID": Any,
"customField": Any,
"minRedelDate": "2007-12-03",
"maxRedelDate": "2007-12-03",
"minRedelDays": 987.65,
"maxRedelDays": 987.65,
"tcoEstimateID": "xyz789",
"vesselCode": "abc123",
"deliveryDateGmt": "2007-12-03",
"tcCode": "xyz789",
"estimateID": "abc123",
"voyageEstimate": VoyageEstimate,
"vessel": Vessel,
"timeCharterContract": TimeCharterContract,
"voyages": [Voyage],
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
TimeCharterOutDetailsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterOutDetailsFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterOutDetailsFormQueryWhere
}
TimeCharterOutDetailsFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TimeCharterOutDetailsFormQueryWhere!]
|
|
or - [TimeCharterOutDetailsFormQueryWhere!]
|
|
rawExpression - String
|
|
tcoEstimateID - StringWhereValueExpression
|
|
vesselCode - StringWhereValueExpression
|
|
deliveryDateGmt - DateWhereValueExpression
|
|
tcCode - StringWhereValueExpression
|
|
estimateID - StringWhereValueExpression
|
|
voyageEstimate - VoyageEstimateFormQueryWhere
|
|
vessel - VesselFormQueryWhere
|
|
timeCharterContract - TimeCharterContractFormQueryWhere
|
Example
{
"and": [TimeCharterOutDetailsFormQueryWhere],
"or": [TimeCharterOutDetailsFormQueryWhere],
"rawExpression": "abc123",
"tcoEstimateID": StringWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"deliveryDateGmt": DateWhereValueExpression,
"tcCode": StringWhereValueExpression,
"estimateID": StringWhereValueExpression,
"voyageEstimate": VoyageEstimateFormQueryWhere,
"vessel": VesselFormQueryWhere,
"timeCharterContract": TimeCharterContractFormQueryWhere
}
TimeCharterOutDetailsRelationships
Fields
| Field Name | Description |
|---|---|
voyageEstimate - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
timeCharterContract - RelationshipDefinition
|
|
voyages - RelationshipDefinition
|
Example
{
"voyageEstimate": RelationshipDefinition,
"vessel": RelationshipDefinition,
"timeCharterContract": RelationshipDefinition,
"voyages": RelationshipDefinition
}
TimeCharterPortConsumption
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tcCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seq - Int
|
|
remarks - String
|
|
fuelType - String
|
|
loading - Float
|
|
discharging - Float
|
|
idleOn - Float
|
|
idleOff - Float
|
|
heat - Float
|
|
heatPlus - Float
|
|
clean - Float
|
|
auxiliary - Float
|
|
maneuvering - Float
|
|
iGS - Float
|
|
lastUser - String
|
|
cool - Float
|
|
heatPlusPlus - Float
|
|
fuelGradeCode - Int
|
|
boiler - Float
|
|
incinerator - Float
|
|
fuel - FuelLubeType
|
|
fuelGrade - Term
|
|
timeCharterBunker - TimeCharterBunkerDelivery
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"tcCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"seq": 123,
"remarks": "abc123",
"fuelType": "abc123",
"loading": 123.45,
"discharging": 123.45,
"idleOn": 987.65,
"idleOff": 123.45,
"heat": 123.45,
"heatPlus": 123.45,
"clean": 987.65,
"auxiliary": 123.45,
"maneuvering": 123.45,
"iGS": 987.65,
"lastUser": "abc123",
"cool": 987.65,
"heatPlusPlus": 123.45,
"fuelGradeCode": 123,
"boiler": 123.45,
"incinerator": 987.65,
"fuel": FuelLubeType,
"fuelGrade": Term,
"timeCharterBunker": TimeCharterBunkerDelivery,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
TimeCharterPortConsumptionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterPortConsumptionFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterPortConsumptionFormQueryWhere
}
TimeCharterPortConsumptionFormQueryWhere
Fields
Example
{
"and": [TimeCharterPortConsumptionFormQueryWhere],
"or": [TimeCharterPortConsumptionFormQueryWhere],
"rawExpression": "abc123",
"tcCode": StringWhereValueExpression,
"seq": NumberWhereValueExpression,
"remarks": StringWhereValueExpression,
"fuelType": StringWhereValueExpression,
"loading": NumberWhereValueExpression,
"discharging": NumberWhereValueExpression,
"idleOn": NumberWhereValueExpression,
"idleOff": NumberWhereValueExpression,
"heat": NumberWhereValueExpression,
"heatPlus": NumberWhereValueExpression,
"clean": NumberWhereValueExpression,
"auxiliary": NumberWhereValueExpression,
"maneuvering": NumberWhereValueExpression,
"iGS": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"cool": NumberWhereValueExpression,
"heatPlusPlus": NumberWhereValueExpression,
"fuelGradeCode": NumberWhereValueExpression,
"boiler": NumberWhereValueExpression,
"incinerator": NumberWhereValueExpression,
"fuel": FuelLubeTypeFormQueryWhere,
"fuelGrade": TermFormQueryWhere,
"timeCharterBunker": TimeCharterBunkerDeliveryFormQueryWhere
}
TimeCharterPortConsumptionRelationships
Fields
| Field Name | Description |
|---|---|
fuel - RelationshipDefinition
|
|
fuelGrade - RelationshipDefinition
|
|
timeCharterBunker - RelationshipDefinition
|
Example
{
"fuel": RelationshipDefinition,
"fuelGrade": RelationshipDefinition,
"timeCharterBunker": RelationshipDefinition
}
TimeCharterProjectedInvoice
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tcCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
tcType - String
|
|
vesselCode - String
|
|
companyCode - String
|
|
redeliveryDate - Date
|
|
status - String
|
|
invoiceType - String
|
|
description - String
|
|
actualAmountBaseInternal - Float
|
|
invoicedAmountBaseInternal - Float
|
|
paidAmountBaseInternal - Float
|
|
counterpartyType - String
|
|
counterpartyShortName - String
|
|
periodFrom - Date
|
|
periodTo - Date
|
|
duration - Float
|
|
rate - Float
|
|
lastUpdateGmt - Date
|
|
source - String
|
|
outstandingBalanceBaseInternal - Float
|
|
bulkActionUniqueID - String
|
|
lOB - String
|
|
opsCoordinator - String
|
|
vesselName - String
|
|
vesselFleet - String
|
|
parentTcCode - String
|
|
chtrSpecialist - String
|
|
originalInvoiceNo - String
|
|
originalInvoiceTransNo - String
|
|
originalInvoiceCurrAmount - Float
|
|
originalInvoiceStatus - String
|
|
timeCharterContract - TimeCharterContract
|
|
bareboatContract - BareboatContract
|
|
vessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"tcCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"tcType": "abc123",
"vesselCode": "xyz789",
"companyCode": "abc123",
"redeliveryDate": "2007-12-03",
"status": "abc123",
"invoiceType": "abc123",
"description": "xyz789",
"actualAmountBaseInternal": 987.65,
"invoicedAmountBaseInternal": 987.65,
"paidAmountBaseInternal": 987.65,
"counterpartyType": "abc123",
"counterpartyShortName": "abc123",
"periodFrom": "2007-12-03",
"periodTo": "2007-12-03",
"duration": 123.45,
"rate": 123.45,
"lastUpdateGmt": "2007-12-03",
"source": "xyz789",
"outstandingBalanceBaseInternal": 123.45,
"bulkActionUniqueID": "xyz789",
"lOB": "xyz789",
"opsCoordinator": "abc123",
"vesselName": "abc123",
"vesselFleet": "abc123",
"parentTcCode": "abc123",
"chtrSpecialist": "xyz789",
"originalInvoiceNo": "abc123",
"originalInvoiceTransNo": "abc123",
"originalInvoiceCurrAmount": 987.65,
"originalInvoiceStatus": "abc123",
"timeCharterContract": TimeCharterContract,
"bareboatContract": BareboatContract,
"vessel": Vessel,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
TimeCharterProjectedInvoiceFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterProjectedInvoiceFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterProjectedInvoiceFormQueryWhere
}
TimeCharterProjectedInvoiceFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TimeCharterProjectedInvoiceFormQueryWhere!]
|
|
or - [TimeCharterProjectedInvoiceFormQueryWhere!]
|
|
rawExpression - String
|
|
timeCharterContract - TimeCharterContractFormQueryWhere
|
|
bareboatContract - BareboatContractFormQueryWhere
|
|
vessel - VesselFormQueryWhere
|
Example
{
"and": [TimeCharterProjectedInvoiceFormQueryWhere],
"or": [TimeCharterProjectedInvoiceFormQueryWhere],
"rawExpression": "xyz789",
"timeCharterContract": TimeCharterContractFormQueryWhere,
"bareboatContract": BareboatContractFormQueryWhere,
"vessel": VesselFormQueryWhere
}
TimeCharterProjectedInvoiceRelationships
Fields
| Field Name | Description |
|---|---|
timeCharterContract - RelationshipDefinition
|
|
bareboatContract - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
Example
{
"timeCharterContract": RelationshipDefinition,
"bareboatContract": RelationshipDefinition,
"vessel": RelationshipDefinition
}
TimeCharterPurchaseOption
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tcCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
sequenceNo - Int
|
|
declarationDate - Date
|
|
priceDate - Date
|
|
priceCurr - Float
|
|
curr - String
|
|
exchangeRate - Float
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
timeCharterContract - TimeCharterContract
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"tcCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"sequenceNo": 123,
"declarationDate": "2007-12-03",
"priceDate": "2007-12-03",
"priceCurr": 123.45,
"curr": "xyz789",
"exchangeRate": 123.45,
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"timeCharterContract": TimeCharterContract,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
TimeCharterPurchaseOptionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterPurchaseOptionFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterPurchaseOptionFormQueryWhere
}
TimeCharterPurchaseOptionFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TimeCharterPurchaseOptionFormQueryWhere!]
|
|
or - [TimeCharterPurchaseOptionFormQueryWhere!]
|
|
rawExpression - String
|
|
tcCode - StringWhereValueExpression
|
|
sequenceNo - NumberWhereValueExpression
|
|
declarationDate - DateWhereValueExpression
|
|
priceDate - DateWhereValueExpression
|
|
priceCurr - NumberWhereValueExpression
|
|
curr - StringWhereValueExpression
|
|
exchangeRate - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
timeCharterContract - TimeCharterContractFormQueryWhere
|
Example
{
"and": [TimeCharterPurchaseOptionFormQueryWhere],
"or": [TimeCharterPurchaseOptionFormQueryWhere],
"rawExpression": "abc123",
"tcCode": StringWhereValueExpression,
"sequenceNo": NumberWhereValueExpression,
"declarationDate": DateWhereValueExpression,
"priceDate": DateWhereValueExpression,
"priceCurr": NumberWhereValueExpression,
"curr": StringWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"timeCharterContract": TimeCharterContractFormQueryWhere
}
TimeCharterPurchaseOptionRelationships
Fields
| Field Name | Description |
|---|---|
timeCharterContract - RelationshipDefinition
|
Example
{"timeCharterContract": RelationshipDefinition}
TimeCharterSeaConsumption
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tcCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
speed - Float
|
|
lastUser - String
|
|
ballastLaden - String
|
|
description - String
|
|
timeCharterSeaConsumptionBunkers - [TimeCharterSeaConsumptionBunker]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"tcCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"speed": 123.45,
"lastUser": "abc123",
"ballastLaden": "xyz789",
"description": "abc123",
"timeCharterSeaConsumptionBunkers": [
TimeCharterSeaConsumptionBunker
],
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
TimeCharterSeaConsumptionBallastLadenEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
TimeCharterSeaConsumptionBallastLadenEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterSeaConsumptionBallastLadenEnum
|
|
isNot - TimeCharterSeaConsumptionBallastLadenEnum
|
|
isIn - [TimeCharterSeaConsumptionBallastLadenEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
TimeCharterSeaConsumptionBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
consumption - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
tcCode - String
|
|
speed - Float
|
|
ballastLaden - String
|
|
fuelType - String
|
|
ladenConsumptionInternal - Float
|
|
ballastConsumptionInternal - Float
|
|
timeCharterSeaConsumption - TimeCharterSeaConsumption
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"consumption": 987.65,
"customFieldByID": Any,
"customField": Any,
"tcCode": "xyz789",
"speed": 987.65,
"ballastLaden": "abc123",
"fuelType": "abc123",
"ladenConsumptionInternal": 123.45,
"ballastConsumptionInternal": 987.65,
"timeCharterSeaConsumption": TimeCharterSeaConsumption,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
TimeCharterSeaConsumptionBunkerBallastLadenEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
TimeCharterSeaConsumptionBunkerBallastLadenEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterSeaConsumptionBunkerBallastLadenEnum
|
|
isNot - TimeCharterSeaConsumptionBunkerBallastLadenEnum
|
|
isIn - [TimeCharterSeaConsumptionBunkerBallastLadenEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
TimeCharterSeaConsumptionBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterSeaConsumptionBunkerFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterSeaConsumptionBunkerFormQueryWhere
}
TimeCharterSeaConsumptionBunkerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TimeCharterSeaConsumptionBunkerFormQueryWhere!]
|
|
or - [TimeCharterSeaConsumptionBunkerFormQueryWhere!]
|
|
rawExpression - String
|
|
tcCode - StringWhereValueExpression
|
|
speed - NumberWhereValueExpression
|
|
ballastLaden - TimeCharterSeaConsumptionBunkerBallastLadenEnumValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
ladenConsumptionInternal - NumberWhereValueExpression
|
|
ballastConsumptionInternal - NumberWhereValueExpression
|
|
timeCharterSeaConsumption - TimeCharterSeaConsumptionFormQueryWhere
|
Example
{
"and": [TimeCharterSeaConsumptionBunkerFormQueryWhere],
"or": [TimeCharterSeaConsumptionBunkerFormQueryWhere],
"rawExpression": "xyz789",
"tcCode": StringWhereValueExpression,
"speed": NumberWhereValueExpression,
"ballastLaden": TimeCharterSeaConsumptionBunkerBallastLadenEnumValueExpression,
"fuelType": StringWhereValueExpression,
"ladenConsumptionInternal": NumberWhereValueExpression,
"ballastConsumptionInternal": NumberWhereValueExpression,
"timeCharterSeaConsumption": TimeCharterSeaConsumptionFormQueryWhere
}
TimeCharterSeaConsumptionBunkerRelationships
Fields
| Field Name | Description |
|---|---|
timeCharterSeaConsumption - RelationshipDefinition
|
Example
{"timeCharterSeaConsumption": RelationshipDefinition}
TimeCharterSeaConsumptionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterSeaConsumptionFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterSeaConsumptionFormQueryWhere
}
TimeCharterSeaConsumptionFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TimeCharterSeaConsumptionFormQueryWhere!]
|
|
or - [TimeCharterSeaConsumptionFormQueryWhere!]
|
|
rawExpression - String
|
|
tcCode - StringWhereValueExpression
|
|
speed - NumberWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
ballastLaden - TimeCharterSeaConsumptionBallastLadenEnumValueExpression
|
|
description - StringWhereValueExpression
|
Example
{
"and": [TimeCharterSeaConsumptionFormQueryWhere],
"or": [TimeCharterSeaConsumptionFormQueryWhere],
"rawExpression": "abc123",
"tcCode": StringWhereValueExpression,
"speed": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"ballastLaden": TimeCharterSeaConsumptionBallastLadenEnumValueExpression,
"description": StringWhereValueExpression
}
TimeCharterSeaConsumptionRelationships
Fields
| Field Name | Description |
|---|---|
timeCharterSeaConsumptionBunkers - RelationshipDefinition
|
Example
{
"timeCharterSeaConsumptionBunkers": RelationshipDefinition
}
TimeCharterTonnageTax
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tcCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seq - Int
|
|
compliantFromDate - Date
|
|
compliantToDate - Date
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"tcCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"seq": 987,
"compliantFromDate": "2007-12-03",
"compliantToDate": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUser": "abc123",
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
TimeCharterTonnageTaxFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterTonnageTaxFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterTonnageTaxFormQueryWhere
}
TimeCharterTonnageTaxFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TimeCharterTonnageTaxFormQueryWhere!]
|
|
or - [TimeCharterTonnageTaxFormQueryWhere!]
|
|
rawExpression - String
|
|
tcCode - StringWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
compliantFromDate - DateWhereValueExpression
|
|
compliantToDate - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
Example
{
"and": [TimeCharterTonnageTaxFormQueryWhere],
"or": [TimeCharterTonnageTaxFormQueryWhere],
"rawExpression": "xyz789",
"tcCode": StringWhereValueExpression,
"seq": NumberWhereValueExpression,
"compliantFromDate": DateWhereValueExpression,
"compliantToDate": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression
}
TimeCharterWarrantyConsumption
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tcCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
speed - Float
|
|
fuelModeConsumption - Float
|
|
gasOnlyModeConsumption - Float
|
|
dualModeConsumption - Float
|
|
ballastOrLaden - String
|
|
foe - Float
|
|
pilotFuel - Float
|
|
mainEngineFO - Float
|
|
baseSeaLoadFO - Float
|
|
reliqFO - Float
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"tcCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"speed": 123.45,
"fuelModeConsumption": 987.65,
"gasOnlyModeConsumption": 987.65,
"dualModeConsumption": 123.45,
"ballastOrLaden": "abc123",
"foe": 123.45,
"pilotFuel": 987.65,
"mainEngineFO": 123.45,
"baseSeaLoadFO": 123.45,
"reliqFO": 123.45,
"lastUser": "abc123",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
TimeCharterWarrantyConsumptionBallastOrLadenEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
TimeCharterWarrantyConsumptionBallastOrLadenEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterWarrantyConsumptionBallastOrLadenEnum
|
|
isNot - TimeCharterWarrantyConsumptionBallastOrLadenEnum
|
|
isIn - [TimeCharterWarrantyConsumptionBallastOrLadenEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
TimeCharterWarrantyConsumptionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterWarrantyConsumptionFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterWarrantyConsumptionFormQueryWhere
}
TimeCharterWarrantyConsumptionFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TimeCharterWarrantyConsumptionFormQueryWhere!]
|
|
or - [TimeCharterWarrantyConsumptionFormQueryWhere!]
|
|
rawExpression - String
|
|
tcCode - StringWhereValueExpression
|
|
speed - NumberWhereValueExpression
|
|
fuelModeConsumption - NumberWhereValueExpression
|
|
gasOnlyModeConsumption - NumberWhereValueExpression
|
|
dualModeConsumption - NumberWhereValueExpression
|
|
ballastOrLaden - TimeCharterWarrantyConsumptionBallastOrLadenEnumValueExpression
|
|
foe - NumberWhereValueExpression
|
|
pilotFuel - NumberWhereValueExpression
|
|
mainEngineFO - NumberWhereValueExpression
|
|
baseSeaLoadFO - NumberWhereValueExpression
|
|
reliqFO - NumberWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
Example
{
"and": [TimeCharterWarrantyConsumptionFormQueryWhere],
"or": [TimeCharterWarrantyConsumptionFormQueryWhere],
"rawExpression": "abc123",
"tcCode": StringWhereValueExpression,
"speed": NumberWhereValueExpression,
"fuelModeConsumption": NumberWhereValueExpression,
"gasOnlyModeConsumption": NumberWhereValueExpression,
"dualModeConsumption": NumberWhereValueExpression,
"ballastOrLaden": TimeCharterWarrantyConsumptionBallastOrLadenEnumValueExpression,
"foe": NumberWhereValueExpression,
"pilotFuel": NumberWhereValueExpression,
"mainEngineFO": NumberWhereValueExpression,
"baseSeaLoadFO": NumberWhereValueExpression,
"reliqFO": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression
}
TimeCharterWarrantyDelayExclusion
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tcCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seq - Int
|
|
warrantyType - String
|
|
segmentMinDays - Float
|
|
delayTypeDescription - String
|
|
minContinuousHours - Float
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
delayType - DelayType
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"tcCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"seq": 987,
"warrantyType": "xyz789",
"segmentMinDays": 987.65,
"delayTypeDescription": "abc123",
"minContinuousHours": 987.65,
"lastUser": "xyz789",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"delayType": DelayType,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
TimeCharterWarrantyDelayExclusionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeCharterWarrantyDelayExclusionFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeCharterWarrantyDelayExclusionFormQueryWhere
}
TimeCharterWarrantyDelayExclusionFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TimeCharterWarrantyDelayExclusionFormQueryWhere!]
|
|
or - [TimeCharterWarrantyDelayExclusionFormQueryWhere!]
|
|
rawExpression - String
|
|
tcCode - StringWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
warrantyType - TimeCharterWarrantyDelayExclusionWarrantyTypeEnumValueExpression
|
|
segmentMinDays - NumberWhereValueExpression
|
|
delayTypeDescription - StringWhereValueExpression
|
|
minContinuousHours - NumberWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
delayType - DelayTypeFormQueryWhere
|
Example
{
"and": [
TimeCharterWarrantyDelayExclusionFormQueryWhere
],
"or": [TimeCharterWarrantyDelayExclusionFormQueryWhere],
"rawExpression": "abc123",
"tcCode": StringWhereValueExpression,
"seq": NumberWhereValueExpression,
"warrantyType": TimeCharterWarrantyDelayExclusionWarrantyTypeEnumValueExpression,
"segmentMinDays": NumberWhereValueExpression,
"delayTypeDescription": StringWhereValueExpression,
"minContinuousHours": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"delayType": DelayTypeFormQueryWhere
}
TimeCharterWarrantyDelayExclusionRelationships
Fields
| Field Name | Description |
|---|---|
delayType - RelationshipDefinition
|
Example
{"delayType": RelationshipDefinition}
TimeCharterWarrantyDelayExclusionWarrantyTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"None"
TimeCharterWarrantyDelayExclusionWarrantyTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TimeCharterWarrantyDelayExclusionWarrantyTypeEnum
|
|
isNot - TimeCharterWarrantyDelayExclusionWarrantyTypeEnum
|
|
isIn - [TimeCharterWarrantyDelayExclusionWarrantyTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
TimeZoneCodes
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
sTDOffset - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
dSTOffset - Float
|
|
timeZoneCode - String
|
|
sTDOffsetInternal - Int
|
|
dSTOffsetInternal - Int
|
|
description - String
|
|
observeDST - Boolean
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"sTDOffset": 987.65,
"customFieldByID": Any,
"customField": Any,
"dSTOffset": 123.45,
"timeZoneCode": "abc123",
"sTDOffsetInternal": 987,
"dSTOffsetInternal": 987,
"description": "xyz789",
"observeDST": true,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
TimeZoneCodesFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeZoneCodesFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeZoneCodesFormQueryWhere
}
TimeZoneCodesFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TimeZoneCodesFormQueryWhere!]
|
|
or - [TimeZoneCodesFormQueryWhere!]
|
|
rawExpression - String
|
|
timeZoneCode - StringWhereValueExpression
|
|
sTDOffsetInternal - NumberWhereValueExpression
|
|
dSTOffsetInternal - NumberWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
observeDST - BoolWhereValueExpression
|
Example
{
"and": [TimeZoneCodesFormQueryWhere],
"or": [TimeZoneCodesFormQueryWhere],
"rawExpression": "abc123",
"timeZoneCode": StringWhereValueExpression,
"sTDOffsetInternal": NumberWhereValueExpression,
"dSTOffsetInternal": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"observeDST": BoolWhereValueExpression
}
TimeZoneInfo
Fields
| Field Name | Description |
|---|---|
year - Int
|
|
entryType - String
|
|
tZRef - String
|
|
stdGmtOffsetMinutes - Int
|
|
dstStartLocal - Date
|
|
dstEndLocal - Date
|
|
dstGmtOffsetMinutes - Int
|
|
secondDstStartLocal - Date
|
|
secondDstEndLocal - Date
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"year": 123,
"entryType": "abc123",
"tZRef": "abc123",
"stdGmtOffsetMinutes": 123,
"dstStartLocal": "2007-12-03",
"dstEndLocal": "2007-12-03",
"dstGmtOffsetMinutes": 123,
"secondDstStartLocal": "2007-12-03",
"secondDstEndLocal": "2007-12-03",
"_id": "xyz789",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
TimeZoneInfoFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TimeZoneInfoFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TimeZoneInfoFormQueryWhere
}
TimeZoneInfoFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TimeZoneInfoFormQueryWhere!]
|
|
or - [TimeZoneInfoFormQueryWhere!]
|
|
rawExpression - String
|
|
year - NumberWhereValueExpression
|
|
entryType - StringWhereValueExpression
|
|
tZRef - StringWhereValueExpression
|
|
stdGmtOffsetMinutes - NumberWhereValueExpression
|
|
dstStartLocal - DateWhereValueExpression
|
|
dstEndLocal - DateWhereValueExpression
|
|
dstGmtOffsetMinutes - NumberWhereValueExpression
|
|
secondDstStartLocal - DateWhereValueExpression
|
|
secondDstEndLocal - DateWhereValueExpression
|
Example
{
"and": [TimeZoneInfoFormQueryWhere],
"or": [TimeZoneInfoFormQueryWhere],
"rawExpression": "abc123",
"year": NumberWhereValueExpression,
"entryType": StringWhereValueExpression,
"tZRef": StringWhereValueExpression,
"stdGmtOffsetMinutes": NumberWhereValueExpression,
"dstStartLocal": DateWhereValueExpression,
"dstEndLocal": DateWhereValueExpression,
"dstGmtOffsetMinutes": NumberWhereValueExpression,
"secondDstStartLocal": DateWhereValueExpression,
"secondDstEndLocal": DateWhereValueExpression
}
TradeArea
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
areaCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
name - String
|
|
areaNo - Int
|
|
tradeRoute - String
|
|
externalRef - String
|
|
inactive - Boolean
|
|
createdInTradehub - Boolean
|
|
portArea - String
|
|
regionDefinitionJson - String
|
|
tradeType - TradeType
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"areaCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"name": "xyz789",
"areaNo": 123,
"tradeRoute": "xyz789",
"externalRef": "xyz789",
"inactive": false,
"createdInTradehub": true,
"portArea": "xyz789",
"regionDefinitionJson": "abc123",
"tradeType": TradeType,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
TradeAreaFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TradeAreaFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TradeAreaFormQueryWhere
}
TradeAreaFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TradeAreaFormQueryWhere!]
|
|
or - [TradeAreaFormQueryWhere!]
|
|
rawExpression - String
|
|
areaCode - StringWhereValueExpression
|
|
name - StringWhereValueExpression
|
|
areaNo - NumberWhereValueExpression
|
|
tradeRoute - StringWhereValueExpression
|
|
externalRef - StringWhereValueExpression
|
|
inactive - BoolWhereValueExpression
|
|
createdInTradehub - BoolWhereValueExpression
|
|
portArea - StringWhereValueExpression
|
|
regionDefinitionJson - StringWhereValueExpression
|
|
tradeType - TradeTypeFormQueryWhere
|
Example
{
"and": [TradeAreaFormQueryWhere],
"or": [TradeAreaFormQueryWhere],
"rawExpression": "abc123",
"areaCode": StringWhereValueExpression,
"name": StringWhereValueExpression,
"areaNo": NumberWhereValueExpression,
"tradeRoute": StringWhereValueExpression,
"externalRef": StringWhereValueExpression,
"inactive": BoolWhereValueExpression,
"createdInTradehub": BoolWhereValueExpression,
"portArea": StringWhereValueExpression,
"regionDefinitionJson": StringWhereValueExpression,
"tradeType": TradeTypeFormQueryWhere
}
TradeAreaRelationships
Fields
| Field Name | Description |
|---|---|
tradeType - RelationshipDefinition
|
Example
{"tradeType": RelationshipDefinition}
TradeBroker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
commissionAmount - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
tradeID - Int
|
|
seqNo - Int
|
|
brokerType - String
|
|
brokerShortName - String
|
|
commissionRate - Float
|
|
commissionType - String
|
|
paidOnExecution - Boolean
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
addressBook - AddressBook
|
|
paperTrade - PaperTrade
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"commissionAmount": 987.65,
"customFieldByID": Any,
"customField": Any,
"tradeID": 987,
"seqNo": 123,
"brokerType": "xyz789",
"brokerShortName": "abc123",
"commissionRate": 123.45,
"commissionType": "xyz789",
"paidOnExecution": false,
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123",
"addressBook": AddressBook,
"paperTrade": PaperTrade,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
TradeBrokerCommissionTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
TradeBrokerCommissionTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TradeBrokerCommissionTypeEnum
|
|
isNot - TradeBrokerCommissionTypeEnum
|
|
isIn - [TradeBrokerCommissionTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
TradeBrokerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TradeBrokerFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TradeBrokerFormQueryWhere
}
TradeBrokerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TradeBrokerFormQueryWhere!]
|
|
or - [TradeBrokerFormQueryWhere!]
|
|
rawExpression - String
|
|
tradeID - NumberWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
brokerType - StringWhereValueExpression
|
|
brokerShortName - StringWhereValueExpression
|
|
commissionRate - NumberWhereValueExpression
|
|
commissionType - TradeBrokerCommissionTypeEnumValueExpression
|
|
paidOnExecution - BoolWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
addressBook - AddressBookFormQueryWhere
|
|
paperTrade - PaperTradeFormQueryWhere
|
Example
{
"and": [TradeBrokerFormQueryWhere],
"or": [TradeBrokerFormQueryWhere],
"rawExpression": "abc123",
"tradeID": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"brokerType": StringWhereValueExpression,
"brokerShortName": StringWhereValueExpression,
"commissionRate": NumberWhereValueExpression,
"commissionType": TradeBrokerCommissionTypeEnumValueExpression,
"paidOnExecution": BoolWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"addressBook": AddressBookFormQueryWhere,
"paperTrade": PaperTradeFormQueryWhere
}
TradeBrokerRelationships
Fields
| Field Name | Description |
|---|---|
addressBook - RelationshipDefinition
|
|
paperTrade - RelationshipDefinition
|
Example
{
"addressBook": RelationshipDefinition,
"paperTrade": RelationshipDefinition
}
TradeContract
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
snapshotID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
contractType - String
|
|
contractID - String
|
|
counterpartyShortName - String
|
|
counterpartyType - String
|
|
buySell - String
|
|
tradeAreaNo - Int
|
|
vesselType - String
|
|
vesselCode - String
|
|
vesselFleet - String
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
internal - Boolean
|
|
missingData - Boolean
|
|
indexLinked - Boolean
|
|
useMarketRateOffset - Boolean
|
|
inbound - Boolean
|
|
pending - Boolean
|
|
pendingFurther - Boolean
|
|
ownersOption - Boolean
|
|
companyCode - String
|
|
route - String
|
|
indexRoute - String
|
|
marketRateUnit - String
|
|
rateUnit - String
|
|
benchmarkEstimateID - String
|
|
bunkerMarketName - String
|
|
tradeDate - Date
|
|
externalRef - String
|
|
optionStrike - Float
|
|
optionPremium - Float
|
|
fronthaulEstimateID - String
|
|
exposureBasisType - String
|
|
optionDeclareDate - Date
|
|
status - String
|
|
firstLoadPort - String
|
|
bookingDate - Date
|
|
contractStartDateGmt - Date
|
|
contractEndDateGmt - Date
|
|
appliedAgainstID - String
|
|
appliedAgainstType - String
|
|
applicationDateGmt - Date
|
|
addCommission - Float
|
|
brokerCommission - Float
|
|
strategyName - String
|
|
mTEquivalent - Float
|
|
laycanFromGmt - Date
|
|
laycanToGmt - Date
|
|
vesselExternalRef - String
|
|
lobCode - String
|
|
voyageNo - Int
|
|
tcType - String
|
|
loadPortNo - Int
|
|
dischargePortNo - Int
|
|
openPortNo - Int
|
|
openDateGmt - Date
|
|
refContractID - String
|
|
minDuration - Float
|
|
maxDuration - Float
|
|
durationUnit - String
|
|
iCAdjustmentRate - Float
|
|
iCAdjustmentAmount - Float
|
|
refGroupCode - String
|
|
internalCommissionRate - Float
|
|
contractExchangeRate - Float
|
|
referenceContract - String
|
|
reference - String
|
|
contractCurrency - String
|
|
parentContractID - String
|
|
contractEntryUserID - String
|
|
contractEntryDate - Date
|
|
contractLastUser - String
|
|
contractLastUpdate - Date
|
|
parentContractType - String
|
|
childContractID - String
|
|
childContractType - String
|
|
openPort - Port
|
|
dischargePort - Port
|
|
loadPort - Port
|
|
lob - Lob
|
|
market - Market
|
|
voyageEstimate - VoyageEstimate
|
|
tradeArea - TradeArea
|
|
vessel - Vessel
|
|
addressBook - AddressBook
|
|
tradeSnapshot - TradeSnapshot
|
|
cargo - Cargo
|
|
timeCharterContract - TimeCharterContract
|
|
coa - COA
|
|
tradePnlDetails - [TradePnlDetail]
|
|
tradePnls - [TradePnl]
|
|
unpricedElements - [UnpricedElement]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"snapshotID": 123,
"customFieldByID": Any,
"customField": Any,
"contractType": "abc123",
"contractID": "xyz789",
"counterpartyShortName": "abc123",
"counterpartyType": "abc123",
"buySell": "abc123",
"tradeAreaNo": 987,
"vesselType": "abc123",
"vesselCode": "abc123",
"vesselFleet": "xyz789",
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"internal": false,
"missingData": true,
"indexLinked": true,
"useMarketRateOffset": true,
"inbound": false,
"pending": false,
"pendingFurther": false,
"ownersOption": true,
"companyCode": "xyz789",
"route": "xyz789",
"indexRoute": "abc123",
"marketRateUnit": "xyz789",
"rateUnit": "abc123",
"benchmarkEstimateID": "abc123",
"bunkerMarketName": "xyz789",
"tradeDate": "2007-12-03",
"externalRef": "abc123",
"optionStrike": 123.45,
"optionPremium": 987.65,
"fronthaulEstimateID": "xyz789",
"exposureBasisType": "abc123",
"optionDeclareDate": "2007-12-03",
"status": "xyz789",
"firstLoadPort": "abc123",
"bookingDate": "2007-12-03",
"contractStartDateGmt": "2007-12-03",
"contractEndDateGmt": "2007-12-03",
"appliedAgainstID": "abc123",
"appliedAgainstType": "xyz789",
"applicationDateGmt": "2007-12-03",
"addCommission": 987.65,
"brokerCommission": 123.45,
"strategyName": "abc123",
"mTEquivalent": 987.65,
"laycanFromGmt": "2007-12-03",
"laycanToGmt": "2007-12-03",
"vesselExternalRef": "xyz789",
"lobCode": "xyz789",
"voyageNo": 987,
"tcType": "abc123",
"loadPortNo": 987,
"dischargePortNo": 123,
"openPortNo": 123,
"openDateGmt": "2007-12-03",
"refContractID": "xyz789",
"minDuration": 987.65,
"maxDuration": 987.65,
"durationUnit": "abc123",
"iCAdjustmentRate": 987.65,
"iCAdjustmentAmount": 987.65,
"refGroupCode": "abc123",
"internalCommissionRate": 987.65,
"contractExchangeRate": 987.65,
"referenceContract": "xyz789",
"reference": "abc123",
"contractCurrency": "xyz789",
"parentContractID": "abc123",
"contractEntryUserID": "xyz789",
"contractEntryDate": "2007-12-03",
"contractLastUser": "xyz789",
"contractLastUpdate": "2007-12-03",
"parentContractType": "xyz789",
"childContractID": "abc123",
"childContractType": "xyz789",
"openPort": Port,
"dischargePort": Port,
"loadPort": Port,
"lob": Lob,
"market": Market,
"voyageEstimate": VoyageEstimate,
"tradeArea": TradeArea,
"vessel": Vessel,
"addressBook": AddressBook,
"tradeSnapshot": TradeSnapshot,
"cargo": Cargo,
"timeCharterContract": TimeCharterContract,
"coa": COA,
"tradePnlDetails": [TradePnlDetail],
"tradePnls": [TradePnl],
"unpricedElements": [UnpricedElement],
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
TradeContractBuySellEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
TradeContractBuySellEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TradeContractBuySellEnum
|
|
isNot - TradeContractBuySellEnum
|
|
isIn - [TradeContractBuySellEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
TradeContractExposureBasisTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Invalid"
TradeContractExposureBasisTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TradeContractExposureBasisTypeEnum
|
|
isNot - TradeContractExposureBasisTypeEnum
|
|
isIn - [TradeContractExposureBasisTypeEnum]
|
Example
{"is": "Invalid", "isNot": "Invalid", "isIn": ["Invalid"]}
TradeContractFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TradeContractFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TradeContractFormQueryWhere
}
TradeContractFormQueryWhere
Fields
Example
{
"and": [TradeContractFormQueryWhere],
"or": [TradeContractFormQueryWhere],
"rawExpression": "xyz789",
"snapshotID": NumberWhereValueExpression,
"contractType": StringWhereValueExpression,
"contractID": StringWhereValueExpression,
"counterpartyShortName": StringWhereValueExpression,
"counterpartyType": StringWhereValueExpression,
"buySell": TradeContractBuySellEnumValueExpression,
"tradeAreaNo": NumberWhereValueExpression,
"vesselType": StringWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"vesselFleet": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"internal": BoolWhereValueExpression,
"missingData": BoolWhereValueExpression,
"indexLinked": BoolWhereValueExpression,
"useMarketRateOffset": BoolWhereValueExpression,
"inbound": BoolWhereValueExpression,
"pending": BoolWhereValueExpression,
"pendingFurther": BoolWhereValueExpression,
"ownersOption": BoolWhereValueExpression,
"companyCode": StringWhereValueExpression,
"route": StringWhereValueExpression,
"indexRoute": StringWhereValueExpression,
"marketRateUnit": StringWhereValueExpression,
"rateUnit": StringWhereValueExpression,
"benchmarkEstimateID": StringWhereValueExpression,
"bunkerMarketName": StringWhereValueExpression,
"tradeDate": DateWhereValueExpression,
"externalRef": StringWhereValueExpression,
"optionStrike": NumberWhereValueExpression,
"optionPremium": NumberWhereValueExpression,
"fronthaulEstimateID": StringWhereValueExpression,
"exposureBasisType": TradeContractExposureBasisTypeEnumValueExpression,
"optionDeclareDate": DateWhereValueExpression,
"status": StringWhereValueExpression,
"firstLoadPort": StringWhereValueExpression,
"bookingDate": DateWhereValueExpression,
"contractStartDateGmt": DateWhereValueExpression,
"contractEndDateGmt": DateWhereValueExpression,
"appliedAgainstID": StringWhereValueExpression,
"appliedAgainstType": StringWhereValueExpression,
"applicationDateGmt": DateWhereValueExpression,
"addCommission": NumberWhereValueExpression,
"brokerCommission": NumberWhereValueExpression,
"strategyName": StringWhereValueExpression,
"mTEquivalent": NumberWhereValueExpression,
"laycanFromGmt": DateWhereValueExpression,
"laycanToGmt": DateWhereValueExpression,
"vesselExternalRef": StringWhereValueExpression,
"lobCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"tcType": StringWhereValueExpression,
"loadPortNo": NumberWhereValueExpression,
"dischargePortNo": NumberWhereValueExpression,
"openPortNo": NumberWhereValueExpression,
"openDateGmt": DateWhereValueExpression,
"refContractID": StringWhereValueExpression,
"minDuration": NumberWhereValueExpression,
"maxDuration": NumberWhereValueExpression,
"durationUnit": StringWhereValueExpression,
"iCAdjustmentRate": NumberWhereValueExpression,
"iCAdjustmentAmount": NumberWhereValueExpression,
"refGroupCode": StringWhereValueExpression,
"internalCommissionRate": NumberWhereValueExpression,
"contractExchangeRate": NumberWhereValueExpression,
"referenceContract": StringWhereValueExpression,
"reference": StringWhereValueExpression,
"contractCurrency": StringWhereValueExpression,
"parentContractID": StringWhereValueExpression,
"contractEntryUserID": StringWhereValueExpression,
"contractEntryDate": DateWhereValueExpression,
"contractLastUser": StringWhereValueExpression,
"contractLastUpdate": DateWhereValueExpression,
"parentContractType": StringWhereValueExpression,
"childContractID": StringWhereValueExpression,
"childContractType": StringWhereValueExpression,
"openPort": PortFormQueryWhere,
"dischargePort": PortFormQueryWhere,
"loadPort": PortFormQueryWhere,
"lob": LobFormQueryWhere,
"market": MarketFormQueryWhere,
"voyageEstimate": VoyageEstimateFormQueryWhere,
"tradeArea": TradeAreaFormQueryWhere,
"vessel": VesselFormQueryWhere,
"addressBook": AddressBookFormQueryWhere,
"tradeSnapshot": TradeSnapshotFormQueryWhere,
"cargo": CargoFormQueryWhere,
"timeCharterContract": TimeCharterContractFormQueryWhere,
"coa": COAFormQueryWhere
}
TradeContractRelationships
Fields
| Field Name | Description |
|---|---|
openPort - RelationshipDefinition
|
|
dischargePort - RelationshipDefinition
|
|
loadPort - RelationshipDefinition
|
|
lob - RelationshipDefinition
|
|
market - RelationshipDefinition
|
|
voyageEstimate - RelationshipDefinition
|
|
tradeArea - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
addressBook - RelationshipDefinition
|
|
tradeSnapshot - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
timeCharterContract - RelationshipDefinition
|
|
cOA - RelationshipDefinition
|
|
tradePnlDetails - RelationshipDefinition
|
|
tradePnls - RelationshipDefinition
|
|
unpricedElements - RelationshipDefinition
|
Example
{
"openPort": RelationshipDefinition,
"dischargePort": RelationshipDefinition,
"loadPort": RelationshipDefinition,
"lob": RelationshipDefinition,
"market": RelationshipDefinition,
"voyageEstimate": RelationshipDefinition,
"tradeArea": RelationshipDefinition,
"vessel": RelationshipDefinition,
"addressBook": RelationshipDefinition,
"tradeSnapshot": RelationshipDefinition,
"cargo": RelationshipDefinition,
"timeCharterContract": RelationshipDefinition,
"cOA": RelationshipDefinition,
"tradePnlDetails": RelationshipDefinition,
"tradePnls": RelationshipDefinition,
"unpricedElements": RelationshipDefinition
}
TradeFilter
Fields
| Field Name | Description |
|---|---|
filterID - Int
|
|
shortName - String
|
|
description - String
|
|
remarks - String
|
|
flags - Int
|
|
externalRef - String
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
filterType - String
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"filterID": 987,
"shortName": "abc123",
"description": "abc123",
"remarks": "abc123",
"flags": 123,
"externalRef": "abc123",
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"filterType": "abc123",
"_id": "xyz789",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
TradeFilterDetail
Fields
| Field Name | Description |
|---|---|
filterID - Int
|
|
sequence - Int
|
|
subType - String
|
|
value - String
|
|
flags - Int
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
tradeFilter - TradeFilter
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"filterID": 987,
"sequence": 987,
"subType": "abc123",
"value": "abc123",
"flags": 987,
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"tradeFilter": TradeFilter,
"_id": "xyz789",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
TradeFilterDetailFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TradeFilterDetailFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TradeFilterDetailFormQueryWhere
}
TradeFilterDetailFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TradeFilterDetailFormQueryWhere!]
|
|
or - [TradeFilterDetailFormQueryWhere!]
|
|
rawExpression - String
|
|
filterID - NumberWhereValueExpression
|
|
sequence - NumberWhereValueExpression
|
|
subType - StringWhereValueExpression
|
|
value - StringWhereValueExpression
|
|
flags - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
tradeFilter - TradeFilterFormQueryWhere
|
Example
{
"and": [TradeFilterDetailFormQueryWhere],
"or": [TradeFilterDetailFormQueryWhere],
"rawExpression": "xyz789",
"filterID": NumberWhereValueExpression,
"sequence": NumberWhereValueExpression,
"subType": StringWhereValueExpression,
"value": StringWhereValueExpression,
"flags": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"tradeFilter": TradeFilterFormQueryWhere
}
TradeFilterDetailRelationships
Fields
| Field Name | Description |
|---|---|
tradeFilter - RelationshipDefinition
|
Example
{"tradeFilter": RelationshipDefinition}
TradeFilterFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TradeFilterFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TradeFilterFormQueryWhere
}
TradeFilterFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TradeFilterFormQueryWhere!]
|
|
or - [TradeFilterFormQueryWhere!]
|
|
rawExpression - String
|
|
filterID - NumberWhereValueExpression
|
|
shortName - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
flags - NumberWhereValueExpression
|
|
externalRef - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
filterType - StringWhereValueExpression
|
Example
{
"and": [TradeFilterFormQueryWhere],
"or": [TradeFilterFormQueryWhere],
"rawExpression": "xyz789",
"filterID": NumberWhereValueExpression,
"shortName": StringWhereValueExpression,
"description": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"flags": NumberWhereValueExpression,
"externalRef": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"filterType": StringWhereValueExpression
}
TradeIndex
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
iD - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
name - String
|
|
groupID - Int
|
|
description - String
|
|
lastUpdateGmt - Date
|
|
updateTimes - Int
|
|
route - String
|
|
weightFactor - Float
|
|
lastUser - String
|
|
correlation - Float
|
|
externalRef - String
|
|
referenceNo - Int
|
|
vesselType - String
|
|
tradeType - TradeType
|
|
tradeTypes - [TradeType]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"iD": 987,
"customFieldByID": Any,
"customField": Any,
"name": "xyz789",
"groupID": 987,
"description": "xyz789",
"lastUpdateGmt": "2007-12-03",
"updateTimes": 987,
"route": "abc123",
"weightFactor": 123.45,
"lastUser": "abc123",
"correlation": 987.65,
"externalRef": "xyz789",
"referenceNo": 987,
"vesselType": "abc123",
"tradeType": TradeType,
"tradeTypes": [TradeType],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
TradeIndexFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TradeIndexFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TradeIndexFormQueryWhere
}
TradeIndexFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TradeIndexFormQueryWhere!]
|
|
or - [TradeIndexFormQueryWhere!]
|
|
rawExpression - String
|
|
iD - NumberWhereValueExpression
|
|
name - StringWhereValueExpression
|
|
groupID - NumberWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
updateTimes - NumberWhereValueExpression
|
|
route - StringWhereValueExpression
|
|
weightFactor - NumberWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
correlation - NumberWhereValueExpression
|
|
externalRef - StringWhereValueExpression
|
|
referenceNo - NumberWhereValueExpression
|
|
vesselType - StringWhereValueExpression
|
|
tradeType - TradeTypeFormQueryWhere
|
Example
{
"and": [TradeIndexFormQueryWhere],
"or": [TradeIndexFormQueryWhere],
"rawExpression": "xyz789",
"iD": NumberWhereValueExpression,
"name": StringWhereValueExpression,
"groupID": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"updateTimes": NumberWhereValueExpression,
"route": StringWhereValueExpression,
"weightFactor": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"correlation": NumberWhereValueExpression,
"externalRef": StringWhereValueExpression,
"referenceNo": NumberWhereValueExpression,
"vesselType": StringWhereValueExpression,
"tradeType": TradeTypeFormQueryWhere
}
TradeIndexRelationships
Fields
| Field Name | Description |
|---|---|
tradeType - RelationshipDefinition
|
|
tradeTypes - RelationshipDefinition
|
Example
{
"tradeType": RelationshipDefinition,
"tradeTypes": RelationshipDefinition
}
TradePnl
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
shortLong - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
exposureCalcType - Int
|
|
isContractPaper - Boolean
|
|
isContractPaperOption - Boolean
|
|
isContractOption - Boolean
|
|
isInternalCompany - Boolean
|
|
contractTypeCalculated - String
|
|
contractGroupCalculated - String
|
|
tradeAreaName - String
|
|
tradeRealized - Boolean
|
|
tradePnlValue - Float
|
|
tradeTcExposure - Float
|
|
tradeStatus - String
|
|
tradePnlStatus - String
|
|
tradeWeightedDays - Float
|
|
tradeLoadPortRegion - String
|
|
tradeDiscPortRegion - String
|
|
tradeOpenPortRegion - String
|
|
tradeMarginingAgreement - Boolean
|
|
tradeNettingAgreement - Boolean
|
|
tradeOptionDeclarationDate - Date
|
|
tradeOptionStatus - String
|
|
isMissingData - Boolean
|
|
benchmarkBunkerExp - Float
|
|
exposureBasis - String
|
|
exposureBenchmarkBasis - String
|
|
totalDays - Float
|
|
totalTons - Float
|
|
totalExposureDays - Float
|
|
tradeDaysCalculated - Float
|
|
tradeTonsCalculated - Float
|
|
tradeExposureDaysCalculated - Float
|
|
snapshotType - String
|
|
contractID - String
|
|
dateLocal - Date
|
|
seqNo - Int
|
|
marketName - String
|
|
realized - Float
|
|
exposure - Float
|
|
exposureDays - Float
|
|
exposureTons - Float
|
|
days - Float
|
|
tons - Float
|
|
marketDate - Date
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
snapshotID - Int
|
|
contractType - String
|
|
routeCode - String
|
|
marketRef - String
|
|
tradeRate - Float
|
|
tradeRateUnit - String
|
|
marketRate - Float
|
|
marketRateUnit - String
|
|
marketRateConverted - Float
|
|
periodFromGmt - Date
|
|
periodToGmt - Date
|
|
monthIndex - Int
|
|
status - String
|
|
settledRate - Float
|
|
bunkerExposure - Float
|
|
tce - Float
|
|
weightedDays - Float
|
|
correlation - Float
|
|
bunkerQty - Float
|
|
bunkerRate - Float
|
|
bunkerMarketRate - Float
|
|
baf - Float
|
|
bunkerSymbol - String
|
|
bunkerCorrelation - Float
|
|
benchmarkBunkerExposure - Float
|
|
bunkerMarketSource - String
|
|
bunkerMarketDate - Date
|
|
bafRate - Float
|
|
marketRateOffset - Float
|
|
referenceID - Int
|
|
contractTce - Float
|
|
calcDescription - String
|
|
contractRate - Float
|
|
benchmarkEstimateID - String
|
|
tradingMonthID - String
|
|
externalRef - String
|
|
realizedPNL - Float
|
|
unrealizedPNL - Float
|
|
voyageEstimate - VoyageEstimate
|
|
tradeType - TradeType
|
|
tradeContract - TradeContract
|
|
tradePnlCargo - TradePnl
|
|
firstTradePnlDetail - TradePnlDetail
|
|
cargo - Cargo
|
|
company - AddressBook
|
|
tradePnlDetails - [TradePnlDetail]
|
|
tradePnlDetailsExposure - [TradePnlDetail]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"shortLong": "abc123",
"customFieldByID": Any,
"customField": Any,
"exposureCalcType": 123,
"isContractPaper": false,
"isContractPaperOption": true,
"isContractOption": true,
"isInternalCompany": true,
"contractTypeCalculated": "abc123",
"contractGroupCalculated": "xyz789",
"tradeAreaName": "xyz789",
"tradeRealized": true,
"tradePnlValue": 123.45,
"tradeTcExposure": 123.45,
"tradeStatus": "abc123",
"tradePnlStatus": "abc123",
"tradeWeightedDays": 123.45,
"tradeLoadPortRegion": "abc123",
"tradeDiscPortRegion": "xyz789",
"tradeOpenPortRegion": "abc123",
"tradeMarginingAgreement": false,
"tradeNettingAgreement": false,
"tradeOptionDeclarationDate": "2007-12-03",
"tradeOptionStatus": "abc123",
"isMissingData": false,
"benchmarkBunkerExp": 987.65,
"exposureBasis": "abc123",
"exposureBenchmarkBasis": "abc123",
"totalDays": 987.65,
"totalTons": 123.45,
"totalExposureDays": 123.45,
"tradeDaysCalculated": 987.65,
"tradeTonsCalculated": 987.65,
"tradeExposureDaysCalculated": 123.45,
"snapshotType": "xyz789",
"contractID": "xyz789",
"dateLocal": "2007-12-03",
"seqNo": 987,
"marketName": "xyz789",
"realized": 123.45,
"exposure": 123.45,
"exposureDays": 123.45,
"exposureTons": 987.65,
"days": 123.45,
"tons": 123.45,
"marketDate": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"snapshotID": 123,
"contractType": "xyz789",
"routeCode": "abc123",
"marketRef": "xyz789",
"tradeRate": 123.45,
"tradeRateUnit": "abc123",
"marketRate": 987.65,
"marketRateUnit": "xyz789",
"marketRateConverted": 123.45,
"periodFromGmt": "2007-12-03",
"periodToGmt": "2007-12-03",
"monthIndex": 123,
"status": "abc123",
"settledRate": 987.65,
"bunkerExposure": 123.45,
"tce": 123.45,
"weightedDays": 123.45,
"correlation": 987.65,
"bunkerQty": 123.45,
"bunkerRate": 123.45,
"bunkerMarketRate": 123.45,
"baf": 987.65,
"bunkerSymbol": "abc123",
"bunkerCorrelation": 987.65,
"benchmarkBunkerExposure": 987.65,
"bunkerMarketSource": "abc123",
"bunkerMarketDate": "2007-12-03",
"bafRate": 123.45,
"marketRateOffset": 123.45,
"referenceID": 987,
"contractTce": 123.45,
"calcDescription": "xyz789",
"contractRate": 123.45,
"benchmarkEstimateID": "abc123",
"tradingMonthID": "xyz789",
"externalRef": "abc123",
"realizedPNL": 987.65,
"unrealizedPNL": 123.45,
"voyageEstimate": VoyageEstimate,
"tradeType": TradeType,
"tradeContract": TradeContract,
"tradePnlCargo": TradePnl,
"firstTradePnlDetail": TradePnlDetail,
"cargo": Cargo,
"company": AddressBook,
"tradePnlDetails": [TradePnlDetail],
"tradePnlDetailsExposure": [TradePnlDetail],
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
TradePnlDetail
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
shortLong - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
exposureCalcType - Int
|
|
isContractPaper - Boolean
|
|
isContractOption - Boolean
|
|
isInternalCompany - Boolean
|
|
tradeDays - Float
|
|
contractTypeCalculated - String
|
|
contractGroupCalculated - String
|
|
tradeAreaName - String
|
|
tradeRealized - Boolean
|
|
tradePnlValue - Float
|
|
tradeStatus - String
|
|
tradePnlStatus - String
|
|
tradeWeightedDays - Float
|
|
tradeLoadPortRegion - String
|
|
tradeDiscPortRegion - String
|
|
tradeOpenPortRegion - String
|
|
tradeMarginingAgreement - Boolean
|
|
tradeNettingAgreement - Boolean
|
|
tradeMonthDesc - String
|
|
isMissingData - Boolean
|
|
periodToGmt - Date
|
|
marketCurrency - String
|
|
cO2Tons - Float
|
|
cO2Exposure - Float
|
|
cO2Price - Float
|
|
cO2Market - String
|
|
cO2PriceSource - String
|
|
cO2PriceBasis - Date
|
|
cO2MarketRate - Float
|
|
cO2Symbol - String
|
|
snapshotID - Int
|
|
contractType - String
|
|
contractID - String
|
|
routeCode - String
|
|
monthIndex - Int
|
|
seqNo - Int
|
|
rate - Float
|
|
marketRate - Float
|
|
correlation - Float
|
|
adjustment - Float
|
|
marketDate - Date
|
|
marketSource - String
|
|
status - String
|
|
periodFromGmt - Date
|
|
periodToGmtInternal - Date
|
|
weightedDays - Float
|
|
days - Float
|
|
tons - Float
|
|
category - String
|
|
subType - String
|
|
exposure - Float
|
|
realized - Float
|
|
indexLinkedNoExposure - Boolean
|
|
marketValueCalculation - Boolean
|
|
calcDescription - String
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
optionType - String
|
|
calcType - String
|
|
impliedVolatility - Float
|
|
underlyingPremium - Float
|
|
exposureDate - Date
|
|
delta - Float
|
|
gamma - Float
|
|
vega - Float
|
|
theta - Float
|
|
rho - Float
|
|
ocean - String
|
|
startAveraging - Date
|
|
endAveraging - Date
|
|
pricingDays - Int
|
|
pricedDays - Int
|
|
holidayRef - String
|
|
refRate - Float
|
|
subID - String
|
|
externalRef - String
|
|
declarationDate - Date
|
|
referenceSeq - Int
|
|
averagingType - String
|
|
subCategory - String
|
|
discountRate - Float
|
|
nPV - Float
|
|
pricingType - String
|
|
marketName - String
|
|
wscLevel - Float
|
|
wscRate - Float
|
|
remarks - String
|
|
marketAddressCommission - Float
|
|
bafRate - Float
|
|
contractUnderlying - Float
|
|
unpricedComponent - String
|
|
contractDays - Float
|
|
contractQty - Float
|
|
contractRouteCode - String
|
|
contractRouteCorrelation - Float
|
|
netPnl - Float
|
|
brokerCommissionType - String
|
|
brokerCommissionAmount - Float
|
|
brokerCommissionRate - Float
|
|
internalCommissionType - String
|
|
internalCommissionAmount - Float
|
|
internalCommissionRate - Float
|
|
applicationStatus - String
|
|
hireRateFromGmt - Date
|
|
hireRateToGmt - Date
|
|
structureCorrelation - Float
|
|
profitSharePercent - Float
|
|
contractNetAddressCommission - Float
|
|
netPnlAfterAddressCommission - Float
|
|
tradeType - TradeType
|
|
tradeContract - TradeContract
|
|
tradePnlDetailCargo - TradePnlDetail
|
|
tradePnl - TradePnl
|
|
cargo - Cargo
|
|
company - AddressBook
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"shortLong": "xyz789",
"customFieldByID": Any,
"customField": Any,
"exposureCalcType": 987,
"isContractPaper": false,
"isContractOption": true,
"isInternalCompany": true,
"tradeDays": 123.45,
"contractTypeCalculated": "abc123",
"contractGroupCalculated": "xyz789",
"tradeAreaName": "xyz789",
"tradeRealized": true,
"tradePnlValue": 123.45,
"tradeStatus": "xyz789",
"tradePnlStatus": "abc123",
"tradeWeightedDays": 123.45,
"tradeLoadPortRegion": "xyz789",
"tradeDiscPortRegion": "abc123",
"tradeOpenPortRegion": "abc123",
"tradeMarginingAgreement": true,
"tradeNettingAgreement": false,
"tradeMonthDesc": "abc123",
"isMissingData": true,
"periodToGmt": "2007-12-03",
"marketCurrency": "abc123",
"cO2Tons": 987.65,
"cO2Exposure": 987.65,
"cO2Price": 987.65,
"cO2Market": "abc123",
"cO2PriceSource": "abc123",
"cO2PriceBasis": "2007-12-03",
"cO2MarketRate": 123.45,
"cO2Symbol": "abc123",
"snapshotID": 987,
"contractType": "xyz789",
"contractID": "xyz789",
"routeCode": "xyz789",
"monthIndex": 123,
"seqNo": 123,
"rate": 987.65,
"marketRate": 123.45,
"correlation": 987.65,
"adjustment": 123.45,
"marketDate": "2007-12-03",
"marketSource": "xyz789",
"status": "xyz789",
"periodFromGmt": "2007-12-03",
"periodToGmtInternal": "2007-12-03",
"weightedDays": 987.65,
"days": 987.65,
"tons": 123.45,
"category": "abc123",
"subType": "abc123",
"exposure": 123.45,
"realized": 123.45,
"indexLinkedNoExposure": false,
"marketValueCalculation": false,
"calcDescription": "abc123",
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123",
"optionType": "abc123",
"calcType": "abc123",
"impliedVolatility": 123.45,
"underlyingPremium": 987.65,
"exposureDate": "2007-12-03",
"delta": 987.65,
"gamma": 987.65,
"vega": 123.45,
"theta": 123.45,
"rho": 987.65,
"ocean": "abc123",
"startAveraging": "2007-12-03",
"endAveraging": "2007-12-03",
"pricingDays": 123,
"pricedDays": 987,
"holidayRef": "abc123",
"refRate": 123.45,
"subID": "abc123",
"externalRef": "xyz789",
"declarationDate": "2007-12-03",
"referenceSeq": 987,
"averagingType": "abc123",
"subCategory": "xyz789",
"discountRate": 123.45,
"nPV": 123.45,
"pricingType": "xyz789",
"marketName": "xyz789",
"wscLevel": 987.65,
"wscRate": 987.65,
"remarks": "abc123",
"marketAddressCommission": 123.45,
"bafRate": 987.65,
"contractUnderlying": 987.65,
"unpricedComponent": "abc123",
"contractDays": 123.45,
"contractQty": 123.45,
"contractRouteCode": "abc123",
"contractRouteCorrelation": 123.45,
"netPnl": 987.65,
"brokerCommissionType": "abc123",
"brokerCommissionAmount": 123.45,
"brokerCommissionRate": 123.45,
"internalCommissionType": "abc123",
"internalCommissionAmount": 123.45,
"internalCommissionRate": 987.65,
"applicationStatus": "abc123",
"hireRateFromGmt": "2007-12-03",
"hireRateToGmt": "2007-12-03",
"structureCorrelation": 987.65,
"profitSharePercent": 987.65,
"contractNetAddressCommission": 123.45,
"netPnlAfterAddressCommission": 123.45,
"tradeType": TradeType,
"tradeContract": TradeContract,
"tradePnlDetailCargo": TradePnlDetail,
"tradePnl": TradePnl,
"cargo": Cargo,
"company": AddressBook,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
TradePnlDetailFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TradePnlDetailFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TradePnlDetailFormQueryWhere
}
TradePnlDetailFormQueryWhere
Fields
Example
{
"and": [TradePnlDetailFormQueryWhere],
"or": [TradePnlDetailFormQueryWhere],
"rawExpression": "abc123",
"snapshotID": NumberWhereValueExpression,
"contractType": StringWhereValueExpression,
"contractID": StringWhereValueExpression,
"routeCode": StringWhereValueExpression,
"monthIndex": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"rate": NumberWhereValueExpression,
"marketRate": NumberWhereValueExpression,
"correlation": NumberWhereValueExpression,
"adjustment": NumberWhereValueExpression,
"marketDate": DateWhereValueExpression,
"marketSource": StringWhereValueExpression,
"status": StringWhereValueExpression,
"periodFromGmt": DateWhereValueExpression,
"periodToGmtInternal": DateWhereValueExpression,
"weightedDays": NumberWhereValueExpression,
"days": NumberWhereValueExpression,
"tons": NumberWhereValueExpression,
"category": StringWhereValueExpression,
"subType": StringWhereValueExpression,
"exposure": NumberWhereValueExpression,
"realized": NumberWhereValueExpression,
"indexLinkedNoExposure": BoolWhereValueExpression,
"marketValueCalculation": BoolWhereValueExpression,
"calcDescription": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"optionType": StringWhereValueExpression,
"calcType": StringWhereValueExpression,
"impliedVolatility": NumberWhereValueExpression,
"underlyingPremium": NumberWhereValueExpression,
"exposureDate": DateWhereValueExpression,
"delta": NumberWhereValueExpression,
"gamma": NumberWhereValueExpression,
"vega": NumberWhereValueExpression,
"theta": NumberWhereValueExpression,
"rho": NumberWhereValueExpression,
"ocean": StringWhereValueExpression,
"startAveraging": DateWhereValueExpression,
"endAveraging": DateWhereValueExpression,
"pricingDays": NumberWhereValueExpression,
"pricedDays": NumberWhereValueExpression,
"holidayRef": StringWhereValueExpression,
"refRate": NumberWhereValueExpression,
"subID": StringWhereValueExpression,
"externalRef": StringWhereValueExpression,
"declarationDate": DateWhereValueExpression,
"referenceSeq": NumberWhereValueExpression,
"averagingType": StringWhereValueExpression,
"subCategory": StringWhereValueExpression,
"discountRate": NumberWhereValueExpression,
"nPV": NumberWhereValueExpression,
"pricingType": StringWhereValueExpression,
"marketName": StringWhereValueExpression,
"wscLevel": NumberWhereValueExpression,
"wscRate": NumberWhereValueExpression,
"remarks": StringWhereValueExpression,
"marketAddressCommission": NumberWhereValueExpression,
"bafRate": NumberWhereValueExpression,
"contractUnderlying": NumberWhereValueExpression,
"unpricedComponent": StringWhereValueExpression,
"contractDays": NumberWhereValueExpression,
"contractQty": NumberWhereValueExpression,
"contractRouteCode": StringWhereValueExpression,
"contractRouteCorrelation": NumberWhereValueExpression,
"netPnl": NumberWhereValueExpression,
"brokerCommissionType": StringWhereValueExpression,
"brokerCommissionAmount": NumberWhereValueExpression,
"brokerCommissionRate": NumberWhereValueExpression,
"internalCommissionType": StringWhereValueExpression,
"internalCommissionAmount": NumberWhereValueExpression,
"internalCommissionRate": NumberWhereValueExpression,
"applicationStatus": StringWhereValueExpression,
"hireRateFromGmt": DateWhereValueExpression,
"hireRateToGmt": DateWhereValueExpression,
"structureCorrelation": NumberWhereValueExpression,
"profitSharePercent": NumberWhereValueExpression,
"contractNetAddressCommission": NumberWhereValueExpression,
"netPnlAfterAddressCommission": NumberWhereValueExpression,
"tradeType": TradeTypeFormQueryWhere,
"tradeContract": TradeContractFormQueryWhere,
"tradePnlDetailCargo": TradePnlDetailFormQueryWhere,
"tradePnl": TradePnlFormQueryWhere,
"cargo": CargoFormQueryWhere,
"company": AddressBookFormQueryWhere
}
TradePnlDetailRelationships
Fields
| Field Name | Description |
|---|---|
tradeType - RelationshipDefinition
|
|
tradeContract - RelationshipDefinition
|
|
tradePnlDetailCargo - RelationshipDefinition
|
|
tradePnl - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
company - RelationshipDefinition
|
Example
{
"tradeType": RelationshipDefinition,
"tradeContract": RelationshipDefinition,
"tradePnlDetailCargo": RelationshipDefinition,
"tradePnl": RelationshipDefinition,
"cargo": RelationshipDefinition,
"company": RelationshipDefinition
}
TradePnlFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TradePnlFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TradePnlFormQueryWhere
}
TradePnlFormQueryWhere
Fields
Example
{
"and": [TradePnlFormQueryWhere],
"or": [TradePnlFormQueryWhere],
"rawExpression": "abc123",
"snapshotType": StringWhereValueExpression,
"contractID": StringWhereValueExpression,
"dateLocal": DateWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"marketName": StringWhereValueExpression,
"realized": NumberWhereValueExpression,
"exposure": NumberWhereValueExpression,
"exposureDays": NumberWhereValueExpression,
"exposureTons": NumberWhereValueExpression,
"days": NumberWhereValueExpression,
"tons": NumberWhereValueExpression,
"marketDate": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"snapshotID": NumberWhereValueExpression,
"contractType": StringWhereValueExpression,
"routeCode": StringWhereValueExpression,
"marketRef": StringWhereValueExpression,
"tradeRate": NumberWhereValueExpression,
"tradeRateUnit": StringWhereValueExpression,
"marketRate": NumberWhereValueExpression,
"marketRateUnit": StringWhereValueExpression,
"marketRateConverted": NumberWhereValueExpression,
"periodFromGmt": DateWhereValueExpression,
"periodToGmt": DateWhereValueExpression,
"monthIndex": NumberWhereValueExpression,
"status": StringWhereValueExpression,
"settledRate": NumberWhereValueExpression,
"bunkerExposure": NumberWhereValueExpression,
"tce": NumberWhereValueExpression,
"weightedDays": NumberWhereValueExpression,
"correlation": NumberWhereValueExpression,
"bunkerQty": NumberWhereValueExpression,
"bunkerRate": NumberWhereValueExpression,
"bunkerMarketRate": NumberWhereValueExpression,
"baf": NumberWhereValueExpression,
"bunkerSymbol": StringWhereValueExpression,
"bunkerCorrelation": NumberWhereValueExpression,
"benchmarkBunkerExposure": NumberWhereValueExpression,
"bunkerMarketSource": StringWhereValueExpression,
"bunkerMarketDate": DateWhereValueExpression,
"bafRate": NumberWhereValueExpression,
"marketRateOffset": NumberWhereValueExpression,
"referenceID": NumberWhereValueExpression,
"contractTce": NumberWhereValueExpression,
"calcDescription": StringWhereValueExpression,
"contractRate": NumberWhereValueExpression,
"benchmarkEstimateID": StringWhereValueExpression,
"tradingMonthID": StringWhereValueExpression,
"externalRef": StringWhereValueExpression,
"realizedPNL": NumberWhereValueExpression,
"unrealizedPNL": NumberWhereValueExpression,
"voyageEstimate": VoyageEstimateFormQueryWhere,
"tradeType": TradeTypeFormQueryWhere,
"tradeContract": TradeContractFormQueryWhere,
"tradePnlCargo": TradePnlFormQueryWhere,
"firstTradePnlDetail": TradePnlDetailFormQueryWhere,
"cargo": CargoFormQueryWhere,
"company": AddressBookFormQueryWhere
}
TradePnlRelationships
Fields
| Field Name | Description |
|---|---|
voyageEstimate - RelationshipDefinition
|
|
tradeType - RelationshipDefinition
|
|
tradeContract - RelationshipDefinition
|
|
tradePnlCargo - RelationshipDefinition
|
|
firstTradePnlDetail - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
company - RelationshipDefinition
|
|
tradePnlLastSnapshot - RelationshipDefinition
|
|
tradePnlDetails - RelationshipDefinition
|
|
tradePnlDetailsExposure - RelationshipDefinition
|
|
tradePnlThisSnapshot - RelationshipDefinition
|
Example
{
"voyageEstimate": RelationshipDefinition,
"tradeType": RelationshipDefinition,
"tradeContract": RelationshipDefinition,
"tradePnlCargo": RelationshipDefinition,
"firstTradePnlDetail": RelationshipDefinition,
"cargo": RelationshipDefinition,
"company": RelationshipDefinition,
"tradePnlLastSnapshot": RelationshipDefinition,
"tradePnlDetails": RelationshipDefinition,
"tradePnlDetailsExposure": RelationshipDefinition,
"tradePnlThisSnapshot": RelationshipDefinition
}
TradeSnapshot
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
snapshotID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
snapshotType - String
|
|
cacheDateGmt - Date
|
|
marketName - String
|
|
marketVariance - Float
|
|
bunkerMarketName - String
|
|
bunkerMarketVariance - Float
|
|
startDate - Date
|
|
drilldown - Boolean
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
externalRef - String
|
|
tradingProfileID - Int
|
|
tradingProfileShortName - String
|
|
tradingProfile - TradingProfile
|
|
tradeContracts - [TradeContract]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"snapshotID": 987,
"customFieldByID": Any,
"customField": Any,
"snapshotType": "xyz789",
"cacheDateGmt": "2007-12-03",
"marketName": "xyz789",
"marketVariance": 987.65,
"bunkerMarketName": "xyz789",
"bunkerMarketVariance": 987.65,
"startDate": "2007-12-03",
"drilldown": false,
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"externalRef": "abc123",
"tradingProfileID": 123,
"tradingProfileShortName": "abc123",
"tradingProfile": TradingProfile,
"tradeContracts": [TradeContract],
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
TradeSnapshotFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TradeSnapshotFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TradeSnapshotFormQueryWhere
}
TradeSnapshotFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TradeSnapshotFormQueryWhere!]
|
|
or - [TradeSnapshotFormQueryWhere!]
|
|
rawExpression - String
|
|
snapshotID - NumberWhereValueExpression
|
|
snapshotType - TradeSnapshotSnapshotTypeEnumValueExpression
|
|
cacheDateGmt - DateWhereValueExpression
|
|
marketName - StringWhereValueExpression
|
|
marketVariance - NumberWhereValueExpression
|
|
bunkerMarketName - StringWhereValueExpression
|
|
bunkerMarketVariance - NumberWhereValueExpression
|
|
startDate - DateWhereValueExpression
|
|
drilldown - BoolWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
externalRef - StringWhereValueExpression
|
|
tradingProfileID - NumberWhereValueExpression
|
|
tradingProfileShortName - StringWhereValueExpression
|
|
tradingProfile - TradingProfileFormQueryWhere
|
Example
{
"and": [TradeSnapshotFormQueryWhere],
"or": [TradeSnapshotFormQueryWhere],
"rawExpression": "xyz789",
"snapshotID": NumberWhereValueExpression,
"snapshotType": TradeSnapshotSnapshotTypeEnumValueExpression,
"cacheDateGmt": DateWhereValueExpression,
"marketName": StringWhereValueExpression,
"marketVariance": NumberWhereValueExpression,
"bunkerMarketName": StringWhereValueExpression,
"bunkerMarketVariance": NumberWhereValueExpression,
"startDate": DateWhereValueExpression,
"drilldown": BoolWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"externalRef": StringWhereValueExpression,
"tradingProfileID": NumberWhereValueExpression,
"tradingProfileShortName": StringWhereValueExpression,
"tradingProfile": TradingProfileFormQueryWhere
}
TradeSnapshotRelationships
Fields
| Field Name | Description |
|---|---|
tradingProfile - RelationshipDefinition
|
|
tradeContracts - RelationshipDefinition
|
Example
{
"tradingProfile": RelationshipDefinition,
"tradeContracts": RelationshipDefinition
}
TradeSnapshotSnapshotTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
TradeSnapshotSnapshotTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TradeSnapshotSnapshotTypeEnum
|
|
isNot - TradeSnapshotSnapshotTypeEnum
|
|
isIn - [TradeSnapshotSnapshotTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
TradeType
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
sqlID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
name - String
|
|
description - String
|
|
rateDescription - String
|
|
groupIndex - Int
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
basisQty - Float
|
|
lastUser - String
|
|
correlation - Float
|
|
externalRef - String
|
|
basisDays - Float
|
|
vesselType - String
|
|
portNo - Int
|
|
fuelType - String
|
|
calendarCode - String
|
|
commodityUnit - String
|
|
settlementRoute - String
|
|
spotRoute - String
|
|
impliedAddressCommission - Float
|
|
volatilityRoute - String
|
|
currency - String
|
|
tradeIndex - TradeIndex
|
|
port - Port
|
|
tradeIndexs - [TradeIndex]
|
|
tradeAreas - [TradeArea]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"sqlID": 987,
"customFieldByID": Any,
"customField": Any,
"name": "abc123",
"description": "xyz789",
"rateDescription": "xyz789",
"groupIndex": 123,
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"basisQty": 123.45,
"lastUser": "xyz789",
"correlation": 123.45,
"externalRef": "xyz789",
"basisDays": 123.45,
"vesselType": "xyz789",
"portNo": 123,
"fuelType": "abc123",
"calendarCode": "abc123",
"commodityUnit": "abc123",
"settlementRoute": "xyz789",
"spotRoute": "xyz789",
"impliedAddressCommission": 123.45,
"volatilityRoute": "abc123",
"currency": "xyz789",
"tradeIndex": TradeIndex,
"port": Port,
"tradeIndexs": [TradeIndex],
"tradeAreas": [TradeArea],
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
TradeTypeFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TradeTypeFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TradeTypeFormQueryWhere
}
TradeTypeFormQueryWhere
Fields
Example
{
"and": [TradeTypeFormQueryWhere],
"or": [TradeTypeFormQueryWhere],
"rawExpression": "abc123",
"name": StringWhereValueExpression,
"description": StringWhereValueExpression,
"rateDescription": StringWhereValueExpression,
"groupIndex": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"basisQty": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"correlation": NumberWhereValueExpression,
"externalRef": StringWhereValueExpression,
"basisDays": NumberWhereValueExpression,
"vesselType": StringWhereValueExpression,
"portNo": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"calendarCode": StringWhereValueExpression,
"commodityUnit": StringWhereValueExpression,
"settlementRoute": StringWhereValueExpression,
"spotRoute": StringWhereValueExpression,
"impliedAddressCommission": NumberWhereValueExpression,
"volatilityRoute": StringWhereValueExpression,
"currency": StringWhereValueExpression,
"tradeIndex": TradeIndexFormQueryWhere,
"port": PortFormQueryWhere
}
TradeTypeRelationships
Fields
| Field Name | Description |
|---|---|
tradeIndex - RelationshipDefinition
|
|
port - RelationshipDefinition
|
|
tradeIndexs - RelationshipDefinition
|
|
tradeAreas - RelationshipDefinition
|
Example
{
"tradeIndex": RelationshipDefinition,
"port": RelationshipDefinition,
"tradeIndexs": RelationshipDefinition,
"tradeAreas": RelationshipDefinition
}
TradeUnit
Fields
| Field Name | Description |
|---|---|
iD - Int
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
companyCode - String
|
|
lobCode - String
|
|
department - String
|
|
commodity - String
|
|
date - Date
|
|
isFobCargo - Boolean
|
|
fOBRefVesselName - String
|
|
qtyMt - Float
|
|
qtyBbl - Float
|
|
qtyKgl - Float
|
|
actualRevenue - Float
|
|
actualExpense - Float
|
|
grossMargin - Float
|
|
netMargin - Float
|
|
lastUpdateGmt - Date
|
|
lastUserID - String
|
|
saleContractIds - String
|
|
purchaseContractIds - String
|
|
status - String
|
|
cargo - Cargo
|
|
company - AddressBook
|
|
voyage - Voyage
|
|
vessel - Vessel
|
|
lob - Lob
|
|
actDepartment - ActDepartment
|
|
cargoName - CargoName
|
|
tradeUnitItineraries - [CargoItinerary]
|
|
loadItineraries - [CargoItinerary]
|
|
discItineraries - [CargoItinerary]
|
|
userDefinedFields - Json
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"iD": 987,
"vesselCode": "abc123",
"voyageNo": 987,
"companyCode": "xyz789",
"lobCode": "abc123",
"department": "abc123",
"commodity": "xyz789",
"date": "2007-12-03",
"isFobCargo": true,
"fOBRefVesselName": "xyz789",
"qtyMt": 987.65,
"qtyBbl": 123.45,
"qtyKgl": 987.65,
"actualRevenue": 123.45,
"actualExpense": 123.45,
"grossMargin": 987.65,
"netMargin": 987.65,
"lastUpdateGmt": "2007-12-03",
"lastUserID": "abc123",
"saleContractIds": "xyz789",
"purchaseContractIds": "abc123",
"status": "xyz789",
"cargo": Cargo,
"company": AddressBook,
"voyage": Voyage,
"vessel": Vessel,
"lob": Lob,
"actDepartment": ActDepartment,
"cargoName": CargoName,
"tradeUnitItineraries": [CargoItinerary],
"loadItineraries": [CargoItinerary],
"discItineraries": [CargoItinerary],
"userDefinedFields": Json,
"_id": "xyz789",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
TradeUnitFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TradeUnitFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TradeUnitFormQueryWhere
}
TradeUnitFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TradeUnitFormQueryWhere!]
|
|
or - [TradeUnitFormQueryWhere!]
|
|
rawExpression - String
|
|
cargo - CargoFormQueryWhere
|
|
company - AddressBookFormQueryWhere
|
|
voyage - VoyageFormQueryWhere
|
|
vessel - VesselFormQueryWhere
|
|
lob - LobFormQueryWhere
|
|
actDepartment - ActDepartmentFormQueryWhere
|
|
cargoName - CargoNameFormQueryWhere
|
Example
{
"and": [TradeUnitFormQueryWhere],
"or": [TradeUnitFormQueryWhere],
"rawExpression": "xyz789",
"cargo": CargoFormQueryWhere,
"company": AddressBookFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"vessel": VesselFormQueryWhere,
"lob": LobFormQueryWhere,
"actDepartment": ActDepartmentFormQueryWhere,
"cargoName": CargoNameFormQueryWhere
}
TradeUnitRelationships
Fields
| Field Name | Description |
|---|---|
cargo - RelationshipDefinition
|
|
company - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
lob - RelationshipDefinition
|
|
actDepartment - RelationshipDefinition
|
|
cargoName - RelationshipDefinition
|
|
tradeUnitItineraries - RelationshipDefinition
|
|
saleCommodityContractItineraries - RelationshipDefinition
|
|
purchaseCommodityContractItineraries - RelationshipDefinition
|
|
loadItineraries - RelationshipDefinition
|
|
discItineraries - RelationshipDefinition
|
Example
{
"cargo": RelationshipDefinition,
"company": RelationshipDefinition,
"voyage": RelationshipDefinition,
"vessel": RelationshipDefinition,
"lob": RelationshipDefinition,
"actDepartment": RelationshipDefinition,
"cargoName": RelationshipDefinition,
"tradeUnitItineraries": RelationshipDefinition,
"saleCommodityContractItineraries": RelationshipDefinition,
"purchaseCommodityContractItineraries": RelationshipDefinition,
"loadItineraries": RelationshipDefinition,
"discItineraries": RelationshipDefinition
}
TradingProfile
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
iD - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
name - String
|
|
description - String
|
|
includeCommission - Boolean
|
|
excludeOtm - Boolean
|
|
excludeInternalTrades - Boolean
|
|
normalizeTCRouteCorr - Boolean
|
|
overwriteBenchmarkItin - Boolean
|
|
adjustTcDurationMarketCond - Boolean
|
|
useAboutDays - Boolean
|
|
hideDaysExposureOnIndexLinked - Boolean
|
|
externalRef - String
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
type - String
|
|
cargoCorrelationAndAdjustmentFromIndexLinkedContract - Boolean
|
|
tcCorrelationAndAdjustmentFromIndexLinkedContract - Boolean
|
|
useEstimatedBallastDaysToCalculateStartOfExposure - Boolean
|
|
estimatedBallastDaysStartBasisMidLaycan - Boolean
|
|
estimatedBallastDaysStartBasisMaxLaycan - Boolean
|
|
useMinDurationOnTCContracts - Boolean
|
|
applyMarketValueConcept - Boolean
|
|
movePhysicalBunkerExposureAheadOneMonth - Boolean
|
|
onlyAfterThresholdNumberOfDaysInMonthHavePassed - Boolean
|
|
useActualDeliveryDateForTcExposure - Boolean
|
|
preserveExposureAtCommencementForBallastVoyages - Boolean
|
|
deductTCUnavailableDaysFromExposureDays - Boolean
|
|
tradingProfileProperties - [TradingProfileProperty]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"iD": 987,
"customFieldByID": Any,
"customField": Any,
"name": "xyz789",
"description": "xyz789",
"includeCommission": true,
"excludeOtm": false,
"excludeInternalTrades": true,
"normalizeTCRouteCorr": false,
"overwriteBenchmarkItin": true,
"adjustTcDurationMarketCond": false,
"useAboutDays": false,
"hideDaysExposureOnIndexLinked": false,
"externalRef": "abc123",
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123",
"type": "abc123",
"cargoCorrelationAndAdjustmentFromIndexLinkedContract": true,
"tcCorrelationAndAdjustmentFromIndexLinkedContract": false,
"useEstimatedBallastDaysToCalculateStartOfExposure": false,
"estimatedBallastDaysStartBasisMidLaycan": true,
"estimatedBallastDaysStartBasisMaxLaycan": false,
"useMinDurationOnTCContracts": true,
"applyMarketValueConcept": true,
"movePhysicalBunkerExposureAheadOneMonth": true,
"onlyAfterThresholdNumberOfDaysInMonthHavePassed": false,
"useActualDeliveryDateForTcExposure": false,
"preserveExposureAtCommencementForBallastVoyages": false,
"deductTCUnavailableDaysFromExposureDays": false,
"tradingProfileProperties": [TradingProfileProperty],
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
TradingProfileFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TradingProfileFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TradingProfileFormQueryWhere
}
TradingProfileFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TradingProfileFormQueryWhere!]
|
|
or - [TradingProfileFormQueryWhere!]
|
|
rawExpression - String
|
|
iD - NumberWhereValueExpression
|
|
name - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
includeCommission - BoolWhereValueExpression
|
|
excludeOtm - BoolWhereValueExpression
|
|
excludeInternalTrades - BoolWhereValueExpression
|
|
normalizeTCRouteCorr - BoolWhereValueExpression
|
|
overwriteBenchmarkItin - BoolWhereValueExpression
|
|
adjustTcDurationMarketCond - BoolWhereValueExpression
|
|
useAboutDays - BoolWhereValueExpression
|
|
hideDaysExposureOnIndexLinked - BoolWhereValueExpression
|
|
externalRef - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
type - StringWhereValueExpression
|
|
cargoCorrelationAndAdjustmentFromIndexLinkedContract - BoolWhereValueExpression
|
|
tcCorrelationAndAdjustmentFromIndexLinkedContract - BoolWhereValueExpression
|
|
useEstimatedBallastDaysToCalculateStartOfExposure - BoolWhereValueExpression
|
|
estimatedBallastDaysStartBasisMidLaycan - BoolWhereValueExpression
|
|
estimatedBallastDaysStartBasisMaxLaycan - BoolWhereValueExpression
|
|
useMinDurationOnTCContracts - BoolWhereValueExpression
|
|
applyMarketValueConcept - BoolWhereValueExpression
|
|
movePhysicalBunkerExposureAheadOneMonth - BoolWhereValueExpression
|
|
onlyAfterThresholdNumberOfDaysInMonthHavePassed - BoolWhereValueExpression
|
|
useActualDeliveryDateForTcExposure - BoolWhereValueExpression
|
|
preserveExposureAtCommencementForBallastVoyages - BoolWhereValueExpression
|
|
deductTCUnavailableDaysFromExposureDays - BoolWhereValueExpression
|
Example
{
"and": [TradingProfileFormQueryWhere],
"or": [TradingProfileFormQueryWhere],
"rawExpression": "abc123",
"iD": NumberWhereValueExpression,
"name": StringWhereValueExpression,
"description": StringWhereValueExpression,
"includeCommission": BoolWhereValueExpression,
"excludeOtm": BoolWhereValueExpression,
"excludeInternalTrades": BoolWhereValueExpression,
"normalizeTCRouteCorr": BoolWhereValueExpression,
"overwriteBenchmarkItin": BoolWhereValueExpression,
"adjustTcDurationMarketCond": BoolWhereValueExpression,
"useAboutDays": BoolWhereValueExpression,
"hideDaysExposureOnIndexLinked": BoolWhereValueExpression,
"externalRef": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"type": StringWhereValueExpression,
"cargoCorrelationAndAdjustmentFromIndexLinkedContract": BoolWhereValueExpression,
"tcCorrelationAndAdjustmentFromIndexLinkedContract": BoolWhereValueExpression,
"useEstimatedBallastDaysToCalculateStartOfExposure": BoolWhereValueExpression,
"estimatedBallastDaysStartBasisMidLaycan": BoolWhereValueExpression,
"estimatedBallastDaysStartBasisMaxLaycan": BoolWhereValueExpression,
"useMinDurationOnTCContracts": BoolWhereValueExpression,
"applyMarketValueConcept": BoolWhereValueExpression,
"movePhysicalBunkerExposureAheadOneMonth": BoolWhereValueExpression,
"onlyAfterThresholdNumberOfDaysInMonthHavePassed": BoolWhereValueExpression,
"useActualDeliveryDateForTcExposure": BoolWhereValueExpression,
"preserveExposureAtCommencementForBallastVoyages": BoolWhereValueExpression,
"deductTCUnavailableDaysFromExposureDays": BoolWhereValueExpression
}
TradingProfileProperty
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
m2MMarket - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
m2MMarketAdjPct - Float
|
|
m2MBunkerMarket - String
|
|
m2MBunkerMarketAdjPct - Float
|
|
pRFixed - String
|
|
pRSailed - String
|
|
pnlRRRealizedPnl - String
|
|
oVRDeltaModel - String
|
|
oVRPricingModel - String
|
|
oVRMarket - String
|
|
oVRDiscountMarket - String
|
|
iD - Int
|
|
seqNo - Int
|
|
type - String
|
|
subType - String
|
|
stringValue1 - String
|
|
stringValue2 - String
|
|
stringValue3 - String
|
|
stringValue4 - String
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
numericValue1 - Float
|
|
numericValue2 - Float
|
|
numericValue3 - Float
|
|
stringValue6 - String
|
|
numericValue4 - Float
|
|
tradingProfile - TradingProfile
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"m2MMarket": "xyz789",
"customFieldByID": Any,
"customField": Any,
"m2MMarketAdjPct": 987.65,
"m2MBunkerMarket": "abc123",
"m2MBunkerMarketAdjPct": 123.45,
"pRFixed": "xyz789",
"pRSailed": "abc123",
"pnlRRRealizedPnl": "xyz789",
"oVRDeltaModel": "xyz789",
"oVRPricingModel": "xyz789",
"oVRMarket": "abc123",
"oVRDiscountMarket": "abc123",
"iD": 123,
"seqNo": 987,
"type": "xyz789",
"subType": "abc123",
"stringValue1": "xyz789",
"stringValue2": "abc123",
"stringValue3": "abc123",
"stringValue4": "xyz789",
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"numericValue1": 987.65,
"numericValue2": 987.65,
"numericValue3": 987.65,
"stringValue6": "abc123",
"numericValue4": 987.65,
"tradingProfile": TradingProfile,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
TradingProfilePropertyFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - TradingProfilePropertyFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": TradingProfilePropertyFormQueryWhere
}
TradingProfilePropertyFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [TradingProfilePropertyFormQueryWhere!]
|
|
or - [TradingProfilePropertyFormQueryWhere!]
|
|
rawExpression - String
|
|
iD - NumberWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
type - TradingProfilePropertyTypeEnumValueExpression
|
|
subType - StringWhereValueExpression
|
|
stringValue1 - StringWhereValueExpression
|
|
stringValue2 - StringWhereValueExpression
|
|
stringValue3 - StringWhereValueExpression
|
|
stringValue4 - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
numericValue1 - NumberWhereValueExpression
|
|
numericValue2 - NumberWhereValueExpression
|
|
numericValue3 - NumberWhereValueExpression
|
|
stringValue6 - StringWhereValueExpression
|
|
numericValue4 - NumberWhereValueExpression
|
|
tradingProfile - TradingProfileFormQueryWhere
|
Example
{
"and": [TradingProfilePropertyFormQueryWhere],
"or": [TradingProfilePropertyFormQueryWhere],
"rawExpression": "xyz789",
"iD": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"type": TradingProfilePropertyTypeEnumValueExpression,
"subType": StringWhereValueExpression,
"stringValue1": StringWhereValueExpression,
"stringValue2": StringWhereValueExpression,
"stringValue3": StringWhereValueExpression,
"stringValue4": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"numericValue1": NumberWhereValueExpression,
"numericValue2": NumberWhereValueExpression,
"numericValue3": NumberWhereValueExpression,
"stringValue6": StringWhereValueExpression,
"numericValue4": NumberWhereValueExpression,
"tradingProfile": TradingProfileFormQueryWhere
}
TradingProfilePropertyRelationships
Fields
| Field Name | Description |
|---|---|
tradingProfile - RelationshipDefinition
|
Example
{"tradingProfile": RelationshipDefinition}
TradingProfilePropertyTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
TradingProfilePropertyTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - TradingProfilePropertyTypeEnum
|
|
isNot - TradingProfilePropertyTypeEnum
|
|
isIn - [TradingProfilePropertyTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
TradingProfileRelationships
Fields
| Field Name | Description |
|---|---|
tradingProfileProperties - RelationshipDefinition
|
Example
{"tradingProfileProperties": RelationshipDefinition}
Trading_functionsRootMutation
Fields
| Field Name | Description |
|---|---|
applyUpdatePaperTrade - Imosfunctions_ApplyUpdatePaperTradeResponse
|
|
Arguments |
|
compareTradingPnlSnapshots - Imosfunctions_CompareTradingPnlSnapshotsResponse
|
|
Arguments |
|
deletePaperTrade - Imosfunctions_DeletePaperTradeResponse
|
|
Arguments
|
|
Example
{
"applyUpdatePaperTrade": Imosfunctions_ApplyUpdatePaperTradeResponse,
"compareTradingPnlSnapshots": Imosfunctions_CompareTradingPnlSnapshotsResponse,
"deletePaperTrade": Imosfunctions_DeletePaperTradeResponse
}
UnitOfMeasure
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
code - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
description - String
|
|
type - String
|
|
alternateCode - String
|
|
conversionFactor - Float
|
|
vesselBunkerTanks - [VesselBunkerTank]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"code": "xyz789",
"customFieldByID": Any,
"customField": Any,
"description": "xyz789",
"type": "xyz789",
"alternateCode": "xyz789",
"conversionFactor": 123.45,
"vesselBunkerTanks": [VesselBunkerTank],
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
UnitOfMeasureFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - UnitOfMeasureFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": UnitOfMeasureFormQueryWhere
}
UnitOfMeasureFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [UnitOfMeasureFormQueryWhere!]
|
|
or - [UnitOfMeasureFormQueryWhere!]
|
|
rawExpression - String
|
|
code - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
type - UnitOfMeasureTypeEnumValueExpression
|
|
alternateCode - StringWhereValueExpression
|
|
conversionFactor - NumberWhereValueExpression
|
Example
{
"and": [UnitOfMeasureFormQueryWhere],
"or": [UnitOfMeasureFormQueryWhere],
"rawExpression": "xyz789",
"code": StringWhereValueExpression,
"description": StringWhereValueExpression,
"type": UnitOfMeasureTypeEnumValueExpression,
"alternateCode": StringWhereValueExpression,
"conversionFactor": NumberWhereValueExpression
}
UnitOfMeasureRelationships
Fields
| Field Name | Description |
|---|---|
vesselBunkerTanks - RelationshipDefinition
|
Example
{"vesselBunkerTanks": RelationshipDefinition}
UnitOfMeasureTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Other"
UnitOfMeasureTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - UnitOfMeasureTypeEnum
|
|
isNot - UnitOfMeasureTypeEnum
|
|
isIn - [UnitOfMeasureTypeEnum]
|
Example
{"is": "Other", "isNot": "Other", "isIn": ["Other"]}
UnpricedElement
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
startEnd - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
isCommissionable - Boolean
|
|
sqlID - Int
|
|
iD - Int
|
|
contractType - String
|
|
contractID - String
|
|
seqNo - Int
|
|
component - String
|
|
subtype - String
|
|
settlementMarket - String
|
|
settlementCurve - String
|
|
settlementCurveCorrelation - Float
|
|
settlementCurveAdjustment - Float
|
|
timeOffset - Float
|
|
timeOffsetUnit - String
|
|
averagingPeriod - Float
|
|
averagingPeriodUnit - String
|
|
remarks - String
|
|
useEventEnd - Boolean
|
|
useStructure - Boolean
|
|
fillRuleNextAvailable - Boolean
|
|
fillTypeWeekends - Boolean
|
|
fillTypeHolidays - Boolean
|
|
onDeadfreight - Boolean
|
|
fillRuleLastSpotPricing - Boolean
|
|
multiplyByFreight - Boolean
|
|
isNotCommissionable - Boolean
|
|
structureInterval - Float
|
|
eventType - String
|
|
eventDate - Date
|
|
forwardCurve - String
|
|
forwardCurveCorrelation - Float
|
|
forwardCurveAdjustment - Float
|
|
quantity - Float
|
|
quantityUnit - String
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
cargoID - Int
|
|
tcCode - String
|
|
fuelType - String
|
|
overridingPrice - Float
|
|
coaID - Int
|
|
fuelLubeType - FuelLubeType
|
|
coa - COA
|
|
cargo - Cargo
|
|
tcContract - TimeCharterContract
|
|
unpricedElementStructures - [UnpricedElementStructure]
|
|
forwardMarketData - [MarketData]
|
|
settlementMarketData - [MarketData]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"startEnd": "abc123",
"customFieldByID": Any,
"customField": Any,
"isCommissionable": true,
"sqlID": 987,
"iD": 123,
"contractType": "abc123",
"contractID": "xyz789",
"seqNo": 987,
"component": "xyz789",
"subtype": "xyz789",
"settlementMarket": "abc123",
"settlementCurve": "xyz789",
"settlementCurveCorrelation": 987.65,
"settlementCurveAdjustment": 123.45,
"timeOffset": 987.65,
"timeOffsetUnit": "xyz789",
"averagingPeriod": 123.45,
"averagingPeriodUnit": "xyz789",
"remarks": "abc123",
"useEventEnd": true,
"useStructure": true,
"fillRuleNextAvailable": true,
"fillTypeWeekends": true,
"fillTypeHolidays": true,
"onDeadfreight": false,
"fillRuleLastSpotPricing": false,
"multiplyByFreight": false,
"isNotCommissionable": false,
"structureInterval": 987.65,
"eventType": "xyz789",
"eventDate": "2007-12-03",
"forwardCurve": "abc123",
"forwardCurveCorrelation": 987.65,
"forwardCurveAdjustment": 987.65,
"quantity": 123.45,
"quantityUnit": "xyz789",
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"cargoID": 123,
"tcCode": "abc123",
"fuelType": "xyz789",
"overridingPrice": 123.45,
"coaID": 123,
"fuelLubeType": FuelLubeType,
"coa": COA,
"cargo": Cargo,
"tcContract": TimeCharterContract,
"unpricedElementStructures": [UnpricedElementStructure],
"forwardMarketData": [MarketData],
"settlementMarketData": [MarketData],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
UnpricedElementComponentEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Hire"
UnpricedElementComponentEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - UnpricedElementComponentEnum
|
|
isNot - UnpricedElementComponentEnum
|
|
isIn - [UnpricedElementComponentEnum]
|
Example
{"is": "Hire", "isNot": "Hire", "isIn": ["Hire"]}
UnpricedElementContractTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Cargo"
UnpricedElementContractTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - UnpricedElementContractTypeEnum
|
|
isNot - UnpricedElementContractTypeEnum
|
|
isIn - [UnpricedElementContractTypeEnum]
|
Example
{"is": "Cargo", "isNot": "Cargo", "isIn": ["Cargo"]}
UnpricedElementEventTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"StartOfLaycan"
UnpricedElementEventTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - UnpricedElementEventTypeEnum
|
|
isNot - UnpricedElementEventTypeEnum
|
|
isIn - [UnpricedElementEventTypeEnum]
|
Example
{"is": "StartOfLaycan", "isNot": "StartOfLaycan", "isIn": ["StartOfLaycan"]}
UnpricedElementFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - UnpricedElementFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": UnpricedElementFormQueryWhere
}
UnpricedElementFormQueryWhere
Fields
Example
{
"and": [UnpricedElementFormQueryWhere],
"or": [UnpricedElementFormQueryWhere],
"rawExpression": "xyz789",
"iD": NumberWhereValueExpression,
"contractType": UnpricedElementContractTypeEnumValueExpression,
"contractID": StringWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"component": UnpricedElementComponentEnumValueExpression,
"subtype": StringWhereValueExpression,
"settlementMarket": StringWhereValueExpression,
"settlementCurve": StringWhereValueExpression,
"settlementCurveCorrelation": NumberWhereValueExpression,
"settlementCurveAdjustment": NumberWhereValueExpression,
"timeOffset": NumberWhereValueExpression,
"timeOffsetUnit": StringWhereValueExpression,
"averagingPeriod": NumberWhereValueExpression,
"averagingPeriodUnit": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"useEventEnd": BoolWhereValueExpression,
"useStructure": BoolWhereValueExpression,
"fillRuleNextAvailable": BoolWhereValueExpression,
"fillTypeWeekends": BoolWhereValueExpression,
"fillTypeHolidays": BoolWhereValueExpression,
"onDeadfreight": BoolWhereValueExpression,
"fillRuleLastSpotPricing": BoolWhereValueExpression,
"multiplyByFreight": BoolWhereValueExpression,
"isNotCommissionable": BoolWhereValueExpression,
"structureInterval": NumberWhereValueExpression,
"eventType": UnpricedElementEventTypeEnumValueExpression,
"eventDate": DateWhereValueExpression,
"forwardCurve": StringWhereValueExpression,
"forwardCurveCorrelation": NumberWhereValueExpression,
"forwardCurveAdjustment": NumberWhereValueExpression,
"quantity": NumberWhereValueExpression,
"quantityUnit": UnpricedElementQuantityUnitEnumValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"tcCode": StringWhereValueExpression,
"fuelType": StringWhereValueExpression,
"overridingPrice": NumberWhereValueExpression,
"coaID": NumberWhereValueExpression,
"fuelLubeType": FuelLubeTypeFormQueryWhere,
"coa": COAFormQueryWhere,
"cargo": CargoFormQueryWhere,
"tcContract": TimeCharterContractFormQueryWhere
}
UnpricedElementQuantityUnitEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
UnpricedElementQuantityUnitEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - UnpricedElementQuantityUnitEnum
|
|
isNot - UnpricedElementQuantityUnitEnum
|
|
isIn - [UnpricedElementQuantityUnitEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
UnpricedElementRelationships
Fields
| Field Name | Description |
|---|---|
fuelLubeType - RelationshipDefinition
|
|
cOA - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
tCContract - RelationshipDefinition
|
|
unpricedElementStructures - RelationshipDefinition
|
|
forwardMarketData - RelationshipDefinition
|
|
settlementMarketData - RelationshipDefinition
|
Example
{
"fuelLubeType": RelationshipDefinition,
"cOA": RelationshipDefinition,
"cargo": RelationshipDefinition,
"tCContract": RelationshipDefinition,
"unpricedElementStructures": RelationshipDefinition,
"forwardMarketData": RelationshipDefinition,
"settlementMarketData": RelationshipDefinition
}
UnpricedElementRemark
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
contractType - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
contractID - String
|
|
remark - String
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
cargoID - Int
|
|
tcCode - String
|
|
coaID - Int
|
|
cargo - Cargo
|
|
coa - COA
|
|
_keys - [String]
|
|
_intents - [String]
|
|
Example
{
"_id": "abc123",
"contractType": "xyz789",
"customFieldByID": Any,
"customField": Any,
"contractID": "abc123",
"remark": "abc123",
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123",
"cargoID": 987,
"tcCode": "xyz789",
"coaID": 987,
"cargo": Cargo,
"coa": COA,
"_keys": ["xyz789"],
"_intents": ["abc123"]
}
UnpricedElementRemarkRelationships
Fields
| Field Name | Description |
|---|---|
cargo - RelationshipDefinition
|
|
cOA - RelationshipDefinition
|
Example
{
"cargo": RelationshipDefinition,
"cOA": RelationshipDefinition
}
UnpricedElementStructure
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
iD - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
contractType - String
|
|
contractID - String
|
|
unpricedElementSeqNo - Int
|
|
seqNo - Int
|
|
range - String
|
|
level - Float
|
|
correlation - Float
|
|
offset - Float
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
unpricedElement - UnpricedElement
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"iD": 987,
"customFieldByID": Any,
"customField": Any,
"contractType": "xyz789",
"contractID": "abc123",
"unpricedElementSeqNo": 123,
"seqNo": 123,
"range": "xyz789",
"level": 123.45,
"correlation": 987.65,
"offset": 987.65,
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123",
"unpricedElement": UnpricedElement,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
UnpricedElementStructureContractTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Cargo"
UnpricedElementStructureContractTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - UnpricedElementStructureContractTypeEnum
|
|
isNot - UnpricedElementStructureContractTypeEnum
|
|
isIn - [UnpricedElementStructureContractTypeEnum]
|
Example
{"is": "Cargo", "isNot": "Cargo", "isIn": ["Cargo"]}
UnpricedElementStructureFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - UnpricedElementStructureFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": UnpricedElementStructureFormQueryWhere
}
UnpricedElementStructureFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [UnpricedElementStructureFormQueryWhere!]
|
|
or - [UnpricedElementStructureFormQueryWhere!]
|
|
rawExpression - String
|
|
iD - NumberWhereValueExpression
|
|
contractType - UnpricedElementStructureContractTypeEnumValueExpression
|
|
contractID - StringWhereValueExpression
|
|
unpricedElementSeqNo - NumberWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
range - StringWhereValueExpression
|
|
level - NumberWhereValueExpression
|
|
correlation - NumberWhereValueExpression
|
|
offset - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
unpricedElement - UnpricedElementFormQueryWhere
|
Example
{
"and": [UnpricedElementStructureFormQueryWhere],
"or": [UnpricedElementStructureFormQueryWhere],
"rawExpression": "xyz789",
"iD": NumberWhereValueExpression,
"contractType": UnpricedElementStructureContractTypeEnumValueExpression,
"contractID": StringWhereValueExpression,
"unpricedElementSeqNo": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"range": StringWhereValueExpression,
"level": NumberWhereValueExpression,
"correlation": NumberWhereValueExpression,
"offset": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"unpricedElement": UnpricedElementFormQueryWhere
}
UnpricedElementStructureRelationships
Fields
| Field Name | Description |
|---|---|
unpricedElement - RelationshipDefinition
|
Example
{"unpricedElement": RelationshipDefinition}
UpcomingPortsListInput
Description
Submits a veslink UpcomingPortsList transaction
Fields
| Input Field | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
|
seq - Int
|
|
upcomingPorts - [UpcomingPortsList_UpcomingPortsInput]!
|
|
reportTime - Date
|
|
reportType - String
|
|
allowChangingItinerary - Boolean
|
Determines whether user is allowed to change the itinerary, defaults to false |
allowChangingItinLength - Boolean
|
Determines whether user is allowed to change itinerary length, defaults to false |
suppressPortMismatchError - Boolean
|
Determines whether port mismatches will throw errors if user is not allowed to change itinerary, defaults to false |
Example
{
"vesselCode": "xyz789",
"voyageNo": 987,
"seq": 987,
"upcomingPorts": [UpcomingPortsList_UpcomingPortsInput],
"reportTime": "2007-12-03",
"reportType": "abc123",
"allowChangingItinerary": false,
"allowChangingItinLength": false,
"suppressPortMismatchError": false
}
UpcomingPortsListMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "abc123",
"debug": true,
"context": ["xyz789"],
"timestamp": "abc123",
"originalTimestamp": "abc123",
"intent": "xyz789",
"from": "abc123",
"to": ["abc123"],
"fromUser": "xyz789",
"status": "abc123",
"approvalStatus": "xyz789",
"objectId": "abc123",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "abc123",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "xyz789",
"unmapped": true,
"responseData": Json,
"applyErrors": ["abc123"],
"applyWarnings": ["xyz789"],
"parentMessageId": "abc123",
"preResolutionObjectId": "xyz789",
"title": "abc123",
"effectiveDate": "xyz789",
"source": "xyz789",
"sourceId": "abc123",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": false,
"threadCount": 987,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "xyz789"
}
UpcomingPortsList_UpcomingPortsInput
Fields
| Input Field | Description |
|---|---|
port - UpcomingPortsList_UpcomingPortsInput_PortInput
|
|
etaGmt - Date
|
|
distanceToGo - Float
|
distance to the port from current position |
projectedSpeed - Float
|
projected speed vessel will travel at |
Example
{
"port": UpcomingPortsList_UpcomingPortsInput_PortInput,
"etaGmt": "2007-12-03",
"distanceToGo": 123.45,
"projectedSpeed": 123.45
}
UpcomingPortsList_UpcomingPortsInput_PortInput
UpdateActivityLogInput
Fields
| Input Field | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
|
seq - Int
|
|
cargoShortName - String
|
|
activityName - String
|
|
activityType - String
|
|
equipmentCode - String
|
|
remarks - String
|
|
berthShortName - String
|
|
cargoHandlingSeqNo - Int
|
|
portNo - Float
|
|
portName - String
|
|
cargoID - Float
|
|
activityTime - Date
|
Example
{
"vesselCode": "abc123",
"voyageNo": 987,
"seq": 987,
"cargoShortName": "abc123",
"activityName": "xyz789",
"activityType": "xyz789",
"equipmentCode": "abc123",
"remarks": "xyz789",
"berthShortName": "abc123",
"cargoHandlingSeqNo": 123,
"portNo": 123.45,
"portName": "abc123",
"cargoID": 123.45,
"activityTime": "2007-12-03"
}
UpdateActivityLogMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": false,
"context": ["xyz789"],
"timestamp": "xyz789",
"originalTimestamp": "xyz789",
"intent": "abc123",
"from": "xyz789",
"to": ["xyz789"],
"fromUser": "abc123",
"status": "abc123",
"approvalStatus": "xyz789",
"objectId": "abc123",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "abc123",
"previousData": Json,
"comment": "xyz789",
"unmapped": false,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["abc123"],
"parentMessageId": "xyz789",
"preResolutionObjectId": "xyz789",
"title": "abc123",
"effectiveDate": "abc123",
"source": "xyz789",
"sourceId": "xyz789",
"threadId": "xyz789",
"links": [MessageLinkOutput],
"retrieveWarnings": ["abc123"],
"isLatest": true,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "xyz789"
}
UpdateBareboatInput
Fields
| Input Field | Description |
|---|---|
cpCode - String
|
|
hireLines - [UpdateBareboat_HireLinesInput]!
|
Example
{
"cpCode": "abc123",
"hireLines": [UpdateBareboat_HireLinesInput]
}
UpdateBareboatMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": true,
"context": ["xyz789"],
"timestamp": "xyz789",
"originalTimestamp": "xyz789",
"intent": "abc123",
"from": "xyz789",
"to": ["abc123"],
"fromUser": "xyz789",
"status": "abc123",
"approvalStatus": "xyz789",
"objectId": "xyz789",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "abc123",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "xyz789",
"unmapped": true,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["xyz789"],
"parentMessageId": "xyz789",
"preResolutionObjectId": "abc123",
"title": "abc123",
"effectiveDate": "xyz789",
"source": "xyz789",
"sourceId": "abc123",
"threadId": "xyz789",
"links": [MessageLinkOutput],
"retrieveWarnings": ["abc123"],
"isLatest": false,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
UpdateBareboat_HireLinesInput
UpdateCOAInput
Fields
| Input Field | Description |
|---|---|
coaNo - String
|
|
contractType - String
|
|
counterpartyShortName - String
|
|
cpQty - Float
|
|
cargoUnit - String
|
|
periodFromLocal - Date
|
|
periodToLocal - Date
|
|
statusCode - String
|
|
minLiftings - Int
|
|
optionalLiftings - Int
|
|
curr - String
|
|
companyCode - String
|
|
initialEstimateID - String
|
|
coaVessels - [UpdateCOA_CoaVesselsInput]
|
|
coaCargos - [UpdateCOA_CoaCargosInput]
|
|
coaOptions - [UpdateCOA_CoaOptionsInput]
|
|
liftings - Int
|
|
coaItineraries - [UpdateCOA_CoaItinerariesInput]
|
|
referenceNo - String
|
|
isParent - Boolean
|
|
chtrCoordinator - String
|
|
refVoyageRoute - String
|
|
lobCode - String
|
|
exposureMethod - String
|
|
benchmarkEstimates - [UpdateCOA_BenchmarkEstimatesInput]
|
|
parentCoaId - Int
|
|
userProperties - [UpdateCOA_UserPropertiesInput]
|
Example
{
"coaNo": "abc123",
"contractType": "abc123",
"counterpartyShortName": "xyz789",
"cpQty": 123.45,
"cargoUnit": "xyz789",
"periodFromLocal": "2007-12-03",
"periodToLocal": "2007-12-03",
"statusCode": "abc123",
"minLiftings": 123,
"optionalLiftings": 987,
"curr": "xyz789",
"companyCode": "xyz789",
"initialEstimateID": "xyz789",
"coaVessels": [UpdateCOA_CoaVesselsInput],
"coaCargos": [UpdateCOA_CoaCargosInput],
"coaOptions": [UpdateCOA_CoaOptionsInput],
"liftings": 123,
"coaItineraries": [UpdateCOA_CoaItinerariesInput],
"referenceNo": "abc123",
"isParent": false,
"chtrCoordinator": "xyz789",
"refVoyageRoute": "abc123",
"lobCode": "xyz789",
"exposureMethod": "abc123",
"benchmarkEstimates": [
UpdateCOA_BenchmarkEstimatesInput
],
"parentCoaId": 987,
"userProperties": [UpdateCOA_UserPropertiesInput]
}
UpdateCOAMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "abc123",
"debug": true,
"context": ["abc123"],
"timestamp": "abc123",
"originalTimestamp": "xyz789",
"intent": "abc123",
"from": "abc123",
"to": ["xyz789"],
"fromUser": "xyz789",
"status": "xyz789",
"approvalStatus": "xyz789",
"objectId": "xyz789",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "abc123",
"unmapped": false,
"responseData": Json,
"applyErrors": ["abc123"],
"applyWarnings": ["abc123"],
"parentMessageId": "xyz789",
"preResolutionObjectId": "xyz789",
"title": "abc123",
"effectiveDate": "xyz789",
"source": "abc123",
"sourceId": "xyz789",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": true,
"threadCount": 987,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "xyz789"
}
UpdateCOA_BenchmarkEstimatesInput
UpdateCOA_CoaCargosInput
Fields
| Input Field | Description |
|---|---|
reference - String
|
Example
{"reference": "abc123"}
UpdateCOA_CoaItinerariesInput
Example
{
"port": UpdateCOA_CoaItinerariesInput_PortInput,
"portFunc": "xyz789",
"loadDiscRate": 123.45,
"rateUnit": "xyz789",
"terms": "xyz789",
"norHours": 987.65,
"portExpAmountBase": 123,
"draft": 123.45
}
UpdateCOA_CoaItinerariesInput_PortInput
UpdateCOA_CoaOptionsInput
Example
{
"portNo": 987,
"portFunc": "abc123",
"loadDiscRate": 987.65,
"rateUnit": "xyz789",
"terms": "xyz789",
"norHours": 123.45,
"portExpAmountBase": 123,
"draft": 123.45,
"port": UpdateCOA_CoaOptionsInput_PortInput
}
UpdateCOA_CoaOptionsInput_PortInput
UpdateCOA_CoaVesselsInput
Fields
| Input Field | Description |
|---|---|
reference - String
|
Example
{"reference": "xyz789"}
UpdateCOA_UserPropertiesInput
UpdateCargoInput
Description
This message publishes cargo handling ETA/ETD updates to the specified party
Fields
| Input Field | Description |
|---|---|
cargoID - Int
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
cpQty - Float
|
|
freightRate - Float
|
|
firstCargoLoadItin - UpdateCargo_FirstCargoLoadItinInput!
|
|
lastCargoDiscItin - UpdateCargo_LastCargoDiscItinInput!
|
|
externalRef - String
|
|
refContract - String
|
|
cargoShortName - String
|
|
qtyUnit - String
|
|
optionPercentage - Float
|
|
optionType - String
|
|
companyCode - String
|
|
voyageCargoHandlings - [UpdateCargo_VoyageCargoHandlingsInput]
|
Example
{
"cargoID": 123,
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"cpQty": 987.65,
"freightRate": 123.45,
"firstCargoLoadItin": UpdateCargo_FirstCargoLoadItinInput,
"lastCargoDiscItin": UpdateCargo_LastCargoDiscItinInput,
"externalRef": "xyz789",
"refContract": "abc123",
"cargoShortName": "xyz789",
"qtyUnit": "abc123",
"optionPercentage": 987.65,
"optionType": "xyz789",
"companyCode": "xyz789",
"voyageCargoHandlings": [
UpdateCargo_VoyageCargoHandlingsInput
]
}
UpdateCargoMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": false,
"context": ["xyz789"],
"timestamp": "xyz789",
"originalTimestamp": "xyz789",
"intent": "xyz789",
"from": "abc123",
"to": ["abc123"],
"fromUser": "abc123",
"status": "xyz789",
"approvalStatus": "xyz789",
"objectId": "abc123",
"type": "xyz789",
"data": Json,
"applyTriggeredOn": "abc123",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "abc123",
"unmapped": true,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["xyz789"],
"parentMessageId": "xyz789",
"preResolutionObjectId": "abc123",
"title": "xyz789",
"effectiveDate": "xyz789",
"source": "abc123",
"sourceId": "abc123",
"threadId": "xyz789",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": false,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
UpdateCargo_FirstCargoLoadItinInput
Fields
| Input Field | Description |
|---|---|
port - UpdateCargo_FirstCargoLoadItinInput_PortInput!
|
|
portName - String
|
Example
{
"port": UpdateCargo_FirstCargoLoadItinInput_PortInput,
"portName": "xyz789"
}
UpdateCargo_FirstCargoLoadItinInput_PortInput
UpdateCargo_LastCargoDiscItinInput
Fields
| Input Field | Description |
|---|---|
port - UpdateCargo_LastCargoDiscItinInput_PortInput!
|
|
portName - String
|
Example
{
"port": UpdateCargo_LastCargoDiscItinInput_PortInput,
"portName": "xyz789"
}
UpdateCargo_LastCargoDiscItinInput_PortInput
UpdateCargo_VoyageCargoHandlingsInput
Fields
| Input Field | Description |
|---|---|
seqNo - Int
|
|
voyageSeqNo - Int
|
|
berthSeqNo - Int
|
|
voyageNo - Int
|
|
vesselCode - String
|
|
portFunction - UpdateCargo_VoyageCargoHandlingsInput_PortFunctionInput
|
|
blCode - String
|
|
voyageItinerary - UpdateCargo_VoyageCargoHandlingsInput_VoyageItineraryInput
|
Example
{
"seqNo": 123,
"voyageSeqNo": 987,
"berthSeqNo": 987,
"voyageNo": 123,
"vesselCode": "xyz789",
"portFunction": UpdateCargo_VoyageCargoHandlingsInput_PortFunctionInput,
"blCode": "xyz789",
"voyageItinerary": UpdateCargo_VoyageCargoHandlingsInput_VoyageItineraryInput
}
UpdateCargo_VoyageCargoHandlingsInput_PortFunctionInput
Fields
| Input Field | Description |
|---|---|
code - String
|
Example
{"code": "xyz789"}
UpdateCargo_VoyageCargoHandlingsInput_VoyageItineraryInput
Fields
| Input Field | Description |
|---|---|
port - UpdateCargo_VoyageCargoHandlingsInput_VoyageItineraryInput_PortInput
|
|
portNo - Int
|
|
arrivalLocal - Date
|
|
etaGmt - Date
|
|
departureLocal - Date
|
|
etdGmt - Date
|
|
voyagePortActivities - [UpdateCargo_VoyageCargoHandlingsInput_VoyageItineraryInput_VoyagePortActivitiesInput]
|
Example
{
"port": UpdateCargo_VoyageCargoHandlingsInput_VoyageItineraryInput_PortInput,
"portNo": 123,
"arrivalLocal": "2007-12-03",
"etaGmt": "2007-12-03",
"departureLocal": "2007-12-03",
"etdGmt": "2007-12-03",
"voyagePortActivities": [
UpdateCargo_VoyageCargoHandlingsInput_VoyageItineraryInput_VoyagePortActivitiesInput
]
}
UpdateCargo_VoyageCargoHandlingsInput_VoyageItineraryInput_PortInput
Fields
| Input Field | Description |
|---|---|
name - String
|
Example
{"name": "abc123"}
UpdateCargo_VoyageCargoHandlingsInput_VoyageItineraryInput_VoyagePortActivitiesInput
Example
{
"activityName": "abc123",
"activityType": "xyz789",
"activityTimeGmt": "2007-12-03",
"activityTimeLocal": "2007-12-03",
"reasonType": "xyz789",
"remarks": "xyz789",
"berthShortName": "abc123"
}
UpdateChartOfAccountsInput
Example
{
"code": "xyz789",
"accountName": "xyz789",
"appliesToLobs": true,
"appliesToVessels": true,
"appliesToVoyages": false,
"appliesToPorts": true,
"appliesToDepts": false,
"appliesToIntercompany": false,
"category": "abc123"
}
UpdateChartOfAccountsMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": true,
"context": ["xyz789"],
"timestamp": "abc123",
"originalTimestamp": "abc123",
"intent": "abc123",
"from": "xyz789",
"to": ["xyz789"],
"fromUser": "abc123",
"status": "xyz789",
"approvalStatus": "xyz789",
"objectId": "abc123",
"type": "xyz789",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "abc123",
"previousData": Json,
"comment": "xyz789",
"unmapped": false,
"responseData": Json,
"applyErrors": ["abc123"],
"applyWarnings": ["abc123"],
"parentMessageId": "abc123",
"preResolutionObjectId": "xyz789",
"title": "xyz789",
"effectiveDate": "xyz789",
"source": "xyz789",
"sourceId": "abc123",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": false,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "xyz789"
}
UpdateConfigFlag
Fields
| Input Field | Description |
|---|---|
configFlag - ImosConfigFlags!
|
|
value - String!
|
Example
{
"configFlag": "AECompanyName",
"value": "abc123"
}
UpdateEquipmentContractInput
Fields
| Input Field | Description |
|---|---|
contractType - String
|
ContractType |
counterpartyShortName - String
|
CounterpartyShortName |
contractID - String
|
ContractID |
currency - String
|
Currency |
description - String
|
Description |
fixtureDate - Date
|
FixtureDate |
fixedBy - String
|
FixedBy |
estDeliveryDateGmt - Date
|
EstDeliveryDateGmt |
estRedeliveryDateGmt - Date
|
EstRedeliveryDateGmt |
companyCode - String
|
CompanyCode |
status - String
|
Status |
billingPeriod - String
|
BillingPeriod |
tradeAreaName - String
|
TradeAreaName |
deliveryPort - UpdateEquipmentContract_DeliveryPortInput
|
|
redeliveryPort - UpdateEquipmentContract_RedeliveryPortInput
|
|
hires - [UpdateEquipmentContract_HiresInput]
|
Example
{
"contractType": "xyz789",
"counterpartyShortName": "abc123",
"contractID": "abc123",
"currency": "abc123",
"description": "abc123",
"fixtureDate": "2007-12-03",
"fixedBy": "abc123",
"estDeliveryDateGmt": "2007-12-03",
"estRedeliveryDateGmt": "2007-12-03",
"companyCode": "abc123",
"status": "xyz789",
"billingPeriod": "abc123",
"tradeAreaName": "xyz789",
"deliveryPort": UpdateEquipmentContract_DeliveryPortInput,
"redeliveryPort": UpdateEquipmentContract_RedeliveryPortInput,
"hires": [UpdateEquipmentContract_HiresInput]
}
UpdateEquipmentContractMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": false,
"context": ["abc123"],
"timestamp": "abc123",
"originalTimestamp": "xyz789",
"intent": "abc123",
"from": "xyz789",
"to": ["xyz789"],
"fromUser": "abc123",
"status": "xyz789",
"approvalStatus": "xyz789",
"objectId": "xyz789",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "abc123",
"previousData": Json,
"comment": "abc123",
"unmapped": false,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["abc123"],
"parentMessageId": "abc123",
"preResolutionObjectId": "xyz789",
"title": "xyz789",
"effectiveDate": "abc123",
"source": "abc123",
"sourceId": "xyz789",
"threadId": "xyz789",
"links": [MessageLinkOutput],
"retrieveWarnings": ["abc123"],
"isLatest": true,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "xyz789"
}
UpdateEquipmentContract_DeliveryPortInput
UpdateEquipmentContract_HiresInput
Example
{
"equipmentType": "xyz789",
"equipmentQuantity": 123.45,
"hireFromGmt": "2007-12-03",
"hireToGmt": "2007-12-03",
"hireRate": 123.45,
"remarks": "xyz789"
}
UpdateEquipmentContract_RedeliveryPortInput
UpdateEquipmentInput
Description
A data point representing the current known information about a piece of equipment
Example
{
"vesselCode": "xyz789",
"name": "xyz789",
"refNo": "abc123",
"vesselType": "abc123",
"unitTypeCode": "abc123",
"isActive": false,
"dWT": 987.65,
"barge": UpdateEquipment_BargeInput,
"vesselOwner": "xyz789"
}
UpdateEquipmentMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "abc123",
"debug": true,
"context": ["abc123"],
"timestamp": "abc123",
"originalTimestamp": "xyz789",
"intent": "xyz789",
"from": "xyz789",
"to": ["xyz789"],
"fromUser": "abc123",
"status": "abc123",
"approvalStatus": "xyz789",
"objectId": "xyz789",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "abc123",
"unmapped": false,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["xyz789"],
"parentMessageId": "abc123",
"preResolutionObjectId": "abc123",
"title": "abc123",
"effectiveDate": "abc123",
"source": "xyz789",
"sourceId": "abc123",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": true,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "xyz789"
}
UpdateEquipment_BargeInput
Example
{
"name": "xyz789",
"code": "xyz789",
"height": 123.45,
"width": 123.45,
"length": 987.65,
"hullType": "abc123",
"hullArrangement": "xyz789",
"opaDate": "2007-12-03",
"ownership": "xyz789",
"yearBuilt": 987,
"registeredTons": 123.45,
"serviceArea": "abc123",
"vesselTypeCode": "abc123",
"calibratedBbls": 123.45
}
UpdateEstimateInput
Fields
| Input Field | Description |
|---|---|
estimateID - String
|
|
vesselCode - String
|
|
voyageCommenceDateLocal - Date
|
|
estimateCargoes - [UpdateEstimate_EstimateCargoesInput]
|
|
estimateItineraries - [UpdateEstimate_EstimateItinerariesInput]
|
|
categoryID - Int
|
|
contractType - String
|
|
commencePort - UpdateEstimate_CommencePortInput
|
|
weatherFactorPercentage - Float
|
|
dailyCost - Float
|
|
addressCommission - Float
|
|
speedBallast - Float
|
|
speedLaden - Float
|
|
terminatingPort - String
|
|
lockProfit - Boolean
|
|
profit - Float
|
|
tcE - Float
|
|
voyageEstimateBunkers - [UpdateEstimate_VoyageEstimateBunkersInput]
|
|
commit - Boolean
|
|
initFromBenchmark - Boolean
|
|
atSeaBunkerPrice - Float
|
|
inPortBunkerPrice - Float
|
|
lockTce - Boolean
|
|
vesselImo - String
|
|
prevDistance - Float
|
|
prevCo2Emissions - Float
|
Example
{
"estimateID": "abc123",
"vesselCode": "xyz789",
"voyageCommenceDateLocal": "2007-12-03",
"estimateCargoes": [
UpdateEstimate_EstimateCargoesInput
],
"estimateItineraries": [
UpdateEstimate_EstimateItinerariesInput
],
"categoryID": 123,
"contractType": "xyz789",
"commencePort": UpdateEstimate_CommencePortInput,
"weatherFactorPercentage": 987.65,
"dailyCost": 123.45,
"addressCommission": 123.45,
"speedBallast": 987.65,
"speedLaden": 987.65,
"terminatingPort": "xyz789",
"lockProfit": false,
"profit": 987.65,
"tcE": 987.65,
"voyageEstimateBunkers": [
UpdateEstimate_VoyageEstimateBunkersInput
],
"commit": true,
"initFromBenchmark": true,
"atSeaBunkerPrice": 987.65,
"inPortBunkerPrice": 123.45,
"lockTce": true,
"vesselImo": "xyz789",
"prevDistance": 123.45,
"prevCo2Emissions": 123.45
}
UpdateEstimateMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": false,
"context": ["abc123"],
"timestamp": "abc123",
"originalTimestamp": "abc123",
"intent": "xyz789",
"from": "xyz789",
"to": ["abc123"],
"fromUser": "xyz789",
"status": "xyz789",
"approvalStatus": "xyz789",
"objectId": "xyz789",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "abc123",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "xyz789",
"unmapped": true,
"responseData": Json,
"applyErrors": ["abc123"],
"applyWarnings": ["abc123"],
"parentMessageId": "abc123",
"preResolutionObjectId": "abc123",
"title": "abc123",
"effectiveDate": "abc123",
"source": "xyz789",
"sourceId": "xyz789",
"threadId": "xyz789",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": false,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "xyz789"
}
UpdateEstimate_CommencePortInput
UpdateEstimate_EstimateCargoesInput
Fields
| Input Field | Description |
|---|---|
cargoSeq - Int
|
|
cargoID - Int
|
|
cargoShortName - String
|
|
chartererShortName - String
|
|
cpQty - Int
|
|
cargoUnit - String
|
|
freightRateBase - Float
|
|
curr - String
|
|
freightType - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
optionPercentage - Float
|
|
primaryCargoSeq - Int
|
|
option - String
|
Example
{
"cargoSeq": 987,
"cargoID": 123,
"cargoShortName": "abc123",
"chartererShortName": "abc123",
"cpQty": 123,
"cargoUnit": "xyz789",
"freightRateBase": 123.45,
"curr": "xyz789",
"freightType": "xyz789",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"optionPercentage": 123.45,
"primaryCargoSeq": 123,
"option": "xyz789"
}
UpdateEstimate_EstimateItinerariesInput
Fields
| Input Field | Description |
|---|---|
seq - Int
|
|
portNo - Int
|
|
cargoSeq - Int
|
|
portFunction - String
|
|
loadDischargeQuantity - Int
|
|
loadDischargeRate - Float
|
|
rateUnit - String
|
|
portExpensesBase - Int
|
|
weatherFactorPercentage - Float
|
|
terms - String
|
|
idleDays - Float
|
|
extraPortDays - Float
|
|
extraSeaDays - Float
|
|
speed - Float
|
|
portDays - Float
|
|
demurrageDays - Float
|
|
termsFactor - Float
|
Example
{
"seq": 123,
"portNo": 987,
"cargoSeq": 123,
"portFunction": "abc123",
"loadDischargeQuantity": 987,
"loadDischargeRate": 123.45,
"rateUnit": "xyz789",
"portExpensesBase": 123,
"weatherFactorPercentage": 123.45,
"terms": "xyz789",
"idleDays": 987.65,
"extraPortDays": 123.45,
"extraSeaDays": 123.45,
"speed": 987.65,
"portDays": 123.45,
"demurrageDays": 987.65,
"termsFactor": 123.45
}
UpdateEstimate_VoyageEstimateBunkersInput
Example
{
"fuelType": "xyz789",
"initialPrice": 123.45,
"consumptionBallast": 987.65,
"consumptionLaden": 123.45,
"consumptionLoad": 123.45,
"consumptionDischarge": 987.65,
"consumptionIdle": 987.65,
"consumptionHeat": 987.65,
"consumptionHotel": 987.65
}
UpdateFreightMatrixQuoteInput
Example
{
"estimateID": "xyz789",
"voyageEstimate": UpdateFreightMatrixQuote_VoyageEstimateInput,
"basisDate": "abc123",
"notes": "abc123",
"expiryDate": "xyz789",
"freightRate": 987.65
}
UpdateFreightMatrixQuoteMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": true,
"context": ["xyz789"],
"timestamp": "xyz789",
"originalTimestamp": "abc123",
"intent": "xyz789",
"from": "xyz789",
"to": ["abc123"],
"fromUser": "abc123",
"status": "abc123",
"approvalStatus": "abc123",
"objectId": "abc123",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "abc123",
"unmapped": true,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["abc123"],
"parentMessageId": "abc123",
"preResolutionObjectId": "abc123",
"title": "xyz789",
"effectiveDate": "xyz789",
"source": "abc123",
"sourceId": "xyz789",
"threadId": "xyz789",
"links": [MessageLinkOutput],
"retrieveWarnings": ["abc123"],
"isLatest": true,
"threadCount": 987,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "xyz789"
}
UpdateFreightMatrixQuote_VoyageEstimateInput
Fields
| Input Field | Description |
|---|---|
estimateCargoes - [UpdateFreightMatrixQuote_VoyageEstimateInput_EstimateCargoesInput]
|
Example
{
"estimateCargoes": [
UpdateFreightMatrixQuote_VoyageEstimateInput_EstimateCargoesInput
]
}
UpdateFreightMatrixQuote_VoyageEstimateInput_EstimateCargoesInput
Fields
| Input Field | Description |
|---|---|
cargoShortName - String
|
|
cpQty - Int
|
|
loadCargoItineraries - [UpdateFreightMatrixQuote_VoyageEstimateInput_EstimateCargoesInput_LoadCargoItinerariesInput]
|
|
discCargoItineraries - [UpdateFreightMatrixQuote_VoyageEstimateInput_EstimateCargoesInput_DiscCargoItinerariesInput]
|
Example
{
"cargoShortName": "xyz789",
"cpQty": 987,
"loadCargoItineraries": [
UpdateFreightMatrixQuote_VoyageEstimateInput_EstimateCargoesInput_LoadCargoItinerariesInput
],
"discCargoItineraries": [
UpdateFreightMatrixQuote_VoyageEstimateInput_EstimateCargoesInput_DiscCargoItinerariesInput
]
}
UpdateFreightMatrixQuote_VoyageEstimateInput_EstimateCargoesInput_DiscCargoItinerariesInput
Fields
| Input Field | Description |
|---|---|
port - UpdateFreightMatrixQuote_VoyageEstimateInput_EstimateCargoesInput_DiscCargoItinerariesInput_PortInput
|
Example
{
"port": UpdateFreightMatrixQuote_VoyageEstimateInput_EstimateCargoesInput_DiscCargoItinerariesInput_PortInput
}
UpdateFreightMatrixQuote_VoyageEstimateInput_EstimateCargoesInput_DiscCargoItinerariesInput_PortInput
Fields
| Input Field | Description |
|---|---|
name - String
|
Example
{"name": "xyz789"}
UpdateFreightMatrixQuote_VoyageEstimateInput_EstimateCargoesInput_LoadCargoItinerariesInput
Fields
| Input Field | Description |
|---|---|
port - UpdateFreightMatrixQuote_VoyageEstimateInput_EstimateCargoesInput_LoadCargoItinerariesInput_PortInput
|
Example
{
"port": UpdateFreightMatrixQuote_VoyageEstimateInput_EstimateCargoesInput_LoadCargoItinerariesInput_PortInput
}
UpdateFreightMatrixQuote_VoyageEstimateInput_EstimateCargoesInput_LoadCargoItinerariesInput_PortInput
Fields
| Input Field | Description |
|---|---|
name - String
|
Example
{"name": "abc123"}
UpdateTimeCharterCOAInput
Fields
| Input Field | Description |
|---|---|
contractType - String
|
|
counterpartyShortName - String
|
|
counterpartyType - String
|
|
fixtureDate - Date
|
|
startGmt - Date
|
|
endGmt - Date
|
|
companyCode - String
|
|
actDepartmentCode - String
|
|
tradeAreaNo - Int
|
|
fixedBy - String
|
|
shipments - Int
|
|
shipmentDuration - Float
|
|
shipmentDurationUnit - String
|
|
optionalShipments - Int
|
|
optionDateLocal - Date
|
|
paymentTermsCode - String
|
|
billingPeriod - String
|
|
billingSchedule - String
|
|
refContract - String
|
|
externalRef - String
|
|
statusCode - String
|
|
route - String
|
|
strategy - String
|
|
vesselTurnover - Float
|
|
vesselTypeAdjustment - Float
|
|
vesselTypeCorrelation - Float
|
|
timeCharterCOADeliveryRedeliveryOptions - [UpdateTimeCharterCOA_TimeCharterCOADeliveryRedeliveryOptionsInput]
|
|
timeCharterCOAVesselTypes - [UpdateTimeCharterCOA_TimeCharterCOAVesselTypesInput]
|
|
timeCharterCOAVessels - [UpdateTimeCharterCOA_TimeCharterCOAVesselsInput]
|
Example
{
"contractType": "xyz789",
"counterpartyShortName": "xyz789",
"counterpartyType": "abc123",
"fixtureDate": "2007-12-03",
"startGmt": "2007-12-03",
"endGmt": "2007-12-03",
"companyCode": "xyz789",
"actDepartmentCode": "xyz789",
"tradeAreaNo": 987,
"fixedBy": "abc123",
"shipments": 123,
"shipmentDuration": 987.65,
"shipmentDurationUnit": "abc123",
"optionalShipments": 123,
"optionDateLocal": "2007-12-03",
"paymentTermsCode": "abc123",
"billingPeriod": "abc123",
"billingSchedule": "abc123",
"refContract": "abc123",
"externalRef": "xyz789",
"statusCode": "xyz789",
"route": "xyz789",
"strategy": "xyz789",
"vesselTurnover": 123.45,
"vesselTypeAdjustment": 123.45,
"vesselTypeCorrelation": 123.45,
"timeCharterCOADeliveryRedeliveryOptions": [
UpdateTimeCharterCOA_TimeCharterCOADeliveryRedeliveryOptionsInput
],
"timeCharterCOAVesselTypes": [
UpdateTimeCharterCOA_TimeCharterCOAVesselTypesInput
],
"timeCharterCOAVessels": [
UpdateTimeCharterCOA_TimeCharterCOAVesselsInput
]
}
UpdateTimeCharterCOAMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "xyz789",
"debug": false,
"context": ["abc123"],
"timestamp": "abc123",
"originalTimestamp": "xyz789",
"intent": "abc123",
"from": "xyz789",
"to": ["abc123"],
"fromUser": "xyz789",
"status": "xyz789",
"approvalStatus": "abc123",
"objectId": "abc123",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "xyz789",
"unmapped": false,
"responseData": Json,
"applyErrors": ["abc123"],
"applyWarnings": ["xyz789"],
"parentMessageId": "abc123",
"preResolutionObjectId": "xyz789",
"title": "abc123",
"effectiveDate": "xyz789",
"source": "abc123",
"sourceId": "xyz789",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["abc123"],
"isLatest": true,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "xyz789"
}
UpdateTimeCharterCOA_TimeCharterCOADeliveryRedeliveryOptionsInput
Fields
| Input Field | Description |
|---|---|
type - String
|
|
port - UpdateTimeCharterCOA_TimeCharterCOADeliveryRedeliveryOptionsInput_PortInput
|
Example
{
"type": "abc123",
"port": UpdateTimeCharterCOA_TimeCharterCOADeliveryRedeliveryOptionsInput_PortInput
}
UpdateTimeCharterCOA_TimeCharterCOADeliveryRedeliveryOptionsInput_PortInput
UpdateTimeCharterCOA_TimeCharterCOAVesselTypesInput
Fields
| Input Field | Description |
|---|---|
vesselType - String
|
Example
{"vesselType": "abc123"}
UpdateTimeCharterCOA_TimeCharterCOAVesselsInput
Fields
| Input Field | Description |
|---|---|
vessel - UpdateTimeCharterCOA_TimeCharterCOAVesselsInput_VesselInput
|
Example
{
"vessel": UpdateTimeCharterCOA_TimeCharterCOAVesselsInput_VesselInput
}
UpdateTimeCharterCOA_TimeCharterCOAVesselsInput_VesselInput
UpdateTimeCharterInput
Fields
| Input Field | Description |
|---|---|
tcCode - String
|
|
tcType - String
|
|
companyCode - String
|
|
status - String
|
|
vesselCode - String
|
|
counterpartyShortName - String
|
|
fixtureDate - Date
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
deliveryPortNo - Int
|
|
estDeliveryDateGmt - Date
|
|
redeliveryPortNo - Int
|
|
estRedeliveryDateGmt - Date
|
|
minRedeliveryDateGmt - Date
|
|
maxRedeliveryDateGmt - Date
|
|
projActDeliveryDateGmt - Date
|
|
projActRedeliveryDateGmt - Date
|
|
contractType - String
|
|
route - String
|
|
vesselTypeCorrelation - Float
|
|
opsCoordinator - String
|
|
charteringCoordinatorName - String
|
|
lobCode - String
|
|
benchmarkEstimateID - String
|
|
fixedBy - String
|
|
billingPeriod - String
|
|
curr - String
|
|
timeCharterHires - [UpdateTimeCharter_TimeCharterHiresInput]
|
|
timeCharterBunkerDeliveries - [UpdateTimeCharter_TimeCharterBunkerDeliveriesInput]
|
|
externalRef - String
|
|
vessel - UpdateTimeCharter_VesselInput
|
|
deliveryPort - UpdateTimeCharter_DeliveryPortInput
|
|
redeliveryPort - UpdateTimeCharter_RedeliveryPortInput
|
|
userProperties - [UpdateTimeCharter_UserPropertiesInput]
|
|
options - UpdateTimeCharter_OptionsInput
|
Example
{
"tcCode": "xyz789",
"tcType": "abc123",
"companyCode": "xyz789",
"status": "abc123",
"vesselCode": "abc123",
"counterpartyShortName": "abc123",
"fixtureDate": "2007-12-03",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"deliveryPortNo": 987,
"estDeliveryDateGmt": "2007-12-03",
"redeliveryPortNo": 123,
"estRedeliveryDateGmt": "2007-12-03",
"minRedeliveryDateGmt": "2007-12-03",
"maxRedeliveryDateGmt": "2007-12-03",
"projActDeliveryDateGmt": "2007-12-03",
"projActRedeliveryDateGmt": "2007-12-03",
"contractType": "xyz789",
"route": "xyz789",
"vesselTypeCorrelation": 987.65,
"opsCoordinator": "xyz789",
"charteringCoordinatorName": "xyz789",
"lobCode": "xyz789",
"benchmarkEstimateID": "xyz789",
"fixedBy": "xyz789",
"billingPeriod": "abc123",
"curr": "xyz789",
"timeCharterHires": [
UpdateTimeCharter_TimeCharterHiresInput
],
"timeCharterBunkerDeliveries": [
UpdateTimeCharter_TimeCharterBunkerDeliveriesInput
],
"externalRef": "xyz789",
"vessel": UpdateTimeCharter_VesselInput,
"deliveryPort": UpdateTimeCharter_DeliveryPortInput,
"redeliveryPort": UpdateTimeCharter_RedeliveryPortInput,
"userProperties": [
UpdateTimeCharter_UserPropertiesInput
],
"options": UpdateTimeCharter_OptionsInput
}
UpdateTimeCharterMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "abc123",
"debug": true,
"context": ["xyz789"],
"timestamp": "abc123",
"originalTimestamp": "xyz789",
"intent": "abc123",
"from": "abc123",
"to": ["xyz789"],
"fromUser": "abc123",
"status": "xyz789",
"approvalStatus": "xyz789",
"objectId": "xyz789",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "abc123",
"previousData": Json,
"comment": "xyz789",
"unmapped": true,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["abc123"],
"parentMessageId": "abc123",
"preResolutionObjectId": "abc123",
"title": "xyz789",
"effectiveDate": "xyz789",
"source": "abc123",
"sourceId": "abc123",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["xyz789"],
"isLatest": true,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "xyz789"
}
UpdateTimeCharter_DeliveryPortInput
UpdateTimeCharter_OptionsInput
Fields
| Input Field | Description |
|---|---|
timeCharterHiresAction - String
|
Example
{"timeCharterHiresAction": "abc123"}
UpdateTimeCharter_RedeliveryPortInput
UpdateTimeCharter_TimeCharterBunkerDeliveriesInput
UpdateTimeCharter_TimeCharterHiresInput
UpdateTimeCharter_UserPropertiesInput
UpdateTimeCharter_VesselInput
UpdateViewRequest
UpdateVoyageInput
Fields
| Input Field | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
If a voyage number is provided and already exists, this indicates that the voyage should be rescheduled with the given new information |
externalRef - String
|
|
voyageReference - String
|
|
oprType - String
|
|
companyCode - String
|
|
lastTci - Boolean
|
|
lastTco - Boolean
|
|
lobCode - String
|
|
tcCode - String
|
|
tcoCode - String
|
|
remarks - String
|
|
voyageItineraries - [UpdateVoyage_VoyageItinerariesInput]
|
|
cargos - [UpdateVoyage_CargosInput]
|
|
voyageBunkerInventories - [UpdateVoyage_VoyageBunkerInventoriesInput]
|
|
consecutive - Boolean
|
|
autoAssignConsecutive - Boolean
|
|
lockItineraryDates - Boolean
|
Example
{
"vesselCode": "abc123",
"voyageNo": 123,
"externalRef": "xyz789",
"voyageReference": "xyz789",
"oprType": "abc123",
"companyCode": "abc123",
"lastTci": false,
"lastTco": false,
"lobCode": "abc123",
"tcCode": "xyz789",
"tcoCode": "xyz789",
"remarks": "abc123",
"voyageItineraries": [
UpdateVoyage_VoyageItinerariesInput
],
"cargos": [UpdateVoyage_CargosInput],
"voyageBunkerInventories": [
UpdateVoyage_VoyageBunkerInventoriesInput
],
"consecutive": false,
"autoAssignConsecutive": true,
"lockItineraryDates": true
}
UpdateVoyageMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "abc123",
"debug": true,
"context": ["xyz789"],
"timestamp": "abc123",
"originalTimestamp": "xyz789",
"intent": "abc123",
"from": "abc123",
"to": ["abc123"],
"fromUser": "abc123",
"status": "xyz789",
"approvalStatus": "xyz789",
"objectId": "abc123",
"type": "abc123",
"data": Json,
"applyTriggeredOn": "xyz789",
"applyTriggeredBy": "xyz789",
"previousData": Json,
"comment": "xyz789",
"unmapped": true,
"responseData": Json,
"applyErrors": ["xyz789"],
"applyWarnings": ["abc123"],
"parentMessageId": "abc123",
"preResolutionObjectId": "xyz789",
"title": "xyz789",
"effectiveDate": "abc123",
"source": "xyz789",
"sourceId": "abc123",
"threadId": "abc123",
"links": [MessageLinkOutput],
"retrieveWarnings": ["abc123"],
"isLatest": false,
"threadCount": 987,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
UpdateVoyage_CargosInput
Fields
| Input Field | Description |
|---|---|
cargoID - Int
|
|
cargoBooking - UpdateVoyage_CargosInput_CargoBookingInput
|
Example
{
"cargoID": 123,
"cargoBooking": UpdateVoyage_CargosInput_CargoBookingInput
}
UpdateVoyage_CargosInput_CargoBookingInput
Fields
| Input Field | Description |
|---|---|
cargoBookingStowages - [UpdateVoyage_CargosInput_CargoBookingInput_CargoBookingStowagesInput]
|
Example
{
"cargoBookingStowages": [
UpdateVoyage_CargosInput_CargoBookingInput_CargoBookingStowagesInput
]
}
UpdateVoyage_CargosInput_CargoBookingInput_CargoBookingStowagesInput
Example
{
"tankName": "xyz789",
"prevCargoFirst": "abc123",
"prevCargoSecond": "abc123",
"prevCargoThird": "abc123",
"approved": "abc123",
"inspection": "abc123",
"purging": "abc123",
"inspectionStatus": "xyz789",
"purgingStatus": "abc123",
"comments": "xyz789"
}
UpdateVoyage_VoyageBunkerInventoriesInput
UpdateVoyage_VoyageItinerariesInput
Fields
| Input Field | Description |
|---|---|
seq - Int
|
|
externalRef - String
|
|
portFunc - String
|
|
portNo - Int
|
|
portName - String
|
|
voyageItineraryBerths - [UpdateVoyage_VoyageItinerariesInput_VoyageItineraryBerthsInput]
|
|
voyagePortActivities - [UpdateVoyage_VoyageItinerariesInput_VoyagePortActivitiesInput]
|
|
voyageItineraryBunkers - [UpdateVoyage_VoyageItinerariesInput_VoyageItineraryBunkersInput]
|
|
eta - Date
|
|
etd - Date
|
Example
{
"seq": 987,
"externalRef": "xyz789",
"portFunc": "xyz789",
"portNo": 123,
"portName": "abc123",
"voyageItineraryBerths": [
UpdateVoyage_VoyageItinerariesInput_VoyageItineraryBerthsInput
],
"voyagePortActivities": [
UpdateVoyage_VoyageItinerariesInput_VoyagePortActivitiesInput
],
"voyageItineraryBunkers": [
UpdateVoyage_VoyageItinerariesInput_VoyageItineraryBunkersInput
],
"eta": "2007-12-03",
"etd": "2007-12-03"
}
UpdateVoyage_VoyageItinerariesInput_VoyageItineraryBerthsInput
Fields
| Input Field | Description |
|---|---|
berthShortName - String
|
|
voyageCargoHandlings - UpdateVoyage_VoyageItinerariesInput_VoyageItineraryBerthsInput_VoyageCargoHandlingsInput
|
|
etb - Date
|
Estimated berth arrival time |
etd - Date
|
Example
{
"berthShortName": "abc123",
"voyageCargoHandlings": UpdateVoyage_VoyageItinerariesInput_VoyageItineraryBerthsInput_VoyageCargoHandlingsInput,
"etb": "2007-12-03",
"etd": "2007-12-03"
}
UpdateVoyage_VoyageItinerariesInput_VoyageItineraryBerthsInput_VoyageCargoHandlingsInput
UpdateVoyage_VoyageItinerariesInput_VoyageItineraryBunkersInput
UpdateVoyage_VoyageItinerariesInput_VoyagePortActivitiesInput
Example
{
"activityName": "abc123",
"activityType": "abc123",
"activityTimeLocal": "2007-12-03",
"reasonType": "abc123",
"remarks": "xyz789",
"activityTime": "2007-12-03"
}
User
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
membership - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
lastLogin - Date
|
|
sqlID - Int
|
|
userNo - Int
|
|
userName - String
|
|
initials - String
|
|
type - String
|
|
fullName - String
|
|
email - String
|
|
securityAdmin - Boolean
|
|
windowsUser - Boolean
|
|
forceEuropeanDates - Boolean
|
|
inactive - Boolean
|
|
readOnly - Boolean
|
|
outOfOffice - Boolean
|
|
bCryptPasswordHash - Boolean
|
|
externalAccessOnly - Boolean
|
|
authOnly - Boolean
|
|
imosXUser - Boolean
|
|
flags - Int
|
|
ldapUserName - String
|
|
ldapGuid - String
|
|
userPhoneNo - String
|
|
createdBy - String
|
|
createdOnGmt - Date
|
|
objectAccess - [ObjectAccess]
|
|
moduleAccess - [ModuleAccess]
|
|
groupMember - [GroupMember]
|
|
audit - [Audit]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"membership": "xyz789",
"customFieldByID": Any,
"customField": Any,
"lastLogin": "2007-12-03",
"sqlID": 123,
"userNo": 987,
"userName": "xyz789",
"initials": "xyz789",
"type": "xyz789",
"fullName": "xyz789",
"email": "abc123",
"securityAdmin": true,
"windowsUser": true,
"forceEuropeanDates": true,
"inactive": false,
"readOnly": true,
"outOfOffice": true,
"bCryptPasswordHash": true,
"externalAccessOnly": false,
"authOnly": true,
"imosXUser": true,
"flags": 987,
"ldapUserName": "xyz789",
"ldapGuid": "xyz789",
"userPhoneNo": "abc123",
"createdBy": "abc123",
"createdOnGmt": "2007-12-03",
"objectAccess": [ObjectAccess],
"moduleAccess": [ModuleAccess],
"groupMember": [GroupMember],
"audit": [Audit],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
UserField
Fields
| Field Name | Description |
|---|---|
fieldID - Int
|
|
objectType - String
|
|
fieldType - String
|
|
fieldName - String
|
|
fieldDescription - String
|
|
prompt - String
|
|
formatSpec - String
|
|
default - Boolean
|
|
inactive - Boolean
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"fieldID": 987,
"objectType": "abc123",
"fieldType": "xyz789",
"fieldName": "xyz789",
"fieldDescription": "abc123",
"prompt": "xyz789",
"formatSpec": "abc123",
"default": true,
"inactive": false,
"_id": "xyz789",
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
UserFieldFieldTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NoType"
UserFieldFieldTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - UserFieldFieldTypeEnum
|
|
isNot - UserFieldFieldTypeEnum
|
|
isIn - [UserFieldFieldTypeEnum]
|
Example
{"is": "NoType", "isNot": "NoType", "isIn": ["NoType"]}
UserFieldFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - UserFieldFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": UserFieldFormQueryWhere
}
UserFieldFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [UserFieldFormQueryWhere!]
|
|
or - [UserFieldFormQueryWhere!]
|
|
rawExpression - String
|
|
fieldID - NumberWhereValueExpression
|
|
objectType - StringWhereValueExpression
|
|
fieldType - UserFieldFieldTypeEnumValueExpression
|
|
fieldName - StringWhereValueExpression
|
|
fieldDescription - StringWhereValueExpression
|
|
prompt - StringWhereValueExpression
|
|
formatSpec - StringWhereValueExpression
|
|
default - BoolWhereValueExpression
|
|
inactive - BoolWhereValueExpression
|
Example
{
"and": [UserFieldFormQueryWhere],
"or": [UserFieldFormQueryWhere],
"rawExpression": "xyz789",
"fieldID": NumberWhereValueExpression,
"objectType": StringWhereValueExpression,
"fieldType": UserFieldFieldTypeEnumValueExpression,
"fieldName": StringWhereValueExpression,
"fieldDescription": StringWhereValueExpression,
"prompt": StringWhereValueExpression,
"formatSpec": StringWhereValueExpression,
"default": BoolWhereValueExpression,
"inactive": BoolWhereValueExpression
}
UserFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - UserFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": UserFormQueryWhere
}
UserFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [UserFormQueryWhere!]
|
|
or - [UserFormQueryWhere!]
|
|
rawExpression - String
|
|
userNo - NumberWhereValueExpression
|
|
userName - StringWhereValueExpression
|
|
initials - StringWhereValueExpression
|
|
type - StringWhereValueExpression
|
|
fullName - StringWhereValueExpression
|
|
email - StringWhereValueExpression
|
|
securityAdmin - BoolWhereValueExpression
|
|
windowsUser - BoolWhereValueExpression
|
|
forceEuropeanDates - BoolWhereValueExpression
|
|
inactive - BoolWhereValueExpression
|
|
readOnly - BoolWhereValueExpression
|
|
outOfOffice - BoolWhereValueExpression
|
|
bCryptPasswordHash - BoolWhereValueExpression
|
|
externalAccessOnly - BoolWhereValueExpression
|
|
authOnly - BoolWhereValueExpression
|
|
imosXUser - BoolWhereValueExpression
|
|
flags - NumberWhereValueExpression
|
|
ldapUserName - StringWhereValueExpression
|
|
ldapGuid - StringWhereValueExpression
|
|
userPhoneNo - StringWhereValueExpression
|
|
createdBy - StringWhereValueExpression
|
|
createdOnGmt - DateWhereValueExpression
|
Example
{
"and": [UserFormQueryWhere],
"or": [UserFormQueryWhere],
"rawExpression": "xyz789",
"userNo": NumberWhereValueExpression,
"userName": StringWhereValueExpression,
"initials": StringWhereValueExpression,
"type": StringWhereValueExpression,
"fullName": StringWhereValueExpression,
"email": StringWhereValueExpression,
"securityAdmin": BoolWhereValueExpression,
"windowsUser": BoolWhereValueExpression,
"forceEuropeanDates": BoolWhereValueExpression,
"inactive": BoolWhereValueExpression,
"readOnly": BoolWhereValueExpression,
"outOfOffice": BoolWhereValueExpression,
"bCryptPasswordHash": BoolWhereValueExpression,
"externalAccessOnly": BoolWhereValueExpression,
"authOnly": BoolWhereValueExpression,
"imosXUser": BoolWhereValueExpression,
"flags": NumberWhereValueExpression,
"ldapUserName": StringWhereValueExpression,
"ldapGuid": StringWhereValueExpression,
"userPhoneNo": StringWhereValueExpression,
"createdBy": StringWhereValueExpression,
"createdOnGmt": DateWhereValueExpression
}
UserPref
UserRelationships
Fields
| Field Name | Description |
|---|---|
objectAccess - RelationshipDefinition
|
|
moduleAccess - RelationshipDefinition
|
|
groupMember - RelationshipDefinition
|
|
audit - RelationshipDefinition
|
Example
{
"objectAccess": RelationshipDefinition,
"moduleAccess": RelationshipDefinition,
"groupMember": RelationshipDefinition,
"audit": RelationshipDefinition
}
VeslinkFormInput
Description
Represents a Veslink form submission
Fields
| Input Field | Description |
|---|---|
vesselCode - String
|
The vessel code of the vessel, required on submission if no imoNo is specified |
voyageNo - Int
|
|
seq - Int
|
|
port - VeslinkForm_PortInput
|
|
imoNo - String
|
The IMO number of the vessel, used for vessel inference if no vesselCode is specified |
formDate - Date
|
The effective date of the Veslink form, used for leg inference if no seq is specified |
positionReport - VeslinkForm_PositionReportInput
|
|
portActivities - VeslinkForm_PortActivitiesInput
|
|
etaEtd - VeslinkForm_EtaEtdInput
|
|
upcomingPorts - VeslinkForm_UpcomingPortsInput
|
|
delay - VeslinkForm_DelayInput
|
|
cargoHandlings - VeslinkForm_CargoHandlingsInput
|
Example
{
"vesselCode": "xyz789",
"voyageNo": 123,
"seq": 987,
"port": VeslinkForm_PortInput,
"imoNo": "xyz789",
"formDate": "2007-12-03",
"positionReport": VeslinkForm_PositionReportInput,
"portActivities": VeslinkForm_PortActivitiesInput,
"etaEtd": VeslinkForm_EtaEtdInput,
"upcomingPorts": VeslinkForm_UpcomingPortsInput,
"delay": VeslinkForm_DelayInput,
"cargoHandlings": VeslinkForm_CargoHandlingsInput
}
VeslinkFormMessageRecord
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
debug - Boolean
|
|
context - [String]
|
|
timestamp - String
|
|
originalTimestamp - String
|
|
intent - String
|
|
from - String!
|
|
to - [String!]
|
|
fromUser - String
|
|
status - String
|
|
approvalStatus - String
|
Message approval status. Must be one of pending, approved, rejected, failed, edited. Can specify multiple as a comma-separated list. |
objectId - String
|
|
type - String
|
|
data - Json
|
|
applyTriggeredOn - String
|
|
applyTriggeredBy - String
|
|
previousData - Json
|
|
comment - String
|
|
unmapped - Boolean
|
|
responseData - Json
|
|
applyErrors - [String!]
|
|
applyWarnings - [String!]
|
|
parentMessageId - String
|
|
preResolutionObjectId - String
|
|
title - String
|
|
effectiveDate - String
|
|
source - String
|
|
sourceId - String
|
|
threadId - String
|
|
links - [MessageLinkOutput]
|
|
retrieveWarnings - [String!]
|
|
isLatest - Boolean
|
|
threadCount - Int
|
|
timestampObject - Date
|
|
tags - [MessageTag]
|
|
associatedFormId - String
|
Example
{
"_id": "abc123",
"debug": false,
"context": ["abc123"],
"timestamp": "xyz789",
"originalTimestamp": "xyz789",
"intent": "abc123",
"from": "xyz789",
"to": ["xyz789"],
"fromUser": "xyz789",
"status": "abc123",
"approvalStatus": "abc123",
"objectId": "abc123",
"type": "xyz789",
"data": Json,
"applyTriggeredOn": "abc123",
"applyTriggeredBy": "abc123",
"previousData": Json,
"comment": "abc123",
"unmapped": false,
"responseData": Json,
"applyErrors": ["abc123"],
"applyWarnings": ["xyz789"],
"parentMessageId": "xyz789",
"preResolutionObjectId": "xyz789",
"title": "xyz789",
"effectiveDate": "xyz789",
"source": "abc123",
"sourceId": "abc123",
"threadId": "xyz789",
"links": [MessageLinkOutput],
"retrieveWarnings": ["abc123"],
"isLatest": true,
"threadCount": 123,
"timestampObject": "2007-12-03",
"tags": [MessageTag],
"associatedFormId": "abc123"
}
VeslinkForm_CargoHandlingsInput
Fields
| Input Field | Description |
|---|---|
voyageCargoHandlings - [VeslinkForm_CargoHandlingsInput_VoyageCargoHandlingsInput]!
|
Example
{
"voyageCargoHandlings": [
VeslinkForm_CargoHandlingsInput_VoyageCargoHandlingsInput
]
}
VeslinkForm_CargoHandlingsInput_VoyageCargoHandlingsInput
Fields
| Input Field | Description |
|---|---|
cargoShortName - String
|
|
functionCode - String
|
|
cargoID - Int
|
|
seqNo - Int
|
|
berthSeqNo - Int
|
|
blCode - String
|
|
blDate - Date
|
|
cpUnit - String
|
|
blQuantity - Float
|
|
shipGross - Float
|
|
blDraft - Float
|
|
shipLTemp - Float
|
|
apiShip - Float
|
|
gsvShore - Float
|
|
altCPUnit - String
|
|
altBLGross - Float
|
|
altShipGross - Float
|
|
isLopFiled - Boolean
|
|
isWarrantyConditionsMet - Boolean
|
|
voyageCargoHandlingDocuments - [VeslinkForm_CargoHandlingsInput_VoyageCargoHandlingsInput_VoyageCargoHandlingDocumentsInput]!
|
|
voyageCargoHandlingStowages - [VeslinkForm_CargoHandlingsInput_VoyageCargoHandlingsInput_VoyageCargoHandlingStowagesInput]!
|
|
berthShortName - String
|
|
blDraftUnit - String
|
Example
{
"cargoShortName": "abc123",
"functionCode": "abc123",
"cargoID": 123,
"seqNo": 123,
"berthSeqNo": 987,
"blCode": "xyz789",
"blDate": "2007-12-03",
"cpUnit": "xyz789",
"blQuantity": 123.45,
"shipGross": 123.45,
"blDraft": 123.45,
"shipLTemp": 987.65,
"apiShip": 987.65,
"gsvShore": 987.65,
"altCPUnit": "abc123",
"altBLGross": 123.45,
"altShipGross": 987.65,
"isLopFiled": false,
"isWarrantyConditionsMet": true,
"voyageCargoHandlingDocuments": [
VeslinkForm_CargoHandlingsInput_VoyageCargoHandlingsInput_VoyageCargoHandlingDocumentsInput
],
"voyageCargoHandlingStowages": [
VeslinkForm_CargoHandlingsInput_VoyageCargoHandlingsInput_VoyageCargoHandlingStowagesInput
],
"berthShortName": "abc123",
"blDraftUnit": "xyz789"
}
VeslinkForm_CargoHandlingsInput_VoyageCargoHandlingsInput_VoyageCargoHandlingDocumentsInput
VeslinkForm_CargoHandlingsInput_VoyageCargoHandlingsInput_VoyageCargoHandlingStowagesInput
VeslinkForm_DelayInput
Fields
| Input Field | Description |
|---|---|
remarks - String
|
|
delayStartGmt - Date
|
|
delayEndGmt - Date
|
|
hours - Float
|
|
miles - Int
|
|
delayType - VeslinkForm_DelayInput_DelayTypeInput!
|
|
delayBunkers - [VeslinkForm_DelayInput_DelayBunkersInput]
|
|
delayReasonName - String
|
Longform reason name, this is what the user will see. |
Example
{
"remarks": "xyz789",
"delayStartGmt": "2007-12-03",
"delayEndGmt": "2007-12-03",
"hours": 987.65,
"miles": 987,
"delayType": VeslinkForm_DelayInput_DelayTypeInput,
"delayBunkers": [
VeslinkForm_DelayInput_DelayBunkersInput
],
"delayReasonName": "abc123"
}
VeslinkForm_DelayInput_DelayBunkersInput
VeslinkForm_DelayInput_DelayTypeInput
Fields
| Input Field | Description |
|---|---|
description - String
|
Example
{"description": "abc123"}
VeslinkForm_EtaEtdInput
VeslinkForm_PortActivitiesInput
Fields
| Input Field | Description |
|---|---|
voyagePortActivities - [VeslinkForm_PortActivitiesInput_VoyagePortActivitiesInput]!
|
|
importMode - VeslinkForm_PortActivitiesInput_ImportMode
|
Update - If there is an overlap of the incoming and existing voyagePortActivities, it will update the activityTime or delete the port activity if there is no time Append - Add the incoming voyagePortActivities to the existing voyagePortActivities |
Example
{
"voyagePortActivities": [
VeslinkForm_PortActivitiesInput_VoyagePortActivitiesInput
],
"importMode": "Overwrite"
}
VeslinkForm_PortActivitiesInput_ImportMode
Description
Overwrite (default) - Completely replaces the existing voyagePortActivities with the incoming voyagePortActivities Update - If there is an overlap of the incoming and existing voyagePortActivities, it will update the activityTime or delete the port activity if there is no time Append - Add the incoming voyagePortActivities to the existing voyagePortActivities
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Overwrite"
VeslinkForm_PortActivitiesInput_VoyagePortActivitiesInput
Fields
| Input Field | Description |
|---|---|
activityName - String
|
The name of this activity from the set of predefined activities |
activityType - String
|
Overrides the two letter code of the activity for this instance for special case handling |
remarks - String
|
|
activityTimeGmt - Date
|
|
activityTimeLocal - Date
|
|
berthShortName - String
|
|
cargoShortName - String
|
|
cargoHandlingSeqNo - Int
|
|
portActivityBunkers - [VeslinkForm_PortActivitiesInput_VoyagePortActivitiesInput_PortActivityBunkersInput]
|
|
berthSeqNo - Int
|
Example
{
"activityName": "xyz789",
"activityType": "abc123",
"remarks": "abc123",
"activityTimeGmt": "2007-12-03",
"activityTimeLocal": "2007-12-03",
"berthShortName": "xyz789",
"cargoShortName": "xyz789",
"cargoHandlingSeqNo": 123,
"portActivityBunkers": [
VeslinkForm_PortActivitiesInput_VoyagePortActivitiesInput_PortActivityBunkersInput
],
"berthSeqNo": 987
}
VeslinkForm_PortActivitiesInput_VoyagePortActivitiesInput_PortActivityBunkersInput
VeslinkForm_PortInput
VeslinkForm_PositionReportInput
Fields
| Input Field | Description |
|---|---|
reportType - String
|
|
latitude - String
|
|
longitude - String
|
|
remarks - String
|
|
reportedSpeed - Float
|
|
projectedSpeed - Float
|
|
orderedSpeed - Float
|
|
observedDistance - Int
|
|
distanceToGo - Int
|
|
averageSpeed - Float
|
|
badWeatherHours - Float
|
|
badWeatherDistance - Float
|
|
dwt - Float
|
|
headingDegrees - Int
|
|
headingDirection - String
|
|
engineDistance - Float
|
|
slippagePercentage - Float
|
|
engineLoadPercentage - Float
|
|
reportedSlipPercentage - Float
|
|
averageBhp - Float
|
|
averageRpm - Float
|
|
mainEngineHours - Float
|
|
mainEngineKwhr - Float
|
|
maxLdIndicator - Float
|
|
steamingHours - Float
|
|
boilerHours - Float
|
|
incineratorHours - Float
|
|
generator1Hrs - Float
|
|
generator2Hrs - Float
|
|
generator3Hrs - Float
|
|
generator4Hrs - Float
|
|
generator1Kwhr - Float
|
|
generator2Kwhr - Float
|
|
generator3Kwhr - Float
|
|
generator4Kwhr - Float
|
|
fwGeneratorHours - Float
|
|
freshWaterCons - Float
|
|
freshWaterRec - Float
|
|
freshWaterRob - Float
|
|
distilledWaterCons - Float
|
|
distilledWaterProd - Float
|
|
distilledWaterRec - Float
|
|
distilledWaterRob - Float
|
|
slopRec - Float
|
|
slopRob - Float
|
|
beaufortScaleNo - Int
|
|
windDirection - String
|
|
seaState - Int
|
|
seaDirection - String
|
|
seaTemp - String
|
|
seaHeight - Float
|
|
seaSwell - Int
|
|
swellDirection - String
|
|
swellHeight - Float
|
|
airTemp - String
|
|
barometricPressure - String
|
|
barometricMovement - String
|
|
currentSpeed - Float
|
|
currentDirection - String
|
|
currentLocationGaugeName - String
|
|
currentLocationWaterLevel - Float
|
|
currentLocationUOM - String
|
|
restrictedLocationGaugeName - String
|
|
restrictedLocationWaterLevel - Float
|
|
restrictedLocationUOM - String
|
|
displacement - Float
|
|
fwdDraft - Float
|
|
aftDraft - Float
|
|
midDraft - Float
|
|
portFwdDraft - Float
|
|
portAftDraft - Float
|
|
portMidDraft - Float
|
|
starboardFwdDraft - Float
|
|
starboardAftDraft - Float
|
|
starboardMidDraft - Float
|
|
salinity - Float
|
|
ballast - Float
|
|
crewStores - Float
|
|
lubes - Float
|
|
constant - Float
|
|
numberOfTugs - Int
|
|
positionNote - String
|
|
waterwayCode - String
|
|
cpStatus - Int
|
|
lngReadingType - String
|
|
isForcedBoilOff - Boolean
|
|
totalRevs - Float
|
|
masterLastName - String
|
|
masterFirstName - String
|
|
engineerLastName - String
|
|
engineerFirstName - String
|
|
fuelConsMode - String
|
|
gmsControlMode - String
|
|
loggedDistance - Float
|
|
cargoTempUnit - String
|
|
cargoTemperature - Float
|
|
draftUnit - String
|
|
activityReportBunkerDetails - [VeslinkForm_PositionReportInput_ActivityReportBunkerDetailsInput]!
|
|
reportDate - Date
|
|
nextPortEta - Date
|
|
noonReportType - String
|
|
refPortName - String
|
|
isBunkering - Boolean
|
Example
{
"reportType": "xyz789",
"latitude": "abc123",
"longitude": "xyz789",
"remarks": "abc123",
"reportedSpeed": 987.65,
"projectedSpeed": 123.45,
"orderedSpeed": 123.45,
"observedDistance": 987,
"distanceToGo": 987,
"averageSpeed": 123.45,
"badWeatherHours": 123.45,
"badWeatherDistance": 123.45,
"dwt": 987.65,
"headingDegrees": 987,
"headingDirection": "xyz789",
"engineDistance": 123.45,
"slippagePercentage": 987.65,
"engineLoadPercentage": 123.45,
"reportedSlipPercentage": 123.45,
"averageBhp": 987.65,
"averageRpm": 123.45,
"mainEngineHours": 123.45,
"mainEngineKwhr": 987.65,
"maxLdIndicator": 123.45,
"steamingHours": 987.65,
"boilerHours": 987.65,
"incineratorHours": 123.45,
"generator1Hrs": 987.65,
"generator2Hrs": 987.65,
"generator3Hrs": 123.45,
"generator4Hrs": 123.45,
"generator1Kwhr": 987.65,
"generator2Kwhr": 987.65,
"generator3Kwhr": 123.45,
"generator4Kwhr": 987.65,
"fwGeneratorHours": 123.45,
"freshWaterCons": 987.65,
"freshWaterRec": 123.45,
"freshWaterRob": 123.45,
"distilledWaterCons": 123.45,
"distilledWaterProd": 123.45,
"distilledWaterRec": 123.45,
"distilledWaterRob": 987.65,
"slopRec": 987.65,
"slopRob": 123.45,
"beaufortScaleNo": 987,
"windDirection": "xyz789",
"seaState": 123,
"seaDirection": "xyz789",
"seaTemp": "abc123",
"seaHeight": 987.65,
"seaSwell": 987,
"swellDirection": "abc123",
"swellHeight": 987.65,
"airTemp": "abc123",
"barometricPressure": "abc123",
"barometricMovement": "abc123",
"currentSpeed": 987.65,
"currentDirection": "xyz789",
"currentLocationGaugeName": "abc123",
"currentLocationWaterLevel": 987.65,
"currentLocationUOM": "abc123",
"restrictedLocationGaugeName": "xyz789",
"restrictedLocationWaterLevel": 123.45,
"restrictedLocationUOM": "abc123",
"displacement": 123.45,
"fwdDraft": 123.45,
"aftDraft": 987.65,
"midDraft": 123.45,
"portFwdDraft": 987.65,
"portAftDraft": 987.65,
"portMidDraft": 987.65,
"starboardFwdDraft": 123.45,
"starboardAftDraft": 987.65,
"starboardMidDraft": 987.65,
"salinity": 987.65,
"ballast": 987.65,
"crewStores": 123.45,
"lubes": 987.65,
"constant": 987.65,
"numberOfTugs": 123,
"positionNote": "abc123",
"waterwayCode": "xyz789",
"cpStatus": 123,
"lngReadingType": "xyz789",
"isForcedBoilOff": false,
"totalRevs": 987.65,
"masterLastName": "xyz789",
"masterFirstName": "xyz789",
"engineerLastName": "abc123",
"engineerFirstName": "abc123",
"fuelConsMode": "xyz789",
"gmsControlMode": "abc123",
"loggedDistance": 123.45,
"cargoTempUnit": "xyz789",
"cargoTemperature": 123.45,
"draftUnit": "abc123",
"activityReportBunkerDetails": [
VeslinkForm_PositionReportInput_ActivityReportBunkerDetailsInput
],
"reportDate": "2007-12-03",
"nextPortEta": "2007-12-03",
"noonReportType": "abc123",
"refPortName": "abc123",
"isBunkering": false
}
VeslinkForm_PositionReportInput_ActivityReportBunkerDetailsInput
Fields
| Input Field | Description |
|---|---|
fuelType - String
|
|
fuelRob - Float
|
|
fuelReceived - Float
|
|
mainEng - Float
|
|
auxEng - Float
|
|
badWeatherConsumption - Float
|
|
loadOrDisch - Float
|
|
maneuver - Float
|
|
propulsion - Float
|
|
deballast - Float
|
|
igs - Float
|
|
generator - Float
|
|
heat - Float
|
|
boiler - Float
|
|
incinerator - Float
|
|
others - Float
|
|
clean - Float
|
|
heatPlus - Float
|
|
heatPlusPlus - Float
|
|
cooling - Float
|
|
idleorOn - Float
|
|
idleorOff - Float
|
|
pilotFlame - Float
|
|
sulfurContentPct_0 - Float
|
|
sulfurContentRob_0 - Float
|
|
sulfurContentPct_1 - Float
|
|
sulfurContentRob_1 - Float
|
|
sulfurContentPct_2 - Float
|
|
sulfurContentRob_2 - Float
|
|
fuelConsumed - Float
|
Example
{
"fuelType": "abc123",
"fuelRob": 123.45,
"fuelReceived": 123.45,
"mainEng": 123.45,
"auxEng": 123.45,
"badWeatherConsumption": 123.45,
"loadOrDisch": 123.45,
"maneuver": 987.65,
"propulsion": 123.45,
"deballast": 987.65,
"igs": 987.65,
"generator": 123.45,
"heat": 123.45,
"boiler": 987.65,
"incinerator": 123.45,
"others": 123.45,
"clean": 987.65,
"heatPlus": 123.45,
"heatPlusPlus": 123.45,
"cooling": 987.65,
"idleorOn": 987.65,
"idleorOff": 123.45,
"pilotFlame": 123.45,
"sulfurContentPct_0": 123.45,
"sulfurContentRob_0": 123.45,
"sulfurContentPct_1": 123.45,
"sulfurContentRob_1": 987.65,
"sulfurContentPct_2": 123.45,
"sulfurContentRob_2": 123.45,
"fuelConsumed": 987.65
}
VeslinkForm_UpcomingPortsInput
Fields
| Input Field | Description |
|---|---|
upcomingPorts - [VeslinkForm_UpcomingPortsInput_UpcomingPortsInput]!
|
|
reportTime - Date
|
|
reportType - String
|
|
allowChangingItinerary - Boolean
|
Determines whether user is allowed to change the itinerary, defaults to false |
allowChangingItinLength - Boolean
|
Determines whether user is allowed to change itinerary length, defaults to false |
suppressPortMismatchError - Boolean
|
Determines whether port mismatches will throw errors if user is not allowed to change itinerary, defaults to false |
Example
{
"upcomingPorts": [
VeslinkForm_UpcomingPortsInput_UpcomingPortsInput
],
"reportTime": "2007-12-03",
"reportType": "abc123",
"allowChangingItinerary": false,
"allowChangingItinLength": false,
"suppressPortMismatchError": false
}
VeslinkForm_UpcomingPortsInput_UpcomingPortsInput
Fields
| Input Field | Description |
|---|---|
port - VeslinkForm_UpcomingPortsInput_UpcomingPortsInput_PortInput
|
|
etaGmt - Date
|
|
distanceToGo - Float
|
distance to the port from current position |
projectedSpeed - Float
|
projected speed vessel will travel at |
Example
{
"port": VeslinkForm_UpcomingPortsInput_UpcomingPortsInput_PortInput,
"etaGmt": "2007-12-03",
"distanceToGo": 987.65,
"projectedSpeed": 123.45
}
VeslinkForm_UpcomingPortsInput_UpcomingPortsInput_PortInput
VesonSubscription
Fields
| Field Name | Description |
|---|---|
subscriptionID - String
|
|
formName - String
|
|
publisherUri - String
|
|
subscriberUri - String
|
|
lastUpdateGMT - Date
|
|
filterExpression - String
|
|
fields - String
|
|
mappedFields - String
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"subscriptionID": "abc123",
"formName": "xyz789",
"publisherUri": "xyz789",
"subscriberUri": "xyz789",
"lastUpdateGMT": "2007-12-03",
"filterExpression": "xyz789",
"fields": "xyz789",
"mappedFields": "xyz789",
"_id": "xyz789",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
VesonSubscriptionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesonSubscriptionFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesonSubscriptionFormQueryWhere
}
VesonSubscriptionFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesonSubscriptionFormQueryWhere!]
|
|
or - [VesonSubscriptionFormQueryWhere!]
|
|
rawExpression - String
|
|
subscriptionID - StringWhereValueExpression
|
|
formName - StringWhereValueExpression
|
|
publisherUri - StringWhereValueExpression
|
|
subscriberUri - StringWhereValueExpression
|
|
lastUpdateGMT - DateWhereValueExpression
|
|
filterExpression - StringWhereValueExpression
|
|
fields - StringWhereValueExpression
|
|
mappedFields - StringWhereValueExpression
|
Example
{
"and": [VesonSubscriptionFormQueryWhere],
"or": [VesonSubscriptionFormQueryWhere],
"rawExpression": "abc123",
"subscriptionID": StringWhereValueExpression,
"formName": StringWhereValueExpression,
"publisherUri": StringWhereValueExpression,
"subscriberUri": StringWhereValueExpression,
"lastUpdateGMT": DateWhereValueExpression,
"filterExpression": StringWhereValueExpression,
"fields": StringWhereValueExpression,
"mappedFields": StringWhereValueExpression
}
Vessel
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
capacityBaleM3 - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
capacityGrainM3 - Float
|
|
fillingLimitPercentage - Float
|
|
isActive - Boolean
|
|
containerCapacityFEU - Float
|
|
deckCapacityM3 - Float
|
|
isActiveForVeslink - Boolean
|
|
last5CargoShortNames - String
|
|
foeConversionFactor - Float
|
|
sqlID - Int
|
|
vesselCode - String
|
|
name - String
|
|
vesselType - String
|
|
suezType - String
|
|
fleet - String
|
|
flag - String
|
|
unitTypeCode - String
|
|
ownership - String
|
|
callLetters - String
|
|
operator - String
|
|
lOA - Float
|
|
beam - Float
|
|
depth - Float
|
|
dailyCost - Float
|
|
opa90 - Float
|
|
dWT - Float
|
|
capacity - Float
|
|
totalBBLs - Float
|
|
vesselSummerDraft - Float
|
|
vesselWinterDraft - Float
|
|
maxDraft - Float
|
|
tPC - Float
|
|
gRT - Float
|
|
nRT - Float
|
|
panamaGross - Float
|
|
panamaNet - Float
|
|
suezGross - Float
|
|
suezNet - Float
|
|
ladenSpeed - Float
|
|
ballastSpeed - Float
|
|
tradeArea - String
|
|
foeConversionFactorInverted - Float
|
|
maxAirDraft - Float
|
|
telex - String
|
|
fax - String
|
|
imoNo - String
|
|
phone - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
allowUpdate - Int
|
|
hullType - String
|
|
lastUser - String
|
|
yearBuilt - Int
|
|
isBargeUnit - Int
|
|
vapor - Boolean
|
|
igs - Boolean
|
|
nonActive - Boolean
|
|
allowDespatch - Boolean
|
|
trackInlandBunkers - Boolean
|
|
estOnly - Boolean
|
|
co2Fitted - Boolean
|
|
bowThruster - Boolean
|
|
strengthened - Boolean
|
|
australianLadders - Boolean
|
|
toledoSuitable - Boolean
|
|
tveValid - Boolean
|
|
rejected - Boolean
|
|
logFitted - Boolean
|
|
grainFitted - Boolean
|
|
commercialMgmt - Boolean
|
|
etaExcluded - Boolean
|
|
a60Fitted - Boolean
|
|
offshoreBarge - Boolean
|
|
useBoilOffMinCons - Boolean
|
|
useScrubbers - Boolean
|
|
isCommonlyUsed - Boolean
|
|
isUnitTow - Boolean
|
|
activeForOnboard - Boolean
|
|
isGeneralCargo - Boolean
|
|
equipmentFlags - Int
|
|
email - String
|
|
refNo - String
|
|
satC - String
|
|
ventilation - String
|
|
iceClass - String
|
|
grabsQty - Float
|
|
grabsCap - Float
|
|
engineMake - String
|
|
holdStrengthened - String
|
|
inheritRouteFromVessel - String
|
|
remarks - String
|
|
officialNo - String
|
|
pnsNo - String
|
|
hatchType - String
|
|
hAndMValue - String
|
|
pAndIClub - String
|
|
gapValue - String
|
|
maxBallastDailyBoilOffPct - Float
|
|
maxLadenDailyBoilOffPct - Float
|
|
demAnalyst - String
|
|
satA - String
|
|
satB - String
|
|
miniM - String
|
|
masterPhone - String
|
|
bridgePhone - String
|
|
ccrNo - String
|
|
chtrCoordinator - String
|
|
opsCoordinator - String
|
|
beaufortNo - Int
|
|
seaStateNo - Int
|
|
seaSwellNo - Int
|
|
alerts - String
|
|
dailyAdminFee - Float
|
|
adminFeeCurr - String
|
|
vesselTypeCorrelation - Float
|
|
crossRefNo - String
|
|
replicationFlags - Int
|
|
veslinkCompany - String
|
|
unitFactor - Float
|
|
fuelZoneSetID - Int
|
|
vesselTypeAdjustment - Float
|
|
naturalBoilOffBallastSpeed - Float
|
|
naturalBoilOffLadenSpeed - Float
|
|
bunkerConfigVersion - Int
|
|
companyCode - String
|
|
scrubberType - String
|
|
vettingRemarks - String
|
|
iceClassType - String
|
|
engineType - String
|
|
fuelZoneSet - FuelZoneSet
|
|
vesselDetails - VesselDetails
|
|
ownerAddressBook - AddressBook
|
|
vesselTypeData - VesselType
|
|
vesselVariables - VesselVariables
|
|
barge - Barge
|
|
voyagePnls - [VoyagePnl]
|
|
vesselDraftMarks - [VesselDraftMarks]
|
|
vesselCranes - [VesselCrane]
|
|
poolAssignments - [PoolAssignment]
|
|
vesselHolds - [VesselHold]
|
|
vesselTceTargets - [VesselTceTarget]
|
|
vesselSeaConsBunkers - [VesselSeaConsBunker]
|
|
vesselSeaCons - [VesselSeaCons]
|
|
vesselPortCons - [VesselPortCons]
|
|
vesselInspections - [VesselInspection]
|
|
vesselIncidents - [VesselIncident]
|
|
vesselHatchs - [VesselHatch]
|
|
vesselEvaluations - [VesselEvaluation]
|
|
vesselDrafts - [VesselDraft]
|
|
vesselConsModes - [VesselConsMode]
|
|
vesselBunkerTanks - [VesselBunkerTank]
|
|
vesselBoats - [VesselBoats]
|
|
vesselTanks - [VesselTank]
|
|
vesselFleetMember - [VesselFleetMemberFull]
|
|
updateEquipmentMessages - [UpdateEquipmentMessageRecord]
|
|
Arguments
|
|
changesSinceLast - VesselChangesSinceLast
|
|
userDefinedFields - Json
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"capacityBaleM3": 123.45,
"customFieldByID": Any,
"customField": Any,
"capacityGrainM3": 123.45,
"fillingLimitPercentage": 123.45,
"isActive": true,
"containerCapacityFEU": 123.45,
"deckCapacityM3": 987.65,
"isActiveForVeslink": false,
"last5CargoShortNames": "abc123",
"foeConversionFactor": 987.65,
"sqlID": 123,
"vesselCode": "xyz789",
"name": "abc123",
"vesselType": "abc123",
"suezType": "xyz789",
"fleet": "xyz789",
"flag": "xyz789",
"unitTypeCode": "abc123",
"ownership": "abc123",
"callLetters": "abc123",
"operator": "abc123",
"lOA": 123.45,
"beam": 123.45,
"depth": 987.65,
"dailyCost": 123.45,
"opa90": 987.65,
"dWT": 123.45,
"capacity": 987.65,
"totalBBLs": 987.65,
"vesselSummerDraft": 123.45,
"vesselWinterDraft": 123.45,
"maxDraft": 987.65,
"tPC": 123.45,
"gRT": 123.45,
"nRT": 987.65,
"panamaGross": 123.45,
"panamaNet": 987.65,
"suezGross": 123.45,
"suezNet": 123.45,
"ladenSpeed": 123.45,
"ballastSpeed": 987.65,
"tradeArea": "abc123",
"foeConversionFactorInverted": 123.45,
"maxAirDraft": 987.65,
"telex": "xyz789",
"fax": "abc123",
"imoNo": "abc123",
"phone": "abc123",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"allowUpdate": 123,
"hullType": "xyz789",
"lastUser": "abc123",
"yearBuilt": 123,
"isBargeUnit": 987,
"vapor": false,
"igs": false,
"nonActive": false,
"allowDespatch": true,
"trackInlandBunkers": true,
"estOnly": false,
"co2Fitted": true,
"bowThruster": true,
"strengthened": true,
"australianLadders": true,
"toledoSuitable": false,
"tveValid": false,
"rejected": false,
"logFitted": false,
"grainFitted": false,
"commercialMgmt": false,
"etaExcluded": true,
"a60Fitted": true,
"offshoreBarge": true,
"useBoilOffMinCons": true,
"useScrubbers": true,
"isCommonlyUsed": false,
"isUnitTow": true,
"activeForOnboard": true,
"isGeneralCargo": false,
"equipmentFlags": 123,
"email": "xyz789",
"refNo": "abc123",
"satC": "xyz789",
"ventilation": "xyz789",
"iceClass": "xyz789",
"grabsQty": 123.45,
"grabsCap": 987.65,
"engineMake": "abc123",
"holdStrengthened": "abc123",
"inheritRouteFromVessel": "abc123",
"remarks": "abc123",
"officialNo": "abc123",
"pnsNo": "abc123",
"hatchType": "abc123",
"hAndMValue": "abc123",
"pAndIClub": "abc123",
"gapValue": "xyz789",
"maxBallastDailyBoilOffPct": 123.45,
"maxLadenDailyBoilOffPct": 123.45,
"demAnalyst": "xyz789",
"satA": "abc123",
"satB": "xyz789",
"miniM": "xyz789",
"masterPhone": "xyz789",
"bridgePhone": "xyz789",
"ccrNo": "xyz789",
"chtrCoordinator": "abc123",
"opsCoordinator": "abc123",
"beaufortNo": 987,
"seaStateNo": 987,
"seaSwellNo": 123,
"alerts": "xyz789",
"dailyAdminFee": 987.65,
"adminFeeCurr": "xyz789",
"vesselTypeCorrelation": 987.65,
"crossRefNo": "xyz789",
"replicationFlags": 123,
"veslinkCompany": "xyz789",
"unitFactor": 987.65,
"fuelZoneSetID": 987,
"vesselTypeAdjustment": 987.65,
"naturalBoilOffBallastSpeed": 123.45,
"naturalBoilOffLadenSpeed": 123.45,
"bunkerConfigVersion": 987,
"companyCode": "xyz789",
"scrubberType": "abc123",
"vettingRemarks": "abc123",
"iceClassType": "abc123",
"engineType": "xyz789",
"fuelZoneSet": FuelZoneSet,
"vesselDetails": VesselDetails,
"ownerAddressBook": AddressBook,
"vesselTypeData": VesselType,
"vesselVariables": VesselVariables,
"barge": Barge,
"voyagePnls": [VoyagePnl],
"vesselDraftMarks": [VesselDraftMarks],
"vesselCranes": [VesselCrane],
"poolAssignments": [PoolAssignment],
"vesselHolds": [VesselHold],
"vesselTceTargets": [VesselTceTarget],
"vesselSeaConsBunkers": [VesselSeaConsBunker],
"vesselSeaCons": [VesselSeaCons],
"vesselPortCons": [VesselPortCons],
"vesselInspections": [VesselInspection],
"vesselIncidents": [VesselIncident],
"vesselHatchs": [VesselHatch],
"vesselEvaluations": [VesselEvaluation],
"vesselDrafts": [VesselDraft],
"vesselConsModes": [VesselConsMode],
"vesselBunkerTanks": [VesselBunkerTank],
"vesselBoats": [VesselBoats],
"vesselTanks": [VesselTank],
"vesselFleetMember": [VesselFleetMemberFull],
"updateEquipmentMessages": [
UpdateEquipmentMessageRecord
],
"changesSinceLast": VesselChangesSinceLast,
"userDefinedFields": Json,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VesselAisTypeSet
VesselAlertRulesRequest
VesselBoats
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
bargeCode - String
|
|
sequenceNumber - Int
|
|
inGMT - Date
|
|
outGMT - Date
|
|
vessel - Vessel
|
|
barge - Barge
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"bargeCode": "xyz789",
"sequenceNumber": 123,
"inGMT": "2007-12-03",
"outGMT": "2007-12-03",
"vessel": Vessel,
"barge": Barge,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VesselBoatsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselBoatsFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselBoatsFormQueryWhere
}
VesselBoatsFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesselBoatsFormQueryWhere!]
|
|
or - [VesselBoatsFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
bargeCode - StringWhereValueExpression
|
|
sequenceNumber - NumberWhereValueExpression
|
|
inGMT - DateWhereValueExpression
|
|
outGMT - DateWhereValueExpression
|
|
vessel - VesselFormQueryWhere
|
|
barge - BargeFormQueryWhere
|
Example
{
"and": [VesselBoatsFormQueryWhere],
"or": [VesselBoatsFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"bargeCode": StringWhereValueExpression,
"sequenceNumber": NumberWhereValueExpression,
"inGMT": DateWhereValueExpression,
"outGMT": DateWhereValueExpression,
"vessel": VesselFormQueryWhere,
"barge": BargeFormQueryWhere
}
VesselBoatsRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
|
barge - RelationshipDefinition
|
Example
{
"vessel": RelationshipDefinition,
"barge": RelationshipDefinition
}
VesselBunkerTank
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
bunkerTankNo - Int
|
|
description - String
|
|
location - String
|
|
capacity - Float
|
|
unit - String
|
|
unitOfMeasure - UnitOfMeasure
|
|
vessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"bunkerTankNo": 987,
"description": "abc123",
"location": "abc123",
"capacity": 123.45,
"unit": "xyz789",
"unitOfMeasure": UnitOfMeasure,
"vessel": Vessel,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
VesselBunkerTankFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselBunkerTankFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselBunkerTankFormQueryWhere
}
VesselBunkerTankFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesselBunkerTankFormQueryWhere!]
|
|
or - [VesselBunkerTankFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
bunkerTankNo - NumberWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
location - StringWhereValueExpression
|
|
capacity - NumberWhereValueExpression
|
|
unit - StringWhereValueExpression
|
|
unitOfMeasure - UnitOfMeasureFormQueryWhere
|
|
vessel - VesselFormQueryWhere
|
Example
{
"and": [VesselBunkerTankFormQueryWhere],
"or": [VesselBunkerTankFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"bunkerTankNo": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"location": StringWhereValueExpression,
"capacity": NumberWhereValueExpression,
"unit": StringWhereValueExpression,
"unitOfMeasure": UnitOfMeasureFormQueryWhere,
"vessel": VesselFormQueryWhere
}
VesselBunkerTankRelationships
Fields
| Field Name | Description |
|---|---|
unitOfMeasure - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
Example
{
"unitOfMeasure": RelationshipDefinition,
"vessel": RelationshipDefinition
}
VesselChangesSinceLast
Fields
| Field Name | Description |
|---|---|
updateEquipment - MessageUpdateResponse
|
Example
{"updateEquipment": MessageUpdateResponse}
VesselConsMode
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vslCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
consModeID - Int
|
|
isFuelVersion - Boolean
|
|
vessel - Vessel
|
|
consMode - ConsMode
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vslCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"consModeID": 123,
"isFuelVersion": true,
"vessel": Vessel,
"consMode": ConsMode,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
VesselConsModeFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselConsModeFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselConsModeFormQueryWhere
}
VesselConsModeFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesselConsModeFormQueryWhere!]
|
|
or - [VesselConsModeFormQueryWhere!]
|
|
rawExpression - String
|
|
vslCode - StringWhereValueExpression
|
|
consModeID - NumberWhereValueExpression
|
|
isFuelVersion - BoolWhereValueExpression
|
|
vessel - VesselFormQueryWhere
|
|
consMode - ConsModeFormQueryWhere
|
Example
{
"and": [VesselConsModeFormQueryWhere],
"or": [VesselConsModeFormQueryWhere],
"rawExpression": "abc123",
"vslCode": StringWhereValueExpression,
"consModeID": NumberWhereValueExpression,
"isFuelVersion": BoolWhereValueExpression,
"vessel": VesselFormQueryWhere,
"consMode": ConsModeFormQueryWhere
}
VesselConsModeRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
|
consMode - RelationshipDefinition
|
Example
{
"vessel": RelationshipDefinition,
"consMode": RelationshipDefinition
}
VesselCrane
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
craneType - String
|
|
seqNo - Int
|
|
noOutreach - Int
|
|
capacity - Float
|
|
radius - Float
|
|
vessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"craneType": "abc123",
"seqNo": 123,
"noOutreach": 987,
"capacity": 987.65,
"radius": 123.45,
"vessel": Vessel,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VesselCraneFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselCraneFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselCraneFormQueryWhere
}
VesselCraneFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesselCraneFormQueryWhere!]
|
|
or - [VesselCraneFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
craneType - StringWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
noOutreach - NumberWhereValueExpression
|
|
capacity - NumberWhereValueExpression
|
|
radius - NumberWhereValueExpression
|
|
vessel - VesselFormQueryWhere
|
Example
{
"and": [VesselCraneFormQueryWhere],
"or": [VesselCraneFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"craneType": StringWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"noOutreach": NumberWhereValueExpression,
"capacity": NumberWhereValueExpression,
"radius": NumberWhereValueExpression,
"vessel": VesselFormQueryWhere
}
VesselCraneRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
Example
{"vessel": RelationshipDefinition}
VesselDetails
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
freshWater - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
constantsSea - Float
|
|
constantsOther - Float
|
|
constantsLakes - Float
|
|
managerShortName - String
|
|
vesselCode - String
|
|
formerName - String
|
|
classSocietyCode - String
|
|
builder - String
|
|
buildDet - String
|
|
registry - String
|
|
vesselOwnerNew - String
|
|
disponentOwner - String
|
|
cargoGear - String
|
|
containerCost - Float
|
|
dwtDate - Date
|
|
lastDryDock - Date
|
|
nextDryDock - Date
|
|
nextSurvey - Date
|
|
nextInspection - Date
|
|
lastPropPolished - Date
|
|
lastHullCleaned - Date
|
|
ownerShortName - String
|
|
tveExpires - Date
|
|
loadTimeHr - Float
|
|
loadMinLiquidPressure - Float
|
|
loadMinGasReturnM3Hr - Float
|
|
loadMaxGasPressure - Float
|
|
dischTimeHr - Float
|
|
dischMaxLiquidPressure - Float
|
|
dischMinGasReturnM3Hr - Float
|
|
dischMinGasPressure - Float
|
|
managerCompanyNo - Int
|
|
hullNumber - String
|
|
yard - String
|
|
poolPointType - String
|
|
scrubbersActive - Date
|
|
managerCompany - AddressBook
|
|
vessel - Vessel
|
|
ownerAddressBook - AddressBook
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"freshWater": 123.45,
"customFieldByID": Any,
"customField": Any,
"constantsSea": 123.45,
"constantsOther": 123.45,
"constantsLakes": 123.45,
"managerShortName": "abc123",
"vesselCode": "xyz789",
"formerName": "abc123",
"classSocietyCode": "abc123",
"builder": "xyz789",
"buildDet": "abc123",
"registry": "abc123",
"vesselOwnerNew": "xyz789",
"disponentOwner": "xyz789",
"cargoGear": "xyz789",
"containerCost": 987.65,
"dwtDate": "2007-12-03",
"lastDryDock": "2007-12-03",
"nextDryDock": "2007-12-03",
"nextSurvey": "2007-12-03",
"nextInspection": "2007-12-03",
"lastPropPolished": "2007-12-03",
"lastHullCleaned": "2007-12-03",
"ownerShortName": "abc123",
"tveExpires": "2007-12-03",
"loadTimeHr": 123.45,
"loadMinLiquidPressure": 123.45,
"loadMinGasReturnM3Hr": 123.45,
"loadMaxGasPressure": 987.65,
"dischTimeHr": 987.65,
"dischMaxLiquidPressure": 123.45,
"dischMinGasReturnM3Hr": 123.45,
"dischMinGasPressure": 987.65,
"managerCompanyNo": 123,
"hullNumber": "abc123",
"yard": "abc123",
"poolPointType": "xyz789",
"scrubbersActive": "2007-12-03",
"managerCompany": AddressBook,
"vessel": Vessel,
"ownerAddressBook": AddressBook,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VesselDetailsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselDetailsFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselDetailsFormQueryWhere
}
VesselDetailsFormQueryWhere
Fields
Example
{
"and": [VesselDetailsFormQueryWhere],
"or": [VesselDetailsFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"formerName": StringWhereValueExpression,
"classSocietyCode": StringWhereValueExpression,
"builder": StringWhereValueExpression,
"buildDet": StringWhereValueExpression,
"registry": StringWhereValueExpression,
"vesselOwnerNew": StringWhereValueExpression,
"disponentOwner": StringWhereValueExpression,
"cargoGear": StringWhereValueExpression,
"containerCost": NumberWhereValueExpression,
"dwtDate": DateWhereValueExpression,
"lastDryDock": DateWhereValueExpression,
"nextDryDock": DateWhereValueExpression,
"nextSurvey": DateWhereValueExpression,
"nextInspection": DateWhereValueExpression,
"lastPropPolished": DateWhereValueExpression,
"lastHullCleaned": DateWhereValueExpression,
"ownerShortName": StringWhereValueExpression,
"tveExpires": DateWhereValueExpression,
"loadTimeHr": NumberWhereValueExpression,
"loadMinLiquidPressure": NumberWhereValueExpression,
"loadMinGasReturnM3Hr": NumberWhereValueExpression,
"loadMaxGasPressure": NumberWhereValueExpression,
"dischTimeHr": NumberWhereValueExpression,
"dischMaxLiquidPressure": NumberWhereValueExpression,
"dischMinGasReturnM3Hr": NumberWhereValueExpression,
"dischMinGasPressure": NumberWhereValueExpression,
"managerCompanyNo": NumberWhereValueExpression,
"hullNumber": StringWhereValueExpression,
"yard": StringWhereValueExpression,
"poolPointType": StringWhereValueExpression,
"scrubbersActive": DateWhereValueExpression,
"managerCompany": AddressBookFormQueryWhere,
"vessel": VesselFormQueryWhere,
"ownerAddressBook": AddressBookFormQueryWhere
}
VesselDetailsRelationships
Fields
| Field Name | Description |
|---|---|
managerCompany - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
vesselVariables - RelationshipDefinition
|
|
ownerAddressBook - RelationshipDefinition
|
Example
{
"managerCompany": RelationshipDefinition,
"vessel": RelationshipDefinition,
"vesselVariables": RelationshipDefinition,
"ownerAddressBook": RelationshipDefinition
}
VesselDraft
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
draft - Float
|
|
dwt - Float
|
|
displacement - Float
|
|
tpc - Float
|
|
remarks - String
|
|
vessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"draft": 123.45,
"dwt": 123.45,
"displacement": 123.45,
"tpc": 987.65,
"remarks": "abc123",
"vessel": Vessel,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
VesselDraftFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselDraftFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselDraftFormQueryWhere
}
VesselDraftFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesselDraftFormQueryWhere!]
|
|
or - [VesselDraftFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
draft - NumberWhereValueExpression
|
|
dwt - NumberWhereValueExpression
|
|
displacement - NumberWhereValueExpression
|
|
tpc - NumberWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
vessel - VesselFormQueryWhere
|
Example
{
"and": [VesselDraftFormQueryWhere],
"or": [VesselDraftFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"draft": NumberWhereValueExpression,
"dwt": NumberWhereValueExpression,
"displacement": NumberWhereValueExpression,
"tpc": NumberWhereValueExpression,
"remarks": StringWhereValueExpression,
"vessel": VesselFormQueryWhere
}
VesselDraftMarks
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
tropicalFWDraft - Float
|
|
tropicalFWDwt - Float
|
|
tropicalFWDisplacement - Float
|
|
tropicalFWFreeBoard - Float
|
|
tropicalFWTpc - Float
|
|
fWDraft - Float
|
|
fWDwt - Float
|
|
fWDisplacement - Float
|
|
fWFreeBoard - Float
|
|
fWTpc - Float
|
|
designDraft - Float
|
|
designDwt - Float
|
|
designDisplacement - Float
|
|
designFreeBoard - Float
|
|
designTpc - Float
|
|
summerDraft - Float
|
|
summerDwt - Float
|
|
summerDisplacement - Float
|
|
summerFreeBoard - Float
|
|
summerTpc - Float
|
|
winterDraft - Float
|
|
winterDwt - Float
|
|
winterDisplacement - Float
|
|
winterFreeBoard - Float
|
|
winterTpc - Float
|
|
normalDraft - Float
|
|
normalDwt - Float
|
|
normalDisplacement - Float
|
|
normalFreeBoard - Float
|
|
normalTpc - Float
|
|
lightshipDraft - Float
|
|
lightshipDwt - Float
|
|
lightshipDisplacement - Float
|
|
lightshipFreeBoard - Float
|
|
lightshipTpc - Float
|
|
freshWaterAllowance - Float
|
|
tropicalSWDraft - Float
|
|
tropicalSWDwt - Float
|
|
tropicalSWDisplacement - Float
|
|
tropicalSWFreeBoard - Float
|
|
tropicalSWTpc - Float
|
|
vessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"tropicalFWDraft": 123.45,
"tropicalFWDwt": 123.45,
"tropicalFWDisplacement": 987.65,
"tropicalFWFreeBoard": 123.45,
"tropicalFWTpc": 987.65,
"fWDraft": 123.45,
"fWDwt": 123.45,
"fWDisplacement": 987.65,
"fWFreeBoard": 123.45,
"fWTpc": 987.65,
"designDraft": 987.65,
"designDwt": 123.45,
"designDisplacement": 123.45,
"designFreeBoard": 987.65,
"designTpc": 123.45,
"summerDraft": 987.65,
"summerDwt": 987.65,
"summerDisplacement": 987.65,
"summerFreeBoard": 123.45,
"summerTpc": 987.65,
"winterDraft": 987.65,
"winterDwt": 987.65,
"winterDisplacement": 123.45,
"winterFreeBoard": 123.45,
"winterTpc": 987.65,
"normalDraft": 123.45,
"normalDwt": 987.65,
"normalDisplacement": 123.45,
"normalFreeBoard": 987.65,
"normalTpc": 123.45,
"lightshipDraft": 123.45,
"lightshipDwt": 123.45,
"lightshipDisplacement": 987.65,
"lightshipFreeBoard": 987.65,
"lightshipTpc": 987.65,
"freshWaterAllowance": 987.65,
"tropicalSWDraft": 987.65,
"tropicalSWDwt": 123.45,
"tropicalSWDisplacement": 987.65,
"tropicalSWFreeBoard": 123.45,
"tropicalSWTpc": 123.45,
"vessel": Vessel,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
VesselDraftMarksFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselDraftMarksFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselDraftMarksFormQueryWhere
}
VesselDraftMarksFormQueryWhere
Fields
Example
{
"and": [VesselDraftMarksFormQueryWhere],
"or": [VesselDraftMarksFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"tropicalFWDraft": NumberWhereValueExpression,
"tropicalFWDwt": NumberWhereValueExpression,
"tropicalFWDisplacement": NumberWhereValueExpression,
"tropicalFWFreeBoard": NumberWhereValueExpression,
"tropicalFWTpc": NumberWhereValueExpression,
"fWDraft": NumberWhereValueExpression,
"fWDwt": NumberWhereValueExpression,
"fWDisplacement": NumberWhereValueExpression,
"fWFreeBoard": NumberWhereValueExpression,
"fWTpc": NumberWhereValueExpression,
"designDraft": NumberWhereValueExpression,
"designDwt": NumberWhereValueExpression,
"designDisplacement": NumberWhereValueExpression,
"designFreeBoard": NumberWhereValueExpression,
"designTpc": NumberWhereValueExpression,
"summerDraft": NumberWhereValueExpression,
"summerDwt": NumberWhereValueExpression,
"summerDisplacement": NumberWhereValueExpression,
"summerFreeBoard": NumberWhereValueExpression,
"summerTpc": NumberWhereValueExpression,
"winterDraft": NumberWhereValueExpression,
"winterDwt": NumberWhereValueExpression,
"winterDisplacement": NumberWhereValueExpression,
"winterFreeBoard": NumberWhereValueExpression,
"winterTpc": NumberWhereValueExpression,
"normalDraft": NumberWhereValueExpression,
"normalDwt": NumberWhereValueExpression,
"normalDisplacement": NumberWhereValueExpression,
"normalFreeBoard": NumberWhereValueExpression,
"normalTpc": NumberWhereValueExpression,
"lightshipDraft": NumberWhereValueExpression,
"lightshipDwt": NumberWhereValueExpression,
"lightshipDisplacement": NumberWhereValueExpression,
"lightshipFreeBoard": NumberWhereValueExpression,
"lightshipTpc": NumberWhereValueExpression,
"freshWaterAllowance": NumberWhereValueExpression,
"tropicalSWDraft": NumberWhereValueExpression,
"tropicalSWDwt": NumberWhereValueExpression,
"tropicalSWDisplacement": NumberWhereValueExpression,
"tropicalSWFreeBoard": NumberWhereValueExpression,
"tropicalSWTpc": NumberWhereValueExpression,
"vessel": VesselFormQueryWhere
}
VesselDraftMarksRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
Example
{"vessel": RelationshipDefinition}
VesselDraftRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
Example
{"vessel": RelationshipDefinition}
VesselEngineTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NotSpecified"
VesselEngineTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VesselEngineTypeEnum
|
|
isNot - VesselEngineTypeEnum
|
|
isIn - [VesselEngineTypeEnum]
|
Example
{"is": "NotSpecified", "isNot": "NotSpecified", "isIn": ["NotSpecified"]}
VesselEvaluation
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
imoNo - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seqNo - Int
|
|
ordNo - Int
|
|
inspectionDate - Date
|
|
statutoryPercent - Float
|
|
recommendedPercent - Float
|
|
desirablePercent - Float
|
|
totalQuestions - Int
|
|
totalNegativeQuestions - Int
|
|
totalNAQuestions - Int
|
|
rating - Int
|
|
approvedToDate - Date
|
|
tSEval - String
|
|
gasEval - String
|
|
prohibit - String
|
|
remarks - String
|
|
entryDateGmt - Date
|
|
createdByUser - String
|
|
evaluationDateGmt - Date
|
|
source - String
|
|
environmentRating - String
|
|
externalRef - String
|
|
environmentRatingVerification - String
|
|
dOCSubscore - Int
|
|
vessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"imoNo": "abc123",
"customFieldByID": Any,
"customField": Any,
"seqNo": 987,
"ordNo": 123,
"inspectionDate": "2007-12-03",
"statutoryPercent": 987.65,
"recommendedPercent": 987.65,
"desirablePercent": 987.65,
"totalQuestions": 987,
"totalNegativeQuestions": 987,
"totalNAQuestions": 123,
"rating": 123,
"approvedToDate": "2007-12-03",
"tSEval": "abc123",
"gasEval": "abc123",
"prohibit": "xyz789",
"remarks": "xyz789",
"entryDateGmt": "2007-12-03",
"createdByUser": "xyz789",
"evaluationDateGmt": "2007-12-03",
"source": "abc123",
"environmentRating": "xyz789",
"externalRef": "xyz789",
"environmentRatingVerification": "abc123",
"dOCSubscore": 123,
"vessel": Vessel,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
VesselEvaluationEnvironmentRatingVerificationEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NA"
VesselEvaluationEnvironmentRatingVerificationEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VesselEvaluationEnvironmentRatingVerificationEnum
|
|
isNot - VesselEvaluationEnvironmentRatingVerificationEnum
|
|
isIn - [VesselEvaluationEnvironmentRatingVerificationEnum]
|
Example
{"is": "NA", "isNot": "NA", "isIn": ["NA"]}
VesselEvaluationFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselEvaluationFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselEvaluationFormQueryWhere
}
VesselEvaluationFormQueryWhere
Fields
Example
{
"and": [VesselEvaluationFormQueryWhere],
"or": [VesselEvaluationFormQueryWhere],
"rawExpression": "abc123",
"imoNo": StringWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"ordNo": NumberWhereValueExpression,
"inspectionDate": DateWhereValueExpression,
"statutoryPercent": NumberWhereValueExpression,
"recommendedPercent": NumberWhereValueExpression,
"desirablePercent": NumberWhereValueExpression,
"totalQuestions": NumberWhereValueExpression,
"totalNegativeQuestions": NumberWhereValueExpression,
"totalNAQuestions": NumberWhereValueExpression,
"rating": NumberWhereValueExpression,
"approvedToDate": DateWhereValueExpression,
"tSEval": VesselEvaluationTSEvalEnumValueExpression,
"gasEval": VesselEvaluationGasEvalEnumValueExpression,
"prohibit": VesselEvaluationProhibitEnumValueExpression,
"remarks": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"createdByUser": StringWhereValueExpression,
"evaluationDateGmt": DateWhereValueExpression,
"source": StringWhereValueExpression,
"environmentRating": StringWhereValueExpression,
"externalRef": StringWhereValueExpression,
"environmentRatingVerification": VesselEvaluationEnvironmentRatingVerificationEnumValueExpression,
"dOCSubscore": NumberWhereValueExpression,
"vessel": VesselFormQueryWhere
}
VesselEvaluationGasEvalEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"None"
VesselEvaluationGasEvalEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VesselEvaluationGasEvalEnum
|
|
isNot - VesselEvaluationGasEvalEnum
|
|
isIn - [VesselEvaluationGasEvalEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VesselEvaluationProhibitEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"None"
VesselEvaluationProhibitEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VesselEvaluationProhibitEnum
|
|
isNot - VesselEvaluationProhibitEnum
|
|
isIn - [VesselEvaluationProhibitEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VesselEvaluationRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
Example
{"vessel": RelationshipDefinition}
VesselEvaluationTSEvalEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"None"
VesselEvaluationTSEvalEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VesselEvaluationTSEvalEnum
|
|
isNot - VesselEvaluationTSEvalEnum
|
|
isIn - [VesselEvaluationTSEvalEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VesselFleetMember
Fields
| Field Name | Description |
|---|---|
vesselCode - String
|
|
fleetName - String
|
|
vessel - Vessel
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"vesselCode": "abc123",
"fleetName": "xyz789",
"vessel": Vessel,
"_id": "abc123",
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
VesselFleetMemberFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselFleetMemberFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselFleetMemberFormQueryWhere
}
VesselFleetMemberFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesselFleetMemberFormQueryWhere!]
|
|
or - [VesselFleetMemberFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
fleetName - StringWhereValueExpression
|
|
vessel - VesselFormQueryWhere
|
Example
{
"and": [VesselFleetMemberFormQueryWhere],
"or": [VesselFleetMemberFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"fleetName": StringWhereValueExpression,
"vessel": VesselFormQueryWhere
}
VesselFleetMemberFull
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
fleetName - String
|
|
fleet - VesselType
|
|
vessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"fleetName": "xyz789",
"fleet": VesselType,
"vessel": Vessel,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
VesselFleetMemberFullFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselFleetMemberFullFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselFleetMemberFullFormQueryWhere
}
VesselFleetMemberFullFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesselFleetMemberFullFormQueryWhere!]
|
|
or - [VesselFleetMemberFullFormQueryWhere!]
|
|
rawExpression - String
|
|
fleet - VesselTypeFormQueryWhere
|
|
vessel - VesselFormQueryWhere
|
Example
{
"and": [VesselFleetMemberFullFormQueryWhere],
"or": [VesselFleetMemberFullFormQueryWhere],
"rawExpression": "xyz789",
"fleet": VesselTypeFormQueryWhere,
"vessel": VesselFormQueryWhere
}
VesselFleetMemberFullRelationships
Fields
| Field Name | Description |
|---|---|
fleet - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
Example
{
"fleet": RelationshipDefinition,
"vessel": RelationshipDefinition
}
VesselFleetMemberRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
Example
{"vessel": RelationshipDefinition}
VesselFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselFormQueryWhere
}
VesselFormQueryWhere
Fields
Example
{
"and": [VesselFormQueryWhere],
"or": [VesselFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"name": StringWhereValueExpression,
"vesselType": StringWhereValueExpression,
"suezType": StringWhereValueExpression,
"fleet": StringWhereValueExpression,
"flag": StringWhereValueExpression,
"unitTypeCode": StringWhereValueExpression,
"ownership": VesselOwnershipEnumValueExpression,
"callLetters": StringWhereValueExpression,
"operator": StringWhereValueExpression,
"lOA": NumberWhereValueExpression,
"beam": NumberWhereValueExpression,
"depth": NumberWhereValueExpression,
"dailyCost": NumberWhereValueExpression,
"opa90": NumberWhereValueExpression,
"dWT": NumberWhereValueExpression,
"capacity": NumberWhereValueExpression,
"totalBBLs": NumberWhereValueExpression,
"vesselSummerDraft": NumberWhereValueExpression,
"vesselWinterDraft": NumberWhereValueExpression,
"maxDraft": NumberWhereValueExpression,
"tPC": NumberWhereValueExpression,
"gRT": NumberWhereValueExpression,
"nRT": NumberWhereValueExpression,
"panamaGross": NumberWhereValueExpression,
"panamaNet": NumberWhereValueExpression,
"suezGross": NumberWhereValueExpression,
"suezNet": NumberWhereValueExpression,
"ladenSpeed": NumberWhereValueExpression,
"ballastSpeed": NumberWhereValueExpression,
"tradeArea": StringWhereValueExpression,
"foeConversionFactorInverted": NumberWhereValueExpression,
"maxAirDraft": NumberWhereValueExpression,
"telex": StringWhereValueExpression,
"fax": StringWhereValueExpression,
"imoNo": StringWhereValueExpression,
"phone": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"allowUpdate": NumberWhereValueExpression,
"hullType": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"yearBuilt": NumberWhereValueExpression,
"isBargeUnit": NumberWhereValueExpression,
"vapor": BoolWhereValueExpression,
"igs": BoolWhereValueExpression,
"nonActive": BoolWhereValueExpression,
"allowDespatch": BoolWhereValueExpression,
"trackInlandBunkers": BoolWhereValueExpression,
"estOnly": BoolWhereValueExpression,
"co2Fitted": BoolWhereValueExpression,
"bowThruster": BoolWhereValueExpression,
"strengthened": BoolWhereValueExpression,
"australianLadders": BoolWhereValueExpression,
"toledoSuitable": BoolWhereValueExpression,
"tveValid": BoolWhereValueExpression,
"rejected": BoolWhereValueExpression,
"logFitted": BoolWhereValueExpression,
"grainFitted": BoolWhereValueExpression,
"commercialMgmt": BoolWhereValueExpression,
"etaExcluded": BoolWhereValueExpression,
"a60Fitted": BoolWhereValueExpression,
"offshoreBarge": BoolWhereValueExpression,
"useBoilOffMinCons": BoolWhereValueExpression,
"useScrubbers": BoolWhereValueExpression,
"isCommonlyUsed": BoolWhereValueExpression,
"isUnitTow": BoolWhereValueExpression,
"activeForOnboard": BoolWhereValueExpression,
"isGeneralCargo": BoolWhereValueExpression,
"equipmentFlags": NumberWhereValueExpression,
"email": StringWhereValueExpression,
"refNo": StringWhereValueExpression,
"satC": StringWhereValueExpression,
"ventilation": StringWhereValueExpression,
"iceClass": StringWhereValueExpression,
"grabsQty": NumberWhereValueExpression,
"grabsCap": NumberWhereValueExpression,
"engineMake": StringWhereValueExpression,
"holdStrengthened": StringWhereValueExpression,
"inheritRouteFromVessel": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"officialNo": StringWhereValueExpression,
"pnsNo": StringWhereValueExpression,
"hatchType": StringWhereValueExpression,
"hAndMValue": StringWhereValueExpression,
"pAndIClub": StringWhereValueExpression,
"gapValue": StringWhereValueExpression,
"maxBallastDailyBoilOffPct": NumberWhereValueExpression,
"maxLadenDailyBoilOffPct": NumberWhereValueExpression,
"demAnalyst": StringWhereValueExpression,
"satA": StringWhereValueExpression,
"satB": StringWhereValueExpression,
"miniM": StringWhereValueExpression,
"masterPhone": StringWhereValueExpression,
"bridgePhone": StringWhereValueExpression,
"ccrNo": StringWhereValueExpression,
"chtrCoordinator": StringWhereValueExpression,
"opsCoordinator": StringWhereValueExpression,
"beaufortNo": NumberWhereValueExpression,
"seaStateNo": NumberWhereValueExpression,
"seaSwellNo": NumberWhereValueExpression,
"alerts": StringWhereValueExpression,
"dailyAdminFee": NumberWhereValueExpression,
"adminFeeCurr": StringWhereValueExpression,
"vesselTypeCorrelation": NumberWhereValueExpression,
"crossRefNo": StringWhereValueExpression,
"replicationFlags": NumberWhereValueExpression,
"veslinkCompany": StringWhereValueExpression,
"unitFactor": NumberWhereValueExpression,
"fuelZoneSetID": NumberWhereValueExpression,
"vesselTypeAdjustment": NumberWhereValueExpression,
"naturalBoilOffBallastSpeed": NumberWhereValueExpression,
"naturalBoilOffLadenSpeed": NumberWhereValueExpression,
"bunkerConfigVersion": NumberWhereValueExpression,
"companyCode": StringWhereValueExpression,
"scrubberType": VesselScrubberTypeEnumValueExpression,
"vettingRemarks": StringWhereValueExpression,
"iceClassType": VesselIceClassTypeEnumValueExpression,
"engineType": VesselEngineTypeEnumValueExpression,
"fuelZoneSet": FuelZoneSetFormQueryWhere,
"vesselDetails": VesselDetailsFormQueryWhere,
"ownerAddressBook": AddressBookFormQueryWhere,
"vesselTypeData": VesselTypeFormQueryWhere,
"barge": BargeFormQueryWhere
}
VesselHatch
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
hatchNo - Int
|
|
hatchLengthM - Float
|
|
hatchWidthM - Float
|
|
hatchWaterline - Float
|
|
hatchMaxWt - Float
|
|
craneCap - Float
|
|
derrickCap - Float
|
|
cementholes - Float
|
|
dimension - Float
|
|
vessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"hatchNo": 123,
"hatchLengthM": 123.45,
"hatchWidthM": 987.65,
"hatchWaterline": 987.65,
"hatchMaxWt": 987.65,
"craneCap": 123.45,
"derrickCap": 987.65,
"cementholes": 987.65,
"dimension": 987.65,
"vessel": Vessel,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
VesselHatchFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselHatchFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselHatchFormQueryWhere
}
VesselHatchFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesselHatchFormQueryWhere!]
|
|
or - [VesselHatchFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
hatchNo - NumberWhereValueExpression
|
|
hatchLengthM - NumberWhereValueExpression
|
|
hatchWidthM - NumberWhereValueExpression
|
|
hatchWaterline - NumberWhereValueExpression
|
|
hatchMaxWt - NumberWhereValueExpression
|
|
craneCap - NumberWhereValueExpression
|
|
derrickCap - NumberWhereValueExpression
|
|
cementholes - NumberWhereValueExpression
|
|
dimension - NumberWhereValueExpression
|
|
vessel - VesselFormQueryWhere
|
Example
{
"and": [VesselHatchFormQueryWhere],
"or": [VesselHatchFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"hatchNo": NumberWhereValueExpression,
"hatchLengthM": NumberWhereValueExpression,
"hatchWidthM": NumberWhereValueExpression,
"hatchWaterline": NumberWhereValueExpression,
"hatchMaxWt": NumberWhereValueExpression,
"craneCap": NumberWhereValueExpression,
"derrickCap": NumberWhereValueExpression,
"cementholes": NumberWhereValueExpression,
"dimension": NumberWhereValueExpression,
"vessel": VesselFormQueryWhere
}
VesselHatchRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
Example
{"vessel": RelationshipDefinition}
VesselHold
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
holdNo - Int
|
|
grainFt3 - Float
|
|
baleFt3 - Float
|
|
holdLength - Float
|
|
holdWidthFwd - Float
|
|
holdWidthAft - Float
|
|
wTTanktop - Float
|
|
wTHold - Float
|
|
ballastHold - String
|
|
vessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"holdNo": 987,
"grainFt3": 987.65,
"baleFt3": 987.65,
"holdLength": 123.45,
"holdWidthFwd": 123.45,
"holdWidthAft": 987.65,
"wTTanktop": 123.45,
"wTHold": 987.65,
"ballastHold": "xyz789",
"vessel": Vessel,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
VesselHoldFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselHoldFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselHoldFormQueryWhere
}
VesselHoldFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesselHoldFormQueryWhere!]
|
|
or - [VesselHoldFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
holdNo - NumberWhereValueExpression
|
|
grainFt3 - NumberWhereValueExpression
|
|
baleFt3 - NumberWhereValueExpression
|
|
holdLength - NumberWhereValueExpression
|
|
holdWidthFwd - NumberWhereValueExpression
|
|
holdWidthAft - NumberWhereValueExpression
|
|
wTTanktop - NumberWhereValueExpression
|
|
wTHold - NumberWhereValueExpression
|
|
ballastHold - StringWhereValueExpression
|
|
vessel - VesselFormQueryWhere
|
Example
{
"and": [VesselHoldFormQueryWhere],
"or": [VesselHoldFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"holdNo": NumberWhereValueExpression,
"grainFt3": NumberWhereValueExpression,
"baleFt3": NumberWhereValueExpression,
"holdLength": NumberWhereValueExpression,
"holdWidthFwd": NumberWhereValueExpression,
"holdWidthAft": NumberWhereValueExpression,
"wTTanktop": NumberWhereValueExpression,
"wTHold": NumberWhereValueExpression,
"ballastHold": StringWhereValueExpression,
"vessel": VesselFormQueryWhere
}
VesselHoldRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
Example
{"vessel": RelationshipDefinition}
VesselIceClassTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NotIceClass"
VesselIceClassTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VesselIceClassTypeEnum
|
|
isNot - VesselIceClassTypeEnum
|
|
isIn - [VesselIceClassTypeEnum]
|
Example
{"is": "NotIceClass", "isNot": "NotIceClass", "isIn": ["NotIceClass"]}
VesselIncident
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
typeCode - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
typeName - String
|
|
typeDescription - String
|
|
imoNo - String
|
|
seqNo - Int
|
|
ordNo - Int
|
|
action - String
|
|
details - String
|
|
infoSource - String
|
|
remarks - String
|
|
entryDateGmt - Date
|
|
createdByUser - String
|
|
incidentDateGmt - Date
|
|
vessel - Vessel
|
|
incidentType - Term
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"typeCode": 123,
"customFieldByID": Any,
"customField": Any,
"typeName": "xyz789",
"typeDescription": "xyz789",
"imoNo": "xyz789",
"seqNo": 123,
"ordNo": 987,
"action": "abc123",
"details": "xyz789",
"infoSource": "abc123",
"remarks": "xyz789",
"entryDateGmt": "2007-12-03",
"createdByUser": "xyz789",
"incidentDateGmt": "2007-12-03",
"vessel": Vessel,
"incidentType": Term,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
VesselIncidentActionEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NotApplicable"
VesselIncidentActionEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VesselIncidentActionEnum
|
|
isNot - VesselIncidentActionEnum
|
|
isIn - [VesselIncidentActionEnum]
|
Example
{"is": "NotApplicable", "isNot": "NotApplicable", "isIn": ["NotApplicable"]}
VesselIncidentFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselIncidentFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselIncidentFormQueryWhere
}
VesselIncidentFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesselIncidentFormQueryWhere!]
|
|
or - [VesselIncidentFormQueryWhere!]
|
|
rawExpression - String
|
|
typeCode - NumberWhereValueExpression
|
|
imoNo - StringWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
ordNo - NumberWhereValueExpression
|
|
action - VesselIncidentActionEnumValueExpression
|
|
details - StringWhereValueExpression
|
|
infoSource - StringWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
createdByUser - StringWhereValueExpression
|
|
incidentDateGmt - DateWhereValueExpression
|
|
vessel - VesselFormQueryWhere
|
|
incidentType - TermFormQueryWhere
|
Example
{
"and": [VesselIncidentFormQueryWhere],
"or": [VesselIncidentFormQueryWhere],
"rawExpression": "xyz789",
"typeCode": NumberWhereValueExpression,
"imoNo": StringWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"ordNo": NumberWhereValueExpression,
"action": VesselIncidentActionEnumValueExpression,
"details": StringWhereValueExpression,
"infoSource": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"createdByUser": StringWhereValueExpression,
"incidentDateGmt": DateWhereValueExpression,
"vessel": VesselFormQueryWhere,
"incidentType": TermFormQueryWhere
}
VesselIncidentRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
|
incidentType - RelationshipDefinition
|
Example
{
"vessel": RelationshipDefinition,
"incidentType": RelationshipDefinition
}
VesselInspection
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
imoNo - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seqNo - Int
|
|
ordNo - Int
|
|
inspectionDate - Date
|
|
inspectionUser - String
|
|
status - String
|
|
externalParty - String
|
|
vessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"imoNo": "xyz789",
"customFieldByID": Any,
"customField": Any,
"seqNo": 987,
"ordNo": 123,
"inspectionDate": "2007-12-03",
"inspectionUser": "xyz789",
"status": "xyz789",
"externalParty": "xyz789",
"vessel": Vessel,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
VesselInspectionFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselInspectionFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselInspectionFormQueryWhere
}
VesselInspectionFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesselInspectionFormQueryWhere!]
|
|
or - [VesselInspectionFormQueryWhere!]
|
|
rawExpression - String
|
|
imoNo - StringWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
ordNo - NumberWhereValueExpression
|
|
inspectionDate - DateWhereValueExpression
|
|
inspectionUser - StringWhereValueExpression
|
|
status - VesselInspectionStatusEnumValueExpression
|
|
externalParty - StringWhereValueExpression
|
|
vessel - VesselFormQueryWhere
|
Example
{
"and": [VesselInspectionFormQueryWhere],
"or": [VesselInspectionFormQueryWhere],
"rawExpression": "abc123",
"imoNo": StringWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"ordNo": NumberWhereValueExpression,
"inspectionDate": DateWhereValueExpression,
"inspectionUser": StringWhereValueExpression,
"status": VesselInspectionStatusEnumValueExpression,
"externalParty": StringWhereValueExpression,
"vessel": VesselFormQueryWhere
}
VesselInspectionRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
Example
{"vessel": RelationshipDefinition}
VesselInspectionStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"None"
VesselInspectionStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VesselInspectionStatusEnum
|
|
isNot - VesselInspectionStatusEnum
|
|
isIn - [VesselInspectionStatusEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VesselOwnershipEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
VesselOwnershipEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VesselOwnershipEnum
|
|
isNot - VesselOwnershipEnum
|
|
isIn - [VesselOwnershipEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VesselPortCons
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
gradeSulfur - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
gradeDataCenter - String
|
|
isFoe - String
|
|
vesselCode - String
|
|
index - Int
|
|
lineNo - Int
|
|
fuelType - String
|
|
loadFuel - Float
|
|
dischargeFuel - Float
|
|
idle - Float
|
|
hotel - Float
|
|
heat - Float
|
|
clean - Float
|
|
margin - Float
|
|
capacity - Float
|
|
unit - String
|
|
isFuelGradeHighSulfur - Boolean
|
|
isFuelGradeLowSulfur - Boolean
|
|
isFuelAsFoe - Boolean
|
|
isFuelInactive - Boolean
|
|
heatPlus - Float
|
|
auxiliary - Float
|
|
maneuver - Float
|
|
igs - Float
|
|
cool - Float
|
|
coolPlus - Float
|
|
heatPlusPlus - Float
|
|
gradeCode - Int
|
|
boiler - Float
|
|
incinerator - Float
|
|
bunkerConfigVersion - Int
|
|
units - UnitOfMeasure
|
|
fuel - FuelLubeType
|
|
vessel - Vessel
|
|
gradeDataCenterTerm - Term
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"gradeSulfur": "xyz789",
"customFieldByID": Any,
"customField": Any,
"gradeDataCenter": "abc123",
"isFoe": "abc123",
"vesselCode": "xyz789",
"index": 987,
"lineNo": 123,
"fuelType": "abc123",
"loadFuel": 987.65,
"dischargeFuel": 987.65,
"idle": 987.65,
"hotel": 123.45,
"heat": 987.65,
"clean": 987.65,
"margin": 123.45,
"capacity": 123.45,
"unit": "abc123",
"isFuelGradeHighSulfur": false,
"isFuelGradeLowSulfur": true,
"isFuelAsFoe": true,
"isFuelInactive": false,
"heatPlus": 123.45,
"auxiliary": 987.65,
"maneuver": 123.45,
"igs": 987.65,
"cool": 123.45,
"coolPlus": 987.65,
"heatPlusPlus": 123.45,
"gradeCode": 987,
"boiler": 123.45,
"incinerator": 987.65,
"bunkerConfigVersion": 987,
"units": UnitOfMeasure,
"fuel": FuelLubeType,
"vessel": Vessel,
"gradeDataCenterTerm": Term,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
VesselPortConsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselPortConsFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselPortConsFormQueryWhere
}
VesselPortConsFormQueryWhere
Fields
Example
{
"and": [VesselPortConsFormQueryWhere],
"or": [VesselPortConsFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"index": NumberWhereValueExpression,
"lineNo": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"loadFuel": NumberWhereValueExpression,
"dischargeFuel": NumberWhereValueExpression,
"idle": NumberWhereValueExpression,
"hotel": NumberWhereValueExpression,
"heat": NumberWhereValueExpression,
"clean": NumberWhereValueExpression,
"margin": NumberWhereValueExpression,
"capacity": NumberWhereValueExpression,
"unit": StringWhereValueExpression,
"isFuelGradeHighSulfur": BoolWhereValueExpression,
"isFuelGradeLowSulfur": BoolWhereValueExpression,
"isFuelAsFoe": BoolWhereValueExpression,
"isFuelInactive": BoolWhereValueExpression,
"heatPlus": NumberWhereValueExpression,
"auxiliary": NumberWhereValueExpression,
"maneuver": NumberWhereValueExpression,
"igs": NumberWhereValueExpression,
"cool": NumberWhereValueExpression,
"coolPlus": NumberWhereValueExpression,
"heatPlusPlus": NumberWhereValueExpression,
"gradeCode": NumberWhereValueExpression,
"boiler": NumberWhereValueExpression,
"incinerator": NumberWhereValueExpression,
"bunkerConfigVersion": NumberWhereValueExpression,
"units": UnitOfMeasureFormQueryWhere,
"fuel": FuelLubeTypeFormQueryWhere,
"vessel": VesselFormQueryWhere,
"gradeDataCenterTerm": TermFormQueryWhere
}
VesselPortConsRelationships
Fields
| Field Name | Description |
|---|---|
units - RelationshipDefinition
|
|
fuel - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
gradeDataCenterTerm - RelationshipDefinition
|
Example
{
"units": RelationshipDefinition,
"fuel": RelationshipDefinition,
"vessel": RelationshipDefinition,
"gradeDataCenterTerm": RelationshipDefinition
}
VesselRelationships
Fields
Example
{
"fuelZoneSet": RelationshipDefinition,
"vesselDetails": RelationshipDefinition,
"ownerAddressBook": RelationshipDefinition,
"vesselTypeData": RelationshipDefinition,
"vesselVariables": RelationshipDefinition,
"barge": RelationshipDefinition,
"voyagePnls": RelationshipDefinition,
"vesselDraftMarks": RelationshipDefinition,
"vesselCranes": RelationshipDefinition,
"poolAssignments": RelationshipDefinition,
"vesselHolds": RelationshipDefinition,
"vesselTceTargets": RelationshipDefinition,
"vesselSeaConsBunkers": RelationshipDefinition,
"vesselSeaCons": RelationshipDefinition,
"vesselPortCons": RelationshipDefinition,
"vesselInspections": RelationshipDefinition,
"vesselIncidents": RelationshipDefinition,
"vesselHatchs": RelationshipDefinition,
"vesselEvaluations": RelationshipDefinition,
"vesselDrafts": RelationshipDefinition,
"vesselConsModes": RelationshipDefinition,
"vesselBunkerTanks": RelationshipDefinition,
"vesselBoats": RelationshipDefinition,
"vesselTanks": RelationshipDefinition,
"vesselFleetMember": RelationshipDefinition,
"vesselFleetMemberLegacy": RelationshipDefinition,
"vesselLast5CargoLoadings": RelationshipDefinition
}
VesselRootMutation
Fields
| Field Name | Description |
|---|---|
updateFleetMembers - Boolean
|
|
Arguments
|
|
Example
{"updateFleetMembers": false}
VesselRootQuery
Fields
| Field Name | Description |
|---|---|
getVessels - [VesselService_Vessel]
|
|
Arguments
|
|
getVesselByPartialNameResults - [VesselService_Vessel]
|
|
Arguments |
|
getVesselTypeDefinitions - [VesselTypeDefinition]
|
|
Arguments
|
|
getHistoricalVesselPositions - [HistoricalVesselPosition]
|
|
Arguments |
|
Example
{
"getVessels": [VesselService_Vessel],
"getVesselByPartialNameResults": [VesselService_Vessel],
"getVesselTypeDefinitions": [VesselTypeDefinition],
"getHistoricalVesselPositions": [
HistoricalVesselPosition
]
}
VesselRoute
Fields
| Field Name | Description |
|---|---|
vesselCode - String
|
|
canalId - Int
|
|
ballastExpense - Float
|
|
ladenExpense - Float
|
|
portDays - Float
|
|
extraPortDays - Float
|
|
isBlock - Boolean
|
|
isHidden - Boolean
|
|
isNoTolls - Boolean
|
|
isLadenOnly - Boolean
|
|
isBallastOnly - Boolean
|
|
viaPointFunc - String
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"vesselCode": "xyz789",
"canalId": 123,
"ballastExpense": 987.65,
"ladenExpense": 123.45,
"portDays": 123.45,
"extraPortDays": 987.65,
"isBlock": false,
"isHidden": false,
"isNoTolls": false,
"isLadenOnly": false,
"isBallastOnly": true,
"viaPointFunc": "xyz789",
"_id": "xyz789",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
VesselRouteFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselRouteFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselRouteFormQueryWhere
}
VesselRouteFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesselRouteFormQueryWhere!]
|
|
or - [VesselRouteFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
canalId - NumberWhereValueExpression
|
|
ballastExpense - NumberWhereValueExpression
|
|
ladenExpense - NumberWhereValueExpression
|
|
portDays - NumberWhereValueExpression
|
|
extraPortDays - NumberWhereValueExpression
|
|
isBlock - BoolWhereValueExpression
|
|
isHidden - BoolWhereValueExpression
|
|
isNoTolls - BoolWhereValueExpression
|
|
isLadenOnly - BoolWhereValueExpression
|
|
isBallastOnly - BoolWhereValueExpression
|
|
viaPointFunc - StringWhereValueExpression
|
Example
{
"and": [VesselRouteFormQueryWhere],
"or": [VesselRouteFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"canalId": NumberWhereValueExpression,
"ballastExpense": NumberWhereValueExpression,
"ladenExpense": NumberWhereValueExpression,
"portDays": NumberWhereValueExpression,
"extraPortDays": NumberWhereValueExpression,
"isBlock": BoolWhereValueExpression,
"isHidden": BoolWhereValueExpression,
"isNoTolls": BoolWhereValueExpression,
"isLadenOnly": BoolWhereValueExpression,
"isBallastOnly": BoolWhereValueExpression,
"viaPointFunc": StringWhereValueExpression
}
VesselScrubberTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
VesselScrubberTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VesselScrubberTypeEnum
|
|
isNot - VesselScrubberTypeEnum
|
|
isIn - [VesselScrubberTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VesselSeaCons
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
speed - Float
|
|
isCpSpeed - Boolean
|
|
engineLoad - Float
|
|
type - String
|
|
description - String
|
|
bunkerConfigVersion - Int
|
|
vessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"speed": 123.45,
"isCpSpeed": false,
"engineLoad": 987.65,
"type": "abc123",
"description": "xyz789",
"bunkerConfigVersion": 123,
"vessel": Vessel,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VesselSeaConsBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
speed - Float
|
|
consumptionType - String
|
|
fuelType - String
|
|
laden - Float
|
|
ballast - Float
|
|
engineLoad - Float
|
|
description - String
|
|
vessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"speed": 123.45,
"consumptionType": "xyz789",
"fuelType": "xyz789",
"laden": 987.65,
"ballast": 123.45,
"engineLoad": 123.45,
"description": "abc123",
"vessel": Vessel,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
VesselSeaConsBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselSeaConsBunkerFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselSeaConsBunkerFormQueryWhere
}
VesselSeaConsBunkerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesselSeaConsBunkerFormQueryWhere!]
|
|
or - [VesselSeaConsBunkerFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
speed - NumberWhereValueExpression
|
|
consumptionType - StringWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
laden - NumberWhereValueExpression
|
|
ballast - NumberWhereValueExpression
|
|
engineLoad - NumberWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
vessel - VesselFormQueryWhere
|
Example
{
"and": [VesselSeaConsBunkerFormQueryWhere],
"or": [VesselSeaConsBunkerFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"speed": NumberWhereValueExpression,
"consumptionType": StringWhereValueExpression,
"fuelType": StringWhereValueExpression,
"laden": NumberWhereValueExpression,
"ballast": NumberWhereValueExpression,
"engineLoad": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"vessel": VesselFormQueryWhere
}
VesselSeaConsBunkerRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
Example
{"vessel": RelationshipDefinition}
VesselSeaConsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselSeaConsFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselSeaConsFormQueryWhere
}
VesselSeaConsFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesselSeaConsFormQueryWhere!]
|
|
or - [VesselSeaConsFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
speed - NumberWhereValueExpression
|
|
isCpSpeed - BoolWhereValueExpression
|
|
engineLoad - NumberWhereValueExpression
|
|
type - StringWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
bunkerConfigVersion - NumberWhereValueExpression
|
|
vessel - VesselFormQueryWhere
|
Example
{
"and": [VesselSeaConsFormQueryWhere],
"or": [VesselSeaConsFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"speed": NumberWhereValueExpression,
"isCpSpeed": BoolWhereValueExpression,
"engineLoad": NumberWhereValueExpression,
"type": StringWhereValueExpression,
"description": StringWhereValueExpression,
"bunkerConfigVersion": NumberWhereValueExpression,
"vessel": VesselFormQueryWhere
}
VesselSeaConsRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
Example
{"vessel": RelationshipDefinition}
VesselServiceImosAddressBook
Fields
| Field Name | Description |
|---|---|
countryCode - String
|
|
vATNo - String
|
|
typeDescr - String
|
|
inactive - Boolean
|
|
fullAddress - String
|
|
lastTransactionDate - Date
|
|
emailDomain - String
|
|
sqlID - Int
|
|
type - String
|
|
shortName - String
|
|
fullName - String
|
|
address1 - String
|
|
address2 - String
|
|
address3 - String
|
|
address4 - String
|
|
country - String
|
|
sDN - String
|
|
phone - String
|
|
faxSpd - String
|
|
fax - String
|
|
telex - String
|
|
webPage - String
|
|
crossRefNo - String
|
|
mainContact - String
|
|
curr - String
|
|
creditTerm - Int
|
|
creditLine - Float
|
|
lastUpdateGmt - Date
|
|
companyNo - Int
|
|
legacyInactive - String
|
|
lastUserID - String
|
|
parentCompanyNo - Int
|
|
email - String
|
|
refNo - String
|
|
veslinkID - String
|
|
veslinkCompanyType - String
|
|
paymentTermsCode - String
|
|
aPAccount - String
|
|
aRAccount - String
|
|
internal - Boolean
|
|
internalAddress - Boolean
|
|
marginingPaper - Boolean
|
|
marginingPhysical - Boolean
|
|
nettingPaper - Boolean
|
|
nettingPhysical - Boolean
|
|
preferred - Boolean
|
|
taxCodeRequired - Boolean
|
|
rejectAllVessles - Boolean
|
|
prohibitedParty - Boolean
|
|
ratingDate - Date
|
|
creditRating - String
|
|
demTBDays - Float
|
|
entryDateGmt - Date
|
|
updateTimes - Int
|
|
paymentCompanyNo - Int
|
|
alerts - String
|
|
iCAccount - String
|
|
lobCode - String
|
|
contractSubStatus - String
|
|
actDeptCode - String
|
|
referenceCode - String
|
|
defaultAccount - String
|
|
imoNumber - String
|
|
transshipmentDate - Date
|
|
prohibitedPartyDate - Date
|
|
pOInspDate - Date
|
|
parentCompanyData - VesselServiceImosAddressBook
|
|
paymentCompanyData - VesselServiceImosAddressBook
|
|
userDefinedFields - Json
|
Example
{
"countryCode": "abc123",
"vATNo": "xyz789",
"typeDescr": "xyz789",
"inactive": false,
"fullAddress": "abc123",
"lastTransactionDate": "2007-12-03",
"emailDomain": "abc123",
"sqlID": 987,
"type": "xyz789",
"shortName": "xyz789",
"fullName": "xyz789",
"address1": "abc123",
"address2": "abc123",
"address3": "abc123",
"address4": "abc123",
"country": "xyz789",
"sDN": "xyz789",
"phone": "abc123",
"faxSpd": "xyz789",
"fax": "xyz789",
"telex": "xyz789",
"webPage": "xyz789",
"crossRefNo": "abc123",
"mainContact": "xyz789",
"curr": "xyz789",
"creditTerm": 987,
"creditLine": 987.65,
"lastUpdateGmt": "2007-12-03",
"companyNo": 123,
"legacyInactive": "abc123",
"lastUserID": "abc123",
"parentCompanyNo": 123,
"email": "xyz789",
"refNo": "abc123",
"veslinkID": "abc123",
"veslinkCompanyType": "abc123",
"paymentTermsCode": "abc123",
"aPAccount": "abc123",
"aRAccount": "abc123",
"internal": true,
"internalAddress": false,
"marginingPaper": false,
"marginingPhysical": true,
"nettingPaper": false,
"nettingPhysical": false,
"preferred": false,
"taxCodeRequired": false,
"rejectAllVessles": true,
"prohibitedParty": true,
"ratingDate": "2007-12-03",
"creditRating": "abc123",
"demTBDays": 123.45,
"entryDateGmt": "2007-12-03",
"updateTimes": 987,
"paymentCompanyNo": 987,
"alerts": "xyz789",
"iCAccount": "abc123",
"lobCode": "abc123",
"contractSubStatus": "xyz789",
"actDeptCode": "xyz789",
"referenceCode": "xyz789",
"defaultAccount": "xyz789",
"imoNumber": "abc123",
"transshipmentDate": "2007-12-03",
"prohibitedPartyDate": "2007-12-03",
"pOInspDate": "2007-12-03",
"parentCompanyData": VesselServiceImosAddressBook,
"paymentCompanyData": VesselServiceImosAddressBook,
"userDefinedFields": Json
}
VesselServiceImosBarge
Fields
| Field Name | Description |
|---|---|
isTanker - Boolean
|
|
isBulker - Boolean
|
|
code - String
|
|
iD - String
|
|
name - String
|
|
type - String
|
|
hullType - String
|
|
hullArrangement - String
|
|
serviceArea - String
|
|
bargeNotes - String
|
|
ownership - String
|
|
yearBuilt - Int
|
|
vapor - Int
|
|
heat - Int
|
|
steam - Int
|
|
inactive - Boolean
|
|
tankerBulkType - String
|
|
vesselTypeCode - String
|
|
referenceNo - String
|
|
opaDate - Date
|
|
length - Float
|
|
width - Float
|
|
height - Float
|
|
towCapacity - Float
|
|
registeredTons - Float
|
|
calibratedBbls - Float
|
|
dailyCost - Float
|
|
ballastSpeed - Float
|
|
ladenSpeed - Float
|
|
power - Float
|
|
vetted - Int
|
|
vettedDate - Date
|
|
vesselType - String
|
|
fleet - String
|
|
heatConsumption - Float
|
|
vesselBoats - [VesselServiceImosVesselBoats]
|
Example
{
"isTanker": false,
"isBulker": true,
"code": "xyz789",
"iD": "xyz789",
"name": "abc123",
"type": "xyz789",
"hullType": "abc123",
"hullArrangement": "abc123",
"serviceArea": "xyz789",
"bargeNotes": "abc123",
"ownership": "abc123",
"yearBuilt": 987,
"vapor": 123,
"heat": 123,
"steam": 123,
"inactive": false,
"tankerBulkType": "abc123",
"vesselTypeCode": "abc123",
"referenceNo": "xyz789",
"opaDate": "2007-12-03",
"length": 987.65,
"width": 987.65,
"height": 123.45,
"towCapacity": 987.65,
"registeredTons": 987.65,
"calibratedBbls": 123.45,
"dailyCost": 123.45,
"ballastSpeed": 987.65,
"ladenSpeed": 987.65,
"power": 123.45,
"vetted": 987,
"vettedDate": "2007-12-03",
"vesselType": "abc123",
"fleet": "abc123",
"heatConsumption": 987.65,
"vesselBoats": [VesselServiceImosVesselBoats]
}
VesselServiceImosCargoName
Fields
| Field Name | Description |
|---|---|
capacityBasisString - String
|
|
cargoGroup - String
|
|
stowFactorFt3 - Float
|
|
isActive - Boolean
|
|
description - String
|
|
billBy - String
|
|
sqlID - Int
|
|
shortName - String
|
|
fullName - String
|
|
description1 - String
|
|
description2 - String
|
|
description3 - String
|
|
description4 - String
|
|
description5 - String
|
|
description6 - String
|
|
description7 - String
|
|
description8 - String
|
|
description9 - String
|
|
productCode - String
|
|
lastUpdateGmt - Date
|
|
api - Float
|
|
type - String
|
|
lastUserID - String
|
|
isDangerous - Boolean
|
|
isInactive - Boolean
|
|
isPreClearance - Boolean
|
|
isCapBasisGrain - Boolean
|
|
isCapBasisBale - Boolean
|
|
mTBE - Boolean
|
|
fAME - Boolean
|
|
eTBE - Boolean
|
|
isPersistent - Boolean
|
|
billByCPQty - Boolean
|
|
billByInvoiceQty - Boolean
|
|
billByOutturnQty - Boolean
|
|
isSpecialHandlingRequired - Boolean
|
|
imoName - String
|
|
unNum - String
|
|
unClass - String
|
|
bcCodeGroup - String
|
|
cpUnit - String
|
|
liftUnit - String
|
|
altLiftUnit - String
|
|
bcCode - String
|
|
onshoreProductUrl - String
|
|
onboardProductUrl - String
|
|
uSCGName - String
|
|
mARPOLCategory - String
|
|
imoShipType - String
|
|
sGTempBasisDegree - Float
|
|
sGTempCoefficient - Float
|
|
sGTempScale - String
|
|
meltingPoint - Float
|
|
meltingPointTempScale - String
|
|
boilingPoint - Float
|
|
boilingPointTempScale - String
|
|
imoClass - String
|
|
adnrEniClass - String
|
|
uSCGGrade - String
|
|
uSCGSubchapter - String
|
|
uSCGCargoName - String
|
|
cpUnitData - VesselServiceImosUnitOfMeasure
|
|
liftUnitData - VesselServiceImosUnitOfMeasure
|
|
altLiftUnitData - VesselServiceImosUnitOfMeasure
|
|
userDefinedFields - Json
|
Example
{
"capacityBasisString": "xyz789",
"cargoGroup": "abc123",
"stowFactorFt3": 987.65,
"isActive": false,
"description": "abc123",
"billBy": "abc123",
"sqlID": 123,
"shortName": "xyz789",
"fullName": "abc123",
"description1": "xyz789",
"description2": "abc123",
"description3": "xyz789",
"description4": "xyz789",
"description5": "abc123",
"description6": "xyz789",
"description7": "abc123",
"description8": "abc123",
"description9": "xyz789",
"productCode": "xyz789",
"lastUpdateGmt": "2007-12-03",
"api": 123.45,
"type": "abc123",
"lastUserID": "abc123",
"isDangerous": true,
"isInactive": false,
"isPreClearance": false,
"isCapBasisGrain": true,
"isCapBasisBale": false,
"mTBE": true,
"fAME": true,
"eTBE": true,
"isPersistent": true,
"billByCPQty": false,
"billByInvoiceQty": true,
"billByOutturnQty": false,
"isSpecialHandlingRequired": true,
"imoName": "xyz789",
"unNum": "xyz789",
"unClass": "abc123",
"bcCodeGroup": "abc123",
"cpUnit": "xyz789",
"liftUnit": "abc123",
"altLiftUnit": "xyz789",
"bcCode": "abc123",
"onshoreProductUrl": "xyz789",
"onboardProductUrl": "abc123",
"uSCGName": "abc123",
"mARPOLCategory": "xyz789",
"imoShipType": "abc123",
"sGTempBasisDegree": 987.65,
"sGTempCoefficient": 123.45,
"sGTempScale": "abc123",
"meltingPoint": 123.45,
"meltingPointTempScale": "xyz789",
"boilingPoint": 987.65,
"boilingPointTempScale": "abc123",
"imoClass": "xyz789",
"adnrEniClass": "abc123",
"uSCGGrade": "xyz789",
"uSCGSubchapter": "xyz789",
"uSCGCargoName": "abc123",
"cpUnitData": VesselServiceImosUnitOfMeasure,
"liftUnitData": VesselServiceImosUnitOfMeasure,
"altLiftUnitData": VesselServiceImosUnitOfMeasure,
"userDefinedFields": Json
}
VesselServiceImosConsMode
VesselServiceImosExchangeRate
Example
{
"baseCurrencyCode": "abc123",
"targetCurrencyCode": "xyz789",
"effectiveDate": "2007-12-03",
"rate": 123.45,
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123"
}
VesselServiceImosFuelLubeType
Fields
| Field Name | Description |
|---|---|
sqlID - Int
|
|
code - String
|
|
description - String
|
|
type - String
|
|
group - Int
|
|
trackSulfurPercentage - Int
|
|
calorificValue - Float
|
|
fuelSulfurGrade - String
|
|
cO2EmissionsFactor - Float
|
|
extraFreightRateTerm - String
|
|
extraFreightLumpsumTerm - String
|
|
backupFuelType - String
|
|
tankToWakeCH4EmissionsFactor - Float
|
|
tankToWakeN2OEmissionsFactor - Float
|
|
lowerCalorificValue - Float
|
|
wellToTankCO2Equivalent - Float
|
|
tankToWakeCO2Equivalent - Float
|
|
lngEquivalent - Boolean
|
|
supportLiftingFactors - Boolean
|
Example
{
"sqlID": 987,
"code": "abc123",
"description": "xyz789",
"type": "abc123",
"group": 123,
"trackSulfurPercentage": 123,
"calorificValue": 987.65,
"fuelSulfurGrade": "abc123",
"cO2EmissionsFactor": 987.65,
"extraFreightRateTerm": "xyz789",
"extraFreightLumpsumTerm": "xyz789",
"backupFuelType": "abc123",
"tankToWakeCH4EmissionsFactor": 123.45,
"tankToWakeN2OEmissionsFactor": 987.65,
"lowerCalorificValue": 123.45,
"wellToTankCO2Equivalent": 987.65,
"tankToWakeCO2Equivalent": 987.65,
"lngEquivalent": false,
"supportLiftingFactors": false
}
VesselServiceImosFuelZone
Fields
| Field Name | Description |
|---|---|
sqlID - Int
|
|
ecaID - Int
|
|
fuelType - String
|
|
consumptionType - String
|
|
orderNo - Int
|
|
consRateOnly - Boolean
|
|
inactive - Boolean
|
|
scrubber - Boolean
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
vesselType - String
|
|
vesselCode - String
|
|
fuelZoneSetID - Int
|
|
fuelZoneSet - VesselServiceImosFuelZoneSet
|
Example
{
"sqlID": 987,
"ecaID": 123,
"fuelType": "xyz789",
"consumptionType": "xyz789",
"orderNo": 987,
"consRateOnly": false,
"inactive": true,
"scrubber": false,
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"vesselType": "abc123",
"vesselCode": "xyz789",
"fuelZoneSetID": 123,
"fuelZoneSet": VesselServiceImosFuelZoneSet
}
VesselServiceImosFuelZoneSet
Example
{
"iD": 987,
"name": "xyz789",
"description": "xyz789",
"inactive": true,
"default": false,
"imo2020": false,
"fuelZones": [VesselServiceImosFuelZone]
}
VesselServiceImosPool
Example
{
"poolName": "abc123",
"dwt": 123.45,
"mgtFeePercentage": 123.45,
"mgtFeePerDay": 987.65,
"description": "xyz789",
"poolID": 987,
"companyCode": "abc123",
"calculationStartDate": "2007-12-03"
}
VesselServiceImosPoolAssignment
Fields
| Field Name | Description |
|---|---|
isPremium - Boolean
|
|
year - Int
|
|
poolID - Int
|
|
vesselCode - String
|
|
netDailyPlan - Float
|
|
vesselPoints - Float
|
|
poolEntryDateGmt - Date
|
|
poolExitDateGmt - Date
|
|
mgtFeePercentage - Float
|
|
mgtFeePerDay - Float
|
|
premiumInternal - Boolean
|
|
participantCompanyNo - Int
|
|
participantCompany - VesselServiceImosAddressBook
|
|
vessel - VesselServiceImosVessel
|
|
pool - VesselServiceImosPool
|
|
firstPoolAssignmentPremium - VesselServiceImosPoolAssignmentPremium
|
|
poolAssignmentPremiums - [VesselServiceImosPoolAssignmentPremium]
|
Example
{
"isPremium": false,
"year": 123,
"poolID": 987,
"vesselCode": "abc123",
"netDailyPlan": 123.45,
"vesselPoints": 987.65,
"poolEntryDateGmt": "2007-12-03",
"poolExitDateGmt": "2007-12-03",
"mgtFeePercentage": 987.65,
"mgtFeePerDay": 123.45,
"premiumInternal": true,
"participantCompanyNo": 987,
"participantCompany": VesselServiceImosAddressBook,
"vessel": VesselServiceImosVessel,
"pool": VesselServiceImosPool,
"firstPoolAssignmentPremium": VesselServiceImosPoolAssignmentPremium,
"poolAssignmentPremiums": [
VesselServiceImosPoolAssignmentPremium
]
}
VesselServiceImosPoolAssignmentPremium
Example
{
"year": 123,
"poolID": 123,
"vesselCode": "abc123",
"poolEntryDateGmt": "2007-12-03",
"premiumCode": "abc123",
"poolAssignment": VesselServiceImosPoolAssignment
}
VesselServiceImosTerm
Example
{
"type": "xyz789",
"code": 987,
"name": "abc123",
"description": "abc123",
"lastUser": "abc123",
"inactive": false,
"text": "xyz789",
"group": "xyz789",
"lastUpdateGmt": "2007-12-03",
"refType": "abc123",
"refName": "xyz789",
"fuelFactorSetID": 123
}
VesselServiceImosUnitOfMeasure
Example
{
"code": "xyz789",
"description": "abc123",
"type": "abc123",
"alternateCode": "xyz789",
"conversionFactor": 987.65,
"vesselBunkerTanks": [VesselServiceImosVesselBunkerTank]
}
VesselServiceImosUser
Fields
| Field Name | Description |
|---|---|
membership - String
|
|
lastLogin - Date
|
|
sqlID - Int
|
|
userNo - Int
|
|
userName - String
|
|
initials - String
|
|
type - String
|
|
fullName - String
|
|
email - String
|
|
securityAdmin - Boolean
|
|
windowsUser - Boolean
|
|
forceEuropeanDates - Boolean
|
|
inactive - Boolean
|
|
readOnly - Boolean
|
|
outOfOffice - Boolean
|
|
bCryptPasswordHash - Boolean
|
|
externalAccessOnly - Boolean
|
|
authOnly - Boolean
|
|
imosXUser - Boolean
|
|
flags - Int
|
|
ldapUserName - String
|
|
ldapGuid - String
|
|
userPhoneNo - String
|
|
createdBy - String
|
|
createdOnGmt - Date
|
Example
{
"membership": "abc123",
"lastLogin": "2007-12-03",
"sqlID": 987,
"userNo": 987,
"userName": "xyz789",
"initials": "abc123",
"type": "xyz789",
"fullName": "abc123",
"email": "abc123",
"securityAdmin": false,
"windowsUser": true,
"forceEuropeanDates": true,
"inactive": true,
"readOnly": true,
"outOfOffice": false,
"bCryptPasswordHash": true,
"externalAccessOnly": true,
"authOnly": true,
"imosXUser": false,
"flags": 987,
"ldapUserName": "abc123",
"ldapGuid": "xyz789",
"userPhoneNo": "abc123",
"createdBy": "xyz789",
"createdOnGmt": "2007-12-03"
}
VesselServiceImosVessel
Fields
| Field Name | Description |
|---|---|
capacityBaleM3 - Float
|
|
capacityGrainM3 - Float
|
|
fillingLimitPercentage - Float
|
|
isActive - Boolean
|
|
containerCapacityFEU - Float
|
|
deckCapacityM3 - Float
|
|
isActiveForVeslink - Boolean
|
|
last5CargoShortNames - String
|
|
foeConversionFactor - Float
|
|
sqlID - Int
|
|
vesselCode - String
|
|
name - String
|
|
vesselType - String
|
|
suezType - String
|
|
fleet - String
|
|
flag - String
|
|
unitTypeCode - String
|
|
ownership - String
|
|
callLetters - String
|
|
operator - String
|
|
lOA - Float
|
|
beam - Float
|
|
depth - Float
|
|
dailyCost - Float
|
|
opa90 - Float
|
|
dWT - Float
|
|
capacity - Float
|
|
totalBBLs - Float
|
|
vesselSummerDraft - Float
|
|
vesselWinterDraft - Float
|
|
maxDraft - Float
|
|
tPC - Float
|
|
gRT - Float
|
|
nRT - Float
|
|
panamaGross - Float
|
|
panamaNet - Float
|
|
suezGross - Float
|
|
suezNet - Float
|
|
ladenSpeed - Float
|
|
ballastSpeed - Float
|
|
tradeArea - String
|
|
foeConversionFactorInverted - Float
|
|
maxAirDraft - Float
|
|
telex - String
|
|
fax - String
|
|
imoNo - String
|
|
phone - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
allowUpdate - Int
|
|
hullType - String
|
|
lastUser - String
|
|
yearBuilt - Int
|
|
isBargeUnit - Int
|
|
vapor - Boolean
|
|
igs - Boolean
|
|
nonActive - Boolean
|
|
allowDespatch - Boolean
|
|
trackInlandBunkers - Boolean
|
|
estOnly - Boolean
|
|
co2Fitted - Boolean
|
|
bowThruster - Boolean
|
|
strengthened - Boolean
|
|
australianLadders - Boolean
|
|
toledoSuitable - Boolean
|
|
tveValid - Boolean
|
|
rejected - Boolean
|
|
logFitted - Boolean
|
|
grainFitted - Boolean
|
|
commercialMgmt - Boolean
|
|
etaExcluded - Boolean
|
|
a60Fitted - Boolean
|
|
offshoreBarge - Boolean
|
|
useBoilOffMinCons - Boolean
|
|
useScrubbers - Boolean
|
|
isCommonlyUsed - Boolean
|
|
isUnitTow - Boolean
|
|
activeForOnboard - Boolean
|
|
isGeneralCargo - Boolean
|
|
equipmentFlags - Int
|
|
email - String
|
|
refNo - String
|
|
satC - String
|
|
ventilation - String
|
|
iceClass - String
|
|
grabsQty - Float
|
|
grabsCap - Float
|
|
engineMake - String
|
|
holdStrengthened - String
|
|
inheritRouteFromVessel - String
|
|
remarks - String
|
|
officialNo - String
|
|
pnsNo - String
|
|
hatchType - String
|
|
hAndMValue - String
|
|
pAndIClub - String
|
|
gapValue - String
|
|
maxBallastDailyBoilOffPct - Float
|
|
maxLadenDailyBoilOffPct - Float
|
|
demAnalyst - String
|
|
satA - String
|
|
satB - String
|
|
miniM - String
|
|
masterPhone - String
|
|
bridgePhone - String
|
|
ccrNo - String
|
|
chtrCoordinator - String
|
|
opsCoordinator - String
|
|
beaufortNo - Int
|
|
seaStateNo - Int
|
|
seaSwellNo - Int
|
|
alerts - String
|
|
dailyAdminFee - Float
|
|
adminFeeCurr - String
|
|
vesselTypeCorrelation - Float
|
|
crossRefNo - String
|
|
replicationFlags - Int
|
|
veslinkCompany - String
|
|
unitFactor - Float
|
|
fuelZoneSetID - Int
|
|
vesselTypeAdjustment - Float
|
|
naturalBoilOffBallastSpeed - Float
|
|
naturalBoilOffLadenSpeed - Float
|
|
bunkerConfigVersion - Int
|
|
companyCode - String
|
|
scrubberType - String
|
|
vettingRemarks - String
|
|
iceClassType - String
|
|
engineType - String
|
|
fuelZoneSet - VesselServiceImosFuelZoneSet
|
|
vesselDetails - VesselServiceImosVesselDetails
|
|
ownerAddressBook - VesselServiceImosAddressBook
|
|
vesselTypeData - VesselServiceImosVesselType
|
|
vesselVariables - VesselServiceImosVesselVariables
|
|
barge - VesselServiceImosBarge
|
|
voyagePnls - [VesselServiceImosVoyagePnl]
|
|
vesselDraftMarks - [VesselServiceImosVesselDraftMarks]
|
|
vesselCranes - [VesselServiceImosVesselCrane]
|
|
poolAssignments - [VesselServiceImosPoolAssignment]
|
|
vesselHolds - [VesselServiceImosVesselHold]
|
|
vesselTceTargets - [VesselServiceImosVesselTceTarget]
|
|
vesselSeaConsBunkers - [VesselServiceImosVesselSeaConsBunker]
|
|
vesselSeaCons - [VesselServiceImosVesselSeaCons]
|
|
vesselPortCons - [VesselServiceImosVesselPortCons]
|
|
vesselInspections - [VesselServiceImosVesselInspection]
|
|
vesselIncidents - [VesselServiceImosVesselIncident]
|
|
vesselHatchs - [VesselServiceImosVesselHatch]
|
|
vesselEvaluations - [VesselServiceImosVesselEvaluation]
|
|
vesselDrafts - [VesselServiceImosVesselDraft]
|
|
vesselConsModes - [VesselServiceImosVesselConsMode]
|
|
vesselBunkerTanks - [VesselServiceImosVesselBunkerTank]
|
|
vesselBoats - [VesselServiceImosVesselBoats]
|
|
vesselTanks - [VesselServiceImosVesselTank]
|
|
vesselFleetMember - [VesselServiceImosVesselFleetMemberFull]
|
|
userDefinedFields - Json
|
Example
{
"capacityBaleM3": 123.45,
"capacityGrainM3": 123.45,
"fillingLimitPercentage": 987.65,
"isActive": false,
"containerCapacityFEU": 987.65,
"deckCapacityM3": 987.65,
"isActiveForVeslink": false,
"last5CargoShortNames": "abc123",
"foeConversionFactor": 987.65,
"sqlID": 123,
"vesselCode": "xyz789",
"name": "xyz789",
"vesselType": "xyz789",
"suezType": "xyz789",
"fleet": "xyz789",
"flag": "abc123",
"unitTypeCode": "xyz789",
"ownership": "xyz789",
"callLetters": "abc123",
"operator": "abc123",
"lOA": 987.65,
"beam": 987.65,
"depth": 123.45,
"dailyCost": 123.45,
"opa90": 123.45,
"dWT": 123.45,
"capacity": 123.45,
"totalBBLs": 123.45,
"vesselSummerDraft": 987.65,
"vesselWinterDraft": 123.45,
"maxDraft": 123.45,
"tPC": 123.45,
"gRT": 987.65,
"nRT": 123.45,
"panamaGross": 987.65,
"panamaNet": 987.65,
"suezGross": 987.65,
"suezNet": 987.65,
"ladenSpeed": 123.45,
"ballastSpeed": 123.45,
"tradeArea": "abc123",
"foeConversionFactorInverted": 987.65,
"maxAirDraft": 123.45,
"telex": "xyz789",
"fax": "abc123",
"imoNo": "abc123",
"phone": "abc123",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"allowUpdate": 987,
"hullType": "abc123",
"lastUser": "abc123",
"yearBuilt": 987,
"isBargeUnit": 123,
"vapor": true,
"igs": true,
"nonActive": true,
"allowDespatch": false,
"trackInlandBunkers": false,
"estOnly": false,
"co2Fitted": false,
"bowThruster": true,
"strengthened": true,
"australianLadders": true,
"toledoSuitable": false,
"tveValid": true,
"rejected": true,
"logFitted": true,
"grainFitted": false,
"commercialMgmt": true,
"etaExcluded": false,
"a60Fitted": true,
"offshoreBarge": false,
"useBoilOffMinCons": false,
"useScrubbers": true,
"isCommonlyUsed": false,
"isUnitTow": false,
"activeForOnboard": false,
"isGeneralCargo": true,
"equipmentFlags": 987,
"email": "abc123",
"refNo": "abc123",
"satC": "abc123",
"ventilation": "abc123",
"iceClass": "xyz789",
"grabsQty": 987.65,
"grabsCap": 123.45,
"engineMake": "xyz789",
"holdStrengthened": "abc123",
"inheritRouteFromVessel": "xyz789",
"remarks": "xyz789",
"officialNo": "abc123",
"pnsNo": "abc123",
"hatchType": "abc123",
"hAndMValue": "xyz789",
"pAndIClub": "xyz789",
"gapValue": "xyz789",
"maxBallastDailyBoilOffPct": 987.65,
"maxLadenDailyBoilOffPct": 123.45,
"demAnalyst": "xyz789",
"satA": "xyz789",
"satB": "xyz789",
"miniM": "xyz789",
"masterPhone": "abc123",
"bridgePhone": "xyz789",
"ccrNo": "abc123",
"chtrCoordinator": "xyz789",
"opsCoordinator": "xyz789",
"beaufortNo": 123,
"seaStateNo": 987,
"seaSwellNo": 987,
"alerts": "abc123",
"dailyAdminFee": 987.65,
"adminFeeCurr": "abc123",
"vesselTypeCorrelation": 987.65,
"crossRefNo": "xyz789",
"replicationFlags": 987,
"veslinkCompany": "xyz789",
"unitFactor": 987.65,
"fuelZoneSetID": 987,
"vesselTypeAdjustment": 987.65,
"naturalBoilOffBallastSpeed": 987.65,
"naturalBoilOffLadenSpeed": 123.45,
"bunkerConfigVersion": 987,
"companyCode": "abc123",
"scrubberType": "xyz789",
"vettingRemarks": "xyz789",
"iceClassType": "abc123",
"engineType": "abc123",
"fuelZoneSet": VesselServiceImosFuelZoneSet,
"vesselDetails": VesselServiceImosVesselDetails,
"ownerAddressBook": VesselServiceImosAddressBook,
"vesselTypeData": VesselServiceImosVesselType,
"vesselVariables": VesselServiceImosVesselVariables,
"barge": VesselServiceImosBarge,
"voyagePnls": [VesselServiceImosVoyagePnl],
"vesselDraftMarks": [VesselServiceImosVesselDraftMarks],
"vesselCranes": [VesselServiceImosVesselCrane],
"poolAssignments": [VesselServiceImosPoolAssignment],
"vesselHolds": [VesselServiceImosVesselHold],
"vesselTceTargets": [VesselServiceImosVesselTceTarget],
"vesselSeaConsBunkers": [
VesselServiceImosVesselSeaConsBunker
],
"vesselSeaCons": [VesselServiceImosVesselSeaCons],
"vesselPortCons": [VesselServiceImosVesselPortCons],
"vesselInspections": [
VesselServiceImosVesselInspection
],
"vesselIncidents": [VesselServiceImosVesselIncident],
"vesselHatchs": [VesselServiceImosVesselHatch],
"vesselEvaluations": [
VesselServiceImosVesselEvaluation
],
"vesselDrafts": [VesselServiceImosVesselDraft],
"vesselConsModes": [VesselServiceImosVesselConsMode],
"vesselBunkerTanks": [
VesselServiceImosVesselBunkerTank
],
"vesselBoats": [VesselServiceImosVesselBoats],
"vesselTanks": [VesselServiceImosVesselTank],
"vesselFleetMember": [
VesselServiceImosVesselFleetMemberFull
],
"userDefinedFields": Json
}
VesselServiceImosVesselBoats
Fields
| Field Name | Description |
|---|---|
vesselCode - String
|
|
bargeCode - String
|
|
sequenceNumber - Int
|
|
inGMT - Date
|
|
outGMT - Date
|
|
vessel - VesselServiceImosVessel
|
|
barge - VesselServiceImosBarge
|
Example
{
"vesselCode": "xyz789",
"bargeCode": "abc123",
"sequenceNumber": 123,
"inGMT": "2007-12-03",
"outGMT": "2007-12-03",
"vessel": VesselServiceImosVessel,
"barge": VesselServiceImosBarge
}
VesselServiceImosVesselBunkerTank
Fields
| Field Name | Description |
|---|---|
vesselCode - String
|
|
bunkerTankNo - Int
|
|
description - String
|
|
location - String
|
|
capacity - Float
|
|
unit - String
|
|
unitOfMeasure - VesselServiceImosUnitOfMeasure
|
|
vessel - VesselServiceImosVessel
|
Example
{
"vesselCode": "xyz789",
"bunkerTankNo": 123,
"description": "abc123",
"location": "xyz789",
"capacity": 987.65,
"unit": "abc123",
"unitOfMeasure": VesselServiceImosUnitOfMeasure,
"vessel": VesselServiceImosVessel
}
VesselServiceImosVesselConsMode
Fields
| Field Name | Description |
|---|---|
vslCode - String
|
|
consModeID - Int
|
|
isFuelVersion - Boolean
|
|
vessel - VesselServiceImosVessel
|
|
consMode - VesselServiceImosConsMode
|
Example
{
"vslCode": "abc123",
"consModeID": 987,
"isFuelVersion": true,
"vessel": VesselServiceImosVessel,
"consMode": VesselServiceImosConsMode
}
VesselServiceImosVesselCrane
Example
{
"vesselCode": "xyz789",
"craneType": "abc123",
"seqNo": 987,
"noOutreach": 987,
"capacity": 123.45,
"radius": 123.45,
"vessel": VesselServiceImosVessel
}
VesselServiceImosVesselDetails
Fields
| Field Name | Description |
|---|---|
freshWater - Float
|
|
constantsSea - Float
|
|
constantsOther - Float
|
|
constantsLakes - Float
|
|
managerShortName - String
|
|
vesselCode - String
|
|
formerName - String
|
|
classSocietyCode - String
|
|
builder - String
|
|
buildDet - String
|
|
registry - String
|
|
vesselOwnerNew - String
|
|
disponentOwner - String
|
|
cargoGear - String
|
|
containerCost - Float
|
|
dwtDate - Date
|
|
lastDryDock - Date
|
|
nextDryDock - Date
|
|
nextSurvey - Date
|
|
nextInspection - Date
|
|
lastPropPolished - Date
|
|
lastHullCleaned - Date
|
|
ownerShortName - String
|
|
tveExpires - Date
|
|
loadTimeHr - Float
|
|
loadMinLiquidPressure - Float
|
|
loadMinGasReturnM3Hr - Float
|
|
loadMaxGasPressure - Float
|
|
dischTimeHr - Float
|
|
dischMaxLiquidPressure - Float
|
|
dischMinGasReturnM3Hr - Float
|
|
dischMinGasPressure - Float
|
|
managerCompanyNo - Int
|
|
hullNumber - String
|
|
yard - String
|
|
poolPointType - String
|
|
scrubbersActive - Date
|
|
managerCompany - VesselServiceImosAddressBook
|
|
vessel - VesselServiceImosVessel
|
|
ownerAddressBook - VesselServiceImosAddressBook
|
Example
{
"freshWater": 123.45,
"constantsSea": 987.65,
"constantsOther": 123.45,
"constantsLakes": 123.45,
"managerShortName": "xyz789",
"vesselCode": "abc123",
"formerName": "xyz789",
"classSocietyCode": "abc123",
"builder": "abc123",
"buildDet": "xyz789",
"registry": "xyz789",
"vesselOwnerNew": "xyz789",
"disponentOwner": "abc123",
"cargoGear": "xyz789",
"containerCost": 123.45,
"dwtDate": "2007-12-03",
"lastDryDock": "2007-12-03",
"nextDryDock": "2007-12-03",
"nextSurvey": "2007-12-03",
"nextInspection": "2007-12-03",
"lastPropPolished": "2007-12-03",
"lastHullCleaned": "2007-12-03",
"ownerShortName": "xyz789",
"tveExpires": "2007-12-03",
"loadTimeHr": 987.65,
"loadMinLiquidPressure": 987.65,
"loadMinGasReturnM3Hr": 123.45,
"loadMaxGasPressure": 123.45,
"dischTimeHr": 123.45,
"dischMaxLiquidPressure": 987.65,
"dischMinGasReturnM3Hr": 123.45,
"dischMinGasPressure": 123.45,
"managerCompanyNo": 987,
"hullNumber": "abc123",
"yard": "xyz789",
"poolPointType": "xyz789",
"scrubbersActive": "2007-12-03",
"managerCompany": VesselServiceImosAddressBook,
"vessel": VesselServiceImosVessel,
"ownerAddressBook": VesselServiceImosAddressBook
}
VesselServiceImosVesselDraft
Example
{
"vesselCode": "abc123",
"draft": 987.65,
"dwt": 987.65,
"displacement": 987.65,
"tpc": 123.45,
"remarks": "xyz789",
"vessel": VesselServiceImosVessel
}
VesselServiceImosVesselDraftMarks
Fields
| Field Name | Description |
|---|---|
vesselCode - String
|
|
tropicalFWDraft - Float
|
|
tropicalFWDwt - Float
|
|
tropicalFWDisplacement - Float
|
|
tropicalFWFreeBoard - Float
|
|
tropicalFWTpc - Float
|
|
fWDraft - Float
|
|
fWDwt - Float
|
|
fWDisplacement - Float
|
|
fWFreeBoard - Float
|
|
fWTpc - Float
|
|
designDraft - Float
|
|
designDwt - Float
|
|
designDisplacement - Float
|
|
designFreeBoard - Float
|
|
designTpc - Float
|
|
summerDraft - Float
|
|
summerDwt - Float
|
|
summerDisplacement - Float
|
|
summerFreeBoard - Float
|
|
summerTpc - Float
|
|
winterDraft - Float
|
|
winterDwt - Float
|
|
winterDisplacement - Float
|
|
winterFreeBoard - Float
|
|
winterTpc - Float
|
|
normalDraft - Float
|
|
normalDwt - Float
|
|
normalDisplacement - Float
|
|
normalFreeBoard - Float
|
|
normalTpc - Float
|
|
lightshipDraft - Float
|
|
lightshipDwt - Float
|
|
lightshipDisplacement - Float
|
|
lightshipFreeBoard - Float
|
|
lightshipTpc - Float
|
|
freshWaterAllowance - Float
|
|
tropicalSWDraft - Float
|
|
tropicalSWDwt - Float
|
|
tropicalSWDisplacement - Float
|
|
tropicalSWFreeBoard - Float
|
|
tropicalSWTpc - Float
|
|
vessel - VesselServiceImosVessel
|
Example
{
"vesselCode": "xyz789",
"tropicalFWDraft": 987.65,
"tropicalFWDwt": 987.65,
"tropicalFWDisplacement": 987.65,
"tropicalFWFreeBoard": 123.45,
"tropicalFWTpc": 123.45,
"fWDraft": 987.65,
"fWDwt": 987.65,
"fWDisplacement": 123.45,
"fWFreeBoard": 123.45,
"fWTpc": 987.65,
"designDraft": 987.65,
"designDwt": 987.65,
"designDisplacement": 123.45,
"designFreeBoard": 123.45,
"designTpc": 123.45,
"summerDraft": 123.45,
"summerDwt": 123.45,
"summerDisplacement": 987.65,
"summerFreeBoard": 123.45,
"summerTpc": 123.45,
"winterDraft": 987.65,
"winterDwt": 987.65,
"winterDisplacement": 123.45,
"winterFreeBoard": 987.65,
"winterTpc": 123.45,
"normalDraft": 987.65,
"normalDwt": 123.45,
"normalDisplacement": 123.45,
"normalFreeBoard": 123.45,
"normalTpc": 123.45,
"lightshipDraft": 123.45,
"lightshipDwt": 123.45,
"lightshipDisplacement": 987.65,
"lightshipFreeBoard": 987.65,
"lightshipTpc": 987.65,
"freshWaterAllowance": 987.65,
"tropicalSWDraft": 987.65,
"tropicalSWDwt": 123.45,
"tropicalSWDisplacement": 987.65,
"tropicalSWFreeBoard": 123.45,
"tropicalSWTpc": 123.45,
"vessel": VesselServiceImosVessel
}
VesselServiceImosVesselEvaluation
Fields
| Field Name | Description |
|---|---|
imoNo - String
|
|
seqNo - Int
|
|
ordNo - Int
|
|
inspectionDate - Date
|
|
statutoryPercent - Float
|
|
recommendedPercent - Float
|
|
desirablePercent - Float
|
|
totalQuestions - Int
|
|
totalNegativeQuestions - Int
|
|
totalNAQuestions - Int
|
|
rating - Int
|
|
approvedToDate - Date
|
|
tSEval - String
|
|
gasEval - String
|
|
prohibit - String
|
|
remarks - String
|
|
entryDateGmt - Date
|
|
createdByUser - String
|
|
evaluationDateGmt - Date
|
|
source - String
|
|
environmentRating - String
|
|
externalRef - String
|
|
environmentRatingVerification - String
|
|
dOCSubscore - Int
|
|
vessel - VesselServiceImosVessel
|
Example
{
"imoNo": "xyz789",
"seqNo": 987,
"ordNo": 123,
"inspectionDate": "2007-12-03",
"statutoryPercent": 123.45,
"recommendedPercent": 123.45,
"desirablePercent": 123.45,
"totalQuestions": 987,
"totalNegativeQuestions": 123,
"totalNAQuestions": 123,
"rating": 123,
"approvedToDate": "2007-12-03",
"tSEval": "abc123",
"gasEval": "abc123",
"prohibit": "abc123",
"remarks": "abc123",
"entryDateGmt": "2007-12-03",
"createdByUser": "xyz789",
"evaluationDateGmt": "2007-12-03",
"source": "xyz789",
"environmentRating": "abc123",
"externalRef": "xyz789",
"environmentRatingVerification": "xyz789",
"dOCSubscore": 123,
"vessel": VesselServiceImosVessel
}
VesselServiceImosVesselFleetMemberFull
Fields
| Field Name | Description |
|---|---|
vesselCode - String
|
|
fleetName - String
|
|
fleet - VesselServiceImosVesselType
|
|
vessel - VesselServiceImosVessel
|
Example
{
"vesselCode": "xyz789",
"fleetName": "xyz789",
"fleet": VesselServiceImosVesselType,
"vessel": VesselServiceImosVessel
}
VesselServiceImosVesselHatch
Example
{
"vesselCode": "abc123",
"hatchNo": 987,
"hatchLengthM": 123.45,
"hatchWidthM": 123.45,
"hatchWaterline": 123.45,
"hatchMaxWt": 123.45,
"craneCap": 987.65,
"derrickCap": 123.45,
"cementholes": 123.45,
"dimension": 987.65,
"vessel": VesselServiceImosVessel
}
VesselServiceImosVesselHold
Example
{
"vesselCode": "abc123",
"holdNo": 123,
"grainFt3": 123.45,
"baleFt3": 987.65,
"holdLength": 123.45,
"holdWidthFwd": 987.65,
"holdWidthAft": 123.45,
"wTTanktop": 123.45,
"wTHold": 123.45,
"ballastHold": "abc123",
"vessel": VesselServiceImosVessel
}
VesselServiceImosVesselIncident
Fields
| Field Name | Description |
|---|---|
typeCode - Int
|
|
typeName - String
|
|
typeDescription - String
|
|
imoNo - String
|
|
seqNo - Int
|
|
ordNo - Int
|
|
action - String
|
|
details - String
|
|
infoSource - String
|
|
remarks - String
|
|
entryDateGmt - Date
|
|
createdByUser - String
|
|
incidentDateGmt - Date
|
|
vessel - VesselServiceImosVessel
|
|
incidentType - VesselServiceImosTerm
|
Example
{
"typeCode": 987,
"typeName": "xyz789",
"typeDescription": "xyz789",
"imoNo": "abc123",
"seqNo": 123,
"ordNo": 123,
"action": "abc123",
"details": "xyz789",
"infoSource": "xyz789",
"remarks": "xyz789",
"entryDateGmt": "2007-12-03",
"createdByUser": "xyz789",
"incidentDateGmt": "2007-12-03",
"vessel": VesselServiceImosVessel,
"incidentType": VesselServiceImosTerm
}
VesselServiceImosVesselInspection
Example
{
"imoNo": "xyz789",
"seqNo": 123,
"ordNo": 987,
"inspectionDate": "2007-12-03",
"inspectionUser": "xyz789",
"status": "xyz789",
"externalParty": "xyz789",
"vessel": VesselServiceImosVessel
}
VesselServiceImosVesselPortCons
Fields
| Field Name | Description |
|---|---|
gradeSulfur - String
|
|
gradeDataCenter - String
|
|
isFoe - String
|
|
vesselCode - String
|
|
index - Int
|
|
lineNo - Int
|
|
fuelType - String
|
|
loadFuel - Float
|
|
dischargeFuel - Float
|
|
idle - Float
|
|
hotel - Float
|
|
heat - Float
|
|
clean - Float
|
|
margin - Float
|
|
capacity - Float
|
|
unit - String
|
|
isFuelGradeHighSulfur - Boolean
|
|
isFuelGradeLowSulfur - Boolean
|
|
isFuelAsFoe - Boolean
|
|
isFuelInactive - Boolean
|
|
heatPlus - Float
|
|
auxiliary - Float
|
|
maneuver - Float
|
|
igs - Float
|
|
cool - Float
|
|
coolPlus - Float
|
|
heatPlusPlus - Float
|
|
gradeCode - Int
|
|
boiler - Float
|
|
incinerator - Float
|
|
bunkerConfigVersion - Int
|
|
units - VesselServiceImosUnitOfMeasure
|
|
fuel - VesselServiceImosFuelLubeType
|
|
vessel - VesselServiceImosVessel
|
|
gradeDataCenterTerm - VesselServiceImosTerm
|
Example
{
"gradeSulfur": "xyz789",
"gradeDataCenter": "xyz789",
"isFoe": "abc123",
"vesselCode": "abc123",
"index": 987,
"lineNo": 987,
"fuelType": "xyz789",
"loadFuel": 123.45,
"dischargeFuel": 123.45,
"idle": 123.45,
"hotel": 123.45,
"heat": 987.65,
"clean": 987.65,
"margin": 123.45,
"capacity": 987.65,
"unit": "xyz789",
"isFuelGradeHighSulfur": true,
"isFuelGradeLowSulfur": false,
"isFuelAsFoe": false,
"isFuelInactive": false,
"heatPlus": 123.45,
"auxiliary": 123.45,
"maneuver": 123.45,
"igs": 123.45,
"cool": 123.45,
"coolPlus": 123.45,
"heatPlusPlus": 123.45,
"gradeCode": 123,
"boiler": 987.65,
"incinerator": 987.65,
"bunkerConfigVersion": 987,
"units": VesselServiceImosUnitOfMeasure,
"fuel": VesselServiceImosFuelLubeType,
"vessel": VesselServiceImosVessel,
"gradeDataCenterTerm": VesselServiceImosTerm
}
VesselServiceImosVesselSeaCons
Example
{
"vesselCode": "abc123",
"speed": 987.65,
"isCpSpeed": true,
"engineLoad": 987.65,
"type": "xyz789",
"description": "abc123",
"bunkerConfigVersion": 987,
"vessel": VesselServiceImosVessel
}
VesselServiceImosVesselSeaConsBunker
Example
{
"vesselCode": "xyz789",
"speed": 987.65,
"consumptionType": "xyz789",
"fuelType": "abc123",
"laden": 987.65,
"ballast": 123.45,
"engineLoad": 987.65,
"description": "xyz789",
"vessel": VesselServiceImosVessel
}
VesselServiceImosVesselTank
Fields
| Field Name | Description |
|---|---|
capacity - Float
|
|
vesselCode - String
|
|
vesselType - String
|
|
type - String
|
|
name - String
|
|
location - String
|
|
capacityA1 - Float
|
|
capacityA2 - Float
|
|
capacityA3 - Float
|
|
coating - String
|
|
cargoLastName - String
|
|
cargoFirstName - String
|
|
cargoThirdName - String
|
|
tankNo - Int
|
|
category - String
|
|
sourceSystemName - String
|
|
cargoThird - VesselServiceImosCargoName
|
|
cargoFirst - VesselServiceImosCargoName
|
|
cargoLast - VesselServiceImosCargoName
|
|
vessel - VesselServiceImosVessel
|
|
voyages - [VesselServiceImosVoyage]
|
|
voyageCargoHandlingStowages - [VesselServiceImosVoyageCargoHandlingStowage]
|
Example
{
"capacity": 123.45,
"vesselCode": "abc123",
"vesselType": "xyz789",
"type": "xyz789",
"name": "abc123",
"location": "abc123",
"capacityA1": 123.45,
"capacityA2": 987.65,
"capacityA3": 123.45,
"coating": "xyz789",
"cargoLastName": "abc123",
"cargoFirstName": "xyz789",
"cargoThirdName": "abc123",
"tankNo": 987,
"category": "xyz789",
"sourceSystemName": "xyz789",
"cargoThird": VesselServiceImosCargoName,
"cargoFirst": VesselServiceImosCargoName,
"cargoLast": VesselServiceImosCargoName,
"vessel": VesselServiceImosVessel,
"voyages": [VesselServiceImosVoyage],
"voyageCargoHandlingStowages": [
VesselServiceImosVoyageCargoHandlingStowage
]
}
VesselServiceImosVesselTceTarget
Example
{
"vesselCode": "xyz789",
"effectiveFromGmt": "2007-12-03",
"tceTarget": 123.45,
"lastUser": "abc123",
"lastUpdateGmt": "2007-12-03",
"vessel": VesselServiceImosVessel
}
VesselServiceImosVesselType
Fields
| Field Name | Description |
|---|---|
type - String
|
|
blank - String
|
|
routeCorrelation - Float
|
|
basisRoute - String
|
|
basisQuantity - Float
|
|
weightedDaysCorrelation - Float
|
|
benchmarkVesselCode - String
|
|
defaultTypeCode - String
|
|
minDWT - Int
|
|
maxDWT - Int
|
|
ownerUserNo - Int
|
|
vessel - VesselServiceImosVessel
|
|
owner - VesselServiceImosUser
|
Example
{
"type": "xyz789",
"blank": "abc123",
"routeCorrelation": 123.45,
"basisRoute": "abc123",
"basisQuantity": 987.65,
"weightedDaysCorrelation": 123.45,
"benchmarkVesselCode": "xyz789",
"defaultTypeCode": "xyz789",
"minDWT": 987,
"maxDWT": 123,
"ownerUserNo": 123,
"vessel": VesselServiceImosVessel,
"owner": VesselServiceImosUser
}
VesselServiceImosVesselVariables
Example
{
"vesselCode": "xyz789",
"freshWater": 123.45,
"constantsSea": 123.45,
"constantsOther": 123.45,
"constantsLakes": 987.65,
"vessel": VesselServiceImosVessel
}
VesselServiceImosVoyage
Fields
| Field Name | Description |
|---|---|
tcoBrokersList - String
|
|
equipmentList - String
|
|
boats - String
|
|
equipmentContractIDs - String
|
|
barges - String
|
|
ballastPort - String
|
|
remarks - String
|
|
repositionPort - String
|
|
bunkCalcMethod - String
|
|
localUTCOffset - String
|
|
voyagePnlVariance - Float
|
|
tcoChartCoordinator - String
|
|
chtrSpecialist - String
|
|
nominationDate - Date
|
|
estimateID - String
|
|
keyUsers - String
|
|
currentPortName - String
|
|
currentPortStatus - String
|
|
nextPortName - String
|
|
nextPortStatus - String
|
|
cargoCounterpartyShortNames - String
|
|
counterpartyShortName - String
|
|
counterpartyType - String
|
|
counterpartyCompanyNo - Int
|
|
tradeAreaName - String
|
|
laycanAlerts - Int
|
|
dailyCostString - String
|
|
vesselDailyCost - String
|
|
cargoList - String
|
|
cargoGradesList - String
|
|
cargoShortNamesList - String
|
|
cargoBookingNosList - String
|
|
cargoExternalRefsList - String
|
|
openDate - Date
|
|
voyageRangeGMT - String
|
|
totalLoadCargoVolume - Float
|
|
totalSaleCPCargoVolume - Float
|
|
voyageStatus - String
|
|
totalPortDays - Float
|
|
totalSeaDays - Float
|
|
lSMiles - Int
|
|
lSPortDays - Float
|
|
lSSeaDays - Float
|
|
isLSVoyage - Boolean
|
|
basisPnl - Float
|
|
comparePnl - Float
|
|
pnlReport - String
|
|
operationsReport - String
|
|
performanceReport - String
|
|
basisVsCompare - String
|
|
previousVoyageNo - Int
|
|
nextVoyageNo - Int
|
|
firstLoadPort - String
|
|
lastDischargePort - String
|
|
oprType - String
|
|
sqlID - Int
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
tcCode - String
|
|
vesselName - String
|
|
deliveryPortNo - Int
|
|
voyageStatusCode - String
|
|
departmentNo - Int
|
|
teamNo - Int
|
|
tcoCode - String
|
|
fixtureNo - String
|
|
commenceDateLocal - Date
|
|
completeDateLocal - Date
|
|
dailyCost - Float
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
bunkerCalcMethod - Int
|
|
consecutiveYN - String
|
|
lastUser - String
|
|
externalRef - String
|
|
opsCoordinator - String
|
|
heating - Boolean
|
|
tRBunker - Boolean
|
|
tciBnkAdj - Boolean
|
|
lastTci - Boolean
|
|
forecast - Boolean
|
|
daDesk - Boolean
|
|
claimPending - Boolean
|
|
legalHold - Boolean
|
|
ice - Boolean
|
|
pool - Boolean
|
|
clean - Boolean
|
|
coated - Boolean
|
|
highRisk - Boolean
|
|
cancel - Boolean
|
|
supportJob - Boolean
|
|
drydock - Boolean
|
|
nonPool - Boolean
|
|
lastTco - Boolean
|
|
offhireVoyage - Boolean
|
|
firstTci - Boolean
|
|
firstTco - Boolean
|
|
tveValid - Boolean
|
|
blComplete - Boolean
|
|
piracyEnabled - Boolean
|
|
piracyDisabled - Boolean
|
|
dischApproved - Boolean
|
|
includeInCover - Boolean
|
|
market - Boolean
|
|
trackBargeRobs - Boolean
|
|
legacyTowVoyage - Boolean
|
|
lowSulfurOnly - Boolean
|
|
disableBnkrWarnings - Boolean
|
|
companyCode - String
|
|
lobCode - String
|
|
voyageReference - String
|
|
commenceDateGmt - Date
|
|
completeDateGmt - Date
|
|
mVERate - Float
|
|
maxDailyBoilOffBallast - Float
|
|
maxDailyBoilOffLaden - Float
|
|
vesselLaycanFrom - Date
|
|
vesselLaycanTo - Date
|
|
voyageTemplateID - Int
|
|
currBase - String
|
|
poolFee - Float
|
|
segment - String
|
|
opsCoordinator2 - String
|
|
voyageController - String
|
|
fDManager - String
|
|
lossControlStatus - String
|
|
lossControlNotes - String
|
|
parentVesselCode - String
|
|
parentVoyageNo - Int
|
|
financeCoordinator - String
|
|
fuelZoneSetID - Int
|
|
marketDailyHireRate - Float
|
|
disableBackupFuelTypes - Boolean
|
|
restrictEdits - Boolean
|
|
noPoolDays - Boolean
|
|
enableBunkerRequirementDrivenWorkflow - Boolean
|
|
useScrubbers - Boolean
|
|
voyageBooking - Boolean
|
|
destMirrorVoyage - Boolean
|
|
syncEmissionsData - Boolean
|
|
includeCarbonExpenseInPnl - Boolean
|
|
useImprovedAttachmentKey - Boolean
|
|
manualOverrideAgreedEtsEmission - Boolean
|
|
manualOverrideAgreedEtsCost - Boolean
|
|
manualEtsExchangeRate - Boolean
|
|
manualOverrideFuelEuExchangeRate - Boolean
|
|
manualOverrideFuelEuAgreedPenaltyEur - Boolean
|
|
manualOverrideFuelEuAgreedPenaltyBase - Boolean
|
|
includeFuelEuExpenseInPnl - Boolean
|
|
manualOverrideFuelEuAgreedCompBalance - Boolean
|
|
manualLNGPricing - Boolean
|
|
naturalBoilOffBallastSpeed - Float
|
|
naturalBoilOffLadenSpeed - Float
|
|
scrubberType - String
|
|
closedBy - String
|
|
closedOnGmt - Date
|
|
marketValuationRateBase - Float
|
|
marketValuationRateUnit - String
|
|
marketValuationSymbol - String
|
|
marketValuationCorrelation - Float
|
|
marketValuationAdjustment - Float
|
|
marketValuationLumpsumAmountBase - Float
|
|
voyageAer - Float
|
|
voyageCiiRating - String
|
|
etsCO2Price - Float
|
|
etsCO2PriceCurrency - String
|
|
etsCO2PriceExchangeRate - Float
|
|
cO2Quantity - Float
|
|
etsCO2Quantity - Float
|
|
etsCO2Cost - Float
|
|
transportWork - Float
|
|
eEOI - Float
|
|
agreedEtsEmission - Float
|
|
agreedEtsCost - Float
|
|
previousDistance - Float
|
|
previousEmission - Float
|
|
previousAer - Float
|
|
previousCiiGrade - String
|
|
endOfVoyageDistance - Float
|
|
endOfVoyageEmission - Float
|
|
endOfVoyageAer - Float
|
|
endOfVoyageCiiGrade - String
|
|
etsPreVoyagePortNo - Int
|
|
etsPostVoyagePortNo - Int
|
|
fuelEUComplianceBalance - Float
|
|
fuelEUPenalty - Float
|
|
fuelEUTotalEnergy - Float
|
|
fuelEUExchangeRate - Float
|
|
fuelEUAgreedPenaltyEUR - Float
|
|
fuelEUAgreedPenaltyBase - Float
|
|
fuelEUAgreedComplianceBalance - Float
|
|
initialLNGPrice - Float
|
|
dischargeLNGPrice - Float
|
|
initialLNGCalorificValue - Float
|
|
dischargeLNGCalorificValue - Float
|
|
fuelZoneSet - VesselServiceImosFuelZoneSet
|
|
user - VesselServiceImosUser
|
|
vessel - VesselServiceImosVessel
|
|
voyageActPnl - VesselServiceImosVoyagePnl
|
|
voyageEstPnl - VesselServiceImosVoyagePnl
|
|
voyagePstPnl - VesselServiceImosVoyagePnl
|
|
voyageActPnlBasis - VesselServiceImosVoyagePnl
|
|
voyageActPnlCompare - VesselServiceImosVoyagePnl
|
|
companyAddressBook - VesselServiceImosAddressBook
|
|
previousVoyage - VesselServiceImosVoyage
|
|
nextVoyage - VesselServiceImosVoyage
|
|
voyagePnls - [VesselServiceImosVoyagePnl]
|
|
userDefinedFields - Json
|
Example
{
"tcoBrokersList": "abc123",
"equipmentList": "abc123",
"boats": "abc123",
"equipmentContractIDs": "xyz789",
"barges": "xyz789",
"ballastPort": "xyz789",
"remarks": "abc123",
"repositionPort": "abc123",
"bunkCalcMethod": "abc123",
"localUTCOffset": "abc123",
"voyagePnlVariance": 123.45,
"tcoChartCoordinator": "abc123",
"chtrSpecialist": "xyz789",
"nominationDate": "2007-12-03",
"estimateID": "xyz789",
"keyUsers": "xyz789",
"currentPortName": "abc123",
"currentPortStatus": "xyz789",
"nextPortName": "abc123",
"nextPortStatus": "abc123",
"cargoCounterpartyShortNames": "abc123",
"counterpartyShortName": "abc123",
"counterpartyType": "xyz789",
"counterpartyCompanyNo": 123,
"tradeAreaName": "abc123",
"laycanAlerts": 123,
"dailyCostString": "xyz789",
"vesselDailyCost": "abc123",
"cargoList": "xyz789",
"cargoGradesList": "xyz789",
"cargoShortNamesList": "abc123",
"cargoBookingNosList": "abc123",
"cargoExternalRefsList": "xyz789",
"openDate": "2007-12-03",
"voyageRangeGMT": "xyz789",
"totalLoadCargoVolume": 123.45,
"totalSaleCPCargoVolume": 123.45,
"voyageStatus": "abc123",
"totalPortDays": 123.45,
"totalSeaDays": 987.65,
"lSMiles": 123,
"lSPortDays": 987.65,
"lSSeaDays": 987.65,
"isLSVoyage": true,
"basisPnl": 123.45,
"comparePnl": 123.45,
"pnlReport": "abc123",
"operationsReport": "abc123",
"performanceReport": "xyz789",
"basisVsCompare": "xyz789",
"previousVoyageNo": 987,
"nextVoyageNo": 987,
"firstLoadPort": "xyz789",
"lastDischargePort": "xyz789",
"oprType": "xyz789",
"sqlID": 123,
"vesselCode": "xyz789",
"voyageNo": 123,
"tcCode": "abc123",
"vesselName": "abc123",
"deliveryPortNo": 987,
"voyageStatusCode": "abc123",
"departmentNo": 987,
"teamNo": 987,
"tcoCode": "abc123",
"fixtureNo": "abc123",
"commenceDateLocal": "2007-12-03",
"completeDateLocal": "2007-12-03",
"dailyCost": 123.45,
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"bunkerCalcMethod": 987,
"consecutiveYN": "xyz789",
"lastUser": "abc123",
"externalRef": "abc123",
"opsCoordinator": "xyz789",
"heating": true,
"tRBunker": true,
"tciBnkAdj": true,
"lastTci": false,
"forecast": true,
"daDesk": false,
"claimPending": false,
"legalHold": false,
"ice": false,
"pool": true,
"clean": true,
"coated": false,
"highRisk": false,
"cancel": true,
"supportJob": false,
"drydock": true,
"nonPool": true,
"lastTco": true,
"offhireVoyage": true,
"firstTci": false,
"firstTco": true,
"tveValid": true,
"blComplete": false,
"piracyEnabled": true,
"piracyDisabled": true,
"dischApproved": false,
"includeInCover": false,
"market": false,
"trackBargeRobs": true,
"legacyTowVoyage": true,
"lowSulfurOnly": false,
"disableBnkrWarnings": true,
"companyCode": "abc123",
"lobCode": "xyz789",
"voyageReference": "xyz789",
"commenceDateGmt": "2007-12-03",
"completeDateGmt": "2007-12-03",
"mVERate": 987.65,
"maxDailyBoilOffBallast": 123.45,
"maxDailyBoilOffLaden": 987.65,
"vesselLaycanFrom": "2007-12-03",
"vesselLaycanTo": "2007-12-03",
"voyageTemplateID": 987,
"currBase": "abc123",
"poolFee": 987.65,
"segment": "xyz789",
"opsCoordinator2": "abc123",
"voyageController": "xyz789",
"fDManager": "xyz789",
"lossControlStatus": "xyz789",
"lossControlNotes": "xyz789",
"parentVesselCode": "xyz789",
"parentVoyageNo": 987,
"financeCoordinator": "xyz789",
"fuelZoneSetID": 123,
"marketDailyHireRate": 123.45,
"disableBackupFuelTypes": false,
"restrictEdits": true,
"noPoolDays": true,
"enableBunkerRequirementDrivenWorkflow": true,
"useScrubbers": true,
"voyageBooking": true,
"destMirrorVoyage": true,
"syncEmissionsData": true,
"includeCarbonExpenseInPnl": true,
"useImprovedAttachmentKey": false,
"manualOverrideAgreedEtsEmission": true,
"manualOverrideAgreedEtsCost": false,
"manualEtsExchangeRate": true,
"manualOverrideFuelEuExchangeRate": true,
"manualOverrideFuelEuAgreedPenaltyEur": false,
"manualOverrideFuelEuAgreedPenaltyBase": true,
"includeFuelEuExpenseInPnl": true,
"manualOverrideFuelEuAgreedCompBalance": true,
"manualLNGPricing": true,
"naturalBoilOffBallastSpeed": 987.65,
"naturalBoilOffLadenSpeed": 987.65,
"scrubberType": "abc123",
"closedBy": "abc123",
"closedOnGmt": "2007-12-03",
"marketValuationRateBase": 123.45,
"marketValuationRateUnit": "abc123",
"marketValuationSymbol": "xyz789",
"marketValuationCorrelation": 987.65,
"marketValuationAdjustment": 987.65,
"marketValuationLumpsumAmountBase": 987.65,
"voyageAer": 123.45,
"voyageCiiRating": "xyz789",
"etsCO2Price": 123.45,
"etsCO2PriceCurrency": "abc123",
"etsCO2PriceExchangeRate": 123.45,
"cO2Quantity": 987.65,
"etsCO2Quantity": 987.65,
"etsCO2Cost": 123.45,
"transportWork": 123.45,
"eEOI": 123.45,
"agreedEtsEmission": 987.65,
"agreedEtsCost": 123.45,
"previousDistance": 123.45,
"previousEmission": 123.45,
"previousAer": 123.45,
"previousCiiGrade": "xyz789",
"endOfVoyageDistance": 123.45,
"endOfVoyageEmission": 987.65,
"endOfVoyageAer": 123.45,
"endOfVoyageCiiGrade": "abc123",
"etsPreVoyagePortNo": 987,
"etsPostVoyagePortNo": 987,
"fuelEUComplianceBalance": 123.45,
"fuelEUPenalty": 987.65,
"fuelEUTotalEnergy": 123.45,
"fuelEUExchangeRate": 123.45,
"fuelEUAgreedPenaltyEUR": 987.65,
"fuelEUAgreedPenaltyBase": 123.45,
"fuelEUAgreedComplianceBalance": 987.65,
"initialLNGPrice": 123.45,
"dischargeLNGPrice": 987.65,
"initialLNGCalorificValue": 123.45,
"dischargeLNGCalorificValue": 987.65,
"fuelZoneSet": VesselServiceImosFuelZoneSet,
"user": VesselServiceImosUser,
"vessel": VesselServiceImosVessel,
"voyageActPnl": VesselServiceImosVoyagePnl,
"voyageEstPnl": VesselServiceImosVoyagePnl,
"voyagePstPnl": VesselServiceImosVoyagePnl,
"voyageActPnlBasis": VesselServiceImosVoyagePnl,
"voyageActPnlCompare": VesselServiceImosVoyagePnl,
"companyAddressBook": VesselServiceImosAddressBook,
"previousVoyage": VesselServiceImosVoyage,
"nextVoyage": VesselServiceImosVoyage,
"voyagePnls": [VesselServiceImosVoyagePnl],
"userDefinedFields": Json
}
VesselServiceImosVoyageCargoHandlingStowage
Example
{
"tankName": "xyz789",
"vesselCode": "xyz789",
"voyageNo": 123,
"voyageSeqNo": 987,
"berthSeqNo": 123,
"seqNo": 123,
"holdNo": 987,
"quantity": 123.45,
"lastUser": "abc123",
"vesselTank": VesselServiceImosVesselTank
}
VesselServiceImosVoyagePnl
Fields
| Field Name | Description |
|---|---|
periodFromGmt - Date
|
|
periodToGmt - Date
|
|
periodRangeGmt - String
|
|
loadPortDays - Float
|
|
dischPortDays - Float
|
|
totalPortDays - Float
|
|
periodOpsBallastDays - Float
|
|
periodOpsLadenDays - Float
|
|
periodOpsWaitingDays - Float
|
|
periodOpsDischPortDays - Float
|
|
periodOpsLoadPortDays - Float
|
|
periodOpsBunkeringDays - Float
|
|
periodOpsIdleDays - Float
|
|
periodOpsPortDays - Float
|
|
periodOpsSeaDays - Float
|
|
voyageStatus - String
|
|
portionPct - Float
|
|
onHireDays - Float
|
|
waitingBunkerCost - Float
|
|
waitingCost - Float
|
|
month - Date
|
|
monthlyInterval - Boolean
|
|
emissionExpenses - Float
|
|
emissionExpensesRebill - Float
|
|
calcOptions_ApplyTcHire - Boolean
|
|
calcOptions_ApplyXHireToPeriod - Boolean
|
|
calcOptions_ApplyOffHire - Boolean
|
|
calcOptions_ApplyBallastBonus - Boolean
|
|
calcOptions_ApplyTcBunkerAdjToPeriod - Boolean
|
|
calcOptions_ApplyTcExpensesToPeriod - Boolean
|
|
calcOptions_ApplyBunkerCons - Boolean
|
|
calcOptions_ApplyOtherRevExpToPeriod - Boolean
|
|
calcOptions_ApplyPortExpensesToPeriod - Boolean
|
|
calcOptions_ApplyDemurrageToPeriod - Boolean
|
|
calcOptions_AdjustForOffHire - Boolean
|
|
calcOptions_AdjustForWaiting - Boolean
|
|
calcOptions_AdjustForBallastDays - Boolean
|
|
calcOptions_AdjustForDemurrageDays - Boolean
|
|
calcOptions_ReconcileBunkers - Boolean
|
|
calcOptions_ExcludeRunningCostsTCI - Boolean
|
|
calcOptions_ExcludeHireRelatedItemsTCO - Boolean
|
|
calcOptions_AccrueSettledLinkedTrades - Boolean
|
|
calcOptions_ApplyInternalFreightRevenueToPeriod - Boolean
|
|
calcOptions_CapitalizeAmortizeContractFulfillmentCosts - Boolean
|
|
calcOptions_ApplyTcRebillsToPeriod - Boolean
|
|
calcOptions_ApplyEmissionExpensesToPeriod - Boolean
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
tciCode - String
|
|
vesselName - String
|
|
tcoCode - String
|
|
fixtureNo - String
|
|
dataType - String
|
|
entryDateGmt - Date
|
|
oprType - String
|
|
cargoLift - Float
|
|
demCredit - Float
|
|
totalProfitLoss - Float
|
|
tce - Float
|
|
totalVoyageDays - Float
|
|
totalSeaDays - Float
|
|
totalWaitForLaycanDays - Float
|
|
totalWaitForOrdersDays - Float
|
|
vesselType - String
|
|
commenceDateLocal - Date
|
|
completeDateLocal - Date
|
|
commenceDateGmt - Date
|
|
completeDateGmt - Date
|
|
offHireDays - Float
|
|
totalBallastDays - Float
|
|
totalLadenDays - Float
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
snapshotType - String
|
|
snapshotRefDateLocal - Date
|
|
remarks - String
|
|
externalRef - String
|
|
applyTcExpensesToPeriod - Boolean
|
|
applyOtherRevenuesExpensesToPeriod - Boolean
|
|
applyAdditionalHireToPeriod - Boolean
|
|
applyTcBunkerAdjustmentsToPeriod - Boolean
|
|
applyPortExpensesToPeriod - Boolean
|
|
excludeHireRelatedItemsForLongTermTco - Boolean
|
|
applyInternalFreightRevenueToPeriod - Boolean
|
|
capitalizeAmortizeCostsPriorToPerformingPeriod - Boolean
|
|
applyTcHireToPeriod - Boolean
|
|
applyOffHireWaitingToPeriod - Boolean
|
|
applyBallastBonusToPeriod - Boolean
|
|
adjustPortionForOffHire - Boolean
|
|
adjustPortionForWaitingTime - Boolean
|
|
excludeRunningCostsForLongTermTcOrOv - Boolean
|
|
applyBunkerConsumptionToPeriod - Boolean
|
|
reconcileBunkerRobForCurrentVoyages - Boolean
|
|
adjustPortionForBallastDays - Boolean
|
|
applyDemurrageToPeriod - Boolean
|
|
adjustPortionForDemurrageDays - Boolean
|
|
accrueSettledLinkedTrades - Boolean
|
|
totalIdleDays - Float
|
|
totalBunkeringDays - Float
|
|
totalWaitingDays - Float
|
|
revenues - Float
|
|
expenses - Float
|
|
runningCost - Float
|
|
freight - Float
|
|
demurrage - Float
|
|
despatch - Float
|
|
freightComm - Float
|
|
freightAddComm - Float
|
|
freightTax - Float
|
|
freightCargoLoss - Float
|
|
demurrageComm - Float
|
|
demurrageAddComm - Float
|
|
rebills - Float
|
|
miscRevenue - Float
|
|
nonAccRevenue - Float
|
|
vesselDailyCost - Float
|
|
bunkers - Float
|
|
hire - Float
|
|
hireComm - Float
|
|
hireAddComm - Float
|
|
tciBunkerAdjustment - Float
|
|
offHire - Float
|
|
offHireBunkers - Float
|
|
offHireAddComm - Float
|
|
offHireComm - Float
|
|
cve - Float
|
|
offHireCve - Float
|
|
ballastBonus - Float
|
|
holdCleaning - Float
|
|
tciAdminFee - Float
|
|
tciMiscExpenses - Float
|
|
transshipmentCost - Float
|
|
lighteringCost - Float
|
|
tcoHire - Float
|
|
tcoHireComm - Float
|
|
tcoHireAddComm - Float
|
|
tcoBunkerAdjustment - Float
|
|
tcoCve - Float
|
|
tcoOffHire - Float
|
|
tcoOffHireBunkers - Float
|
|
tcoOffHireComm - Float
|
|
tcoOffHireAddComm - Float
|
|
tcoOffHireCve - Float
|
|
tcoBallastBonus - Float
|
|
tcoHoldCleaning - Float
|
|
tcoAdminFee - Float
|
|
tcoMiscRevenues - Float
|
|
portExpenses - Float
|
|
cargoExpenses - Float
|
|
surveyExpenses - Float
|
|
tolls - Float
|
|
miscExpenses - Float
|
|
nonAccExpenses - Float
|
|
vCInFreight - Float
|
|
vCInFreightComm - Float
|
|
vCInFreightAddComm - Float
|
|
vCInFreightTax - Float
|
|
vCInFreightCargoLoss - Float
|
|
vCInDemurrage - Float
|
|
vCInDemComm - Float
|
|
vCInDemAddComm - Float
|
|
vCInDespatch - Float
|
|
bareboatHire - Float
|
|
bareboatOffHire - Float
|
|
bareboatAddComm - Float
|
|
bareboatOffHireAddComm - Float
|
|
bareboatComm - Float
|
|
bareboatVoyageExpenses - Float
|
|
bareboatMiscExpenses - Float
|
|
bareboatAdjustments - Float
|
|
bareboatOffHireBunkers - Float
|
|
adminFees - Float
|
|
revenueAdjustment - Float
|
|
expenseAdjustment - Float
|
|
uncategorizedAdjustment - Float
|
|
interserviceRevenue - Float
|
|
exchangeDifference - Float
|
|
tciGratuities - Float
|
|
tciVictualling - Float
|
|
tciLashingandStowage - Float
|
|
tciReprExpAllowances - Float
|
|
tciOffHireGratuities - Float
|
|
tciOffHireVictualling - Float
|
|
tciOffHireLashingandStowage - Float
|
|
tciOffHireReprExpAllowances - Float
|
|
tcoGratuities - Float
|
|
tcoVictualling - Float
|
|
tcoLashingandStowage - Float
|
|
tcoReprExpAllowances - Float
|
|
tcoOffHireGratuities - Float
|
|
tcoOffHireVictualling - Float
|
|
tcoOffHireLashingandStowage - Float
|
|
tcoOffHireReprExpAllowances - Float
|
|
profitShare - Float
|
|
premiumIncome - Float
|
|
estimateID - String
|
|
cargoShortName - String
|
|
firstChartererShortName - String
|
|
firstLoadPortName - String
|
|
lastDischPortName - String
|
|
baseCurrency - String
|
|
forecast - Boolean
|
|
claimPending - Boolean
|
|
legalHold - Boolean
|
|
cancel - Boolean
|
|
voyageStatusCode - String
|
|
bunkerSwaps - Float
|
|
voyageReference - String
|
|
marketValuationRate - Float
|
|
marketValuationRateUnit - String
|
|
marketValuationSymbol - String
|
|
marketValuationCorrelation - Float
|
|
marketValuationAdjustment - Float
|
|
marketValuationLumpsumAmount - Float
|
|
marketResultIn - Float
|
|
marketResultOut - Float
|
|
lastNoonReportGmt - Date
|
|
vessel - VesselServiceImosVessel
|
|
voyage - VesselServiceImosVoyage
|
|
voyagePnlDrilldowns - [VesselServiceImosVoyagePnlDrilldown]
|
|
voyagePnlDetails - [VesselServiceImosVoyagePnlDetail]
|
|
voyagePnlCargos - [VesselServiceImosVoyagePnlCargo]
|
|
voyagePnlItineraryLines - [VesselServiceImosVoyagePnlItineraryLine]
|
|
voyagePnlBunkers - [VesselServiceImosVoyagePnlBunker]
|
|
voyageItineraryLoads - [VesselServiceImosVoyagePnlItineraryLine]
|
|
voyageItineraryDischarges - [VesselServiceImosVoyagePnlItineraryLine]
|
|
exchangeRates - [VesselServiceImosExchangeRate]
|
Example
{
"periodFromGmt": "2007-12-03",
"periodToGmt": "2007-12-03",
"periodRangeGmt": "xyz789",
"loadPortDays": 123.45,
"dischPortDays": 987.65,
"totalPortDays": 123.45,
"periodOpsBallastDays": 123.45,
"periodOpsLadenDays": 987.65,
"periodOpsWaitingDays": 987.65,
"periodOpsDischPortDays": 987.65,
"periodOpsLoadPortDays": 987.65,
"periodOpsBunkeringDays": 123.45,
"periodOpsIdleDays": 987.65,
"periodOpsPortDays": 123.45,
"periodOpsSeaDays": 123.45,
"voyageStatus": "abc123",
"portionPct": 987.65,
"onHireDays": 987.65,
"waitingBunkerCost": 123.45,
"waitingCost": 123.45,
"month": "2007-12-03",
"monthlyInterval": false,
"emissionExpenses": 123.45,
"emissionExpensesRebill": 123.45,
"calcOptions_ApplyTcHire": true,
"calcOptions_ApplyXHireToPeriod": true,
"calcOptions_ApplyOffHire": true,
"calcOptions_ApplyBallastBonus": false,
"calcOptions_ApplyTcBunkerAdjToPeriod": false,
"calcOptions_ApplyTcExpensesToPeriod": false,
"calcOptions_ApplyBunkerCons": true,
"calcOptions_ApplyOtherRevExpToPeriod": false,
"calcOptions_ApplyPortExpensesToPeriod": true,
"calcOptions_ApplyDemurrageToPeriod": true,
"calcOptions_AdjustForOffHire": true,
"calcOptions_AdjustForWaiting": false,
"calcOptions_AdjustForBallastDays": true,
"calcOptions_AdjustForDemurrageDays": false,
"calcOptions_ReconcileBunkers": false,
"calcOptions_ExcludeRunningCostsTCI": false,
"calcOptions_ExcludeHireRelatedItemsTCO": true,
"calcOptions_AccrueSettledLinkedTrades": false,
"calcOptions_ApplyInternalFreightRevenueToPeriod": false,
"calcOptions_CapitalizeAmortizeContractFulfillmentCosts": true,
"calcOptions_ApplyTcRebillsToPeriod": true,
"calcOptions_ApplyEmissionExpensesToPeriod": true,
"vesselCode": "abc123",
"voyageNo": 987,
"tciCode": "abc123",
"vesselName": "xyz789",
"tcoCode": "abc123",
"fixtureNo": "xyz789",
"dataType": "xyz789",
"entryDateGmt": "2007-12-03",
"oprType": "abc123",
"cargoLift": 987.65,
"demCredit": 123.45,
"totalProfitLoss": 123.45,
"tce": 987.65,
"totalVoyageDays": 123.45,
"totalSeaDays": 123.45,
"totalWaitForLaycanDays": 987.65,
"totalWaitForOrdersDays": 987.65,
"vesselType": "xyz789",
"commenceDateLocal": "2007-12-03",
"completeDateLocal": "2007-12-03",
"commenceDateGmt": "2007-12-03",
"completeDateGmt": "2007-12-03",
"offHireDays": 987.65,
"totalBallastDays": 123.45,
"totalLadenDays": 123.45,
"lastUser": "xyz789",
"lastUpdateGmt": "2007-12-03",
"snapshotType": "xyz789",
"snapshotRefDateLocal": "2007-12-03",
"remarks": "xyz789",
"externalRef": "xyz789",
"applyTcExpensesToPeriod": true,
"applyOtherRevenuesExpensesToPeriod": false,
"applyAdditionalHireToPeriod": true,
"applyTcBunkerAdjustmentsToPeriod": true,
"applyPortExpensesToPeriod": true,
"excludeHireRelatedItemsForLongTermTco": false,
"applyInternalFreightRevenueToPeriod": true,
"capitalizeAmortizeCostsPriorToPerformingPeriod": true,
"applyTcHireToPeriod": true,
"applyOffHireWaitingToPeriod": false,
"applyBallastBonusToPeriod": false,
"adjustPortionForOffHire": true,
"adjustPortionForWaitingTime": true,
"excludeRunningCostsForLongTermTcOrOv": true,
"applyBunkerConsumptionToPeriod": false,
"reconcileBunkerRobForCurrentVoyages": false,
"adjustPortionForBallastDays": false,
"applyDemurrageToPeriod": false,
"adjustPortionForDemurrageDays": true,
"accrueSettledLinkedTrades": true,
"totalIdleDays": 987.65,
"totalBunkeringDays": 123.45,
"totalWaitingDays": 987.65,
"revenues": 987.65,
"expenses": 987.65,
"runningCost": 123.45,
"freight": 987.65,
"demurrage": 987.65,
"despatch": 123.45,
"freightComm": 123.45,
"freightAddComm": 123.45,
"freightTax": 123.45,
"freightCargoLoss": 123.45,
"demurrageComm": 987.65,
"demurrageAddComm": 987.65,
"rebills": 987.65,
"miscRevenue": 123.45,
"nonAccRevenue": 987.65,
"vesselDailyCost": 123.45,
"bunkers": 123.45,
"hire": 123.45,
"hireComm": 987.65,
"hireAddComm": 123.45,
"tciBunkerAdjustment": 987.65,
"offHire": 987.65,
"offHireBunkers": 987.65,
"offHireAddComm": 123.45,
"offHireComm": 987.65,
"cve": 987.65,
"offHireCve": 987.65,
"ballastBonus": 987.65,
"holdCleaning": 123.45,
"tciAdminFee": 123.45,
"tciMiscExpenses": 987.65,
"transshipmentCost": 987.65,
"lighteringCost": 987.65,
"tcoHire": 987.65,
"tcoHireComm": 123.45,
"tcoHireAddComm": 987.65,
"tcoBunkerAdjustment": 987.65,
"tcoCve": 123.45,
"tcoOffHire": 123.45,
"tcoOffHireBunkers": 123.45,
"tcoOffHireComm": 987.65,
"tcoOffHireAddComm": 987.65,
"tcoOffHireCve": 987.65,
"tcoBallastBonus": 123.45,
"tcoHoldCleaning": 987.65,
"tcoAdminFee": 987.65,
"tcoMiscRevenues": 123.45,
"portExpenses": 123.45,
"cargoExpenses": 987.65,
"surveyExpenses": 987.65,
"tolls": 123.45,
"miscExpenses": 123.45,
"nonAccExpenses": 123.45,
"vCInFreight": 123.45,
"vCInFreightComm": 987.65,
"vCInFreightAddComm": 123.45,
"vCInFreightTax": 987.65,
"vCInFreightCargoLoss": 123.45,
"vCInDemurrage": 987.65,
"vCInDemComm": 987.65,
"vCInDemAddComm": 123.45,
"vCInDespatch": 123.45,
"bareboatHire": 123.45,
"bareboatOffHire": 987.65,
"bareboatAddComm": 987.65,
"bareboatOffHireAddComm": 123.45,
"bareboatComm": 987.65,
"bareboatVoyageExpenses": 123.45,
"bareboatMiscExpenses": 123.45,
"bareboatAdjustments": 123.45,
"bareboatOffHireBunkers": 987.65,
"adminFees": 987.65,
"revenueAdjustment": 123.45,
"expenseAdjustment": 987.65,
"uncategorizedAdjustment": 123.45,
"interserviceRevenue": 123.45,
"exchangeDifference": 123.45,
"tciGratuities": 123.45,
"tciVictualling": 987.65,
"tciLashingandStowage": 123.45,
"tciReprExpAllowances": 123.45,
"tciOffHireGratuities": 123.45,
"tciOffHireVictualling": 987.65,
"tciOffHireLashingandStowage": 987.65,
"tciOffHireReprExpAllowances": 987.65,
"tcoGratuities": 123.45,
"tcoVictualling": 987.65,
"tcoLashingandStowage": 123.45,
"tcoReprExpAllowances": 123.45,
"tcoOffHireGratuities": 123.45,
"tcoOffHireVictualling": 123.45,
"tcoOffHireLashingandStowage": 123.45,
"tcoOffHireReprExpAllowances": 987.65,
"profitShare": 987.65,
"premiumIncome": 987.65,
"estimateID": "abc123",
"cargoShortName": "abc123",
"firstChartererShortName": "abc123",
"firstLoadPortName": "xyz789",
"lastDischPortName": "abc123",
"baseCurrency": "abc123",
"forecast": false,
"claimPending": false,
"legalHold": true,
"cancel": false,
"voyageStatusCode": "xyz789",
"bunkerSwaps": 987.65,
"voyageReference": "abc123",
"marketValuationRate": 123.45,
"marketValuationRateUnit": "abc123",
"marketValuationSymbol": "abc123",
"marketValuationCorrelation": 987.65,
"marketValuationAdjustment": 123.45,
"marketValuationLumpsumAmount": 123.45,
"marketResultIn": 987.65,
"marketResultOut": 123.45,
"lastNoonReportGmt": "2007-12-03",
"vessel": VesselServiceImosVessel,
"voyage": VesselServiceImosVoyage,
"voyagePnlDrilldowns": [
VesselServiceImosVoyagePnlDrilldown
],
"voyagePnlDetails": [VesselServiceImosVoyagePnlDetail],
"voyagePnlCargos": [VesselServiceImosVoyagePnlCargo],
"voyagePnlItineraryLines": [
VesselServiceImosVoyagePnlItineraryLine
],
"voyagePnlBunkers": [VesselServiceImosVoyagePnlBunker],
"voyageItineraryLoads": [
VesselServiceImosVoyagePnlItineraryLine
],
"voyageItineraryDischarges": [
VesselServiceImosVoyagePnlItineraryLine
],
"exchangeRates": [VesselServiceImosExchangeRate]
}
VesselServiceImosVoyagePnlBunker
Example
{
"lastUpdateGmt": "2007-12-03",
"vesselCode": "abc123",
"voyageNo": 123,
"seq": 987,
"description": "abc123",
"receivedDateGmt": "2007-12-03",
"portName": "abc123",
"snapshotType": "xyz789",
"snapshotRefDateLocal": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUserID": "xyz789",
"voyagePnl": VesselServiceImosVoyagePnl
}
VesselServiceImosVoyagePnlCargo
Fields
| Field Name | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
|
dataType - String
|
|
snapshotType - String
|
|
snapshotRefDateLocal - Date
|
|
seq - Int
|
|
berthOrderNo - Int
|
|
portCargoSeq - Int
|
|
fixtureNo - String
|
|
fixtureCargoSeq - Int
|
|
cargoShortName - String
|
|
portFunction - String
|
|
altBLGross - Float
|
|
altShipGross - Float
|
|
lDQty - Float
|
|
api - Float
|
|
productNet - Float
|
|
blQty - Float
|
|
terms - String
|
|
tankName - String
|
|
blDischDate - Date
|
|
blCode - String
|
|
cpUnit - String
|
|
lastUserID - String
|
|
altUnit - String
|
|
lastUpdateGmt - Date
|
|
lDRate - Float
|
|
rateUnit - String
|
|
cargoID - Int
|
|
gradeSeqNo - Int
|
|
voyagePnl - VesselServiceImosVoyagePnl
|
|
voyagePnlItineraryLine - VesselServiceImosVoyagePnlItineraryLine
|
Example
{
"vesselCode": "xyz789",
"voyageNo": 123,
"dataType": "xyz789",
"snapshotType": "xyz789",
"snapshotRefDateLocal": "2007-12-03",
"seq": 987,
"berthOrderNo": 123,
"portCargoSeq": 987,
"fixtureNo": "xyz789",
"fixtureCargoSeq": 987,
"cargoShortName": "xyz789",
"portFunction": "xyz789",
"altBLGross": 123.45,
"altShipGross": 123.45,
"lDQty": 123.45,
"api": 123.45,
"productNet": 987.65,
"blQty": 987.65,
"terms": "xyz789",
"tankName": "abc123",
"blDischDate": "2007-12-03",
"blCode": "xyz789",
"cpUnit": "xyz789",
"lastUserID": "abc123",
"altUnit": "xyz789",
"lastUpdateGmt": "2007-12-03",
"lDRate": 987.65,
"rateUnit": "xyz789",
"cargoID": 987,
"gradeSeqNo": 123,
"voyagePnl": VesselServiceImosVoyagePnl,
"voyagePnlItineraryLine": VesselServiceImosVoyagePnlItineraryLine
}
VesselServiceImosVoyagePnlDetail
Fields
| Field Name | Description |
|---|---|
portSeqNo - Int
|
|
pnlCategory - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
seq - Int
|
|
dataType - String
|
|
source - String
|
|
portNo - Int
|
|
periodFromGmt - Date
|
|
periodToGmt - Date
|
|
rateBase - Float
|
|
billCode - String
|
|
amountCurr - Float
|
|
amountBase - Float
|
|
description - String
|
|
vendorType - String
|
|
vendorShortName - String
|
|
entryDateGmt - Date
|
|
lastUserID - String
|
|
remarks - String
|
|
taxCode - String
|
|
taxRate - Float
|
|
companyCode - String
|
|
subCode - String
|
|
percentage - Float
|
|
rateUnit - String
|
|
qtyUnit - String
|
|
accountType - String
|
|
currency - String
|
|
invoiceNo - String
|
|
account - String
|
|
portFunction - String
|
|
accountingDate - Date
|
|
transNo - Int
|
|
snapshotType - String
|
|
snapshotRefDateLocal - Date
|
|
pnlCategoryStored - String
|
|
drillSeq - Int
|
|
cargoID - Int
|
|
externalRef - String
|
|
lastUpdateGmt - Date
|
|
gradeSeqNo - Int
|
|
cargoShortName - String
|
|
rebillTransNo - Int
|
|
rebillSeq - Int
|
|
exchangeRate - Float
|
|
linkedItinerarySeq - Int
|
|
voyagePnl - VesselServiceImosVoyagePnl
|
|
voyagePnlItineraryLine - VesselServiceImosVoyagePnlItineraryLine
|
|
voyagePnlDrilldown - VesselServiceImosVoyagePnlDrilldown
|
|
parentDrilldownItem - VesselServiceImosVoyagePnlDrilldown
|
|
rootDrilldownItem - VesselServiceImosVoyagePnlDrilldown
|
|
rootDrilldownItemStored - VesselServiceImosVoyagePnlDrilldown
|
Example
{
"portSeqNo": 123,
"pnlCategory": "abc123",
"vesselCode": "abc123",
"voyageNo": 123,
"seq": 987,
"dataType": "abc123",
"source": "xyz789",
"portNo": 987,
"periodFromGmt": "2007-12-03",
"periodToGmt": "2007-12-03",
"rateBase": 987.65,
"billCode": "xyz789",
"amountCurr": 987.65,
"amountBase": 123.45,
"description": "xyz789",
"vendorType": "xyz789",
"vendorShortName": "xyz789",
"entryDateGmt": "2007-12-03",
"lastUserID": "abc123",
"remarks": "xyz789",
"taxCode": "abc123",
"taxRate": 123.45,
"companyCode": "abc123",
"subCode": "abc123",
"percentage": 987.65,
"rateUnit": "abc123",
"qtyUnit": "abc123",
"accountType": "abc123",
"currency": "xyz789",
"invoiceNo": "abc123",
"account": "abc123",
"portFunction": "abc123",
"accountingDate": "2007-12-03",
"transNo": 123,
"snapshotType": "xyz789",
"snapshotRefDateLocal": "2007-12-03",
"pnlCategoryStored": "xyz789",
"drillSeq": 123,
"cargoID": 123,
"externalRef": "xyz789",
"lastUpdateGmt": "2007-12-03",
"gradeSeqNo": 123,
"cargoShortName": "abc123",
"rebillTransNo": 987,
"rebillSeq": 123,
"exchangeRate": 987.65,
"linkedItinerarySeq": 123,
"voyagePnl": VesselServiceImosVoyagePnl,
"voyagePnlItineraryLine": VesselServiceImosVoyagePnlItineraryLine,
"voyagePnlDrilldown": VesselServiceImosVoyagePnlDrilldown,
"parentDrilldownItem": VesselServiceImosVoyagePnlDrilldown,
"rootDrilldownItem": VesselServiceImosVoyagePnlDrilldown,
"rootDrilldownItemStored": VesselServiceImosVoyagePnlDrilldown
}
VesselServiceImosVoyagePnlDrilldown
Fields
| Field Name | Description |
|---|---|
pnlCategory - String
|
|
pnlCategoryStored - String
|
|
accountName - String
|
|
isRootCategory - Boolean
|
|
pnlSection - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
seq - Int
|
|
parentSeq - Int
|
|
groupID - String
|
|
description - String
|
|
estimatedAmountBase - Float
|
|
actualAmountBase - Float
|
|
postedAmountBase - Float
|
|
paidAmountBase - Float
|
|
snapshotType - String
|
|
snapshotRefDateLocal - Date
|
|
dataType - String
|
|
currency - String
|
|
estimatedAmountCurr - Float
|
|
actualAmountCurr - Float
|
|
postedAmountCurr - Float
|
|
paidAmountCurr - Float
|
|
account - String
|
|
counterpartyCompanyNo - Int
|
|
externalRef - String
|
|
isLineItem - Boolean
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
itinerarySeq - Int
|
|
cargoID - Int
|
|
transNo - Int
|
|
counterpartyType - String
|
|
counterpartyShortName - String
|
|
initialEstimatedAmountBase - Float
|
|
initialEstimatedAmountCurr - Float
|
|
rootSeq - Int
|
|
remarks - String
|
|
counterparty - VesselServiceImosAddressBook
|
|
voyage - VesselServiceImosVoyage
|
|
voyagePnl - VesselServiceImosVoyagePnl
|
|
parentDrilldownItem - VesselServiceImosVoyagePnlDrilldown
|
|
childDrilldownItem - VesselServiceImosVoyagePnlDrilldown
|
|
rootDrilldownItem - VesselServiceImosVoyagePnlDrilldown
|
|
rootDrilldownItemStored - VesselServiceImosVoyagePnlDrilldown
|
|
runningCostsDrilldownItem - VesselServiceImosVoyagePnlDrilldown
|
Example
{
"pnlCategory": "abc123",
"pnlCategoryStored": "abc123",
"accountName": "abc123",
"isRootCategory": true,
"pnlSection": "xyz789",
"vesselCode": "abc123",
"voyageNo": 123,
"seq": 987,
"parentSeq": 987,
"groupID": "abc123",
"description": "abc123",
"estimatedAmountBase": 123.45,
"actualAmountBase": 987.65,
"postedAmountBase": 123.45,
"paidAmountBase": 987.65,
"snapshotType": "xyz789",
"snapshotRefDateLocal": "2007-12-03",
"dataType": "abc123",
"currency": "xyz789",
"estimatedAmountCurr": 123.45,
"actualAmountCurr": 987.65,
"postedAmountCurr": 987.65,
"paidAmountCurr": 987.65,
"account": "abc123",
"counterpartyCompanyNo": 987,
"externalRef": "abc123",
"isLineItem": true,
"entryDateGmt": "2007-12-03",
"lastUser": "abc123",
"lastUpdateGmt": "2007-12-03",
"itinerarySeq": 987,
"cargoID": 987,
"transNo": 987,
"counterpartyType": "abc123",
"counterpartyShortName": "xyz789",
"initialEstimatedAmountBase": 123.45,
"initialEstimatedAmountCurr": 123.45,
"rootSeq": 987,
"remarks": "xyz789",
"counterparty": VesselServiceImosAddressBook,
"voyage": VesselServiceImosVoyage,
"voyagePnl": VesselServiceImosVoyagePnl,
"parentDrilldownItem": VesselServiceImosVoyagePnlDrilldown,
"childDrilldownItem": VesselServiceImosVoyagePnlDrilldown,
"rootDrilldownItem": VesselServiceImosVoyagePnlDrilldown,
"rootDrilldownItemStored": VesselServiceImosVoyagePnlDrilldown,
"runningCostsDrilldownItem": VesselServiceImosVoyagePnlDrilldown
}
VesselServiceImosVoyagePnlItineraryLine
Fields
| Field Name | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
|
seq - Int
|
|
entryDateGmt - Date
|
|
dataType - String
|
|
status - String
|
|
ballastOrLaden - String
|
|
orderNo - Int
|
|
portNo - Int
|
|
portName - String
|
|
miles - Float
|
|
speed - Float
|
|
extraSeaDays - Float
|
|
arrivalDateGmt - Date
|
|
anchorageInHours - Float
|
|
portDays - Float
|
|
departureDateGmt - Date
|
|
arrivalDateLocal - Date
|
|
departureDateLocal - Date
|
|
portFunction - String
|
|
demurrageDays - Float
|
|
despatchDays - Float
|
|
lastUserID - String
|
|
pilotToBerthHours - Float
|
|
berthToPilotHours - Float
|
|
seaDays - Float
|
|
idleDays - Float
|
|
extraPortDays - Float
|
|
lSSeaDays - Float
|
|
lSPortDays - Float
|
|
lowSpeedZoneMiles - Float
|
|
lowSpeedZoneDays - Float
|
|
lsMiles - Float
|
|
snapshotType - String
|
|
snapshotRefDateLocal - Date
|
|
externalRef - String
|
|
lastUpdateGmt - Date
|
|
seaEcaID - Int
|
|
voyagePnl - VesselServiceImosVoyagePnl
|
|
voyagePnlCargos - [VesselServiceImosVoyagePnlCargo]
|
Example
{
"vesselCode": "abc123",
"voyageNo": 123,
"seq": 987,
"entryDateGmt": "2007-12-03",
"dataType": "abc123",
"status": "xyz789",
"ballastOrLaden": "xyz789",
"orderNo": 987,
"portNo": 987,
"portName": "abc123",
"miles": 987.65,
"speed": 987.65,
"extraSeaDays": 123.45,
"arrivalDateGmt": "2007-12-03",
"anchorageInHours": 987.65,
"portDays": 123.45,
"departureDateGmt": "2007-12-03",
"arrivalDateLocal": "2007-12-03",
"departureDateLocal": "2007-12-03",
"portFunction": "xyz789",
"demurrageDays": 987.65,
"despatchDays": 987.65,
"lastUserID": "abc123",
"pilotToBerthHours": 123.45,
"berthToPilotHours": 987.65,
"seaDays": 987.65,
"idleDays": 123.45,
"extraPortDays": 123.45,
"lSSeaDays": 123.45,
"lSPortDays": 123.45,
"lowSpeedZoneMiles": 987.65,
"lowSpeedZoneDays": 987.65,
"lsMiles": 123.45,
"snapshotType": "xyz789",
"snapshotRefDateLocal": "2007-12-03",
"externalRef": "xyz789",
"lastUpdateGmt": "2007-12-03",
"seaEcaID": 123,
"voyagePnl": VesselServiceImosVoyagePnl,
"voyagePnlCargos": [VesselServiceImosVoyagePnlCargo]
}
VesselService_Vessel
Fields
| Field Name | Description |
|---|---|
capacityBaleM3 - Float
|
|
capacityGrainM3 - Float
|
|
fillingLimitPercentage - Float
|
|
isActive - Boolean
|
|
containerCapacityFEU - Float
|
|
deckCapacityM3 - Float
|
|
isActiveForVeslink - Boolean
|
|
last5CargoShortNames - String
|
|
foeConversionFactor - Float
|
|
sqlID - Int
|
|
vesselCode - String
|
|
name - String
|
|
vesselType - String
|
|
suezType - String
|
|
fleet - String
|
|
flag - String
|
|
unitTypeCode - String
|
|
ownership - String
|
|
callLetters - String
|
|
operator - String
|
|
lOA - Float
|
|
beam - Float
|
|
depth - Float
|
|
dailyCost - Float
|
|
opa90 - Float
|
|
dWT - Float
|
|
capacity - Float
|
|
totalBBLs - Float
|
|
vesselSummerDraft - Float
|
|
vesselWinterDraft - Float
|
|
maxDraft - Float
|
|
tPC - Float
|
|
gRT - Float
|
|
nRT - Float
|
|
panamaGross - Float
|
|
panamaNet - Float
|
|
suezGross - Float
|
|
suezNet - Float
|
|
ladenSpeed - Float
|
|
ballastSpeed - Float
|
|
tradeArea - String
|
|
foeConversionFactorInverted - Float
|
|
maxAirDraft - Float
|
|
telex - String
|
|
fax - String
|
|
imoNo - String
|
|
phone - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
allowUpdate - Int
|
|
hullType - String
|
|
lastUser - String
|
|
yearBuilt - Int
|
|
isBargeUnit - Int
|
|
vapor - Boolean
|
|
igs - Boolean
|
|
nonActive - Boolean
|
|
allowDespatch - Boolean
|
|
trackInlandBunkers - Boolean
|
|
estOnly - Boolean
|
|
co2Fitted - Boolean
|
|
bowThruster - Boolean
|
|
strengthened - Boolean
|
|
australianLadders - Boolean
|
|
toledoSuitable - Boolean
|
|
tveValid - Boolean
|
|
rejected - Boolean
|
|
logFitted - Boolean
|
|
grainFitted - Boolean
|
|
commercialMgmt - Boolean
|
|
etaExcluded - Boolean
|
|
a60Fitted - Boolean
|
|
offshoreBarge - Boolean
|
|
useBoilOffMinCons - Boolean
|
|
useScrubbers - Boolean
|
|
isCommonlyUsed - Boolean
|
|
isUnitTow - Boolean
|
|
activeForOnboard - Boolean
|
|
isGeneralCargo - Boolean
|
|
equipmentFlags - Int
|
|
email - String
|
|
refNo - String
|
|
satC - String
|
|
ventilation - String
|
|
iceClass - String
|
|
grabsQty - Float
|
|
grabsCap - Float
|
|
engineMake - String
|
|
holdStrengthened - String
|
|
inheritRouteFromVessel - String
|
|
remarks - String
|
|
officialNo - String
|
|
pnsNo - String
|
|
hatchType - String
|
|
hAndMValue - String
|
|
pAndIClub - String
|
|
gapValue - String
|
|
maxBallastDailyBoilOffPct - Float
|
|
maxLadenDailyBoilOffPct - Float
|
|
demAnalyst - String
|
|
satA - String
|
|
satB - String
|
|
miniM - String
|
|
masterPhone - String
|
|
bridgePhone - String
|
|
ccrNo - String
|
|
chtrCoordinator - String
|
|
opsCoordinator - String
|
|
beaufortNo - Int
|
|
seaStateNo - Int
|
|
seaSwellNo - Int
|
|
alerts - String
|
|
dailyAdminFee - Float
|
|
adminFeeCurr - String
|
|
vesselTypeCorrelation - Float
|
|
crossRefNo - String
|
|
replicationFlags - Int
|
|
veslinkCompany - String
|
|
unitFactor - Float
|
|
fuelZoneSetID - Int
|
|
vesselTypeAdjustment - Float
|
|
naturalBoilOffBallastSpeed - Float
|
|
naturalBoilOffLadenSpeed - Float
|
|
bunkerConfigVersion - Int
|
|
companyCode - String
|
|
scrubberType - String
|
|
vettingRemarks - String
|
|
iceClassType - String
|
|
engineType - String
|
|
fuelZoneSet - VesselServiceImosFuelZoneSet
|
|
vesselDetails - VesselServiceImosVesselDetails
|
|
ownerAddressBook - VesselServiceImosAddressBook
|
|
vesselTypeData - VesselServiceImosVesselType
|
|
vesselVariables - VesselServiceImosVesselVariables
|
|
barge - VesselServiceImosBarge
|
|
voyagePnls - [VesselServiceImosVoyagePnl]
|
|
vesselDraftMarks - [VesselServiceImosVesselDraftMarks]
|
|
vesselCranes - [VesselServiceImosVesselCrane]
|
|
poolAssignments - [VesselServiceImosPoolAssignment]
|
|
vesselHolds - [VesselServiceImosVesselHold]
|
|
vesselTceTargets - [VesselServiceImosVesselTceTarget]
|
|
vesselSeaConsBunkers - [VesselServiceImosVesselSeaConsBunker]
|
|
vesselSeaCons - [VesselServiceImosVesselSeaCons]
|
|
vesselPortCons - [VesselServiceImosVesselPortCons]
|
|
vesselInspections - [VesselServiceImosVesselInspection]
|
|
vesselIncidents - [VesselServiceImosVesselIncident]
|
|
vesselHatchs - [VesselServiceImosVesselHatch]
|
|
vesselEvaluations - [VesselServiceImosVesselEvaluation]
|
|
vesselDrafts - [VesselServiceImosVesselDraft]
|
|
vesselConsModes - [VesselServiceImosVesselConsMode]
|
|
vesselBunkerTanks - [VesselServiceImosVesselBunkerTank]
|
|
vesselBoats - [VesselServiceImosVesselBoats]
|
|
vesselTanks - [VesselServiceImosVesselTank]
|
|
vesselFleetMember - [VesselServiceImosVesselFleetMemberFull]
|
|
userDefinedFields - Json
|
|
builder - String
|
|
registry - String
|
|
vesselOwnerNew - String
|
|
vesselSource - String
|
|
latestEvaluation - LatestVesselEvaluation
|
|
speedSource - String
|
Example
{
"capacityBaleM3": 123.45,
"capacityGrainM3": 987.65,
"fillingLimitPercentage": 123.45,
"isActive": true,
"containerCapacityFEU": 123.45,
"deckCapacityM3": 123.45,
"isActiveForVeslink": true,
"last5CargoShortNames": "xyz789",
"foeConversionFactor": 123.45,
"sqlID": 987,
"vesselCode": "xyz789",
"name": "abc123",
"vesselType": "xyz789",
"suezType": "abc123",
"fleet": "xyz789",
"flag": "abc123",
"unitTypeCode": "xyz789",
"ownership": "abc123",
"callLetters": "abc123",
"operator": "xyz789",
"lOA": 987.65,
"beam": 987.65,
"depth": 123.45,
"dailyCost": 987.65,
"opa90": 123.45,
"dWT": 123.45,
"capacity": 123.45,
"totalBBLs": 987.65,
"vesselSummerDraft": 987.65,
"vesselWinterDraft": 123.45,
"maxDraft": 123.45,
"tPC": 987.65,
"gRT": 123.45,
"nRT": 987.65,
"panamaGross": 987.65,
"panamaNet": 123.45,
"suezGross": 123.45,
"suezNet": 987.65,
"ladenSpeed": 987.65,
"ballastSpeed": 987.65,
"tradeArea": "abc123",
"foeConversionFactorInverted": 123.45,
"maxAirDraft": 987.65,
"telex": "xyz789",
"fax": "xyz789",
"imoNo": "xyz789",
"phone": "abc123",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"allowUpdate": 123,
"hullType": "abc123",
"lastUser": "xyz789",
"yearBuilt": 987,
"isBargeUnit": 123,
"vapor": false,
"igs": false,
"nonActive": true,
"allowDespatch": false,
"trackInlandBunkers": false,
"estOnly": true,
"co2Fitted": true,
"bowThruster": true,
"strengthened": false,
"australianLadders": false,
"toledoSuitable": true,
"tveValid": true,
"rejected": false,
"logFitted": true,
"grainFitted": true,
"commercialMgmt": false,
"etaExcluded": true,
"a60Fitted": true,
"offshoreBarge": true,
"useBoilOffMinCons": false,
"useScrubbers": true,
"isCommonlyUsed": false,
"isUnitTow": false,
"activeForOnboard": true,
"isGeneralCargo": false,
"equipmentFlags": 987,
"email": "abc123",
"refNo": "abc123",
"satC": "xyz789",
"ventilation": "abc123",
"iceClass": "xyz789",
"grabsQty": 987.65,
"grabsCap": 123.45,
"engineMake": "abc123",
"holdStrengthened": "abc123",
"inheritRouteFromVessel": "xyz789",
"remarks": "xyz789",
"officialNo": "xyz789",
"pnsNo": "abc123",
"hatchType": "xyz789",
"hAndMValue": "abc123",
"pAndIClub": "xyz789",
"gapValue": "abc123",
"maxBallastDailyBoilOffPct": 987.65,
"maxLadenDailyBoilOffPct": 987.65,
"demAnalyst": "abc123",
"satA": "xyz789",
"satB": "abc123",
"miniM": "xyz789",
"masterPhone": "abc123",
"bridgePhone": "abc123",
"ccrNo": "abc123",
"chtrCoordinator": "xyz789",
"opsCoordinator": "abc123",
"beaufortNo": 123,
"seaStateNo": 123,
"seaSwellNo": 123,
"alerts": "xyz789",
"dailyAdminFee": 987.65,
"adminFeeCurr": "abc123",
"vesselTypeCorrelation": 987.65,
"crossRefNo": "abc123",
"replicationFlags": 123,
"veslinkCompany": "abc123",
"unitFactor": 987.65,
"fuelZoneSetID": 123,
"vesselTypeAdjustment": 123.45,
"naturalBoilOffBallastSpeed": 123.45,
"naturalBoilOffLadenSpeed": 123.45,
"bunkerConfigVersion": 123,
"companyCode": "xyz789",
"scrubberType": "abc123",
"vettingRemarks": "xyz789",
"iceClassType": "abc123",
"engineType": "xyz789",
"fuelZoneSet": VesselServiceImosFuelZoneSet,
"vesselDetails": VesselServiceImosVesselDetails,
"ownerAddressBook": VesselServiceImosAddressBook,
"vesselTypeData": VesselServiceImosVesselType,
"vesselVariables": VesselServiceImosVesselVariables,
"barge": VesselServiceImosBarge,
"voyagePnls": [VesselServiceImosVoyagePnl],
"vesselDraftMarks": [VesselServiceImosVesselDraftMarks],
"vesselCranes": [VesselServiceImosVesselCrane],
"poolAssignments": [VesselServiceImosPoolAssignment],
"vesselHolds": [VesselServiceImosVesselHold],
"vesselTceTargets": [VesselServiceImosVesselTceTarget],
"vesselSeaConsBunkers": [
VesselServiceImosVesselSeaConsBunker
],
"vesselSeaCons": [VesselServiceImosVesselSeaCons],
"vesselPortCons": [VesselServiceImosVesselPortCons],
"vesselInspections": [
VesselServiceImosVesselInspection
],
"vesselIncidents": [VesselServiceImosVesselIncident],
"vesselHatchs": [VesselServiceImosVesselHatch],
"vesselEvaluations": [
VesselServiceImosVesselEvaluation
],
"vesselDrafts": [VesselServiceImosVesselDraft],
"vesselConsModes": [VesselServiceImosVesselConsMode],
"vesselBunkerTanks": [
VesselServiceImosVesselBunkerTank
],
"vesselBoats": [VesselServiceImosVesselBoats],
"vesselTanks": [VesselServiceImosVesselTank],
"vesselFleetMember": [
VesselServiceImosVesselFleetMemberFull
],
"userDefinedFields": Json,
"builder": "abc123",
"registry": "xyz789",
"vesselOwnerNew": "xyz789",
"vesselSource": "abc123",
"latestEvaluation": LatestVesselEvaluation,
"speedSource": "abc123"
}
VesselTank
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
capacity - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
vesselCode - String
|
|
vesselType - String
|
|
type - String
|
|
name - String
|
|
location - String
|
|
capacityA1 - Float
|
|
capacityA2 - Float
|
|
capacityA3 - Float
|
|
coating - String
|
|
cargoLastName - String
|
|
cargoFirstName - String
|
|
cargoThirdName - String
|
|
tankNo - Int
|
|
category - String
|
|
sourceSystemName - String
|
|
cargoThird - CargoName
|
|
cargoFirst - CargoName
|
|
cargoLast - CargoName
|
|
vessel - Vessel
|
|
voyages - [Voyage]
|
|
voyageCargoHandlingStowages - [VoyageCargoHandlingStowage]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"capacity": 123.45,
"customFieldByID": Any,
"customField": Any,
"vesselCode": "abc123",
"vesselType": "abc123",
"type": "xyz789",
"name": "abc123",
"location": "xyz789",
"capacityA1": 123.45,
"capacityA2": 987.65,
"capacityA3": 123.45,
"coating": "abc123",
"cargoLastName": "abc123",
"cargoFirstName": "xyz789",
"cargoThirdName": "abc123",
"tankNo": 123,
"category": "xyz789",
"sourceSystemName": "xyz789",
"cargoThird": CargoName,
"cargoFirst": CargoName,
"cargoLast": CargoName,
"vessel": Vessel,
"voyages": [Voyage],
"voyageCargoHandlingStowages": [
VoyageCargoHandlingStowage
],
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
VesselTankCategoryEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Main"
VesselTankCategoryEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VesselTankCategoryEnum
|
|
isNot - VesselTankCategoryEnum
|
|
isIn - [VesselTankCategoryEnum]
|
Example
{"is": "Main", "isNot": "Main", "isIn": ["Main"]}
VesselTankFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselTankFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselTankFormQueryWhere
}
VesselTankFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesselTankFormQueryWhere!]
|
|
or - [VesselTankFormQueryWhere!]
|
|
rawExpression - String
|
|
capacity - NumberWhereValueExpression
|
|
vesselCode - StringWhereValueExpression
|
|
vesselType - StringWhereValueExpression
|
|
type - StringWhereValueExpression
|
|
name - StringWhereValueExpression
|
|
location - StringWhereValueExpression
|
|
capacityA1 - NumberWhereValueExpression
|
|
capacityA2 - NumberWhereValueExpression
|
|
capacityA3 - NumberWhereValueExpression
|
|
coating - StringWhereValueExpression
|
|
cargoLastName - StringWhereValueExpression
|
|
cargoFirstName - StringWhereValueExpression
|
|
cargoThirdName - StringWhereValueExpression
|
|
tankNo - NumberWhereValueExpression
|
|
category - VesselTankCategoryEnumValueExpression
|
|
sourceSystemName - StringWhereValueExpression
|
|
cargoThird - CargoNameFormQueryWhere
|
|
cargoFirst - CargoNameFormQueryWhere
|
|
cargoLast - CargoNameFormQueryWhere
|
|
vessel - VesselFormQueryWhere
|
Example
{
"and": [VesselTankFormQueryWhere],
"or": [VesselTankFormQueryWhere],
"rawExpression": "xyz789",
"capacity": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"vesselType": StringWhereValueExpression,
"type": StringWhereValueExpression,
"name": StringWhereValueExpression,
"location": StringWhereValueExpression,
"capacityA1": NumberWhereValueExpression,
"capacityA2": NumberWhereValueExpression,
"capacityA3": NumberWhereValueExpression,
"coating": StringWhereValueExpression,
"cargoLastName": StringWhereValueExpression,
"cargoFirstName": StringWhereValueExpression,
"cargoThirdName": StringWhereValueExpression,
"tankNo": NumberWhereValueExpression,
"category": VesselTankCategoryEnumValueExpression,
"sourceSystemName": StringWhereValueExpression,
"cargoThird": CargoNameFormQueryWhere,
"cargoFirst": CargoNameFormQueryWhere,
"cargoLast": CargoNameFormQueryWhere,
"vessel": VesselFormQueryWhere
}
VesselTankRelationships
Fields
| Field Name | Description |
|---|---|
cargoThird - RelationshipDefinition
|
|
cargoFirst - RelationshipDefinition
|
|
cargoLast - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
voyages - RelationshipDefinition
|
|
voyageCargoHandlingStowages - RelationshipDefinition
|
Example
{
"cargoThird": RelationshipDefinition,
"cargoFirst": RelationshipDefinition,
"cargoLast": RelationshipDefinition,
"vessel": RelationshipDefinition,
"voyages": RelationshipDefinition,
"voyageCargoHandlingStowages": RelationshipDefinition
}
VesselTceTarget
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
effectiveFromGmt - Date
|
|
tceTarget - Float
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
vessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"effectiveFromGmt": "2007-12-03",
"tceTarget": 987.65,
"lastUser": "abc123",
"lastUpdateGmt": "2007-12-03",
"vessel": Vessel,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
VesselTceTargetFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselTceTargetFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselTceTargetFormQueryWhere
}
VesselTceTargetFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesselTceTargetFormQueryWhere!]
|
|
or - [VesselTceTargetFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
effectiveFromGmt - DateWhereValueExpression
|
|
tceTarget - NumberWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
vessel - VesselFormQueryWhere
|
Example
{
"and": [VesselTceTargetFormQueryWhere],
"or": [VesselTceTargetFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"effectiveFromGmt": DateWhereValueExpression,
"tceTarget": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"vessel": VesselFormQueryWhere
}
VesselTceTargetRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
Example
{"vessel": RelationshipDefinition}
VesselType
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
type - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
blank - String
|
|
routeCorrelation - Float
|
|
basisRoute - String
|
|
basisQuantity - Float
|
|
weightedDaysCorrelation - Float
|
|
benchmarkVesselCode - String
|
|
defaultTypeCode - String
|
|
minDWT - Int
|
|
maxDWT - Int
|
|
ownerUserNo - Int
|
|
vessel - Vessel
|
|
owner - User
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"type": "abc123",
"customFieldByID": Any,
"customField": Any,
"blank": "abc123",
"routeCorrelation": 123.45,
"basisRoute": "xyz789",
"basisQuantity": 987.65,
"weightedDaysCorrelation": 123.45,
"benchmarkVesselCode": "abc123",
"defaultTypeCode": "abc123",
"minDWT": 987,
"maxDWT": 123,
"ownerUserNo": 123,
"vessel": Vessel,
"owner": User,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VesselTypeCondition
Fields
| Field Name | Description |
|---|---|
possibleAisTypes - [VesselAisTypeSet]
|
|
dwtGte - Float
|
|
dwtLt - Float
|
Example
{
"possibleAisTypes": [VesselAisTypeSet],
"dwtGte": 123.45,
"dwtLt": 123.45
}
VesselTypeDefinition
Fields
| Field Name | Description |
|---|---|
vesselType - String!
|
|
unitTypeCode - String!
|
|
condition - VesselTypeCondition
|
Example
{
"vesselType": "abc123",
"unitTypeCode": "abc123",
"condition": VesselTypeCondition
}
VesselTypeFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselTypeFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselTypeFormQueryWhere
}
VesselTypeFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesselTypeFormQueryWhere!]
|
|
or - [VesselTypeFormQueryWhere!]
|
|
rawExpression - String
|
|
type - StringWhereValueExpression
|
|
blank - StringWhereValueExpression
|
|
routeCorrelation - NumberWhereValueExpression
|
|
basisRoute - StringWhereValueExpression
|
|
basisQuantity - NumberWhereValueExpression
|
|
weightedDaysCorrelation - NumberWhereValueExpression
|
|
benchmarkVesselCode - StringWhereValueExpression
|
|
defaultTypeCode - StringWhereValueExpression
|
|
minDWT - NumberWhereValueExpression
|
|
maxDWT - NumberWhereValueExpression
|
|
ownerUserNo - NumberWhereValueExpression
|
|
vessel - VesselFormQueryWhere
|
|
owner - UserFormQueryWhere
|
Example
{
"and": [VesselTypeFormQueryWhere],
"or": [VesselTypeFormQueryWhere],
"rawExpression": "xyz789",
"type": StringWhereValueExpression,
"blank": StringWhereValueExpression,
"routeCorrelation": NumberWhereValueExpression,
"basisRoute": StringWhereValueExpression,
"basisQuantity": NumberWhereValueExpression,
"weightedDaysCorrelation": NumberWhereValueExpression,
"benchmarkVesselCode": StringWhereValueExpression,
"defaultTypeCode": StringWhereValueExpression,
"minDWT": NumberWhereValueExpression,
"maxDWT": NumberWhereValueExpression,
"ownerUserNo": NumberWhereValueExpression,
"vessel": VesselFormQueryWhere,
"owner": UserFormQueryWhere
}
VesselTypeRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
|
owner - RelationshipDefinition
|
Example
{
"vessel": RelationshipDefinition,
"owner": RelationshipDefinition
}
VesselVariables
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
freshWater - Float
|
|
constantsSea - Float
|
|
constantsOther - Float
|
|
constantsLakes - Float
|
|
vessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
Example
{
"_id": "abc123",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"freshWater": 123.45,
"constantsSea": 123.45,
"constantsOther": 987.65,
"constantsLakes": 987.65,
"vessel": Vessel,
"_keys": ["abc123"],
"_intents": ["xyz789"]
}
VesselVariablesRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
Example
{"vessel": RelationshipDefinition}
VesselVetting
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
isApproved - Boolean
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
isRejected - Boolean
|
|
fixtureNo - String
|
|
vesselCode - String
|
|
seq - Int
|
|
portNo - Int
|
|
portFunc - String
|
|
counterpartyShortName - String
|
|
counterpartyType - String
|
|
vettedIndication - String
|
|
approvedOnDateGmt - Date
|
|
approvedBy - String
|
|
remarks - String
|
|
cargo - String
|
|
port - Port
|
|
addressBook - AddressBook
|
|
vessel - Vessel
|
|
fixture - Fixture
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"isApproved": true,
"customFieldByID": Any,
"customField": Any,
"isRejected": true,
"fixtureNo": "xyz789",
"vesselCode": "xyz789",
"seq": 987,
"portNo": 987,
"portFunc": "abc123",
"counterpartyShortName": "abc123",
"counterpartyType": "abc123",
"vettedIndication": "abc123",
"approvedOnDateGmt": "2007-12-03",
"approvedBy": "abc123",
"remarks": "xyz789",
"cargo": "abc123",
"port": Port,
"addressBook": AddressBook,
"vessel": Vessel,
"fixture": Fixture,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VesselVettingFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VesselVettingFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VesselVettingFormQueryWhere
}
VesselVettingFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VesselVettingFormQueryWhere!]
|
|
or - [VesselVettingFormQueryWhere!]
|
|
rawExpression - String
|
|
fixtureNo - StringWhereValueExpression
|
|
vesselCode - StringWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
portNo - NumberWhereValueExpression
|
|
portFunc - StringWhereValueExpression
|
|
counterpartyShortName - StringWhereValueExpression
|
|
counterpartyType - StringWhereValueExpression
|
|
vettedIndication - VesselVettingVettedIndicationEnumValueExpression
|
|
approvedOnDateGmt - DateWhereValueExpression
|
|
approvedBy - StringWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
cargo - StringWhereValueExpression
|
|
port - PortFormQueryWhere
|
|
addressBook - AddressBookFormQueryWhere
|
|
vessel - VesselFormQueryWhere
|
|
fixture - FixtureFormQueryWhere
|
Example
{
"and": [VesselVettingFormQueryWhere],
"or": [VesselVettingFormQueryWhere],
"rawExpression": "abc123",
"fixtureNo": StringWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"seq": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"portFunc": StringWhereValueExpression,
"counterpartyShortName": StringWhereValueExpression,
"counterpartyType": StringWhereValueExpression,
"vettedIndication": VesselVettingVettedIndicationEnumValueExpression,
"approvedOnDateGmt": DateWhereValueExpression,
"approvedBy": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"cargo": StringWhereValueExpression,
"port": PortFormQueryWhere,
"addressBook": AddressBookFormQueryWhere,
"vessel": VesselFormQueryWhere,
"fixture": FixtureFormQueryWhere
}
VesselVettingRelationships
Fields
| Field Name | Description |
|---|---|
port - RelationshipDefinition
|
|
addressBook - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
fixture - RelationshipDefinition
|
Example
{
"port": RelationshipDefinition,
"addressBook": RelationshipDefinition,
"vessel": RelationshipDefinition,
"fixture": RelationshipDefinition
}
VesselVettingVettedIndicationEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Pending"
VesselVettingVettedIndicationEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VesselVettingVettedIndicationEnum
|
|
isNot - VesselVettingVettedIndicationEnum
|
|
isIn - [VesselVettingVettedIndicationEnum]
|
Example
{"is": "Pending", "isNot": "Pending", "isIn": ["Pending"]}
VesselsAndBargesRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
Example
{"vessel": RelationshipDefinition}
View
ViewContextRequest
ViewIdValueRequest
ViewsRootMutation
Fields
| Field Name | Description |
|---|---|
clearCurrentViewHistory - [String!]!
|
|
Arguments
|
|
deleteView - Boolean
|
|
Arguments
|
|
clearView - View
|
|
Arguments
|
|
updateView - View
|
|
Arguments
|
|
createView - View
|
|
Arguments
|
|
makeViewPublic - View
|
|
Arguments
|
|
setCurrentView - View
|
|
Arguments
|
|
Example
{
"clearCurrentViewHistory": ["xyz789"],
"deleteView": true,
"clearView": View,
"updateView": View,
"createView": View,
"makeViewPublic": View,
"setCurrentView": View
}
ViewsRootQuery
Fields
| Field Name | Description |
|---|---|
getViews - [View!]!
|
|
Arguments
|
|
getView - View
|
|
Arguments
|
|
getCurrentView - View
|
|
Arguments
|
|
getCurrentViewHistory - [String!]!
|
|
Arguments
|
|
Example
{
"getViews": [View],
"getView": View,
"getCurrentView": View,
"getCurrentViewHistory": ["xyz789"]
}
Voyage
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tcoBrokersList - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
equipmentList - String
|
|
boats - String
|
|
equipmentContractIDs - String
|
|
barges - String
|
|
ballastPort - String
|
|
remarks - String
|
|
repositionPort - String
|
|
bunkCalcMethod - String
|
|
localUTCOffset - String
|
|
voyagePnlVariance - Float
|
|
tcoChartCoordinator - String
|
|
chtrSpecialist - String
|
|
nominationDate - Date
|
|
estimateID - String
|
|
keyUsers - String
|
|
currentPortName - String
|
|
currentPortStatus - String
|
|
nextPortName - String
|
|
nextPortStatus - String
|
|
cargoCounterpartyShortNames - String
|
|
counterpartyShortName - String
|
|
counterpartyType - String
|
|
counterpartyCompanyNo - Int
|
|
tradeAreaName - String
|
|
laycanAlerts - Int
|
|
dailyCostString - String
|
|
vesselDailyCost - String
|
|
cargoList - String
|
|
cargoGradesList - String
|
|
cargoShortNamesList - String
|
|
cargoBookingNosList - String
|
|
cargoExternalRefsList - String
|
|
openDate - Date
|
|
voyageRangeGMT - String
|
|
totalLoadCargoVolume - Float
|
|
totalSaleCPCargoVolume - Float
|
|
voyageStatus - String
|
|
totalPortDays - Float
|
|
totalSeaDays - Float
|
|
lSMiles - Int
|
|
lSPortDays - Float
|
|
lSSeaDays - Float
|
|
isLSVoyage - Boolean
|
|
basisPnl - Float
|
|
comparePnl - Float
|
|
pnlReport - String
|
|
operationsReport - String
|
|
performanceReport - String
|
|
basisVsCompare - String
|
|
previousVoyageNo - Int
|
|
nextVoyageNo - Int
|
|
firstLoadPort - String
|
|
lastDischargePort - String
|
|
oprType - String
|
|
sqlID - Int
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
tcCode - String
|
|
vesselName - String
|
|
deliveryPortNo - Int
|
|
voyageStatusCode - String
|
|
departmentNo - Int
|
|
teamNo - Int
|
|
tcoCode - String
|
|
fixtureNo - String
|
|
commenceDateLocal - Date
|
|
completeDateLocal - Date
|
|
dailyCost - Float
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
bunkerCalcMethod - Int
|
|
consecutiveYN - String
|
|
lastUser - String
|
|
externalRef - String
|
|
opsCoordinator - String
|
|
heating - Boolean
|
|
tRBunker - Boolean
|
|
tciBnkAdj - Boolean
|
|
lastTci - Boolean
|
|
forecast - Boolean
|
|
daDesk - Boolean
|
|
claimPending - Boolean
|
|
legalHold - Boolean
|
|
ice - Boolean
|
|
pool - Boolean
|
|
clean - Boolean
|
|
coated - Boolean
|
|
highRisk - Boolean
|
|
cancel - Boolean
|
|
supportJob - Boolean
|
|
drydock - Boolean
|
|
nonPool - Boolean
|
|
lastTco - Boolean
|
|
offhireVoyage - Boolean
|
|
firstTci - Boolean
|
|
firstTco - Boolean
|
|
tveValid - Boolean
|
|
blComplete - Boolean
|
|
piracyEnabled - Boolean
|
|
piracyDisabled - Boolean
|
|
dischApproved - Boolean
|
|
includeInCover - Boolean
|
|
market - Boolean
|
|
trackBargeRobs - Boolean
|
|
legacyTowVoyage - Boolean
|
|
lowSulfurOnly - Boolean
|
|
disableBnkrWarnings - Boolean
|
|
companyCode - String
|
|
lobCode - String
|
|
voyageReference - String
|
|
commenceDateGmt - Date
|
|
completeDateGmt - Date
|
|
mVERate - Float
|
|
maxDailyBoilOffBallast - Float
|
|
maxDailyBoilOffLaden - Float
|
|
vesselLaycanFrom - Date
|
|
vesselLaycanTo - Date
|
|
voyageTemplateID - Int
|
|
currBase - String
|
|
poolFee - Float
|
|
segment - String
|
|
opsCoordinator2 - String
|
|
voyageController - String
|
|
fDManager - String
|
|
lossControlStatus - String
|
|
lossControlNotes - String
|
|
parentVesselCode - String
|
|
parentVoyageNo - Int
|
|
financeCoordinator - String
|
|
fuelZoneSetID - Int
|
|
marketDailyHireRate - Float
|
|
disableBackupFuelTypes - Boolean
|
|
restrictEdits - Boolean
|
|
noPoolDays - Boolean
|
|
enableBunkerRequirementDrivenWorkflow - Boolean
|
|
useScrubbers - Boolean
|
|
voyageBooking - Boolean
|
|
destMirrorVoyage - Boolean
|
|
syncEmissionsData - Boolean
|
|
includeCarbonExpenseInPnl - Boolean
|
|
useImprovedAttachmentKey - Boolean
|
|
manualOverrideAgreedEtsEmission - Boolean
|
|
manualOverrideAgreedEtsCost - Boolean
|
|
manualEtsExchangeRate - Boolean
|
|
manualOverrideFuelEuExchangeRate - Boolean
|
|
manualOverrideFuelEuAgreedPenaltyEur - Boolean
|
|
manualOverrideFuelEuAgreedPenaltyBase - Boolean
|
|
includeFuelEuExpenseInPnl - Boolean
|
|
manualOverrideFuelEuAgreedCompBalance - Boolean
|
|
manualLNGPricing - Boolean
|
|
naturalBoilOffBallastSpeed - Float
|
|
naturalBoilOffLadenSpeed - Float
|
|
scrubberType - String
|
|
closedBy - String
|
|
closedOnGmt - Date
|
|
marketValuationRateBase - Float
|
|
marketValuationRateUnit - String
|
|
marketValuationSymbol - String
|
|
marketValuationCorrelation - Float
|
|
marketValuationAdjustment - Float
|
|
marketValuationLumpsumAmountBase - Float
|
|
voyageAer - Float
|
|
voyageCiiRating - String
|
|
etsCO2Price - Float
|
|
etsCO2PriceCurrency - String
|
|
etsCO2PriceExchangeRate - Float
|
|
cO2Quantity - Float
|
|
etsCO2Quantity - Float
|
|
etsCO2Cost - Float
|
|
transportWork - Float
|
|
eEOI - Float
|
|
agreedEtsEmission - Float
|
|
agreedEtsCost - Float
|
|
previousDistance - Float
|
|
previousEmission - Float
|
|
previousAer - Float
|
|
previousCiiGrade - String
|
|
endOfVoyageDistance - Float
|
|
endOfVoyageEmission - Float
|
|
endOfVoyageAer - Float
|
|
endOfVoyageCiiGrade - String
|
|
etsPreVoyagePortNo - Int
|
|
etsPostVoyagePortNo - Int
|
|
fuelEUComplianceBalance - Float
|
|
fuelEUPenalty - Float
|
|
fuelEUTotalEnergy - Float
|
|
fuelEUExchangeRate - Float
|
|
fuelEUAgreedPenaltyEUR - Float
|
|
fuelEUAgreedPenaltyBase - Float
|
|
fuelEUAgreedComplianceBalance - Float
|
|
initialLNGPrice - Float
|
|
dischargeLNGPrice - Float
|
|
initialLNGCalorificValue - Float
|
|
dischargeLNGCalorificValue - Float
|
|
tradeType - TradeType
|
|
voyageTemplate - VoyageTemplate
|
|
fuelZoneSet - FuelZoneSet
|
|
lob - Lob
|
|
user - User
|
|
fixture - Fixture
|
|
team - Team
|
|
tradeArea - TradeArea
|
|
vessel - Vessel
|
|
voyageActPnl - VoyagePnl
|
|
voyageEstPnl - VoyagePnl
|
|
voyagePstPnl - VoyagePnl
|
|
voyageActPnlBasis - VoyagePnl
|
|
voyageActPnlCompare - VoyagePnl
|
|
department - Department
|
|
firstCargo - Cargo
|
|
currentPort - VoyageItinerary
|
|
nextPort - VoyageItinerary
|
|
firstBallastPort - VoyageItinerary
|
|
firstTermPort - VoyageItinerary
|
|
firstLoadItin - VoyageItinerary
|
|
firstDiscItin - VoyageItinerary
|
|
lastLoadItin - VoyageItinerary
|
|
lastDiscItin - VoyageItinerary
|
|
firstItin - VoyageItinerary
|
|
lastItin - VoyageItinerary
|
|
tciContract - TimeCharterContract
|
|
tcoContract - TimeCharterContract
|
|
tcoDetails - TimeCharterOutDetails
|
|
firstFixtureBallastPort - VoyageItinerary
|
|
firstFixtureTermPort - VoyageItinerary
|
|
companyAddressBook - AddressBook
|
|
company - Company
|
|
voyageEstimate - VoyageEstimate
|
|
voyageRemarks - VoyageRemarks
|
|
opsCoordinatorUser - ImosUser
|
|
charteringCoordinatorUser - ImosUser
|
|
opsCoordinatorUser2 - ImosUser
|
|
controllerUser - ImosUser
|
|
fDManagerUser - ImosUser
|
|
financeCoordinatorUser - ImosUser
|
|
latestActivityReport - VoyageActivityReport
|
|
latestPositionReport - VoyageActivityReport
|
|
previousVoyage - Voyage
|
|
nextVoyage - Voyage
|
|
voyageEmissions - [VoyageEmissions]
|
|
voyagePnls - [VoyagePnl]
|
|
voyageEquipmentEvents - [VoyageEquipmentEvent]
|
|
voyageContacts - [VoyageContact]
|
|
voyageBunkerSummaries - [VoyageBunkerSummary]
|
|
voyageBunkerInventories - [VoyageBunkerInventory]
|
|
voyageProfitShares - [VoyageProfitShare]
|
|
poolingDistributions - [PoolingDistribution]
|
|
delays - [Delay]
|
|
voyageCargoHandlingDocuments - [VoyageCargoHandlingDocument]
|
|
voyageActivityReports - [VoyageActivityReport]
|
|
laytimes - [Laytime]
|
|
financialsInvoiceDetails - [FinancialsInvoiceDetail]
|
|
operationsInvoiceDetails - [OperationsInvoiceDetails]
|
|
voyageItineraries - [VoyageItinerary]
|
|
saleCargoContracts - [Cargo]
|
|
voyageCargoHandlings - [VoyageCargoHandling]
|
|
loadCargoHandlings - [VoyageCargoHandling]
|
|
discCargoHandlings - [VoyageCargoHandling]
|
|
voyageItinLoads - [VoyageItinerary]
|
|
voyageItinDischarges - [VoyageItinerary]
|
|
voyageItineraryBerths - [VoyageItineraryBerth]
|
|
tcoBrokers - [TimeCharterBroker]
|
|
cargos - [Cargo]
|
|
cargoGrades - [CargoGrades]
|
|
boatEquipmentEvents - [VoyageEquipmentEvent]
|
|
bargeEquipmentEvents - [VoyageEquipmentEvent]
|
|
contractedEquipmentEvents - [VoyageEquipmentEvent]
|
|
voyageBunkerLifting - [VoyageBunkerLifting]
|
|
voyageAllRemarks - [VoyageRemarks]
|
|
alerts - [Alert]
|
|
voyageProjectedInvoice - [VoyageProjectedInvoice]
|
|
voyageLegSummary - [VoyageLegSummary]
|
|
voyageLegDetails - [VoyageLegDetails]
|
|
voyagePnlSummary - [VoyagePnlSummary]
|
|
orderedVoyageItineraries - [VoyageItinerary]
|
|
voyageCargoTransfers - [VoyageCargoTransfer]
|
|
voyageInstruction - [VoyageInstruction]
|
|
attachments - [Attachment]
|
|
voyageNote - [ClaimNote]
|
|
sCCVoyageEmissionsMessages - [SCCVoyageEmissionsMessageRecord]
|
|
Arguments
|
|
publishVoyageUpdateMessages - [PublishVoyageUpdateMessageRecord]
|
|
Arguments
|
|
scheduleVoyageMessages - [ScheduleVoyageMessageRecord]
|
|
Arguments
|
|
updateVoyageMessages - [UpdateVoyageMessageRecord]
|
|
Arguments
|
|
changesSinceLast - VoyageChangesSinceLast
|
|
userDefinedFields - Json
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"tcoBrokersList": "xyz789",
"customFieldByID": Any,
"customField": Any,
"equipmentList": "abc123",
"boats": "abc123",
"equipmentContractIDs": "xyz789",
"barges": "abc123",
"ballastPort": "abc123",
"remarks": "xyz789",
"repositionPort": "abc123",
"bunkCalcMethod": "xyz789",
"localUTCOffset": "xyz789",
"voyagePnlVariance": 987.65,
"tcoChartCoordinator": "abc123",
"chtrSpecialist": "abc123",
"nominationDate": "2007-12-03",
"estimateID": "abc123",
"keyUsers": "xyz789",
"currentPortName": "abc123",
"currentPortStatus": "xyz789",
"nextPortName": "abc123",
"nextPortStatus": "xyz789",
"cargoCounterpartyShortNames": "xyz789",
"counterpartyShortName": "xyz789",
"counterpartyType": "xyz789",
"counterpartyCompanyNo": 987,
"tradeAreaName": "abc123",
"laycanAlerts": 123,
"dailyCostString": "xyz789",
"vesselDailyCost": "abc123",
"cargoList": "xyz789",
"cargoGradesList": "abc123",
"cargoShortNamesList": "abc123",
"cargoBookingNosList": "xyz789",
"cargoExternalRefsList": "xyz789",
"openDate": "2007-12-03",
"voyageRangeGMT": "xyz789",
"totalLoadCargoVolume": 987.65,
"totalSaleCPCargoVolume": 987.65,
"voyageStatus": "abc123",
"totalPortDays": 987.65,
"totalSeaDays": 123.45,
"lSMiles": 123,
"lSPortDays": 987.65,
"lSSeaDays": 123.45,
"isLSVoyage": true,
"basisPnl": 987.65,
"comparePnl": 123.45,
"pnlReport": "xyz789",
"operationsReport": "abc123",
"performanceReport": "abc123",
"basisVsCompare": "abc123",
"previousVoyageNo": 987,
"nextVoyageNo": 123,
"firstLoadPort": "abc123",
"lastDischargePort": "abc123",
"oprType": "abc123",
"sqlID": 123,
"vesselCode": "abc123",
"voyageNo": 123,
"tcCode": "xyz789",
"vesselName": "xyz789",
"deliveryPortNo": 987,
"voyageStatusCode": "xyz789",
"departmentNo": 987,
"teamNo": 123,
"tcoCode": "xyz789",
"fixtureNo": "abc123",
"commenceDateLocal": "2007-12-03",
"completeDateLocal": "2007-12-03",
"dailyCost": 987.65,
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"bunkerCalcMethod": 123,
"consecutiveYN": "xyz789",
"lastUser": "abc123",
"externalRef": "abc123",
"opsCoordinator": "xyz789",
"heating": false,
"tRBunker": false,
"tciBnkAdj": false,
"lastTci": false,
"forecast": false,
"daDesk": false,
"claimPending": true,
"legalHold": true,
"ice": false,
"pool": false,
"clean": false,
"coated": false,
"highRisk": true,
"cancel": true,
"supportJob": true,
"drydock": false,
"nonPool": true,
"lastTco": true,
"offhireVoyage": false,
"firstTci": true,
"firstTco": true,
"tveValid": true,
"blComplete": false,
"piracyEnabled": false,
"piracyDisabled": true,
"dischApproved": false,
"includeInCover": true,
"market": false,
"trackBargeRobs": true,
"legacyTowVoyage": false,
"lowSulfurOnly": false,
"disableBnkrWarnings": true,
"companyCode": "abc123",
"lobCode": "xyz789",
"voyageReference": "abc123",
"commenceDateGmt": "2007-12-03",
"completeDateGmt": "2007-12-03",
"mVERate": 123.45,
"maxDailyBoilOffBallast": 123.45,
"maxDailyBoilOffLaden": 123.45,
"vesselLaycanFrom": "2007-12-03",
"vesselLaycanTo": "2007-12-03",
"voyageTemplateID": 987,
"currBase": "xyz789",
"poolFee": 123.45,
"segment": "abc123",
"opsCoordinator2": "abc123",
"voyageController": "xyz789",
"fDManager": "abc123",
"lossControlStatus": "xyz789",
"lossControlNotes": "xyz789",
"parentVesselCode": "xyz789",
"parentVoyageNo": 123,
"financeCoordinator": "abc123",
"fuelZoneSetID": 987,
"marketDailyHireRate": 987.65,
"disableBackupFuelTypes": true,
"restrictEdits": true,
"noPoolDays": false,
"enableBunkerRequirementDrivenWorkflow": true,
"useScrubbers": false,
"voyageBooking": true,
"destMirrorVoyage": true,
"syncEmissionsData": true,
"includeCarbonExpenseInPnl": false,
"useImprovedAttachmentKey": false,
"manualOverrideAgreedEtsEmission": true,
"manualOverrideAgreedEtsCost": true,
"manualEtsExchangeRate": true,
"manualOverrideFuelEuExchangeRate": false,
"manualOverrideFuelEuAgreedPenaltyEur": false,
"manualOverrideFuelEuAgreedPenaltyBase": false,
"includeFuelEuExpenseInPnl": true,
"manualOverrideFuelEuAgreedCompBalance": false,
"manualLNGPricing": true,
"naturalBoilOffBallastSpeed": 987.65,
"naturalBoilOffLadenSpeed": 123.45,
"scrubberType": "xyz789",
"closedBy": "xyz789",
"closedOnGmt": "2007-12-03",
"marketValuationRateBase": 123.45,
"marketValuationRateUnit": "xyz789",
"marketValuationSymbol": "xyz789",
"marketValuationCorrelation": 987.65,
"marketValuationAdjustment": 987.65,
"marketValuationLumpsumAmountBase": 123.45,
"voyageAer": 123.45,
"voyageCiiRating": "xyz789",
"etsCO2Price": 123.45,
"etsCO2PriceCurrency": "abc123",
"etsCO2PriceExchangeRate": 987.65,
"cO2Quantity": 123.45,
"etsCO2Quantity": 123.45,
"etsCO2Cost": 123.45,
"transportWork": 987.65,
"eEOI": 987.65,
"agreedEtsEmission": 123.45,
"agreedEtsCost": 987.65,
"previousDistance": 987.65,
"previousEmission": 987.65,
"previousAer": 987.65,
"previousCiiGrade": "xyz789",
"endOfVoyageDistance": 987.65,
"endOfVoyageEmission": 123.45,
"endOfVoyageAer": 123.45,
"endOfVoyageCiiGrade": "xyz789",
"etsPreVoyagePortNo": 123,
"etsPostVoyagePortNo": 123,
"fuelEUComplianceBalance": 987.65,
"fuelEUPenalty": 987.65,
"fuelEUTotalEnergy": 123.45,
"fuelEUExchangeRate": 123.45,
"fuelEUAgreedPenaltyEUR": 987.65,
"fuelEUAgreedPenaltyBase": 987.65,
"fuelEUAgreedComplianceBalance": 987.65,
"initialLNGPrice": 123.45,
"dischargeLNGPrice": 123.45,
"initialLNGCalorificValue": 123.45,
"dischargeLNGCalorificValue": 123.45,
"tradeType": TradeType,
"voyageTemplate": VoyageTemplate,
"fuelZoneSet": FuelZoneSet,
"lob": Lob,
"user": User,
"fixture": Fixture,
"team": Team,
"tradeArea": TradeArea,
"vessel": Vessel,
"voyageActPnl": VoyagePnl,
"voyageEstPnl": VoyagePnl,
"voyagePstPnl": VoyagePnl,
"voyageActPnlBasis": VoyagePnl,
"voyageActPnlCompare": VoyagePnl,
"department": Department,
"firstCargo": Cargo,
"currentPort": VoyageItinerary,
"nextPort": VoyageItinerary,
"firstBallastPort": VoyageItinerary,
"firstTermPort": VoyageItinerary,
"firstLoadItin": VoyageItinerary,
"firstDiscItin": VoyageItinerary,
"lastLoadItin": VoyageItinerary,
"lastDiscItin": VoyageItinerary,
"firstItin": VoyageItinerary,
"lastItin": VoyageItinerary,
"tciContract": TimeCharterContract,
"tcoContract": TimeCharterContract,
"tcoDetails": TimeCharterOutDetails,
"firstFixtureBallastPort": VoyageItinerary,
"firstFixtureTermPort": VoyageItinerary,
"companyAddressBook": AddressBook,
"company": Company,
"voyageEstimate": VoyageEstimate,
"voyageRemarks": VoyageRemarks,
"opsCoordinatorUser": ImosUser,
"charteringCoordinatorUser": ImosUser,
"opsCoordinatorUser2": ImosUser,
"controllerUser": ImosUser,
"fDManagerUser": ImosUser,
"financeCoordinatorUser": ImosUser,
"latestActivityReport": VoyageActivityReport,
"latestPositionReport": VoyageActivityReport,
"previousVoyage": Voyage,
"nextVoyage": Voyage,
"voyageEmissions": [VoyageEmissions],
"voyagePnls": [VoyagePnl],
"voyageEquipmentEvents": [VoyageEquipmentEvent],
"voyageContacts": [VoyageContact],
"voyageBunkerSummaries": [VoyageBunkerSummary],
"voyageBunkerInventories": [VoyageBunkerInventory],
"voyageProfitShares": [VoyageProfitShare],
"poolingDistributions": [PoolingDistribution],
"delays": [Delay],
"voyageCargoHandlingDocuments": [
VoyageCargoHandlingDocument
],
"voyageActivityReports": [VoyageActivityReport],
"laytimes": [Laytime],
"financialsInvoiceDetails": [FinancialsInvoiceDetail],
"operationsInvoiceDetails": [OperationsInvoiceDetails],
"voyageItineraries": [VoyageItinerary],
"saleCargoContracts": [Cargo],
"voyageCargoHandlings": [VoyageCargoHandling],
"loadCargoHandlings": [VoyageCargoHandling],
"discCargoHandlings": [VoyageCargoHandling],
"voyageItinLoads": [VoyageItinerary],
"voyageItinDischarges": [VoyageItinerary],
"voyageItineraryBerths": [VoyageItineraryBerth],
"tcoBrokers": [TimeCharterBroker],
"cargos": [Cargo],
"cargoGrades": [CargoGrades],
"boatEquipmentEvents": [VoyageEquipmentEvent],
"bargeEquipmentEvents": [VoyageEquipmentEvent],
"contractedEquipmentEvents": [VoyageEquipmentEvent],
"voyageBunkerLifting": [VoyageBunkerLifting],
"voyageAllRemarks": [VoyageRemarks],
"alerts": [Alert],
"voyageProjectedInvoice": [VoyageProjectedInvoice],
"voyageLegSummary": [VoyageLegSummary],
"voyageLegDetails": [VoyageLegDetails],
"voyagePnlSummary": [VoyagePnlSummary],
"orderedVoyageItineraries": [VoyageItinerary],
"voyageCargoTransfers": [VoyageCargoTransfer],
"voyageInstruction": [VoyageInstruction],
"attachments": [Attachment],
"voyageNote": [ClaimNote],
"sCCVoyageEmissionsMessages": [
SCCVoyageEmissionsMessageRecord
],
"publishVoyageUpdateMessages": [
PublishVoyageUpdateMessageRecord
],
"scheduleVoyageMessages": [ScheduleVoyageMessageRecord],
"updateVoyageMessages": [UpdateVoyageMessageRecord],
"changesSinceLast": VoyageChangesSinceLast,
"userDefinedFields": Json,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageActivityReport
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
averageRpm - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
averageSpeed - Float
|
|
averageSteamSpeed - Float
|
|
totalRevs - Float
|
|
meanDraft - Float
|
|
reportTypeCode - String
|
|
nextItinerarySeq - Int
|
|
windDegree - Float
|
|
seaDegree - Float
|
|
swellDegree - Float
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
itinerarySeq - Int
|
|
reportType - String
|
|
cpStatus - Int
|
|
ballastLaden - String
|
|
orderedSpeed - Float
|
|
projectedSpeed - Float
|
|
reportDateGmt - Date
|
|
gmtOffsetHours - Float
|
|
latitude - String
|
|
longitude - String
|
|
observedDistance - Int
|
|
distanceToGo - Int
|
|
dwt - Float
|
|
fwdDraft - Float
|
|
aftDraft - Float
|
|
meanDraftInternal - Float
|
|
cargoTemperature - Float
|
|
engineDistance - Float
|
|
slippagePercentage - Float
|
|
totalRevsInternal - Float
|
|
averageBhp - Float
|
|
generator1Hrs - Float
|
|
maxLdIndicator - Float
|
|
generator2Hrs - Float
|
|
generator3Hrs - Float
|
|
beaufortScaleNo - Int
|
|
windDirection - String
|
|
seaState - Int
|
|
seaDirection - String
|
|
seaHeight - Float
|
|
seaSwell - Int
|
|
swellDirection - String
|
|
swellHeight - Float
|
|
airTemp - String
|
|
seaTemp - String
|
|
barometricPressure - String
|
|
barometricMovement - String
|
|
remarks - String
|
|
lastUpdateGmt - Date
|
|
lastUserID - String
|
|
waterwayCode - String
|
|
waterwayMarker - Int
|
|
headingDegrees - Int
|
|
headingDirection - String
|
|
isRejected - Boolean
|
|
isDelayStart - Boolean
|
|
isDelayEnd - Boolean
|
|
isAvgRpmCalculated - Boolean
|
|
isForcedBoilOff - Boolean
|
|
isInferPosition - Boolean
|
|
freshWaterRob - Float
|
|
freshWaterRec - Float
|
|
distilledWaterRob - Float
|
|
distilledWaterRec - Float
|
|
delayHours - Float
|
|
delayType - Int
|
|
delayReason - Int
|
|
externalRef - String
|
|
slopRec - Float
|
|
slopRob - Float
|
|
masterLastName - String
|
|
engineerLastName - String
|
|
badWeatherHours - Float
|
|
fuelConsMode - String
|
|
gmsControlMode - String
|
|
masterFirstName - String
|
|
engineerFirstName - String
|
|
engineLoadPercentage - Float
|
|
reportedSlipPercentage - Float
|
|
loggedDistance - Float
|
|
lngBogConsumed - Float
|
|
cargoTempUnit - String
|
|
currentSpeed - Float
|
|
currentDirection - String
|
|
steamingHours - Float
|
|
reportedSpeed - Float
|
|
generator1Kwhr - Float
|
|
generator2Kwhr - Float
|
|
generator3Kwhr - Float
|
|
mainEngineKwhr - Float
|
|
badWeatherDistance - Float
|
|
generator4Hrs - Float
|
|
generator4Kwhr - Float
|
|
boilerHours - Float
|
|
fwGeneratorHours - Float
|
|
freshWaterCons - Float
|
|
distilledWaterCons - Float
|
|
distilledWaterProd - Float
|
|
incineratorHours - Float
|
|
displacement - Float
|
|
mainEngineHours - Float
|
|
auxEngineHours - Float
|
|
averageRpmInternal - Float
|
|
averageSpeedInternal - Float
|
|
averageEngineSpeed - Float
|
|
averageSteamSpeedInternal - Float
|
|
midDraft - Float
|
|
portFwdDraft - Float
|
|
portMidDraft - Float
|
|
portAftDraft - Float
|
|
starboardFwdDraft - Float
|
|
starboardMidDraft - Float
|
|
starboardAftDraft - Float
|
|
currentLocationGaugeName - String
|
|
currentLocationWaterLevel - Float
|
|
currentLocationUOM - String
|
|
restrictedLocationGaugeName - String
|
|
restrictedLocationWaterLevel - Float
|
|
restrictedLocationUOM - String
|
|
salinity - Float
|
|
ballast - Float
|
|
crewStores - Float
|
|
lubes - Float
|
|
constant - Float
|
|
draftUnit - String
|
|
refCargoQty - Float
|
|
refPortNo - Int
|
|
numberOfTugs - Int
|
|
positionNote - String
|
|
lngReadingType - String
|
|
mMBtuPerM3 - Float
|
|
port - Port
|
|
voyageItinerary - VoyageItinerary
|
|
voyage - Voyage
|
|
itineraryPort - Port
|
|
vessel - Vessel
|
|
weatherBeaufortScale - WeatherState
|
|
weatherSeaState - WeatherState
|
|
weatherSwellState - WeatherState
|
|
tankConditions - [TankCondition]
|
|
activityReportBunkerDetails - [ActivityReportBunkerDetail]
|
|
publishActivityReportMessages - [PublishActivityReportMessageRecord]
|
|
Arguments
|
|
publishPositionMessages - [PublishPositionMessageRecord]
|
|
Arguments
|
|
positionReportMessages - [PositionReportMessageRecord]
|
|
Arguments
|
|
changesSinceLast - VoyageActivityReportChangesSinceLast
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"averageRpm": 123.45,
"customFieldByID": Any,
"customField": Any,
"averageSpeed": 123.45,
"averageSteamSpeed": 123.45,
"totalRevs": 123.45,
"meanDraft": 123.45,
"reportTypeCode": "abc123",
"nextItinerarySeq": 123,
"windDegree": 987.65,
"seaDegree": 987.65,
"swellDegree": 123.45,
"vesselCode": "abc123",
"voyageNo": 123,
"itinerarySeq": 123,
"reportType": "abc123",
"cpStatus": 987,
"ballastLaden": "abc123",
"orderedSpeed": 987.65,
"projectedSpeed": 123.45,
"reportDateGmt": "2007-12-03",
"gmtOffsetHours": 987.65,
"latitude": "xyz789",
"longitude": "abc123",
"observedDistance": 123,
"distanceToGo": 123,
"dwt": 123.45,
"fwdDraft": 123.45,
"aftDraft": 123.45,
"meanDraftInternal": 123.45,
"cargoTemperature": 123.45,
"engineDistance": 987.65,
"slippagePercentage": 123.45,
"totalRevsInternal": 123.45,
"averageBhp": 987.65,
"generator1Hrs": 987.65,
"maxLdIndicator": 987.65,
"generator2Hrs": 987.65,
"generator3Hrs": 123.45,
"beaufortScaleNo": 123,
"windDirection": "xyz789",
"seaState": 123,
"seaDirection": "abc123",
"seaHeight": 123.45,
"seaSwell": 123,
"swellDirection": "xyz789",
"swellHeight": 123.45,
"airTemp": "xyz789",
"seaTemp": "xyz789",
"barometricPressure": "xyz789",
"barometricMovement": "xyz789",
"remarks": "abc123",
"lastUpdateGmt": "2007-12-03",
"lastUserID": "abc123",
"waterwayCode": "xyz789",
"waterwayMarker": 987,
"headingDegrees": 123,
"headingDirection": "abc123",
"isRejected": true,
"isDelayStart": false,
"isDelayEnd": false,
"isAvgRpmCalculated": true,
"isForcedBoilOff": true,
"isInferPosition": true,
"freshWaterRob": 123.45,
"freshWaterRec": 987.65,
"distilledWaterRob": 987.65,
"distilledWaterRec": 987.65,
"delayHours": 123.45,
"delayType": 123,
"delayReason": 987,
"externalRef": "xyz789",
"slopRec": 123.45,
"slopRob": 987.65,
"masterLastName": "xyz789",
"engineerLastName": "abc123",
"badWeatherHours": 123.45,
"fuelConsMode": "xyz789",
"gmsControlMode": "xyz789",
"masterFirstName": "abc123",
"engineerFirstName": "abc123",
"engineLoadPercentage": 987.65,
"reportedSlipPercentage": 987.65,
"loggedDistance": 987.65,
"lngBogConsumed": 123.45,
"cargoTempUnit": "xyz789",
"currentSpeed": 987.65,
"currentDirection": "xyz789",
"steamingHours": 987.65,
"reportedSpeed": 987.65,
"generator1Kwhr": 123.45,
"generator2Kwhr": 123.45,
"generator3Kwhr": 123.45,
"mainEngineKwhr": 123.45,
"badWeatherDistance": 987.65,
"generator4Hrs": 123.45,
"generator4Kwhr": 123.45,
"boilerHours": 987.65,
"fwGeneratorHours": 987.65,
"freshWaterCons": 987.65,
"distilledWaterCons": 987.65,
"distilledWaterProd": 123.45,
"incineratorHours": 123.45,
"displacement": 987.65,
"mainEngineHours": 123.45,
"auxEngineHours": 987.65,
"averageRpmInternal": 987.65,
"averageSpeedInternal": 987.65,
"averageEngineSpeed": 123.45,
"averageSteamSpeedInternal": 987.65,
"midDraft": 123.45,
"portFwdDraft": 987.65,
"portMidDraft": 987.65,
"portAftDraft": 123.45,
"starboardFwdDraft": 123.45,
"starboardMidDraft": 123.45,
"starboardAftDraft": 123.45,
"currentLocationGaugeName": "abc123",
"currentLocationWaterLevel": 123.45,
"currentLocationUOM": "abc123",
"restrictedLocationGaugeName": "abc123",
"restrictedLocationWaterLevel": 987.65,
"restrictedLocationUOM": "abc123",
"salinity": 123.45,
"ballast": 123.45,
"crewStores": 987.65,
"lubes": 987.65,
"constant": 123.45,
"draftUnit": "xyz789",
"refCargoQty": 987.65,
"refPortNo": 987,
"numberOfTugs": 987,
"positionNote": "xyz789",
"lngReadingType": "xyz789",
"mMBtuPerM3": 123.45,
"port": Port,
"voyageItinerary": VoyageItinerary,
"voyage": Voyage,
"itineraryPort": Port,
"vessel": Vessel,
"weatherBeaufortScale": WeatherState,
"weatherSeaState": WeatherState,
"weatherSwellState": WeatherState,
"tankConditions": [TankCondition],
"activityReportBunkerDetails": [
ActivityReportBunkerDetail
],
"publishActivityReportMessages": [
PublishActivityReportMessageRecord
],
"publishPositionMessages": [
PublishPositionMessageRecord
],
"positionReportMessages": [PositionReportMessageRecord],
"changesSinceLast": VoyageActivityReportChangesSinceLast,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageActivityReportChangesSinceLast
Fields
| Field Name | Description |
|---|---|
publishActivityReport - MessageUpdateResponse
|
|
publishPosition - MessageUpdateResponse
|
|
positionReport - MessageUpdateResponse
|
Example
{
"publishActivityReport": MessageUpdateResponse,
"publishPosition": MessageUpdateResponse,
"positionReport": MessageUpdateResponse
}
VoyageActivityReportDraftUnitEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Unspecified"
VoyageActivityReportDraftUnitEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageActivityReportDraftUnitEnum
|
|
isNot - VoyageActivityReportDraftUnitEnum
|
|
isIn - [VoyageActivityReportDraftUnitEnum]
|
Example
{"is": "Unspecified", "isNot": "Unspecified", "isIn": ["Unspecified"]}
VoyageActivityReportFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageActivityReportFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageActivityReportFormQueryWhere
}
VoyageActivityReportFormQueryWhere
Fields
Example
{
"and": [VoyageActivityReportFormQueryWhere],
"or": [VoyageActivityReportFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"itinerarySeq": NumberWhereValueExpression,
"reportType": VoyageActivityReportReportTypeEnumValueExpression,
"cpStatus": NumberWhereValueExpression,
"ballastLaden": StringWhereValueExpression,
"orderedSpeed": NumberWhereValueExpression,
"projectedSpeed": NumberWhereValueExpression,
"reportDateGmt": DateWhereValueExpression,
"gmtOffsetHours": NumberWhereValueExpression,
"latitude": StringWhereValueExpression,
"longitude": StringWhereValueExpression,
"observedDistance": NumberWhereValueExpression,
"distanceToGo": NumberWhereValueExpression,
"dwt": NumberWhereValueExpression,
"fwdDraft": NumberWhereValueExpression,
"aftDraft": NumberWhereValueExpression,
"meanDraftInternal": NumberWhereValueExpression,
"cargoTemperature": NumberWhereValueExpression,
"engineDistance": NumberWhereValueExpression,
"slippagePercentage": NumberWhereValueExpression,
"totalRevsInternal": NumberWhereValueExpression,
"averageBhp": NumberWhereValueExpression,
"generator1Hrs": NumberWhereValueExpression,
"maxLdIndicator": NumberWhereValueExpression,
"generator2Hrs": NumberWhereValueExpression,
"generator3Hrs": NumberWhereValueExpression,
"beaufortScaleNo": NumberWhereValueExpression,
"windDirection": StringWhereValueExpression,
"seaState": NumberWhereValueExpression,
"seaDirection": StringWhereValueExpression,
"seaHeight": NumberWhereValueExpression,
"seaSwell": NumberWhereValueExpression,
"swellDirection": StringWhereValueExpression,
"swellHeight": NumberWhereValueExpression,
"airTemp": StringWhereValueExpression,
"seaTemp": StringWhereValueExpression,
"barometricPressure": StringWhereValueExpression,
"barometricMovement": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"waterwayCode": StringWhereValueExpression,
"waterwayMarker": NumberWhereValueExpression,
"headingDegrees": NumberWhereValueExpression,
"headingDirection": StringWhereValueExpression,
"isRejected": BoolWhereValueExpression,
"isDelayStart": BoolWhereValueExpression,
"isDelayEnd": BoolWhereValueExpression,
"isAvgRpmCalculated": BoolWhereValueExpression,
"isForcedBoilOff": BoolWhereValueExpression,
"isInferPosition": BoolWhereValueExpression,
"freshWaterRob": NumberWhereValueExpression,
"freshWaterRec": NumberWhereValueExpression,
"distilledWaterRob": NumberWhereValueExpression,
"distilledWaterRec": NumberWhereValueExpression,
"delayHours": NumberWhereValueExpression,
"delayType": NumberWhereValueExpression,
"delayReason": NumberWhereValueExpression,
"externalRef": StringWhereValueExpression,
"slopRec": NumberWhereValueExpression,
"slopRob": NumberWhereValueExpression,
"masterLastName": StringWhereValueExpression,
"engineerLastName": StringWhereValueExpression,
"badWeatherHours": NumberWhereValueExpression,
"fuelConsMode": StringWhereValueExpression,
"gmsControlMode": StringWhereValueExpression,
"masterFirstName": StringWhereValueExpression,
"engineerFirstName": StringWhereValueExpression,
"engineLoadPercentage": NumberWhereValueExpression,
"reportedSlipPercentage": NumberWhereValueExpression,
"loggedDistance": NumberWhereValueExpression,
"lngBogConsumed": NumberWhereValueExpression,
"cargoTempUnit": StringWhereValueExpression,
"currentSpeed": NumberWhereValueExpression,
"currentDirection": StringWhereValueExpression,
"steamingHours": NumberWhereValueExpression,
"reportedSpeed": NumberWhereValueExpression,
"generator1Kwhr": NumberWhereValueExpression,
"generator2Kwhr": NumberWhereValueExpression,
"generator3Kwhr": NumberWhereValueExpression,
"mainEngineKwhr": NumberWhereValueExpression,
"badWeatherDistance": NumberWhereValueExpression,
"generator4Hrs": NumberWhereValueExpression,
"generator4Kwhr": NumberWhereValueExpression,
"boilerHours": NumberWhereValueExpression,
"fwGeneratorHours": NumberWhereValueExpression,
"freshWaterCons": NumberWhereValueExpression,
"distilledWaterCons": NumberWhereValueExpression,
"distilledWaterProd": NumberWhereValueExpression,
"incineratorHours": NumberWhereValueExpression,
"displacement": NumberWhereValueExpression,
"mainEngineHours": NumberWhereValueExpression,
"auxEngineHours": NumberWhereValueExpression,
"averageRpmInternal": NumberWhereValueExpression,
"averageSpeedInternal": NumberWhereValueExpression,
"averageEngineSpeed": NumberWhereValueExpression,
"averageSteamSpeedInternal": NumberWhereValueExpression,
"midDraft": NumberWhereValueExpression,
"portFwdDraft": NumberWhereValueExpression,
"portMidDraft": NumberWhereValueExpression,
"portAftDraft": NumberWhereValueExpression,
"starboardFwdDraft": NumberWhereValueExpression,
"starboardMidDraft": NumberWhereValueExpression,
"starboardAftDraft": NumberWhereValueExpression,
"currentLocationGaugeName": StringWhereValueExpression,
"currentLocationWaterLevel": NumberWhereValueExpression,
"currentLocationUOM": StringWhereValueExpression,
"restrictedLocationGaugeName": StringWhereValueExpression,
"restrictedLocationWaterLevel": NumberWhereValueExpression,
"restrictedLocationUOM": StringWhereValueExpression,
"salinity": NumberWhereValueExpression,
"ballast": NumberWhereValueExpression,
"crewStores": NumberWhereValueExpression,
"lubes": NumberWhereValueExpression,
"constant": NumberWhereValueExpression,
"draftUnit": VoyageActivityReportDraftUnitEnumValueExpression,
"refCargoQty": NumberWhereValueExpression,
"refPortNo": NumberWhereValueExpression,
"numberOfTugs": NumberWhereValueExpression,
"positionNote": StringWhereValueExpression,
"lngReadingType": VoyageActivityReportLngReadingTypeEnumValueExpression,
"mMBtuPerM3": NumberWhereValueExpression,
"port": PortFormQueryWhere,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"itineraryPort": PortFormQueryWhere,
"vessel": VesselFormQueryWhere,
"weatherBeaufortScale": WeatherStateFormQueryWhere,
"weatherSeaState": WeatherStateFormQueryWhere,
"weatherSwellState": WeatherStateFormQueryWhere
}
VoyageActivityReportLngReadingTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Standard"
VoyageActivityReportLngReadingTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageActivityReportLngReadingTypeEnum
|
|
isNot - VoyageActivityReportLngReadingTypeEnum
|
|
isIn - [VoyageActivityReportLngReadingTypeEnum]
|
Example
{"is": "Standard", "isNot": "Standard", "isIn": ["Standard"]}
VoyageActivityReportRelationships
Fields
| Field Name | Description |
|---|---|
port - RelationshipDefinition
|
|
voyageItinerary - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
prevVoyageActivityReport - RelationshipDefinition
|
|
nextVoyageItinerary - RelationshipDefinition
|
|
itineraryPort - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
weatherBeaufortScale - RelationshipDefinition
|
|
weatherSeaState - RelationshipDefinition
|
|
weatherSwellState - RelationshipDefinition
|
|
tankConditions - RelationshipDefinition
|
|
activityReportBunkerDetails - RelationshipDefinition
|
Example
{
"port": RelationshipDefinition,
"voyageItinerary": RelationshipDefinition,
"voyage": RelationshipDefinition,
"prevVoyageActivityReport": RelationshipDefinition,
"nextVoyageItinerary": RelationshipDefinition,
"itineraryPort": RelationshipDefinition,
"vessel": RelationshipDefinition,
"weatherBeaufortScale": RelationshipDefinition,
"weatherSeaState": RelationshipDefinition,
"weatherSwellState": RelationshipDefinition,
"tankConditions": RelationshipDefinition,
"activityReportBunkerDetails": RelationshipDefinition
}
VoyageActivityReportReportTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
VoyageActivityReportReportTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageActivityReportReportTypeEnum
|
|
isNot - VoyageActivityReportReportTypeEnum
|
|
isIn - [VoyageActivityReportReportTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VoyageAlertRulesRequest
VoyageAndTcoFixture
Fields
| Field Name | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
|
fixtureNo - String
|
|
fixtureType - String
|
|
companyCode - String
|
|
oprType - String
|
|
estimateID - String
|
|
charterer - String
|
|
chtrSpecialist - String
|
|
opsCoordinator - String
|
|
tradeArea - String
|
|
cargoCoaSeq - Int
|
|
cargoBookingNo - String
|
|
cargo - String
|
|
segment - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
windowFromLocal - Date
|
|
windowToLocal - Date
|
|
fixtureDate - Date
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
commenceGmt - Date
|
|
shipOnSubsDateGmt - Date
|
|
cpDate - Date
|
|
fixtureStatus - String
|
|
ballastPort - String
|
|
repositionPort - String
|
|
deliveryPort - String
|
|
redeliveryPort - String
|
|
lastDiscPort - String
|
|
firstLoadPort - String
|
|
isThirdPartyVoyage - String
|
|
isPoolFixture - String
|
|
fixtureCoaSeqList - String
|
|
keyUsers - String
|
|
nominationDate - Date
|
|
vessel - Vessel
|
|
voyage - Voyage
|
|
fixture - Fixture
|
|
_id - String!
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
Example
{
"vesselCode": "abc123",
"voyageNo": 987,
"fixtureNo": "abc123",
"fixtureType": "abc123",
"companyCode": "abc123",
"oprType": "abc123",
"estimateID": "xyz789",
"charterer": "abc123",
"chtrSpecialist": "xyz789",
"opsCoordinator": "abc123",
"tradeArea": "xyz789",
"cargoCoaSeq": 987,
"cargoBookingNo": "xyz789",
"cargo": "xyz789",
"segment": "xyz789",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"windowFromLocal": "2007-12-03",
"windowToLocal": "2007-12-03",
"fixtureDate": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123",
"commenceGmt": "2007-12-03",
"shipOnSubsDateGmt": "2007-12-03",
"cpDate": "2007-12-03",
"fixtureStatus": "abc123",
"ballastPort": "abc123",
"repositionPort": "xyz789",
"deliveryPort": "xyz789",
"redeliveryPort": "xyz789",
"lastDiscPort": "abc123",
"firstLoadPort": "xyz789",
"isThirdPartyVoyage": "xyz789",
"isPoolFixture": "xyz789",
"fixtureCoaSeqList": "xyz789",
"keyUsers": "abc123",
"nominationDate": "2007-12-03",
"vessel": Vessel,
"voyage": Voyage,
"fixture": Fixture,
"_id": "xyz789",
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any,
"customFieldByID": Any,
"customField": Any
}
VoyageAndTcoFixtureFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageAndTcoFixtureFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageAndTcoFixtureFormQueryWhere
}
VoyageAndTcoFixtureFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyageAndTcoFixtureFormQueryWhere!]
|
|
or - [VoyageAndTcoFixtureFormQueryWhere!]
|
|
rawExpression - String
|
|
vessel - VesselFormQueryWhere
|
|
voyage - VoyageFormQueryWhere
|
|
fixture - FixtureFormQueryWhere
|
Example
{
"and": [VoyageAndTcoFixtureFormQueryWhere],
"or": [VoyageAndTcoFixtureFormQueryWhere],
"rawExpression": "abc123",
"vessel": VesselFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"fixture": FixtureFormQueryWhere
}
VoyageAndTcoFixtureRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
fixture - RelationshipDefinition
|
Example
{
"vessel": RelationshipDefinition,
"voyage": RelationshipDefinition,
"fixture": RelationshipDefinition
}
VoyageApiCargos_Voyage_Cargo
Fields
| Field Name | Description |
|---|---|
cargoID - Int
|
|
coaNo - String
|
|
firstLoadPortName - String
|
|
lastDiscPortName - String
|
|
cargoShortName - String
|
|
counterpartyShortName - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
contractType - String
|
|
cpDate - Date
|
|
segment - String
|
|
counterparty - VoyageApiCargos_Voyage_Counterparty_Cargo_AddressBook
|
|
cargoName - VoyageApiCargos_Voyage_CargoName_Cargo_CargoName
|
Example
{
"cargoID": 987,
"coaNo": "abc123",
"firstLoadPortName": "abc123",
"lastDiscPortName": "abc123",
"cargoShortName": "xyz789",
"counterpartyShortName": "xyz789",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"contractType": "xyz789",
"cpDate": "2007-12-03",
"segment": "xyz789",
"counterparty": VoyageApiCargos_Voyage_Counterparty_Cargo_AddressBook,
"cargoName": VoyageApiCargos_Voyage_CargoName_Cargo_CargoName
}
VoyageApiCargos_Voyage_CargoInput
Fields
| Input Field | Description |
|---|---|
cargoID - Int
|
|
coaNo - String
|
|
firstLoadPortName - String
|
|
lastDiscPortName - String
|
|
cargoShortName - String
|
|
counterpartyShortName - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
contractType - String
|
|
cpDate - Date
|
|
segment - String
|
|
counterparty - VoyageApiCargos_Voyage_Counterparty_Cargo_AddressBookInput
|
|
cargoName - VoyageApiCargos_Voyage_CargoName_Cargo_CargoNameInput
|
Example
{
"cargoID": 123,
"coaNo": "abc123",
"firstLoadPortName": "xyz789",
"lastDiscPortName": "abc123",
"cargoShortName": "abc123",
"counterpartyShortName": "abc123",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"contractType": "abc123",
"cpDate": "2007-12-03",
"segment": "abc123",
"counterparty": VoyageApiCargos_Voyage_Counterparty_Cargo_AddressBookInput,
"cargoName": VoyageApiCargos_Voyage_CargoName_Cargo_CargoNameInput
}
VoyageApiCargos_Voyage_CargoName_Cargo_CargoName
Fields
| Field Name | Description |
|---|---|
fullName - String
|
Example
{"fullName": "xyz789"}
VoyageApiCargos_Voyage_CargoName_Cargo_CargoNameInput
Fields
| Input Field | Description |
|---|---|
fullName - String
|
Example
{"fullName": "abc123"}
VoyageApiCargos_Voyage_Counterparty_Cargo_AddressBook
Fields
| Field Name | Description |
|---|---|
fullName - String
|
Example
{"fullName": "abc123"}
VoyageApiCargos_Voyage_Counterparty_Cargo_AddressBookInput
Fields
| Input Field | Description |
|---|---|
fullName - String
|
Example
{"fullName": "xyz789"}
VoyageApiCharteringCoordinatorUser_Voyage_ImosUser
VoyageApiCharteringCoordinatorUser_Voyage_ImosUserInput
VoyageApiCompanyAddressBook_Voyage_AddressBook
VoyageApiCompanyAddressBook_Voyage_AddressBookInput
VoyageApiCompany_Voyage_AddressBook_Company_AddressBook
Fields
| Field Name | Description |
|---|---|
shortName - String
|
Example
{"shortName": "abc123"}
VoyageApiCompany_Voyage_AddressBook_Company_AddressBookInput
Fields
| Input Field | Description |
|---|---|
shortName - String
|
Example
{"shortName": "xyz789"}
VoyageApiCompany_Voyage_Company
Fields
| Field Name | Description |
|---|---|
addressBook - VoyageApiCompany_Voyage_AddressBook_Company_AddressBook
|
Example
{
"addressBook": VoyageApiCompany_Voyage_AddressBook_Company_AddressBook
}
VoyageApiCompany_Voyage_CompanyInput
Fields
| Input Field | Description |
|---|---|
addressBook - VoyageApiCompany_Voyage_AddressBook_Company_AddressBookInput
|
Example
{
"addressBook": VoyageApiCompany_Voyage_AddressBook_Company_AddressBookInput
}
VoyageApiControllerUser_Voyage_ImosUser
VoyageApiControllerUser_Voyage_ImosUserInput
VoyageApiFDManagerUser_Voyage_ImosUser
VoyageApiFDManagerUser_Voyage_ImosUserInput
VoyageApiFinanceCoordinatorUser_Voyage_ImosUser
VoyageApiFinanceCoordinatorUser_Voyage_ImosUserInput
VoyageApiLatestActivityReport_Voyage_ActivityReportBunkerDetails_VoyageActivityReport_ActivityReportBunkerDetail
VoyageApiLatestActivityReport_Voyage_ActivityReportBunkerDetails_VoyageActivityReport_ActivityReportBunkerDetailInput
VoyageApiLatestActivityReport_Voyage_VoyageActivityReport
Fields
| Field Name | Description |
|---|---|
itinerarySeq - Int
|
|
reportType - String
|
|
orderedSpeed - Float
|
|
projectedSpeed - Float
|
|
reportDateGmt - Date
|
|
latitude - Float
|
|
longitude - Float
|
|
observedDistance - Int
|
|
distanceToGo - Int
|
|
remarks - String
|
|
headingDegrees - Int
|
|
reportedSpeed - Float
|
|
activityReportBunkerDetails - [VoyageApiLatestActivityReport_Voyage_ActivityReportBunkerDetails_VoyageActivityReport_ActivityReportBunkerDetail]
|
Example
{
"itinerarySeq": 123,
"reportType": "xyz789",
"orderedSpeed": 123.45,
"projectedSpeed": 987.65,
"reportDateGmt": "2007-12-03",
"latitude": 987.65,
"longitude": 123.45,
"observedDistance": 123,
"distanceToGo": 123,
"remarks": "xyz789",
"headingDegrees": 123,
"reportedSpeed": 123.45,
"activityReportBunkerDetails": [
VoyageApiLatestActivityReport_Voyage_ActivityReportBunkerDetails_VoyageActivityReport_ActivityReportBunkerDetail
]
}
VoyageApiLatestActivityReport_Voyage_VoyageActivityReportInput
Fields
| Input Field | Description |
|---|---|
itinerarySeq - Int
|
|
reportType - String
|
|
orderedSpeed - Float
|
|
projectedSpeed - Float
|
|
reportDateGmt - Date
|
|
latitude - Float
|
|
longitude - Float
|
|
observedDistance - Int
|
|
distanceToGo - Int
|
|
remarks - String
|
|
headingDegrees - Int
|
|
reportedSpeed - Float
|
|
activityReportBunkerDetails - [VoyageApiLatestActivityReport_Voyage_ActivityReportBunkerDetails_VoyageActivityReport_ActivityReportBunkerDetailInput]
|
Example
{
"itinerarySeq": 987,
"reportType": "xyz789",
"orderedSpeed": 987.65,
"projectedSpeed": 123.45,
"reportDateGmt": "2007-12-03",
"latitude": 123.45,
"longitude": 123.45,
"observedDistance": 123,
"distanceToGo": 987,
"remarks": "abc123",
"headingDegrees": 123,
"reportedSpeed": 987.65,
"activityReportBunkerDetails": [
VoyageApiLatestActivityReport_Voyage_ActivityReportBunkerDetails_VoyageActivityReport_ActivityReportBunkerDetailInput
]
}
VoyageApiNextVoyage_Voyage_Voyage
Fields
| Field Name | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
|
consecutiveYN - String
|
|
voyageItineraries - [VoyageApiNextVoyage_Voyage_VoyageItineraries_Voyage_VoyageItinerary]
|
Example
{
"vesselCode": "abc123",
"voyageNo": 987,
"consecutiveYN": "xyz789",
"voyageItineraries": [
VoyageApiNextVoyage_Voyage_VoyageItineraries_Voyage_VoyageItinerary
]
}
VoyageApiNextVoyage_Voyage_VoyageInput
Fields
| Input Field | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
|
consecutiveYN - String
|
|
voyageItineraries - [VoyageApiNextVoyage_Voyage_VoyageItineraries_Voyage_VoyageItineraryInput]
|
Example
{
"vesselCode": "xyz789",
"voyageNo": 987,
"consecutiveYN": "abc123",
"voyageItineraries": [
VoyageApiNextVoyage_Voyage_VoyageItineraries_Voyage_VoyageItineraryInput
]
}
VoyageApiNextVoyage_Voyage_VoyageItineraries_Voyage_VoyageItinerary
VoyageApiNextVoyage_Voyage_VoyageItineraries_Voyage_VoyageItineraryInput
VoyageApiOpsCoordinatorUser2_Voyage_ImosUser
VoyageApiOpsCoordinatorUser2_Voyage_ImosUserInput
VoyageApiOpsCoordinatorUser_Voyage_ImosUser
VoyageApiOpsCoordinatorUser_Voyage_ImosUserInput
VoyageApiPositionReportInput
Fields
| Input Field | Description |
|---|---|
vesselCode - String
|
|
voyageNo - Int
|
|
itinerarySeq - Int
|
|
reportType - String
|
|
latitude - Float
|
|
longitude - Float
|
|
remarks - String
|
|
reportedSpeed - Float
|
|
projectedSpeed - Float
|
|
orderedSpeed - Float
|
|
observedDistance - Int
|
|
distanceToGo - Int
|
|
averageSpeed - Float
|
|
badWeatherHours - Float
|
|
badWeatherDistance - Float
|
|
dwt - Float
|
|
headingDegrees - Int
|
|
headingDirection - String
|
|
engineDistance - Float
|
|
slippagePercentage - Float
|
|
engineLoadPercentage - Float
|
|
reportedSlipPercentage - Float
|
|
averageBhp - Float
|
|
averageRpm - Float
|
|
mainEngineHours - Float
|
|
mainEngineKwhr - Float
|
|
maxLdIndicator - Float
|
|
steamingHours - Float
|
|
boilerHours - Float
|
|
incineratorHours - Float
|
|
generator1Hrs - Float
|
|
generator2Hrs - Float
|
|
generator3Hrs - Float
|
|
generator4Hrs - Float
|
|
generator1Kwhr - Float
|
|
generator2Kwhr - Float
|
|
generator3Kwhr - Float
|
|
generator4Kwhr - Float
|
|
fwGeneratorHours - Float
|
|
freshWaterCons - Float
|
|
freshWaterRec - Float
|
|
freshWaterRob - Float
|
|
distilledWaterCons - Float
|
|
distilledWaterProd - Float
|
|
distilledWaterRec - Float
|
|
distilledWaterRob - Float
|
|
slopRec - Float
|
|
slopRob - Float
|
|
beaufortScaleNo - Int
|
|
windDirection - String
|
|
seaState - Int
|
|
seaDirection - String
|
|
seaTemp - String
|
|
seaHeight - Float
|
|
seaSwell - Int
|
|
swellDirection - String
|
|
swellHeight - Float
|
|
airTemp - String
|
|
barometricPressure - String
|
|
barometricMovement - String
|
|
currentSpeed - Float
|
|
currentDirection - String
|
|
currentLocationGaugeName - String
|
|
currentLocationWaterLevel - Float
|
|
currentLocationUOM - String
|
|
restrictedLocationGaugeName - String
|
|
restrictedLocationWaterLevel - Float
|
|
restrictedLocationUOM - String
|
|
displacement - Float
|
|
fwdDraft - Float
|
|
aftDraft - Float
|
|
midDraft - Float
|
|
portFwdDraft - Float
|
|
portAftDraft - Float
|
|
portMidDraft - Float
|
|
starboardFwdDraft - Float
|
|
starboardAftDraft - Float
|
|
starboardMidDraft - Float
|
|
salinity - Float
|
|
ballast - Float
|
|
crewStores - Float
|
|
lubes - Float
|
|
constant - Float
|
|
numberOfTugs - Int
|
|
positionNote - String
|
|
waterwayCode - String
|
|
itineraryPort - VoyageApiPositionReport_ItineraryPortInput
|
|
activityReportBunkerDetails - [VoyageApiPositionReport_ActivityReportBunkerDetailsInput]!
|
|
reportDate - Date
|
|
cpStatus - Float
|
|
refPortName - String
|
|
nextPortEta - Date
|
|
totalRevs - Float
|
|
isForcedBoilOff - Boolean
|
|
loggedDistance - Float
|
|
gmsControlMode - String
|
|
noonReportType - String
|
|
masterLastName - String
|
|
cargoTempUnit - String
|
|
engineerFirstName - String
|
|
lngReadingType - String
|
|
fuelConsMode - String
|
|
masterFirstName - String
|
|
engineerLastName - String
|
|
cargoTemperature - Float
|
|
draftUnit - String
|
|
isBunkering - Boolean
|
Example
{
"vesselCode": "abc123",
"voyageNo": 123,
"itinerarySeq": 987,
"reportType": "xyz789",
"latitude": 987.65,
"longitude": 987.65,
"remarks": "abc123",
"reportedSpeed": 987.65,
"projectedSpeed": 123.45,
"orderedSpeed": 987.65,
"observedDistance": 123,
"distanceToGo": 987,
"averageSpeed": 987.65,
"badWeatherHours": 123.45,
"badWeatherDistance": 987.65,
"dwt": 987.65,
"headingDegrees": 987,
"headingDirection": "xyz789",
"engineDistance": 987.65,
"slippagePercentage": 987.65,
"engineLoadPercentage": 987.65,
"reportedSlipPercentage": 987.65,
"averageBhp": 987.65,
"averageRpm": 123.45,
"mainEngineHours": 987.65,
"mainEngineKwhr": 987.65,
"maxLdIndicator": 987.65,
"steamingHours": 123.45,
"boilerHours": 123.45,
"incineratorHours": 987.65,
"generator1Hrs": 123.45,
"generator2Hrs": 987.65,
"generator3Hrs": 123.45,
"generator4Hrs": 123.45,
"generator1Kwhr": 987.65,
"generator2Kwhr": 123.45,
"generator3Kwhr": 123.45,
"generator4Kwhr": 987.65,
"fwGeneratorHours": 987.65,
"freshWaterCons": 987.65,
"freshWaterRec": 123.45,
"freshWaterRob": 123.45,
"distilledWaterCons": 987.65,
"distilledWaterProd": 987.65,
"distilledWaterRec": 987.65,
"distilledWaterRob": 123.45,
"slopRec": 987.65,
"slopRob": 123.45,
"beaufortScaleNo": 987,
"windDirection": "abc123",
"seaState": 123,
"seaDirection": "abc123",
"seaTemp": "abc123",
"seaHeight": 987.65,
"seaSwell": 123,
"swellDirection": "abc123",
"swellHeight": 123.45,
"airTemp": "abc123",
"barometricPressure": "abc123",
"barometricMovement": "abc123",
"currentSpeed": 123.45,
"currentDirection": "abc123",
"currentLocationGaugeName": "abc123",
"currentLocationWaterLevel": 123.45,
"currentLocationUOM": "abc123",
"restrictedLocationGaugeName": "abc123",
"restrictedLocationWaterLevel": 987.65,
"restrictedLocationUOM": "xyz789",
"displacement": 987.65,
"fwdDraft": 123.45,
"aftDraft": 123.45,
"midDraft": 123.45,
"portFwdDraft": 987.65,
"portAftDraft": 987.65,
"portMidDraft": 123.45,
"starboardFwdDraft": 987.65,
"starboardAftDraft": 123.45,
"starboardMidDraft": 987.65,
"salinity": 123.45,
"ballast": 987.65,
"crewStores": 123.45,
"lubes": 123.45,
"constant": 987.65,
"numberOfTugs": 123,
"positionNote": "abc123",
"waterwayCode": "xyz789",
"itineraryPort": VoyageApiPositionReport_ItineraryPortInput,
"activityReportBunkerDetails": [
VoyageApiPositionReport_ActivityReportBunkerDetailsInput
],
"reportDate": "2007-12-03",
"cpStatus": 987.65,
"refPortName": "abc123",
"nextPortEta": "2007-12-03",
"totalRevs": 987.65,
"isForcedBoilOff": true,
"loggedDistance": 987.65,
"gmsControlMode": "abc123",
"noonReportType": "abc123",
"masterLastName": "abc123",
"cargoTempUnit": "xyz789",
"engineerFirstName": "abc123",
"lngReadingType": "abc123",
"fuelConsMode": "abc123",
"masterFirstName": "abc123",
"engineerLastName": "abc123",
"cargoTemperature": 123.45,
"draftUnit": "abc123",
"isBunkering": true
}
VoyageApiPositionReport_ActivityReportBunkerDetailsInput
Fields
| Input Field | Description |
|---|---|
fuelType - String
|
|
fuelRob - Float
|
|
fuelConsumed - Float
|
|
fuelReceived - Float
|
|
mainEng - Float
|
|
auxEng - Float
|
|
badWeatherConsumption - Float
|
|
loadOrDisch - Float
|
|
maneuver - Float
|
|
propulsion - Float
|
|
deballast - Float
|
|
igs - Float
|
|
generator - Float
|
|
heat - Float
|
|
boiler - Float
|
|
incinerator - Float
|
|
others - Float
|
|
clean - Float
|
|
heatPlus - Float
|
|
heatPlusPlus - Float
|
|
cooling - Float
|
|
idleorOn - Float
|
|
idleorOff - Float
|
|
pilotFlame - Float
|
|
sulfurContentPct_0 - Float
|
|
sulfurContentRob_0 - Float
|
|
sulfurContentPct_1 - Float
|
|
sulfurContentRob_1 - Float
|
|
sulfurContentPct_2 - Float
|
|
sulfurContentRob_2 - Float
|
Example
{
"fuelType": "abc123",
"fuelRob": 123.45,
"fuelConsumed": 123.45,
"fuelReceived": 987.65,
"mainEng": 987.65,
"auxEng": 123.45,
"badWeatherConsumption": 123.45,
"loadOrDisch": 987.65,
"maneuver": 123.45,
"propulsion": 123.45,
"deballast": 987.65,
"igs": 987.65,
"generator": 123.45,
"heat": 987.65,
"boiler": 123.45,
"incinerator": 123.45,
"others": 987.65,
"clean": 123.45,
"heatPlus": 123.45,
"heatPlusPlus": 987.65,
"cooling": 123.45,
"idleorOn": 987.65,
"idleorOff": 123.45,
"pilotFlame": 987.65,
"sulfurContentPct_0": 123.45,
"sulfurContentRob_0": 987.65,
"sulfurContentPct_1": 987.65,
"sulfurContentRob_1": 123.45,
"sulfurContentPct_2": 987.65,
"sulfurContentRob_2": 123.45
}
VoyageApiPositionReport_ItineraryPortInput
VoyageApiTCIContract_Voyage_TimeCharterContract
VoyageApiTCIContract_Voyage_TimeCharterContractInput
VoyageApiTCOContract_Voyage_TimeCharterContract
VoyageApiTCOContract_Voyage_TimeCharterContractInput
VoyageApiVeslinkFormInput
Fields
| Input Field | Description |
|---|---|
vesselCode - String!
|
|
imoNo - String
|
|
voyageNo - Int!
|
|
seq - Int
|
|
port - VoyageApiPositionReport_ItineraryPortInput
|
|
formDate - Date
|
|
positionReport - VoyageApiPositionReportInput
|
|
portActivities - PortActivityListInput
|
|
etaEtd - EtaEtdInput
|
|
upcomingPorts - VoyageApi_UpcomingPortsListInput
|
|
delay - DelayInput
|
|
cargoHandlings - CargoHandlingListInput
|
Example
{
"vesselCode": "abc123",
"imoNo": "abc123",
"voyageNo": 987,
"seq": 123,
"port": VoyageApiPositionReport_ItineraryPortInput,
"formDate": "2007-12-03",
"positionReport": VoyageApiPositionReportInput,
"portActivities": PortActivityListInput,
"etaEtd": EtaEtdInput,
"upcomingPorts": VoyageApi_UpcomingPortsListInput,
"delay": DelayInput,
"cargoHandlings": CargoHandlingListInput
}
VoyageApiVessel_Voyage_Vessel
Fields
| Field Name | Description |
|---|---|
name - String
|
|
vesselType - String
|
|
flag - String
|
|
unitTypeCode - String
|
|
beam - Float
|
|
dWT - Float
|
|
maxDraft - Float
|
|
ladenSpeed - Float
|
|
ballastSpeed - Float
|
|
imoNo - String
|
|
yearBuilt - Int
|
|
isBargeUnit - Int
|
|
email - String
|
|
vesselSeaConsBunkers - [VoyageApiVessel_Voyage_VesselSeaConsBunkers_Vessel_VesselSeaConsBunker]
|
|
vesselPortCons - [VoyageApiVessel_Voyage_VesselPortCons_Vessel_VesselPortCons]
|
Example
{
"name": "abc123",
"vesselType": "abc123",
"flag": "xyz789",
"unitTypeCode": "xyz789",
"beam": 987.65,
"dWT": 987.65,
"maxDraft": 987.65,
"ladenSpeed": 987.65,
"ballastSpeed": 123.45,
"imoNo": "xyz789",
"yearBuilt": 987,
"isBargeUnit": 123,
"email": "xyz789",
"vesselSeaConsBunkers": [
VoyageApiVessel_Voyage_VesselSeaConsBunkers_Vessel_VesselSeaConsBunker
],
"vesselPortCons": [
VoyageApiVessel_Voyage_VesselPortCons_Vessel_VesselPortCons
]
}
VoyageApiVessel_Voyage_VesselInput
Fields
| Input Field | Description |
|---|---|
name - String
|
|
vesselType - String
|
|
flag - String
|
|
unitTypeCode - String
|
|
beam - Float
|
|
dWT - Float
|
|
maxDraft - Float
|
|
ladenSpeed - Float
|
|
ballastSpeed - Float
|
|
imoNo - String
|
|
yearBuilt - Int
|
|
isBargeUnit - Int
|
|
email - String
|
|
vesselSeaConsBunkers - [VoyageApiVessel_Voyage_VesselSeaConsBunkers_Vessel_VesselSeaConsBunkerInput]
|
|
vesselPortCons - [VoyageApiVessel_Voyage_VesselPortCons_Vessel_VesselPortConsInput]
|
Example
{
"name": "xyz789",
"vesselType": "abc123",
"flag": "abc123",
"unitTypeCode": "xyz789",
"beam": 987.65,
"dWT": 123.45,
"maxDraft": 987.65,
"ladenSpeed": 123.45,
"ballastSpeed": 123.45,
"imoNo": "xyz789",
"yearBuilt": 123,
"isBargeUnit": 123,
"email": "abc123",
"vesselSeaConsBunkers": [
VoyageApiVessel_Voyage_VesselSeaConsBunkers_Vessel_VesselSeaConsBunkerInput
],
"vesselPortCons": [
VoyageApiVessel_Voyage_VesselPortCons_Vessel_VesselPortConsInput
]
}
VoyageApiVessel_Voyage_VesselPortCons_Vessel_Fuel_VesselPortCons_FuelLubeType
VoyageApiVessel_Voyage_VesselPortCons_Vessel_Fuel_VesselPortCons_FuelLubeTypeInput
VoyageApiVessel_Voyage_VesselPortCons_Vessel_VesselPortCons
Fields
| Field Name | Description |
|---|---|
loadFuel - Float
|
|
dischargeFuel - Float
|
|
idle - Float
|
|
unit - String
|
|
fuel - VoyageApiVessel_Voyage_VesselPortCons_Vessel_Fuel_VesselPortCons_FuelLubeType
|
Example
{
"loadFuel": 123.45,
"dischargeFuel": 987.65,
"idle": 123.45,
"unit": "xyz789",
"fuel": VoyageApiVessel_Voyage_VesselPortCons_Vessel_Fuel_VesselPortCons_FuelLubeType
}
VoyageApiVessel_Voyage_VesselPortCons_Vessel_VesselPortConsInput
Fields
| Input Field | Description |
|---|---|
loadFuel - Float
|
|
dischargeFuel - Float
|
|
idle - Float
|
|
unit - String
|
|
fuel - VoyageApiVessel_Voyage_VesselPortCons_Vessel_Fuel_VesselPortCons_FuelLubeTypeInput
|
Example
{
"loadFuel": 123.45,
"dischargeFuel": 987.65,
"idle": 987.65,
"unit": "abc123",
"fuel": VoyageApiVessel_Voyage_VesselPortCons_Vessel_Fuel_VesselPortCons_FuelLubeTypeInput
}
VoyageApiVessel_Voyage_VesselSeaConsBunkers_Vessel_VesselSeaConsBunker
VoyageApiVessel_Voyage_VesselSeaConsBunkers_Vessel_VesselSeaConsBunkerInput
VoyageApiVoyage
Fields
Example
{
"voyageStatus": "xyz789",
"oprType": "xyz789",
"vesselCode": "abc123",
"voyageNo": 987,
"vesselName": "xyz789",
"fixtureNo": "abc123",
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"tRBunker": false,
"lowSulfurOnly": false,
"companyCode": "abc123",
"commenceDateGmt": "2007-12-03",
"completeDateGmt": "2007-12-03",
"destMirrorVoyage": true,
"scrubberType": "abc123",
"cO2Quantity": 123.45,
"eEOI": 123.45,
"previousDistance": 123.45,
"previousEmission": 987.65,
"previousAer": 987.65,
"previousCiiGrade": "abc123",
"endOfVoyageDistance": 123.45,
"endOfVoyageEmission": 123.45,
"endOfVoyageAer": 123.45,
"endOfVoyageCiiGrade": "xyz789",
"voyageTemplate": VoyageApiVoyageTemplate_Voyage_VoyageTemplate,
"vessel": VoyageApiVessel_Voyage_Vessel,
"voyageActPnl": VoyageApiVoyageActPnl_Voyage_VoyagePnl,
"tciContract": VoyageApiTCIContract_Voyage_TimeCharterContract,
"tcoContract": VoyageApiTCOContract_Voyage_TimeCharterContract,
"companyAddressBook": VoyageApiCompanyAddressBook_Voyage_AddressBook,
"company": VoyageApiCompany_Voyage_Company,
"opsCoordinatorUser": VoyageApiOpsCoordinatorUser_Voyage_ImosUser,
"charteringCoordinatorUser": VoyageApiCharteringCoordinatorUser_Voyage_ImosUser,
"opsCoordinatorUser2": VoyageApiOpsCoordinatorUser2_Voyage_ImosUser,
"controllerUser": VoyageApiControllerUser_Voyage_ImosUser,
"fDManagerUser": VoyageApiFDManagerUser_Voyage_ImosUser,
"financeCoordinatorUser": VoyageApiFinanceCoordinatorUser_Voyage_ImosUser,
"latestActivityReport": VoyageApiLatestActivityReport_Voyage_VoyageActivityReport,
"nextVoyage": VoyageApiNextVoyage_Voyage_Voyage,
"voyageEmissions": [
VoyageApiVoyageEmissions_Voyage_VoyageEmissions
],
"voyageBunkerSummaries": [
VoyageApiVoyageBunkerSummaries_Voyage_VoyageBunkerSummary
],
"voyageItineraries": [
VoyageApiVoyageItineraries_Voyage_VoyageItinerary
],
"cargos": [VoyageApiCargos_Voyage_Cargo]
}
VoyageApiVoyageActPnl_Voyage_VoyagePnl
Fields
| Field Name | Description |
|---|---|
totalPortDays - Float
|
|
totalProfitLoss - Float
|
|
tce - Float
|
|
totalVoyageDays - Float
|
|
offHireDays - Float
|
|
totalBallastDays - Float
|
|
totalLadenDays - Float
|
|
totalIdleDays - Float
|
|
totalWaitingDays - Float
|
|
revenues - Float
|
|
expenses - Float
|
|
runningCost - Float
|
|
freight - Float
|
|
demurrage - Float
|
|
freightComm - Float
|
|
freightAddComm - Float
|
|
demurrageComm - Float
|
|
demurrageAddComm - Float
|
|
miscRevenue - Float
|
|
bunkers - Float
|
|
hire - Float
|
|
hireComm - Float
|
|
hireAddComm - Float
|
|
offHire - Float
|
|
offHireBunkers - Float
|
|
offHireAddComm - Float
|
|
offHireComm - Float
|
|
portExpenses - Float
|
|
miscExpenses - Float
|
|
vCInFreight - Float
|
|
vCInDemurrage - Float
|
|
baseCurrency - String
|
|
marketResultIn - Float
|
|
marketResultOut - Float
|
Example
{
"totalPortDays": 123.45,
"totalProfitLoss": 123.45,
"tce": 123.45,
"totalVoyageDays": 987.65,
"offHireDays": 123.45,
"totalBallastDays": 123.45,
"totalLadenDays": 123.45,
"totalIdleDays": 987.65,
"totalWaitingDays": 987.65,
"revenues": 987.65,
"expenses": 987.65,
"runningCost": 123.45,
"freight": 123.45,
"demurrage": 123.45,
"freightComm": 123.45,
"freightAddComm": 987.65,
"demurrageComm": 987.65,
"demurrageAddComm": 123.45,
"miscRevenue": 987.65,
"bunkers": 123.45,
"hire": 123.45,
"hireComm": 123.45,
"hireAddComm": 987.65,
"offHire": 987.65,
"offHireBunkers": 123.45,
"offHireAddComm": 987.65,
"offHireComm": 123.45,
"portExpenses": 123.45,
"miscExpenses": 987.65,
"vCInFreight": 123.45,
"vCInDemurrage": 123.45,
"baseCurrency": "abc123",
"marketResultIn": 987.65,
"marketResultOut": 123.45
}
VoyageApiVoyageActPnl_Voyage_VoyagePnlInput
Fields
| Input Field | Description |
|---|---|
totalPortDays - Float
|
|
totalProfitLoss - Float
|
|
tce - Float
|
|
totalVoyageDays - Float
|
|
offHireDays - Float
|
|
totalBallastDays - Float
|
|
totalLadenDays - Float
|
|
totalIdleDays - Float
|
|
totalWaitingDays - Float
|
|
revenues - Float
|
|
expenses - Float
|
|
runningCost - Float
|
|
freight - Float
|
|
demurrage - Float
|
|
freightComm - Float
|
|
freightAddComm - Float
|
|
demurrageComm - Float
|
|
demurrageAddComm - Float
|
|
miscRevenue - Float
|
|
bunkers - Float
|
|
hire - Float
|
|
hireComm - Float
|
|
hireAddComm - Float
|
|
offHire - Float
|
|
offHireBunkers - Float
|
|
offHireAddComm - Float
|
|
offHireComm - Float
|
|
portExpenses - Float
|
|
miscExpenses - Float
|
|
vCInFreight - Float
|
|
vCInDemurrage - Float
|
|
baseCurrency - String
|
|
marketResultIn - Float
|
|
marketResultOut - Float
|
Example
{
"totalPortDays": 123.45,
"totalProfitLoss": 123.45,
"tce": 123.45,
"totalVoyageDays": 123.45,
"offHireDays": 123.45,
"totalBallastDays": 123.45,
"totalLadenDays": 987.65,
"totalIdleDays": 987.65,
"totalWaitingDays": 123.45,
"revenues": 987.65,
"expenses": 987.65,
"runningCost": 987.65,
"freight": 987.65,
"demurrage": 123.45,
"freightComm": 987.65,
"freightAddComm": 987.65,
"demurrageComm": 123.45,
"demurrageAddComm": 123.45,
"miscRevenue": 987.65,
"bunkers": 123.45,
"hire": 123.45,
"hireComm": 123.45,
"hireAddComm": 987.65,
"offHire": 987.65,
"offHireBunkers": 987.65,
"offHireAddComm": 987.65,
"offHireComm": 987.65,
"portExpenses": 123.45,
"miscExpenses": 987.65,
"vCInFreight": 987.65,
"vCInDemurrage": 123.45,
"baseCurrency": "abc123",
"marketResultIn": 987.65,
"marketResultOut": 987.65
}
VoyageApiVoyageBunkerSummaries_Voyage_VoyageBunkerSummary
VoyageApiVoyageBunkerSummaries_Voyage_VoyageBunkerSummaryInput
VoyageApiVoyageEmissions_Voyage_Port_VoyageEmissions_Port
VoyageApiVoyageEmissions_Voyage_Port_VoyageEmissions_PortInput
VoyageApiVoyageEmissions_Voyage_VoyageEmissions
Fields
| Field Name | Description |
|---|---|
seq - Int
|
|
ordNo - Int
|
|
vschedSeq - Int
|
|
source - String
|
|
distance - Float
|
|
ballastOrLadenLeg - String
|
|
beforeInternal - Boolean
|
|
afterInternal - Boolean
|
|
entryUserID - String
|
|
entryDate - Date
|
|
updateTimes - Int
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
cargoQty - Float
|
|
totalCargoQty - Float
|
|
port - VoyageApiVoyageEmissions_Voyage_Port_VoyageEmissions_Port
|
|
voyageEmissionsDetails - [VoyageApiVoyageEmissions_Voyage_VoyageEmissionsDetails_VoyageEmissions_VoyageEmissionsDetail]
|
Example
{
"seq": 987,
"ordNo": 123,
"vschedSeq": 987,
"source": "abc123",
"distance": 987.65,
"ballastOrLadenLeg": "xyz789",
"beforeInternal": false,
"afterInternal": false,
"entryUserID": "abc123",
"entryDate": "2007-12-03",
"updateTimes": 987,
"lastUser": "xyz789",
"lastUpdateGmt": "2007-12-03",
"cargoQty": 987.65,
"totalCargoQty": 987.65,
"port": VoyageApiVoyageEmissions_Voyage_Port_VoyageEmissions_Port,
"voyageEmissionsDetails": [
VoyageApiVoyageEmissions_Voyage_VoyageEmissionsDetails_VoyageEmissions_VoyageEmissionsDetail
]
}
VoyageApiVoyageEmissions_Voyage_VoyageEmissionsDetails_VoyageEmissions_VoyageEmissionsDetail
VoyageApiVoyageEmissions_Voyage_VoyageEmissionsDetails_VoyageEmissions_VoyageEmissionsDetailInput
VoyageApiVoyageEmissions_Voyage_VoyageEmissionsInput
Fields
| Input Field | Description |
|---|---|
seq - Int
|
|
ordNo - Int
|
|
vschedSeq - Int
|
|
source - String
|
|
distance - Float
|
|
ballastOrLadenLeg - String
|
|
beforeInternal - Boolean
|
|
afterInternal - Boolean
|
|
entryUserID - String
|
|
entryDate - Date
|
|
updateTimes - Int
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
cargoQty - Float
|
|
totalCargoQty - Float
|
|
port - VoyageApiVoyageEmissions_Voyage_Port_VoyageEmissions_PortInput
|
|
voyageEmissionsDetails - [VoyageApiVoyageEmissions_Voyage_VoyageEmissionsDetails_VoyageEmissions_VoyageEmissionsDetailInput]
|
Example
{
"seq": 987,
"ordNo": 987,
"vschedSeq": 987,
"source": "abc123",
"distance": 987.65,
"ballastOrLadenLeg": "abc123",
"beforeInternal": true,
"afterInternal": true,
"entryUserID": "abc123",
"entryDate": "2007-12-03",
"updateTimes": 123,
"lastUser": "xyz789",
"lastUpdateGmt": "2007-12-03",
"cargoQty": 123.45,
"totalCargoQty": 987.65,
"port": VoyageApiVoyageEmissions_Voyage_Port_VoyageEmissions_PortInput,
"voyageEmissionsDetails": [
VoyageApiVoyageEmissions_Voyage_VoyageEmissionsDetails_VoyageEmissions_VoyageEmissionsDetailInput
]
}
VoyageApiVoyageInput
Fields
Example
{
"voyageStatus": "xyz789",
"oprType": "abc123",
"vesselCode": "abc123",
"voyageNo": 987,
"vesselName": "abc123",
"fixtureNo": "abc123",
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"tRBunker": false,
"lowSulfurOnly": false,
"companyCode": "xyz789",
"commenceDateGmt": "2007-12-03",
"completeDateGmt": "2007-12-03",
"destMirrorVoyage": false,
"scrubberType": "xyz789",
"cO2Quantity": 123.45,
"eEOI": 987.65,
"previousDistance": 123.45,
"previousEmission": 987.65,
"previousAer": 123.45,
"previousCiiGrade": "xyz789",
"endOfVoyageDistance": 987.65,
"endOfVoyageEmission": 987.65,
"endOfVoyageAer": 987.65,
"endOfVoyageCiiGrade": "xyz789",
"voyageTemplate": VoyageApiVoyageTemplate_Voyage_VoyageTemplateInput,
"vessel": VoyageApiVessel_Voyage_VesselInput,
"voyageActPnl": VoyageApiVoyageActPnl_Voyage_VoyagePnlInput,
"tciContract": VoyageApiTCIContract_Voyage_TimeCharterContractInput,
"tcoContract": VoyageApiTCOContract_Voyage_TimeCharterContractInput,
"companyAddressBook": VoyageApiCompanyAddressBook_Voyage_AddressBookInput,
"company": VoyageApiCompany_Voyage_CompanyInput,
"opsCoordinatorUser": VoyageApiOpsCoordinatorUser_Voyage_ImosUserInput,
"charteringCoordinatorUser": VoyageApiCharteringCoordinatorUser_Voyage_ImosUserInput,
"opsCoordinatorUser2": VoyageApiOpsCoordinatorUser2_Voyage_ImosUserInput,
"controllerUser": VoyageApiControllerUser_Voyage_ImosUserInput,
"fDManagerUser": VoyageApiFDManagerUser_Voyage_ImosUserInput,
"financeCoordinatorUser": VoyageApiFinanceCoordinatorUser_Voyage_ImosUserInput,
"latestActivityReport": VoyageApiLatestActivityReport_Voyage_VoyageActivityReportInput,
"nextVoyage": VoyageApiNextVoyage_Voyage_VoyageInput,
"voyageEmissions": [
VoyageApiVoyageEmissions_Voyage_VoyageEmissionsInput
],
"voyageBunkerSummaries": [
VoyageApiVoyageBunkerSummaries_Voyage_VoyageBunkerSummaryInput
],
"voyageItineraries": [
VoyageApiVoyageItineraries_Voyage_VoyageItineraryInput
],
"cargos": [VoyageApiCargos_Voyage_CargoInput]
}
VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerInquiriesAndPurchases_BunkerRequirement_BunkerInquiriesAndPurchases
Fields
| Field Name | Description |
|---|---|
status - String
|
|
curr - String
|
|
bunkerInquiriesAndPurchasesBunkers - [VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerInquiriesAndPurchases_BunkerRequirement_BunkerInquiriesAndPurchasesBunkers_BunkerInquiriesAndPurchases_BunkerInquiriesAndPurchasesBunker]
|
Example
{
"status": "xyz789",
"curr": "abc123",
"bunkerInquiriesAndPurchasesBunkers": [
VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerInquiriesAndPurchases_BunkerRequirement_BunkerInquiriesAndPurchasesBunkers_BunkerInquiriesAndPurchases_BunkerInquiriesAndPurchasesBunker
]
}
VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerInquiriesAndPurchases_BunkerRequirement_BunkerInquiriesAndPurchasesBunkers_BunkerInquiriesAndPurchases_BunkerInquiriesAndPurchasesBunker
VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerInquiriesAndPurchases_BunkerRequirement_BunkerInquiriesAndPurchasesBunkers_BunkerInquiriesAndPurchases_BunkerInquiriesAndPurchasesBunkerInput
VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerInquiriesAndPurchases_BunkerRequirement_BunkerInquiriesAndPurchasesInput
Fields
| Input Field | Description |
|---|---|
status - String
|
|
curr - String
|
|
bunkerInquiriesAndPurchasesBunkers - [VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerInquiriesAndPurchases_BunkerRequirement_BunkerInquiriesAndPurchasesBunkers_BunkerInquiriesAndPurchases_BunkerInquiriesAndPurchasesBunkerInput]
|
Example
{
"status": "xyz789",
"curr": "abc123",
"bunkerInquiriesAndPurchasesBunkers": [
VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerInquiriesAndPurchases_BunkerRequirement_BunkerInquiriesAndPurchasesBunkers_BunkerInquiriesAndPurchases_BunkerInquiriesAndPurchasesBunkerInput
]
}
VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerRequirement
Fields
| Field Name | Description |
|---|---|
bunkerInquiriesAndPurchases - [VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerInquiriesAndPurchases_BunkerRequirement_BunkerInquiriesAndPurchases]
|
|
bunkerRequirementBunkers - [VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerRequirementBunkers_BunkerRequirement_BunkerRequirementBunker]
|
Example
{
"bunkerInquiriesAndPurchases": [
VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerInquiriesAndPurchases_BunkerRequirement_BunkerInquiriesAndPurchases
],
"bunkerRequirementBunkers": [
VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerRequirementBunkers_BunkerRequirement_BunkerRequirementBunker
]
}
VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerRequirementBunkers_BunkerRequirement_BunkerRequirementBunker
Fields
| Field Name | Description |
|---|---|
unit - String
|
Example
{"unit": "abc123"}
VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerRequirementBunkers_BunkerRequirement_BunkerRequirementBunkerInput
Fields
| Input Field | Description |
|---|---|
unit - String
|
Example
{"unit": "xyz789"}
VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerRequirementInput
Fields
| Input Field | Description |
|---|---|
bunkerInquiriesAndPurchases - [VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerInquiriesAndPurchases_BunkerRequirement_BunkerInquiriesAndPurchasesInput]
|
|
bunkerRequirementBunkers - [VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerRequirementBunkers_BunkerRequirement_BunkerRequirementBunkerInput]
|
Example
{
"bunkerInquiriesAndPurchases": [
VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerInquiriesAndPurchases_BunkerRequirement_BunkerInquiriesAndPurchasesInput
],
"bunkerRequirementBunkers": [
VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerRequirementBunkers_BunkerRequirement_BunkerRequirementBunkerInput
]
}
VoyageApiVoyageItineraries_Voyage_Port_VoyageItinerary_Port
Fields
| Field Name | Description |
|---|---|
portNo - Int
|
|
vesonID - Int
|
|
country - String
|
|
name - String
|
|
longitude - Float
|
|
latitude - Float
|
|
unCode - String
|
|
lowSulfur - Boolean
|
|
piracyArea - Boolean
|
|
isEcaZone - Boolean
|
|
supportedScrubberType - String
|
|
portBerths - [VoyageApiVoyageItineraries_Voyage_Port_VoyageItinerary_PortBerths_Port_PortBerth]
|
Example
{
"portNo": 987,
"vesonID": 123,
"country": "xyz789",
"name": "xyz789",
"longitude": 987.65,
"latitude": 123.45,
"unCode": "xyz789",
"lowSulfur": true,
"piracyArea": true,
"isEcaZone": false,
"supportedScrubberType": "abc123",
"portBerths": [
VoyageApiVoyageItineraries_Voyage_Port_VoyageItinerary_PortBerths_Port_PortBerth
]
}
VoyageApiVoyageItineraries_Voyage_Port_VoyageItinerary_PortBerths_Port_PortBerth
Fields
| Field Name | Description |
|---|---|
shortName - String
|
Example
{"shortName": "xyz789"}
VoyageApiVoyageItineraries_Voyage_Port_VoyageItinerary_PortBerths_Port_PortBerthInput
Fields
| Input Field | Description |
|---|---|
shortName - String
|
Example
{"shortName": "abc123"}
VoyageApiVoyageItineraries_Voyage_Port_VoyageItinerary_PortInput
Fields
| Input Field | Description |
|---|---|
portNo - Int
|
|
vesonID - Int
|
|
country - String
|
|
name - String
|
|
longitude - Float
|
|
latitude - Float
|
|
unCode - String
|
|
lowSulfur - Boolean
|
|
piracyArea - Boolean
|
|
isEcaZone - Boolean
|
|
supportedScrubberType - String
|
|
portBerths - [VoyageApiVoyageItineraries_Voyage_Port_VoyageItinerary_PortBerths_Port_PortBerthInput]
|
Example
{
"portNo": 123,
"vesonID": 987,
"country": "xyz789",
"name": "abc123",
"longitude": 123.45,
"latitude": 123.45,
"unCode": "abc123",
"lowSulfur": true,
"piracyArea": false,
"isEcaZone": true,
"supportedScrubberType": "xyz789",
"portBerths": [
VoyageApiVoyageItineraries_Voyage_Port_VoyageItinerary_PortBerths_Port_PortBerthInput
]
}
VoyageApiVoyageItineraries_Voyage_VoyageCargoHandlings_VoyageItinerary_Cargo_VoyageCargoHandling_Cargo
VoyageApiVoyageItineraries_Voyage_VoyageCargoHandlings_VoyageItinerary_Cargo_VoyageCargoHandling_CargoInput
VoyageApiVoyageItineraries_Voyage_VoyageCargoHandlings_VoyageItinerary_PortFunction_VoyageCargoHandling_PortFunction
VoyageApiVoyageItineraries_Voyage_VoyageCargoHandlings_VoyageItinerary_PortFunction_VoyageCargoHandling_PortFunctionInput
VoyageApiVoyageItineraries_Voyage_VoyageCargoHandlings_VoyageItinerary_VoyageCargoHandling
Fields
| Field Name | Description |
|---|---|
berthSeqNo - Int
|
|
seqNo - Int
|
|
fixtureCargoSeq - Int
|
|
cargoShortName - String
|
|
blQuantity - Float
|
|
loadDischargeRate - Float
|
|
terms - String
|
|
blDate - Date
|
|
blCode - String
|
|
cpUnit - String
|
|
rateUnit - String
|
|
nominatedLiftQty - Float
|
|
norHours - Float
|
|
cargoItinSeqNo - Int
|
|
ordNo - Int
|
|
portFunction - VoyageApiVoyageItineraries_Voyage_VoyageCargoHandlings_VoyageItinerary_PortFunction_VoyageCargoHandling_PortFunction
|
|
cargo - VoyageApiVoyageItineraries_Voyage_VoyageCargoHandlings_VoyageItinerary_Cargo_VoyageCargoHandling_Cargo
|
Example
{
"berthSeqNo": 987,
"seqNo": 987,
"fixtureCargoSeq": 987,
"cargoShortName": "abc123",
"blQuantity": 123.45,
"loadDischargeRate": 987.65,
"terms": "xyz789",
"blDate": "2007-12-03",
"blCode": "xyz789",
"cpUnit": "abc123",
"rateUnit": "abc123",
"nominatedLiftQty": 987.65,
"norHours": 987.65,
"cargoItinSeqNo": 123,
"ordNo": 123,
"portFunction": VoyageApiVoyageItineraries_Voyage_VoyageCargoHandlings_VoyageItinerary_PortFunction_VoyageCargoHandling_PortFunction,
"cargo": VoyageApiVoyageItineraries_Voyage_VoyageCargoHandlings_VoyageItinerary_Cargo_VoyageCargoHandling_Cargo
}
VoyageApiVoyageItineraries_Voyage_VoyageCargoHandlings_VoyageItinerary_VoyageCargoHandlingInput
Fields
| Input Field | Description |
|---|---|
berthSeqNo - Int
|
|
seqNo - Int
|
|
fixtureCargoSeq - Int
|
|
cargoShortName - String
|
|
blQuantity - Float
|
|
loadDischargeRate - Float
|
|
terms - String
|
|
blDate - Date
|
|
blCode - String
|
|
cpUnit - String
|
|
rateUnit - String
|
|
nominatedLiftQty - Float
|
|
norHours - Float
|
|
cargoItinSeqNo - Int
|
|
ordNo - Int
|
|
portFunction - VoyageApiVoyageItineraries_Voyage_VoyageCargoHandlings_VoyageItinerary_PortFunction_VoyageCargoHandling_PortFunctionInput
|
|
cargo - VoyageApiVoyageItineraries_Voyage_VoyageCargoHandlings_VoyageItinerary_Cargo_VoyageCargoHandling_CargoInput
|
Example
{
"berthSeqNo": 123,
"seqNo": 987,
"fixtureCargoSeq": 123,
"cargoShortName": "xyz789",
"blQuantity": 987.65,
"loadDischargeRate": 987.65,
"terms": "abc123",
"blDate": "2007-12-03",
"blCode": "abc123",
"cpUnit": "abc123",
"rateUnit": "abc123",
"nominatedLiftQty": 123.45,
"norHours": 123.45,
"cargoItinSeqNo": 123,
"ordNo": 987,
"portFunction": VoyageApiVoyageItineraries_Voyage_VoyageCargoHandlings_VoyageItinerary_PortFunction_VoyageCargoHandling_PortFunctionInput,
"cargo": VoyageApiVoyageItineraries_Voyage_VoyageCargoHandlings_VoyageItinerary_Cargo_VoyageCargoHandling_CargoInput
}
VoyageApiVoyageItineraries_Voyage_VoyageItinerary
Fields
Example
{
"seq": 987,
"arrDepStatus": "xyz789",
"ballastLadenFromPort": "xyz789",
"fixtureNo": "abc123",
"order": 123,
"portNo": 987,
"portName": "abc123",
"speedFromPort": 987.65,
"weatherFactorFromPort": 987.65,
"etaGmt": "2007-12-03",
"portDays": 123.45,
"etdGmt": "2007-12-03",
"arrivalLocal": "2007-12-03",
"departureLocal": "2007-12-03",
"portFunc": "abc123",
"lastUpdateGmt": "2007-12-03",
"demDesRate": 987.65,
"lowSpeedMiles": 987,
"lowSpeedDays": 987.65,
"miles": 123,
"port": VoyageApiVoyageItineraries_Voyage_Port_VoyageItinerary_Port,
"voyageItineraryBunkers": [
VoyageApiVoyageItineraries_Voyage_VoyageItineraryBunkers_VoyageItinerary_VoyageItineraryBunker
],
"voyagePortActivities": [
VoyageApiVoyageItineraries_Voyage_VoyagePortActivities_VoyageItinerary_VoyagePortActivities
],
"voyageItineraryBerths": [
VoyageApiVoyageItineraries_Voyage_VoyageItineraryBerths_VoyageItinerary_VoyageItineraryBerth
],
"voyageCargoHandlings": [
VoyageApiVoyageItineraries_Voyage_VoyageCargoHandlings_VoyageItinerary_VoyageCargoHandling
],
"bunkerRequirements": [
VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerRequirement
],
"voyagePortAgents": [
VoyageApiVoyageItineraries_Voyage_VoyagePortAgents_VoyageItinerary_VoyagePortAgent
]
}
VoyageApiVoyageItineraries_Voyage_VoyageItineraryBerths_VoyageItinerary_VoyageItineraryBerth
VoyageApiVoyageItineraries_Voyage_VoyageItineraryBerths_VoyageItinerary_VoyageItineraryBerthInput
VoyageApiVoyageItineraries_Voyage_VoyageItineraryBunkers_VoyageItinerary_VoyageItineraryBunker
Example
{
"fuelType": "abc123",
"robArrival": 987.65,
"oprQty": 123.45,
"robDeparture": 123.45,
"price": 987.65,
"arrRobPrice": 987.65,
"depRobPrice": 123.45
}
VoyageApiVoyageItineraries_Voyage_VoyageItineraryBunkers_VoyageItinerary_VoyageItineraryBunkerInput
Example
{
"fuelType": "abc123",
"robArrival": 987.65,
"oprQty": 987.65,
"robDeparture": 987.65,
"price": 123.45,
"arrRobPrice": 123.45,
"depRobPrice": 987.65
}
VoyageApiVoyageItineraries_Voyage_VoyageItineraryInput
Fields
Example
{
"seq": 123,
"arrDepStatus": "abc123",
"ballastLadenFromPort": "xyz789",
"fixtureNo": "xyz789",
"order": 123,
"portNo": 987,
"portName": "xyz789",
"speedFromPort": 987.65,
"weatherFactorFromPort": 123.45,
"etaGmt": "2007-12-03",
"portDays": 987.65,
"etdGmt": "2007-12-03",
"arrivalLocal": "2007-12-03",
"departureLocal": "2007-12-03",
"portFunc": "xyz789",
"lastUpdateGmt": "2007-12-03",
"demDesRate": 123.45,
"lowSpeedMiles": 987,
"lowSpeedDays": 987.65,
"miles": 123,
"port": VoyageApiVoyageItineraries_Voyage_Port_VoyageItinerary_PortInput,
"voyageItineraryBunkers": [
VoyageApiVoyageItineraries_Voyage_VoyageItineraryBunkers_VoyageItinerary_VoyageItineraryBunkerInput
],
"voyagePortActivities": [
VoyageApiVoyageItineraries_Voyage_VoyagePortActivities_VoyageItinerary_VoyagePortActivitiesInput
],
"voyageItineraryBerths": [
VoyageApiVoyageItineraries_Voyage_VoyageItineraryBerths_VoyageItinerary_VoyageItineraryBerthInput
],
"voyageCargoHandlings": [
VoyageApiVoyageItineraries_Voyage_VoyageCargoHandlings_VoyageItinerary_VoyageCargoHandlingInput
],
"bunkerRequirements": [
VoyageApiVoyageItineraries_Voyage_BunkerRequirements_VoyageItinerary_BunkerRequirementInput
],
"voyagePortAgents": [
VoyageApiVoyageItineraries_Voyage_VoyagePortAgents_VoyageItinerary_VoyagePortAgentInput
]
}
VoyageApiVoyageItineraries_Voyage_VoyagePortActivities_VoyageItinerary_VoyagePortActivities
Example
{
"seq": 987,
"activityTimeLocal": "2007-12-03",
"activityTimeGmt": "2007-12-03",
"activityName": "xyz789",
"remarks": "abc123",
"cargoHandlingSeqNo": 987,
"cargoShortName": "abc123",
"berthShortName": "abc123",
"activityType": "abc123"
}
VoyageApiVoyageItineraries_Voyage_VoyagePortActivities_VoyageItinerary_VoyagePortActivitiesInput
Example
{
"seq": 987,
"activityTimeLocal": "2007-12-03",
"activityTimeGmt": "2007-12-03",
"activityName": "abc123",
"remarks": "xyz789",
"cargoHandlingSeqNo": 123,
"cargoShortName": "xyz789",
"berthShortName": "xyz789",
"activityType": "xyz789"
}
VoyageApiVoyageItineraries_Voyage_VoyagePortAgents_VoyageItinerary_AddressBook_VoyagePortAgent_AddressBook
Example
{
"shortName": "xyz789",
"fullName": "abc123",
"address1": "abc123",
"address2": "xyz789",
"address3": "abc123",
"address4": "xyz789",
"country": "xyz789",
"phone": "xyz789",
"mainContact": "abc123",
"curr": "xyz789",
"companyNo": 123,
"email": "abc123",
"veslinkID": "abc123"
}
VoyageApiVoyageItineraries_Voyage_VoyagePortAgents_VoyageItinerary_AddressBook_VoyagePortAgent_AddressBookInput
Example
{
"shortName": "xyz789",
"fullName": "abc123",
"address1": "xyz789",
"address2": "xyz789",
"address3": "xyz789",
"address4": "xyz789",
"country": "xyz789",
"phone": "xyz789",
"mainContact": "abc123",
"curr": "xyz789",
"companyNo": 123,
"email": "xyz789",
"veslinkID": "xyz789"
}
VoyageApiVoyageItineraries_Voyage_VoyagePortAgents_VoyageItinerary_VoyagePortAgent
Fields
| Field Name | Description |
|---|---|
agentRole - String
|
|
addressBook - VoyageApiVoyageItineraries_Voyage_VoyagePortAgents_VoyageItinerary_AddressBook_VoyagePortAgent_AddressBook
|
Example
{
"agentRole": "xyz789",
"addressBook": VoyageApiVoyageItineraries_Voyage_VoyagePortAgents_VoyageItinerary_AddressBook_VoyagePortAgent_AddressBook
}
VoyageApiVoyageItineraries_Voyage_VoyagePortAgents_VoyageItinerary_VoyagePortAgentInput
Fields
| Input Field | Description |
|---|---|
agentRole - String
|
|
addressBook - VoyageApiVoyageItineraries_Voyage_VoyagePortAgents_VoyageItinerary_AddressBook_VoyagePortAgent_AddressBookInput
|
Example
{
"agentRole": "abc123",
"addressBook": VoyageApiVoyageItineraries_Voyage_VoyagePortAgents_VoyageItinerary_AddressBook_VoyagePortAgent_AddressBookInput
}
VoyageApiVoyageTemplate_Voyage_VoyageTemplate
Example
{
"laytimeCommencePortActName": "xyz789",
"laytimeCommencePortActOffsetHours": 123.45,
"laytimeCompletePortActName": "xyz789",
"laytimeCompletePortActOffsetHours": 123.45
}
VoyageApiVoyageTemplate_Voyage_VoyageTemplateInput
Example
{
"laytimeCommencePortActName": "xyz789",
"laytimeCommencePortActOffsetHours": 987.65,
"laytimeCompletePortActName": "xyz789",
"laytimeCompletePortActOffsetHours": 123.45
}
VoyageApi_UpcomingPortsListInput
Example
{
"vesselCode": "xyz789",
"voyageNo": 987,
"seq": 987,
"upcomingPorts": [
VoyageApi_UpcomingPortsList_UpcomingPortsInput
],
"suppressPortMismatchError": false,
"allowChangingItinLength": false,
"allowChangingItinerary": true,
"reportTime": "2007-12-03",
"reportType": "abc123"
}
VoyageApi_UpcomingPortsList_UpcomingPortsInput
Fields
| Input Field | Description |
|---|---|
distanceToGo - Float
|
|
projectedSpeed - Float
|
|
etaGmt - Date
|
|
port - VoyageApi_UpcomingPortsList_UpcomingPortsInput_PortInput
|
Example
{
"distanceToGo": 123.45,
"projectedSpeed": 987.65,
"etaGmt": "2007-12-03",
"port": VoyageApi_UpcomingPortsList_UpcomingPortsInput_PortInput
}
VoyageApi_UpcomingPortsList_UpcomingPortsInput_PortInput
VoyageBunkerInventory
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
seq - Int
|
|
lastUpdateGmt - Date
|
|
lastUserID - String
|
|
itinerarySeq - Int
|
|
type - String
|
|
counterpartyShortName - String
|
|
referenceDateGmt - Date
|
|
counterpartyType - String
|
|
liftingID - Int
|
|
voyageBunkerLifting - VoyageBunkerLifting
|
|
counterparty - AddressBook
|
|
voyage - Voyage
|
|
voyageItinerary - VoyageItinerary
|
|
voyageBunkerInventoryDetails - [VoyageBunkerInventoryDetail]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 987,
"seq": 123,
"lastUpdateGmt": "2007-12-03",
"lastUserID": "abc123",
"itinerarySeq": 987,
"type": "xyz789",
"counterpartyShortName": "xyz789",
"referenceDateGmt": "2007-12-03",
"counterpartyType": "xyz789",
"liftingID": 987,
"voyageBunkerLifting": VoyageBunkerLifting,
"counterparty": AddressBook,
"voyage": Voyage,
"voyageItinerary": VoyageItinerary,
"voyageBunkerInventoryDetails": [
VoyageBunkerInventoryDetail
],
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
VoyageBunkerInventoryDetail
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
seq - Int
|
|
itinerarySeq - Int
|
|
type - String
|
|
fuelType - String
|
|
qty - Float
|
|
price - Float
|
|
voyageBunkerInventory - VoyageBunkerInventory
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 987,
"seq": 123,
"itinerarySeq": 123,
"type": "xyz789",
"fuelType": "abc123",
"qty": 987.65,
"price": 123.45,
"voyageBunkerInventory": VoyageBunkerInventory,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageBunkerInventoryDetailFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageBunkerInventoryDetailFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageBunkerInventoryDetailFormQueryWhere
}
VoyageBunkerInventoryDetailFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyageBunkerInventoryDetailFormQueryWhere!]
|
|
or - [VoyageBunkerInventoryDetailFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
itinerarySeq - NumberWhereValueExpression
|
|
type - VoyageBunkerInventoryDetailTypeEnumValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
qty - NumberWhereValueExpression
|
|
price - NumberWhereValueExpression
|
|
voyageBunkerInventory - VoyageBunkerInventoryFormQueryWhere
|
Example
{
"and": [VoyageBunkerInventoryDetailFormQueryWhere],
"or": [VoyageBunkerInventoryDetailFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"itinerarySeq": NumberWhereValueExpression,
"type": VoyageBunkerInventoryDetailTypeEnumValueExpression,
"fuelType": StringWhereValueExpression,
"qty": NumberWhereValueExpression,
"price": NumberWhereValueExpression,
"voyageBunkerInventory": VoyageBunkerInventoryFormQueryWhere
}
VoyageBunkerInventoryDetailRelationships
Fields
| Field Name | Description |
|---|---|
voyageBunkerInventory - RelationshipDefinition
|
Example
{"voyageBunkerInventory": RelationshipDefinition}
VoyageBunkerInventoryDetailTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Open"
VoyageBunkerInventoryDetailTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageBunkerInventoryDetailTypeEnum
|
|
isNot - VoyageBunkerInventoryDetailTypeEnum
|
|
isIn - [VoyageBunkerInventoryDetailTypeEnum]
|
Example
{"is": "Open", "isNot": "Open", "isIn": ["Open"]}
VoyageBunkerInventoryFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageBunkerInventoryFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageBunkerInventoryFormQueryWhere
}
VoyageBunkerInventoryFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyageBunkerInventoryFormQueryWhere!]
|
|
or - [VoyageBunkerInventoryFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUserID - StringWhereValueExpression
|
|
itinerarySeq - NumberWhereValueExpression
|
|
type - VoyageBunkerInventoryTypeEnumValueExpression
|
|
counterpartyShortName - StringWhereValueExpression
|
|
referenceDateGmt - DateWhereValueExpression
|
|
counterpartyType - StringWhereValueExpression
|
|
liftingID - NumberWhereValueExpression
|
|
voyageBunkerLifting - VoyageBunkerLiftingFormQueryWhere
|
|
counterparty - AddressBookFormQueryWhere
|
|
voyage - VoyageFormQueryWhere
|
|
voyageItinerary - VoyageItineraryFormQueryWhere
|
Example
{
"and": [VoyageBunkerInventoryFormQueryWhere],
"or": [VoyageBunkerInventoryFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"itinerarySeq": NumberWhereValueExpression,
"type": VoyageBunkerInventoryTypeEnumValueExpression,
"counterpartyShortName": StringWhereValueExpression,
"referenceDateGmt": DateWhereValueExpression,
"counterpartyType": StringWhereValueExpression,
"liftingID": NumberWhereValueExpression,
"voyageBunkerLifting": VoyageBunkerLiftingFormQueryWhere,
"counterparty": AddressBookFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"voyageItinerary": VoyageItineraryFormQueryWhere
}
VoyageBunkerInventoryRelationships
Fields
| Field Name | Description |
|---|---|
voyageBunkerLifting - RelationshipDefinition
|
|
counterparty - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
voyageItinerary - RelationshipDefinition
|
|
voyageBunkerInventoryDetails - RelationshipDefinition
|
Example
{
"voyageBunkerLifting": RelationshipDefinition,
"counterparty": RelationshipDefinition,
"voyage": RelationshipDefinition,
"voyageItinerary": RelationshipDefinition,
"voyageBunkerInventoryDetails": RelationshipDefinition
}
VoyageBunkerInventoryTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Open"
VoyageBunkerInventoryTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageBunkerInventoryTypeEnum
|
|
isNot - VoyageBunkerInventoryTypeEnum
|
|
isIn - [VoyageBunkerInventoryTypeEnum]
|
Example
{"is": "Open", "isNot": "Open", "isIn": ["Open"]}
VoyageBunkerLifting
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
requirementID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
bunkerInvoiceTransNo - Int
|
|
hasBunkerInvoice - Boolean
|
|
requestID - Int
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
itinerarySeq - Int
|
|
vendorShortName - String
|
|
bunkerInvoiceTransNoInternal - Int
|
|
tciCode - String
|
|
tcoCode - String
|
|
status - String
|
|
paidBy - String
|
|
forAccount - String
|
|
liftingDateGmt - Date
|
|
liftingID - Int
|
|
vendorType - String
|
|
linkedLiftingID - Int
|
|
tcoCharteredStatus - String
|
|
order - Int
|
|
vendor - AddressBook
|
|
voyageItinerary - VoyageItinerary
|
|
voyage - Voyage
|
|
bunkerInquiriesAndPurchases - BunkerInquiriesAndPurchases
|
|
linkedBunkerInvoice - BunkerInvoice
|
|
operationsInvoice - OperationsInvoice
|
|
bunkerLiftingDetails - [BunkerLiftingDetail]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"requirementID": 987,
"customFieldByID": Any,
"customField": Any,
"bunkerInvoiceTransNo": 123,
"hasBunkerInvoice": true,
"requestID": 987,
"vesselCode": "abc123",
"voyageNo": 987,
"itinerarySeq": 123,
"vendorShortName": "abc123",
"bunkerInvoiceTransNoInternal": 987,
"tciCode": "abc123",
"tcoCode": "abc123",
"status": "abc123",
"paidBy": "xyz789",
"forAccount": "xyz789",
"liftingDateGmt": "2007-12-03",
"liftingID": 987,
"vendorType": "xyz789",
"linkedLiftingID": 987,
"tcoCharteredStatus": "abc123",
"order": 123,
"vendor": AddressBook,
"voyageItinerary": VoyageItinerary,
"voyage": Voyage,
"bunkerInquiriesAndPurchases": BunkerInquiriesAndPurchases,
"linkedBunkerInvoice": BunkerInvoice,
"operationsInvoice": OperationsInvoice,
"bunkerLiftingDetails": [BunkerLiftingDetail],
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
VoyageBunkerLiftingFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageBunkerLiftingFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageBunkerLiftingFormQueryWhere
}
VoyageBunkerLiftingFormQueryWhere
Fields
Example
{
"and": [VoyageBunkerLiftingFormQueryWhere],
"or": [VoyageBunkerLiftingFormQueryWhere],
"rawExpression": "abc123",
"requestID": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"itinerarySeq": NumberWhereValueExpression,
"vendorShortName": StringWhereValueExpression,
"bunkerInvoiceTransNoInternal": NumberWhereValueExpression,
"tciCode": StringWhereValueExpression,
"tcoCode": StringWhereValueExpression,
"status": StringWhereValueExpression,
"paidBy": StringWhereValueExpression,
"forAccount": StringWhereValueExpression,
"liftingDateGmt": DateWhereValueExpression,
"liftingID": NumberWhereValueExpression,
"vendorType": StringWhereValueExpression,
"linkedLiftingID": NumberWhereValueExpression,
"tcoCharteredStatus": VoyageBunkerLiftingTcoCharteredStatusEnumValueExpression,
"order": NumberWhereValueExpression,
"vendor": AddressBookFormQueryWhere,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"bunkerInquiriesAndPurchases": BunkerInquiriesAndPurchasesFormQueryWhere,
"linkedBunkerInvoice": BunkerInvoiceFormQueryWhere,
"operationsInvoice": OperationsInvoiceFormQueryWhere
}
VoyageBunkerLiftingRelationships
Fields
| Field Name | Description |
|---|---|
vendor - RelationshipDefinition
|
|
voyageItinerary - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
bunkerInquiriesAndPurchases - RelationshipDefinition
|
|
linkedBunkerInvoice - RelationshipDefinition
|
|
operationsInvoice - RelationshipDefinition
|
|
bunkerLiftingDetails - RelationshipDefinition
|
Example
{
"vendor": RelationshipDefinition,
"voyageItinerary": RelationshipDefinition,
"voyage": RelationshipDefinition,
"bunkerInquiriesAndPurchases": RelationshipDefinition,
"linkedBunkerInvoice": RelationshipDefinition,
"operationsInvoice": RelationshipDefinition,
"bunkerLiftingDetails": RelationshipDefinition
}
VoyageBunkerLiftingTcoCharteredStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
VoyageBunkerLiftingTcoCharteredStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageBunkerLiftingTcoCharteredStatusEnum
|
|
isNot - VoyageBunkerLiftingTcoCharteredStatusEnum
|
|
isIn - [VoyageBunkerLiftingTcoCharteredStatusEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VoyageBunkerSummary
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
fuelType - String
|
|
startQty - Float
|
|
startPrice - Float
|
|
endQty - Float
|
|
endPrice - Float
|
|
cO2EmissionsFactor - Float
|
|
voyage - Voyage
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 123,
"fuelType": "abc123",
"startQty": 987.65,
"startPrice": 987.65,
"endQty": 123.45,
"endPrice": 123.45,
"cO2EmissionsFactor": 123.45,
"voyage": Voyage,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageBunkerSummaryFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageBunkerSummaryFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageBunkerSummaryFormQueryWhere
}
VoyageBunkerSummaryFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyageBunkerSummaryFormQueryWhere!]
|
|
or - [VoyageBunkerSummaryFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
startQty - NumberWhereValueExpression
|
|
startPrice - NumberWhereValueExpression
|
|
endQty - NumberWhereValueExpression
|
|
endPrice - NumberWhereValueExpression
|
|
cO2EmissionsFactor - NumberWhereValueExpression
|
|
voyage - VoyageFormQueryWhere
|
Example
{
"and": [VoyageBunkerSummaryFormQueryWhere],
"or": [VoyageBunkerSummaryFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"startQty": NumberWhereValueExpression,
"startPrice": NumberWhereValueExpression,
"endQty": NumberWhereValueExpression,
"endPrice": NumberWhereValueExpression,
"cO2EmissionsFactor": NumberWhereValueExpression,
"voyage": VoyageFormQueryWhere
}
VoyageBunkerSummaryRelationships
Fields
| Field Name | Description |
|---|---|
voyage - RelationshipDefinition
|
Example
{"voyage": RelationshipDefinition}
VoyageCargoHandling
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
voyageItineraryOrderNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
laycanAlertCount - Int
|
|
blQuantityString - String
|
|
specificGravity - Float
|
|
stowageFactor - Float
|
|
cargoVolume - Float
|
|
cargoHasEther - Boolean
|
|
qtyDiff - Float
|
|
sG - Float
|
|
altQty1 - Float
|
|
altUnit1 - String
|
|
effectiveDemurrageRate - Float
|
|
barges - String
|
|
sqlID - Int
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
voyageSeqNo - Int
|
|
berthSeqNo - Int
|
|
seqNo - Int
|
|
fixtureNo - String
|
|
fixtureCargoSeq - Int
|
|
cargoShortName - String
|
|
portNo - Int
|
|
functionCode - String
|
|
altBLGross - Float
|
|
altShipGross - Float
|
|
shipGross - Float
|
|
apiShip - Float
|
|
shipLTemp - Float
|
|
altProductNet - Float
|
|
productNet - Float
|
|
blQuantity - Float
|
|
loadDischargeRate - Float
|
|
terms - String
|
|
blOriginals - Int
|
|
blOriginalsSignedByMasterOnBoard - Int
|
|
copies - Int
|
|
signedByMasterOnBoard - Int
|
|
blDate - Date
|
|
authorizedToSignForMaster - String
|
|
blCode - String
|
|
cpUnit - String
|
|
altCPUnit - String
|
|
supplierReceiver - String
|
|
rateUnit - String
|
|
manualTtlPDays - Boolean
|
|
interservice - Boolean
|
|
flagTwo - Boolean
|
|
flagThree - Boolean
|
|
manualLDRate - Boolean
|
|
manualTTHrs - Boolean
|
|
mtbeEntered - Boolean
|
|
fameEntered - Boolean
|
|
etbeEntered - Boolean
|
|
allBarges - Boolean
|
|
isWarrantyConditionsMet - Boolean
|
|
isLopFiled - Boolean
|
|
isTimeUntilStartActual - Boolean
|
|
isInspectionActual - Boolean
|
|
isPurgingActual - Boolean
|
|
isConnectActual - Boolean
|
|
isPumpingActual - Boolean
|
|
isDisconnectActual - Boolean
|
|
isExtraHoursActual - Boolean
|
|
isInspectionWaitingActual - Boolean
|
|
isPurgingWaitingActual - Boolean
|
|
isConnectWaitingActual - Boolean
|
|
isPumpingWaitingActual - Boolean
|
|
isDisconnectWaitingActual - Boolean
|
|
isAllocated - Boolean
|
|
altQty2 - Float
|
|
altUnit2 - String
|
|
altQty3 - Float
|
|
altUnit3 - String
|
|
altQty4 - Float
|
|
altUnit4 - String
|
|
internalBU - String
|
|
nominatedLiftQty - Float
|
|
nominatedLiftUnit - String
|
|
laycanFromLocal - Date
|
|
laycanToLocal - Date
|
|
cargoItinGradeSeqNo - Int
|
|
commercialID - String
|
|
agentShortName - String
|
|
norHours - Float
|
|
cargoItinSeqNo - Int
|
|
lastUpdateGmt - Date
|
|
transshipmentCargoID - Int
|
|
transshipmentPortNo - Int
|
|
sCACCode - String
|
|
transferID - Int
|
|
externalRef - String
|
|
blInfoReceivedDate - Date
|
|
sTSVessel - String
|
|
ordNo - Int
|
|
mTBEPercentage - Float
|
|
fAMEPercentage - Float
|
|
eTBEPercentage - Float
|
|
gsvShore - Float
|
|
inspectorShortName - String
|
|
cargoID - Int
|
|
blDraft - Float
|
|
transshipmentCPLoadDiscRate - Float
|
|
transshipmentCPRateUnit - String
|
|
transshipmentCPTerms - String
|
|
transshipmentCPNorHours - Float
|
|
lOIDate - Date
|
|
timeUntilStartHours - Float
|
|
inspectionHours - Float
|
|
purgingHours - Float
|
|
connectHours - Float
|
|
pumpingHours - Float
|
|
disconnectHours - Float
|
|
extraHours - Float
|
|
purgeDome - String
|
|
loadDome - String
|
|
handlingStatus - String
|
|
informationalTransshipmentVesselCode - String
|
|
estimatedRate - Float
|
|
estimatedRateUnit - String
|
|
inspectionHoursWaiting - Float
|
|
purgingHoursWaiting - Float
|
|
connectHoursWaiting - Float
|
|
pumpingHoursWaiting - Float
|
|
disconnectHoursWaiting - Float
|
|
extraHoursWaiting - Float
|
|
portFunction - PortFunction
|
|
informationalTransshipmentVessel - Vessel
|
|
voyageCargoTransfer - VoyageCargoTransfer
|
|
port - Port
|
|
cargo - Cargo
|
|
voyageItinerary - VoyageItinerary
|
|
voyItinBerth - VoyageItineraryBerth
|
|
cargoItinerary - CargoItinerary
|
|
cargoItineraryByGrade - CargoItinerary
|
|
cargoName - CargoName
|
|
laycanAlert - CargoItinerary
|
|
voyageCargoHandlingEvents - [VoyageCargoHandlingEvent]
|
|
voyageCargoHandlingStowages - [VoyageCargoHandlingStowage]
|
|
cargoBrokers - [CargoBroker]
|
|
voyageCargoHandlingDocuments - [VoyageCargoHandlingDocument]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"voyageItineraryOrderNo": 123,
"customFieldByID": Any,
"customField": Any,
"laycanAlertCount": 987,
"blQuantityString": "xyz789",
"specificGravity": 123.45,
"stowageFactor": 123.45,
"cargoVolume": 123.45,
"cargoHasEther": false,
"qtyDiff": 123.45,
"sG": 123.45,
"altQty1": 123.45,
"altUnit1": "abc123",
"effectiveDemurrageRate": 123.45,
"barges": "abc123",
"sqlID": 123,
"vesselCode": "xyz789",
"voyageNo": 123,
"voyageSeqNo": 987,
"berthSeqNo": 987,
"seqNo": 123,
"fixtureNo": "abc123",
"fixtureCargoSeq": 987,
"cargoShortName": "xyz789",
"portNo": 987,
"functionCode": "xyz789",
"altBLGross": 123.45,
"altShipGross": 123.45,
"shipGross": 987.65,
"apiShip": 987.65,
"shipLTemp": 123.45,
"altProductNet": 987.65,
"productNet": 123.45,
"blQuantity": 987.65,
"loadDischargeRate": 987.65,
"terms": "xyz789",
"blOriginals": 987,
"blOriginalsSignedByMasterOnBoard": 123,
"copies": 123,
"signedByMasterOnBoard": 123,
"blDate": "2007-12-03",
"authorizedToSignForMaster": "xyz789",
"blCode": "abc123",
"cpUnit": "abc123",
"altCPUnit": "xyz789",
"supplierReceiver": "abc123",
"rateUnit": "abc123",
"manualTtlPDays": false,
"interservice": false,
"flagTwo": true,
"flagThree": false,
"manualLDRate": true,
"manualTTHrs": true,
"mtbeEntered": true,
"fameEntered": true,
"etbeEntered": false,
"allBarges": true,
"isWarrantyConditionsMet": false,
"isLopFiled": true,
"isTimeUntilStartActual": true,
"isInspectionActual": false,
"isPurgingActual": true,
"isConnectActual": true,
"isPumpingActual": false,
"isDisconnectActual": false,
"isExtraHoursActual": false,
"isInspectionWaitingActual": true,
"isPurgingWaitingActual": false,
"isConnectWaitingActual": false,
"isPumpingWaitingActual": false,
"isDisconnectWaitingActual": true,
"isAllocated": false,
"altQty2": 987.65,
"altUnit2": "abc123",
"altQty3": 123.45,
"altUnit3": "abc123",
"altQty4": 123.45,
"altUnit4": "abc123",
"internalBU": "xyz789",
"nominatedLiftQty": 123.45,
"nominatedLiftUnit": "abc123",
"laycanFromLocal": "2007-12-03",
"laycanToLocal": "2007-12-03",
"cargoItinGradeSeqNo": 123,
"commercialID": "abc123",
"agentShortName": "abc123",
"norHours": 987.65,
"cargoItinSeqNo": 123,
"lastUpdateGmt": "2007-12-03",
"transshipmentCargoID": 123,
"transshipmentPortNo": 987,
"sCACCode": "xyz789",
"transferID": 987,
"externalRef": "xyz789",
"blInfoReceivedDate": "2007-12-03",
"sTSVessel": "abc123",
"ordNo": 987,
"mTBEPercentage": 987.65,
"fAMEPercentage": 123.45,
"eTBEPercentage": 987.65,
"gsvShore": 123.45,
"inspectorShortName": "abc123",
"cargoID": 123,
"blDraft": 123.45,
"transshipmentCPLoadDiscRate": 123.45,
"transshipmentCPRateUnit": "abc123",
"transshipmentCPTerms": "xyz789",
"transshipmentCPNorHours": 987.65,
"lOIDate": "2007-12-03",
"timeUntilStartHours": 123.45,
"inspectionHours": 123.45,
"purgingHours": 987.65,
"connectHours": 987.65,
"pumpingHours": 123.45,
"disconnectHours": 987.65,
"extraHours": 123.45,
"purgeDome": "xyz789",
"loadDome": "xyz789",
"handlingStatus": "xyz789",
"informationalTransshipmentVesselCode": "abc123",
"estimatedRate": 123.45,
"estimatedRateUnit": "abc123",
"inspectionHoursWaiting": 123.45,
"purgingHoursWaiting": 987.65,
"connectHoursWaiting": 987.65,
"pumpingHoursWaiting": 987.65,
"disconnectHoursWaiting": 123.45,
"extraHoursWaiting": 987.65,
"portFunction": PortFunction,
"informationalTransshipmentVessel": Vessel,
"voyageCargoTransfer": VoyageCargoTransfer,
"port": Port,
"cargo": Cargo,
"voyageItinerary": VoyageItinerary,
"voyItinBerth": VoyageItineraryBerth,
"cargoItinerary": CargoItinerary,
"cargoItineraryByGrade": CargoItinerary,
"cargoName": CargoName,
"laycanAlert": CargoItinerary,
"voyageCargoHandlingEvents": [VoyageCargoHandlingEvent],
"voyageCargoHandlingStowages": [
VoyageCargoHandlingStowage
],
"cargoBrokers": [CargoBroker],
"voyageCargoHandlingDocuments": [
VoyageCargoHandlingDocument
],
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
VoyageCargoHandlingDocument
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
itinerarySeq - Int
|
|
seqNo - Int
|
|
lineNo - Int
|
|
text - String
|
|
cargoShortName - String
|
|
type - String
|
|
lastUser - String
|
|
voyage - Voyage
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 123,
"itinerarySeq": 987,
"seqNo": 123,
"lineNo": 123,
"text": "xyz789",
"cargoShortName": "abc123",
"type": "abc123",
"lastUser": "xyz789",
"voyage": Voyage,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
VoyageCargoHandlingDocumentFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageCargoHandlingDocumentFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageCargoHandlingDocumentFormQueryWhere
}
VoyageCargoHandlingDocumentFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyageCargoHandlingDocumentFormQueryWhere!]
|
|
or - [VoyageCargoHandlingDocumentFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
itinerarySeq - NumberWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
lineNo - NumberWhereValueExpression
|
|
text - StringWhereValueExpression
|
|
cargoShortName - StringWhereValueExpression
|
|
type - VoyageCargoHandlingDocumentTypeEnumValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
voyage - VoyageFormQueryWhere
|
Example
{
"and": [VoyageCargoHandlingDocumentFormQueryWhere],
"or": [VoyageCargoHandlingDocumentFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"itinerarySeq": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"lineNo": NumberWhereValueExpression,
"text": StringWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"type": VoyageCargoHandlingDocumentTypeEnumValueExpression,
"lastUser": StringWhereValueExpression,
"voyage": VoyageFormQueryWhere
}
VoyageCargoHandlingDocumentRelationships
Fields
| Field Name | Description |
|---|---|
voyage - RelationshipDefinition
|
Example
{"voyage": RelationshipDefinition}
VoyageCargoHandlingDocumentTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
VoyageCargoHandlingDocumentTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageCargoHandlingDocumentTypeEnum
|
|
isNot - VoyageCargoHandlingDocumentTypeEnum
|
|
isIn - [VoyageCargoHandlingDocumentTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
VoyageCargoHandlingEvent
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
itinerarySeqNo - Int
|
|
berthSeqNo - Int
|
|
cargoHandlingSeqNo - Int
|
|
seqNo - Int
|
|
estimatedHours - Float
|
|
estimatedWaitingHours - Float
|
|
type - Int
|
|
orderNo - Int
|
|
actualStartTimeLocal - Date
|
|
actualEndTimeLocal - Date
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
createdByUser - String
|
|
lastUserID - String
|
|
voyageCargoHandling - VoyageCargoHandling
|
|
cargoHandlingEventType - CargoHandlingEventType
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 123,
"itinerarySeqNo": 987,
"berthSeqNo": 987,
"cargoHandlingSeqNo": 123,
"seqNo": 123,
"estimatedHours": 123.45,
"estimatedWaitingHours": 987.65,
"type": 123,
"orderNo": 123,
"actualStartTimeLocal": "2007-12-03",
"actualEndTimeLocal": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"createdByUser": "abc123",
"lastUserID": "xyz789",
"voyageCargoHandling": VoyageCargoHandling,
"cargoHandlingEventType": CargoHandlingEventType,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageCargoHandlingEventFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageCargoHandlingEventFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageCargoHandlingEventFormQueryWhere
}
VoyageCargoHandlingEventFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyageCargoHandlingEventFormQueryWhere!]
|
|
or - [VoyageCargoHandlingEventFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
itinerarySeqNo - NumberWhereValueExpression
|
|
berthSeqNo - NumberWhereValueExpression
|
|
cargoHandlingSeqNo - NumberWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
estimatedHours - NumberWhereValueExpression
|
|
estimatedWaitingHours - NumberWhereValueExpression
|
|
type - NumberWhereValueExpression
|
|
orderNo - NumberWhereValueExpression
|
|
actualStartTimeLocal - DateWhereValueExpression
|
|
actualEndTimeLocal - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
createdByUser - StringWhereValueExpression
|
|
lastUserID - StringWhereValueExpression
|
|
voyageCargoHandling - VoyageCargoHandlingFormQueryWhere
|
|
cargoHandlingEventType - CargoHandlingEventTypeFormQueryWhere
|
Example
{
"and": [VoyageCargoHandlingEventFormQueryWhere],
"or": [VoyageCargoHandlingEventFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"itinerarySeqNo": NumberWhereValueExpression,
"berthSeqNo": NumberWhereValueExpression,
"cargoHandlingSeqNo": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"estimatedHours": NumberWhereValueExpression,
"estimatedWaitingHours": NumberWhereValueExpression,
"type": NumberWhereValueExpression,
"orderNo": NumberWhereValueExpression,
"actualStartTimeLocal": DateWhereValueExpression,
"actualEndTimeLocal": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"createdByUser": StringWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"voyageCargoHandling": VoyageCargoHandlingFormQueryWhere,
"cargoHandlingEventType": CargoHandlingEventTypeFormQueryWhere
}
VoyageCargoHandlingEventRelationships
Fields
| Field Name | Description |
|---|---|
voyageCargoHandling - RelationshipDefinition
|
|
cargoHandlingEventType - RelationshipDefinition
|
Example
{
"voyageCargoHandling": RelationshipDefinition,
"cargoHandlingEventType": RelationshipDefinition
}
VoyageCargoHandlingFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageCargoHandlingFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageCargoHandlingFormQueryWhere
}
VoyageCargoHandlingFormQueryWhere
Fields
Example
{
"and": [VoyageCargoHandlingFormQueryWhere],
"or": [VoyageCargoHandlingFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"voyageSeqNo": NumberWhereValueExpression,
"berthSeqNo": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"fixtureNo": StringWhereValueExpression,
"fixtureCargoSeq": NumberWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"portNo": NumberWhereValueExpression,
"functionCode": StringWhereValueExpression,
"altBLGross": NumberWhereValueExpression,
"altShipGross": NumberWhereValueExpression,
"shipGross": NumberWhereValueExpression,
"apiShip": NumberWhereValueExpression,
"shipLTemp": NumberWhereValueExpression,
"altProductNet": NumberWhereValueExpression,
"productNet": NumberWhereValueExpression,
"blQuantity": NumberWhereValueExpression,
"loadDischargeRate": NumberWhereValueExpression,
"terms": StringWhereValueExpression,
"blOriginals": NumberWhereValueExpression,
"blOriginalsSignedByMasterOnBoard": NumberWhereValueExpression,
"copies": NumberWhereValueExpression,
"signedByMasterOnBoard": NumberWhereValueExpression,
"blDate": DateWhereValueExpression,
"authorizedToSignForMaster": StringWhereValueExpression,
"blCode": StringWhereValueExpression,
"cpUnit": StringWhereValueExpression,
"altCPUnit": StringWhereValueExpression,
"supplierReceiver": StringWhereValueExpression,
"rateUnit": StringWhereValueExpression,
"manualTtlPDays": BoolWhereValueExpression,
"interservice": BoolWhereValueExpression,
"flagTwo": BoolWhereValueExpression,
"flagThree": BoolWhereValueExpression,
"manualLDRate": BoolWhereValueExpression,
"manualTTHrs": BoolWhereValueExpression,
"mtbeEntered": BoolWhereValueExpression,
"fameEntered": BoolWhereValueExpression,
"etbeEntered": BoolWhereValueExpression,
"allBarges": BoolWhereValueExpression,
"isWarrantyConditionsMet": BoolWhereValueExpression,
"isLopFiled": BoolWhereValueExpression,
"isTimeUntilStartActual": BoolWhereValueExpression,
"isInspectionActual": BoolWhereValueExpression,
"isPurgingActual": BoolWhereValueExpression,
"isConnectActual": BoolWhereValueExpression,
"isPumpingActual": BoolWhereValueExpression,
"isDisconnectActual": BoolWhereValueExpression,
"isExtraHoursActual": BoolWhereValueExpression,
"isInspectionWaitingActual": BoolWhereValueExpression,
"isPurgingWaitingActual": BoolWhereValueExpression,
"isConnectWaitingActual": BoolWhereValueExpression,
"isPumpingWaitingActual": BoolWhereValueExpression,
"isDisconnectWaitingActual": BoolWhereValueExpression,
"isAllocated": BoolWhereValueExpression,
"altQty2": NumberWhereValueExpression,
"altUnit2": StringWhereValueExpression,
"altQty3": NumberWhereValueExpression,
"altUnit3": StringWhereValueExpression,
"altQty4": NumberWhereValueExpression,
"altUnit4": StringWhereValueExpression,
"internalBU": StringWhereValueExpression,
"nominatedLiftQty": NumberWhereValueExpression,
"nominatedLiftUnit": StringWhereValueExpression,
"laycanFromLocal": DateWhereValueExpression,
"laycanToLocal": DateWhereValueExpression,
"cargoItinGradeSeqNo": NumberWhereValueExpression,
"commercialID": StringWhereValueExpression,
"agentShortName": StringWhereValueExpression,
"norHours": NumberWhereValueExpression,
"cargoItinSeqNo": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"transshipmentCargoID": NumberWhereValueExpression,
"transshipmentPortNo": NumberWhereValueExpression,
"sCACCode": StringWhereValueExpression,
"transferID": NumberWhereValueExpression,
"externalRef": StringWhereValueExpression,
"blInfoReceivedDate": DateWhereValueExpression,
"sTSVessel": StringWhereValueExpression,
"ordNo": NumberWhereValueExpression,
"mTBEPercentage": NumberWhereValueExpression,
"fAMEPercentage": NumberWhereValueExpression,
"eTBEPercentage": NumberWhereValueExpression,
"gsvShore": NumberWhereValueExpression,
"inspectorShortName": StringWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"blDraft": NumberWhereValueExpression,
"transshipmentCPLoadDiscRate": NumberWhereValueExpression,
"transshipmentCPRateUnit": StringWhereValueExpression,
"transshipmentCPTerms": StringWhereValueExpression,
"transshipmentCPNorHours": NumberWhereValueExpression,
"lOIDate": DateWhereValueExpression,
"timeUntilStartHours": NumberWhereValueExpression,
"inspectionHours": NumberWhereValueExpression,
"purgingHours": NumberWhereValueExpression,
"connectHours": NumberWhereValueExpression,
"pumpingHours": NumberWhereValueExpression,
"disconnectHours": NumberWhereValueExpression,
"extraHours": NumberWhereValueExpression,
"purgeDome": VoyageCargoHandlingPurgeDomeEnumValueExpression,
"loadDome": VoyageCargoHandlingLoadDomeEnumValueExpression,
"handlingStatus": VoyageCargoHandlingHandlingStatusEnumValueExpression,
"informationalTransshipmentVesselCode": StringWhereValueExpression,
"estimatedRate": NumberWhereValueExpression,
"estimatedRateUnit": StringWhereValueExpression,
"inspectionHoursWaiting": NumberWhereValueExpression,
"purgingHoursWaiting": NumberWhereValueExpression,
"connectHoursWaiting": NumberWhereValueExpression,
"pumpingHoursWaiting": NumberWhereValueExpression,
"disconnectHoursWaiting": NumberWhereValueExpression,
"extraHoursWaiting": NumberWhereValueExpression,
"portFunction": PortFunctionFormQueryWhere,
"informationalTransshipmentVessel": VesselFormQueryWhere,
"voyageCargoTransfer": VoyageCargoTransferFormQueryWhere,
"port": PortFormQueryWhere,
"cargo": CargoFormQueryWhere,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"voyItinBerth": VoyageItineraryBerthFormQueryWhere,
"cargoItinerary": CargoItineraryFormQueryWhere,
"cargoItineraryByGrade": CargoItineraryFormQueryWhere,
"cargoName": CargoNameFormQueryWhere,
"laycanAlert": CargoItineraryFormQueryWhere
}
VoyageCargoHandlingHandlingStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
VoyageCargoHandlingHandlingStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageCargoHandlingHandlingStatusEnum
|
|
isNot - VoyageCargoHandlingHandlingStatusEnum
|
|
isIn - [VoyageCargoHandlingHandlingStatusEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VoyageCargoHandlingLoadDomeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
VoyageCargoHandlingLoadDomeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageCargoHandlingLoadDomeEnum
|
|
isNot - VoyageCargoHandlingLoadDomeEnum
|
|
isIn - [VoyageCargoHandlingLoadDomeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VoyageCargoHandlingPurgeDomeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
VoyageCargoHandlingPurgeDomeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageCargoHandlingPurgeDomeEnum
|
|
isNot - VoyageCargoHandlingPurgeDomeEnum
|
|
isIn - [VoyageCargoHandlingPurgeDomeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VoyageCargoHandlingRelationships
Fields
| Field Name | Description |
|---|---|
portFunction - RelationshipDefinition
|
|
informationalTransshipmentVessel - RelationshipDefinition
|
|
voyageCargoTransfer - RelationshipDefinition
|
|
port - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
voyageItinerary - RelationshipDefinition
|
|
voyItinBerth - RelationshipDefinition
|
|
cargoItinerary - RelationshipDefinition
|
|
cargoItineraryByGrade - RelationshipDefinition
|
|
cargoName - RelationshipDefinition
|
|
laycanAlert - RelationshipDefinition
|
|
voyageCargoHandlingEvents - RelationshipDefinition
|
|
voyageCargoHandlingStowages - RelationshipDefinition
|
|
cargoBrokers - RelationshipDefinition
|
|
voyageCargoHandlingDocuments - RelationshipDefinition
|
|
scheduleBarges - RelationshipDefinition
|
Example
{
"portFunction": RelationshipDefinition,
"informationalTransshipmentVessel": RelationshipDefinition,
"voyageCargoTransfer": RelationshipDefinition,
"port": RelationshipDefinition,
"cargo": RelationshipDefinition,
"voyageItinerary": RelationshipDefinition,
"voyItinBerth": RelationshipDefinition,
"cargoItinerary": RelationshipDefinition,
"cargoItineraryByGrade": RelationshipDefinition,
"cargoName": RelationshipDefinition,
"laycanAlert": RelationshipDefinition,
"voyageCargoHandlingEvents": RelationshipDefinition,
"voyageCargoHandlingStowages": RelationshipDefinition,
"cargoBrokers": RelationshipDefinition,
"voyageCargoHandlingDocuments": RelationshipDefinition,
"scheduleBarges": RelationshipDefinition
}
VoyageCargoHandlingStowage
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tankName - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
voyageSeqNo - Int
|
|
berthSeqNo - Int
|
|
seqNo - Int
|
|
holdNo - Int
|
|
quantity - Float
|
|
lastUser - String
|
|
voyageCargoHandling - VoyageCargoHandling
|
|
vesselTank - VesselTank
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"tankName": "abc123",
"customFieldByID": Any,
"customField": Any,
"vesselCode": "abc123",
"voyageNo": 123,
"voyageSeqNo": 987,
"berthSeqNo": 123,
"seqNo": 987,
"holdNo": 987,
"quantity": 987.65,
"lastUser": "abc123",
"voyageCargoHandling": VoyageCargoHandling,
"vesselTank": VesselTank,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
VoyageCargoHandlingStowageFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageCargoHandlingStowageFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageCargoHandlingStowageFormQueryWhere
}
VoyageCargoHandlingStowageFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyageCargoHandlingStowageFormQueryWhere!]
|
|
or - [VoyageCargoHandlingStowageFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
voyageSeqNo - NumberWhereValueExpression
|
|
berthSeqNo - NumberWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
holdNo - NumberWhereValueExpression
|
|
quantity - NumberWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
voyageCargoHandling - VoyageCargoHandlingFormQueryWhere
|
|
vesselTank - VesselTankFormQueryWhere
|
Example
{
"and": [VoyageCargoHandlingStowageFormQueryWhere],
"or": [VoyageCargoHandlingStowageFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"voyageSeqNo": NumberWhereValueExpression,
"berthSeqNo": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"holdNo": NumberWhereValueExpression,
"quantity": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"voyageCargoHandling": VoyageCargoHandlingFormQueryWhere,
"vesselTank": VesselTankFormQueryWhere
}
VoyageCargoHandlingStowageRelationships
Fields
| Field Name | Description |
|---|---|
voyageCargoHandling - RelationshipDefinition
|
|
vesselTank - RelationshipDefinition
|
Example
{
"voyageCargoHandling": RelationshipDefinition,
"vesselTank": RelationshipDefinition
}
VoyageCargoTransfer
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
tradeNo - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
sourceItinerarySeq - Int
|
|
sourceVoyageNo - Int
|
|
destinationVoyageNo - Int
|
|
iD - Int
|
|
sourceVesselCode - String
|
|
sourceVoyageNoInternal - Int
|
|
sourceFixtureNo - String
|
|
destinationVesselCode - String
|
|
destinationVoyageNoInternal - Int
|
|
destinationFixtureNo - String
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
lastUserID - String
|
|
cargoShortName - String
|
|
nominatedLiftUnit - String
|
|
nominatedLiftQty - Float
|
|
lighteringOrder - Int
|
|
destinationFixture - Fixture
|
|
sourceFixture - Fixture
|
|
destinationVessel - Vessel
|
|
sourceVessel - Vessel
|
|
sourceVoyageItinerary - VoyageItinerary
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"tradeNo": "xyz789",
"customFieldByID": Any,
"customField": Any,
"sourceItinerarySeq": 987,
"sourceVoyageNo": 123,
"destinationVoyageNo": 987,
"iD": 987,
"sourceVesselCode": "xyz789",
"sourceVoyageNoInternal": 987,
"sourceFixtureNo": "abc123",
"destinationVesselCode": "xyz789",
"destinationVoyageNoInternal": 123,
"destinationFixtureNo": "abc123",
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"lastUserID": "xyz789",
"cargoShortName": "abc123",
"nominatedLiftUnit": "xyz789",
"nominatedLiftQty": 123.45,
"lighteringOrder": 123,
"destinationFixture": Fixture,
"sourceFixture": Fixture,
"destinationVessel": Vessel,
"sourceVessel": Vessel,
"sourceVoyageItinerary": VoyageItinerary,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageCargoTransferFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageCargoTransferFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageCargoTransferFormQueryWhere
}
VoyageCargoTransferFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyageCargoTransferFormQueryWhere!]
|
|
or - [VoyageCargoTransferFormQueryWhere!]
|
|
rawExpression - String
|
|
iD - NumberWhereValueExpression
|
|
sourceVesselCode - StringWhereValueExpression
|
|
sourceVoyageNoInternal - NumberWhereValueExpression
|
|
sourceFixtureNo - StringWhereValueExpression
|
|
destinationVesselCode - StringWhereValueExpression
|
|
destinationVoyageNoInternal - NumberWhereValueExpression
|
|
destinationFixtureNo - StringWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUserID - StringWhereValueExpression
|
|
cargoShortName - StringWhereValueExpression
|
|
nominatedLiftUnit - StringWhereValueExpression
|
|
nominatedLiftQty - NumberWhereValueExpression
|
|
lighteringOrder - NumberWhereValueExpression
|
|
destinationFixture - FixtureFormQueryWhere
|
|
sourceFixture - FixtureFormQueryWhere
|
|
destinationVessel - VesselFormQueryWhere
|
|
sourceVessel - VesselFormQueryWhere
|
|
sourceVoyageItinerary - VoyageItineraryFormQueryWhere
|
Example
{
"and": [VoyageCargoTransferFormQueryWhere],
"or": [VoyageCargoTransferFormQueryWhere],
"rawExpression": "xyz789",
"iD": NumberWhereValueExpression,
"sourceVesselCode": StringWhereValueExpression,
"sourceVoyageNoInternal": NumberWhereValueExpression,
"sourceFixtureNo": StringWhereValueExpression,
"destinationVesselCode": StringWhereValueExpression,
"destinationVoyageNoInternal": NumberWhereValueExpression,
"destinationFixtureNo": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"nominatedLiftUnit": StringWhereValueExpression,
"nominatedLiftQty": NumberWhereValueExpression,
"lighteringOrder": NumberWhereValueExpression,
"destinationFixture": FixtureFormQueryWhere,
"sourceFixture": FixtureFormQueryWhere,
"destinationVessel": VesselFormQueryWhere,
"sourceVessel": VesselFormQueryWhere,
"sourceVoyageItinerary": VoyageItineraryFormQueryWhere
}
VoyageCargoTransferRelationships
Fields
| Field Name | Description |
|---|---|
destinationFixture - RelationshipDefinition
|
|
sourceFixture - RelationshipDefinition
|
|
destinationVessel - RelationshipDefinition
|
|
sourceVessel - RelationshipDefinition
|
|
sourceVoyageCargoHandling - RelationshipDefinition
|
|
sourceVoyageItinerary - RelationshipDefinition
|
|
sourceVoyage - RelationshipDefinition
|
|
destinationVoyage - RelationshipDefinition
|
Example
{
"destinationFixture": RelationshipDefinition,
"sourceFixture": RelationshipDefinition,
"destinationVessel": RelationshipDefinition,
"sourceVessel": RelationshipDefinition,
"sourceVoyageCargoHandling": RelationshipDefinition,
"sourceVoyageItinerary": RelationshipDefinition,
"sourceVoyage": RelationshipDefinition,
"destinationVoyage": RelationshipDefinition
}
VoyageChangesSinceLast
Fields
| Field Name | Description |
|---|---|
sCCVoyageEmissions - MessageUpdateResponse
|
|
publishVoyageUpdate - MessageUpdateResponse
|
|
scheduleVoyage - MessageUpdateResponse
|
|
updateVoyage - MessageUpdateResponse
|
Example
{
"sCCVoyageEmissions": MessageUpdateResponse,
"publishVoyageUpdate": MessageUpdateResponse,
"scheduleVoyage": MessageUpdateResponse,
"updateVoyage": MessageUpdateResponse
}
VoyageContact
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
contactID - Int
|
|
subContactID - Int
|
|
companyType - String
|
|
companyShortName - String
|
|
termCode - Int
|
|
etaUsePrimaryEmail - Boolean
|
|
etaUseCCEmail - Boolean
|
|
ptaUsePrimaryEmail - Boolean
|
|
ptaUseCCEmail - Boolean
|
|
remarks - String
|
|
subType - String
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
cargoID - Int
|
|
email - String
|
|
voyage - Voyage
|
|
addressBook - AddressBook
|
|
addressBookContact - AddressBookContact
|
|
term - Term
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 123,
"contactID": 123,
"subContactID": 987,
"companyType": "xyz789",
"companyShortName": "abc123",
"termCode": 987,
"etaUsePrimaryEmail": true,
"etaUseCCEmail": true,
"ptaUsePrimaryEmail": true,
"ptaUseCCEmail": false,
"remarks": "abc123",
"subType": "xyz789",
"lastUser": "xyz789",
"lastUpdateGmt": "2007-12-03",
"cargoID": 987,
"email": "xyz789",
"voyage": Voyage,
"addressBook": AddressBook,
"addressBookContact": AddressBookContact,
"term": Term,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageContactFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageContactFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageContactFormQueryWhere
}
VoyageContactFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyageContactFormQueryWhere!]
|
|
or - [VoyageContactFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
contactID - NumberWhereValueExpression
|
|
subContactID - NumberWhereValueExpression
|
|
companyType - StringWhereValueExpression
|
|
companyShortName - StringWhereValueExpression
|
|
termCode - NumberWhereValueExpression
|
|
etaUsePrimaryEmail - BoolWhereValueExpression
|
|
etaUseCCEmail - BoolWhereValueExpression
|
|
ptaUsePrimaryEmail - BoolWhereValueExpression
|
|
ptaUseCCEmail - BoolWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
subType - VoyageContactSubTypeEnumValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
cargoID - NumberWhereValueExpression
|
|
email - StringWhereValueExpression
|
|
voyage - VoyageFormQueryWhere
|
|
addressBook - AddressBookFormQueryWhere
|
|
addressBookContact - AddressBookContactFormQueryWhere
|
|
term - TermFormQueryWhere
|
Example
{
"and": [VoyageContactFormQueryWhere],
"or": [VoyageContactFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"contactID": NumberWhereValueExpression,
"subContactID": NumberWhereValueExpression,
"companyType": StringWhereValueExpression,
"companyShortName": StringWhereValueExpression,
"termCode": NumberWhereValueExpression,
"etaUsePrimaryEmail": BoolWhereValueExpression,
"etaUseCCEmail": BoolWhereValueExpression,
"ptaUsePrimaryEmail": BoolWhereValueExpression,
"ptaUseCCEmail": BoolWhereValueExpression,
"remarks": StringWhereValueExpression,
"subType": VoyageContactSubTypeEnumValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"email": StringWhereValueExpression,
"voyage": VoyageFormQueryWhere,
"addressBook": AddressBookFormQueryWhere,
"addressBookContact": AddressBookContactFormQueryWhere,
"term": TermFormQueryWhere
}
VoyageContactFullRelationships
Fields
| Field Name | Description |
|---|---|
voyageContact - RelationshipDefinition
|
|
addressBook - RelationshipDefinition
|
|
addressBookContact - RelationshipDefinition
|
Example
{
"voyageContact": RelationshipDefinition,
"addressBook": RelationshipDefinition,
"addressBookContact": RelationshipDefinition
}
VoyageContactRelationships
Fields
| Field Name | Description |
|---|---|
voyage - RelationshipDefinition
|
|
addressBook - RelationshipDefinition
|
|
addressBookContact - RelationshipDefinition
|
|
term - RelationshipDefinition
|
Example
{
"voyage": RelationshipDefinition,
"addressBook": RelationshipDefinition,
"addressBookContact": RelationshipDefinition,
"term": RelationshipDefinition
}
VoyageContactSubTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
VoyageContactSubTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageContactSubTypeEnum
|
|
isNot - VoyageContactSubTypeEnum
|
|
isIn - [VoyageContactSubTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
VoyageEmissions
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
seq - Int
|
|
ordNo - Int
|
|
vschedSeq - Int
|
|
source - String
|
|
portNo - Int
|
|
distance - Float
|
|
ballastOrLadenLeg - String
|
|
beforeInternal - Boolean
|
|
afterInternal - Boolean
|
|
entryUserID - String
|
|
entryDate - Date
|
|
updateTimes - Int
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
cargoQty - Float
|
|
totalCargoQty - Float
|
|
portCargoQty - Float
|
|
portTotalCargoQty - Float
|
|
port - Port
|
|
voyage - Voyage
|
|
voyageEmissionsDetails - [VoyageEmissionsDetail]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 987,
"seq": 123,
"ordNo": 123,
"vschedSeq": 987,
"source": "abc123",
"portNo": 123,
"distance": 123.45,
"ballastOrLadenLeg": "abc123",
"beforeInternal": true,
"afterInternal": false,
"entryUserID": "abc123",
"entryDate": "2007-12-03",
"updateTimes": 123,
"lastUser": "xyz789",
"lastUpdateGmt": "2007-12-03",
"cargoQty": 987.65,
"totalCargoQty": 987.65,
"portCargoQty": 987.65,
"portTotalCargoQty": 123.45,
"port": Port,
"voyage": Voyage,
"voyageEmissionsDetails": [VoyageEmissionsDetail],
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
VoyageEmissionsDetail
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
seq - Int
|
|
fuelType - String
|
|
seaCons - Float
|
|
portCons - Float
|
|
cO2Factor - Float
|
|
voyageEmissions - VoyageEmissions
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 987,
"seq": 123,
"fuelType": "xyz789",
"seaCons": 987.65,
"portCons": 123.45,
"cO2Factor": 987.65,
"voyageEmissions": VoyageEmissions,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageEmissionsDetailFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageEmissionsDetailFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageEmissionsDetailFormQueryWhere
}
VoyageEmissionsDetailFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyageEmissionsDetailFormQueryWhere!]
|
|
or - [VoyageEmissionsDetailFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
seaCons - NumberWhereValueExpression
|
|
portCons - NumberWhereValueExpression
|
|
cO2Factor - NumberWhereValueExpression
|
|
voyageEmissions - VoyageEmissionsFormQueryWhere
|
Example
{
"and": [VoyageEmissionsDetailFormQueryWhere],
"or": [VoyageEmissionsDetailFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"seaCons": NumberWhereValueExpression,
"portCons": NumberWhereValueExpression,
"cO2Factor": NumberWhereValueExpression,
"voyageEmissions": VoyageEmissionsFormQueryWhere
}
VoyageEmissionsDetailRelationships
Fields
| Field Name | Description |
|---|---|
voyageEmissions - RelationshipDefinition
|
Example
{"voyageEmissions": RelationshipDefinition}
VoyageEmissionsFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageEmissionsFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageEmissionsFormQueryWhere
}
VoyageEmissionsFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyageEmissionsFormQueryWhere!]
|
|
or - [VoyageEmissionsFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
ordNo - NumberWhereValueExpression
|
|
vschedSeq - NumberWhereValueExpression
|
|
source - VoyageEmissionsSourceEnumValueExpression
|
|
portNo - NumberWhereValueExpression
|
|
distance - NumberWhereValueExpression
|
|
ballastOrLadenLeg - StringWhereValueExpression
|
|
beforeInternal - BoolWhereValueExpression
|
|
afterInternal - BoolWhereValueExpression
|
|
entryUserID - StringWhereValueExpression
|
|
entryDate - DateWhereValueExpression
|
|
updateTimes - NumberWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
cargoQty - NumberWhereValueExpression
|
|
totalCargoQty - NumberWhereValueExpression
|
|
portCargoQty - NumberWhereValueExpression
|
|
portTotalCargoQty - NumberWhereValueExpression
|
|
port - PortFormQueryWhere
|
|
voyage - VoyageFormQueryWhere
|
Example
{
"and": [VoyageEmissionsFormQueryWhere],
"or": [VoyageEmissionsFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"ordNo": NumberWhereValueExpression,
"vschedSeq": NumberWhereValueExpression,
"source": VoyageEmissionsSourceEnumValueExpression,
"portNo": NumberWhereValueExpression,
"distance": NumberWhereValueExpression,
"ballastOrLadenLeg": StringWhereValueExpression,
"beforeInternal": BoolWhereValueExpression,
"afterInternal": BoolWhereValueExpression,
"entryUserID": StringWhereValueExpression,
"entryDate": DateWhereValueExpression,
"updateTimes": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"cargoQty": NumberWhereValueExpression,
"totalCargoQty": NumberWhereValueExpression,
"portCargoQty": NumberWhereValueExpression,
"portTotalCargoQty": NumberWhereValueExpression,
"port": PortFormQueryWhere,
"voyage": VoyageFormQueryWhere
}
VoyageEmissionsRelationships
Fields
| Field Name | Description |
|---|---|
port - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
voyageEmissionsDetails - RelationshipDefinition
|
Example
{
"port": RelationshipDefinition,
"voyage": RelationshipDefinition,
"voyageEmissionsDetails": RelationshipDefinition
}
VoyageEmissionsSourceEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Internal"
VoyageEmissionsSourceEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageEmissionsSourceEnum
|
|
isNot - VoyageEmissionsSourceEnum
|
|
isIn - [VoyageEmissionsSourceEnum]
|
Example
{"is": "Internal", "isNot": "Internal", "isIn": ["Internal"]}
VoyageEquipmentEvent
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
equipmentContractCode - String
|
|
equipmentCode - String
|
|
sequenceNo - Int
|
|
event - String
|
|
eventDateGmt - Date
|
|
eventDateGmtOffset - Float
|
|
remarks - String
|
|
reason - String
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
equipmentType - String
|
|
orderNo - Int
|
|
rateDifferentialName - String
|
|
eventId - Int
|
|
automaticVoyageStart - Boolean
|
|
bunkerAdjWriteOff - Boolean
|
|
voyage - Voyage
|
|
barge - Barge
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 987,
"equipmentContractCode": "abc123",
"equipmentCode": "xyz789",
"sequenceNo": 987,
"event": "xyz789",
"eventDateGmt": "2007-12-03",
"eventDateGmtOffset": 123.45,
"remarks": "xyz789",
"reason": "xyz789",
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123",
"equipmentType": "xyz789",
"orderNo": 123,
"rateDifferentialName": "abc123",
"eventId": 987,
"automaticVoyageStart": false,
"bunkerAdjWriteOff": true,
"voyage": Voyage,
"barge": Barge,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageEquipmentEventEquipmentTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
VoyageEquipmentEventEquipmentTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageEquipmentEventEquipmentTypeEnum
|
|
isNot - VoyageEquipmentEventEquipmentTypeEnum
|
|
isIn - [VoyageEquipmentEventEquipmentTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
VoyageEquipmentEventEventEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Undefined"
VoyageEquipmentEventEventEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageEquipmentEventEventEnum
|
|
isNot - VoyageEquipmentEventEventEnum
|
|
isIn - [VoyageEquipmentEventEventEnum]
|
Example
{"is": "Undefined", "isNot": "Undefined", "isIn": ["Undefined"]}
VoyageEquipmentEventFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageEquipmentEventFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageEquipmentEventFormQueryWhere
}
VoyageEquipmentEventFormQueryWhere
Fields
Example
{
"and": [VoyageEquipmentEventFormQueryWhere],
"or": [VoyageEquipmentEventFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"equipmentContractCode": StringWhereValueExpression,
"equipmentCode": StringWhereValueExpression,
"sequenceNo": NumberWhereValueExpression,
"event": VoyageEquipmentEventEventEnumValueExpression,
"eventDateGmt": DateWhereValueExpression,
"eventDateGmtOffset": NumberWhereValueExpression,
"remarks": StringWhereValueExpression,
"reason": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"equipmentType": VoyageEquipmentEventEquipmentTypeEnumValueExpression,
"orderNo": NumberWhereValueExpression,
"rateDifferentialName": StringWhereValueExpression,
"eventId": NumberWhereValueExpression,
"automaticVoyageStart": BoolWhereValueExpression,
"bunkerAdjWriteOff": BoolWhereValueExpression,
"voyage": VoyageFormQueryWhere,
"barge": BargeFormQueryWhere
}
VoyageEquipmentEventRelationships
Fields
| Field Name | Description |
|---|---|
voyage - RelationshipDefinition
|
|
barge - RelationshipDefinition
|
Example
{
"voyage": RelationshipDefinition,
"barge": RelationshipDefinition
}
VoyageEstimate
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
statusString - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
totalMiles - Int
|
|
tradeAreaName - String
|
|
loadPortNames - String
|
|
discPortNames - String
|
|
isLSEstimate - Boolean
|
|
estCargoCounterpartyShortNames - String
|
|
estCargoIDs - String
|
|
voyageCommenceDateGmt - Date
|
|
voyageCompleteDateGmt - Date
|
|
sqlID - Int
|
|
lastUserInitials - String
|
|
estimateID - String
|
|
chartererShortName - String
|
|
cargo - String
|
|
firstLoadPortName - String
|
|
lastDischPortName - String
|
|
ballastBonus - Float
|
|
addressCommission - Float
|
|
vesselCode - String
|
|
dailyCost - Float
|
|
speedLaden - Float
|
|
speedBallast - Float
|
|
ballastPort - String
|
|
voyageCommenceDateLocal - Date
|
|
freightType - String
|
|
terminatingPort - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
fixed - String
|
|
lastUser - String
|
|
remarks - String
|
|
weatherFactorPercentage - Float
|
|
contractType - String
|
|
useCOAFreight - Boolean
|
|
lockTCE - Boolean
|
|
autoCalcByLiftQty - Boolean
|
|
useVschedItin - Boolean
|
|
tcoEstimate - Boolean
|
|
lowSulfurOnly - Boolean
|
|
capNoRebills - Boolean
|
|
consecutive - Boolean
|
|
bunkerOwner - Boolean
|
|
manualDailyCost - Boolean
|
|
manualAddCommRate - Boolean
|
|
fifoBunkers - Boolean
|
|
benchmark - Boolean
|
|
fixBunkers - Boolean
|
|
cancelled - Boolean
|
|
transshipment - Boolean
|
|
vettingFail - Boolean
|
|
addCommInclOPA - Boolean
|
|
forwardCurve - Boolean
|
|
thirdParty - Boolean
|
|
onSubs - Boolean
|
|
tcoExchRateManual - Boolean
|
|
lockProfit - Boolean
|
|
devTceCalc - Boolean
|
|
inProgressEst - Boolean
|
|
piracyDisabled - Boolean
|
|
piracyEnabled - Boolean
|
|
estTemplate - Boolean
|
|
estDeviation - Boolean
|
|
tcoEstTripTc - Boolean
|
|
lastTciVoyage - Boolean
|
|
isDeviationBaseline - Boolean
|
|
voyageDays - Float
|
|
voyageCompleteDateLocal - Date
|
|
tcE - Float
|
|
profit - Float
|
|
tradeAreaNo - Int
|
|
matrix - String
|
|
program - String
|
|
companyCode - String
|
|
lobCode - String
|
|
tcCode - String
|
|
charteringCoordinator - String
|
|
vesselLaycanFrom - Date
|
|
vesselLaycanTo - Date
|
|
createdByUser - String
|
|
baseCurrency - String
|
|
ice - Boolean
|
|
pool - Boolean
|
|
clean - Boolean
|
|
coated - Boolean
|
|
highRisk - Boolean
|
|
categoryID - Int
|
|
poolFee - Float
|
|
freightCurrency - String
|
|
worldscaleRate - Float
|
|
worldscalePercent - Float
|
|
cargoUnit - String
|
|
freightRate - Float
|
|
lumpsum - Float
|
|
totalLoadQuantity - Float
|
|
deviationVesselCode - String
|
|
deviationVoyageNumber - Int
|
|
accountingSegmentCode - String
|
|
prevVoyageNo - Int
|
|
prevEstimateID - String
|
|
prevTcCode - String
|
|
deviationEstimateBaselineId - String
|
|
deviationSnapshotTimeGmt - Date
|
|
enableFNCoaComponentCalc - Boolean
|
|
tceFromTarget - Boolean
|
|
openEstimate - Boolean
|
|
disableBackupFuelTypes - Boolean
|
|
waitForLaycan - Boolean
|
|
useScrubbers - Boolean
|
|
hasManualTciCommRate - Boolean
|
|
hasManuallyOverriddenMarketTcRate - Boolean
|
|
tcoBenchmark - Boolean
|
|
isLocked - Boolean
|
|
includeCarbonInPnL - Boolean
|
|
manualEtsExchangeRate - Boolean
|
|
manualOverrideAgreedEtsEmission - Boolean
|
|
manualOverrideAgreedEtsCost - Boolean
|
|
manualOverrideEtsPrice - Boolean
|
|
manualOverrideFuelEuExchangeRate - Boolean
|
|
manualOverrideFuelEuAgreedPenaltyEur - Boolean
|
|
manualOverrideFuelEuAgreedPenaltyBase - Boolean
|
|
includeFuelPenaltyInPnL - Boolean
|
|
manualOverrideFuelEuAgreedCompBalance - Boolean
|
|
manualLNGPricing - Boolean
|
|
useFuelEuBreakevenPrice - Boolean
|
|
prevPositionID - String
|
|
fuelZoneSetID - Int
|
|
naturalBoilOffBallastSpeed - Float
|
|
naturalBoilOffLadenSpeed - Float
|
|
scrubberType - String
|
|
tciBrokerCommissionRate - Float
|
|
tradeRoute - String
|
|
basisDate - Date
|
|
cO2Price - Float
|
|
cO2PriceCurrency - String
|
|
cO2PriceExchangeRate - Float
|
|
cO2Quantity - Float
|
|
etsCO2Quantity - Float
|
|
etsCO2Cost - Float
|
|
defaultSeaFuelConsumptionMode - String
|
|
defaultPortFuelConsumptionMode - String
|
|
voyageAer - Float
|
|
voyageCiiRating - String
|
|
transportWork - Float
|
|
eEOI - Float
|
|
previousDistance - Float
|
|
previousEmission - Float
|
|
previousAer - Float
|
|
previousCiiRating - String
|
|
cO2Symbol - String
|
|
cO2PriceBasisDate - Date
|
|
agreedEtsEmission - Float
|
|
agreedEtsCost - Float
|
|
etsPreVoyagePortNo - Int
|
|
etsPostVoyagePortNo - Int
|
|
fuelEUComplianceBalance - Float
|
|
fuelEUPenalty - Float
|
|
fuelEUTotalEnergy - Float
|
|
fuelEUExchangeRate - Float
|
|
fuelEUAgreedPenaltyEUR - Float
|
|
fuelEUAgreedPenaltyBase - Float
|
|
fuelEUAgreedComplianceBalance - Float
|
|
initialLNGPrice - Float
|
|
dischargeLNGPrice - Float
|
|
initialLNGCalorificValue - Float
|
|
dischargeLNGCalorificValue - Float
|
|
fuelEUBreakevenReplacementFuel - String
|
|
fuelEUBreakevenReplacementFuelPrice - Float
|
|
fuelZoneSet - FuelZoneSet
|
|
vessel - Vessel
|
|
cargoName - CargoName
|
|
fixture - Fixture
|
|
tradeArea - TradeArea
|
|
timeCharterOutDetails - TimeCharterOutDetails
|
|
commenceItinerary - EstimateItinerary
|
|
commencePort - Port
|
|
firstItinerary - EstimateItinerary
|
|
lastItinerary - EstimateItinerary
|
|
firstLoadItinerary - EstimateItinerary
|
|
lastDiscItinerary - EstimateItinerary
|
|
tciContract - TimeCharterContract
|
|
estimateFuelEuReplacementBunkers - [EstimateFuelEuReplacementBunker]
|
|
voyageEstimatePortExpenses - [VoyageEstimatePortExpense]
|
|
estimateDelays - [EstimateDelay]
|
|
voyageEstimateTimeCharterExpenses - [VoyageEstimateTimeCharterExpense]
|
|
voyageEstimateCOACVCAnalysis - [VoyageEstimateCOACVCAnalysis]
|
|
voyageEstimateBunkers - [VoyageEstimateBunker]
|
|
estimateCargoExtraFreightTerms - [EstimateCargoExtraFreightTerms]
|
|
benchmarkEstimates - [BenchmarkEstimate]
|
|
voyageEstimateMiscExpenses - [VoyageEstimateMiscExpense]
|
|
cargos - [Cargo]
|
|
estimateCargoes - [EstimateCargoes]
|
|
worksheetEstimates - [WorksheetEstimate]
|
|
charterer - [AddressBook]
|
|
loadItineraries - [EstimateItinerary]
|
|
discItineraries - [EstimateItinerary]
|
|
lSItineraries - [EstimateItinerary]
|
|
firstEstimateCargo - [EstimateCargoes]
|
|
category - [Term]
|
|
alerts - [Alert]
|
|
estimateItineraries - [EstimateItinerary]
|
|
auditActions - [AuditAction]
|
|
copyEstimateMessages - [CopyEstimateMessageRecord]
|
|
Arguments
|
|
updateEstimateMessages - [UpdateEstimateMessageRecord]
|
|
Arguments
|
|
changesSinceLast - VoyageEstimateChangesSinceLast
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"statusString": "xyz789",
"customFieldByID": Any,
"customField": Any,
"totalMiles": 123,
"tradeAreaName": "xyz789",
"loadPortNames": "xyz789",
"discPortNames": "xyz789",
"isLSEstimate": true,
"estCargoCounterpartyShortNames": "abc123",
"estCargoIDs": "abc123",
"voyageCommenceDateGmt": "2007-12-03",
"voyageCompleteDateGmt": "2007-12-03",
"sqlID": 987,
"lastUserInitials": "abc123",
"estimateID": "abc123",
"chartererShortName": "abc123",
"cargo": "xyz789",
"firstLoadPortName": "xyz789",
"lastDischPortName": "abc123",
"ballastBonus": 987.65,
"addressCommission": 987.65,
"vesselCode": "abc123",
"dailyCost": 987.65,
"speedLaden": 123.45,
"speedBallast": 123.45,
"ballastPort": "xyz789",
"voyageCommenceDateLocal": "2007-12-03",
"freightType": "abc123",
"terminatingPort": "abc123",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"fixed": "xyz789",
"lastUser": "xyz789",
"remarks": "xyz789",
"weatherFactorPercentage": 123.45,
"contractType": "abc123",
"useCOAFreight": false,
"lockTCE": false,
"autoCalcByLiftQty": true,
"useVschedItin": false,
"tcoEstimate": true,
"lowSulfurOnly": false,
"capNoRebills": false,
"consecutive": false,
"bunkerOwner": true,
"manualDailyCost": true,
"manualAddCommRate": false,
"fifoBunkers": false,
"benchmark": false,
"fixBunkers": true,
"cancelled": false,
"transshipment": true,
"vettingFail": true,
"addCommInclOPA": false,
"forwardCurve": false,
"thirdParty": false,
"onSubs": true,
"tcoExchRateManual": false,
"lockProfit": false,
"devTceCalc": true,
"inProgressEst": false,
"piracyDisabled": false,
"piracyEnabled": false,
"estTemplate": true,
"estDeviation": true,
"tcoEstTripTc": false,
"lastTciVoyage": true,
"isDeviationBaseline": true,
"voyageDays": 123.45,
"voyageCompleteDateLocal": "2007-12-03",
"tcE": 123.45,
"profit": 987.65,
"tradeAreaNo": 123,
"matrix": "xyz789",
"program": "xyz789",
"companyCode": "abc123",
"lobCode": "xyz789",
"tcCode": "xyz789",
"charteringCoordinator": "xyz789",
"vesselLaycanFrom": "2007-12-03",
"vesselLaycanTo": "2007-12-03",
"createdByUser": "xyz789",
"baseCurrency": "xyz789",
"ice": false,
"pool": false,
"clean": true,
"coated": true,
"highRisk": false,
"categoryID": 987,
"poolFee": 987.65,
"freightCurrency": "abc123",
"worldscaleRate": 987.65,
"worldscalePercent": 987.65,
"cargoUnit": "abc123",
"freightRate": 123.45,
"lumpsum": 987.65,
"totalLoadQuantity": 123.45,
"deviationVesselCode": "abc123",
"deviationVoyageNumber": 123,
"accountingSegmentCode": "abc123",
"prevVoyageNo": 987,
"prevEstimateID": "abc123",
"prevTcCode": "xyz789",
"deviationEstimateBaselineId": "xyz789",
"deviationSnapshotTimeGmt": "2007-12-03",
"enableFNCoaComponentCalc": false,
"tceFromTarget": true,
"openEstimate": false,
"disableBackupFuelTypes": true,
"waitForLaycan": false,
"useScrubbers": true,
"hasManualTciCommRate": true,
"hasManuallyOverriddenMarketTcRate": false,
"tcoBenchmark": false,
"isLocked": false,
"includeCarbonInPnL": false,
"manualEtsExchangeRate": false,
"manualOverrideAgreedEtsEmission": false,
"manualOverrideAgreedEtsCost": true,
"manualOverrideEtsPrice": false,
"manualOverrideFuelEuExchangeRate": false,
"manualOverrideFuelEuAgreedPenaltyEur": true,
"manualOverrideFuelEuAgreedPenaltyBase": true,
"includeFuelPenaltyInPnL": false,
"manualOverrideFuelEuAgreedCompBalance": false,
"manualLNGPricing": true,
"useFuelEuBreakevenPrice": false,
"prevPositionID": "xyz789",
"fuelZoneSetID": 123,
"naturalBoilOffBallastSpeed": 123.45,
"naturalBoilOffLadenSpeed": 123.45,
"scrubberType": "abc123",
"tciBrokerCommissionRate": 123.45,
"tradeRoute": "abc123",
"basisDate": "2007-12-03",
"cO2Price": 987.65,
"cO2PriceCurrency": "xyz789",
"cO2PriceExchangeRate": 987.65,
"cO2Quantity": 123.45,
"etsCO2Quantity": 123.45,
"etsCO2Cost": 987.65,
"defaultSeaFuelConsumptionMode": "xyz789",
"defaultPortFuelConsumptionMode": "abc123",
"voyageAer": 123.45,
"voyageCiiRating": "abc123",
"transportWork": 987.65,
"eEOI": 123.45,
"previousDistance": 987.65,
"previousEmission": 123.45,
"previousAer": 987.65,
"previousCiiRating": "xyz789",
"cO2Symbol": "xyz789",
"cO2PriceBasisDate": "2007-12-03",
"agreedEtsEmission": 123.45,
"agreedEtsCost": 123.45,
"etsPreVoyagePortNo": 123,
"etsPostVoyagePortNo": 123,
"fuelEUComplianceBalance": 123.45,
"fuelEUPenalty": 123.45,
"fuelEUTotalEnergy": 987.65,
"fuelEUExchangeRate": 123.45,
"fuelEUAgreedPenaltyEUR": 123.45,
"fuelEUAgreedPenaltyBase": 987.65,
"fuelEUAgreedComplianceBalance": 987.65,
"initialLNGPrice": 987.65,
"dischargeLNGPrice": 123.45,
"initialLNGCalorificValue": 123.45,
"dischargeLNGCalorificValue": 987.65,
"fuelEUBreakevenReplacementFuel": "abc123",
"fuelEUBreakevenReplacementFuelPrice": 987.65,
"fuelZoneSet": FuelZoneSet,
"vessel": Vessel,
"cargoName": CargoName,
"fixture": Fixture,
"tradeArea": TradeArea,
"timeCharterOutDetails": TimeCharterOutDetails,
"commenceItinerary": EstimateItinerary,
"commencePort": Port,
"firstItinerary": EstimateItinerary,
"lastItinerary": EstimateItinerary,
"firstLoadItinerary": EstimateItinerary,
"lastDiscItinerary": EstimateItinerary,
"tciContract": TimeCharterContract,
"estimateFuelEuReplacementBunkers": [
EstimateFuelEuReplacementBunker
],
"voyageEstimatePortExpenses": [
VoyageEstimatePortExpense
],
"estimateDelays": [EstimateDelay],
"voyageEstimateTimeCharterExpenses": [
VoyageEstimateTimeCharterExpense
],
"voyageEstimateCOACVCAnalysis": [
VoyageEstimateCOACVCAnalysis
],
"voyageEstimateBunkers": [VoyageEstimateBunker],
"estimateCargoExtraFreightTerms": [
EstimateCargoExtraFreightTerms
],
"benchmarkEstimates": [BenchmarkEstimate],
"voyageEstimateMiscExpenses": [
VoyageEstimateMiscExpense
],
"cargos": [Cargo],
"estimateCargoes": [EstimateCargoes],
"worksheetEstimates": [WorksheetEstimate],
"charterer": [AddressBook],
"loadItineraries": [EstimateItinerary],
"discItineraries": [EstimateItinerary],
"lSItineraries": [EstimateItinerary],
"firstEstimateCargo": [EstimateCargoes],
"category": [Term],
"alerts": [Alert],
"estimateItineraries": [EstimateItinerary],
"auditActions": [AuditAction],
"copyEstimateMessages": [CopyEstimateMessageRecord],
"updateEstimateMessages": [UpdateEstimateMessageRecord],
"changesSinceLast": VoyageEstimateChangesSinceLast,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
VoyageEstimateAlertRulesRequest
VoyageEstimateBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
estimateID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
fuelType - String
|
|
endingPrice - Float
|
|
initialQty - Float
|
|
initialPrice - Float
|
|
consumptionLaden - Float
|
|
consumptionBallast - Float
|
|
consumptionLoad - Float
|
|
consumptionDischarge - Float
|
|
consumptionIdle - Float
|
|
consumptionHotel - Float
|
|
consumptionHeat - Float
|
|
endingQty - Float
|
|
consumptionTotal - Float
|
|
bunkerSymbol - String
|
|
basisDate - Date
|
|
cO2EmissionsFactor - Float
|
|
voyageEstimate - VoyageEstimate
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"estimateID": "xyz789",
"customFieldByID": Any,
"customField": Any,
"fuelType": "abc123",
"endingPrice": 123.45,
"initialQty": 987.65,
"initialPrice": 987.65,
"consumptionLaden": 123.45,
"consumptionBallast": 123.45,
"consumptionLoad": 987.65,
"consumptionDischarge": 987.65,
"consumptionIdle": 123.45,
"consumptionHotel": 987.65,
"consumptionHeat": 123.45,
"endingQty": 987.65,
"consumptionTotal": 123.45,
"bunkerSymbol": "abc123",
"basisDate": "2007-12-03",
"cO2EmissionsFactor": 987.65,
"voyageEstimate": VoyageEstimate,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
VoyageEstimateBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageEstimateBunkerFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageEstimateBunkerFormQueryWhere
}
VoyageEstimateBunkerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyageEstimateBunkerFormQueryWhere!]
|
|
or - [VoyageEstimateBunkerFormQueryWhere!]
|
|
rawExpression - String
|
|
estimateID - StringWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
endingPrice - NumberWhereValueExpression
|
|
initialQty - NumberWhereValueExpression
|
|
initialPrice - NumberWhereValueExpression
|
|
consumptionLaden - NumberWhereValueExpression
|
|
consumptionBallast - NumberWhereValueExpression
|
|
consumptionLoad - NumberWhereValueExpression
|
|
consumptionDischarge - NumberWhereValueExpression
|
|
consumptionIdle - NumberWhereValueExpression
|
|
consumptionHotel - NumberWhereValueExpression
|
|
consumptionHeat - NumberWhereValueExpression
|
|
endingQty - NumberWhereValueExpression
|
|
consumptionTotal - NumberWhereValueExpression
|
|
bunkerSymbol - StringWhereValueExpression
|
|
basisDate - DateWhereValueExpression
|
|
cO2EmissionsFactor - NumberWhereValueExpression
|
|
voyageEstimate - VoyageEstimateFormQueryWhere
|
Example
{
"and": [VoyageEstimateBunkerFormQueryWhere],
"or": [VoyageEstimateBunkerFormQueryWhere],
"rawExpression": "xyz789",
"estimateID": StringWhereValueExpression,
"fuelType": StringWhereValueExpression,
"endingPrice": NumberWhereValueExpression,
"initialQty": NumberWhereValueExpression,
"initialPrice": NumberWhereValueExpression,
"consumptionLaden": NumberWhereValueExpression,
"consumptionBallast": NumberWhereValueExpression,
"consumptionLoad": NumberWhereValueExpression,
"consumptionDischarge": NumberWhereValueExpression,
"consumptionIdle": NumberWhereValueExpression,
"consumptionHotel": NumberWhereValueExpression,
"consumptionHeat": NumberWhereValueExpression,
"endingQty": NumberWhereValueExpression,
"consumptionTotal": NumberWhereValueExpression,
"bunkerSymbol": StringWhereValueExpression,
"basisDate": DateWhereValueExpression,
"cO2EmissionsFactor": NumberWhereValueExpression,
"voyageEstimate": VoyageEstimateFormQueryWhere
}
VoyageEstimateBunkerRelationships
Fields
| Field Name | Description |
|---|---|
voyageEstimate - RelationshipDefinition
|
Example
{"voyageEstimate": RelationshipDefinition}
VoyageEstimateCOACVCAnalysis
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
estimateID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
seq - Int
|
|
evaluationType - String
|
|
counterparty - String
|
|
counterpartyType - String
|
|
cpQuantity - Int
|
|
freightRate - Float
|
|
bAFBase - Float
|
|
bAFRate - Float
|
|
noOfLiftings - Int
|
|
dateFromLocal - Date
|
|
dateToLocal - Date
|
|
tcRoute - String
|
|
bunkerSymbol - String
|
|
vCRoute - String
|
|
weatherFactorPercentage - Float
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
entryDateGmt - Date
|
|
basisDate - Date
|
|
remarks - String
|
|
worksheetID - Int
|
|
vesselCode - String
|
|
voyageEstimate - VoyageEstimate
|
|
worksheet - Worksheet
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"estimateID": "abc123",
"customFieldByID": Any,
"customField": Any,
"seq": 987,
"evaluationType": "abc123",
"counterparty": "abc123",
"counterpartyType": "xyz789",
"cpQuantity": 123,
"freightRate": 123.45,
"bAFBase": 123.45,
"bAFRate": 987.65,
"noOfLiftings": 987,
"dateFromLocal": "2007-12-03",
"dateToLocal": "2007-12-03",
"tcRoute": "abc123",
"bunkerSymbol": "xyz789",
"vCRoute": "xyz789",
"weatherFactorPercentage": 123.45,
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"entryDateGmt": "2007-12-03",
"basisDate": "2007-12-03",
"remarks": "abc123",
"worksheetID": 987,
"vesselCode": "abc123",
"voyageEstimate": VoyageEstimate,
"worksheet": Worksheet,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageEstimateCOACVCAnalysisEvaluationTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
VoyageEstimateCOACVCAnalysisEvaluationTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageEstimateCOACVCAnalysisEvaluationTypeEnum
|
|
isNot - VoyageEstimateCOACVCAnalysisEvaluationTypeEnum
|
|
isIn - [VoyageEstimateCOACVCAnalysisEvaluationTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
VoyageEstimateCOACVCAnalysisFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageEstimateCOACVCAnalysisFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageEstimateCOACVCAnalysisFormQueryWhere
}
VoyageEstimateCOACVCAnalysisFormQueryWhere
Fields
Example
{
"and": [VoyageEstimateCOACVCAnalysisFormQueryWhere],
"or": [VoyageEstimateCOACVCAnalysisFormQueryWhere],
"rawExpression": "xyz789",
"estimateID": StringWhereValueExpression,
"seq": NumberWhereValueExpression,
"evaluationType": VoyageEstimateCOACVCAnalysisEvaluationTypeEnumValueExpression,
"counterparty": StringWhereValueExpression,
"counterpartyType": StringWhereValueExpression,
"cpQuantity": NumberWhereValueExpression,
"freightRate": NumberWhereValueExpression,
"bAFBase": NumberWhereValueExpression,
"bAFRate": NumberWhereValueExpression,
"noOfLiftings": NumberWhereValueExpression,
"dateFromLocal": DateWhereValueExpression,
"dateToLocal": DateWhereValueExpression,
"tcRoute": StringWhereValueExpression,
"bunkerSymbol": StringWhereValueExpression,
"vCRoute": StringWhereValueExpression,
"weatherFactorPercentage": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"basisDate": DateWhereValueExpression,
"remarks": StringWhereValueExpression,
"worksheetID": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"voyageEstimate": VoyageEstimateFormQueryWhere,
"worksheet": WorksheetFormQueryWhere
}
VoyageEstimateCOACVCAnalysisRelationships
Fields
| Field Name | Description |
|---|---|
voyageEstimate - RelationshipDefinition
|
|
worksheet - RelationshipDefinition
|
Example
{
"voyageEstimate": RelationshipDefinition,
"worksheet": RelationshipDefinition
}
VoyageEstimateCOACVCAnalysisResult
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
estimateID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
varsSeq - Int
|
|
seq - Int
|
|
date - Date
|
|
tcRoutePrice - Float
|
|
vCRoutePrice - Float
|
|
bunkerPrice - Float
|
|
benchmarkFreightRate - Float
|
|
benchmarkMtm - Float
|
|
routeMtm - Float
|
|
benchmarkRateDiff - Float
|
|
routeDiff - Float
|
|
bafAdjustmentFreightRate - Float
|
|
tcSource - String
|
|
bunkerSource - String
|
|
vCSource - String
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
entryDateGmt - Date
|
|
worksheetID - Int
|
|
vesselCode - String
|
|
basisDate - Date
|
|
forwardPeriod - String
|
|
tceMarket - Float
|
|
freightRate - Float
|
|
hireExpenses - Float
|
|
bunkerExpenses - Float
|
|
cO2Quantity - Float
|
|
voyageDays - Float
|
|
cO2Cost - Float
|
|
worksheet - Worksheet
|
|
voyageEstimateCOACVCAnalysisResultBunkers - [VoyageEstimateCOACVCAnalysisResultBunker]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"estimateID": "xyz789",
"customFieldByID": Any,
"customField": Any,
"varsSeq": 123,
"seq": 123,
"date": "2007-12-03",
"tcRoutePrice": 123.45,
"vCRoutePrice": 123.45,
"bunkerPrice": 987.65,
"benchmarkFreightRate": 123.45,
"benchmarkMtm": 987.65,
"routeMtm": 123.45,
"benchmarkRateDiff": 987.65,
"routeDiff": 123.45,
"bafAdjustmentFreightRate": 987.65,
"tcSource": "abc123",
"bunkerSource": "abc123",
"vCSource": "abc123",
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123",
"entryDateGmt": "2007-12-03",
"worksheetID": 987,
"vesselCode": "abc123",
"basisDate": "2007-12-03",
"forwardPeriod": "xyz789",
"tceMarket": 987.65,
"freightRate": 123.45,
"hireExpenses": 987.65,
"bunkerExpenses": 987.65,
"cO2Quantity": 987.65,
"voyageDays": 987.65,
"cO2Cost": 987.65,
"worksheet": Worksheet,
"voyageEstimateCOACVCAnalysisResultBunkers": [
VoyageEstimateCOACVCAnalysisResultBunker
],
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
VoyageEstimateCOACVCAnalysisResultBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
estimateID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
varsSeq - Int
|
|
seq - Int
|
|
fuelType - String
|
|
symbol - String
|
|
source - String
|
|
price - Float
|
|
voyageEstimateCOACVCAnalysisResult - VoyageEstimateCOACVCAnalysisResult
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"estimateID": "xyz789",
"customFieldByID": Any,
"customField": Any,
"varsSeq": 123,
"seq": 987,
"fuelType": "xyz789",
"symbol": "xyz789",
"source": "abc123",
"price": 123.45,
"voyageEstimateCOACVCAnalysisResult": VoyageEstimateCOACVCAnalysisResult,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageEstimateCOACVCAnalysisResultBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageEstimateCOACVCAnalysisResultBunkerFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageEstimateCOACVCAnalysisResultBunkerFormQueryWhere
}
VoyageEstimateCOACVCAnalysisResultBunkerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyageEstimateCOACVCAnalysisResultBunkerFormQueryWhere!]
|
|
or - [VoyageEstimateCOACVCAnalysisResultBunkerFormQueryWhere!]
|
|
rawExpression - String
|
|
estimateID - StringWhereValueExpression
|
|
varsSeq - NumberWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
symbol - StringWhereValueExpression
|
|
source - StringWhereValueExpression
|
|
price - NumberWhereValueExpression
|
|
voyageEstimateCOACVCAnalysisResult - VoyageEstimateCOACVCAnalysisResultFormQueryWhere
|
Example
{
"and": [
VoyageEstimateCOACVCAnalysisResultBunkerFormQueryWhere
],
"or": [
VoyageEstimateCOACVCAnalysisResultBunkerFormQueryWhere
],
"rawExpression": "xyz789",
"estimateID": StringWhereValueExpression,
"varsSeq": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"symbol": StringWhereValueExpression,
"source": StringWhereValueExpression,
"price": NumberWhereValueExpression,
"voyageEstimateCOACVCAnalysisResult": VoyageEstimateCOACVCAnalysisResultFormQueryWhere
}
VoyageEstimateCOACVCAnalysisResultBunkerRelationships
Fields
| Field Name | Description |
|---|---|
voyageEstimateCOACVCAnalysisResult - RelationshipDefinition
|
Example
{
"voyageEstimateCOACVCAnalysisResult": RelationshipDefinition
}
VoyageEstimateCOACVCAnalysisResultFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageEstimateCOACVCAnalysisResultFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageEstimateCOACVCAnalysisResultFormQueryWhere
}
VoyageEstimateCOACVCAnalysisResultFormQueryWhere
Fields
Example
{
"and": [
VoyageEstimateCOACVCAnalysisResultFormQueryWhere
],
"or": [
VoyageEstimateCOACVCAnalysisResultFormQueryWhere
],
"rawExpression": "abc123",
"estimateID": StringWhereValueExpression,
"varsSeq": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"date": DateWhereValueExpression,
"tcRoutePrice": NumberWhereValueExpression,
"vCRoutePrice": NumberWhereValueExpression,
"bunkerPrice": NumberWhereValueExpression,
"benchmarkFreightRate": NumberWhereValueExpression,
"benchmarkMtm": NumberWhereValueExpression,
"routeMtm": NumberWhereValueExpression,
"benchmarkRateDiff": NumberWhereValueExpression,
"routeDiff": NumberWhereValueExpression,
"bafAdjustmentFreightRate": NumberWhereValueExpression,
"tcSource": StringWhereValueExpression,
"bunkerSource": StringWhereValueExpression,
"vCSource": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"worksheetID": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"basisDate": DateWhereValueExpression,
"forwardPeriod": StringWhereValueExpression,
"tceMarket": NumberWhereValueExpression,
"freightRate": NumberWhereValueExpression,
"hireExpenses": NumberWhereValueExpression,
"bunkerExpenses": NumberWhereValueExpression,
"cO2Quantity": NumberWhereValueExpression,
"voyageDays": NumberWhereValueExpression,
"cO2Cost": NumberWhereValueExpression,
"worksheet": WorksheetFormQueryWhere
}
VoyageEstimateCOACVCAnalysisResultRelationships
Fields
| Field Name | Description |
|---|---|
worksheet - RelationshipDefinition
|
|
voyageEstimateCOACVCAnalysisResultBunkers - RelationshipDefinition
|
Example
{
"worksheet": RelationshipDefinition,
"voyageEstimateCOACVCAnalysisResultBunkers": RelationshipDefinition
}
VoyageEstimateChangesSinceLast
Fields
| Field Name | Description |
|---|---|
copyEstimate - MessageUpdateResponse
|
|
updateEstimate - MessageUpdateResponse
|
Example
{
"copyEstimate": MessageUpdateResponse,
"updateEstimate": MessageUpdateResponse
}
VoyageEstimateDefaultPortFuelConsumptionModeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Automatic"
VoyageEstimateDefaultPortFuelConsumptionModeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageEstimateDefaultPortFuelConsumptionModeEnum
|
|
isNot - VoyageEstimateDefaultPortFuelConsumptionModeEnum
|
|
isIn - [VoyageEstimateDefaultPortFuelConsumptionModeEnum]
|
Example
{"is": "Automatic", "isNot": "Automatic", "isIn": ["Automatic"]}
VoyageEstimateDefaultSeaFuelConsumptionModeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Automatic"
VoyageEstimateDefaultSeaFuelConsumptionModeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageEstimateDefaultSeaFuelConsumptionModeEnum
|
|
isNot - VoyageEstimateDefaultSeaFuelConsumptionModeEnum
|
|
isIn - [VoyageEstimateDefaultSeaFuelConsumptionModeEnum]
|
Example
{"is": "Automatic", "isNot": "Automatic", "isIn": ["Automatic"]}
VoyageEstimateFixedEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Open"
VoyageEstimateFixedEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageEstimateFixedEnum
|
|
isNot - VoyageEstimateFixedEnum
|
|
isIn - [VoyageEstimateFixedEnum]
|
Example
{"is": "Open", "isNot": "Open", "isIn": ["Open"]}
VoyageEstimateFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageEstimateFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageEstimateFormQueryWhere
}
VoyageEstimateFormQueryWhere
Fields
Example
{
"and": [VoyageEstimateFormQueryWhere],
"or": [VoyageEstimateFormQueryWhere],
"rawExpression": "abc123",
"lastUserInitials": StringWhereValueExpression,
"estimateID": StringWhereValueExpression,
"chartererShortName": StringWhereValueExpression,
"cargo": StringWhereValueExpression,
"firstLoadPortName": StringWhereValueExpression,
"lastDischPortName": StringWhereValueExpression,
"ballastBonus": NumberWhereValueExpression,
"addressCommission": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"dailyCost": NumberWhereValueExpression,
"speedLaden": NumberWhereValueExpression,
"speedBallast": NumberWhereValueExpression,
"ballastPort": StringWhereValueExpression,
"voyageCommenceDateLocal": DateWhereValueExpression,
"freightType": StringWhereValueExpression,
"terminatingPort": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"fixed": VoyageEstimateFixedEnumValueExpression,
"lastUser": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"weatherFactorPercentage": NumberWhereValueExpression,
"contractType": StringWhereValueExpression,
"useCOAFreight": BoolWhereValueExpression,
"lockTCE": BoolWhereValueExpression,
"autoCalcByLiftQty": BoolWhereValueExpression,
"useVschedItin": BoolWhereValueExpression,
"tcoEstimate": BoolWhereValueExpression,
"lowSulfurOnly": BoolWhereValueExpression,
"capNoRebills": BoolWhereValueExpression,
"consecutive": BoolWhereValueExpression,
"bunkerOwner": BoolWhereValueExpression,
"manualDailyCost": BoolWhereValueExpression,
"manualAddCommRate": BoolWhereValueExpression,
"fifoBunkers": BoolWhereValueExpression,
"benchmark": BoolWhereValueExpression,
"fixBunkers": BoolWhereValueExpression,
"cancelled": BoolWhereValueExpression,
"transshipment": BoolWhereValueExpression,
"vettingFail": BoolWhereValueExpression,
"addCommInclOPA": BoolWhereValueExpression,
"forwardCurve": BoolWhereValueExpression,
"thirdParty": BoolWhereValueExpression,
"onSubs": BoolWhereValueExpression,
"tcoExchRateManual": BoolWhereValueExpression,
"lockProfit": BoolWhereValueExpression,
"devTceCalc": BoolWhereValueExpression,
"inProgressEst": BoolWhereValueExpression,
"piracyDisabled": BoolWhereValueExpression,
"piracyEnabled": BoolWhereValueExpression,
"estTemplate": BoolWhereValueExpression,
"estDeviation": BoolWhereValueExpression,
"tcoEstTripTc": BoolWhereValueExpression,
"lastTciVoyage": BoolWhereValueExpression,
"isDeviationBaseline": BoolWhereValueExpression,
"voyageDays": NumberWhereValueExpression,
"voyageCompleteDateLocal": DateWhereValueExpression,
"tcE": NumberWhereValueExpression,
"profit": NumberWhereValueExpression,
"tradeAreaNo": NumberWhereValueExpression,
"matrix": StringWhereValueExpression,
"program": StringWhereValueExpression,
"companyCode": StringWhereValueExpression,
"lobCode": StringWhereValueExpression,
"tcCode": StringWhereValueExpression,
"charteringCoordinator": StringWhereValueExpression,
"vesselLaycanFrom": DateWhereValueExpression,
"vesselLaycanTo": DateWhereValueExpression,
"createdByUser": StringWhereValueExpression,
"baseCurrency": StringWhereValueExpression,
"ice": BoolWhereValueExpression,
"pool": BoolWhereValueExpression,
"clean": BoolWhereValueExpression,
"coated": BoolWhereValueExpression,
"highRisk": BoolWhereValueExpression,
"categoryID": NumberWhereValueExpression,
"poolFee": NumberWhereValueExpression,
"freightCurrency": StringWhereValueExpression,
"worldscaleRate": NumberWhereValueExpression,
"worldscalePercent": NumberWhereValueExpression,
"cargoUnit": StringWhereValueExpression,
"freightRate": NumberWhereValueExpression,
"lumpsum": NumberWhereValueExpression,
"totalLoadQuantity": NumberWhereValueExpression,
"deviationVesselCode": StringWhereValueExpression,
"deviationVoyageNumber": NumberWhereValueExpression,
"accountingSegmentCode": StringWhereValueExpression,
"prevVoyageNo": NumberWhereValueExpression,
"prevEstimateID": StringWhereValueExpression,
"prevTcCode": StringWhereValueExpression,
"deviationEstimateBaselineId": StringWhereValueExpression,
"deviationSnapshotTimeGmt": DateWhereValueExpression,
"enableFNCoaComponentCalc": BoolWhereValueExpression,
"tceFromTarget": BoolWhereValueExpression,
"openEstimate": BoolWhereValueExpression,
"disableBackupFuelTypes": BoolWhereValueExpression,
"waitForLaycan": BoolWhereValueExpression,
"useScrubbers": BoolWhereValueExpression,
"hasManualTciCommRate": BoolWhereValueExpression,
"hasManuallyOverriddenMarketTcRate": BoolWhereValueExpression,
"tcoBenchmark": BoolWhereValueExpression,
"isLocked": BoolWhereValueExpression,
"includeCarbonInPnL": BoolWhereValueExpression,
"manualEtsExchangeRate": BoolWhereValueExpression,
"manualOverrideAgreedEtsEmission": BoolWhereValueExpression,
"manualOverrideAgreedEtsCost": BoolWhereValueExpression,
"manualOverrideEtsPrice": BoolWhereValueExpression,
"manualOverrideFuelEuExchangeRate": BoolWhereValueExpression,
"manualOverrideFuelEuAgreedPenaltyEur": BoolWhereValueExpression,
"manualOverrideFuelEuAgreedPenaltyBase": BoolWhereValueExpression,
"includeFuelPenaltyInPnL": BoolWhereValueExpression,
"manualOverrideFuelEuAgreedCompBalance": BoolWhereValueExpression,
"manualLNGPricing": BoolWhereValueExpression,
"useFuelEuBreakevenPrice": BoolWhereValueExpression,
"prevPositionID": StringWhereValueExpression,
"fuelZoneSetID": NumberWhereValueExpression,
"naturalBoilOffBallastSpeed": NumberWhereValueExpression,
"naturalBoilOffLadenSpeed": NumberWhereValueExpression,
"scrubberType": VoyageEstimateScrubberTypeEnumValueExpression,
"tciBrokerCommissionRate": NumberWhereValueExpression,
"tradeRoute": StringWhereValueExpression,
"basisDate": DateWhereValueExpression,
"cO2Price": NumberWhereValueExpression,
"cO2PriceCurrency": StringWhereValueExpression,
"cO2PriceExchangeRate": NumberWhereValueExpression,
"cO2Quantity": NumberWhereValueExpression,
"etsCO2Quantity": NumberWhereValueExpression,
"etsCO2Cost": NumberWhereValueExpression,
"defaultSeaFuelConsumptionMode": VoyageEstimateDefaultSeaFuelConsumptionModeEnumValueExpression,
"defaultPortFuelConsumptionMode": VoyageEstimateDefaultPortFuelConsumptionModeEnumValueExpression,
"voyageAer": NumberWhereValueExpression,
"voyageCiiRating": StringWhereValueExpression,
"transportWork": NumberWhereValueExpression,
"eEOI": NumberWhereValueExpression,
"previousDistance": NumberWhereValueExpression,
"previousEmission": NumberWhereValueExpression,
"previousAer": NumberWhereValueExpression,
"previousCiiRating": StringWhereValueExpression,
"cO2Symbol": StringWhereValueExpression,
"cO2PriceBasisDate": DateWhereValueExpression,
"agreedEtsEmission": NumberWhereValueExpression,
"agreedEtsCost": NumberWhereValueExpression,
"etsPreVoyagePortNo": NumberWhereValueExpression,
"etsPostVoyagePortNo": NumberWhereValueExpression,
"fuelEUComplianceBalance": NumberWhereValueExpression,
"fuelEUPenalty": NumberWhereValueExpression,
"fuelEUTotalEnergy": NumberWhereValueExpression,
"fuelEUExchangeRate": NumberWhereValueExpression,
"fuelEUAgreedPenaltyEUR": NumberWhereValueExpression,
"fuelEUAgreedPenaltyBase": NumberWhereValueExpression,
"fuelEUAgreedComplianceBalance": NumberWhereValueExpression,
"initialLNGPrice": NumberWhereValueExpression,
"dischargeLNGPrice": NumberWhereValueExpression,
"initialLNGCalorificValue": NumberWhereValueExpression,
"dischargeLNGCalorificValue": NumberWhereValueExpression,
"fuelEUBreakevenReplacementFuel": StringWhereValueExpression,
"fuelEUBreakevenReplacementFuelPrice": NumberWhereValueExpression,
"fuelZoneSet": FuelZoneSetFormQueryWhere,
"vessel": VesselFormQueryWhere,
"cargoName": CargoNameFormQueryWhere,
"fixture": FixtureFormQueryWhere,
"tradeArea": TradeAreaFormQueryWhere,
"timeCharterOutDetails": TimeCharterOutDetailsFormQueryWhere,
"commenceItinerary": EstimateItineraryFormQueryWhere,
"commencePort": PortFormQueryWhere,
"firstItinerary": EstimateItineraryFormQueryWhere,
"lastItinerary": EstimateItineraryFormQueryWhere,
"firstLoadItinerary": EstimateItineraryFormQueryWhere,
"lastDiscItinerary": EstimateItineraryFormQueryWhere,
"tciContract": TimeCharterContractFormQueryWhere
}
VoyageEstimateMiscExpense
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
exchangeRate - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
rateType - String
|
|
amountCurr - Float
|
|
estimateID - String
|
|
type - String
|
|
seqNo - Int
|
|
description - String
|
|
amountCurrInternal - Float
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
curr - String
|
|
amountBase - Float
|
|
rateCurrInternal - Float
|
|
rateUnitInternal - String
|
|
billCode - String
|
|
provisional - Boolean
|
|
nonAccrual - Boolean
|
|
manualExchRate - Boolean
|
|
standardExp - Boolean
|
|
isRebillable - Boolean
|
|
isAdvanceRebillable - Boolean
|
|
isManualRebillableType - Boolean
|
|
isManualAmount - Boolean
|
|
isInProgressVoyageImport - Boolean
|
|
cargoSeqNo - Int
|
|
billSubcode - String
|
|
portSeqNo - Int
|
|
cargoShortName - String
|
|
gradeSeqNo - Int
|
|
operationsLedger - OperationsLedger
|
|
voyageEstimate - VoyageEstimate
|
|
voyageEstimateItinerary - EstimateItinerary
|
|
voyageEstimateCargos - [EstimateCargoes]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"exchangeRate": 987.65,
"customFieldByID": Any,
"customField": Any,
"rateType": "xyz789",
"amountCurr": 987.65,
"estimateID": "xyz789",
"type": "abc123",
"seqNo": 123,
"description": "xyz789",
"amountCurrInternal": 987.65,
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUser": "xyz789",
"curr": "abc123",
"amountBase": 987.65,
"rateCurrInternal": 123.45,
"rateUnitInternal": "abc123",
"billCode": "xyz789",
"provisional": true,
"nonAccrual": true,
"manualExchRate": false,
"standardExp": false,
"isRebillable": false,
"isAdvanceRebillable": true,
"isManualRebillableType": false,
"isManualAmount": true,
"isInProgressVoyageImport": true,
"cargoSeqNo": 987,
"billSubcode": "abc123",
"portSeqNo": 987,
"cargoShortName": "xyz789",
"gradeSeqNo": 987,
"operationsLedger": OperationsLedger,
"voyageEstimate": VoyageEstimate,
"voyageEstimateItinerary": EstimateItinerary,
"voyageEstimateCargos": [EstimateCargoes],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageEstimateMiscExpenseFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageEstimateMiscExpenseFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageEstimateMiscExpenseFormQueryWhere
}
VoyageEstimateMiscExpenseFormQueryWhere
Fields
Example
{
"and": [VoyageEstimateMiscExpenseFormQueryWhere],
"or": [VoyageEstimateMiscExpenseFormQueryWhere],
"rawExpression": "xyz789",
"estimateID": StringWhereValueExpression,
"type": VoyageEstimateMiscExpenseTypeEnumValueExpression,
"seqNo": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"amountCurrInternal": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"curr": StringWhereValueExpression,
"amountBase": NumberWhereValueExpression,
"rateCurrInternal": NumberWhereValueExpression,
"rateUnitInternal": StringWhereValueExpression,
"billCode": StringWhereValueExpression,
"provisional": BoolWhereValueExpression,
"nonAccrual": BoolWhereValueExpression,
"manualExchRate": BoolWhereValueExpression,
"standardExp": BoolWhereValueExpression,
"isRebillable": BoolWhereValueExpression,
"isAdvanceRebillable": BoolWhereValueExpression,
"isManualRebillableType": BoolWhereValueExpression,
"isManualAmount": BoolWhereValueExpression,
"isInProgressVoyageImport": BoolWhereValueExpression,
"cargoSeqNo": NumberWhereValueExpression,
"billSubcode": StringWhereValueExpression,
"portSeqNo": NumberWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"gradeSeqNo": NumberWhereValueExpression,
"operationsLedger": OperationsLedgerFormQueryWhere,
"voyageEstimate": VoyageEstimateFormQueryWhere,
"voyageEstimateItinerary": EstimateItineraryFormQueryWhere
}
VoyageEstimateMiscExpenseRelationships
Fields
| Field Name | Description |
|---|---|
operationsLedger - RelationshipDefinition
|
|
voyageEstimate - RelationshipDefinition
|
|
voyageEstimateItinerary - RelationshipDefinition
|
|
voyageEstimateCargos - RelationshipDefinition
|
Example
{
"operationsLedger": RelationshipDefinition,
"voyageEstimate": RelationshipDefinition,
"voyageEstimateItinerary": RelationshipDefinition,
"voyageEstimateCargos": RelationshipDefinition
}
VoyageEstimateMiscExpenseTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
VoyageEstimateMiscExpenseTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageEstimateMiscExpenseTypeEnum
|
|
isNot - VoyageEstimateMiscExpenseTypeEnum
|
|
isIn - [VoyageEstimateMiscExpenseTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
VoyageEstimatePortExpense
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
estimateID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
portSeqNo - Int
|
|
seqNo - Int
|
|
amountCurr - Float
|
|
curr - String
|
|
exchangeRate - Float
|
|
ledgerCode - String
|
|
expenseCode - Int
|
|
manualExchRate - Boolean
|
|
automaticExpense - Boolean
|
|
isRebillable - Boolean
|
|
isAdvanceRebillable - Boolean
|
|
isManualRebillableType - Boolean
|
|
isManualAmount - Boolean
|
|
isHiddenViaExpense - Boolean
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
description - String
|
|
cargoShortName - String
|
|
gradeSeqNo - Int
|
|
portNo - Int
|
|
port - Port
|
|
currency - Currency
|
|
expense - Expense
|
|
voyageEstimate - VoyageEstimate
|
|
voyageEstimateItinerary - EstimateItinerary
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"estimateID": "xyz789",
"customFieldByID": Any,
"customField": Any,
"portSeqNo": 123,
"seqNo": 123,
"amountCurr": 123.45,
"curr": "abc123",
"exchangeRate": 123.45,
"ledgerCode": "xyz789",
"expenseCode": 123,
"manualExchRate": false,
"automaticExpense": true,
"isRebillable": false,
"isAdvanceRebillable": false,
"isManualRebillableType": true,
"isManualAmount": true,
"isHiddenViaExpense": true,
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123",
"description": "xyz789",
"cargoShortName": "xyz789",
"gradeSeqNo": 123,
"portNo": 123,
"port": Port,
"currency": Currency,
"expense": Expense,
"voyageEstimate": VoyageEstimate,
"voyageEstimateItinerary": EstimateItinerary,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageEstimatePortExpenseFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageEstimatePortExpenseFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageEstimatePortExpenseFormQueryWhere
}
VoyageEstimatePortExpenseFormQueryWhere
Fields
Example
{
"and": [VoyageEstimatePortExpenseFormQueryWhere],
"or": [VoyageEstimatePortExpenseFormQueryWhere],
"rawExpression": "xyz789",
"estimateID": StringWhereValueExpression,
"portSeqNo": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"amountCurr": NumberWhereValueExpression,
"curr": StringWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"ledgerCode": StringWhereValueExpression,
"expenseCode": NumberWhereValueExpression,
"manualExchRate": BoolWhereValueExpression,
"automaticExpense": BoolWhereValueExpression,
"isRebillable": BoolWhereValueExpression,
"isAdvanceRebillable": BoolWhereValueExpression,
"isManualRebillableType": BoolWhereValueExpression,
"isManualAmount": BoolWhereValueExpression,
"isHiddenViaExpense": BoolWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"description": StringWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"gradeSeqNo": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"port": PortFormQueryWhere,
"currency": CurrencyFormQueryWhere,
"expense": ExpenseFormQueryWhere,
"voyageEstimate": VoyageEstimateFormQueryWhere,
"voyageEstimateItinerary": EstimateItineraryFormQueryWhere
}
VoyageEstimatePortExpenseRelationships
Fields
| Field Name | Description |
|---|---|
port - RelationshipDefinition
|
|
currency - RelationshipDefinition
|
|
expense - RelationshipDefinition
|
|
voyageEstimate - RelationshipDefinition
|
|
voyageEstimateItinerary - RelationshipDefinition
|
Example
{
"port": RelationshipDefinition,
"currency": RelationshipDefinition,
"expense": RelationshipDefinition,
"voyageEstimate": RelationshipDefinition,
"voyageEstimateItinerary": RelationshipDefinition
}
VoyageEstimateRelationships
Fields
Example
{
"fuelZoneSet": RelationshipDefinition,
"vessel": RelationshipDefinition,
"cargoName": RelationshipDefinition,
"fixture": RelationshipDefinition,
"tradeArea": RelationshipDefinition,
"timeCharterOutDetails": RelationshipDefinition,
"commenceItinerary": RelationshipDefinition,
"commencePort": RelationshipDefinition,
"firstItinerary": RelationshipDefinition,
"lastItinerary": RelationshipDefinition,
"firstLoadItinerary": RelationshipDefinition,
"lastDiscItinerary": RelationshipDefinition,
"firstEstimateCargoInternal": RelationshipDefinition,
"firstChartererTco": RelationshipDefinition,
"firstChartererNonTco": RelationshipDefinition,
"tCIContract": RelationshipDefinition,
"estimateFuelEuReplacementBunkers": RelationshipDefinition,
"voyageEstimatePortExpenses": RelationshipDefinition,
"estimateDelays": RelationshipDefinition,
"voyageEstimateTimeCharterExpenses": RelationshipDefinition,
"voyageEstimateCOACVCAnalysis": RelationshipDefinition,
"voyageEstimateBunkers": RelationshipDefinition,
"estimateCargoExtraFreightTerms": RelationshipDefinition,
"benchmarkEstimates": RelationshipDefinition,
"voyageEstimateMiscExpenses": RelationshipDefinition,
"cargos": RelationshipDefinition,
"estimateCargoes": RelationshipDefinition,
"worksheetEstimates": RelationshipDefinition,
"charterer": RelationshipDefinition,
"loadItineraries": RelationshipDefinition,
"discItineraries": RelationshipDefinition,
"lSItineraries": RelationshipDefinition,
"firstEstimateCargo": RelationshipDefinition,
"category": RelationshipDefinition,
"alerts": RelationshipDefinition,
"estimateItineraries": RelationshipDefinition,
"auditActions": RelationshipDefinition
}
VoyageEstimateScrubberTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
VoyageEstimateScrubberTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageEstimateScrubberTypeEnum
|
|
isNot - VoyageEstimateScrubberTypeEnum
|
|
isIn - [VoyageEstimateScrubberTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VoyageEstimateTimeCharterExpense
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
estimateID - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
tcType - String
|
|
seqNo - Int
|
|
billCode - String
|
|
description - String
|
|
rateCurr - Float
|
|
rateType - String
|
|
periodFromGmt - Date
|
|
periodToGmt - Date
|
|
remarks - String
|
|
ignoreOffHire - Boolean
|
|
manuallyEdited - Boolean
|
|
flags - Int
|
|
entryDateGmt - Date
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
voyageEstimate - VoyageEstimate
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"estimateID": "abc123",
"customFieldByID": Any,
"customField": Any,
"tcType": "xyz789",
"seqNo": 987,
"billCode": "abc123",
"description": "abc123",
"rateCurr": 987.65,
"rateType": "xyz789",
"periodFromGmt": "2007-12-03",
"periodToGmt": "2007-12-03",
"remarks": "xyz789",
"ignoreOffHire": true,
"manuallyEdited": true,
"flags": 987,
"entryDateGmt": "2007-12-03",
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"voyageEstimate": VoyageEstimate,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageEstimateTimeCharterExpenseBillCodeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BallastBonus"
VoyageEstimateTimeCharterExpenseBillCodeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageEstimateTimeCharterExpenseBillCodeEnum
|
|
isNot - VoyageEstimateTimeCharterExpenseBillCodeEnum
|
|
isIn - [VoyageEstimateTimeCharterExpenseBillCodeEnum]
|
Example
{"is": "BallastBonus", "isNot": "BallastBonus", "isIn": ["BallastBonus"]}
VoyageEstimateTimeCharterExpenseFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageEstimateTimeCharterExpenseFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageEstimateTimeCharterExpenseFormQueryWhere
}
VoyageEstimateTimeCharterExpenseFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyageEstimateTimeCharterExpenseFormQueryWhere!]
|
|
or - [VoyageEstimateTimeCharterExpenseFormQueryWhere!]
|
|
rawExpression - String
|
|
estimateID - StringWhereValueExpression
|
|
tcType - VoyageEstimateTimeCharterExpenseTcTypeEnumValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
billCode - VoyageEstimateTimeCharterExpenseBillCodeEnumValueExpression
|
|
description - StringWhereValueExpression
|
|
rateCurr - NumberWhereValueExpression
|
|
rateType - VoyageEstimateTimeCharterExpenseRateTypeEnumValueExpression
|
|
periodFromGmt - DateWhereValueExpression
|
|
periodToGmt - DateWhereValueExpression
|
|
remarks - StringWhereValueExpression
|
|
ignoreOffHire - BoolWhereValueExpression
|
|
manuallyEdited - BoolWhereValueExpression
|
|
flags - NumberWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
voyageEstimate - VoyageEstimateFormQueryWhere
|
Example
{
"and": [VoyageEstimateTimeCharterExpenseFormQueryWhere],
"or": [VoyageEstimateTimeCharterExpenseFormQueryWhere],
"rawExpression": "xyz789",
"estimateID": StringWhereValueExpression,
"tcType": VoyageEstimateTimeCharterExpenseTcTypeEnumValueExpression,
"seqNo": NumberWhereValueExpression,
"billCode": VoyageEstimateTimeCharterExpenseBillCodeEnumValueExpression,
"description": StringWhereValueExpression,
"rateCurr": NumberWhereValueExpression,
"rateType": VoyageEstimateTimeCharterExpenseRateTypeEnumValueExpression,
"periodFromGmt": DateWhereValueExpression,
"periodToGmt": DateWhereValueExpression,
"remarks": StringWhereValueExpression,
"ignoreOffHire": BoolWhereValueExpression,
"manuallyEdited": BoolWhereValueExpression,
"flags": NumberWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"voyageEstimate": VoyageEstimateFormQueryWhere
}
VoyageEstimateTimeCharterExpenseRateTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Lumpsum"
VoyageEstimateTimeCharterExpenseRateTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageEstimateTimeCharterExpenseRateTypeEnum
|
|
isNot - VoyageEstimateTimeCharterExpenseRateTypeEnum
|
|
isIn - [VoyageEstimateTimeCharterExpenseRateTypeEnum]
|
Example
{"is": "Lumpsum", "isNot": "Lumpsum", "isIn": ["Lumpsum"]}
VoyageEstimateTimeCharterExpenseRelationships
Fields
| Field Name | Description |
|---|---|
voyageEstimate - RelationshipDefinition
|
Example
{"voyageEstimate": RelationshipDefinition}
VoyageEstimateTimeCharterExpenseTcTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
VoyageEstimateTimeCharterExpenseTcTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageEstimateTimeCharterExpenseTcTypeEnum
|
|
isNot - VoyageEstimateTimeCharterExpenseTcTypeEnum
|
|
isIn - [VoyageEstimateTimeCharterExpenseTcTypeEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
VoyageFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageFormQueryWhere
}
VoyageFormQueryWhere
Fields
Example
{
"and": [VoyageFormQueryWhere],
"or": [VoyageFormQueryWhere],
"rawExpression": "xyz789",
"oprType": StringWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"tcCode": StringWhereValueExpression,
"vesselName": StringWhereValueExpression,
"deliveryPortNo": NumberWhereValueExpression,
"voyageStatusCode": VoyageVoyageStatusCodeEnumValueExpression,
"departmentNo": NumberWhereValueExpression,
"teamNo": NumberWhereValueExpression,
"tcoCode": StringWhereValueExpression,
"fixtureNo": StringWhereValueExpression,
"commenceDateLocal": DateWhereValueExpression,
"completeDateLocal": DateWhereValueExpression,
"dailyCost": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"bunkerCalcMethod": NumberWhereValueExpression,
"consecutiveYN": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"externalRef": StringWhereValueExpression,
"opsCoordinator": StringWhereValueExpression,
"heating": BoolWhereValueExpression,
"tRBunker": BoolWhereValueExpression,
"tciBnkAdj": BoolWhereValueExpression,
"lastTci": BoolWhereValueExpression,
"forecast": BoolWhereValueExpression,
"daDesk": BoolWhereValueExpression,
"claimPending": BoolWhereValueExpression,
"legalHold": BoolWhereValueExpression,
"ice": BoolWhereValueExpression,
"pool": BoolWhereValueExpression,
"clean": BoolWhereValueExpression,
"coated": BoolWhereValueExpression,
"highRisk": BoolWhereValueExpression,
"cancel": BoolWhereValueExpression,
"supportJob": BoolWhereValueExpression,
"drydock": BoolWhereValueExpression,
"nonPool": BoolWhereValueExpression,
"lastTco": BoolWhereValueExpression,
"offhireVoyage": BoolWhereValueExpression,
"firstTci": BoolWhereValueExpression,
"firstTco": BoolWhereValueExpression,
"tveValid": BoolWhereValueExpression,
"blComplete": BoolWhereValueExpression,
"piracyEnabled": BoolWhereValueExpression,
"piracyDisabled": BoolWhereValueExpression,
"dischApproved": BoolWhereValueExpression,
"includeInCover": BoolWhereValueExpression,
"market": BoolWhereValueExpression,
"trackBargeRobs": BoolWhereValueExpression,
"legacyTowVoyage": BoolWhereValueExpression,
"lowSulfurOnly": BoolWhereValueExpression,
"disableBnkrWarnings": BoolWhereValueExpression,
"companyCode": StringWhereValueExpression,
"lobCode": StringWhereValueExpression,
"voyageReference": StringWhereValueExpression,
"commenceDateGmt": DateWhereValueExpression,
"completeDateGmt": DateWhereValueExpression,
"mVERate": NumberWhereValueExpression,
"maxDailyBoilOffBallast": NumberWhereValueExpression,
"maxDailyBoilOffLaden": NumberWhereValueExpression,
"vesselLaycanFrom": DateWhereValueExpression,
"vesselLaycanTo": DateWhereValueExpression,
"voyageTemplateID": NumberWhereValueExpression,
"currBase": StringWhereValueExpression,
"poolFee": NumberWhereValueExpression,
"segment": StringWhereValueExpression,
"opsCoordinator2": StringWhereValueExpression,
"voyageController": StringWhereValueExpression,
"fDManager": StringWhereValueExpression,
"lossControlStatus": StringWhereValueExpression,
"lossControlNotes": StringWhereValueExpression,
"parentVesselCode": StringWhereValueExpression,
"parentVoyageNo": NumberWhereValueExpression,
"financeCoordinator": StringWhereValueExpression,
"fuelZoneSetID": NumberWhereValueExpression,
"marketDailyHireRate": NumberWhereValueExpression,
"disableBackupFuelTypes": BoolWhereValueExpression,
"restrictEdits": BoolWhereValueExpression,
"noPoolDays": BoolWhereValueExpression,
"enableBunkerRequirementDrivenWorkflow": BoolWhereValueExpression,
"useScrubbers": BoolWhereValueExpression,
"voyageBooking": BoolWhereValueExpression,
"destMirrorVoyage": BoolWhereValueExpression,
"syncEmissionsData": BoolWhereValueExpression,
"includeCarbonExpenseInPnl": BoolWhereValueExpression,
"useImprovedAttachmentKey": BoolWhereValueExpression,
"manualOverrideAgreedEtsEmission": BoolWhereValueExpression,
"manualOverrideAgreedEtsCost": BoolWhereValueExpression,
"manualEtsExchangeRate": BoolWhereValueExpression,
"manualOverrideFuelEuExchangeRate": BoolWhereValueExpression,
"manualOverrideFuelEuAgreedPenaltyEur": BoolWhereValueExpression,
"manualOverrideFuelEuAgreedPenaltyBase": BoolWhereValueExpression,
"includeFuelEuExpenseInPnl": BoolWhereValueExpression,
"manualOverrideFuelEuAgreedCompBalance": BoolWhereValueExpression,
"manualLNGPricing": BoolWhereValueExpression,
"naturalBoilOffBallastSpeed": NumberWhereValueExpression,
"naturalBoilOffLadenSpeed": NumberWhereValueExpression,
"scrubberType": VoyageScrubberTypeEnumValueExpression,
"closedBy": StringWhereValueExpression,
"closedOnGmt": DateWhereValueExpression,
"marketValuationRateBase": NumberWhereValueExpression,
"marketValuationRateUnit": StringWhereValueExpression,
"marketValuationSymbol": StringWhereValueExpression,
"marketValuationCorrelation": NumberWhereValueExpression,
"marketValuationAdjustment": NumberWhereValueExpression,
"marketValuationLumpsumAmountBase": NumberWhereValueExpression,
"voyageAer": NumberWhereValueExpression,
"voyageCiiRating": StringWhereValueExpression,
"etsCO2Price": NumberWhereValueExpression,
"etsCO2PriceCurrency": StringWhereValueExpression,
"etsCO2PriceExchangeRate": NumberWhereValueExpression,
"cO2Quantity": NumberWhereValueExpression,
"etsCO2Quantity": NumberWhereValueExpression,
"etsCO2Cost": NumberWhereValueExpression,
"transportWork": NumberWhereValueExpression,
"eEOI": NumberWhereValueExpression,
"agreedEtsEmission": NumberWhereValueExpression,
"agreedEtsCost": NumberWhereValueExpression,
"previousDistance": NumberWhereValueExpression,
"previousEmission": NumberWhereValueExpression,
"previousAer": NumberWhereValueExpression,
"previousCiiGrade": StringWhereValueExpression,
"endOfVoyageDistance": NumberWhereValueExpression,
"endOfVoyageEmission": NumberWhereValueExpression,
"endOfVoyageAer": NumberWhereValueExpression,
"endOfVoyageCiiGrade": StringWhereValueExpression,
"etsPreVoyagePortNo": NumberWhereValueExpression,
"etsPostVoyagePortNo": NumberWhereValueExpression,
"fuelEUComplianceBalance": NumberWhereValueExpression,
"fuelEUPenalty": NumberWhereValueExpression,
"fuelEUTotalEnergy": NumberWhereValueExpression,
"fuelEUExchangeRate": NumberWhereValueExpression,
"fuelEUAgreedPenaltyEUR": NumberWhereValueExpression,
"fuelEUAgreedPenaltyBase": NumberWhereValueExpression,
"fuelEUAgreedComplianceBalance": NumberWhereValueExpression,
"initialLNGPrice": NumberWhereValueExpression,
"dischargeLNGPrice": NumberWhereValueExpression,
"initialLNGCalorificValue": NumberWhereValueExpression,
"dischargeLNGCalorificValue": NumberWhereValueExpression,
"tradeType": TradeTypeFormQueryWhere,
"voyageTemplate": VoyageTemplateFormQueryWhere,
"fuelZoneSet": FuelZoneSetFormQueryWhere,
"lob": LobFormQueryWhere,
"user": UserFormQueryWhere,
"fixture": FixtureFormQueryWhere,
"team": TeamFormQueryWhere,
"tradeArea": TradeAreaFormQueryWhere,
"vessel": VesselFormQueryWhere,
"voyageActPnl": VoyagePnlFormQueryWhere,
"voyageEstPnl": VoyagePnlFormQueryWhere,
"voyagePstPnl": VoyagePnlFormQueryWhere,
"voyageActPnlBasis": VoyagePnlFormQueryWhere,
"voyageActPnlCompare": VoyagePnlFormQueryWhere,
"department": DepartmentFormQueryWhere,
"firstCargo": CargoFormQueryWhere,
"currentPort": VoyageItineraryFormQueryWhere,
"nextPort": VoyageItineraryFormQueryWhere,
"firstBallastPort": VoyageItineraryFormQueryWhere,
"firstTermPort": VoyageItineraryFormQueryWhere,
"firstLoadItin": VoyageItineraryFormQueryWhere,
"firstDiscItin": VoyageItineraryFormQueryWhere,
"lastLoadItin": VoyageItineraryFormQueryWhere,
"lastDiscItin": VoyageItineraryFormQueryWhere,
"firstItin": VoyageItineraryFormQueryWhere,
"lastItin": VoyageItineraryFormQueryWhere,
"tciContract": TimeCharterContractFormQueryWhere,
"tcoContract": TimeCharterContractFormQueryWhere,
"tcoDetails": TimeCharterOutDetailsFormQueryWhere,
"firstFixtureBallastPort": VoyageItineraryFormQueryWhere,
"firstFixtureTermPort": VoyageItineraryFormQueryWhere,
"companyAddressBook": AddressBookFormQueryWhere,
"company": CompanyFormQueryWhere,
"voyageEstimate": VoyageEstimateFormQueryWhere,
"voyageRemarks": VoyageRemarksFormQueryWhere,
"opsCoordinatorUser": ImosUserFormQueryWhere,
"charteringCoordinatorUser": ImosUserFormQueryWhere,
"opsCoordinatorUser2": ImosUserFormQueryWhere,
"controllerUser": ImosUserFormQueryWhere,
"fDManagerUser": ImosUserFormQueryWhere,
"financeCoordinatorUser": ImosUserFormQueryWhere,
"latestActivityReport": VoyageActivityReportFormQueryWhere,
"latestPositionReport": VoyageActivityReportFormQueryWhere,
"previousVoyage": VoyageFormQueryWhere,
"nextVoyage": VoyageFormQueryWhere
}
VoyageInstruction
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
voyageFormInstanceID - Int
|
|
voyageTemplateID - Int
|
|
seq - Int
|
|
voyageTemplateName - String
|
|
revision - Int
|
|
isSubmitted - Boolean
|
|
submitDate - Date
|
|
isExported - Boolean
|
|
exportDate - Date
|
|
lastUser - String
|
|
formData - String
|
|
formName - String
|
|
formGuid - String
|
|
status - String
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 123,
"voyageFormInstanceID": 987,
"voyageTemplateID": 123,
"seq": 987,
"voyageTemplateName": "abc123",
"revision": 123,
"isSubmitted": false,
"submitDate": "2007-12-03",
"isExported": true,
"exportDate": "2007-12-03",
"lastUser": "abc123",
"formData": "xyz789",
"formName": "abc123",
"formGuid": "xyz789",
"status": "abc123",
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageItinerary
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
eTB - Date
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
weatherFactorToPort - Float
|
|
ballastLadenToPort - String
|
|
cargoScheduler - String
|
|
cargoInspector - String
|
|
liquidQty - String
|
|
nonLiquidQty - String
|
|
isCurrentPortCall - Boolean
|
|
speedInstructionType - String
|
|
operationsPortRemarks - String
|
|
fixturePortRemarks - String
|
|
noticePortRemarks - String
|
|
allFastLocal - Date
|
|
alongside - Float
|
|
firstHosesOnDateLocal - Date
|
|
lastHosesOnDateLocal - Date
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
seq - Int
|
|
arrDepStatus - String
|
|
ballastLadenFromPort - String
|
|
fixtureNo - String
|
|
order - Int
|
|
portNo - Int
|
|
portName - String
|
|
estMiles - Float
|
|
speedFromPort - Float
|
|
extraSeaDays - Float
|
|
weatherFactorFromPort - Float
|
|
etaGmt - Date
|
|
anchorageDelay - Float
|
|
portDays - Float
|
|
etdGmt - Date
|
|
arrivalLocal - Date
|
|
departureLocal - Date
|
|
portFunc - String
|
|
estCostBase - Float
|
|
lastUpdateGmt - Date
|
|
demDesDays - Float
|
|
demDesRate - Float
|
|
lastUserID - String
|
|
masterSeq - Int
|
|
pilotToBerth - Float
|
|
berthToPilot - Float
|
|
portExpCurr - String
|
|
seaDays - Float
|
|
idleDays - Float
|
|
extraPortDays - Float
|
|
portExpExchRate - Float
|
|
lSSeaDays - Float
|
|
lSPortDays - Float
|
|
useEstimateCostInPnL - Boolean
|
|
isSpeedInstructionSAT - Boolean
|
|
isSpeedInstructionSpeed - Boolean
|
|
isSpeedInstructionEconomicalSpeed - Boolean
|
|
portExpAmountLocal - Float
|
|
portExpAmountBase - Float
|
|
via - String
|
|
lowSpeedMiles - Int
|
|
lowSpeedDays - Float
|
|
lSMiles - Int
|
|
portStatusCode - String
|
|
agreedSpeed - Float
|
|
agreedSpeedCons - Float
|
|
agreedSpeedEngineLoad - Float
|
|
dataSubmissionAgentShortName - String
|
|
dataSubmissionAgentType - String
|
|
portEcaID - Int
|
|
seaEcaID - Int
|
|
miles - Int
|
|
speedToPort - Float
|
|
seaConsMode - String
|
|
portConsMode - String
|
|
instructedSATLocal - Date
|
|
instructedSpeed - Float
|
|
voyageInstructionsTimestampGmt - Date
|
|
uSCGInspectionDateGmt - Date
|
|
uSCGInspectionStatus - String
|
|
fleetLocation - String
|
|
tankermanShortName - String
|
|
tankermanType - String
|
|
referencePortNo - Int
|
|
externalRef - String
|
|
seaEcaIDPort - Port
|
|
portEcaIDPort - Port
|
|
tankerman - AddressBook
|
|
portFunction - PortFunction
|
|
port - Port
|
|
fixture - Fixture
|
|
voyage - Voyage
|
|
vessel - Vessel
|
|
lastDischargeVoyageCargoHandling - VoyageCargoHandling
|
|
lastLoadVoyageCargoHandling - VoyageCargoHandling
|
|
firstCargoHandlingLoadByLaycanDate - VoyageCargoHandling
|
|
nextVoyageItinerary - VoyageItinerary
|
|
prevVoyageItinerary - VoyageItinerary
|
|
dataAgent - VoyagePortAgent
|
|
chartererAgent - VoyagePortAgent
|
|
protectiveAgent - VoyagePortAgent
|
|
ownerAgent - VoyagePortAgent
|
|
otherAgent - VoyagePortAgent
|
|
anchoredPortActivity - VoyagePortActivities
|
|
anchorAweighPortActivity - VoyagePortActivities
|
|
allFastPortActivity - VoyagePortActivities
|
|
firstHosesOnPortActivity - VoyagePortActivities
|
|
lastHosesOnPortActivity - VoyagePortActivities
|
|
quayBerth - VoyageItineraryBerth
|
|
currentPortCall - VoyageItinerary
|
|
voyageItineraryBunkers - [VoyageItineraryBunker]
|
|
portExpenseMiscDetails - [PortExpenseMiscDetails]
|
|
scheduleBarges - [ScheduleBarge]
|
|
portExpenses - [PortExpense]
|
|
voyageItineraryCarbons - [VoyageItineraryCarbon]
|
|
voyagePortActivities - [VoyagePortActivities]
|
|
voyageBunkerLiftings - [VoyageBunkerLifting]
|
|
voyageActivityReports - [VoyageActivityReport]
|
|
voyageItineraryBerths - [VoyageItineraryBerth]
|
|
voyageCargoHandlings - [VoyageCargoHandling]
|
|
bunkerInquiriesAndPurchasess - [BunkerInquiriesAndPurchases]
|
|
bunkerRequirements - [BunkerRequirement]
|
|
legEvents - [Delay]
|
|
voyagePortAgents - [VoyagePortAgent]
|
|
cargoHandlingListMessages - [CargoHandlingListMessageRecord]
|
|
Arguments
|
|
etaEtdMessages - [EtaEtdMessageRecord]
|
|
Arguments
|
|
portActivityListMessages - [PortActivityListMessageRecord]
|
|
Arguments
|
|
upcomingPortsListMessages - [UpcomingPortsListMessageRecord]
|
|
Arguments
|
|
veslinkFormMessages - [VeslinkFormMessageRecord]
|
|
Arguments
|
|
changesSinceLast - VoyageItineraryChangesSinceLast
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"eTB": "2007-12-03",
"customFieldByID": Any,
"customField": Any,
"weatherFactorToPort": 123.45,
"ballastLadenToPort": "xyz789",
"cargoScheduler": "abc123",
"cargoInspector": "xyz789",
"liquidQty": "xyz789",
"nonLiquidQty": "xyz789",
"isCurrentPortCall": false,
"speedInstructionType": "xyz789",
"operationsPortRemarks": "xyz789",
"fixturePortRemarks": "abc123",
"noticePortRemarks": "xyz789",
"allFastLocal": "2007-12-03",
"alongside": 123.45,
"firstHosesOnDateLocal": "2007-12-03",
"lastHosesOnDateLocal": "2007-12-03",
"vesselCode": "xyz789",
"voyageNo": 987,
"seq": 987,
"arrDepStatus": "xyz789",
"ballastLadenFromPort": "abc123",
"fixtureNo": "abc123",
"order": 987,
"portNo": 123,
"portName": "abc123",
"estMiles": 123.45,
"speedFromPort": 987.65,
"extraSeaDays": 987.65,
"weatherFactorFromPort": 987.65,
"etaGmt": "2007-12-03",
"anchorageDelay": 123.45,
"portDays": 123.45,
"etdGmt": "2007-12-03",
"arrivalLocal": "2007-12-03",
"departureLocal": "2007-12-03",
"portFunc": "xyz789",
"estCostBase": 987.65,
"lastUpdateGmt": "2007-12-03",
"demDesDays": 123.45,
"demDesRate": 987.65,
"lastUserID": "xyz789",
"masterSeq": 987,
"pilotToBerth": 987.65,
"berthToPilot": 987.65,
"portExpCurr": "xyz789",
"seaDays": 987.65,
"idleDays": 123.45,
"extraPortDays": 123.45,
"portExpExchRate": 123.45,
"lSSeaDays": 987.65,
"lSPortDays": 123.45,
"useEstimateCostInPnL": true,
"isSpeedInstructionSAT": false,
"isSpeedInstructionSpeed": true,
"isSpeedInstructionEconomicalSpeed": true,
"portExpAmountLocal": 123.45,
"portExpAmountBase": 987.65,
"via": "xyz789",
"lowSpeedMiles": 987,
"lowSpeedDays": 987.65,
"lSMiles": 987,
"portStatusCode": "xyz789",
"agreedSpeed": 987.65,
"agreedSpeedCons": 987.65,
"agreedSpeedEngineLoad": 123.45,
"dataSubmissionAgentShortName": "xyz789",
"dataSubmissionAgentType": "abc123",
"portEcaID": 123,
"seaEcaID": 987,
"miles": 987,
"speedToPort": 123.45,
"seaConsMode": "abc123",
"portConsMode": "xyz789",
"instructedSATLocal": "2007-12-03",
"instructedSpeed": 123.45,
"voyageInstructionsTimestampGmt": "2007-12-03",
"uSCGInspectionDateGmt": "2007-12-03",
"uSCGInspectionStatus": "xyz789",
"fleetLocation": "abc123",
"tankermanShortName": "abc123",
"tankermanType": "abc123",
"referencePortNo": 123,
"externalRef": "xyz789",
"seaEcaIDPort": Port,
"portEcaIDPort": Port,
"tankerman": AddressBook,
"portFunction": PortFunction,
"port": Port,
"fixture": Fixture,
"voyage": Voyage,
"vessel": Vessel,
"lastDischargeVoyageCargoHandling": VoyageCargoHandling,
"lastLoadVoyageCargoHandling": VoyageCargoHandling,
"firstCargoHandlingLoadByLaycanDate": VoyageCargoHandling,
"nextVoyageItinerary": VoyageItinerary,
"prevVoyageItinerary": VoyageItinerary,
"dataAgent": VoyagePortAgent,
"chartererAgent": VoyagePortAgent,
"protectiveAgent": VoyagePortAgent,
"ownerAgent": VoyagePortAgent,
"otherAgent": VoyagePortAgent,
"anchoredPortActivity": VoyagePortActivities,
"anchorAweighPortActivity": VoyagePortActivities,
"allFastPortActivity": VoyagePortActivities,
"firstHosesOnPortActivity": VoyagePortActivities,
"lastHosesOnPortActivity": VoyagePortActivities,
"quayBerth": VoyageItineraryBerth,
"currentPortCall": VoyageItinerary,
"voyageItineraryBunkers": [VoyageItineraryBunker],
"portExpenseMiscDetails": [PortExpenseMiscDetails],
"scheduleBarges": [ScheduleBarge],
"portExpenses": [PortExpense],
"voyageItineraryCarbons": [VoyageItineraryCarbon],
"voyagePortActivities": [VoyagePortActivities],
"voyageBunkerLiftings": [VoyageBunkerLifting],
"voyageActivityReports": [VoyageActivityReport],
"voyageItineraryBerths": [VoyageItineraryBerth],
"voyageCargoHandlings": [VoyageCargoHandling],
"bunkerInquiriesAndPurchasess": [
BunkerInquiriesAndPurchases
],
"bunkerRequirements": [BunkerRequirement],
"legEvents": [Delay],
"voyagePortAgents": [VoyagePortAgent],
"cargoHandlingListMessages": [
CargoHandlingListMessageRecord
],
"etaEtdMessages": [EtaEtdMessageRecord],
"portActivityListMessages": [
PortActivityListMessageRecord
],
"upcomingPortsListMessages": [
UpcomingPortsListMessageRecord
],
"veslinkFormMessages": [VeslinkFormMessageRecord],
"changesSinceLast": VoyageItineraryChangesSinceLast,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
VoyageItineraryBerth
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
draft - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
draftImosUnits - Float
|
|
order - Int
|
|
sqlID - Int
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
voyageSeq - Int
|
|
berthSeq - Int
|
|
portNo - Int
|
|
berthShortName - String
|
|
arrivalLocal - Date
|
|
departureLocal - Date
|
|
extraLoadDischDays - Float
|
|
departDelay - Float
|
|
salinity - Float
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
draftBasis - String
|
|
externalRef - String
|
|
hasManualLoadline - Boolean
|
|
isManualBerth - Boolean
|
|
berthOrdNo - Int
|
|
portBerth - PortBerth
|
|
voyageItinerary - VoyageItinerary
|
|
voyageCargoHandlings - VoyageCargoHandling
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"draft": 987.65,
"customFieldByID": Any,
"customField": Any,
"draftImosUnits": 123.45,
"order": 123,
"sqlID": 987,
"vesselCode": "abc123",
"voyageNo": 987,
"voyageSeq": 987,
"berthSeq": 123,
"portNo": 123,
"berthShortName": "xyz789",
"arrivalLocal": "2007-12-03",
"departureLocal": "2007-12-03",
"extraLoadDischDays": 123.45,
"departDelay": 123.45,
"salinity": 123.45,
"lastUpdateGmt": "2007-12-03",
"lastUser": "xyz789",
"draftBasis": "xyz789",
"externalRef": "xyz789",
"hasManualLoadline": false,
"isManualBerth": false,
"berthOrdNo": 987,
"portBerth": PortBerth,
"voyageItinerary": VoyageItinerary,
"voyageCargoHandlings": VoyageCargoHandling,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
VoyageItineraryBerthFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageItineraryBerthFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageItineraryBerthFormQueryWhere
}
VoyageItineraryBerthFormQueryWhere
Fields
Example
{
"and": [VoyageItineraryBerthFormQueryWhere],
"or": [VoyageItineraryBerthFormQueryWhere],
"rawExpression": "xyz789",
"draft": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"voyageSeq": NumberWhereValueExpression,
"berthSeq": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"berthShortName": StringWhereValueExpression,
"arrivalLocal": DateWhereValueExpression,
"departureLocal": DateWhereValueExpression,
"extraLoadDischDays": NumberWhereValueExpression,
"departDelay": NumberWhereValueExpression,
"salinity": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"draftBasis": StringWhereValueExpression,
"externalRef": StringWhereValueExpression,
"hasManualLoadline": BoolWhereValueExpression,
"isManualBerth": BoolWhereValueExpression,
"berthOrdNo": NumberWhereValueExpression,
"portBerth": PortBerthFormQueryWhere,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"voyageCargoHandlings": VoyageCargoHandlingFormQueryWhere
}
VoyageItineraryBerthRelationships
Fields
| Field Name | Description |
|---|---|
portBerth - RelationshipDefinition
|
|
voyageItinerary - RelationshipDefinition
|
|
voyageCargoHandlings - RelationshipDefinition
|
Example
{
"portBerth": RelationshipDefinition,
"voyageItinerary": RelationshipDefinition,
"voyageCargoHandlings": RelationshipDefinition
}
VoyageItineraryBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
seq - Int
|
|
fuelType - String
|
|
robArrival - Float
|
|
oprQty - Float
|
|
robDeparture - Float
|
|
price - Float
|
|
isReceivedBunkerPriceManual - Boolean
|
|
isROBArrivalQtyManual - Boolean
|
|
isROBDepartureQtyManual - Boolean
|
|
arrRobPrice - Float
|
|
depRobPrice - Float
|
|
voyageItinerary - VoyageItinerary
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 123,
"seq": 123,
"fuelType": "xyz789",
"robArrival": 987.65,
"oprQty": 123.45,
"robDeparture": 123.45,
"price": 987.65,
"isReceivedBunkerPriceManual": false,
"isROBArrivalQtyManual": false,
"isROBDepartureQtyManual": true,
"arrRobPrice": 987.65,
"depRobPrice": 123.45,
"voyageItinerary": VoyageItinerary,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageItineraryBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageItineraryBunkerFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageItineraryBunkerFormQueryWhere
}
VoyageItineraryBunkerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyageItineraryBunkerFormQueryWhere!]
|
|
or - [VoyageItineraryBunkerFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
robArrival - NumberWhereValueExpression
|
|
oprQty - NumberWhereValueExpression
|
|
robDeparture - NumberWhereValueExpression
|
|
price - NumberWhereValueExpression
|
|
isReceivedBunkerPriceManual - BoolWhereValueExpression
|
|
isROBArrivalQtyManual - BoolWhereValueExpression
|
|
isROBDepartureQtyManual - BoolWhereValueExpression
|
|
arrRobPrice - NumberWhereValueExpression
|
|
depRobPrice - NumberWhereValueExpression
|
|
voyageItinerary - VoyageItineraryFormQueryWhere
|
Example
{
"and": [VoyageItineraryBunkerFormQueryWhere],
"or": [VoyageItineraryBunkerFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"robArrival": NumberWhereValueExpression,
"oprQty": NumberWhereValueExpression,
"robDeparture": NumberWhereValueExpression,
"price": NumberWhereValueExpression,
"isReceivedBunkerPriceManual": BoolWhereValueExpression,
"isROBArrivalQtyManual": BoolWhereValueExpression,
"isROBDepartureQtyManual": BoolWhereValueExpression,
"arrRobPrice": NumberWhereValueExpression,
"depRobPrice": NumberWhereValueExpression,
"voyageItinerary": VoyageItineraryFormQueryWhere
}
VoyageItineraryBunkerRelationships
Fields
| Field Name | Description |
|---|---|
voyageItinerary - RelationshipDefinition
|
Example
{"voyageItinerary": RelationshipDefinition}
VoyageItineraryCarbon
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
totalEmissions - Float
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
regulatedEmissions - Float
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
itinSeq - Int
|
|
manualSeaPercent - Boolean
|
|
manualPortPercent - Boolean
|
|
manualPhaseInPercent - Boolean
|
|
manualSeaEtsEmission - Boolean
|
|
manualPortEtsEmission - Boolean
|
|
entryUserID - String
|
|
entryDate - Date
|
|
updateTimes - Int
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
seaPercentage - Float
|
|
portPercentage - Float
|
|
regulationScheme - String
|
|
phaseInPercentage - Float
|
|
year - Int
|
|
totalSeaEmissions - Float
|
|
totalPortEmissions - Float
|
|
regulatedSeaEmissions - Float
|
|
regulatedPortEmissions - Float
|
|
seqNo - Int
|
|
seaTimeStart - Date
|
|
seaTimeEnd - Date
|
|
portTimeStart - Date
|
|
portTimeEnd - Date
|
|
voyageItinerary - VoyageItinerary
|
|
voyageItineraryCarbonBunkers - [VoyageItineraryCarbonBunker]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"totalEmissions": 987.65,
"customFieldByID": Any,
"customField": Any,
"regulatedEmissions": 123.45,
"vesselCode": "abc123",
"voyageNo": 987,
"itinSeq": 123,
"manualSeaPercent": true,
"manualPortPercent": true,
"manualPhaseInPercent": false,
"manualSeaEtsEmission": false,
"manualPortEtsEmission": false,
"entryUserID": "abc123",
"entryDate": "2007-12-03",
"updateTimes": 123,
"lastUser": "abc123",
"lastUpdateGmt": "2007-12-03",
"seaPercentage": 987.65,
"portPercentage": 123.45,
"regulationScheme": "abc123",
"phaseInPercentage": 123.45,
"year": 987,
"totalSeaEmissions": 123.45,
"totalPortEmissions": 123.45,
"regulatedSeaEmissions": 987.65,
"regulatedPortEmissions": 987.65,
"seqNo": 123,
"seaTimeStart": "2007-12-03",
"seaTimeEnd": "2007-12-03",
"portTimeStart": "2007-12-03",
"portTimeEnd": "2007-12-03",
"voyageItinerary": VoyageItinerary,
"voyageItineraryCarbonBunkers": [
VoyageItineraryCarbonBunker
],
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageItineraryCarbonBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
regulationScheme - String
|
|
seqNo - Int
|
|
fuelType - String
|
|
seaCons - Float
|
|
portCons - Float
|
|
seaEmissions - Float
|
|
portEmissions - Float
|
|
voyageItineraryCarbon - VoyageItineraryCarbon
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 123,
"regulationScheme": "xyz789",
"seqNo": 987,
"fuelType": "xyz789",
"seaCons": 123.45,
"portCons": 123.45,
"seaEmissions": 987.65,
"portEmissions": 123.45,
"voyageItineraryCarbon": VoyageItineraryCarbon,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageItineraryCarbonBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageItineraryCarbonBunkerFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageItineraryCarbonBunkerFormQueryWhere
}
VoyageItineraryCarbonBunkerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyageItineraryCarbonBunkerFormQueryWhere!]
|
|
or - [VoyageItineraryCarbonBunkerFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
regulationScheme - VoyageItineraryCarbonBunkerRegulationSchemeEnumValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
seaCons - NumberWhereValueExpression
|
|
portCons - NumberWhereValueExpression
|
|
seaEmissions - NumberWhereValueExpression
|
|
portEmissions - NumberWhereValueExpression
|
|
voyageItineraryCarbon - VoyageItineraryCarbonFormQueryWhere
|
Example
{
"and": [VoyageItineraryCarbonBunkerFormQueryWhere],
"or": [VoyageItineraryCarbonBunkerFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"regulationScheme": VoyageItineraryCarbonBunkerRegulationSchemeEnumValueExpression,
"seqNo": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"seaCons": NumberWhereValueExpression,
"portCons": NumberWhereValueExpression,
"seaEmissions": NumberWhereValueExpression,
"portEmissions": NumberWhereValueExpression,
"voyageItineraryCarbon": VoyageItineraryCarbonFormQueryWhere
}
VoyageItineraryCarbonBunkerRegulationSchemeEnum
Values
| Enum Value | Description |
|---|---|
|
|
Example
"EU"
VoyageItineraryCarbonBunkerRegulationSchemeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageItineraryCarbonBunkerRegulationSchemeEnum
|
|
isNot - VoyageItineraryCarbonBunkerRegulationSchemeEnum
|
|
isIn - [VoyageItineraryCarbonBunkerRegulationSchemeEnum]
|
Example
{"is": "EU", "isNot": "EU", "isIn": ["EU"]}
VoyageItineraryCarbonBunkerRelationships
Fields
| Field Name | Description |
|---|---|
voyageItineraryCarbon - RelationshipDefinition
|
Example
{"voyageItineraryCarbon": RelationshipDefinition}
VoyageItineraryCarbonFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageItineraryCarbonFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageItineraryCarbonFormQueryWhere
}
VoyageItineraryCarbonFormQueryWhere
Fields
Example
{
"and": [VoyageItineraryCarbonFormQueryWhere],
"or": [VoyageItineraryCarbonFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"itinSeq": NumberWhereValueExpression,
"manualSeaPercent": BoolWhereValueExpression,
"manualPortPercent": BoolWhereValueExpression,
"manualPhaseInPercent": BoolWhereValueExpression,
"manualSeaEtsEmission": BoolWhereValueExpression,
"manualPortEtsEmission": BoolWhereValueExpression,
"entryUserID": StringWhereValueExpression,
"entryDate": DateWhereValueExpression,
"updateTimes": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"seaPercentage": NumberWhereValueExpression,
"portPercentage": NumberWhereValueExpression,
"regulationScheme": VoyageItineraryCarbonRegulationSchemeEnumValueExpression,
"phaseInPercentage": NumberWhereValueExpression,
"year": NumberWhereValueExpression,
"totalSeaEmissions": NumberWhereValueExpression,
"totalPortEmissions": NumberWhereValueExpression,
"regulatedSeaEmissions": NumberWhereValueExpression,
"regulatedPortEmissions": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"seaTimeStart": DateWhereValueExpression,
"seaTimeEnd": DateWhereValueExpression,
"portTimeStart": DateWhereValueExpression,
"portTimeEnd": DateWhereValueExpression,
"voyageItinerary": VoyageItineraryFormQueryWhere
}
VoyageItineraryCarbonRegulationSchemeEnum
Values
| Enum Value | Description |
|---|---|
|
|
Example
"EU"
VoyageItineraryCarbonRegulationSchemeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageItineraryCarbonRegulationSchemeEnum
|
|
isNot - VoyageItineraryCarbonRegulationSchemeEnum
|
|
isIn - [VoyageItineraryCarbonRegulationSchemeEnum]
|
Example
{"is": "EU", "isNot": "EU", "isIn": ["EU"]}
VoyageItineraryCarbonRelationships
Fields
| Field Name | Description |
|---|---|
voyageItinerary - RelationshipDefinition
|
|
voyageItineraryCarbonBunkers - RelationshipDefinition
|
Example
{
"voyageItinerary": RelationshipDefinition,
"voyageItineraryCarbonBunkers": RelationshipDefinition
}
VoyageItineraryCargoHandlingRelationships
Fields
| Field Name | Description |
|---|---|
voyageItinerary - RelationshipDefinition
|
|
cargoInspectorAddressBook - RelationshipDefinition
|
Example
{
"voyageItinerary": RelationshipDefinition,
"cargoInspectorAddressBook": RelationshipDefinition
}
VoyageItineraryChangesSinceLast
Fields
| Field Name | Description |
|---|---|
cargoHandlingList - MessageUpdateResponse
|
|
etaEtd - MessageUpdateResponse
|
|
portActivityList - MessageUpdateResponse
|
|
upcomingPortsList - MessageUpdateResponse
|
|
veslinkForm - MessageUpdateResponse
|
Example
{
"cargoHandlingList": MessageUpdateResponse,
"etaEtd": MessageUpdateResponse,
"portActivityList": MessageUpdateResponse,
"upcomingPortsList": MessageUpdateResponse,
"veslinkForm": MessageUpdateResponse
}
VoyageItineraryFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageItineraryFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageItineraryFormQueryWhere
}
VoyageItineraryFormQueryWhere
Fields
Example
{
"and": [VoyageItineraryFormQueryWhere],
"or": [VoyageItineraryFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"arrDepStatus": StringWhereValueExpression,
"ballastLadenFromPort": StringWhereValueExpression,
"fixtureNo": StringWhereValueExpression,
"order": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"portName": StringWhereValueExpression,
"estMiles": NumberWhereValueExpression,
"speedFromPort": NumberWhereValueExpression,
"extraSeaDays": NumberWhereValueExpression,
"weatherFactorFromPort": NumberWhereValueExpression,
"etaGmt": DateWhereValueExpression,
"anchorageDelay": NumberWhereValueExpression,
"portDays": NumberWhereValueExpression,
"etdGmt": DateWhereValueExpression,
"arrivalLocal": DateWhereValueExpression,
"departureLocal": DateWhereValueExpression,
"portFunc": StringWhereValueExpression,
"estCostBase": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"demDesDays": NumberWhereValueExpression,
"demDesRate": NumberWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"masterSeq": NumberWhereValueExpression,
"pilotToBerth": NumberWhereValueExpression,
"berthToPilot": NumberWhereValueExpression,
"portExpCurr": StringWhereValueExpression,
"seaDays": NumberWhereValueExpression,
"idleDays": NumberWhereValueExpression,
"extraPortDays": NumberWhereValueExpression,
"portExpExchRate": NumberWhereValueExpression,
"lSSeaDays": NumberWhereValueExpression,
"lSPortDays": NumberWhereValueExpression,
"useEstimateCostInPnL": BoolWhereValueExpression,
"isSpeedInstructionSAT": BoolWhereValueExpression,
"isSpeedInstructionSpeed": BoolWhereValueExpression,
"isSpeedInstructionEconomicalSpeed": BoolWhereValueExpression,
"portExpAmountLocal": NumberWhereValueExpression,
"portExpAmountBase": NumberWhereValueExpression,
"via": StringWhereValueExpression,
"lowSpeedMiles": NumberWhereValueExpression,
"lowSpeedDays": NumberWhereValueExpression,
"lSMiles": NumberWhereValueExpression,
"portStatusCode": StringWhereValueExpression,
"agreedSpeed": NumberWhereValueExpression,
"agreedSpeedCons": NumberWhereValueExpression,
"agreedSpeedEngineLoad": NumberWhereValueExpression,
"dataSubmissionAgentShortName": StringWhereValueExpression,
"dataSubmissionAgentType": StringWhereValueExpression,
"portEcaID": NumberWhereValueExpression,
"seaEcaID": NumberWhereValueExpression,
"miles": NumberWhereValueExpression,
"speedToPort": NumberWhereValueExpression,
"seaConsMode": VoyageItinerarySeaConsModeEnumValueExpression,
"portConsMode": VoyageItineraryPortConsModeEnumValueExpression,
"instructedSATLocal": DateWhereValueExpression,
"instructedSpeed": NumberWhereValueExpression,
"voyageInstructionsTimestampGmt": DateWhereValueExpression,
"uSCGInspectionDateGmt": DateWhereValueExpression,
"uSCGInspectionStatus": VoyageItineraryUSCGInspectionStatusEnumValueExpression,
"fleetLocation": StringWhereValueExpression,
"tankermanShortName": StringWhereValueExpression,
"tankermanType": StringWhereValueExpression,
"referencePortNo": NumberWhereValueExpression,
"externalRef": StringWhereValueExpression,
"seaEcaIDPort": PortFormQueryWhere,
"portEcaIDPort": PortFormQueryWhere,
"tankerman": AddressBookFormQueryWhere,
"portFunction": PortFunctionFormQueryWhere,
"port": PortFormQueryWhere,
"fixture": FixtureFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"vessel": VesselFormQueryWhere,
"lastDischargeVoyageCargoHandling": VoyageCargoHandlingFormQueryWhere,
"lastLoadVoyageCargoHandling": VoyageCargoHandlingFormQueryWhere,
"firstCargoHandlingLoadByLaycanDate": VoyageCargoHandlingFormQueryWhere,
"nextVoyageItinerary": VoyageItineraryFormQueryWhere,
"prevVoyageItinerary": VoyageItineraryFormQueryWhere,
"dataAgent": VoyagePortAgentFormQueryWhere,
"chartererAgent": VoyagePortAgentFormQueryWhere,
"protectiveAgent": VoyagePortAgentFormQueryWhere,
"ownerAgent": VoyagePortAgentFormQueryWhere,
"otherAgent": VoyagePortAgentFormQueryWhere,
"anchoredPortActivity": VoyagePortActivitiesFormQueryWhere,
"anchorAweighPortActivity": VoyagePortActivitiesFormQueryWhere,
"allFastPortActivity": VoyagePortActivitiesFormQueryWhere,
"firstHosesOnPortActivity": VoyagePortActivitiesFormQueryWhere,
"lastHosesOnPortActivity": VoyagePortActivitiesFormQueryWhere,
"quayBerth": VoyageItineraryBerthFormQueryWhere,
"currentPortCall": VoyageItineraryFormQueryWhere
}
VoyageItineraryPortConsModeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Automatic"
VoyageItineraryPortConsModeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageItineraryPortConsModeEnum
|
|
isNot - VoyageItineraryPortConsModeEnum
|
|
isIn - [VoyageItineraryPortConsModeEnum]
|
Example
{"is": "Automatic", "isNot": "Automatic", "isIn": ["Automatic"]}
VoyageItineraryProjectedBunkerInvoiceRelationships
Fields
| Field Name | Description |
|---|---|
voyage - RelationshipDefinition
|
|
voyageItinerary - RelationshipDefinition
|
|
firstCargoHandling - RelationshipDefinition
|
|
firstActivityReportBunkerDetail - RelationshipDefinition
|
Example
{
"voyage": RelationshipDefinition,
"voyageItinerary": RelationshipDefinition,
"firstCargoHandling": RelationshipDefinition,
"firstActivityReportBunkerDetail": RelationshipDefinition
}
VoyageItineraryRelationships
Fields
Example
{
"seaEcaIDPort": RelationshipDefinition,
"portEcaIDPort": RelationshipDefinition,
"tankerman": RelationshipDefinition,
"portFunction": RelationshipDefinition,
"port": RelationshipDefinition,
"fixture": RelationshipDefinition,
"voyage": RelationshipDefinition,
"vessel": RelationshipDefinition,
"lastDischargeVoyageCargoHandling": RelationshipDefinition,
"lastLoadVoyageCargoHandling": RelationshipDefinition,
"firstCargoHandlingLoadByLaycanDate": RelationshipDefinition,
"nextVoyageItinerary": RelationshipDefinition,
"prevVoyageItinerary": RelationshipDefinition,
"dataAgent": RelationshipDefinition,
"chartererAgent": RelationshipDefinition,
"protectiveAgent": RelationshipDefinition,
"ownerAgent": RelationshipDefinition,
"otherAgent": RelationshipDefinition,
"anchoredPortActivity": RelationshipDefinition,
"anchorAweighPortActivity": RelationshipDefinition,
"allFastPortActivity": RelationshipDefinition,
"firstHosesOnPortActivity": RelationshipDefinition,
"lastHosesOnPortActivity": RelationshipDefinition,
"quayBerth": RelationshipDefinition,
"voyageItineraryCargoHandling": RelationshipDefinition,
"currentPortCall": RelationshipDefinition,
"opsVoyageRemarks": RelationshipDefinition,
"fixtureVoyageRemarks": RelationshipDefinition,
"noticeVoyageRemarks": RelationshipDefinition,
"voyageItineraryBunkers": RelationshipDefinition,
"portExpenseMiscDetails": RelationshipDefinition,
"scheduleBarges": RelationshipDefinition,
"portExpenses": RelationshipDefinition,
"voyageItineraryCarbons": RelationshipDefinition,
"voyagePortActivities": RelationshipDefinition,
"voyageBunkerLiftings": RelationshipDefinition,
"voyageActivityReports": RelationshipDefinition,
"voyageItineraryBerths": RelationshipDefinition,
"voyageCargoHandlings": RelationshipDefinition,
"bunkerInquiriesAndPurchasess": RelationshipDefinition,
"bunkerRequirements": RelationshipDefinition,
"legEvents": RelationshipDefinition,
"voyagePortAgents": RelationshipDefinition,
"voyageItineraryCargoHandlings": RelationshipDefinition
}
VoyageItinerarySeaConsModeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Automatic"
VoyageItinerarySeaConsModeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageItinerarySeaConsModeEnum
|
|
isNot - VoyageItinerarySeaConsModeEnum
|
|
isIn - [VoyageItinerarySeaConsModeEnum]
|
Example
{"is": "Automatic", "isNot": "Automatic", "isIn": ["Automatic"]}
VoyageItineraryUSCGInspectionStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"None"
VoyageItineraryUSCGInspectionStatusEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageItineraryUSCGInspectionStatusEnum
|
|
isNot - VoyageItineraryUSCGInspectionStatusEnum
|
|
isIn - [VoyageItineraryUSCGInspectionStatusEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VoyageLegDetails
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
companyCode - String
|
|
eventGMT - Date
|
|
eventType - String
|
|
eventLongitude - String
|
|
eventLatitude - String
|
|
fromPortSeq - Int
|
|
fromPortNo - Int
|
|
fromPortName - String
|
|
fromPortUNCode - String
|
|
fromPortFunc - String
|
|
fromPortBLQty - Float
|
|
fromPortCountry - String
|
|
toPortSeq - Int
|
|
toPortNo - Int
|
|
toPortName - String
|
|
toPortUNCode - String
|
|
toPortFunc - String
|
|
toPortBLQty - Float
|
|
toPortCountry - String
|
|
portion - Float
|
|
elapsedHours - Float
|
|
reportingHours - Float
|
|
steamingHours - Float
|
|
steamingDistance - Float
|
|
inPortHours - Float
|
|
inPortDistance - Float
|
|
berthHours - Float
|
|
berthDistance - Float
|
|
anchorHours - Float
|
|
anchorDistance - Float
|
|
shiftingHours - Float
|
|
shiftingDistance - Float
|
|
distance - Float
|
|
vesselSpeed - Float
|
|
displacement - Float
|
|
deadweight - Float
|
|
constant - Float
|
|
eEOI - Float
|
|
onboardQty - Float
|
|
beaufortScaleNo - Int
|
|
bnkr1_FuelType - String
|
|
bnkr1_ROB - Float
|
|
bnkr1_Received - Float
|
|
bnkr1_MainEng - Float
|
|
bnkr1_AuxEng - Float
|
|
bnkr1_Adjustment - Float
|
|
bnkr1_Propulsion - Float
|
|
bnkr1_LoadOrDisch - Float
|
|
bnkr1_Heat - Float
|
|
bnkr1_Clean - Float
|
|
bnkr1_Deballast - Float
|
|
bnkr1_Maneuver - Float
|
|
bnkr1_Others - Float
|
|
bnkr1_Igs - Float
|
|
bnkr1_Generator - Float
|
|
bnkr1_AtSeaTotal - Float
|
|
bnkr1_AtSeaPerDay - Float
|
|
bnkr1_InPortTotal - Float
|
|
bnkr1_InPortPerDay - Float
|
|
bnkr1_BerthTotal - Float
|
|
bnkr1_AnchorTotal - Float
|
|
bnkr1_ShiftingTotal - Float
|
|
bnkr1_Total - Float
|
|
bnkr1_CO2EmissionsFactor - Float
|
|
bnkr1_CO2Emissions - Float
|
|
bnkr2_FuelType - String
|
|
bnkr2_ROB - Float
|
|
bnkr2_Received - Float
|
|
bnkr2_MainEng - Float
|
|
bnkr2_AuxEng - Float
|
|
bnkr2_Adjustment - Float
|
|
bnkr2_Propulsion - Float
|
|
bnkr2_LoadOrDisch - Float
|
|
bnkr2_Heat - Float
|
|
bnkr2_Clean - Float
|
|
bnkr2_Deballast - Float
|
|
bnkr2_Maneuver - Float
|
|
bnkr2_Others - Float
|
|
bnkr2_Igs - Float
|
|
bnkr2_Generator - Float
|
|
bnkr2_AtSeaTotal - Float
|
|
bnkr2_AtSeaPerDay - Float
|
|
bnkr2_InPortTotal - Float
|
|
bnkr2_InPortPerDay - Float
|
|
bnkr2_BerthTotal - Float
|
|
bnkr2_AnchorTotal - Float
|
|
bnkr2_ShiftingTotal - Float
|
|
bnkr2_Total - Float
|
|
bnkr2_CO2EmissionsFactor - Float
|
|
bnkr2_CO2Emissions - Float
|
|
bnkr3_FuelType - String
|
|
bnkr3_ROB - Float
|
|
bnkr3_Received - Float
|
|
bnkr3_MainEng - Float
|
|
bnkr3_AuxEng - Float
|
|
bnkr3_Adjustment - Float
|
|
bnkr3_Propulsion - Float
|
|
bnkr3_LoadOrDisch - Float
|
|
bnkr3_Heat - Float
|
|
bnkr3_Clean - Float
|
|
bnkr3_Deballast - Float
|
|
bnkr3_Maneuver - Float
|
|
bnkr3_Others - Float
|
|
bnkr3_Igs - Float
|
|
bnkr3_Generator - Float
|
|
bnkr3_AtSeaTotal - Float
|
|
bnkr3_AtSeaPerDay - Float
|
|
bnkr3_InPortTotal - Float
|
|
bnkr3_InPortPerDay - Float
|
|
bnkr3_BerthTotal - Float
|
|
bnkr3_AnchorTotal - Float
|
|
bnkr3_ShiftingTotal - Float
|
|
bnkr3_Total - Float
|
|
bnkr3_CO2EmissionsFactor - Float
|
|
bnkr3_CO2Emissions - Float
|
|
bnkr4_FuelType - String
|
|
bnkr4_ROB - Float
|
|
bnkr4_Received - Float
|
|
bnkr4_MainEng - Float
|
|
bnkr4_AuxEng - Float
|
|
bnkr4_Adjustment - Float
|
|
bnkr4_Propulsion - Float
|
|
bnkr4_LoadOrDisch - Float
|
|
bnkr4_Heat - Float
|
|
bnkr4_Clean - Float
|
|
bnkr4_Deballast - Float
|
|
bnkr4_Maneuver - Float
|
|
bnkr4_Others - Float
|
|
bnkr4_Igs - Float
|
|
bnkr4_Generator - Float
|
|
bnkr4_AtSeaTotal - Float
|
|
bnkr4_AtSeaPerDay - Float
|
|
bnkr4_InPortTotal - Float
|
|
bnkr4_InPortPerDay - Float
|
|
bnkr4_BerthTotal - Float
|
|
bnkr4_AnchorTotal - Float
|
|
bnkr4_ShiftingTotal - Float
|
|
bnkr4_Total - Float
|
|
bnkr4_CO2EmissionsFactor - Float
|
|
bnkr4_CO2Emissions - Float
|
|
bnkr5_FuelType - String
|
|
bnkr5_ROB - Float
|
|
bnkr5_Received - Float
|
|
bnkr5_MainEng - Float
|
|
bnkr5_AuxEng - Float
|
|
bnkr5_Adjustment - Float
|
|
bnkr5_Propulsion - Float
|
|
bnkr5_LoadOrDisch - Float
|
|
bnkr5_Heat - Float
|
|
bnkr5_Clean - Float
|
|
bnkr5_Deballast - Float
|
|
bnkr5_Maneuver - Float
|
|
bnkr5_Others - Float
|
|
bnkr5_Igs - Float
|
|
bnkr5_Generator - Float
|
|
bnkr5_AtSeaTotal - Float
|
|
bnkr5_AtSeaPerDay - Float
|
|
bnkr5_InPortTotal - Float
|
|
bnkr5_InPortPerDay - Float
|
|
bnkr5_BerthTotal - Float
|
|
bnkr5_AnchorTotal - Float
|
|
bnkr5_ShiftingTotal - Float
|
|
bnkr5_Total - Float
|
|
bnkr5_CO2EmissionsFactor - Float
|
|
bnkr5_CO2Emissions - Float
|
|
bnkr6_FuelType - String
|
|
bnkr6_ROB - Float
|
|
bnkr6_Received - Float
|
|
bnkr6_MainEng - Float
|
|
bnkr6_AuxEng - Float
|
|
bnkr6_Adjustment - Float
|
|
bnkr6_Propulsion - Float
|
|
bnkr6_LoadOrDisch - Float
|
|
bnkr6_Heat - Float
|
|
bnkr6_Clean - Float
|
|
bnkr6_Deballast - Float
|
|
bnkr6_Maneuver - Float
|
|
bnkr6_Others - Float
|
|
bnkr6_Igs - Float
|
|
bnkr6_Generator - Float
|
|
bnkr6_AtSeaTotal - Float
|
|
bnkr6_AtSeaPerDay - Float
|
|
bnkr6_InPortTotal - Float
|
|
bnkr6_InPortPerDay - Float
|
|
bnkr6_BerthTotal - Float
|
|
bnkr6_AnchorTotal - Float
|
|
bnkr6_ShiftingTotal - Float
|
|
bnkr6_Total - Float
|
|
bnkr6_CO2EmissionsFactor - Float
|
|
bnkr6_CO2Emissions - Float
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 123,
"companyCode": "xyz789",
"eventGMT": "2007-12-03",
"eventType": "xyz789",
"eventLongitude": "xyz789",
"eventLatitude": "xyz789",
"fromPortSeq": 123,
"fromPortNo": 987,
"fromPortName": "xyz789",
"fromPortUNCode": "xyz789",
"fromPortFunc": "xyz789",
"fromPortBLQty": 123.45,
"fromPortCountry": "xyz789",
"toPortSeq": 123,
"toPortNo": 123,
"toPortName": "abc123",
"toPortUNCode": "xyz789",
"toPortFunc": "xyz789",
"toPortBLQty": 987.65,
"toPortCountry": "xyz789",
"portion": 987.65,
"elapsedHours": 987.65,
"reportingHours": 987.65,
"steamingHours": 123.45,
"steamingDistance": 123.45,
"inPortHours": 987.65,
"inPortDistance": 123.45,
"berthHours": 987.65,
"berthDistance": 123.45,
"anchorHours": 123.45,
"anchorDistance": 987.65,
"shiftingHours": 123.45,
"shiftingDistance": 123.45,
"distance": 123.45,
"vesselSpeed": 123.45,
"displacement": 123.45,
"deadweight": 123.45,
"constant": 123.45,
"eEOI": 987.65,
"onboardQty": 123.45,
"beaufortScaleNo": 123,
"bnkr1_FuelType": "abc123",
"bnkr1_ROB": 987.65,
"bnkr1_Received": 987.65,
"bnkr1_MainEng": 123.45,
"bnkr1_AuxEng": 987.65,
"bnkr1_Adjustment": 123.45,
"bnkr1_Propulsion": 987.65,
"bnkr1_LoadOrDisch": 123.45,
"bnkr1_Heat": 987.65,
"bnkr1_Clean": 123.45,
"bnkr1_Deballast": 123.45,
"bnkr1_Maneuver": 987.65,
"bnkr1_Others": 123.45,
"bnkr1_Igs": 123.45,
"bnkr1_Generator": 987.65,
"bnkr1_AtSeaTotal": 123.45,
"bnkr1_AtSeaPerDay": 987.65,
"bnkr1_InPortTotal": 123.45,
"bnkr1_InPortPerDay": 123.45,
"bnkr1_BerthTotal": 123.45,
"bnkr1_AnchorTotal": 987.65,
"bnkr1_ShiftingTotal": 123.45,
"bnkr1_Total": 987.65,
"bnkr1_CO2EmissionsFactor": 123.45,
"bnkr1_CO2Emissions": 123.45,
"bnkr2_FuelType": "abc123",
"bnkr2_ROB": 987.65,
"bnkr2_Received": 987.65,
"bnkr2_MainEng": 987.65,
"bnkr2_AuxEng": 987.65,
"bnkr2_Adjustment": 123.45,
"bnkr2_Propulsion": 123.45,
"bnkr2_LoadOrDisch": 123.45,
"bnkr2_Heat": 123.45,
"bnkr2_Clean": 987.65,
"bnkr2_Deballast": 987.65,
"bnkr2_Maneuver": 123.45,
"bnkr2_Others": 123.45,
"bnkr2_Igs": 123.45,
"bnkr2_Generator": 987.65,
"bnkr2_AtSeaTotal": 987.65,
"bnkr2_AtSeaPerDay": 987.65,
"bnkr2_InPortTotal": 987.65,
"bnkr2_InPortPerDay": 123.45,
"bnkr2_BerthTotal": 987.65,
"bnkr2_AnchorTotal": 987.65,
"bnkr2_ShiftingTotal": 123.45,
"bnkr2_Total": 987.65,
"bnkr2_CO2EmissionsFactor": 987.65,
"bnkr2_CO2Emissions": 987.65,
"bnkr3_FuelType": "abc123",
"bnkr3_ROB": 987.65,
"bnkr3_Received": 987.65,
"bnkr3_MainEng": 987.65,
"bnkr3_AuxEng": 987.65,
"bnkr3_Adjustment": 123.45,
"bnkr3_Propulsion": 123.45,
"bnkr3_LoadOrDisch": 987.65,
"bnkr3_Heat": 123.45,
"bnkr3_Clean": 987.65,
"bnkr3_Deballast": 987.65,
"bnkr3_Maneuver": 123.45,
"bnkr3_Others": 123.45,
"bnkr3_Igs": 987.65,
"bnkr3_Generator": 987.65,
"bnkr3_AtSeaTotal": 987.65,
"bnkr3_AtSeaPerDay": 987.65,
"bnkr3_InPortTotal": 123.45,
"bnkr3_InPortPerDay": 987.65,
"bnkr3_BerthTotal": 123.45,
"bnkr3_AnchorTotal": 123.45,
"bnkr3_ShiftingTotal": 123.45,
"bnkr3_Total": 123.45,
"bnkr3_CO2EmissionsFactor": 123.45,
"bnkr3_CO2Emissions": 123.45,
"bnkr4_FuelType": "abc123",
"bnkr4_ROB": 987.65,
"bnkr4_Received": 987.65,
"bnkr4_MainEng": 123.45,
"bnkr4_AuxEng": 123.45,
"bnkr4_Adjustment": 123.45,
"bnkr4_Propulsion": 123.45,
"bnkr4_LoadOrDisch": 123.45,
"bnkr4_Heat": 123.45,
"bnkr4_Clean": 123.45,
"bnkr4_Deballast": 123.45,
"bnkr4_Maneuver": 123.45,
"bnkr4_Others": 987.65,
"bnkr4_Igs": 987.65,
"bnkr4_Generator": 987.65,
"bnkr4_AtSeaTotal": 987.65,
"bnkr4_AtSeaPerDay": 987.65,
"bnkr4_InPortTotal": 123.45,
"bnkr4_InPortPerDay": 123.45,
"bnkr4_BerthTotal": 123.45,
"bnkr4_AnchorTotal": 987.65,
"bnkr4_ShiftingTotal": 123.45,
"bnkr4_Total": 987.65,
"bnkr4_CO2EmissionsFactor": 123.45,
"bnkr4_CO2Emissions": 123.45,
"bnkr5_FuelType": "xyz789",
"bnkr5_ROB": 987.65,
"bnkr5_Received": 987.65,
"bnkr5_MainEng": 123.45,
"bnkr5_AuxEng": 123.45,
"bnkr5_Adjustment": 987.65,
"bnkr5_Propulsion": 987.65,
"bnkr5_LoadOrDisch": 987.65,
"bnkr5_Heat": 987.65,
"bnkr5_Clean": 123.45,
"bnkr5_Deballast": 987.65,
"bnkr5_Maneuver": 123.45,
"bnkr5_Others": 987.65,
"bnkr5_Igs": 987.65,
"bnkr5_Generator": 987.65,
"bnkr5_AtSeaTotal": 123.45,
"bnkr5_AtSeaPerDay": 123.45,
"bnkr5_InPortTotal": 987.65,
"bnkr5_InPortPerDay": 987.65,
"bnkr5_BerthTotal": 987.65,
"bnkr5_AnchorTotal": 987.65,
"bnkr5_ShiftingTotal": 987.65,
"bnkr5_Total": 123.45,
"bnkr5_CO2EmissionsFactor": 987.65,
"bnkr5_CO2Emissions": 123.45,
"bnkr6_FuelType": "abc123",
"bnkr6_ROB": 987.65,
"bnkr6_Received": 987.65,
"bnkr6_MainEng": 987.65,
"bnkr6_AuxEng": 987.65,
"bnkr6_Adjustment": 123.45,
"bnkr6_Propulsion": 987.65,
"bnkr6_LoadOrDisch": 987.65,
"bnkr6_Heat": 987.65,
"bnkr6_Clean": 987.65,
"bnkr6_Deballast": 987.65,
"bnkr6_Maneuver": 987.65,
"bnkr6_Others": 123.45,
"bnkr6_Igs": 987.65,
"bnkr6_Generator": 987.65,
"bnkr6_AtSeaTotal": 123.45,
"bnkr6_AtSeaPerDay": 123.45,
"bnkr6_InPortTotal": 987.65,
"bnkr6_InPortPerDay": 123.45,
"bnkr6_BerthTotal": 123.45,
"bnkr6_AnchorTotal": 987.65,
"bnkr6_ShiftingTotal": 123.45,
"bnkr6_Total": 987.65,
"bnkr6_CO2EmissionsFactor": 987.65,
"bnkr6_CO2Emissions": 123.45,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageLegSummary
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
companyCode - String
|
|
fromGMT - Date
|
|
toGMT - Date
|
|
fromPortSeq - Int
|
|
fromPortNo - Int
|
|
fromPortName - String
|
|
fromPortUNCode - String
|
|
fromPortFunc - String
|
|
fromPortBLQty - Float
|
|
fromPortCountry - String
|
|
toPortSeq - Int
|
|
toPortNo - Int
|
|
toPortName - String
|
|
toPortUNCode - String
|
|
toPortFunc - String
|
|
toPortBLQty - Float
|
|
toPortCountry - String
|
|
portion - Float
|
|
elapsedHours - Float
|
|
reportingHours - Float
|
|
steamingHours - Float
|
|
steamingDistance - Float
|
|
inPortHours - Float
|
|
inPortDistance - Float
|
|
berthHours - Float
|
|
berthDistance - Float
|
|
anchorHours - Float
|
|
anchorDistance - Float
|
|
shiftingHours - Float
|
|
shiftingDistance - Float
|
|
distance - Float
|
|
vesselSpeed - Float
|
|
displacement - Float
|
|
deadweight - Float
|
|
constant - Float
|
|
onboardQty - Float
|
|
eEOI - Float
|
|
bnkr1_FuelType - String
|
|
bnkr1_AtSeaTotal - Float
|
|
bnkr1_AtSeaPerDay - Float
|
|
bnkr1_InPortTotal - Float
|
|
bnkr1_InPortPerDay - Float
|
|
bnkr1_BerthTotal - Float
|
|
bnkr1_AnchorTotal - Float
|
|
bnkr1_ShiftingTotal - Float
|
|
bnkr1_Total - Float
|
|
bnkr1_CO2EmissionsFactor - Float
|
|
bnkr1_CO2Emissions - Float
|
|
bnkr2_FuelType - String
|
|
bnkr2_AtSeaTotal - Float
|
|
bnkr2_AtSeaPerDay - Float
|
|
bnkr2_InPortTotal - Float
|
|
bnkr2_InPortPerDay - Float
|
|
bnkr2_BerthTotal - Float
|
|
bnkr2_AnchorTotal - Float
|
|
bnkr2_ShiftingTotal - Float
|
|
bnkr2_Total - Float
|
|
bnkr2_CO2EmissionsFactor - Float
|
|
bnkr2_CO2Emissions - Float
|
|
bnkr3_FuelType - String
|
|
bnkr3_AtSeaTotal - Float
|
|
bnkr3_AtSeaPerDay - Float
|
|
bnkr3_InPortTotal - Float
|
|
bnkr3_InPortPerDay - Float
|
|
bnkr3_BerthTotal - Float
|
|
bnkr3_AnchorTotal - Float
|
|
bnkr3_ShiftingTotal - Float
|
|
bnkr3_Total - Float
|
|
bnkr3_CO2EmissionsFactor - Float
|
|
bnkr3_CO2Emissions - Float
|
|
bnkr4_FuelType - String
|
|
bnkr4_AtSeaTotal - Float
|
|
bnkr4_AtSeaPerDay - Float
|
|
bnkr4_InPortTotal - Float
|
|
bnkr4_InPortPerDay - Float
|
|
bnkr4_BerthTotal - Float
|
|
bnkr4_AnchorTotal - Float
|
|
bnkr4_ShiftingTotal - Float
|
|
bnkr4_Total - Float
|
|
bnkr4_CO2EmissionsFactor - Float
|
|
bnkr4_CO2Emissions - Float
|
|
bnkr5_FuelType - String
|
|
bnkr5_AtSeaTotal - Float
|
|
bnkr5_AtSeaPerDay - Float
|
|
bnkr5_InPortTotal - Float
|
|
bnkr5_InPortPerDay - Float
|
|
bnkr5_BerthTotal - Float
|
|
bnkr5_AnchorTotal - Float
|
|
bnkr5_ShiftingTotal - Float
|
|
bnkr5_Total - Float
|
|
bnkr5_CO2EmissionsFactor - Float
|
|
bnkr5_CO2Emissions - Float
|
|
bnkr6_FuelType - String
|
|
bnkr6_AtSeaTotal - Float
|
|
bnkr6_AtSeaPerDay - Float
|
|
bnkr6_InPortTotal - Float
|
|
bnkr6_InPortPerDay - Float
|
|
bnkr6_BerthTotal - Float
|
|
bnkr6_AnchorTotal - Float
|
|
bnkr6_ShiftingTotal - Float
|
|
bnkr6_Total - Float
|
|
bnkr6_CO2EmissionsFactor - Float
|
|
bnkr6_CO2Emissions - Float
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 987,
"companyCode": "abc123",
"fromGMT": "2007-12-03",
"toGMT": "2007-12-03",
"fromPortSeq": 987,
"fromPortNo": 987,
"fromPortName": "abc123",
"fromPortUNCode": "xyz789",
"fromPortFunc": "abc123",
"fromPortBLQty": 123.45,
"fromPortCountry": "xyz789",
"toPortSeq": 987,
"toPortNo": 987,
"toPortName": "xyz789",
"toPortUNCode": "xyz789",
"toPortFunc": "abc123",
"toPortBLQty": 987.65,
"toPortCountry": "abc123",
"portion": 987.65,
"elapsedHours": 987.65,
"reportingHours": 987.65,
"steamingHours": 123.45,
"steamingDistance": 123.45,
"inPortHours": 987.65,
"inPortDistance": 987.65,
"berthHours": 987.65,
"berthDistance": 987.65,
"anchorHours": 123.45,
"anchorDistance": 123.45,
"shiftingHours": 987.65,
"shiftingDistance": 987.65,
"distance": 987.65,
"vesselSpeed": 123.45,
"displacement": 123.45,
"deadweight": 123.45,
"constant": 123.45,
"onboardQty": 123.45,
"eEOI": 123.45,
"bnkr1_FuelType": "xyz789",
"bnkr1_AtSeaTotal": 987.65,
"bnkr1_AtSeaPerDay": 123.45,
"bnkr1_InPortTotal": 987.65,
"bnkr1_InPortPerDay": 123.45,
"bnkr1_BerthTotal": 987.65,
"bnkr1_AnchorTotal": 123.45,
"bnkr1_ShiftingTotal": 987.65,
"bnkr1_Total": 123.45,
"bnkr1_CO2EmissionsFactor": 987.65,
"bnkr1_CO2Emissions": 987.65,
"bnkr2_FuelType": "xyz789",
"bnkr2_AtSeaTotal": 123.45,
"bnkr2_AtSeaPerDay": 123.45,
"bnkr2_InPortTotal": 123.45,
"bnkr2_InPortPerDay": 987.65,
"bnkr2_BerthTotal": 123.45,
"bnkr2_AnchorTotal": 987.65,
"bnkr2_ShiftingTotal": 123.45,
"bnkr2_Total": 123.45,
"bnkr2_CO2EmissionsFactor": 987.65,
"bnkr2_CO2Emissions": 123.45,
"bnkr3_FuelType": "abc123",
"bnkr3_AtSeaTotal": 123.45,
"bnkr3_AtSeaPerDay": 123.45,
"bnkr3_InPortTotal": 987.65,
"bnkr3_InPortPerDay": 123.45,
"bnkr3_BerthTotal": 987.65,
"bnkr3_AnchorTotal": 987.65,
"bnkr3_ShiftingTotal": 987.65,
"bnkr3_Total": 987.65,
"bnkr3_CO2EmissionsFactor": 987.65,
"bnkr3_CO2Emissions": 987.65,
"bnkr4_FuelType": "abc123",
"bnkr4_AtSeaTotal": 123.45,
"bnkr4_AtSeaPerDay": 987.65,
"bnkr4_InPortTotal": 987.65,
"bnkr4_InPortPerDay": 123.45,
"bnkr4_BerthTotal": 123.45,
"bnkr4_AnchorTotal": 987.65,
"bnkr4_ShiftingTotal": 987.65,
"bnkr4_Total": 123.45,
"bnkr4_CO2EmissionsFactor": 123.45,
"bnkr4_CO2Emissions": 123.45,
"bnkr5_FuelType": "abc123",
"bnkr5_AtSeaTotal": 987.65,
"bnkr5_AtSeaPerDay": 123.45,
"bnkr5_InPortTotal": 987.65,
"bnkr5_InPortPerDay": 987.65,
"bnkr5_BerthTotal": 987.65,
"bnkr5_AnchorTotal": 987.65,
"bnkr5_ShiftingTotal": 987.65,
"bnkr5_Total": 123.45,
"bnkr5_CO2EmissionsFactor": 987.65,
"bnkr5_CO2Emissions": 123.45,
"bnkr6_FuelType": "xyz789",
"bnkr6_AtSeaTotal": 123.45,
"bnkr6_AtSeaPerDay": 987.65,
"bnkr6_InPortTotal": 987.65,
"bnkr6_InPortPerDay": 123.45,
"bnkr6_BerthTotal": 987.65,
"bnkr6_AnchorTotal": 987.65,
"bnkr6_ShiftingTotal": 987.65,
"bnkr6_Total": 987.65,
"bnkr6_CO2EmissionsFactor": 987.65,
"bnkr6_CO2Emissions": 123.45,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyagePnl
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
periodFromGmt - Date
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
periodToGmt - Date
|
|
periodRangeGmt - String
|
|
loadPortDays - Float
|
|
dischPortDays - Float
|
|
totalPortDays - Float
|
|
periodOpsBallastDays - Float
|
|
periodOpsLadenDays - Float
|
|
periodOpsWaitingDays - Float
|
|
periodOpsDischPortDays - Float
|
|
periodOpsLoadPortDays - Float
|
|
periodOpsBunkeringDays - Float
|
|
periodOpsIdleDays - Float
|
|
periodOpsPortDays - Float
|
|
periodOpsSeaDays - Float
|
|
voyageStatus - String
|
|
portionPct - Float
|
|
onHireDays - Float
|
|
waitingBunkerCost - Float
|
|
waitingCost - Float
|
|
month - Date
|
|
monthlyInterval - Boolean
|
|
emissionExpenses - Float
|
|
emissionExpensesRebill - Float
|
|
calcOptions_ApplyTcHire - Boolean
|
|
calcOptions_ApplyXHireToPeriod - Boolean
|
|
calcOptions_ApplyOffHire - Boolean
|
|
calcOptions_ApplyBallastBonus - Boolean
|
|
calcOptions_ApplyTcBunkerAdjToPeriod - Boolean
|
|
calcOptions_ApplyTcExpensesToPeriod - Boolean
|
|
calcOptions_ApplyBunkerCons - Boolean
|
|
calcOptions_ApplyOtherRevExpToPeriod - Boolean
|
|
calcOptions_ApplyPortExpensesToPeriod - Boolean
|
|
calcOptions_ApplyDemurrageToPeriod - Boolean
|
|
calcOptions_AdjustForOffHire - Boolean
|
|
calcOptions_AdjustForWaiting - Boolean
|
|
calcOptions_AdjustForBallastDays - Boolean
|
|
calcOptions_AdjustForDemurrageDays - Boolean
|
|
calcOptions_ReconcileBunkers - Boolean
|
|
calcOptions_ExcludeRunningCostsTCI - Boolean
|
|
calcOptions_ExcludeHireRelatedItemsTCO - Boolean
|
|
calcOptions_AccrueSettledLinkedTrades - Boolean
|
|
calcOptions_ApplyInternalFreightRevenueToPeriod - Boolean
|
|
calcOptions_CapitalizeAmortizeContractFulfillmentCosts - Boolean
|
|
calcOptions_ApplyTcRebillsToPeriod - Boolean
|
|
calcOptions_ApplyEmissionExpensesToPeriod - Boolean
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
tciCode - String
|
|
vesselName - String
|
|
tcoCode - String
|
|
fixtureNo - String
|
|
dataType - String
|
|
entryDateGmt - Date
|
|
oprType - String
|
|
cargoLift - Float
|
|
demCredit - Float
|
|
totalProfitLoss - Float
|
|
tce - Float
|
|
totalVoyageDays - Float
|
|
totalSeaDays - Float
|
|
totalWaitForLaycanDays - Float
|
|
totalWaitForOrdersDays - Float
|
|
vesselType - String
|
|
commenceDateLocal - Date
|
|
completeDateLocal - Date
|
|
commenceDateGmt - Date
|
|
completeDateGmt - Date
|
|
offHireDays - Float
|
|
totalBallastDays - Float
|
|
totalLadenDays - Float
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
snapshotType - String
|
|
snapshotRefDateLocal - Date
|
|
remarks - String
|
|
externalRef - String
|
|
applyTcExpensesToPeriod - Boolean
|
|
applyOtherRevenuesExpensesToPeriod - Boolean
|
|
applyAdditionalHireToPeriod - Boolean
|
|
applyTcBunkerAdjustmentsToPeriod - Boolean
|
|
applyPortExpensesToPeriod - Boolean
|
|
excludeHireRelatedItemsForLongTermTco - Boolean
|
|
applyInternalFreightRevenueToPeriod - Boolean
|
|
capitalizeAmortizeCostsPriorToPerformingPeriod - Boolean
|
|
applyTcHireToPeriod - Boolean
|
|
applyOffHireWaitingToPeriod - Boolean
|
|
applyBallastBonusToPeriod - Boolean
|
|
adjustPortionForOffHire - Boolean
|
|
adjustPortionForWaitingTime - Boolean
|
|
excludeRunningCostsForLongTermTcOrOv - Boolean
|
|
applyBunkerConsumptionToPeriod - Boolean
|
|
reconcileBunkerRobForCurrentVoyages - Boolean
|
|
adjustPortionForBallastDays - Boolean
|
|
applyDemurrageToPeriod - Boolean
|
|
adjustPortionForDemurrageDays - Boolean
|
|
accrueSettledLinkedTrades - Boolean
|
|
totalIdleDays - Float
|
|
totalBunkeringDays - Float
|
|
totalWaitingDays - Float
|
|
revenues - Float
|
|
expenses - Float
|
|
runningCost - Float
|
|
freight - Float
|
|
demurrage - Float
|
|
despatch - Float
|
|
freightComm - Float
|
|
freightAddComm - Float
|
|
freightTax - Float
|
|
freightCargoLoss - Float
|
|
demurrageComm - Float
|
|
demurrageAddComm - Float
|
|
rebills - Float
|
|
miscRevenue - Float
|
|
nonAccRevenue - Float
|
|
vesselDailyCost - Float
|
|
bunkers - Float
|
|
hire - Float
|
|
hireComm - Float
|
|
hireAddComm - Float
|
|
tciBunkerAdjustment - Float
|
|
offHire - Float
|
|
offHireBunkers - Float
|
|
offHireAddComm - Float
|
|
offHireComm - Float
|
|
cve - Float
|
|
offHireCve - Float
|
|
ballastBonus - Float
|
|
holdCleaning - Float
|
|
tciAdminFee - Float
|
|
tciMiscExpenses - Float
|
|
transshipmentCost - Float
|
|
lighteringCost - Float
|
|
tcoHire - Float
|
|
tcoHireComm - Float
|
|
tcoHireAddComm - Float
|
|
tcoBunkerAdjustment - Float
|
|
tcoCve - Float
|
|
tcoOffHire - Float
|
|
tcoOffHireBunkers - Float
|
|
tcoOffHireComm - Float
|
|
tcoOffHireAddComm - Float
|
|
tcoOffHireCve - Float
|
|
tcoBallastBonus - Float
|
|
tcoHoldCleaning - Float
|
|
tcoAdminFee - Float
|
|
tcoMiscRevenues - Float
|
|
portExpenses - Float
|
|
cargoExpenses - Float
|
|
surveyExpenses - Float
|
|
tolls - Float
|
|
miscExpenses - Float
|
|
nonAccExpenses - Float
|
|
vCInFreight - Float
|
|
vCInFreightComm - Float
|
|
vCInFreightAddComm - Float
|
|
vCInFreightTax - Float
|
|
vCInFreightCargoLoss - Float
|
|
vCInDemurrage - Float
|
|
vCInDemComm - Float
|
|
vCInDemAddComm - Float
|
|
vCInDespatch - Float
|
|
bareboatHire - Float
|
|
bareboatOffHire - Float
|
|
bareboatAddComm - Float
|
|
bareboatOffHireAddComm - Float
|
|
bareboatComm - Float
|
|
bareboatVoyageExpenses - Float
|
|
bareboatMiscExpenses - Float
|
|
bareboatAdjustments - Float
|
|
bareboatOffHireBunkers - Float
|
|
adminFees - Float
|
|
revenueAdjustment - Float
|
|
expenseAdjustment - Float
|
|
uncategorizedAdjustment - Float
|
|
interserviceRevenue - Float
|
|
exchangeDifference - Float
|
|
tciGratuities - Float
|
|
tciVictualling - Float
|
|
tciLashingandStowage - Float
|
|
tciReprExpAllowances - Float
|
|
tciOffHireGratuities - Float
|
|
tciOffHireVictualling - Float
|
|
tciOffHireLashingandStowage - Float
|
|
tciOffHireReprExpAllowances - Float
|
|
tcoGratuities - Float
|
|
tcoVictualling - Float
|
|
tcoLashingandStowage - Float
|
|
tcoReprExpAllowances - Float
|
|
tcoOffHireGratuities - Float
|
|
tcoOffHireVictualling - Float
|
|
tcoOffHireLashingandStowage - Float
|
|
tcoOffHireReprExpAllowances - Float
|
|
profitShare - Float
|
|
premiumIncome - Float
|
|
estimateID - String
|
|
cargoShortName - String
|
|
firstChartererShortName - String
|
|
firstLoadPortName - String
|
|
lastDischPortName - String
|
|
baseCurrency - String
|
|
forecast - Boolean
|
|
claimPending - Boolean
|
|
legalHold - Boolean
|
|
cancel - Boolean
|
|
voyageStatusCode - String
|
|
bunkerSwaps - Float
|
|
voyageReference - String
|
|
marketValuationRate - Float
|
|
marketValuationRateUnit - String
|
|
marketValuationSymbol - String
|
|
marketValuationCorrelation - Float
|
|
marketValuationAdjustment - Float
|
|
marketValuationLumpsumAmount - Float
|
|
marketResultIn - Float
|
|
marketResultOut - Float
|
|
lastNoonReportGmt - Date
|
|
vessel - Vessel
|
|
voyage - Voyage
|
|
voyagePnlDrilldowns - [VoyagePnlDrilldown]
|
|
voyagePnlDetails - [VoyagePnlDetail]
|
|
voyagePnlCargos - [VoyagePnlCargo]
|
|
voyagePnlItineraryLines - [VoyagePnlItineraryLine]
|
|
voyagePnlBunkers - [VoyagePnlBunker]
|
|
voyageItineraryLoads - [VoyagePnlItineraryLine]
|
|
voyageItineraryDischarges - [VoyagePnlItineraryLine]
|
|
exchangeRates - [ExchangeRate]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"periodFromGmt": "2007-12-03",
"customFieldByID": Any,
"customField": Any,
"periodToGmt": "2007-12-03",
"periodRangeGmt": "abc123",
"loadPortDays": 987.65,
"dischPortDays": 123.45,
"totalPortDays": 123.45,
"periodOpsBallastDays": 987.65,
"periodOpsLadenDays": 123.45,
"periodOpsWaitingDays": 123.45,
"periodOpsDischPortDays": 123.45,
"periodOpsLoadPortDays": 123.45,
"periodOpsBunkeringDays": 987.65,
"periodOpsIdleDays": 987.65,
"periodOpsPortDays": 123.45,
"periodOpsSeaDays": 987.65,
"voyageStatus": "xyz789",
"portionPct": 123.45,
"onHireDays": 123.45,
"waitingBunkerCost": 987.65,
"waitingCost": 987.65,
"month": "2007-12-03",
"monthlyInterval": true,
"emissionExpenses": 123.45,
"emissionExpensesRebill": 123.45,
"calcOptions_ApplyTcHire": true,
"calcOptions_ApplyXHireToPeriod": true,
"calcOptions_ApplyOffHire": false,
"calcOptions_ApplyBallastBonus": true,
"calcOptions_ApplyTcBunkerAdjToPeriod": false,
"calcOptions_ApplyTcExpensesToPeriod": true,
"calcOptions_ApplyBunkerCons": true,
"calcOptions_ApplyOtherRevExpToPeriod": false,
"calcOptions_ApplyPortExpensesToPeriod": true,
"calcOptions_ApplyDemurrageToPeriod": true,
"calcOptions_AdjustForOffHire": false,
"calcOptions_AdjustForWaiting": false,
"calcOptions_AdjustForBallastDays": false,
"calcOptions_AdjustForDemurrageDays": true,
"calcOptions_ReconcileBunkers": true,
"calcOptions_ExcludeRunningCostsTCI": true,
"calcOptions_ExcludeHireRelatedItemsTCO": true,
"calcOptions_AccrueSettledLinkedTrades": false,
"calcOptions_ApplyInternalFreightRevenueToPeriod": true,
"calcOptions_CapitalizeAmortizeContractFulfillmentCosts": false,
"calcOptions_ApplyTcRebillsToPeriod": false,
"calcOptions_ApplyEmissionExpensesToPeriod": false,
"vesselCode": "xyz789",
"voyageNo": 123,
"tciCode": "abc123",
"vesselName": "xyz789",
"tcoCode": "abc123",
"fixtureNo": "xyz789",
"dataType": "xyz789",
"entryDateGmt": "2007-12-03",
"oprType": "xyz789",
"cargoLift": 123.45,
"demCredit": 123.45,
"totalProfitLoss": 123.45,
"tce": 987.65,
"totalVoyageDays": 987.65,
"totalSeaDays": 987.65,
"totalWaitForLaycanDays": 123.45,
"totalWaitForOrdersDays": 123.45,
"vesselType": "xyz789",
"commenceDateLocal": "2007-12-03",
"completeDateLocal": "2007-12-03",
"commenceDateGmt": "2007-12-03",
"completeDateGmt": "2007-12-03",
"offHireDays": 123.45,
"totalBallastDays": 123.45,
"totalLadenDays": 123.45,
"lastUser": "xyz789",
"lastUpdateGmt": "2007-12-03",
"snapshotType": "xyz789",
"snapshotRefDateLocal": "2007-12-03",
"remarks": "abc123",
"externalRef": "xyz789",
"applyTcExpensesToPeriod": false,
"applyOtherRevenuesExpensesToPeriod": true,
"applyAdditionalHireToPeriod": true,
"applyTcBunkerAdjustmentsToPeriod": false,
"applyPortExpensesToPeriod": false,
"excludeHireRelatedItemsForLongTermTco": true,
"applyInternalFreightRevenueToPeriod": false,
"capitalizeAmortizeCostsPriorToPerformingPeriod": true,
"applyTcHireToPeriod": true,
"applyOffHireWaitingToPeriod": true,
"applyBallastBonusToPeriod": true,
"adjustPortionForOffHire": true,
"adjustPortionForWaitingTime": true,
"excludeRunningCostsForLongTermTcOrOv": false,
"applyBunkerConsumptionToPeriod": true,
"reconcileBunkerRobForCurrentVoyages": false,
"adjustPortionForBallastDays": false,
"applyDemurrageToPeriod": false,
"adjustPortionForDemurrageDays": true,
"accrueSettledLinkedTrades": true,
"totalIdleDays": 123.45,
"totalBunkeringDays": 987.65,
"totalWaitingDays": 123.45,
"revenues": 123.45,
"expenses": 123.45,
"runningCost": 123.45,
"freight": 987.65,
"demurrage": 987.65,
"despatch": 123.45,
"freightComm": 123.45,
"freightAddComm": 987.65,
"freightTax": 987.65,
"freightCargoLoss": 123.45,
"demurrageComm": 987.65,
"demurrageAddComm": 987.65,
"rebills": 987.65,
"miscRevenue": 987.65,
"nonAccRevenue": 987.65,
"vesselDailyCost": 123.45,
"bunkers": 987.65,
"hire": 987.65,
"hireComm": 987.65,
"hireAddComm": 987.65,
"tciBunkerAdjustment": 987.65,
"offHire": 123.45,
"offHireBunkers": 987.65,
"offHireAddComm": 123.45,
"offHireComm": 123.45,
"cve": 123.45,
"offHireCve": 987.65,
"ballastBonus": 123.45,
"holdCleaning": 987.65,
"tciAdminFee": 123.45,
"tciMiscExpenses": 123.45,
"transshipmentCost": 123.45,
"lighteringCost": 123.45,
"tcoHire": 987.65,
"tcoHireComm": 123.45,
"tcoHireAddComm": 987.65,
"tcoBunkerAdjustment": 987.65,
"tcoCve": 123.45,
"tcoOffHire": 123.45,
"tcoOffHireBunkers": 987.65,
"tcoOffHireComm": 987.65,
"tcoOffHireAddComm": 987.65,
"tcoOffHireCve": 987.65,
"tcoBallastBonus": 123.45,
"tcoHoldCleaning": 987.65,
"tcoAdminFee": 123.45,
"tcoMiscRevenues": 987.65,
"portExpenses": 123.45,
"cargoExpenses": 123.45,
"surveyExpenses": 987.65,
"tolls": 987.65,
"miscExpenses": 987.65,
"nonAccExpenses": 123.45,
"vCInFreight": 987.65,
"vCInFreightComm": 123.45,
"vCInFreightAddComm": 987.65,
"vCInFreightTax": 987.65,
"vCInFreightCargoLoss": 987.65,
"vCInDemurrage": 123.45,
"vCInDemComm": 987.65,
"vCInDemAddComm": 987.65,
"vCInDespatch": 987.65,
"bareboatHire": 987.65,
"bareboatOffHire": 987.65,
"bareboatAddComm": 987.65,
"bareboatOffHireAddComm": 987.65,
"bareboatComm": 123.45,
"bareboatVoyageExpenses": 987.65,
"bareboatMiscExpenses": 123.45,
"bareboatAdjustments": 987.65,
"bareboatOffHireBunkers": 987.65,
"adminFees": 987.65,
"revenueAdjustment": 987.65,
"expenseAdjustment": 987.65,
"uncategorizedAdjustment": 987.65,
"interserviceRevenue": 123.45,
"exchangeDifference": 987.65,
"tciGratuities": 987.65,
"tciVictualling": 123.45,
"tciLashingandStowage": 987.65,
"tciReprExpAllowances": 123.45,
"tciOffHireGratuities": 123.45,
"tciOffHireVictualling": 987.65,
"tciOffHireLashingandStowage": 123.45,
"tciOffHireReprExpAllowances": 987.65,
"tcoGratuities": 123.45,
"tcoVictualling": 123.45,
"tcoLashingandStowage": 987.65,
"tcoReprExpAllowances": 123.45,
"tcoOffHireGratuities": 987.65,
"tcoOffHireVictualling": 987.65,
"tcoOffHireLashingandStowage": 123.45,
"tcoOffHireReprExpAllowances": 123.45,
"profitShare": 987.65,
"premiumIncome": 123.45,
"estimateID": "abc123",
"cargoShortName": "abc123",
"firstChartererShortName": "xyz789",
"firstLoadPortName": "abc123",
"lastDischPortName": "xyz789",
"baseCurrency": "abc123",
"forecast": true,
"claimPending": false,
"legalHold": true,
"cancel": false,
"voyageStatusCode": "abc123",
"bunkerSwaps": 123.45,
"voyageReference": "xyz789",
"marketValuationRate": 123.45,
"marketValuationRateUnit": "abc123",
"marketValuationSymbol": "xyz789",
"marketValuationCorrelation": 987.65,
"marketValuationAdjustment": 987.65,
"marketValuationLumpsumAmount": 987.65,
"marketResultIn": 123.45,
"marketResultOut": 987.65,
"lastNoonReportGmt": "2007-12-03",
"vessel": Vessel,
"voyage": Voyage,
"voyagePnlDrilldowns": [VoyagePnlDrilldown],
"voyagePnlDetails": [VoyagePnlDetail],
"voyagePnlCargos": [VoyagePnlCargo],
"voyagePnlItineraryLines": [VoyagePnlItineraryLine],
"voyagePnlBunkers": [VoyagePnlBunker],
"voyageItineraryLoads": [VoyagePnlItineraryLine],
"voyageItineraryDischarges": [VoyagePnlItineraryLine],
"exchangeRates": [ExchangeRate],
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyagePnlBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
lastUpdateGmt - Date
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
seq - Int
|
|
description - String
|
|
receivedDateGmt - Date
|
|
portName - String
|
|
snapshotType - String
|
|
snapshotRefDateLocal - Date
|
|
entryDateGmt - Date
|
|
lastUserID - String
|
|
voyagePnl - VoyagePnl
|
|
voyagePnlBunkerDetails - [VoyagePnlBunkerDetail]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"lastUpdateGmt": "2007-12-03",
"customFieldByID": Any,
"customField": Any,
"vesselCode": "xyz789",
"voyageNo": 987,
"seq": 987,
"description": "xyz789",
"receivedDateGmt": "2007-12-03",
"portName": "xyz789",
"snapshotType": "abc123",
"snapshotRefDateLocal": "2007-12-03",
"entryDateGmt": "2007-12-03",
"lastUserID": "abc123",
"voyagePnl": VoyagePnl,
"voyagePnlBunkerDetails": [VoyagePnlBunkerDetail],
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyagePnlBunkerDetail
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
lastUpdateGmt - Date
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
seq - Int
|
|
snapshotType - String
|
|
snapshotRefDateLocal - Date
|
|
fuelType - String
|
|
qty - Float
|
|
price - Float
|
|
voyagePnlBunker - VoyagePnlBunker
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"lastUpdateGmt": "2007-12-03",
"customFieldByID": Any,
"customField": Any,
"vesselCode": "abc123",
"voyageNo": 123,
"seq": 123,
"snapshotType": "abc123",
"snapshotRefDateLocal": "2007-12-03",
"fuelType": "abc123",
"qty": 987.65,
"price": 123.45,
"voyagePnlBunker": VoyagePnlBunker,
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
VoyagePnlBunkerDetailFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyagePnlBunkerDetailFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyagePnlBunkerDetailFormQueryWhere
}
VoyagePnlBunkerDetailFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyagePnlBunkerDetailFormQueryWhere!]
|
|
or - [VoyagePnlBunkerDetailFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
snapshotType - StringWhereValueExpression
|
|
snapshotRefDateLocal - DateWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
qty - NumberWhereValueExpression
|
|
price - NumberWhereValueExpression
|
|
voyagePnlBunker - VoyagePnlBunkerFormQueryWhere
|
Example
{
"and": [VoyagePnlBunkerDetailFormQueryWhere],
"or": [VoyagePnlBunkerDetailFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"snapshotType": StringWhereValueExpression,
"snapshotRefDateLocal": DateWhereValueExpression,
"fuelType": StringWhereValueExpression,
"qty": NumberWhereValueExpression,
"price": NumberWhereValueExpression,
"voyagePnlBunker": VoyagePnlBunkerFormQueryWhere
}
VoyagePnlBunkerDetailRelationships
Fields
| Field Name | Description |
|---|---|
voyagePnlBunker - RelationshipDefinition
|
Example
{"voyagePnlBunker": RelationshipDefinition}
VoyagePnlBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyagePnlBunkerFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyagePnlBunkerFormQueryWhere
}
VoyagePnlBunkerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyagePnlBunkerFormQueryWhere!]
|
|
or - [VoyagePnlBunkerFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
receivedDateGmt - DateWhereValueExpression
|
|
portName - StringWhereValueExpression
|
|
snapshotType - StringWhereValueExpression
|
|
snapshotRefDateLocal - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUserID - StringWhereValueExpression
|
|
voyagePnl - VoyagePnlFormQueryWhere
|
Example
{
"and": [VoyagePnlBunkerFormQueryWhere],
"or": [VoyagePnlBunkerFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"receivedDateGmt": DateWhereValueExpression,
"portName": StringWhereValueExpression,
"snapshotType": StringWhereValueExpression,
"snapshotRefDateLocal": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"voyagePnl": VoyagePnlFormQueryWhere
}
VoyagePnlBunkerRelationships
Fields
| Field Name | Description |
|---|---|
voyagePnl - RelationshipDefinition
|
|
voyagePnlBunkerDetails - RelationshipDefinition
|
Example
{
"voyagePnl": RelationshipDefinition,
"voyagePnlBunkerDetails": RelationshipDefinition
}
VoyagePnlCargo
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
dataType - String
|
|
snapshotType - String
|
|
snapshotRefDateLocal - Date
|
|
seq - Int
|
|
berthOrderNo - Int
|
|
portCargoSeq - Int
|
|
fixtureNo - String
|
|
fixtureCargoSeq - Int
|
|
cargoShortName - String
|
|
portFunction - String
|
|
altBLGross - Float
|
|
altShipGross - Float
|
|
lDQty - Float
|
|
api - Float
|
|
productNet - Float
|
|
blQty - Float
|
|
terms - String
|
|
tankName - String
|
|
blDischDate - Date
|
|
blCode - String
|
|
cpUnit - String
|
|
lastUserID - String
|
|
altUnit - String
|
|
lastUpdateGmt - Date
|
|
lDRate - Float
|
|
rateUnit - String
|
|
cargoID - Int
|
|
gradeSeqNo - Int
|
|
voyagePnl - VoyagePnl
|
|
voyagePnlItineraryLine - VoyagePnlItineraryLine
|
|
cargo - Cargo
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 123,
"dataType": "abc123",
"snapshotType": "xyz789",
"snapshotRefDateLocal": "2007-12-03",
"seq": 987,
"berthOrderNo": 987,
"portCargoSeq": 123,
"fixtureNo": "abc123",
"fixtureCargoSeq": 123,
"cargoShortName": "abc123",
"portFunction": "xyz789",
"altBLGross": 987.65,
"altShipGross": 123.45,
"lDQty": 123.45,
"api": 987.65,
"productNet": 123.45,
"blQty": 987.65,
"terms": "abc123",
"tankName": "abc123",
"blDischDate": "2007-12-03",
"blCode": "abc123",
"cpUnit": "xyz789",
"lastUserID": "xyz789",
"altUnit": "xyz789",
"lastUpdateGmt": "2007-12-03",
"lDRate": 123.45,
"rateUnit": "xyz789",
"cargoID": 987,
"gradeSeqNo": 987,
"voyagePnl": VoyagePnl,
"voyagePnlItineraryLine": VoyagePnlItineraryLine,
"cargo": Cargo,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyagePnlCargoDataTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
VoyagePnlCargoDataTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyagePnlCargoDataTypeEnum
|
|
isNot - VoyagePnlCargoDataTypeEnum
|
|
isIn - [VoyagePnlCargoDataTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VoyagePnlCargoFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyagePnlCargoFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyagePnlCargoFormQueryWhere
}
VoyagePnlCargoFormQueryWhere
Fields
Example
{
"and": [VoyagePnlCargoFormQueryWhere],
"or": [VoyagePnlCargoFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"dataType": VoyagePnlCargoDataTypeEnumValueExpression,
"snapshotType": StringWhereValueExpression,
"snapshotRefDateLocal": DateWhereValueExpression,
"seq": NumberWhereValueExpression,
"berthOrderNo": NumberWhereValueExpression,
"portCargoSeq": NumberWhereValueExpression,
"fixtureNo": StringWhereValueExpression,
"fixtureCargoSeq": NumberWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"portFunction": StringWhereValueExpression,
"altBLGross": NumberWhereValueExpression,
"altShipGross": NumberWhereValueExpression,
"lDQty": NumberWhereValueExpression,
"api": NumberWhereValueExpression,
"productNet": NumberWhereValueExpression,
"blQty": NumberWhereValueExpression,
"terms": StringWhereValueExpression,
"tankName": StringWhereValueExpression,
"blDischDate": DateWhereValueExpression,
"blCode": StringWhereValueExpression,
"cpUnit": StringWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"altUnit": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lDRate": NumberWhereValueExpression,
"rateUnit": StringWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"gradeSeqNo": NumberWhereValueExpression,
"voyagePnl": VoyagePnlFormQueryWhere,
"voyagePnlItineraryLine": VoyagePnlItineraryLineFormQueryWhere,
"cargo": CargoFormQueryWhere
}
VoyagePnlCargoRelationships
Fields
| Field Name | Description |
|---|---|
voyagePnl - RelationshipDefinition
|
|
voyagePnlItineraryLine - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
Example
{
"voyagePnl": RelationshipDefinition,
"voyagePnlItineraryLine": RelationshipDefinition,
"cargo": RelationshipDefinition
}
VoyagePnlDataTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
VoyagePnlDataTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyagePnlDataTypeEnum
|
|
isNot - VoyagePnlDataTypeEnum
|
|
isIn - [VoyagePnlDataTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VoyagePnlDetail
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
portSeqNo - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
pnlCategory - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
seq - Int
|
|
dataType - String
|
|
source - String
|
|
portNo - Int
|
|
periodFromGmt - Date
|
|
periodToGmt - Date
|
|
rateBase - Float
|
|
billCode - String
|
|
amountCurr - Float
|
|
amountBase - Float
|
|
description - String
|
|
vendorType - String
|
|
vendorShortName - String
|
|
entryDateGmt - Date
|
|
lastUserID - String
|
|
remarks - String
|
|
taxCode - String
|
|
taxRate - Float
|
|
companyCode - String
|
|
subCode - String
|
|
percentage - Float
|
|
rateUnit - String
|
|
qtyUnit - String
|
|
accountType - String
|
|
currency - String
|
|
invoiceNo - String
|
|
account - String
|
|
portFunction - String
|
|
accountingDate - Date
|
|
transNo - Int
|
|
snapshotType - String
|
|
snapshotRefDateLocal - Date
|
|
pnlCategoryStored - String
|
|
drillSeq - Int
|
|
cargoID - Int
|
|
externalRef - String
|
|
lastUpdateGmt - Date
|
|
gradeSeqNo - Int
|
|
cargoShortName - String
|
|
rebillTransNo - Int
|
|
rebillSeq - Int
|
|
exchangeRate - Float
|
|
linkedItinerarySeq - Int
|
|
voyagePnl - VoyagePnl
|
|
accountLedger - ChartOfAccounts
|
|
voyagePnlItineraryLine - VoyagePnlItineraryLine
|
|
voyagePnlDrilldown - VoyagePnlDrilldown
|
|
parentDrilldownItem - VoyagePnlDrilldown
|
|
rootDrilldownItem - VoyagePnlDrilldown
|
|
rootDrilldownItemStored - VoyagePnlDrilldown
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"portSeqNo": 123,
"customFieldByID": Any,
"customField": Any,
"pnlCategory": "abc123",
"vesselCode": "xyz789",
"voyageNo": 987,
"seq": 987,
"dataType": "abc123",
"source": "abc123",
"portNo": 123,
"periodFromGmt": "2007-12-03",
"periodToGmt": "2007-12-03",
"rateBase": 123.45,
"billCode": "xyz789",
"amountCurr": 123.45,
"amountBase": 123.45,
"description": "abc123",
"vendorType": "xyz789",
"vendorShortName": "abc123",
"entryDateGmt": "2007-12-03",
"lastUserID": "abc123",
"remarks": "xyz789",
"taxCode": "abc123",
"taxRate": 123.45,
"companyCode": "xyz789",
"subCode": "xyz789",
"percentage": 123.45,
"rateUnit": "xyz789",
"qtyUnit": "xyz789",
"accountType": "abc123",
"currency": "abc123",
"invoiceNo": "xyz789",
"account": "abc123",
"portFunction": "xyz789",
"accountingDate": "2007-12-03",
"transNo": 987,
"snapshotType": "xyz789",
"snapshotRefDateLocal": "2007-12-03",
"pnlCategoryStored": "xyz789",
"drillSeq": 987,
"cargoID": 123,
"externalRef": "xyz789",
"lastUpdateGmt": "2007-12-03",
"gradeSeqNo": 987,
"cargoShortName": "xyz789",
"rebillTransNo": 123,
"rebillSeq": 987,
"exchangeRate": 987.65,
"linkedItinerarySeq": 987,
"voyagePnl": VoyagePnl,
"accountLedger": ChartOfAccounts,
"voyagePnlItineraryLine": VoyagePnlItineraryLine,
"voyagePnlDrilldown": VoyagePnlDrilldown,
"parentDrilldownItem": VoyagePnlDrilldown,
"rootDrilldownItem": VoyagePnlDrilldown,
"rootDrilldownItemStored": VoyagePnlDrilldown,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
VoyagePnlDetailAccountTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
VoyagePnlDetailAccountTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyagePnlDetailAccountTypeEnum
|
|
isNot - VoyagePnlDetailAccountTypeEnum
|
|
isIn - [VoyagePnlDetailAccountTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VoyagePnlDetailDataTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
VoyagePnlDetailDataTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyagePnlDetailDataTypeEnum
|
|
isNot - VoyagePnlDetailDataTypeEnum
|
|
isIn - [VoyagePnlDetailDataTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VoyagePnlDetailFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyagePnlDetailFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyagePnlDetailFormQueryWhere
}
VoyagePnlDetailFormQueryWhere
Fields
Example
{
"and": [VoyagePnlDetailFormQueryWhere],
"or": [VoyagePnlDetailFormQueryWhere],
"rawExpression": "xyz789",
"portSeqNo": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"dataType": VoyagePnlDetailDataTypeEnumValueExpression,
"source": StringWhereValueExpression,
"portNo": NumberWhereValueExpression,
"periodFromGmt": DateWhereValueExpression,
"periodToGmt": DateWhereValueExpression,
"rateBase": NumberWhereValueExpression,
"billCode": StringWhereValueExpression,
"amountCurr": NumberWhereValueExpression,
"amountBase": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"vendorType": StringWhereValueExpression,
"vendorShortName": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"taxCode": StringWhereValueExpression,
"taxRate": NumberWhereValueExpression,
"companyCode": StringWhereValueExpression,
"subCode": StringWhereValueExpression,
"percentage": NumberWhereValueExpression,
"rateUnit": StringWhereValueExpression,
"qtyUnit": StringWhereValueExpression,
"accountType": VoyagePnlDetailAccountTypeEnumValueExpression,
"currency": StringWhereValueExpression,
"invoiceNo": StringWhereValueExpression,
"account": StringWhereValueExpression,
"portFunction": StringWhereValueExpression,
"accountingDate": DateWhereValueExpression,
"transNo": NumberWhereValueExpression,
"snapshotType": StringWhereValueExpression,
"snapshotRefDateLocal": DateWhereValueExpression,
"pnlCategoryStored": VoyagePnlDetailPnlCategoryStoredEnumValueExpression,
"drillSeq": NumberWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"externalRef": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"gradeSeqNo": NumberWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"rebillTransNo": NumberWhereValueExpression,
"rebillSeq": NumberWhereValueExpression,
"exchangeRate": NumberWhereValueExpression,
"linkedItinerarySeq": NumberWhereValueExpression,
"voyagePnl": VoyagePnlFormQueryWhere,
"accountLedger": ChartOfAccountsFormQueryWhere,
"voyagePnlItineraryLine": VoyagePnlItineraryLineFormQueryWhere,
"voyagePnlDrilldown": VoyagePnlDrilldownFormQueryWhere,
"parentDrilldownItem": VoyagePnlDrilldownFormQueryWhere,
"rootDrilldownItem": VoyagePnlDrilldownFormQueryWhere,
"rootDrilldownItemStored": VoyagePnlDrilldownFormQueryWhere
}
VoyagePnlDetailPnlCategoryStoredEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
VoyagePnlDetailPnlCategoryStoredEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyagePnlDetailPnlCategoryStoredEnum
|
|
isNot - VoyagePnlDetailPnlCategoryStoredEnum
|
|
isIn - [VoyagePnlDetailPnlCategoryStoredEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
VoyagePnlDetailRelationships
Fields
| Field Name | Description |
|---|---|
voyagePnl - RelationshipDefinition
|
|
accountLedger - RelationshipDefinition
|
|
voyagePnlItineraryLine - RelationshipDefinition
|
|
voyagePnlDrilldown - RelationshipDefinition
|
|
parentDrilldownItem - RelationshipDefinition
|
|
rootDrilldownItem - RelationshipDefinition
|
|
rootDrilldownItemStored - RelationshipDefinition
|
Example
{
"voyagePnl": RelationshipDefinition,
"accountLedger": RelationshipDefinition,
"voyagePnlItineraryLine": RelationshipDefinition,
"voyagePnlDrilldown": RelationshipDefinition,
"parentDrilldownItem": RelationshipDefinition,
"rootDrilldownItem": RelationshipDefinition,
"rootDrilldownItemStored": RelationshipDefinition
}
VoyagePnlDrilldown
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
pnlCategory - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
pnlCategoryStored - String
|
|
accountName - String
|
|
isRootCategory - Boolean
|
|
pnlSection - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
seq - Int
|
|
parentSeq - Int
|
|
groupID - String
|
|
description - String
|
|
estimatedAmountBase - Float
|
|
actualAmountBase - Float
|
|
postedAmountBase - Float
|
|
paidAmountBase - Float
|
|
snapshotType - String
|
|
snapshotRefDateLocal - Date
|
|
dataType - String
|
|
currency - String
|
|
estimatedAmountCurr - Float
|
|
actualAmountCurr - Float
|
|
postedAmountCurr - Float
|
|
paidAmountCurr - Float
|
|
account - String
|
|
counterpartyCompanyNo - Int
|
|
externalRef - String
|
|
isLineItem - Boolean
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
itinerarySeq - Int
|
|
cargoID - Int
|
|
transNo - Int
|
|
counterpartyType - String
|
|
counterpartyShortName - String
|
|
initialEstimatedAmountBase - Float
|
|
initialEstimatedAmountCurr - Float
|
|
rootSeq - Int
|
|
remarks - String
|
|
cargo - Cargo
|
|
operationsInvoice - OperationsInvoice
|
|
counterparty - AddressBook
|
|
voyage - Voyage
|
|
voyagePnl - VoyagePnl
|
|
voyageItinerary - VoyageItinerary
|
|
parentDrilldownItem - VoyagePnlDrilldown
|
|
childDrilldownItem - VoyagePnlDrilldown
|
|
rootDrilldownItem - VoyagePnlDrilldown
|
|
rootDrilldownItemStored - VoyagePnlDrilldown
|
|
runningCostsDrilldownItem - VoyagePnlDrilldown
|
|
chartOfAccounts - ChartOfAccounts
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"pnlCategory": "xyz789",
"customFieldByID": Any,
"customField": Any,
"pnlCategoryStored": "abc123",
"accountName": "abc123",
"isRootCategory": true,
"pnlSection": "abc123",
"vesselCode": "abc123",
"voyageNo": 123,
"seq": 123,
"parentSeq": 123,
"groupID": "xyz789",
"description": "xyz789",
"estimatedAmountBase": 123.45,
"actualAmountBase": 123.45,
"postedAmountBase": 123.45,
"paidAmountBase": 987.65,
"snapshotType": "xyz789",
"snapshotRefDateLocal": "2007-12-03",
"dataType": "xyz789",
"currency": "abc123",
"estimatedAmountCurr": 123.45,
"actualAmountCurr": 987.65,
"postedAmountCurr": 123.45,
"paidAmountCurr": 987.65,
"account": "xyz789",
"counterpartyCompanyNo": 123,
"externalRef": "xyz789",
"isLineItem": true,
"entryDateGmt": "2007-12-03",
"lastUser": "xyz789",
"lastUpdateGmt": "2007-12-03",
"itinerarySeq": 123,
"cargoID": 123,
"transNo": 123,
"counterpartyType": "xyz789",
"counterpartyShortName": "xyz789",
"initialEstimatedAmountBase": 123.45,
"initialEstimatedAmountCurr": 987.65,
"rootSeq": 123,
"remarks": "abc123",
"cargo": Cargo,
"operationsInvoice": OperationsInvoice,
"counterparty": AddressBook,
"voyage": Voyage,
"voyagePnl": VoyagePnl,
"voyageItinerary": VoyageItinerary,
"parentDrilldownItem": VoyagePnlDrilldown,
"childDrilldownItem": VoyagePnlDrilldown,
"rootDrilldownItem": VoyagePnlDrilldown,
"rootDrilldownItemStored": VoyagePnlDrilldown,
"runningCostsDrilldownItem": VoyagePnlDrilldown,
"chartOfAccounts": ChartOfAccounts,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
VoyagePnlDrilldownDataTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
VoyagePnlDrilldownDataTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyagePnlDrilldownDataTypeEnum
|
|
isNot - VoyagePnlDrilldownDataTypeEnum
|
|
isIn - [VoyagePnlDrilldownDataTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VoyagePnlDrilldownFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyagePnlDrilldownFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyagePnlDrilldownFormQueryWhere
}
VoyagePnlDrilldownFormQueryWhere
Fields
Example
{
"and": [VoyagePnlDrilldownFormQueryWhere],
"or": [VoyagePnlDrilldownFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"parentSeq": NumberWhereValueExpression,
"groupID": StringWhereValueExpression,
"description": StringWhereValueExpression,
"estimatedAmountBase": NumberWhereValueExpression,
"actualAmountBase": NumberWhereValueExpression,
"postedAmountBase": NumberWhereValueExpression,
"paidAmountBase": NumberWhereValueExpression,
"snapshotType": StringWhereValueExpression,
"snapshotRefDateLocal": DateWhereValueExpression,
"dataType": VoyagePnlDrilldownDataTypeEnumValueExpression,
"currency": StringWhereValueExpression,
"estimatedAmountCurr": NumberWhereValueExpression,
"actualAmountCurr": NumberWhereValueExpression,
"postedAmountCurr": NumberWhereValueExpression,
"paidAmountCurr": NumberWhereValueExpression,
"account": StringWhereValueExpression,
"counterpartyCompanyNo": NumberWhereValueExpression,
"externalRef": StringWhereValueExpression,
"isLineItem": BoolWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"itinerarySeq": NumberWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"transNo": NumberWhereValueExpression,
"counterpartyType": StringWhereValueExpression,
"counterpartyShortName": StringWhereValueExpression,
"initialEstimatedAmountBase": NumberWhereValueExpression,
"initialEstimatedAmountCurr": NumberWhereValueExpression,
"rootSeq": NumberWhereValueExpression,
"remarks": StringWhereValueExpression,
"cargo": CargoFormQueryWhere,
"operationsInvoice": OperationsInvoiceFormQueryWhere,
"counterparty": AddressBookFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"voyagePnl": VoyagePnlFormQueryWhere,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"parentDrilldownItem": VoyagePnlDrilldownFormQueryWhere,
"childDrilldownItem": VoyagePnlDrilldownFormQueryWhere,
"rootDrilldownItem": VoyagePnlDrilldownFormQueryWhere,
"rootDrilldownItemStored": VoyagePnlDrilldownFormQueryWhere,
"runningCostsDrilldownItem": VoyagePnlDrilldownFormQueryWhere,
"chartOfAccounts": ChartOfAccountsFormQueryWhere
}
VoyagePnlDrilldownRelationships
Fields
| Field Name | Description |
|---|---|
cargo - RelationshipDefinition
|
|
operationsInvoice - RelationshipDefinition
|
|
counterparty - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
voyagePnl - RelationshipDefinition
|
|
voyageItinerary - RelationshipDefinition
|
|
parentDrilldownItem - RelationshipDefinition
|
|
childDrilldownItem - RelationshipDefinition
|
|
rootDrilldownItem - RelationshipDefinition
|
|
rootDrilldownItemStored - RelationshipDefinition
|
|
runningCostsDrilldownItem - RelationshipDefinition
|
|
chartOfAccounts - RelationshipDefinition
|
Example
{
"cargo": RelationshipDefinition,
"operationsInvoice": RelationshipDefinition,
"counterparty": RelationshipDefinition,
"voyage": RelationshipDefinition,
"voyagePnl": RelationshipDefinition,
"voyageItinerary": RelationshipDefinition,
"parentDrilldownItem": RelationshipDefinition,
"childDrilldownItem": RelationshipDefinition,
"rootDrilldownItem": RelationshipDefinition,
"rootDrilldownItemStored": RelationshipDefinition,
"runningCostsDrilldownItem": RelationshipDefinition,
"chartOfAccounts": RelationshipDefinition
}
VoyagePnlFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyagePnlFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyagePnlFormQueryWhere
}
VoyagePnlFormQueryWhere
Fields
Example
{
"and": [VoyagePnlFormQueryWhere],
"or": [VoyagePnlFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"tciCode": StringWhereValueExpression,
"vesselName": StringWhereValueExpression,
"tcoCode": StringWhereValueExpression,
"fixtureNo": StringWhereValueExpression,
"dataType": VoyagePnlDataTypeEnumValueExpression,
"entryDateGmt": DateWhereValueExpression,
"oprType": StringWhereValueExpression,
"cargoLift": NumberWhereValueExpression,
"demCredit": NumberWhereValueExpression,
"totalProfitLoss": NumberWhereValueExpression,
"tce": NumberWhereValueExpression,
"totalVoyageDays": NumberWhereValueExpression,
"totalSeaDays": NumberWhereValueExpression,
"totalWaitForLaycanDays": NumberWhereValueExpression,
"totalWaitForOrdersDays": NumberWhereValueExpression,
"vesselType": StringWhereValueExpression,
"commenceDateLocal": DateWhereValueExpression,
"completeDateLocal": DateWhereValueExpression,
"commenceDateGmt": DateWhereValueExpression,
"completeDateGmt": DateWhereValueExpression,
"offHireDays": NumberWhereValueExpression,
"totalBallastDays": NumberWhereValueExpression,
"totalLadenDays": NumberWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"snapshotType": StringWhereValueExpression,
"snapshotRefDateLocal": DateWhereValueExpression,
"remarks": StringWhereValueExpression,
"externalRef": StringWhereValueExpression,
"applyTcExpensesToPeriod": BoolWhereValueExpression,
"applyOtherRevenuesExpensesToPeriod": BoolWhereValueExpression,
"applyAdditionalHireToPeriod": BoolWhereValueExpression,
"applyTcBunkerAdjustmentsToPeriod": BoolWhereValueExpression,
"applyPortExpensesToPeriod": BoolWhereValueExpression,
"excludeHireRelatedItemsForLongTermTco": BoolWhereValueExpression,
"applyInternalFreightRevenueToPeriod": BoolWhereValueExpression,
"capitalizeAmortizeCostsPriorToPerformingPeriod": BoolWhereValueExpression,
"applyTcHireToPeriod": BoolWhereValueExpression,
"applyOffHireWaitingToPeriod": BoolWhereValueExpression,
"applyBallastBonusToPeriod": BoolWhereValueExpression,
"adjustPortionForOffHire": BoolWhereValueExpression,
"adjustPortionForWaitingTime": BoolWhereValueExpression,
"excludeRunningCostsForLongTermTcOrOv": BoolWhereValueExpression,
"applyBunkerConsumptionToPeriod": BoolWhereValueExpression,
"reconcileBunkerRobForCurrentVoyages": BoolWhereValueExpression,
"adjustPortionForBallastDays": BoolWhereValueExpression,
"applyDemurrageToPeriod": BoolWhereValueExpression,
"adjustPortionForDemurrageDays": BoolWhereValueExpression,
"accrueSettledLinkedTrades": BoolWhereValueExpression,
"totalIdleDays": NumberWhereValueExpression,
"totalBunkeringDays": NumberWhereValueExpression,
"totalWaitingDays": NumberWhereValueExpression,
"revenues": NumberWhereValueExpression,
"expenses": NumberWhereValueExpression,
"runningCost": NumberWhereValueExpression,
"freight": NumberWhereValueExpression,
"demurrage": NumberWhereValueExpression,
"despatch": NumberWhereValueExpression,
"freightComm": NumberWhereValueExpression,
"freightAddComm": NumberWhereValueExpression,
"freightTax": NumberWhereValueExpression,
"freightCargoLoss": NumberWhereValueExpression,
"demurrageComm": NumberWhereValueExpression,
"demurrageAddComm": NumberWhereValueExpression,
"rebills": NumberWhereValueExpression,
"miscRevenue": NumberWhereValueExpression,
"nonAccRevenue": NumberWhereValueExpression,
"vesselDailyCost": NumberWhereValueExpression,
"bunkers": NumberWhereValueExpression,
"hire": NumberWhereValueExpression,
"hireComm": NumberWhereValueExpression,
"hireAddComm": NumberWhereValueExpression,
"tciBunkerAdjustment": NumberWhereValueExpression,
"offHire": NumberWhereValueExpression,
"offHireBunkers": NumberWhereValueExpression,
"offHireAddComm": NumberWhereValueExpression,
"offHireComm": NumberWhereValueExpression,
"cve": NumberWhereValueExpression,
"offHireCve": NumberWhereValueExpression,
"ballastBonus": NumberWhereValueExpression,
"holdCleaning": NumberWhereValueExpression,
"tciAdminFee": NumberWhereValueExpression,
"tciMiscExpenses": NumberWhereValueExpression,
"transshipmentCost": NumberWhereValueExpression,
"lighteringCost": NumberWhereValueExpression,
"tcoHire": NumberWhereValueExpression,
"tcoHireComm": NumberWhereValueExpression,
"tcoHireAddComm": NumberWhereValueExpression,
"tcoBunkerAdjustment": NumberWhereValueExpression,
"tcoCve": NumberWhereValueExpression,
"tcoOffHire": NumberWhereValueExpression,
"tcoOffHireBunkers": NumberWhereValueExpression,
"tcoOffHireComm": NumberWhereValueExpression,
"tcoOffHireAddComm": NumberWhereValueExpression,
"tcoOffHireCve": NumberWhereValueExpression,
"tcoBallastBonus": NumberWhereValueExpression,
"tcoHoldCleaning": NumberWhereValueExpression,
"tcoAdminFee": NumberWhereValueExpression,
"tcoMiscRevenues": NumberWhereValueExpression,
"portExpenses": NumberWhereValueExpression,
"cargoExpenses": NumberWhereValueExpression,
"surveyExpenses": NumberWhereValueExpression,
"tolls": NumberWhereValueExpression,
"miscExpenses": NumberWhereValueExpression,
"nonAccExpenses": NumberWhereValueExpression,
"vCInFreight": NumberWhereValueExpression,
"vCInFreightComm": NumberWhereValueExpression,
"vCInFreightAddComm": NumberWhereValueExpression,
"vCInFreightTax": NumberWhereValueExpression,
"vCInFreightCargoLoss": NumberWhereValueExpression,
"vCInDemurrage": NumberWhereValueExpression,
"vCInDemComm": NumberWhereValueExpression,
"vCInDemAddComm": NumberWhereValueExpression,
"vCInDespatch": NumberWhereValueExpression,
"bareboatHire": NumberWhereValueExpression,
"bareboatOffHire": NumberWhereValueExpression,
"bareboatAddComm": NumberWhereValueExpression,
"bareboatOffHireAddComm": NumberWhereValueExpression,
"bareboatComm": NumberWhereValueExpression,
"bareboatVoyageExpenses": NumberWhereValueExpression,
"bareboatMiscExpenses": NumberWhereValueExpression,
"bareboatAdjustments": NumberWhereValueExpression,
"bareboatOffHireBunkers": NumberWhereValueExpression,
"adminFees": NumberWhereValueExpression,
"revenueAdjustment": NumberWhereValueExpression,
"expenseAdjustment": NumberWhereValueExpression,
"uncategorizedAdjustment": NumberWhereValueExpression,
"interserviceRevenue": NumberWhereValueExpression,
"exchangeDifference": NumberWhereValueExpression,
"tciGratuities": NumberWhereValueExpression,
"tciVictualling": NumberWhereValueExpression,
"tciLashingandStowage": NumberWhereValueExpression,
"tciReprExpAllowances": NumberWhereValueExpression,
"tciOffHireGratuities": NumberWhereValueExpression,
"tciOffHireVictualling": NumberWhereValueExpression,
"tciOffHireLashingandStowage": NumberWhereValueExpression,
"tciOffHireReprExpAllowances": NumberWhereValueExpression,
"tcoGratuities": NumberWhereValueExpression,
"tcoVictualling": NumberWhereValueExpression,
"tcoLashingandStowage": NumberWhereValueExpression,
"tcoReprExpAllowances": NumberWhereValueExpression,
"tcoOffHireGratuities": NumberWhereValueExpression,
"tcoOffHireVictualling": NumberWhereValueExpression,
"tcoOffHireLashingandStowage": NumberWhereValueExpression,
"tcoOffHireReprExpAllowances": NumberWhereValueExpression,
"profitShare": NumberWhereValueExpression,
"premiumIncome": NumberWhereValueExpression,
"estimateID": StringWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"firstChartererShortName": StringWhereValueExpression,
"firstLoadPortName": StringWhereValueExpression,
"lastDischPortName": StringWhereValueExpression,
"baseCurrency": StringWhereValueExpression,
"forecast": BoolWhereValueExpression,
"claimPending": BoolWhereValueExpression,
"legalHold": BoolWhereValueExpression,
"cancel": BoolWhereValueExpression,
"voyageStatusCode": VoyagePnlVoyageStatusCodeEnumValueExpression,
"bunkerSwaps": NumberWhereValueExpression,
"voyageReference": StringWhereValueExpression,
"marketValuationRate": NumberWhereValueExpression,
"marketValuationRateUnit": StringWhereValueExpression,
"marketValuationSymbol": StringWhereValueExpression,
"marketValuationCorrelation": NumberWhereValueExpression,
"marketValuationAdjustment": NumberWhereValueExpression,
"marketValuationLumpsumAmount": NumberWhereValueExpression,
"marketResultIn": NumberWhereValueExpression,
"marketResultOut": NumberWhereValueExpression,
"lastNoonReportGmt": DateWhereValueExpression,
"vessel": VesselFormQueryWhere,
"voyage": VoyageFormQueryWhere
}
VoyagePnlItineraryLine
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
seq - Int
|
|
entryDateGmt - Date
|
|
dataType - String
|
|
status - String
|
|
ballastOrLaden - String
|
|
orderNo - Int
|
|
portNo - Int
|
|
portName - String
|
|
miles - Float
|
|
speed - Float
|
|
extraSeaDays - Float
|
|
arrivalDateGmt - Date
|
|
anchorageInHours - Float
|
|
portDays - Float
|
|
departureDateGmt - Date
|
|
arrivalDateLocal - Date
|
|
departureDateLocal - Date
|
|
portFunction - String
|
|
demurrageDays - Float
|
|
despatchDays - Float
|
|
lastUserID - String
|
|
pilotToBerthHours - Float
|
|
berthToPilotHours - Float
|
|
seaDays - Float
|
|
idleDays - Float
|
|
extraPortDays - Float
|
|
lSSeaDays - Float
|
|
lSPortDays - Float
|
|
lowSpeedZoneMiles - Float
|
|
lowSpeedZoneDays - Float
|
|
lsMiles - Float
|
|
snapshotType - String
|
|
snapshotRefDateLocal - Date
|
|
externalRef - String
|
|
lastUpdateGmt - Date
|
|
seaEcaID - Int
|
|
voyagePnl - VoyagePnl
|
|
voyagePnlCargos - [VoyagePnlCargo]
|
|
voyagePnlItineraryLineBunkers - [VoyagePnlItineraryLineBunker]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 123,
"seq": 987,
"entryDateGmt": "2007-12-03",
"dataType": "abc123",
"status": "xyz789",
"ballastOrLaden": "abc123",
"orderNo": 987,
"portNo": 987,
"portName": "xyz789",
"miles": 987.65,
"speed": 987.65,
"extraSeaDays": 987.65,
"arrivalDateGmt": "2007-12-03",
"anchorageInHours": 987.65,
"portDays": 987.65,
"departureDateGmt": "2007-12-03",
"arrivalDateLocal": "2007-12-03",
"departureDateLocal": "2007-12-03",
"portFunction": "xyz789",
"demurrageDays": 123.45,
"despatchDays": 123.45,
"lastUserID": "abc123",
"pilotToBerthHours": 123.45,
"berthToPilotHours": 987.65,
"seaDays": 987.65,
"idleDays": 987.65,
"extraPortDays": 987.65,
"lSSeaDays": 987.65,
"lSPortDays": 987.65,
"lowSpeedZoneMiles": 987.65,
"lowSpeedZoneDays": 123.45,
"lsMiles": 987.65,
"snapshotType": "abc123",
"snapshotRefDateLocal": "2007-12-03",
"externalRef": "xyz789",
"lastUpdateGmt": "2007-12-03",
"seaEcaID": 987,
"voyagePnl": VoyagePnl,
"voyagePnlCargos": [VoyagePnlCargo],
"voyagePnlItineraryLineBunkers": [
VoyagePnlItineraryLineBunker
],
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
VoyagePnlItineraryLineBunker
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
snapshotType - String
|
|
snapshotRefDateLocal - Date
|
|
dataType - String
|
|
voyageNo - Int
|
|
seq - Int
|
|
fuelType - String
|
|
robArrival - Float
|
|
fuelReceived - Float
|
|
robDeparture - Float
|
|
price - Float
|
|
seaCons - Float
|
|
portCons - Float
|
|
voyagePnlItineraryLine - VoyagePnlItineraryLine
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"snapshotType": "abc123",
"snapshotRefDateLocal": "2007-12-03",
"dataType": "abc123",
"voyageNo": 123,
"seq": 123,
"fuelType": "xyz789",
"robArrival": 123.45,
"fuelReceived": 123.45,
"robDeparture": 123.45,
"price": 123.45,
"seaCons": 123.45,
"portCons": 987.65,
"voyagePnlItineraryLine": VoyagePnlItineraryLine,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyagePnlItineraryLineBunkerDataTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
VoyagePnlItineraryLineBunkerDataTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyagePnlItineraryLineBunkerDataTypeEnum
|
|
isNot - VoyagePnlItineraryLineBunkerDataTypeEnum
|
|
isIn - [VoyagePnlItineraryLineBunkerDataTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VoyagePnlItineraryLineBunkerFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyagePnlItineraryLineBunkerFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyagePnlItineraryLineBunkerFormQueryWhere
}
VoyagePnlItineraryLineBunkerFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyagePnlItineraryLineBunkerFormQueryWhere!]
|
|
or - [VoyagePnlItineraryLineBunkerFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
snapshotType - StringWhereValueExpression
|
|
snapshotRefDateLocal - DateWhereValueExpression
|
|
dataType - VoyagePnlItineraryLineBunkerDataTypeEnumValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
seq - NumberWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
robArrival - NumberWhereValueExpression
|
|
fuelReceived - NumberWhereValueExpression
|
|
robDeparture - NumberWhereValueExpression
|
|
price - NumberWhereValueExpression
|
|
seaCons - NumberWhereValueExpression
|
|
portCons - NumberWhereValueExpression
|
|
voyagePnlItineraryLine - VoyagePnlItineraryLineFormQueryWhere
|
Example
{
"and": [VoyagePnlItineraryLineBunkerFormQueryWhere],
"or": [VoyagePnlItineraryLineBunkerFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"snapshotType": StringWhereValueExpression,
"snapshotRefDateLocal": DateWhereValueExpression,
"dataType": VoyagePnlItineraryLineBunkerDataTypeEnumValueExpression,
"voyageNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"fuelType": StringWhereValueExpression,
"robArrival": NumberWhereValueExpression,
"fuelReceived": NumberWhereValueExpression,
"robDeparture": NumberWhereValueExpression,
"price": NumberWhereValueExpression,
"seaCons": NumberWhereValueExpression,
"portCons": NumberWhereValueExpression,
"voyagePnlItineraryLine": VoyagePnlItineraryLineFormQueryWhere
}
VoyagePnlItineraryLineBunkerRelationships
Fields
| Field Name | Description |
|---|---|
voyagePnlItineraryLine - RelationshipDefinition
|
Example
{"voyagePnlItineraryLine": RelationshipDefinition}
VoyagePnlItineraryLineDataTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
VoyagePnlItineraryLineDataTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyagePnlItineraryLineDataTypeEnum
|
|
isNot - VoyagePnlItineraryLineDataTypeEnum
|
|
isIn - [VoyagePnlItineraryLineDataTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VoyagePnlItineraryLineFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyagePnlItineraryLineFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyagePnlItineraryLineFormQueryWhere
}
VoyagePnlItineraryLineFormQueryWhere
Fields
Example
{
"and": [VoyagePnlItineraryLineFormQueryWhere],
"or": [VoyagePnlItineraryLineFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"dataType": VoyagePnlItineraryLineDataTypeEnumValueExpression,
"status": StringWhereValueExpression,
"ballastOrLaden": StringWhereValueExpression,
"orderNo": NumberWhereValueExpression,
"portNo": NumberWhereValueExpression,
"portName": StringWhereValueExpression,
"miles": NumberWhereValueExpression,
"speed": NumberWhereValueExpression,
"extraSeaDays": NumberWhereValueExpression,
"arrivalDateGmt": DateWhereValueExpression,
"anchorageInHours": NumberWhereValueExpression,
"portDays": NumberWhereValueExpression,
"departureDateGmt": DateWhereValueExpression,
"arrivalDateLocal": DateWhereValueExpression,
"departureDateLocal": DateWhereValueExpression,
"portFunction": StringWhereValueExpression,
"demurrageDays": NumberWhereValueExpression,
"despatchDays": NumberWhereValueExpression,
"lastUserID": StringWhereValueExpression,
"pilotToBerthHours": NumberWhereValueExpression,
"berthToPilotHours": NumberWhereValueExpression,
"seaDays": NumberWhereValueExpression,
"idleDays": NumberWhereValueExpression,
"extraPortDays": NumberWhereValueExpression,
"lSSeaDays": NumberWhereValueExpression,
"lSPortDays": NumberWhereValueExpression,
"lowSpeedZoneMiles": NumberWhereValueExpression,
"lowSpeedZoneDays": NumberWhereValueExpression,
"lsMiles": NumberWhereValueExpression,
"snapshotType": StringWhereValueExpression,
"snapshotRefDateLocal": DateWhereValueExpression,
"externalRef": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"seaEcaID": NumberWhereValueExpression,
"voyagePnl": VoyagePnlFormQueryWhere
}
VoyagePnlItineraryLineRelationships
Fields
| Field Name | Description |
|---|---|
voyagePnl - RelationshipDefinition
|
|
voyagePnlCargos - RelationshipDefinition
|
|
voyagePnlItineraryLineBunkers - RelationshipDefinition
|
Example
{
"voyagePnl": RelationshipDefinition,
"voyagePnlCargos": RelationshipDefinition,
"voyagePnlItineraryLineBunkers": RelationshipDefinition
}
VoyagePnlRelationships
Fields
| Field Name | Description |
|---|---|
vessel - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
latestActSnapshotRefDate - RelationshipDefinition
|
|
latestActSnapshotVoyage - RelationshipDefinition
|
|
latestSnapshotRefDateExchangeRate - RelationshipDefinition
|
|
voyagePnlDrilldowns - RelationshipDefinition
|
|
voyagePnlDetails - RelationshipDefinition
|
|
voyagePnlCargos - RelationshipDefinition
|
|
voyagePnlItineraryLines - RelationshipDefinition
|
|
voyagePnlBunkers - RelationshipDefinition
|
|
voyageItineraryLoads - RelationshipDefinition
|
|
voyageItineraryDischarges - RelationshipDefinition
|
|
exchangeRates - RelationshipDefinition
|
Example
{
"vessel": RelationshipDefinition,
"voyage": RelationshipDefinition,
"latestActSnapshotRefDate": RelationshipDefinition,
"latestActSnapshotVoyage": RelationshipDefinition,
"latestSnapshotRefDateExchangeRate": RelationshipDefinition,
"voyagePnlDrilldowns": RelationshipDefinition,
"voyagePnlDetails": RelationshipDefinition,
"voyagePnlCargos": RelationshipDefinition,
"voyagePnlItineraryLines": RelationshipDefinition,
"voyagePnlBunkers": RelationshipDefinition,
"voyageItineraryLoads": RelationshipDefinition,
"voyageItineraryDischarges": RelationshipDefinition,
"exchangeRates": RelationshipDefinition
}
VoyagePnlSummary
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
companyCode - String
|
|
vesselName - String
|
|
voyageStatus - String
|
|
description - String
|
|
estimatedAmountBase - Float
|
|
actualAmountBase - Float
|
|
postedAmountBase - Float
|
|
paidAmountBase - Float
|
|
actEstVarianceAmountBase - Float
|
|
actEstVariancePct - Float
|
|
seq - Int
|
|
isRootCategory - Boolean
|
|
rootCategory - String
|
|
isTotalCategory - Boolean
|
|
accountCode - String
|
|
accountName - String
|
|
accountCodeCategory - String
|
|
accountsView - Boolean
|
|
includeDetails - Boolean
|
|
snapshotType - String
|
|
snapshotRefDate - Date
|
|
forceCalc - Boolean
|
|
periodFromGmt - Date
|
|
periodToGmt - Date
|
|
periodRangeGmt - String
|
|
portionPct - Float
|
|
voyage - Voyage
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 987,
"companyCode": "xyz789",
"vesselName": "xyz789",
"voyageStatus": "xyz789",
"description": "abc123",
"estimatedAmountBase": 123.45,
"actualAmountBase": 987.65,
"postedAmountBase": 987.65,
"paidAmountBase": 987.65,
"actEstVarianceAmountBase": 123.45,
"actEstVariancePct": 987.65,
"seq": 123,
"isRootCategory": true,
"rootCategory": "abc123",
"isTotalCategory": true,
"accountCode": "xyz789",
"accountName": "xyz789",
"accountCodeCategory": "abc123",
"accountsView": false,
"includeDetails": false,
"snapshotType": "xyz789",
"snapshotRefDate": "2007-12-03",
"forceCalc": false,
"periodFromGmt": "2007-12-03",
"periodToGmt": "2007-12-03",
"periodRangeGmt": "abc123",
"portionPct": 123.45,
"voyage": Voyage,
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyagePnlSummaryFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyagePnlSummaryFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyagePnlSummaryFormQueryWhere
}
VoyagePnlSummaryFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyagePnlSummaryFormQueryWhere!]
|
|
or - [VoyagePnlSummaryFormQueryWhere!]
|
|
rawExpression - String
|
|
voyage - VoyageFormQueryWhere
|
Example
{
"and": [VoyagePnlSummaryFormQueryWhere],
"or": [VoyagePnlSummaryFormQueryWhere],
"rawExpression": "abc123",
"voyage": VoyageFormQueryWhere
}
VoyagePnlSummaryRelationships
Fields
| Field Name | Description |
|---|---|
voyage - RelationshipDefinition
|
Example
{"voyage": RelationshipDefinition}
VoyagePnlVoyageStatusCodeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Scheduled"
VoyagePnlVoyageStatusCodeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyagePnlVoyageStatusCodeEnum
|
|
isNot - VoyagePnlVoyageStatusCodeEnum
|
|
isIn - [VoyagePnlVoyageStatusCodeEnum]
|
Example
{"is": "Scheduled", "isNot": "Scheduled", "isIn": ["Scheduled"]}
VoyagePortActivities
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
itinerarySeq - Int
|
|
seq - Int
|
|
activityTimeLocal - Date
|
|
activityTimeGmt - Date
|
|
activityName - String
|
|
remarks - String
|
|
cargoHandlingSeqNo - Int
|
|
cargoShortName - String
|
|
berthShortName - String
|
|
activityType - String
|
|
reasonType - String
|
|
lastUpdateGmt - Date
|
|
equipmentCode - String
|
|
voyageActivityReportSeq - Int
|
|
barge - Barge
|
|
cargoName - CargoName
|
|
portActivity - PortActivity
|
|
voyageItinerary - VoyageItinerary
|
|
voyageCargoHandling - VoyageCargoHandling
|
|
portActivityBunkers - [PortActivityBunker]
|
|
updateActivityLogMessages - [UpdateActivityLogMessageRecord]
|
|
Arguments
|
|
changesSinceLast - VoyagePortActivitiesChangesSinceLast
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 987,
"itinerarySeq": 123,
"seq": 987,
"activityTimeLocal": "2007-12-03",
"activityTimeGmt": "2007-12-03",
"activityName": "xyz789",
"remarks": "abc123",
"cargoHandlingSeqNo": 123,
"cargoShortName": "xyz789",
"berthShortName": "abc123",
"activityType": "xyz789",
"reasonType": "xyz789",
"lastUpdateGmt": "2007-12-03",
"equipmentCode": "xyz789",
"voyageActivityReportSeq": 987,
"barge": Barge,
"cargoName": CargoName,
"portActivity": PortActivity,
"voyageItinerary": VoyageItinerary,
"voyageCargoHandling": VoyageCargoHandling,
"portActivityBunkers": [PortActivityBunker],
"updateActivityLogMessages": [
UpdateActivityLogMessageRecord
],
"changesSinceLast": VoyagePortActivitiesChangesSinceLast,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyagePortActivitiesChangesSinceLast
Fields
| Field Name | Description |
|---|---|
updateActivityLog - MessageUpdateResponse
|
Example
{"updateActivityLog": MessageUpdateResponse}
VoyagePortActivitiesFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyagePortActivitiesFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyagePortActivitiesFormQueryWhere
}
VoyagePortActivitiesFormQueryWhere
Fields
Example
{
"and": [VoyagePortActivitiesFormQueryWhere],
"or": [VoyagePortActivitiesFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"itinerarySeq": NumberWhereValueExpression,
"seq": NumberWhereValueExpression,
"activityTimeLocal": DateWhereValueExpression,
"activityTimeGmt": DateWhereValueExpression,
"activityName": StringWhereValueExpression,
"remarks": StringWhereValueExpression,
"cargoHandlingSeqNo": NumberWhereValueExpression,
"cargoShortName": StringWhereValueExpression,
"berthShortName": StringWhereValueExpression,
"activityType": StringWhereValueExpression,
"reasonType": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"equipmentCode": StringWhereValueExpression,
"voyageActivityReportSeq": NumberWhereValueExpression,
"barge": BargeFormQueryWhere,
"cargoName": CargoNameFormQueryWhere,
"portActivity": PortActivityFormQueryWhere,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"voyageCargoHandling": VoyageCargoHandlingFormQueryWhere
}
VoyagePortActivitiesRelationships
Fields
| Field Name | Description |
|---|---|
barge - RelationshipDefinition
|
|
cargoName - RelationshipDefinition
|
|
portActivity - RelationshipDefinition
|
|
voyageItinerary - RelationshipDefinition
|
|
voyageCargoHandling - RelationshipDefinition
|
|
portActivityBunkers - RelationshipDefinition
|
Example
{
"barge": RelationshipDefinition,
"cargoName": RelationshipDefinition,
"portActivity": RelationshipDefinition,
"voyageItinerary": RelationshipDefinition,
"voyageCargoHandling": RelationshipDefinition,
"portActivityBunkers": RelationshipDefinition
}
VoyagePortAgent
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
itinerarySeq - Int
|
|
categoryNo - Int
|
|
agentRole - String
|
|
nominatorShortName - String
|
|
agentShortName - String
|
|
statusPending - Boolean
|
|
statusReleased - Boolean
|
|
statusError - Boolean
|
|
statusClosed - Boolean
|
|
apiCallSuccessful - Boolean
|
|
flags - Int
|
|
agentType - String
|
|
originalFeeCurr - Float
|
|
negotiatedFeeCurr - Float
|
|
currency - String
|
|
exchRate - Float
|
|
agentSubType - String
|
|
voyageItinerary - VoyageItinerary
|
|
addressBook - AddressBook
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "abc123",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 987,
"itinerarySeq": 123,
"categoryNo": 987,
"agentRole": "abc123",
"nominatorShortName": "abc123",
"agentShortName": "xyz789",
"statusPending": true,
"statusReleased": false,
"statusError": true,
"statusClosed": true,
"apiCallSuccessful": false,
"flags": 987,
"agentType": "abc123",
"originalFeeCurr": 987.65,
"negotiatedFeeCurr": 987.65,
"currency": "xyz789",
"exchRate": 123.45,
"agentSubType": "abc123",
"voyageItinerary": VoyageItinerary,
"addressBook": AddressBook,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
VoyagePortAgentAgentRoleEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EnumEmpty"
VoyagePortAgentAgentRoleEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyagePortAgentAgentRoleEnum
|
|
isNot - VoyagePortAgentAgentRoleEnum
|
|
isIn - [VoyagePortAgentAgentRoleEnum]
|
Example
{"is": "EnumEmpty", "isNot": "EnumEmpty", "isIn": ["EnumEmpty"]}
VoyagePortAgentAgentSubTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
VoyagePortAgentAgentSubTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyagePortAgentAgentSubTypeEnum
|
|
isNot - VoyagePortAgentAgentSubTypeEnum
|
|
isIn - [VoyagePortAgentAgentSubTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VoyagePortAgentFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyagePortAgentFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyagePortAgentFormQueryWhere
}
VoyagePortAgentFormQueryWhere
Fields
Example
{
"and": [VoyagePortAgentFormQueryWhere],
"or": [VoyagePortAgentFormQueryWhere],
"rawExpression": "abc123",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"itinerarySeq": NumberWhereValueExpression,
"categoryNo": NumberWhereValueExpression,
"agentRole": VoyagePortAgentAgentRoleEnumValueExpression,
"nominatorShortName": StringWhereValueExpression,
"agentShortName": StringWhereValueExpression,
"statusPending": BoolWhereValueExpression,
"statusReleased": BoolWhereValueExpression,
"statusError": BoolWhereValueExpression,
"statusClosed": BoolWhereValueExpression,
"apiCallSuccessful": BoolWhereValueExpression,
"flags": NumberWhereValueExpression,
"agentType": StringWhereValueExpression,
"originalFeeCurr": NumberWhereValueExpression,
"negotiatedFeeCurr": NumberWhereValueExpression,
"currency": StringWhereValueExpression,
"exchRate": NumberWhereValueExpression,
"agentSubType": VoyagePortAgentAgentSubTypeEnumValueExpression,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"addressBook": AddressBookFormQueryWhere
}
VoyagePortAgentRelationships
Fields
| Field Name | Description |
|---|---|
voyageItinerary - RelationshipDefinition
|
|
addressBook - RelationshipDefinition
|
Example
{
"voyageItinerary": RelationshipDefinition,
"addressBook": RelationshipDefinition
}
VoyageProjectedInvoice
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
companyCode - String
|
|
vesselName - String
|
|
invoiceType - String
|
|
description - String
|
|
actualAmountBaseInternal - Float
|
|
actualAmountCurrInternal - Float
|
|
invoicedAmountBaseInternal - Float
|
|
paidAmountBaseInternal - Float
|
|
paidAmountCurrInternal - Float
|
|
counterpartyType - String
|
|
counterpartyTypeDescription - String
|
|
counterpartyShortName - String
|
|
source - String
|
|
billCode - String
|
|
voyageStatus - String
|
|
outstandingBalanceBaseInternal - Float
|
|
originalInvoiceNo - String
|
|
originalInvoiceTransNo - String
|
|
originalInvoiceCurrAmount - Float
|
|
originalInvoiceStatus - String
|
|
snapshotDateGmt - Date
|
|
voyage - Voyage
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 123,
"companyCode": "xyz789",
"vesselName": "abc123",
"invoiceType": "abc123",
"description": "abc123",
"actualAmountBaseInternal": 123.45,
"actualAmountCurrInternal": 987.65,
"invoicedAmountBaseInternal": 987.65,
"paidAmountBaseInternal": 123.45,
"paidAmountCurrInternal": 123.45,
"counterpartyType": "abc123",
"counterpartyTypeDescription": "abc123",
"counterpartyShortName": "xyz789",
"source": "xyz789",
"billCode": "abc123",
"voyageStatus": "xyz789",
"outstandingBalanceBaseInternal": 123.45,
"originalInvoiceNo": "abc123",
"originalInvoiceTransNo": "abc123",
"originalInvoiceCurrAmount": 123.45,
"originalInvoiceStatus": "xyz789",
"snapshotDateGmt": "2007-12-03",
"voyage": Voyage,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageProjectedInvoiceFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageProjectedInvoiceFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageProjectedInvoiceFormQueryWhere
}
VoyageProjectedInvoiceFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyageProjectedInvoiceFormQueryWhere!]
|
|
or - [VoyageProjectedInvoiceFormQueryWhere!]
|
|
rawExpression - String
|
|
voyage - VoyageFormQueryWhere
|
Example
{
"and": [VoyageProjectedInvoiceFormQueryWhere],
"or": [VoyageProjectedInvoiceFormQueryWhere],
"rawExpression": "xyz789",
"voyage": VoyageFormQueryWhere
}
VoyageProjectedInvoiceRelationships
Fields
| Field Name | Description |
|---|---|
voyage - RelationshipDefinition
|
Example
{"voyage": RelationshipDefinition}
VoyageRelationships
Fields
Example
{
"tradeType": RelationshipDefinition,
"voyageTemplate": RelationshipDefinition,
"fuelZoneSet": RelationshipDefinition,
"lob": RelationshipDefinition,
"user": RelationshipDefinition,
"fixture": RelationshipDefinition,
"team": RelationshipDefinition,
"tradeArea": RelationshipDefinition,
"vessel": RelationshipDefinition,
"voyageActPnl": RelationshipDefinition,
"voyageEstPnl": RelationshipDefinition,
"voyagePstPnl": RelationshipDefinition,
"voyageActPnlBasis": RelationshipDefinition,
"voyageActPnlCompare": RelationshipDefinition,
"department": RelationshipDefinition,
"firstCargo": RelationshipDefinition,
"currentPort": RelationshipDefinition,
"nextPort": RelationshipDefinition,
"firstBallastPort": RelationshipDefinition,
"firstTermPort": RelationshipDefinition,
"firstLoadItin": RelationshipDefinition,
"firstDiscItin": RelationshipDefinition,
"lastLoadItin": RelationshipDefinition,
"lastDiscItin": RelationshipDefinition,
"firstItin": RelationshipDefinition,
"lastItin": RelationshipDefinition,
"tCIContract": RelationshipDefinition,
"tCOContract": RelationshipDefinition,
"tCODetails": RelationshipDefinition,
"firstFixtureBallastPort": RelationshipDefinition,
"firstFixtureTermPort": RelationshipDefinition,
"companyAddressBook": RelationshipDefinition,
"company": RelationshipDefinition,
"voyageEstimate": RelationshipDefinition,
"voyageRemarks": RelationshipDefinition,
"opsCoordinatorUser": RelationshipDefinition,
"charteringCoordinatorUser": RelationshipDefinition,
"opsCoordinatorUser2": RelationshipDefinition,
"controllerUser": RelationshipDefinition,
"fDManagerUser": RelationshipDefinition,
"financeCoordinatorUser": RelationshipDefinition,
"latestActivityReport": RelationshipDefinition,
"latestPositionReport": RelationshipDefinition,
"voyageActPnlLatest": RelationshipDefinition,
"previousVoyage": RelationshipDefinition,
"nextVoyage": RelationshipDefinition,
"voyageNoteLinkedClaim": RelationshipDefinition,
"voyageEmissions": RelationshipDefinition,
"voyagePnls": RelationshipDefinition,
"voyageEquipmentEvents": RelationshipDefinition,
"voyageContacts": RelationshipDefinition,
"voyageBunkerSummaries": RelationshipDefinition,
"voyageBunkerInventories": RelationshipDefinition,
"voyageProfitShares": RelationshipDefinition,
"poolingDistributions": RelationshipDefinition,
"delays": RelationshipDefinition,
"voyageCargoHandlingDocuments": RelationshipDefinition,
"voyageActivityReports": RelationshipDefinition,
"laytimes": RelationshipDefinition,
"financialsInvoiceDetails": RelationshipDefinition,
"operationsInvoiceDetails": RelationshipDefinition,
"voyageItineraries": RelationshipDefinition,
"saleCargoContracts": RelationshipDefinition,
"voyageCargoHandlings": RelationshipDefinition,
"loadCargoHandlings": RelationshipDefinition,
"discCargoHandlings": RelationshipDefinition,
"last3CargoLoadings": RelationshipDefinition,
"voyageItinLoads": RelationshipDefinition,
"voyageItinDischarges": RelationshipDefinition,
"voyageItineraryBerths": RelationshipDefinition,
"freightInvoiceDetails": RelationshipDefinition,
"nonAccrualsOperationsInvoiceDetails": RelationshipDefinition,
"tcoBrokers": RelationshipDefinition,
"cargos": RelationshipDefinition,
"cargoGrades": RelationshipDefinition,
"boatEquipmentEvents": RelationshipDefinition,
"bargeEquipmentEvents": RelationshipDefinition,
"contractedEquipmentEvents": RelationshipDefinition,
"voyageBunkerLifting": RelationshipDefinition,
"voyageAllRemarks": RelationshipDefinition,
"alerts": RelationshipDefinition,
"voyageCargoHandlingsAlert": RelationshipDefinition,
"tcoVoyageItinerariesAlert": RelationshipDefinition,
"voyageActPnls": RelationshipDefinition,
"voyageProjectedInvoice": RelationshipDefinition,
"voyageLegSummary": RelationshipDefinition,
"voyageLegDetails": RelationshipDefinition,
"voyagePnlSummary": RelationshipDefinition,
"orderedVoyageItineraries": RelationshipDefinition,
"voyageCargoTransferHandlings": RelationshipDefinition,
"voyageCargoTransfers": RelationshipDefinition,
"voyageInstruction": RelationshipDefinition,
"attachments": RelationshipDefinition,
"voyageNote": RelationshipDefinition
}
VoyageRemarks
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
vesselCode - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageNo - Int
|
|
seqNo - Int
|
|
type - String
|
|
remark - String
|
|
lastUpdateGmt - Date
|
|
entryDateGmt - Date
|
|
voyageItinerary - VoyageItinerary
|
|
voyage - Voyage
|
|
vessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"vesselCode": "xyz789",
"customFieldByID": Any,
"customField": Any,
"voyageNo": 987,
"seqNo": 123,
"type": "xyz789",
"remark": "abc123",
"lastUpdateGmt": "2007-12-03",
"entryDateGmt": "2007-12-03",
"voyageItinerary": VoyageItinerary,
"voyage": Voyage,
"vessel": Vessel,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageRemarksFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageRemarksFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageRemarksFormQueryWhere
}
VoyageRemarksFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [VoyageRemarksFormQueryWhere!]
|
|
or - [VoyageRemarksFormQueryWhere!]
|
|
rawExpression - String
|
|
vesselCode - StringWhereValueExpression
|
|
voyageNo - NumberWhereValueExpression
|
|
seqNo - NumberWhereValueExpression
|
|
type - VoyageRemarksTypeEnumValueExpression
|
|
remark - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
voyageItinerary - VoyageItineraryFormQueryWhere
|
|
voyage - VoyageFormQueryWhere
|
|
vessel - VesselFormQueryWhere
|
Example
{
"and": [VoyageRemarksFormQueryWhere],
"or": [VoyageRemarksFormQueryWhere],
"rawExpression": "xyz789",
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"seqNo": NumberWhereValueExpression,
"type": VoyageRemarksTypeEnumValueExpression,
"remark": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"voyageItinerary": VoyageItineraryFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"vessel": VesselFormQueryWhere
}
VoyageRemarksRelationships
Fields
| Field Name | Description |
|---|---|
voyageItinerary - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
Example
{
"voyageItinerary": RelationshipDefinition,
"voyage": RelationshipDefinition,
"vessel": RelationshipDefinition
}
VoyageRemarksTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
VoyageRemarksTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageRemarksTypeEnum
|
|
isNot - VoyageRemarksTypeEnum
|
|
isIn - [VoyageRemarksTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VoyageRootQuery
Fields
| Field Name | Description |
|---|---|
processPositionReport - ProcessPositionReportResult
|
|
Arguments
|
|
processEtaEtd - ProcessEtaEtdResult
|
|
Arguments
|
|
processPortActivityList - ProcessPortActivityListResult
|
|
Arguments
|
|
processUpcomingPortsList - ProcessUpcomingPortsListResult
|
|
Arguments
|
|
processDelay - ProcessDelayResult
|
|
Arguments
|
|
processCargoHandlingList - ProcessCargoHandlingListResult
|
|
Arguments
|
|
processVeslinkForm - ProcessVeslinkFormResult
|
|
Arguments
|
|
recalculateVoyage - RecalculateVoyageResult
|
|
Arguments
|
|
Example
{
"processPositionReport": ProcessPositionReportResult,
"processEtaEtd": ProcessEtaEtdResult,
"processPortActivityList": ProcessPortActivityListResult,
"processUpcomingPortsList": ProcessUpcomingPortsListResult,
"processDelay": ProcessDelayResult,
"processCargoHandlingList": ProcessCargoHandlingListResult,
"processVeslinkForm": ProcessVeslinkFormResult,
"recalculateVoyage": RecalculateVoyageResult
}
VoyageScrubberTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
VoyageScrubberTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageScrubberTypeEnum
|
|
isNot - VoyageScrubberTypeEnum
|
|
isIn - [VoyageScrubberTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
VoyageTemplate
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
iD - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
name - String
|
|
description - String
|
|
hasCustomLaytimeCommence - Boolean
|
|
hasCustomLaytimeComplete - Boolean
|
|
hasEtaChangeTrackingEnabled - Boolean
|
|
hasLockEtaEtdEnabled - Boolean
|
|
hasAutoCreateMultiEstDemEnabled - Boolean
|
|
hasDefaultAutoUpdateEstDemEnabled - Boolean
|
|
hasPreserveTermFactorEnabled - Boolean
|
|
lastUser - String
|
|
laytimeCalcMethod - String
|
|
laytimeCalcDurationFormat - String
|
|
laytimeCommencePortActName - String
|
|
laytimeCommencePortActOffsetHours - Float
|
|
laytimeCompletePortActName - String
|
|
laytimeCompletePortActOffsetHours - Float
|
|
taskGroupName - String
|
|
voyageTemplateRecipients - [VoyageTemplateRecipient]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"iD": 123,
"customFieldByID": Any,
"customField": Any,
"name": "xyz789",
"description": "xyz789",
"hasCustomLaytimeCommence": true,
"hasCustomLaytimeComplete": true,
"hasEtaChangeTrackingEnabled": true,
"hasLockEtaEtdEnabled": false,
"hasAutoCreateMultiEstDemEnabled": true,
"hasDefaultAutoUpdateEstDemEnabled": true,
"hasPreserveTermFactorEnabled": true,
"lastUser": "abc123",
"laytimeCalcMethod": "xyz789",
"laytimeCalcDurationFormat": "xyz789",
"laytimeCommencePortActName": "xyz789",
"laytimeCommencePortActOffsetHours": 123.45,
"laytimeCompletePortActName": "xyz789",
"laytimeCompletePortActOffsetHours": 987.65,
"taskGroupName": "abc123",
"voyageTemplateRecipients": [VoyageTemplateRecipient],
"_keys": ["abc123"],
"_intents": ["xyz789"],
"aggregate": Any
}
VoyageTemplateFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - VoyageTemplateFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": VoyageTemplateFormQueryWhere
}
VoyageTemplateFormQueryWhere
Fields
Example
{
"and": [VoyageTemplateFormQueryWhere],
"or": [VoyageTemplateFormQueryWhere],
"rawExpression": "abc123",
"iD": NumberWhereValueExpression,
"name": StringWhereValueExpression,
"description": StringWhereValueExpression,
"hasCustomLaytimeCommence": BoolWhereValueExpression,
"hasCustomLaytimeComplete": BoolWhereValueExpression,
"hasEtaChangeTrackingEnabled": BoolWhereValueExpression,
"hasLockEtaEtdEnabled": BoolWhereValueExpression,
"hasAutoCreateMultiEstDemEnabled": BoolWhereValueExpression,
"hasDefaultAutoUpdateEstDemEnabled": BoolWhereValueExpression,
"hasPreserveTermFactorEnabled": BoolWhereValueExpression,
"lastUser": StringWhereValueExpression,
"laytimeCalcMethod": StringWhereValueExpression,
"laytimeCalcDurationFormat": StringWhereValueExpression,
"laytimeCommencePortActName": StringWhereValueExpression,
"laytimeCommencePortActOffsetHours": NumberWhereValueExpression,
"laytimeCompletePortActName": StringWhereValueExpression,
"laytimeCompletePortActOffsetHours": NumberWhereValueExpression,
"taskGroupName": StringWhereValueExpression
}
VoyageTemplateRecipient
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
sqlID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
voyageTemplateID - Int
|
|
emailType - String
|
|
type - String
|
|
role - String
|
|
formType - String
|
|
companyType - String
|
|
companyShortName - String
|
|
subcontactSeqNo - Int
|
|
lastUpdateGmt - Date
|
|
company - AddressBook
|
|
voyageTemplate - VoyageTemplate
|
|
_keys - [String]
|
|
_intents - [String]
|
|
Example
{
"_id": "abc123",
"sqlID": 123,
"customFieldByID": Any,
"customField": Any,
"voyageTemplateID": 123,
"emailType": "xyz789",
"type": "xyz789",
"role": "abc123",
"formType": "abc123",
"companyType": "xyz789",
"companyShortName": "xyz789",
"subcontactSeqNo": 987,
"lastUpdateGmt": "2007-12-03",
"company": AddressBook,
"voyageTemplate": VoyageTemplate,
"_keys": ["xyz789"],
"_intents": ["abc123"]
}
VoyageTemplateRecipientRelationships
Fields
| Field Name | Description |
|---|---|
company - RelationshipDefinition
|
|
voyageTemplate - RelationshipDefinition
|
|
subcontact - RelationshipDefinition
|
Example
{
"company": RelationshipDefinition,
"voyageTemplate": RelationshipDefinition,
"subcontact": RelationshipDefinition
}
VoyageTemplateRelationships
Fields
| Field Name | Description |
|---|---|
voyageTemplateRecipients - RelationshipDefinition
|
|
voyageInstructionsRecipients - RelationshipDefinition
|
Example
{
"voyageTemplateRecipients": RelationshipDefinition,
"voyageInstructionsRecipients": RelationshipDefinition
}
VoyageVoyageStatusCodeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Scheduled"
VoyageVoyageStatusCodeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - VoyageVoyageStatusCodeEnum
|
|
isNot - VoyageVoyageStatusCodeEnum
|
|
isIn - [VoyageVoyageStatusCodeEnum]
|
Example
{"is": "Scheduled", "isNot": "Scheduled", "isIn": ["Scheduled"]}
Waterway
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
system - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
code - String
|
|
name - String
|
|
upstreamSpeed - Float
|
|
downstreamSpeed - Float
|
|
milemarkerFrom - Int
|
|
milemarkerTo - Int
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"system": "xyz789",
"customFieldByID": Any,
"customField": Any,
"code": "abc123",
"name": "abc123",
"upstreamSpeed": 987.65,
"downstreamSpeed": 123.45,
"milemarkerFrom": 123,
"milemarkerTo": 123,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
WaterwayFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - WaterwayFormQueryWhere
|
Example
{
"limit": 987,
"offset": 987,
"filter": "abc123",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": WaterwayFormQueryWhere
}
WaterwayFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [WaterwayFormQueryWhere!]
|
|
or - [WaterwayFormQueryWhere!]
|
|
rawExpression - String
|
|
system - StringWhereValueExpression
|
|
code - StringWhereValueExpression
|
|
name - StringWhereValueExpression
|
|
upstreamSpeed - NumberWhereValueExpression
|
|
downstreamSpeed - NumberWhereValueExpression
|
|
milemarkerFrom - NumberWhereValueExpression
|
|
milemarkerTo - NumberWhereValueExpression
|
Example
{
"and": [WaterwayFormQueryWhere],
"or": [WaterwayFormQueryWhere],
"rawExpression": "xyz789",
"system": StringWhereValueExpression,
"code": StringWhereValueExpression,
"name": StringWhereValueExpression,
"upstreamSpeed": NumberWhereValueExpression,
"downstreamSpeed": NumberWhereValueExpression,
"milemarkerFrom": NumberWhereValueExpression,
"milemarkerTo": NumberWhereValueExpression
}
WeatherState
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
type - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
scaleNo - Int
|
|
description - String
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"type": "xyz789",
"customFieldByID": Any,
"customField": Any,
"scaleNo": 123,
"description": "xyz789",
"lastUser": "abc123",
"lastUpdateGmt": "2007-12-03",
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
WeatherStateFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - WeatherStateFormQueryWhere
|
Example
{
"limit": 123,
"offset": 987,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": WeatherStateFormQueryWhere
}
WeatherStateFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [WeatherStateFormQueryWhere!]
|
|
or - [WeatherStateFormQueryWhere!]
|
|
rawExpression - String
|
|
type - WeatherStateTypeEnumValueExpression
|
|
scaleNo - NumberWhereValueExpression
|
|
description - StringWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
Example
{
"and": [WeatherStateFormQueryWhere],
"or": [WeatherStateFormQueryWhere],
"rawExpression": "xyz789",
"type": WeatherStateTypeEnumValueExpression,
"scaleNo": NumberWhereValueExpression,
"description": StringWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression
}
WeatherStateTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
WeatherStateTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - WeatherStateTypeEnum
|
|
isNot - WeatherStateTypeEnum
|
|
isIn - [WeatherStateTypeEnum]
|
Example
{"is": "None", "isNot": "None", "isIn": ["None"]}
Worksheet
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
positionName - String
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
openPortName - String
|
|
estimateCount - Int
|
|
worksheetID - Int
|
|
worksheetName - String
|
|
intendedEstimateID - String
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
isLocked - Boolean
|
|
worksheetType - String
|
|
vesselCode - String
|
|
voyageNo - Int
|
|
tcCode - String
|
|
cargoID - Int
|
|
programID - String
|
|
positionEstimateID - String
|
|
referenceID - String
|
|
positionID - String
|
|
sourceWorksheet - Int
|
|
worksheet - Worksheet
|
|
cargo - Cargo
|
|
vessel - Vessel
|
|
timeCharterContract - TimeCharterContract
|
|
voyageEstimate - VoyageEstimate
|
|
voyage - Voyage
|
|
marketPosition - MarketPosition
|
|
worksheetVessels - [WorksheetVessel]
|
|
worksheetPriceComponents - [WorksheetPriceComponent]
|
|
worksheetEstimates - [WorksheetEstimate]
|
|
voyageEstimateCOACVCAnalysisResults - [VoyageEstimateCOACVCAnalysisResult]
|
|
voyageEstimateCOACVCAnalysis - [VoyageEstimateCOACVCAnalysis]
|
|
benchmarkSensitivities - [BenchmarkSensitivity]
|
|
benchmarkResults - [BenchmarkResult]
|
|
worksheetEst - [WorksheetEstimate]
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"positionName": "xyz789",
"customFieldByID": Any,
"customField": Any,
"openPortName": "abc123",
"estimateCount": 987,
"worksheetID": 123,
"worksheetName": "abc123",
"intendedEstimateID": "xyz789",
"entryDateGmt": "2007-12-03",
"lastUser": "abc123",
"lastUpdateGmt": "2007-12-03",
"isLocked": false,
"worksheetType": "abc123",
"vesselCode": "xyz789",
"voyageNo": 987,
"tcCode": "abc123",
"cargoID": 123,
"programID": "abc123",
"positionEstimateID": "abc123",
"referenceID": "abc123",
"positionID": "abc123",
"sourceWorksheet": 987,
"worksheet": Worksheet,
"cargo": Cargo,
"vessel": Vessel,
"timeCharterContract": TimeCharterContract,
"voyageEstimate": VoyageEstimate,
"voyage": Voyage,
"marketPosition": MarketPosition,
"worksheetVessels": [WorksheetVessel],
"worksheetPriceComponents": [WorksheetPriceComponent],
"worksheetEstimates": [WorksheetEstimate],
"voyageEstimateCOACVCAnalysisResults": [
VoyageEstimateCOACVCAnalysisResult
],
"voyageEstimateCOACVCAnalysis": [
VoyageEstimateCOACVCAnalysis
],
"benchmarkSensitivities": [BenchmarkSensitivity],
"benchmarkResults": [BenchmarkResult],
"worksheetEst": [WorksheetEstimate],
"_keys": ["abc123"],
"_intents": ["abc123"],
"aggregate": Any
}
WorksheetEstimate
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
worksheetID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
estimateID - String
|
|
orderNo - Int
|
|
entryDateGmt - Date
|
|
lastUser - String
|
|
lastUpdateGmt - Date
|
|
isManualWeight - Boolean
|
|
weight - Float
|
|
worksheet - Worksheet
|
|
voyageEstimate - VoyageEstimate
|
|
updateFreightMatrixQuoteMessages - [UpdateFreightMatrixQuoteMessageRecord]
|
|
Arguments
|
|
calculateVesselValuationMessages - [CalculateVesselValuationMessageRecord]
|
|
Arguments
|
|
changesSinceLast - WorksheetEstimateChangesSinceLast
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "abc123",
"worksheetID": 123,
"customFieldByID": Any,
"customField": Any,
"estimateID": "xyz789",
"orderNo": 987,
"entryDateGmt": "2007-12-03",
"lastUser": "xyz789",
"lastUpdateGmt": "2007-12-03",
"isManualWeight": true,
"weight": 987.65,
"worksheet": Worksheet,
"voyageEstimate": VoyageEstimate,
"updateFreightMatrixQuoteMessages": [
UpdateFreightMatrixQuoteMessageRecord
],
"calculateVesselValuationMessages": [
CalculateVesselValuationMessageRecord
],
"changesSinceLast": WorksheetEstimateChangesSinceLast,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
WorksheetEstimateChangesSinceLast
Fields
| Field Name | Description |
|---|---|
updateFreightMatrixQuote - MessageUpdateResponse
|
|
calculateVesselValuation - MessageUpdateResponse
|
Example
{
"updateFreightMatrixQuote": MessageUpdateResponse,
"calculateVesselValuation": MessageUpdateResponse
}
WorksheetEstimateFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - WorksheetEstimateFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": WorksheetEstimateFormQueryWhere
}
WorksheetEstimateFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [WorksheetEstimateFormQueryWhere!]
|
|
or - [WorksheetEstimateFormQueryWhere!]
|
|
rawExpression - String
|
|
worksheetID - NumberWhereValueExpression
|
|
estimateID - StringWhereValueExpression
|
|
orderNo - NumberWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
isManualWeight - BoolWhereValueExpression
|
|
weight - NumberWhereValueExpression
|
|
worksheet - WorksheetFormQueryWhere
|
|
voyageEstimate - VoyageEstimateFormQueryWhere
|
Example
{
"and": [WorksheetEstimateFormQueryWhere],
"or": [WorksheetEstimateFormQueryWhere],
"rawExpression": "abc123",
"worksheetID": NumberWhereValueExpression,
"estimateID": StringWhereValueExpression,
"orderNo": NumberWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"isManualWeight": BoolWhereValueExpression,
"weight": NumberWhereValueExpression,
"worksheet": WorksheetFormQueryWhere,
"voyageEstimate": VoyageEstimateFormQueryWhere
}
WorksheetEstimateRelationships
Fields
| Field Name | Description |
|---|---|
worksheet - RelationshipDefinition
|
|
voyageEstimate - RelationshipDefinition
|
Example
{
"worksheet": RelationshipDefinition,
"voyageEstimate": RelationshipDefinition
}
WorksheetFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - WorksheetFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["xyz789"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": WorksheetFormQueryWhere
}
WorksheetFormQueryWhere
Fields
Example
{
"and": [WorksheetFormQueryWhere],
"or": [WorksheetFormQueryWhere],
"rawExpression": "abc123",
"worksheetID": NumberWhereValueExpression,
"worksheetName": StringWhereValueExpression,
"intendedEstimateID": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"isLocked": BoolWhereValueExpression,
"worksheetType": WorksheetWorksheetTypeEnumValueExpression,
"vesselCode": StringWhereValueExpression,
"voyageNo": NumberWhereValueExpression,
"tcCode": StringWhereValueExpression,
"cargoID": NumberWhereValueExpression,
"programID": StringWhereValueExpression,
"positionEstimateID": StringWhereValueExpression,
"referenceID": StringWhereValueExpression,
"positionID": StringWhereValueExpression,
"sourceWorksheet": NumberWhereValueExpression,
"worksheet": WorksheetFormQueryWhere,
"cargo": CargoFormQueryWhere,
"vessel": VesselFormQueryWhere,
"timeCharterContract": TimeCharterContractFormQueryWhere,
"voyageEstimate": VoyageEstimateFormQueryWhere,
"voyage": VoyageFormQueryWhere,
"marketPosition": MarketPositionFormQueryWhere
}
WorksheetPriceComponent
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
worksheetID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
component - String
|
|
componentDescription - String
|
|
ordNo - Int
|
|
unit - String
|
|
rate - Float
|
|
methodName - String
|
|
indexRoute - String
|
|
indexPeriod - String
|
|
indexDate - Date
|
|
midPoint - Float
|
|
step - Float
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
entryDateGmt - Date
|
|
rateDescription - String
|
|
fuelType - String
|
|
worksheet - Worksheet
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"worksheetID": 123,
"customFieldByID": Any,
"customField": Any,
"component": "xyz789",
"componentDescription": "abc123",
"ordNo": 987,
"unit": "xyz789",
"rate": 987.65,
"methodName": "xyz789",
"indexRoute": "xyz789",
"indexPeriod": "xyz789",
"indexDate": "2007-12-03",
"midPoint": 123.45,
"step": 123.45,
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123",
"entryDateGmt": "2007-12-03",
"rateDescription": "xyz789",
"fuelType": "xyz789",
"worksheet": Worksheet,
"_keys": ["xyz789"],
"_intents": ["abc123"],
"aggregate": Any
}
WorksheetPriceComponentFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - WorksheetPriceComponentFormQueryWhere
|
Example
{
"limit": 123,
"offset": 123,
"filter": "xyz789",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": WorksheetPriceComponentFormQueryWhere
}
WorksheetPriceComponentFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [WorksheetPriceComponentFormQueryWhere!]
|
|
or - [WorksheetPriceComponentFormQueryWhere!]
|
|
rawExpression - String
|
|
worksheetID - NumberWhereValueExpression
|
|
component - StringWhereValueExpression
|
|
componentDescription - StringWhereValueExpression
|
|
ordNo - NumberWhereValueExpression
|
|
unit - StringWhereValueExpression
|
|
rate - NumberWhereValueExpression
|
|
methodName - StringWhereValueExpression
|
|
indexRoute - StringWhereValueExpression
|
|
indexPeriod - StringWhereValueExpression
|
|
indexDate - DateWhereValueExpression
|
|
midPoint - NumberWhereValueExpression
|
|
step - NumberWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
rateDescription - StringWhereValueExpression
|
|
fuelType - StringWhereValueExpression
|
|
worksheet - WorksheetFormQueryWhere
|
Example
{
"and": [WorksheetPriceComponentFormQueryWhere],
"or": [WorksheetPriceComponentFormQueryWhere],
"rawExpression": "xyz789",
"worksheetID": NumberWhereValueExpression,
"component": StringWhereValueExpression,
"componentDescription": StringWhereValueExpression,
"ordNo": NumberWhereValueExpression,
"unit": StringWhereValueExpression,
"rate": NumberWhereValueExpression,
"methodName": StringWhereValueExpression,
"indexRoute": StringWhereValueExpression,
"indexPeriod": StringWhereValueExpression,
"indexDate": DateWhereValueExpression,
"midPoint": NumberWhereValueExpression,
"step": NumberWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"rateDescription": StringWhereValueExpression,
"fuelType": StringWhereValueExpression,
"worksheet": WorksheetFormQueryWhere
}
WorksheetPriceComponentRelationships
Fields
| Field Name | Description |
|---|---|
worksheet - RelationshipDefinition
|
Example
{"worksheet": RelationshipDefinition}
WorksheetRelationships
Fields
| Field Name | Description |
|---|---|
worksheet - RelationshipDefinition
|
|
cargo - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
|
timeCharterContract - RelationshipDefinition
|
|
voyageEstimate - RelationshipDefinition
|
|
voyage - RelationshipDefinition
|
|
marketPosition - RelationshipDefinition
|
|
worksheetVessels - RelationshipDefinition
|
|
worksheetPriceComponents - RelationshipDefinition
|
|
worksheetEstimates - RelationshipDefinition
|
|
voyageEstimateCOACVCAnalysisResults - RelationshipDefinition
|
|
voyageEstimateCOACVCAnalysis - RelationshipDefinition
|
|
benchmarkSensitivities - RelationshipDefinition
|
|
benchmarkResults - RelationshipDefinition
|
|
worksheetEst - RelationshipDefinition
|
Example
{
"worksheet": RelationshipDefinition,
"cargo": RelationshipDefinition,
"vessel": RelationshipDefinition,
"timeCharterContract": RelationshipDefinition,
"voyageEstimate": RelationshipDefinition,
"voyage": RelationshipDefinition,
"marketPosition": RelationshipDefinition,
"worksheetVessels": RelationshipDefinition,
"worksheetPriceComponents": RelationshipDefinition,
"worksheetEstimates": RelationshipDefinition,
"voyageEstimateCOACVCAnalysisResults": RelationshipDefinition,
"voyageEstimateCOACVCAnalysis": RelationshipDefinition,
"benchmarkSensitivities": RelationshipDefinition,
"benchmarkResults": RelationshipDefinition,
"worksheetEst": RelationshipDefinition
}
WorksheetVessel
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
worksheetID - Int
|
|
customFieldByID - Any
|
Fetches a user-defined custom field by its identifier (Seq) |
Arguments
|
|
customField - Any
|
Fetches a user-defined custom field by either its field name (Link ID) or its prompt. |
Arguments
|
|
vesselCode - String
|
|
vesselName - String
|
|
orderNo - Int
|
|
deadweight - Float
|
|
ballastSpeed - Float
|
|
ladenSpeed - Float
|
|
isManualSpeed - Boolean
|
|
lastUpdateGmt - Date
|
|
lastUser - String
|
|
entryDateGmt - Date
|
|
worksheet - Worksheet
|
|
vessel - Vessel
|
|
_keys - [String]
|
|
_intents - [String]
|
|
aggregate - Any
|
|
Arguments
|
|
Example
{
"_id": "xyz789",
"worksheetID": 987,
"customFieldByID": Any,
"customField": Any,
"vesselCode": "xyz789",
"vesselName": "abc123",
"orderNo": 987,
"deadweight": 987.65,
"ballastSpeed": 123.45,
"ladenSpeed": 123.45,
"isManualSpeed": true,
"lastUpdateGmt": "2007-12-03",
"lastUser": "abc123",
"entryDateGmt": "2007-12-03",
"worksheet": Worksheet,
"vessel": Vessel,
"_keys": ["xyz789"],
"_intents": ["xyz789"],
"aggregate": Any
}
WorksheetVesselFormQuery
Fields
| Input Field | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
filter - String
|
|
order - [String!]
|
Fields to order by, prefix with - for descending |
querySettings - Json
|
|
aggregations - [DataAggregator]
|
|
where - WorksheetVesselFormQueryWhere
|
Example
{
"limit": 987,
"offset": 123,
"filter": "abc123",
"order": ["abc123"],
"querySettings": Json,
"aggregations": [DataAggregator],
"where": WorksheetVesselFormQueryWhere
}
WorksheetVesselFormQueryWhere
Fields
| Input Field | Description |
|---|---|
and - [WorksheetVesselFormQueryWhere!]
|
|
or - [WorksheetVesselFormQueryWhere!]
|
|
rawExpression - String
|
|
worksheetID - NumberWhereValueExpression
|
|
vesselCode - StringWhereValueExpression
|
|
vesselName - StringWhereValueExpression
|
|
orderNo - NumberWhereValueExpression
|
|
deadweight - NumberWhereValueExpression
|
|
ballastSpeed - NumberWhereValueExpression
|
|
ladenSpeed - NumberWhereValueExpression
|
|
isManualSpeed - BoolWhereValueExpression
|
|
lastUpdateGmt - DateWhereValueExpression
|
|
lastUser - StringWhereValueExpression
|
|
entryDateGmt - DateWhereValueExpression
|
|
worksheet - WorksheetFormQueryWhere
|
|
vessel - VesselFormQueryWhere
|
Example
{
"and": [WorksheetVesselFormQueryWhere],
"or": [WorksheetVesselFormQueryWhere],
"rawExpression": "xyz789",
"worksheetID": NumberWhereValueExpression,
"vesselCode": StringWhereValueExpression,
"vesselName": StringWhereValueExpression,
"orderNo": NumberWhereValueExpression,
"deadweight": NumberWhereValueExpression,
"ballastSpeed": NumberWhereValueExpression,
"ladenSpeed": NumberWhereValueExpression,
"isManualSpeed": BoolWhereValueExpression,
"lastUpdateGmt": DateWhereValueExpression,
"lastUser": StringWhereValueExpression,
"entryDateGmt": DateWhereValueExpression,
"worksheet": WorksheetFormQueryWhere,
"vessel": VesselFormQueryWhere
}
WorksheetVesselRelationships
Fields
| Field Name | Description |
|---|---|
worksheet - RelationshipDefinition
|
|
vessel - RelationshipDefinition
|
Example
{
"worksheet": RelationshipDefinition,
"vessel": RelationshipDefinition
}
WorksheetWorksheetTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Scratch"
WorksheetWorksheetTypeEnumValueExpression
Fields
| Input Field | Description |
|---|---|
is - WorksheetWorksheetTypeEnum
|
|
isNot - WorksheetWorksheetTypeEnum
|
|
isIn - [WorksheetWorksheetTypeEnum]
|
Example
{"is": "Scratch", "isNot": "Scratch", "isIn": ["Scratch"]}
aPAR
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"AP"
aPAROverride
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"AP"
ballastLaden
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Ballast"
fuelType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"HFO"
join__FieldSet
Example
join__FieldSet
join__Graph
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FLEETMAP_API"
legType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Port"
link__Import
Example
link__Import
link__Purpose
Values
| Enum Value | Description |
|---|---|
|
|
SECURITY features provide metadata necessary to securely resolve fields.
|
|
|
EXECUTION features provide metadata necessary for operation execution.
|
Example
"SECURITY"
type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BulkCarrier"
voyageType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TimeCharter"