Versions Compared

Key

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

Short Description

...

PropertyTypeLengthMandatoryDescription
portCall
/PortCall
YPortCall object or port call key
serviceOrderLines
Array of /ServiceOrderLine
YServiceOrderLines of the ServiceOrder
businessPartner
/BusinessPartner


externalReferenceNo
String64
External ServiceOrder Reference Number
exchangeRate
Double

Exchange Rate Between amountAdvanced and amountAdvancedCurrency
currency
/Currency
YServiceOrder Currency
orderDate
Date

Service order date ISO format
status
/StatusType
YServiceOrder Status, find list of valid status types below.
amountAdvancedDouble


amountAdvancedCurrency/Currency
Y
nominationEmailString

Nomination email sent to the agent in HTML format. since 6.3
emailSentDateDate

The date when the nomination email has been sent to the Agent. since 6.3


List of Disbursement Account (DA) Statuses in Dataloy VMS

...

The following http header was used to get the below result. 

fields{"amountAdvanced":"*","amountAdvancedCurrency":{"currencyCode":"*"},"businessPartner":{"businessPartnerCode":"*"},"exchangeRate":"*","portCall":"*","orderDate":"*","externalReferenceNo":"*","currency":{"currencyCode":"*"},"status":{"statusTypeCode":"*"},"serviceOrderLines": { "description":"*", "isCharterersCost":"*", "isOwnersCost":"*", "amountEstimate":"*", "amountFinal":"*", "amountRevised":"*", "serviceCode":{"serviceCode":"*"}}}

Code Block
languagejs
{
    "key": 36647845,
    "self": "http://platform-dev.dataloy.com:80:80/ws/rest/ServiceOrder/36647845",
    "amountAdvanced": 10000.0,
    "amountAdvancedCurrency": {
        "currencyCode": "EUR",
        "key": 400008,
        "self": "http://platform-dev.dataloy.com:80:80/ws/rest/Currency/400008"
    },
    "serviceOrderLines": [
        {
            "key": 36647846,
            "self": "http://platform-dev.dataloy.com:80:80/ws/rest/ServiceOrderLine/36647846",
            "description": null,
            "isCharterersCost": true,
            "isOwnersCost": false,
            "amountEstimate": 10000.0,
            "amountFinal": 11000.0,
            "amountRevised": 0.0,
            "serviceCode": {
                "key": 36567907,
                "self": "http://platform-dev.dataloy.com:80:80/ws/rest/ServiceCode/36567907",
                "serviceCode": "TOWX"
            }
        }
    ],
    "businessPartner": {
        "businessPartnerCode": "100131",
        "key": 20798543,
        "self": "http://platform-dev.dataloy.com:80:80/ws/rest/BusinessPartner/20798543"
    },
    "exchangeRate": 1.2345,
    "portCall": {
        "key": 36344213,
        "self": "http://platform-dev.dataloy.com:80:80/ws/rest/PortCall/36344213"
    },
    "orderDate": "2020-10-01T00:00:00",
    "externalReferenceNo": "DA1234",
    "currency": {
        "currencyCode": "USD",
        "key": 400132,
        "self": "http://platform-dev.dataloy.com:80:80/ws/rest/Currency/400132"
    },
    "status": {
        "key": 1000131,
        "self": "http://platform-dev.dataloy.com:80:80/ws/rest/StatusType/1000131",
        "statusTypeCode": "FIN"
    }
}

...