API

Sales APIs

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

Project order item details for the provided identifier

HTTP method GET
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 4094, version 64

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
1

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.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select 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
<ProjectOrderItem>
2
     <ProjectOrderItemId
ProjectOrderItemId

Project order item identifier

>{Integer}</ProjectOrderItemId>
3
     <Status
Status

Status of the project order item

Possible domain values can be found here

>{Integer}</Status>
4
     <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

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

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

>{String}</ProductDescription>
6
     <Category
Category

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

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
8
     <LineNumber
LineNumber

Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.

>{Integer}</LineNumber>
9
     <DiscountPercent
DiscountPercent

Not in use

>{Decimal}</DiscountPercent>
10
     <Note
Note

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

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

An internal note to be added to the project order item

>{String}</InternalNote>
12
     <VATPercent
VATPercent

Value added tax percent

>{Decimal}</VATPercent>
13
     <ExternalReference
ExternalReference

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

>{String}</ExternalReference>
14
     <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.

>{Boolean}</IsBasedOnExpenseLog>
15
     <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

>{Boolean}</IsDependantOnSerialNumbers>
16
     <AssignmentStatus
AssignmentStatus

Status of the internal sales order for "Material for project order' which is used for getting assignments of material for a project order item.

Possible domain values can be found here

>{Integer}</AssignmentStatus>
17
     <EndCustomer
EndCustomer

End customer

This field is greyed out because it is an expandable field. You have to add $expand=EndCustomer in your request URI to get this field

>
18
          <CustomerId
CustomerId

Customer identifier

This field is greyed out because it is an expandable field. You have to add $expand=EndCustomer in your request URI to get this field

>{Integer}</CustomerId>
19
          <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

This field is greyed out because it is an expandable field. You have to add $expand=EndCustomer in your request URI to get this field

>{String}</Name>
20
          <FirstName
FirstName

Secondary name of a company or firstname of a person

This field is greyed out because it is an expandable field. You have to add $expand=EndCustomer in your request URI to get this field

>{String}</FirstName>
21
          <VATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

This field is greyed out because it is an expandable field. You have to add $expand=EndCustomer in your request URI to get this field

>{String}</VATRegistrationNumber>
22
          <CustomerLink
CustomerLink

Customer reference

This field is greyed out because it is an expandable field. You have to add $expand=EndCustomer in your request URI to get this field

>{String}</CustomerLink>
23
     </EndCustomer>
24
     <Product>
25
          <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
26
          <Name
Name

Name of the product

>{String}</Name>
27
          <Type
Type

Type of product

Possible domain values can be found here

>{String}</Type>
28
          <MeasurementUnit
MeasurementUnit

This field is greyed out because it is an expandable field. You have to add $expand=Product.MeasurementUnit in your request URI to get this field

>
29
               <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

This field is greyed out because it is an expandable field. You have to add $expand=Product.MeasurementUnit in your request URI to get this field

>{Integer}</MeasurementUnitId>
30
               <Unit
Unit

Measurement unit (ex. mm, km, dl, kg)

This field is greyed out because it is an expandable field. You have to add $expand=Product.MeasurementUnit in your request URI to get this field

>{String}</Unit>
31
               <Precision
Precision

The precision/accuracy of the measurement (number of decimals)

This field is greyed out because it is an expandable field. You have to add $expand=Product.MeasurementUnit in your request URI to get this field

>{Integer}</Precision>
32
               <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

This field is greyed out because it is an expandable field. You have to add $expand=Product.MeasurementUnit in your request URI to get this field

>{String}</MeasurementUnitLink>
33
          </MeasurementUnit>
34
          <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
35
     </Product>
36
     <ProductRevision>
37
          <Revision
Revision

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

>{String}</Revision>
38
     </ProductRevision>
39
     <Accounting>
40
          <VATCodeDefinition>
41
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

>{String}</VATCode>
42
               <Description
Description

Description of VAT Code definition

This field is greyed out because it is an expandable field. You have to add $expand=Accounting.VATCodeDefinition.Description in your request URI to get this field

>{String}</Description>
43
          </VATCodeDefinition>
44
          <GeneralLedgerAccount>
45
               <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>{Integer}</GeneralLedgerAccountId>
46
               <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>
47
          </GeneralLedgerAccount>
48
          <Department
Department

