API

Procurement APIs

GET procurement/backlog-items

List of all purchase order items and purchase order response items

HTTP method GET
URI https://api.rambase.net/procurement/backlog-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 3552, version 62

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.

BacklogItems() Named filter Items in backlog (status 3-5)
EarlyItems() Named filter Items with earliest consumption days larger than 0, which means that item is arriving earlier than neccessary.
IsNonStockProduct() Named filter Products that are non-phycial products and therefor are not assigned.
IsStockProduct() Named filter Products that are physical products and are using assignments.
LateItems() Named filter Items with latest cunsumption days less than 0, which means that item is arriving later than neccessary.
ProcessedItems() Named filter Processed items (status 9)
UnRegisteredItems() Named filter Items pending registration or sealing (status 1 or 2)
WithAvailableQty() Named filter Items with percent unassigned over 0%, which means that the items has available stock quantity
Assignee Integer The user who has been assigned to work with this object. Available macros: currentUser()
ConfirmedDeliveryDate Date Confirmed delivery 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.
ConvertedNetBalance Decimal Total remaining amount in company currency.
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.
DeliveryTerms String Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).
EarliestConsumptionDate Date The earliest date that these items can be used or consumed based upon the stock assignment with the earliest production date if it is linked to a production work order, or if it is linked to a sales order, the earliest requested date on the linked sales orders. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
EarliestConsumptionDays Integer The deviation between Earliest consumption date and Confirmed delivery date, or Requested delivery date if no delivery date is confirmed by the supplier.
EquivalentProductName String Name of product with equivalent behavior and attributes. Can be used for same purpose..
GrossAmount Decimal Represents the item amount before any discounts etc. is applied.
GrossAmountConverted Decimal Total gross amount in company currency.
GrossPrice Decimal Represents the price per unit before any discounting is applied.
GrossPriceConverted Decimal Represents the price per unit before any discounting is applied.
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.
InitialPurchaseOrderId Integer Purchase order identifier.
InitialPurchaseOrderItemId Integer Item-/line-number of the purchase order.
IsNonStock Boolean True if this is a non-physical product which are no using assignments from the assignment archive.
LatestConsumptionDays Integer The deviation between Latest consumption date and Confirmed delivery date, or Requested delivery date if no delivery date is confirmed by the supplier.
LineNumber Integer Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
Location String Unique abbreviation/short name of the location.
ManufacturerId Integer Manufacturer identifier.
ManufacturerShortName String Shortname/code of the manufacturer.
ManufacturersProductName String Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).
NetAmount Decimal Final item amount after deducting all discounts etc.
NetAmountConverted Decimal Total net amount in company currency.
NetPrice Decimal Final price per unit after deducting all discounts etc.
NetPriceConverted Decimal Final price per unit after deducting all discounts.
Note String Additional information regarding the item (free text). Might be visible to customers/suppliers.
ObjectId Integer Identifier of the object.
PercentUnassigned Decimal Remaining production available in percent.
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.
ProjectOrderId Integer Project order identifier.
ProjectOrderItemId Integer Project order item identifier.
PurchaseGroupId Integer Purchase group identifier.
PurchaseResponsibleEmployeeId Integer Employee identifier. Available macros: currentUser()
Quantity Decimal Quantity of the object.
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()
Status Integer Status of the item/object.
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.
Type String Type of document.
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.
ConfirmedDeliveryDate Date Confirmed delivery 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
ConvertedNetBalance Decimal Total remaining amount in company currency.
CreatedAt Datetime Date and time of creation
Currency String Three character code following the ISO 4217 standard
DeliveryTerms String Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).
EarliestConsumptionDate Date The earliest date that these items can be used or consumed based upon the stock assignment with the earliest production date if it is linked to a production work order, or if it is linked to a sales order, the earliest requested date on the linked sales orders.
EarliestConsumptionDays Integer The deviation between Earliest consumption date and Confirmed delivery date, or Requested delivery date if no delivery date is confirmed by the supplier.
EquivalentProductName String Name of product with equivalent behavior and attributes. Can be used for same purpose.
GrossAmount Decimal Represents the item amount before any discounts etc. is applied.
GrossAmountConverted Decimal Total gross amount in company currency.
GrossPrice Decimal Represents the price per unit before any discounting is applied.
GrossPriceConverted Decimal Represents the price per unit before any discounting is applied.
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.
InitialPurchaseOrderId Integer Purchase order identifier
InitialPurchaseOrderItemId Integer Item-/line-number of the purchase order
IsNonStock Boolean True if this is a non-physical product which are no using assignments from the assignment archive
LatestConsumptionDays Integer The deviation between Latest consumption date and Confirmed delivery date, or Requested delivery date if no delivery date is confirmed by the supplier.
LineNumber Integer Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
Location String Unique abbreviation/short name of the location
ManufacturerId Integer Manufacturer identifier
ManufacturerShortName String Shortname/code of the manufacturer
ManufacturersProductName String Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).
NetAmount Decimal Final item amount after deducting all discounts etc.
NetAmountConverted Decimal Total net amount in company currency.
NetPrice Decimal Final price per unit after deducting all discounts etc.
NetPriceConverted Decimal Final price per unit after deducting all discounts.
Note String Additional information regarding the item (free text). Might be visible to customers/suppliers.
ObjectId Integer Identifier of the object
PercentUnassigned Decimal Remaining production available in percent
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
ProjectOrderId Integer Project order identifier
ProjectOrderItemId Integer Project order item identifier
PurchaseGroupId Integer Purchase group identifier
PurchaseResponsibleEmployeeId Integer Employee identifier
Quantity Decimal Quantity of the object.
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
Status Integer Status of the item/object.
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.
Type String Type of document
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
<BacklogItems>
2
     <Item>
