API

RamBase REST APIs

GET sales/orders/{salesOrderId}/items/{itemId}

Details about a specific item of an order

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

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

Format:
1
1

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

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

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

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

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

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

Format:
1
<SalesOrderItem>
2
     <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

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

Item type

Possible domain values can be found here

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

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

Possible domain values can be found here

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

Date and time of creation

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

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

>{Integer}</LineNumber>
7
     <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

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

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

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

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

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

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

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

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

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

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

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

Name of product with equivalent behavior and attributes. Can be used for same purpose.

>{String}</EquivalentProductName>
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
     <HasStockAssignmentsWithRevisionMismatch
HasStockAssignmentsWithRevisionMismatch

Is linked to a stock assignment (SAR) with a product structure revision that mismatches the requested product structure revision on the sales order item.

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

>{Boolean}</HasStockAssignmentsWithRevisionMismatch>
16
     <ProductDescription
ProductDescription

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

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

Additional information regarding the item (free text). Might be visible to customers/suppliers.

>{String}</Note>
18
     <GrossMargin
GrossMargin

Gross margin of the item.

>{Decimal}</GrossMargin>
19
     <VATPercent
VATPercent

Value added tax percent

>{Decimal}</VATPercent>
20
     <DiscountPercent
DiscountPercent

The discount in percent for this item.

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

Number of units ordered

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

Remaining number of units to be forwarded.

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

Quantity forwarded to one or more shipping advices

>{Decimal}</ShippedQuantity>
24
     <AllocatedStockQuantity
AllocatedStockQuantity

The quantity of this item which do have assignments from stock

>{Decimal}</AllocatedStockQuantity>
25
     <RequireSerialNumberBeforeShipping
RequireSerialNumberBeforeShipping

True if serial number is required before shipping. Note that if the product has set this value to true, this can not be overridden.

>{Boolean}</RequireSerialNumberBeforeShipping>
26
     <IsBlockedForProduction
IsBlockedForProduction

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

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

End customer

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

>
28
          <CustomerId
CustomerId

Customer identifier

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

>{Integer}</CustomerId>
29
          <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=EndCustomer in your request URI to get this field

>{String}</Name>
30
          <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=EndCustomer in your request URI to get this field

>{String}</FirstName>
31
          <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=EndCustomer in your request URI to get this field

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

Customer reference

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

>{String}</CustomerLink>
33
     </EndCustomer>
34
     <Warranty>
35
          <WarrantyExpirationDate
WarrantyExpirationDate

Date of warranty expiration.

>{Date}</WarrantyExpirationDate>
36
          <IsPaymentCoveredByWarranty
IsPaymentCoveredByWarranty

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.

>{Boolean}</IsPaymentCoveredByWarranty>
37
     </Warranty>
38
     <Price>
39
          <Currency
Currency

Three character code following the ISO 4217 standard

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

Represents the price per unit before any discounting is applied.

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

The discount for the item.

>{Decimal}</Discount>
42
          <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
43
          <ExpectedPrice
ExpectedPrice

The expected price from the sales order request item this sales order item was forwarded from.

>{Decimal}</ExpectedPrice>
44
     </Price>
45
     <PriceConverted
PriceConverted

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

>
46
          <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=PriceConverted in your request URI to get this field

>{String}</Currency>
47
          <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=PriceConverted in your request URI to get this field

>{Decimal}</GrossPrice>
48
          <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=PriceConverted in your request URI to get this field

>{Decimal}</NetPrice>
49
     </PriceConverted>
50
     <Totals>
51
          <Currency
Currency

Three character code following the ISO 4217 standard

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

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

>{Decimal}</GrossAmount>
53
          <DiscountAmount
DiscountAmount

The items discount amount.

>{Decimal}</DiscountAmount>
54
          <NetAmount
NetAmount

Final item amount after deducting all discounts etc.

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

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

>{Decimal}</RemainingAmount>
56
     </Totals>
57
     <TotalsConverted
TotalsConverted

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

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

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

Total gross amount in company currency.

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

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

Total net amount in company currency.

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

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

Total remaining amount in company currency.

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

>{Decimal}</RemainingAmount>
62
     </TotalsConverted>
63
     <Location>
64
          <LocationId
LocationId

Location identifier

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

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

Unique abbreviation/short name of the location

>{String}</ShortName>
66
          <LocationLink
LocationLink

Location reference

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

>{String}</LocationLink>
67
     </Location>
68
     <Seller
Seller

Reference to the seller of the item

>
69
          <EmployeeId
EmployeeId

Employee identifier

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

First name of employee

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

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

Last name of employee

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

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

Employee reference

