API

Logistics APIs

PUT logistics/goods-receptions/{goodsReceptionId}/items/{itemId}

Stores information about goods reception item.

HTTP method PUT
URI https://api.rambase.net/logistics/goods-receptions/{goodsReceptionId}/items/{itemId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {goodsReceptionId} Goods reception identifier
Integer, minimum 10000
- URI parameter {itemId} Item-/line-number of the goods reception
Integer, minimum 1
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 3372, version 20

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
<GoodsReceptionItem
GoodsReceptionItem

This field is optional.

>
2
     <SuppliersReferenceNumber
SuppliersReferenceNumber

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

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

The requested revision of the product structure

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

Number of units received

Minimum value: 0

This field is optional.

>{Decimal}</Quantity>
9
     <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>
10
     <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>
11
     <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>
12
     <ProductionLot
ProductionLot

The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch.

This field is optional.

>{String}</ProductionLot>
13
     <ProductionDate
ProductionDate

Production date is the date when the product was manufactured. For purchased products this date is informed about from supplier. For goods that are manufactured inhouse, this date is a date for when the company manufactured these products.

This field is optional.

>{Date}</ProductionDate>
14
     <Parcels
Parcels

Number of parcels/packages for this reception item. Used for deciding number of labels to print.

This field is optional.

>{Integer}</Parcels>
15
     <CountryOfOriginCode
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.

This field is optional.

>{String}</CountryOfOriginCode>
16
     <BestBeforeDate
BestBeforeDate

Goods received in this goods reception item is best before this date.

This field is optional.

>{Date}</BestBeforeDate>
17
     <MaterialQuality
MaterialQuality

This field is optional.

>
18
          <QualityCode
QualityCode

Quality of the material. Only used for information.

This field is optional.

>{String}</QualityCode>
19
          <InternalNote
InternalNote

Additonal quality codes that are covered in addition to the code given by the field Quality description

This field is optional.

>{String}</InternalNote>
20
     </MaterialQuality>
21
     <Price
Price

This field is optional.

>
22
          <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

Minimum value: 0

This field is optional.

>{Decimal}</NetPrice>
23
          <Freight
Freight

Freight pr unit. Is a part of landed cost for the received product.

Minimum value: 0

This field is optional.

>{Decimal}</Freight>
24
          <FreightPercent
FreightPercent

Freight in percent of net price. Used for including 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>
25
     </Price>
26
     <Product
Product

This field is optional.

>
27
          <ProductId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

>{Integer}</ProductId>
28
     </Product>
29
     <ManufacturersProduct
ManufacturersProduct

This field is optional.

>
30
          <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

Minimum value: 100000

This field is optional.

>{Integer}</ManufacturersProductId>
31
     </ManufacturersProduct>
32
     <Accounting
Accounting

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

This field is optional.

>
33
          <VATCodeDefinition
VATCodeDefinition

This field is optional.

>
34
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

>{String}</VATCode>
35
          </VATCodeDefinition>
36
     </Accounting>
37
</GoodsReceptionItem>
1
{
2
     "goodsReceptionItem
GoodsReceptionItem

This field is optional.

": {
3
          "suppliersReferenceNumber
SuppliersReferenceNumber

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

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

The requested revision of the product structure

This field is optional.

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

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

This field is optional.

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

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

This field is optional.

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

Number of units received

Minimum value: 0

This field is optional.

": "{Decimal}",
10
          "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}",
11
          "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}",
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}",
13
          "productionLot
ProductionLot

The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch.

This field is optional.

": "{String}",
14
          "productionDate
ProductionDate

Production date is the date when the product was manufactured. For purchased products this date is informed about from supplier. For goods that are manufactured inhouse, this date is a date for when the company manufactured these products.

This field is optional.

": "{Date}",
15
          "parcels
Parcels

Number of parcels/packages for this reception item. Used for deciding number of labels to print.

This field is optional.

": "{Integer}",
16
          "countryOfOriginCode
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.

This field is optional.

": "{String}",
17
          "bestBeforeDate
BestBeforeDate

Goods received in this goods reception item is best before this date.

This field is optional.

": "{Date}",
18
          "materialQuality
MaterialQuality

This field is optional.

": {
19
               "qualityCode
QualityCode

Quality of the material. Only used for information.

This field is optional.

": "{String}",
20
               "internalNote
InternalNote

Additonal quality codes that are covered in addition to the code given by the field Quality description

This field is optional.

": "{String}"
21
          },
22
          "price
Price

This field is optional.

": {
23
               "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

Minimum value: 0

This field is optional.

": "{Decimal}",
24
               "freight
Freight

Freight pr unit. Is a part of landed cost for the received product.

Minimum value: 0

This field is optional.

": "{Decimal}",
25
               "freightPercent
FreightPercent

Freight in percent of net price. Used for including freight cost in the gross margin calculation in sales orders, sales invoices etc.

Minimum value: 0

Maximum value: 100

This field is optional.

": "{Decimal}"
26
          },
27
          "product
Product

This field is optional.

": {
28
               "productId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
29
          },
30
          "manufacturersProduct
ManufacturersProduct

This field is optional.

": {
31
               "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
32
          },
33
          "accounting
Accounting

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

This field is optional.

": {
34
               "vATCodeDefinition
VATCodeDefinition

This field is optional.

": {
35
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

": "{String}"
36
               }
37
          }
38
     }
39
}

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 100009 HTTP 400 Missing required input arguments
Error 104192 HTTP 404 Custom value not found
Error 105251 HTTP 400 Setup time on product structure operation must be greater than 0
Error 105250 HTTP 400 Cleanup time on product structure operation must be greater than 0
Error 105679 HTTP 400 Production resource does not allow to add manhours
Error 108137 HTTP 400 Standard ManhourRate is not set for Resource
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}