API

Finance APIs

GET finance/cash-flow-forecast?periodType={periodType}&periodCount={periodCount}&parentCategoryId={parentCategoryId}

A list of cash flow forecast categories for the selected forecast horizon. Categories may represent either top-level categories or subcategories within a hierarchical forecast structure. Each category includes forecast amounts grouped by period

HTTP method GET
URI https://api.rambase.net/finance/cash-flow-forecast?periodType={periodType}&periodCount={periodCount}&parentCategoryId={parentCategoryId}
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 200
API resource identifier 7317, 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.

periodCount Integer, required Number of forecast periods to be generated based on the selected time period

Minimum: 1,
Maximum: 12
periodType String, required Time unit used to divide the cash flow forecast into periods, e.g. day, week, or month.
parentCategoryId Integer, optional Identifier of cash flow forecast category, e.g. Incoming Cash Balance, Supplier Withdrawals, Manual Deposit Inputs

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

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

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
<CashFlowForecast>
2
     <CashFlowForecastCategory>
3
          <CategoryId
CategoryId

Identifier of cash flow forecast category, e.g. Incoming Cash Balance, Supplier Withdrawals, Manual Deposit Inputs

>
{Integer}</CategoryId>
4
          <Description
Description

Cash flow forecast category name

>
{String}</Description>
5
          <TranslatedDescription
TranslatedDescription

Cash flow forecast category translated name

>
{String}</TranslatedDescription>
6
          <Currency
Currency

Three character code following the ISO 4217 standard

>
{String}</Currency>
7
          <HasSubcategories
HasSubcategories

Flag indicating whether the category has a subcategory

>
{Boolean}</HasSubcategories>
8
          <PeriodAmounts
PeriodAmounts

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

>
9
               <PeriodAmount
PeriodAmount

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

>
10
                    <Period
Period

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

>
11
                         <StartDate
StartDate

Start date of the forecast period

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

>
{Date}</StartDate>
12
                         <EndDate
EndDate

End date of the forecast period

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

>
{Date}</EndDate>
13
                    </Period>
14
                    <Amount
Amount

Total cash flow forecasted amount for the selected forecast horizon.

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

>
{Decimal}</Amount>
15
               </PeriodAmount>
16
          </PeriodAmounts>
17
          <TotalAmount
TotalAmount

Total cash flow forecasted amount for the selected forecast horizon.

>
{Decimal}</TotalAmount>
18
     </CashFlowForecastCategory>
19
     <Paging
Paging

Detailed paging information for this list.

>
20
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>
{Integer}</Page>
23
          <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>
24
          <FirstPage
FirstPage

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

>
{String}</FirstPage>
25
          <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>
26
          <PreviousPage
PreviousPage

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

>
{String}</PreviousPage>
27
          <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>
28
          <NextPage
NextPage

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

>
{String}</NextPage>
29
          <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>
30
          <LastPage
LastPage

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

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

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

>
{Integer}</Size>
32
     </Paging>
33
</CashFlowForecast>
1
{
2
     "cashFlowForecast": [
3
          {
4
               "categoryId
CategoryId

Identifier of cash flow forecast category, e.g. Incoming Cash Balance, Supplier Withdrawals, Manual Deposit Inputs

":
"{Integer}",
5
               "description
Description

Cash flow forecast category name

":
"{String}",
6
               "translatedDescription
TranslatedDescription

Cash flow forecast category translated name

":
"{String}",
7
               "currency
Currency

Three character code following the ISO 4217 standard

":
"{String}",
8
               "hasSubcategories
HasSubcategories

Flag indicating whether the category has a subcategory

":
"{Boolean}",
9
               "periodAmounts
PeriodAmounts

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

":
[
10
                    {
11
                         "period
Period

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

":
{
12
                              "startDate
StartDate

Start date of the forecast period

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

":
"{Date}",
13
                              "endDate
EndDate

End date of the forecast period

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

":
"{Date}"
14
                         },
15
                         "amount
Amount

Total cash flow forecasted amount for the selected forecast horizon.

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

":
"{Decimal}"
16
                    }
17
               ],
18
               "totalAmount
TotalAmount

Total cash flow forecasted amount for the selected forecast horizon.

":
"{Decimal}"
19
          }
20
     ],
21
     "paging
Paging

Detailed paging information for this list.

":
{
22
          "pageSize
PageSize

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

":
"{Integer}",
23
          "position
Position

Position of the first element in the list

":
"{Integer}",
24
          "page
Page

Page index

":
"{Integer}",
25
          "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}",
26
          "firstPage
FirstPage

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

":
"{String}",
27
          "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}",
28
          "previousPage
PreviousPage

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

":
"{String}",
29
          "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}",
30
          "nextPage
NextPage

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

":
"{String}",
31
          "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}",
32
          "lastPage
LastPage

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

":
"{String}",
33
          "size
Size

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

":
"{Integer}"
34
     }
35
}

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: