API

RamBase REST APIs

GET sales/orders

List of sales orders

HTTP method GET
URI https://api.rambase.net/sales/orders
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 604, version 49

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
$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.
$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.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

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

Active() Named filter Active sales orders. Sales orders registered, but not delivered yet.
ActiveOrShipped() Named filter List of active sales orders and processed orders with one or more items forwarded to shipping advice. This list excludes sales orders forwarded to new sales orders.
Delayed() Named filter Sales orders that contains item(s) which should have been delivered according to confirmed delivery date.
InfoNotification() Named filter Sales orders with notifications of category I (Information)
MyOpenOrders() Named filter Sales orders not processed where current user is either assigned to, sales assistant for og account manager for.
MyOrders() Named filter Sales orders the current user is either assigned to, sales assistent for or account manager for.
OpenOrders() Named filter Sales orders not processed
PendingRegistration() Named filter Sales orders which is not yet registered
PendingShipping() Named filter Sales orders ready for shipping
AccountManager Integer Reference to the employee who is responsible for the management of sales, and relationship with the customer. Available macros: currentUser()
Assignee Integer The user who has been assigned to work with this object. Available macros: currentUser()
AssigneeName String The name of the user who has been assigned to work with this object.
ContainingNotificationMessage String Show all transaction documents containing notifications. Note that search will be for messages in company language, and not in user language.
ContainingNotificationTypeId Integer Notification type identifier.
ConvertedSubTotalAmount Decimal Total amount of the object in company currency, excluding VAT.
ConvertedTotalAmount Decimal The total amount in company currency, including VAT.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Currency String Three character code following the ISO 4217 standard.
CustomerId Integer Customer identifier.
CustomersReference String Customers reference. Typically a person.
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
DeliveryTermPlace String Named place related to delivery terms (Incoterms).
DeliveryTerms String 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.
DocumentController Integer Reference to the employee who is a production management document controller. Available macros: currentUser()
ExchangeRateFluctuationAgreement String 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.
FeeAmount Decimal Fee amount in transaction document's currency.
Firstname String Secondary name of a company or firstname of a person.
FreightAmount Decimal Freight amount in transaction document's currency.
GrossMargin Decimal 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.
HasAttachmentsToForward Boolean Has attachements that will be included when forwarded to other transaction documents.
InitialSalesOrderId Integer Reference to initial sales order.
InvoiceAddressCity String City/town/village.
InvoiceAddressCountryCode String Two-character code (ISO 3166) identifying the country.
InvoiceAddressPostalCode String Postalcode/Postcode/ZIP.
Location String Unique abbreviation/short name of the location.
MarketSegment String Market segment of the customer.
Name String Name of customer (name of company or surname/familyname/lastname of a person).
NetWeight Decimal The net weight of object (excluding packing meterial) in kilograms.
Note String Additional information regarding the object (free text). This note might be visible to customers/suppliers.
PaymentMethod String Method of payment. Default value is retrieved from the customer..
PaymentTerms String 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.
Planner Integer Reference to the employee who is a production management planner. Available macros: currentUser()
ProjectLeader Integer Reference to the employee who is a production management project leader. Available macros: currentUser()
ProjectOrderId Integer Project order identifier.
ProjectOrderItemId Integer Project order item identifier.
RegistrationDate Date Date of registration. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
SalesAssistant Integer Reference to the employee who is sales assistant for the customer. Available macros: currentUser()
SalesDeliveryProjectId Integer Sales delivery project identifier.
SalesDistrict String A geographic district for which an individual salesperson or sales team holds responsibility.
SalesOrderId Integer Sales order identifier.
SellersReferenceNumber String Sellers reference number..
ShippingAddressCountryCode String Country code of shipment destination.
ShippingAddressName String 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.
Status Integer Status of sales order.
SubTotalAmount Decimal Total amount of the object in object currency, excluding VAT.
TotalAmount Decimal The total amount in object currency, including VAT.
Type String Type of sales order..
UpdatedAt Datetime Date and time of update. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
VATAmount Decimal Total value added tax in object currency.
VATHandling String Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.
VolumePriceAgreement String Special price agreement related to the quantity beeing ordered..

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

