API

Sales APIs

GET sales/order-requests/{salesOrderRequestId}

Sales order request details for provided identifier

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

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
<SalesOrderRequest>
2
     <SalesOrderRequestId
SalesOrderRequestId

Sales order request identifier

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

Status of sales order request

Possible domain values can be found here

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

Date and time of creation

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

Date of registration

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

Sellers reference number.

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

Customers reference. Typically a person.

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

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

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

Special price agreement related to the quantity beeing ordered.

Possible domain values can be found here

>{String}</VolumePriceAgreement>
10
     <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>
11
     <NetWeight
NetWeight

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

>{Decimal}</NetWeight>
12
     <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>
13
     <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

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

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

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

>{String}</Note>
16
     <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>
17
     <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>
18
     <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>
19
     <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>
20
     <Location>
21
          <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>
22
          <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
23
          <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>
24
     </Location>
25
     <Assignee
Assignee

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

>
26
          <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
30
     </Assignee>
31
     <Customer>
32
          <CustomerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

>{String}</Firstname>
35
          <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>
36
          <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>
37
          <Sales>
38
               <SalesDistrict
SalesDistrict

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

Possible domain values can be found here

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

Market segment of the customer

Possible domain values can be found here

>{String}</MarketSegment>
40
               <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

>
41
                    <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>
42
                    <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>
43
                    <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>
44
                    <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>
45
               </SalesAssistant>
46
               <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

>
47
                    <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>
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.AccountManager in your request URI to get this field

>{String}</LastName>
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.AccountManager in your request URI to get this field

>{String}</FirstName>
50
                    <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>
51
               </AccountManager>
52
          </Sales>
53
          <CustomerLegalEntity>
54
               <CustomerLegalEntityId
CustomerLegalEntityId

Customer legal entity identifier

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

Reference to customer legal entity

>{String}</CustomerLegalEntityLink>
56
          </CustomerLegalEntity>
57
          <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
58
     </Customer>
59
     <ShippingAddress>
60
          <AddressId
AddressId

Address identifier

>{Integer}</AddressId>
61
          <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>
62
          <Firstname
Firstname

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

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

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

External address identifier. Normally defined by the customer.

>{String}</ExternalReference>
71
     </ShippingAddress>
72
     <InvoiceAddress>
73
          <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>
74
          <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>
75
          <Firstname
Firstname

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

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

>{String}</Country>
83
     </InvoiceAddress>
84
     <Totals>
85
          <Currency
Currency

Three character code following the ISO 4217 standard

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

Freight amount in transaction document's currency

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

Fee amount in transaction document's currency

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

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

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

Total value added tax in object currency.

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

The total amount in object currency, including VAT

>{Decimal}</TotalAmount>
91
     </Totals>
92
     <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

>
93
          <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>
94
          <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>
95
          <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>
96
          <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>
97
          <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>
98
          <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>
99
          <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>
100
     </TotalsConverted>
101
     <Shipment>
102
          <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>
103
          <DeliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

>{String}</DeliveryTermPlace>
104
          <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>
105
          <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>
106
          <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>
107
          <ShipBasedOnConfirmedDeliveryDate
ShipBasedOnConfirmedDeliveryDate

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

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

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

>{Boolean}</FreightForEachShipment>
109
          <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>
110
          <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>
111
          <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>
112
          <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>
113
          <SpecialHandling
SpecialHandling

Special handling to use for this shipment.

>
114
               <SpecialHandlingId
SpecialHandlingId

Special handling identifier

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

Special handling code reference

>{String}</SpecialHandlingLink>
116
          </SpecialHandling>
117
          <ShippingService>
118
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

>{String}</Name>
120
               <Carrier>
121
                    <CarrierId
CarrierId

Carrier identifier

>{Integer}</CarrierId>
122
                    <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>
123
                    <CarrierLink
CarrierLink

Carrier reference

>{String}</CarrierLink>
124
               </Carrier>
125
               <ShippingServiceLink
ShippingServiceLink

Shipping service reference

>{String}</ShippingServiceLink>
126
          </ShippingService>
127
     </Shipment>
128
     <Invoicing>
129
          <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>
130
          <SalesInvoiceConsolidationField
SalesInvoiceConsolidationField

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

Possible domain values can be found here

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

Field name to sort by when creating sales invoice items.

Possible domain values can be found here

>{String}</SalesInvoiceItemSortBy>
132
     </Invoicing>
133
     <Payment>
134
          <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>
135
          <PaymentMethod
PaymentMethod

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

Possible domain values can be found here

>{String}</PaymentMethod>
136
     </Payment>
137
     <VATDetails>
138
          <VATType
VATType

Type of value added tax

>{String}</VATType>
139
          <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>
140
          <DefaultVATPercent
DefaultVATPercent

Value added tax percent.