>{String}</EmployeeLink>
73
     </Seller>
74
     <MeasurementUnit>
75
          <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

>{String}</Unit>
77
          <Precision
Precision

The precision/accuracy of the measurement (number of decimals)

>{Integer}</Precision>
78
          <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

>{String}</MeasurementUnitLink>
79
     </MeasurementUnit>
80
     <Product>
81
          <ProductId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

>{String}</Type>
84
          <CountryOfOriginCode
CountryOfOriginCode

Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.

>{String}</CountryOfOriginCode>
85
          <CustomField1
CustomField1

Custom field for grouping, sorting, categorizing and other purposes.

>{String}</CustomField1>
86
          <CustomField2
CustomField2

Custom field for grouping, sorting, categorizing and other purposes.

>{String}</CustomField2>
87
          <StandardLeadTime
StandardLeadTime

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.

>{Integer}</StandardLeadTime>
88
          <Weight
Weight

The weight of the product in kilograms.

>{Decimal}</Weight>
89
          <Manufacturer>
90
               <ManufacturerId
ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>
91
               <Name
Name

Company name of the manufacturer.

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

>{String}</Name>
92
               <ShortName
ShortName

Shortname/code of the manufacturer

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

Manufacturer reference

>{String}</ManufacturerLink>
94
          </Manufacturer>
95
          <ProductClassification>
96
               <ProductClassificationId
ProductClassificationId

Product classification identifier

>{String}</ProductClassificationId>
97
               <ProductClassificationLink
ProductClassificationLink

Product classification reference

>{String}</ProductClassificationLink>
98
          </ProductClassification>
99
          <Stock>
100
               <IsNonStock
IsNonStock

True if this is a non-physical product which are no using assignments from the assignment archive

>{Boolean}</IsNonStock>
101
          </Stock>
102
          <LatestProductRevision
LatestProductRevision

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

>
103
               <Revision
Revision

Revision number

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

>{String}</Revision>
104
          </LatestProductRevision>
105
          <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
106
     </Product>
107
     <ProductStructure>
108
          <ProductStructureId
ProductStructureId

Product structure reference

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

Product structure reference

>{String}</ProductStructureLink>
110
     </ProductStructure>
111
     <LandedCost>
112
          <PurchaseCurrency
PurchaseCurrency

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.

Possible domain values can be found here

>{String}</PurchaseCurrency>
113
          <PurchasePrice
PurchasePrice

Purchase price for each unit

>{Decimal}</PurchasePrice>
114
          <Freight
Freight

Estimated freight cost of getting each unit in stock. Used for calculating landed cost.

>{Decimal}</Freight>
115
          <Duty
Duty

Duty cost of getting each unit in stock. Used for calculating landed cost.

>{Decimal}</Duty>
116
          <Charge
Charge

Other costs of getting each unit in stock. Used for calculating landed cost.

>{Decimal}</Charge>
117
          <GrossPrice
GrossPrice

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

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

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

>{Decimal}</PurchaseExchangeRate>
119
          <IsDerivedFromUserInput
IsDerivedFromUserInput

True if landed cost is derived from manual user input. Landed cost can only be manually updated for products without assignments

>{Boolean}</IsDerivedFromUserInput>
120
          <IsDerivedFromPreferredPurchasePrice
IsDerivedFromPreferredPurchasePrice

True if the landed cost for this item is derived from preferred purchase price. This means that parts (or all) of the item has not reserved goods in stock, nor incoming goods (supplier backlog or production backlog).

>{Boolean}</IsDerivedFromPreferredPurchasePrice>
121
          <IsDerivedFromAssignedSupplierBacklog
IsDerivedFromAssignedSupplierBacklog

True if landed cost for this item is derived from assigned supplier backlog. This means that the item has reserved incoming goods (supplier backlog or production backlog).

>{Boolean}</IsDerivedFromAssignedSupplierBacklog>
122
          <IsDerivedFromAssignedStock
IsDerivedFromAssignedStock

True if landed cost for this item is derived from assigned stock. This means that the item has reserved goods in stock.

>{Boolean}</IsDerivedFromAssignedStock>
123
          <DerivedFrom>
124
               <PurchaseQuoteItemId
PurchaseQuoteItemId

Purchase quote item identifier

>{Integer}</PurchaseQuoteItemId>
125
               <PurchaseQuote>
126
                    <Database
Database

Database of the object

>{String}</Database>
127
                    <PurchaseQuoteId
PurchaseQuoteId

Purchase quote identifier

>{Integer}</PurchaseQuoteId>
128
                    <PurchaseQuoteLink
PurchaseQuoteLink

Purchase quote reference

