API

Procurement APIs

GET procurement/quotes/{purchaseQuoteId}/items/{itemId}

Details about a specific item of an purchase quote

HTTP method GET
URI https://api.rambase.net/procurement/quotes/{purchaseQuoteId}/items/{itemId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {purchaseQuoteId} Purchase quote identifier
Integer, minimum 100000
- URI parameter {itemId} Purchase quote item identifier
Integer, minimum 1
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 2332, 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
<PurchaseQuoteItem>
2
     <PurchaseQuoteItemId
PurchaseQuoteItemId

Purchase quote item identifier

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

Status of purchase quote item

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

Suppliers/sellers item reference number. Typically to an external system.

>{String}</SuppliersReferenceNumber>
7
     <SuppliersProductName
SuppliersProductName

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

>{String}</SuppliersProductName>
8
     <EquivalentProductName
EquivalentProductName

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

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

The product structure revison the supplier can offer

>{String}</ProductStructureRevision>
10
     <ProductDescription
ProductDescription

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

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

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

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

Quantity of the purchase quote

>{Decimal}</Quantity>
13
     <HeatNumber
HeatNumber

A heat number is an identification coupon number that is stamped on a material plate after it is removed from the ladle and rolled at a steel mill.

>{String}</HeatNumber>
14
     <RemainingQuantity
RemainingQuantity

Remaining number of units to be forwarded

>{Decimal}</RemainingQuantity>
15
     <AvailableQuantity
AvailableQuantity

Quantity available/free for use. Not assigned to anything.

>{Decimal}</AvailableQuantity>
16
     <LeadTime
LeadTime

The lead time, in number of days, from ordering to delivery.

>{Integer}</LeadTime>
17
     <Resale>
18
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
19
          <MinimumNetPrice
MinimumNetPrice

The minimum net price to use in sales order. Lower than 5% of this price will need approval before registering the sales order.

>{Decimal}</MinimumNetPrice>
20
          <ExclusivelyFor
ExclusivelyFor

Exclusevly for either customer, customer group or company

>
21
               <Database
Database

Database of the object

>{String}</Database>
22
               <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
23
               <Name
Name

Name retrieved from the object

>{String}</Name>
24
               <ObjectType
ObjectType

Type of object

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

API reference to the object

>{String}</ObjectLink>
26
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
27
          </ExclusivelyFor>
28
     </Resale>
29
     <Agreement
Agreement

If the quote is accepted by the supplier, an agreement is made. The status of the quote item will then be set to 4.

>
30
          <ExpirationDate
ExpirationDate

The agreement will have an expiration date. Note that this date might be different from the validity expiration date of the purchase quote.

>{Date}</ExpirationDate>
31
     </Agreement>
32
     <Price>
33
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
34
          <TargetPrice
TargetPrice

The target price from the purchase quote request item this purchase quote item was forwarded from

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

>{Decimal}</TargetPrice>
35
          <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
36
          <Freight
Freight

Estimated freight for including expected freight cost in the gross margin calculation in sales orders, sales invoices etc.

>{Decimal}</Freight>
37
          <FreightPercent
FreightPercent

Estimated freight in percent of net price. Used for including expected freight cost in the gross margin calculation in sales orders, sales invoices etc.

>{Decimal}</FreightPercent>
38
     </Price>
39
     <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

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

>{String}</Currency>
41
          <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>
42
     </PriceConverted>
43
     <Totals>
44
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
45
          <NetAmount
NetAmount

Final item amount after deducting all discounts etc.

>{Decimal}</NetAmount>
46
     </Totals>
47
     <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

>
48
          <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
49
          <NetAmount
NetAmount

Total net amount in company currency.

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

>{Decimal}</NetAmount>
50
     </TotalsConverted>
51
     <MeasurementUnit>
52
          <MeasurementUnitId
MeasurementUnitId

Material unit reference

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

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

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

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

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

Material unit reference

>{String}</MeasurementUnitLink>
56
     </MeasurementUnit>
57
     <Product>
58
          <ProductId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

>{String}</Type>
61
          <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>
62
          <CustomField1
CustomField1

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

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

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

>{String}</CustomField2>
64
          <Dimensions>
65
               <Weight
Weight

The weight of the product in kilograms.

>{Decimal}</Weight>
66
          </Dimensions>
67
          <ProductClassification>
68
               <ProductClassificationId
ProductClassificationId

Product classification identifier

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

Product classification reference

>{String}</ProductClassificationLink>
70
          </ProductClassification>
71
          <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
72
     </Product>
73
     <Manufacturer>
74
          <ManufacturerId
ManufacturerId

Manufacturer identifier

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

Company name of the manufacturer.

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

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

Shortname/code of the manufacturer

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

Manufacturer reference

>{String}</ManufacturerLink>
78
     </Manufacturer>
79
     <ManufacturersProduct
ManufacturersProduct

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

>
80
          <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

>{Integer}</ManufacturersProductId>
81
          <Name
Name

Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).

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

>{String}</Name>
82
          <ManufacturersProductLink
ManufacturersProductLink

Manufacturers product reference

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

>{String}</ManufacturersProductLink>
83
     </ManufacturersProduct>
84
     <ForwardedFrom
ForwardedFrom

The preceding/previous/source item.

>
85
          <ForwardedFromItem>
86
               <ItemId
ItemId

Identifier of the object

>{Integer}</ItemId>
87
               <Object>
88
                    <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

>{String}</ObjectLink>
91
               </Object>
92
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

