API

Procurement APIs

GET procurement/order-items

List of all purchase order items

HTTP method GET
URI https://api.rambase.net/procurement/order-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 302, version 38

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 Purhcase order items with notifications of category A (approvals)
InfoNotification() Named filter Purchase order items with notifications of category I (Information)
MyItems() Named filter Purchase orders current user is assigned to
PendingRegistration() Named filter Purchase order items pending registration (status 1 or status 2)
PendingResponse() Named filter Purchase order items pending response from supplier (status 3)
Assignee Integer The user who has been assigned to work with this object. Available macros: currentUser()
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.
EquivalentProductName String Name of product with equivalent behavior and attributes. Can be used for same purpose..
ExclusivelyForCustomerId Integer Identifier of the object.
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.
LocationShortName String Unique abbreviation/short name of the location.
ManufacturerId Integer Manufacturer identifier.
ManufacturerShortName String Shortname/code of the manufacturer.
ManufacturersProductId Integer Manufacturer product identifier.
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.
ProductClassificationId String Product classification identifier.
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductType String Type of product.
PurchaseGroupId Integer Purchase group identifier.
PurchaseOrderId Integer Purchase order identifier.
PurchaseOrderItemId Integer Item-/line-number of the purchase order.
PurchaseResponsibleEmployeeId Integer Employee identifier. Available macros: currentUser()
Quantity Decimal Number of units purchased.
RegistrationDate Date Date of registration. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
RemainingQuantity Decimal Remaining number of units to be forwarded.
RequestedDeliveryDate Date The delivery date as requested by the buyer/purchaser. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ReservedQuantity Decimal Reserved Quantity on the SOA ITEM.
Status Integer Status code of the the purchase order item.
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.
Type String Type of document.

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.
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
EquivalentProductName String Name of product with equivalent behavior and attributes. Can be used for same purpose.
ExclusivelyForCustomerId Integer Identifier of the object
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.
LocationShortName String Unique abbreviation/short name of the location
ManufacturerId Integer Manufacturer identifier
ManufacturerShortName String Shortname/code of the manufacturer
ManufacturersProductId Integer Manufacturer product identifier
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.
ProductClassificationId String Product classification identifier
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductId Integer Product identifier
ProductName String Name of the product
ProductType String Type of product
PurchaseGroupId Integer Purchase group identifier
PurchaseOrderId Integer Purchase order identifier
PurchaseOrderItemId Integer Item-/line-number of the purchase order
PurchaseResponsibleEmployeeId Integer Employee identifier
Quantity Decimal Number of units purchased
RegistrationDate Date Date of registration
RemainingQuantity Decimal Remaining number of units to be forwarded
RequestedDeliveryDate Date The delivery date as requested by the buyer/purchaser
ReservedQuantity Decimal Reserved Quantity on the SOA ITEM
Status Integer Status code of the the purchase order item
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.
Type String Type of document

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
<PurchaseOrderItems>
2
     <PurchaseOrderItem>
3
          <PurchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

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

Status code of the the purchase order 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
          <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the buyer/purchaser

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

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

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

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

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

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

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

Number of units purchased

>{Decimal}</Quantity>
12
          <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>
13
          <RemainingQuantity
RemainingQuantity

Remaining number of units to be forwarded

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

Reserved Quantity on the SOA ITEM

>{Decimal}</ReservedQuantity>
15
          <Price>
16
               <Currency
Currency

Three character code following the ISO 4217 standard

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

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
18
          </Price>
19
          <Totals>
20
               <Currency
Currency

Three character code following the ISO 4217 standard

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

Final item amount after deducting all discounts etc.

>{Decimal}</NetAmount>
22
          </Totals>
23
          <PurchaseResponsible
PurchaseResponsible

User responsible for the procurement transaction

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

>
24
               <EmployeeId
EmployeeId

Employee identifier

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

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

First name of employee

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

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

Last name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
28
          </PurchaseResponsible>
29
          <MeasurementUnit>
30
               <MeasurementUnitId
MeasurementUnitId

Material unit reference

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

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

>{String}</Unit>
32
               <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

>{String}</MeasurementUnitLink>
33
          </MeasurementUnit>
34
          <Product>
35
               <ProductId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

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

Product reference

>{String}</ProductLink>
39
          </Product>
40
          <RequestedProductRevision>
41
               <Revision
Revision

Revision number

>{String}</Revision>
42
          </RequestedProductRevision>
43
          <Manufacturer>
44
               <ManufacturerId
ManufacturerId

Manufacturer identifier

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

Shortname/code of the manufacturer

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

Manufacturer reference

>{String}</ManufacturerLink>
47
          </Manufacturer>
48
          <ManufacturersProduct
ManufacturersProduct

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

>
49
               <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

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

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

Manufacturers product reference

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

>{String}</ManufacturersProductLink>
52
          </ManufacturersProduct>
53
          <PurchaseOrder>
54
               <PurchaseOrderId
PurchaseOrderId

Purchase order identifier

>{Integer}</PurchaseOrderId>
55
               <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
56
               <Type
Type

Type of purchase order

Possible domain values can be found here

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

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

>
58
                    <LocationId
LocationId

Location identifier

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

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

Name of location

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

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

Unique abbreviation/short name of the location

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

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

Location reference

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

>{String}</LocationLink>
62
               </Location>
63
               <Supplier>
64
                    <SupplierId
SupplierId

RamBase supplier identifier

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

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

>{String}</Name>
66
                    <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
67
               </Supplier>
68
               <ExclusivelyFor
ExclusivelyFor

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

>
69
                    <ObjectId
ObjectId

Identifier of the object

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

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

Type of object

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

>{String}</ObjectType>
71
                    <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=PurchaseOrderItem.PurchaseOrder.ExclusivelyFor in your request URI to get this field

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

First name of the customer/supplier

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

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

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

API reference to the object

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

>{String}</ObjectLink>
75
               </ExclusivelyFor>
76
               <PurchaseOrderLink
PurchaseOrderLink

Purchase order reference

>{String}</PurchaseOrderLink>
77
          </PurchaseOrder>
78
          <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=PurchaseOrderItem.Accounting in your request URI to get this field

>
79
               <GeneralLedgerAccount
GeneralLedgerAccount

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

>
80
                    <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

>{Integer}</GeneralLedgerAccountId>
81
                    <AccountNumber
AccountNumber

The account number of the general ledger account

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

>{String}</AccountNumber>
82
                    <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

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

>{String}</GeneralLedgerAccountLink>
83
               </GeneralLedgerAccount>
84
               <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=PurchaseOrderItem.Accounting in your request URI to get this field

>
85
                    <DepartmentId
DepartmentId

Department identifier

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

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

Finance department reference

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

>{String}</DepartmentLink>
87
               </Department>
88
               <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=PurchaseOrderItem.Accounting in your request URI to get this field

>
89
                    <FinanceProjectId
FinanceProjectId

Finance project identifier

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

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

Finance project reference

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

>{String}</FinanceProjectLink>
91
               </FinanceProject>
92
          </Accounting>
93
          <HighlightedNotification
HighlightedNotification

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

>
94
               <NotificationId
NotificationId

Notification identifier

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

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

Status of the notification

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

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

Date and time of creation

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

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

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

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

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

>
100
                    <NotificationTypeId
NotificationTypeId

Notification type identifier

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

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

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

Notification type reference

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

>{String}</NotificationTypeLink>
103
               </NotificationType>
104
               <NotificationLink
NotificationLink

Notification reference

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

>{String}</NotificationLink>
105
          </HighlightedNotification>
106
          <PurchaseOrderItemLink
PurchaseOrderItemLink

Purchase order item reference

>{String}</PurchaseOrderItemLink>
107
     </PurchaseOrderItem>
108
     <Paging
Paging

Detailed paging information for this list.

>
109
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
112
          <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>
113
          <FirstPage
FirstPage

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

>{String}</FirstPage>
114
          <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>
115
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
116
          <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>
117
          <NextPage
NextPage

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

>{String}</NextPage>
118
          <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>
119
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
121
     </Paging>