The department related to the item. One of the system/fixed account dimensions.

>
49
               <DepartmentId
DepartmentId

Department identifier

>{Integer}</DepartmentId>
50
               <DepartmentLink
DepartmentLink

Finance department reference

>{String}</DepartmentLink>
51
          </Department>
52
          <FinanceProject
FinanceProject

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

>
53
               <FinanceProjectId
FinanceProjectId

Finance project identifier

>{Integer}</FinanceProjectId>
54
               <FinanceProjectLink
FinanceProjectLink

Finance project reference

>{String}</FinanceProjectLink>
55
          </FinanceProject>
56
     </Accounting>
57
     <InitialSalesEstimate>
58
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
59
          <MarkupPercent
MarkupPercent

A copy of markup percent at the time the project order was activated.

>{Decimal}</MarkupPercent>
60
          <Quantity
Quantity

Initial estimated quantity. Will be a copy of the forecasted value at the time the project order is activated.

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

Initial estimated sales price, in sales currency. Will be a copy of the forecasted value at the time the project order is activated.

>{Decimal}</Price>
62
          <Amount
Amount

Initial estimated revenues, in sales currency. Will be a copy of the forecasted value at the time the project order is activated.

>{Decimal}</Amount>
63
     </InitialSalesEstimate>
64
     <InitialSalesEstimateConverted
InitialSalesEstimateConverted

This field is greyed out because it is an expandable field. You have to add $expand=InitialSalesEstimateConverted in your request URI to get this field

>
65
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=InitialSalesEstimateConverted in your request URI to get this field

>{String}</Currency>
66
          <Price
Price

Initial estimated sales price, in local currency. Will not be updated after the project order has been activated.

This field is greyed out because it is an expandable field. You have to add $expand=InitialSalesEstimateConverted in your request URI to get this field

>{Decimal}</Price>
67
          <Amount
Amount

Initial estimated revenues, in local currency. Will not be updated after the project order has been activated.

This field is greyed out because it is an expandable field. You have to add $expand=InitialSalesEstimateConverted in your request URI to get this field

>{Decimal}</Amount>
68
     </InitialSalesEstimateConverted>
69
     <InitialCostEstimate>
70
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
71
          <Price
Price

Initial estimated cost pr unit, in local currency. Will not be updated after the project order has been activated.

>{Decimal}</Price>
72
          <Amount
Amount

Initial estimated cost, in local currency. Will not be updated after the project order has been activated.

>{Decimal}</Amount>
73
     </InitialCostEstimate>
74
     <Sales>
75
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
76
          <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.

>{Decimal}</MarkupPercent>
77
          <Remaining>
78
               <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.

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

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

>{Decimal}</Price>
80
               <Amount
Amount

Estimated revenues for the remaining quantity, in sales currency.

>{Decimal}</Amount>
81
          </Remaining>
82
          <Pending>
83
               <Quantity
Quantity

Pending quantity. Quantity is to be understood as pending e.g if hours are logged, but yet not approved by manager (status 3), or when the internal sales order for "Material to project order" has been created, but material is not confirmed as consumed yet.

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

Pending sales price, in sales currency. Revenues are to be understood as pending e.g when hours are logged, but not approved by manager (status 3), -or when the internal sales order for "Material to project order" has been created, but material has not been confirmed as consumed yet.

>{Decimal}</Price>
85
               <Amount
Amount

Pending revenues, in sales currency. Revenues are to be understood as pending e.g if hours are logged, but yet not approved by manager (status 3), or when the internal sales order for "Material to project order" has been created, but material is not confirmed as consumed yet.

>{Decimal}</Amount>
86
          </Pending>
87
          <Accrued>
88
               <Quantity
Quantity

Accrued quantity. Quantity that has been accrued is to be understood as e.g logged hours that are approved, or material has been confirmed as consumed.

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

Accrued sales price, in sales currency. Revenues are to be understood as accrued e.g when logged hours have been approved, or when material has been confirmed as consumed.

>{Decimal}</Price>
90
               <Amount
Amount

Accrued revenues, in sales currency. Revenues are to be understood as accrued e.g if logged hours have been approved or when material has been confirmed as consumed.

>{Decimal}</Amount>
91
          </Accrued>
92
          <Forecast>
93
               <Quantity
Quantity

