RamBase REST APIs
Copies purchase order to a new purchase order. 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}/api-operations/100507/instances |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {purchaseOrderId} |
Purchase order identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 3091, version 1 |
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.
UseProductPurchasePrice
Required/mandatory field
When copiing items to a new purchase order the price will be picked from the pricelist if the value is true.
>{Boolean}</UseProductPurchasePrice>UseLatestRevisionFromStandardStructure
Required/mandatory field
When copiing item from a purchase order to a new one, if the value is true the product structure revision will be picked from the latest standard structure of the product.
>{Boolean}</UseLatestRevisionFromStandardStructure>QuantityIncreaseFactor
Required/mandatory field
When copiing itemfs from a purchase order to a new one, the quantity of the items will be multiplied with this factor.
Minimum value: 1
Maximum value: 99999
Default value: 1
>{Decimal}</QuantityIncreaseFactor>RequestedDeliveryDate
Required/mandatory field
The delivery date as requested by the buyer/purchaser
>{Date}</RequestedDeliveryDate>UseProductPurchasePrice
Required/mandatory field
When copiing items to a new purchase order the price will be picked from the pricelist if the value is true.
": "{Boolean}",UseLatestRevisionFromStandardStructure
Required/mandatory field
When copiing item from a purchase order to a new one, if the value is true the product structure revision will be picked from the latest standard structure of the product.
": "{Boolean}",QuantityIncreaseFactor
Required/mandatory field
When copiing itemfs from a purchase order to a new one, the quantity of the items will be multiplied with this factor.
Minimum value: 1
Maximum value: 99999
Default value: 1
": "{Decimal}",RequestedDeliveryDate
Required/mandatory field
The delivery date as requested by the buyer/purchaser
": "{Date}"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 100147 HTTP 404 | Notification type not found |
| Error 103343 HTTP 400 | Illegal update : Accountingperiod {0} is closed. |
| Error 103342 HTTP 400 | Illegal Update : Accountingperiod {0} has agio calculations. |
| Error 101493 HTTP 400 | Illegal update: New VAT code has VAT percentage different from old VAT code. |
| Error 101494 HTTP 400 | Illegal VAT code: Vat code and document has different VAT number |
| Error 101496 HTTP 400 | Illegal VAT code {0}: Check VAT FromPeriod and ToPeriod |
| Error 101495 HTTP 400 | Illegal VAT code: {0} |
| Error 107641 HTTP 400 | VAT code {0} has not an active VAT code setup |
| Error 100984 HTTP 400 | Illegal update. The General ledger posting has ST>4 |
| Error 100985 HTTP 400 | Illegal update. The General ledger posting has AGIO-calculation |
| Error 108105 HTTP 400 | Linking is not allowed for project order items for which have manually accrued handling |
| Error 108106 HTTP 400 | Linking is not allowed for project order item which is based on expense log |
| Error 101469 HTTP 400 | The object is not open for edit. To change currency, the object must be in status 1. |
| Error 101562 HTTP 400 | This currency is not supported by the supplier |
| Error 101689 HTTP 400 | You cannot change this purchase order to type 'REQUISITION' as it contains standard products (type not equal to X or V). |
| Error 101690 HTTP 400 | You cannot change this purchase order to type 'REQUISITION' as it has assignments. |