API

Procurement APIs

POST procurement/order-responses/{purchaseOrderResponseId}/items

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.

Format:
1
<PurchaseOrderResponseItem>
2
     <RequestedDeliveryDate
RequestedDeliveryDate

Required/mandatory field

The delivery date as requested by the buyer/purchaser

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

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

This field is optional.

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

Confirmed delivery date

This field is optional.

>{Date}</ConfirmedDeliveryDate>
5
     <SuppliersReferenceNumber
SuppliersReferenceNumber

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

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

>{String}</EquivalentProductName>
8
     <ProductStructureRevision
ProductStructureRevision

The requested revision of the product structure

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

Required/mandatory field

Quantity of the purchase order response item

Minimum value: 0

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

Default value: False

This field is optional.

>{Boolean}</RequireSerialNumberAtGoodsReception>
14
     <Price
Price

This field is optional.

>
15
          <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

Minimum value: 0

This field is optional.

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

Required/mandatory field

Product identifier

Minimum value: 10000

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

This field is optional.

>
23
          <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

Minimum value: 100000

This field is optional.

>{Integer}</ManufacturersProductId>
24
     </ManufacturersProduct>
25
     <Accounting
Accounting

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

This field is optional.

>
26
          <VATCodeDefinition
VATCodeDefinition

This field is optional.

>
27
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

>{String}</VATCode>
28
          </VATCodeDefinition>
29
     </Accounting>
30
</PurchaseOrderResponseItem>
1
{
2
     "purchaseOrderResponseItem": {
3
          "requestedDeliveryDate
RequestedDeliveryDate

Required/mandatory field

The delivery date as requested by the buyer/purchaser

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

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

This field is optional.

": "{Date}",
5
          "confirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed delivery date

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

": "{String}",
9
          "productStructureRevision
ProductStructureRevision

The requested revision of the product structure

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

Required/mandatory field

Quantity of the purchase order response item

Minimum value: 0

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

Default value: False

This field is optional.

": "{Boolean}",
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}",
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}",
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}"
19
          },
20
          "product": {
21
               "productId
ProductId

Required/mandatory field

Product identifier

Minimum value: 10000

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

This field is optional.

": {
24
               "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
25
          },
26
          "accounting
Accounting

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

This field is optional.

": {
27
               "vATCodeDefinition
VATCodeDefinition

This field is optional.

": {
28
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

": "{String}"
29
               }
30
          }
31
     }
32
}

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.
$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.

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 100033 HTTP 404 Sales order item not found
Error 103472 HTTP 400 Owner document has already cost set
Error 102746 HTTP 400 The parameter value can not be more than {0}
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 109539 HTTP 400 Dimension value {0} could not be used : Check its FromPeriod and ToPeriod.
Error 102486 HTTP 400 Invalid value for dimension {0}