Forecasted quantity is an accumulated value of RemainingQty + PendingQty + AccruedQty. It's the total quantity one expect to deliver based on the situation at the moment.

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

Forecasted sales price, in sales currency. Is calculated based on remaining, pending and accrued sales price.

>{Decimal}</Price>
95
               <Amount
Amount

Forecasted revenues, in sales currency. Is a sum of remaining, pending and accrued revenues.

>{Decimal}</Amount>
96
          </Forecast>
97
          <Invoiced>
98
               <Amount
Amount

Invoiced revenues, in sales currency.

>{Decimal}</Amount>
99
          </Invoiced>
100
          <BillableSales
BillableSales

This field is greyed out because it is an expandable field. You have to add $expand=Sales.BillableSales in your request URI to get this field

>
101
               <Amount
Amount

The total sum of billing basis, in sales currency for a specific project order, where invoice or credit note has not been created yet, or where it has been created, but is yet not registered

This field is greyed out because it is an expandable field. You have to add $expand=Sales.BillableSales in your request URI to get this field

>{Decimal}</Amount>
102
          </BillableSales>
103
     </Sales>
104
     <SalesConverted
SalesConverted

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

>
105
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

>{String}</Currency>
106
          <Remaining
Remaining

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

>
107
               <Price
Price

Estimated sales price for the remaining quantity, in local currency.

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

>{Decimal}</Price>
108
               <Amount
Amount

Estimated revenues for the remaining quantity, in local currency.

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

>{Decimal}</Amount>
109
          </Remaining>
110
          <Pending
Pending

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

>
111
               <Price
Price

Pending sales price, in local currency. Revenues are to be understood as pendig e.g if hours are logged, but yet not approved by manager (status 3), or when the internal sales order for "Material for project order" has been created, but material has been confirmed as consumed yet.

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

>{Decimal}</Price>
112
               <Amount
Amount

Pending revenues, in local currency. Revenues are to be understood as pending e.g if hours are logged, but yet not approved by manager (status 3), or when internal sales order for "Material to project order" has been created, but material has been confirmed as consumed yet.

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

>{Decimal}</Amount>
113
          </Pending>
114
          <Accrued
Accrued

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

>
115
               <Price
Price

Accrued sales price, in local currency. Revenues are understood as accrued e.g when logged hours are approved, or when material has been confirmed as consumed.

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

>{Decimal}</Price>
116
               <Amount
Amount

Accrued revenues, in local currency. Revenues are to be understood as accrued e.g if logged hours have been approved or when material has been confirmed as consumed.

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

>{Decimal}</Amount>
117
          </Accrued>
118
          <Forecast
Forecast

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

>
119
               <Price
Price

Forecasted sales price, in local currency. Is calculated based on remaining, pending and accured sales price in local currency.

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

>{Decimal}</Price>
120
               <Amount
Amount

Forecasted revenues, in local currency. Is a sum of remaining, pending and accrued revenues in local currency.

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

>{Decimal}</Amount>
121
          </Forecast>
122
          <Invoiced
Invoiced

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

>
123
               <Amount
Amount

Invoiced revenues, in local currency

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

>{Decimal}</Amount>
124
          </Invoiced>
125
          <BillableSales
BillableSales

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

>
126
               <Amount
Amount

The total sum of billing basis, in local currency for a specific project order, where invoice or credit note has not been created yet, or where it has been created, but is yet not registered.

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

>{Decimal}</Amount>
127
          </BillableSales>
128
     </SalesConverted>
129
     <CostConverted
CostConverted

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

>
130
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

>{String}</Currency>
131
          <Remaining
Remaining

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

>
132
               <Price
Price

Remaining estimated cost per unit, in local currency.

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

>{Decimal}</Price>
133
               <Amount
Amount

Remaining estimated cost, in local currency.

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

>{Decimal}</Amount>
134
          </Remaining>
135
          <Pending
Pending

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

>
136
               <Price
Price

Pending cost pr unit, in local currency. Cost is to be understood as pending e.g. when hours have been logged, but not approved by manager (status 3), -or when the internal sales order for "Material for project order" has been created, but material is not yet confirmed as consumed.

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

>{Decimal}</Price>
137
               <Amount
Amount

Pending cost, in local currency. Cost is to be understood as pending e.g if hours are logged, but yet not approved by manger (status 3), or when the internal sales order for "Material to project order" has been created, but material is not confirmed as consumed yet.

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

