API

Sales APIs

GET system/reports/108645/result-set?fromDate={fromDate}&toDate={toDate}

Sub report to REP/108640 This report shows by default invoiced and accrued numbers incurred previous month (as in an interval) and up to last date in previous month, -in addition to forecast numbers. The numbers are grouped by project order item. The dates for interval and 'up to'can be changed as an ordinary filter.

Report name Project order (POD) accrued and invoiced numbers - by project order item
Report identifier 108645
HTTP method GET
URI https://api.rambase.net/system/reports/108645/result-set?fromDate={fromDate}&toDate={toDate}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5143, version 11

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.

fromDate Date, optional Dates from and including date

Minimum: 2000.01.01
toDate Date, optional Dates to and including date

Minimum: 2000.01.01
$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.

Category String The category of this project order item: Material, Hours or Expenses.
ConvertedForecastCostAmount Decimal Forecasted cost, in local currency. Is a sum of remaining, pending anc accrued cost in local currency.
ConvertedForecastSaleAmount Decimal Forecasted revenues, in local currency. Is a sum of remaining, pending and accrued revenues in local currency.
CustomerId Integer Customer identifier.
DepartmentId Integer Department identifier.
FinanceProjectId Integer Finance project identifier.
InternalNote String An internal note to be added to the project order item.
Name String Name of the project order.
Note String A note to be added to the project order item. Will typically be printed.
PricingModel String States if there are a fixed price for the project order, or if price will be based on time and material.
ProductDescription String Description of the product.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProjectOrderId Integer Project order identifier.
ProjectOrderItemId Integer Project order item identifier.
Status Integer Status of the project order item.

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

ProjectOrderItemId Integer Project order item identifier

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 the project order item

Possible domain values can be found here

>{Integer}</Status>
5
               <ProjectOrderItem
ProjectOrderItem

Project order item reference

>
6
                    <ProjectOrderItemId
ProjectOrderItemId

Project order item identifier

>{Integer}</ProjectOrderItemId>
7
                    <ProjectOrder
ProjectOrder

Project order reference

>
8
                         <ProjectOrderId
ProjectOrderId

Project order identifier

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

Project order reference

>{String}</ProjectOrderLink>
10
                    </ProjectOrder>
11
                    <ProjectOrderItemLink
ProjectOrderItemLink

Project order item reference

>{String}</ProjectOrderItemLink>
12
               </ProjectOrderItem>
13
               <PricingModel
PricingModel

States if there are a fixed price for the project order, or if price will be based on time and material

Possible domain values can be found here

>{String}</PricingModel>
14
               <Customer
Customer

Customer reference

>
15
                    <CustomerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

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

Customer reference

>{String}</CustomerLink>
19
               </Customer>
20
               <Name
Name

Name of the project order

>{String}</Name>
21
               <Product
Product

Product reference

>
22
                    <ProductId
ProductId

Product identifier

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

Name of the product

>{String}</Name>
24
                    <Description
Description

Description of the product

>{String}</Description>
25
                    <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
26
               </Product>
27
               <AccruedCostInterval
AccruedCostInterval

Accrued cost {FROMDATE}-{TODATE}

>{Decimal}</AccruedCostInterval>
28
               <AccruedSaleInterval
AccruedSaleInterval

Accrued sale {FROMDATE}-{TODATE}

>{Decimal}</AccruedSaleInterval>
29
               <InvoicedInterval
InvoicedInterval

Invoiced {FROMDATE}-{TODATE}

>{Decimal}</InvoicedInterval>
30
               <AccruedCostToDate
AccruedCostToDate

Accrued cost up to {TODATE}

>{Decimal}</AccruedCostToDate>
31
               <AccruedSaleToDate
AccruedSaleToDate

Accrued sale up to {TODATE}

>{Decimal}</AccruedSaleToDate>
32
               <InvoicedToDate
InvoicedToDate

Invoiced up to {TODATE}

>{Decimal}</InvoicedToDate>
33
               <ConvertedForecastCostAmount
ConvertedForecastCostAmount

Forecast cost/{CUR}

>{Decimal}</ConvertedForecastCostAmount>
34
               <ConvertedForecastSaleAmount
ConvertedForecastSaleAmount

Forecast sale/{CUR}

>{Decimal}</ConvertedForecastSaleAmount>
35
               <Category
Category

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

Possible domain values can be found here

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

>{String}</Category>
36
               <Note
Note

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

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

>{String}</Note>
37
               <Department
Department

Department reference. One of the system/fixed account dimensions.

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

>
38
                    <DepartmentId
DepartmentId

Department identifier

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

>{Integer}</DepartmentId>
39
                    <Name
Name

Name of finance project

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

>{String}</Name>
40
                    <DepartmentLink
DepartmentLink

Finance department reference

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

