API

Sales APIs

GET sales/orders/{salesOrderId}

Sales order details for the provided identifier

HTTP method GET
URI https://api.rambase.net/sales/orders/{salesOrderId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {salesOrderId} Sales order identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 605, version 79

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<SalesOrder>
2
     <SalesOrderId
SalesOrderId

Sales order identifier

>{Integer}</SalesOrderId>
3
     <Status
Status

Status of sales order

Possible domain values can be found here

>{Integer}</Status>
4
     <Type
Type

Type of sales order.

Possible domain values can be found here

>{String}</Type>
5
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
     <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
7
     <SellersReferenceNumber
SellersReferenceNumber

Sellers reference number.

>{String}</SellersReferenceNumber>
8
     <CustomersReference
CustomersReference

Customers reference. Typically a person.

>{String}</CustomersReference>
9
     <CustomersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

>{String}</CustomersReferenceNumber>
10
     <VolumePriceAgreement
VolumePriceAgreement

Special price agreement related to the quantity beeing ordered.

Possible domain values can be found here

>{String}</VolumePriceAgreement>
11
     <ExchangeRateFluctuationAgreement
ExchangeRateFluctuationAgreement

When a sales order is issued, RamBase stores the current exchange rate and the currency the product normally is purchased in. The exchange rate might have changed when the invoice is issued. The exchange rate fluctuation agreement specifies how to handle these differences. The agreement has the format AAA/BBB, where AAA is a percentage of the total invoice, and BBB is the exchange rate fluctuation percentage. E.g. 100/3.0 means that if the rate of exchange on the date a sales order is forwarded to an invoice has changed more than +/- 3% from the rate of exchange, 100% of the invoice amount will be adjusted.

Possible domain values can be found here

>{String}</ExchangeRateFluctuationAgreement>
12
     <NetWeight
NetWeight

The net weight of object (excluding packing meterial) in kilograms

>{Decimal}</NetWeight>
13
     <GrossMargin
GrossMargin

Gross margin of sale, calculated as an average of gross margin of all items at the time items are created and when the document is registered. Will not be recalculated if gross margin in items change afterwards

>{Decimal}</GrossMargin>
14
     <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
15
     <HasAttachmentsToForward
HasAttachmentsToForward

Has attachements that will be included when forwarded to other transaction documents.

>{Boolean}</HasAttachmentsToForward>
16
     <Note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

>{String}</Note>
17
     <ShippingAddressAttention
ShippingAddressAttention

Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.

>{String}</ShippingAddressAttention>
18
     <ShippingAddressPhone
ShippingAddressPhone

Phone number of the shipping address. When changing shipping address, the ShippingAddressPhone will be overridden by the phone number of the new shipping address.

>{String}</ShippingAddressPhone>
19
     <ShippingAddressEmail
ShippingAddressEmail

Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.

>{String}</ShippingAddressEmail>
20
     <InvoiceAddressAttention
InvoiceAddressAttention

Attention of the invoice address. When changing invoice address, the InvoiceAddressAttention will be overridden by the attention of the new invoice address.

>{String}</InvoiceAddressAttention>
21
     <LocationCountryCode
LocationCountryCode

Country code of the location. Inherits from the location.

>{String}</LocationCountryCode>
22
     <Location>
23
          <LocationId
LocationId

Location identifier

This field is greyed out because it is an expandable field. You have to add $expand=Location.LocationId in your request URI to get this field

>{Integer}</LocationId>
24
          <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
25
          <Address
Address

This field is greyed out because it is an expandable field. You have to add $expand=Location.Address in your request URI to get this field

>
26
               <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

This field is greyed out because it is an expandable field. You have to add $expand=Location.Address in your request URI to get this field

>{String}</CountryCode>
27
          </Address>
28
          <LocationLink
LocationLink

Location reference

This field is greyed out because it is an expandable field. You have to add $expand=Location.LocationLink in your request URI to get this field

>{String}</LocationLink>
29
     </Location>
30
     <Assignee
Assignee

The user who has been assigned to work with this object.

>
31
          <UserId
UserId

User identifier

>{Integer}</UserId>
32
          <Name
Name

Name of the user

>{String}</Name>
33
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
34
          <UserLink
UserLink

User reference

>{String}</UserLink>
35
     </Assignee>
36
     <Customer>
37
          <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
38
          <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>{String}</Name>
39
          <Firstname
Firstname

Secondary name of a company or firstname of a person

>{String}</Firstname>
40
          <Phone
Phone

Customers main phone number

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Phone in your request URI to get this field

>{String}</Phone>
41
          <Email
Email

Customers main email

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Email in your request URI to get this field

>{String}</Email>
42
          <Sales>
43
               <SalesDistrict
SalesDistrict

A geographic district for which an individual salesperson or sales team holds responsibility

Possible domain values can be found here

>{String}</SalesDistrict>
44
               <MarketSegment
MarketSegment

Market segment of the customer