>{String}</ItemLink>
94
          </ForwardedFromItem>
95
     </ForwardedFrom>
96
     <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

>
97
          <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>
98
          <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

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

>
100
                    <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>
101
                    <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

>
102
                         <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>
103
                         <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>
104
                         <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>
105
                    </Object>
106
                    <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>
107
                    <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>
108
               </Item>
109
          </ForwardedToItems>
110
     </ForwardedTo>
111
     <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

>
112
          <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>
113
          <Status
Status

Status of the notification

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>
114
          <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>
115
          <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>
116
          <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>
117
          <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

>
118
               <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>
119
               <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>
120
               <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>
121
          </NotificationType>
122
          <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>
123
     </HighlightedNotification>
124
</PurchaseQuoteItem>
1
{
2
     "purchaseQuoteItem": {
3
          "purchaseQuoteItemId
PurchaseQuoteItemId

Purchase quote item identifier

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

Status of purchase quote item

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
          "suppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers item reference number. Typically to an external system.

": "{String}",
8
          "suppliersProductName
SuppliersProductName

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

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

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

": "{String}",
10
          "productStructureRevision
ProductStructureRevision

The product structure revison the supplier can offer

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

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

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

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

": "{String}",
13
          "quantity
Quantity

Quantity of the purchase quote

": "{Decimal}",
14
          "heatNumber
HeatNumber

A heat number is an identification coupon number that is stamped on a material plate after it is removed from the ladle and rolled at a steel mill.

": "{String}",
15
          "remainingQuantity
RemainingQuantity

Remaining number of units to be forwarded

": "{Decimal}",
16
          "availableQuantity
AvailableQuantity

Quantity available/free for use. Not assigned to anything.

": "{Decimal}",
17
          "leadTime
LeadTime

The lead time, in number of days, from ordering to delivery.

": "{Integer}",
18
          "resale": {
19
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
20
               "minimumNetPrice
MinimumNetPrice

The minimum net price to use in sales order. Lower than 5% of this price will need approval before registering the sales order.

": "{Decimal}",
21
               "exclusivelyFor
ExclusivelyFor

Exclusevly for either customer, customer group or company

": {
22
                    "database
Database

Database of the object

": "{String}",
23
                    "objectId
ObjectId

Identifier of the object

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

Name retrieved from the object

": "{String}",
25
                    "objectType
ObjectType

Type of object

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

API reference to the object

": "{String}",
27
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"
28
               }
29
          },
30
          "agreement
Agreement

If the quote is accepted by the supplier, an agreement is made. The status of the quote item will then be set to 4.

": {
31
               "expirationDate
ExpirationDate

The agreement will have an expiration date. Note that this date might be different from the validity expiration date of the purchase quote.

": "{Date}"
32
          },
33
          "price": {
34
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
35
               "targetPrice
TargetPrice

The target price from the purchase quote request item this purchase quote item was forwarded from

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

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

Final price per unit after deducting all discounts etc.

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

Estimated freight for including expected freight cost in the gross margin calculation in sales orders, sales invoices etc.

": "{Decimal}",
38
               "freightPercent
FreightPercent

Estimated freight in percent of net price. Used for including expected freight cost in the gross margin calculation in sales orders, sales invoices etc.

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

": {
41
               "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}",
42
               "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}"
43
          },
44
          "totals": {
45
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
46
               "netAmount
NetAmount

Final item amount after deducting all discounts etc.

": "{Decimal}"
47
          },
48
          "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

": {
49
               "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}",
50
               "netAmount
NetAmount

Total net amount in company currency.

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

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

Material unit reference

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

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

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

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

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

Material unit reference

": "{String}"
57
          },
58
          "product": {
59
               "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

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

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

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

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

": "{String}",
65
               "dimensions": {
66
                    "weight
Weight

The weight of the product in kilograms.

": "{Decimal}"
67
               },
68
               "productClassification": {
69
                    "productClassificationId
ProductClassificationId

Product classification identifier

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

Product classification reference

": "{String}"
71
               },
72
               "productLink
ProductLink

Product reference

": "{String}"
73
          },
74
          "manufacturer": {
75
               "manufacturerId
ManufacturerId

Manufacturer identifier

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

Company name of the manufacturer.

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

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

Shortname/code of the manufacturer

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

Manufacturer reference

": "{String}"
79
          },
80
          "manufacturersProduct
ManufacturersProduct

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

": {
81
               "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

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

Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).

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

": "{String}",
83
               "manufacturersProductLink
ManufacturersProductLink

Manufacturers product reference

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

": "{String}"
84
          },
85
          "forwardedFrom
ForwardedFrom

The preceding/previous/source item.

": {
86
               "forwardedFromItem": {
87
                    "itemId
ItemId

Identifier of the object

": "{Integer}",
88
                    "object": {
89
                         "objectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

": "{String}"
92
                    },
93
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

": "{String}"
95
               }
96
          },
97
          "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

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

": [
100
                    {
101
                         "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}",
102
                         "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

": {
103
                              "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}",
104
                              "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}",
105
                              "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}"
106
                         },
107
                         "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}",
108
                         "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}"
109
                    }
110
               ]
111
          },
112
          "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

": {
113
               "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}",
114
               "status
Status

Status of the notification

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}",
115
               "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}",
116
               "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}",
117
               "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}",
118
               "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

": {
119
                    "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}",
120
                    "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}",
121
                    "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}"
122
               },
123
               "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}"
124
          }
125
     }
126
}

Possible error codes the response might return:

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