API

Sales APIs

GET sales/order-items

List of all sales order items

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

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 order items. Sales orders items registered, but not delivered yet.
ApprovalNotification() Named filter Sales order items with notifications of category A (approvals)
ConfirmedThisWeek() Named filter Sales order items with a confirmed delivery date this week
ConfLaterThanReq() Named filter Sales order items where confirmed delivery date is later than requested delivery date
Delayed() Named filter Sales order items which should have been delivered according to confirmed delivery date
InfoNotification() Named filter Sales order items with notification of category I (Information)
MyItems() Named filter Items which belong to a sales order the current user is either assigned to, sales assistent for or account manager for.
MyOpenItems() Named filter Sales order items not processed which belongs to a sales order which the current user is assigned to, sales assistant for or account manager for
OpenItems() Named filter Sales order items not processed
WithDeliveryProblems() Named filter Sales order items with possible delivery problems. Possible delivery problems can be delayed items (status 6), unconfirmed items or items with mismatch between confirmed delivery date and requested delivery date.
AccountManager Integer Reference to the employee who is responsible for the management of sales, and relationship with the customer. Available macros: currentUser()
AllocatedStockQuantity Decimal The quantity of this item which do have assignments from stock.
AssetId Integer Asset identifier.
Assignee Integer The user who has been assigned to work with this object. Available macros: currentUser()
ConfirmedDeliveryDate Date Confirmed date of delivery. Date of which the customer can expect the arriving goods. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ContainingNotificationTypeId Integer Notification type identifier.
ConvertedGrossAmount Decimal Total gross amount in company currency.
ConvertedGrossPrice Decimal Represents the price per unit before any discounting is applied.
ConvertedNetAmount Decimal Total net amount in company currency.
ConvertedNetPrice Decimal Final price per unit after deducting all discounts.
ConvertedRemainingAmount Decimal Total remaining amount in company currency.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CreditCardTransactionId Integer Credit card transaction identifier.
CustomerFirstname String Secondary name of a company or firstname of a person.
CustomerId Integer Customer identifier.
CustomerLegalEntityId Integer Customer legal entity identifier.
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
CustomersProductName String Customers internal name of the product. Retrieved from the product.
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
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.
DepartmentId Integer Department identifier.
DeviationId Integer Deviation identifier.
DeviationTypeId Integer Deviation definition identifier.
Discount Decimal The discount for the item.
DiscountAmount Decimal The items discount amount.
DiscountPercent Decimal The discount in percent for this item.
DocumentController Integer Reference to the employee who is a production management document controller. Available macros: currentUser()
DueDate Date Date the sales order is due to be paid. Only relevant for pre-paid orders. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
EndCustomerFirstName String Secondary name of a company or firstname of a person.
EndCustomerId Integer Customer identifier.
EndCustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
EquivalentProductName String Name of product with equivalent behavior and attributes. Can be used for same purpose..
ExpectedEndDate Date Expected end date of subscription or rental item. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
FeeAmount Decimal Fee amount in transaction document's currency.
FinanceProjectId Integer Finance project identifier.
FreightAmount Decimal Freight amount in transaction document's currency.
GeneralLedgerAccountId Integer General ledger account identifier.
GrossAmount Decimal Represents the item amount before any discounts etc. is applied.
GrossMargin Decimal Gross margin of the item.
GrossPrice Decimal Represents the price per unit before any discounting is applied.
IntercompanySalesOrderReferenceValue String Value for the field from the sales order in the other company.
IsBlockedForProduction Boolean True if a new production is not to be started automatically based on this sales order item.
IsConfirmedDeliveryDateLocked Boolean If confirmed delivery date in sales order item (COA) is locked, this date should not be re-calculated automatically.
IsPaymentCoveredByWarranty Boolean True if payment of item will be covered by warranty. For sales order items that are a part of the repair process, it means that these will not be invoiced.
IsSerialNumberRequiredBeforeShipping Boolean True if serial number is required before shipping. Note that if the product has set this value to true, this can not be overridden.
LineNumber Integer Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
LocationShortName String Unique abbreviation/short name of the location.
ManufacturerId Integer Manufacturer identifier.
ManufacturerShortName String Shortname/code of the manufacturer.
MarketSegment String Market segment of the customer.
NetAmount Decimal Final item amount after deducting all discounts etc.
NetPrice Decimal Final price per unit after deducting all discounts etc.
Note String Additional information regarding the item (free text). Might be visible to customers/suppliers.
OpenForwardedQuantity Decimal When items are forwarded they end up in one or more open items. Open items in this context means items that are not registered (status 0 or 1). OpenForwardedQuantity will be the sum of ForwardedQuantity of all items this item has been forwarded to.
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()
PriceChangeAgreement Integer Defines if and how the recurring price can be updated.
ProductCustomField1 String Custom field for grouping, sorting, categorizing and other purposes.
ProductCustomField2 String Custom field for grouping, sorting, categorizing and other purposes.
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductStructureId Integer Product structure reference.
ProductType String Type of product.
ProductWeight Decimal The weight of the product in kilograms.
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.
PurchaseCurrency String Purchase currency is the currency this product normally is purchased in. This is also the base currency used in the gross margin calculation. By default the purchase currency is retrieved from the product.
Quantity Decimal Number of units ordered.
RecurringPriceId Integer Recurring price indentifier.
RegistrationDate Date Date of registration. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
RemainingAmount Decimal Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice.
RemainingQuantity Decimal Remaining number of units to be forwarded.
RequestedDeliveryDate Date The delivery date as requested by the customer. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
RequestedProductStructureRevision String The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
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.
SalesOrderItemId Integer Sales order item identifier.
SalesOrderType String Type of sales order..
ScheduledShippingDate Date Date when the goods was/will be shipped from the warehouse. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
SellerEmployeeId Integer Employee identifier. Available macros: currentUser()
SellersReferenceNumber String Sellers reference number..
ShippedQuantity Decimal Quantity forwarded to one or more shipping advices.
ShippingDay String Specifies when the goods should be shipped. This is used to calculate the scheduled shipping date for each item.
StandardLeadTime Integer The expected lead time, in number of days, from ordering from supplier to delivery. Used in different purchase processes, typically when supplier is unknown. Note that this might differ from the standard lead times defined on the different suppliers..
StartDate Date Start date of subscription or rental item. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Status Integer Status of the sales order item (0-9).
SubTotalAmount Decimal Total amount of the object in object currency, excluding VAT.
Type Integer Item type.
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.
VATCode String Code that determines VAT rules used for VAT calculations.
VATHandling String Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.
VATPercent Decimal Value added tax percent.
VATType String Type of value added tax.
WarrantyExpirationDate Date Date of warranty expiration. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()

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.
AllocatedStockQuantity Decimal The quantity of this item which do have assignments from stock
AssetId Integer Asset identifier
Assignee Integer The user who has been assigned to work with this object.
ConfirmedDeliveryDate Date Confirmed date of delivery. Date of which the customer can expect the arriving goods
ContainingNotificationTypeId Integer Notification type identifier
ConvertedGrossAmount Decimal Total gross amount in company currency.
ConvertedGrossPrice Decimal Represents the price per unit before any discounting is applied.
ConvertedNetAmount Decimal Total net amount in company currency.
ConvertedNetPrice Decimal Final price per unit after deducting all discounts.
ConvertedRemainingAmount Decimal Total remaining amount in company currency.
CreatedAt Datetime Date and time of creation
CreditCardTransactionId Integer Credit card transaction identifier
CustomerFirstname String Secondary name of a company or firstname of a person
CustomerId Integer Customer identifier
CustomerLegalEntityId Integer Customer legal entity identifier
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
CustomersProductName String Customers internal name of the product. Retrieved from the product.
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
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.
DepartmentId Integer Department identifier
DeviationId Integer Deviation identifier
DeviationTypeId Integer Deviation definition identifier
Discount Decimal The discount for the item.
DiscountAmount Decimal The items discount amount.
DiscountPercent Decimal The discount in percent for this item.
DocumentController Integer Reference to the employee who is a production management document controller.
DueDate Date Date the sales order is due to be paid. Only relevant for pre-paid orders.
EndCustomerFirstName String Secondary name of a company or firstname of a person
EndCustomerId Integer Customer identifier
EndCustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
EquivalentProductName String Name of product with equivalent behavior and attributes. Can be used for same purpose.
ExpectedEndDate Date Expected end date of subscription or rental item
FeeAmount Decimal Fee amount in transaction document's currency
FinanceProjectId Integer Finance project identifier
FreightAmount Decimal Freight amount in transaction document's currency
GeneralLedgerAccountId Integer General ledger account identifier
GrossAmount Decimal Represents the item amount before any discounts etc. is applied.
GrossMargin Decimal Gross margin of the item.
GrossPrice Decimal Represents the price per unit before any discounting is applied.
IntercompanySalesOrderReferenceValue String Value for the field from the sales order in the other company
IsBlockedForProduction Boolean True if a new production is not to be started automatically based on this sales order item.
IsConfirmedDeliveryDateLocked Boolean If confirmed delivery date in sales order item (COA) is locked, this date should not be re-calculated automatically.
IsPaymentCoveredByWarranty Boolean True if payment of item will be covered by warranty. For sales order items that are a part of the repair process, it means that these will not be invoiced.
IsSerialNumberRequiredBeforeShipping Boolean True if serial number is required before shipping. Note that if the product has set this value to true, this can not be overridden.
LineNumber Integer Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
LocationShortName String Unique abbreviation/short name of the location
ManufacturerId Integer Manufacturer identifier
ManufacturerShortName String Shortname/code of the manufacturer
MarketSegment String Market segment of the customer
NetAmount Decimal Final item amount after deducting all discounts etc.
NetPrice Decimal Final price per unit after deducting all discounts etc.
Note String Additional information regarding the item (free text). Might be visible to customers/suppliers.
OpenForwardedQuantity Decimal When items are forwarded they end up in one or more open items. Open items in this context means items that are not registered (status 0 or 1). OpenForwardedQuantity will be the sum of ForwardedQuantity of all items this item has been forwarded to.
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.
PriceChangeAgreement Integer Defines if and how the recurring price can be updated
ProductCustomField1 String Custom field for grouping, sorting, categorizing and other purposes.
ProductCustomField2 String Custom field for grouping, sorting, categorizing and other purposes.
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductId Integer Product identifier
ProductName String Name of the product
ProductStructureId Integer Product structure reference
ProductType String Type of product
ProductWeight Decimal The weight of the product in kilograms.
ProjectLeader Integer Reference to the employee who is a production management project leader.
ProjectOrderId Integer Project order identifier
ProjectOrderItemId Integer Project order item identifier
PurchaseCurrency String Purchase currency is the currency this product normally is purchased in. This is also the base currency used in the gross margin calculation. By default the purchase currency is retrieved from the product.
Quantity Decimal Number of units ordered
RecurringPriceId Integer Recurring price indentifier
RegistrationDate Date Date of registration
RemainingAmount Decimal Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice
RemainingQuantity Decimal Remaining number of units to be forwarded.
RequestedDeliveryDate Date The delivery date as requested by the customer.
RequestedProductStructureRevision String The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
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
SalesOrderItemId Integer Sales order item identifier
SalesOrderType String Type of sales order.
ScheduledShippingDate Date Date when the goods was/will be shipped from the warehouse.
SellerEmployeeId Integer Employee identifier
SellersReferenceNumber String Sellers reference number.
ShippedQuantity Decimal Quantity forwarded to one or more shipping advices
ShippingDay String Specifies when the goods should be shipped. This is used to calculate the scheduled shipping date for each item.
StandardLeadTime Integer The expected lead time, in number of days, from ordering from supplier to delivery. Used in different purchase processes, typically when supplier is unknown. Note that this might differ from the standard lead times defined on the different suppliers.
StartDate Date Start date of subscription or rental item
Status Integer Status of the sales order item (0-9).
SubTotalAmount Decimal Total amount of the object in object currency, excluding VAT.
Type Integer Item type
UpdatedAt Datetime Date and time of update
VATAmount Decimal Total value added tax in object currency.
VATCode String Code that determines VAT rules used for VAT calculations.
VATHandling String Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.
VATPercent Decimal Value added tax percent
VATType String Type of value added tax
WarrantyExpirationDate Date Date of warranty expiration.

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
<SalesOrderItems>
2
     <SalesOrderItem>