3
          <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
4
          <ItemType
ItemType

Type of item

>{String}</ItemType>
5
          <Status
Status

Status of the item/object.

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

Date and time of creation

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

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

>{Integer}</LineNumber>
8
          <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the buyer/purchaser

>{Date}</RequestedDeliveryDate>
9
          <ConfirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed delivery date

>{Date}</ConfirmedDeliveryDate>
10
          <SuppliersReferenceNumber
SuppliersReferenceNumber

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

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

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

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

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

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

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

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

Quantity of the object.

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

Remaining number of units to be forwarded

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

If all units of this product should have a serial number in stock, you should require serial number to be required at goods reception. This will ensure that serial number is specified before goods receptions with this product is registered.

>{Boolean}</RequireSerialNumberAtGoodsReception>
17
          <Assignments
Assignments

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

>
18
               <EarliestConsumptionDate
EarliestConsumptionDate

The earliest date that these items can be used or consumed based upon the stock assignment with the earliest production date if it is linked to a production work order, or if it is linked to a sales order, the earliest requested date on the linked sales orders.

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

>{Date}</EarliestConsumptionDate>
19
               <EarliestConsumptionDays
EarliestConsumptionDays

The deviation between Earliest consumption date and Confirmed delivery date, or Requested delivery date if no delivery date is confirmed by the supplier.

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

>{Integer}</EarliestConsumptionDays>
20
               <LatestConsumptionDate
LatestConsumptionDate

The earliest date that these items can be used or consumed based upon the stock assignment with the latest production date if it is linked to a production work order, or if it is linked to a sales order, the latest requested date on the linked sales orders.

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

>{Date}</LatestConsumptionDate>
21
               <LatestConsumptionDays
LatestConsumptionDays

The deviation between Latest consumption date and Confirmed delivery date, or Requested delivery date if no delivery date is confirmed by the supplier.

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

>{Integer}</LatestConsumptionDays>
22
               <PercentUnassigned
PercentUnassigned

Remaining production available in percent

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

>{Decimal}</PercentUnassigned>
23
          </Assignments>
24
          <PurchaseGroup>
25
               <PurchaseGroupId
PurchaseGroupId

Purchase group identifier

>{Integer}</PurchaseGroupId>
26
               <Name
Name

Name of purchase group

>{String}</Name>
27
               <PurchaseGroupLink
PurchaseGroupLink

Purchase group identifier

>{String}</PurchaseGroupLink>
28
          </PurchaseGroup>
