API

Procurement APIs

GET procurement/purchase-requirements-by-order?locationId={locationId}&supplierId={supplierId}

List out purchase requirements accumulated

HTTP method GET
URI https://api.rambase.net/procurement/purchase-requirements-by-order?locationId={locationId}&supplierId={supplierId}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5976, version 78

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.

locationId Integer, optional Location identifier

Minimum: 10000
supplierId Integer, optional RamBase supplier identifier

Minimum: 100
$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"
$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.

DeadlineNext3Months() Named filter Items that have a deadline date earlier than three months in advance Deadline date = Date when you need to place a purchase order to receive it in time for the requirement, calculated by subtracting leadtime from required date.
DeadlineNextOneMonth() Named filter Items that have a deadline date earlier than one month in advance Deadline date = Date when you need to place a purchase order to receive it in time for the requirement, calculated by subtracting leadtime from required date.
DeadlineNextTwoWeeks() Named filter Items that have a deadline date earlier than two weeks in advance Deadline date = Date when you need to place a purchase order to receive it in time for the requirement, calculated by subtracting leadtime from required date.
DeadlineOverdue() Named filter Items that have a deadline date earlier than today Deadline date = Date when you need to place a purchase order to receive it in time for the requirement, calculated by subtracting leadtime from required date.
HideBlocked() Named filter If a product is blocked for purchase, no purchase quotes or purchase orders with that product can be registered.
MissingResponsible() Named filter Items where no responsible purchaser is set Items can be components in the KIT structure connected to the PWO on these items, Sales Order Items or Service Order Items
MyItems() Named filter Items where I am the responsible purchaser. Items can be parts in the KIT structure connected to the PWO on these items, Sales Order Items or Service Order Items
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
DeadlineDate Date The latest date for placing a purchase order for this product to receive it in time for the requirement. Calculated by subtracting leadtime from required date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
FinanceProjectName String Name of finance project.
InternalNote String Note for product structure version's material.
IsBlockedForPurchase Boolean If a product is blocked for purchase, no purchase quotes or purchase orders with that product can be registered..
IsOutsideOfAssignmentWindow Boolean Indicates that this order is outside of assignment window.
LatestProductRevision String Revision number.
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).
MaterialNote String Purchase order note for external operation, copied to the Note field at PO item.
MeasurementUnit String Measurement unit (ex. mm, km, dl, kg).
NetAmount Decimal Total price.
NetRequirementQuantity Decimal Required quantity.
OrderRamBaseKey String Internal RamBase identifier of the object/item.
OrderStatus Integer Status of the item/object.
PreferredSupplier Boolean Whether this supplier is preferred or not.
PreferredSupplierName String Name of supplier (name of company or surname/familyname/lastname of a person).
ProductDescription String Description of the product.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductStatus Integer Status of the product.
ProductType String Type of product.
PurchaseGroupId Integer Purchase group identifier.
PurchaseLeadTime Integer Specifies the expected number of days from ordering from the supplier to goods can be expected to be received.
PurchaseNote String Purchase note for this product on this location.
PurchaseResponsibleEmployeeId Integer Employee identifier. Available macros: currentUser()
PurchaseResponsibleFirstName String First name of employee.
PurchaseResponsibleLastName String Last name of employee.
RequestedDeliveryDate Date The delivery date as requested by the customer. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
SalesDeliveryProjectName String Name of sales delivery project.
SuggestedPurchaseNetPrice Decimal The purchase price of the product for this product supplier.
SuggestedPurchaseNetPriceCurrency String Three character code following the ISO 4217 standard.
SuggestedPurchaseQuantity Decimal Suggested quantity to purchase.
SupplierLeadTime Integer Standard leadtime in days for this product from this supplier.
SuppliersProductName String Supplier internal product name.
TotalAvailableStockQuantity Decimal Total available quantity in stock in all locations. This quantity is not assigned to any orders.
TotalStockQuantity Decimal Total quantity in stock in all locations.

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

CustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
DeadlineDate Date The latest date for placing a purchase order for this product to receive it in time for the requirement. Calculated by subtracting leadtime from required date.
FinanceProjectName String Name of finance project
InternalNote String Note for product structure version's material
IsBlockedForPurchase Boolean If a product is blocked for purchase, no purchase quotes or purchase orders with that product can be registered.
IsOutsideOfAssignmentWindow Boolean Indicates that this order is outside of assignment window
LatestProductRevision String Revision number
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).
MaterialNote String Purchase order note for external operation, copied to the Note field at PO item
MeasurementUnit String Measurement unit (ex. mm, km, dl, kg)
NetAmount Decimal Total price
NetRequirementQuantity Decimal Required quantity
OrderRamBaseKey String Internal RamBase identifier of the object/item
OrderStatus Integer Status of the item/object.
PreferredSupplier Boolean Whether this supplier is preferred or not
PreferredSupplierName String Name of supplier (name of company or surname/familyname/lastname of a person)
ProductDescription String Description of the product
ProductId Integer Product identifier
ProductName String Name of the product
ProductStatus Integer Status of the product
ProductType String Type of product
PurchaseGroupId Integer Purchase group identifier
PurchaseLeadTime Integer Specifies the expected number of days from ordering from the supplier to goods can be expected to be received
PurchaseNote String Purchase note for this product on this location
PurchaseResponsibleEmployeeId Integer Employee identifier
PurchaseResponsibleFirstName String First name of employee
PurchaseResponsibleLastName String Last name of employee
RequestedDeliveryDate Date The delivery date as requested by the customer.
SalesDeliveryProjectName String Name of sales delivery project
SuggestedPurchaseNetPrice Decimal The purchase price of the product for this product supplier
SuggestedPurchaseNetPriceCurrency String Three character code following the ISO 4217 standard
SuggestedPurchaseQuantity Decimal Suggested quantity to purchase
SupplierLeadTime Integer Standard leadtime in days for this product from this supplier
SuppliersProductName String Supplier internal product name
TotalAvailableStockQuantity Decimal Total available quantity in stock in all locations. This quantity is not assigned to any orders.
TotalStockQuantity Decimal Total quantity in stock in all locations.

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
<PurchaseRequirementsByOrder>
2
     <PurchaseRequirementByOrder>
3
          <IsBlockedForPurchase
IsBlockedForPurchase

If a product is blocked for purchase, no purchase quotes or purchase orders with that product can be registered.

>{Boolean}</IsBlockedForPurchase>
4
          <NetRequirementQuantity
NetRequirementQuantity

Required quantity

>{Decimal}</NetRequirementQuantity>
5
          <SuggestedPurchaseQuantity
SuggestedPurchaseQuantity

Suggested quantity to purchase

>{Decimal}</SuggestedPurchaseQuantity>
6
          <RequestedDeliveryDate
RequestedDeliveryDate

‘Scheduled shipping date’ from sales order or 'Requested completion date' for production work order

>{Date}</RequestedDeliveryDate>
7
          <DeadlineDate
DeadlineDate

The latest date for placing a purchase order for this product to receive it in time for the requirement. Calculated by subtracting leadtime from required date.

>{Date}</DeadlineDate>
8
          <TotalNetAmount
TotalNetAmount

Total price

>{Decimal}</TotalNetAmount>
9
          <HasLowerPriceForHigherQuantity
HasLowerPriceForHigherQuantity

Indicates that this product has lower price for higher quantity for this supplier

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

>{Boolean}</HasLowerPriceForHigherQuantity>
10
          <HasReplacements
HasReplacements

Indicates that this product has replacements

>{Boolean}</HasReplacements>
11
          <CustomersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

>{String}</CustomersReferenceNumber>
12
          <NumberOfPurchaseQuoteRequestsForRequirement
NumberOfPurchaseQuoteRequestsForRequirement

Number of purchase quote requests

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

>{Integer}</NumberOfPurchaseQuoteRequestsForRequirement>
13
          <NumberOfPurchaseQuotesForRequirement
NumberOfPurchaseQuotesForRequirement

Number of purchase quotes

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

>{Integer}</NumberOfPurchaseQuotesForRequirement>
14
          <OrderHasFileRequirements
OrderHasFileRequirements

Indicating this product have planned file requirements

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

>{Boolean}</OrderHasFileRequirements>
15
          <PurchaseLeadTime
PurchaseLeadTime

Specifies the expected number of days from ordering from the supplier to goods can be expected to be received

>{Integer}</PurchaseLeadTime>
16
          <Order>
17
               <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
18
               <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
19
               <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
20
               <Status
Status

Status of the item/object.

>{Integer}</Status>
21
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
22
               <ItemLink
ItemLink

API reference to the item

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

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
24
          </Order>
25
          <Procurement>
26
               <PurchaseResponsible
PurchaseResponsible

User responsible for the procurement transaction

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

>
27
                    <EmployeeId
EmployeeId

Employee identifier

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

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

First name of employee

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

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

Last name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
31
               </PurchaseResponsible>