3
          <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

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

Item type

Possible domain values can be found here

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

Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.

>{Integer}</LineNumber>
6
          <Status
Status

Status of the sales order item (0-9).

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
8
          <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

>{Date}</RequestedDeliveryDate>
9
          <ConfirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed date of delivery. Date of which the customer can expect the arriving goods

>{Date}</ConfirmedDeliveryDate>
10
          <IsConfirmedDeliveryDateLocked
IsConfirmedDeliveryDateLocked

If confirmed delivery date in sales order item (COA) is locked, this date should not be re-calculated automatically.

>{Boolean}</IsConfirmedDeliveryDateLocked>
11
          <ScheduledShippingDate
ScheduledShippingDate

Date when the goods was/will be shipped from the warehouse.

>{Date}</ScheduledShippingDate>
12
          <CustomersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

>{String}</CustomersReferenceNumber>
13
          <CustomersProductName
CustomersProductName

Customers internal name of the product. Retrieved from the product.

>{String}</CustomersProductName>
14
          <RequestedProductStructureRevision
RequestedProductStructureRevision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

>{String}</RequestedProductStructureRevision>
15
          <ProductDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

>{String}</ProductDescription>
16
          <GrossMargin
GrossMargin

Gross margin of the item.

>{Decimal}</GrossMargin>
17
          <DiscountPercent