>{String}</PurchaseQuoteLink>
129
               </PurchaseQuote>
130
               <PurchaseQuoteItemLink
PurchaseQuoteItemLink

Purchase quote item link

>{String}</PurchaseQuoteItemLink>
131
          </DerivedFrom>
132
     </LandedCost>
133
     <LandedCostConverted
LandedCostConverted

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

>
134
          <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=LandedCostConverted in your request URI to get this field

>{String}</Currency>
135
          <PurchasePrice
PurchasePrice

Purchase price in sales currency.

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

>{Decimal}</PurchasePrice>
136
          <Freight
Freight

Freigth cost in sales currency.

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

>{Decimal}</Freight>
137
          <Duty
Duty

Duty costs in sales currency.

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

>{Decimal}</Duty>
138
          <Charge
Charge

Other cost in sales currency

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

>{Decimal}</Charge>
139
          <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=LandedCostConverted in your request URI to get this field

>{Decimal}</GrossPrice>
140
     </LandedCostConverted>
141
     <Accounting
Accounting

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

>
142
          <VATCodeDefinition>
143
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

>{String}</VATCode>
144
               <Description
Description

Description of VAT Code definition

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

>{String}</Description>
145
          </VATCodeDefinition>
146
          <GeneralLedgerAccount>
147
               <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

General ledger account reference

>{String}</GeneralLedgerAccountLink>
149
          </GeneralLedgerAccount>
150
          <Department
Department

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

>
151
               <DepartmentId
DepartmentId

Department identifier

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

Finance department reference

>{String}</DepartmentLink>
153
          </Department>
154
          <FinanceProject
FinanceProject

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

>
155
               <FinanceProjectId
FinanceProjectId

Finance project identifier

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

Finance project reference

>{String}</FinanceProjectLink>
157
          </FinanceProject>
158
          <Asset
Asset

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

>
159
               <AssetId
AssetId

Asset identifier

>{Integer}</AssetId>
160
               <AssetLink
AssetLink

Asset reference

>{String}</AssetLink>
161
          </Asset>
162
     </Accounting>
163
     <InitialSalesOrderItem
InitialSalesOrderItem

Reference to the initial/first/original sales order item in the document flow for this item.

>
164
          <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

>{Integer}</SalesOrderItemId>
165
          <SalesOrder>
166
               <SalesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

>{String}</SalesOrderLink>
168
          </SalesOrder>
169
          <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

>{String}</SalesOrderItemLink>
170
     </InitialSalesOrderItem>
171
     <ForwardedFrom
ForwardedFrom

The preceding/previous/source item.

>
172
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
173
          <ForwardedNetAmount
ForwardedNetAmount

The net amount forwarded to this item.

>{Decimal}</ForwardedNetAmount>
174
          <ForwardedQuantity
ForwardedQuantity

The quantity forwarded to this item.

>{Decimal}</ForwardedQuantity>
175
          <CausedBy
CausedBy

States who has requested the change of the sales order.

Possible domain values can be found here

>{String}</CausedBy>
176
          <ChangeReason
ChangeReason

States the reason why the sales order item was forwarded

Possible domain values can be found here

>{String}</ChangeReason>
177
          <ForwardedFromItem>
178
               <ItemId
ItemId

Identifier of the object

>{Integer}</ItemId>
179
               <Object>
180
                    <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
181
                    <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
182
                    <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
183
               </Object>
184
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
185
               <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
186
          </ForwardedFromItem>
187
     </ForwardedFrom>
188
     <ForwardedTo
ForwardedTo

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

>
189
          <OpenForwardedQuantity
OpenForwardedQuantity

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.

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

>{Decimal}</OpenForwardedQuantity>
190
          <ForwardedToItems
ForwardedToItems

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

>
191
               <Item
Item

Item this item was forwarded to.

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

>
192
                    <ItemId
ItemId

Identifier of the object

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

>{Integer}</ItemId>
193
                    <Object
Object

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

>
194
                         <ObjectId
ObjectId

Identifier of the object

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

>{Integer}</ObjectId>
195
                         <ObjectType
ObjectType

Type of object

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

>{String}</ObjectType>
196
                         <ObjectLink
ObjectLink

API reference to the object

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

>{String}</ObjectLink>
197
                    </Object>
198
                    <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

>{String}</RamBaseKey>
199
                    <ItemLink
ItemLink

API reference to the item

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

>{String}</ItemLink>
200
               </Item>
201
          </ForwardedToItems>
202
     </ForwardedTo>
203
     <HighlightedNotification
HighlightedNotification

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

>
204
          <NotificationId
NotificationId

Notification identifier

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

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

