API

Sales APIs

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

Sub report to REP/108618 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. 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
Report identifier 108640
HTTP method GET
URI https://api.rambase.net/system/reports/108640/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 5140, version 5

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.

CustomerId Integer Customer identifier.
CustomersReference String Customers reference. Typically a person.
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
Description String Description of the project order.
ForecastGrossMargin Decimal Forecasted gross margin. This is calculated as ((CForecastSaleTotal - CForecastCostTotal) * 100) / CForecastSaleTotal.
InitialEstimatedGrossMargin Decimal Initial estimated gross margin when a project order is registered. This is calculated as ((InitialEstimatedSaleTotal - InitialEstimatedCostTotal) * 100) / InitialEstimatedSaleTotal.
InternalNote String An internal note to be added to the project order.
IsInternal Boolean True if this is an internal project order.
LocationId Integer Location identifier.
Name String Name of the project order.
Note String A note to be added to the project order. 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.
ProjectOrderId Integer Project order identifier.
RegistrationDate Date Date of registration. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ResponsibleId Integer Employee identifier. Available macros: currentUser()
Status Integer Status of project order.

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

ProjectOrderId Integer Project order 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 project order

Possible domain values can be found here

>{Integer}</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
               <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>
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
               <Name
Name

Name of the project order

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

Accrued cost {FROMDATE}-{TODATE}

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

Accrued sale {FROMDATE}-{TODATE}

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

Invoiced {FROMDATE}-{TODATE}

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

Accrued cost up to {TODATE}

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

Accrued sale up to {TODATE}

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

Invoiced up to {TODATE}

>{Decimal}</InvoicedToDate>
23
               <ForecastCostAmount
ForecastCostAmount

Total forecasted cost, in local currency, for both hours, material and expenses. Forecasted cost is a sum of remaining, pending and accrued cost.

>{Decimal}</ForecastCostAmount>
24
               <ForecastSaleAmount
ForecastSaleAmount

Total forecasted revenues, in local currency, for both hours, material and expenses. Forecasted revenues are a sum of remaining, pending and accrued revenues 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}</ForecastSaleAmount>
25
               <Description
Description

Description of the project order

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

>{String}</Description>
26
               <CustomersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

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

>{String}</CustomersReferenceNumber>
27
               <CustomersReference
CustomersReference

Customers reference. Typically a person.

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

>{String}</CustomersReference>
28
               <Responsible
Responsible

The user who has been assigned to be responsible for this object.

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

>
29
                    <EmployeeId
EmployeeId

Employee identifier

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

>{Integer}</EmployeeId>
30
                    <LastName
LastName

Last name of employee

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

>{String}</LastName>
31
                    <FirstName
FirstName

First name of employee

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

>{String}</FirstName>
32
                    <EmployeeLink
EmployeeLink

Employee reference

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

>{String}</EmployeeLink>
33
               </Responsible>
34
               <PaymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field.

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.PaymentTerms in your request URI to get this field

>{String}</PaymentTerms>
35
               <Location
Location

Location reference

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

>
36
                    <LocationId
LocationId

Location identifier

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

>{Integer}</LocationId>
37
                    <ShortName
ShortName

Unique abbreviation/short name of the location

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

>{String}</ShortName>
38
                    <LocationLink
LocationLink

Location reference

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

>{String}</LocationLink>
39
               </Location>
40
               <IsInternal
IsInternal

True if this is an internal project order

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

>{Boolean}</IsInternal>
41
               <RegistrationDate
RegistrationDate

Date of registration

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

>{Date}</RegistrationDate>
42
               <Note
Note

A note to be added to the project order. 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>
43
               <InternalNote
InternalNote

An internal note to be added to the project order

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>
44
               <InitialEstimatedGM
InitialEstimatedGM

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

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

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

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

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

>{Decimal}</ForecastGM>
46
               <Inspect>
47
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

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

Filter used when inspecting a line in a report.

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

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

>
54
               <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>
55
               <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>
56
          </ColumnParameter>
57
     </ColumnParameters>
58
     <Paging
Paging

Detailed paging information for this list.

>
59
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
62
          <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>
63
          <FirstPage
FirstPage

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

>{String}</FirstPage>
64
          <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>
65
          <PreviousPage
PreviousPage

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

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

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

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

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

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

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

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

Status of project order

Possible domain values can be found here

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

Project order reference

": {
7
                         "projectOrderId
ProjectOrderId

Project order identifier

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

Project order reference

": "{String}"
9
                    },
10
                    "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}",
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
                    "name
Name

Name of the project order

": "{String}",
18
                    "accruedCostInterval
AccruedCostInterval

Accrued cost {FROMDATE}-{TODATE}

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

Accrued sale {FROMDATE}-{TODATE}

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

Invoiced {FROMDATE}-{TODATE}

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

Accrued cost up to {TODATE}

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

Accrued sale up to {TODATE}

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

Invoiced up to {TODATE}

": "{Decimal}",
24
                    "forecastCostAmount
ForecastCostAmount

Total forecasted cost, in local currency, for both hours, material and expenses. Forecasted cost is a sum of remaining, pending and accrued cost.

": "{Decimal}",
25
                    "forecastSaleAmount
ForecastSaleAmount

Total forecasted revenues, in local currency, for both hours, material and expenses. Forecasted revenues are a sum of remaining, pending and accrued revenues 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}",
26
                    "description
Description

Description of the project order

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

": "{String}",
27
                    "customersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

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

": "{String}",
28
                    "customersReference
CustomersReference

Customers reference. Typically a person.

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

": "{String}",
29
                    "responsible
Responsible

The user who has been assigned to be responsible for this object.

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

": {
30
                         "employeeId
EmployeeId

Employee identifier

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

": "{Integer}",
31
                         "lastName
LastName

Last name of employee

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

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

First name of employee

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

": "{String}",
33
                         "employeeLink
EmployeeLink

Employee reference

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

": "{String}"
34
                    },
35
                    "paymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the customer. The due date of the sales order and sales invoice is calculated based on this field.

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.PaymentTerms in your request URI to get this field

": "{String}",
36
                    "location
Location

Location reference

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

": {
37
                         "locationId
LocationId

Location identifier

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

": "{Integer}",
38
                         "shortName
ShortName

Unique abbreviation/short name of the location

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

": "{String}",
39
                         "locationLink
LocationLink

Location reference

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

": "{String}"
40
                    },
41
                    "isInternal
IsInternal

True if this is an internal project order

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

": "{Boolean}",
42
                    "registrationDate
RegistrationDate

Date of registration

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

": "{Date}",
43
                    "note
Note

A note to be added to the project order. 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}",
44
                    "internalNote
InternalNote

An internal note to be added to the project order

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}",
45
                    "initialEstimatedGM
InitialEstimatedGM

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

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

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

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

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

": "{Decimal}",
47
                    "inspect": {
48
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

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

Filter used when inspecting a line in a report.

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

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

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