122
</PurchaseOrderItems>
1
{
2
     "purchaseOrderItems": [
3
          {
4
               "purchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

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

Status code of the the purchase order 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
               "requestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the buyer/purchaser

": "{Date}",
9
               "suppliersReferenceNumber
SuppliersReferenceNumber

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

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

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

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

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

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

Number of units purchased

": "{Decimal}",
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}",
14
               "remainingQuantity
RemainingQuantity

Remaining number of units to be forwarded

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

Reserved Quantity on the SOA ITEM

": "{Decimal}",
16
               "price": {
17
                    "currency
Currency

Three character code following the ISO 4217 standard

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

Final price per unit after deducting all discounts etc.

": "{Decimal}"
19
               },
20
               "totals": {
21
                    "currency
Currency

Three character code following the ISO 4217 standard

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

Final item amount after deducting all discounts etc.

": "{Decimal}"
23
               },
24
               "purchaseResponsible
PurchaseResponsible

User responsible for the procurement transaction

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

": {
25
                    "employeeId
EmployeeId

Employee identifier

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

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

First name of employee

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

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

Last name of employee

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

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

Employee reference

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

": "{String}"
29
               },
30
               "measurementUnit": {
31
                    "measurementUnitId
MeasurementUnitId

Material unit reference

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

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

": "{String}",
33
                    "measurementUnitLink
MeasurementUnitLink

Material unit reference

": "{String}"
34
               },
35
               "product": {
36
                    "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

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

Product reference

": "{String}"
40
               },
41
               "requestedProductRevision": {
42
                    "revision
Revision

Revision number

": "{String}"
43
               },
44
               "manufacturer": {
45
                    "manufacturerId
ManufacturerId

Manufacturer identifier

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

Shortname/code of the manufacturer

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

Manufacturer reference

": "{String}"
48
               },
49
               "manufacturersProduct
ManufacturersProduct

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

": {
50
                    "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

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

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

Manufacturers product reference

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

": "{String}"
53
               },
54
               "purchaseOrder": {
55
                    "purchaseOrderId
PurchaseOrderId

Purchase order identifier

": "{Integer}",
56
                    "registrationDate
RegistrationDate

Date of registration

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

Type of purchase order

Possible domain values can be found here

": "{String}",
58
                    "location
Location

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

": {
59
                         "locationId
LocationId

Location identifier

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

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

Name of location

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

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

Unique abbreviation/short name of the location

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

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

Location reference

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

": "{String}"
63
                    },
64
                    "supplier": {
65
                         "supplierId
SupplierId

RamBase supplier identifier

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

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

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

Supplier reference

": "{String}"
68
                    },
69
                    "exclusivelyFor
ExclusivelyFor

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

": {
70
                         "objectId
ObjectId

Identifier of the object

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

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

Type of object

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

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

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

First name of the customer/supplier

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

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

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

API reference to the object

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

": "{String}"
76
                    },
77
                    "purchaseOrderLink
PurchaseOrderLink

Purchase order reference

": "{String}"
78
               },
79
               "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=PurchaseOrderItem.Accounting in your request URI to get this field

": {
80
                    "generalLedgerAccount
GeneralLedgerAccount

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

": {
81
                         "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

": "{Integer}",
82
                         "accountNumber
AccountNumber

The account number of the general ledger account

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

": "{String}",
83
                         "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

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

": "{String}"
84
                    },
85
                    "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=PurchaseOrderItem.Accounting in your request URI to get this field

": {
86
                         "departmentId
DepartmentId

Department identifier

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

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

Finance department reference

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

": "{String}"
88
                    },
89
                    "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=PurchaseOrderItem.Accounting in your request URI to get this field

": {
90
                         "financeProjectId
FinanceProjectId

Finance project identifier

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

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

Finance project reference

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

": "{String}"
92
                    }
93
               },
94
               "highlightedNotification
HighlightedNotification

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

": {
95
                    "notificationId
NotificationId

Notification identifier

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

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

Status of the notification

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

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

Date and time of creation

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

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

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

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

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

": {
101
                         "notificationTypeId
NotificationTypeId

Notification type identifier

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

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

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

Notification type reference

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

": "{String}"
104
                    },
105
                    "notificationLink
NotificationLink

Notification reference

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

": "{String}"
106
               },
107
               "purchaseOrderItemLink
PurchaseOrderItemLink

Purchase order item reference

": "{String}"
108
          }
109
     ],
110
     "paging
Paging

Detailed paging information for this list.

": {
111
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
114
          "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}",
115
          "firstPage
FirstPage

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

": "{String}",
116
          "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}",
117
          "previousPage
PreviousPage

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

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

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

": "{String}",
120
          "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}",
121
          "lastPage
LastPage

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

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

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

": "{Integer}"
123
     }
124
}

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