Page Comparison

...

...

This API as been Deprecated, use instead Service Order Integration 

Short Description

The objective of the Disbursement Account (DA) integration is to transfer port call and port cost data between Dataloy VMS and an agency system in order to correctly assign port costs to the correct port call, vessel and voyage and import this data into the VMS.

Chapter Contents: 

...

Anchor
costItemFields costItemFields

Properties 

...

• Inserting (or Updating) a Disbursement Account (DA)

  • To insert (or update) a disbursement account (DA) into Dataloy VMS post a populated JSON message (see JSON example) to the Dataloy API.
  • Fields required to be populated when posting a DA to Dataloy VMS: portCall, businessPartner, invoiceReference, currency, status, accountCode, costItemKey.
    Note: When updating an existing DisbursementAccount, unchanged properties (except required fields) need not be updated. The insertion process is shown in Fig. 1 (see Validations).
    
    

• Anchor
  val1 val1

  Validations
  Prior to inserting/updating the DA in Dataloy VMS, the following validations will be performed on the JSON message:
  
  1. Are the required fields populated?
     1. Yes: Continue Insertion.
     2. No: Nothing is inserted and a HTTP status code is returned.
  2. Does the Port Call, Business Partner, Agent Type (if populated), Currency and Status exist in Dataloy VMS?
     1. Yes: Continue Insertion.
     2. No: Nothing is inserted and a HTTP status code is returned. Also, the status codes are returned in the HTTP header, additional information will be provided in the body in JSON format.
  3. Does the account code exist in Dataloy and is it unique?
  1. Yes: Continue Insertion.
  2. No: Nothing is inserted and a HTTP status code is returned. Also, the status codes are returned in the HTTP header, additional information will be provided in the body in JSON format.
     
     

   

  Anchor
  fig1 fig1

  Fig. 1

  
  
  

• Inserting (or Updating) a Proforma Disbursement Account (PDA) 
1. Populate the status field in the JSON message with EST (Estimate) and post a DA JSON message to the Dataloy API.
   Note: The status field must be populated with EST in order for the VMS to treat it as a PDA.
2. Validate the JSON message.
1. Validated: Insert Disbursement Account (DA).
2. Not validated: Return Error.
   
   
• Inserting (or Updating) a Revised Disbursement Account (RDA)
1. Populate the status field in the JSON message with REV (Revised) and post a DA JSON message to the Dataloy API.
   Note: The status field must be populated with REVin order for the VMS to treat it as a RDA.
2. Validate the JSON message.
1. Validated: Insert Disbursement Account (DA).
2. Not validated: Return Error
   
   
• Inserting (or Updating) a Final Disbursement Account (FDA) 
1. Populate the status field in the JSON message with FIN (Final) and post a DA JSON message to the Dataloy API.
   Note: The status field must be populated with FIN in order for the VMS to treat it as a FDA.
2. Validate the JSON message.
1. Validated: Insert Disbursement Account (DA).
2. Not validated: Return Error.
   

...

Note: Currently the disbursement account (DA) stage (PDA etc.) cannot display in Dataloy VMS. However, if the amounts are estimates, the Amount LC (Estimated) column is populated. If they are revised/final amounts, the Amount LC (Revised)/Amount LC (Actual) column is populated. This ONLY applies to Port Cost and Handling Cost. The Various costs has ONLY a single amount, i.e. NO estimate/revised amounts. The examples of inserted disbursement accounts in Figures 2, 3 and 4 all shows where the DAs in the JSON example are inserted in Dataloy VMS.

...

Fig. 3: DA Handling Costs

Fig 4: DA Various Costs

Top
Back

Related Content

{dynamiccontentbylabel:showLabels=false|showSpace=false}