Procurement APIs
Creates a new item in provided purchase quote request.
| HTTP method | POST |
| URI | https://api.rambase.net/procurement/quote-requests/{purchaseQuoteRequestId}/items |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {purchaseQuoteRequestId} |
Purchase quote request identifier
Integer, minimum 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 2749, 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 buyer/purchaser
This field is optional.
>{Date}</RequestedDeliveryDate>SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
This field is optional.
>{String}</SuppliersProductName>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>Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
This field is optional.
>{String}</Note>Quantity
Required/mandatory field
Requested quantity for quote
Minimum value: 0
>{Decimal}</Quantity>Price
This field is optional.
>TargetPrice
The requested target price for this item
This field is optional.
>{Decimal}</TargetPrice>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>RequestedDeliveryDate
The delivery date as requested by the buyer/purchaser
This field is optional.
": "{Date}",SuppliersProductName
Suppliers 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}",Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
This field is optional.
": "{String}",Quantity
Required/mandatory field
Requested quantity for quote
Minimum value: 0
": "{Decimal}",Price
This field is optional.
": {TargetPrice
The requested target price for this item
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.
PurchaseQuoteRequestItemId
Purchase quote request item identifier
>{Integer}</PurchaseQuoteRequestItemId>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 buyer/purchaser
>{Date}</RequestedDeliveryDate>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>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>Quantity
Requested quantity for quote
>{Decimal}</Quantity>RemainingQuantity
Remaining number of units to be forwarded
>{Decimal}</RemainingQuantity>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>TargetPrice
The requested target price for this item
>{Decimal}</TargetPrice>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>TargetPrice
The requested target price for this item
>{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
The total item amount. Calculated by multiplying target price with quantity.
>{Decimal}</TargetAmount>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>CustomField1
Custom field for grouping, sorting, categorizing and other purposes.
>{String}</CustomField1>CustomField2
Custom field for grouping, sorting, categorizing and other purposes.
>{String}</CustomField2>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>Database
Database of the object
>{String}</Database>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>Status
Status of the sales item
>{Integer}</Status>Quantity
Quantity of the sales item
>{Decimal}</Quantity>Seller
Reference to the seller of the item
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>FirstName
First name of employee
>{String}</FirstName>LastName
Last name of employee
>{String}</LastName>EmployeeLink
Employee reference
>{String}</EmployeeLink>ObjectType
Type of object
>{String}</ObjectType>ObjectId
Identifier of the object
>{Integer}</ObjectId>RegistrationDate
Date of registration
>{Date}</RegistrationDate>Assignee
The user who has been assigned to work with this object.
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>CustomerLink
Customer reference
>{String}</CustomerLink>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>PurchaseQuoteRequestItemId
Purchase quote request item identifier
": "{Integer}",Status
Status of 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 buyer/purchaser
": "{Date}",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}",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}",Quantity
Requested quantity for quote
": "{Decimal}",RemainingQuantity
Remaining number of units to be forwarded
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",TargetPrice
The requested target price for this item
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",TargetPrice
The requested target price for this item
": "{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
The total item amount. Calculated by multiplying target price with quantity.
": "{Decimal}"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}",CustomField1
Custom field for grouping, sorting, categorizing and other purposes.
": "{String}",CustomField2
Custom field for grouping, sorting, categorizing and other purposes.
": "{String}",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}"Database
Database of the object
": "{String}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",Status
Status of the sales item
": "{Integer}",Quantity
Quantity of the sales item
": "{Decimal}",Seller
Reference to the seller of the item
": {EmployeeId
Employee identifier
": "{Integer}",FirstName
First name of employee
": "{String}",LastName
Last name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"ObjectType
Type of object
": "{String}",ObjectId
Identifier of the object
": "{Integer}",RegistrationDate
Date of registration
": "{Date}",Assignee
The user who has been assigned to work with this object.
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",CustomerLink
Customer reference
": "{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 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} |