>{Decimal}</Amount>
138
          </Pending>
139
          <Forecast
Forecast

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

>
140
               <Price
Price

Forecasted cost pr unit, in local currency. This is calculated based on remaining, pending and accrued cost in local currency.

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

>{Decimal}</Price>
141
               <Amount
Amount

Forecasted cost, in local currency. Is a sum of remaining, pending anc accrued cost in local currency.

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

>{Decimal}</Amount>
142
          </Forecast>
143
          <Accrued
Accrued

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

>
144
               <Price
Price

Accrued cost pr unit, in local currency. Cost is to be understood as accrued e.g when logged hours have been approved, or when material has been confirmed as consumed.

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

>{Decimal}</Price>
145
               <Amount
Amount

Accrued cost, in local currency. Cost is to be understood as accrued e.g when logged hours have been approved, or when material has been confirmed as consumed.

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

>{Decimal}</Amount>
146
          </Accrued>
147
     </CostConverted>
148
     <HighlightedNotification
HighlightedNotification

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>
149
          <NotificationId
NotificationId

Notification identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{Integer}</NotificationId>
150
          <Status
Status

Status of the notification

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{Integer}</Status>
151
          <CreatedAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{Datetime}</CreatedAt>
152
          <Message
Message

The message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</Message>
153
          <TranslatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</TranslatedMessage>
154
          <NotificationType
NotificationType

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>
155
               <NotificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</NotificationTypeId>
156
               <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</Category>
157
               <NotificationTypeLink
NotificationTypeLink

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</NotificationTypeLink>
158
          </NotificationType>
159
          <NotificationLink
NotificationLink

Notification reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

>{String}</NotificationLink>
160
     </HighlightedNotification>
161
</ProjectOrderItem>
1
{
2
     "projectOrderItem": {
3
          "projectOrderItemId
ProjectOrderItemId

Project order item identifier

": "{Integer}",
4
          "status
Status

Status of the project order item

Possible domain values can be found here

": "{Integer}",
5
          "requestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

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

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

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

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

Possible domain values can be found here

": "{String}",
8
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
9
          "lineNumber
LineNumber

Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.

": "{Integer}",
10
          "discountPercent
DiscountPercent

Not in use

": "{Decimal}",
11
          "note
Note

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

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

An internal note to be added to the project order item

": "{String}",
13
          "vATPercent
VATPercent

Value added tax percent

": "{Decimal}",
14
          "externalReference
ExternalReference

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

": "{String}",
15
          "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.

": "{Boolean}",
16
          "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

": "{Boolean}",
17
          "assignmentStatus
AssignmentStatus

Status of the internal sales order for "Material for project order' which is used for getting assignments of material for a project order item.

Possible domain values can be found here

": "{Integer}",
18
          "endCustomer
EndCustomer

End customer

This field is greyed out because it is an expandable field. You have to add $expand=EndCustomer in your request URI to get this field

": {
19
               "customerId
CustomerId

Customer identifier

This field is greyed out because it is an expandable field. You have to add $expand=EndCustomer in your request URI to get this field

": "{Integer}",
20
               "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

This field is greyed out because it is an expandable field. You have to add $expand=EndCustomer in your request URI to get this field

": "{String}",
21
               "firstName
FirstName

Secondary name of a company or firstname of a person

This field is greyed out because it is an expandable field. You have to add $expand=EndCustomer in your request URI to get this field

": "{String}",
22
               "vATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

This field is greyed out because it is an expandable field. You have to add $expand=EndCustomer in your request URI to get this field

": "{String}",
23
               "customerLink
CustomerLink

Customer reference

This field is greyed out because it is an expandable field. You have to add $expand=EndCustomer in your request URI to get this field

": "{String}"
24
          },
25
          "product": {
26
               "productId
ProductId

Product identifier

": "{Integer}",
27
               "name
Name

Name of the product

": "{String}",
28
               "type
Type

Type of product

Possible domain values can be found here

": "{String}",
29
               "measurementUnit
MeasurementUnit

This field is greyed out because it is an expandable field. You have to add $expand=Product.MeasurementUnit in your request URI to get this field

": {
30
                    "measurementUnitId
MeasurementUnitId

Measurement unit identifier

This field is greyed out because it is an expandable field. You have to add $expand=Product.MeasurementUnit in your request URI to get this field

": "{Integer}",
31
                    "unit
Unit

Measurement unit (ex. mm, km, dl, kg)

This field is greyed out because it is an expandable field. You have to add $expand=Product.MeasurementUnit in your request URI to get this field

": "{String}",
32
                    "precision
Precision

The precision/accuracy of the measurement (number of decimals)

This field is greyed out because it is an expandable field. You have to add $expand=Product.MeasurementUnit in your request URI to get this field

": "{Integer}",
33
                    "measurementUnitLink
MeasurementUnitLink

Material unit reference

This field is greyed out because it is an expandable field. You have to add $expand=Product.MeasurementUnit in your request URI to get this field

": "{String}"
34
               },
35
               "productLink
ProductLink

Product reference

": "{String}"
36
          },
