Procurement APIs
Forwards a purchase order item to a goods reception. This is an API operation. Read the documentation pages for more information about API operations.
| HTTP method | POST |
| URI | https://api.rambase.net/procurement/orders/{purchaseOrderId}/items/{itemId}/api-operations/100487/instances |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {purchaseOrderId} |
Purchase order identifier
Integer, minimum 100000 |
| - URI parameter {itemId} |
Item-/line-number of the purchase order
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 3069, version 5 |
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.
GoodsReceptionId
Required/mandatory field
Goods reception identifier
Minimum value: 100000
>{Integer}</GoodsReceptionId>SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
This field is optional.
>{String}</SuppliersReferenceNumber>Quantity
Required/mandatory field
Number of units purchased
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>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>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>Parcels
Number of parcels/packages for this reception item. Used for deciding number of labels to print.
Minimum value: 0
This field is optional.
>{Integer}</Parcels>MaterialQuality
Quality of the material. Only used for information.
This field is optional.
>{String}</MaterialQuality>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>ProductStructureRevision
The requested revision of the product structure
This field is optional.
>{String}</ProductStructureRevision>GoodsReceptionId
Required/mandatory field
Goods reception identifier
Minimum value: 100000
": "{Integer}",SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
This field is optional.
": "{String}",Quantity
Required/mandatory field
Number of units purchased
Minimum value: 0
": "{Decimal}",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}",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}",Parcels
Number of parcels/packages for this reception item. Used for deciding number of labels to print.
Minimum value: 0
This field is optional.
": "{Integer}",MaterialQuality
Quality of the material. Only used for information.
This field is optional.
": "{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.
This field is optional.
": "{String}",ProductStructureRevision
The requested revision of the product structure
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 102185 HTTP 400 | Missing mandatory parameter for assignment. |
| Error 102186 HTTP 400 | Missing mandatory parameter for assignment id. |
| Error 100089 HTTP 404 | Product not found |
| Error 104311 HTTP 400 | Manufacturers product is no longer valid to use |
| Error 101118 HTTP 400 | Seller is not valid |
| Error 100199 HTTP 404 | Location not found |
| Error 106493 HTTP 400 | Currencies of document and recurring price should always match |
| Error 105820 HTTP 400 | Expected end date should come after start date |
| Error 105784 HTTP 400 | Only subscription products can be added to subscription items |
| Error 106957 HTTP 400 | Only rental or subscription products can be used in recurring contract's lines |
| Error 105760 HTTP 400 | You cannot attach a recurring price to a sales order item |
| Error 106302 HTTP 404 | Product revision not found |
| Error 103551 HTTP 400 | IsManufacturedInBatches can only be changed on product structures |
| Error 103554 HTTP 400 | AutomaticallyCreateWorkOrdersForSubstructures can only be changed on product structures |
| Error 104253 HTTP 400 | ProduceInMultipleOf can only be changed on product structures. |
| Error 107694 HTTP 400 | Use line production can only be changed on product structeres |
| Error 106999 HTTP 400 | Sub module 'Projectorder' is not activated in this company |
| Error 106436 HTTP 400 | Unit can only be changed when status is equal to draft (status 1) |
| Error 100167 HTTP 404 | Measurement unit not found |
| Error 104486 HTTP 400 | Unit production is only allowed for measurment units (UNI) of type QTY |
| Error 100200 HTTP 404 | Special handling code not found |
| Error 100092 HTTP 404 | Service template not found |
| Error 103020 HTTP 404 | Qcdoc not found |
| Error 101091 HTTP 404 | Contry of origin is not valid: {0} |
| Error 101124 HTTP 400 | Hardware code already exists |
| Error 106437 HTTP 400 | Type can not be changed when status is not equal to draft (status 1) |
| Error 101009 HTTP 400 | The product has a structure. You can only change the product type to a type that can contain a structure. |
| Error 101010 HTTP 400 | The product structure contains operations and can not be changed to become a phantom structure |
| Error 101008 HTTP 400 | Cannot change product type from a physical type to a virtual type |
| Error 101007 HTTP 400 | Cannot change product type from a virtual type to a physical type |
| Error 103021 HTTP 400 | Linkid must be a rental product |
| Error 104760 HTTP 400 | Costing method can't be changed after product has been received |
| Error 104652 HTTP 400 | Both minimum sales price and minimum sales price currency must be given |
| Error 100563 HTTP 400 | Currency {0} is not supported by the system |
| Error 104653 HTTP 400 | Minimum sales price can not be negative |
| Error 106506 HTTP 404 | Image not found |