API

Sales APIs

POST sales/project-orders/{projectOrderId}/items

Resource for creating new project order item

HTTP method POST
URI https://api.rambase.net/sales/project-orders/{projectOrderId}/items
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 201
API resource identifier 4430, version 10

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>
2
     <Category
Category

Required/mandatory field

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

Applicable domain values can be found here

>
{String}</Category>
3
     <Sales>
4
          <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>
5
          <Remaining>
6
               <Quantity
Quantity

Required/mandatory field

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

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

This field is optional.

>
{Decimal}</Price>
8
          </Remaining>
9
     </Sales>
10
     <Product>
11
          <ProductId
ProductId

Required/mandatory field

Product identifier

Minimum value: 10000

>
{Integer}</ProductId>
12
     </Product>
13
     <ProductDescription
ProductDescription

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

This field is optional.

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

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

This field is optional.

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

An internal note to be added to the project order item

This field is optional.

>
{String}</InternalNote>
16
     <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.

Default value: False

This field is optional.

>
{Boolean}</IsBasedOnExpenseLog>
17
</ProjectOrderItem>
1
{
2
     "projectOrderItem": {
3
          "category
Category

Required/mandatory field

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

Applicable domain values can be found here

":
"{String}",
4
          "sales": {
5
               "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}",
6
               "remaining": {
7
                    "quantity
Quantity

Required/mandatory field

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}",
8
                    "price
Price

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

This field is optional.

":
"{Decimal}"
9
               }
10
          },
11
          "product": {
12
               "productId
ProductId

Required/mandatory field

Product identifier

Minimum value: 10000

":
"{Integer}"
13
          },
14
          "productDescription
ProductDescription

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

This field is optional.

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

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

This field is optional.

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

An internal note to be added to the project order item

This field is optional.

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

Default value: False

This field is optional.

":
"{Boolean}"
18
     }
19
}

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.
$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]
$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.

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

>
17
          <CustomerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

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

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

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

Customer reference

>
{String}</CustomerLink>
22
     </AssignmentStatus>
23
     <Product>
24
          <ProductId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

>
27
               <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

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

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

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

Material unit reference

>
{String}</MeasurementUnitLink>
31
          </Type>
32
          <ProductLink
ProductLink

Product reference

>
{String}</ProductLink>
33
     </Product>
34
     <ProductRevision>
35
          <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>
36
     </ProductRevision>
37
     <Accounting>
38
          <VATCodeDefinition>
39
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

>
{String}</VATCode>
40
          </VATCodeDefinition>
41
          <GeneralLedgerAccount>
42
               <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

General ledger account reference

>
{String}</GeneralLedgerAccountLink>
44
          </GeneralLedgerAccount>
45
          <Department
Department

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

>
46
               <DepartmentId
DepartmentId

Department identifier

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

Finance department reference

>
{String}</DepartmentLink>
48
          </Department>
49
          <FinanceProject
FinanceProject

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

>
50
               <FinanceProjectId
FinanceProjectId

Finance project identifier

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

Finance project reference

>
{String}</FinanceProjectLink>
52
          </FinanceProject>
53
     </Accounting>
54
     <InitialSalesEstimate>
55
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

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

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

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

>
{Decimal}</Quantity>
58
          <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>
59
          <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>
60
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

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

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

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

>
{Decimal}</Amount>
63
     </InitialSalesEstimate>
64
     <InitialCostEstimate>
65
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

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

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

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

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

Three character code following the ISO 4217 standard

Possible domain values can be found here

>
{String}</Currency>
71
          <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>
72
          <Remaining>
73
               <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>
74
               <Price
Price

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

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

Estimated revenues for the remaining quantity, in sales currency.

>
{Decimal}</Amount>
76
          </Remaining>
77
          <Pending>
78
               <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>
79
               <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>
80
               <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>
81
          </Pending>
82
          <Accrued>
83
               <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>
84
               <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>
85
               <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>
86
          </Accrued>
87
          <Forecast>
88
               <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>
89
               <Price
Price

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

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

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

>
{Decimal}</Amount>
91
          </Forecast>
92
          <Invoiced>
93
               <Amount
Amount

Invoiced revenues, in sales currency.

>
{Decimal}</Amount>
94
               <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

>
{Decimal}</Amount>
95
          </Invoiced>
96
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>
{String}</Currency>
97
          <Remaining>
98
               <Price
Price

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

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

Estimated revenues for the remaining quantity, in local currency.

>
{Decimal}</Amount>
100
          </Remaining>
101
          <Pending>
102
               <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.

>
{Decimal}</Price>
103
               <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.

>
{Decimal}</Amount>
104
          </Pending>
105
          <Accrued>
106
               <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.

>
{Decimal}</Price>
107
               <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.

>
{Decimal}</Amount>
108
          </Accrued>
109
          <Forecast>
110
               <Price
Price

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

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

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

>
{Decimal}</Amount>
112
          </Forecast>
113
          <Invoiced>
114
               <Amount
Amount

Invoiced revenues, in local currency

>
{Decimal}</Amount>
115
               <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.

>
{Decimal}</Amount>
116
          </Invoiced>
