Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Short Description

...

Test data for invoicing integration can be generated in the Dataloy VMS post fixture modules (Accounts Receivable, Accounts Payable and Hire Payable).

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:

...

Code Block
titleGet all fixed voyages modified since given date
GET /VoyageHeader?filter=modifiedDate(GTE)2014-01-01T12:30:00

Post Transaction 

No post transaction is required.

...

Create test data for transferring business partners from Dataloy VMS by updating Business Partners in Master Data.

Post Transaction 

No post transaction is required.

...

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

...

More information: /DocumentType/Document.

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:

...

  • A payment record should ONLY ever have one document line. Never more.

More information: /DocumentType/Document.

Amount Prefix

This matrix is showing which prefix the payment amount should have for the various cases.

...

Code Block
titlePost a payment/receipt to Dataloy
POST /Document
 
{
    "documentAmount": 10000.00,
    "companyCurrencyAmount": 10000.00,
    "sourceCurrencyAmount": 10000.00,
    "documentCurrency": "USD",
    "documentDate": "2014-01-01T00:00:00",
    "documentType": "PMO",
    "documentNo": "111111199",
	"externalDocumentNo": "50300",
    "company": "01",
    "businessPartner": "60526",
    "invoicingStatus": "POS",    
    "documentText": "text here",
    "documentLines": 
    [
        {
            "documentAmount": 10000.00,
            "companyCurrencyAmount": 10000.00,
            "sourceCurrencyAmount": 10000.00,
            "documentCurrency": "USD",
            "invoicingStatus": "POS",
            "documentLineText": "text here",
            "businessPartner": "BPCODE",
            "isAccountsPayable": true,
            "refDocument": "71800125"
        }
    ]    
}

More information: /DocumentType/Document.


Note

documentNo can be skipped. The payment will then get the new document key as documentNo. If skipping then remove documentNo from JSON, do not set the value empty.

...

Create an invoice in Dataloy VMS and transfer it to the accounting system. Create a payment in the accounting system and transfer it to Dataloy VMS.

Post transaction 

No post transaction is required.

Anchor
actuals
actuals
Actuals

Prerequisites

Invoice Integration need to be in place before setting up and testing actuals integration.

...