>{Decimal}</DefaultVATPercent>
141
     </VATDetails>
142
     <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

>
143
          <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>
144
          <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>
145
          <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>
146
          <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>
147
          <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>
148
          <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

>
149
               <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>
150
               <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>
151
               <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>
152
          </NotificationType>
153
          <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>
154
     </HighlightedNotification>
155
</SalesOrderRequest>
1
{
2
     "salesOrderRequest": {
3
          "salesOrderRequestId
SalesOrderRequestId

Sales order request identifier

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

Status of sales order request

Possible domain values can be found here

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

Date and time of creation

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

Date of registration

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

Sellers reference number.

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

Customers reference. Typically a person.

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

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

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

Special price agreement related to the quantity beeing ordered.

Possible domain values can be found here

": "{String}",
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}",
12
          "netWeight
NetWeight

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

": "{Decimal}",
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}",
14
          "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

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

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

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

": "{String}",
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}",
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}",
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}",
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}",
21
          "location": {
22
               "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}",
23
               "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
24
               "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}"
25
          },
26
          "assignee
Assignee

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

": {
27
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
31
          },
32
          "customer": {
33
               "customerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

": "{String}",
36
               "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}",
37
               "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}",
38
               "sales": {
39
                    "salesDistrict
SalesDistrict

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

Possible domain values can be found here

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

Market segment of the customer

Possible domain values can be found here

": "{String}",
41
                    "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

": {
42
                         "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}",
43
                         "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}",
44
                         "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}",
45
                         "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}"
46
                    },
47
                    "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

": {
48
                         "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}",
49
                         "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}",
50
                         "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}",
51
                         "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}"
52
                    }
53
               },
54
               "customerLegalEntity": {
55
                    "customerLegalEntityId
CustomerLegalEntityId

Customer legal entity identifier

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

Reference to customer legal entity

": "{String}"
57
               },
58
               "customerLink
CustomerLink

Customer reference

": "{String}"
59
          },
60
          "shippingAddress": {
61
               "addressId
AddressId

Address identifier

": "{Integer}",
62
               "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}",
63
               "firstname
Firstname

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

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

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

External address identifier. Normally defined by the customer.

": "{String}"
72
          },
73
          "invoiceAddress": {
74
               "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}",
75
               "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}",
76
               "firstname
Firstname

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

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

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

": "{String}"
84
          },
85
          "totals": {
86
               "currency
Currency

Three character code following the ISO 4217 standard

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

Freight amount in transaction document's currency

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

Fee amount in transaction document's currency

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

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

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

Total value added tax in object currency.

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

The total amount in object currency, including VAT

": "{Decimal}"
92
          },
93
          "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

": {
94
               "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}",
95
               "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}",
96
               "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}",
97
               "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}",
98
               "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}",
99
               "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}",
100
               "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}"
101
          },
102
          "shipment": {
103
               "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}",
104
               "deliveryTermPlace
DeliveryTermPlace

Named place related to delivery terms (Incoterms)

": "{String}",
105
               "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}",
106
               "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}",
107
               "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}",
108
               "shipBasedOnConfirmedDeliveryDate
ShipBasedOnConfirmedDeliveryDate

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

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

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

": "{Boolean}",
110
               "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}",
111
               "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}",
112
               "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}",
113
               "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}",
114
               "specialHandling
SpecialHandling

Special handling to use for this shipment.

": {
115
                    "specialHandlingId
SpecialHandlingId

Special handling identifier

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

Special handling code reference

": "{String}"
117
               },
118
               "shippingService": {
119
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

": "{String}",
121
                    "carrier": {
122
                         "carrierId
CarrierId

Carrier identifier

": "{Integer}",
123
                         "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}",
124
                         "carrierLink
CarrierLink

Carrier reference

": "{String}"
125
                    },
126
                    "shippingServiceLink
ShippingServiceLink

Shipping service reference

": "{String}"
127
               }
128
          },
129
          "invoicing": {
130
               "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}",
131
               "salesInvoiceConsolidationField
SalesInvoiceConsolidationField

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

Possible domain values can be found here

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

Field name to sort by when creating sales invoice items.

Possible domain values can be found here

": "{String}"
133
          },
134
          "payment": {
135
               "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}",
136
               "paymentMethod
PaymentMethod

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

Possible domain values can be found here

": "{String}"
137
          },
138
          "vATDetails": {
139
               "vATType
VATType

Type of value added tax

": "{String}",
140
               "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}",
141
               "defaultVATPercent
DefaultVATPercent

Value added tax percent.

": "{Decimal}"
142
          },
143
          "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

": {
144
               "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}",
145
               "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}",
146
               "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}",
147
               "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}",
148
               "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}",
149
               "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

": {
150
                    "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}",
151
                    "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}",
152
                    "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}"
153
               },
154
               "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}"
155
          }
156
     }
157
}

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