Status of the notification

Possible domain values can be found here

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

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

Date and time of creation

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

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

The message from the notification definition, expanded with parameters.

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

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

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

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

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

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

>
210
               <NotificationTypeId
NotificationTypeId

Notification type identifier

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

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

Category of notification type (warning, information etc)

Possible domain values can be found here

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

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

Notification type reference

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

>{String}</NotificationTypeLink>
213
          </NotificationType>
214
          <NotificationLink
NotificationLink

Notification reference

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

>{String}</NotificationLink>
215
     </HighlightedNotification>
216
     <Deviation>
217
          <DeviationId
DeviationId

Deviation identifier

>{Integer}</DeviationId>
218
          <DeviationType>
219
               <Database
Database

Database of the object

>{String}</Database>
220
               <DeviationTypeId
DeviationTypeId

Deviation definition identifier

>{Integer}</DeviationTypeId>
221
               <Category
Category

Type of deviation

Possible domain values can be found here

>{Integer}</Category>
222
               <GoodsHandling
GoodsHandling

Specifies how the goods should be handled

Possible domain values can be found here

>{Integer}</GoodsHandling>
223
               <AccountingHandling
AccountingHandling

Specifies how accounting should handle the deviation

Possible domain values can be found here

>{Integer}</AccountingHandling>
224
               <InterCompanyHandling
InterCompanyHandling

Specifies how the deviation should be handled in the inter company trading.

Possible domain values can be found here

>{Integer}</InterCompanyHandling>
225
               <LandedCostCalculation
LandedCostCalculation

Specifies how landed cost should be calculated.

Possible domain values can be found here

>{Integer}</LandedCostCalculation>
226
               <DeviationTypeLink
DeviationTypeLink

Deviation definition reference

>{String}</DeviationTypeLink>
227
          </DeviationType>
228
          <DeviationLink
DeviationLink

Deviation reference

>{String}</DeviationLink>
229
     </Deviation>
230
     <SalesForecast>
231
          <SalesForecastId
SalesForecastId

Sales forecast identifier

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

Sales forecast reference

>{String}</SalesForecastLink>
233
     </SalesForecast>
234
     <RecurringInvoicing
RecurringInvoicing

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

>
235
          <StartDate
StartDate

Start date of subscription or rental item

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

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

Expected end date of subscription or rental item

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

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

Defines if and how the recurring price can be updated

Possible domain values can be found here

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

>{Integer}</PriceChangeAgreement>
238
          <EstimatedAmount
EstimatedAmount

Estimated amount of rental or subscription item

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

>{Decimal}</EstimatedAmount>
239
          <RecurringPrice
RecurringPrice

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

>
240
               <RecurringPriceId
RecurringPriceId

Recurring price indentifier

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

>{Integer}</RecurringPriceId>
241
               <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=RecurringInvoicing in your request URI to get this field

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

Interval of recurring price

Possible domain values can be found here

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

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

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

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

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

Boolean indicating if the recurring price has any usage steps.

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

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

Recurring price reference

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

>{String}</RecurringPriceLink>
246
          </RecurringPrice>
247
          <CurrentPriceStep
CurrentPriceStep

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

>
248
               <Price
Price

Value of a price step

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

>{Decimal}</Price>
249
          </CurrentPriceStep>
250
     </RecurringInvoicing>
251
     <ProjectOrder
ProjectOrder

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

>
252
          <ProjectOrderId
ProjectOrderId

Project order identifier

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

>{Integer}</ProjectOrderId>
253
          <ProjectOrderLink
ProjectOrderLink

Project order reference

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

>{String}</ProjectOrderLink>
254
     </ProjectOrder>
255
     <ProjectOrderItem
ProjectOrderItem

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

>
256
          <ProjectOrderItemId
ProjectOrderItemId

Project order item identifier

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

>{Integer}</ProjectOrderItemId>
257
          <ProjectOrderItemLink
ProjectOrderItemLink

Reference to the project order item.

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

>{String}</ProjectOrderItemLink>
258
     </ProjectOrderItem>
259
     <IntercompanySalesOrderReference
IntercompanySalesOrderReference

If this sales order is created based on a purchase order from another company, these fields will be referencing the sales order which is assigned to the purchase order in the other company.

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

>
260
          <Field
Field

Field to get value from in the other company sales order

Possible domain values can be found here

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

>{String}</Field>
261
          <Value
Value

Value for the field from the sales order in the other company

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

>{String}</Value>
262
          <SalesOrderId
SalesOrderId

Sales order identifier

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

>{Integer}</SalesOrderId>
263
     </IntercompanySalesOrderReference>
