API

Sales APIs

POST sales/quote-requests/{salesQuoteRequestId}/items

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.

Format:
1
<SalesQuoteRequestItem>
2
     <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

This field is optional.

>{Date}</RequestedDeliveryDate>
3
     <CustomersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

This field is optional.

>{String}</CustomersReferenceNumber>
4
     <CustomersProductName
CustomersProductName

Customers internal name of the product. Retrieved from the product.

This field is optional.

>{String}</CustomersProductName>
5
     <EquivalentProductName
EquivalentProductName

Name of product with equivalent behavior and attributes. Can be used for same purpose.

This field is optional.

>{String}</EquivalentProductName>
6
     <RequestedProductStructureRevision
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>
7
     <ProductDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

This field is optional.

>{String}</ProductDescription>
8
     <Note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

This field is optional.

>{String}</Note>
9
     <Quantity
Quantity

Required/mandatory field

Number of units requested quote for

Minimum value: 0

>{Decimal}</Quantity>
10
     <Price
Price

This field is optional.

>
11
          <TargetPrice
TargetPrice

The net price as requested by the customer

Minimum value: 0

This field is optional.

>{Decimal}</TargetPrice>
12
     </Price>
13
     <Seller
Seller

Reference to the seller of the item

This field is optional.

>
14
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
15
     </Seller>
16
     <Product>
17
          <ProductId
ProductId

Required/mandatory field

Product identifier

Minimum value: 10000

>{Integer}</ProductId>
18
     </Product>
19
</SalesQuoteRequestItem>
1
{
2
     "salesQuoteRequestItem": {
3
          "requestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

This field is optional.

": "{Date}",
4
          "customersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

This field is optional.

": "{String}",
5
          "customersProductName
CustomersProductName

Customers internal name of the product. Retrieved from the product.

This field is optional.

": "{String}",
6
          "equivalentProductName
EquivalentProductName

Name of product with equivalent behavior and attributes. Can be used for same purpose.

This field is optional.

": "{String}",
7
          "requestedProductStructureRevision
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}",
8
          "productDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

This field is optional.

": "{String}",
9
          "note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

This field is optional.

": "{String}",
10
          "quantity
Quantity

Required/mandatory field

Number of units requested quote for

Minimum value: 0

": "{Decimal}",
11
          "price
Price

This field is optional.

": {
12
               "targetPrice
TargetPrice

The net price as requested by the customer

Minimum value: 0

This field is optional.

": "{Decimal}"
13
          },
14
          "seller
Seller

Reference to the seller of the item

This field is optional.

": {
15
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
16
          },
17
          "product": {
18
               "productId
ProductId

Required/mandatory field

Product identifier

Minimum value: 10000

": "{Integer}"
19
          }
20
     }
21
}

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.
$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.

Format:
1
1

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 105932 HTTP 400 From quantity should be greater than 0
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}