Procurement APIs
Creates a new item in provided purchase quote. Note that Freight will be ignored when FreightPercent is provided.
| HTTP method | POST |
| URI | https://api.rambase.net/procurement/quotes/{purchaseQuoteId}/items |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {purchaseQuoteId} |
Purchase quote identifier
Integer, minimum 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 2873, version 4 |
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.
SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
This field is optional.
>{String}</SuppliersProductName>SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
This field is optional.
>{String}</SuppliersReferenceNumber>EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
This field is optional.
>{String}</EquivalentProductName>ProductStructureRevision
The product structure revison the supplier can offer
This field is optional.
>{String}</ProductStructureRevision>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>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.
This field is optional.
>{String}</HeatNumber>Quantity
Required/mandatory field
Quantity of the purchase quote
Minimum value: 0
>{Decimal}</Quantity>LeadTime
The lead time, in number of days, from ordering to delivery.
Minimum value: 0
This field is optional.
>{Integer}</LeadTime>Resale
This field is optional.
>MinimumNetPrice
The minimum net price to use in sales order. Lower than 5% of this price will need approval before registering the sales order.
This field is optional.
>{Decimal}</MinimumNetPrice>ExclusivelyFor
Exclusevly for either customer, customer group or company
This field is optional.
>Database
Database of the object
This field is optional.
>{String}</Database>ObjectId
Identifier of the object
Minimum value: 100
This field is optional.
>{Integer}</ObjectId>ObjectType
Type of object
This field is optional.
>{String}</ObjectType>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.
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 purchase quote.
This field is optional.
>{Date}</ExpirationDate>Price
This field is optional.
>NetPrice
Final price per unit after deducting all discounts etc.
Minimum value: 0
This field is optional.
>{Decimal}</NetPrice>Freight
Estimated freight for including expected freight cost in the gross margin calculation in sales orders, sales invoices etc.
Minimum value: 0
This field is optional.
>{Decimal}</Freight>FreightPercent
Estimated freight in percent of net price. Used for including expected freight cost in the gross margin calculation in sales orders, sales invoices etc.
Minimum value: 0
Maximum value: 100
This field is optional.
>{Decimal}</FreightPercent>ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
>{Integer}</ProductId>ManufacturersProduct
This field is optional.
>ManufacturersProductId
Manufacturer product identifier
Minimum value: 100000
This field is optional.
>{Integer}</ManufacturersProductId>SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
This field is optional.
": "{String}",SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
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}",ProductStructureRevision
The product structure revison the supplier can offer
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}",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.
This field is optional.
": "{String}",Quantity
Required/mandatory field
Quantity of the purchase quote
Minimum value: 0
": "{Decimal}",LeadTime
The lead time, in number of days, from ordering to delivery.
Minimum value: 0
This field is optional.
": "{Integer}",Resale
This field is optional.
": {MinimumNetPrice
The minimum net price to use in sales order. Lower than 5% of this price will need approval before registering the sales order.
This field is optional.
": "{Decimal}",ExclusivelyFor
Exclusevly for either customer, customer group or company
This field is optional.
": {Database
Database of the object
This field is optional.
": "{String}",ObjectId
Identifier of the object
Minimum value: 100
This field is optional.
": "{Integer}",ObjectType
Type of object
This field is optional.
": "{String}"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.
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 purchase quote.
This field is optional.
": "{Date}"Price
This field is optional.
": {NetPrice
Final price per unit after deducting all discounts etc.
Minimum value: 0
This field is optional.
": "{Decimal}",Freight
Estimated freight for including expected freight cost in the gross margin calculation in sales orders, sales invoices etc.
Minimum value: 0
This field is optional.
": "{Decimal}",FreightPercent
Estimated freight in percent of net price. Used for including expected freight cost in the gross margin calculation in sales orders, sales invoices etc.
Minimum value: 0
Maximum value: 100
This field is optional.
": "{Decimal}"ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
": "{Integer}"ManufacturersProduct
This field is optional.
": {ManufacturersProductId
Manufacturer product identifier
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. |
| $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.
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>SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
>{String}</SuppliersReferenceNumber>SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
>{String}</SuppliersProductName>EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
>{String}</EquivalentProductName>ProductStructureRevision
The product structure revison the supplier can offer
>{String}</ProductStructureRevision>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>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>RemainingQuantity
Remaining number of units to be forwarded
>{Decimal}</RemainingQuantity>AvailableQuantity
Quantity available/free for use. Not assigned to anything.
>{Decimal}</AvailableQuantity>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>ExclusivelyFor
Exclusevly for either customer, customer group or company
>Database
Database of the object
>{String}</Database>ObjectId
Identifier of the object
>{Integer}</ObjectId>Name
Name retrieved from the object
>{String}</Name>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>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>Freight
Estimated freight for including expected freight cost in the gross margin calculation in sales orders, sales invoices etc.
>{Decimal}</Freight>FreightPercent
Estimated freight in percent of net price. Used for including expected freight cost in the gross margin calculation in sales orders, sales invoices etc.
>{Decimal}</FreightPercent>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetPrice
Final price per unit after deducting all discounts.
>{Decimal}</NetPrice>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetAmount
Final item amount after deducting all discounts etc.
>{Decimal}</NetAmount>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetAmount
Total net amount in company currency.
>{Decimal}</NetAmount>MeasurementUnitId
Material unit reference
>{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>ProductClassificationId
Product classification identifier
>{String}</ProductClassificationId>ProductClassificationLink
Product classification reference
>{String}</ProductClassificationLink>ProductLink
Product reference
>{String}</ProductLink>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>ShortName
Shortname/code of the manufacturer
>{String}</ShortName>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>ManufacturersProductId
Manufacturer product identifier
>{Integer}</ManufacturersProductId>Name
Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).
>{String}</Name>ManufacturersProductLink
Manufacturers product reference
>{String}</ManufacturersProductLink>ForwardedFrom
The preceding/previous/source item.
>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>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>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}",SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
": "{String}",SuppliersProductName
Suppliers 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}",ProductStructureRevision
The product structure revison the supplier can offer
": "{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}",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}",RemainingQuantity
Remaining number of units to be forwarded
": "{Decimal}",AvailableQuantity
Quantity available/free for use. Not assigned to anything.
": "{Decimal}",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}",ExclusivelyFor
Exclusevly for either customer, customer group or company
": {Database
Database of the object
": "{String}",ObjectId
Identifier of the object
": "{Integer}",Name
Name retrieved from the object
": "{String}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}"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}",Freight
Estimated freight for including expected freight cost in the gross margin calculation in sales orders, sales invoices etc.
": "{Decimal}",FreightPercent
Estimated freight in percent of net price. Used for including expected freight cost in the gross margin calculation in sales orders, sales invoices etc.
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",NetPrice
Final price per unit after deducting all discounts.
": "{Decimal}"Currency
Three character code following the ISO 4217 standard
": "{String}",NetAmount
Final item amount after deducting all discounts etc.
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",NetAmount
Total net amount in company currency.
": "{Decimal}"MeasurementUnitId
Material unit reference
": "{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}"ProductClassificationId
Product classification identifier
": "{String}",ProductClassificationLink
Product classification reference
": "{String}"ProductLink
Product reference
": "{String}"ManufacturerId
Manufacturer identifier
": "{Integer}",ShortName
Shortname/code of the manufacturer
": "{String}",ManufacturerLink
Manufacturer reference
": "{String}",ManufacturersProductId
Manufacturer product identifier
": "{Integer}",Name
Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).
": "{String}",ManufacturersProductLink
Manufacturers product reference
": "{String}"ForwardedFrom
The preceding/previous/source item.
": {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}"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}"
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 101746 HTTP 404 | Product structure not found. Id: {0} |
| Error 102633 HTTP 404 | Product structure cost element not found |
| Error 102746 HTTP 400 | The parameter value can not be more than {0} |
| Error 102747 HTTP 400 | Error in formula: {0} |
| Error 107762 HTTP 400 | Only product structures can auto create work orders for sub production |
| Error 107763 HTTP 400 | Only product structures can be set up for line production |
| Error 107764 HTTP 400 | Only product structures can be externally manufactured |
| Error 101047 HTTP 400 | The purchase quote item has too low available quantity |
| Error 101400 HTTP 400 | Supplier credit claim has been created from shipping advice |
| Error 102483 HTTP 400 | Finance project is required for general ledger account {0} |
| Error 102484 HTTP 400 | Asset is required for general ledger account {0} |
| Error 102485 HTTP 400 | Dimension {0} ({1}) is required for general ledger account {2} |
| 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} |