API

Sales APIs

GET system/reports/108563/result-set?projectOrderId={projectOrderId}

Sub report to REP/108532. This report shows key figures in local and sales currency, per category, for project orders. It can simply be run for one project order only, by setting filter for this POD id (only the sequense number, like e.g "100012") on a row will start REP/108579 (Project order items key figures) which shows the same key figures for each item for the selected project order.

Report name Project order (POD) key figures per category
Report identifier 108563
HTTP method GET
URI https://api.rambase.net/system/reports/108563/result-set?projectOrderId={projectOrderId}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5104, version 4

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.

projectOrderId Integer, optional Project order reference

Minimum: 100000
$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
$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.
$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.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

AccruedHours Decimal Sum of all logged hours that have been approved by manager (status 4).
AccruedSaleExpenses Decimal Total accrued revenues for expenses, in sales currency.
AccruedSaleHours Decimal Total accrued revenues for hours, in sales currency.
AccruedSalematerial Decimal Total accrued revenues for material, in sales currency.
ConvertedAccruedCostExpenses Decimal Accrued cost expenses/{CUR}.
ConvertedAccruedCostHours Decimal Accrued cost hours/{CUR}.
ConvertedAccruedCostMaterial Decimal Accrued cost material/{CUR}.
ConvertedAccruedSaleExpenses Decimal Accrued sale expenses/{CUR}.
ConvertedAccruedSaleHours Decimal Accrued sale hours/{CUR}.
ConvertedAccruedSaleMaterial Decimal Accrued sale material/{CUR}.
ConvertedForecastCostExpenses Decimal Forecast cost expenses/{CUR}.
ConvertedForecastCostHours Decimal Forecast cost hours/{CUR}.
ConvertedForecastCostMaterial Decimal Forecast cost material/{CUR}.
ConvertedForecastSaleExpenses Decimal Forecast sale expenses/{CUR}.
ConvertedForecastSaleHours Decimal Forecast sale hours/{CUR}.
ConvertedForecastSaleMaterial Decimal Forecast sale material/{CUR}.
ConvertedInitialEstimatedCostExpenses Decimal Initial estimated cost expenses/{CUR}.
ConvertedInitialEstimatedCostHours Decimal Initial estimated cost hours/{CUR}.
ConvertedInitialEstimatedCostMaterial Decimal Initial estimated cost material/{CUR}.
ConvertedInitialEstimatedSaleHours Decimal Initial estimated sale hours/{CUR}.
ConvertedInitialEstimatedSaleMaterial Decimal Initial estimated sale material/{CUR}.
ConvertedInitialEstimateSaleExpenses Decimal Initial estimated sale expenses/{CUR}.
ConvertedInvoicedSaleExpenses Decimal Invoiced sale expenses/{CUR}.
ConvertedInvoicedSaleHours Decimal Invoiced sale hours/{CUR}.
ConvertedInvoicedSaleMaterial Decimal Invoiced sale material/{CUR}.
ConvertedPendingCostExpenses Decimal Pending cost expenses/{CUR}.
ConvertedPendingCostHours Decimal Pending cost hours/{CUR}.
ConvertedPendingCostMaterial Decimal Pending cost material/{CUR}.
ConvertedPendingSaleExpenses Decimal Pending sale expenses/{CUR}.
ConvertedPendingSaleHours Decimal Pending sale hours/{CUR}.
ConvertedPendingSaleMaterial Decimal Pending sale material/{CUR}.
ConvertedRemainingEstimatedCostExpenses Decimal Remaining estimated cost expenses/{CUR}.
ConvertedRemainingEstimatedCostHours Decimal Remaining estimated cost hours/{CUR}.
ConvertedRemainingEstimatedCostMaterial Decimal Remaining estimated cost material/{CUR}.
ConvertedRemainingEstimatedSaleExpenses Decimal Remaining estimated sale expenses/{CUR}.
ConvertedRemainingEstimatedSaleHours Decimal Remaining estimated sale hours/{CUR}.
ConvertedRemainingEstimatedSaleMaterial Decimal Remaining estimated sale material/{CUR}.
CustomerId Integer Customer identifier.
ForecastGrossMargin Decimal Forecasted gross margin. This is calculated as ((CForecastSaleTotal - CForecastCostTotal) * 100) / CForecastSaleTotal.
ForecastSaleExpenses Decimal Total forecasted revenues for expenses, in sales currency.
ForecastSaleHours Decimal Total forecasted revenues for hours, in sales currency..
ForecastSaleMaterial Decimal Total forecasted revenues for material, in sales currency..
InitialEstimatedGrossMargin Decimal Initial estimated gross margin when a project order is registered. This is calculated as ((InitialEstimatedSaleTotal - InitialEstimatedCostTotal) * 100) / InitialEstimatedSaleTotal.
InitialEstimatedSaleExpenses Decimal Total initial estimated revenues for expenses at the time the project order is started. In sales currency.
InitialEstimatedSaleHours Decimal Total Intial estimated revenues for hours at the time the project order is started. In sales currency.
InitialEstimatedSaleMaterial Decimal Total Intial estimated revenues for material at the time the project order is started. In sales currency.
InvoicedSaleExpenses Decimal Total invoiced revenues for expenses. In sales currency.
InvoicedSaleHours Decimal Total invoiced revenues for hours. In sales currency.
InvoicedSaleMaterial Decimal Total invoiced revenues for material. In sales currency.
Name String Name of the project order.
PendingSaleExpenses Decimal Total pending revenues for expenses. In sales currency.|.
PendingSaleHours Decimal Total pending revenues for hours, in sales currency. Revenues for hours are to be understood as pending when they are logged, but not yet approved by manager (status 3).
PendingSaleMaterial Decimal Total pending revenues for material, in sales currency. Revenues for material are to be understood as pending when the internal sales order for "Material to project order" has been created, but material is not confirmed as consumed yet.
ProjectOrderId Integer Project order identifier.
RegistrationDate Date Date of registration. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
RemainingEstimatedSaleExpenses Decimal Total remaining estimated revenues for expenses. In sales currency.
RemainingEstimatedSaleHours Decimal Total remaining estimated revenues for hours, in sales currency.
RemainingEstimatedSaleMaterial Decimal Total remaining estimated revenues for material, in sales currency.
SalesCurrency String Sales currency for project order.
Status String Status of project order.

