Bunker Transactions

Prerequisites

Before setting up and testing a bunker transaction integration other integrations need to be in place.

• 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.

Integration Set-Up

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

Test Data

Test data for bunker transactions can be generated in Booking and Operations > Bunkers-FO tab > Bunker Transactions.

Data Transaction

To get bunker transactions that are ready for posting in Webhooks the following subscription can be created:

{
    "eventType":"U",
    "user": the user code to be used in the subscription,
    "objectType":"Document",
    "expression": "{"type":"group","id":"root","combine":"AND","items":[{"type":"condition","condition":{"id":"1782903512505-wqx06zl","operator":"=","leftKind":"field","leftField":{"path":["invoicingStatus","statusTypeCode"],"type":"object","arrayFilters":[]},"leftSource":"current","rightKind":"literal","rightValue":"RFP"}},{"type":"condition","condition":{"id":"1782903524453-kmp0t03","operator":"=","leftKind":"field","leftField":{"path":["documentType","documentType"],"type":"object","arrayFilters":[]},"leftSource":"current","rightKind":"literal","rightValue":"ACC"}}],"version":2}",
    "url":"your webhook url"
}

If you use the expression builder, create an expression like this: invoicingStatus.statusTypeCode = "RFP" AND documentType.documentType = "ACC"

Alternatively a scheduled job can be setup to use the following request:

Get bunker transactions that are ready for posting to accounting

GET /Document?filter=invoicingStatus.statusTypeCode(EQ)RFP&filter=documentType.documentType(EQ)ACC

Post Transaction

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

Update status to posted for a specific invoice

PUT /Document/{key}
  
{
    "invoicingStatus": "POS"
}