Possible domain values can be found here

>{String}</MarketSegment>
45
               <SalesAssistant
SalesAssistant

Reference to the employee who is sales assistant for the customer.

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.SalesAssistant in your request URI to get this field

>
46
                    <EmployeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.SalesAssistant in your request URI to get this field

>{Integer}</EmployeeId>
47
                    <LastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.SalesAssistant in your request URI to get this field

>{String}</LastName>
48
                    <FirstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.SalesAssistant in your request URI to get this field

>{String}</FirstName>
49
                    <EmployeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.SalesAssistant in your request URI to get this field

>{String}</EmployeeLink>
50
               </SalesAssistant>
51
               <AccountManager
AccountManager

Reference to the employee who is responsible for the management of sales, and relationship with the customer.

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.AccountManager in your request URI to get this field

>
52
                    <EmployeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.AccountManager in your request URI to get this field

>{Integer}</EmployeeId>
53
                    <LastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.AccountManager in your request URI to get this field

>{String}</LastName>
54
                    <FirstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.AccountManager in your request URI to get this field

>{String}</FirstName>
55
                    <EmployeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.AccountManager in your request URI to get this field

>{String}</EmployeeLink>
56
               </AccountManager>
57
          </Sales>
58
          <CustomerLegalEntity>
59
               <CustomerLegalEntityId
CustomerLegalEntityId

Customer legal entity identifier

>{Integer}</CustomerLegalEntityId>
60
               <CustomerLegalEntityLink
CustomerLegalEntityLink

Reference to customer legal entity

>{String}</CustomerLegalEntityLink>
61
          </CustomerLegalEntity>
62
          <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
63
     </Customer>
64
     <InitialSalesOrder
InitialSalesOrder

Reference to initial sales order

>
65
          <SalesOrderId
SalesOrderId

Sales order identifier

>{Integer}</SalesOrderId>
66
          <SalesOrderLink
SalesOrderLink

Sales order reference

>{String}</SalesOrderLink>
67
     </InitialSalesOrder>
68
     <Management
Management

Represents a group of users, which are assigned to particular management roles.

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

>
69
          <Planner
Planner

Reference to the employee who is a production management planner.

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

>
70
               <EmployeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

>{Integer}</EmployeeId>
71
               <LastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

>{String}</LastName>
72
               <FirstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

>{String}</FirstName>
73
               <EmployeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

>{String}</EmployeeLink>
74
          </Planner>
75
          <ProjectLeader
ProjectLeader

Reference to the employee who is a production management project leader.

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

>
76
               <EmployeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

>{Integer}</EmployeeId>
77
               <LastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

>{String}</LastName>
78
               <FirstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

>{String}</FirstName>
79
               <EmployeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

>{String}</EmployeeLink>
80
          </ProjectLeader>
81
          <DocumentController
DocumentController

Reference to the employee who is a production management document controller.

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

>
82
               <EmployeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

>{Integer}</EmployeeId>
83
               <LastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

>{String}</LastName>
84
               <FirstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

>{String}</FirstName>
85
               <EmployeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

>{String}</EmployeeLink>
86
          </DocumentController>
87
     </Management>
88
     <ShippingAddress>
89
          <AddressId
AddressId

Address identifier

>{Integer}</AddressId>
90
          <Name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

>{String}</Name>
91
          <Firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

>{String}</Firstname>
92
          <AddressLine1
AddressLine1

First address line

>{String}</AddressLine1>
93
          <AddressLine2
AddressLine2

Second address line

>{String}</AddressLine2>
94
          <PostalCode
PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>
95
          <City
City

City/town/village

>{String}</City>
96
          <Region
Region

Region/province/state

>{String}</Region>
97
          <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
98
          <Country
Country

English name of country.

>{String}</Country>
99
          <ExternalReference
ExternalReference

External address identifier. Normally defined by the customer.

>{String}</ExternalReference>
100
     </ShippingAddress>
101
     <InvoiceAddress>
102
          <AddressId
AddressId

Address identifier

This field is greyed out because it is an expandable field. You have to add $expand=InvoiceAddress.AddressId in your request URI to get this field

>{Integer}</AddressId>
103
          <Name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

>{String}</Name>
104
          <Firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

>{String}</Firstname>
105
          <AddressLine1
AddressLine1

First address line

>{String}</AddressLine1>
106
          <AddressLine2
AddressLine2

Second address line

>{String}</AddressLine2>
107
          <PostalCode
PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>
108
          <City
City

City/town/village

>{String}</City>
109
          <Region
Region

Region/province/state

>{String}</Region>
110
          <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
111
          <Country
Country

English name of country.

>{String}</Country>
112
     </InvoiceAddress>
113
     <Totals>
114
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
115
          <FreightAmount
FreightAmount

Freight amount in transaction document's currency

>{Decimal}</FreightAmount>
116
          <FeeAmount
FeeAmount

Fee amount in transaction document's currency

>{Decimal}</FeeAmount>
117
          <SubTotalAmount
