API

Sales APIs

GET system/reports/108532/result-set

This report shows key figures in local and sales currency for all project orders. It is possible to get details about key figures, per category, for a single project order by on the relevant row. This will then start REPORT/108563 (Project orders key figures per category) with a filter for this project order only.

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

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
$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).
AccruedSale Decimal Total accrued revenues, in sales currency. Includes accrued revenues for both hours, material and expenses.
ConvertedAccruedCost Decimal Accrued cost/{CUR}.
ConvertedAccruedSale Decimal Accrued sale/{CUR}.
ConvertedForecastCost Decimal Forecast cost/{CUR}.
ConvertedForecastSale Decimal Forecast sale/{CUR}.
ConvertedInitialEstimatedCost Decimal Initial estimated cost/{CUR}.
ConvertedInitialEstimatedSale Decimal Initial estimated sale/{CUR}.
ConvertedInvoicedSale Decimal Invoiced sale/{CUR}.
ConvertedPendingCost Decimal Pending cost/{CUR}.
ConvertedPendingSale Decimal Pending sale/{CUR}.
ConvertedRemainingEstimatedCost Decimal Remaining estimated cost/{CUR}.
ConvertedRemainingEstimatedSale Decimal Remaining estimated sale/{CUR}.
CustomerId Integer Customer identifier.
ForecastGrossMargin Decimal Forecasted gross margin. This is calculated as ((CForecastSaleTotal - CForecastCostTotal) * 100) / CForecastSaleTotal.
ForecastSale Decimal Total forecast revenues for the project order, in sales currency. Includes forecast revenue for both hour, material and expenses for a project order with price model 'Time & material'. For price model 'Fixed price' it's equal to the sales price that is given to the customer in the belonging sales transaction.
InitialEstimatedGrossMargin Decimal Initial estimated gross margin when a project order is registered. This is calculated as ((InitialEstimatedSaleTotal - InitialEstimatedCostTotal) * 100) / InitialEstimatedSaleTotal.
InitialEstimatedSale Decimal Total initial estimated revenues at the time the project order is registered, in sales currency. Includes initial estimated revenues for both hours, material and expenses.
InvoicedSale Decimal Total invoiced revenues, in sales currency. Includes invoiced revenues for both hours, material and expenses.
Name String Name of the project order.
PendingSale Decimal Total pending revenues, in sales currency. Includes pending revenues for both hours, material and expenses.
ProjectOrderId Integer Project order identifier.
RegistrationDate Date Date of registration. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
RemainingEstimatedSale Decimal Total remaining estimated revenues, in sales currency. Includes revenues for both hours, material and expenses.
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)
AccruedSale Decimal Total accrued revenues, in sales currency. Includes accrued revenues for both hours, material and expenses.
ConvertedAccruedCost Decimal Accrued cost/{CUR}
ConvertedAccruedSale Decimal Accrued sale/{CUR}
ConvertedForecastCost Decimal Forecast cost/{CUR}
ConvertedForecastSale Decimal Forecast sale/{CUR}
ConvertedInitialEstimatedCost Decimal Initial estimated cost/{CUR}
ConvertedInitialEstimatedSale Decimal Initial estimated sale/{CUR}
ConvertedInvoicedSale Decimal Invoiced sale/{CUR}
ConvertedPendingCost Decimal Pending cost/{CUR}
ConvertedPendingSale Decimal Pending sale/{CUR}
ConvertedRemainingEstimatedCost Decimal Remaining estimated cost/{CUR}
ConvertedRemainingEstimatedSale Decimal Remaining estimated sale/{CUR}
CustomerId Integer Customer identifier
ForecastGrossMargin Decimal Forecasted gross margin. This is calculated as ((CForecastSaleTotal - CForecastCostTotal) * 100) / CForecastSaleTotal
ForecastSale Decimal Total forecast revenues for the project order, in sales currency. Includes forecast revenue for both hour, material and expenses for a project order with price model 'Time & material'. For price model 'Fixed price' it's equal to the sales price that is given to the customer in the belonging sales transaction.
InitialEstimatedGrossMargin Decimal Initial estimated gross margin when a project order is registered. This is calculated as ((InitialEstimatedSaleTotal - InitialEstimatedCostTotal) * 100) / InitialEstimatedSaleTotal
InitialEstimatedSale Decimal Total initial estimated revenues at the time the project order is registered, in sales currency. Includes initial estimated revenues for both hours, material and expenses.
InvoicedSale Decimal Total invoiced revenues, in sales currency. Includes invoiced revenues for both hours, material and expenses.
Name String Name of the project order
PendingSale Decimal Total pending revenues, in sales currency. Includes pending revenues for both hours, material and expenses.
ProjectOrderId Integer Project order identifier
RegistrationDate Date Date of registration
RemainingEstimatedSale Decimal Total remaining estimated revenues, in sales currency. Includes revenues for both hours, material and expenses.
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

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

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