DiscountPercent

The discount in percent for this item.

>{Decimal}</DiscountPercent>
18
          <Quantity
Quantity

Number of units ordered

>{Decimal}</Quantity>
19
          <RemainingQuantity
RemainingQuantity

Remaining number of units to be forwarded.

>{Decimal}</RemainingQuantity>
20
          <ShippedQuantity
ShippedQuantity

Quantity forwarded to one or more shipping advices

>{Decimal}</ShippedQuantity>
21
          <IsBlockedForProduction
IsBlockedForProduction

True if a new production is not to be started automatically based on this sales order item.

>{Boolean}</IsBlockedForProduction>
22
          <EndCustomer
EndCustomer

End customer

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

>
23
               <CustomerId
CustomerId

Customer identifier

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

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

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

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

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

Secondary name of a company or firstname of a person

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

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

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

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

>{String}</VATRegistrationNumber>
27
               <CustomerLink
CustomerLink

Customer reference

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

>{String}</CustomerLink>
28
          </EndCustomer>
29
          <Price>
30
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
31
               <Discount
Discount

The discount for the item.

>{Decimal}</Discount>
32
               <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

>{Decimal}</GrossPrice>
33
               <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
34
          </Price>
35
          <PriceConverted
PriceConverted

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

>
36
               <Currency
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=SalesOrderItem.PriceConverted in your request URI to get this field