264
</SalesOrderItem>
1
{
2
     "salesOrderItem": {
3
          "salesOrderItemId
SalesOrderItemId

Sales order item identifier

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

Item type

Possible domain values can be found here

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

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

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
7
          "lineNumber
LineNumber

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

": "{Integer}",
8
          "requestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

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

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

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

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

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

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

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

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

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

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

": "{String}",
14
          "equivalentProductName
EquivalentProductName

Name of product with equivalent behavior and attributes. Can be used for same purpose.

": "{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
          "hasStockAssignmentsWithRevisionMismatch
HasStockAssignmentsWithRevisionMismatch

Is linked to a stock assignment (SAR) with a product structure revision that mismatches the requested product structure revision on the sales order item.

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

": "{Boolean}",
17
          "productDescription
ProductDescription

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

": "{String}",
18
          "note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

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

Gross margin of the item.

": "{Decimal}",
20
          "vATPercent
VATPercent

Value added tax percent

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

The discount in percent for this item.

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

Number of units ordered

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

Remaining number of units to be forwarded.

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

Quantity forwarded to one or more shipping advices

": "{Decimal}",
25
          "allocatedStockQuantity
AllocatedStockQuantity

The quantity of this item which do have assignments from stock

": "{Decimal}",
26
          "requireSerialNumberBeforeShipping
RequireSerialNumberBeforeShipping

True if serial number is required before shipping. Note that if the product has set this value to true, this can not be overridden.

": "{Boolean}",
27
          "isBlockedForProduction
IsBlockedForProduction

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

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

End customer

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

": {
29
               "customerId
CustomerId

Customer identifier

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

": "{Integer}",
30
               "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=EndCustomer in your request URI to get this field

": "{String}",
31
               "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=EndCustomer in your request URI to get this field

": "{String}",
32
               "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=EndCustomer in your request URI to get this field

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

Customer reference

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

": "{String}"
34
          },
35
          "warranty": {
36
               "warrantyExpirationDate
WarrantyExpirationDate

Date of warranty expiration.

": "{Date}",
37
               "isPaymentCoveredByWarranty
IsPaymentCoveredByWarranty

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.

": "{Boolean}"
38
          },
39
          "price": {
40
               "currency
Currency

Three character code following the ISO 4217 standard

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

Represents the price per unit before any discounting is applied.

": "{Decimal}",
42
               "discount
Discount

The discount for the item.

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

Final price per unit after deducting all discounts etc.

": "{Decimal}",
44
               "expectedPrice
ExpectedPrice

The expected price from the sales order request item this sales order item was forwarded from.

": "{Decimal}"
45
          },
46
          "priceConverted
PriceConverted

This field is greyed out because it is an expandable field. You have to add $expand=PriceConverted 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=PriceConverted in your request URI to get this field

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

": "{Decimal}",
49
               "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=PriceConverted in your request URI to get this field

": "{Decimal}"
50
          },
51
          "totals": {
52
               "currency
Currency

Three character code following the ISO 4217 standard

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

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

": "{Decimal}",
54
               "discountAmount
DiscountAmount

The items discount amount.

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

Final item amount after deducting all discounts etc.

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

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

": "{Decimal}"
57
          },
58
          "totalsConverted
TotalsConverted

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

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

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

Total gross amount in company currency.

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

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

Total net amount in company currency.

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

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

Total remaining amount in company currency.

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

": "{Decimal}"
63
          },
64
          "location": {
65
               "locationId
LocationId

Location identifier

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

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

Unique abbreviation/short name of the location

": "{String}",
67
               "locationLink
LocationLink

Location reference

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

": "{String}"
68
          },
69
          "seller
Seller

Reference to the seller of the item

": {
70
               "employeeId
EmployeeId

Employee identifier

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

First name of employee

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

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

Last name of employee

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

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

Employee reference

": "{String}"
74
          },
75
          "measurementUnit": {
76
               "measurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

": "{String}",
78
               "precision
Precision

The precision/accuracy of the measurement (number of decimals)

": "{Integer}",
79
               "measurementUnitLink
MeasurementUnitLink

Material unit reference

": "{String}"
80
          },