Read more about filters and sorting on how to use sortable parameters

AccruedHours Decimal Sum of all logged hours that have been approved by manager (status 4)
AccruedSaleExpenses Decimal Total accrued revenues for expenses, in sales currency.
AccruedSaleHours Decimal Total accrued revenues for hours, in sales currency.
AccruedSalematerial Decimal Total accrued revenues for material, in sales currency.
ConvertedAccruedCostExpenses Decimal Accrued cost expenses/{CUR}
ConvertedAccruedCostHours Decimal Accrued cost hours/{CUR}
ConvertedAccruedCostMaterial Decimal Accrued cost material/{CUR}
ConvertedAccruedSaleExpenses Decimal Accrued sale expenses/{CUR}
ConvertedAccruedSaleHours Decimal Accrued sale hours/{CUR}
ConvertedAccruedSaleMaterial Decimal Accrued sale material/{CUR}
ConvertedForecastCostExpenses Decimal Forecast cost expenses/{CUR}
ConvertedForecastCostHours Decimal Forecast cost hours/{CUR}
ConvertedForecastCostMaterial Decimal Forecast cost material/{CUR}
ConvertedForecastSaleExpenses Decimal Forecast sale expenses/{CUR}
ConvertedForecastSaleHours Decimal Forecast sale hours/{CUR}
ConvertedForecastSaleMaterial Decimal Forecast sale material/{CUR}
ConvertedInitialEstimatedCostExpenses Decimal Initial estimated cost expenses/{CUR}
ConvertedInitialEstimatedCostHours Decimal Initial estimated cost hours/{CUR}
ConvertedInitialEstimatedCostMaterial Decimal Initial estimated cost material/{CUR}
ConvertedInitialEstimatedSaleHours Decimal Initial estimated sale hours/{CUR}
ConvertedInitialEstimatedSaleMaterial Decimal Initial estimated sale material/{CUR}
ConvertedInitialEstimateSaleExpenses Decimal Initial estimated sale expenses/{CUR}
ConvertedInvoicedSaleExpenses Decimal Invoiced sale expenses/{CUR}
ConvertedInvoicedSaleHours Decimal Invoiced sale hours/{CUR}
ConvertedInvoicedSaleMaterial Decimal Invoiced sale material/{CUR}
ConvertedPendingCostExpenses Decimal Pending cost expenses/{CUR}
ConvertedPendingCostHours Decimal Pending cost hours/{CUR}
ConvertedPendingCostMaterial Decimal Pending cost material/{CUR}
ConvertedPendingSaleExpenses Decimal Pending sale expenses/{CUR}
ConvertedPendingSaleHours Decimal Pending sale hours/{CUR}
ConvertedPendingSaleMaterial Decimal Pending sale material/{CUR}
ConvertedRemainingEstimatedCostExpenses Decimal Remaining estimated cost expenses/{CUR}
ConvertedRemainingEstimatedCostHours Decimal Remaining estimated cost hours/{CUR}
ConvertedRemainingEstimatedCostMaterial Decimal Remaining estimated cost material/{CUR}
ConvertedRemainingEstimatedSaleExpenses Decimal Remaining estimated sale expenses/{CUR}
ConvertedRemainingEstimatedSaleHours Decimal Remaining estimated sale hours/{CUR}
ConvertedRemainingEstimatedSaleMaterial Decimal Remaining estimated sale material/{CUR}
CustomerId Integer Customer identifier
ForecastGrossMargin Decimal Forecasted gross margin. This is calculated as ((CForecastSaleTotal - CForecastCostTotal) * 100) / CForecastSaleTotal
ForecastSaleExpenses Decimal Total forecasted revenues for expenses, in sales currency.
ForecastSaleHours Decimal Total forecasted revenues for hours, in sales currency.
ForecastSaleMaterial Decimal Total forecasted revenues for material, in sales currency.
InitialEstimatedGrossMargin Decimal Initial estimated gross margin when a project order is registered. This is calculated as ((InitialEstimatedSaleTotal - InitialEstimatedCostTotal) * 100) / InitialEstimatedSaleTotal
InitialEstimatedSaleExpenses Decimal Total initial estimated revenues for expenses at the time the project order is started. In sales currency.
InitialEstimatedSaleHours Decimal Total Intial estimated revenues for hours at the time the project order is started. In sales currency.
InitialEstimatedSaleMaterial Decimal Total Intial estimated revenues for material at the time the project order is started. In sales currency.
InvoicedSaleExpenses Decimal Total invoiced revenues for expenses. In sales currency
InvoicedSaleHours Decimal Total invoiced revenues for hours. In sales currency.
InvoicedSaleMaterial Decimal Total invoiced revenues for material. In sales currency.
Name String Name of the project order
PendingSaleExpenses Decimal Total pending revenues for expenses. In sales currency.|
PendingSaleHours Decimal Total pending revenues for hours, in sales currency. Revenues for hours are to be understood as pending when they are logged, but not yet approved by manager (status 3)
PendingSaleMaterial Decimal Total pending revenues for material, in sales currency. Revenues for material are to be understood as pending when the internal sales order for "Material to project order" has been created, but material is not confirmed as consumed yet.
ProjectOrderId Integer Project order identifier
RegistrationDate Date Date of registration
RemainingEstimatedSaleExpenses Decimal Total remaining estimated revenues for expenses. In sales currency.
RemainingEstimatedSaleHours Decimal Total remaining estimated revenues for hours, in sales currency
RemainingEstimatedSaleMaterial Decimal Total remaining estimated revenues for material, in sales currency.
SalesCurrency String Sales currency for project order
Status String Status of project order

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
<Report>
2
     <Rows>
