RamBase REST APIs
Creates a new item in provided sales order. 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 | POST |
| URI | https://api.rambase.net/sales/orders/{salesOrderId}/items |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {salesOrderId} |
Sales order identifier
Integer, minimum 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 1903, version 27 |
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.
Type
Item type
Applicable domain values can be found here
This field is optional.
>{Integer}</Type>RequestedDeliveryDate
The delivery date as requested by the customer.
This field is optional.
>{Date}</RequestedDeliveryDate>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
Required/mandatory field
Number of units ordered
Minimum value: 0
>{Decimal}</Quantity>Warranty
This field is optional.
>WarrantyExpirationDate
Date of warranty expiration.
This field is optional.
>{Date}</WarrantyExpirationDate>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>ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
>{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>DerivedFrom
This field is optional.
>PurchaseQuoteItemId
Purchase quote item identifier
Minimum value: 1
This field is optional.
>{Integer}</PurchaseQuoteItemId>PurchaseQuote
This field is optional.
>PurchaseQuoteId
Purchase quote identifier
Minimum value: 100000
This field is optional.
>{Integer}</PurchaseQuoteId>RecurringInvoicing
This field is optional.
>StartDate
Start date of subscription or rental item
This field is optional.
>{Date}</StartDate>EstimatedEndDate
Expected end date of subscription or rental item
This field is optional.
>{Date}</EstimatedEndDate>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>Type
Item type
Applicable domain values can be found here
This field is optional.
": "{Integer}",RequestedDeliveryDate
The delivery date as requested by the customer.
This field is optional.
": "{Date}",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
Required/mandatory field
Number of units ordered
Minimum value: 0
": "{Decimal}",Warranty
This field is optional.
": {WarrantyExpirationDate
Date of warranty expiration.
This field is optional.
": "{Date}"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}"ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
": "{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}",DerivedFrom
This field is optional.
": {PurchaseQuoteItemId
Purchase quote item identifier
Minimum value: 1
This field is optional.
": "{Integer}",PurchaseQuote
This field is optional.
": {PurchaseQuoteId
Purchase quote identifier
Minimum value: 100000
This field is optional.
": "{Integer}"RecurringInvoicing
This field is optional.
": {StartDate
Start date of subscription or rental item
This field is optional.
": "{Date}",EstimatedEndDate
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. |
| $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.
SalesOrderItemId
Sales order item identifier
>{Integer}</SalesOrderItemId>Status
Status of the sales order item (0-9).
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>RequestedDeliveryDate
The delivery date as requested by the customer.
>{Date}</RequestedDeliveryDate>ConfirmedDeliveryDate
Confirmed date of delivery. Date of which the customer can expect the arriving goods
>{Date}</ConfirmedDeliveryDate>IsConfirmedDeliveryDateLocked
If confirmed delivery date in sales order item (COA) is locked, this date should not be re-calculated automatically.
>{Boolean}</IsConfirmedDeliveryDateLocked>ScheduledShippingDate
Date when the goods was/will be shipped from the warehouse.
>{Date}</ScheduledShippingDate>CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
>{String}</CustomersReferenceNumber>CustomersProductName
Customers internal name of the product. Retrieved from the product.
>{String}</CustomersProductName>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>GrossMargin
Gross margin of the item.
>{Decimal}</GrossMargin>VATPercent
Value added tax percent
>{Decimal}</VATPercent>DiscountPercent
The discount in percent for this item.
>{Decimal}</DiscountPercent>Quantity
Number of units ordered
>{Decimal}</Quantity>RemainingQuantity
Remaining number of units to be forwarded.
>{Decimal}</RemainingQuantity>ShippedQuantity
Quantity forwarded to one or more shipping advices
>{Decimal}</ShippedQuantity>AllocatedStockQuantity
The quantity of this item which do have assignments from stock
>{Decimal}</AllocatedStockQuantity>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.
>{Boolean}</RequireSerialNumberBeforeShipping>IsBlockedForProduction
True if a new production is not to be started automatically based on this sales order item.
>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>FirstName
Secondary name of a company or firstname of a person
>{String}</FirstName>VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).
>{String}</VATRegistrationNumber>CustomerLink
Customer reference
>{String}</CustomerLink>WarrantyExpirationDate
Date of warranty expiration.
>{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.
>{Boolean}</IsPaymentCoveredByWarranty>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>GrossPrice
Represents the price per unit before any discounting is applied.
>{Decimal}</GrossPrice>Discount
The discount for the item.
>{Decimal}</Discount>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>ExpectedPrice
The expected price from the sales order request item this sales order item was forwarded from.
>{Decimal}</ExpectedPrice>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>GrossPrice
Represents the price per unit before any discounting is applied.
>{Decimal}</GrossPrice>NetPrice
Final price per unit after deducting all discounts.
>{Decimal}</NetPrice>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>GrossAmount
Represents the item amount before any discounts etc. is applied.
>{Decimal}</GrossAmount>DiscountAmount
The items discount amount.
>{Decimal}</DiscountAmount>NetAmount
Final item amount after deducting all discounts etc.
>{Decimal}</NetAmount>RemainingAmount
Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice
>{Decimal}</RemainingAmount>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>GrossAmount
Total gross amount in company currency.
>{Decimal}</GrossAmount>NetAmount
Total net amount in company currency.
>{Decimal}</NetAmount>RemainingAmount
Total remaining amount in company currency.
>{Decimal}</RemainingAmount>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>Seller
Reference to the seller of the item
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>EmployeeLink
Employee reference
>{String}</EmployeeLink>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>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>StandardLeadTime
The expected lead time, in number of days, from ordering from supplier to delivery. Used in different purchase processes, typically when supplier is unknown. Note that this might differ from the standard lead times defined on the different suppliers.
>{Integer}</StandardLeadTime>Weight
The weight of the product in kilograms.
>{Decimal}</Weight>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>ShortName
Shortname/code of the manufacturer
>{String}</ShortName>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>ProductClassificationId
Product classification identifier
>{String}</ProductClassificationId>ProductClassificationLink
Product classification reference
>{String}</ProductClassificationLink>IsNonStock
True if this is a non-physical product which are no using assignments from the assignment archive
>{Boolean}</IsNonStock>Revision
Revision number
>{String}</Revision>ProductLink
Product reference
>{String}</ProductLink>ProductStructureId
Product structure reference
>{Integer}</ProductStructureId>ProductStructureLink
Product structure reference
>{String}</ProductStructureLink>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.
Possible domain values can be found here
>{String}</PurchaseCurrency>PurchasePrice
Purchase price for each unit
>{Decimal}</PurchasePrice>Freight
Estimated freight cost of getting each unit in stock. Used for calculating landed cost.
>{Decimal}</Freight>Duty
Duty cost of getting each unit in stock. Used for calculating landed cost.
>{Decimal}</Duty>Charge
Other costs of getting each unit in stock. Used for calculating landed cost.
>{Decimal}</Charge>GrossPrice
Total cost (landed cost or true cost) of getting each unit in stock, including purchase price, duties, charges, freight etc.
>{Decimal}</GrossPrice>PurchaseExchangeRate
Exchange rate between document currency and purchase currency. Used in landed cost calculations.
>{Decimal}</PurchaseExchangeRate>IsDerivedFromUserInput
True if landed cost is derived from manual user input. Landed cost can only be manually updated for products without assignments
>{Boolean}</IsDerivedFromUserInput>IsDerivedFromPreferredPurchasePrice
True if the landed cost for this item is derived from preferred purchase price. This means that parts (or all) of the item has not reserved goods in stock, nor incoming goods (supplier backlog or production backlog).
>{Boolean}</IsDerivedFromPreferredPurchasePrice>IsDerivedFromAssignedSupplierBacklog
True if landed cost for this item is derived from assigned supplier backlog. This means that the item has reserved incoming goods (supplier backlog or production backlog).
>{Boolean}</IsDerivedFromAssignedSupplierBacklog>IsDerivedFromAssignedStock
True if landed cost for this item is derived from assigned stock. This means that the item has reserved goods in stock.
>{Boolean}</IsDerivedFromAssignedStock>PurchaseQuoteItemId
Purchase quote item identifier
>{Integer}</PurchaseQuoteItemId>Database
Database of the object
>{String}</Database>PurchaseQuoteId
Purchase quote identifier
>{Integer}</PurchaseQuoteId>PurchaseQuoteLink
Purchase quote reference
>{String}</PurchaseQuoteLink>PurchaseQuoteItemLink
Purchase quote item link
>{String}</PurchaseQuoteItemLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>PurchasePrice
Purchase price in sales currency.
>{Decimal}</PurchasePrice>Freight
Freigth cost in sales currency.
>{Decimal}</Freight>Duty
Duty costs in sales currency.
>{Decimal}</Duty>Charge
Other cost in sales currency
>{Decimal}</Charge>GrossPrice
Total cost (landed cost or true cost) in sales currency
>{Decimal}</GrossPrice>Accounting
Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.
>VATCode
Code that determines VAT rules used for VAT calculations.
>{String}</VATCode>GeneralLedgerAccountId
General ledger account identifier
>{Integer}</GeneralLedgerAccountId>GeneralLedgerAccountLink
General ledger account reference
>{String}</GeneralLedgerAccountLink>Department
The department related to the item. One of the system/fixed account dimensions.
>DepartmentId
Department identifier
>{Integer}</DepartmentId>DepartmentLink
Finance department reference
>{String}</DepartmentLink>FinanceProject
The finance project related to the item. One of the system/fixed account dimensions.
>FinanceProjectId
Finance project identifier
>{Integer}</FinanceProjectId>FinanceProjectLink
Finance project reference
>{String}</FinanceProjectLink>Asset
The asset related to the item. One of the system/fixed account dimensions.
>AssetId
Asset identifier
>{Integer}</AssetId>AssetLink
Asset reference
>{String}</AssetLink>InitialSalesOrderItem
Reference to the initial/first/original sales order item in the document flow for this item.
>SalesOrderItemId
Sales order item identifier
>{Integer}</SalesOrderItemId>SalesOrderId
Sales order identifier
>{Integer}</SalesOrderId>SalesOrderLink
Sales order reference
>{String}</SalesOrderLink>SalesOrderItemLink
Reference to the sales order item.
>{String}</SalesOrderItemLink>ForwardedFrom
The preceding/previous/source item.
>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>ForwardedNetAmount
The net amount forwarded to this item.
>{Decimal}</ForwardedNetAmount>ForwardedQuantity
The quantity forwarded to this item.
>{Decimal}</ForwardedQuantity>CausedBy
States who has requested the change of the sales order.
Possible domain values can be found here
>{String}</CausedBy>ChangeReason
States the reason why the sales order item was forwarded
Possible domain values can be found here
>{String}</ChangeReason>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>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>DeviationId
Deviation identifier
>{Integer}</DeviationId>Database
Database of the object
>{String}</Database>DeviationTypeId
Deviation definition identifier
>{Integer}</DeviationTypeId>GoodsHandling
Specifies how the goods should be handled
Possible domain values can be found here
>{Integer}</GoodsHandling>AccountingHandling
Specifies how accounting should handle the deviation
Possible domain values can be found here
>{Integer}</AccountingHandling>InterCompanyHandling
Specifies how the deviation should be handled in the inter company trading.
Possible domain values can be found here
>{Integer}</InterCompanyHandling>LandedCostCalculation
Specifies how landed cost should be calculated.
Possible domain values can be found here
>{Integer}</LandedCostCalculation>DeviationTypeLink
Deviation definition reference
>{String}</DeviationTypeLink>DeviationLink
Deviation reference
>{String}</DeviationLink>SalesForecastId
Sales forecast identifier
>{Integer}</SalesForecastId>SalesForecastLink
Sales forecast reference
>{String}</SalesForecastLink>StartDate
Start date of subscription or rental item
>{Date}</StartDate>ExpectedEndDate
Expected end date of subscription or rental item
>{Date}</ExpectedEndDate>PriceChangeAgreement
Defines if and how the recurring price can be updated
Possible domain values can be found here
>{Integer}</PriceChangeAgreement>EstimatedAmount
Estimated amount of rental or subscription item
>{Decimal}</EstimatedAmount>RecurringPriceId
Recurring price indentifier
>{Integer}</RecurringPriceId>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>PriceInterval
Interval of recurring price
Possible domain values can be found here
>{Integer}</PriceInterval>HasOneTimeFee
Boolean indicating if the recurring price has a one-time fee.
>{Boolean}</HasOneTimeFee>HasUsageStep
Boolean indicating if the recurring price has any usage steps.
>{Boolean}</HasUsageStep>RecurringPriceLink
Recurring price reference
>{String}</RecurringPriceLink>Price
Value of a price step
>{Decimal}</Price>ProjectOrderId
Project order identifier
>{Integer}</ProjectOrderId>ProjectOrderLink
Project order reference
>{String}</ProjectOrderLink>ProjectOrderItemId
Project order item identifier
>{Integer}</ProjectOrderItemId>ProjectOrderItemLink
Reference to the project order item.
>{String}</ProjectOrderItemLink>Field
Field to get value from in the other company sales order
Possible domain values can be found here
>{String}</Field>Value
Value for the field from the sales order in the other company
>{String}</Value>SalesOrderId
Sales order identifier
>{Integer}</SalesOrderId>SalesOrderItemId
Sales order item identifier
": "{Integer}",Type
Item type
Possible domain values can be found here
": "{Integer}",Status
Status of the sales order item (0-9).
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 customer.
": "{Date}",ConfirmedDeliveryDate
Confirmed date of delivery. Date of which the customer can expect the arriving goods
": "{Date}",IsConfirmedDeliveryDateLocked
If confirmed delivery date in sales order item (COA) is locked, this date should not be re-calculated automatically.
": "{Boolean}",ScheduledShippingDate
Date when the goods was/will be shipped from the warehouse.
": "{Date}",CustomersReferenceNumber
Customers item reference number. Typically to the customers internal system.
": "{String}",CustomersProductName
Customers 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}",GrossMargin
Gross margin of the item.
": "{Decimal}",VATPercent
Value added tax percent
": "{Decimal}",DiscountPercent
The discount in percent for this item.
": "{Decimal}",Quantity
Number of units ordered
": "{Decimal}",RemainingQuantity
Remaining number of units to be forwarded.
": "{Decimal}",ShippedQuantity
Quantity forwarded to one or more shipping advices
": "{Decimal}",AllocatedStockQuantity
The quantity of this item which do have assignments from stock
": "{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.
": "{Boolean}",IsBlockedForProduction
True if a new production is not to be started automatically based on this sales order item.
": {CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",FirstName
Secondary name of a company or firstname of a person
": "{String}",VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).
": "{String}",CustomerLink
Customer reference
": "{String}"WarrantyExpirationDate
Date of warranty expiration.
": "{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.
": "{Boolean}"Currency
Three character code following the ISO 4217 standard
": "{String}",GrossPrice
Represents the price per unit before any discounting is applied.
": "{Decimal}",Discount
The discount for the item.
": "{Decimal}",NetPrice
Final price per unit after deducting all discounts etc.
": "{Decimal}",ExpectedPrice
The expected price from the sales order request item this sales order item was forwarded from.
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",GrossPrice
Represents the price per unit before any discounting is applied.
": "{Decimal}",NetPrice
Final price per unit after deducting all discounts.
": "{Decimal}"Currency
Three character code following the ISO 4217 standard
": "{String}",GrossAmount
Represents the item amount before any discounts etc. is applied.
": "{Decimal}",DiscountAmount
The items discount amount.
": "{Decimal}",NetAmount
Final item amount after deducting all discounts etc.
": "{Decimal}",RemainingAmount
Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",GrossAmount
Total gross amount in company currency.
": "{Decimal}",NetAmount
Total net amount in company currency.
": "{Decimal}",RemainingAmount
Total remaining amount in company currency.
": "{Decimal}"ShortName
Unique abbreviation/short name of the location
": "{String}"Seller
Reference to the seller of the item
": {EmployeeId
Employee identifier
": "{Integer}",EmployeeLink
Employee reference
": "{String}"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}",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}",StandardLeadTime
The expected lead time, in number of days, from ordering from supplier to delivery. Used in different purchase processes, typically when supplier is unknown. Note that this might differ from the standard lead times defined on the different suppliers.
": "{Integer}",Weight
The weight of the product in kilograms.
": "{Decimal}",ManufacturerId
Manufacturer identifier
": "{Integer}",ShortName
Shortname/code of the manufacturer
": "{String}",ManufacturerLink
Manufacturer reference
": "{String}"ProductClassificationId
Product classification identifier
": "{String}",ProductClassificationLink
Product classification reference
": "{String}"IsNonStock
True if this is a non-physical product which are no using assignments from the assignment archive
": "{Boolean}",Revision
Revision number
": "{String}"ProductLink
Product reference
": "{String}"ProductStructureId
Product structure reference
": "{Integer}",ProductStructureLink
Product structure reference
": "{String}"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.
Possible domain values can be found here
": "{String}",PurchasePrice
Purchase price for each unit
": "{Decimal}",Freight
Estimated freight cost of getting each unit in stock. Used for calculating landed cost.
": "{Decimal}",Duty
Duty cost of getting each unit in stock. Used for calculating landed cost.
": "{Decimal}",Charge
Other costs of getting each unit in stock. Used for calculating landed cost.
": "{Decimal}",GrossPrice
Total cost (landed cost or true cost) of getting each unit in stock, including purchase price, duties, charges, freight etc.
": "{Decimal}",PurchaseExchangeRate
Exchange rate between document currency and purchase currency. Used in landed cost calculations.
": "{Decimal}",IsDerivedFromUserInput
True if landed cost is derived from manual user input. Landed cost can only be manually updated for products without assignments
": "{Boolean}",IsDerivedFromPreferredPurchasePrice
True if the landed cost for this item is derived from preferred purchase price. This means that parts (or all) of the item has not reserved goods in stock, nor incoming goods (supplier backlog or production backlog).
": "{Boolean}",IsDerivedFromAssignedSupplierBacklog
True if landed cost for this item is derived from assigned supplier backlog. This means that the item has reserved incoming goods (supplier backlog or production backlog).
": "{Boolean}",IsDerivedFromAssignedStock
True if landed cost for this item is derived from assigned stock. This means that the item has reserved goods in stock.
": "{Boolean}",PurchaseQuoteItemId
Purchase quote item identifier
": "{Integer}",Database
Database of the object
": "{String}",PurchaseQuoteId
Purchase quote identifier
": "{Integer}",PurchaseQuoteLink
Purchase quote reference
": "{String}"PurchaseQuoteItemLink
Purchase quote item link
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",PurchasePrice
Purchase price in sales currency.
": "{Decimal}",Freight
Freigth cost in sales currency.
": "{Decimal}",Duty
Duty costs in sales currency.
": "{Decimal}",Charge
Other cost in sales currency
": "{Decimal}",GrossPrice
Total cost (landed cost or true cost) in sales currency
": "{Decimal}"Accounting
Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.
": {VATCode
Code that determines VAT rules used for VAT calculations.
": "{String}"GeneralLedgerAccountId
General ledger account identifier
": "{Integer}",GeneralLedgerAccountLink
General ledger account reference
": "{String}"Department
The department related to the item. One of the system/fixed account dimensions.
": {DepartmentId
Department identifier
": "{Integer}",DepartmentLink
Finance department reference
": "{String}"FinanceProject
The finance project related to the item. One of the system/fixed account dimensions.
": {FinanceProjectId
Finance project identifier
": "{Integer}",FinanceProjectLink
Finance project reference
": "{String}"Asset
The asset related to the item. One of the system/fixed account dimensions.
": {AssetId
Asset identifier
": "{Integer}",AssetLink
Asset reference
": "{String}"InitialSalesOrderItem
Reference to the initial/first/original sales order item in the document flow for this item.
": {SalesOrderItemId
Sales order item identifier
": "{Integer}",SalesOrderId
Sales order identifier
": "{Integer}",SalesOrderLink
Sales order reference
": "{String}"SalesOrderItemLink
Reference to the sales order item.
": "{String}"ForwardedFrom
The preceding/previous/source item.
": {Currency
Three character code following the ISO 4217 standard
": "{String}",ForwardedNetAmount
The net amount forwarded to this item.
": "{Decimal}",ForwardedQuantity
The quantity forwarded to this item.
": "{Decimal}",CausedBy
States who has requested the change of the sales order.
Possible domain values can be found here
": "{String}",ChangeReason
States the reason why the sales order item was forwarded
Possible domain values can be found here
": "{String}",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
Possible domain values can be found here
": "{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}"DeviationId
Deviation identifier
": "{Integer}",Database
Database of the object
": "{String}",DeviationTypeId
Deviation definition identifier
": "{Integer}",Category
Type of deviation
Possible domain values can be found here
": "{Integer}",GoodsHandling
Specifies how the goods should be handled
Possible domain values can be found here
": "{Integer}",AccountingHandling
Specifies how accounting should handle the deviation
Possible domain values can be found here
": "{Integer}",InterCompanyHandling
Specifies how the deviation should be handled in the inter company trading.
Possible domain values can be found here
": "{Integer}",LandedCostCalculation
Specifies how landed cost should be calculated.
Possible domain values can be found here
": "{Integer}",DeviationTypeLink
Deviation definition reference
": "{String}"DeviationLink
Deviation reference
": "{String}"SalesForecastId
Sales forecast identifier
": "{Integer}",SalesForecastLink
Sales forecast reference
": "{String}",StartDate
Start date of subscription or rental item
": "{Date}",ExpectedEndDate
Expected end date of subscription or rental item
": "{Date}",PriceChangeAgreement
Defines if and how the recurring price can be updated
Possible domain values can be found here
": "{Integer}",EstimatedAmount
Estimated amount of rental or subscription item
": "{Decimal}",RecurringPriceId
Recurring price indentifier
": "{Integer}",Currency
Three character code following the ISO 4217 standard
": "{String}",PriceInterval
Interval of recurring price
Possible domain values can be found here
": "{Integer}",HasOneTimeFee
Boolean indicating if the recurring price has a one-time fee.
": "{Boolean}",HasUsageStep
Boolean indicating if the recurring price has any usage steps.
": "{Boolean}",RecurringPriceLink
Recurring price reference
": "{String}"Price
Value of a price step
": "{Decimal}"ProjectOrderId
Project order identifier
": "{Integer}",ProjectOrderLink
Project order reference
": "{String}",ProjectOrderItemId
Project order item identifier
": "{Integer}",ProjectOrderItemLink
Reference to the project order item.
": "{String}",Field
Field to get value from in the other company sales order
Possible domain values can be found here
": "{String}",Value
Value for the field from the sales order in the other company
": "{String}",SalesOrderId
Sales order identifier
": "{Integer}"
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 102556 HTTP 404 | RamBase event not found |
| Error 101205 HTTP 404 | Recurring sales quote item not found |
| Error 101254 HTTP 400 | Only articles with matching PARTNERID can be purchased from this supplier |
| Error 107812 HTTP 400 | End customer not found |
| Error 103343 HTTP 400 | Illegal update : Accountingperiod {0} is closed. |
| Error 103342 HTTP 400 | Illegal Update : Accountingperiod {0} has agio calculations. |
| Error 106493 HTTP 400 | Currencies of document and recurring price should always match |
| Error 105749 HTTP 400 | Recurring price type should be specified for subscription and rental items |
| Error 105784 HTTP 400 | Only subscription products can be added to subscription items |
| 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} |