Finance APIs
Resource for creating new depreciation templates
| HTTP method | POST |
| URI | https://api.rambase.net/finance/depreciation-templates |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 3974, 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.
Name
Required/mandatory field
Name of depreciation template
>{String}</Name>Description
Required/mandatory field
Description of depreciation template
>{String}</Description>Type
Required/mandatory field
Type of depreciation template
Applicable domain values can be found here
>{String}</Type>DepreciationPeriods
Required/mandatory field
Count of periods of depreciation template
Minimum value: 0
Maximum value: 2400
>{Integer}</DepreciationPeriods>CountryCode
Required/mandatory field
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>EffectivePeriod
Required/mandatory field
Effective period of the depreciation template
Minimum value: 199000
Maximum value: 299912
>{Integer}</EffectivePeriod>Name
Required/mandatory field
Name of depreciation template
": "{String}",Description
Required/mandatory field
Description of depreciation template
": "{String}",Type
Required/mandatory field
Type of depreciation template
Applicable domain values can be found here
": "{String}",DepreciationPeriods
Required/mandatory field
Count of periods of depreciation template
Minimum value: 0
Maximum value: 2400
": "{Integer}",CountryCode
Required/mandatory field
Two-character code (ISO 3166) identifying the country.
": "{String}",EffectivePeriod
Required/mandatory field
Effective period of the depreciation template
Minimum value: 199000
Maximum value: 299912
": "{Integer}"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.
DepreciationTemplateId
Depriciation template identifier
>{Integer}</DepreciationTemplateId>Status
Status of depreciation template
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Name
Name of depreciation template
>{String}</Name>Description
Description of depreciation template
>{String}</Description>DepreciationPeriods
Count of periods of depreciation template
>{Integer}</DepreciationPeriods>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Amount
Amount limit of depreciation template
>{Integer}</Amount>EffectivePeriod
Effective period of the depreciation template
>{Integer}</EffectivePeriod>ExpirationPeriod
Expiration period of the depreciation template
>{Integer}</ExpirationPeriod>GeneralLedgerAccountId
General ledger account identifier
>{Integer}</GeneralLedgerAccountId>AccountNumber
The account number of the general ledger account
>{String}</AccountNumber>GeneralLedgerAccountLink
General ledger account reference
>{String}</GeneralLedgerAccountLink>GeneralLedgerAccountId
General ledger account identifier
>{Integer}</GeneralLedgerAccountId>AccountNumber
The account number of the general ledger account
>{String}</AccountNumber>GeneralLedgerAccountLink
General ledger account reference
>{String}</GeneralLedgerAccountLink>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
>{String}</Scope>IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
>{Boolean}</IsChanged>ChangedBy
EmployeeId of the employee making the change
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>IsPendingDeployment
Tells whether this object has been changed locally and is ready to be deployed from the Repository
>{Boolean}</IsPendingDeployment>DepreciationTemplateId
Depriciation template identifier
": "{Integer}",Status
Status of depreciation template
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Name
Name of depreciation template
": "{String}",Description
Description of depreciation template
": "{String}",Type
Type of depreciation template
Possible domain values can be found here
": "{String}",DepreciationPeriods
Count of periods of depreciation template
": "{Integer}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}",Currency
Three character code following the ISO 4217 standard
": "{String}",Amount
Amount limit of depreciation template
": "{Integer}"EffectivePeriod
Effective period of the depreciation template
": "{Integer}",ExpirationPeriod
Expiration period of the depreciation template
": "{Integer}"GeneralLedgerAccountId
General ledger account identifier
": "{Integer}",AccountNumber
The account number of the general ledger account
": "{String}",GeneralLedgerAccountLink
General ledger account reference
": "{String}"GeneralLedgerAccountId
General ledger account identifier
": "{Integer}",AccountNumber
The account number of the general ledger account
": "{String}",GeneralLedgerAccountLink
General ledger account reference
": "{String}",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
": "{String}",IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
": "{Boolean}",ChangedBy
EmployeeId of the employee making the change
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"IsPendingDeployment
Tells whether this object has been changed locally and is ready to be deployed from the Repository
": "{Boolean}"
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 100613 HTTP 400 | Expiration period must be later than effective period |
| Error 101804 HTTP 400 | Scope is not valid |