81
          "product": {
82
               "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

": "{String}",
85
               "countryOfOriginCode
CountryOfOriginCode

Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.

": "{String}",
86
               "customField1
CustomField1

Custom field for grouping, sorting, categorizing and other purposes.

": "{String}",
87
               "customField2
CustomField2

Custom field for grouping, sorting, categorizing and other purposes.

": "{String}",
88
               "standardLeadTime
StandardLeadTime

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.

": "{Integer}",
89
               "weight
Weight

The weight of the product in kilograms.

": "{Decimal}",
90
               "manufacturer": {
91
                    "manufacturerId
ManufacturerId

Manufacturer identifier

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

Company name of the manufacturer.

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

": "{String}",
93
                    "shortName
ShortName

Shortname/code of the manufacturer

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

Manufacturer reference

": "{String}"
95
               },
96
               "productClassification": {
97
                    "productClassificationId
ProductClassificationId

Product classification identifier

": "{String}",
98
                    "productClassificationLink
ProductClassificationLink

Product classification reference

": "{String}"
99
               },
100
               "stock": {
101
                    "isNonStock
IsNonStock

True if this is a non-physical product which are no using assignments from the assignment archive

": "{Boolean}"
102
               },
103
               "latestProductRevision
LatestProductRevision

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

": {
104
                    "revision
Revision

Revision number

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

": "{String}"
105
               },
106
               "productLink
ProductLink

Product reference

": "{String}"
107
          },
108
          "productStructure": {
109
               "productStructureId
ProductStructureId

Product structure reference

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

Product structure reference

": "{String}"
111
          },
112
          "landedCost": {
113
               "purchaseCurrency
PurchaseCurrency

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.

Possible domain values can be found here

": "{String}",
114
               "purchasePrice
PurchasePrice

Purchase price for each unit

": "{Decimal}",
115
               "freight
Freight

Estimated freight cost of getting each unit in stock. Used for calculating landed cost.

": "{Decimal}",
116
               "duty
Duty

Duty cost of getting each unit in stock. Used for calculating landed cost.

": "{Decimal}",
117
               "charge
Charge

Other costs of getting each unit in stock. Used for calculating landed cost.

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

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

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

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

": "{Decimal}",
120
               "isDerivedFromUserInput
IsDerivedFromUserInput

True if landed cost is derived from manual user input. Landed cost can only be manually updated for products without assignments

": "{Boolean}",
121
               "isDerivedFromPreferredPurchasePrice
IsDerivedFromPreferredPurchasePrice

True if the landed cost for this item is derived from preferred purchase price. This means that parts (or all) of the item has not reserved goods in stock, nor incoming goods (supplier backlog or production backlog).

": "{Boolean}",
122
               "isDerivedFromAssignedSupplierBacklog
IsDerivedFromAssignedSupplierBacklog

True if landed cost for this item is derived from assigned supplier backlog. This means that the item has reserved incoming goods (supplier backlog or production backlog).

": "{Boolean}",
123
               "isDerivedFromAssignedStock
IsDerivedFromAssignedStock

True if landed cost for this item is derived from assigned stock. This means that the item has reserved goods in stock.

": "{Boolean}",
124
               "derivedFrom": {
125
                    "purchaseQuoteItemId
PurchaseQuoteItemId

Purchase quote item identifier

": "{Integer}",
126
                    "purchaseQuote": {
127
                         "database
Database

Database of the object

": "{String}",
128
                         "purchaseQuoteId
PurchaseQuoteId

Purchase quote identifier

": "{Integer}",
129
                         "purchaseQuoteLink
PurchaseQuoteLink

Purchase quote reference

": "{String}"
130
                    },
131
                    "purchaseQuoteItemLink
PurchaseQuoteItemLink

Purchase quote item link

": "{String}"
132
               }
133
          },
134
          "landedCostConverted
LandedCostConverted

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

": {
135
               "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=LandedCostConverted in your request URI to get this field

": "{String}",
136
               "purchasePrice
PurchasePrice

Purchase price in sales currency.

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

": "{Decimal}",
137
               "freight
Freight

Freigth cost in sales currency.

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

": "{Decimal}",
138
               "duty
Duty

Duty costs in sales currency.

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

": "{Decimal}",
139
               "charge
Charge

Other cost in sales currency

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

": "{Decimal}",
140
               "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=LandedCostConverted in your request URI to get this field

": "{Decimal}"
141
          },
142
          "accounting
Accounting

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

": {
143
               "vATCodeDefinition": {
144
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

": "{String}",
145
                    "description
Description

Description of VAT Code definition

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

": "{String}"
146
               },
147
               "generalLedgerAccount": {
148
                    "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

General ledger account reference

": "{String}"
150
               },
151
               "department
Department

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

": {
152
                    "departmentId
DepartmentId

Department identifier

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

Finance department reference

": "{String}"
154
               },
155
               "financeProject
FinanceProject

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

": {
156
                    "financeProjectId
FinanceProjectId

Finance project identifier

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

Finance project reference

": "{String}"
158
               },
159
               "asset
Asset

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

": {
160
                    "assetId
AssetId

Asset identifier

