API

Finance APIs

GET system/reports/106119/result-set?date={date}&accountingPeriod={accountingPeriod}&groupBy={groupBy}&cusFilter={cusFilter}&balDue={balDue}&balCur={balCur}&balRate={balRate}&rateDate={rateDate}&inclCusSup={inclSupBalance}&include={include}&minimumCustomerBalance={minCusBalance}&customerId={customerId}

TEST version of CUSBAL report for testing new report viewer. Some additional functionality has been added øæååæ Long Description test for report output with special characters and numbers check the decription inthe csv Some more description : Essentially, a report is a short, sharp, concise document which is written for a particular purpose and audience. It generally sets outs and analyses a situation or problem, often making recommendations for future action. It is a factual paper, and needs to be clear and well-structured. A report is a written presentation of factual information based on an investigation or research. Reports form the basis for solving problems or making decisions, often in the subjects of business and the sciences. The length of reports varies; there are short memorandum (memo) reports and long reports.

Report name TEST version of CUSBAL -sæøåæ%¤#%end Long name to try if it comes in the excel option or something is cut off or hidden. letters and numbers 2132132 end of the report name
Report identifier 106119
HTTP method GET
URI https://api.rambase.net/system/reports/106119/result-set?date={date}&accountingPeriod={accountingPeriod}&groupBy={groupBy}&cusFilter={cusFilter}&balDue={balDue}&balCur={balCur}&balRate={balRate}&rateDate={rateDate}&inclCusSup={inclSupBalance}&include={include}&minimumCustomerBalance={minCusBalance}&customerId={customerId}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 4061, 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.

groupBy String, required Field(s) the data shown in the report should be grouped by

Default: ACCOUNT,CUR
balDue String, required Day interval for overdue amount columns

Default: 30,60
balRate String, required Show balances in the report based on rate and date of the transaction or converted to a specific date or period

Default: TRANS
date Date, optional Report will list records to this date. If this is specified the period parameter will be ignored.
accountingPeriod Integer, optional Report will list records to this period. If date is specified this period parameter will be ignored.

Minimum: 190000,
Maximum: 299999
cusFilter String, optional Filter on customers that should be included in the report
balCur String, optional Currency the balances in the report should be displayed in
rateDate String, optional For balance rate parameter "Period Rate" a specific period or date must be specified in this parameter. Date on format YYYY.MM.DD or period on format YYYYMM.
inclCusSup Boolean, optional Include supplier balance in report

Default: true
include String, optional Predefined restriction on data to be included in the report
minimumCustomerBalance Decimal, optional Total balance for the customer. Positive amount indicates how much the customer owes. Negative amount indicates that the customer has a credit balance.

Minimum: 0
customerId Integer, optional Customer identifier

Minimum: 100000,
Maximum: 999999
$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.

CreditNote() Named filter Credit note restriction
Invoice() Named filter Invoice restriction
Payment() Named filter Payment restriction
AccountingPeriod Integer Accounting period. Available macros: currentPeriod(), previousPeriod()
Currency String Three character code following the ISO 4217 standard.
CustomerId Integer Customer identifier.
Status String Status of receivable journal entry.
TransactionReferenceType String Accounts receivable transaction reference.

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
<Report>
2
     <Rows>
3
          <Row>
4
               <GroupField
GroupField

{GROUPFLD}*

>{String}</GroupField>
5
               <Text
Text

Descriptive text of record

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

Three character code following the ISO 4217 standard

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

The maximum amount that the customer may charge on a credit card or borrow from a financial institution.

>{Decimal}</CreditLimit>
8
               <CreditInsuranceAmount
CreditInsuranceAmount

Credit amount insured for the customer

>{Decimal}</CreditInsuranceAmount>
9
               <BalanceIncludingVAT
BalanceIncludingVAT

Balance / {BALCUR}

>{Decimal}</BalanceIncludingVAT>
10
               <NotDueAmount
NotDueAmount

Total amount that is not due

>{Decimal}</NotDueAmount>
11
               <OverdueAmount1