>{String}</Currency>
37
               <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

>{Decimal}</GrossPrice>
38
               <NetPrice
NetPrice

Final price per unit after deducting all discounts.

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

>{Decimal}</NetPrice>
39
          </PriceConverted>
40
          <Totals>
41
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
42
               <GrossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

>{Decimal}</GrossAmount>
43
               <NetAmount
NetAmount

Final item amount after deducting all discounts etc.

>{Decimal}</NetAmount>
44
               <RemainingAmount
RemainingAmount

Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice

>{Decimal}</RemainingAmount>
45
          </Totals>
46
          <TotalsConverted
TotalsConverted

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

>
47
               <Currency
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=SalesOrderItem.TotalsConverted in your request URI to get this field

>{String}</Currency>
48
               <GrossAmount
GrossAmount

Total gross amount in company currency.

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

>{Decimal}</GrossAmount>
49
               <NetAmount
NetAmount

Total net amount in company currency.

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

>{Decimal}</NetAmount>
50
               <RemainingAmount
RemainingAmount

Total remaining amount in company currency.

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

>{Decimal}</RemainingAmount>
51
          </TotalsConverted>
52
          <MeasurementUnit>
53
               <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

>{Integer}</MeasurementUnitId>
54
               <Unit
Unit

Measurement unit (ex. mm, km, dl, kg)