>{String}</DepartmentLink>
41
               </Department>
42
               <FinanceProject
FinanceProject

Finance project reference. One of the system/fixed account dimensions.

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

>
43
                    <FinanceProjectId
FinanceProjectId

Finance project identifier

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

>{Integer}</FinanceProjectId>
44
                    <Name
Name

Name of finance project

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

>{String}</Name>
45
                    <FinanceProjectLink
FinanceProjectLink

Finance project reference

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

>{String}</FinanceProjectLink>
46
               </FinanceProject>
47
               <InternalNote
InternalNote

An internal note to be added to the project order item

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

>{String}</InternalNote>
48
               <Inspect>
49
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

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

Filter used when inspecting a line in a report.

>{String}</Filter>
51
               </Inspect>
52
          </Row>
53
     </Rows>
54
     <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

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

>
56
               <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>
57
               <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>
58
          </ColumnParameter>
59
     </ColumnParameters>
60
     <Paging
Paging

Detailed paging information for this list.

>
61
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
64
          <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>
65
          <FirstPage
FirstPage

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

>{String}</FirstPage>
66
          <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>
67
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
68
          <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>
69
          <NextPage
NextPage

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

>{String}</NextPage>
70
          <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>
71
          <LastPage
LastPage

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

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

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

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

Status of the project order item

Possible domain values can be found here

": "{Integer}",
6
                    "projectOrderItem
ProjectOrderItem

Project order item reference

": {
7
                         "projectOrderItemId
ProjectOrderItemId

Project order item identifier

": "{Integer}",
8
                         "projectOrder
ProjectOrder

Project order reference

": {
9
                              "projectOrderId
ProjectOrderId

Project order identifier

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

Project order reference

": "{String}"
11
                         },
12
                         "projectOrderItemLink
ProjectOrderItemLink

Project order item reference

": "{String}"
13
                    },
14
                    "pricingModel
PricingModel

States if there are a fixed price for the project order, or if price will be based on time and material

Possible domain values can be found here

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

Customer reference

": {
16
                         "customerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

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

Customer reference

": "{String}"
20
                    },
21
                    "name
Name

Name of the project order

": "{String}",
22
                    "product
Product

Product reference

": {
23
                         "productId
ProductId

Product identifier

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

Name of the product

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

Description of the product

": "{String}",
26
                         "productLink
ProductLink

Product reference

": "{String}"
27
                    },
28
                    "accruedCostInterval
AccruedCostInterval

Accrued cost {FROMDATE}-{TODATE}

": "{Decimal}",
29
                    "accruedSaleInterval
AccruedSaleInterval

Accrued sale {FROMDATE}-{TODATE}

": "{Decimal}",
30
                    "invoicedInterval
InvoicedInterval

Invoiced {FROMDATE}-{TODATE}

": "{Decimal}",
31
                    "accruedCostToDate
AccruedCostToDate

Accrued cost up to {TODATE}

": "{Decimal}",
32
                    "accruedSaleToDate
AccruedSaleToDate

Accrued sale up to {TODATE}

": "{Decimal}",
33
                    "invoicedToDate
InvoicedToDate

Invoiced up to {TODATE}

": "{Decimal}",
34
                    "convertedForecastCostAmount
ConvertedForecastCostAmount

Forecast cost/{CUR}

": "{Decimal}",
35
                    "convertedForecastSaleAmount
ConvertedForecastSaleAmount

Forecast sale/{CUR}

": "{Decimal}",
36
                    "category
Category

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

Possible domain values can be found here

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

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

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

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

": "{String}",
38
                    "department
Department

Department reference. One of the system/fixed account dimensions.

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

": {
39
                         "departmentId
DepartmentId

Department identifier

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

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

Name of finance project

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

": "{String}",
41
                         "departmentLink
DepartmentLink

Finance department reference

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

": "{String}"
42
                    },
43
                    "financeProject
FinanceProject

Finance project reference. One of the system/fixed account dimensions.

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

": {
44
                         "financeProjectId
FinanceProjectId

Finance project identifier

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

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

Name of finance project

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

": "{String}",
46
                         "financeProjectLink
FinanceProjectLink

Finance project reference

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

": "{String}"
47
                    },
48
                    "internalNote
InternalNote

An internal note to be added to the project order item

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

": "{String}",
49
                    "inspect": {
50
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

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

Filter used when inspecting a line in a report.

": "{String}"
52
                    }
53
               }
54
          ],
55
          "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

": [
56
               {
57
                    "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}",
58
                    "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}"
59
               }
60
          ]
61
     }
62
}

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 102120 HTTP 404 Delivery project not found
Error 101420 HTTP 404 Setting definition not found
Error 100175 HTTP 400 To date must be equal to, or later than from date.
Error 105710 HTTP 400 Invalid output type