API

Sales APIs

PUT sales/credit-notes/{salesCreditNoteId}/items/{itemId}/account-dimensions

Resource for changing values in account dimensions

HTTP method PUT
URI https://api.rambase.net/sales/credit-notes/{salesCreditNoteId}/items/{itemId}/account-dimensions
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {salesCreditNoteId} Sales credit note identifier
Integer, minimum 100000
- URI parameter {itemId} Item-/line-number of the credit note
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 4819, version 1

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 101746 HTTP 404 Product structure not found. Id: {0}
Error 102633 HTTP 404 Product structure cost element not found
Error 102746 HTTP 400 The parameter value can not be more than {0}
Error 105250 HTTP 400 Cleanup time on product structure operation must be greater than 0
Error 105679 HTTP 400 Production resource does not allow to add manhours
Error 108137 HTTP 400 Standard ManhourRate is not set for Resource
Error 107764 HTTP 400 Only product structures can be externally manufactured
Error 101517 HTTP 400 Illegal Account {0}: This account require ICTDB.
Error 102482 HTTP 400 Department is required for general ledger account {0}
Error 102483 HTTP 400 Finance project is required for general ledger account {0}
Error 102484 HTTP 400 Asset is required for general ledger account {0}
Error 102485 HTTP 400 Dimension {0} ({1}) is required for general ledger account {2}
Error 101313 HTTP 400 Department number is not valid: {0}
Error 101320 HTTP 400 The project number is not valid: {0}
Error 101500 HTTP 400 Project {0} could not be used : Check project FromPeriod and ToPeriod.
Error 101501 HTTP 400 Asset is not allowed on general ledger account {0}
Error 101326 HTTP 400 The asset number is not valid : {0}
Error 102486 HTTP 400 Invalid value for dimension {0}