AccountManager Integer Reference to the employee who is responsible for the management of sales, and relationship with the customer.
Assignee Integer The user who has been assigned to work with this object.
AssigneeName String The name of the user who has been assigned to work with this object.
ContainingNotificationMessage String Show all transaction documents containing notifications. Note that search will be for messages in company language, and not in user language.
ContainingNotificationTypeId Integer Notification type identifier
ConvertedSubTotalAmount Decimal Total amount of the object in company currency, excluding VAT.
ConvertedTotalAmount Decimal The total amount in company currency, including VAT.
CreatedAt Datetime Date and time of creation
Currency String Three character code following the ISO 4217 standard
CustomerId Integer Customer identifier
CustomersReference String Customers reference. Typically a person.
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
DeliveryTermPlace String Named place related to delivery terms (Incoterms)
DeliveryTerms String 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.
DocumentController Integer Reference to the employee who is a production management document controller.
ExchangeRateFluctuationAgreement String 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.
FeeAmount Decimal Fee amount in transaction document's currency
Firstname String Secondary name of a company or firstname of a person
FreightAmount Decimal Freight amount in transaction document's currency
GrossMargin Decimal 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
HasAttachmentsToForward Boolean Has attachements that will be included when forwarded to other transaction documents.
InitialSalesOrderId Integer Reference to initial sales order
InvoiceAddressCity String City/town/village
InvoiceAddressCountryCode String Two-character code (ISO 3166) identifying the country.
InvoiceAddressPostalCode String Postalcode/Postcode/ZIP
Location String Unique abbreviation/short name of the location
MarketSegment String Market segment of the customer
Name String Name of customer (name of company or surname/familyname/lastname of a person)
NetWeight Decimal The net weight of object (excluding packing meterial) in kilograms
PaymentMethod String Method of payment. Default value is retrieved from the customer.
PaymentTerms String 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.
Planner Integer Reference to the employee who is a production management planner.
ProjectLeader Integer Reference to the employee who is a production management project leader.
ProjectOrderId Integer Project order identifier
ProjectOrderItemId Integer Project order item identifier
RegistrationDate Date Date of registration
SalesAssistant Integer Reference to the employee who is sales assistant for the customer.
SalesDeliveryProjectId Integer Sales delivery project identifier
SalesDistrict String A geographic district for which an individual salesperson or sales team holds responsibility
SalesOrderId Integer Sales order identifier
SellersReferenceNumber String Sellers reference number.
ShippingAddressCountryCode String Country code of shipment destination
ShippingAddressName String 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.
Status Integer Status of sales order
SubTotalAmount Decimal Total amount of the object in object currency, excluding VAT.
TotalAmount Decimal The total amount in object currency, including VAT
Type String Type of sales order.
UpdatedAt Datetime Date and time of update
VATAmount Decimal Total value added tax in object currency.
VATHandling String Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.
VolumePriceAgreement String Special price agreement related to the quantity beeing ordered.

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
<SalesOrders>
2
     <SalesOrder>
3
          <SalesOrderId
SalesOrderId

Sales order identifier

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

Status of sales order

Possible domain values can be found here

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

Type of sales order.

Possible domain values can be found here

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

Date and time of creation

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

Date of registration

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

Sellers reference number.

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

Customers reference. Typically a person.

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

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

>{String}</CustomersReferenceNumber>
11
          <Assignee
Assignee

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

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

>
12
               <UserId
UserId

User identifier

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

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

Name of the user

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

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

First name of the user

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

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

User reference

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

>{String}</UserLink>
16
          </Assignee>
17
          <Customer>
18
               <CustomerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

>{String}</Firstname>
21
               <Sales>
22
                    <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=SalesOrder.Customer.Sales.AccountManager in your request URI to get this field

>
23
                         <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
27
                    </AccountManager>
28
               </Sales>
29
               <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
30
          </Customer>
31
          <InitialSalesOrder
InitialSalesOrder

Reference to initial sales order

>
32
               <SalesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

>{String}</SalesOrderLink>
34
          </InitialSalesOrder>
35
          <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=SalesOrder.Management in your request URI to get this field

>
36
               <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=SalesOrder.Management in your request URI to get this field

>
37
                    <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
41
               </Planner>
42
               <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=SalesOrder.Management in your request URI to get this field

>
43
                    <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
47
               </ProjectLeader>
48
               <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=SalesOrder.Management in your request URI to get this field

>
49
                    <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
53
               </DocumentController>
54
          </Management>
55
          <Payment
Payment

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

>
56
               <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

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

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

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

Possible domain values can be found here

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

>{String}</PaymentMethod>
58
          </Payment>
59
          <Totals>
60
               <Currency
Currency

Three character code following the ISO 4217 standard

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

Freight amount in transaction document's currency

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

Fee amount in transaction document's currency

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

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

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

Total value added tax in object currency.

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

The total amount in object currency, including VAT

>{Decimal}</TotalAmount>
66
          </Totals>
67
          <TotalsConverted
TotalsConverted

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

>
68
               <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=SalesOrder.TotalsConverted in your request URI to get this field

>{String}</Currency>
69
               <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=SalesOrder.TotalsConverted in your request URI to get this field

>{Decimal}</SubTotalAmount>
70
               <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=SalesOrder.TotalsConverted in your request URI to get this field

>{Decimal}</TotalAmount>
71
          </TotalsConverted>
72
          <HighlightedNotification
HighlightedNotification

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

>
73
               <NotificationId
NotificationId

Notification identifier

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

>{Integer}</NotificationId>
74
               <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=SalesOrder.HighlightedNotification in your request URI to get this field

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

Date and time of creation

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

>{Datetime}</CreatedAt>
76
               <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=SalesOrder.HighlightedNotification in your request URI to get this field

>{String}</Message>
77
               <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=SalesOrder.HighlightedNotification in your request URI to get this field

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

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

>
79
                    <NotificationTypeId
NotificationTypeId

Notification type identifier

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