": "{Integer}",
161
                    "assetLink
AssetLink

Asset reference

": "{String}"
162
               }
163
          },
164
          "initialSalesOrderItem
InitialSalesOrderItem

Reference to the initial/first/original sales order item in the document flow for this item.

": {
165
               "salesOrderItemId
SalesOrderItemId

Sales order item identifier

": "{Integer}",
166
               "salesOrder": {
167
                    "salesOrderId
SalesOrderId

Sales order identifier

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

Sales order reference

": "{String}"
169
               },
170
               "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

": "{String}"
171
          },
172
          "forwardedFrom
ForwardedFrom

The preceding/previous/source item.

": {
173
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
174
               "forwardedNetAmount
ForwardedNetAmount

The net amount forwarded to this item.

": "{Decimal}",
175
               "forwardedQuantity
ForwardedQuantity

The quantity forwarded to this item.

": "{Decimal}",
176
               "causedBy
CausedBy

States who has requested the change of the sales order.

Possible domain values can be found here

": "{String}",
177
               "changeReason
ChangeReason

States the reason why the sales order item was forwarded

Possible domain values can be found here

": "{String}",
178
               "forwardedFromItem": {
179
                    "itemId
ItemId

Identifier of the object

": "{Integer}",
180
                    "object": {
181
                         "objectId
ObjectId

Identifier of the object

": "{Integer}",
182
                         "objectType
ObjectType

Type of object

": "{String}",
183
                         "objectLink
ObjectLink

API reference to the object

": "{String}"
184
                    },
185
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",
186
                    "itemLink
ItemLink

API reference to the item

": "{String}"
187
               }
188
          },
189
          "forwardedTo
ForwardedTo

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

": {
190
               "openForwardedQuantity
OpenForwardedQuantity

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.

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

": "{Decimal}",
191
               "forwardedToItems
ForwardedToItems

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

": [
192
                    {
193
                         "itemId
ItemId

Identifier of the object

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

": "{Integer}",
194
                         "object
Object

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

": {
195
                              "objectId
ObjectId

Identifier of the object

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

": "{Integer}",
196
                              "objectType
ObjectType

Type of object

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

": "{String}",
197
                              "objectLink
ObjectLink

API reference to the object

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

": "{String}"
198
                         },
199
                         "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

": "{String}",
200
                         "itemLink
ItemLink

API reference to the item

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

": "{String}"
201
                    }
202
               ]
203
          },
204
          "highlightedNotification
HighlightedNotification

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

": {
205
               "notificationId
NotificationId

Notification identifier

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

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

Status of the notification

Possible domain values can be found here

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

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

Date and time of creation

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

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

The message from the notification definition, expanded with parameters.

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

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

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

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

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

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

": {
211
                    "notificationTypeId
NotificationTypeId

Notification type identifier

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

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

Category of notification type (warning, information etc)

Possible domain values can be found here

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

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

Notification type reference

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

": "{String}"
214
               },
215
               "notificationLink
NotificationLink

Notification reference

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

": "{String}"
216
          },
217
          "deviation": {
218
               "deviationId
DeviationId

Deviation identifier

": "{Integer}",
219
               "deviationType": {
220
                    "database
Database

Database of the object

": "{String}",
221
                    "deviationTypeId
DeviationTypeId

Deviation definition identifier

": "{Integer}",
222
                    "category
Category

Type of deviation

Possible domain values can be found here

": "{Integer}",
223
                    "goodsHandling
GoodsHandling

Specifies how the goods should be handled

Possible domain values can be found here

": "{Integer}",
224
                    "accountingHandling
AccountingHandling

Specifies how accounting should handle the deviation

Possible domain values can be found here

": "{Integer}",
225
                    "interCompanyHandling
InterCompanyHandling

Specifies how the deviation should be handled in the inter company trading.

Possible domain values can be found here

": "{Integer}",
226
                    "landedCostCalculation
LandedCostCalculation

Specifies how landed cost should be calculated.

Possible domain values can be found here

": "{Integer}",
227
                    "deviationTypeLink
DeviationTypeLink

Deviation definition reference

": "{String}"
228
               },
229
               "deviationLink
DeviationLink

Deviation reference

": "{String}"
230
          },
231
          "salesForecast": {
232
               "salesForecastId
SalesForecastId

Sales forecast identifier

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

Sales forecast reference

": "{String}"
234
          },
235
          "recurringInvoicing
RecurringInvoicing

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

": {
236
               "startDate
StartDate

Start date of subscription or rental item

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

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

Expected end date of subscription or rental item

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

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

Defines if and how the recurring price can be updated

Possible domain values can be found here

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