3
          <Row>
4
               <Status
Status

Status of project order

Possible domain values can be found here

>{String}</Status>
5
               <ProjectOrder
ProjectOrder

Project order reference

>
6
                    <ProjectOrderId
ProjectOrderId

Project order identifier

>{Integer}</ProjectOrderId>
7
                    <ProjectOrderLink
ProjectOrderLink

Project order reference

>{String}</ProjectOrderLink>
8
               </ProjectOrder>
9
               <Name
Name

Name of the project order

>{String}</Name>
10
               <Customer
Customer

Customer reference

>
11
                    <CustomerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

>{String}</FirstName>
14
                    <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
15
               </Customer>
16
               <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
17
               <InitialEstimatedGM
InitialEstimatedGM

Initial estimated gross margin when a project order is registered. This is calculated as ((InitialEstimatedSaleTotal - InitialEstimatedCostTotal) * 100) / InitialEstimatedSaleTotal

>{Decimal}</InitialEstimatedGM>
18
               <ForecastGM
ForecastGM

Forecasted gross margin. This is calculated as ((CForecastSaleTotal - CForecastCostTotal) * 100) / CForecastSaleTotal

>{Decimal}</ForecastGM>
19
               <AccruedHours
AccruedHours

Sum of all logged hours that have been approved by manager (status 4)

