Page Comparison

Short Description

...

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

More information: /DocumentType, /Document.

Payment Terms

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 documentPaymentTerms objects in the Document.documentPaymentTerms list.

...

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:

...

GET /VoyageHeader?filter=modifiedDate(GTE)2014-01-01T12:30:00

Post Transaction 

No post transaction is required.

...

1. Check if relevant business partner/s is/are already existing in Dataloy VMS by using the following request in conjunction with the base URL:

   Code Block
   title Get business partner by key
   GET /BusinessPartner?filter=businessPartnerCode(EQ)99999

   
   

2. If the business partner is
   1.  already entered in Dataloy VMS. For versions prior to API 3.0:

      1. Update Business Partner:

         Code Block
         title Update Business Partner
         PUT /BusinessPartner/{BusinessPartner key}   { "businessPartnerName": "Updated Test Name" }

         
         

      2. Update Address:

         Code Block
         title Update Address
         PUT /Address/{Address key}   { "address1": "Updated address" }

         
         

      3. Update Bank:

         Code Block
         title Update Bank
         PUT /Bank/{Bank key}   { "swiftAddress": "Updated Swift address" }

         
         

      4. Update Bank Account:

         Code Block
         title Update Bank Account
         PUT /BankAccount/{Bank account key}   { "bankAccountNo": "UpdatedNumber" }

         
         

      5. Update Contact Information:

         Code Block
         title Update Contact Info
         PUT /ContactInfo/{ContactInfo key}   { "email": "updated@emailaddress.com" }

         
         

      6. Link an existing Bank Account to the Business Partner (new in API version 2.0.0).

         Code Block
         POST /BusinessPartner/{business partner key}/BankAccount/{bank account key}/link

         
         

      7. Unlink an existing Bank Account to a Business Partner (new in API version 2.0.0).

         Code Block
         POST /BusinessPartner/{business partner key}/BankAccount/{bank account key}/unlink

         
         

   2. already entered in Dataloy VMS. For versions from API 3.0:
      

      1. PUT the BusinessPartner object:
         

         Code Block

         put /BusinessPartner {  "key":1111111, "businessPartnerName": "Test Name", "businessPartnerCode": "123456789", "businessPartnerSort": "TESTNAME", "companyRegistrationNo": "123456789", "businessPartnerType": "C", "bankAccounts":[ {  "key":222222, "iban":"9754", "bankAccountNo":"6523", "bank": 1033615, "currency": 400132 } ], "addresses": [ { "key":333333, "country": "NL", "address1": "Street Name 54", "address2": "5th floor", "address3": "", "city": "Amsterdam", "postalCode": "1000 AA" } ], "contactInfo": [ {  "key":444444, "email": "test@test.com", "faxNo": "55555555", "mobileNo": "66666666", "phoneNo": "77777777", "telexNo": "88888888" } ] }

          

   3. not entered in Dataloy VMS: 

      1. POST the new business partner. Note: Required fields: businessPartnerName, businessPartnerCode, businessPartnerSort. Find an overview of business partner types here: /BusinessPartnerType

         Code Block
         title Insert a new business partner
         POST /BusinessPartner   { "businessPartnerName": "Test Name", "businessPartnerCode": "123456789", "businessPartnerSort": "TESTNAME", "companyRegistrationNo": "123456789",   "businessPartnerType": "C",   "bankAccounts":[ { "iban":"9754", "bankAccountNo":"6523", "bank": { "bankName":"BP bank", "abaNumber":"1111", "chip":"2222", "swiftAddress":"42341" }, "currency": 400132 } ], "addresses": [ { "country": "NL", "address1": "Street Name 54", "address2": "5th floor", "address3": "", "city": "Amsterdam", "postalCode": "1000 AA" } ], "contactInfo": [ { "email": "test@test.com", "faxNo": "55555555", "mobileNo": "66666666", "phoneNo": "77777777", "telexNo": "88888888" } ] }

         More Info: /BusinessPartner, /BusinessPartnerType, /Address, /ContactInfo, /BankAccount, /Bank

Test Data

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

Post Transaction 

No post transaction is required.

...

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:

...

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.

...

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: 

...