32
          </Procurement>
33
          <Customer
Customer

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

>
34
               <CustomerId
CustomerId

Customer identifier

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

>{Integer}</CustomerId>
35
               <Name
Name

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

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

>{String}</Name>
36
               <CustomerLink
CustomerLink

Customer reference

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

>{String}</CustomerLink>
37
          </Customer>
38
          <FinanceProject
FinanceProject

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

>
39
               <FinanceProjectId
FinanceProjectId

Finance project identifier

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

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

Name of finance project

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

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

Finance project reference

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

>{String}</FinanceProjectLink>
42
          </FinanceProject>
43
          <SalesDeliveryProject
SalesDeliveryProject

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

>
44
               <SalesDeliveryProjectId
SalesDeliveryProjectId

Sales delivery project identifier

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

>{Integer}</SalesDeliveryProjectId>
45
               <Name
Name

Name of sales delivery project

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

>{String}</Name>
46
               <SalesDeliveryProjectLink
SalesDeliveryProjectLink

Sales delivery project reference

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

>{String}</SalesDeliveryProjectLink>
47
          </SalesDeliveryProject>
48
          <Product>
49
               <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
50
               <HasPlannedFileRequirements
HasPlannedFileRequirements

Indicating this product have planned file requirements

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

>{Boolean}</HasPlannedFileRequirements>
51
               <Status
Status

Status of the product

Possible domain values can be found here

>{Integer}</Status>
52
               <Name
Name

Name of the product

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

Type of product

Possible domain values can be found here

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

Description of the product

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

Internal note regardig the product. Should not be exposed to customers.

>{String}</InternalNote>
56
               <NumberOfNotes
NumberOfNotes

Number of notes

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

>{Integer}</NumberOfNotes>
57
               <MeasurementUnit
MeasurementUnit

Measurement unit used for this product, both in sales and purchase.

>
58
                    <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

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

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

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

Material unit reference

>{String}</MeasurementUnitLink>
62
               </MeasurementUnit>
63
               <ProductClassification
ProductClassification

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

>
64
                    <ProductClassificationId
ProductClassificationId

Product classification identifier

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

>{String}</ProductClassificationId>
65
                    <TreeLevel
TreeLevel

Level in product classification tree (0 is root)

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

>{Integer}</TreeLevel>
66
                    <Name
Name

Name of product classification

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

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

Product classification reference

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

>{String}</ProductClassificationLink>
68
               </ProductClassification>
69
               <Manufacturer
Manufacturer

Manufacturer of the product

>
70
                    <ManufacturerId
ManufacturerId

Manufacturer identifier

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

Shortname/code of the manufacturer

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

Manufacturer reference

>{String}</ManufacturerLink>
73
               </Manufacturer>
74
               <DefaultManufacturersProduct>
75
                    <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

>{Integer}</ManufacturersProductId>
76
                    <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=PurchaseRequirementByOrder.Product.DefaultManufacturersProduct.Name in your request URI to get this field

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

Manufacturers product reference

>{String}</ManufacturersProductLink>
78
               </DefaultManufacturersProduct>
79
               <Stock>
80
                    <StockQuantity
StockQuantity

Total quantity in stock in all locations.

>{Decimal}</StockQuantity>
81
                    <AvailableStockQuantity
AvailableStockQuantity

Total available quantity in stock in all locations. This quantity is not assigned to any orders.

>{Decimal}</AvailableStockQuantity>
82
               </Stock>
83
               <Procurement>
84
                    <ExpectedLeadTime
ExpectedLeadTime

The expected lead time, in number of days, from ordering from supplier to goods reception. Used in different purchase processes, typically when supplier is unknown. Note that this might differ from the standard lead times defined on the different suppliers.

>{Integer}</ExpectedLeadTime>
85
               </Procurement>
86
               <LatestProductRevision
LatestProductRevision

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

>
87
                    <Revision
Revision

Revision number

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

>{String}</Revision>
88
               </LatestProductRevision>
89
               <ProductLink
ProductLink

Product identifier

>{String}</ProductLink>
90
          </Product>
91
          <ProductLocation>
92
               <Location>
93
                    <LocationId
LocationId

Location identifier

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

Name of warehouse location

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

Unique abbreviation/short name of the location

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

Location reference

>{String}</LocationLink>
97
               </Location>
98
               <Procurement>
99
                    <BlockedForPurchase
BlockedForPurchase

If a product is blocked for purchase, no purchase quotes or purchase orders with that product can be registered.

