Sales APIs
Details about a specific item of a quote
HTTP method | GET |
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 | 2134, version 61 |
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 |
$format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
$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. |
$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. |
$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. |
$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.
SalesQuoteItemId
Sales quote item identifier
>{Integer}</SalesQuoteItemId>Status
Status of the sales 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>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.
>{Decimal}</GrossMargin>VATPercent
Value added tax percent
>{Decimal}</VATPercent>DiscountPercent
The discount in percent for this item.
>{Decimal}</DiscountPercent>Quantity
Number of units quoted
>{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.
>{Decimal}</BufferStockQuantity>RemainingQuantity
Remaining number of units to be forwarded.
>{Decimal}</RemainingQuantity>LeadTime
The lead time from ordering to delivery.
>{String}</LeadTime>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.
>ExpirationDate
The agreement will have an expiration date. Note that this date might be different from the validity expiration date of the sales 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>Discount
The discount for the item.
>{Decimal}</Discount>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>GrossAmount
Represents the item amount before any discounts etc. is applied.
>{Decimal}</GrossAmount>DiscountAmount
The items discount amount.
>{Decimal}</DiscountAmount>NetAmount
Final item amount after deducting all discounts etc.
>{Decimal}</NetAmount>RemainingAmount
Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice
>{Decimal}</RemainingAmount>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>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>IsNonStock
True if this is a non-physical product which are no using assignments from the assignment archive
>{Boolean}</IsNonStock>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>IsDerivedFromUserInput
True if landed cost is derived from manual user input. Landed cost can only be manually updated for products without assignments
>{Boolean}</IsDerivedFromUserInput>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>IsDerivedFromAssignedSupplierBacklog
True if landed cost for this item is derived from assigned supplier backlog. This means that the item has reserved incoming goods (supplier backlog or production backlog).
>{Boolean}</IsDerivedFromAssignedSupplierBacklog>IsDerivedFromAssignedStock
True if landed cost for this item is derived from assigned stock. This means that the item has reserved goods in stock.
>{Boolean}</IsDerivedFromAssignedStock>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>Accounting
Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.
>VATCode
Code that determines VAT rules used for VAT calculations.
>{String}</VATCode>GeneralLedgerAccountId
General ledger account identifier
>{Integer}</GeneralLedgerAccountId>GeneralLedgerAccountLink
General ledger account reference
>{String}</GeneralLedgerAccountLink>Department
The department related to the item. One of the system/fixed account dimensions.
>DepartmentId
Department identifier
>{Integer}</DepartmentId>DepartmentLink
Finance department reference
>{String}</DepartmentLink>FinanceProject
The finance project related to the item. One of the system/fixed account dimensions.
>FinanceProjectId
Finance project identifier
>{Integer}</FinanceProjectId>FinanceProjectLink
Finance project reference
>{String}</FinanceProjectLink>Asset
The asset related to the item. One of the system/fixed account dimensions.
>AssetId
Asset identifier
>{Integer}</AssetId>AssetLink
Asset reference
>{String}</AssetLink>InitialSalesOrderItem
Reference to the initial/first/original sales order item in the document flow for this item.
>SalesOrderItemId
Sales order item identifier
>{Integer}</SalesOrderItemId>SalesOrderId
Sales order identifier
>{Integer}</SalesOrderId>SalesOrderLink
Sales order reference
>{String}</SalesOrderLink>SalesOrderItemLink
Reference to the sales order item.
>{String}</SalesOrderItemLink>ForwardedFrom
The preceding/previous/source item.
>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>ForwardedNetAmount
The net amount forwarded to this item.
>{Decimal}</ForwardedNetAmount>ForwardedQuantity
The quantity forwarded to this item.
>{Decimal}</ForwardedQuantity>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>SalesQuoteItemId
Sales quote item identifier
": "{Integer}",Type
Item type
Possible domain values can be found here
": "{Integer}",Status
Status of the sales 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}",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.
": "{Decimal}",VATPercent
Value added tax percent
": "{Decimal}",DiscountPercent
The discount in percent for this item.
": "{Decimal}",Quantity
Number of units quoted
": "{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.
": "{Decimal}",RemainingQuantity
Remaining number of units to be forwarded.
": "{Decimal}",LeadTime
The lead time from ordering to delivery.
": "{String}",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.
": {ExpirationDate
The agreement will have an expiration date. Note that this date might be different from the validity expiration date of the sales quote.
": "{Date}"Currency
Three character code following the ISO 4217 standard
": "{String}",GrossPrice
Represents the price per unit before any discounting is applied.
": "{Decimal}",Discount
The discount for the item.
": "{Decimal}",NetPrice
Final price per unit after deducting all discounts etc.
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",GrossAmount
Represents the item amount before any discounts etc. is applied.
": "{Decimal}",DiscountAmount
The items discount amount.
": "{Decimal}",NetAmount
Final item amount after deducting all discounts etc.
": "{Decimal}",RemainingAmount
Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice
": "{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}",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}"IsNonStock
True if this is a non-physical product which are no using assignments from the assignment archive
": "{Boolean}"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}",IsDerivedFromUserInput
True if landed cost is derived from manual user input. Landed cost can only be manually updated for products without assignments
": "{Boolean}",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}",IsDerivedFromAssignedSupplierBacklog
True if landed cost for this item is derived from assigned supplier backlog. This means that the item has reserved incoming goods (supplier backlog or production backlog).
": "{Boolean}",IsDerivedFromAssignedStock
True if landed cost for this item is derived from assigned stock. This means that the item has reserved goods in stock.
": "{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}"Accounting
Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.
": {VATCode
Code that determines VAT rules used for VAT calculations.
": "{String}",GeneralLedgerAccountId
General ledger account identifier
": "{Integer}",GeneralLedgerAccountLink
General ledger account reference
": "{String}"Department
The department related to the item. One of the system/fixed account dimensions.
": {DepartmentId
Department identifier
": "{Integer}",DepartmentLink
Finance department reference
": "{String}"FinanceProject
The finance project related to the item. One of the system/fixed account dimensions.
": {FinanceProjectId
Finance project identifier
": "{Integer}",FinanceProjectLink
Finance project reference
": "{String}"Asset
The asset related to the item. One of the system/fixed account dimensions.
": {AssetId
Asset identifier
": "{Integer}",AssetLink
Asset reference
": "{String}"InitialSalesOrderItem
Reference to the initial/first/original sales order item in the document flow for this item.
": {SalesOrderItemId
Sales order item identifier
": "{Integer}",SalesOrderId
Sales order identifier
": "{Integer}",SalesOrderLink
Sales order reference
": "{String}"SalesOrderItemLink
Reference to the sales order item.
": "{String}"ForwardedFrom
The preceding/previous/source item.
": {Currency
Three character code following the ISO 4217 standard
": "{String}",ForwardedNetAmount
The net amount forwarded to this item.
": "{Decimal}",ForwardedQuantity
The quantity forwarded to this item.
": "{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}"
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 |
Error 101420 HTTP 404 | Setting definition not found |