API

Logistics APIs

GET logistics/goods-reception-items

List of all goods reception items

HTTP method GET
URI https://api.rambase.net/logistics/goods-reception-items
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 159, version 73

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

Format:
1
1

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

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

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

ApprovalNotification() Named filter Goods reception items with approval notifications
ApprovalRequired() Named filter Goods reception items that require approval
HasStockQuantity() Named filter Have more that 0 available in stock quantity
Imported() Named filter Imported goods receptions (status 0)
MyItems() Named filter Goods reception items the current user is assigned to
PendingCustoms() Named filter Goods reception items pending customs documents (status 5)
PendingInvoice() Named filter Goods reception items pending supplier invoice (status 3)
PendingLabelPrint() Named filter Goods reception items pending label print (status 1)
PendingRegistration() Named filter Goods reception items pending registration to stock (status 2)
Processed() Named filter Processed goods reception items (status 9)
Assignee Integer The user who has been assigned to work with this object. Available macros: currentUser()
AvailableQuantity Decimal Quantity available/free for use. Not assigned to anything.
BestBeforeDate Date Goods received in this goods reception item is best before this date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ContainingNotificationMessage String Show all transaction documents containing notifications. Note that search will be for messages in company language, and not in user language.
ContainingNotificationTypeId Integer Notification type identifier.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Currency String Three character code following the ISO 4217 standard.
DepartmentId Integer Department identifier.
ExclusivelyForCustomerId Integer Identifier of the object.
FinanceProjectId Integer Finance project identifier.
FreightPercent Decimal Freight in percent of net price. Used for including freight cost in the gross margin calculation in sales orders, sales invoices etc..
GoodsReceptionId Integer Goods reception identifier.
GoodsReceptionItemId Integer Item-/line-number of the goods reception.
HeatNumber String 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.
LineNumber Integer Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
LocationShortName String Unique abbreviation/short name of the location.
ManufacturerId Integer Manufacturer identifier.
ManufacturerShortName String Shortname/code of the manufacturer.
MaterialQuality String Quality of the material. Only used for information.
NetAmount Decimal Final item amount after deducting all discounts etc.
NetPrice Decimal Final price per unit after deducting all discounts etc.
Note String Additional information regarding the item (free text). Might be visible to customers/suppliers.
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductId Integer Product identifier.
ProductionLot String The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch.
ProductName String Name of the product.
ProductType String Type of product.
Quantity Decimal Quantity of the supplier return item.
RemainingQuantity Decimal Remaining number of units to be forwarded.
ReservedQuantity Decimal Quantity reserved from beeing assigned to other objects. Ex. quantity reserved to be used as spare parts, reserved for exhibitions and similar. The reserved quantity cannot be assigned to anything until the reservedquantity is released..
Status Integer Status code of the the goods reception item.
StockQuantity Decimal Remaining quantity in stock of the goods reception item. This quantity will decrease when shipped to customer or supplier, or when consumed in a completed production.
SupplierFirstName String Firstname/givenname if the supplier is a person.
SupplierId Integer RamBase supplier identifier.
SupplierName String Name of supplier (name of company or surname/familyname/lastname of a person).
SuppliersProductName String Suppliers internal name of the product. Retrieved from the product.
SuppliersReferenceNumber String Suppliers/sellers item reference number. Typically to an external system.
UpdatedAt Datetime Date and time of update. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()

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

