API

Sales APIs

PUT sales/order-requests/{salesOrderRequestId}/items/{itemId}

Stores information about sales order item. All amounts should be in the currency of the sales order request. Note that Discount will be ignored when DiscountPercent is provided. Note also that Discount, DiscountPercent and GrossPrice will be ignored when GrossMargin is provided.

HTTP method PUT
URI https://api.rambase.net/sales/order-requests/{salesOrderRequestId}/items/{itemId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {salesOrderRequestId} Sales order request identifier
Integer, minimum 100000
- URI parameter {itemId} Sales order request item identifier
Integer, minimum 1
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 2118, version 16

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
<SalesOrderRequestItem
SalesOrderRequestItem

This field is optional.

>
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
     <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>
6
     <ProductDescription
ProductDescription

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

This field is optional.

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

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

This field is optional.

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

The quantity requested

Minimum value: 0

This field is optional.

>{Decimal}</Quantity>
9
     <IsBlockedForProduction
IsBlockedForProduction

True if a new production is not to be started automatically based on this sales order request item.

This field is optional.

>{Boolean}</IsBlockedForProduction>
10
     <EndCustomer
EndCustomer

End customer

This field is optional.

>
11
          <CustomerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

>{Integer}</CustomerId>
12
     </EndCustomer>
13
     <Price
Price

This field is optional.

>
14
          <ExpectedPrice
ExpectedPrice

The expected price received from the customer. This price will be rejected or accepted by the seller

Minimum value: 0

This field is optional.

>{Decimal}</ExpectedPrice>
15
     </Price>
16
     <Seller
Seller

Reference to the seller of the item

This field is optional.

>
17
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
18
     </Seller>
19
     <Product
Product

This field is optional.

>
20
          <ProductId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

>{Integer}</ProductId>
21
     </Product>
22
     <LandedCost
LandedCost

This field is optional.

>
23
          <PurchaseCurrency
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.

Applicable domain values can be found here

This field is optional.

>{String}</PurchaseCurrency>
24
          <PurchaseExchangeRate
PurchaseExchangeRate

Exchange rate between document currency and purchase currency. Used in landed cost calculations.

This field is optional.

>{Decimal}</PurchaseExchangeRate>
25
          <DerivedFrom
DerivedFrom

This field is optional.

>
26
               <PurchaseQuoteItemId
PurchaseQuoteItemId

Purchase quote item identifier

Minimum value: 1

This field is optional.

>{Integer}</PurchaseQuoteItemId>
27
               <PurchaseQuote
PurchaseQuote

This field is optional.

>
28
                    <Database
Database

Database of the object. If not provided the current database will be used.

This field is optional.

>{String}</Database>
29
                    <PurchaseQuoteId
PurchaseQuoteId

Purchase quote identifier

Minimum value: 10000

This field is optional.

>{Integer}</PurchaseQuoteId>
30
               </PurchaseQuote>
31
          </DerivedFrom>
32
     </LandedCost>
33
     <Accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

This field is optional.

>
34
          <VATCodeDefinition
VATCodeDefinition

This field is optional.

>
35
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

>{String}</VATCode>
36
          </VATCodeDefinition>
37
     </Accounting>
38
</SalesOrderRequestItem>
1
{
2
     "salesOrderRequestItem
SalesOrderRequestItem

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

The quantity requested

Minimum value: 0

This field is optional.

": "{Decimal}",
10
          "isBlockedForProduction
IsBlockedForProduction

True if a new production is not to be started automatically based on this sales order request item.

This field is optional.

": "{Boolean}",
11
          "endCustomer
EndCustomer

End customer

This field is optional.

": {
12
               "customerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
13
          },
14
          "price
Price

This field is optional.

": {
15
               "expectedPrice
ExpectedPrice

The expected price received from the customer. This price will be rejected or accepted by the seller

Minimum value: 0

This field is optional.

": "{Decimal}"
16
          },
17
          "seller
Seller

Reference to the seller of the item

This field is optional.

": {
18
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
19
          },
20
          "product
Product

This field is optional.

": {
21
               "productId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
22
          },
23
          "landedCost
LandedCost

This field is optional.

": {
24
               "purchaseCurrency
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.

Applicable domain values can be found here

This field is optional.

": "{String}",
25
               "purchaseExchangeRate
PurchaseExchangeRate

Exchange rate between document currency and purchase currency. Used in landed cost calculations.

This field is optional.

": "{Decimal}",
26
               "derivedFrom
DerivedFrom

This field is optional.

": {
27
                    "purchaseQuoteItemId
PurchaseQuoteItemId

Purchase quote item identifier

Minimum value: 1

This field is optional.

": "{Integer}",
28
                    "purchaseQuote
PurchaseQuote

This field is optional.

": {
29
                         "database
Database

Database of the object. If not provided the current database will be used.

This field is optional.

": "{String}",
30
                         "purchaseQuoteId
PurchaseQuoteId

Purchase quote identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
31
                    }
32
               }
33
          },
34
          "accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

This field is optional.

": {
35
               "vATCodeDefinition
VATCodeDefinition

This field is optional.

": {
36
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

": "{String}"
37
               }
38
          }
39
     }
40
}

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

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 101746 HTTP 404 Product structure not found. Id: {0}
Error 102267 HTTP 404 Product structure operation not found
Error 103838 HTTP 400 Recalculation failed. Missing location.
Error 103546 HTTP 400 Only product structures can be blocked for production
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 101517 HTTP 400 Illegal Account {0}: This account require ICTDB.
Error 102482 HTTP 400 Department is required for general ledger account {0}
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}