SubTotalAmount

Total amount of the object in object currency, excluding VAT.

>{Decimal}</SubTotalAmount>
118
          <VATAmount
VATAmount

Total value added tax in object currency.

>{Decimal}</VATAmount>
119
          <TotalAmount
TotalAmount

The total amount in object currency, including VAT

>{Decimal}</TotalAmount>
120
     </Totals>
121
     <TotalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>
122
          <Currency
Currency

Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{String}</Currency>
123
          <ExchangeRate
ExchangeRate

The exchange rate used in convertion

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</ExchangeRate>
124
          <FreightAmount
FreightAmount

Freight amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</FreightAmount>
125
          <FeeAmount
FeeAmount

Fee amount in company currency

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</FeeAmount>
126
          <SubTotalAmount
SubTotalAmount

Total amount of the object in company currency, excluding VAT.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</SubTotalAmount>
127
          <VATAmount
VATAmount

Value added tax amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</VATAmount>
128
          <TotalAmount
TotalAmount

The total amount in company currency, including VAT.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

>{Decimal}</TotalAmount>
129
     </TotalsConverted>
130
     <Shipment>
131
          <DeliveryTerms
DeliveryTerms

Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer.

Possible domain values can be found here

>{String}</DeliveryTerms>
132
          <DeliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

>{String}</DeliveryTermPlace>
133
          <OnlyShipEntireSalesOrder
OnlyShipEntireSalesOrder

True if all items of a sales order should be shipped together. The items of a sales order should never be split into several shipments. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.

>{Boolean}</OnlyShipEntireSalesOrder>
134
          <OnlyShipEntireSalesOrderItems
OnlyShipEntireSalesOrderItems

True if the total quantity of a sales order item always should be shipped together. The quantity should never be split into several shipments. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.

>{Boolean}</OnlyShipEntireSalesOrderItems>
135
          <AvoidMultipleShipmentsOnSameDate
AvoidMultipleShipmentsOnSameDate

True if all items of a sales order with the same sheduled delivery date should be shipped together. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.

>{Boolean}</AvoidMultipleShipmentsOnSameDate>
136
          <ShipBasedOnConfirmedDeliveryDate
ShipBasedOnConfirmedDeliveryDate

If true, will sheduled shipping date on each item be calculated based on confirmed date rather than requested date.

>{Boolean}</ShipBasedOnConfirmedDeliveryDate>
137
          <FreightForEachShipment
FreightForEachShipment

If unchecked there will only be calculated freight on one shipping advice if the particular sales order has serveral shipments.

>{Boolean}</FreightForEachShipment>
138
          <ShippingDay
ShippingDay

Specifies when the goods should be shipped. This is used to calculate the scheduled shipping date for each item.

Possible domain values can be found here

>{String}</ShippingDay>
139
          <ConsolidateShippingAdvices
ConsolidateShippingAdvices

If true, sales orders will be consolidated when creating shipping advices via the "Prepare for picking" process the . If false, each sales order will result in seperate shipping advice. The field to use when consolidating is specified in the ShippingAdviceConsolidationField.

>{Boolean}</ConsolidateShippingAdvices>
140
          <ShippingAdviceConsolidationField
ShippingAdviceConsolidationField

Field to use when consolidating sales order items into shipping advices in the "Prepare for picking" process.

Possible domain values can be found here

>{String}</ShippingAdviceConsolidationField>
141
          <ShippingAdviceItemSortBy
ShippingAdviceItemSortBy

Items in consolidated shipping advices will be sorted by this fields when they are created in the 'Prepare for picking' process

Possible domain values can be found here

>{String}</ShippingAdviceItemSortBy>
142
          <SpecialHandling
SpecialHandling

Special handling to use for this shipment.

>
143
               <SpecialHandlingId
SpecialHandlingId

Special handling identifier

>{Integer}</SpecialHandlingId>
144
               <SpecialHandlingLink
SpecialHandlingLink

Special handling code reference

>{String}</SpecialHandlingLink>
145
          </SpecialHandling>
146
          <ShippingService>
147
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

>{Integer}</ShippingServiceId>
148
               <Name
Name

Name of shipping service

>{String}</Name>
149
               <Carrier>
150
                    <CarrierId
CarrierId

Carrier identifier

>{Integer}</CarrierId>
151
                    <Name
Name

Name of carrier

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.ShippingService.Carrier.Name in your request URI to get this field

>{String}</Name>
152
                    <CarrierLink
CarrierLink

Carrier reference

>{String}</CarrierLink>
153
               </Carrier>
154
               <ShippingServiceLink
ShippingServiceLink

Shipping service reference

>{String}</ShippingServiceLink>
155
          </ShippingService>
156
     </Shipment>
157
     <Invoicing>
158
          <SalesInvoiceConsolidation
SalesInvoiceConsolidation

Specifies whether or how often shipping advices that origins from this sales order will be consolidated when creating sales invoices.

