API

Finance APIs

POST finance/dimension-definitions/{dimensionDefinitionId}/custom-values

Resource for creating new custom value

HTTP method POST
URI https://api.rambase.net/finance/dimension-definitions/{dimensionDefinitionId}/custom-values
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {dimensionDefinitionId} Dimension identifier
Integer, minimum 1, maximum 10
Successful HTTP status code 201
API resource identifier 3453, version 4

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
<CustomValue>
2
     <CustomValueId
CustomValueId

Required/mandatory field

Dimension value identifier

Minimum value: 1

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

Required/mandatory field

Dimension value name

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

Dimension value description

This field is optional.

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

This field is optional.

>
6
          <EffectivePeriod
EffectivePeriod

Period the dimension value is effective/valid from

Minimum value: 199000

Maximum value: 299912

This field is optional.

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

Period the dimension value expires (is valid to)

Minimum value: 199000

Maximum value: 299912

This field is optional.

>{Integer}</ExpirationPeriod>
8
     </Validity>
9
</CustomValue>
1
{
2
     "customValue": {
3
          "customValueId
CustomValueId

Required/mandatory field

Dimension value identifier

Minimum value: 1

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

Required/mandatory field

Dimension value name

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

Dimension value description

This field is optional.

": "{String}",
6
          "validity
Validity

This field is optional.

": {
7
               "effectivePeriod
EffectivePeriod

Period the dimension value is effective/valid from

Minimum value: 199000

Maximum value: 299912

This field is optional.

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

Period the dimension value expires (is valid to)

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.
$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
<CustomValue>
2
     <CustomValueId
CustomValueId

Dimension value identifier

>{String}</CustomValueId>
3
     <Status
Status

Status of dimension value

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

Dimension value name

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

Dimension value description

>{String}</Description>
6
     <CreatedBy>
7
          <UserId
UserId

User identifier

>{Integer}</UserId>
8
          <UserLink
UserLink

User reference

>{String}</UserLink>
9
     </CreatedBy>
10
     <Validity>
11
          <EffectivePeriod
EffectivePeriod

Period the dimension value is effective/valid from

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

Period the dimension value expires (is valid to)

>{Integer}</ExpirationPeriod>
13
     </Validity>
14
</CustomValue>
1
{
2
     "customValue": {
3
          "customValueId
CustomValueId

Dimension value identifier

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

Status of dimension value

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

Dimension value name

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

Dimension value description

": "{String}",
7
          "createdBy": {
8
               "userId
UserId

User identifier

": "{Integer}",
9
               "userLink
UserLink

User reference

": "{String}"
10
          },
11
          "validity": {
12
               "effectivePeriod
EffectivePeriod

Period the dimension value is effective/valid from

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

Period the dimension value expires (is valid to)

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

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 100178 HTTP 404 Dimension not found
Error 104192 HTTP 404 Custom value not found
Error 104254 HTTP 400 Invalid Effective period provided!
Error 104255 HTTP 400 Invalid Expiration period provided!
Error 104256 HTTP 400 Effective period cannot be a smaller value than Expiration period.
Error 100568 HTTP 400 From period is required
Error 104258 HTTP 400 Invalid ID provided!