OverdueAmount1

Due, {OVERDUE1START} - {OVERDUE1END} days

>{Decimal}</OverdueAmount1>
12
               <OverdueAmount2
OverdueAmount2

Due, {OVERDUE2START} - {OVERDUE2END} days

>{Decimal}</OverdueAmount2>
13
               <OverdueAmount3
OverdueAmount3

Due, more than {OVERDUE2END} days

>{Decimal}</OverdueAmount3>
14
               <Inspect>
15
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

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

Filter used when inspecting a line in a report.

>{String}</Filter>
17
               </Inspect>
18
          </Row>
19
     </Rows>
20
     <Aggregated
Aggregated

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

>
21
          <BalanceIncludingVAT
BalanceIncludingVAT

Balance / {BALCUR}

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

>{Decimal}</BalanceIncludingVAT>
22
          <NotDueAmount
NotDueAmount

Total amount that is not due

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

>{Decimal}</NotDueAmount>
23
          <OverdueAmount1
OverdueAmount1

Due, {OVERDUE1START} - {OVERDUE1END} days

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

>{Decimal}</OverdueAmount1>
24
          <OverdueAmount2
OverdueAmount2

Due, {OVERDUE2START} - {OVERDUE2END} days

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

>{Decimal}</OverdueAmount2>
25
          <OverdueAmount3
OverdueAmount3

Due, more than {OVERDUE2END} days

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

>{Decimal}</OverdueAmount3>
26
     </Aggregated>
27
     <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

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

>
29
               <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>
30
               <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>
31
          </ColumnParameter>
32
     </ColumnParameters>
33
     <Paging
Paging

Detailed paging information for this list.

>
34
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
37
          <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>
38
          <FirstPage
FirstPage

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

>{String}</FirstPage>
39
          <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>
40
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
41
          <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>
42
          <NextPage
NextPage

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

>{String}</NextPage>
43
          <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>
44
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
46
     </Paging>
47
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "groupField
GroupField

{GROUPFLD}*

": "{String}",
6
                    "text
Text

Descriptive text of record

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

Three character code following the ISO 4217 standard

": "{String}",
8
                    "creditLimit
CreditLimit

The maximum amount that the customer may charge on a credit card or borrow from a financial institution.

": "{Decimal}",
9
                    "creditInsuranceAmount
CreditInsuranceAmount

Credit amount insured for the customer

": "{Decimal}",
10
                    "balanceIncludingVAT
BalanceIncludingVAT

Balance / {BALCUR}

": "{Decimal}",
11
                    "notDueAmount
NotDueAmount

Total amount that is not due

": "{Decimal}",
12
                    "overdueAmount1
OverdueAmount1

Due, {OVERDUE1START} - {OVERDUE1END} days

": "{Decimal}",
13
                    "overdueAmount2
OverdueAmount2

Due, {OVERDUE2START} - {OVERDUE2END} days

": "{Decimal}",
14
                    "overdueAmount3
OverdueAmount3

Due, more than {OVERDUE2END} days

": "{Decimal}",
15
                    "inspect": {
16
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

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

Filter used when inspecting a line in a report.

": "{String}"
18
                    }
19
               }
20
          ],
21
          "aggregated
Aggregated

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

": {
22
               "balanceIncludingVAT
BalanceIncludingVAT

Balance / {BALCUR}

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

": "{Decimal}",
23
               "notDueAmount
NotDueAmount

Total amount that is not due

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

": "{Decimal}",
24
               "overdueAmount1
OverdueAmount1

Due, {OVERDUE1START} - {OVERDUE1END} days

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

": "{Decimal}",
25
               "overdueAmount2
OverdueAmount2

Due, {OVERDUE2START} - {OVERDUE2END} days

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

": "{Decimal}",
26
               "overdueAmount3
OverdueAmount3

Due, more than {OVERDUE2END} days

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

": "{Decimal}"
27
          },
28
          "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

": [
29
               {
30
                    "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}",
31
                    "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}"
32
               }
33
          ]
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:

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