Assignee Integer The user who has been assigned to work with this object.
AvailableQuantity Decimal Quantity available/free for use. Not assigned to anything.
BestBeforeDate Date Goods received in this goods reception item is best before this date.
ContainingNotificationMessage String Show all transaction documents containing notifications. Note that search will be for messages in company language, and not in user language.
ContainingNotificationTypeId Integer Notification type identifier
CreatedAt Datetime Date and time of creation
Currency String Three character code following the ISO 4217 standard
DepartmentId Integer Department identifier
ExclusivelyForCustomerId Integer Identifier of the object
FinanceProjectId Integer Finance project identifier
FreightPercent Decimal Freight in percent of net price. Used for including freight cost in the gross margin calculation in sales orders, sales invoices etc.
GoodsReceptionId Integer Goods reception identifier
GoodsReceptionItemId Integer Item-/line-number of the goods reception
HeatNumber String 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.
LineNumber Integer Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
LocationShortName String Unique abbreviation/short name of the location
ManufacturerId Integer Manufacturer identifier
ManufacturerShortName String Shortname/code of the manufacturer
MaterialQuality String Quality of the material. Only used for information.
NetAmount Decimal Final item amount after deducting all discounts etc.
NetPrice Decimal Final price per unit after deducting all discounts etc.
Note String Additional information regarding the item (free text). Might be visible to customers/suppliers.
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductId Integer Product identifier
ProductionLot String The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch.
ProductName String Name of the product
ProductType String Type of product
Quantity Decimal Quantity of the supplier return item
RemainingQuantity Decimal Remaining number of units to be forwarded
ReservedQuantity Decimal Quantity reserved from beeing assigned to other objects. Ex. quantity reserved to be used as spare parts, reserved for exhibitions and similar. The reserved quantity cannot be assigned to anything until the reservedquantity is released.
Status Integer Status code of the the goods reception item
StockQuantity Decimal Remaining quantity in stock of the goods reception item. This quantity will decrease when shipped to customer or supplier, or when consumed in a completed production.
SupplierFirstName String Firstname/givenname if the supplier is a person
SupplierId Integer RamBase supplier identifier
SupplierName String Name of supplier (name of company or surname/familyname/lastname of a person)
SuppliersProductName String Suppliers internal name of the product. Retrieved from the product.
SuppliersReferenceNumber String Suppliers/sellers item reference number. Typically to an external system.
UpdatedAt Datetime Date and time of update

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
<GoodsReceptionItems>
2
     <GoodsReceptionItem>
3
          <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

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

Status code of the the goods reception item

Possible domain values can be found here

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

Date and time of creation

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

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

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

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

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

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

>{String}</SuppliersProductName>
9
          <HasCustomizedStructure
HasCustomizedStructure

True if products in goods reception item are customized product structures (and not standard product structure).

>{Boolean}</HasCustomizedStructure>
10
          <ProductStructureRevision
ProductStructureRevision

The requested revision of the product structure

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

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

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

Number of units received

