Procurement APIs
Details about a specific item of an order
HTTP method | GET |
URI | https://api.rambase.net/procurement/orders/{purchaseOrderId}/items/{itemId} |
Supported formats | Xml, Html, Json (ex. $format=json) |
- URI parameter {purchaseOrderId} |
Purchase order identifier
Integer, minimum 100000 |
- URI parameter {itemId} |
Item-/line-number of the purchase order
Integer, minimum 1 |
Custom fields | Custom fields supported |
Successful HTTP status code | 200 |
API resource identifier | 3001, version 61 |
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.
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.
$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] |
$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 |
$format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
$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. |
$select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
$expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select 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.
PurchaseOrderItemId
Item-/line-number of the purchase order
>{Integer}</PurchaseOrderItemId>Status
Status code of the the purchase order item
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 buyer/purchaser
>{Date}</RequestedDeliveryDate>ScheduledShippingDateToSupplier
Shceduled date of shipping goods or material to supplier for external work.
>{Date}</ScheduledShippingDateToSupplier>SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
>{String}</SuppliersReferenceNumber>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 requested revision 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>VATPercent
Value added tax percent
>{Decimal}</VATPercent>Quantity
Number of units purchased
>{Decimal}</Quantity>HeatNumber
A heat number is an identification coupon number that is stamped on a material plate after it is removed from the ladle and rolled at a steel mill.
>{String}</HeatNumber>RequireSerialNumberAtGoodsReception
If all units of this product should have a serial number in stock, you should require serial number to be required at goods reception. This will ensure that serial number is specified before goods receptions with this product is registered.
>{Boolean}</RequireSerialNumberAtGoodsReception>RemainingQuantity
Remaining number of units to be forwarded
>{Decimal}</RemainingQuantity>AvailableQuantity
Quantity available/free for use. Not assigned to anything.
>{Decimal}</AvailableQuantity>ReservedQuantity
Quantity reserved from beeing assigned to other objects. Ex. quantity reserved to be used as spare parts, reserved for exhibitions and similar. The reserved quantity cannot be assigned to anything until the reservedquantity is released.
>{Decimal}</ReservedQuantity>ProductUnitMarkingSpecification
Describes how to mark the product unit
>{String}</ProductUnitMarkingSpecification>PurchaseGroupId
Purchase group identifier
>{Integer}</PurchaseGroupId>PurchaseGroupLink
Material unit reference
>{String}</PurchaseGroupLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>Freight
Estimated freight for including expected freight cost in the gross margin calculation in sales orders, sales invoices etc.
>{Decimal}</Freight>FreightPercent
Estimated freight in percent of net price. Used for including expected freight cost in the gross margin calculation in sales orders, sales invoices etc.
>{Decimal}</FreightPercent>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetAmount
Final item amount after deducting all discounts etc.
>{Decimal}</NetAmount>MeasurementUnitId
Material unit reference
>{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>Weight
The weight of the product in kilograms.
>{Decimal}</Weight>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>AutoCreateProductUnitAtGoodsReception
When activated, product units are automatically generated when goods are registered to stock.
>{Boolean}</AutoCreateProductUnitAtGoodsReception>ProductLink
Product reference
>{String}</ProductLink>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>ShortName
Shortname/code of the manufacturer
>{String}</ShortName>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>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>ForwardedFrom
The preceding/previous/source item.
>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>PurchaseOrderItemId
Item-/line-number of the purchase order
": "{Integer}",Status
Status code of the the purchase order 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}",ScheduledShippingDateToSupplier
Shceduled date of shipping goods or material to supplier for external work.
": "{Date}",SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
": "{String}",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 requested revision 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}",VATPercent
Value added tax percent
": "{Decimal}",Quantity
Number of units purchased
": "{Decimal}",HeatNumber
A heat number is an identification coupon number that is stamped on a material plate after it is removed from the ladle and rolled at a steel mill.
": "{String}",RequireSerialNumberAtGoodsReception
If all units of this product should have a serial number in stock, you should require serial number to be required at goods reception. This will ensure that serial number is specified before goods receptions with this product is registered.
": "{Boolean}",RemainingQuantity
Remaining number of units to be forwarded
": "{Decimal}",AvailableQuantity
Quantity available/free for use. Not assigned to anything.
": "{Decimal}",ReservedQuantity
Quantity reserved from beeing assigned to other objects. Ex. quantity reserved to be used as spare parts, reserved for exhibitions and similar. The reserved quantity cannot be assigned to anything until the reservedquantity is released.
": "{Decimal}",ProductUnitMarkingSpecification
Describes how to mark the product unit
": "{String}",PurchaseGroupId
Purchase group identifier
": "{Integer}",PurchaseGroupLink
Material unit reference
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",NetPrice
Final price per unit after deducting all discounts etc.
": "{Decimal}",Freight
Estimated freight for including expected freight cost in the gross margin calculation in sales orders, sales invoices etc.
": "{Decimal}",FreightPercent
Estimated freight in percent of net price. Used for including expected freight cost in the gross margin calculation in sales orders, sales invoices etc.
": "{Decimal}"Currency
Three character code following the ISO 4217 standard
": "{String}",NetAmount
Final item amount after deducting all discounts etc.
": "{Decimal}"MeasurementUnitId
Material unit reference
": "{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}",Weight
The weight of the product in kilograms.
": "{Decimal}"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}",AutoCreateProductUnitAtGoodsReception
When activated, product units are automatically generated when goods are registered to stock.
": "{Boolean}"ProductLink
Product reference
": "{String}"ManufacturerId
Manufacturer identifier
": "{Integer}",ShortName
Shortname/code of the manufacturer
": "{String}",ManufacturerLink
Manufacturer reference
": "{String}"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}"ForwardedFrom
The preceding/previous/source item.
": {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}"
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 100027 HTTP 400 | Missing mandatory parameter {0} |
Error 101420 HTTP 404 | Setting definition not found |