API

Finance APIs

POST finance/assets

Resource for creating new finance assets

HTTP method POST
URI https://api.rambase.net/finance/assets
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 3181, 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
<Asset>
2
     <AssetId
AssetId

Required/mandatory field

Asset identifier

Minimum value: 1

>{Integer}</AssetId>
3
     <Name
Name

Required/mandatory field

Name of asset

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

Description of finance asset

This field is optional.

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

Required/mandatory field

Effective period of the finance asset

Minimum value: 199000

Maximum value: 299912

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

Expiration period of the finance asset

Minimum value: 199000

Maximum value: 299912

This field is optional.

>{Integer}</ExpirationPeriod>
8
     </Validity>
9
</Asset>
1
{
2
     "asset": {
3
          "assetId
AssetId

Required/mandatory field

Asset identifier

Minimum value: 1

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

Required/mandatory field

Name of asset

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

Description of finance asset

This field is optional.

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

Required/mandatory field

Effective period of the finance asset

Minimum value: 199000

Maximum value: 299912

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

Expiration period of the finance asset

Minimum value: 199000

Maximum value: 299912

This field is optional.

": "{Integer}"
9
          }
10
     }
11
}

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
<Asset>
2
     <AssetId
AssetId

Asset identifier

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

Status of asset

Possible domain values can be found here

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

Name of asset

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

Description of finance asset

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

Date and time of creation

>{Datetime}</CreatedAt>
7
     <CreatedBy>
8
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
9
          <LastName
LastName

Last name of employee

>{String}</LastName>
10
          <FirstName
FirstName

First name of employee

>{String}</FirstName>
11
          <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
12
     </CreatedBy>
13
     <Validity>
14
          <EffectivePeriod
EffectivePeriod

Effective period of the finance asset

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

Expiration period of the finance asset

>{Integer}</ExpirationPeriod>
16
     </Validity>
17
</Asset>
1
{
2
     "asset": {
3
          "assetId
AssetId

Asset identifier

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

Status of asset

Possible domain values can be found here

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

Name of asset

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

Description of finance asset

": "{String}",
7
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
8
          "createdBy": {
9
               "employeeId
EmployeeId

Employee identifier

": "{Integer}",
10
               "lastName
LastName

Last name of employee

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

First name of employee

": "{String}",
12
               "employeeLink
EmployeeLink

Employee reference

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

Effective period of the finance asset

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

Expiration period of the finance asset

": "{Integer}"
17
          }
18
     }
19
}

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 101420 HTTP 404 Setting definition not found
Error 103703 HTTP 400 To period is not valid. General ledger postings exists.
Error 103918 HTTP 400 Asset number {0} already exists