>{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
          <AvailableQuantity
AvailableQuantity

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

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

Remaining quantity in stock of the goods reception item. This quantity will decrease when shipped to customer or supplier, or when consumed in a completed production.

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

Remaining number of units to be forwarded

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

Quantity reserved from beeing assigned to other objects. Ex. quantity reserved to be used as spare parts, reserved for exhibitions and similar. The reserved quantity cannot be assigned to anything until the reservedquantity is released.

>{Decimal}</ReservedQuantity>
18
          <ProductionLot
ProductionLot

The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch.

>{String}</ProductionLot>
19
          <ProductionDate
ProductionDate

Production date is the date when the product was manufactured. For purchased products this date is informed about from supplier. For goods that are manufactured inhouse, this date is a date for when the company manufactured these products.

>{Date}</ProductionDate>
20
          <BestBeforeDate
BestBeforeDate

Goods received in this goods reception item is best before this date.

>{Date}</BestBeforeDate>
21
          <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>
22
          <MaterialQuality>
23
               <QualityCode
QualityCode

Quality of the material. Only used for information.

>{String}</QualityCode>
24
          </MaterialQuality>
25
          <Price>
26
               <Currency
Currency

Three character code following the ISO 4217 standard

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

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

>{Decimal}</FreightPercent>
28
               <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
30
          </Price>
31
          <PriceConverted
PriceConverted

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

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

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

Represents the price per unit before any discounting is applied.

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

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

>{Decimal}</NetPrice>
35
          </PriceConverted>
36
          <Totals>
37
               <Currency
Currency

Three character code following the ISO 4217 standard

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

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

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

Final item amount after deducting all discounts etc.

>{Decimal}</NetAmount>
40
          </Totals>
41
          <TotalsConverted
TotalsConverted

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

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

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

Total gross amount in company currency.

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

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

Total net amount in company currency.

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

>{Decimal}</NetAmount>
45
          </TotalsConverted>
46
          <MeasurementUnit>
47
               <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

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

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

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

Material unit reference

>{String}</MeasurementUnitLink>
51
          </MeasurementUnit>
52
          <Product>
53
               <ProductId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Type of product

Possible domain values can be found here

>{String}</Type>
57
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
58
          </Product>
59
          <Manufacturer>
60
               <ManufacturerId
ManufacturerId

Manufacturer identifier

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

Shortname/code of the manufacturer

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

Manufacturer reference

>{String}</ManufacturerLink>
63
          </Manufacturer>
64
          <ManufacturersProduct
ManufacturersProduct

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

>
65
               <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

>{Integer}</ManufacturersProductId>
66
               <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=GoodsReceptionItem.ManufacturersProduct in your request URI to get this field

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

Manufacturers product reference

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

>{String}</ManufacturersProductLink>
68
          </ManufacturersProduct>
69
          <ProductStructure>
70
               <ProductStructureId
ProductStructureId

Product structure reference

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

Product structure reference

>{String}</ProductStructureLink>
72
          </ProductStructure>
73
          <GoodsReception>
74
               <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

>{Integer}</GoodsReceptionId>
75
               <Type
Type

Type of goods reception

Possible domain values can be found here

>{String}</Type>
76
               <SubType
SubType

Subtype of goods reception

Possible domain values can be found here

>{String}</SubType>
77
               <Supplier>
78
                    <SupplierId
SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>
79
                    <Name
Name

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

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

Firstname/givenname if the supplier is a person

>{String}</FirstName>
81
                    <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
82
               </Supplier>
83
               <Location>
84
                    <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
85
                    <Name
Name

Name of location

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

Unique abbreviation/short name of the location

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

Location reference

>{String}</LocationLink>
88
               </Location>
89
               <GoodsReceptionLink
GoodsReceptionLink

Goods reception reference

>{String}</GoodsReceptionLink>
90
          </GoodsReception>
91
          <ExclusivelyFor
ExclusivelyFor

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

>
92
               <ObjectId
ObjectId

Identifier of the object

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

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

Type of object

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

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

Name of the customer/supplier, or last name if it is a person.

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

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

First name of the customer/supplier

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

>{String}</FirstName>
96
               <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=GoodsReceptionItem.ExclusivelyFor in your request URI to get this field

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

API reference to the object

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

>{String}</ObjectLink>
98
          </ExclusivelyFor>
99
          <Accounting
Accounting

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

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

>
100
               <GeneralLedgerAccount
GeneralLedgerAccount

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

>
101
                    <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

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

General ledger account reference

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

>{String}</GeneralLedgerAccountLink>
103
               </GeneralLedgerAccount>
104
               <Department
Department

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

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

>
105
                    <DepartmentId
DepartmentId

Department identifier

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

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

Finance department reference

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

>{String}</DepartmentLink>
107
               </Department>
108
               <FinanceProject
FinanceProject

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

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

>
109
                    <FinanceProjectId
FinanceProjectId

Finance project identifier

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

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

Finance project reference

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

>{String}</FinanceProjectLink>
111
               </FinanceProject>
112
          </Accounting>
113
          <ForwardedFrom
ForwardedFrom

The preceding/previous/source item.

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

>
114
               <ForwardedFromItem
ForwardedFromItem

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

>
115
                    <ItemId
ItemId

Identifier of the object

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

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

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

>
117
                         <ObjectId
ObjectId

Identifier of the object

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

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

Type of object

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

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

API reference to the object

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

>{String}</ObjectLink>
120
                    </Object>
121
                    <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=GoodsReceptionItem.ForwardedFrom in your request URI to get this field

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

API reference to the item

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

>{String}</ItemLink>
123
               </ForwardedFromItem>
124
          </ForwardedFrom>
125
          <HighlightedNotification
HighlightedNotification

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

>
126
               <NotificationId
NotificationId

Notification identifier

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

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

Status of the notification

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

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

Date and time of creation

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

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

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

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

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

>
132
                    <NotificationTypeId
NotificationTypeId

Notification type identifier

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

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

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

Notification type reference

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

>{String}</NotificationTypeLink>
135
               </NotificationType>
136
               <NotificationLink
NotificationLink

Notification reference

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

>{String}</NotificationLink>
137
          </HighlightedNotification>
138
          <GoodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

>{String}</GoodsReceptionItemLink>
139
     </GoodsReceptionItem>
140
     <Paging
Paging

Detailed paging information for this list.

>
141
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
144
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

>{String}</FirstPageKey>
145
          <FirstPage
FirstPage

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

>{String}</FirstPage>
146
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

>{String}</PreviousPageKey>
147
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
148
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

>{String}</NextPageKey>
149
          <NextPage
NextPage

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

>{String}</NextPage>
150
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

>{String}</LastPageKey>
151
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
153
     </Paging>
154
</GoodsReceptionItems>
1
{
2
     "goodsReceptionItems": [
3
          {
4
               "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

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

Status code of the the goods reception item

Possible domain values can be found here

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

Date and time of creation

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

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

": "{Integer}",
8
               "suppliersReferenceNumber
SuppliersReferenceNumber

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

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

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

": "{String}",
10
               "hasCustomizedStructure
HasCustomizedStructure

True if products in goods reception item are customized product structures (and not standard product structure).

": "{Boolean}",
11
               "productStructureRevision
ProductStructureRevision

The requested revision of the product structure

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

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

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

Number of units received

": "{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
               "availableQuantity
AvailableQuantity

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

": "{Decimal}",
16
               "stockQuantity
StockQuantity

Remaining quantity in stock of the goods reception item. This quantity will decrease when shipped to customer or supplier, or when consumed in a completed production.

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

Remaining number of units to be forwarded

": "{Decimal}",
18
               "reservedQuantity
ReservedQuantity

Quantity reserved from beeing assigned to other objects. Ex. quantity reserved to be used as spare parts, reserved for exhibitions and similar. The reserved quantity cannot be assigned to anything until the reservedquantity is released.

": "{Decimal}",
19
               "productionLot
ProductionLot

The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch.

": "{String}",
20
               "productionDate
ProductionDate

Production date is the date when the product was manufactured. For purchased products this date is informed about from supplier. For goods that are manufactured inhouse, this date is a date for when the company manufactured these products.

": "{Date}",
21
               "bestBeforeDate
BestBeforeDate

Goods received in this goods reception item is best before this date.

": "{Date}",
22
               "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}",
23
               "materialQuality": {
24
                    "qualityCode
QualityCode

Quality of the material. Only used for information.

": "{String}"
25
               },
26
               "price": {
27
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
28
                    "freightPercent
FreightPercent

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

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

Represents the price per unit before any discounting is applied.

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

Final price per unit after deducting all discounts etc.

": "{Decimal}"
31
               },
32
               "priceConverted
PriceConverted

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

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

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

Represents the price per unit before any discounting is applied.

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

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

": "{Decimal}"
36
               },
37
               "totals": {
38
                    "currency
Currency

Three character code following the ISO 4217 standard

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

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

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

Final item amount after deducting all discounts etc.

": "{Decimal}"
41
               },
42
               "totalsConverted
TotalsConverted

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

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

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

Total gross amount in company currency.

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

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

Total net amount in company currency.

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

": "{Decimal}"
46
               },
47
               "measurementUnit": {
48
                    "measurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

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

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

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

Material unit reference

": "{String}"
52
               },
53
               "product": {
54
                    "productId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Type of product

Possible domain values can be found here

": "{String}",
58
                    "productLink
ProductLink

Product reference

": "{String}"
59
               },
60
               "manufacturer": {
61
                    "manufacturerId
ManufacturerId

Manufacturer identifier

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

Shortname/code of the manufacturer

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

Manufacturer reference

": "{String}"
64
               },
65
               "manufacturersProduct
ManufacturersProduct

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

": {
66
                    "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

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

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

Manufacturers product reference

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

": "{String}"
69
               },
70
               "productStructure": {
71
                    "productStructureId
ProductStructureId

Product structure reference

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

Product structure reference

": "{String}"
73
               },
74
               "goodsReception": {
75
                    "goodsReceptionId
GoodsReceptionId

Goods reception identifier

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

Type of goods reception

Possible domain values can be found here

": "{String}",
77
                    "subType
SubType

Subtype of goods reception

Possible domain values can be found here

": "{String}",
78
                    "supplier": {
79
                         "supplierId
SupplierId

RamBase supplier identifier

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

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

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

Firstname/givenname if the supplier is a person

": "{String}",
82
                         "supplierLink
SupplierLink

Supplier reference

": "{String}"
83
                    },
84
                    "location": {
85
                         "locationId
LocationId

Location identifier

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

Name of location

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

Unique abbreviation/short name of the location

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

Location reference

": "{String}"
89
                    },
90
                    "goodsReceptionLink
GoodsReceptionLink

Goods reception reference

": "{String}"
91
               },
92
               "exclusivelyFor
ExclusivelyFor

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

": {
93
                    "objectId
ObjectId

Identifier of the object

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

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

Type of object

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

": "{String}",
95
                    "name
Name

Name of the customer/supplier, or last name if it is a person.

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

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

First name of the customer/supplier

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

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

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

API reference to the object

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

": "{String}"
99
               },
100
               "accounting
Accounting

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

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

": {
101
                    "generalLedgerAccount
GeneralLedgerAccount

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

": {
102
                         "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

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

General ledger account reference

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

": "{String}"
104
                    },