>{Decimal}</AccruedHours>
20
               <SalesCurrency
SalesCurrency

Sales currency for project order

>{String}</SalesCurrency>
21
               <ConvertedInitialEstimatedCostExpenses
ConvertedInitialEstimatedCostExpenses

Initial estimated cost expenses/{CUR}

>{Decimal}</ConvertedInitialEstimatedCostExpenses>
22
               <ConvertedInitialEstimateSaleExpenses
ConvertedInitialEstimateSaleExpenses

Initial estimated sale expenses/{CUR}

>{Decimal}</ConvertedInitialEstimateSaleExpenses>
23
               <InitialEstimatedSaleExpenses
InitialEstimatedSaleExpenses

Total initial estimated revenues for expenses at the time the project order is started. In sales currency.

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

>{Decimal}</InitialEstimatedSaleExpenses>
24
               <ConvertedInitialEstimatedCostHours
ConvertedInitialEstimatedCostHours

Initial estimated cost hours/{CUR}

>{Decimal}</ConvertedInitialEstimatedCostHours>
25
               <ConvertedInitialEstimatedSaleHours
ConvertedInitialEstimatedSaleHours

Initial estimated sale hours/{CUR}

>{Decimal}</ConvertedInitialEstimatedSaleHours>
26
               <InitialEstimatedSaleHours
InitialEstimatedSaleHours

Total Intial estimated revenues for hours at the time the project order is started. In sales currency.

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

>{Decimal}</InitialEstimatedSaleHours>
27
               <ConvertedInitialEstimatedCostMaterial
ConvertedInitialEstimatedCostMaterial

Initial estimated cost material/{CUR}

>{Decimal}</ConvertedInitialEstimatedCostMaterial>
28
               <ConvertedInitialEstimatedSaleMaterial
ConvertedInitialEstimatedSaleMaterial

Initial estimated sale material/{CUR}

>{Decimal}</ConvertedInitialEstimatedSaleMaterial>
29
               <InitialEstimatedSaleMaterial
InitialEstimatedSaleMaterial

Total Intial estimated revenues for material at the time the project order is started. In sales currency.

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

>{Decimal}</InitialEstimatedSaleMaterial>
30
               <ConvertedRemainingEstimatedCostExpenses
ConvertedRemainingEstimatedCostExpenses

Remaining estimated cost expenses/{CUR}

>{Decimal}</ConvertedRemainingEstimatedCostExpenses>
31
               <ConvertedRemainingEstimatedSaleExpenses
ConvertedRemainingEstimatedSaleExpenses

Remaining estimated sale expenses/{CUR}

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

>{Decimal}</ConvertedRemainingEstimatedSaleExpenses>
32
               <RemainingEstimatedSaleExpenses
RemainingEstimatedSaleExpenses

Total remaining estimated revenues for expenses. In sales currency.

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

>{Decimal}</RemainingEstimatedSaleExpenses>
33
               <ConvertedRemainingEstimatedCostHours
ConvertedRemainingEstimatedCostHours

Remaining estimated cost hours/{CUR}

>{Decimal}</ConvertedRemainingEstimatedCostHours>
34
               <ConvertedRemainingEstimatedSaleHours
ConvertedRemainingEstimatedSaleHours

Remaining estimated sale hours/{CUR}

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

>{Decimal}</ConvertedRemainingEstimatedSaleHours>
35
               <RemainingEstimatedSaleHours
RemainingEstimatedSaleHours

Total remaining estimated revenues for hours, in sales currency

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

>{Decimal}</RemainingEstimatedSaleHours>
36
               <ConvertedRemainingEstimatedCostMaterial
ConvertedRemainingEstimatedCostMaterial

Remaining estimated cost material/{CUR}

>{Decimal}</ConvertedRemainingEstimatedCostMaterial>
37
               <ConvertedRemainingEstimatedSaleMaterial
ConvertedRemainingEstimatedSaleMaterial

Remaining estimated sale material/{CUR}

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

>{Decimal}</ConvertedRemainingEstimatedSaleMaterial>
38
               <RemainingEstimatedSaleMaterial
RemainingEstimatedSaleMaterial

Total remaining estimated revenues for material, in sales currency.

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

>{Decimal}</RemainingEstimatedSaleMaterial>
39
               <ConvertedPendingCostExpenses
ConvertedPendingCostExpenses

