API

Sales APIs

PUT sales/recurring-invoice-plans/{recurringInvoicePlanId}/items/{itemId}/account-dimensions

Update value of provided account dimensions

HTTP method PUT
URI https://api.rambase.net/sales/recurring-invoice-plans/{recurringInvoicePlanId}/items/{itemId}/account-dimensions
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {recurringInvoicePlanId} Recurring invoice plan identifier
Integer, minimum 100000
- URI parameter {itemId} Recurring invoice plan item identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 4429, 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.

Format:
1
<AccountDimensions
AccountDimensions

This field is optional.

>
2
     <GeneralLedgerAccount
GeneralLedgerAccount

This field is optional.

>
3
          <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

Minimum value: 1000

This field is optional.

>{Integer}</GeneralLedgerAccountId>
4
     </GeneralLedgerAccount>
5
     <Dimensions
Dimensions

This field is optional.

>
6
          <Dimension
Dimension

This field is optional.

>
7
               <Value
Value

Value for this dimension defintion.

This field is optional.

>{String}</Value>
8
               <DimensionDefinition
DimensionDefinition

This field is optional.

>
9
                    <DimensionDefinitionId
DimensionDefinitionId

Dimension identifier

Minimum value: 1

This field is optional.

>{Integer}</DimensionDefinitionId>
10
               </DimensionDefinition>
11
          </Dimension>
12
     </Dimensions>
13
</AccountDimensions>
1
{
2
     "accountDimensions
AccountDimensions

This field is optional.

": {
3
          "generalLedgerAccount
GeneralLedgerAccount

This field is optional.

": {
4
               "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

Minimum value: 1000

This field is optional.

": "{Integer}"
5
          },
6
          "dimensions
Dimensions

This field is optional.

": [
7
               {
8
                    "value
Value

Value for this dimension defintion.

This field is optional.

": "{String}",
9
                    "dimensionDefinition
DimensionDefinition

This field is optional.

": {
10
                         "dimensionDefinitionId
DimensionDefinitionId

Dimension identifier

Minimum value: 1

This field is optional.

": "{Integer}"
11
                    }
12
               }
13
          ]
14
     }
15
}

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 105969 HTTP 400 Start date is required
Error 105970 HTTP 400 End date is required