Initial estimated cost/{CUR}

>{Decimal}</ConvertedInitialEstimatedCost>
22
               <InitialEstimatedSale
InitialEstimatedSale

Total initial estimated revenues at the time the project order is registered, in sales currency. Includes initial estimated revenues for both hours, material and expenses.

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

>{Decimal}</InitialEstimatedSale>
23
               <ConvertedInitialEstimatedSale
ConvertedInitialEstimatedSale

Initial estimated sale/{CUR}

>{Decimal}</ConvertedInitialEstimatedSale>
24
               <ConvertedRemainingEstimatedCost
ConvertedRemainingEstimatedCost

Remaining estimated cost/{CUR}

>{Decimal}</ConvertedRemainingEstimatedCost>
25
               <RemainingEstimatedSale
RemainingEstimatedSale

Total remaining estimated revenues, in sales currency. Includes revenues for both hours, material and expenses.

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

>{Decimal}</RemainingEstimatedSale>
26
               <ConvertedRemainingEstimatedSale
ConvertedRemainingEstimatedSale

Remaining estimated sale/{CUR}

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

>{Decimal}</ConvertedRemainingEstimatedSale>
27
               <ConvertedPendingCost
ConvertedPendingCost

Pending cost/{CUR}

>{Decimal}</ConvertedPendingCost>
28
               <PendingSale
PendingSale

Total pending revenues, in sales currency. Includes pending revenues for both hours, material and expenses.

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

>{Decimal}</PendingSale>
29
               <ConvertedPendingSale
ConvertedPendingSale

Pending sale/{CUR}

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

>{Decimal}</ConvertedPendingSale>
30
               <ConvertedAccruedCost
ConvertedAccruedCost

Accrued cost/{CUR}

>{Decimal}</ConvertedAccruedCost>
31
               <AccruedSale
AccruedSale

Total accrued revenues, in sales currency. Includes accrued revenues for both hours, material and expenses.

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

>{Decimal}</AccruedSale>
32
               <ConvertedAccruedSale
ConvertedAccruedSale

Accrued sale/{CUR}

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

>{Decimal}</ConvertedAccruedSale>
33
               <ConvertedForecastCost
ConvertedForecastCost

Forecast cost/{CUR}

>{Decimal}</ConvertedForecastCost>
34
               <ForecastSale
ForecastSale

Total forecast revenues for the project order, in sales currency. Includes forecast revenue for both hour, material and expenses for a project order with price model 'Time & material'. For price model 'Fixed price' it's equal to the sales price that is given to the customer in the belonging sales transaction.

>{Decimal}</ForecastSale>
35
               <ConvertedForecastSale
ConvertedForecastSale

Forecast sale/{CUR}

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

>{Decimal}</ConvertedForecastSale>
36
               <InvoicedSale
InvoicedSale

Total invoiced revenues, in sales currency. Includes invoiced revenues for both hours, material and expenses.