Possible domain values can be found here

>{String}</SalesInvoiceConsolidation>
159
          <SalesInvoiceConsolidationField
SalesInvoiceConsolidationField

Field name to group by when consolidating shipping advice items into sales invoices.

Possible domain values can be found here

>{String}</SalesInvoiceConsolidationField>
160
          <SalesInvoiceItemSortBy
SalesInvoiceItemSortBy

Field name to sort by when creating sales invoice items.

Possible domain values can be found here

>{String}</SalesInvoiceItemSortBy>
161
     </Invoicing>
162
     <Payment>
163
          <PaymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field.

Possible domain values can be found here

>{String}</PaymentTerms>
164
          <PaymentMethod
PaymentMethod

Method of payment. Default value is retrieved from the customer.

Possible domain values can be found here

>{String}</PaymentMethod>
165
          <DueDate
DueDate

Date the sales order is due to be paid. Only relevant for pre-paid orders.

>{Date}</DueDate>
166
          <CreditCardTransaction>
167
               <CreditCardTransactionId
CreditCardTransactionId

Credit card transaction identifier

>{Integer}</CreditCardTransactionId>
168
               <CreditCardTransactionLink
CreditCardTransactionLink

Credit card transaction reference

>{String}</CreditCardTransactionLink>
169
          </CreditCardTransaction>
170
     </Payment>
171
     <VATDetails>
172
          <VATType
VATType

Type of value added tax

>{String}</VATType>
173
          <VATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Possible domain values can be found here

>{String}</VATHandling>
174
          <DefaultVATPercent
DefaultVATPercent

Value added tax percent.

>{Decimal}</DefaultVATPercent>
175
     </VATDetails>
176
     <HighlightedNotification
HighlightedNotification

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>
177
          <NotificationId
NotificationId

Notification identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{Integer}</NotificationId>
178
          <Status
Status

Status of the notification

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{Integer}</Status>
179
          <CreatedAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{Datetime}</CreatedAt>
180
          <Message
Message

The message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</Message>
181
          <TranslatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</TranslatedMessage>
182
          <NotificationType
NotificationType

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>
183
               <NotificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</NotificationTypeId>
184
               <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</Category>
185
               <NotificationTypeLink
NotificationTypeLink

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</NotificationTypeLink>
186
          </NotificationType>
187
          <NotificationLink
NotificationLink

Notification reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</NotificationLink>
188
     </HighlightedNotification>
189
     <SalesDeliveryProject>
190
          <SalesDeliveryProjectId
SalesDeliveryProjectId

Sales delivery project identifier

>{Integer}</SalesDeliveryProjectId>
191
          <Name
Name

Name of sales delivery

This field is greyed out because it is an expandable field. You have to add $expand=SalesDeliveryProject.Name in your request URI to get this field

>{String}</Name>
192
          <SalesDeliveryProjectLink
SalesDeliveryProjectLink

Sales delivery project reference

>{String}</SalesDeliveryProjectLink>
193
     </SalesDeliveryProject>
194
     <Service
Service

This field is greyed out because it is an expandable field. You have to add $expand=Service in your request URI to get this field

>
195
          <SpecialHandling
SpecialHandling

This field is greyed out because it is an expandable field. You have to add $expand=Service in your request URI to get this field

>
196
               <SpecialHandlingId
SpecialHandlingId

Special handling identifier

This field is greyed out because it is an expandable field. You have to add $expand=Service in your request URI to get this field

>{Integer}</SpecialHandlingId>
197
               <SpecialHandlingLink
SpecialHandlingLink

Special handling code reference

This field is greyed out because it is an expandable field. You have to add $expand=Service in your request URI to get this field

>{String}</SpecialHandlingLink>
198
          </SpecialHandling>
199
     </Service>
