API

Finance APIs

GET system/reports/108009/result-set

Report shows general ledger default accounts with related general ledger default account assignments

Report name General ledger default account assignments
Report identifier 108009
HTTP method GET
URI https://api.rambase.net/system/reports/108009/result-set
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5010, version 10

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.

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

CountryCode String Country code of the company.
CountryName String Name of country.
Description String Description of the general ledger default account.
GeneralLedgerAccountName String Name of general ledger account.
GeneralLedgerAccountNumber String The account number of the general ledger account.
IsCountrySpecific Boolean Flag if account default can be defined for each country.
IsRequired Boolean Flag if account default is required.
Key String Account default key.
Name String Name of account default.

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

CountryCode String Country code of the company
GeneralLedgerAccountName String Name of general ledger account
GeneralLedgerAccountNumber String The account number of the general ledger account
IsCountrySpecific Boolean Flag if account default can be defined for each country
IsRequired Boolean Flag if account default is required
Key String Account default key
Name String Name of account default

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

Account default key

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

>{String}</Key>
5
               <Country
Country

Country reference

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

>
6
                    <Name
Name

Name of country

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

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

Country code of the company

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

>{String}</CountryCode>
8
                    <CountryLink
CountryLink

Country reference

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

>{String}</CountryLink>
9
               </Country>
10
               <Name
Name

Name of account default

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

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

Description of the general ledger default account

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

Translated name of account default

>{String}</TranslatedName>
13
               <TranslatedDescription
TranslatedDescription

Translated description of the general ledger default account

>{String}</TranslatedDescription>
14
               <IsRequired
IsRequired

Flag if account default is required

>{Boolean}</IsRequired>
15
               <IsCountrySpecific
IsCountrySpecific

Flag if account default can be defined for each country

>{Boolean}</IsCountrySpecific>
16
               <Module
Module

Module reference

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

>
17
                    <TranslatedName
TranslatedName

Translated name of the module. The language used is specified either in $lang or by user settings. If translated name doesn't exist in desired language, english will be used.

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

>{String}</TranslatedName>
18
                    <ModuleLink
ModuleLink

Module reference

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

>{String}</ModuleLink>
19
               </Module>
20
               <Submodule
Submodule

Submodule reference

>
21
                    <TranslatedName
TranslatedName

Translated name of the submodule. The language used is specified either in $lang or by user settings. If translated name doesn't exist in desired language, english will be used.

>{String}</TranslatedName>
22
                    <SubmoduleLink
SubmoduleLink

Submodule reference

>{String}</SubmoduleLink>
23
               </Submodule>
24
               <GLAccount
GLAccount

General ledger account reference

>
25
                    <AccountNumber
AccountNumber

The account number of the general ledger account

>{String}</AccountNumber>
26
                    <Name
Name

Name of general ledger account

>{String}</Name>
27
                    <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>
28
               </GLAccount>
29
          </Row>
30
     </Rows>
31
     <Paging
Paging

Detailed paging information for this list.

>
32
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
35
          <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>
36
          <FirstPage
FirstPage

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

>{String}</FirstPage>
37
          <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>
38
          <PreviousPage
PreviousPage

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

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

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

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

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

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

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

>{Integer}</Size>
44
     </Paging>
45
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "key
Key

Account default key

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

": "{String}",
6
                    "country
Country

Country reference

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

": {
7
                         "name
Name

Name of country

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

": "{String}",
8
                         "countryCode
CountryCode

Country code of the company

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

": "{String}",
9
                         "countryLink
CountryLink

Country reference

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

": "{String}"
10
                    },
11
                    "name
Name

Name of account default

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

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

Description of the general ledger default account

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}",
13
                    "translatedName
TranslatedName

Translated name of account default

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

Translated description of the general ledger default account

": "{String}",
15
                    "isRequired
IsRequired

Flag if account default is required

": "{Boolean}",
16
                    "isCountrySpecific
IsCountrySpecific

Flag if account default can be defined for each country

": "{Boolean}",
17
                    "module
Module

Module reference

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

": {
18
                         "translatedName
TranslatedName

Translated name of the module. The language used is specified either in $lang or by user settings. If translated name doesn't exist in desired language, english will be used.

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

": "{String}",
19
                         "moduleLink
ModuleLink

Module reference

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

": "{String}"
20
                    },
21
                    "submodule
Submodule

Submodule reference

": {
22
                         "translatedName
TranslatedName

Translated name of the submodule. The language used is specified either in $lang or by user settings. If translated name doesn't exist in desired language, english will be used.

": "{String}",
23
                         "submoduleLink
SubmoduleLink

Submodule reference

": "{String}"
24
                    },
25
                    "gLAccount
GLAccount

General ledger account reference

": {
26
                         "accountNumber
AccountNumber

The account number of the general ledger account

": "{String}",
27
                         "name
Name

Name of general ledger account

": "{String}",
28
                         "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

": "{String}"
29
                    }
30
               }
31
          ]
32
     }
33
}

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