Knowledge Base
About DataloyRelease NotesAPI DocumentationJava VMS Documentation
Release 8.0
Release 8.0
  • Knowledge Base
  • Voyage Management System
    • VMS: Step-By-Step Guides
      • Vessels
        • Create Vessels
        • Copy Vessel
        • Find Vessels
        • Voyages & Port Calls
        • Main Vessel Description
        • Speed & Consumption
        • Load & Discharge Rates
          • Manage Load And Discharge Rates
        • Internal Data
        • AIS & Weather Reports
        • AIS-subscription
        • View Vessel Route from Previous Port to Next Port
      • Voyages
        • Create New Voyages
          • Create Voyage Charterer
          • Create Time Charter Out
          • Create Voyage From Template
          • Create Voyage Without Cargo
        • Find Voyages
        • Maintain Voyages
          • Overview
            • Vessel
            • Cargo
            • TC
            • Schedule
            • Profit/Loss Summary
              • Analysis
            • Speed & Consumption
          • Cargo
          • Bunkers
          • Various Cost/Revenue
          • Organisational Data
          • Invoices
          • Related
          • Voyage Functionalities
            • Converting Voyage to Template
            • Change Voyage Status
            • Swap Vessel
            • Configure Voyage as a “Last TC Voyage”
            • Change Voyage Reference Number/Voyage Number and Voyage Starting Year
            • Voyage Comparison
        • TC Voyages
        • Create Laytime Calculations
        • Delete Voyages
        • Voyage Map
        • Voyage Schedule
        • Voyage Edit Schedule
        • Voyage Alternative Routes
        • Voyage Functions
          • Sensitivity Analysis
          • Intake Calculation
        • Long Time Charter (TC) Voyage
        • Voyage Bunkers
      • Cargoes
        • Create New Cargoes
          • Create Cargo
          • Create Cargo From CoA Template
          • Create Cargo on TC Voyages
          • Create Cargo by Importing from Excel
          • Create Cargo From Existing Cargo
        • Find Cargoes
        • Maintain Cargoes
          • Cargo drawer
            • Main Details
            • Sub-cargoes
            • Various Cost/Revenue
            • Commissions
            • Freight Rate Tiers
            • Payment Terms
            • Comments
            • Cargo Drawer Actions
              • Allocate Cargo
              • Change Cargo Status
              • Delete Cargo
              • Relet Cargo
              • Convert Cargo to Relet/Non-Relet
              • Transship and Preship Cargo
              • Transfer Cargo
              • Connect Cargo to CoA
              • Remove CoA from Cargo
        • Template Cargoes
        • Capacity Plan
        • Sub-cargo
        • View Cargo History
      • Port Calls
        • Find Port Calls
        • Maintain Port Calls
          • Days Extra In Port
          • Speed Order
        • Register Noon Reports
        • Register Arrivals
        • Register Berths
        • Register Unberths
        • Register In Port Reports
        • Register Departures
        • Use Cost from Service Orders
          • Automating the Use Cost from Service order
        • Port Call Bunkers and Overview
        • View Service Orders on Port Calls
        • View Bunker Orders on Port Calls
        • View Vessel Reports on Port Calls
        • View Port Log on Port Calls
          • Stoppages
      • Port Costs
        • Find Port Costs
        • Maintain Port Costs
        • View Service Orders of Port Costs
      • Contracts of Affreightment
        • Create Contracts of Affreightment
        • Maintain Contracts of Affreightment
        • Find Contracts of Affreightment
        • Contract of Affreightment Lines
          • Find Contract of Affreightment Lines
          • Create Contract of Affreightment Lines
          • Maintain Contract of Affreightment Lines
          • Template Cargoes
            • Create Template Cargo
            • Maintain Template Cargo
            • Find Template Cargo
      • Time Charter Contracts
        • Create Time Charter Contracts
        • Maintain Time Charter Contracts
          • Duration and Rates
            • Create Duration and Rates
          • Notices
          • Comissions
          • Payment Terms
          • View Speed & Consumption
        • Print Statement of Account
      • Broker Commissions
        • Create Commissions
        • Find Broker Commission
        • Maintain Broker Commission
      • Bunker Orders
        • Create Bunker Orders
          • Create from a port call
          • Create bunker order from scratch
        • Maintain Bunker Orders
        • Stem Bunker Orders
        • Register Delivery Against a Bunker Order
        • Cancel Bunker Order
        • Delete Bunker Order
      • Service Orders
        • Create Service Order
        • Maintain Service Order
        • Delete Service Order
      • Laytime Calculations
        • Create Laytime Calculation
        • Find Laytime Calculation
        • Delete Laytime Calculation
        • Maintain Laytime Calculation
          • Status
          • Drawer Fields
          • Manage Cargo Ports
            • Cargo Port Fields
            • Statement Of Facts
              • Event
            • Timesheet
      • Bills of Lading
        • Create Bills of Lading
        • Attachments
        • Edit Bills of Lading
        • Delete Bills of Lading
        • Print Bills of Lading
        • Print Sea Waybills
      • Offhire
        • Create Offhire
        • Find Offhire
        • Maintain Offhire
          • Delete Offhire
          • Copy Offhire
          • Status
          • Overview
          • Various Cost/Revenue
          • Comments
      • Vessel Reports
        • Find Vessel Reports
        • Create Vessel Reports
      • Voyage Analysis Dashboard
        • Log In
        • Viewing and Managing Deviated Voyages
          • Viewing and Managing Deviated Voyages
          • Viewing Post Voyage Analysis Detail
          • No Freight Received
      • Invoices
        • Invoices List
        • Pending Invoices
        • Assembling Invoices
        • Invoice Drawer
        • Printing Invoices
        • Reversing an Invoice
      • Bunker Transactions
      • Accruals
        • Accruals
          • Batch Post Accruals
          • Generate Accruals
          • Find Accruals
          • Maintain Accruals
        • Bunker Stock Adjustments List
          • Batch Post Bunker Stock Adjustments
          • Bunker Stock Adjustment Drawer
        • Actuals list
        • Time Correction list
      • Status Transitions
      • Webhook Subscriptions
        • Create Webhook Subscription
        • Find Webhook Subscription
        • Maintain Webhook Subscription
          • Overview
          • Notification
      • Setup
        • Users
          • Create Users
            • Create a Vessel Master user
          • Maintain Users
            • Change User Passwords
          • Find Users
          • Disable Users
          • Multi-Factor Authentication (MFA)
            • Guardian Multi-Factor Authentication (MFA)
        • Security Roles
          • Find Security Roles
          • Create Security Role
          • Maintain Security Roles
        • Security Groups
          • Security Group Aliases
          • Find Security Groups
          • Create Security Group
          • Maintain Security Groups
        • System Settings
          • General
          • Invoicing Preferences
        • Data Control
        • Widgets
      • Master Data
        • Banks
        • Bunker Categories
        • Bunker Types
        • Business Partners
          • Manage Business Partners
        • Companies
          • Manage Companies
        • Events
        • Ice Class
        • Individuals
        • Port
        • Restricted Areas
        • Taxes
        • Various Costs and Revenues
        • Vessel Types
      • EU ETS Compliance
      • Attachments
      • Audit Log
      • Comments
      • Notifications
      • Sorting and Filtering Lists
      • Customising List Columns
      • Export to Excel Sheet
      • Widgets
    • Oracle Database Compatibility
  • Fleet Allocation & Scheduling
    • FAS: Step-By-Step Guides
      • Capacity Plan
      • Fleet Plans
        • Open Positions Board
        • Scheduler Board
        • Cargo Management Board
          • Cargo Actions
        • FAS Voyages List
        • FAS Cargoes List
        • Voyage Actions
      • Scenarios
        • Find Scenario
        • Create Scenario
        • Maintain Scenario
        • Copy Scenario
      • Budgets
        • Create Budget Scenario
        • Template Voyages
          • Create Template Voyages
          • Find Template Voyages
          • Maintain Template Voyages
        • Budgeted Voyages
          • Find Budgeted Voyages
          • Bulk Updating Budgeted Voyages
    • Create Voyages (JVMS)
      • Create Commitment
      • Create Commitment from CoA
      • Create Commitment from Voyage Estimate
  • Dataloy Distance Table (DDT)
    • About Dataloy Distances
    • Routing and routing options
    • Custom Point using Latitude and Longitude
    • High-Risk Area (HRA) / Piracy Routing
    • Distances API
    • Distances Change Log
  • Dataloy Systems AS
    • Privacy Policy
    • GDPR Statement
    • Release Notes