29
          <Price>
30
               <Currency
Currency

Three character code following the ISO 4217 standard

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

Represents the price per unit before any discounting is applied.

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

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
33
          </Price>
34
          <PriceConverted
PriceConverted

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

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

>{String}</Currency>
36
               <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=Item.PriceConverted in your request URI to get this field

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

>{Decimal}</NetPrice>
38
          </PriceConverted>
39
          <Totals>
40
               <Currency
Currency

Three character code following the ISO 4217 standard

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

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

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

Final item amount after deducting all discounts etc.

>{Decimal}</NetAmount>
43
          </Totals>
44
          <TotalsConverted
TotalsConverted

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

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

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

Total gross amount in company currency.

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

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

Total net amount in company currency.

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

>{Decimal}</NetAmount>
48
          </TotalsConverted>
49
          <PurchaseResponsible
PurchaseResponsible

User responsible for the procurement transaction

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

>
50
               <EmployeeId
EmployeeId

Employee identifier

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

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

First name of employee

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

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

Last name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
54
          </PurchaseResponsible>
55
          <MeasurementUnit>
56
               <MeasurementUnitId
MeasurementUnitId

Material unit reference

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

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

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

Material unit reference

>{String}</MeasurementUnitLink>
59
          </MeasurementUnit>
60
          <Product>
61
               <ProductId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Type of product

Possible domain values can be found here

>{String}</Type>
65
               <Stock>
66
                    <IsNonStock
IsNonStock

True if this is a non-physical product which are no using assignments from the assignment archive

>{Boolean}</IsNonStock>
67
               </Stock>
68
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
69
          </Product>
70
          <Manufacturer>
71
               <ManufacturerId
ManufacturerId

Manufacturer identifier

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

Company name of the manufacturer.

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

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

Shortname/code of the manufacturer

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

Manufacturer reference

>{String}</ManufacturerLink>
75
          </Manufacturer>
76
          <ManufacturersProduct
ManufacturersProduct

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

>
77
               <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

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

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

Manufacturers product reference

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

>{String}</ManufacturersProductLink>
80
          </ManufacturersProduct>
81
          <Object>
82
               <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
84
               <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
85
               <DeliveryTerms
DeliveryTerms

Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).

Possible domain values can be found here

>{String}</DeliveryTerms>
86
               <Type
Type

Type of document

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

Subtype of document

>{String}</SubType>
88
               <Location
Location

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

>
89
                    <LocationId
LocationId

Location identifier

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

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

Name of location

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

>{String}</Name>
91
                    <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=Item.Object.Location in your request URI to get this field

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

Location reference

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

>{String}</LocationLink>
93
               </Location>
94
               <Supplier>
95
                    <SupplierId
SupplierId

RamBase supplier identifier

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

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

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

Firstname/givenname if the supplier is a person

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

Supplier reference

>{String}</SupplierLink>
99
               </Supplier>
100
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
101
          </Object>
102
          <InitialPurchaseOrderItem>
103
               <PurchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

>{Integer}</PurchaseOrderItemId>
104
               <PurchaseOrder>
105
                    <PurchaseOrderId
PurchaseOrderId

Purchase order identifier

>{Integer}</PurchaseOrderId>
106
                    <PurchaseOrderLink
PurchaseOrderLink

Purchase order reference

>{String}</PurchaseOrderLink>
107
                    <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
108
               </PurchaseOrder>
109
               <PurchaseOrderItemLink
PurchaseOrderItemLink

Purchase order item reference

>{String}</PurchaseOrderItemLink>
110
          </InitialPurchaseOrderItem>
111
          <HighlightedNotification
HighlightedNotification

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

>
112
               <NotificationId
NotificationId

Notification identifier

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

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

Status of the notification

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

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

Date and time of creation

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

>{Datetime}</CreatedAt>
115
               <Message
Message

The message from the notification definition, expanded with parameters.

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

>{String}</Message>
116
               <TranslatedMessage
TranslatedMessage

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

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

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

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

>
118
                    <NotificationTypeId
NotificationTypeId

Notification type identifier

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

>{String}</NotificationTypeId>
119
                    <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

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

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

