Finance APIs
Resource for creating new finance budget item
| HTTP method | POST |
| URI | https://api.rambase.net/finance/budget-accounts/{budgetAccountId}/amounts |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {budgetAccountId} |
Budget account identifier
Integer, minimum 100 |
| Successful HTTP status code | 201 |
| API resource identifier | 3868, version 5 |
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.
Period
Required/mandatory field
Period of the budget account item
Minimum value: 199000
Maximum value: 299912
>{Integer}</Period>Amount
Required/mandatory field
Amount of the budget account item
Maximum value: 99999999999999999999
>{Decimal}</Amount>Department
The department related to the budget account item.
This field is optional.
>DepartmentId
Department identifier
Minimum value: 1
This field is optional.
>{Integer}</DepartmentId>FinanceProject
The project related to the budget account item.
This field is optional.
>FinanceProjectId
Finance project identifier
Minimum value: 1
This field is optional.
>{Integer}</FinanceProjectId>Period
Required/mandatory field
Period of the budget account item
Minimum value: 199000
Maximum value: 299912
": "{Integer}",Amount
Required/mandatory field
Amount of the budget account item
Maximum value: 99999999999999999999
": "{Decimal}",Department
The department related to the budget account item.
This field is optional.
": {DepartmentId
Department identifier
Minimum value: 1
This field is optional.
": "{Integer}"FinanceProject
The project related to the budget account item.
This field is optional.
": {FinanceProjectId
Finance project identifier
Minimum value: 1
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. |
| $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.
BudgetAmountId
Budget amount identifier
>{Integer}</BudgetAmountId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Status
Status code of the the budget account item
Possible domain values can be found here
>{Integer}</Status>Period
Period of the budget account item
>{Integer}</Period>Year
Year of the budget account item
>{Integer}</Year>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Amount
Amount of the budget account item
>{Decimal}</Amount>Department
The department related to the budget account item.
>DepartmentId
Department identifier
>{Integer}</DepartmentId>DepartmentLink
Finance department reference
>{String}</DepartmentLink>FinanceProject
The project related to the budget account item.
>FinanceProjectId
Finance project identifier
>{Integer}</FinanceProjectId>FinanceProjectLink
Finance project reference
>{String}</FinanceProjectLink>BudgetAmountId
Budget amount identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Status
Status code of the the budget account item
Possible domain values can be found here
": "{Integer}",Period
Period of the budget account item
": "{Integer}",Year
Year of the budget account item
": "{Integer}",Currency
Three character code following the ISO 4217 standard
": "{String}",Amount
Amount of the budget account item
": "{Decimal}",Department
The department related to the budget account item.
": {DepartmentId
Department identifier
": "{Integer}",DepartmentLink
Finance department reference
": "{String}"FinanceProject
The project related to the budget account item.
": {FinanceProjectId
Finance project identifier
": "{Integer}",FinanceProjectLink
Finance project reference
": "{String}"
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 100189 HTTP 404 | Project not found |
| Error 104775 HTTP 404 | Budget item not found |
| Error 104952 HTTP 400 | Department for budget {0} is not allowed |
| Error 104954 HTTP 400 | Project for budget {0} is not allowed |