Powered by GitBook
On this page
  • General invoice settings
  • Selectable Fields
  • Labels
  • Object paths

Was this helpful?

Export as PDF
  1. Voyage Management System
  2. VMS: Step-By-Step Guides
  3. Setup
  4. System Settings

Invoicing Preferences

PreviousGeneralNextData Control

Last updated 7 months ago

Was this helpful?

In this page, you will find settings related to the invoicing and invoice printout. Below the settings, you can find a section for setting up labels and paths for the different "Selectable Fields" sections; a feature of the new invoice template.

We are in the process of migrating the invoice settings from the Company drawer, to the System Settings Invoicing Preferences tab. Until this process is complete, some settings will reside under the Company drawer, others in the System Settings -> Invoicing Preferences tab.

For more details can be found on the page.

General invoice settings

Setting
Description

Display Total Amount in writing on invoice

Adds a line underneath the invoice total spelling out the currency and amount with words.

Print cargo external reference

Will add the external reference of the Cargo as a new line below the freight line on the invoice

Use new invoice template

System will generate invoice PDFs using the new invoice template. This setting is required to be turned on in order to use the Selectable Fields feature.

Selectable Fields

In Selectable Fields Below Header section, can choose up to 8 pairs of labels and object paths, while up to 4 pairs in Selectable Fields Below Document Lines section. The position of the labels and object paths are fixed, and can be referenced in the small preview picture in the blue area to the left. You can also read more about the invoice PDF itself .

  • If neither label nor object path is filled in, nothing will be printed in that position.

  • If a value cannot be fetched from the object path, nothing will be printed in that position

  • If no label is set, but a value can be fetched from the object path, only the fetched value will be printed in that position

