🖍️
Dataloy VMS API Documentation
API Release 8.5
API Release 8.5
  • Dataloy VMS API
  • Dataloy Rest API
    • What is it?
    • Authentication / Authorization
    • Getting Started
    • Data Model
    • Filtering
    • Sorting
    • Pagination
    • Adjust Number of Fields to be Returned from a Request
    • Webhooks
      • Webhook example
      • Expressions Made Easy
      • Webhooks - New functionalities
    • Master data Objects
    • Attachments
    • Audit Log
  • User Guides
    • Accounting Integration API
      • Invoicing
      • Payments/Receipts
      • Voyages
      • Business Partners
      • Exchange Rates
      • Bunker Transactions
      • Actuals
      • Autopost Invoices
      • Accruals
    • Schedule API
    • Bunker Order Integration API
    • Service Order Integration API
    • Vessel Report
      • Release 8.5
      • Release 8.0
      • Release 7.3 - 7.12
      • Release 7.0 - 7.2
      • Release 6.29 - 6.46
      • Legacy version (6.26 - 6.28)
      • Vessel report master data
    • Bunker Consumption API
    • Left join in API queries
    • Enterprise functionalities
      • Versioning
      • Endpoint access control
      • Data access control via target object
      • Data access control via target object and security role
      • Data access control at object level
      • Fields access control
      • Alert Scripts
      • Websockets
      • Bulk Deletion
      • Copy objects
      • OR and AND operators in API queries
      • Sub queries
      • XML Transformation
      • Expressions
      • Bulk Update
Powered by GitBook
On this page
  • Invoicing
  • Prerequisites
  • Integration Set-Up
  • Reverse Invoice
  • Dissolve Invoice
  • Data Transaction
  • Get invoices that are ready for posting to accounting
  • Payment Terms
  • Test Data
  • Post Transaction
  • Update status to posted for a specific invoice

Was this helpful?

Export as PDF
  1. User Guides
  2. Accounting Integration API

Invoicing

Invoicing

Prerequisites

Certain integrations need to be in place before the set-up and testing of an invoice integration:

  • Transfer of voyage related data to the accounting system.

  • Synchronization of business partners between Dataloy VMS and the accounting system.

  • Exchange rate transfer to Dataloy VMS.

  • Map accounts between Dataloy VMS and the accounting system.

Integration Set-Up

When invoices are posted in Dataloy VMS, the document status is automatically set to Ready-for-Posting. Set up a scheduled task and use the request under Data Transaction to extract invoices and credit notes that are ready for posting. When an invoice is transferred to accounting, update the status to Posted.

Reverse Invoice

To reverse a posted invoice you need the document key and POST as in the example below

POST /Document/{document key}/reverse

Dissolve Invoice

To dissolve an assembled invoice you need the document key and POST as in the example below

POST /Document/{document key}/dissolve

Data Transaction

{
    "eventType":"U",
    "user": the user code to be used in the subscription,
    "objectType":"Document",
    "expression": "dlpObject.getInvoicingStatus() != null && dlpObject.getInvoicingStatus().getStatusTypeCode().equals(\"RFP\") && (dlpObject.getDocumentType().getDocumentType().equals(\"INO\") || dlpObject.getDocumentType().getDocumentType().equals(\"INI\") || dlpObject.getDocumentType().getDocumentType().equals(\"CRI\") || dlpObject.getDocumentType().getDocumentType().equals(\"CRO\"))",
    "url": "your webhook url"
}

Alternatively, a scheduled job can be set-up to use the following request:

Get invoices that are ready for posting to accounting

GET /Document?filter=invoicingStatus.statusTypeCode(EQ)RFP&filter=documentType.documentType(IN)(INI,INO,CRI,CRO)

Payment Terms

To create two documents when integrating:

  1. Loop on paymentTerms and create one document for each payment term.

  2. Calculate the following values:

    • dueDate: document.documentPaymentTerms.dueDate

    • documentAmount: document.documentAmount * document.documentPaymentTerms.percentage / 100

    • companyCurrencyAmount: document.companyCurrencyAmount * document.documentPaymentTerms.percentage / 100

    • sourceCurrencyAmount: document.sourceCurrencyAmount * document.documentPaymentTerms.percentage / 100

Test Data

Post Transaction

When an invoice is successfully transferred to an accounting system, the document status must be updated to Posted in Dataloy VMS. This is done in a PUT request:

Update status to posted for a specific invoice

PUT request on /Document/{key}
  
{
    "invoicingStatus": "POS"
}
PreviousAccounting Integration APINextPayments/Receipts

Was this helpful?

To get invoices that are ready for posting in the following subscription can be created:

There will be only one Document object in the API despite two payment terms for an invoice (for example 95/5 percent). However, the Document will have two objects in the Document.documentPaymentTerms list.

Test data for invoicing integration can be generated in the Dataloy VMS modules (, and ).

Webhooks
documentPaymentTerms
post fixture
Accounts Receivable
Accounts Payable
Hire Payable