Procurement APIs
Forwards purchase order response item to existing purchase order response. This is an API operation. Read the documentation pages for more information about API operations.
| HTTP method | POST |
| URI | https://api.rambase.net/procurement/order-responses/{purchaseOrderResponseId}/items/{itemId}/api-operations/100499/instances |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {purchaseOrderResponseId} |
Purchase order response identifier
Integer, minimum 100000 |
| - URI parameter {itemId} |
Item-/linenumber of purchase order response
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 3079, 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.
PurchaseOrderResponseId
Required/mandatory field
Purchase order response identifier
Minimum value: 100000
>{Integer}</PurchaseOrderResponseId>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>Price
This field is optional.
>NetPrice
Final price per unit after deducting all discounts etc.
Minimum value: 0
This field is optional.
>{Decimal}</NetPrice>SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
This field is optional.
>{String}</SuppliersReferenceNumber>RequestedDeliveryDate
The delivery date as requested by the buyer/purchaser
This field is optional.
>{Date}</RequestedDeliveryDate>ConfirmedDeliveryDate
Confirmed delivery date
This field is optional.
>{Date}</ConfirmedDeliveryDate>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>CausedBy
States who has changed the purchase order
Applicable domain values can be found here
This field is optional.
>{String}</CausedBy>IgnoreConfirmedDeliveryDateBuffer
If the confirmed delivery date is unreliable, you can specify a buffer in days to be added on the supplier.
If value is value is "True" the buffer days on the supplier will be ignored when this operation runs.
Default value: False
This field is optional.
>{Boolean}</IgnoreConfirmedDeliveryDateBuffer>PurchaseOrderResponseId
Required/mandatory field
Purchase order response identifier
Minimum value: 100000
": "{Integer}",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}",Price
This field is optional.
": {NetPrice
Final price per unit after deducting all discounts etc.
Minimum value: 0
This field is optional.
": "{Decimal}"SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
This field is optional.
": "{String}",RequestedDeliveryDate
The delivery date as requested by the buyer/purchaser
This field is optional.
": "{Date}",ConfirmedDeliveryDate
Confirmed delivery date
This field is optional.
": "{Date}",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}",CausedBy
States who has changed the purchase order
Applicable domain values can be found here
This field is optional.
": "{String}",IgnoreConfirmedDeliveryDateBuffer
If the confirmed delivery date is unreliable, you can specify a buffer in days to be added on the supplier.
If value is value is "True" the buffer days on the supplier will be ignored when this operation runs.
Default value: False
This field is optional.
": "{Boolean}"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 102529 HTTP 404 | RamBase event type not found |
| Error 100018 HTTP 404 | Document {0} not found |
| Error 100041 HTTP 400 | Cannot delete this item |
| Error 105477 HTTP 400 | Production date cannot be a date in the future. |
| Error 107754 HTTP 400 | Quantity cannot be updated for items which have been moved from another product |
| Error 107755 HTTP 400 | Product identifier cannot be updated for items which have been moved from another product |
| Error 103244 HTTP 400 | Reserved quantity can not exceed available quantity. |
| Error 106477 HTTP 400 | Project order identifier is not defined |
| Error 106478 HTTP 400 | Project order item identifier is not defined |
| Error 108107 HTTP 400 | Linking is allowed only for registered (status 4) and paused (status 5) project order items |
| Error 108104 HTTP 400 | Linking is allowed only for project order items with category 'Expenses' |
| Error 108106 HTTP 400 | Linking is not allowed for project order item which is based on expense log |
| Error 107155 HTTP 400 | End date is required |
| Error 104971 HTTP 400 | The start date cannot be later than the end 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 108677 HTTP 400 | Expected delivery date cannot be earlier than the effective date |
| Error 108678 HTTP 400 | Expected collection date cannot be earlier than the effective date |
| Error 108679 HTTP 400 | Expected collection date cannot be earlier then expected delivery date |
| Error 108680 HTTP 400 | Collection date cannot be earlier then the effective date |
| Error 108681 HTTP 400 | Collection date cannot be earlier then the expected delivery date |
| Error 108683 HTTP 400 | Termination date must be earlier then the expiration date |
| 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 |