Labels

Labels are fixed values for a given position that you can choose yourself, used to describe the value fetched from the object path.

Object paths

Object Paths are paths that describe the Dataloy API data-model, leading from object to object and terminating in a value. The object path starts from the Document object.

For instance, if you want to find and print the name of the vessel for a given document, you would do as follows. A Document have one or more DocumentLines. A DocumentLine is connected to a Voyage, which is connected to a Vessel. A Vessel has a VesselName. The final object path will thus be documentLines.voyage.vessel.vesselName.

To assist with setting up the object path, the Select Field modal is used.

The Select Field Modal

You can open this modal by clicking on the input field itself (which is non-editable), or click on this icon:

Both options will open up this modal:

Below the title, you can see the word document, which represents the root object of the modal. Meaning, you can search for anything inside the document object, or select one of the fields when scrolling up and down. You will quickly see that each sub-object will open up a new list of new objects again, e.g. Account will open up the possibility to choose Account Code, Account Desc, etc. You can also search on the objects within document > account, or scroll. Most of the valuable data is likely under document > documentLines.

You can also clear the the input field by clicking on this icon:

The icon is not visible until you have chosen a path first.

here
Invoicing Preferences tab
Example setup of both Selectable Fields sections
Select Field Icon
Select Field Modal
Clear Field Icon