/
/DocumentLine

/DocumentLine

Jun 09, 2023

Short Description

Chapter Contents:

Long Description

Properties

PropertyTypeLengthMandatoryDescriptionComments
glAccount
String

General Ledger Account. Documentation of GL Account.Invoice View
isAccountsPayable
Boolean

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.
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: documentLine.voyage will be set equal to the documentLine.voyage of the referring invoice.

commission
/Commission



variousText
/VariousText



realmId
Integer


??

Invoice View

portCost
/PortCost



serviceOrderLine/ServiceOrderLine



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



documentLineText
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
documentAmount
Float

Invoice View
portAgent
/PortAgent



portCostCode
/PortCostCode



refAccount
/Account



refDocumentLine
/DocumentLine



sourceCurrency
/Currency

Currency for sourceCurrencyAmount (see sourceCurrencyAmount).Invoice View
tc
/Tc



various
/Various


Invoice View
vatRate
/VatRate

Value Added Tax (VAT) RateInvoice View
createdDate
Date


Invoice View
modifiedDate
Date


Invoice View
laytimeCalculation/LaytimeCalculation


Available from version 5.50
bunkerAdjustment/BunkerAdjustment


Available from version 6.31

Example Response Body

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)

{
    "key": 1116527,
    "self": "http://localhost:8080/ws/rest/DocumentLine/1116527",
    "glAccount": "4612",
    "isAccountsPayable": true,
    "refDocument": null,
    "commission": null,
    "createdDate": "2012-10-03T10:33:11",
    "modifiedDate": "2014-05-14T07:59:04",
    "variousText": null,
    "realmId": null,
    "portCost": null,
    "tcRate": null,
    "handlingCost": null,
    "businessUnit": null,
    "voyage": {
        "referenceNo": 198,
        "vessel": {
            "vesselName": "MV Vessel",
            "self": "http://localhost:8080/ws/rest/Vessel/1089713",
            "key": 1089713
        },
        "ballastPort": {
            "portName": "DOUALA",
            "unLoCode": "CMDLA",
            "country": {
                "countryCode": "CM",
                "countryName": "CAMEROON",
                "key": 410043,
                "self": "http://localhost:8080/ws/rest/Country/410043"
            },
            "isCanal": false,
            "self": "http://localhost:8080/ws/rest/Port/103579",
            "key": 103579
        },
        "portCalls": [
            {
                "key": 1106792,
                "self": "http://localhost:8080/ws/rest/PortCall/1106792"
            },
            {
                "key": 1106668,
                "self": "http://localhost:8080/ws/rest/PortCall/1106668"
            }
        ],
        "cargos": [
            {
                "self": "http://localhost:8080/ws/rest/Cargo/1106646",
                "key": 1106646
            }
        ],
        "ballastBonus": 0,
        "ballastBonusCommission": 0,
        "ballastBonusNet": 0,
        "ballastBonusRevenue": 0,
        "canalCost": 0,
        "comments": null,
        "commission": 0,
        "commissionAddress": 0,
        "commissionOwnersCost": 0,
        "cveTcIn": 0,
        "createdDate": "2012-10-01T14:55:41",
        "ilohcTcIn": 0,
        "ilohcTcOut": 0,
        "isTc": false,
        "milesBallast": 986,
        "milesLoaded": 4477,
        "netFreight": 775961.5384615385,
        "percentExtraAtSea": 0,
        "portCost": 51923.07692307692,
        "restrictingCubic": 546697,
        "robFixed": 0,
        "runningCost": 0,
        "runningCostPerDay": 0,
        "speedBallast": 11.428571428571429,
        "speedLoaded": 11.428571428571427,
        "tabTitle": null,
        "tcHireCommission": 0,
        "tcHireNet": 0,
        "tcRate": 0,
        "tcResult": 142491.40982905985,
        "tcResultDay": 3790.6453011979715,
        "tdw": 12086,
        "utilisationComments": null,
        "variousCost": 104007.07692307692,
        "variousRevenue": 0,
        "voyageResult": 142491.40982905985,
        "tcIn": null,
        "tcs": [],
        "voyageCurrency": {
            "currencyCode": "EUR",
            "currencyName": "Euro",
            "key": 400008,
            "self": "http://localhost:8080/ws/rest/Currency/400008"
        },
        "cveTcOut": 0,
        "daysBallast": 4.041666666666667,
        "daysCanal": 0,
        "daysCleaning": 0,
        "daysDischarging": 4.475694444444445,
        "daysExtraAtSea": 0,
        "daysExtraInPort": 7.25,
        "daysHeating": 0,
        "daysIdle": 0,
        "daysLoaded": 16.60763888888889,
        "daysLoading": 5.215277777777778,
        "daysOffhire": 0,
        "daysOffhireCharterer": 0,
        "daysOffhireOwner": 0,
        "daysTotal": 37.59027777777778,
        "daysTotalAtSea": 20.649305555555557,
        "daysTotalInPort": 16.94097222222222,
        "daysWaiting": 0,
        "demurrage": 0,
        "despatch": 0,
        "dlConsumption": 44.236,
        "dlCost": 0,
        "dlPrice": 0,
        "doAtSea": 0,
        "doConsumption": 50.27644444444445,
        "doCost": 37088.54632478633,
        "doInPort": 1.15,
        "doInPortWorking": 3.2,
        "doPrice": 959,
        "estimatedVoyageStartDate": "2012-10-03T07:50:00",
        "flConsumption": 68.753,
        "flCost": 36439.09,
        "flPrice": 689,
        "foBallast": 14,
        "foCleaning": 0,
        "foConsumption": 290.92,
        "foCost": 142550.8,
        "foHeating": 0,
        "foInPort": 0,
        "foInPortWorking": 0,
        "foLoaded": 15,
        "foPrice": 637,
        "foPumping": 0,
        "freight": 775961.5384615385,
        "freightCost": 0,
        "grossFreight": 775961.5384615385,
        "handlingCost": 261461.53846153847,
        "self": "http://localhost:8080/ws/rest/Voyage/1106645",
        "key": 1106645
    },
    "paymentTerms": null,
    "company": null,
    "quantity": 295.16302,
    "bunkerHedgeLine": null,
    "vesselCode": null,
    "exchangeRate": 1,
    "cargo": null,
    "documentLineText": "FO Consumption ",
    "freightRate": null,
    "exchangeRateDate": null,
    "portCall": null,
    "businessPartner": null,
    "sourceCurrencyAmount": -154392.96,
    "unitPrice": 523.077,
    "billOfLading": null,
    "cargoPort": null,
    "document": {
        "key": 1116529,
        "self": "http://localhost:8080/ws/rest/Document/1116529",
        "glAccount": "4611",
        "externalDocumentNo": null,
        "documentPaymentTerms": [],
        "documentType": {
            "key": 1000045,
            "self": "http://localhost:8080/ws/rest/DocumentType/1000045",
            "documentType": "ACC",
            "documentTypeDesc": "Accounting"
        },
        "documentNo": "1116529",
        "documentText": null,
        "modifiedDate": "2014-05-14T07:58:53",
        "documentDate": "2012-10-03T10:33:11",
        "sourceCurrencyAmount": -154392.96,
        "documentCurrency": {
            "currencyCode": "EUR",
            "currencyName": "Euro",
            "key": 400008,
            "self": "http://localhost:8080/ws/rest/Currency/400008"
        },
        "companyCurrencyAmount": -154392.96,
        "documentAmount": -154392.96,
        "refDocument": null
    },
    "documentCurrency": {
        "currencyCode": "EUR",
        "currencyName": "Euro",
        "key": 400008,
        "self": "http://localhost:8080/ws/rest/Currency/400008"
    },
    "handlingCostCode": null,
    "invoicingStatus": {
        "key": 1000091,
        "self": "http://localhost:8080/ws/rest/StatusType/1000091",
        "statusTypeCode": "PEN",
        "statusTypeDesc": "Pending"
    },
    "offhire": null,
    "policyDeductible": null,
    "companyCurrencyAmount": -154392.96,
    "documentAmount": -154392.96,
    "portAgent": null,
    "portCostCode": null,
    "refAccount": null,
    "refDocumentLine": null,
    "sourceCurrency": {
        "currencyCode": "EUR",
        "currencyName": "Euro",
        "key": 400008,
        "self": "http://localhost:8080/ws/rest/Currency/400008"
    },
    "tc": null,
    "various": null,
    "vatRate": null,
    "remarks": []
}

Top
Back

Related Content

 Expand to see related content


Unknown macro: {dynamiccontentbylabel}