API

Sales APIs

GET system/reports/107970/result-set

This report lists sales quote items which are linked to project orders. Some of the columns show information from the sales quote and some from the related project order. It is possible to create filter based on the columns that shows information from sales quote.

Report name Sales quote (CQU) items with information from related project orders (POD)
Report identifier 107970
HTTP method GET
URI https://api.rambase.net/system/reports/107970/result-set
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5007, version 9

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.

ConvertedGrossAmount Decimal Gross amount/{CUR}.
ConvertedGrossPrice Decimal Gross price/{CUR}.
CustomerFirstName String Secondary name of a company or firstname of a person.
CustomerId Integer Customer identifier.
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
Date Date Date when the document was issued. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ExpirationDate Date The date the sales quote expires. The quote will be active to and including this date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
GrossAmount Decimal Represents the item amount before any discounts etc. is applied.
GrossPrice Decimal Represents the price per unit before any discounting is applied.
ProductDescription String Description of the product.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProjectOrderId Integer Project order identifier.
Quantity Decimal Number of units quoted.
SalesCurrency String Document currency used by Sales Quote and Project Order.
SalesQuoteId Integer Sales quote identifier.
SalesQuoteItemId Integer Sales quote item identifier.
Status String Status of the sales quote item.

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

ConvertedGrossAmount Decimal Gross amount/{CUR}
ConvertedGrossPrice Decimal Gross price/{CUR}
CustomerFirstName String Secondary name of a company or firstname of a person
CustomerId Integer Customer identifier
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
Date Date Date when the document was issued.
ExpirationDate Date The date the sales quote expires. The quote will be active to and including this date.
GrossAmount Decimal Represents the item amount before any discounts etc. is applied.
GrossPrice Decimal Represents the price per unit before any discounting is applied.
ProductDescription String Description of the product
ProductId Integer Product identifier
ProductName String Name of the product
ProjectOrderId Integer Project order identifier
Quantity Decimal Number of units quoted
SalesCurrency String Document currency used by Sales Quote and Project Order
SalesQuoteId Integer Sales quote identifier
SalesQuoteItemId Integer Sales quote item identifier
Status String Status of the sales quote item

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 sales quote item

Possible domain values can be found here

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

Sales quote item reference

>
6
                    <SalesQuoteItemId
SalesQuoteItemId

Sales quote item identifier

>{Integer}</SalesQuoteItemId>
7
                    <SalesQuote
SalesQuote

Sales quote reference

>
8
                         <SalesQuoteId
SalesQuoteId

Sales quote identifier

>{Integer}</SalesQuoteId>
9
                         <SalesQuoteLink
SalesQuoteLink

Sales quote reference

>{String}</SalesQuoteLink>
10
                    </SalesQuote>
11
                    <SalesQuoteItemLink
SalesQuoteItemLink

Sales order item reference

>{String}</SalesQuoteItemLink>
12
               </SalesQuoteItem>
13
               <Customer
Customer

Customer reference

>
14
                    <CustomerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

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

Customer reference

>{String}</CustomerLink>
18
               </Customer>
19
               <Quantity
Quantity

Number of units quoted

>{Decimal}</Quantity>
20
               <Product
Product

Product reference

>
21
                    <ProductId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Product reference

>{String}</ProductLink>
25
               </Product>
26
               <Date
Date

Date when the document was issued.

>{Date}</Date>
27
               <ConvertedGrossPrice
ConvertedGrossPrice

Gross price/{CUR}

>{Decimal}</ConvertedGrossPrice>
28
               <ConvertedGrossAmount
ConvertedGrossAmount

Gross amount/{CUR}

>{Decimal}</ConvertedGrossAmount>
29
               <SalesCurrency
SalesCurrency

Document currency used by Sales Quote and 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>
30
               <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

>{Decimal}</GrossPrice>
31
               <GrossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

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

>{Decimal}</GrossAmount>
32
               <ExpirationDate
ExpirationDate

The date the sales quote expires. The quote will be active to and including this date.

>{Date}</ExpirationDate>
33
               <ProjectOrder
ProjectOrder

Project order reference

>
34
                    <ProjectOrderId
ProjectOrderId

Project order identifier

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

Project order reference

>{String}</ProjectOrderLink>
36
               </ProjectOrder>
37
               <Description
Description

Description of the project order

>{String}</Description>
38
               <ForecastHours
ForecastHours

Sum of all forecasted hours to be used in this project order

>{Decimal}</ForecastHours>
39
               <ForecastSaleTotal
ForecastSaleTotal

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.

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

>{Decimal}</ForecastSaleTotal>
40
               <ConvertedForecastSaleTotal
ConvertedForecastSaleTotal

Forecast sale total/{CUR}

>{Decimal}</ConvertedForecastSaleTotal>
41
               <Inspect>
42
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
43
               </Inspect>
44
          </Row>
45
     </Rows>
46
     <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

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

>
48
               <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>
49
               <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>
50
          </ColumnParameter>
51
     </ColumnParameters>
52
     <Paging
Paging

Detailed paging information for this list.

>
53
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
56
          <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>
57
          <FirstPage
FirstPage

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

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

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

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

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

>{String}</NextPage>
62
          <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>
63
          <LastPage
LastPage

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

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

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

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

Status of the sales quote item

Possible domain values can be found here

": "{String}",
6
                    "salesQuoteItem
SalesQuoteItem

Sales quote item reference

": {
7
                         "salesQuoteItemId
SalesQuoteItemId

Sales quote item identifier

": "{Integer}",
8
                         "salesQuote
SalesQuote

Sales quote reference

": {
9
                              "salesQuoteId
SalesQuoteId

Sales quote identifier

": "{Integer}",
10
                              "salesQuoteLink
SalesQuoteLink

Sales quote reference

": "{String}"
11
                         },
12
                         "salesQuoteItemLink
SalesQuoteItemLink

Sales order item reference

": "{String}"
13
                    },
14
                    "customer
Customer

Customer reference

": {
15
                         "customerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

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

Customer reference

": "{String}"
19
                    },
20
                    "quantity
Quantity

Number of units quoted

": "{Decimal}",
21
                    "product
Product

Product reference

": {
22
                         "productId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Product reference

": "{String}"
26
                    },
27
                    "date
Date

Date when the document was issued.

": "{Date}",
28
                    "convertedGrossPrice
ConvertedGrossPrice

Gross price/{CUR}

": "{Decimal}",
29
                    "convertedGrossAmount
ConvertedGrossAmount

Gross amount/{CUR}

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

Document currency used by Sales Quote and 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}",
31
                    "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

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

": "{Decimal}",
32
                    "grossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

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

": "{Decimal}",
33
                    "expirationDate
ExpirationDate

The date the sales quote expires. The quote will be active to and including this date.

": "{Date}",
34
                    "projectOrder
ProjectOrder

Project order reference

": {
35
                         "projectOrderId
ProjectOrderId

Project order identifier

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

Project order reference

": "{String}"
37
                    },
38
                    "description
Description

Description of the project order

": "{String}",
39
                    "forecastHours
ForecastHours

Sum of all forecasted hours to be used in this project order

": "{Decimal}",
40
                    "forecastSaleTotal
ForecastSaleTotal

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.

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

": "{Decimal}",
41
                    "convertedForecastSaleTotal
ConvertedForecastSaleTotal

Forecast sale total/{CUR}

": "{Decimal}",
42
                    "inspect": {
43
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

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

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

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