Procurement APIs
Creates a new item in the provided purchase order response
| HTTP method | POST |
| URI | https://api.rambase.net/procurement/order-responses/{purchaseOrderResponseId}/items |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {purchaseOrderResponseId} |
Purchase order response identifier
Integer, minimum 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 3049, version 9 |
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.
RequestedDeliveryDate
Required/mandatory field
The delivery date as requested by the buyer/purchaser
>{Date}</RequestedDeliveryDate>ScheduledShippingDateToSupplier
Shceduled date of shipping goods or material to supplier for external work.
This field is optional.
>{Date}</ScheduledShippingDateToSupplier>ConfirmedDeliveryDate
Confirmed delivery date
This field is optional.
>{Date}</ConfirmedDeliveryDate>SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
This field is optional.
>{String}</SuppliersReferenceNumber>SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
This field is optional.
>{String}</SuppliersProductName>EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
This field is optional.
>{String}</EquivalentProductName>ProductStructureRevision
The requested revision of the product structure
This field is optional.
>{String}</ProductStructureRevision>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>Quantity
Required/mandatory field
Quantity of the purchase order response item
Minimum value: 0
>{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.
This field is optional.
>{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.
Default value: False
This field is optional.
>{Boolean}</RequireSerialNumberAtGoodsReception>Price
This field is optional.
>NetPrice
Final price per unit after deducting all discounts etc.
Minimum value: 0
This field is optional.
>{Decimal}</NetPrice>Freight
Estimated freight for including expected freight cost in the gross margin calculation in sales orders, sales invoices etc.
Minimum value: 0
This field is optional.
>{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.
Minimum value: 0
Maximum value: 100
This field is optional.
>{Decimal}</FreightPercent>ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
>{Integer}</ProductId>ManufacturersProduct
This field is optional.
>ManufacturersProductId
Manufacturer product identifier
Minimum value: 100000
This field is optional.
>{Integer}</ManufacturersProductId>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>RequestedDeliveryDate
Required/mandatory field
The delivery date as requested by the buyer/purchaser
": "{Date}",ScheduledShippingDateToSupplier
Shceduled date of shipping goods or material to supplier for external work.
This field is optional.
": "{Date}",ConfirmedDeliveryDate
Confirmed delivery date
This field is optional.
": "{Date}",SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
This field is optional.
": "{String}",SuppliersProductName
Suppliers 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}",ProductStructureRevision
The requested revision 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}",Quantity
Required/mandatory field
Quantity of the purchase order response item
Minimum value: 0
": "{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.
This field is optional.
": "{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.
Default value: False
This field is optional.
": "{Boolean}",Price
This field is optional.
": {NetPrice
Final price per unit after deducting all discounts etc.
Minimum value: 0
This field is optional.
": "{Decimal}",Freight
Estimated freight for including expected freight cost in the gross margin calculation in sales orders, sales invoices etc.
Minimum value: 0
This field is optional.
": "{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.
Minimum value: 0
Maximum value: 100
This field is optional.
": "{Decimal}"ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
": "{Integer}"ManufacturersProduct
This field is optional.
": {ManufacturersProductId
Manufacturer product 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}"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.
PurchaseOrderResponseItemId
Item-/linenumber of purchase order response
>{Integer}</PurchaseOrderResponseItemId>Status
Status of the purchase order response 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>ConfirmedDeliveryDate
Confirmed delivery date
>{Date}</ConfirmedDeliveryDate>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>ProductStructureRevision
The requested revision of the product structure
>{String}</ProductStructureRevision>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
Quantity of the purchase order response item
>{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
>EarliestConsumptionDate
The earliest date that these items can be used or consumed based upon the stock assignment with the earliest production date if it is linked to a production work order, or if it is linked to a sales order, the earliest requested date on the linked sales orders.
>{Date}</EarliestConsumptionDate>EarliestConsumptionDays
The deviation between Earliest consumption date and Confirmed delivery date, or Requested delivery date if no delivery date is confirmed by the supplier.
>{Integer}</EarliestConsumptionDays>LatestConsumptionDate
The earliest date that these items can be used or consumed based upon the stock assignment with the latest production date if it is linked to a production work order, or if it is linked to a sales order, the latest requested date on the linked sales orders.
>{Date}</LatestConsumptionDate>LatestConsumptionDays
The deviation between Latest consumption date and Confirmed delivery date, or Requested delivery date if no delivery date is confirmed by the supplier.
>{Integer}</LatestConsumptionDays>PercentUnassigned
Remaining production available in percent
>{Decimal}</PercentUnassigned>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>NetPrice
Final price per unit after deducting all discounts.
>{Decimal}</NetPrice>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetAmount
Final item amount after deducting all discounts etc.
>{Decimal}</NetAmount>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetAmount
Total net amount in company currency.
>{Decimal}</NetAmount>EmployeeId
Employee identifier
>{Integer}</EmployeeId>FirstName
First name of employee
>{String}</FirstName>LastName
Last name of employee
>{String}</LastName>EmployeeLink
Employee reference
>{String}</EmployeeLink>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>ManufacturersProductId
Manufacturer product identifier
>{Integer}</ManufacturersProductId>Name
Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).
>{String}</Name>ManufacturersProductLink
Manufacturers product reference
>{String}</ManufacturersProductLink>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>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>InitialBacklogItem
Purchase order reference this purchase order response item is created for
>ItemId
Item-number 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>ProjectOrderItemId
Project order item identifier
>{Integer}</ProjectOrderItemId>ProjectOrderId
Project order identifier
>{Integer}</ProjectOrderId>InitialOrderQuantity
Original total quantity of purchase order
>{Decimal}</InitialOrderQuantity>InitialOrderAmount
Original total amount of purchase order
>{Decimal}</InitialOrderAmount>RemainingOrderQuantity
Net quantity of purchase order
>{Decimal}</RemainingOrderQuantity>RemainingOrderAmount
Total net amount of purchase order
>{Decimal}</RemainingOrderAmount>ConfirmedQuantity
Total confirmed quantity
>{Decimal}</ConfirmedQuantity>ConfirmedAmount
Total confirmed amount
>{Decimal}</ConfirmedAmount>ReceivedQuantity
Total received quantity
>{Decimal}</ReceivedQuantity>ReceivedAmount
Total received amount
>{Decimal}</ReceivedAmount>InvoicedQuantity
Total invoiced quantity
>{Decimal}</InvoicedQuantity>InvoicedAmount
Total invoiced amount
>{Decimal}</InvoicedAmount>CanceledQuantity
Total canceled quantity
>{Decimal}</CanceledQuantity>CanceledAmount
Total canceled amount
>{Decimal}</CanceledAmount>ClosedWithoutInvoiceQuantity
Total no invoice quantity
>{Decimal}</ClosedWithoutInvoiceQuantity>ClosedWithoutInvoiceAmount
Total no invoice amount
>{Decimal}</ClosedWithoutInvoiceAmount>PurchaseOrderResponseItemId
Item-/linenumber of purchase order response
": "{Integer}",Status
Status of the purchase order response 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}",ConfirmedDeliveryDate
Confirmed delivery date
": "{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}",ProductStructureRevision
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
Quantity of the purchase order response item
": "{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
": {EarliestConsumptionDate
The earliest date that these items can be used or consumed based upon the stock assignment with the earliest production date if it is linked to a production work order, or if it is linked to a sales order, the earliest requested date on the linked sales orders.
": "{Date}",EarliestConsumptionDays
The deviation between Earliest consumption date and Confirmed delivery date, or Requested delivery date if no delivery date is confirmed by the supplier.
": "{Integer}",LatestConsumptionDate
The earliest date that these items can be used or consumed based upon the stock assignment with the latest production date if it is linked to a production work order, or if it is linked to a sales order, the latest requested date on the linked sales orders.
": "{Date}",LatestConsumptionDays
The deviation between Latest consumption date and Confirmed delivery date, or Requested delivery date if no delivery date is confirmed by the supplier.
": "{Integer}",PercentUnassigned
Remaining production available in percent
": "{Decimal}"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}",NetPrice
Final price per unit after deducting all discounts.
": "{Decimal}"Currency
Three character code following the ISO 4217 standard
": "{String}",NetAmount
Final item amount after deducting all discounts etc.
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",NetAmount
Total net amount in company currency.
": "{Decimal}",EmployeeId
Employee identifier
": "{Integer}",FirstName
First name of employee
": "{String}",LastName
Last name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"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}",ManufacturersProductId
Manufacturer product identifier
": "{Integer}",Name
Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).
": "{String}",ManufacturersProductLink
Manufacturers product 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}"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}"InitialBacklogItem
Purchase order reference this purchase order response item is created for
": {ItemId
Item-number 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}",ProjectOrderItemId
Project order item identifier
": "{Integer}",ProjectOrderId
Project order identifier
": "{Integer}"InitialOrderQuantity
Original total quantity of purchase order
": "{Decimal}",InitialOrderAmount
Original total amount of purchase order
": "{Decimal}",RemainingOrderQuantity
Net quantity of purchase order
": "{Decimal}",RemainingOrderAmount
Total net amount of purchase order
": "{Decimal}",ConfirmedQuantity
Total confirmed quantity
": "{Decimal}",ConfirmedAmount
Total confirmed amount
": "{Decimal}",ReceivedQuantity
Total received quantity
": "{Decimal}",ReceivedAmount
Total received amount
": "{Decimal}",InvoicedQuantity
Total invoiced quantity
": "{Decimal}",InvoicedAmount
Total invoiced amount
": "{Decimal}",CanceledQuantity
Total canceled quantity
": "{Decimal}",CanceledAmount
Total canceled amount
": "{Decimal}",ClosedWithoutInvoiceQuantity
Total no invoice quantity
": "{Decimal}",ClosedWithoutInvoiceAmount
Total no invoice amount
": "{Decimal}"
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 102529 HTTP 404 | RamBase event type not found |
| Error 105969 HTTP 400 | Start date is required |
| Error 105970 HTTP 400 | End date is required |
| Error 102747 HTTP 400 | Error in formula: {0} |
| Error 101050 HTTP 400 | Purchase Quote Item quantity needs to be increased |
| Error 101045 HTTP 400 | The purchase quote item needs to be activated |
| Error 101401 HTTP 400 | The Ship and debit purchase quote must be in the same database as the stock assignment |
| Error 101047 HTTP 400 | The purchase quote item has too low available quantity |
| Error 101400 HTTP 400 | Supplier credit claim has been created from shipping advice |
| 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} |