200
</SalesOrder>
1
{
2
     "salesOrder": {
3
          "salesOrderId
SalesOrderId

Sales order identifier

": "{Integer}",
4
          "status
Status

Status of sales order

Possible domain values can be found here

": "{Integer}",
5
          "type
Type

Type of sales order.

Possible domain values can be found here

": "{String}",
6
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
          "registrationDate
RegistrationDate

Date of registration

": "{Date}",
8
          "sellersReferenceNumber
SellersReferenceNumber

Sellers reference number.

": "{String}",
9
          "customersReference
CustomersReference

Customers reference. Typically a person.

": "{String}",
10
          "customersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

": "{String}",
11
          "volumePriceAgreement
VolumePriceAgreement

Special price agreement related to the quantity beeing ordered.

Possible domain values can be found here

": "{String}",
12
          "exchangeRateFluctuationAgreement
ExchangeRateFluctuationAgreement

When a sales order is issued, RamBase stores the current exchange rate and the currency the product normally is purchased in. The exchange rate might have changed when the invoice is issued. The exchange rate fluctuation agreement specifies how to handle these differences. The agreement has the format AAA/BBB, where AAA is a percentage of the total invoice, and BBB is the exchange rate fluctuation percentage. E.g. 100/3.0 means that if the rate of exchange on the date a sales order is forwarded to an invoice has changed more than +/- 3% from the rate of exchange, 100% of the invoice amount will be adjusted.

Possible domain values can be found here

": "{String}",
13
          "netWeight
NetWeight

The net weight of object (excluding packing meterial) in kilograms

": "{Decimal}",
14
          "grossMargin
GrossMargin

Gross margin of sale, calculated as an average of gross margin of all items at the time items are created and when the document is registered. Will not be recalculated if gross margin in items change afterwards

": "{Decimal}",
15
          "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
16
          "hasAttachmentsToForward
HasAttachmentsToForward

Has attachements that will be included when forwarded to other transaction documents.

": "{Boolean}",
17
          "note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

": "{String}",
18
          "shippingAddressAttention
ShippingAddressAttention

Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.

": "{String}",
19
          "shippingAddressPhone
ShippingAddressPhone

Phone number of the shipping address. When changing shipping address, the ShippingAddressPhone will be overridden by the phone number of the new shipping address.

": "{String}",
20
          "shippingAddressEmail
ShippingAddressEmail

Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.

": "{String}",
21
          "invoiceAddressAttention
InvoiceAddressAttention

Attention of the invoice address. When changing invoice address, the InvoiceAddressAttention will be overridden by the attention of the new invoice address.

": "{String}",
22
          "locationCountryCode
LocationCountryCode

Country code of the location. Inherits from the location.

": "{String}",
23
          "location": {
24
               "locationId
LocationId

Location identifier

This field is greyed out because it is an expandable field. You have to add $expand=Location.LocationId in your request URI to get this field

": "{Integer}",
25
               "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
26
               "address
Address

This field is greyed out because it is an expandable field. You have to add $expand=Location.Address in your request URI to get this field

": {
27
                    "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

This field is greyed out because it is an expandable field. You have to add $expand=Location.Address in your request URI to get this field

": "{String}"
28
               },
29
               "locationLink
LocationLink

Location reference

This field is greyed out because it is an expandable field. You have to add $expand=Location.LocationLink in your request URI to get this field

": "{String}"
30
          },
31
          "assignee
Assignee

The user who has been assigned to work with this object.

": {
32
               "userId
UserId

User identifier

": "{Integer}",
33
               "name
Name

Name of the user

": "{String}",
34
               "firstName
FirstName

First name of the user

": "{String}",
35
               "userLink
UserLink

User reference

": "{String}"
36
          },
37
          "customer": {
38
               "customerId
CustomerId

Customer identifier

": "{Integer}",
39
               "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
40
               "firstname
Firstname

Secondary name of a company or firstname of a person

": "{String}",
41
               "phone
Phone

Customers main phone number

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Phone in your request URI to get this field

": "{String}",
42
               "email
Email

Customers main email

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Email in your request URI to get this field

": "{String}",
43
               "sales": {
44
                    "salesDistrict
SalesDistrict

A geographic district for which an individual salesperson or sales team holds responsibility

Possible domain values can be found here

": "{String}",
45
                    "marketSegment
MarketSegment

Market segment of the customer

Possible domain values can be found here

": "{String}",
46
                    "salesAssistant
SalesAssistant

Reference to the employee who is sales assistant for the customer.

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.SalesAssistant in your request URI to get this field

": {
47
                         "employeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.SalesAssistant in your request URI to get this field

": "{Integer}",
48
                         "lastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.SalesAssistant in your request URI to get this field

": "{String}",
49
                         "firstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.SalesAssistant in your request URI to get this field

": "{String}",
50
                         "employeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.SalesAssistant in your request URI to get this field

": "{String}"
51
                    },
52
                    "accountManager
AccountManager

Reference to the employee who is responsible for the management of sales, and relationship with the customer.

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.AccountManager in your request URI to get this field

": {
53
                         "employeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.AccountManager in your request URI to get this field

": "{Integer}",
54
                         "lastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.AccountManager in your request URI to get this field

": "{String}",
55
                         "firstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.AccountManager in your request URI to get this field

": "{String}",
56
                         "employeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Sales.AccountManager in your request URI to get this field

": "{String}"
57
                    }
58
               },
59
               "customerLegalEntity": {
60
                    "customerLegalEntityId
CustomerLegalEntityId

Customer legal entity identifier

": "{Integer}",
61
                    "customerLegalEntityLink
CustomerLegalEntityLink

Reference to customer legal entity

": "{String}"
62
               },
63
               "customerLink
CustomerLink

Customer reference

": "{String}"
64
          },
65
          "initialSalesOrder
InitialSalesOrder

Reference to initial sales order

": {
66
               "salesOrderId
SalesOrderId

Sales order identifier

": "{Integer}",
67
               "salesOrderLink
SalesOrderLink

Sales order reference

