Logistics APIs
Forward goods reception item to new supplier invoice. This is an API operation. Read the documentation pages for more information about API operations.
| HTTP method | POST |
| URI | https://api.rambase.net/logistics/goods-receptions/{goodsReceptionId}/items/{itemId}/api-operations/100656/instances |
| 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 |
| Successful HTTP status code | 200 |
| API resource identifier | 3442, version 3 |
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.
Quantity
Required/mandatory field
Number of units received
Minimum value: 0
>{Decimal}</Quantity>Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
This field is optional.
>{String}</Note>Price
This field is optional.
>NetPrice
Final price per unit after deducting all discounts etc.
Minimum value: 0
This field is optional.
>{Decimal}</NetPrice>UpdateNetPriceInGoodsReceptionItem
Boolean value that represents whether the net price should be updated on the goods reception item.
Default value: false
This field is optional.
>{Boolean}</UpdateNetPriceInGoodsReceptionItem>SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
This field is optional.
>{String}</SuppliersReferenceNumber>Quantity
Required/mandatory field
Number of units received
Minimum value: 0
": "{Decimal}",Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
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}",UpdateNetPriceInGoodsReceptionItem
Boolean value that represents whether the net price should be updated on the goods reception item.
Default value: false
This field is optional.
": "{Boolean}"SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
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. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
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.
OperationInstanceId
Operation instance identifier
>{Integer}</OperationInstanceId>Status
Status of the instance, 2 = started, 7 = error, 9 = finished
>{Integer}</Status>CreatedAt
Date and time the operation instance was created
>{Datetime}</CreatedAt>CreatedBy
Reference to the creator
>UserId
User identifier
>{Integer}</UserId>UserLink
User reference
>{String}</UserLink>ObjectId
Identifier of the object
>{String}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ItemLink
API reference to the item
>{String}</ItemLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ApiOprationId
Api operation identifiers
>{Integer}</ApiOprationId>ApiOperationLink
Api operation reference
>{String}</ApiOperationLink>ObjectId
Identifier of the object
>{String}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ItemLink
API reference to the item
>{String}</ItemLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>Message
Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).
>{String}</Message>TranslatedMessage
Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.
>{String}</TranslatedMessage>StackTrace
Stack trace for details about the error
>{String}</StackTrace>ErrorMessage
Contains a reference to the error message, if an error occured
>ErrorMessageId
Error message identifier
>{Integer}</ErrorMessageId>ErrorMessageLink
Error message reference
>{String}</ErrorMessageLink>Index
Error Key
>{Integer}</Index>Value
Value of the error parameter
>{String}</Value>Message
Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).
>{String}</Message>TranslatedMessage
Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.
>{String}</TranslatedMessage>StackTrace
Stack trace for details about the error
>{String}</StackTrace>ErrorMessage
Contains a reference to the error message, if an error occured
>ErrorMessageId
Error message identifier
>{Integer}</ErrorMessageId>ErrorMessageLink
Error message reference
>{String}</ErrorMessageLink>Index
Error Key
>{Integer}</Index>Value
Value of the error parameter
>{String}</Value>Key
Key of the result value
>{String}</Key>Value
Value of the result value
>{String}</Value>SystemJob
Contains a reference to the system job, if a system job was started
>ObjectId
{OIN.ObjectId}
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>PercentComplete
Percent complete
>{Integer}</PercentComplete>ObjectLink
API reference to the object
>{String}</ObjectLink>OperationInstanceLink
Operation instance reference
>{String}</OperationInstanceLink>OperationInstanceId
Operation instance identifier
": "{Integer}",Status
Status of the instance, 2 = started, 7 = error, 9 = finished
": "{Integer}",CreatedAt
Date and time the operation instance was created
": "{Datetime}",CreatedBy
Reference to the creator
": {UserId
User identifier
": "{Integer}",UserLink
User reference
": "{String}"ObjectId
Identifier of the object
": "{String}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",ItemLink
API reference to the item
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}"ApiOprationId
Api operation identifiers
": "{Integer}",ApiOperationLink
Api operation reference
": "{String}"ObjectId
Identifier of the object
": "{String}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",ItemLink
API reference to the item
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}"Message
Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).
": "{String}",TranslatedMessage
Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.
": "{String}",StackTrace
Stack trace for details about the error
": "{String}",ErrorMessage
Contains a reference to the error message, if an error occured
": {ErrorMessageId
Error message identifier
": "{Integer}",ErrorMessageLink
Error message reference
": "{String}"Index
Error Key
": "{Integer}",Value
Value of the error parameter
": "{String}"Message
Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).
": "{String}",TranslatedMessage
Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.
": "{String}",StackTrace
Stack trace for details about the error
": "{String}",ErrorMessage
Contains a reference to the error message, if an error occured
": {ErrorMessageId
Error message identifier
": "{Integer}",ErrorMessageLink
Error message reference
": "{String}"Index
Error Key
": "{Integer}",Value
Value of the error parameter
": "{String}"Key
Key of the result value
": "{String}",Value
Value of the result value
": "{String}"SystemJob
Contains a reference to the system job, if a system job was started
": {ObjectId
{OIN.ObjectId}
": "{Integer}",ObjectType
Type of object
": "{String}",PercentComplete
Percent complete
": "{Integer}",ObjectLink
API reference to the object
": "{String}"OperationInstanceLink
Operation instance 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 102667 HTTP 404 | Customer group not found |
| Error 107900 HTTP 400 | Currency is required |
| Error 101481 HTTP 400 | Customer is missing currency |
| Error 100992 HTTP 400 | This customer does not buy in this currency |
| Error 108717 HTTP 400 | Base date of rental contract is required |
| Error 100345 HTTP 400 | Location is required |
| Error 101294 HTTP 400 | Location is not active (status 4) |
| Error 109725 HTTP 400 | The new main location must follow the same country as there are some items already defined for the contract |
| Error 108514 HTTP 400 | Invalid invoice frequency |
| Error 102035 HTTP 400 | Effective date is required |
| Error 108421 HTTP 400 | The effective date cannot be later than the expiration date |
| Error 108635 HTTP 400 | Effective date cannot be later then effective date of any contract item |
| Error 108735 HTTP 400 | Expiration date of a contract cannot be earlier then expiration date of any of its quotes |
| Error 108674 HTTP 400 | Termination date cannot be earlier then the effective date |
| Error 108675 HTTP 400 | Termination date cannot be later then the expiration date |
| Error 108672 HTTP 400 | Closing date cannot be earlier then the effective date |
| Error 108969 HTTP 400 | The selected default check-out location ({0}) is not active |
| Error 108970 HTTP 400 | The selected default check-out location ({0}) is not a rental depot capable location |
| Error 109723 HTTP 400 | The country of selected default check-out location ({0}) is different than contract's main location country ({1}) |
| Error 108971 HTTP 400 | The selected default check-in location ({0}) is not active |
| Error 108972 HTTP 400 | The selected default check-in location ({0}) is not a rental depot capable location |
| Error 109724 HTTP 400 | The country of selected default check-in location ({0}) is different than contract's main location country ({1}) |
| Error 109335 HTTP 400 | Selected payment term is not supported on rental contract |
| Error 108670 HTTP 400 | Discount percentage must be a number between 0 and 100 |
| Error 109623 HTTP 400 | VAT handling can't be changed since there has been made invoice(s) from this contract |
| Error 108679 HTTP 400 | Expected check-in date cannot be earlier then expected check-out date |
| Error 108262 HTTP 404 | Recurring rate not found |
| Error 108691 HTTP 400 | Recurring rate is not active |
| Error 108018 HTTP 400 | Currency mismatch |
| Error 108016 HTTP 400 | Product id mismatch |
| Error 108824 HTTP 400 | Cannot apply recurring rate as it is not valid for selected period |
| Error 108671 HTTP 400 | The effective date cannot be changed because earlier days have already been invoiced |
| Error 108684 HTTP 400 | The expiration date cannot be changed because later days have already been invoiced |
| Error 108683 HTTP 400 | Termination date must be earlier then the expiration date |
| Error 109306 HTTP 400 | Shipping details can only be updated until an item is shipped |
| Error 109467 HTTP 400 | The rental unit is not available to non-owners for the selected period |
| Error 109315 HTTP 400 | Rental unit is not available within given period |