API

Sales APIs

GET sales/order-requests/{salesOrderRequestId}/items/{itemId}

Details about a specific item of an order request

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

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
<SalesOrderRequestItem>
2
     <SalesOrderRequestItemId
SalesOrderRequestItemId

Sales order request item identifier

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

Status of the sales order request identifier

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
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
     <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

>{Date}</RequestedDeliveryDate>
7
     <CustomersReferenceNumber
CustomersReferenceNumber

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

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

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

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

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

>{String}</EquivalentProductName>
10
     <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>
11
     <ProductDescription
ProductDescription

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

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

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

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

Gross margin of the item.

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

Value added tax percent

>{Decimal}</VATPercent>
15
     <Quantity
Quantity

The quantity requested

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

Remaining number of units to be forwarded.

>{Decimal}</RemainingQuantity>
17
     <IsBlockedForProduction
IsBlockedForProduction

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

>{Boolean}</IsBlockedForProduction>
18
     <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

>
19
          <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>
20
          <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>
21
          <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>
22
          <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>
23
          <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>
24
     </EndCustomer>
25
     <Price>
26
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
27
          <ExpectedPrice
ExpectedPrice

The expected price received from the customer. This price will be rejected or accepted by the seller

>{Decimal}</ExpectedPrice>
28
     </Price>
29
     <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

>
30
          <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>
31
          <ExpectedPrice
ExpectedPrice

Expected price in company currency

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}</ExpectedPrice>
32
     </PriceConverted>
33
     <Totals>
34
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
35
          <ExpectedAmount
ExpectedAmount

Represents the expected item amount

>{Decimal}</ExpectedAmount>
36
          <RemainingAmount
RemainingAmount

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

>{Decimal}</RemainingAmount>
37
     </Totals>
38
     <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

>
39
          <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>
40
          <ExpectedAmount
ExpectedAmount

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}</ExpectedAmount>
41
          <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>
42
     </TotalsConverted>
43
     <Seller
Seller

Reference to the seller of the item

>
44
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
45
          <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>
46
          <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>
47
          <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
48
     </Seller>
49
     <MeasurementUnit>
50
          <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

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

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

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

Material unit reference

>{String}</MeasurementUnitLink>
54
     </MeasurementUnit>
55
     <Product>
56
          <ProductId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

>{String}</Type>
59
          <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>
60
          <CustomField1
CustomField1

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

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

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

>{String}</CustomField2>
62
          <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>
63
          <Weight
Weight

The weight of the product in kilograms.

>{Decimal}</Weight>
64
          <Manufacturer>
65
               <ManufacturerId
ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>
66
               <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>
67
               <ShortName
ShortName

Shortname/code of the manufacturer

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

Manufacturer reference

>{String}</ManufacturerLink>
69
          </Manufacturer>
70
          <ProductClassification>
71
               <ProductClassificationId
ProductClassificationId

Product classification identifier

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

Product classification reference

>{String}</ProductClassificationLink>
73
          </ProductClassification>
74
          <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

>
75
               <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>
76
          </LatestProductRevision>
77
          <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
78
     </Product>
79
     <LandedCost>
80
          <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>
81
          <PurchasePrice
PurchasePrice

Purchase price for each unit

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

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

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

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

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

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

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

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

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

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

>{Decimal}</PurchaseExchangeRate>
87
          <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>
88
          <DerivedFrom>
89
               <PurchaseQuoteItemId
PurchaseQuoteItemId

Purchase quote item identifier

>{Integer}</PurchaseQuoteItemId>
90
               <PurchaseQuote>
91
                    <Database
Database

Database of the object

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

Purchase quote identifier

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

Purchase quote reference

>{String}</PurchaseQuoteLink>
94
               </PurchaseQuote>
95
               <PurchaseQuoteItemLink
PurchaseQuoteItemLink

Purchase quote item link

>{String}</PurchaseQuoteItemLink>
96
          </DerivedFrom>
97
     </LandedCost>
98
     <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

>
99
          <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>
100
          <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>
101
          <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>
102
          <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>
103
          <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>
104
          <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>
105
     </LandedCostConverted>
106
     <Accounting
Accounting

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

>
107
          <VATCodeDefinition>
108
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

>{String}</VATCode>
109
          </VATCodeDefinition>
110
     </Accounting>
111
     <ForwardedFrom
ForwardedFrom

The preceding/previous/source item.

>
112
          <Currency
Currency

Three character code following the ISO 4217 standard

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

The net amount forwarded to this item.

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

The quantity forwarded to this item.

>{Decimal}</ForwardedQuantity>
115
          <ForwardedFromItem>
116
               <ItemId
ItemId

Identifier of the object

>{Integer}</ItemId>
117
               <Object>
118
                    <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

>{String}</ObjectLink>
121
               </Object>
122
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

>{String}</ItemLink>
124
          </ForwardedFromItem>
125
     </ForwardedFrom>
126
     <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

>
127
          <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>
128
          <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

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

>
130
                    <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>
131
                    <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

>
132
                         <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>
133
                         <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>
134
                         <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>
135
                    </Object>
136
                    <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>
137
                    <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>
138
               </Item>
