Sales APIs
Copy project order to new project order. This is an API operation. Read the documentation pages for more information about API operations.
| HTTP method | POST |
| URI | https://api.rambase.net/sales/project-orders/{projectOrderId}/api-operations/101591/instances |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {projectOrderId} |
Project order identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 5669, 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.
Currency
Required/mandatory field
Three character code following the ISO 4217 standard
Applicable domain values can be found here
Input must match the following regular expression pattern: ^[A-Z]{3}$
>{String}</Currency>Name
Name of the project order
This field is optional.
>{String}</Name>IsInternal
True if this is an internal project order
Default value: False
This field is optional.
>{Boolean}</IsInternal>Description
Description of the project order
This field is optional.
>{String}</Description>Pricing
Used at copy of project order to new project order. States if remaining estimated price should be copied to the new project order item, or if lowest applicable price should be used
This field is optional.
>{String}</Pricing>CopyInternalNote
Used at copy of project order to new project order. States if internal note should be copied to the new project order item
Default value: False
This field is optional.
>{Boolean}</CopyInternalNote>CopyItemAccounting
Used at copy of project order to new project order. States if accounting fields in the old project order item should be copied to the new project order item
Default value: False
This field is optional.
>{Boolean}</CopyItemAccounting>CopyProductDescription
Used at copy of project order to new project order. States if product description should be copied to the new project order item
Default value: False
This field is optional.
>{Boolean}</CopyProductDescription>CopyProjectMembers
Used at copy of project order to new project order. States if project members should be copied to the new project order
Default value: False
This field is optional.
>{Boolean}</CopyProjectMembers>Accounting
This field is optional.
>Department
Accounting department to be used as a default for items that are created for project order
This field is optional.
>DepartmentId
Department identifier
Minimum value: 1
This field is optional.
>{Integer}</DepartmentId>FinanceProject
The finance project related to the project order. One of the system/fixed account dimensions.
This field is optional.
>FinanceProjectId
Finance project identifier
Minimum value: 1
This field is optional.
>{Integer}</FinanceProjectId>Customer
This field is optional.
>CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
>{Integer}</CustomerId>ShippingAddress
This field is optional.
>AddressId
Address identifier
Minimum value: 1
This field is optional.
>{Integer}</AddressId>Responsible
Reference to the user who is responsible project manger for this project order
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>Currency
Required/mandatory field
Three character code following the ISO 4217 standard
Applicable domain values can be found here
Input must match the following regular expression pattern: ^[A-Z]{3}$
": "{String}",Name
Name of the project order
This field is optional.
": "{String}",IsInternal
True if this is an internal project order
Default value: False
This field is optional.
": "{Boolean}",Description
Description of the project order
This field is optional.
": "{String}",Pricing
Used at copy of project order to new project order. States if remaining estimated price should be copied to the new project order item, or if lowest applicable price should be used
This field is optional.
": "{String}",CopyInternalNote
Used at copy of project order to new project order. States if internal note should be copied to the new project order item
Default value: False
This field is optional.
": "{Boolean}",CopyItemAccounting
Used at copy of project order to new project order. States if accounting fields in the old project order item should be copied to the new project order item
Default value: False
This field is optional.
": "{Boolean}",CopyProductDescription
Used at copy of project order to new project order. States if product description should be copied to the new project order item
Default value: False
This field is optional.
": "{Boolean}",CopyProjectMembers
Used at copy of project order to new project order. States if project members should be copied to the new project order
Default value: False
This field is optional.
": "{Boolean}",Accounting
This field is optional.
": {Department
Accounting department to be used as a default for items that are created for project order
This field is optional.
": {DepartmentId
Department identifier
Minimum value: 1
This field is optional.
": "{Integer}"FinanceProject
The finance project related to the project order. One of the system/fixed account dimensions.
This field is optional.
": {FinanceProjectId
Finance project identifier
Minimum value: 1
This field is optional.
": "{Integer}"Customer
This field is optional.
": {CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
": "{Integer}"ShippingAddress
This field is optional.
": {AddressId
Address identifier
Minimum value: 1
This field is optional.
": "{Integer}"Responsible
Reference to the user who is responsible project manger for this project order
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"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 101146 HTTP 400 | Freight calculation mode is not valid |
| Error 101078 HTTP 400 | KID could not be created due to missing setup for company |
| Error 102464 HTTP 400 | Cannot register due to notification in item {0}: {1} |
| Error 102465 HTTP 400 | Cannot register due to notification: {0} |
| Error 107467 HTTP 400 | A valid customer has to be selected before registration is allowed |
| Error 101915 HTTP 400 | The total quantity on the sales order item must be forwarded because picking is in progress |
| Error 101047 HTTP 400 | The purchase quote item has too low available quantity |
| Error 105091 HTTP 400 | Forward is not allowed because there exists an order change request in edit status |
| Error 106088 HTTP 400 | You can not forward just a part of the quantity for products of this type (WP) |
| 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 109539 HTTP 400 | Dimension value {0} could not be used : Check its FromPeriod and ToPeriod. |
| Error 102486 HTTP 400 | Invalid value for dimension {0} |