API

Finance APIs

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

Saves information about the finance general ledger default account

HTTP method PUT
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 3916, version 4

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
GeneralLedgerDefaultAccount

This field is optional.

>
2
     <Key
Key

Account default key

This field is optional.

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

Name of account default

This field is optional.

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

This field is optional.

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

Flag if account default can be defined for each country

This field is optional.

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

Sort order number

This field is optional.

>
{Integer}</SortIndex>
8
     <SubModule
SubModule

This field is optional.

>
9
          <SubModuleId
SubModuleId

Submodule identifier

Minimum value: 100000

This field is optional.

>
{Integer}</SubModuleId>
10
     </SubModule>
11
</GeneralLedgerDefaultAccount>
1
{
2
     "generalLedgerDefaultAccount
GeneralLedgerDefaultAccount

This field is optional.

":
{
3
          "key
Key

Account default key

This field is optional.

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

Name of account default

This field is optional.

":
"{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

This field is optional.

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

Flag if account default can be defined for each country

This field is optional.

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

Sort order number

This field is optional.

":
"{Integer}",
9
          "subModule
SubModule

This field is optional.

":
{
10
               "subModuleId
SubModuleId

Submodule identifier

Minimum value: 100000

This field is optional.

":
"{Integer}"
11
          }
12
     }
13
}

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.

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
1

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