API

Finance APIs

POST finance/general-ledger-default-accounts

Resource for creating new general ledger deafult account

HTTP method POST
URI https://api.rambase.net/finance/general-ledger-default-accounts
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 3913, version 1

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

Required/mandatory field

Account default key

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

Required/mandatory field

Name of account default

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

Description of the general ledger default account

This field is optional.

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

Flag if account default is required

Default value: False

This field is optional.

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

Flag if account default can be defined for each country

Default value: False

This field is optional.

>{Boolean}</IsCountrySpecific>
7
     <SubModule>
8
          <SubModuleId
SubModuleId

Required/mandatory field

Submodule identifier

Minimum value: 100000

>{Integer}</SubModuleId>
9
     </SubModule>
10
</GeneralLedgerDefaultAccount>
1
{
2
     "generalLedgerDefaultAccount": {
3
          "key
Key

Required/mandatory field

Account default key

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

Required/mandatory field

Name of account default

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

Description of the general ledger default account

This field is optional.

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

Flag if account default is required

Default value: False

This field is optional.

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

Flag if account default can be defined for each country

Default value: False

This field is optional.

": "{Boolean}",
8
          "subModule": {
9
               "subModuleId
SubModuleId

Required/mandatory field

Submodule identifier

Minimum value: 100000

": "{Integer}"
10
          }
11
     }
12
}

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.

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

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.

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

Description of the general ledger default account

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

Flag if account default is required

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

Flag if account default can be defined for each country

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

Sort order number

>{Integer}</SortIndex>
11
     <SubModule>
12
          <SubModuleId
SubModuleId

Submodule identifier

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

Name of the submodule

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

Submodule reference

>
15
               <ModuleId
ModuleId

Module identifier

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

Name of the module

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

Module reference

>{String}</ModuleLink>
18
          </SubModuleLink>
19
     </SubModule>
20
     <Repository>
21
          <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>
22
          <IsChanged
IsChanged

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

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

EmployeeId of the employee making the change

>
24
               <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
28
          </ChangedBy>
29
          <IsPendingDeployment
IsPendingDeployment

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

>{Boolean}</IsPendingDeployment>
30
     </Repository>
31
</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
          "description
Description

Description of the general ledger default account

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

Flag if account default is required

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

Flag if account default can be defined for each country

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

Sort order number

": "{Integer}",
12
          "subModule": {
13
               "subModuleId
SubModuleId

Submodule identifier

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

Name of the submodule

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

Submodule reference

": {
16
                    "moduleId
ModuleId

Module identifier

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

Name of the module

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

Module reference

": "{String}"
19
               }
20
          },
21
          "repository": {
22
               "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}",
23
               "isChanged
IsChanged

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

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

EmployeeId of the employee making the change

": {
25
                    "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
29
               },
30
               "isPendingDeployment
IsPendingDeployment

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

": "{Boolean}"
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 101079 HTTP 400 Mismatch in size of revision parameters
Error 104878 HTTP 400 Name is required
Error 104877 HTTP 400 Key is required
Error 104892 HTTP 400 The key contains illegal characters. Only A-Z are allowed.
Error 104893 HTTP 400 ADD with the same key already esists.