": "{String}"
68
          },
69
          "management
Management

Represents a group of users, which are assigned to particular management roles.

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

": {
70
               "planner
Planner

Reference to the employee who is a production management planner.

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

": {
71
                    "employeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

": "{Integer}",
72
                    "lastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

": "{String}",
73
                    "firstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

": "{String}",
74
                    "employeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

": "{String}"
75
               },
76
               "projectLeader
ProjectLeader

Reference to the employee who is a production management project leader.

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

": {
77
                    "employeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

": "{Integer}",
78
                    "lastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

": "{String}",
79
                    "firstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

": "{String}",
80
                    "employeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

": "{String}"
81
               },
82
               "documentController
DocumentController

Reference to the employee who is a production management document controller.

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

": {
83
                    "employeeId
EmployeeId

Employee identifier

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

": "{Integer}",
84
                    "lastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

": "{String}",
85
                    "firstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

": "{String}",
86
                    "employeeLink
EmployeeLink

Employee reference

This field is greyed out because it is an expandable field. You have to add $expand=Management in your request URI to get this field

": "{String}"
87
               }
88
          },
89
          "shippingAddress": {
90
               "addressId
AddressId

Address identifier

": "{Integer}",
91
               "name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

": "{String}",
92
               "firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

": "{String}",
93
               "addressLine1
AddressLine1

First address line

": "{String}",
94
               "addressLine2
AddressLine2

Second address line

": "{String}",
95
               "postalCode
PostalCode

Postalcode/Postcode/ZIP

": "{String}",
96
               "city
City

City/town/village

": "{String}",
97
               "region
Region

Region/province/state

": "{String}",
98
               "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",
99
               "country
Country

English name of country.

": "{String}",
100
               "externalReference
ExternalReference

External address identifier. Normally defined by the customer.

": "{String}"
101
          },
102
          "invoiceAddress": {
103
               "addressId
AddressId

Address identifier

This field is greyed out because it is an expandable field. You have to add $expand=InvoiceAddress.AddressId in your request URI to get this field

": "{Integer}",
104
               "name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

": "{String}",
105
               "firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

": "{String}",
106
               "addressLine1
AddressLine1

First address line

": "{String}",
107
               "addressLine2
AddressLine2

Second address line

": "{String}",
108
               "postalCode
PostalCode

Postalcode/Postcode/ZIP

": "{String}",
109
               "city
City

City/town/village

": "{String}",
110
               "region
Region

Region/province/state

": "{String}",
111
               "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",
112
               "country
Country

English name of country.

": "{String}"
113
          },
114
          "totals": {
115
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
116
               "freightAmount
FreightAmount

Freight amount in transaction document's currency

": "{Decimal}",
117
               "feeAmount
FeeAmount

Fee amount in transaction document's currency

": "{Decimal}",
118
               "subTotalAmount
SubTotalAmount

Total amount of the object in object currency, excluding VAT.

": "{Decimal}",
119
               "vATAmount
VATAmount

Total value added tax in object currency.

": "{Decimal}",
120
               "totalAmount
TotalAmount

The total amount in object currency, including VAT

": "{Decimal}"
121
          },
122
          "totalsConverted
TotalsConverted

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": {
123
               "currency
Currency

Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{String}",
124
               "exchangeRate
ExchangeRate

The exchange rate used in convertion

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
125
               "freightAmount
FreightAmount

Freight amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
126
               "feeAmount
FeeAmount

Fee amount in company currency

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
127
               "subTotalAmount
SubTotalAmount

Total amount of the object in company currency, excluding VAT.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
128
               "vATAmount
VATAmount

Value added tax amount in company currency.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}",
129
               "totalAmount
TotalAmount

The total amount in company currency, including VAT.

This field is greyed out because it is an expandable field. You have to add $expand=TotalsConverted in your request URI to get this field

": "{Decimal}"
130
          },