>{String}</Unit>
55
               <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

>{String}</MeasurementUnitLink>
56
          </MeasurementUnit>
57
          <Seller
Seller

Reference to the seller of the item

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

>
58
               <EmployeeId
EmployeeId

Employee identifier

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

>{Integer}</EmployeeId>
59
               <FirstName
FirstName

First name of employee

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

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

Last name of employee

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

>{String}</LastName>
61
               <EmployeeLink
EmployeeLink

Employee reference

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

>{String}</EmployeeLink>
62
          </Seller>
63
          <Product>
64
               <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
65
               <Name
Name

Name of the product

>{String}</Name>
66
               <Type
Type

Type of product

Possible domain values can be found here

>{String}</Type>
67
               <Manufacturer>
68
                    <ManufacturerId
ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>
69
                    <ShortName
ShortName

Shortname/code of the manufacturer

>{String}</ShortName>
70
                    <ManufacturerLink
ManufacturerLink

Manufacturer reference

>{String}</ManufacturerLink>
71
               </Manufacturer>
72
               <LatestProductRevision
LatestProductRevision

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

>
73
                    <Revision
Revision

Revision number

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

>{String}</Revision>
74
               </LatestProductRevision>
75
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
76
          </Product>
77
          <ProductStructure>
78
               <ProductStructureId
ProductStructureId

Product structure reference

>{Integer}</ProductStructureId>
79
               <ProductStructureLink
ProductStructureLink

Product structure reference

>{String}</ProductStructureLink>
80
          </ProductStructure>
81
          <LandedCost>
82
               <GrossPrice
GrossPrice

Total cost (landed cost or true cost) of getting each unit in stock, including purchase price, duties, charges, freight etc.

>{Decimal}</GrossPrice>
83
               <PurchaseExchangeRate
PurchaseExchangeRate

Exchange rate between document currency and purchase currency. Used in landed cost calculations.

>{Decimal}</PurchaseExchangeRate>
84
          </LandedCost>
85
          <LandedCostConverted
LandedCostConverted

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

>
86
               <GrossPrice
GrossPrice

Total cost (landed cost or true cost) in sales currency

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

>{Decimal}</GrossPrice>
87
          </LandedCostConverted>
88
          <Accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

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

>
89
               <GeneralLedgerAccount
GeneralLedgerAccount

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

>
90
                    <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

>{Integer}</GeneralLedgerAccountId>
91
                    <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

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

>{String}</GeneralLedgerAccountLink>
92
               </GeneralLedgerAccount>
93
               <Department
Department

The department related to the item. One of the system/fixed account dimensions.

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

>
94
                    <DepartmentId
DepartmentId

Department identifier

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

>{Integer}</DepartmentId>
95
                    <DepartmentLink
DepartmentLink

Finance department reference

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

>{String}</DepartmentLink>
96
               </Department>
97
               <FinanceProject
FinanceProject

The finance project related to the item. One of the system/fixed account dimensions.

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

>
98
                    <FinanceProjectId
FinanceProjectId

Finance project identifier

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

>{Integer}</FinanceProjectId>
99
                    <FinanceProjectLink
FinanceProjectLink

Finance project reference

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

>{String}</FinanceProjectLink>
100
               </FinanceProject>
101
          </Accounting>
102
          <HighlightedNotification
HighlightedNotification

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

>
103
               <NotificationId
NotificationId

Notification identifier

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

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

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

Date and time of creation

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

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

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

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

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

>
109
                    <NotificationTypeId
NotificationTypeId

Notification type identifier

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

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

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

Notification type reference

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

>{String}</NotificationTypeLink>
112
               </NotificationType>
113
               <NotificationLink
NotificationLink

Notification reference

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

