Download OpenAPI specification:Download
| Version | Description | Date |
|---|---|---|
| 4.3.0 | - Added dimension data endpoints for budget-figures |
October, 2024 |
| 4.2.0 | - Added new dimension distributions endpoints: GetSingle, GetCount. |
October, 2024 |
| 4.1.0 | - New dimension data endpoints are added. booked-entries, draft-entries, sales-document-lines |
October, 2024 |
| 4.0.0 | - Changed restrictions for dimensions, dimension values and dimension distributions endpoints, so that GET/POST/PUT/DELETE requests are now available to all application roles. |
23/08/2024 |
| 3.1.1 | - Specification has been changed for Update. |
07/08/2024 |
| 3.0.0 | - Changed the URL for Create and Update dimensions. - dimensions GetSingle and GetCount endpoints added. - dimension values Create, Update, Delete, GetSingle and GetCount endpoints added. |
18/03/2024 |
| 2.0.0 | dimensions Create, Update and Delete endpoints added. |
18/01/2024 |
| 1.0.0 | dimensions,dimension-values endpoints added. |
02/10/2023 |
Add these three headers to your requests.
| Header | Value | What is this? |
|---|---|---|
| X-AppSecretToken | YOUR_PRIVATE_TOKEN | This identifies your app. This is your secret token. Try using the value demo. |
| X-AgreementGrantToken | YOUR_AGREEMENT_GRANT_TOKEN | This identifies the grant issued by an agreement, to allow your app to access the agreements data. Try using the value demo. |
| Content-Type | application/json | We’re a JSON based API. This tells us that you agree with us on using JSON. |
Optional headers:
| Header | Value | What is this? |
|---|---|---|
| Idempotency-Key | YOUR_IDEMPOTENCY_KEY | This represents your own unique idempotency key. Enables you to make use of our Idempotency Tokens feature. You can't use this feature with GET requests. |
$.ajax({
url: "https://apis.e-conomic.com/dimensionsapi/v4.3.0/the_resource",
dataType: "json",
headers: {
'X-AppSecretToken': "demo",
'X-AgreementGrantToken': "demo",
'Accept': "application/json"
},
type: "GET"
})
.always(function (data) {
$("#output").text(JSON.stringify(data, null, 4));
});
curl -H "X-AppSecretToken: demo" -H "X-AgreementGrantToken: demo" https://apis.e-conomic.com/dimensionsapi/v4.3.0/the_resource
Welcome to the Visma e-conomic OpenAPI documentation!
The e-conomic API is a document-based JSON REST API.
For more in-depth information about e-conomic itself, please have a look at the e-copedia http://wiki.e-conomic.dk.
API releases are versioned using a three-part versioning scheme: {major version}.{minor version}.{patch version}.
We broadly follow Semantic Versioning principles when versioning the API. The major version number is incremented when a breaking change occurs.
The format is:
/{resource-api}/v{major version}.{minor version}.{patch version}/{resource-name}
Each value of the above are integers and you should configure the specific version in each API call.
An example could be: /subscriptionsapi/v1.0.0/subscriptions
To track the changes of versions, please see our changelog.
We reserve the right to deprecate versions at intervals since this allows for moving into a friendly environment for you faster.
If you wish to try out the API before registering a developer agreement, you can do this by using the demo agreement, which mimics the authentication flow you will have to use when you create your app. All you have to do is specify HTTP header tokens X-AgreementGrantToken: demo and X-AppSecretToken: demo. Note however that you can only do GET requests with the demo agreement. If you want full access to our API's, you will need to register.
Our data is exposed as collections of items. Each item has many properties, with one property as a unique identifier, usually called number or id. You can always get a single item if you already know the unique identifier. In case the unique identifier is not known, you can always search the collection and retrieve an array of items that satisfy the search criteria, or retrieve only the count of items that satisfy the search criteria. When you search for items in a collection, you can always use filtering, sorting and pagination. When it comes to pagination, we offer two distinct approaches available on separate endpoints. You can read more about filtering, sorting and pagination in the following sections.
Filtering is enabled on all collection endpoints but not on all properties.
Filtering on collections can be done using the query string parameter filter. A filter is made up of a set of predicates and follows a syntax inspired by mongoDB. A predicate is made up of a property name, an operator, and a value.
Example: ?filter=name$eq:Joe
This matches all resources with the value Joe in the property name.
Predicates can be chained using either of the logical operators AND and OR.
Example: ?filter=name$eq:Joe$and:city$like:*port
Filtering on strings is case insensitive.
Information about what properties allow filtering and on what operators can be found in the property in the schema for the collection. Each property that allows filtering has the property "x-filterable" in combination with operators set. If you try to filter on something that isn’t allowed the server will respond with a status code 400.
If you want to control the operator affinity then you can use parentheses.
An example is: ?filter=name$eq:Joe$and:(city$like:*port$or:age$lt:40)
URL parameter values should always be URL compatible. Always URL encode filter strings.
The possible filtering operators are:
| Operator | Syntax |
|---|---|
| Equals | $eq: |
| Not equals | $ne: |
| Greater than | $gt: |
| Greater than or equal | $gte: |
| Less than | $lt: |
| Less than or equal | $lte: |
| Substring match | $like: |
| And also | $and: |
| Or else | $or: |
| In | $in: |
| Not In | $nin: |
The $like: operator supports both using wildcards (*) and not using wildcards. If no wildcards are used, the expression is considered a contains expression and effectively becomes a filter with a wildcard at the start of the string and one at the end of the string. This operator is only allowed on some properties.
To not interfere with the parsing of the filter expression, certain escape sequences are necessary.
Should you want to filter for the nonexistence of a property (i.e. null value) you can use the null escape sequence.
$null:
To determine whether a specified value matches any value in (or not in) a list you filter using the $in: or $nin: operator. The list to filter by has to be enclosed in brackets and values separated by commas.
customerNumber$in:[2,5,7,22,45]
It is possible to also use the $null: keyword if you wish to include that in the filter. The max supported length of an array using the $in: or $nin: operator is 200.
Sorting on strings is case insensitive.
Sorting on collections can be done using the query string parameter ‘sort’.
?sort=name
The default sort direction is ascending, but this can be turned by prepending a minus (-).
?sort=-name
If you need to sort by multiple properties these can just be separated by commas. Mixing of directions is allowed.
?sort=-name,age
In certain cases, you might want to enforce that even numeric values are sorted alphabetically, so 1000 is less than 30. In those cases, you can prepend the sort property with a tilde (~).
?sort=~name
Information about what properties are sortable can be found in the schema for the collection. Each property that allows sorting has the property "x-sortable": true set.
When it comes to retrieving a collection of items, you can use two distinct approaches:
Cursor-based pagination (continued loading of items using a cursor as a query parameter to get the next page of items)
Items". (Usage: /{ITEM}?cursor={CURSOR_VALUE})x-cursor-page-size extension of the response type. Usually, the size is 1000, but in some cases, where we explicitly state so, it can be smaller.Classic pagination (limited functionality*. Specify skippages and pagesize as query parameters to get a specific page of items)
Items". (Usage: /{ITEM}/paged?skippages=0&pagesize=20)Please bear in mind that the two approaches are supported by separate endpoints. To use classic pagination, add /paged to your request URL.
If you need to know the total count of items that you can expect to get from your search, you can use a separate endpoint called "Retrieve the number of Items".
You can also use the result of this endpoint to calculate the pagination navigation buttons for a table/grid-based UI.
We highly recommend that you use cursor-based pagination because:
When you search for items in a large collection, the response will contain a first set of items and a cursor that you can use in a subsequent request to get the next series of items. This way you can retrieve the next set of items only when needed (if the first set suffices, you dont need to send a second request).
The first set of items usually consists of 1000 results, but in some cases, where we explicitly state so, there may be fewer.
Please note that the cursor is currently the id of the first item on the next set and it should not be mistaken for the number of items which are yet to be displayed.
Also, if the cursor is not present in the response, it means that there are no more items in the results.
I want to retrieve all subscriptions.
I send a request to https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptions and get back an array of 1.000 subscriptions, and a cursor with value 34781
I send a request for the next items in the resulting collection: https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptions?cursor=34781 and get back an array of 1.000 subscriptions and a cursor with value 87695
I send a request for the next items in the result: https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptions?cursor=87695 and get back an array of 56 items and no cursor. No cursor means I have retrieved all the subscriptions, i.e. I have reached the end of the list.
We also provide compound cursor pagination for endpoints which return all sales document lines.
Usage: /{ITEM}?cursor={DOCUMENT_NUMBER}_{LINE_NUMBER}
This will return all the first 1000 items ordered by document number and by line number.
I want to retrieve all subscription lines
I send a request to https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptionlines
and get back an array of 1.000 lines and a cursor with value 20_100.
This means that the first 1000 lines belong to subscriptions 1-20 and stopped at line 99 (or whichever the last line before 100 was) of subscription 20.
I send a request for the next items in the resulting collection:
https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptionlines?cursor=20_100
and get back an array of 1.000 lines starting with subscription number 20, line number 100 and a cursor with value 70_25
I send a request for the next items in the result:
https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptionlines?cursor=70_25
and get back an array of 56 items and no cursor.
If no parameters are used, the collection endpoint returns 20 items at a time. URL parameters allow you to increase this to up to 100 items or to skip pages if necessary.
I want to show a grid with page size of 50 and pagination navigation buttons.
I send a request to see how many subscriptions there are in the collection:https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptions/count
I get the number of subscriptions in the collection, 2056, and I can calculate the number of pages to be 2056 divided by 50 = 40 with 6 as remainder, meaning I have 41 pages total. I can then use this to present the user the navigation buttons.
I send a request to retrieve the first page of subscriptions that my user will see:https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptions/paged?pagesize=50&sort=-number
with this I get back an array of 50 subscriptions, sorted by number in descending order.
Now if the user wants to see page number 6, I'll send a new request, skipping the first 5 pages to get the subscriptions from page number 6:https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptions/paged?pagesize=50&skippages=5&sort=-number
I get back an array of 50 subscriptions that belong to page number 6 when sorting by number in descending order.
As mentioned before we offer endpoint to get the count of items in the collection. You can also use this info for calculation of pagination navigation in case of classic pagination.
Example https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptions/count
The Open API returns these HTTP status codes.
| Code | Text | Description |
|---|---|---|
| 200 | OK | Everything is OK |
| 201 | Created | When you create resources, this is what you get. This will be accompanied by the created resource in the body and a location header with a link to the created resource. |
| 204 | No Content | In certain cases there is nothing to return. So we will let you know by returning a 204. |
| 400 | Bad Request | The request you made was somehow malformed. A malformed request could be failed validation on creation or updating. If you try to filter on something that isn’t filterable this is also what you’ll see. Whenever possible we will also try to include a developer hint to help you get around this issue. |
| 401 | Unauthorized | The credentials you supplied us with weren’t correct, or perhaps you forgot them altogether. If an agreement has revoked the grant they gave your app, this is what you will see. |
| 403 | Forbidden | You won’t necessarily have access to everything. So even though you were authorized we might still deny access to certain resources. This depends on the roles asked for when the grant was issued. |
| 404 | Not Found | This is returned when you try to request something that doesn’t exist. This could be a resource that has been deleted or just a URL you tried to hack. If you see a lot of these, it could be an indication that you aren’t using the links provided by the API. You should never need to concatenate any URLs. The API should provide you with the links needed. |
| 405 | Method Not Allowed | Not all endpoints support all HTTP methods. If you try issue a PUT request to a collection resource this is what you get. |
| 409 | Conflict | The request cannot be completed due to a conflict with the current state of the target resource. Retrieve the resource/object and try the update again. This is needed in order to prevent you from rolling back another user's update. |
| 415 | Unsupported Media Type | Our API is a JSON api. If you ask us to give you anything else, we give you this, and tell you why in the JSON body of the response. |
| 500 | Internal Server Error | We don’t like to see these, and they are flagged in our logs. When you see this, something went wrong on our end. Either try again, or contact our support. |
Since OpenAPI allows client generation based on the specification, we decided to use the same model/schema in our for both read and write endpoints where possible.
This led us to chose not to have the Id/Number in the URL parameter for PUT requests, but to use the one from the body, so there is no confusion.
When a property is marked as required it means you need to provide a value on each POST and PUT requests.
When a property is marked as readonly it means you should provide the same value you get in the GET requests, or do not send the property in the JSON at all (skip it).
All non-alphanumeric characters in resource URLs are standard URL encoded. Please refer to standard URL encoding.
Helpful details to know when implementing e-conomic REST.
Booleans should only be expected to be represented in responses when true. A false boolean is omitted from response body. The same logic applies to write operations such as POST and PUT.
We do not generally accept null as a value and a validation exception should be expected. To null a property you must exclude it from your JSON on the write operation.
ObjectVersion is the mechanism that enforces updates only on latest state of an object.
ObjectVersion property is mandatory in Put Requests.
ObjectVersion property is retrieved on Get Request and needs to be included in Put Request.
If object was modified between Get and Put requests, Put request will fail with error code 409 Conflict
{
"message": "Update conflict. Version does not match.",
"developerHint": "The resource has been updated by another user. Retrieve the resource/object and try the update again. This is needed in order to prevent you from rolling back another user's update.",
"logId": "09580053-1141-4e7f-85e1-bed8600e0278",
"logTimeUtc": "2021-11-04T09:07:56",
"property": "version"
}
Idempotency tokens are unique keys that help maintain the integrity of operations on the API’s. These tokens prevent accidental duplication of requests, ensuring that the same operation is not performed multiple times, even if the same request is sent repeatedly.
When making a request, you can set Idempotency-Key header with your own unique value for that specific request. In case of a network failure, if you don't get the response, you can retry the request with the same value for the header. Our system will prevent duplicate requests, instead you will get the original response from our cache.
Keep in mind that this is cached for only one hour window.
When we return a response from the cache, we set a response header X-ResultFromCache to true.
It’s important to note that you will be responsible for generating and keeping track of these keys.
The Idempotency Tokens feature is not available for GET requests.
The LastUpdated property shows the date when a resource was last updated. A resource is considered updated when any property in the model has been changed. If there aren’t any changes, LastUpdated will equal the creation date.
Please bear in mind that not all resources have a LastUpdated property. Also, sometimes the LastUpdated property is modified by changes to a different model, as is the case with sales documents. For example, when an invoice line is created, the LastUpdated field on the invoice is modified.
The main usage for this property is to help retrieve only data that has been changed within a certain interval. This will save processing and network time spent on the client side.
Usage example: https://apis.e-conomic.com/dimensionsapi/v4.3.0/the_resource?filter$eq:lastUpdated$gt:2024-02-24 This will return all resources which have been updated since 24.02.2024.
In the specification file, there are some custom extensions that developers can make use of when consuming endpoints. Those extensions are always prefixed by x-.
x-required-roles: The list of roles that are required for each group of endpoints.x-error-codes: The list of error codes that are potentially returned from each group of endpoints.x-cursor-page-size: The maximum number of items in CursorResults that can be returned in a single call.Booked entry dimension data endpoints allow you to link booked entries to one or more dimension values.
?filter=entryNumber$eq:11$and:dimensionNumber$eq:2| Error Code | Description |
|---|---|
| ONLYONEITEMPERDIMENSION | Invalid dimension key, only one dimension value or distribution key is allowed per dimension. |
| ONLYONEDISTRIBUTIONALLOWED | Invalid dimension key, only one distribution key is allowed across dimensions. |
| CONTAINSINVALIDVALUES | Invalid dimension key, please use valid dimension value or distribution key. |
| BOOKEDENTRYNOTFOUND | One or more given booked entries do not exist. |
Required application roles: SuperUser or Bookkeeping More info
Use this endpoint to retrieve all the dimension data related to booked entries.
| cursor | string [ 0 .. 50 ] characters Use this parameter to set the continuation cursor for paging. Pagination instructions |
| filter | string Use this parameter to set the filtering for fields. filtering instructions |
| cursor | string or null Use this continuation cursor in a request back to continue the list. In case there are no more items to retrieve, the cursor is not returned at all. Read-only: true Filterable: not filterable Sortable: false |
Array of objects or null (BookedEntry) Max number of items returned is 1000. Filterable: not filterable Sortable: false |
{- "cursor": "234",
- "items": [
- {
- "id": "13",
- "name": "Patrick"
}, - {
- "id": "16",
- "name": "John"
}
]
}Use this endpoint to add new dimension to an existing booked entry
| dimensionKey required | integer <int32> [ 1 .. 2147483647 ] The unique number of the value or distribution corresponding to the dimension that the sales document, journal entry or budget figure is linked to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionNumber required | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| entryNumber required | integer <int32> The number of the booked entry associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| isDistribution | boolean Flag indicating whether the selected entity is a dimension value or a dimension distribution. Filterable: not filterable Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
| dimensionNumber | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
{- "dimensionNumber": 1,
- "dimensionKey": 1,
- "entryNumber": 0
}{- "dimensionNumber": 1
}Use this endpoint to update an existing dimension on an booked entry
| dimensionKey required | integer <int32> [ 1 .. 2147483647 ] The unique number of the value or distribution corresponding to the dimension that the sales document, journal entry or budget figure is linked to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionNumber required | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| entryNumber required | integer <int32> The number of the booked entry associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| isDistribution | boolean Flag indicating whether the selected entity is a dimension value or a dimension distribution. Filterable: not filterable Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
{- "dimensionNumber": 1,
- "dimensionKey": 1,
- "entryNumber": 0
}{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "errors": [
- {
- "property": "string",
- "message": "string",
- "errorCode": "string"
}
], - "traceId": "string",
- "errorCode": "string",
- "traceTimeUtc": "string"
}Use this endpoint to delete a single DimensionData by number.
| dimensionKey required | integer <int32> [ 1 .. 2147483647 ] The unique number of the value or distribution corresponding to the dimension that the sales document, journal entry or budget figure is linked to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionNumber required | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| entryNumber required | integer <int32> The number of the booked entry associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| isDistribution | boolean Flag indicating whether the selected entity is a dimension value or a dimension distribution. Filterable: not filterable Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
{- "dimensionNumber": 1,
- "dimensionKey": 1,
- "entryNumber": 0
}{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "errors": [
- {
- "property": "string",
- "message": "string",
- "errorCode": "string"
}
], - "traceId": "string",
- "errorCode": "string",
- "traceTimeUtc": "string"
}Use this endpoint to load a page of DimensionData.
| filter | string Use this parameter to set the filtering for fields. Filtering instructions |
| pageSize | integer <int32> [ 1 .. 100 ] Default: 20 Use this parameter to set the page size. Pagination instructions |
| skipPages | integer <int32> [ 0 .. 100 ] Default: 0 Use this parameter to set number of pages to skip. Pagination instructions |
| sort | string Use this parameter to set the sort fields and direction. Sort instructions |
| dimensionKey required | integer <int32> [ 1 .. 2147483647 ] The unique number of the value or distribution corresponding to the dimension that the sales document, journal entry or budget figure is linked to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionNumber required | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| entryNumber required | integer <int32> The number of the booked entry associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| isDistribution | boolean Flag indicating whether the selected entity is a dimension value or a dimension distribution. Filterable: not filterable Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
[- {
- "dimensionNumber": 1,
- "dimensionKey": 1,
- "isDistribution": true,
- "objectVersion": "string",
- "entryNumber": 0
}
]Call this endpoint to get the number of DimensionData. You can use filtering as well.
| filter | string Use this parameter to set the filtering for fields. Filtering instructions |
0Use this endpoint to add dimensions to existing booked entries
Array of objects or null (BookedEntry) List of booked entries Filterable: not filterable Sortable: false |
| dimensionNumbers | Array of integers <int32> [ items <int32 > [ 1 .. 2147483647 ] ] |
{ }{- "dimensionNumbers": [
- 1
]
}Use this endpoint to update existing dimensions on existing booked entries
Array of objects or null (BookedEntry) List of booked entries Filterable: not filterable Sortable: false |
{ }{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "errors": [
- {
- "property": "string",
- "message": "string",
- "errorCode": "string"
}
], - "traceId": "string",
- "errorCode": "string",
- "traceTimeUtc": "string"
}Budget figure dimension data endpoints allow you to link budget figures to one or more dimension values.
?filter=budgetFigureNumber$eq:11$and:dimensionNumber$eq:2| Error Code | Description |
|---|---|
| ONLYONEITEMPERDIMENSION | Invalid dimension key, only one dimension value or distribution key is allowed per dimension. |
| ONLYONEDISTRIBUTIONALLOWED | Invalid dimension key, only one distribution key is allowed across dimensions. |
| CONTAINSINVALIDVALUES | Invalid dimension key, please use valid dimension value or distribution key. |
| BUDGETFIGURENOTFOUND | One or more given budget figures do not exist. |
Required application roles: SuperUser or Bookkeeping More info
Use this endpoint to retrieve all the dimension data related to budget figures.
| cursor | string [ 0 .. 50 ] characters Use this parameter to set the continuation cursor for paging. Pagination instructions |
| filter | string Use this parameter to set the filtering for fields. filtering instructions |
| cursor | string or null Use this continuation cursor in a request back to continue the list. In case there are no more items to retrieve, the cursor is not returned at all. Read-only: true Filterable: not filterable Sortable: false |
Array of objects or null (BudgetFigure) Max number of items returned is 1000. Filterable: not filterable Sortable: false |
{- "cursor": "234",
- "items": [
- {
- "id": "13",
- "name": "Patrick"
}, - {
- "id": "16",
- "name": "John"
}
]
}Use this endpoint to add new dimension to an existing budget figure
| budgetFigureNumber required | integer <int32> The number of the budget figure associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionKey required | integer <int32> [ 1 .. 2147483647 ] The unique number of the value or distribution corresponding to the dimension that the sales document, journal entry or budget figure is linked to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionNumber required | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| isDistribution | boolean Flag indicating whether the selected entity is a dimension value or a dimension distribution. Filterable: not filterable Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
| dimensionNumber | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
{- "dimensionNumber": 1,
- "dimensionKey": 1,
- "budgetFigureNumber": 0
}{- "dimensionNumber": 1
}Use this endpoint to update an existing dimension on a budget figure
| budgetFigureNumber required | integer <int32> The number of the budget figure associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionKey required | integer <int32> [ 1 .. 2147483647 ] The unique number of the value or distribution corresponding to the dimension that the sales document, journal entry or budget figure is linked to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionNumber required | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| isDistribution | boolean Flag indicating whether the selected entity is a dimension value or a dimension distribution. Filterable: not filterable Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
{- "dimensionNumber": 1,
- "dimensionKey": 1,
- "budgetFigureNumber": 0
}{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "errors": [
- {
- "property": "string",
- "message": "string",
- "errorCode": "string"
}
], - "traceId": "string",
- "errorCode": "string",
- "traceTimeUtc": "string"
}Use this endpoint to delete a single DimensionData by number.
| budgetFigureNumber required | integer <int32> The number of the budget figure associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionKey required | integer <int32> [ 1 .. 2147483647 ] The unique number of the value or distribution corresponding to the dimension that the sales document, journal entry or budget figure is linked to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionNumber required | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| isDistribution | boolean Flag indicating whether the selected entity is a dimension value or a dimension distribution. Filterable: not filterable Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
{- "dimensionNumber": 1,
- "dimensionKey": 1,
- "budgetFigureNumber": 0
}{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "errors": [
- {
- "property": "string",
- "message": "string",
- "errorCode": "string"
}
], - "traceId": "string",
- "errorCode": "string",
- "traceTimeUtc": "string"
}Use this endpoint to load a page of DimensionData.
| filter | string Use this parameter to set the filtering for fields. Filtering instructions |
| pageSize | integer <int32> [ 1 .. 100 ] Default: 20 Use this parameter to set the page size. Pagination instructions |
| skipPages | integer <int32> [ 0 .. 100 ] Default: 0 Use this parameter to set number of pages to skip. Pagination instructions |
| sort | string Use this parameter to set the sort fields and direction. Sort instructions |
| budgetFigureNumber required | integer <int32> The number of the budget figure associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionKey required | integer <int32> [ 1 .. 2147483647 ] The unique number of the value or distribution corresponding to the dimension that the sales document, journal entry or budget figure is linked to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionNumber required | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| isDistribution | boolean Flag indicating whether the selected entity is a dimension value or a dimension distribution. Filterable: not filterable Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
[- {
- "dimensionNumber": 1,
- "dimensionKey": 1,
- "isDistribution": true,
- "objectVersion": "string",
- "budgetFigureNumber": 0
}
]Call this endpoint to get the number of DimensionData. You can use filtering as well.
| filter | string Use this parameter to set the filtering for fields. Filtering instructions |
0Use this endpoint to add dimensions to existing budget figures
Array of objects or null (BudgetFigure) List of budget figures Filterable: not filterable Sortable: false |
| dimensionNumbers | Array of integers <int32> [ items <int32 > [ 1 .. 2147483647 ] ] |
{ }{- "dimensionNumbers": [
- 1
]
}Use this endpoint to update existing dimensions on existing budget figures
Array of objects or null (BudgetFigure) List of budget figures Filterable: not filterable Sortable: false |
{ }{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "errors": [
- {
- "property": "string",
- "message": "string",
- "errorCode": "string"
}
], - "traceId": "string",
- "errorCode": "string",
- "traceTimeUtc": "string"
}Draft entry dimension data endpoints allow you to link draft entries to one or more dimension values.
?filter=entryNumber$eq:11$and:dimensionNumber$eq:2| Error Code | Description |
|---|---|
| ONLYONEITEMPERDIMENSION | Invalid dimension key, only one dimension value or distribution key is allowed per dimension. |
| ONLYONEDISTRIBUTIONALLOWED | Invalid dimension key, only one distribution key is allowed across dimensions. |
| CONTAINSINVALIDVALUES | Invalid dimension key, please use valid dimension value or distribution key. |
| JOURNALNOTFOUND | One or more given journals do not exist. |
| DRAFTENTRYNOTFOUND | One or more given draft entries do not exist. |
Required application roles: SuperUser or Bookkeeping More info
Use this endpoint to retrieve all the dimension data related to draft entries.
| cursor | string [ 0 .. 50 ] characters Use this parameter to set the continuation cursor for paging. Pagination instructions |
| filter | string Use this parameter to set the filtering for fields. filtering instructions |
| cursor | string or null Use this continuation cursor in a request back to continue the list. In case there are no more items to retrieve, the cursor is not returned at all. Read-only: true Filterable: not filterable Sortable: false |
Array of objects or null (DraftEntry) Max number of items returned is 1000. Filterable: not filterable Sortable: false |
{- "cursor": "234",
- "items": [
- {
- "id": "13",
- "name": "Patrick"
}, - {
- "id": "16",
- "name": "John"
}
]
}Use this endpoint to add new dimension to an existing draft entry
| dimensionKey required | integer <int32> [ 1 .. 2147483647 ] The unique number of the value or distribution corresponding to the dimension that the sales document, journal entry or budget figure is linked to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionNumber required | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| entryNumber required | integer <int32> The number of the draft entry associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| journalNumber required | integer <int32> The number of the journal on which the entry associated with the dimension was registered. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| isDistribution | boolean Flag indicating whether the selected entity is a dimension value or a dimension distribution. Filterable: not filterable Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
| dimensionNumber | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
{- "dimensionNumber": 1,
- "dimensionKey": 1,
- "journalNumber": 0,
- "entryNumber": 0
}{- "dimensionNumber": 1
}Use this endpoint to update an existing dimension on an draft entry
| dimensionKey required | integer <int32> [ 1 .. 2147483647 ] The unique number of the value or distribution corresponding to the dimension that the sales document, journal entry or budget figure is linked to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionNumber required | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| entryNumber required | integer <int32> The number of the draft entry associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| journalNumber required | integer <int32> The number of the journal on which the entry associated with the dimension was registered. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| isDistribution | boolean Flag indicating whether the selected entity is a dimension value or a dimension distribution. Filterable: not filterable Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
{- "dimensionNumber": 1,
- "dimensionKey": 1,
- "journalNumber": 0,
- "entryNumber": 0
}{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "errors": [
- {
- "property": "string",
- "message": "string",
- "errorCode": "string"
}
], - "traceId": "string",
- "errorCode": "string",
- "traceTimeUtc": "string"
}Use this endpoint to delete a single DimensionData by number.
| dimensionKey required | integer <int32> [ 1 .. 2147483647 ] The unique number of the value or distribution corresponding to the dimension that the sales document, journal entry or budget figure is linked to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionNumber required | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| entryNumber required | integer <int32> The number of the draft entry associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| journalNumber required | integer <int32> The number of the journal on which the entry associated with the dimension was registered. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| isDistribution | boolean Flag indicating whether the selected entity is a dimension value or a dimension distribution. Filterable: not filterable Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
{- "dimensionNumber": 1,
- "dimensionKey": 1,
- "journalNumber": 0,
- "entryNumber": 0
}{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "errors": [
- {
- "property": "string",
- "message": "string",
- "errorCode": "string"
}
], - "traceId": "string",
- "errorCode": "string",
- "traceTimeUtc": "string"
}Use this endpoint to load a page of DimensionData.
| filter | string Use this parameter to set the filtering for fields. Filtering instructions |
| pageSize | integer <int32> [ 1 .. 100 ] Default: 20 Use this parameter to set the page size. Pagination instructions |
| skipPages | integer <int32> [ 0 .. 100 ] Default: 0 Use this parameter to set number of pages to skip. Pagination instructions |
| sort | string Use this parameter to set the sort fields and direction. Sort instructions |
| dimensionKey required | integer <int32> [ 1 .. 2147483647 ] The unique number of the value or distribution corresponding to the dimension that the sales document, journal entry or budget figure is linked to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionNumber required | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| entryNumber required | integer <int32> The number of the draft entry associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| journalNumber required | integer <int32> The number of the journal on which the entry associated with the dimension was registered. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| isDistribution | boolean Flag indicating whether the selected entity is a dimension value or a dimension distribution. Filterable: not filterable Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
[- {
- "dimensionNumber": 1,
- "dimensionKey": 1,
- "isDistribution": true,
- "objectVersion": "string",
- "journalNumber": 0,
- "entryNumber": 0
}
]Call this endpoint to get the number of DimensionData. You can use filtering as well.
| filter | string Use this parameter to set the filtering for fields. Filtering instructions |
0Use this endpoint to add dimensions to existing draft entries
Array of objects or null (DraftEntry) List of draft entries Filterable: not filterable Sortable: false |
| dimensionNumbers | Array of integers <int32> [ items <int32 > [ 1 .. 2147483647 ] ] |
{ }{- "dimensionNumbers": [
- 1
]
}Use this endpoint to update existing dimensions on draft entries
Array of objects or null (DraftEntry) List of draft entries Filterable: not filterable Sortable: false |
{ }{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "errors": [
- {
- "property": "string",
- "message": "string",
- "errorCode": "string"
}
], - "traceId": "string",
- "errorCode": "string",
- "traceTimeUtc": "string"
}Sales documents dimension data endpoints allow you to link sales documents such as orders, quotes or invoices to one or more dimension values.
?filter=documentNumber$eq:11$and:dimensionNumber$eq:2| Error Code | Description |
|---|---|
| ONLYONEITEMPERDIMENSION | Invalid dimension key, only one dimension value or distribution key is allowed per dimension. |
| ONLYONEDISTRIBUTIONALLOWED | Invalid dimension key, only one distribution key is allowed across dimensions. |
| CONTAINSINVALIDVALUES | Invalid dimension key, please use valid dimension value or distribution key. |
| SALESDOCUMENTNOTFOUND | One or more given sales documents do not exist. |
| SALESDOCUMENTLINENOTFOUND | One or more given sales document lines do not exist. |
Required application roles: SuperUser or Sales More info
Use this endpoint to retrieve all the dimension data related to sales document lines.
| cursor | string [ 0 .. 50 ] characters Use this parameter to set the continuation cursor for paging. Pagination instructions |
| filter | string Use this parameter to set the filtering for fields. filtering instructions |
| cursor | string or null Use this continuation cursor in a request back to continue the list. In case there are no more items to retrieve, the cursor is not returned at all. Read-only: true Filterable: not filterable Sortable: false |
Array of objects or null (SalesDocumentLine) Max number of items returned is 1000. Filterable: not filterable Sortable: false |
{- "cursor": "234",
- "items": [
- {
- "id": "13",
- "name": "Patrick"
}, - {
- "id": "16",
- "name": "John"
}
]
}Use this endpoint to add new dimension to an existing sales document line
| dimensionKey required | integer <int32> [ 1 .. 2147483647 ] The unique number of the value or distribution corresponding to the dimension that the sales document, journal entry or budget figure is linked to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionNumber required | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| documentNumber required | integer <int32> The number of the sales document (invoice, order or quote) associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| lineNumber required | integer <int32> The number of the line on the sales document (invoice, order or quote) associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| isDistribution | boolean Flag indicating whether the selected entity is a dimension value or a dimension distribution. Filterable: not filterable Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
| dimensionNumber | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
{- "dimensionNumber": 1,
- "dimensionKey": 1,
- "documentNumber": 0,
- "lineNumber": 0
}{- "dimensionNumber": 1
}Use this endpoint to update an existing dimension on an sales document line
| dimensionKey required | integer <int32> [ 1 .. 2147483647 ] The unique number of the value or distribution corresponding to the dimension that the sales document, journal entry or budget figure is linked to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionNumber required | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| documentNumber required | integer <int32> The number of the sales document (invoice, order or quote) associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| lineNumber required | integer <int32> The number of the line on the sales document (invoice, order or quote) associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| isDistribution | boolean Flag indicating whether the selected entity is a dimension value or a dimension distribution. Filterable: not filterable Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
{- "dimensionNumber": 1,
- "dimensionKey": 1,
- "documentNumber": 0,
- "lineNumber": 0
}{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "errors": [
- {
- "property": "string",
- "message": "string",
- "errorCode": "string"
}
], - "traceId": "string",
- "errorCode": "string",
- "traceTimeUtc": "string"
}Use this endpoint to delete a single DimensionData by number.
| dimensionKey required | integer <int32> [ 1 .. 2147483647 ] The unique number of the value or distribution corresponding to the dimension that the sales document, journal entry or budget figure is linked to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionNumber required | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| documentNumber required | integer <int32> The number of the sales document (invoice, order or quote) associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| lineNumber required | integer <int32> The number of the line on the sales document (invoice, order or quote) associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| isDistribution | boolean Flag indicating whether the selected entity is a dimension value or a dimension distribution. Filterable: not filterable Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
{- "dimensionNumber": 1,
- "dimensionKey": 1,
- "documentNumber": 0,
- "lineNumber": 0
}{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "errors": [
- {
- "property": "string",
- "message": "string",
- "errorCode": "string"
}
], - "traceId": "string",
- "errorCode": "string",
- "traceTimeUtc": "string"
}Use this endpoint to load a page of DimensionData.
| filter | string Use this parameter to set the filtering for fields. Filtering instructions |
| pageSize | integer <int32> [ 1 .. 100 ] Default: 20 Use this parameter to set the page size. Pagination instructions |
| skipPages | integer <int32> [ 0 .. 100 ] Default: 0 Use this parameter to set number of pages to skip. Pagination instructions |
| sort | string Use this parameter to set the sort fields and direction. Sort instructions |
| dimensionKey required | integer <int32> [ 1 .. 2147483647 ] The unique number of the value or distribution corresponding to the dimension that the sales document, journal entry or budget figure is linked to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| dimensionNumber required | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension associated with the sales document, journal entry or budget figure. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| documentNumber required | integer <int32> The number of the sales document (invoice, order or quote) associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| lineNumber required | integer <int32> The number of the line on the sales document (invoice, order or quote) associated with the dimension. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| isDistribution | boolean Flag indicating whether the selected entity is a dimension value or a dimension distribution. Filterable: not filterable Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
[- {
- "dimensionNumber": 1,
- "dimensionKey": 1,
- "isDistribution": true,
- "objectVersion": "string",
- "documentNumber": 0,
- "lineNumber": 0
}
]Call this endpoint to get the number of DimensionData. You can use filtering as well.
| filter | string Use this parameter to set the filtering for fields. Filtering instructions |
0Use this endpoint to add dimensions to existing sales document lines
Array of objects or null (SalesDocumentLine) List of sales document lines Filterable: not filterable Sortable: false |
| dimensionNumbers | Array of integers <int32> [ items <int32 > [ 1 .. 2147483647 ] ] |
{ }{- "dimensionNumbers": [
- 1
]
}Use this endpoint to update existing dimensions on existing sales document lines
Array of objects or null (SalesDocumentLine) List of sales document lines Filterable: not filterable Sortable: false |
{ }{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "errors": [
- {
- "property": "string",
- "message": "string",
- "errorCode": "string"
}
], - "traceId": "string",
- "errorCode": "string",
- "traceTimeUtc": "string"
}Dimension distributions allow expenses/revenue to be distributed to several dimension values when registering a sales document.
E.g. Suppose you have a dimension called Region and a value for each city where you have a store and you want to link a sales document not to a single store, but to two. In this case you create a distribution called 40/60, where you specify that 40% of the amount on the sales document is related to the store in value 1 and 60% to the store in value 2.
| Error Code | Description |
|---|---|
| DimensionDistributionDoesNotExist | DimensionDistributionDoesNotExist |
| DimensionDistributionAtLeast1ChildRequired | Distribution keys must have at least one value. |
| DimensionDistributionOnlyOneOfEachValueAllowed | Each value can only be specified once. |
| DimensionDistributionPercentSumMustBe100 | The total of the percentage distributions must be 100. |
Required application roles: SuperUser or Bookkeeping or Sales or ProjectEmployee More info
Use this endpoint to retrieve single dimension distribution defined for a customer.
| dimensionNumber required | integer <int32> |
| key required | integer <int32> |
| active | boolean Flag indicating whether the dimension distribution is active or disabled. Filterable: eq, ne, lt, lte, gt, gte Sortable: false |
| dimensionNumber | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension that the distribution corresponds to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
Array of objects or null (Distribution) List showing the percentage in which you want to distribute several dimension values. E.g. You can have a distribution of 60% for value 1 and 40% for value 2 Filterable: not filterable Sortable: false | |
| key | integer <int32> The unique number of the dimension distribution. Since distributions and values are both dimension keys, there can't be a value with the same key as a distribution. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| name | string or null [ 0 .. 255 ] characters The name of the dimension distribution. It should suggest the percentage you allocate to each value when applying a distribution, e.g. 60/40. Filterable: eq, ne, lt, lte, gt, gte, like Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
{- "dimensionNumber": 1,
- "key": 0,
- "name": "string",
- "active": true,
- "distributions": [
- {
- "key": 0,
- "percent": 0,
- "objectVersion": "string"
}
], - "objectVersion": "string"
}Use this endpoint to retrieve all the dimension distributions that defined for a customer.
| cursor | string [ 0 .. 50 ] characters Use this parameter to set the continuation cursor for paging. Pagination instructions |
| filter | string Use this parameter to set the filtering for fields. filtering instructions |
| cursor | string or null Use this continuation cursor in a request back to continue the list. In case there are no more items to retrieve, the cursor is not returned at all. Read-only: true Filterable: not filterable Sortable: false |
Array of objects or null (DimensionDistribution) Max number of items returned is 1000. Filterable: not filterable Sortable: false |
{- "cursor": "234",
- "items": [
- {
- "id": "13",
- "name": "Patrick"
}, - {
- "id": "16",
- "name": "John"
}
]
}Use this endpoint to load a page of DimensionDistributions.
| filter | string Use this parameter to set the filtering for fields. Filtering instructions |
| pageSize | integer <int32> [ 1 .. 100 ] Default: 20 Use this parameter to set the page size. Pagination instructions |
| skipPages | integer <int32> [ 0 .. 100 ] Default: 0 Use this parameter to set number of pages to skip. Pagination instructions |
| sort | string Use this parameter to set the sort fields and direction. Sort instructions |
| active | boolean Flag indicating whether the dimension distribution is active or disabled. Filterable: eq, ne, lt, lte, gt, gte Sortable: false |
| dimensionNumber | integer <int32> [ 1 .. 2147483647 ] The unique number of the dimension that the distribution corresponds to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
Array of objects or null (Distribution) List showing the percentage in which you want to distribute several dimension values. E.g. You can have a distribution of 60% for value 1 and 40% for value 2 Filterable: not filterable Sortable: false | |
| key | integer <int32> The unique number of the dimension distribution. Since distributions and values are both dimension keys, there can't be a value with the same key as a distribution. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| name | string or null [ 0 .. 255 ] characters The name of the dimension distribution. It should suggest the percentage you allocate to each value when applying a distribution, e.g. 60/40. Filterable: eq, ne, lt, lte, gt, gte, like Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
[- {
- "dimensionNumber": 1,
- "key": 0,
- "name": "string",
- "active": true,
- "distributions": [
- {
- "key": 0,
- "percent": 0,
- "objectVersion": "string"
}
], - "objectVersion": "string"
}
]Call this endpoint to get the number of DimensionDistributions. You can use filtering as well.
| filter | string Use this parameter to set the filtering for fields. Filtering instructions |
0Dimension values go hand in hand with dimensions like a key-value pair. While dimensions can be seen as a category, values designate the items that fit into a particular category. E.g if you have a dimension called Suppliers, you should create a value for each supplier of interest or if you have a chain of stores and a dimension called Region, you could use values for each city where you have a store.
| Error Code | Description |
|---|---|
| DimensionValueDoesNotExist | Dimension value with this number does not exist. |
| DimensionValueInUse | Dimension value is in use with one or more entries/configurations. |
| DimensionValueInUseMultiple | Dimension value is in use with one or more entries/configurations. |
| DimensionValueInUseByDistribution | Dimension value is in use by one or more distribution keys. |
| KeyInUse | A department or distribution key with this number already exists. |
| KeyInUseMultiple | A department or distribution key with this number is in use with one or more entries/configurations. |
| KeyNumberIsZeroOrNegative | Number must be a positive number. |
| DimensionValueImportDuplicateKey | DimensionValueImportDuplicateKey |
| DimensionValueImportDistributionKeyInUse | DimensionValueImportDistributionKeyInUse |
| DimensionValueImportDuplicateIndex | DimensionValueImportDuplicateIndex |
Required application roles: SuperUser or Bookkeeping or Sales or ProjectEmployee More info
Use this endpoint to retrieve single dimension value defined for a customer.
| dimensionNumber required | integer <int32> |
| key required | integer <int32> |
| active | boolean The flag that indicates dimension value is activated or disabled. Filterable: eq, ne, lt, lte, gt, gte Sortable: false |
| dimensionNumber | integer <int32> [ 1 .. 3 ] The unique number of the dimension that the dimension value belongs to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| key | integer <int32> The unique number of the dimension value. Since distributions and values are both dimension keys, there can't be a value with the same key as a distribution. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| name | string or null [ 0 .. 255 ] characters The name of the dimension value. It should reflect the possible values corresponding to a certain dimension. E.g. if you have a dimension called Product, a value name could be the name of a product you are selling or if you have a dimension called Location, a value name could be a city where you have a store. Filterable: eq, ne, lt, lte, gt, gte, like Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
{- "dimensionNumber": 1,
- "key": 0,
- "name": "string",
- "active": true,
- "objectVersion": "string"
}Use this endpoint to retrieve all the dimension values that defined for a customer.
| cursor | string [ 0 .. 50 ] characters Use this parameter to set the continuation cursor for paging. Pagination instructions |
| filter | string Use this parameter to set the filtering for fields. filtering instructions |
| cursor | string or null Use this continuation cursor in a request back to continue the list. In case there are no more items to retrieve, the cursor is not returned at all. Read-only: true Filterable: not filterable Sortable: false |
Array of objects or null (DimensionValue) Max number of items returned is 1000. Filterable: not filterable Sortable: false |
{- "cursor": "234",
- "items": [
- {
- "id": "13",
- "name": "Patrick"
}, - {
- "id": "16",
- "name": "John"
}
]
}Use this endpoint to create a single DimensionValue.
| active | boolean The flag that indicates dimension value is activated or disabled. Filterable: eq, ne, lt, lte, gt, gte Sortable: false |
| dimensionNumber | integer <int32> [ 1 .. 3 ] The unique number of the dimension that the dimension value belongs to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| key | integer <int32> The unique number of the dimension value. Since distributions and values are both dimension keys, there can't be a value with the same key as a distribution. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| name | string or null [ 0 .. 255 ] characters The name of the dimension value. It should reflect the possible values corresponding to a certain dimension. E.g. if you have a dimension called Product, a value name could be the name of a product you are selling or if you have a dimension called Location, a value name could be a city where you have a store. Filterable: eq, ne, lt, lte, gt, gte, like Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
| key | integer <int32> The unique number of the dimension value. Since distributions and values are both dimension keys, there can't be a value with the same key as a distribution. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
{ }{- "key": 0
}Use this endpoint to update a single DimensionValue.
| active | boolean The flag that indicates dimension value is activated or disabled. Filterable: eq, ne, lt, lte, gt, gte Sortable: false |
| dimensionNumber | integer <int32> [ 1 .. 3 ] The unique number of the dimension that the dimension value belongs to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| key | integer <int32> The unique number of the dimension value. Since distributions and values are both dimension keys, there can't be a value with the same key as a distribution. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| name | string or null [ 0 .. 255 ] characters The name of the dimension value. It should reflect the possible values corresponding to a certain dimension. E.g. if you have a dimension called Product, a value name could be the name of a product you are selling or if you have a dimension called Location, a value name could be a city where you have a store. Filterable: eq, ne, lt, lte, gt, gte, like Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
{ }{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "errors": [
- {
- "property": "string",
- "message": "string",
- "errorCode": "string"
}
], - "traceId": "string",
- "errorCode": "string",
- "traceTimeUtc": "string"
}Use this endpoint to delete a single Dimension Value by number.
| active | boolean The flag that indicates dimension value is activated or disabled. Filterable: eq, ne, lt, lte, gt, gte Sortable: false |
| dimensionNumber | integer <int32> [ 1 .. 3 ] The unique number of the dimension that the dimension value belongs to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| key | integer <int32> The unique number of the dimension value. Since distributions and values are both dimension keys, there can't be a value with the same key as a distribution. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| name | string or null [ 0 .. 255 ] characters The name of the dimension value. It should reflect the possible values corresponding to a certain dimension. E.g. if you have a dimension called Product, a value name could be the name of a product you are selling or if you have a dimension called Location, a value name could be a city where you have a store. Filterable: eq, ne, lt, lte, gt, gte, like Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
{ }{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "errors": [
- {
- "property": "string",
- "message": "string",
- "errorCode": "string"
}
], - "traceId": "string",
- "errorCode": "string",
- "traceTimeUtc": "string"
}Use this endpoint to load a page of DimensionValues.
| filter | string Use this parameter to set the filtering for fields. Filtering instructions |
| pageSize | integer <int32> [ 1 .. 100 ] Default: 20 Use this parameter to set the page size. Pagination instructions |
| skipPages | integer <int32> [ 0 .. 100 ] Default: 0 Use this parameter to set number of pages to skip. Pagination instructions |
| sort | string Use this parameter to set the sort fields and direction. Sort instructions |
| active | boolean The flag that indicates dimension value is activated or disabled. Filterable: eq, ne, lt, lte, gt, gte Sortable: false |
| dimensionNumber | integer <int32> [ 1 .. 3 ] The unique number of the dimension that the dimension value belongs to. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| key | integer <int32> The unique number of the dimension value. Since distributions and values are both dimension keys, there can't be a value with the same key as a distribution. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| name | string or null [ 0 .. 255 ] characters The name of the dimension value. It should reflect the possible values corresponding to a certain dimension. E.g. if you have a dimension called Product, a value name could be the name of a product you are selling or if you have a dimension called Location, a value name could be a city where you have a store. Filterable: eq, ne, lt, lte, gt, gte, like Sortable: false |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
[- {
- "dimensionNumber": 1,
- "key": 0,
- "name": "string",
- "active": true,
- "objectVersion": "string"
}
]Call this endpoint to get the number of DimensionValues. You can use filtering as well.
| filter | string Use this parameter to set the filtering for fields. Filtering instructions |
0Dimensions endpoints help organize and eventually track your company's expenses and income in Reports by various parameters such as regions, products, projects, customers, suppliers etc.
They require the Dimension module to be installed. By default, only one dimension per agreement is allowed. Agreements with advanced subscription plan can have up to 3.
A full flow for dimensions API's would be: you create a dimension, e.g. Customers, then you create values that match the dimension, e.g. a value designating each of your customers. On every sales document/ journal entry you select the dimension value that matches the customer on the sales document. You create a report to see which customers brought you the highest revenue.
Related guide for users: e-copedia (Danish).
| Error Code | Description |
|---|---|
| DimensionAlreadyExists | Dimension with this number already exists. |
| DimensionDoesNotExist | Dimension with this number does not exist. |
| DimensionInUse | Dimension is in use with one or more entries/configurations. |
| DimensionInUseMultiple | Dimension is in use with multiple entries/configurations. |
| Dimension1CannotBeDeleted | The first dimension can't be deleted. |
| DimensionAllowedUpTo3 | You are allowed to work with up to 3 dimensions. |
| DimensionIncorrectPackageLevel | You need to upgrade your package level to Advanced to work with multiple dimensions. |
| DimensionIncorrectModule | You need to activate Department module to work with first dimension. |
Required application roles: SuperUser or Bookkeeping or Sales or ProjectEmployee More info
Use this endpoint to retrieve single dimension defined for a customer.
| number required | integer <int32> |
| active required | boolean Flag indicating whether the dimension is active or disabled. Filterable: eq, ne, lt, lte, gt, gte Sortable: false |
| name required | string [ 0 .. 255 ] characters The name of the dimension. It should suggest the category you want your items to be associated with, e.g. Region, Supplier, ProductType, Project etc. Filterable: eq, ne, lt, lte, gt, gte, like Sortable: false |
| number | integer <int32> [ 1 .. 3 ] The unique number of the dimension. By default, only one dimension per agreement is allowed. Agreements with advanced subscription plan can have up to 3. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
{- "number": 1,
- "name": "string",
- "active": true,
- "objectVersion": "string"
}Use this endpoint to delete a single Dimension by number. Please note that the first dimension can never be deleted.
| number required | integer <int32> |
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "errors": [
- {
- "property": "string",
- "message": "string",
- "errorCode": "string"
}
], - "traceId": "string",
- "errorCode": "string",
- "traceTimeUtc": "string"
}Use this endpoint to retrieve all the dimensions defined for a customer.
| cursor | string [ 0 .. 50 ] characters Use this parameter to set the continuation cursor for paging. Pagination instructions |
| filter | string Use this parameter to set the filtering for fields. filtering instructions |
| cursor | string or null Use this continuation cursor in a request back to continue the list. In case there are no more items to retrieve, the cursor is not returned at all. Read-only: true Filterable: not filterable Sortable: false |
Array of objects or null (Dimension) Max number of items returned is 1000. Filterable: not filterable Sortable: false |
{- "cursor": "234",
- "items": [
- {
- "id": "13",
- "name": "Patrick"
}, - {
- "id": "16",
- "name": "John"
}
]
}Use this endpoint to create a single Dimension.
| active required | boolean Flag indicating whether the dimension is active or disabled. Filterable: eq, ne, lt, lte, gt, gte Sortable: false |
| name required | string [ 0 .. 255 ] characters The name of the dimension. It should suggest the category you want your items to be associated with, e.g. Region, Supplier, ProductType, Project etc. Filterable: eq, ne, lt, lte, gt, gte, like Sortable: false |
| number | integer <int32> [ 1 .. 3 ] The unique number of the dimension. By default, only one dimension per agreement is allowed. Agreements with advanced subscription plan can have up to 3. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
| number | integer <int32> Filterable: not filterable Sortable: false |
{- "name": "string",
- "active": true
}{- "number": 0
}Use this endpoint to update a single Dimension by number. Please note that barring a dimension also clears out account dimension required flags as well.
| active required | boolean Flag indicating whether the dimension is active or disabled. Filterable: eq, ne, lt, lte, gt, gte Sortable: false |
| name required | string [ 0 .. 255 ] characters The name of the dimension. It should suggest the category you want your items to be associated with, e.g. Region, Supplier, ProductType, Project etc. Filterable: eq, ne, lt, lte, gt, gte, like Sortable: false |
| number | integer <int32> [ 1 .. 3 ] The unique number of the dimension. By default, only one dimension per agreement is allowed. Agreements with advanced subscription plan can have up to 3. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
{- "name": "string",
- "active": true
}{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "errors": [
- {
- "property": "string",
- "message": "string",
- "errorCode": "string"
}
], - "traceId": "string",
- "errorCode": "string",
- "traceTimeUtc": "string"
}Use this endpoint to load a page of Dimensions.
| filter | string Use this parameter to set the filtering for fields. Filtering instructions |
| pageSize | integer <int32> [ 1 .. 100 ] Default: 20 Use this parameter to set the page size. Pagination instructions |
| skipPages | integer <int32> [ 0 .. 100 ] Default: 0 Use this parameter to set number of pages to skip. Pagination instructions |
| sort | string Use this parameter to set the sort fields and direction. Sort instructions |
| active required | boolean Flag indicating whether the dimension is active or disabled. Filterable: eq, ne, lt, lte, gt, gte Sortable: false |
| name required | string [ 0 .. 255 ] characters The name of the dimension. It should suggest the category you want your items to be associated with, e.g. Region, Supplier, ProductType, Project etc. Filterable: eq, ne, lt, lte, gt, gte, like Sortable: false |
| number | integer <int32> [ 1 .. 3 ] The unique number of the dimension. By default, only one dimension per agreement is allowed. Agreements with advanced subscription plan can have up to 3. Filterable: eq, ne, lt, lte, gt, gte, in, nin Sortable: true |
| objectVersion | string or null The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request. Filterable: not filterable Sortable: false |
[- {
- "number": 1,
- "name": "string",
- "active": true,
- "objectVersion": "string"
}
]Call this endpoint to get the number of Dimensions. You can use filtering as well.
| filter | string Use this parameter to set the filtering for fields. Filtering instructions |
0