API

Finance APIs

POST finance/depreciation-rules

Resource for creating new depreciation rules

HTTP method POST
URI https://api.rambase.net/finance/depreciation-rules
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 3563, version 1

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
<DepreciationRule>
2
     <Name
Name

Required/mandatory field

Name of depreciation rule

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

Required/mandatory field

Description of depreciation rule

>
{String}</Description>
4
     <Validity>
5
          <EffectivePeriod
EffectivePeriod

Required/mandatory field

Effective period of the depreciation rule

Minimum value: 199000

Maximum value: 299912

>
{Integer}</EffectivePeriod>
6
     </Validity>
7
</DepreciationRule>
1
{
2
     "depreciationRule": {
3
          "name
Name

Required/mandatory field

Name of depreciation rule

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

Required/mandatory field

Description of depreciation rule

":
"{String}",
5
          "validity": {
6
               "effectivePeriod
EffectivePeriod

Required/mandatory field

Effective period of the depreciation rule

Minimum value: 199000

Maximum value: 299912

":
"{Integer}"
7
          }
8
     }
9
}

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.
$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]

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.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<DepreciationRule>
2
     <DepreciationRuleId
DepreciationRuleId

Depreciation rule identifier

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

Status of depreciation rule

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 rule

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

Description of depreciation rule

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

Type of depreciation rule

Possible domain values can be found here

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

Count of periods of depreciation rule

>
{Integer}</DepreciationPeriods>
9
     <MinimumAmount>
10
          <Currency
Currency

Three character code following the ISO 4217 standard

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

Amount limit of depreciation rule

>
{Integer}</Amount>
12
     </MinimumAmount>
13
     <Validity>
14
          <EffectivePeriod
EffectivePeriod

Effective period of the depreciation rule

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

Expiration period of the depreciation rule

>
{Integer}</ExpirationPeriod>
16
     </Validity>
17
     <BalanceAccount
BalanceAccount

The account where the asset's original acquisition value is recorded on the balance sheet

>
18
          <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>
{Integer}</GeneralLedgerAccountId>
19
          <AccountNumber
AccountNumber

The account number of the general ledger account

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

General ledger account reference

>
{String}</GeneralLedgerAccountLink>
21
     </BalanceAccount>
22
     <AccumulatedDepreciationAccount
AccumulatedDepreciationAccount

The account on the balance sheet that shows the total depreciation applied to an asset over time, reducing its book value

>
23
          <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>
{Integer}</GeneralLedgerAccountId>
24
          <AccountNumber
AccountNumber

The account number of the general ledger account

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

General ledger account reference

>
{String}</GeneralLedgerAccountLink>
26
     </AccumulatedDepreciationAccount>
27
     <ExpenseDepreciationAccount
ExpenseDepreciationAccount

The account where the periodic depreciation expense is recorded in the income statement

>
28
          <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>
{Integer}</GeneralLedgerAccountId>
29
          <AccountNumber
AccountNumber

The account number of the general ledger account

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

General ledger account reference

>
{String}</GeneralLedgerAccountLink>
31
     </ExpenseDepreciationAccount>
32
</DepreciationRule>
1
{
2
     "depreciationRule": {
3
          "depreciationRuleId
DepreciationRuleId

Depreciation rule identifier

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

Status of depreciation rule

Possible domain values can be found here

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

Date and time of creation

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

Name of depreciation rule

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

Description of depreciation rule

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

Type of depreciation rule

Possible domain values can be found here

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

Count of periods of depreciation rule

":
"{Integer}",
10
          "minimumAmount": {
11
               "currency
Currency

Three character code following the ISO 4217 standard

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

Amount limit of depreciation rule

":
"{Integer}"
13
          },
14
          "validity": {
15
               "effectivePeriod
EffectivePeriod

Effective period of the depreciation rule

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

Expiration period of the depreciation rule

":
"{Integer}"
17
          },
18
          "balanceAccount
BalanceAccount

The account where the asset's original acquisition value is recorded on the balance sheet

":
{
19
               "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

The account number of the general ledger account

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

General ledger account reference

":
"{String}"
22
          },
23
          "accumulatedDepreciationAccount
AccumulatedDepreciationAccount

The account on the balance sheet that shows the total depreciation applied to an asset over time, reducing its book value

":
{
24
               "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

The account number of the general ledger account

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

General ledger account reference

":
"{String}"
27
          },
28
          "expenseDepreciationAccount
ExpenseDepreciationAccount

The account where the periodic depreciation expense is recorded in the income statement

":
{
29
               "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

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

The account number of the general ledger account

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

General ledger account reference

":
"{String}"
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 101015 HTTP 404 Permission not found
Error 100184 HTTP 404 Accounting period not found
Error 100608 HTTP 400 Not a valid year in the period {0}
Error 100609 HTTP 400 Illegal month in period {0}
Error 100613 HTTP 400 Expiration period must be later than effective period
Error 105645 HTTP 400 Update of balance account, accumulated depreciation account, expense depreciation account or periods are not allowed in this status