>{Boolean}</BlockedForPurchase>
100
                    <ReorderQuantity
ReorderQuantity

Suggested quantity to purchase when stock gets below reorder point.

>{Decimal}</ReorderQuantity>
101
                    <ReorderPoint
ReorderPoint

Reorder point. A locations specific stock level which a new order must be placed to replenish stock and prevent a stockout.

>{Decimal}</ReorderPoint>
102
                    <PurchaseNote
PurchaseNote

Purchase note for this product on this location

>{String}</PurchaseNote>
103
                    <LeadTimeBuffer
LeadTimeBuffer

If a value is set, it overrides the company-wide setting for calculating the procurement deadlines,
otherwise the default company-wide setting applies.

>{Integer}</LeadTimeBuffer>
104
                    <PurchaseGroup>
105
                         <PurchaseGroupId
PurchaseGroupId

Purchase group identifier

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

Name of purchase group

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

Purchase group reference

>{String}</PurchaseGroupLink>
108
                    </PurchaseGroup>
109
               </Procurement>
110
               <Stock>
111
                    <StockQuantity
StockQuantity

Quantity in stock at a specifice location.

>{Decimal}</StockQuantity>
112
                    <AvailableStockQuantity
AvailableStockQuantity

Available quantity in stock in a specifice location. This quantity is not assigned to any orders.

>{Decimal}</AvailableStockQuantity>
113
               </Stock>
114
          </ProductLocation>
115
          <ProductStructureMaterial>
116
               <ProductStructureMaterialId
ProductStructureMaterialId

Product structure material identifier

>{Integer}</ProductStructureMaterialId>
117
               <Note
Note

Note for product structure version's material

>{String}</Note>
118
               <ProductStructureOperation>
119
                    <OutsourcedOperation>
120
                         <Note
Note

Purchase order note for external operation, copied to the Note field at PO item

>{String}</Note>
121
                    </OutsourcedOperation>
122
               </ProductStructureOperation>
123
               <ProductStructureVersion>
124
                    <ProductStructureVersionId
ProductStructureVersionId

Product structure identifier

>{Integer}</ProductStructureVersionId>
125
               </ProductStructureVersion>
126
          </ProductStructureMaterial>
127
          <SuggestedProductSupplier>
128
               <StandardLeadTime
StandardLeadTime

Standard leadtime in days for this product from this supplier

>{Integer}</StandardLeadTime>
129
               <IsPreferred
IsPreferred

Whether this supplier is preferred or not

>{Boolean}</IsPreferred>
130
               <Supplier>
131
                    <SupplierId
SupplierId

RamBase supplier identifier

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

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

>{String}</Name>
133
                    <Procurement>
134
                         <ConfirmedDeliveryDateBuffer
ConfirmedDeliveryDateBuffer

If the confirmed delivery date is unreliable, you can specify a buffer in days to be added.

This buffer will be used when the requested delivery date for purchase orders is calculated.
This buffer will also be added to the confirmed delivery date when creating purchase order responses.

>{Integer}</ConfirmedDeliveryDateBuffer>
135
                    </Procurement>
136
                    <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
137
               </Supplier>
138
          </SuggestedProductSupplier>
139
          <SuggestedPurchasePrice>
140
               <MinimumQuantity
MinimumQuantity

The minimum quantity for this purchase price to be applied

>{Decimal}</MinimumQuantity>
141
               <Price>
142
                    <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

The purchase price of the product for this product supplier

>{Decimal}</NetPrice>
144
               </Price>
145
          </SuggestedPurchasePrice>
146
     </PurchaseRequirementByOrder>
147
     <Paging
Paging

Detailed paging information for this list.

>
148
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
151
          <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>
152
          <FirstPage
FirstPage

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

>{String}</FirstPage>
153
          <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>
154
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
155
          <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>
156
          <NextPage
NextPage

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

>{String}</NextPage>
157
          <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>
158
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
160
     </Paging>