>{String}</NotificationLink>
114
          </HighlightedNotification>
115
          <SalesForecast>
116
               <SalesForecastId
SalesForecastId

Sales forecast identifier

>{Integer}</SalesForecastId>
117
               <SalesForecastLink
SalesForecastLink

Sales forecast reference

>{String}</SalesForecastLink>
118
          </SalesForecast>
119
          <SalesOrder>
120
               <SalesOrderId
SalesOrderId

Sales order identifier

>{Integer}</SalesOrderId>
121
               <CustomersReference
CustomersReference

Customers reference. Typically a person.

>{String}</CustomersReference>
122
               <Customer>
123
                    <CustomerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

>{String}</Firstname>
126
                    <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
127
               </Customer>
128
               <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=SalesOrderItem.SalesOrder.Management in your request URI to get this field

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

>
130
                         <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

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

>
136
                         <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

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

>
142
                         <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
146
                    </DocumentController>
147
               </Management>
148
               <SalesOrderLink
SalesOrderLink

Sales order reference

>{String}</SalesOrderLink>
149
          </SalesOrder>
150
          <RecurringInvoicing>
151
               <StartDate
StartDate

Start date of subscription or rental item

>{Date}</StartDate>
152
               <ExpectedEndDate
ExpectedEndDate

Expected end date of subscription or rental item

>{Date}</ExpectedEndDate>
153
               <PriceChangeAgreement
PriceChangeAgreement

Defines if and how the recurring price can be updated

Possible domain values can be found here

>{Integer}</PriceChangeAgreement>
154
               <RecurringPrice>
155
                    <RecurringPriceId
RecurringPriceId

Recurring price indentifier

>{Integer}</RecurringPriceId>
156
                    <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
157
                    <PriceInterval
PriceInterval

Interval of recurring price

Possible domain values can be found here

>{Integer}</PriceInterval>
158
                    <HasOneTimeFee
HasOneTimeFee

Boolean indicating if the recurring price has a one-time fee.

>{Boolean}</HasOneTimeFee>
159
                    <HasUsageStep
HasUsageStep

Boolean indicating if the recurring price has any usage steps.

>{Boolean}</HasUsageStep>
160
                    <RecurringPriceLink
RecurringPriceLink

Recurring price reference

>{String}</RecurringPriceLink>
161
               </RecurringPrice>
162
               <CurrentPriceStep>
163
                    <Price
Price

Value of a price step

>{Decimal}</Price>
164
               </CurrentPriceStep>
165
          </RecurringInvoicing>
166
          <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

>{String}</SalesOrderItemLink>
167
     </SalesOrderItem>
168
     <Paging
Paging

Detailed paging information for this list.

>
169
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
172
          <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>
173
          <FirstPage
FirstPage

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

>{String}</FirstPage>
174
          <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>
175
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
176
          <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>
177
          <NextPage
NextPage

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

>{String}</NextPage>
178
          <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>
179
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
181
     </Paging>
