Finance APIs
Resource for creating new finance budget
| HTTP method | POST |
| URI | https://api.rambase.net/finance/budget-accounts |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 3867, version 2 |
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
Code of budget
Maximum value: 50
Input must match the following regular expression pattern: [A-Za-z0-9-_\.]
>{String}</AccountNumber>Name
Required/mandatory field
Name of budget
>{String}</Name>EffectivePeriod
Required/mandatory field
Period the budget is valid from
Minimum value: 199000
Maximum value: 299912
>{Integer}</EffectivePeriod>AccountNumber
Required/mandatory field
Code of budget
Maximum value: 50
Input must match the following regular expression pattern: [A-Za-z0-9-_\.]
": "{String}",Name
Required/mandatory field
Name of budget
": "{String}",EffectivePeriod
Required/mandatory field
Period the budget is 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. |
| $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.
BudgetAccountId
Budget account identifier
>{Integer}</BudgetAccountId>AccountNumber
Code of budget
>{String}</AccountNumber>Name
Name of budget
>{String}</Name>RequireDepartment
Department is required
>{Boolean}</RequireDepartment>RequireFinanceProject
Project is required
>{Boolean}</RequireFinanceProject>Description
Description of budget
>{String}</Description>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>LatestBudgetYear
Latest year of budget amounts
>{Integer}</LatestBudgetYear>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>Responsible
Information who is responsible for the budget
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>EffectivePeriod
Period the budget is valid from
>{Integer}</EffectivePeriod>ExpirationPeriod
Period the budget expires (is valid to)
>{Integer}</ExpirationPeriod>BudgetAccountId
Budget account identifier
": "{Integer}",Status
Status of budget
Possible domain values can be found here
": "{Integer}",AccountNumber
Code of budget
": "{String}",Name
Name of budget
": "{String}",RequireDepartment
Department is required
": "{Boolean}",RequireFinanceProject
Project is required
": "{Boolean}",Description
Description of budget
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",LatestBudgetYear
Latest year of budget amounts
": "{Integer}",UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"Responsible
Information who is responsible for the budget
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"EffectivePeriod
Period the budget is valid from
": "{Integer}",ExpirationPeriod
Period the budget expires (is valid to)
": "{Integer}"
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 101420 HTTP 404 | Setting definition not found |
| Error 104562 HTTP 400 | FROMPERIOD must be previous then TOPERIOD |
| Error 101314 HTTP 400 | From period is not valid: {0} |