161
</PurchaseRequirementsByOrder>
1
{
2
     "purchaseRequirementsByOrder": [
3
          {
4
               "isBlockedForPurchase
IsBlockedForPurchase

If a product is blocked for purchase, no purchase quotes or purchase orders with that product can be registered.

": "{Boolean}",
5
               "netRequirementQuantity
NetRequirementQuantity

Required quantity

": "{Decimal}",
6
               "suggestedPurchaseQuantity
SuggestedPurchaseQuantity

Suggested quantity to purchase

": "{Decimal}",
7
               "requestedDeliveryDate
RequestedDeliveryDate

‘Scheduled shipping date’ from sales order or 'Requested completion date' for production work order

": "{Date}",
8
               "deadlineDate
DeadlineDate

The latest date for placing a purchase order for this product to receive it in time for the requirement. Calculated by subtracting leadtime from required date.

": "{Date}",
9
               "totalNetAmount
TotalNetAmount

Total price

": "{Decimal}",
10
               "hasLowerPriceForHigherQuantity
HasLowerPriceForHigherQuantity

Indicates that this product has lower price for higher quantity for this supplier

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

": "{Boolean}",
11
               "hasReplacements
HasReplacements

Indicates that this product has replacements

": "{Boolean}",
12
               "customersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

": "{String}",
13
               "numberOfPurchaseQuoteRequestsForRequirement
NumberOfPurchaseQuoteRequestsForRequirement

Number of purchase quote requests

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

": "{Integer}",
14
               "numberOfPurchaseQuotesForRequirement
NumberOfPurchaseQuotesForRequirement

Number of purchase quotes

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

": "{Integer}",
15
               "orderHasFileRequirements
OrderHasFileRequirements

Indicating this product have planned file requirements

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

": "{Boolean}",
16
               "purchaseLeadTime
PurchaseLeadTime

Specifies the expected number of days from ordering from the supplier to goods can be expected to be received

": "{Integer}",
17
               "order": {
18
                    "objectType
ObjectType

Type of object

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

Identifier of the object

": "{Integer}",
20
                    "itemId
ItemId

Item-number of the object

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

Status of the item/object.

": "{Integer}",
22
                    "objectLink
ObjectLink

API reference to the object

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

API reference to the item

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

Internal RamBase identifier of the object/item

": "{String}"
25
               },
26
               "procurement": {
27
                    "purchaseResponsible
PurchaseResponsible

User responsible for the procurement transaction

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

": {
28
                         "employeeId
EmployeeId

Employee identifier

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

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

First name of employee

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

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

Last name of employee

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

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

Employee reference

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

": "{String}"
32
                    }
33
               },
34
               "customer
Customer

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

": {
35
                    "customerId
CustomerId

Customer identifier

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

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

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

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

": "{String}",
37
                    "customerLink
CustomerLink

Customer reference

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

": "{String}"
38
               },
39
               "financeProject
FinanceProject

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

": {
40
                    "financeProjectId
FinanceProjectId

Finance project identifier

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

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

Name of finance project

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

": "{String}",
42
                    "financeProjectLink
FinanceProjectLink

Finance project reference

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

": "{String}"
43
               },
44
               "salesDeliveryProject
SalesDeliveryProject

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

": {
45
                    "salesDeliveryProjectId
SalesDeliveryProjectId

Sales delivery project identifier

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

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

Name of sales delivery project

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

": "{String}",
47
                    "salesDeliveryProjectLink
SalesDeliveryProjectLink

Sales delivery project reference

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

": "{String}"
48
               },
49
               "product": {
50
                    "productId
ProductId

Product identifier

": "{Integer}",
51
                    "hasPlannedFileRequirements
HasPlannedFileRequirements

Indicating this product have planned file requirements

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

": "{Boolean}",
52
                    "status
Status

Status of the product

Possible domain values can be found here

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

Name of the product

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

Type of product

Possible domain values can be found here

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

Description of the product

": "{String}",
56
                    "internalNote
InternalNote

Internal note regardig the product. Should not be exposed to customers.

": "{String}",
57
                    "numberOfNotes
NumberOfNotes

Number of notes

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

": "{Integer}",
58
                    "measurementUnit
MeasurementUnit

Measurement unit used for this product, both in sales and purchase.

": {
59
                         "measurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

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

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

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

Material unit reference

": "{String}"
63
                    },
64
                    "productClassification
ProductClassification

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

": {
65
                         "productClassificationId
ProductClassificationId

Product classification identifier

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

": "{String}",
66
                         "treeLevel
TreeLevel

Level in product classification tree (0 is root)

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

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

Name of product classification

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

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

Product classification reference

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

": "{String}"
69
                    },
70
                    "manufacturer
Manufacturer

Manufacturer of the product

": {
71
                         "manufacturerId
ManufacturerId

Manufacturer identifier

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

Shortname/code of the manufacturer

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

Manufacturer reference

": "{String}"
74
                    },
75
                    "defaultManufacturersProduct": {
76
                         "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

": "{Integer}",
77
                         "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=PurchaseRequirementByOrder.Product.DefaultManufacturersProduct.Name in your request URI to get this field

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

Manufacturers product reference

": "{String}"
79
                    },
