API

Procurement APIs

GET procurement/returns/{supplierReturnId}/items/{itemId}

Details about a specific item of an supplier return

HTTP method GET
URI https://api.rambase.net/procurement/returns/{supplierReturnId}/items/{itemId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {supplierReturnId} Supplier return identifier
Integer, minimum 100000
- URI parameter {itemId} Supplier return item identifier
Integer, minimum 1
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 2014, version 32

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
<SupplierReturnItem>
2
     <SupplierReturnItemId
SupplierReturnItemId

Supplier return item identifier

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

Status of the supplier return 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
     <ProductStructureRevision
ProductStructureRevision

The revision of the product structure

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

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

>{String}</Note>
10
     <VATPercent
VATPercent

Value added tax percent

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

Quantity of the supplier return item

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

Remaining number of units to be forwarded

>{Decimal}</RemainingQuantity>
13
     <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>
14
     <Price>
15
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
16
          <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
17
     </Price>
18
     <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

>
19
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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>
20
          <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>
21
     </PriceConverted>
22
     <Totals>
23
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

Final item amount after deducting all discounts etc.

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

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

>{Decimal}</RemainingAmount>
26
     </Totals>
27
     <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

>
28
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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>
29
          <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>
30
          <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>
31
     </TotalsConverted>
32
     <MeasurementUnit>
33
          <MeasurementUnitId
MeasurementUnitId

Material unit reference

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

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

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

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

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

Material unit reference

>{String}</MeasurementUnitLink>
37
     </MeasurementUnit>
38
     <Product>
39
          <ProductId
ProductId

Product identifier

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

Name of the product

>{String}</Name>
41
          <Description
Description

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

>{String}</Description>
42
          <Type
Type

Type of product

Possible domain values can be found here

>{String}</Type>
43
          <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>
44
          <CustomField1
CustomField1

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

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

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

>{String}</CustomField2>
46
          <Dimensions>
47
               <Weight
Weight

The weight of the product in kilograms.

>{Decimal}</Weight>
48
          </Dimensions>
49
          <ProductClassification>
50
               <ProductClassificationId
ProductClassificationId

Product classification identifier

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

Product classification reference

>{String}</ProductClassificationLink>
52
          </ProductClassification>
53
          <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
54
     </Product>
55
     <Manufacturer>
56
          <ManufacturerId
ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>
57
          <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>
58
          <ShortName
ShortName

Shortname/code of the manufacturer

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

Manufacturer reference

>{String}</ManufacturerLink>
60
     </Manufacturer>
61
     <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

>
62
          <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>
63
          <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>
64
          <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>
65
     </ManufacturersProduct>
66
     <ProductUnit
ProductUnit

This is the reference to the product unit where the part change, which is the reason for the supplier return, took place.

>
67
          <ProductUnitId
ProductUnitId

Product unit identifier

>{Integer}</ProductUnitId>
68
          <ProductUnitLink
ProductUnitLink

Product unit reference

>{String}</ProductUnitLink>
69
     </ProductUnit>
70
     <Accounting
Accounting

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

>
71
          <VATCodeDefinition>
72
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

>{String}</VATCode>
73
               <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>
74
          </VATCodeDefinition>
75
          <GeneralLedgerAccount>
76
               <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

General ledger account reference

>{String}</GeneralLedgerAccountLink>
78
          </GeneralLedgerAccount>
79
          <Department
Department

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

>
80
               <DepartmentId
DepartmentId

Department identifier

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

Finance department reference

>{String}</DepartmentLink>
82
          </Department>
83
          <FinanceProject
FinanceProject

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

>
84
               <FinanceProjectId
FinanceProjectId

Finance project identifier

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

Finance project reference

>{String}</FinanceProjectLink>
86
          </FinanceProject>
87
          <Asset
Asset

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

>
88
               <AssetId
AssetId

Asset identifier

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

Asset reference

>{String}</AssetLink>
90
          </Asset>
91
     </Accounting>
92
     <PickOperation>
93
          <PickOperationId
PickOperationId

Pick operation identifier

>{Integer}</PickOperationId>
94
          <PickOperationLink
PickOperationLink

Pick operation reference

>{String}</PickOperationLink>
95
     </PickOperation>
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
     <StockAccruals
StockAccruals

Inventory balance provisions linked to the object. Are a part of product balance and will be loaded to general ledger.

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

>
112
          <StockAccrual
StockAccrual

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

>
113
               <StockAccrualId
StockAccrualId

