Logistics APIs
Creates a new item in provided goods reception
| HTTP method | POST |
| URI | https://api.rambase.net/logistics/goods-receptions/{goodsReceptionId}/items |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {goodsReceptionId} |
Goods reception identifier
Integer, minimum 10000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 3363, version 6 |
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.
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>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>Parcels
Number of parcels/packages for this reception item. Used for deciding number of labels to print.
This field is optional.
>{Integer}</Parcels>Quantity
Required/mandatory field
Number of units received
Minimum value: 0
>{Decimal}</Quantity>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>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
Freight pr unit. Is a part of landed cost for the received product.
Minimum value: 0
This field is optional.
>{Decimal}</Freight>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>ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
>{Integer}</ProductId>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}",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}",Parcels
Number of parcels/packages for this reception item. Used for deciding number of labels to print.
This field is optional.
": "{Integer}",Quantity
Required/mandatory field
Number of units received
Minimum value: 0
": "{Decimal}",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}",Price
This field is optional.
": {NetPrice
Final price per unit after deducting all discounts etc.
Minimum value: 0
This field is optional.
": "{Decimal}",Freight
Freight pr unit. Is a part of landed cost for the received product.
Minimum value: 0
This field is optional.
": "{Decimal}",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}"ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
": "{Integer}"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.
GoodsReceptionItemId
Item-/line-number of the goods reception
>{Integer}</GoodsReceptionItemId>Status
Status code of the the goods reception 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>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>HasCustomizedStructure
True if products in goods reception item are customized product structures (and not standard product structure).
>{Boolean}</HasCustomizedStructure>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
Number of units received
>{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>NotInvoicedQuantity
Remaining quantity that has not been invoiced. Will decrease when the goods reception get invoiced. Note that goods receptions can get invoiced for none or part of the items.
>{Decimal}</NotInvoicedQuantity>AvailableQuantity
Quantity available/free for use. Not assigned to anything.
>{Decimal}</AvailableQuantity>StockQuantity
Remaining quantity in stock of the goods reception item. This quantity will decrease when shipped to customer or supplier, or when consumed in a completed production.
>{Decimal}</StockQuantity>RemainingQuantity
Remaining number of units to be forwarded
>{Decimal}</RemainingQuantity>PickedStockQuantity
The picked stock quantity is the quantity picked, but not yet shipped or completed in production. When goods is picked, it is still included in the stock quantity until the goods is shipped or completed in production. Picked stock quantity can be subtracted from the stock quantity to know the exact quanitity from all stock locations for this goods reception item.
>{Decimal}</PickedStockQuantity>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>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>ProductionLot
The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch.
>{String}</ProductionLot>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.
>{Date}</ProductionDate>Parcels
Number of parcels/packages for this reception item. Used for deciding number of labels to print.
>{Integer}</Parcels>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>BestBeforeDate
Goods received in this goods reception item is best before this date.
>{Date}</BestBeforeDate>QualityCode
Quality of the material. Only used for information.
>{String}</QualityCode>InternalNote
Additonal quality codes that are covered in addition to the code given by the field Quality description
>{String}</InternalNote>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Freight
Freight pr unit. Is a part of landed cost for the received product.
>{Decimal}</Freight>FreightPercent
Freight in percent of net price. Used for including freight cost in the gross margin calculation in sales orders, sales invoices etc.
>{Decimal}</FreightPercent>GrossPrice
Represents the price per unit before any discounting is applied.
>{Decimal}</GrossPrice>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>GrossPrice
Represents the price per unit before any discounting is applied.
>{Decimal}</GrossPrice>NetPrice
Final price per unit after deducting all discounts.
>{Decimal}</NetPrice>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>GrossAmount
Represents the item amount before any discounts etc. is applied.
>{Decimal}</GrossAmount>NetAmount
Final item amount after deducting all discounts etc.
>{Decimal}</NetAmount>StockValue
The total landed cost (amount) for the goods in stock in this item. Formula: Landec Cost = GrossPrice * StockQuantity * (1 + EstimatedFreightPercent / 100 )
>{Decimal}</StockValue>RemainingAmount
Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice
>{Decimal}</RemainingAmount>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>GrossAmount
Total gross amount in company currency.
>{Decimal}</GrossAmount>NetAmount
Total net amount in company currency.
>{Decimal}</NetAmount>StockValue
The total landed cost (amount) for the goods in stock in this item. Formula: Landec Cost = GrossPrice * StockQuantity * (1 + EstimatedFreightPercent / 100 )
>{Decimal}</StockValue>RemainingAmount
Total remaining amount in company currency.
>{Decimal}</RemainingAmount>MeasurementUnitId
Measurement unit identifier
>{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>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>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>ProductStructureId
Product structure reference
>{Integer}</ProductStructureId>ProductStructureLink
Product structure reference
>{String}</ProductStructureLink>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>Name
Name of the customer/supplier, or last name if it is a person.
>{String}</Name>FirstName
First name of the customer/supplier
>{String}</FirstName>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ObjectLink
API reference to the object
>{String}</ObjectLink>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.
>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>ForwardedNetAmount
The net amount forwarded to this item.
>{Decimal}</ForwardedNetAmount>ForwardedQuantity
The quantity forwarded to this item.
>{Decimal}</ForwardedQuantity>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 goods reception 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>DeviationId
Deviation identifier
>{Integer}</DeviationId>Database
Database of the object
>{String}</Database>DeviationTypeId
Deviation definition identifier
>{Integer}</DeviationTypeId>GoodsHandling
Specifies how the goods should be handled
Possible domain values can be found here
>{Integer}</GoodsHandling>AccountingHandling
Specifies how accounting should handle the deviation
Possible domain values can be found here
>{Integer}</AccountingHandling>InterCompanyHandling
Specifies how the deviation should be handled in the inter company trading.
Possible domain values can be found here
>{Integer}</InterCompanyHandling>LandedCostCalculation
Specifies how landed cost should be calculated.
Possible domain values can be found here
>{Integer}</LandedCostCalculation>DeviationTypeLink
Deviation definition reference
>{String}</DeviationTypeLink>DeviationLink
Deviation reference
>{String}</DeviationLink>StockAccrualId
Stock accrual identifier
>{Integer}</StockAccrualId>StockAccrualLink
Stock accrual reference
>{String}</StockAccrualLink>AssignmentRegistertId
Assignment register identifier
>{Integer}</AssignmentRegistertId>AssignmentRegisterLink
Assignment register reference
>{String}</AssignmentRegisterLink>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>GoodsReceptionItemId
Item-/line-number of the goods reception
": "{Integer}",Status
Status code of the the goods reception 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}",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}",HasCustomizedStructure
True if products in goods reception item are customized product structures (and not standard product structure).
": "{Boolean}",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
Number of units received
": "{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}",NotInvoicedQuantity
Remaining quantity that has not been invoiced. Will decrease when the goods reception get invoiced. Note that goods receptions can get invoiced for none or part of the items.
": "{Decimal}",AvailableQuantity
Quantity available/free for use. Not assigned to anything.
": "{Decimal}",StockQuantity
Remaining quantity in stock of the goods reception item. This quantity will decrease when shipped to customer or supplier, or when consumed in a completed production.
": "{Decimal}",RemainingQuantity
Remaining number of units to be forwarded
": "{Decimal}",PickedStockQuantity
The picked stock quantity is the quantity picked, but not yet shipped or completed in production. When goods is picked, it is still included in the stock quantity until the goods is shipped or completed in production. Picked stock quantity can be subtracted from the stock quantity to know the exact quanitity from all stock locations for this goods reception item.
": "{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}",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}",ProductionLot
The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch.
": "{String}",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.
": "{Date}",Parcels
Number of parcels/packages for this reception item. Used for deciding number of labels to print.
": "{Integer}",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}",BestBeforeDate
Goods received in this goods reception item is best before this date.
": "{Date}",QualityCode
Quality of the material. Only used for information.
": "{String}",InternalNote
Additonal quality codes that are covered in addition to the code given by the field Quality description
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",Freight
Freight pr unit. Is a part of landed cost for the received product.
": "{Decimal}",FreightPercent
Freight in percent of net price. Used for including freight cost in the gross margin calculation in sales orders, sales invoices etc.
": "{Decimal}",GrossPrice
Represents the price per unit before any discounting is applied.
": "{Decimal}",NetPrice
Final price per unit after deducting all discounts etc.
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",GrossPrice
Represents the price per unit before any discounting is applied.
": "{Decimal}",NetPrice
Final price per unit after deducting all discounts.
": "{Decimal}"Currency
Three character code following the ISO 4217 standard
": "{String}",GrossAmount
Represents the item amount before any discounts etc. is applied.
": "{Decimal}",NetAmount
Final item amount after deducting all discounts etc.
": "{Decimal}",StockValue
The total landed cost (amount) for the goods in stock in this item. Formula: Landec Cost = GrossPrice * StockQuantity * (1 + EstimatedFreightPercent / 100 )
": "{Decimal}",RemainingAmount
Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
": "{String}",GrossAmount
Total gross amount in company currency.
": "{Decimal}",NetAmount
Total net amount in company currency.
": "{Decimal}",StockValue
The total landed cost (amount) for the goods in stock in this item. Formula: Landec Cost = GrossPrice * StockQuantity * (1 + EstimatedFreightPercent / 100 )
": "{Decimal}",RemainingAmount
Total remaining amount in company currency.
": "{Decimal}"MeasurementUnitId
Measurement unit identifier
": "{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}",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}"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}"ProductStructureId
Product structure reference
": "{Integer}",ProductStructureLink
Product structure reference
": "{String}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",Name
Name of the customer/supplier, or last name if it is a person.
": "{String}",FirstName
First name of the customer/supplier
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ObjectLink
API reference to the object
": "{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.
": {Currency
Three character code following the ISO 4217 standard
": "{String}",ForwardedNetAmount
The net amount forwarded to this item.
": "{Decimal}",ForwardedQuantity
The quantity forwarded to this item.
": "{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}"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 goods reception 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}"DeviationId
Deviation identifier
": "{Integer}",Database
Database of the object
": "{String}",DeviationTypeId
Deviation definition identifier
": "{Integer}",Category
Type of deviation
Possible domain values can be found here
": "{Integer}",GoodsHandling
Specifies how the goods should be handled
Possible domain values can be found here
": "{Integer}",AccountingHandling
Specifies how accounting should handle the deviation
Possible domain values can be found here
": "{Integer}",InterCompanyHandling
Specifies how the deviation should be handled in the inter company trading.
Possible domain values can be found here
": "{Integer}",LandedCostCalculation
Specifies how landed cost should be calculated.
Possible domain values can be found here
": "{Integer}",DeviationTypeLink
Deviation definition reference
": "{String}"DeviationLink
Deviation reference
": "{String}",StockAccrualId
Stock accrual identifier
": "{Integer}",Status
Status of stock accrual
Possible domain values can be found here
": "{Integer}",StockAccrualLink
Stock accrual reference
": "{String}"AssignmentRegistertId
Assignment register identifier
": "{Integer}",AssignmentRegisterLink
Assignment register reference
": "{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}"
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 100089 HTTP 404 | Product not found |
| Error 100563 HTTP 400 | Currency {0} is not supported by the system |
| Error 100012 HTTP 400 | {0} must exist in {1} |
| Error 101999 HTTP 404 | Bank account not found |
| Error 106413 HTTP 400 | Period can't be changed as document is created from a transaction that is posted to a later period |
| Error 106414 HTTP 400 | Period can't be changed as document is linked to a payment posted to period {0} |
| 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} |