Versions Compared

Key

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

...

0 = Accounts Receivable, 1 = Accounts Payable
Inserting Payment/Receipt:
  • Set value to 0 for payments referring to Accounts Receivable.
  • Set values to 1 for payments referring to Accounts Payable.
    Note: The value should always have the same value as for the referring invoice.
Date Invoice View
PropertyTypeLengthMandatoryDescriptionComments
glAccount
String  General Ledger AccountInvoice View
isAccountsPayable
Boolean  Invoice View
refDocument
/Document  
  • Referring Document for Reversals, Payments and Receipts.
    • To set refDocument use Document Number or Key.
  • Payment/Receipts:
    • When setting refDocument for payment receipts: BunkerOrderLine.voyage will be set equal to the BunkerOrderLine.voyage of the referring invoice.
 
commission
/Commission    
variousText
/VariousText    
realmId
Integer   

??

Invoice View

portCost
/PortCost    
tcRate
/TcRate    
handlingCost
/HandlingCost  Handling CostInvoice View
businessUnit
/BusinessUnit  Business UnitInvoice View
voyage
/Voyage  VoyageInvoice View
paymentTerms
/PaymentTerms    
company
/Company    
quantity
Float  Different meaning depending on the 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
Invoice View
bunkerHedgeLine
/BunkerHedgeLine   Invoice View
vesselCode
/VesselCode    
exchangeRate
Float  Exchange Rate Between documentAmount and sourceCurrencyAmountInvoice View
cargo
/Cargo    
BunkerOrderLineText
String1024 Document Line Text/DescriptionInvoice View
freightRate
/FreightRate  Freight RateInvoice View
exchangeRateDate
Date  Exchange Rate DateInvoice View
portCall
/PortCall  PortCallInvoice View
businessPartner
/BusinessPartner  

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

Invoice and Payment/Receipt:

  • For an outgoing invoice, document.company is the company in Dataloy VMS issuing the invoice and document.businessPartner is the business partner receiving the invoice. On the referring payment, document.company is receiving the payment.
  • For an incoming invoice, document.businessPartner is issuing the invoice and document.company is receiving the invoice. On the referring payment document.company is the one paying the invoice.
Invoice View
sourceCurrencyAmount
Float   
unitPrice
Float  Unit Price. Quantity * Unit Price = Document AmountInvoice View
billOfLading
/BillOfLading  Bill of Lading (B/L)Invoice View
cargoPort
/CargoPort    
document
/Document    
documentCurrency
/Currency  Currency for documentAmount (see documentAmount)Invoice View
handlingCostCode
/HandlingCostCode  HandlingCostCodeInvoice View
invoicingStatus
/StatusType  Must belong to StatusClass "INV".Invoice View
offhire
/Offhire  OffhireInvoice View
policyDeductible
/PolicyDeductible    
companyCurrencyAmount
Float  All /DocumentTypes: Amount in Company Currency for the Document.Company.Invoice View
documentAmountbunkeredQuantity
Float  Actyal delivered bunker quantity 
minQuanityFloatY Minimum quanity to lift 
maxQuanityFloat  Maximum quanity to lift 
bunkerType
/BunkerTypeY List of BunkerTypes 
sourceCurrencyAmount
Float  
refBunkerOrderLine
/BunkerOrderLine [Restricted to confluence-developers]  Invoice View
portAgent
/PortAgent    
portCostCode
/PortCostCode    
refAccount
/Account    
    • Currency.

 
 
sourceCurrency
/Currency
unitPrice
Float  Currency for sourceCurrencyAmount (see sourceCurrencyAmount).Unit Price. Quantity * Unit Price = Document AmountInvoice View
tcdocumentAmount
/TcFloat    
various
/Various   Invoice View
vatRatesourceCurrency
/VatRateCurrency  Value Added Tax (VAT) RateCurrency for sourceCurrencyAmount (see sourceCurrencyAmount).Invoice ViewcreatedDate
isPurchaseFinalBoolean   Invoice View
modifiedDate
Date Indication of 

Example Response Body

Note

Updated for API version 2.0.0 using the new required date format yyyy-dd-MMThh:mi:ss to conform ISO 8601, (prior version has date format: yyyy-dd-MM hh:mi:ss)

...