>{Decimal}</InvoicedSale>
37
               <ConvertedInvoicedSale
ConvertedInvoicedSale

Invoiced sale/{CUR}

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

>{Decimal}</ConvertedInvoicedSale>
38
               <Inspect>
39
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

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

Filter used when inspecting a line in a report.

>{String}</Filter>
41
               </Inspect>
42
          </Row>
43
     </Rows>
44
     <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

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

>
46
               <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>
47
               <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>
48
          </ColumnParameter>
49
     </ColumnParameters>
50
     <Paging
Paging

Detailed paging information for this list.

>
51
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
54
          <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>
55
          <FirstPage
FirstPage

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

>{String}</FirstPage>
56
          <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>
57
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
58
          <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>
59
          <NextPage
NextPage

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

>{String}</NextPage>
60
          <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>
61
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
63
     </Paging>
64
</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

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

": "{String}",
22
                    "convertedInitialEstimatedCost
ConvertedInitialEstimatedCost

Initial estimated cost/{CUR}

": "{Decimal}",
23
                    "initialEstimatedSale
InitialEstimatedSale

Total initial estimated revenues at the time the project order is registered, in sales currency. Includes initial estimated revenues for both hours, material and expenses.

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

": "{Decimal}",
24
                    "convertedInitialEstimatedSale
ConvertedInitialEstimatedSale

Initial estimated sale/{CUR}

": "{Decimal}",
25
                    "convertedRemainingEstimatedCost
ConvertedRemainingEstimatedCost

Remaining estimated cost/{CUR}

": "{Decimal}",
26
                    "remainingEstimatedSale
RemainingEstimatedSale

Total remaining estimated revenues, in sales currency. Includes revenues for both hours, material and expenses.

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

": "{Decimal}",
27
                    "convertedRemainingEstimatedSale
ConvertedRemainingEstimatedSale

Remaining estimated sale/{CUR}

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

": "{Decimal}",
28
                    "convertedPendingCost
ConvertedPendingCost

Pending cost/{CUR}

": "{Decimal}",
29
                    "pendingSale
PendingSale

Total pending revenues, in sales currency. Includes pending revenues for both hours, material and expenses.

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

": "{Decimal}",
30
                    "convertedPendingSale
ConvertedPendingSale

Pending sale/{CUR}

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

": "{Decimal}",
31
                    "convertedAccruedCost
ConvertedAccruedCost

Accrued cost/{CUR}

": "{Decimal}",
32
                    "accruedSale
AccruedSale

Total accrued revenues, in sales currency. Includes accrued revenues for both hours, material and expenses.

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

": "{Decimal}",
33
                    "convertedAccruedSale
ConvertedAccruedSale

Accrued sale/{CUR}

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

": "{Decimal}",
34
                    "convertedForecastCost
ConvertedForecastCost

Forecast cost/{CUR}

": "{Decimal}",
35
                    "forecastSale
ForecastSale

Total forecast revenues for the project order, in sales currency. Includes forecast revenue for both hour, material and expenses for a project order with price model 'Time & material'. For price model 'Fixed price' it's equal to the sales price that is given to the customer in the belonging sales transaction.

": "{Decimal}",
36
                    "convertedForecastSale
ConvertedForecastSale

Forecast sale/{CUR}

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

": "{Decimal}",
37
                    "invoicedSale
InvoicedSale

Total invoiced revenues, in sales currency. Includes invoiced revenues for both hours, material and expenses.

": "{Decimal}",
38
                    "convertedInvoicedSale
ConvertedInvoicedSale

Invoiced sale/{CUR}

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

": "{Decimal}",
39
                    "inspect": {
40
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

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

Filter used when inspecting a line in a report.

": "{String}"
42
                    }
43
               }
44
          ],
45
          "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

": [
46
               {
47
                    "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}",
48
                    "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}"
49
               }
50
          ]
51
     }
52
}

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