Transfer of actuals (or physicals) from Accounting to Dataloy VMS can either be setup as a manual task through the Period-End-Closing Process or as a scheduled task. Actuals in accounting are actual costs and revenues, and once entered into Dataloy VMS, the actual record will appear in the Posted section of the Accruals module.  Bunker Only profit/loss accounts should be transferred as actuals to Dataloy. Bunker transactions in Accounting that has been transferred from Dataloy VMS are not to be transferred, as they are already treated as actuals in Dataloy VMS (more information: actuals and accruals page and the Period-End-Closing process.

Data Transaction

...

Code Block
titlePost an actual to Dataloy
POST /Document
 
{
    "documentAmount": 10000.00,
    "companyCurrencyAmount": 10000.00,
    "sourceCurrencyAmount": 10000.00,
    "documentDate": "2014-01-01T00:00:00",
    "documentType": "ACC",
    "documentNo": "111111187",
    "company": "01",
    "invoicingStatus": "POS",
    "documentCurrency": "USD",
    "documentText": "text here",
    "glAccount": "1000",
    "documentLines": 
    [
        {
            "documentAmount": 10000.00,
            "companyCurrencyAmount": 10000.00,
            "sourceCurrencyAmount": 10000.00,
            "documentCurrency": "USD",
            "exchangeRate": 1,
            "invoicingStatus": "POS",
            "documentLineText": "text here",
            "voyage": "VOY100",
            "glAccount": "1000"
        }
    ]
}

More information: /DocumentType/Document.

Post Transaction

No post transaction is required.

...

Code Block
titleGet accruals and accrual reversals that are ready for posting to accounting
GET /Document?filter=invoicingStatus.statusTypeCode(EQ)RFP&filter=documentType.documentType(IN)ACP,ACR

More information: /DocumentType/Document.

Test Data

Test data for accruals integration can be generated in the Accruals module in Dataloy VMS. Generate and batch post the accruals.

Post Transaction  

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

...

Field NameDescriptionNot possible to user in filters
documentAmount
  • For /DocumentTypesDocumentType INO, INI, CRI, CRO: Amount in order currency/sales currency. The original currency.
  • For /DocumentTypesDocumentType PMI, PMO: Amount in Invoice Currency.
  • For /DocumentTypesDocumentType ACR, ACP: Amount in Voyage Currency.
  • For /DocumentTypesDocumentType APR: Amount in Advance Currency
  • For /DocumentTypesDocumentType ACC: Amount in Invoice Currency (use Voyage currency if Invoice Currency is not present)

companyCurrencyAmount

For all /DocumentTypesDocumentType : Amount in Company Currency for the Document.Company.


sourceCurrencyAmount
  • For /DocumentTypesDocumentType INO, INI, CRI, CRO: Amount in order currency/sales currency. The original currency.
  • For /DocumentTypesDocumentType PMI, PMO: Amount in Original Payment Currency.
  • For /DocumentTypesDocumentType ACR, ACP: Amount in Voyage Currency.
  • For /DocumentTypesDocumentType APR: Amount in Advance Currency
  • For /DocumentTypesDocumentType ACC: Amount in Voyage Currency

documentCurrency.currencyCode

Currency Code for documentAmount. More information, see documentAmount


sourceCurrencyCodeCurrency code for sourceCurrencyAmount. More information see sourceCurrencyAmount
exchangeRateExchange Rate between documentAmount and sourceCurrencyAmount
exchangeRateDateExchange Rate Date
glAccountGeneral Ledger AccountX
quantityHas Different Meaning Depending on Document Type:
  • Accruals - Onhire Days Within Accrual Period
  • Bunkers - Bunker Quantity
  • Freight - Cargo Quantity
  • Charter Hire - Days
  • Meals and Cables - Days
  • VAT - VAT Amount is Quantity * vatRate
  • Various, Days - Voyage Days
  • Various, Rate - Cargo Quantity
  • Offhire - Offhire Days
  • Deadfreight - Deadfreight Quantity
  • Demurrage/Despatch - Days

unitPriceUnit Price. Quantity * Unit Price = Document Amount
invoicingStatus.statusTypeCodeStatus Code, see Document Status List
documentLineTextDocument Line Text/Description
businessPartner

Business Partner Object. (Value: businessPartnerCode or businessPartner Key).

Invoice and Payment/Receipt:

  • Outgoing invoice:
    • document.company is the company in Dataloy VMS issuing the invoice.
    • document.businessPartner is the business partner receiving the invoice.
    • On the referring payment, document.company is receiving the payment.
  • Incoming invoice:
    • document.businessPartner is issuing the invoice.
    • document.company is receiving the invoice.
    • On the referring payment document.company is the one paying the invoice.

isAccountsPayablefalse = Accounts Receivable, true = Accounts Payable

Inserting Payment/Receipt:
For payments referring to Accounts Receivable invoices set value to 0. For payments referring to Accounts Payable invoice set value to 1. This value should always have the same value as for the referring invoice.

refDocument

Referring Document for Reversals, Payments and Receipts. To set refDocument use Document Number or Key.

Payment/Receipts: Setting refDocument for payment receipts, documentLine.voyage will be set equal to the documentLine.voyage of the referring invoice.


vatRate.vatRateVAT Rate
vatRate.vat.vatCodeVAT Code
freightRateFreight Rate Object
portCallportCall Object
handlingCosthandlingCost Object
businessUnitbusinessUnit Object
accountAccount Object, use glAccount instead
handlingCostCodehandlingCostCode Object, use glAccount instead
billOfLadingbillOfLading Object
claimClaim Object
offhireOffhire Object
voyageVoyage Object

...