API

Sales APIs

PUT sales/project-orders/{projectOrderId}/items/{itemId}

Resource for update of project order item

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

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
<ProjectOrderItem
ProjectOrderItem

This field is optional.

>
2
     <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

This field is optional.

>{Date}</RequestedDeliveryDate>
3
     <ProductDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

This field is optional.

>{String}</ProductDescription>
4
     <Note
Note

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

This field is optional.

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

An internal note to be added to the project order item

This field is optional.

>{String}</InternalNote>
6
     <ExternalReference
ExternalReference

External item identifier, typically to an external system that interfaces RamBase

This field is optional.

>{String}</ExternalReference>
7
     <Category
Category

The category of this project order item: Material, Hours or Expenses

Applicable domain values can be found here

This field is optional.

>{String}</Category>
8
     <IsBasedOnExpenseLog
IsBasedOnExpenseLog

This is to decide if a project order item of category 'Expenses' should have its cost calculated based on expense logs (EXL), or purhase orders (SPO/SOA) and supplier invoices (SIN/SCN).
IsBasedOnExpenseLog=”True” means that EXL will be basis for cost/sale, and “Fault” means that SPO/SOA/SIN/SCN will be basis.

This field is optional.

>{Boolean}</IsBasedOnExpenseLog>
9
     <IsDependantOnSerialNumbers
IsDependantOnSerialNumbers

Determines whether or not it's required to provide valid serial numbers for project order item during its process of goods consumption confirmation

This field is optional.

>{Boolean}</IsDependantOnSerialNumbers>
10
     <EndCustomer
EndCustomer

End customer

This field is optional.

>
11
          <CustomerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

>{Integer}</CustomerId>
12
     </EndCustomer>
13
     <Product
Product

This field is optional.

>
14
          <ProductId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

>{Integer}</ProductId>
15
     </Product>
16
     <ProductRevision
ProductRevision

This field is optional.

>
17
          <Revision
Revision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

This field is optional.

>{String}</Revision>
18
     </ProductRevision>
19
     <Sales
Sales

This field is optional.

>
20
          <MarkupPercent
MarkupPercent

By default calculated based on cost price / sale when a PODITEM is created. Can be changed during the project, it will then recalculated prices.

This field is optional.

>{Decimal}</MarkupPercent>
21
          <Remaining
Remaining

This field is optional.

>
22
               <Quantity
Quantity

Remaining estimated quantity is the expected remaining quantity to deliver. Will e.g be reduced when work hours are logged, but can be manually adjusted anytime.

This field is optional.

>{Decimal}</Quantity>
23
               <Price
Price

Estimated sales price for the remaining quantity, in sales currency. May be adjusted during the process.

This field is optional.

>{Decimal}</Price>
24
          </Remaining>
25
     </Sales>
26
     <CostConverted
CostConverted

This field is optional.

>
27
          <Remaining
Remaining

This field is optional.

>
28
               <Price
Price

Remaining estimated cost per unit, in local currency.

Minimum value: 0

This field is optional.

>{Decimal}</Price>
29
          </Remaining>
30
     </CostConverted>
31
     <Accounting
Accounting

This field is optional.

>
32
          <VATCodeDefinition
VATCodeDefinition

This field is optional.

>
33
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

Minimum value: 0

This field is optional.

>{String}</VATCode>
34
          </VATCodeDefinition>
35
     </Accounting>
36
</ProjectOrderItem>
1
{
2
     "projectOrderItem
ProjectOrderItem

This field is optional.

": {
3
          "requestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

This field is optional.

": "{Date}",
4
          "productDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

This field is optional.

": "{String}",
5
          "note
Note

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

This field is optional.

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

An internal note to be added to the project order item

This field is optional.

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

External item identifier, typically to an external system that interfaces RamBase

This field is optional.

": "{String}",
8
          "category
Category

The category of this project order item: Material, Hours or Expenses

Applicable domain values can be found here

This field is optional.

": "{String}",
9
          "isBasedOnExpenseLog
IsBasedOnExpenseLog

This is to decide if a project order item of category 'Expenses' should have its cost calculated based on expense logs (EXL), or purhase orders (SPO/SOA) and supplier invoices (SIN/SCN).
IsBasedOnExpenseLog=”True” means that EXL will be basis for cost/sale, and “Fault” means that SPO/SOA/SIN/SCN will be basis.

This field is optional.

": "{Boolean}",
10
          "isDependantOnSerialNumbers
IsDependantOnSerialNumbers

Determines whether or not it's required to provide valid serial numbers for project order item during its process of goods consumption confirmation

This field is optional.

": "{Boolean}",
11
          "endCustomer
EndCustomer

End customer

This field is optional.

": {
12
               "customerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
13
          },
14
          "product
Product

This field is optional.

": {
15
               "productId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
16
          },
17
          "productRevision
ProductRevision

This field is optional.

": {
18
               "revision
Revision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

This field is optional.

": "{String}"
19
          },
20
          "sales
Sales

This field is optional.

": {
21
               "markupPercent
MarkupPercent

By default calculated based on cost price / sale when a PODITEM is created. Can be changed during the project, it will then recalculated prices.

This field is optional.

": "{Decimal}",
22
               "remaining
Remaining

This field is optional.

": {
23
                    "quantity
Quantity

Remaining estimated quantity is the expected remaining quantity to deliver. Will e.g be reduced when work hours are logged, but can be manually adjusted anytime.

This field is optional.

": "{Decimal}",
24
                    "price
Price

Estimated sales price for the remaining quantity, in sales currency. May be adjusted during the process.

This field is optional.

": "{Decimal}"
25
               }
26
          },
27
          "costConverted
CostConverted

This field is optional.

": {
28
               "remaining
Remaining

This field is optional.

": {
29
                    "price
Price

Remaining estimated cost per unit, in local currency.

Minimum value: 0

This field is optional.

": "{Decimal}"
30
               }
31
          },
32
          "accounting
Accounting

This field is optional.

": {
33
               "vATCodeDefinition
VATCodeDefinition

This field is optional.

": {
34
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

Minimum value: 0

This field is optional.

": "{String}"
35
               }
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 100027 HTTP 400 Missing mandatory parameter {0}
Error 101254 HTTP 400 Only articles with matching PARTNERID can be purchased from this supplier
Error 100050 HTTP 403 No admittance as customer {0}
Error 102189 HTTP 400 Missing mandatory parameter for goods reception item id
Error 105416 HTTP 400 Project order item can only be paused if it is active (status 4) and of category 'Hours'
Error 105412 HTTP 400 This change of status is not allowed in a project order item
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}