API

Finance APIs

GET finance/depreciation-templates/{depreciationTemplateId}

Depreciation template details for provided identifier

HTTP method GET
URI https://api.rambase.net/finance/depreciation-templates/{depreciationTemplateId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {depreciationTemplateId} Depriciation template identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 3220, version 7

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
<DepreciationTemplate>
2
     <DepreciationTemplateId
DepreciationTemplateId

Depriciation template identifier

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

Status of depreciation template

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Name
Name

Name of depreciation template

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

Description of depreciation template

>{String}</Description>
7
     <Type
Type

Type of depreciation template

Possible domain values can be found here

>{String}</Type>
8
     <DepreciationPeriods
DepreciationPeriods

Count of periods of depreciation template

>{Integer}</DepreciationPeriods>
9
     <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
10
     <Country
Country

English name of country.

>{String}</Country>
11
     <MinimumAmount>
12
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
13
          <Amount
Amount

Amount limit of depreciation template

>{Integer}</Amount>
14
     </MinimumAmount>
15
     <Validity>
16
          <EffectivePeriod
EffectivePeriod

Effective period of the depreciation template

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

Expiration period of the depreciation template

>{Integer}</ExpirationPeriod>
18
     </Validity>
19
     <BalanceAccount>
20
          <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

Name of general ledger account

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

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

The account number of the general ledger account

>{String}</AccountNumber>
23
          <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>
24
     </BalanceAccount>
25
     <DepreciationAccount>
26
          <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

Name of general ledger account

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

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

The account number of the general ledger account

>{String}</AccountNumber>
29
          <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>
30
     </DepreciationAccount>
31
     <Repository
Repository

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

>
32
          <Scope
Scope

Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.

Possible domain values can be found here

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

>{String}</Scope>
33
          <IsChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

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

>{Boolean}</IsChanged>
34
          <ChangedBy
ChangedBy

EmployeeId of the employee making the change

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

>
35
               <UserId
UserId

User identifier

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

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

Name of the user

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

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

First name of the user

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

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

User reference

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

>{String}</UserLink>
39
          </ChangedBy>
40
          <IsPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

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

>{Boolean}</IsPendingDeployment>
41
     </Repository>
42
</DepreciationTemplate>
1
{
2
     "depreciationTemplate": {
3
          "depreciationTemplateId
DepreciationTemplateId

Depriciation template identifier

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

Status of depreciation template

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

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

Name of depreciation template

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

Description of depreciation template

": "{String}",
8
          "type
Type

Type of depreciation template

Possible domain values can be found here

": "{String}",
9
          "depreciationPeriods
DepreciationPeriods

Count of periods of depreciation template

": "{Integer}",
10
          "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",
11
          "country
Country

English name of country.

": "{String}",
12
          "minimumAmount": {
13
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
14
               "amount
Amount

Amount limit of depreciation template

": "{Integer}"
15
          },
16
          "validity": {
17
               "effectivePeriod
EffectivePeriod

Effective period of the depreciation template

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

Expiration period of the depreciation template

": "{Integer}"
19
          },
20
          "balanceAccount": {
21
               "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

Name of general ledger account

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

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

The account number of the general ledger account

": "{String}",
24
               "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

": "{String}"
25
          },
26
          "depreciationAccount": {
27
               "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

Name of general ledger account

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

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

The account number of the general ledger account

": "{String}",
30
               "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

": "{String}"
31
          },
32
          "repository
Repository

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

": {
33
               "scope
Scope

Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.

Possible domain values can be found here

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

": "{String}",
34
               "isChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

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

": "{Boolean}",
35
               "changedBy
ChangedBy

EmployeeId of the employee making the change

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

": {
36
                    "userId
UserId

User identifier

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

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

Name of the user

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

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

First name of the user

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

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

User reference

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

": "{String}"
40
               },
41
               "isPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

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

": "{Boolean}"
42
          }
43
     }
44
}

Possible error codes the response might return:

Error 101814 HTTP 404 Employee not found