Sales APIs
Stores information about sales order item. All amounts should be in the currency of the sales order. Note that DiscountPercent will be ignored when Discount 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/orders/{salesOrderId}/items/{itemId} |
Supported formats | Xml, Html, Json (ex. $format=json) |
- URI parameter {salesOrderId} |
Sales order identifier
Integer, minimum 100000 |
- URI parameter {itemId} |
Sales order item identifier
Integer, minimum 1 |
Custom fields | Custom fields supported |
Successful HTTP status code | 200 |
API resource identifier | 1966, version 52 |
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.
SalesOrderItem
This field is optional.
>RequestedDeliveryDate
The delivery date as requested by the customer.
This field is optional.
>{Date}</RequestedDeliveryDate>ConfirmedDeliveryDate
Confirmed date of delivery. Date of which the customer can expect the arriving goods
This field is optional.
>{Date}</ConfirmedDeliveryDate>IsConfirmedDeliveryDateLocked
If confirmed delivery date in sales order item (COA) is locked, this date should not be re-calculated automatically.
This field is optional.
>{Boolean}</IsConfirmedDeliveryDateLocked>CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
This field is optional.
>{String}</CustomersReferenceNumber>CustomersProductName
Customers internal name of the product. Retrieved from the product.
This field is optional.
>{String}</CustomersProductName>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>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>GrossMargin
Gross margin of the item.
Minimum value: -100
Maximum value: 100
This field is optional.
>{Decimal}</GrossMargin>DiscountPercent
The discount in percent for this item.
Minimum value: 0
Maximum value: 100
This field is optional.
>{Decimal}</DiscountPercent>Quantity
Number of units ordered
Minimum value: 0
This field is optional.
>{Decimal}</Quantity>RequireSerialNumberBeforeShipping
True if serial number is required before shipping. Note that if the product has set this value to true, this can not be overridden.
This field is optional.
>{Boolean}</RequireSerialNumberBeforeShipping>IsBlockedForProduction
True if a new production is not to be started automatically based on this sales order item.
This field is optional.
>{Boolean}</IsBlockedForProduction>EndCustomer
End customer
This field is optional.
>CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
>{Integer}</CustomerId>Warranty
This field is optional.
>WarrantyExpirationDate
Date of warranty expiration.
This field is optional.
>{Date}</WarrantyExpirationDate>IsPaymentCoveredByWarranty
True if payment of item will be covered by warranty. For sales order items that are a part of the repair process, it means that these will not be invoiced.
This field is optional.
>{Boolean}</IsPaymentCoveredByWarranty>Price
This field is optional.
>GrossPrice
Represents the price per unit before any discounting is applied.
This field is optional.
>{Decimal}</GrossPrice>Discount
The discount for the item.
Minimum value: 0
This field is optional.
>{Decimal}</Discount>Location
This field is optional.
>LocationId
Location identifier
Minimum value: 10000
This field is optional.
>{Integer}</LocationId>Seller
Reference to the seller of the item
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>Product
This field is optional.
>ProductId
Product identifier
Minimum value: 10000
This field is optional.
>{Integer}</ProductId>LandedCost
This field is optional.
>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>PurchaseExchangeRate
Exchange rate between document currency and purchase currency. Used in landed cost calculations.
This field is optional.
>{Decimal}</PurchaseExchangeRate>PurchasePrice
Purchase price for each unit
Minimum value: 0
This field is optional.
>{Decimal}</PurchasePrice>DerivedFrom
This field is optional.
>PurchaseQuoteItemId
Purchase quote item identifier
Minimum value: 1
This field is optional.
>{Integer}</PurchaseQuoteItemId>PurchaseQuote
This field is optional.
>Database
Database of the object. If not provided the current database will be used.
This field is optional.
>{String}</Database>PurchaseQuoteId
Purchase quote identifier
Minimum value: 100000
This field is optional.
>{Integer}</PurchaseQuoteId>Accounting
Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.
This field is optional.
>VATCodeDefinition
This field is optional.
>VATCode
Code that determines VAT rules used for VAT calculations.
This field is optional.
>{String}</VATCode>ForwardedFrom
The preceding/previous/source item.
This field is optional.
>CausedBy
States who has requested the change of the sales order.
Applicable domain values can be found here
This field is optional.
>{String}</CausedBy>ChangeReason
States the reason why the sales order item was forwarded
Applicable domain values can be found here
This field is optional.
>{String}</ChangeReason>RecurringInvoicing
This field is optional.
>StartDate
Start date of subscription or rental item
This field is optional.
>{Date}</StartDate>ExpectedEndDate
Expected end date of subscription or rental item
This field is optional.
>{Date}</ExpectedEndDate>PriceChangeAgreement
Defines if and how the recurring price can be updated
Applicable domain values can be found here
This field is optional.
>{Integer}</PriceChangeAgreement>RecurringPrice
This field is optional.
>RecurringPriceId
Recurring price indentifier
Minimum value: 100000
This field is optional.
>{Integer}</RecurringPriceId>SalesOrderItem
This field is optional.
": {RequestedDeliveryDate
The delivery date as requested by the customer.
This field is optional.
": "{Date}",ConfirmedDeliveryDate
Confirmed date of delivery. Date of which the customer can expect the arriving goods
This field is optional.
": "{Date}",IsConfirmedDeliveryDateLocked
If confirmed delivery date in sales order item (COA) is locked, this date should not be re-calculated automatically.
This field is optional.
": "{Boolean}",CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
This field is optional.
": "{String}",CustomersProductName
Customers 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}",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}",GrossMargin
Gross margin of the item.
Minimum value: -100
Maximum value: 100
This field is optional.
": "{Decimal}",DiscountPercent
The discount in percent for this item.
Minimum value: 0
Maximum value: 100
This field is optional.
": "{Decimal}",Quantity
Number of units ordered
Minimum value: 0
This field is optional.
": "{Decimal}",RequireSerialNumberBeforeShipping
True if serial number is required before shipping. Note that if the product has set this value to true, this can not be overridden.
This field is optional.
": "{Boolean}",IsBlockedForProduction
True if a new production is not to be started automatically based on this sales order item.
This field is optional.
": "{Boolean}",EndCustomer
End customer
This field is optional.
": {CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Warranty
This field is optional.
": {WarrantyExpirationDate
Date of warranty expiration.
This field is optional.
": "{Date}",IsPaymentCoveredByWarranty
True if payment of item will be covered by warranty. For sales order items that are a part of the repair process, it means that these will not be invoiced.
This field is optional.
": "{Boolean}"Price
This field is optional.
": {GrossPrice
Represents the price per unit before any discounting is applied.
This field is optional.
": "{Decimal}",Discount
The discount for the item.
Minimum value: 0
This field is optional.
": "{Decimal}"Location
This field is optional.
": {LocationId
Location identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Seller
Reference to the seller of the item
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"Product
This field is optional.
": {ProductId
Product identifier
Minimum value: 10000
This field is optional.
": "{Integer}"LandedCost
This field is optional.
": {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}",PurchaseExchangeRate
Exchange rate between document currency and purchase currency. Used in landed cost calculations.
This field is optional.
": "{Decimal}",PurchasePrice
Purchase price for each unit
Minimum value: 0
This field is optional.
": "{Decimal}",DerivedFrom
This field is optional.
": {PurchaseQuoteItemId
Purchase quote item identifier
Minimum value: 1
This field is optional.
": "{Integer}",PurchaseQuote
This field is optional.
": {Database
Database of the object. If not provided the current database will be used.
This field is optional.
": "{String}",PurchaseQuoteId
Purchase quote identifier
Minimum value: 100000
This field is optional.
": "{Integer}"Accounting
Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.
This field is optional.
": {VATCodeDefinition
This field is optional.
": {VATCode
Code that determines VAT rules used for VAT calculations.
This field is optional.
": "{String}"ForwardedFrom
The preceding/previous/source item.
This field is optional.
": {CausedBy
States who has requested the change of the sales order.
Applicable domain values can be found here
This field is optional.
": "{String}",ChangeReason
States the reason why the sales order item was forwarded
Applicable domain values can be found here
This field is optional.
": "{String}"RecurringInvoicing
This field is optional.
": {StartDate
Start date of subscription or rental item
This field is optional.
": "{Date}",ExpectedEndDate
Expected end date of subscription or rental item
This field is optional.
": "{Date}",PriceChangeAgreement
Defines if and how the recurring price can be updated
Applicable domain values can be found here
This field is optional.
": "{Integer}",RecurringPrice
This field is optional.
": {RecurringPriceId
Recurring price indentifier
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. |
$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.
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 102733 HTTP 400 | Formula can not be empty |
Error 102750 HTTP 400 | Number of parameter values does not match the number of parameters in the formula |
Error 102749 HTTP 400 | Missing parameter value for parameter {0} |
Error 102747 HTTP 400 | Error in formula: {0} |
Error 103343 HTTP 400 | Illegal update : Accountingperiod {0} is closed. |
Error 103342 HTTP 400 | Illegal Update : Accountingperiod {0} has agio calculations. |
Error 106408 HTTP 403 | You have no permission to create subscription item in sales order |
Error 106957 HTTP 400 | Only rental or subscription products can be used in recurring contract's lines |
Error 106962 HTTP 400 | Product of this type (WP) cannot be added to this type of sales order |
Error 107055 HTTP 400 | The rental date can only be set back {0} days |
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} |