API

Sales APIs

PUT sales/project-orders/{projectOrderId}

Resource for update of project order

HTTP method PUT
URI https://api.rambase.net/sales/project-orders/{projectOrderId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {projectOrderId} Project order identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 4030, version 14

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.

Format:
1
<ProjectOrder
ProjectOrder

This field is optional.

>
2
     <Name
Name

Name of the project order

This field is optional.

>{String}</Name>
3
     <Description
Description

Description of the project order

This field is optional.

>{String}</Description>
4
     <PricingModel
PricingModel

States if there are a fixed price for the project order, or if price will be based on time and material

Applicable domain values can be found here

This field is optional.

>{String}</PricingModel>
5
     <IsInternal
IsInternal

True if this is an internal project order

This field is optional.

>{Boolean}</IsInternal>
6
     <Note
Note

A note to be added to the project order. Will typically be printed.

This field is optional.

>{String}</Note>
7
     <InternalNote
InternalNote

An internal note to be added to the project order

This field is optional.

>{String}</InternalNote>
8
     <CustomersReference
CustomersReference

Customers reference. Typically a person.

This field is optional.

>{String}</CustomersReference>
9
     <CustomersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

This field is optional.

>{String}</CustomersReferenceNumber>
10
     <Currency
Currency

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}$

This field is optional.

>{String}</Currency>
11
     <ExternalReference
ExternalReference

External identifier

This field is optional.

>{String}</ExternalReference>
12
     <EstimatedStartAt
EstimatedStartAt

Estimated start date and time

This field is optional.

>{Datetime}</EstimatedStartAt>
13
     <EstimatedCompleteAt
EstimatedCompleteAt

Estimated end date and time

This field is optional.

>{Datetime}</EstimatedCompleteAt>
14
     <PercentWorkComplete
PercentWorkComplete

Work done in percentage, to be manually updated by responsible user

Minimum value: 0

Maximum value: 100

This field is optional.

>{Decimal}</PercentWorkComplete>
15
     <CalculateMarkupByDefault
CalculateMarkupByDefault

If "True" it means that new PODITEMs that are created will have markup calculated. If "False" it means that they will not have markup calculated, -means markup is disabled

This field is optional.

>{Boolean}</CalculateMarkupByDefault>
16
     <Accounting
Accounting

This field is optional.

>
17
          <Department
Department

Accounting department to be used as a default for items that are created for project order

This field is optional.

>
18
               <DepartmentId
DepartmentId

Department identifier

Minimum value: 1

This field is optional.

>{Integer}</DepartmentId>
19
          </Department>
20
          <FinanceProject
FinanceProject

The finance project related to the project order. One of the system/fixed account dimensions.

This field is optional.

>
21
               <FinanceProjectId
FinanceProjectId

Finance project identifier

Minimum value: 1

This field is optional.

>{Integer}</FinanceProjectId>
22
          </FinanceProject>
23
     </Accounting>
24
     <Customer
Customer

This field is optional.

>
25
          <CustomerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

>{Integer}</CustomerId>
26
     </Customer>
27
     <ShippingAddress
ShippingAddress

This field is optional.

>
28
          <AddressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

>{Integer}</AddressId>
29
     </ShippingAddress>
30
     <Location
Location

This field is optional.

>
31
          <LocationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

>{Integer}</LocationId>
32
     </Location>
33
     <Responsible
Responsible

Reference to the user who is responsible project manger for this project order

This field is optional.

>
34
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
35
     </Responsible>
36
</ProjectOrder>
1
{
2
     "projectOrder
ProjectOrder

This field is optional.

": {
3
          "name
Name

Name of the project order

This field is optional.

": "{String}",
4
          "description
Description

Description of the project order

This field is optional.

": "{String}",
5
          "pricingModel
PricingModel

States if there are a fixed price for the project order, or if price will be based on time and material

Applicable domain values can be found here

This field is optional.

": "{String}",
6
          "isInternal
IsInternal

True if this is an internal project order

This field is optional.

": "{Boolean}",
7
          "note
Note

A note to be added to the project order. Will typically be printed.

This field is optional.

": "{String}",
8
          "internalNote
InternalNote

An internal note to be added to the project order

This field is optional.

": "{String}",
9
          "customersReference
CustomersReference

Customers reference. Typically a person.

This field is optional.

": "{String}",
10
          "customersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

This field is optional.

": "{String}",
11
          "currency
Currency

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}$

This field is optional.

": "{String}",
12
          "externalReference
ExternalReference

External identifier

This field is optional.

": "{String}",
13
          "estimatedStartAt
EstimatedStartAt

Estimated start date and time

This field is optional.

": "{Datetime}",
14
          "estimatedCompleteAt
EstimatedCompleteAt

Estimated end date and time

This field is optional.

": "{Datetime}",
15
          "percentWorkComplete
PercentWorkComplete

Work done in percentage, to be manually updated by responsible user

Minimum value: 0

Maximum value: 100

This field is optional.

": "{Decimal}",
16
          "calculateMarkupByDefault
CalculateMarkupByDefault

If "True" it means that new PODITEMs that are created will have markup calculated. If "False" it means that they will not have markup calculated, -means markup is disabled

This field is optional.

": "{Boolean}",
17
          "accounting
Accounting

This field is optional.

": {
18
               "department
Department

Accounting department to be used as a default for items that are created for project order

This field is optional.

": {
19
                    "departmentId
DepartmentId

Department identifier

Minimum value: 1

This field is optional.

": "{Integer}"
20
               },
21
               "financeProject
FinanceProject

The finance project related to the project order. One of the system/fixed account dimensions.

This field is optional.

": {
22
                    "financeProjectId
FinanceProjectId

Finance project identifier

Minimum value: 1

This field is optional.

": "{Integer}"
23
               }
24
          },
25
          "customer
Customer

This field is optional.

": {
26
               "customerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
27
          },
28
          "shippingAddress
ShippingAddress

This field is optional.

": {
29
               "addressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

": "{Integer}"
30
          },
31
          "location
Location

This field is optional.

": {
32
               "locationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
33
          },
34
          "responsible
Responsible

Reference to the user who is responsible project manger for this project order

This field is optional.

": {
35
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
36
          }
37
     }
38
}

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.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

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. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

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 101453 HTTP 400 Rental products (type R) are not available for shipping advice
Error 103827 HTTP 400 External work is not allowed on shipping advice
Error 106562 HTTP 400 This product is blocked for sale
Error 106563 HTTP 400 This product is blocked for shipping
Error 106448 HTTP 400 A sales order item for product of type project order (WP) cannot be splitted into several items
Error 106476 HTTP 400 This type of product (WP) can only be changed into a product of the same type
Error 106408 HTTP 403 You have no permission to create subscription item in sales order
Error 106957 HTTP 400 Only rental or subscription products can be used in recurring contract's lines
Error 106962 HTTP 400 Product of this type (WP) cannot be added to this type of sales order
Error 107055 HTTP 400 The rental date can only be set back {0} days
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}