API

Procurement APIs

PUT procurement/orders/{purchaseOrderId}/items/{itemId}

Stores information about purchase order item. All amounts should be in the currency of the purchase order.

HTTP method PUT
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 3008, version 16

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<PurchaseOrderItem
PurchaseOrderItem

This field is optional.

>
2
     <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the buyer/purchaser

This field is optional.

>{Date}</RequestedDeliveryDate>
3
     <ScheduledShippingDateToSupplier
ScheduledShippingDateToSupplier

Shceduled date of shipping goods or material to supplier for external work.

This field is optional.

>{Date}</ScheduledShippingDateToSupplier>
4
     <SuppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers item reference number. Typically to an external system.

This field is optional.

>{String}</SuppliersReferenceNumber>
5
     <SuppliersProductName
SuppliersProductName

Suppliers internal name of the product. Retrieved from the product.

This field is optional.

>{String}</SuppliersProductName>
6
     <EquivalentProductName
EquivalentProductName

Name of product with equivalent behavior and attributes. Can be used for same purpose.

This field is optional.

>{String}</EquivalentProductName>
7
     <RequestedProductStructureRevision
RequestedProductStructureRevision

The requested revision of the product structure

This field is optional.

>{String}</RequestedProductStructureRevision>
8
     <ProductDescription
ProductDescription

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

This field is optional.

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

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

This field is optional.

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

Number of units purchased

Minimum value: 0

This field is optional.

>{Decimal}</Quantity>
11
     <HeatNumber
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>
12
     <RequireSerialNumberAtGoodsReception
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.

This field is optional.

>{Boolean}</RequireSerialNumberAtGoodsReception>
13
     <ReservedQuantity
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.

Minimum value: 0

This field is optional.

>{Decimal}</ReservedQuantity>
14
     <ProductUnitMarkingSpecification
ProductUnitMarkingSpecification

Describes how to mark the product unit

This field is optional.

>{String}</ProductUnitMarkingSpecification>
15
     <Price
Price

This field is optional.

>
16
          <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

Minimum value: 0

This field is optional.

>{Decimal}</NetPrice>
17
          <Freight
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>
18
          <FreightPercent
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>
19
     </Price>
20
     <Product
Product

This field is optional.

>
21
          <ProductId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

>{Integer}</ProductId>
22
     </Product>
23
     <ManufacturersProduct
ManufacturersProduct

This field is optional.

>
24
          <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

Minimum value: 100000

This field is optional.

>{Integer}</ManufacturersProductId>
25
     </ManufacturersProduct>
26
     <PurchaseResponsible
PurchaseResponsible

User responsible for the procurement transaction

This field is optional.

>
27
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
28
     </PurchaseResponsible>
29
     <Accounting
Accounting

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

This field is optional.

>
30
          <VATCodeDefinition
VATCodeDefinition

This field is optional.

>
31
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

>{String}</VATCode>
32
          </VATCodeDefinition>
33
     </Accounting>
34
     <ProjectOrderItem
ProjectOrderItem

This field is optional.

>
35
          <ProjectOrderItemId
ProjectOrderItemId

Project order item identifier

Minimum value: 1

This field is optional.

>{Integer}</ProjectOrderItemId>
36
          <ProjectOrder
ProjectOrder

This field is optional.

>
37
               <ProjectOrderId
ProjectOrderId

Project order identifier

Minimum value: 100000

This field is optional.

>{Integer}</ProjectOrderId>
38
          </ProjectOrder>
39
     </ProjectOrderItem>
40
</PurchaseOrderItem>
1
{
2
     "purchaseOrderItem
PurchaseOrderItem

This field is optional.

": {
3
          "requestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the buyer/purchaser

This field is optional.

": "{Date}",
4
          "scheduledShippingDateToSupplier
ScheduledShippingDateToSupplier

Shceduled date of shipping goods or material to supplier for external work.

This field is optional.

": "{Date}",
5
          "suppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers item reference number. Typically to an external system.

This field is optional.

": "{String}",
6
          "suppliersProductName
SuppliersProductName

Suppliers internal name of the product. Retrieved from the product.

This field is optional.

": "{String}",
7
          "equivalentProductName
EquivalentProductName

Name of product with equivalent behavior and attributes. Can be used for same purpose.

This field is optional.

": "{String}",
8
          "requestedProductStructureRevision
RequestedProductStructureRevision

The requested revision of the product structure

This field is optional.

": "{String}",
9
          "productDescription
ProductDescription

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

This field is optional.

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

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

This field is optional.

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

Number of units purchased

Minimum value: 0

This field is optional.

": "{Decimal}",
12
          "heatNumber
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}",
13
          "requireSerialNumberAtGoodsReception
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.

This field is optional.

": "{Boolean}",
14
          "reservedQuantity
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.

Minimum value: 0

This field is optional.

": "{Decimal}",
15
          "productUnitMarkingSpecification
ProductUnitMarkingSpecification

Describes how to mark the product unit

This field is optional.

": "{String}",
16
          "price
Price

This field is optional.

": {
17
               "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

Minimum value: 0

This field is optional.

": "{Decimal}",
18
               "freight
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}",
19
               "freightPercent
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}"
20
          },
21
          "product
Product

This field is optional.

": {
22
               "productId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
23
          },
24
          "manufacturersProduct
ManufacturersProduct

This field is optional.

": {
25
               "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
26
          },
27
          "purchaseResponsible
PurchaseResponsible

User responsible for the procurement transaction

This field is optional.

": {
28
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
29
          },
30
          "accounting
Accounting

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

This field is optional.

": {
31
               "vATCodeDefinition
VATCodeDefinition

This field is optional.

": {
32
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

": "{String}"
33
               }
34
          },
35
          "projectOrderItem
ProjectOrderItem

This field is optional.

": {
36
               "projectOrderItemId
ProjectOrderItemId

Project order item identifier

Minimum value: 1

This field is optional.

": "{Integer}",
37
               "projectOrder
ProjectOrder

This field is optional.

": {
38
                    "projectOrderId
ProjectOrderId

Project order identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
39
               }
40
          }
41
     }
42
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 103463 HTTP 404 Cost not found
Error 100563 HTTP 400 Currency {0} is not supported by the system
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}