37
          "productRevision": {
38
               "revision
Revision

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

": "{String}"
39
          },
40
          "accounting": {
41
               "vATCodeDefinition": {
42
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

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

Description of VAT Code definition

This field is greyed out because it is an expandable field. You have to add $expand=Accounting.VATCodeDefinition.Description in your request URI to get this field

": "{String}"
44
               },
45
               "generalLedgerAccount": {
46
                    "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

": "{Integer}",
47
                    "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

": "{String}"
48
               },
49
               "department
Department

The department related to the item. One of the system/fixed account dimensions.

": {
50
                    "departmentId
DepartmentId

Department identifier

": "{Integer}",
51
                    "departmentLink
DepartmentLink

Finance department reference

": "{String}"
52
               },
53
               "financeProject
FinanceProject

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

": {
54
                    "financeProjectId
FinanceProjectId

Finance project identifier

": "{Integer}",
55
                    "financeProjectLink
FinanceProjectLink

Finance project reference

": "{String}"
56
               }
57
          },
58
          "initialSalesEstimate": {
59
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
60
               "markupPercent
MarkupPercent

A copy of markup percent at the time the project order was activated.

": "{Decimal}",
61
               "quantity
Quantity

Initial estimated quantity. Will be a copy of the forecasted value at the time the project order is activated.

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

Initial estimated sales price, in sales currency. Will be a copy of the forecasted value at the time the project order is activated.

": "{Decimal}",
63
               "amount
Amount

Initial estimated revenues, in sales currency. Will be a copy of the forecasted value at the time the project order is activated.

": "{Decimal}"
64
          },
65
          "initialSalesEstimateConverted
InitialSalesEstimateConverted

This field is greyed out because it is an expandable field. You have to add $expand=InitialSalesEstimateConverted in your request URI to get this field

": {
66
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=InitialSalesEstimateConverted in your request URI to get this field

": "{String}",
67
               "price
Price

Initial estimated sales price, in local currency. Will not be updated after the project order has been activated.

This field is greyed out because it is an expandable field. You have to add $expand=InitialSalesEstimateConverted in your request URI to get this field

": "{Decimal}",
68
               "amount
Amount

Initial estimated revenues, in local currency. Will not be updated after the project order has been activated.

This field is greyed out because it is an expandable field. You have to add $expand=InitialSalesEstimateConverted in your request URI to get this field

": "{Decimal}"
69
          },
70
          "initialCostEstimate": {
71
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
72
               "price
Price

Initial estimated cost pr unit, in local currency. Will not be updated after the project order has been activated.

": "{Decimal}",
73
               "amount
Amount

Initial estimated cost, in local currency. Will not be updated after the project order has been activated.

": "{Decimal}"
74
          },