Pending cost expenses/{CUR}

>{Decimal}</ConvertedPendingCostExpenses>
40
               <ConvertedPendingSaleExpenses
ConvertedPendingSaleExpenses

Pending sale expenses/{CUR}

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

>{Decimal}</ConvertedPendingSaleExpenses>
41
               <PendingSaleExpenses
PendingSaleExpenses

Total pending revenues for expenses. In sales currency.|

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

>{Decimal}</PendingSaleExpenses>
42
               <ConvertedPendingCostHours
ConvertedPendingCostHours

Pending cost hours/{CUR}

>{Decimal}</ConvertedPendingCostHours>
43
               <ConvertedPendingSaleHours
ConvertedPendingSaleHours

Pending sale hours/{CUR}

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

>{Decimal}</ConvertedPendingSaleHours>
44
               <PendingSaleHours
PendingSaleHours

Total pending revenues for hours, in sales currency. Revenues for hours are to be understood as pending when they are logged, but not yet approved by manager (status 3)

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

>{Decimal}</PendingSaleHours>
45
               <ConvertedPendingCostMaterial
ConvertedPendingCostMaterial

Pending cost material/{CUR}

>{Decimal}</ConvertedPendingCostMaterial>
46
               <ConvertedPendingSaleMaterial
ConvertedPendingSaleMaterial

Pending sale material/{CUR}

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

>{Decimal}</ConvertedPendingSaleMaterial>
47
               <PendingSaleMaterial
PendingSaleMaterial

Total pending revenues for material, in sales currency. Revenues for material are to be understood as pending 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=Rows.Row.PendingSaleMaterial in your request URI to get this field

>{Decimal}</PendingSaleMaterial>
48
               <ConvertedAccruedCostExpenses
ConvertedAccruedCostExpenses

Accrued cost expenses/{CUR}

>{Decimal}</ConvertedAccruedCostExpenses>
49
               <ConvertedAccruedSaleExpenses
ConvertedAccruedSaleExpenses

Accrued sale expenses/{CUR}

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

>{Decimal}</ConvertedAccruedSaleExpenses>
50
               <AccruedSaleExpenses
AccruedSaleExpenses

Total accrued revenues for expenses, in sales currency.

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

>{Decimal}</AccruedSaleExpenses>
51
               <ConvertedAccruedCostHours
ConvertedAccruedCostHours

Accrued cost hours/{CUR}

>{Decimal}</ConvertedAccruedCostHours>
52
               <ConvertedAccruedSaleHours
ConvertedAccruedSaleHours

Accrued sale hours/{CUR}

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

>{Decimal}</ConvertedAccruedSaleHours>
53
               <AccruedSaleHours
AccruedSaleHours

Total accrued revenues for hours, in sales currency.

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

>{Decimal}</AccruedSaleHours>
54
               <ConvertedAccruedCostMaterial
ConvertedAccruedCostMaterial

Accrued cost material/{CUR}

>{Decimal}</ConvertedAccruedCostMaterial>
55
               <ConvertedAccruedSaleMaterial
ConvertedAccruedSaleMaterial

Accrued sale material/{CUR}

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

>{Decimal}</ConvertedAccruedSaleMaterial>
56
               <AccruedSalematerial
AccruedSalematerial

Total accrued revenues for material, in sales currency.

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

>{Decimal}</AccruedSalematerial>
57
               <ConvertedForecastCostExpenses
ConvertedForecastCostExpenses

Forecast cost expenses/{CUR}

>{Decimal}</ConvertedForecastCostExpenses>
58
               <ConvertedForecastSaleExpenses
ConvertedForecastSaleExpenses

Forecast sale expenses/{CUR}

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

>{Decimal}</ConvertedForecastSaleExpenses>
59
               <ForecastSaleExpenses
ForecastSaleExpenses

Total forecasted revenues for expenses, in sales currency.

>{Decimal}</ForecastSaleExpenses>
60
               <ConvertedForecastCostHours
ConvertedForecastCostHours

Forecast cost hours/{CUR}

>{Decimal}</ConvertedForecastCostHours>
61
               <ConvertedForecastSaleHours
ConvertedForecastSaleHours

Forecast sale hours/{CUR}

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

>{Decimal}</ConvertedForecastSaleHours>
62
               <ForecastSaleHours
ForecastSaleHours

Total forecasted revenues for hours, in sales currency.

>{Decimal}</ForecastSaleHours>
63
               <ConvertedForecastCostMaterial
