Sales APIs
Creates a new item in provided sales quote request
| HTTP method | POST |
| URI | https://api.rambase.net/sales/quote-requests/{salesQuoteRequestId}/items |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {salesQuoteRequestId} |
Sales quote request identifier
Integer, minimum 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 2123, version 8 |
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.
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>Quantity
Required/mandatory field
Number of units requested quote for
Minimum value: 0
>{Decimal}</Quantity>Price
This field is optional.
>TargetPrice
The net price as requested by the customer
Minimum value: 0
This field is optional.
>{Decimal}</TargetPrice>Seller
Reference to the seller of the item
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
>{Integer}</ProductId>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}",Quantity
Required/mandatory field
Number of units requested quote for
Minimum value: 0
": "{Decimal}",Price
This field is optional.
": {TargetPrice
The net price as requested by the customer
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}"ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
": "{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. |
| $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] |
| $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.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
SalesQuoteRequestItemId
Sales quote request item identifier
>{Integer}</SalesQuoteRequestItemId>Status
Status of the sales quote request 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>RequestedDeliveryDate
The delivery date as requested by the customer.
>{Date}</RequestedDeliveryDate>CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
>{String}</CustomersReferenceNumber>CustomersProductName
Customers internal name of the product. Retrieved from the product.
>{String}</CustomersProductName>EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
>{String}</EquivalentProductName>RequestedProductStructureRevision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
>{String}</RequestedProductStructureRevision>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
>{String}</ProductDescription>Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
>{String}</Note>GrossMargin
Gross margin of the item. An eventual approval of GM is triggered if this percentage is lower than the highest value of minimum gross margin set up in Customer, Product and GM in COM
>{Decimal}</GrossMargin>Quantity
Number of units requested quote for
>{Decimal}</Quantity>RemainingQuantity
Remaining number of units to be forwarded.
>{Decimal}</RemainingQuantity>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>FirstName
Secondary name of a company or firstname of a person
>{String}</FirstName>VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).
>{String}</VATRegistrationNumber>CustomerLink
Customer reference
>{String}</CustomerLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>TargetPrice
The net price as requested by the customer
>{Decimal}</TargetPrice>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>TargetPrice
Represents the price per unit before any discounting is applied.
>{Decimal}</TargetPrice>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>TargetAmount
The total item amount. Calculated by multiplying target price with quantity.
>{Decimal}</TargetAmount>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>TargetAmount
Total gross amount in company currency.
>{Decimal}</TargetAmount>Seller
Reference to the seller of the item
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>EmployeeLink
Employee reference
>{String}</EmployeeLink>MeasurementUnitId
Measurement unit identifier
>{Integer}</MeasurementUnitId>Unit
Measurement unit (ex. mm, km, dl, kg)
>{String}</Unit>Precision
The precision/accuracy of the measurement (number of decimals)
>{Integer}</Precision>MeasurementUnitLink
Material unit reference
>{String}</MeasurementUnitLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>CountryOfOriginCode
Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.
>{String}</CountryOfOriginCode>CustomField1
Custom field for grouping, sorting, categorizing and other purposes.
>{String}</CustomField1>CustomField2
Custom field for grouping, sorting, categorizing and other purposes.
>{String}</CustomField2>StandardLeadTime
The expected lead time, in number of days, from ordering from supplier to delivery. 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}</StandardLeadTime>Weight
The weight of the product in kilograms.
>{Decimal}</Weight>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>ShortName
Shortname/code of the manufacturer
>{String}</ShortName>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>ProductClassificationId
Product classification identifier
>{String}</ProductClassificationId>ProductClassificationLink
Product classification reference
>{String}</ProductClassificationLink>Revision
Revision number
>{String}</Revision>ProductLink
Product reference
>{String}</ProductLink>ProductStructureId
Product structure reference
>{Integer}</ProductStructureId>ProductStructureLink
Product structure reference
>{String}</ProductStructureLink>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.
Possible domain values can be found here
>{String}</PurchaseCurrency>PurchasePrice
Purchase price for each unit
>{Decimal}</PurchasePrice>Freight
Estimated freight cost of getting each unit in stock. Used for calculating landed cost.
>{Decimal}</Freight>Duty
Duty cost of getting each unit in stock. Used for calculating landed cost.
>{Decimal}</Duty>Charge
Other costs of getting each unit in stock. Used for calculating landed cost.
>{Decimal}</Charge>GrossPrice
Total cost (landed cost or true cost) of getting each unit in stock, including purchase price, duties, charges, freight etc.
>{Decimal}</GrossPrice>PurchaseExchangeRate
Exchange rate between document currency and purchase currency. Used in landed cost calculations.
>{Decimal}</PurchaseExchangeRate>IsDerivedFromPreferredPurchasePrice
True if the landed cost for this item is derived from preferred purchase price. This means that parts (or all) of the item has not reserved goods in stock, nor incoming goods (supplier backlog or production backlog).
>{Boolean}</IsDerivedFromPreferredPurchasePrice>PurchaseQuoteItemId
Purchase quote item identifier
>{Integer}</PurchaseQuoteItemId>Database
Database of the object
>{String}</Database>PurchaseQuoteId
Purchase quote identifier
>{Integer}</PurchaseQuoteId>PurchaseQuoteLink
Purchase quote reference
>{String}</PurchaseQuoteLink>PurchaseQuoteItemLink
Purchase quote item link
>{String}</PurchaseQuoteItemLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>PurchasePrice
Purchase price in sales currency.
>{Decimal}</PurchasePrice>Freight
Freigth cost in sales currency.
>{Decimal}</Freight>Duty
Duty costs in sales currency.
>{Decimal}</Duty>Charge
Other cost in sales currency
>{Decimal}</Charge>GrossPrice
Total cost (landed cost or true cost) in sales currency
>{Decimal}</GrossPrice>OpenForwardedQuantity
When items are forwarded they end up in one or more open items. Open items in this context means items that are not registered (status 0 or 1). OpenForwardedQuantity will be the sum of ForwardedQuantity of all items this item has been forwarded to.
>{Decimal}</OpenForwardedQuantity>Item
Item this item was forwarded to.
>ItemId
Identifier of the object
>{Integer}</ItemId>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ItemLink
API reference to the item
>{String}</ItemLink>NotificationId
Notification identifier
>{Integer}</NotificationId>Status
Status of the notification
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Message
The message from the notification definition, expanded with parameters.
>{String}</Message>TranslatedMessage
The translated message from the notification definition, expanded with parameters.
>{String}</TranslatedMessage>NotificationTypeId
Notification type identifier
>{String}</NotificationTypeId>Category
Category of notification type (warning, information etc)
Possible domain values can be found here
>{String}</Category>NotificationTypeLink
Notification type reference
>{String}</NotificationTypeLink>NotificationLink
Notification reference
>{String}</NotificationLink>ProjectOrderId
Project order identifier
>{Integer}</ProjectOrderId>ProjectOrderLink
Project order reference
>{String}</ProjectOrderLink>SalesQuoteRequestItemId
Sales quote request item identifier
": "{Integer}",Status
Status of the sales quote request 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}",RequestedDeliveryDate
The delivery date as requested by the customer.
": "{Date}",CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
": "{String}",CustomersProductName
Customers internal name of the product. Retrieved from the product.
": "{String}",EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
": "{String}",RequestedProductStructureRevision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
": "{String}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
": "{String}",Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
": "{String}",GrossMargin
Gross margin of the item. An eventual approval of GM is triggered if this percentage is lower than the highest value of minimum gross margin set up in Customer, Product and GM in COM
": "{Decimal}",Quantity
Number of units requested quote for
": "{Decimal}",RemainingQuantity
Remaining number of units to be forwarded.
": "{Decimal}",CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",FirstName
Secondary name of a company or firstname of a person
": "{String}",VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).
": "{String}",CustomerLink
Customer reference
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",TargetPrice
The net price as requested by the customer
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",TargetPrice
Represents the price per unit before any discounting is applied.
": "{Decimal}"Currency
Three character code following the ISO 4217 standard
": "{String}",TargetAmount
The total item amount. Calculated by multiplying target price with quantity.
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",TargetAmount
Total gross amount in company currency.
": "{Decimal}"Seller
Reference to the seller of the item
": {EmployeeId
Employee identifier
": "{Integer}",EmployeeLink
Employee reference
": "{String}"MeasurementUnitId
Measurement unit identifier
": "{Integer}",Unit
Measurement unit (ex. mm, km, dl, kg)
": "{String}",Precision
The precision/accuracy of the measurement (number of decimals)
": "{Integer}",MeasurementUnitLink
Material unit reference
": "{String}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",CountryOfOriginCode
Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.
": "{String}",CustomField1
Custom field for grouping, sorting, categorizing and other purposes.
": "{String}",CustomField2
Custom field for grouping, sorting, categorizing and other purposes.
": "{String}",StandardLeadTime
The expected lead time, in number of days, from ordering from supplier to delivery. 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}",Weight
The weight of the product in kilograms.
": "{Decimal}",ManufacturerId
Manufacturer identifier
": "{Integer}",ShortName
Shortname/code of the manufacturer
": "{String}",ManufacturerLink
Manufacturer reference
": "{String}"ProductClassificationId
Product classification identifier
": "{String}",ProductClassificationLink
Product classification reference
": "{String}",Revision
Revision number
": "{String}"ProductLink
Product reference
": "{String}"ProductStructureId
Product structure reference
": "{Integer}",ProductStructureLink
Product structure reference
": "{String}"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.
Possible domain values can be found here
": "{String}",PurchasePrice
Purchase price for each unit
": "{Decimal}",Freight
Estimated freight cost of getting each unit in stock. Used for calculating landed cost.
": "{Decimal}",Duty
Duty cost of getting each unit in stock. Used for calculating landed cost.
": "{Decimal}",Charge
Other costs of getting each unit in stock. Used for calculating landed cost.
": "{Decimal}",GrossPrice
Total cost (landed cost or true cost) of getting each unit in stock, including purchase price, duties, charges, freight etc.
": "{Decimal}",PurchaseExchangeRate
Exchange rate between document currency and purchase currency. Used in landed cost calculations.
": "{Decimal}",IsDerivedFromPreferredPurchasePrice
True if the landed cost for this item is derived from preferred purchase price. This means that parts (or all) of the item has not reserved goods in stock, nor incoming goods (supplier backlog or production backlog).
": "{Boolean}",PurchaseQuoteItemId
Purchase quote item identifier
": "{Integer}",Database
Database of the object
": "{String}",PurchaseQuoteId
Purchase quote identifier
": "{Integer}",PurchaseQuoteLink
Purchase quote reference
": "{String}"PurchaseQuoteItemLink
Purchase quote item link
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",PurchasePrice
Purchase price in sales currency.
": "{Decimal}",Freight
Freigth cost in sales currency.
": "{Decimal}",Duty
Duty costs in sales currency.
": "{Decimal}",Charge
Other cost in sales currency
": "{Decimal}",GrossPrice
Total cost (landed cost or true cost) in sales currency
": "{Decimal}",OpenForwardedQuantity
When items are forwarded they end up in one or more open items. Open items in this context means items that are not registered (status 0 or 1). OpenForwardedQuantity will be the sum of ForwardedQuantity of all items this item has been forwarded to.
": "{Decimal}",ItemId
Identifier of the object
": "{Integer}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}"RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ItemLink
API reference to the item
": "{String}"NotificationId
Notification identifier
": "{Integer}",Status
Status of the notification
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Message
The message from the notification definition, expanded with parameters.
": "{String}",TranslatedMessage
The translated message from the notification definition, expanded with parameters.
": "{String}",NotificationTypeId
Notification type identifier
": "{String}",Category
Category of notification type (warning, information etc)
Possible domain values can be found here
": "{String}",NotificationTypeLink
Notification type reference
": "{String}"NotificationLink
Notification reference
": "{String}",ProjectOrderId
Project order identifier
": "{Integer}",ProjectOrderLink
Project order reference
": "{String}"
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 102120 HTTP 404 | Delivery project not found |
| Error 105969 HTTP 400 | Start date is required |
| Error 105970 HTTP 400 | End date is required |
| Error 102189 HTTP 400 | Missing mandatory parameter for goods reception item id |
| Error 103479 HTTP 400 | Expiration date is in conflict with existing effective date of another item |
| Error 108844 HTTP 400 | Manufacturer part number is not active on the product |
| Error 102115 HTTP 400 | All purchase price conversion fields must be blanked, or all must be filled in |
| Error 100167 HTTP 404 | Measurement unit not found |
| Error 102116 HTTP 400 | Selected measurement unit is not activated in your system |
| Error 102112 HTTP 400 | Purchase price can not be set when using price convesrsion by measurement units |
| Error 103478 HTTP 400 | Purchase price is required |
| Error 102109 HTTP 400 | Supplier is required |
| Error 100047 HTTP 404 | Supplier not found |
| Error 101097 HTTP 404 | Given currency {0} mismatch with currencies of supplier {1} |
| 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 109539 HTTP 400 | Dimension value {0} could not be used : Check its FromPeriod and ToPeriod. |
| Error 102486 HTTP 400 | Invalid value for dimension {0} |