Procurement APIs
List of all purchase quote items
HTTP method | GET |
URI | https://api.rambase.net/procurement/quote-items |
Supported formats | Xml, Html, Json (ex. $format=json) |
Maximum page size ($top) | 60 |
Custom fields | Custom fields supported |
Successful HTTP status code | 200 |
API resource identifier | 2333, version 18 |
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.
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.
CloseToExpiration() Named filter | Items close to expiration date of purchase quote validity or close to expiration date of agreement |
ExclusiveItems() Named filter | Purchase quote items to be used exclusively for customer, company or customer group. |
InfoNotification() Named filter | Purchase quote items with notification of category I (Information) |
MyItems() Named filter | Items which belong to a purchase quote the current user is assigned to |
PendingRegistration() Named filter | Purchase quote items pending registration (status 1) |
AgreementExpirationDate Date | The agreement will have an expiration date. Note that this date might be different from the validity expiration date of the purchase quote.. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
Assignee Integer | The user who has been assigned to work with this object. Available macros: currentUser() |
ContainingNotificationMessage String | Show all transaction documents containing notifications. Note that search will be for messages in company language, and not in user language. |
ContainingNotificationTypeId Integer | Notification type identifier. |
CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
Currency String | Three character code following the ISO 4217 standard. |
EffectiveDate Date | The date the purchase quote takes effect. The quote will be effective from and including this date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
EquivalentProductName String | Name of product with equivalent behavior and attributes. Can be used for same purpose.. |
ExpirationDate Date | The date the purchase quote expires. The quote will be active to and including this date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
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. |
ManufacturerId Integer | Manufacturer identifier. |
ManufacturerShortName String | Shortname/code of the manufacturer. |
MinimumResaleNetPrice Decimal | The minimum net price to use in sales order. Lower than 5% of this price will need approval before registering the sales order. |
NetAmount Decimal | Final item amount after deducting all discounts etc. |
NetPrice Decimal | Final price per unit after deducting all discounts etc. |
Note String | Additional information regarding the item (free text). Might be visible to customers/suppliers. |
ProductClassificationId String | Product classification identifier. |
ProductDescription String | Description of the item. If not specified, the description is by default copied from the product. |
ProductId Integer | Product identifier. |
ProductName String | Name of the product. |
ProductRevision String | Revision number. |
ProductType String | Type of product. |
PurchaseQuoteId Integer | Purchase quote identifier. |
PurchaseQuoteItemId Integer | Purchase quote item identifier. |
Quantity Decimal | Quantity of the purchase quote. |
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. |
Status Integer | Status of purchase quote item. |
SupplierId Integer | RamBase supplier identifier. |
SupplierName String | Name of supplier (name of company or surname/familyname/lastname of a person). |
SuppliersProductName String | Suppliers internal name of the product. Retrieved from the product. |
Read more about filters and sorting on how to use sortable parameters
AgreementExpirationDate Date | The agreement will have an expiration date. Note that this date might be different from the validity expiration date of the purchase quote. |
Assignee Integer | The user who has been assigned to work with this object. |
ContainingNotificationMessage String | Show all transaction documents containing notifications. Note that search will be for messages in company language, and not in user language. |
ContainingNotificationTypeId Integer | Notification type identifier |
CreatedAt Datetime | Date and time of creation |
Currency String | Three character code following the ISO 4217 standard |
EffectiveDate Date | The date the purchase quote takes effect. The quote will be effective from and including this date. |
EquivalentProductName String | Name of product with equivalent behavior and attributes. Can be used for same purpose. |
ExpirationDate Date | The date the purchase quote expires. The quote will be active to and including this date. |
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. |
ManufacturerId Integer | Manufacturer identifier |
ManufacturerShortName String | Shortname/code of the manufacturer |
MinimumResaleNetPrice Decimal | The minimum net price to use in sales order. Lower than 5% of this price will need approval before registering the sales order. |
NetAmount Decimal | Final item amount after deducting all discounts etc. |
NetPrice Decimal | Final price per unit after deducting all discounts etc. |
Note String | Additional information regarding the item (free text). Might be visible to customers/suppliers. |
ProductClassificationId String | Product classification identifier |
ProductDescription String | Description of the item. If not specified, the description is by default copied from the product. |
ProductId Integer | Product identifier |
ProductName String | Name of the product |
ProductRevision String | Revision number |
ProductType String | Type of product |
PurchaseQuoteId Integer | Purchase quote identifier |
PurchaseQuoteItemId Integer | Purchase quote item identifier |
Quantity Decimal | Quantity of the purchase quote |
RegistrationDate Date | Date of registration |
RemainingQuantity Decimal | Remaining number of units to be forwarded |
Status Integer | Status of purchase quote item |
SupplierId Integer | RamBase supplier identifier |
SupplierName String | Name of supplier (name of company or surname/familyname/lastname of a person) |
SuppliersProductName String | Suppliers internal name of the product. Retrieved from the product. |
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.
PurchaseQuoteItemId
Purchase quote item identifier
>{Integer}</PurchaseQuoteItemId>Status
Status of purchase quote item
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>LineNumber
Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
>{Integer}</LineNumber>SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
>{String}</SuppliersProductName>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
>{String}</ProductDescription>Quantity
Quantity of the purchase quote
>{Decimal}</Quantity>HeatNumber
A heat number is an identification coupon number that is stamped on a material plate after it is removed from the ladle and rolled at a steel mill.
>{String}</HeatNumber>LeadTime
The lead time, in number of days, from ordering to delivery.
>{Integer}</LeadTime>RemainingQuantity
Remaining number of units to be forwarded
>{Decimal}</RemainingQuantity>Agreement
If the quote is accepted by the supplier, an agreement is made. The status of the quote item will then be set to 4.
>ExpirationDate
The agreement will have an expiration date. Note that this date might be different from the validity expiration date of the purchase quote.
>{Date}</ExpirationDate>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetAmount
Final item amount after deducting all discounts etc.
>{Decimal}</NetAmount>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>Revision
Revision number
>{String}</Revision>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>ShortName
Shortname/code of the manufacturer
>{String}</ShortName>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>PurchaseQuoteId
Purchase quote identifier
>{Integer}</PurchaseQuoteId>SupplierId
RamBase supplier identifier
>{Integer}</SupplierId>Name
Name of supplier (name of company or surname/familyname/lastname of a person)
>{String}</Name>SupplierLink
Supplier reference
>{String}</SupplierLink>PurhcaseQuoteLink
Purchase quote reference
>{String}</PurhcaseQuoteLink>PurchaseQuoteItemLink
Purchase quote item link
>{String}</PurchaseQuoteItemLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>PurchaseQuoteItemId
Purchase quote item identifier
": "{Integer}",Status
Status of purchase quote item
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",LineNumber
Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
": "{Integer}",SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
": "{String}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
": "{String}",Quantity
Quantity of the purchase quote
": "{Decimal}",HeatNumber
A heat number is an identification coupon number that is stamped on a material plate after it is removed from the ladle and rolled at a steel mill.
": "{String}",LeadTime
The lead time, in number of days, from ordering to delivery.
": "{Integer}",RemainingQuantity
Remaining number of units to be forwarded
": "{Decimal}",Agreement
If the quote is accepted by the supplier, an agreement is made. The status of the quote item will then be set to 4.
": {ExpirationDate
The agreement will have an expiration date. Note that this date might be different from the validity expiration date of the purchase quote.
": "{Date}"Currency
Three character code following the ISO 4217 standard
": "{String}",NetPrice
Final price per unit after deducting all discounts etc.
": "{Decimal}"Currency
Three character code following the ISO 4217 standard
": "{String}",NetAmount
Final item amount after deducting all discounts etc.
": "{Decimal}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",ProductLink
Product reference
": "{String}"Revision
Revision number
": "{String}"ManufacturerId
Manufacturer identifier
": "{Integer}",ShortName
Shortname/code of the manufacturer
": "{String}",ManufacturerLink
Manufacturer reference
": "{String}"PurchaseQuoteId
Purchase quote identifier
": "{Integer}",SupplierId
RamBase supplier identifier
": "{Integer}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",SupplierLink
Supplier reference
": "{String}"PurhcaseQuoteLink
Purchase quote reference
": "{String}"PurchaseQuoteItemLink
Purchase quote item link
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
Error 100147 HTTP 404 | Notification type not found |