ConvertedForecastCostMaterial

Forecast cost material/{CUR}

>{Decimal}</ConvertedForecastCostMaterial>
64
               <ConvertedForecastSaleMaterial
ConvertedForecastSaleMaterial

Forecast sale material/{CUR}

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

>{Decimal}</ConvertedForecastSaleMaterial>
65
               <ForecastSaleMaterial
ForecastSaleMaterial

Total forecasted revenues for material, in sales currency.

>{Decimal}</ForecastSaleMaterial>
66
               <ConvertedInvoicedSaleExpenses
ConvertedInvoicedSaleExpenses

Invoiced sale expenses/{CUR}

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

>{Decimal}</ConvertedInvoicedSaleExpenses>
67
               <InvoicedSaleExpenses
InvoicedSaleExpenses

Total invoiced revenues for expenses. In sales currency

>{Decimal}</InvoicedSaleExpenses>
68
               <ConvertedInvoicedSaleHours
ConvertedInvoicedSaleHours

Invoiced sale hours/{CUR}

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

>{Decimal}</ConvertedInvoicedSaleHours>
69
               <InvoicedSaleHours
InvoicedSaleHours

Total invoiced revenues for hours. In sales currency.

>{Decimal}</InvoicedSaleHours>
70
               <ConvertedInvoicedSaleMaterial
ConvertedInvoicedSaleMaterial

Invoiced sale material/{CUR}

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

>{Decimal}</ConvertedInvoicedSaleMaterial>
71
               <InvoicedSaleMaterial
InvoicedSaleMaterial

Total invoiced revenues for material. In sales currency.

>{Decimal}</InvoicedSaleMaterial>
72
               <Inspect>
73
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
74
                    <Filter
Filter

Filter used when inspecting a line in a report.

>{String}</Filter>
75
               </Inspect>
76
          </Row>
77
     </Rows>
78
     <ColumnParameters
ColumnParameters

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

>
79
          <ColumnParameter
ColumnParameter

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

>
80
               <Key
Key

Key that is used in description to lookup value from COS. The key is referenced by encapsulating it in curly braces.

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

>{String}</Key>
81
               <Value
Value

The value of the column parameter from COS that will be shown in the column headers referencing the column parameter key.

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

>{String}</Value>
82
          </ColumnParameter>
83
     </ColumnParameters>
84
     <Paging
Paging

Detailed paging information for this list.

>
85
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
86
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
87
          <Page
Page

Page index

>{Integer}</Page>
88
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

>{String}</FirstPageKey>
89
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
90
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

>{String}</PreviousPageKey>
91
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
92
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

>{String}</NextPageKey>
93
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
94
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

>{String}</LastPageKey>
95
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
96
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
97
     </Paging>
98
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "status
Status

Status of project order

Possible domain values can be found here

": "{String}",
6
                    "projectOrder
ProjectOrder

Project order reference

": {
7
                         "projectOrderId
ProjectOrderId

Project order identifier

": "{Integer}",
8
                         "projectOrderLink
ProjectOrderLink

Project order reference

": "{String}"
9
                    },
10
                    "name
Name

Name of the project order

": "{String}",
11
                    "customer
Customer

Customer reference

": {
12
                         "customerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

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

Customer reference

": "{String}"
16
                    },
17
                    "registrationDate
RegistrationDate

Date of registration

": "{Date}",
18
                    "initialEstimatedGM
InitialEstimatedGM

Initial estimated gross margin when a project order is registered. This is calculated as ((InitialEstimatedSaleTotal - InitialEstimatedCostTotal) * 100) / InitialEstimatedSaleTotal

": "{Decimal}",
19
                    "forecastGM
ForecastGM

Forecasted gross margin. This is calculated as ((CForecastSaleTotal - CForecastCostTotal) * 100) / CForecastSaleTotal

": "{Decimal}",
20
                    "accruedHours
AccruedHours

Sum of all logged hours that have been approved by manager (status 4)

": "{Decimal}",
21
                    "salesCurrency
SalesCurrency

Sales currency for project order

": "{String}",
22
                    "convertedInitialEstimatedCostExpenses
ConvertedInitialEstimatedCostExpenses

Initial estimated cost expenses/{CUR}

": "{Decimal}",
23
                    "convertedInitialEstimateSaleExpenses
ConvertedInitialEstimateSaleExpenses

Initial estimated sale expenses/{CUR}

