Finance APIs
Resource for creating new general ledger account
| HTTP method | POST |
| URI | https://api.rambase.net/finance/general-ledger-accounts |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 3614, 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.
AccountNumber
Required/mandatory field
The account number of the general ledger account
Maximum value: 50
Input must match the following regular expression pattern: [A-Za-z0-9-_\.]
>{String}</AccountNumber>Name
Required/mandatory field
Name of general ledger account
>{String}</Name>Type
Required/mandatory field
Type of account
Applicable domain values can be found here
>{String}</Type>VATCode
Required/mandatory field
Code that determines VAT rules used for VAT calculations.
>{String}</VATCode>EffectivePeriod
Required/mandatory field
Period the account is effective/valid from
Minimum value: 199000
Maximum value: 299912
>{Integer}</EffectivePeriod>AccountNumber
Required/mandatory field
The account number of the general ledger account
Maximum value: 50
Input must match the following regular expression pattern: [A-Za-z0-9-_\.]
": "{String}",Name
Required/mandatory field
Name of general ledger account
": "{String}",Type
Required/mandatory field
Type of account
Applicable domain values can be found here
": "{String}",VATCode
Required/mandatory field
Code that determines VAT rules used for VAT calculations.
": "{String}"EffectivePeriod
Required/mandatory field
Period the account is effective/valid from
Minimum value: 199000
Maximum value: 299912
": "{Integer}"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. |
| $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.
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 |
| Error 102018 HTTP 403 | You need permission {0}. Duties with this permission: {1} |
| Error 104468 HTTP 400 | You cannot change the depreciation rule, FAR documents exists! |
| Error 104469 HTTP 400 | You cannot change the forward option to NO, FAR documents exists! |
| Error 103702 HTTP 400 | From period is not valid. General ledger postings exists. |
| Error 103703 HTTP 400 | To period is not valid. General ledger postings exists. |
| Error 104702 HTTP 400 | You cannot change posting type of a processed (status 9) general ledger account |
| Error 105056 HTTP 400 | You cannot change account type. General ledger postings exists. |
| Error 105087 HTTP 400 | You cannot change the blocking attributes for an off-balance account. |
| Error 105176 HTTP 400 | Child account exists, the account cannot be changed to an non control account. |
| Error 105177 HTTP 400 | You cannot change to a control account. General ledger postings exists. |
| Error 106939 HTTP 400 | Cannot set parent account to the same account |
| Error 105179 HTTP 400 | Only control accounts are allowed as parent account. |