Sales APIs
Stores information about ales quote item. All amounts should be in the currency of the sales quote. Note that DiscountPercent will be ignored when Discount is provided. Note also that Discount, DiscountPercent and GrossPrice will be ignored when GrossMargin is provided.
| HTTP method | PUT |
| URI | https://api.rambase.net/sales/quotes/{salesQuoteId}/items/{itemId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {salesQuoteId} |
Sales quote identifier
Integer, minimum 100000 |
| - URI parameter {itemId} |
Sales quote item identifier
Integer, minimum 1 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 2142, version 33 |
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.
SalesQuoteItem
This field is optional.
>RequestedDeliveryDate
The delivery date as requested by the customer.
This field is optional.
>{Date}</RequestedDeliveryDate>CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
This field is optional.
>{String}</CustomersReferenceNumber>CustomersProductName
Customers internal name of the product. Retrieved from the product.
This field is optional.
>{String}</CustomersProductName>EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
This field is optional.
>{String}</EquivalentProductName>RequestedProductStructureRevision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
This field is optional.
>{String}</RequestedProductStructureRevision>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
This field is optional.
>{String}</ProductDescription>Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
This field is optional.
>{String}</Note>GrossMargin
Gross margin of the item.
Minimum value: -100
Maximum value: 100
This field is optional.
>{Decimal}</GrossMargin>DiscountPercent
The discount in percent for this item.
Minimum value: 0
Maximum value: 100
This field is optional.
>{Decimal}</DiscountPercent>Quantity
Number of units quoted
Minimum value: 0
This field is optional.
>{Decimal}</Quantity>BufferStockQuantity
The buffer stock quantity is a supply of units held as a reserve to safeguard against unforeseen shortages or demands for the customer. The quantity will be added to the assignment register.
Minimum value: 0
This field is optional.
>{Decimal}</BufferStockQuantity>LeadTime
The lead time from ordering to delivery.
This field is optional.
>{String}</LeadTime>EndCustomer
End customer
This field is optional.
>CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
>{Integer}</CustomerId>Agreement
If the quote is accepted by the customer, an agreement is made. The status of the quote item will then be set to 4.
This field is optional.
>ExpirationDate
The agreement will have an expiration date. Note that this date might be different from the validity expiration date of the sales quote.
This field is optional.
>{Date}</ExpirationDate>Price
This field is optional.
>GrossPrice
Represents the price per unit before any discounting is applied.
This field is optional.
>{Decimal}</GrossPrice>Discount
The discount for the item.
Minimum value: 0
This field is optional.
>{Decimal}</Discount>Seller
Reference to the seller of the item
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>Product
This field is optional.
>ProductId
Product identifier
Minimum value: 10000
This field is optional.
>{Integer}</ProductId>LandedCost
This field is optional.
>PurchaseCurrency
Purchase currency is the currency this product normally is purchased in. This is also the base currency used in the gross margin calculation. By default the purchase currency is retrieved from the product.
Applicable domain values can be found here
This field is optional.
>{String}</PurchaseCurrency>PurchaseExchangeRate
Exchange rate between document currency and purchase currency. Used in landed cost calculations.
This field is optional.
>{Decimal}</PurchaseExchangeRate>PurchasePrice
Purchase price for each unit
Minimum value: 0
This field is optional.
>{Decimal}</PurchasePrice>DerivedFrom
This field is optional.
>PurchaseQuoteItemId
Purchase quote item identifier
Minimum value: 1
This field is optional.
>{Integer}</PurchaseQuoteItemId>PurchaseQuote
This field is optional.
>Database
Database of the object. If not provided the current database will be used.
This field is optional.
>{String}</Database>PurchaseQuoteId
Purchase quote identifier
Minimum value: 10000
This field is optional.
>{Integer}</PurchaseQuoteId>Accounting
Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.
This field is optional.
>VATCodeDefinition
This field is optional.
>VATCode
Code that determines VAT rules used for VAT calculations.
This field is optional.
>{String}</VATCode>RecurringInvoicing
This field is optional.
>StartDate
Start date of subscription or rental item
This field is optional.
>{Date}</StartDate>EstimatedEndDate
Expected end date of subscription or rental item
This field is optional.
>{Date}</EstimatedEndDate>PriceChangeAgreement
Defines if and how the recurring price can be updated
Applicable domain values can be found here
This field is optional.
>{Integer}</PriceChangeAgreement>RecurringPrice
This field is optional.
>RecurringPriceId
Recurring price indentifier
Minimum value: 100000
This field is optional.
>{Integer}</RecurringPriceId>SalesQuoteItem
This field is optional.
": {RequestedDeliveryDate
The delivery date as requested by the customer.
This field is optional.
": "{Date}",CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
This field is optional.
": "{String}",CustomersProductName
Customers internal name of the product. Retrieved from the product.
This field is optional.
": "{String}",EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
This field is optional.
": "{String}",RequestedProductStructureRevision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
This field is optional.
": "{String}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
This field is optional.
": "{String}",Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
This field is optional.
": "{String}",GrossMargin
Gross margin of the item.
Minimum value: -100
Maximum value: 100
This field is optional.
": "{Decimal}",DiscountPercent
The discount in percent for this item.
Minimum value: 0
Maximum value: 100
This field is optional.
": "{Decimal}",Quantity
Number of units quoted
Minimum value: 0
This field is optional.
": "{Decimal}",BufferStockQuantity
The buffer stock quantity is a supply of units held as a reserve to safeguard against unforeseen shortages or demands for the customer. The quantity will be added to the assignment register.
Minimum value: 0
This field is optional.
": "{Decimal}",LeadTime
The lead time from ordering to delivery.
This field is optional.
": "{String}",EndCustomer
End customer
This field is optional.
": {CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Agreement
If the quote is accepted by the customer, an agreement is made. The status of the quote item will then be set to 4.
This field is optional.
": {ExpirationDate
The agreement will have an expiration date. Note that this date might be different from the validity expiration date of the sales quote.
This field is optional.
": "{Date}"Price
This field is optional.
": {GrossPrice
Represents the price per unit before any discounting is applied.
This field is optional.
": "{Decimal}",Discount
The discount for the item.
Minimum value: 0
This field is optional.
": "{Decimal}"Seller
Reference to the seller of the item
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"Product
This field is optional.
": {ProductId
Product identifier
Minimum value: 10000
This field is optional.
": "{Integer}"LandedCost
This field is optional.
": {PurchaseCurrency
Purchase currency is the currency this product normally is purchased in. This is also the base currency used in the gross margin calculation. By default the purchase currency is retrieved from the product.
Applicable domain values can be found here
This field is optional.
": "{String}",PurchaseExchangeRate
Exchange rate between document currency and purchase currency. Used in landed cost calculations.
This field is optional.
": "{Decimal}",PurchasePrice
Purchase price for each unit
Minimum value: 0
This field is optional.
": "{Decimal}",DerivedFrom
This field is optional.
": {PurchaseQuoteItemId
Purchase quote item identifier
Minimum value: 1
This field is optional.
": "{Integer}",PurchaseQuote
This field is optional.
": {Database
Database of the object. If not provided the current database will be used.
This field is optional.
": "{String}",PurchaseQuoteId
Purchase quote identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Accounting
Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.
This field is optional.
": {VATCodeDefinition
This field is optional.
": {VATCode
Code that determines VAT rules used for VAT calculations.
This field is optional.
": "{String}"RecurringInvoicing
This field is optional.
": {StartDate
Start date of subscription or rental item
This field is optional.
": "{Date}",EstimatedEndDate
Expected end date of subscription or rental item
This field is optional.
": "{Date}",PriceChangeAgreement
Defines if and how the recurring price can be updated
Applicable domain values can be found here
This field is optional.
": "{Integer}",RecurringPrice
This field is optional.
": {RecurringPriceId
Recurring price indentifier
Minimum value: 100000
This field is optional.
": "{Integer}"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.
| $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 |
| $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. |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
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.
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 101204 HTTP 404 | Service order item not found |
| Error 102229 HTTP 400 | Location {0} is already defined on the product |
| Error 102747 HTTP 400 | Error in formula: {0} |
| Error 107132 HTTP 400 | To change fixed price to customer, invoices must first be credited or deleted, and invoice plan must be deleted |
| Error 106961 HTTP 400 | Change of purchase rate is not allowed for project order type items (WP) |
| Error 106960 HTTP 400 | Change of purchase currency is not allowed for project order type items (WP) |
| Error 107224 HTTP 400 | Change reason is required |
| Error 103505 HTTP 400 | Requested delivery date can not be set to the past. |
| Error 107812 HTTP 400 | End customer not found |
| Error 107813 HTTP 400 | The end customer is not active |
| Error 107860 HTTP 400 | Cannot update as this sales order belongs to a delivery project that do have a different finance project |
| Error 101313 HTTP 400 | Department number is not valid: {0} |
| Error 101320 HTTP 400 | The project number is not valid: {0} |
| Error 101500 HTTP 400 | Project {0} could not be used : Check project FromPeriod and ToPeriod. |
| Error 101501 HTTP 400 | Asset is not allowed on general ledger account {0} |
| Error 101326 HTTP 400 | The asset number is not valid : {0} |
| Error 102486 HTTP 400 | Invalid value for dimension {0} |