Business Partners

Prerequisites

Synchronization of business partners between Dataloy VMS and the applicable accounting system is required before transferring accounting related transactions. To synchronize business partner updates between systems, decide which system is to be the Master System (where the business partners will be updated). The Master System will then send updated business partner data to the other system.

Integration Set-Up

• Dataloy VMS used as master: Set up a scheduled task and use the request under Data Transaction (below) to gather all business partners data having been modified since the last time a scheduled task was run.

• Dataloy VMS is not used as master: Use the requests under Data Transaction (below) to insert and update the business partners in Dataloy VMS.

Data Transaction

Dataloy VMS as a master for business partners

• Extract the business partners whose data has been modified since a selected date from Dataloy VMS using the following request in conjunction with the base URL:

Get business partner information

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

• Set up a scheduled task and gather all voyages that have been modified since the last time a scheduled task was run.

Other systems as Master for Business Partners

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

Get business partner by key

GET /BusinessPartner?filter=businessPartnerCode(EQ)99999

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

Update Business Partner

PUT /BusinessPartner/{BusinessPartner key}
  
{
"businessPartnerName": "Updated Test Name"
}

Update Address

PUT /Address/{Address key}
  
{
"address1": "Updated address"
}

Update bank

PUT /Bank/{Bank key}
  
{
"swiftAddress": "Updated Swift address"
}

Update Bank Account

PUT /BankAccount/{Bank account key}
  
{
"bankAccountNo": "UpdatedNumber"
}

Update Contact Information

PUT /ContactInfo/{ContactInfo key}
  
{
"email": "[e-mail]"
}

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

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

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

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

Already entered in Dataloy VMS. For versions from API 3.0:

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": "[e-mail]",
            "faxNo": "55555555",
            "mobileNo": "66666666",
            "phoneNo": "77777777",
            "telexNo": "88888888"
        }
    ]
}

Not entered in Dataloy VMS

POST the new business partner.

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

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": "[e-mail]",
            "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 Partners in Master Data.

Post Transaction

No post transaction is required.