>{String}</NotificationTypeId>
80
                    <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=SalesOrder.HighlightedNotification in your request URI to get this field

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

Notification type reference

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

>{String}</NotificationTypeLink>
82
               </NotificationType>
83
               <NotificationLink
NotificationLink

Notification reference

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

>{String}</NotificationLink>
84
          </HighlightedNotification>
85
          <SalesDeliveryProject>
86
               <SalesDeliveryProjectId
SalesDeliveryProjectId

Sales delivery project identifier

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

Name of sales delivery

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

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

Sales delivery project reference

>{String}</SalesDeliveryProjectLink>
89
          </SalesDeliveryProject>
90
          <SalesOrderLink
SalesOrderLink

Sales order reference

>{String}</SalesOrderLink>
91
     </SalesOrder>
92
     <Paging
Paging

Detailed paging information for this list.

>
93
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
94
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
95
          <Page
Page

Page index

>{Integer}</Page>
96
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

>{String}</FirstPageKey>
97
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
98
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

>{String}</PreviousPageKey>
99
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
100
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

>{String}</NextPageKey>
101
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
102
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

>{String}</LastPageKey>
103
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
104
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
105
     </Paging>
106
</SalesOrders>
1
{
2
     "salesOrders": [
3
          {
4
               "salesOrderId
SalesOrderId

Sales order identifier

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

Status of sales order

Possible domain values can be found here

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

Type of sales order.

Possible domain values can be found here

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

Date and time of creation

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

Date of registration

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

Sellers reference number.

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

Customers reference. Typically a person.

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

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

": "{String}",
12
               "assignee
Assignee

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

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

": {
13
                    "userId
UserId

User identifier

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

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

Name of the user

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

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

First name of the user

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

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

User reference

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

": "{String}"
17
               },
18
               "customer": {
19
                    "customerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

": "{String}",
22
                    "sales": {
23
                         "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=SalesOrder.Customer.Sales.AccountManager in your request URI to get this field

": {
24
                              "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
28
                         }
29
                    },
30
                    "customerLink
CustomerLink

Customer reference

": "{String}"
31
               },
32
               "initialSalesOrder
InitialSalesOrder

Reference to initial sales order

": {
33
                    "salesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

": "{String}"
35
               },
36
               "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=SalesOrder.Management in your request URI to get this field

": {
37
                    "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=SalesOrder.Management in your request URI to get this field

": {
38
                         "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
42
                    },
43
                    "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=SalesOrder.Management in your request URI to get this field

": {
44
                         "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
48
                    },
49
                    "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=SalesOrder.Management in your request URI to get this field

": {
50
                         "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
54
                    }
55
               },
56
               "payment
Payment

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

": {
57
                    "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

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

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

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

Possible domain values can be found here

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

": "{String}"
59
               },
60
               "totals": {
61
                    "currency
Currency

Three character code following the ISO 4217 standard

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

Freight amount in transaction document's currency

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

Fee amount in transaction document's currency

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

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

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

Total value added tax in object currency.

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

The total amount in object currency, including VAT

": "{Decimal}"
67
               },
68
               "totalsConverted
TotalsConverted

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

": {
69
                    "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=SalesOrder.TotalsConverted in your request URI to get this field

": "{String}",
70
                    "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=SalesOrder.TotalsConverted in your request URI to get this field

": "{Decimal}",
71
                    "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=SalesOrder.TotalsConverted in your request URI to get this field

": "{Decimal}"
72
               },
73
               "highlightedNotification
HighlightedNotification

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

": {
74
                    "notificationId
NotificationId

Notification identifier

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

": "{Integer}",
75
                    "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=SalesOrder.HighlightedNotification in your request URI to get this field

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

Date and time of creation

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

": "{Datetime}",
77
                    "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=SalesOrder.HighlightedNotification in your request URI to get this field

": "{String}",
78
                    "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=SalesOrder.HighlightedNotification in your request URI to get this field

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

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

": {
80
                         "notificationTypeId
NotificationTypeId

Notification type identifier

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

": "{String}",
81
                         "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=SalesOrder.HighlightedNotification in your request URI to get this field

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

Notification type reference

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

": "{String}"
83
                    },
84
                    "notificationLink
NotificationLink

Notification reference

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

": "{String}"
85
               },
86
               "salesDeliveryProject": {
87
                    "salesDeliveryProjectId
SalesDeliveryProjectId

Sales delivery project identifier

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

Name of sales delivery

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

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

Sales delivery project reference

": "{String}"
90
               },
91
               "salesOrderLink
SalesOrderLink

Sales order reference

": "{String}"
92
          }
93
     ],
94
     "paging
Paging

Detailed paging information for this list.

": {
95
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
96
          "position
Position

Position of the first element in the list

": "{Integer}",
97
          "page
Page

Page index

": "{Integer}",
98
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

": "{String}",
99
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
100
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

": "{String}",
101
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
102
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

": "{String}",
103
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
104
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

": "{String}",
105
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
106
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
107
     }
108
}

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

Possible error codes the response might return:

Error 102738 HTTP 404 Price list not found
Error 100055 HTTP 403 You have only admittance to your own objects