API

Finance APIs

GET finance/general-ledger-default-accounts/{generalLedgerDefaultAccountId}

Finance general ledger default account for provided identifier

HTTP method GET
URI https://api.rambase.net/finance/general-ledger-default-accounts/{generalLedgerDefaultAccountId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {generalLedgerDefaultAccountId} General ledger default account identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 3881, 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.

$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.

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

General ledger default account identifier

>{Integer}</GeneralLedgerDefaultAccountId>
3
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
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=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=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=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=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=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=SubModule.Module in your request URI to get this field

>{String}</ModuleLink>
21
          </Module>
22
     </SubModule>
23
     <Repository>
24
          <Scope
Scope

Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.

Possible domain values can be found here

>{String}</Scope>
25
          <IsChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

>{Boolean}</IsChanged>
26
          <ChangedBy
ChangedBy

EmployeeId of the employee making the change

>
27
               <UserId
UserId

User identifier

>{Integer}</UserId>
28
               <Name
Name

Name of the user

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

First name of the user

>{String}</FirstName>
30
               <UserLink
UserLink

User reference

>{String}</UserLink>
31
          </ChangedBy>
32
          <IsPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

>{Boolean}</IsPendingDeployment>
33
     </Repository>
34
</GeneralLedgerDefaultAccount>
1
{
2
     "generalLedgerDefaultAccount": {
3
          "generalLedgerDefaultAccountId
GeneralLedgerDefaultAccountId

General ledger default account identifier

": "{Integer}",
4
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
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=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=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=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=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=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=SubModule.Module in your request URI to get this field

": "{String}"
22
               }
23
          },
24
          "repository": {
25
               "scope
Scope

Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.

Possible domain values can be found here

": "{String}",
26
               "isChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

": "{Boolean}",
27
               "changedBy
ChangedBy

EmployeeId of the employee making the change

": {
28
                    "userId
UserId

User identifier

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

Name of the user

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

First name of the user

": "{String}",
31
                    "userLink
UserLink

User reference

": "{String}"
32
               },
33
               "isPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

": "{Boolean}"
34
          }
35
     }
36
}

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