Notification type reference

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

>{String}</NotificationTypeLink>
121
               </NotificationType>
122
               <NotificationLink
NotificationLink

Notification reference

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

>{String}</NotificationLink>
123
          </HighlightedNotification>
124
          <ProjectOrderItem
ProjectOrderItem

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

>
125
               <ProjectOrderItemId
ProjectOrderItemId

Project order item identifier

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

>{Integer}</ProjectOrderItemId>
126
               <ProjectOrder
ProjectOrder

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

>
127
                    <ProjectOrderId
ProjectOrderId

Project order identifier

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

>{Integer}</ProjectOrderId>
128
               </ProjectOrder>
129
               <ProjectOrderLink
ProjectOrderLink

Project order reference

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

>{String}</ProjectOrderLink>
130
          </ProjectOrderItem>
131
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
132
          <ObjectItemLink
ObjectItemLink

API reference to the item

>{String}</ObjectItemLink>
133
     </Item>
134
     <Paging
Paging

Detailed paging information for this list.

>
135
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
138
          <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>
139
          <FirstPage
FirstPage

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

>{String}</FirstPage>
140
          <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>
141
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
142
          <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>
143
          <NextPage
NextPage

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

>{String}</NextPage>
144
          <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>
145
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
147
     </Paging>
148
</BacklogItems>
1
{
2
     "backlogItems": [
3
          {
4
               "itemId
ItemId

Item-number of the object

": "{Integer}",
5
               "itemType
ItemType

Type of item

": "{String}",
6
               "status
Status

Status of the item/object.

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

Date and time of creation

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

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

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

The delivery date as requested by the buyer/purchaser

": "{Date}",
10
               "confirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed delivery date

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

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

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

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

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

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

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

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

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

Quantity of the object.

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

Remaining number of units to be forwarded

": "{Decimal}",
17
               "requireSerialNumberAtGoodsReception
RequireSerialNumberAtGoodsReception

If all units of this product should have a serial number in stock, you should require serial number to be required at goods reception. This will ensure that serial number is specified before goods receptions with this product is registered.

": "{Boolean}",
18
               "assignments
Assignments

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

": {
19
                    "earliestConsumptionDate
EarliestConsumptionDate

The earliest date that these items can be used or consumed based upon the stock assignment with the earliest production date if it is linked to a production work order, or if it is linked to a sales order, the earliest requested date on the linked sales orders.

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

": "{Date}",
20
                    "earliestConsumptionDays
EarliestConsumptionDays

The deviation between Earliest consumption date and Confirmed delivery date, or Requested delivery date if no delivery date is confirmed by the supplier.

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

": "{Integer}",
21
                    "latestConsumptionDate
LatestConsumptionDate

The earliest date that these items can be used or consumed based upon the stock assignment with the latest production date if it is linked to a production work order, or if it is linked to a sales order, the latest requested date on the linked sales orders.

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

": "{Date}",
22
                    "latestConsumptionDays
LatestConsumptionDays

The deviation between Latest consumption date and Confirmed delivery date, or Requested delivery date if no delivery date is confirmed by the supplier.

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

": "{Integer}",
23
                    "percentUnassigned
PercentUnassigned

Remaining production available in percent

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

": "{Decimal}"
24
               },
25
               "purchaseGroup": {
26
                    "purchaseGroupId
PurchaseGroupId

Purchase group identifier

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

Name of purchase group

": "{String}",
28
                    "purchaseGroupLink
PurchaseGroupLink

Purchase group identifier

": "{String}"
29
               },
30
               "price": {
31
                    "currency
Currency

Three character code following the ISO 4217 standard

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

Represents the price per unit before any discounting is applied.

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

Final price per unit after deducting all discounts etc.

": "{Decimal}"
34
               },
35
               "priceConverted
PriceConverted

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

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

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

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

": "{Decimal}"
39
               },
40
               "totals": {
41
                    "currency
Currency

Three character code following the ISO 4217 standard

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

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

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

Final item amount after deducting all discounts etc.

": "{Decimal}"
44
               },
45
               "totalsConverted
TotalsConverted

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

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

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

Total gross amount in company currency.

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

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

Total net amount in company currency.

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

": "{Decimal}"
49
               },