75
          "sales": {
76
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
77
               "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.

": "{Decimal}",
78
               "remaining": {
79
                    "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.

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

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

": "{Decimal}",
81
                    "amount
Amount

Estimated revenues for the remaining quantity, in sales currency.

": "{Decimal}"
82
               },
83
               "pending": {
84
                    "quantity
Quantity

Pending quantity. Quantity is to be understood as pending e.g if hours are logged, but yet not approved by manager (status 3), or when the internal sales order for "Material to project order" has been created, but material is not confirmed as consumed yet.

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

Pending sales price, in sales currency. Revenues are to be understood as pending e.g when hours are logged, but not approved by manager (status 3), -or when the internal sales order for "Material to project order" has been created, but material has not been confirmed as consumed yet.

": "{Decimal}",
86
                    "amount
Amount

Pending revenues, in sales currency. Revenues are to be understood as pending e.g if hours are logged, but yet not approved by manager (status 3), or when the internal sales order for "Material to project order" has been created, but material is not confirmed as consumed yet.

": "{Decimal}"
87
               },
88
               "accrued": {
89
                    "quantity
Quantity

Accrued quantity. Quantity that has been accrued is to be understood as e.g logged hours that are approved, or material has been confirmed as consumed.

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

Accrued sales price, in sales currency. Revenues are to be understood as accrued e.g when logged hours have been approved, or when material has been confirmed as consumed.

": "{Decimal}",
91
                    "amount
Amount

Accrued revenues, in sales currency. Revenues are to be understood as accrued e.g if logged hours have been approved or when material has been confirmed as consumed.

": "{Decimal}"
92
               },
93
               "forecast": {
94
                    "quantity
Quantity

Forecasted quantity is an accumulated value of RemainingQty + PendingQty + AccruedQty. It's the total quantity one expect to deliver based on the situation at the moment.

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

Forecasted sales price, in sales currency. Is calculated based on remaining, pending and accrued sales price.

": "{Decimal}",
96
                    "amount
Amount

Forecasted revenues, in sales currency. Is a sum of remaining, pending and accrued revenues.

": "{Decimal}"
97
               },
98
               "invoiced": {
99
                    "amount
Amount

Invoiced revenues, in sales currency.

": "{Decimal}"
100
               },
101
               "billableSales
BillableSales

This field is greyed out because it is an expandable field. You have to add $expand=Sales.BillableSales in your request URI to get this field

": {
102
                    "amount
Amount

The total sum of billing basis, in sales currency for a specific project order, where invoice or credit note has not been created yet, or where it has been created, but is yet not registered

This field is greyed out because it is an expandable field. You have to add $expand=Sales.BillableSales in your request URI to get this field

": "{Decimal}"
103
               }
104
          },
105
          "salesConverted
SalesConverted

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

": {
106
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

": "{String}",
107
               "remaining
Remaining

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

": {
108
                    "price
Price

Estimated sales price for the remaining quantity, in local currency.

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

": "{Decimal}",
109
                    "amount
Amount

Estimated revenues for the remaining quantity, in local currency.

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

": "{Decimal}"
110
               },
111
               "pending
Pending

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

": {
112
                    "price
Price

Pending sales price, in local currency. Revenues are to be understood as pendig e.g if hours are logged, but yet not approved by manager (status 3), or when the internal sales order for "Material for project order" has been created, but material has been confirmed as consumed yet.

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

": "{Decimal}",
113
                    "amount
Amount

Pending revenues, in local currency. Revenues are to be understood as pending e.g if hours are logged, but yet not approved by manager (status 3), or when internal sales order for "Material to project order" has been created, but material has been confirmed as consumed yet.

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

": "{Decimal}"
114
               },
115
               "accrued
Accrued

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

": {
116
                    "price
Price

Accrued sales price, in local currency. Revenues are understood as accrued e.g when logged hours are approved, or when material has been confirmed as consumed.

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

": "{Decimal}",
117
                    "amount
Amount

Accrued revenues, in local currency. Revenues are to be understood as accrued e.g if logged hours have been approved or when material has been confirmed as consumed.

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

": "{Decimal}"
118
               },
119
               "forecast
Forecast

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

": {
120
                    "price
Price

Forecasted sales price, in local currency. Is calculated based on remaining, pending and accured sales price in local currency.

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

": "{Decimal}",
121
                    "amount
Amount

Forecasted revenues, in local currency. Is a sum of remaining, pending and accrued revenues in local currency.

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

": "{Decimal}"
122
               },
123
               "invoiced
Invoiced

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

": {
124
                    "amount
Amount

Invoiced revenues, in local currency

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

": "{Decimal}"
125
               },
126
               "billableSales
BillableSales

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

": {
127
                    "amount
Amount

The total sum of billing basis, in local currency for a specific project order, where invoice or credit note has not been created yet, or where it has been created, but is yet not registered.

This field is greyed out because it is an expandable field. You have to add $expand=SalesConverted in your request URI to get this field

": "{Decimal}"
128
               }