105
                    "department
Department

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

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

": {
106
                         "departmentId
DepartmentId

Department identifier

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

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

Finance department reference

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

": "{String}"
108
                    },
109
                    "financeProject
FinanceProject

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

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

": {
110
                         "financeProjectId
FinanceProjectId

Finance project identifier

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

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

Finance project reference

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

": "{String}"
112
                    }
113
               },
114
               "forwardedFrom
ForwardedFrom

The preceding/previous/source item.

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

": {
115
                    "forwardedFromItem
ForwardedFromItem

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

": {
116
                         "itemId
ItemId

Identifier of the object

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

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

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

": {
118
                              "objectId
ObjectId

Identifier of the object

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

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

Type of object

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

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

API reference to the object

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

": "{String}"
121
                         },
122
                         "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=GoodsReceptionItem.ForwardedFrom in your request URI to get this field

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

API reference to the item

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

": "{String}"
124
                    }
125
               },
126
               "highlightedNotification
HighlightedNotification

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

": {
127
                    "notificationId
NotificationId

Notification identifier

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

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

Status of the notification

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

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

Date and time of creation

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

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

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

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

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

": {
133
                         "notificationTypeId
NotificationTypeId

Notification type identifier

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

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

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

Notification type reference

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

": "{String}"
136
                    },
137
                    "notificationLink
NotificationLink

Notification reference

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

": "{String}"
138
               },
139
               "goodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

": "{String}"
140
          }
141
     ],
142
     "paging
Paging

Detailed paging information for this list.

": {
143
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
146
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

": "{String}",
147
          "firstPage
FirstPage

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

": "{String}",
148
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

": "{String}",
149
          "previousPage
PreviousPage

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

": "{String}",
150
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

": "{String}",
151
          "nextPage
NextPage

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

": "{String}",
152
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

": "{String}",
153
          "lastPage
LastPage

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

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

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

": "{Integer}"
155
     }
156
}

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

Possible error codes the response might return:

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