131
          "shipment": {
132
               "deliveryTerms
DeliveryTerms

Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer.

Possible domain values can be found here

": "{String}",
133
               "deliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

": "{String}",
134
               "onlyShipEntireSalesOrder
OnlyShipEntireSalesOrder

True if all items of a sales order should be shipped together. The items of a sales order should never be split into several shipments. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.

": "{Boolean}",
135
               "onlyShipEntireSalesOrderItems
OnlyShipEntireSalesOrderItems

True if the total quantity of a sales order item always should be shipped together. The quantity should never be split into several shipments. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.

": "{Boolean}",
136
               "avoidMultipleShipmentsOnSameDate
AvoidMultipleShipmentsOnSameDate

True if all items of a sales order with the same sheduled delivery date should be shipped together. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.

": "{Boolean}",
137
               "shipBasedOnConfirmedDeliveryDate
ShipBasedOnConfirmedDeliveryDate

If true, will sheduled shipping date on each item be calculated based on confirmed date rather than requested date.

": "{Boolean}",
138
               "freightForEachShipment
FreightForEachShipment

If unchecked there will only be calculated freight on one shipping advice if the particular sales order has serveral shipments.

": "{Boolean}",
139
               "shippingDay
ShippingDay

Specifies when the goods should be shipped. This is used to calculate the scheduled shipping date for each item.

Possible domain values can be found here

": "{String}",
140
               "consolidateShippingAdvices
ConsolidateShippingAdvices

If true, sales orders will be consolidated when creating shipping advices via the "Prepare for picking" process the . If false, each sales order will result in seperate shipping advice. The field to use when consolidating is specified in the ShippingAdviceConsolidationField.

": "{Boolean}",
141
               "shippingAdviceConsolidationField
ShippingAdviceConsolidationField

Field to use when consolidating sales order items into shipping advices in the "Prepare for picking" process.

Possible domain values can be found here

": "{String}",
142
               "shippingAdviceItemSortBy
ShippingAdviceItemSortBy

Items in consolidated shipping advices will be sorted by this fields when they are created in the 'Prepare for picking' process

Possible domain values can be found here

": "{String}",
143
               "specialHandling
SpecialHandling

Special handling to use for this shipment.

": {
144
                    "specialHandlingId
SpecialHandlingId

Special handling identifier

": "{Integer}",
145
                    "specialHandlingLink
SpecialHandlingLink

Special handling code reference

": "{String}"
146
               },
147
               "shippingService": {
148
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

": "{Integer}",
149
                    "name
Name

Name of shipping service

": "{String}",
150
                    "carrier": {
151
                         "carrierId
CarrierId

Carrier identifier

": "{Integer}",
152
                         "name
Name

Name of carrier

This field is greyed out because it is an expandable field. You have to add $expand=Shipment.ShippingService.Carrier.Name in your request URI to get this field

": "{String}",
153
                         "carrierLink
CarrierLink

Carrier reference

": "{String}"
154
                    },
155
                    "shippingServiceLink
ShippingServiceLink

Shipping service reference

": "{String}"
156
               }
157
          },
158
          "invoicing": {
159
               "salesInvoiceConsolidation
SalesInvoiceConsolidation

Specifies whether or how often shipping advices that origins from this sales order will be consolidated when creating sales invoices.

Possible domain values can be found here

": "{String}",
160
               "salesInvoiceConsolidationField
SalesInvoiceConsolidationField

Field name to group by when consolidating shipping advice items into sales invoices.

Possible domain values can be found here

": "{String}",
161
               "salesInvoiceItemSortBy
SalesInvoiceItemSortBy

Field name to sort by when creating sales invoice items.

Possible domain values can be found here

": "{String}"
162
          },
163
          "payment": {
164
               "paymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field.

Possible domain values can be found here

": "{String}",
165
               "paymentMethod
PaymentMethod

Method of payment. Default value is retrieved from the customer.

Possible domain values can be found here

": "{String}",
166
               "dueDate
DueDate

Date the sales order is due to be paid. Only relevant for pre-paid orders.

": "{Date}",
167
               "creditCardTransaction": {
168
                    "creditCardTransactionId
CreditCardTransactionId

Credit card transaction identifier

": "{Integer}",
169
                    "creditCardTransactionLink
CreditCardTransactionLink

Credit card transaction reference

": "{String}"
170
               }
171
          },
172
          "vATDetails": {
173
               "vATType
VATType

Type of value added tax

": "{String}",
174
               "vATHandling
VATHandling

Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.

Possible domain values can be found here

": "{String}",
175
               "defaultVATPercent
DefaultVATPercent

Value added tax percent.

": "{Decimal}"
176
          },
177
          "highlightedNotification
HighlightedNotification

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": {
178
               "notificationId
NotificationId

Notification identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{Integer}",
179
               "status
Status

Status of the notification

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{Integer}",
180
               "createdAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{Datetime}",
181
               "message
Message

The message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
182
               "translatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
183
               "notificationType
NotificationType

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": {
184
                    "notificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
185
                    "category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
186
                    "notificationTypeLink
NotificationTypeLink

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}"
187
               },
188
               "notificationLink
NotificationLink

Notification reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}"
189
          },
190
          "salesDeliveryProject": {
191
               "salesDeliveryProjectId
SalesDeliveryProjectId

Sales delivery project identifier

": "{Integer}",
192
               "name
Name

Name of sales delivery

This field is greyed out because it is an expandable field. You have to add $expand=SalesDeliveryProject.Name in your request URI to get this field

": "{String}",
193
               "salesDeliveryProjectLink
SalesDeliveryProjectLink

Sales delivery project reference

": "{String}"
194
          },
195
          "service
Service

This field is greyed out because it is an expandable field. You have to add $expand=Service in your request URI to get this field

": {
196
               "specialHandling
SpecialHandling

This field is greyed out because it is an expandable field. You have to add $expand=Service in your request URI to get this field

": {
197
                    "specialHandlingId
SpecialHandlingId

