Finance APIs

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

Budget amount details for provided identifier

HTTP method	GET
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	3805, 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.

Format:

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.

$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]
$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
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$select String, optional	Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional	Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select 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:

                                        <BudgetAmount>
                                    

<BudgetAmountId

BudgetAmountId

Budget amount identifier

>{Integer}</BudgetAmountId>

<CreatedAt

CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>

<Status

Status

Status code of the the budget account item

Possible domain values can be found here

>{Integer}</Status>

<Period

Period

Period of the budget account item

>{Integer}</Period>

<Year

Year

Year of the budget account item

>{Integer}</Year>

<Currency

Currency

Three character code following the ISO 4217 standard

>{String}</Currency>

<Amount

Amount

Amount of the budget account item

>{Decimal}</Amount>

<Department

Department

The department related to the budget account item.

<DepartmentId

DepartmentId

Department identifier

>{Integer}</DepartmentId>

<Name

Name

Name of department

This field is greyed out because it is an expandable field. You have to add $expand=Department.Name in your request URI to get this field

>{String}</Name>

<DepartmentLink

DepartmentLink

Finance department reference

>{String}</DepartmentLink>

                                             </Department>
                                    

<FinanceProject

FinanceProject

The project related to the budget account item.

<FinanceProjectId

FinanceProjectId

Finance project identifier

>{Integer}</FinanceProjectId>

<Name

Name

Name of finance project

This field is greyed out because it is an expandable field. You have to add $expand=FinanceProject.Name in your request URI to get this field

>{String}</Name>

<FinanceProjectLink

FinanceProjectLink

Finance project reference

>{String}</FinanceProjectLink>

                                             </FinanceProject>
                                    

                                        </BudgetAmount>
                                    

{

                                             "budgetAmount": {
                                    

"budgetAmountId

BudgetAmountId

Budget amount identifier

": "{Integer}",

"createdAt

CreatedAt

Date and time of creation

": "{Datetime}",

"status

Status

Status code of the the budget account item

Possible domain values can be found here

": "{Integer}",

"period

Period

Period of the budget account item

": "{Integer}",

"year

Year

Year of the budget account item

": "{Integer}",

"currency

Currency

Three character code following the ISO 4217 standard

": "{String}",

"amount

Amount

Amount of the budget account item

": "{Decimal}",

"department

Department

The department related to the budget account item.

": {

"departmentId

DepartmentId

Department identifier

": "{Integer}",

"name

Name

Name of department

This field is greyed out because it is an expandable field. You have to add $expand=Department.Name in your request URI to get this field

": "{String}",

"departmentLink

DepartmentLink

Finance department reference

": "{String}"

},

"financeProject

FinanceProject

The project related to the budget account item.

": {

"financeProjectId

FinanceProjectId

Finance project identifier

": "{Integer}",

"name

Name

Name of finance project

This field is greyed out because it is an expandable field. You have to add $expand=FinanceProject.Name in your request URI to get this field

": "{String}",

"financeProjectLink

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