182
</SalesOrderItems>
1
{
2
     "salesOrderItems": [
3
          {
4
               "salesOrderItemId
SalesOrderItemId

Sales order item identifier

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

Item type

Possible domain values can be found here

": "{Integer}",
6
               "lineNumber
LineNumber

Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.

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

Status of the sales order item (0-9).

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
9
               "requestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

": "{Date}",
10
               "confirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed date of delivery. Date of which the customer can expect the arriving goods

": "{Date}",
11
               "isConfirmedDeliveryDateLocked
IsConfirmedDeliveryDateLocked

If confirmed delivery date in sales order item (COA) is locked, this date should not be re-calculated automatically.

": "{Boolean}",
12
               "scheduledShippingDate
ScheduledShippingDate

Date when the goods was/will be shipped from the warehouse.

": "{Date}",
13
               "customersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

": "{String}",
14
               "customersProductName
CustomersProductName

Customers internal name of the product. Retrieved from the product.

": "{String}",
15
               "requestedProductStructureRevision
RequestedProductStructureRevision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

": "{String}",
16
               "productDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

": "{String}",
17
               "grossMargin
GrossMargin

Gross margin of the item.

": "{Decimal}",
18
               "discountPercent
DiscountPercent

The discount in percent for this item.

": "{Decimal}",
19
               "quantity
Quantity

Number of units ordered

": "{Decimal}",
20
               "remainingQuantity
RemainingQuantity

Remaining number of units to be forwarded.

": "{Decimal}",
21
               "shippedQuantity
ShippedQuantity

Quantity forwarded to one or more shipping advices

": "{Decimal}",
22
               "isBlockedForProduction
IsBlockedForProduction

True if a new production is not to be started automatically based on this sales order item.

": "{Boolean}",
23
               "endCustomer
EndCustomer

End customer

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

": {
24
                    "customerId
CustomerId

Customer identifier

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

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

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

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

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

Secondary name of a company or firstname of a person

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

": "{String}",
27
                    "vATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

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

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

Customer reference

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

": "{String}"
29
               },
30
               "price": {
31
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
32
                    "discount
Discount

The discount for the item.

": "{Decimal}",
33
                    "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

": "{Decimal}",
34
                    "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

": "{Decimal}"
35
               },
36
               "priceConverted
PriceConverted

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

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

": "{String}",
38
                    "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

": "{Decimal}",
39
                    "netPrice
NetPrice

Final price per unit after deducting all discounts.

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

": "{Decimal}"
40
               },
41
               "totals": {
42
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
43
                    "grossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

": "{Decimal}",
44
                    "netAmount
NetAmount

Final item amount after deducting all discounts etc.

": "{Decimal}",
45
                    "remainingAmount
RemainingAmount

Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice

": "{Decimal}"
46
               },
47
               "totalsConverted
TotalsConverted

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

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

": "{String}",
49
                    "grossAmount
GrossAmount

Total gross amount in company currency.

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

": "{Decimal}",
50
                    "netAmount
NetAmount

Total net amount in company currency.

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

": "{Decimal}",
51
                    "remainingAmount
RemainingAmount

Total remaining amount in company currency.

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

": "{Decimal}"
52
               },
53
               "measurementUnit": {
54
                    "measurementUnitId
MeasurementUnitId

Measurement unit identifier

": "{Integer}",
55
                    "unit
Unit

Measurement unit (ex. mm, km, dl, kg)

": "{String}",
56
                    "measurementUnitLink
MeasurementUnitLink

Material unit reference

": "{String}"
57
               },
58
               "seller
Seller

Reference to the seller of the item

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

": {
59
                    "employeeId
EmployeeId

Employee identifier

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

": "{Integer}",
60
                    "firstName
FirstName

First name of employee

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

": "{String}",
61
                    "lastName
LastName

Last name of employee

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

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

Employee reference

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

": "{String}"
63
               },
64
               "product": {
65
                    "productId
ProductId

Product identifier

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

Name of the product

": "{String}",
67
                    "type
Type

Type of product

Possible domain values can be found here

": "{String}",
68
                    "manufacturer": {
69
                         "manufacturerId
ManufacturerId

Manufacturer identifier

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

Shortname/code of the manufacturer

": "{String}",
71
                         "manufacturerLink
ManufacturerLink

Manufacturer reference

": "{String}"
72
                    },
73
                    "latestProductRevision
LatestProductRevision

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

": {
74
                         "revision
Revision

Revision number

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

": "{String}"
75
                    },
76
                    "productLink
ProductLink

Product reference

": "{String}"
77
               },
78
               "productStructure": {
79
                    "productStructureId
ProductStructureId

Product structure reference

": "{Integer}",
80
                    "productStructureLink
ProductStructureLink

Product structure reference

": "{String}"
81
               },
82
               "landedCost": {
83
                    "grossPrice
GrossPrice

Total cost (landed cost or true cost) of getting each unit in stock, including purchase price, duties, charges, freight etc.

": "{Decimal}",
84
                    "purchaseExchangeRate
PurchaseExchangeRate

Exchange rate between document currency and purchase currency. Used in landed cost calculations.

": "{Decimal}"
85
               },
86
               "landedCostConverted