80
                    "stock": {
81
                         "stockQuantity
StockQuantity

Total quantity in stock in all locations.

": "{Decimal}",
82
                         "availableStockQuantity
AvailableStockQuantity

Total available quantity in stock in all locations. This quantity is not assigned to any orders.

": "{Decimal}"
83
                    },
84
                    "procurement": {
85
                         "expectedLeadTime
ExpectedLeadTime

The expected lead time, in number of days, from ordering from supplier to goods reception. Used in different purchase processes, typically when supplier is unknown. Note that this might differ from the standard lead times defined on the different suppliers.

": "{Integer}"
86
                    },
87
                    "latestProductRevision
LatestProductRevision

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

": {
88
                         "revision
Revision

Revision number

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

": "{String}"
89
                    },
90
                    "productLink
ProductLink

Product identifier

": "{String}"
91
               },
92
               "productLocation": {
93
                    "location": {
94
                         "locationId
LocationId

Location identifier

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

Name of warehouse location

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

Unique abbreviation/short name of the location

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

Location reference

": "{String}"
98
                    },
99
                    "procurement": {
100
                         "blockedForPurchase
BlockedForPurchase

If a product is blocked for purchase, no purchase quotes or purchase orders with that product can be registered.

": "{Boolean}",
101
                         "reorderQuantity
ReorderQuantity

Suggested quantity to purchase when stock gets below reorder point.

": "{Decimal}",
102
                         "reorderPoint
ReorderPoint

Reorder point. A locations specific stock level which a new order must be placed to replenish stock and prevent a stockout.

": "{Decimal}",
103
                         "purchaseNote
PurchaseNote

Purchase note for this product on this location

": "{String}",
104
                         "leadTimeBuffer
LeadTimeBuffer

If a value is set, it overrides the company-wide setting for calculating the procurement deadlines,
otherwise the default company-wide setting applies.

": "{Integer}",
105
                         "purchaseGroup": {
106
                              "purchaseGroupId
PurchaseGroupId

Purchase group identifier

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

Name of purchase group

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

Purchase group reference

": "{String}"
109
                         }
110
                    },
111
                    "stock": {
112
                         "stockQuantity
StockQuantity

Quantity in stock at a specifice location.

": "{Decimal}",
113
                         "availableStockQuantity
AvailableStockQuantity

Available quantity in stock in a specifice location. This quantity is not assigned to any orders.

": "{Decimal}"
114
                    }
115
               },
116
               "productStructureMaterial": {
117
                    "productStructureMaterialId
ProductStructureMaterialId

Product structure material identifier

": "{Integer}",
118
                    "note
Note

Note for product structure version's material

": "{String}",
119
                    "productStructureOperation": {
120
                         "outsourcedOperation": {
121
                              "note
Note

Purchase order note for external operation, copied to the Note field at PO item

": "{String}"
122
                         }
123
                    },
124
                    "productStructureVersion": {
125
                         "productStructureVersionId
ProductStructureVersionId

Product structure identifier

": "{Integer}"
126
                    }
127
               },
128
               "suggestedProductSupplier": {
129
                    "standardLeadTime
StandardLeadTime

Standard leadtime in days for this product from this supplier

": "{Integer}",
130
                    "isPreferred
IsPreferred

Whether this supplier is preferred or not

": "{Boolean}",
131
                    "supplier": {
132
                         "supplierId
SupplierId

RamBase supplier identifier

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

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

": "{String}",
134
                         "procurement": {
135
                              "confirmedDeliveryDateBuffer
ConfirmedDeliveryDateBuffer

If the confirmed delivery date is unreliable, you can specify a buffer in days to be added.

This buffer will be used when the requested delivery date for purchase orders is calculated.
This buffer will also be added to the confirmed delivery date when creating purchase order responses.

": "{Integer}"
136
                         },
137
                         "supplierLink
SupplierLink

Supplier reference

": "{String}"
138
                    }
139
               },
140
               "suggestedPurchasePrice": {
141
                    "minimumQuantity
MinimumQuantity

The minimum quantity for this purchase price to be applied

": "{Decimal}",
142
                    "price": {
143
                         "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

The purchase price of the product for this product supplier

": "{Decimal}"
145
                    }
146
               }
147
          }
148
     ],
149
     "paging
Paging

Detailed paging information for this list.

": {
150
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
162
     }
163
}

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 100559 HTTP 404 Product Classification not found
Error 100167 HTTP 404 Measurement unit not found