Procurement APIs
Creates a new item in provided supplier return
| HTTP method | POST |
| URI | https://api.rambase.net/procurement/returns/{supplierReturnId}/items |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {supplierReturnId} |
Supplier return identifier
Integer, minimum 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 3234, version 7 |
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>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 supplier return item
Minimum value: 0
>{Decimal}</Quantity>RequireSerialNumberBeforeShipping
True if serial number is required before shipping. Note that if the product has set this value to true, this can not be overridden.
Default value: False
This field is optional.
>{Boolean}</RequireSerialNumberBeforeShipping>Price
This field is optional.
>NetPrice
Final price per unit after deducting all discounts etc.
Minimum value: 0
This field is optional.
>{Decimal}</NetPrice>ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
>{Integer}</ProductId>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>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}",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 supplier return item
Minimum value: 0
": "{Decimal}",RequireSerialNumberBeforeShipping
True if serial number is required before shipping. Note that if the product has set this value to true, this can not be overridden.
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}"ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
": "{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.
SupplierReturnItemId
Supplier return item identifier
>{Integer}</SupplierReturnItemId>Status
Status of the supplier return 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>ProductStructureRevision
The revision of the product structure
>{String}</ProductStructureRevision>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 supplier return item
>{Decimal}</Quantity>RemainingQuantity
Remaining number of units to be forwarded
>{Decimal}</RemainingQuantity>RequireSerialNumberBeforeShipping
True if serial number is required before shipping. Note that if the product has set this value to true, this can not be overridden.
>{Boolean}</RequireSerialNumberBeforeShipping>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>NetPrice
Final price per unit after deducting all discounts.
>{Decimal}</NetPrice>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>NetAmount
Final item amount after deducting all discounts etc.
>{Decimal}</NetAmount>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
Possible domain values can be found here
>{String}</Currency>NetAmount
Total net amount in company currency.
>{Decimal}</NetAmount>RemainingAmount
Total remaining amount in company currency.
>{Decimal}</RemainingAmount>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>Description
Description of the item. If not specified, the description is by default copied from the product.
>{String}</Description>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>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>ProductUnit
This is the reference to the product unit where the part change, which is the reason for the supplier return, took place.
>ProductUnitId
Product unit identifier
>{Integer}</ProductUnitId>ProductUnitLink
Product unit reference
>{String}</ProductUnitLink>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>PickOperationId
Pick operation identifier
>{Integer}</PickOperationId>PickOperationLink
Pick operation reference
>{String}</PickOperationLink>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>StockAccrualId
Stock accrual identifier
>{Integer}</StockAccrualId>StockAccrualLink
Stock accrual reference
>{String}</StockAccrualLink>NotificationId
Notification identifier
>{Integer}</NotificationId>Status
Status of the notification
>{Integer}</Status>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>SupplierReturnItemId
Supplier return item identifier
": "{Integer}",Status
Status of the supplier return 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}",ProductStructureRevision
The revision of the product structure
": "{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 supplier return item
": "{Decimal}",RemainingQuantity
Remaining number of units to be forwarded
": "{Decimal}",RequireSerialNumberBeforeShipping
True if serial number is required before shipping. Note that if the product has set this value to true, this can not be overridden.
": "{Boolean}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",NetPrice
Final price per unit after deducting all discounts etc.
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",NetPrice
Final price per unit after deducting all discounts.
": "{Decimal}"Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",NetAmount
Final item amount after deducting all discounts etc.
": "{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
Possible domain values can be found here
": "{String}",NetAmount
Total net amount in company currency.
": "{Decimal}",RemainingAmount
Total remaining amount in company currency.
": "{Decimal}"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}",Description
Description of the item. If not specified, the description is by default copied from 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}"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}"ProductUnit
This is the reference to the product unit where the part change, which is the reason for the supplier return, took place.
": {ProductUnitId
Product unit identifier
": "{Integer}",ProductUnitLink
Product unit 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}"PickOperationId
Pick operation identifier
": "{Integer}",PickOperationLink
Pick operation reference
": "{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}"StockAccrualId
Stock accrual identifier
": "{Integer}",Status
Status of stock accrual
Possible domain values can be found here
": "{Integer}",StockAccrualLink
Stock accrual reference
": "{String}"NotificationId
Notification identifier
": "{Integer}",Status
Status of the notification
": "{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 101746 HTTP 404 | Product structure not found. Id: {0} |
| Error 102267 HTTP 404 | Product structure operation not found |
| Error 102746 HTTP 400 | The parameter value can not be more than {0} |
| Error 102747 HTTP 400 | Error in formula: {0} |
| Error 107762 HTTP 400 | Only product structures can auto create work orders for sub production |
| Error 107763 HTTP 400 | Only product structures can be set up for line production |
| Error 107764 HTTP 400 | Only product structures can be externally manufactured |
| 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} |