Finance APIs
Saves information about the finance budget-account
| HTTP method | PUT |
| URI | https://api.rambase.net/finance/budget-accounts/{budgetAccountId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {budgetAccountId} |
Budget account identifier
Integer, minimum 100 |
| Successful HTTP status code | 200 |
| API resource identifier | 3862, version 7 |
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.
BudgetAccount
This field is optional.
>AccountNumber
Code of budget
Maximum value: 50
Input must match the following regular expression pattern: [A-Za-z0-9-_\.]
This field is optional.
>{String}</AccountNumber>Name
Name of budget
This field is optional.
>{String}</Name>RequireDepartment
Department is required
This field is optional.
>{Boolean}</RequireDepartment>RequireFinanceProject
Project is required
This field is optional.
>{Boolean}</RequireFinanceProject>Description
Description of budget
This field is optional.
>{String}</Description>Responsible
Information who is responsible for the budget
This field is optional.
>UserId
User identifier
Minimum value: 100
This field is optional.
>{Integer}</UserId>Validity
This field is optional.
>EffectivePeriod
Period the budget is valid from
Minimum value: 199000
Maximum value: 299912
This field is optional.
>{Integer}</EffectivePeriod>ExpirationPeriod
Period the budget expires (is valid to)
Minimum value: 199000
Maximum value: 299912
This field is optional.
>{Integer}</ExpirationPeriod>BudgetAccount
This field is optional.
": {AccountNumber
Code of budget
Maximum value: 50
Input must match the following regular expression pattern: [A-Za-z0-9-_\.]
This field is optional.
": "{String}",Name
Name of budget
This field is optional.
": "{String}",RequireDepartment
Department is required
This field is optional.
": "{Boolean}",RequireFinanceProject
Project is required
This field is optional.
": "{Boolean}",Description
Description of budget
This field is optional.
": "{String}",Responsible
Information who is responsible for the budget
This field is optional.
": {UserId
User identifier
Minimum value: 100
This field is optional.
": "{Integer}"Validity
This field is optional.
": {EffectivePeriod
Period the budget is valid from
Minimum value: 199000
Maximum value: 299912
This field is optional.
": "{Integer}",ExpirationPeriod
Period the budget expires (is valid to)
Minimum value: 199000
Maximum value: 299912
This field is optional.
": "{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. |
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.
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 104615 HTTP 400 | Maximum length of account number is 50 characters |
| Error 100542 HTTP 400 | Name is required |
| Error 101314 HTTP 400 | From period is not valid: {0} |
| Error 104562 HTTP 400 | FROMPERIOD must be previous then TOPERIOD |