117
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>
{String}</Currency>
118
          <Remaining>
119
               <Price
Price

Remaining estimated cost per unit, in local currency.

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

Remaining estimated cost, in local currency.

>
{Decimal}</Amount>
121
          </Remaining>
122
          <Pending>
123
               <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.

>
{Decimal}</Price>
124
               <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.

>
{Decimal}</Amount>
125
          </Pending>
126
          <Forecast>
127
               <Price
Price

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

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

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

>
{Decimal}</Amount>
129
          </Forecast>
130
          <Accrued>
131
               <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.

>
{Decimal}</Price>
132
               <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.

>
{Decimal}</Amount>
133
          </Accrued>
134
          <NotificationId
NotificationId

Notification identifier

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

Status of the notification

Possible domain values can be found here

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

Date and time of creation

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

The message from the notification definition, expanded with parameters.

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

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

>
{String}</TranslatedMessage>
139
          <NotificationType>
140
               <NotificationTypeId
NotificationTypeId

Notification type identifier

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

Category of notification type (warning, information etc)

Possible domain values can be found here

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

Notification type reference

>
{String}</NotificationTypeLink>
143
          </NotificationType>
144
          <NotificationLink
NotificationLink

Notification reference

>
{String}</NotificationLink>
145
     </Sales>
146
</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

":
{
18
               "customerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

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

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

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

Customer reference

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

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

":
{
28
                    "measurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

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

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

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

Material unit reference

":
"{String}"
32
               },
33
               "productLink
ProductLink

Product reference

":
"{String}"
34
          },
35
          "productRevision": {
36
               "revision
Revision

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

":
"{String}"
37
          },
38
          "accounting": {
39
               "vATCodeDefinition": {
40
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

":
"{String}"
41
               },
42
               "generalLedgerAccount": {
43
                    "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

General ledger account reference

":
"{String}"
45
               },
46
               "department
Department

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

":
{
47
                    "departmentId
DepartmentId

Department identifier

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

Finance department reference

":
"{String}"
49
               },
50
               "financeProject
FinanceProject

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

":
{
51
                    "financeProjectId
FinanceProjectId

Finance project identifier

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

Finance project reference

":
"{String}"
53
               }
54
          },
55
          "initialSalesEstimate": {
56
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

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

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

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

":
"{Decimal}",
59
               "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}",
60
               "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}",
61
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

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

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

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

":
"{Decimal}"
64
          },
65
          "initialCostEstimate": {
66
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

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

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

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

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

Three character code following the ISO 4217 standard

Possible domain values can be found here

":
"{String}",
72
               "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}",
73
               "remaining": {
74
                    "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}",
75
                    "price
Price

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

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

Estimated revenues for the remaining quantity, in sales currency.

":
"{Decimal}"
77
               },
78
               "pending": {
79
                    "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}",
80
                    "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}",
81
                    "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}"
82
               },
83
               "accrued": {
84
                    "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}",
85
                    "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}",
86
                    "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}"
87
               },
88
               "forecast": {
89
                    "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}",
90
                    "price
Price

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

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

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

":
"{Decimal}"
92
               },
93
               "invoiced": {
94
                    "amount
Amount

Invoiced revenues, in sales currency.

":
"{Decimal}",
95
                    "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

":
"{Decimal}"
96
               },
97
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

":
"{String}",
98
               "remaining": {
99
                    "price
Price

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

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

Estimated revenues for the remaining quantity, in local currency.

":
"{Decimal}"
101
               },
102
               "pending": {
103
                    "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.

":
"{Decimal}",
104
                    "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.

":
"{Decimal}"
105
               },
106
               "accrued": {
107
                    "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.

":
"{Decimal}",
108
                    "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.

":
"{Decimal}"
109
               },
110
               "forecast": {
111
                    "price
Price

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

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

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

":
"{Decimal}"
113
               },
114
               "invoiced": {
115
                    "amount
Amount

Invoiced revenues, in local currency

":
"{Decimal}",
116
                    "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.

":
"{Decimal}"
117
               },
118
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

":
"{String}",
119
               "remaining": {
120
                    "price
Price

Remaining estimated cost per unit, in local currency.

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

Remaining estimated cost, in local currency.

":
"{Decimal}"
122
               },
123
               "pending": {
124
                    "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.

":
"{Decimal}",
125
                    "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.

":
"{Decimal}"
126
               },
127
               "forecast": {
128
                    "price
Price

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

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

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

":
"{Decimal}"
130
               },
131
               "accrued": {
132
                    "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.

":
"{Decimal}",
133
                    "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.

":
"{Decimal}"
134
               },
135
               "notificationId
NotificationId

Notification identifier

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

Status of the notification

Possible domain values can be found here

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

Date and time of creation

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

The message from the notification definition, expanded with parameters.

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

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

":
"{String}",
140
               "notificationType": {
141
                    "notificationTypeId
NotificationTypeId

Notification type identifier

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

Category of notification type (warning, information etc)

Possible domain values can be found here

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

Notification type reference

":
"{String}"
144
               },
145
               "notificationLink
NotificationLink

Notification reference

":
"{String}"
146
          }
147
     }
148
}

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}