": "{Integer}",
239
               "estimatedAmount
EstimatedAmount

Estimated amount of rental or subscription item

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

": "{Decimal}",
240
               "recurringPrice
RecurringPrice

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

": {
241
                    "recurringPriceId
RecurringPriceId

Recurring price indentifier

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

": "{Integer}",
242
                    "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=RecurringInvoicing in your request URI to get this field

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

Interval of recurring price

Possible domain values can be found here

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

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

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

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

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

Boolean indicating if the recurring price has any usage steps.

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

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

Recurring price reference

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

": "{String}"
247
               },
248
               "currentPriceStep
CurrentPriceStep

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

": {
249
                    "price
Price

Value of a price step

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

": "{Decimal}"
250
               }
251
          },
252
          "projectOrder
ProjectOrder

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

": {
253
               "projectOrderId
ProjectOrderId

Project order identifier

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

": "{Integer}",
254
               "projectOrderLink
ProjectOrderLink

Project order reference

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

": "{String}"
255
          },
256
          "projectOrderItem
ProjectOrderItem

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

": {
257
               "projectOrderItemId
ProjectOrderItemId

Project order item identifier

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

": "{Integer}",
258
               "projectOrderItemLink
ProjectOrderItemLink

Reference to the project order item.

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

": "{String}"
259
          },
260
          "intercompanySalesOrderReference
IntercompanySalesOrderReference

If this sales order is created based on a purchase order from another company, these fields will be referencing the sales order which is assigned to the purchase order in the other company.

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

": {
261
               "field
Field

Field to get value from in the other company sales order

Possible domain values can be found here

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

": "{String}",
262
               "value
Value

Value for the field from the sales order in the other company

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

": "{String}",
263
               "salesOrderId
SalesOrderId

Sales order identifier

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

": "{Integer}"
264
          }
265
     }
266
}

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

POST
Cancel Item
Cancel a single sales order item
AOP/100051
POST
Forward sales order item to new sales order
Forward sales order item to new sales order
AOP/100057
POST
Forward sales order item to existing sales order
Forward sales order item to existing sales order
AOP/100077
POST
Forward sales order item to new shipping advice
Forward sales order item to new shipping advice
AOP/100082
POST
Forward sales order item to existing shipping advice
Forward sales order item to existing shipping advice
AOP/100083
POST
Create sales order items for each product in the structure
Create sales order items for each article in the structure
AOP/100084
POST
Insert item
Insert a new item infront of the current one
AOP/100155
POST
Pick
AOP/100165
POST
Undo pick
AOP/100166
POST
Delete sales order item
Deletes and backward a sales order item
AOP/100245
POST
Create or copy product structure to sales order item
Create product structure for sales order item
AOP/100312
POST
Create order change request for sales order item
Creates a new sales order request
AOP/100341
POST
Initiate Pick
AOP/100374
POST
Undo Initiate Pick
AOP/100376
POST
Copy item to new sales order
Copy sales order item to new sales order
AOP/100393
POST
Copy item to existing sales order
Copy sales order item to existing sales order
AOP/100398
POST
Forward sales order item to new sales invoice
Forwards sales order item to new sales invoice
AOP/100568
POST
Forward sales order item to existing sales invoice
Forwards sales order item to existing sales invoice
AOP/100569
POST
Forward item to new or existing shipping advice item in status 0
Forward sales order item to shipping advice in status 0. This is used in the prepare for picking process. The items are grouped in the shipping advice based on the settings in the sales order.
AOP/100795
POST
Reconfirm linked production work orders
Reconfirmed linked production work orders when sales order item is reconfirmed
AOP/100801
POST
Reassign to other goodsreceptions
Reassign sales order item to specified goodsreception(s)
AOP/100869
POST
Create pre-production task from task template
Creates a new pre-production task from a task template
AOP/101455
POST
Recalulate price for sales order item
AOP/101503
POST
Backward item
If a sales quote item is not being used on the sales order item anymore, the item needs to be backwarded and the quanity in the sales quote item needs to be restored.
AOP/101515
POST
Use sales quote item
Used when a price in sales order item is based on a sales quote item. The quantity on the sales quote item is reduced by the quantity used in the sales order item. If the price on the sales order item was previously based on a different sales quote item, the quantity on that sales quote item will be restored.
AOP/101516
POST
Copy GL account, dimensions and VAT to all items
AOP/101602
POST
Calculate leadtime
Calculate leadtime
AOP/101692

Possible error codes the response might return:

Error 102120 HTTP 404 Delivery project not found
Error 100053 HTTP 403 You have only admittance to your own suppliers
Error 105970 HTTP 400 End date is required