50
               "purchaseResponsible
PurchaseResponsible

User responsible for the procurement transaction

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

": {
51
                    "employeeId
EmployeeId

Employee identifier

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

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

First name of employee

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

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

Last name of employee

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

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

Employee reference

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

": "{String}"
55
               },
56
               "measurementUnit": {
57
                    "measurementUnitId
MeasurementUnitId

Material unit reference

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

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

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

Material unit reference

": "{String}"
60
               },
61
               "product": {
62
                    "productId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Type of product

Possible domain values can be found here

": "{String}",
66
                    "stock": {
67
                         "isNonStock
IsNonStock

True if this is a non-physical product which are no using assignments from the assignment archive

": "{Boolean}"
68
                    },
69
                    "productLink
ProductLink

Product reference

": "{String}"
70
               },
71
               "manufacturer": {
72
                    "manufacturerId
ManufacturerId

Manufacturer identifier

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

Company name of the manufacturer.

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

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

Shortname/code of the manufacturer

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

Manufacturer reference

": "{String}"
76
               },
77
               "manufacturersProduct
ManufacturersProduct

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

": {
78
                    "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

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

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

Manufacturers product reference

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

": "{String}"
81
               },
82
               "object": {
83
                    "objectId
ObjectId

Identifier of the object

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

Type of object

": "{String}",
85
                    "registrationDate
RegistrationDate

Date of registration

": "{Date}",
86
                    "deliveryTerms
DeliveryTerms

Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).

Possible domain values can be found here

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

Type of document

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

Subtype of document

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

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

": {
90
                         "locationId
LocationId

Location identifier

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

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

Name of location

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

": "{String}",
92
                         "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=Item.Object.Location in your request URI to get this field

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

Location reference

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

": "{String}"
94
                    },
95
                    "supplier": {
96
                         "supplierId
SupplierId

RamBase supplier identifier

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

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

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

Firstname/givenname if the supplier is a person

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

Supplier reference

": "{String}"
100
                    },
101
                    "objectLink
ObjectLink

API reference to the object

": "{String}"
102
               },
103
               "initialPurchaseOrderItem": {
104
                    "purchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

": "{Integer}",
105
                    "purchaseOrder": {
106
                         "purchaseOrderId
PurchaseOrderId

Purchase order identifier

": "{Integer}",
107
                         "purchaseOrderLink
PurchaseOrderLink

Purchase order reference

": "{String}",
108
                         "registrationDate
RegistrationDate

Date of registration

": "{Date}"
109
                    },
110
                    "purchaseOrderItemLink
PurchaseOrderItemLink

Purchase order item reference

": "{String}"
111
               },
112
               "highlightedNotification
HighlightedNotification

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

": {
113
                    "notificationId
NotificationId

Notification identifier

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

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

Status of the notification

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

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

Date and time of creation

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

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

The message from the notification definition, expanded with parameters.

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

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

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

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

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

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

": {
119
                         "notificationTypeId
NotificationTypeId

Notification type identifier

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

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

Category of notification type (warning, information etc)

Possible domain values can be found here

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

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

Notification type reference

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

": "{String}"
122
                    },
123
                    "notificationLink
NotificationLink

Notification reference

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

": "{String}"
124
               },
125
               "projectOrderItem
ProjectOrderItem

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

": {
126
                    "projectOrderItemId
ProjectOrderItemId

Project order item identifier

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

": "{Integer}",
127
                    "projectOrder
ProjectOrder

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

": {
128
                         "projectOrderId
ProjectOrderId

Project order identifier

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

": "{Integer}"
129
                    },
130
                    "projectOrderLink
ProjectOrderLink

Project order reference

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

": "{String}"
131
               },
132
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",
133
               "objectItemLink
ObjectItemLink

API reference to the item

": "{String}"
134
          }
135
     ],
136
     "paging
Paging

Detailed paging information for this list.

": {
137
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
149
     }
150
}

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 101119 HTTP 404 Shipping service was not found
Error 100053 HTTP 403 You have only admittance to your own suppliers