API

Finance APIs

PUT finance/budget-accounts/{budgetAccountId}/amounts/{budgetAmountId}

Saves information about the finance budget-account amount

HTTP method PUT
URI https://api.rambase.net/finance/budget-accounts/{budgetAccountId}/amounts/{budgetAmountId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {budgetAccountId} Budget account identifier
Integer, minimum 100
- URI parameter {budgetAmountId} Budget amount identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 3871, version 3

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.

Format:
1
<BudgetAmount
BudgetAmount

This field is optional.

>
2
     <Period
Period

Period of the budget account item

Minimum value: 199000

Maximum value: 299912

This field is optional.

>
{Integer}</Period>
3
     <Amount
Amount

Amount of the budget account item

Maximum value: 99999999999999999999

This field is optional.

>
{Decimal}</Amount>
4
     <Department
Department

The department related to the budget account item.

This field is optional.

>
5
          <DepartmentId
DepartmentId

Department identifier

Minimum value: 1

This field is optional.

>
{Integer}</DepartmentId>
6
     </Department>
7
     <FinanceProject
FinanceProject

The project related to the budget account item.

This field is optional.

>
8
          <FinanceProjectId
FinanceProjectId

Finance project identifier

Minimum value: 1

This field is optional.

>
{Integer}</FinanceProjectId>
9
     </FinanceProject>
10
</BudgetAmount>
1
{
2
     "budgetAmount
BudgetAmount

This field is optional.

":
{
3
          "period
Period

Period of the budget account item

Minimum value: 199000

Maximum value: 299912

This field is optional.

":
"{Integer}",
4
          "amount
Amount

Amount of the budget account item

Maximum value: 99999999999999999999

This field is optional.

":
"{Decimal}",
5
          "department
Department

The department related to the budget account item.

This field is optional.

":
{
6
               "departmentId
DepartmentId

Department identifier

Minimum value: 1

This field is optional.

":
"{Integer}"
7
          },
8
          "financeProject
FinanceProject

The project related to the budget account item.

This field is optional.

":
{
9
               "financeProjectId
FinanceProjectId

Finance project identifier

Minimum value: 1

This field is optional.

":
"{Integer}"
10
          }
11
     }
12
}

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.

Format:
1
1

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