API

Rental APIs

GET rental/contracts/{rentalContractId}/items/{itemId}/account-dimensions

List of all account dimensions for the item

HTTP method GET
URI https://api.rambase.net/rental/contracts/{rentalContractId}/items/{itemId}/account-dimensions
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {rentalContractId} Rental contract identifier
Integer, minimum 100000
- URI parameter {itemId} Rental contract item identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 5904, 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:
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.
$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:
1
<AccountDimensions>
2
     <GeneralLedgerAccount>
3
          <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>{Integer}</GeneralLedgerAccountId>
4
          <Name
Name

Name of general ledger account

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

The account number of the general ledger account

>{String}</AccountNumber>
6
          <DimensionRequirements
DimensionRequirements

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

>
7
               <DimensionRequirement
DimensionRequirement

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

>
8
                    <Requirement
Requirement

Specifies how the dimension should be used for the specific account.

Possible domain values can be found here

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

>{String}</Requirement>
9
                    <DimensionDefinition
DimensionDefinition

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

>
10
                         <DimensionDefinitionId
DimensionDefinitionId

Dimension identifier

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

>{Integer}</DimensionDefinitionId>
11
                         <Name
Name

Name of dimension

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

>{String}</Name>
12
                         <ValueSource
ValueSource

Where the value is selected from.

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

>
13
                              <Type
Type

Type of source

Possible domain values can be found here

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

>{String}</Type>
14
                         </ValueSource>
15
                         <DimensionDefinitionLink
DimensionDefinitionLink

Dimension reference

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

>{String}</DimensionDefinitionLink>
16
                    </DimensionDefinition>
17
               </DimensionRequirement>
18
          </DimensionRequirements>
19
          <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>
20
     </GeneralLedgerAccount>
21
     <Dimensions>
22
          <Dimension>
23
               <Value
Value

Value for this dimension defintion.

>{String}</Value>
24
               <Description
Description

Description of the dimension value.

>{String}</Description>
25
               <DimensionDefinition>
26
                    <DimensionDefinitionId
DimensionDefinitionId

Dimension identifier

>{Integer}</DimensionDefinitionId>
27
                    <Name
Name

Name of dimension

>{String}</Name>
28
                    <DimensionDefinitionLink
DimensionDefinitionLink

Dimension reference

>{String}</DimensionDefinitionLink>
29
               </DimensionDefinition>
30
          </Dimension>
31
     </Dimensions>
32
</AccountDimensions>
1
{
2
     "accountDimensions": {
3
          "generalLedgerAccount": {
4
               "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

Name of general ledger account

": "{String}",
6
               "accountNumber
AccountNumber

The account number of the general ledger account

": "{String}",
7
               "dimensionRequirements
DimensionRequirements

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

": [
8
                    {
9
                         "requirement
Requirement

Specifies how the dimension should be used for the specific account.

Possible domain values can be found here

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

": "{String}",
10
                         "dimensionDefinition
DimensionDefinition

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

": {
11
                              "dimensionDefinitionId
DimensionDefinitionId

Dimension identifier

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

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

Name of dimension

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

": "{String}",
13
                              "valueSource
ValueSource

Where the value is selected from.

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

": {
14
                                   "type
Type

Type of source

Possible domain values can be found here

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

": "{String}"
15
                              },
16
                              "dimensionDefinitionLink
DimensionDefinitionLink

Dimension reference

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

": "{String}"
17
                         }
18
                    }
19
               ],
20
               "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

": "{String}"
21
          },
22
          "dimensions": [
23
               {
24
                    "value
Value

Value for this dimension defintion.

": "{String}",
25
                    "description
Description

Description of the dimension value.

": "{String}",
26
                    "dimensionDefinition": {
27
                         "dimensionDefinitionId
DimensionDefinitionId

Dimension identifier

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

Name of dimension

": "{String}",
29
                         "dimensionDefinitionLink
DimensionDefinitionLink

Dimension reference

": "{String}"
30
                    }
31
               }
32
          ]
33
     }
34
}

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 100169 HTTP 404 General ledger account not found : {0}
Error 108012 HTTP 400 Rental contract item not found