API

Finance APIs

GET finance/general-ledger-default-accounts?countryCodeForAssignment={countryCode}

Finance general ledger default accounts

HTTP method GET
URI https://api.rambase.net/finance/general-ledger-default-accounts?countryCodeForAssignment={countryCode}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 3920, version 20

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.

countryCodeForAssignment String, optional Country code of the company
$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.

Active() Named filter Active general ledger default accounts (status 4)
NewAndActive() Named filter New and active general ledger default accounts (status less than 9)
AccountNumber String The account number of the general ledger account.
ChangedBy Integer EmployeeId of the employee making the change. Available macros: currentUser()
Description String Description of the general ledger default account.
GeneralLedgerDefaultAccountId Integer General ledger default account identifier.
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.
ModuleName String Name of the module.
Name String Name of account default.
SortIndex Integer Sort order number.
Status Integer Status of general ledger default account.
SubModuleId Integer Submodule identifier.
SubModuleName String Name of the submodule.

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

AccountNumber String The account number of the general ledger account
ChangedBy Integer EmployeeId of the employee making the change
GeneralLedgerDefaultAccountId Integer General ledger default account identifier
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
ModuleName String Name of the module
Name String Name of account default
SortIndex Integer Sort order number
Status Integer Status of general ledger default account
SubModuleId Integer Submodule identifier
SubModuleName String Name of the submodule

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
<GeneralLedgerDefaultAccounts>
2
     <GeneralLedgerDefaultAccount>
3
          <GeneralLedgerDefaultAccountId
GeneralLedgerDefaultAccountId

General ledger default account identifier

>{Integer}</GeneralLedgerDefaultAccountId>
4
          <Status
Status

Status of general ledger default account

Possible domain values can be found here

>{Integer}</Status>
5
          <Key
Key

Account default key

>{String}</Key>
6
          <Name
Name

Name of account default

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

Name of account default

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

>{String}</TranslatedName>
8
          <Description
Description

Description of the general ledger default account

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

Description of the general ledger default account

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

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

Flag if account default is required

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

Flag if account default can be defined for each country

>{Boolean}</IsCountrySpecific>
12
          <SortIndex
SortIndex

Sort order number

>{Integer}</SortIndex>
13
          <SubModule>
14
               <SubModuleId
SubModuleId

Submodule identifier

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

Name of the submodule

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

Submodule reference

>{String}</SubModuleLink>
17
               <Module
Module

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

>
18
                    <ModuleId
ModuleId

Module identifier

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

>{Integer}</ModuleId>
19
                    <Name
Name

Name of the module

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

>{String}</Name>
20
                    <ModuleLink
ModuleLink

Module reference

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

>{String}</ModuleLink>
21
               </Module>
22
          </SubModule>
23
          <GeneralLedgerAccountAssignment
GeneralLedgerAccountAssignment

General ledger account assignment for a given country, default is the company country

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

>
24
               <GeneralLedgerAccountAssignmentId
GeneralLedgerAccountAssignmentId

General ledger account assignment identifier

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

>{Integer}</GeneralLedgerAccountAssignmentId>
25
               <Status
Status

Status of general ledger default account assignment

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

>{Integer}</Status>
26
               <GeneralLedgerAccount
GeneralLedgerAccount

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

>
27
                    <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

>{Integer}</GeneralLedgerAccountId>
28
                    <AccountNumber
AccountNumber

The account number of the general ledger account

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

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

Name of general ledger account

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

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

General ledger account reference

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

>{String}</GeneralLedgerAccountLink>
31
               </GeneralLedgerAccount>
32
               <Country
Country

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

>
33
                    <CountryId
CountryId

Country identifier

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

>{Integer}</CountryId>
34
                    <Name
Name

Name of country

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

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

Country code of the company

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

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

Country reference

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

>{String}</CountryLink>
37
               </Country>
38
               <GeneralLedgerAccountAssignmentLink
GeneralLedgerAccountAssignmentLink

Default account assignment reference

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

>{String}</GeneralLedgerAccountAssignmentLink>
39
          </GeneralLedgerAccountAssignment>
40
          <GeneralLedgerDefaultAccountLink
GeneralLedgerDefaultAccountLink

Default account reference

>{String}</GeneralLedgerDefaultAccountLink>
41
     </GeneralLedgerDefaultAccount>
42
     <Paging
Paging

Detailed paging information for this list.

>
43
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

>{Integer}</Size>
55
     </Paging>
56
</GeneralLedgerDefaultAccounts>
1
{
2
     "generalLedgerDefaultAccounts": [
3
          {
4
               "generalLedgerDefaultAccountId
GeneralLedgerDefaultAccountId

General ledger default account identifier

": "{Integer}",
5
               "status
Status

Status of general ledger default account

Possible domain values can be found here

": "{Integer}",
6
               "key
Key

Account default key

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

Name of account default

": "{String}",
8
               "translatedName
TranslatedName

Name of account default

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

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

Description of the general ledger default account

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

Description of the general ledger default account

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

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

Flag if account default is required

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

Flag if account default can be defined for each country

": "{Boolean}",
13
               "sortIndex
SortIndex

Sort order number

": "{Integer}",
14
               "subModule": {
15
                    "subModuleId
SubModuleId

Submodule identifier

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

Name of the submodule

": "{String}",
17
                    "subModuleLink
SubModuleLink

Submodule reference

": "{String}",
18
                    "module
Module

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

": {
19
                         "moduleId
ModuleId

Module identifier

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

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

Name of the module

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

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

Module reference

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

": "{String}"
22
                    }
23
               },
24
               "generalLedgerAccountAssignment
GeneralLedgerAccountAssignment

General ledger account assignment for a given country, default is the company country

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

": {
25
                    "generalLedgerAccountAssignmentId
GeneralLedgerAccountAssignmentId

General ledger account assignment identifier

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

": "{Integer}",
26
                    "status
Status

Status of general ledger default account assignment

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

": "{Integer}",
27
                    "generalLedgerAccount
GeneralLedgerAccount

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

": {
28
                         "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

": "{Integer}",
29
                         "accountNumber
AccountNumber

The account number of the general ledger account

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

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

Name of general ledger account

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

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

General ledger account reference

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

": "{String}"
32
                    },
33
                    "country
Country

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

": {
34
                         "countryId
CountryId

Country identifier

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

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

Name of country

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

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

Country code of the company

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

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

Country reference

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

": "{String}"
38
                    },
39
                    "generalLedgerAccountAssignmentLink
GeneralLedgerAccountAssignmentLink

Default account assignment reference

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

": "{String}"
40
               },
41
               "generalLedgerDefaultAccountLink
GeneralLedgerDefaultAccountLink

Default account reference

": "{String}"
42
          }
43
     ],
44
     "paging
Paging

Detailed paging information for this list.

": {
45
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
57
     }
58
}

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 101013 HTTP 404 Sub-module not found