API

Finance APIs

GET finance/budget-accounts/{budgetAccountId}

Budget details for provided identifier

HTTP method GET
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 498, version 15

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
1

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.

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
<BudgetAccount>
2
     <BudgetAccountId
BudgetAccountId

Budget account identifier

>
{Integer}</BudgetAccountId>
3
     <Status
Status

Status of budget

Possible domain values can be found here

>
{Integer}</Status>
4
     <AccountNumber
AccountNumber

Code of budget

>
{String}</AccountNumber>
5
     <Name
Name

Name of budget

>
{String}</Name>
6
     <RequireDepartment
RequireDepartment

Department is required

>
{Boolean}</RequireDepartment>
7
     <RequireFinanceProject
RequireFinanceProject

Project is required

>
{Boolean}</RequireFinanceProject>
8
     <Description
Description

Description of budget

>
{String}</Description>
9
     <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
10
     <LatestBudgetYear
LatestBudgetYear

Latest year of budget amounts

>
{Integer}</LatestBudgetYear>
11
     <CreatedBy>
12
          <UserId
UserId

User identifier

>
{Integer}</UserId>
13
          <Name
Name

Name of the user

>
{String}</Name>
14
          <FirstName
FirstName

First name of the user

>
{String}</FirstName>
15
          <UserLink
UserLink

User reference

>
{String}</UserLink>
16
     </CreatedBy>
17
     <Responsible
Responsible

Information who is responsible for the budget

>
18
          <UserId
UserId

User identifier

>
{Integer}</UserId>
19
          <Name
Name

Name of the user

>
{String}</Name>
20
          <FirstName
FirstName

First name of the user

>
{String}</FirstName>
21
          <UserLink
UserLink

User reference

>
{String}</UserLink>
22
     </Responsible>
23
     <Validity>
24
          <EffectivePeriod
EffectivePeriod

Period the budget is valid from

>
{Integer}</EffectivePeriod>
25
          <ExpirationPeriod
ExpirationPeriod

Period the budget expires (is valid to)

>
{Integer}</ExpirationPeriod>
26
     </Validity>
27
</BudgetAccount>
1
{
2
     "budgetAccount": {
3
          "budgetAccountId
BudgetAccountId

Budget account identifier

":
"{Integer}",
4
          "status
Status

Status of budget

Possible domain values can be found here

":
"{Integer}",
5
          "accountNumber
AccountNumber

Code of budget

":
"{String}",
6
          "name
Name

Name of budget

":
"{String}",
7
          "requireDepartment
RequireDepartment

Department is required

":
"{Boolean}",
8
          "requireFinanceProject
RequireFinanceProject

Project is required

":
"{Boolean}",
9
          "description
Description

Description of budget

":
"{String}",
10
          "createdAt
CreatedAt

Date and time of creation

":
"{Datetime}",
11
          "latestBudgetYear
LatestBudgetYear

Latest year of budget amounts

":
"{Integer}",
12
          "createdBy": {
13
               "userId
UserId

User identifier

":
"{Integer}",
14
               "name
Name

Name of the user

":
"{String}",
15
               "firstName
FirstName

First name of the user

":
"{String}",
16
               "userLink
UserLink

User reference

":
"{String}"
17
          },
18
          "responsible
Responsible

Information who is responsible for the budget

":
{
19
               "userId
UserId

User identifier

":
"{Integer}",
20
               "name
Name

Name of the user

":
"{String}",
21
               "firstName
FirstName

First name of the user

":
"{String}",
22
               "userLink
UserLink

User reference

":
"{String}"
23
          },
24
          "validity": {
25
               "effectivePeriod
EffectivePeriod

Period the budget is valid from

":
"{Integer}",
26
               "expirationPeriod
ExpirationPeriod

Period the budget expires (is valid to)

":
"{Integer}"
27
          }
28
     }
29
}

Possible error codes the response might return:

Error 100036 HTTP 400 Missing required input parameter: {0}