": "{Decimal}",
24
                    "initialEstimatedSaleExpenses
InitialEstimatedSaleExpenses

Total initial estimated revenues for expenses at the time the project order is started. In sales currency.

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

": "{Decimal}",
25
                    "convertedInitialEstimatedCostHours
ConvertedInitialEstimatedCostHours

Initial estimated cost hours/{CUR}

": "{Decimal}",
26
                    "convertedInitialEstimatedSaleHours
ConvertedInitialEstimatedSaleHours

Initial estimated sale hours/{CUR}

": "{Decimal}",
27
                    "initialEstimatedSaleHours
InitialEstimatedSaleHours

Total Intial estimated revenues for hours at the time the project order is started. In sales currency.

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

": "{Decimal}",
28
                    "convertedInitialEstimatedCostMaterial
ConvertedInitialEstimatedCostMaterial

Initial estimated cost material/{CUR}

": "{Decimal}",
29
                    "convertedInitialEstimatedSaleMaterial
ConvertedInitialEstimatedSaleMaterial

Initial estimated sale material/{CUR}

": "{Decimal}",
30
                    "initialEstimatedSaleMaterial
InitialEstimatedSaleMaterial

Total Intial estimated revenues for material at the time the project order is started. In sales currency.

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

": "{Decimal}",
31
                    "convertedRemainingEstimatedCostExpenses
ConvertedRemainingEstimatedCostExpenses

Remaining estimated cost expenses/{CUR}

": "{Decimal}",
32
                    "convertedRemainingEstimatedSaleExpenses
ConvertedRemainingEstimatedSaleExpenses

Remaining estimated sale expenses/{CUR}

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

": "{Decimal}",
33
                    "remainingEstimatedSaleExpenses
RemainingEstimatedSaleExpenses

Total remaining estimated revenues for expenses. In sales currency.

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

": "{Decimal}",
34
                    "convertedRemainingEstimatedCostHours
ConvertedRemainingEstimatedCostHours

Remaining estimated cost hours/{CUR}

": "{Decimal}",
35
                    "convertedRemainingEstimatedSaleHours
ConvertedRemainingEstimatedSaleHours

Remaining estimated sale hours/{CUR}

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

": "{Decimal}",
36
                    "remainingEstimatedSaleHours
RemainingEstimatedSaleHours

Total remaining estimated revenues for hours, in sales currency

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

": "{Decimal}",
37
                    "convertedRemainingEstimatedCostMaterial
ConvertedRemainingEstimatedCostMaterial

Remaining estimated cost material/{CUR}

": "{Decimal}",
38
                    "convertedRemainingEstimatedSaleMaterial
ConvertedRemainingEstimatedSaleMaterial

Remaining estimated sale material/{CUR}

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

": "{Decimal}",
39
                    "remainingEstimatedSaleMaterial
RemainingEstimatedSaleMaterial

Total remaining estimated revenues for material, in sales currency.

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

": "{Decimal}",
40
                    "convertedPendingCostExpenses
ConvertedPendingCostExpenses

Pending cost expenses/{CUR}

": "{Decimal}",
41
                    "convertedPendingSaleExpenses
ConvertedPendingSaleExpenses

Pending sale expenses/{CUR}

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

": "{Decimal}",
42
                    "pendingSaleExpenses
PendingSaleExpenses

Total pending revenues for expenses. In sales currency.|

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

": "{Decimal}",
43
                    "convertedPendingCostHours
ConvertedPendingCostHours

Pending cost hours/{CUR}

": "{Decimal}",
44
                    "convertedPendingSaleHours
ConvertedPendingSaleHours

Pending sale hours/{CUR}

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

": "{Decimal}",
45
                    "pendingSaleHours
PendingSaleHours

Total pending revenues for hours, in sales currency. Revenues for hours are to be understood as pending when they are logged, but not yet approved by manager (status 3)

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

": "{Decimal}",
46
                    "convertedPendingCostMaterial
ConvertedPendingCostMaterial

Pending cost material/{CUR}

": "{Decimal}",
47
                    "convertedPendingSaleMaterial
ConvertedPendingSaleMaterial

Pending sale material/{CUR}

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

": "{Decimal}",
48
                    "pendingSaleMaterial
PendingSaleMaterial

Total pending revenues for material, in sales currency. Revenues for material are to be understood as pending 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=Rows.Row.PendingSaleMaterial in your request URI to get this field

": "{Decimal}",
49
                    "convertedAccruedCostExpenses