Special handling identifier

This field is greyed out because it is an expandable field. You have to add $expand=Service in your request URI to get this field

": "{Integer}",
198
                    "specialHandlingLink
SpecialHandlingLink

Special handling code reference

This field is greyed out because it is an expandable field. You have to add $expand=Service in your request URI to get this field

": "{String}"
199
               }
200
          }
201
     }
202
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

POST
Set sales order as sample order
Mark sales order as sample order and set grossprice to zero
AOP/100038
POST
Cancel sales order
Cancel all items in sales order
AOP/100041
POST
Update confirmed delivery date in all items
Update confirmed delivery date in all items in sales order
AOP/100042
POST
Update requested delivery date in all items
Update requested delivery date in all items in sales order
AOP/100043
POST
Delete all items
Delete all items in sales order
AOP/100044
POST
Cancel credit card transaction
Cancel credit card transaction
AOP/100045
POST
Create advance invoice plan
Create advance invoice plan from sales order
AOP/100046
POST
Make invoice from sales order
Transports sales order to shipping advice, registers shipping advice, transports shipping advice to invoice and registers the in
AOP/100047
POST
Split product structure into seperate items
Split product structure into seperate rental order items
AOP/100050
POST
Register sales order
Register sales order
AOP/100055
POST
Forward all items in sales order to new sales order
Forward all items in sales order to new sales order
AOP/100056
POST
Forward all items in sales order to existing sales order
Forward all items in sales order to existing sales order
AOP/100059
POST
Forward all items in sales order to new shipping advice
Forward all items in sales order to new shipping advice
AOP/100072
POST
Forward all items in sales order to existing shipping advice
Forward all items in sales order to existing shipping advice
AOP/100073
POST
Copy customers reference number to all items
Update CustomersReferenceNumber in all items
AOP/100085
POST
Make invoice and payment from sales order
Registers the sales order, transports sales order to shipping advice, registers shipping advice, transports shipping advice to invoice and registers the invoice + registers payment
AOP/100098
POST
Remove project from all items in sales order
Remove project from all items in sales order
AOP/100101
POST
Release production blocking for all sales order items
Unblock all production blocked itemes
AOP/100146
POST
Re-open sales order
Set all items on a sales order to status 1
AOP/100156
POST
Re-open sales order to status 0
Set all items on a sales order to status 0
AOP/100336
POST
Assign to Stock
AOP/100342
POST
Start direct shipment process by creating new purchase order
Initiate direct shipment prosess by creating a new purchase order as a copy of the sales order
AOP/100353
POST
Undo started direct shipment process
AOP/100365
POST
Start direct shipment process by using an existing purchase order
Initiate direct shipment prosess by using an existing purchase order or a purchase order response
AOP/100368
POST
Copy to new sales order
Copy sales order to new sales order
AOP/100391
POST
Copy sales order to new sales quote
Copies sales order to new sales quote
AOP/100437
POST
Update discount percent on all items
Updates discount percent on all items
AOP/100536
POST
Reserve payment
Payment is reserved by an external system for a specific sales order
AOP/100539
POST
Forward all items in sales order to a new sales invoice
Forward all items in sales order to sales invoice
AOP/100566
POST
Forward all items in sales order to an existing sales invoice
Forwards all items in sales order to an existing sales invoice
AOP/100567
POST
Accept expected price in all items
Will set expected price from sales order request as gross price on all items
AOP/100682
POST
Forward multiple sales order items to a new sales order
AOP/100704
POST
Forward multiple sales order items to an existing sales order
AOP/100705
POST
Forward multiple sales order items to a new shipping advice
AOP/100706
POST
Forward multiple sales order items to an existing shipping advice
AOP/100708
POST
Delete multiple items for a sales order
Deletes multiple items for a sales order
AOP/100709
POST
Cancel multiple sales order items
AOP/100714
POST
Update finance project on all items
AOP/100770
POST
Register sales order and reserve payment
Register sales order and reserve payment by an external system for a specific sales order
AOP/100960
POST
Update gross margin on all sales order items
AOP/100963
POST
Create sales order item of type rental
AOP/101433
POST
Reorder all line numbers
AOP/101486
POST
Recalculate price for all sales order items
AOP/101501
POST
Recalculate price for multiple sales order items
Recalculate price for multiple sales order items
AOP/101506
POST
Change country for direct shipment
AOP/101540
POST
Set end customer on all sales order items
Copies the specified customer data to end customer fields for all sales order items
AOP/101570
POST
Lock confirmed delivery date on all sales order items
AOP/101710
POST
Unlock confirmed delivery date on all sales order items
AOP/101711
POST
Update seller on all items
AOP/101730
POST
Split product structure for all items with phantom product structure
Split product structure for all items of type KS into separate items
AOP/101820

Possible error codes the response might return:

Error 100147 HTTP 404 Notification type not found
Error 100055 HTTP 403 You have only admittance to your own objects