API

Finance APIs

PUT finance/depreciation-templates/{depreciationTemplateId}

Resource for updating existing depreciation template

HTTP method PUT
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 3988, version 3

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

This field is optional.

>
2
     <Name
Name

Name of depreciation template

This field is optional.

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

Description of depreciation template

This field is optional.

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

Type of depreciation template

Applicable domain values can be found here

This field is optional.

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

Count of periods of depreciation template

Minimum value: 0

Maximum value: 2400

This field is optional.

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

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

This field is optional.

>
{String}</CountryCode>
7
     <MinimumAmount
MinimumAmount

This field is optional.

>
8
          <Amount
Amount

Amount limit of depreciation template

Minimum value: 0

This field is optional.

>
{Integer}</Amount>
9
     </MinimumAmount>
10
     <Validity
Validity

This field is optional.

>
11
          <EffectivePeriod
EffectivePeriod

Effective period of the depreciation template

Minimum value: 199000

Maximum value: 299912

This field is optional.

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

Expiration period of the depreciation template

Minimum value: 199000

Maximum value: 299912

This field is optional.

>
{Integer}</ExpirationPeriod>
13
     </Validity>
14
</DepreciationTemplate>
1
{
2
     "depreciationTemplate
DepreciationTemplate

This field is optional.

":
{
3
          "name
Name

Name of depreciation template

This field is optional.

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

Description of depreciation template

This field is optional.

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

Type of depreciation template

Applicable domain values can be found here

This field is optional.

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

Count of periods of depreciation template

Minimum value: 0

Maximum value: 2400

This field is optional.

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

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

This field is optional.

":
"{String}",
8
          "minimumAmount
MinimumAmount

This field is optional.

":
{
9
               "amount
Amount

Amount limit of depreciation template

Minimum value: 0

This field is optional.

":
"{Integer}"
10
          },
11
          "validity
Validity

This field is optional.

":
{
12
               "effectivePeriod
EffectivePeriod

Effective period of the depreciation template

Minimum value: 199000

Maximum value: 299912

This field is optional.

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

Expiration period of the depreciation template

Minimum value: 199000

Maximum value: 299912

This field is optional.

":
"{Integer}"
14
          }
15
     }
16
}

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.

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
1

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 100027 HTTP 400 Missing mandatory parameter {0}
Error 101420 HTTP 404 Setting definition not found
Error 100609 HTTP 400 Illegal month in period {0}
Error 100570 HTTP 400 Depreciation periods is missing
Error 100602 HTTP 400 To Period must have a value before you can discontinue the document
Error 100613 HTTP 400 Expiration period must be later than effective period
Error 101804 HTTP 400 Scope is not valid