Versions Compared

Old Version 93

changes.mady.by.user Karl-André Dalby

Saved on

compared with

New Version 94

changes.mady.by.user Karl-André Dalby

Saved on

Key

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

Short Description

...

More information:/PortCall.

Post Transaction 

When a port call is successfully transferred to an agency system, the port call status must be updated to Appointed in Dataloy VMS. This is done in a PUT request:

...


More information:/PortCall.

Post Transaction 

When an updated port call has been successfully handled in the agency system, the port call status must be updated to Updated in Dataloy VMS. This is done in a PUT request:

...

PropertyTypeDescriptionComments
portCall/PortCallIdentifies Port CallIf a disbursement account (DA) is inserted into Dataloy at a later stage, the port call identifier is necessary to identify which port call to insert the DA on.
agent/BusinessPartnerAgent of the Port CallDataloy VMS agent codes are to be retrieved from Dataloy VMS and can be retrieved through the BusinessPartner resource:
BusinessPartner?filter=businessPartnerType.businessPartnerType(EQ)A
voyage/VoyageThe Voyage the Port Call Belongs to 
vessel/VesselThe Vessel the voyage Belongs to 
company/CompanyThe Company of Responsible for the Voyage 
port/PortPort of the Port Call 
reasonForCall/ReasonForCallReason for Call 
cargos/CargoCargoes on the Voyage 
commodity/CommodityCommodity of the Cargo 
eventLogs/EventLogInformation when the Vessel Arrived, Berthed and Departed from the port 

 

Anchor
businessPartner
businessPartner

Business Partners

Prerequisites

Synchronization of business partners between Dataloy VMS and the applicable agency accounting system is required before transferring port call (or agent information) 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 is used as master: Set up  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 is not used  used as master: Use the requests under Data Transaction (below) to insert and update business the business partners in Dataloy VMS.

Data Transaction

  • Dataloy VMS as a Master master for Business Partners

...

  • business partners

  1. 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:

    Code Block
    titleGet business partner information
    GET /BusinessPartner?filter=modifiedDate(GTE)20152014-01-01T12:30:00
  2. Set up a scheduled task and gather all business partners voyages that have been modified since the last time a scheduled task was run. 

     

  • Other system as master Master for Business Partners

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

    Code Block
    titleGet 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
        titleUpdate Business Partner
        PUT /BusinessPartner/{BusinessPartner key}
 
{
"businessPartnerName": "Updated Test Name"
}

      2. Update Address:

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

      3. Update Bank:

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

      4. Update Bank Account:

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

      5. Update Contact Information:

    3.  

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

      2. Link an existing Bank Account

    4. to a

      1. to the Business Partner (new

    5. in

      1. in API version 2.0.0).

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

      2. Unlink an existing Bank Account to a Business Partner (new

    6. in

      1. in API version 2.0.0).

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

    1. already entered in Dataloy VMS

    8. : 

    Insert banks for bank accounts related to the business partner into the master system: 

    Code Block
    titleInsert a new bank
    POST /Bank   { "bankName":"BP bank",

    1. . For versions from API 3.0:

      1. PUT the BusinessPartner object:

        Code Block
        put /BusinessPartner
 
{
    "key":1111111,
	"businessPartnerName": "Test Name",
    "
    9. abaNumber
      1. businessPartnerCode": "
    10. 1111
      1. 123456789",
      1. 
    "
    12. chip
      1. businessPartnerSort": "
    13. 2222
      1. TESTNAME",
    "
    14. swiftAddress
      1. companyRegistrationNo": "
    15. 3333
      1. 123456789"
    16. }

    POST the new business partner. Note: Required fields: businessPartnerName, businessPartnerCode, businessPartnerSort.

    Code Block
    titleInsert a new business partner
    POST /BusinessPartner   {
      1. ,  
    "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"
        }
    ]
}
    2. not entered in Dataloy VMS: 

      1. POST the new business partner. Note: Required fields: businessPartnerName, businessPartnerCode, businessPartnerSort.

        Code Block
        titleInsert a new business partner
        POST /BusinessPartner
 
{
    "businessPartnerName": "Test Name",
    "businessPartnerCode": "123456789",
    "businessPartnerSort": "TESTNAME",
    "companyRegistrationNo": "123456789",  
    "
    17. businessPartnerName
      1. businessPartnerType": "
    18. Test Name
      1. C",
 
    "
    19. businessPartnerCode
      1. bankAccounts":[
    {
    20. "123456789
      1.   "iban":"9754",
      "
    21. businessPartnerSort
      1. bankAccountNo":
      1. "
    23. TESTNAME
      1. 6523",
      "
    24. companyRegistrationNo
      1. bank":
    25. "123456789",  
      1.  {
        "
    26. businessPartnerType
      1. bankName":"BP
    27. "C
      1. bank",
    28.  
      1.         "
    29. bankAccounts
      1. abaNumber":
    30. [
      1. "1111",
    31. {
      1.        "
    32. iban
      1. chip":"
    33. 9754
      1. 2222",
        "
    34. bankAccountNo
      1. swiftAddress":"
    35. 6523
      1. 42341"
    36. ,
      1.
    37. "bank":
      1.
    38. 1033615
      1. },
      "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, /Address, /ContactInfo, /BankAccount, /Bank

    39. .

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.

...