Finance APIs
Resource for creating new general ledger account group
| HTTP method | POST |
| URI | https://api.rambase.net/finance/general-ledger-account-groups |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 4157, 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.
Code
Required/mandatory field
Code of general ledger account group
Minimum value: 1
Maximum value: 1
Input must match the following regular expression pattern: [a-zA-Z0-9]
>{String}</Code>Name
Required/mandatory field
Name of general ledger account group
>{String}</Name>Code
Required/mandatory field
Code of general ledger account group
Minimum value: 1
Maximum value: 1
Input must match the following regular expression pattern: [a-zA-Z0-9]
": "{String}",Name
Required/mandatory field
Name of general ledger account group
": "{String}"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.
GeneralLedgerAccountGroupId
General ledger account group identifier
>{Integer}</GeneralLedgerAccountGroupId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Status
Status of general ledger account group
Possible domain values can be found here
>{Integer}</Status>Code
Code of general ledger account group
>{String}</Code>Name
Name of general ledger account group
>{String}</Name>AutomaticallyAssign
Indicates if an GL account will be linked to this general ledger account group automatically under creation
>{Boolean}</AutomaticallyAssign>GeneralLedgerAccountGroupId
General ledger account group identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Status
Status of general ledger account group
Possible domain values can be found here
": "{Integer}",Code
Code of general ledger account group
": "{String}",Name
Name of general ledger account group
": "{String}",AutomaticallyAssign
Indicates if an GL account will be linked to this general ledger account group automatically under creation
": "{Boolean}"
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 105298 HTTP 400 | Account group code with the given code already exists |
| Error 105296 HTTP 400 | Account group code is required |
| Error 105297 HTTP 400 | Account group code name is required |