129
          },
130
          "costConverted
CostConverted

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

": {
131
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

": "{String}",
132
               "remaining
Remaining

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

": {
133
                    "price
Price

Remaining estimated cost per unit, in local currency.

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

": "{Decimal}",
134
                    "amount
Amount

Remaining estimated cost, in local currency.

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

": "{Decimal}"
135
               },
136
               "pending
Pending

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

": {
137
                    "price
Price

Pending cost pr unit, in local currency. Cost is to be understood as pending e.g. when hours have been logged, but not approved by manager (status 3), -or when the internal sales order for "Material for project order" has been created, but material is not yet confirmed as consumed.

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

": "{Decimal}",
138
                    "amount
Amount

Pending cost, in local currency. Cost is to be understood as pending e.g if hours are logged, but yet not approved by manger (status 3), or when the internal sales order for "Material to project order" has been created, but material is not confirmed as consumed yet.

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

": "{Decimal}"
139
               },
140
               "forecast
Forecast

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

": {
141
                    "price
Price

Forecasted cost pr unit, in local currency. This is calculated based on remaining, pending and accrued cost in local currency.

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

": "{Decimal}",
142
                    "amount
Amount

Forecasted cost, in local currency. Is a sum of remaining, pending anc accrued cost in local currency.

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

": "{Decimal}"
143
               },
144
               "accrued
Accrued

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

": {
145
                    "price
Price

Accrued cost pr unit, in local currency. Cost is to be understood as accrued e.g when logged hours have been approved, or when material has been confirmed as consumed.

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

": "{Decimal}",
146
                    "amount
Amount

Accrued cost, in local currency. Cost is to be understood as accrued e.g when logged hours have been approved, or when material has been confirmed as consumed.

This field is greyed out because it is an expandable field. You have to add $expand=CostConverted in your request URI to get this field

": "{Decimal}"
147
               }
148
          },
149
          "highlightedNotification
HighlightedNotification

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": {
150
               "notificationId
NotificationId

Notification identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{Integer}",
151
               "status
Status

Status of the notification

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{Integer}",
152
               "createdAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{Datetime}",
153
               "message
Message

The message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
154
               "translatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
155
               "notificationType
NotificationType

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": {
156
                    "notificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

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

Category of notification type (warning, information etc)

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}",
158
                    "notificationTypeLink
NotificationTypeLink

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}"
159
               },
160
               "notificationLink
NotificationLink

Notification reference

This field is greyed out because it is an expandable field. You have to add $expand=HighlightedNotification in your request URI to get this field

": "{String}"
161
          }
162
     }
163
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

POST
Set project order item as active
Change status from 1 to 4 in project order item
AOP/100977
POST
Pause project order item
Change status from 4 to 5 in project order item
AOP/100979
POST
Create sales order for project order item
Create a new COA based on a Project order item
AOP/101008
POST
Start picking for a project order item
Starts the picking process for a project order item
AOP/101145
POST
Update item quantity in procurement process
Updates project order item's quantity in the procurement process by performing a forward for a related sales order document
AOP/101163
POST
Pick
Performs a pick for a sales order document that is related with a specified project order item
AOP/101201
POST
Undo pick
Performs an undo pick for a sales order document that is related with a specified project order item
AOP/101203
POST
Create shipping advice for picked material
AOP/101247
POST
Close project order item
AOP/101249
POST
Reactivate project order item
Change status from 5 to 4 in project order item
AOP/101348
POST
Set project order item ready for final billing
AOP/101391
POST
Create multiple expenses
Creates multiple expenses
AOP/101664
POST
Create shipping advice for picked material with serial numbers
AOP/101680
POST
Add serial number related to goods reception
Adds a serial number to project order item that was picked by goods reception id
AOP/101694
POST
Add serial number related to product
Adds a serial number to project order item that was picked by product id
AOP/101697
POST
Reopen project order item from final billing
AOP/101715
POST
Revert serial number picking
Reverts the serial number, which was scanned during project order item picking process
AOP/101746
POST
Revert serial number unpicking
Reverts the serial number, which was scanned during project order item unpicking process
AOP/101747

Possible error codes the response might return:

Error 102120 HTTP 404 Delivery project not found
Error 100001 HTTP 404 Address not found
Error 101420 HTTP 404 Setting definition not found