ConvertedAccruedCostExpenses

Accrued cost expenses/{CUR}

": "{Decimal}",
50
                    "convertedAccruedSaleExpenses
ConvertedAccruedSaleExpenses

Accrued sale expenses/{CUR}

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

": "{Decimal}",
51
                    "accruedSaleExpenses
AccruedSaleExpenses

Total accrued revenues for expenses, in sales currency.

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

": "{Decimal}",
52
                    "convertedAccruedCostHours
ConvertedAccruedCostHours

Accrued cost hours/{CUR}

": "{Decimal}",
53
                    "convertedAccruedSaleHours
ConvertedAccruedSaleHours

Accrued sale hours/{CUR}

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

": "{Decimal}",
54
                    "accruedSaleHours
AccruedSaleHours

Total accrued revenues for hours, in sales currency.

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

": "{Decimal}",
55
                    "convertedAccruedCostMaterial
ConvertedAccruedCostMaterial

Accrued cost material/{CUR}

": "{Decimal}",
56
                    "convertedAccruedSaleMaterial
ConvertedAccruedSaleMaterial

Accrued sale material/{CUR}

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

": "{Decimal}",
57
                    "accruedSalematerial
AccruedSalematerial

Total accrued revenues for material, in sales currency.

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

": "{Decimal}",
58
                    "convertedForecastCostExpenses
ConvertedForecastCostExpenses

Forecast cost expenses/{CUR}

": "{Decimal}",
59
                    "convertedForecastSaleExpenses
ConvertedForecastSaleExpenses

Forecast sale expenses/{CUR}

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

": "{Decimal}",
60
                    "forecastSaleExpenses
ForecastSaleExpenses

Total forecasted revenues for expenses, in sales currency.

": "{Decimal}",
61
                    "convertedForecastCostHours
ConvertedForecastCostHours

Forecast cost hours/{CUR}

": "{Decimal}",
62
                    "convertedForecastSaleHours
ConvertedForecastSaleHours

Forecast sale hours/{CUR}

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

": "{Decimal}",
63
                    "forecastSaleHours
ForecastSaleHours

Total forecasted revenues for hours, in sales currency.

": "{Decimal}",
64
                    "convertedForecastCostMaterial
ConvertedForecastCostMaterial

Forecast cost material/{CUR}

": "{Decimal}",
65
                    "convertedForecastSaleMaterial
ConvertedForecastSaleMaterial

Forecast sale material/{CUR}

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

": "{Decimal}",
66
                    "forecastSaleMaterial
ForecastSaleMaterial

Total forecasted revenues for material, in sales currency.

": "{Decimal}",
67
                    "convertedInvoicedSaleExpenses
ConvertedInvoicedSaleExpenses

Invoiced sale expenses/{CUR}

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

": "{Decimal}",
68
                    "invoicedSaleExpenses
InvoicedSaleExpenses

Total invoiced revenues for expenses. In sales currency

": "{Decimal}",
69
                    "convertedInvoicedSaleHours
ConvertedInvoicedSaleHours

Invoiced sale hours/{CUR}

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

": "{Decimal}",
70
                    "invoicedSaleHours
InvoicedSaleHours

Total invoiced revenues for hours. In sales currency.

": "{Decimal}",
71
                    "convertedInvoicedSaleMaterial
ConvertedInvoicedSaleMaterial

Invoiced sale material/{CUR}

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

": "{Decimal}",
72
                    "invoicedSaleMaterial
InvoicedSaleMaterial

Total invoiced revenues for material. In sales currency.

": "{Decimal}",
73
                    "inspect": {
74
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}",
75
                         "filter
Filter

Filter used when inspecting a line in a report.

": "{String}"
76
                    }
77
               }
78
          ],
79
          "columnParameters
ColumnParameters

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

": [
80
               {
81
                    "key
Key

Key that is used in description to lookup value from COS. The key is referenced by encapsulating it in curly braces.

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

": "{String}",
82
                    "value
Value

The value of the column parameter from COS that will be shown in the column headers referencing the column parameter key.

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

": "{String}"
83
               }
84
          ]
85
     }
86
}

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 104920 HTTP 400 Log text is required
Error 104921 HTTP 400 Invalid log category
Error 101281 HTTP 400 Too many {0} parameters. Maximum is {1}.
Error 100175 HTTP 400 To date must be equal to, or later than from date.
Error 105710 HTTP 400 Invalid output type