Stock accrual identifier

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

>{Integer}</StockAccrualId>
114
               <Status
Status

Status of stock accrual

Possible domain values can be found here

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

>{Integer}</Status>
115
               <StockAccrualLink
StockAccrualLink

Stock accrual reference

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

>{String}</StockAccrualLink>
116
          </StockAccrual>
117
     </StockAccruals>
118
     <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

>
119
          <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>
120
          <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>
121
          <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>
122
          <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>
123
          <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>
124
          <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

>
125
               <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>
126
               <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>
127
               <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>
128
          </NotificationType>
129
          <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>
130
     </HighlightedNotification>
131
</SupplierReturnItem>
1
{
2
     "supplierReturnItem": {
3
          "supplierReturnItemId
SupplierReturnItemId

Supplier return item identifier

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

Status of the supplier return 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
          "productStructureRevision
ProductStructureRevision

The revision of the product structure

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

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

": "{String}",
11
          "vATPercent
VATPercent

Value added tax percent

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

Quantity of the supplier return item

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

Remaining number of units to be forwarded

": "{Decimal}",
14
          "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}",
15
          "price": {
16
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
17
               "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

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

": {
20
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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}",
21
               "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}"
22
          },
23
          "totals": {
24
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

Final item amount after deducting all discounts etc.

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

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

": "{Decimal}"
27
          },
28
          "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

": {
29
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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}",
30
               "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}",
31
               "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}"
32
          },
33
          "measurementUnit": {
34
               "measurementUnitId
MeasurementUnitId

Material unit reference

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

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

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

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

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

Material unit reference

": "{String}"
38
          },
39
          "product": {
40
               "productId
ProductId

Product identifier

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

Name of the product

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

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

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

Type of product

Possible domain values can be found here

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

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

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

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

": "{String}",
47
               "dimensions": {
48
                    "weight
Weight

The weight of the product in kilograms.

": "{Decimal}"
49
               },
50
               "productClassification": {
51
                    "productClassificationId
ProductClassificationId

Product classification identifier

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

Product classification reference

": "{String}"
53
               },
54
               "productLink
ProductLink

Product reference

": "{String}"
55
          },
56
          "manufacturer": {
57
               "manufacturerId
ManufacturerId

Manufacturer identifier

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

Shortname/code of the manufacturer

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

Manufacturer reference

": "{String}"
61
          },
62
          "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

": {
63
               "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}",
64
               "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}",
65
               "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}"
66
          },
67
          "productUnit
ProductUnit

This is the reference to the product unit where the part change, which is the reason for the supplier return, took place.

": {
68
               "productUnitId
ProductUnitId

Product unit identifier

": "{Integer}",
69
               "productUnitLink
ProductUnitLink

Product unit reference

": "{String}"
70
          },
71
          "accounting
Accounting

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

": {
72
               "vATCodeDefinition": {
73
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

": "{String}",
74
                    "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}"
75
               },
76
               "generalLedgerAccount": {
77
                    "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

General ledger account reference

": "{String}"
79
               },
80
               "department
Department

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

": {
81
                    "departmentId
DepartmentId

Department identifier

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

Finance department reference

": "{String}"
83
               },
84
               "financeProject
FinanceProject

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

": {
85
                    "financeProjectId
FinanceProjectId

Finance project identifier

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

Finance project reference

": "{String}"
87
               },
88
               "asset
Asset

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

": {
89
                    "assetId
AssetId

Asset identifier

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

Asset reference

": "{String}"
91
               }
92
          },
93
          "pickOperation": {
94
               "pickOperationId
PickOperationId

Pick operation identifier

": "{Integer}",
95
               "pickOperationLink
PickOperationLink

Pick operation reference

": "{String}"
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
          "stockAccruals
StockAccruals

Inventory balance provisions linked to the object. Are a part of product balance and will be loaded to general ledger.

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

": [
113
               {
114
                    "stockAccrualId
StockAccrualId

Stock accrual identifier

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

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

Status of stock accrual

Possible domain values can be found here

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

": "{Integer}",
116
                    "stockAccrualLink
StockAccrualLink

Stock accrual reference

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

": "{String}"
117
               }
118
          ],
119
          "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

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

": {
126
                    "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}",
127
                    "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}",
128
                    "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}"
129
               },
130
               "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}"
131
          }
132
     }
133
}

Possible error codes the response might return:

Error 100027 HTTP 400 Missing mandatory parameter {0}
Error 101420 HTTP 404 Setting definition not found