LandedCostConverted

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

": {
87
                    "grossPrice
GrossPrice

Total cost (landed cost or true cost) in sales currency

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

": "{Decimal}"
88
               },
89
               "accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

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

": {
90
                    "generalLedgerAccount
GeneralLedgerAccount

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

": {
91
                         "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

": "{Integer}",
92
                         "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

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

": "{String}"
93
                    },
94
                    "department
Department

The department related to the item. One of the system/fixed account dimensions.

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

": {
95
                         "departmentId
DepartmentId

Department identifier

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

": "{Integer}",
96
                         "departmentLink
DepartmentLink

Finance department reference

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

": "{String}"
97
                    },
98
                    "financeProject
FinanceProject

The finance project related to the item. One of the system/fixed account dimensions.

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

": {
99
                         "financeProjectId
FinanceProjectId

Finance project identifier

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

": "{Integer}",
100
                         "financeProjectLink
FinanceProjectLink

Finance project reference

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

": "{String}"
101
                    }
102
               },
103
               "highlightedNotification
HighlightedNotification

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

": {
104
                    "notificationId
NotificationId

Notification identifier

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

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

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

Date and time of creation

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

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

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

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

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

": {
110
                         "notificationTypeId
NotificationTypeId

Notification type identifier

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

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

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

Notification type reference

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

": "{String}"
113
                    },
114
                    "notificationLink
NotificationLink

Notification reference

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

": "{String}"
115
               },
116
               "salesForecast": {
117
                    "salesForecastId
SalesForecastId

Sales forecast identifier

": "{Integer}",
118
                    "salesForecastLink
SalesForecastLink

Sales forecast reference

": "{String}"
119
               },
120
               "salesOrder": {
121
                    "salesOrderId
SalesOrderId

Sales order identifier

": "{Integer}",
122
                    "customersReference
CustomersReference

Customers reference. Typically a person.

": "{String}",
123
                    "customer": {
124
                         "customerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

": "{String}",
127
                         "customerLink
CustomerLink

Customer reference

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

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

": {
131
                              "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

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

": {
137
                              "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

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

": {
143
                              "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
147
                         }
148
                    },
149
                    "salesOrderLink
SalesOrderLink

Sales order reference

": "{String}"
150
               },
151
               "recurringInvoicing": {
152
                    "startDate
StartDate

Start date of subscription or rental item

": "{Date}",
153
                    "expectedEndDate
ExpectedEndDate

Expected end date of subscription or rental item

": "{Date}",
154
                    "priceChangeAgreement
PriceChangeAgreement

Defines if and how the recurring price can be updated

Possible domain values can be found here

": "{Integer}",
155
                    "recurringPrice": {
156
                         "recurringPriceId
RecurringPriceId

Recurring price indentifier

": "{Integer}",
157
                         "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
158
                         "priceInterval
PriceInterval

Interval of recurring price

Possible domain values can be found here

": "{Integer}",
159
                         "hasOneTimeFee
HasOneTimeFee

Boolean indicating if the recurring price has a one-time fee.

": "{Boolean}",
160
                         "hasUsageStep
HasUsageStep

Boolean indicating if the recurring price has any usage steps.

": "{Boolean}",
161
                         "recurringPriceLink
RecurringPriceLink

Recurring price reference

": "{String}"
162
                    },
163
                    "currentPriceStep": {
164
                         "price
Price

Value of a price step

": "{Decimal}"
165
                    }
166
               },
167
               "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

": "{String}"
168
          }
169
     ],
170
     "paging
Paging

Detailed paging information for this list.

": {
171
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
174
          "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}",
175
          "firstPage
FirstPage

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

": "{String}",
176
          "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}",
177
          "previousPage
PreviousPage

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

": "{String}",
178
          "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}",
179
          "nextPage
NextPage

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

": "{String}",
180
          "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}",
181
          "lastPage
LastPage

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

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

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

": "{Integer}"
183
     }
184
}

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 100147 HTTP 404 Notification type not found
Error 105969 HTTP 400 Start date is required
Error 105970 HTTP 400 End date is required