Sales APIs
List of applicable/possible purchase quote items to use when calculating landed cost for the item
| HTTP method | GET |
| URI | https://api.rambase.net/sales/orders/{salesOrderId}/items/{itemId}/applicable-purchase-quote-items |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {salesOrderId} |
Sales order identifier
Integer, minimum 10000 |
| - URI parameter {itemId} |
Sales order item identifier
Integer, minimum 1 |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 2525, version 3 |
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" |
| $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.
| 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() |
| 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() |
| 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() |
| GrossPrice Decimal | Represents the price per unit before any discounting is applied. |
| PurchaseQuoteId Integer | Purchase quote identifier. |
| PurchaseQuoteItemId Integer | Purchase quote item identifier. |
| 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). |
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. |
| EffectiveDate Date | The date the purchase quote takes effect. The quote will be effective from and including this date. |
| ExpirationDate Date | The date the purchase quote expires. The quote will be active to and including this date. |
| GrossPrice Decimal | Represents the price per unit before any discounting is applied. |
| PurchaseQuoteId Integer | Purchase quote identifier |
| PurchaseQuoteItemId Integer | Purchase quote item identifier |
| 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) |
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>LeadTime
The lead time, in number of days, from ordering to delivery.
>{Integer}</LeadTime>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>MinimumNetPrice
The minimum net price to use in sales order. Lower than 5% of this price will need approval before registering the sales order.
>{Decimal}</MinimumNetPrice>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>GrossPrice
Represents the price per unit before any discounting is applied.
>{Decimal}</GrossPrice>Database
Database of the object
>{String}</Database>PurchaseQuoteId
Purchase quote identifier
>{Integer}</PurchaseQuoteId>EffectiveDate
The date the purchase quote takes effect. The quote will be effective from and including this date.
>{Date}</EffectiveDate>ExpirationDate
The date the purchase quote expires. The quote will be active to and including this date.
>{Date}</ExpirationDate>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>PurchaseQuoteLink
Purchase quote reference
>{String}</PurchaseQuoteLink>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}",LeadTime
The lead time, in number of days, from ordering to delivery.
": "{Integer}",Currency
Three character code following the ISO 4217 standard
": "{String}",MinimumNetPrice
The minimum net price to use in sales order. Lower than 5% of this price will need approval before registering the sales order.
": "{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}",GrossPrice
Represents the price per unit before any discounting is applied.
": "{Decimal}"Database
Database of the object
": "{String}",PurchaseQuoteId
Purchase quote identifier
": "{Integer}",EffectiveDate
The date the purchase quote takes effect. The quote will be effective from and including this date.
": "{Date}",ExpirationDate
The date the purchase quote expires. The quote will be active to and including this date.
": "{Date}"SupplierId
RamBase supplier identifier
": "{Integer}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",SupplierLink
Supplier reference
": "{String}"PurchaseQuoteLink
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 100050 HTTP 403 | No admittance as customer {0} |
| Error 105969 HTTP 400 | Start date is required |
| Error 105970 HTTP 400 | End date is required |