139
          </ForwardedToItems>
140
     </ForwardedTo>
141
     <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

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

>
148
               <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>
149
               <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>
150
               <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>
151
          </NotificationType>
152
          <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>
153
     </HighlightedNotification>
154
</SalesOrderRequestItem>
1
{
2
     "salesOrderRequestItem": {
3
          "salesOrderRequestItemId
SalesOrderRequestItemId

Sales order request item identifier

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

Status of the sales order request identifier

Possible domain values can be found here

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

Date and time of creation

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

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

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

The delivery date as requested by the customer.

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

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

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

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

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

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

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

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

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

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

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

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

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

Gross margin of the item.

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

Value added tax percent

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

The quantity requested

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

Remaining number of units to be forwarded.

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

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

": "{Boolean}",
19
          "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

": {
20
               "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}",
21
               "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}",
22
               "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}",
23
               "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}",
24
               "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}"
25
          },
26
          "price": {
27
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
28
               "expectedPrice
ExpectedPrice

The expected price received from the customer. This price will be rejected or accepted by the seller

": "{Decimal}"
29
          },
30
          "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

": {
31
               "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}",
32
               "expectedPrice
ExpectedPrice

Expected price in company currency

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}"
33
          },
34
          "totals": {
35
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
36
               "expectedAmount
ExpectedAmount

Represents the expected item amount

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

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

": "{Decimal}"
38
          },
39
          "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

": {
40
               "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}",
41
               "expectedAmount
ExpectedAmount

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}",
42
               "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}"
43
          },
44
          "seller
Seller

Reference to the seller of the item

": {
45
               "employeeId
EmployeeId

Employee identifier

": "{Integer}",
46
               "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}",
47
               "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}",
48
               "employeeLink
EmployeeLink

Employee reference

": "{String}"
49
          },
50
          "measurementUnit": {
51
               "measurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

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

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

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

Material unit reference

": "{String}"
55
          },
56
          "product": {
57
               "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

": "{String}",
60
               "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}",
61
               "customField1
CustomField1

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

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

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

": "{String}",
63
               "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}",
64
               "weight
Weight

The weight of the product in kilograms.

": "{Decimal}",
65
               "manufacturer": {
66
                    "manufacturerId
ManufacturerId

Manufacturer identifier

": "{Integer}",
67
                    "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}",
68
                    "shortName
ShortName

Shortname/code of the manufacturer

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

Manufacturer reference

": "{String}"
70
               },
71
               "productClassification": {
72
                    "productClassificationId
ProductClassificationId

Product classification identifier

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

Product classification reference

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

": {
76
                    "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}"
77
               },
78
               "productLink
ProductLink

Product reference

": "{String}"
79
          },
80
          "landedCost": {
81
               "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}",
82
               "purchasePrice
PurchasePrice

Purchase price for each unit

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

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

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

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

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

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

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

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

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

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

": "{Decimal}",
88
               "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}",
89
               "derivedFrom": {
90
                    "purchaseQuoteItemId
PurchaseQuoteItemId

Purchase quote item identifier

": "{Integer}",
91
                    "purchaseQuote": {
92
                         "database
Database

Database of the object

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

Purchase quote identifier

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

Purchase quote reference

": "{String}"
95
                    },
96
                    "purchaseQuoteItemLink
PurchaseQuoteItemLink

Purchase quote item link

": "{String}"
97
               }
98
          },
99
          "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

": {
100
               "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}",
101
               "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}",
102
               "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}",
103
               "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}",
104
               "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}",
105
               "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}"
106
          },
107
          "accounting
Accounting

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

": {
108
               "vATCodeDefinition": {
109
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

": "{String}"
110
               }
111
          },
112
          "forwardedFrom
ForwardedFrom

The preceding/previous/source item.

": {
113
               "currency
Currency

Three character code following the ISO 4217 standard

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

The net amount forwarded to this item.

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

The quantity forwarded to this item.

": "{Decimal}",
116
               "forwardedFromItem": {
117
                    "itemId
ItemId

Identifier of the object

": "{Integer}",
118
                    "object": {
119
                         "objectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

": "{String}"
122
                    },
123
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

": "{String}"
125
               }
126
          },
127
          "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

": {
128
               "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}",
129
               "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

": [
130
                    {
131
                         "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}",
132
                         "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

": {
133
                              "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}",
134
                              "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}",
135
                              "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}"
136
                         },
137
                         "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}",
138
                         "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}"
139
                    }
140
               ]
141
          },
142
          "highlightedNotification
HighlightedNotification

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

": {
143
               "notificationId
NotificationId

Notification identifier

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

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

Status of the notification

Possible domain values can be found here

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

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

Date and time of creation

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

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

The message from the notification definition, expanded with parameters.

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

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

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

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

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

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

": {
149
                    "notificationTypeId
NotificationTypeId

Notification type identifier

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

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

Category of notification type (warning, information etc)

Possible domain values can be found here

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

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

Notification type reference

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

": "{String}"
152
               },
153
               "notificationLink
NotificationLink

Notification reference

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

": "{String}"
154
          }
155
     }
156
}

Possible error codes the response might return:

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