API

Sales APIs

GET system/reports/114273/result-set?fromDate={fromDate}

Customer backlog grouped by Customer account and Financial project. By default report will show customer backlog 12 months ahead starting with current month - by giving a date in 'From date', month of given date will be used as first month. The 'Overdue'-column will always show overdue based on todays date. If a date in a future month is given, the full month will be used as the starting month - if report is run with a date in current month, first month will be calculated from that date. Dates in the past will be set to todays date. Backlog with no Confirmed date will use Requested date instead.

Report name Customer Backlog by Customer and PrjNo (12 months)
Report identifier 114273
HTTP method GET
URI https://api.rambase.net/system/reports/114273/result-set?fromDate={fromDate}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6169, version 4

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

fromDate Date, optional From date used to filter data
$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.

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).
FinanceProjectId Integer Finance project identifier.
SalesDistrict String A geographic district for which an individual salesperson or sales team holds responsibility.

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

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)
FinanceProjectId Integer Finance project identifier
SalesDistrict String A geographic district for which an individual salesperson or sales team holds responsibility

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

Customer reference

>
5
                    <CustomerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

>{String}</FirstName>
8
                    <SalesDistrict
SalesDistrict

A geographic district for which an individual salesperson or sales team holds responsibility

Possible domain values can be found here

>{String}</SalesDistrict>
9
                    <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
10
               </Customer>
11
               <FinanceProject
FinanceProject

The finance project related to the item. One of the system/fixed account dimensions.

>
12
                    <FinanceProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

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

Finance project reference

>{String}</FinanceProjectLink>
15
               </FinanceProject>
16
               <BacklogAmounts
BacklogAmounts

Backlog amounts in object currency

>
17
                    <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
18
                    <Overdue
Overdue

Overdue amount

>{Decimal}</Overdue>
19
                    <Month1
Month1

{MONTH1}

>{Decimal}</Month1>
20
                    <Month2
Month2

{MONTH2}

>{Decimal}</Month2>
21
                    <Month3
Month3

{MONTH3}

>{Decimal}</Month3>
22
                    <Month4
Month4

{MONTH4}

>{Decimal}</Month4>
23
                    <Month5
Month5

{MONTH5}

>{Decimal}</Month5>
24
                    <Month6
Month6

{MONTH6}

>{Decimal}</Month6>
25
                    <Month7
Month7

{MONTH7}

>{Decimal}</Month7>
26
                    <Month8
Month8

{MONTH8}

>{Decimal}</Month8>
27
                    <Month9
Month9

{MONTH9}

>{Decimal}</Month9>
28
                    <Month10
Month10

{MONTH10}

>{Decimal}</Month10>
29
                    <Month11
Month11

{MONTH11}

>{Decimal}</Month11>
30
                    <Month12
Month12

{MONTH12}

>{Decimal}</Month12>
31
               </BacklogAmounts>
32
               <Inspect>
33
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
34
               </Inspect>
35
          </Row>
36
     </Rows>
37
     <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

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

>
39
               <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>
40
               <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>
41
          </ColumnParameter>
42
     </ColumnParameters>
43
     <Paging
Paging

Detailed paging information for this list.

>
44
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
47
          <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>
48
          <FirstPage
FirstPage

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

>{String}</FirstPage>
49
          <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>
50
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
51
          <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>
52
          <NextPage
NextPage

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

>{String}</NextPage>
53
          <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>
54
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
56
     </Paging>
57
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "customer
Customer

Customer reference

": {
6
                         "customerId
CustomerId

Customer identifier

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

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

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

Secondary name of a company or firstname of a person

": "{String}",
9
                         "salesDistrict
SalesDistrict

A geographic district for which an individual salesperson or sales team holds responsibility

Possible domain values can be found here

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

Customer reference

": "{String}"
11
                    },
12
                    "financeProject
FinanceProject

The finance project related to the item. One of the system/fixed account dimensions.

": {
13
                         "financeProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

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

Finance project reference

": "{String}"
16
                    },
17
                    "backlogAmounts
BacklogAmounts

Backlog amounts in object currency

": {
18
                         "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
19
                         "overdue
Overdue

Overdue amount

": "{Decimal}",
20
                         "month1
Month1

{MONTH1}

": "{Decimal}",
21
                         "month2
Month2

{MONTH2}

": "{Decimal}",
22
                         "month3
Month3

{MONTH3}

": "{Decimal}",
23
                         "month4
Month4

{MONTH4}

": "{Decimal}",
24
                         "month5
Month5

{MONTH5}

": "{Decimal}",
25
                         "month6
Month6

{MONTH6}

": "{Decimal}",
26
                         "month7
Month7

{MONTH7}

": "{Decimal}",
27
                         "month8
Month8

{MONTH8}

": "{Decimal}",
28
                         "month9
Month9

{MONTH9}

": "{Decimal}",
29
                         "month10
Month10

{MONTH10}

": "{Decimal}",
30
                         "month11
Month11

{MONTH11}

": "{Decimal}",
31
                         "month12
Month12

{MONTH12}

": "{Decimal}"
32
                    },
33
                    "inspect": {
34
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
35
                    }
36
               }
37
          ],
38
          "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

": [
39
               {
40
                    "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}",
41
                    "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}"
42
               }
43
          ]
44
     }
45
}

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 100027 HTTP 400 Missing mandatory parameter {0}
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