Finance APIs
Saves information about the finance dimension custom value
| HTTP method | PUT |
| URI | https://api.rambase.net/finance/dimension-definitions/{dimensionDefinitionId}/custom-values/{customValueId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {dimensionDefinitionId} |
Dimension identifier
Integer, minimum 1, maximum 10 |
| - URI parameter {customValueId} |
Dimension value identifier
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 3457, version 2 |
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.
CustomValue
This field is optional.
>Name
Dimension value name
This field is optional.
>{String}</Name>Description
Dimension value description
This field is optional.
>{String}</Description>Validity
This field is optional.
>EffectivePeriod
Period the dimension value is effective/valid from
Minimum value: 199000
Maximum value: 299912
This field is optional.
>{Integer}</EffectivePeriod>ExpirationPeriod
Period the dimension value expires (is valid to)
Minimum value: 199000
Maximum value: 299912
This field is optional.
>{Integer}</ExpirationPeriod>CustomValue
This field is optional.
": {Name
Dimension value name
This field is optional.
": "{String}",Description
Dimension value description
This field is optional.
": "{String}",Validity
This field is optional.
": {EffectivePeriod
Period the dimension value is effective/valid from
Minimum value: 199000
Maximum value: 299912
This field is optional.
": "{Integer}",ExpirationPeriod
Period the dimension value expires (is valid to)
Minimum value: 199000
Maximum value: 299912
This field is optional.
": "{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. |
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.
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 101336 HTTP 400 | Dimension number is not valid |
| 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 |