API docs by Redocly

Visma e-conomic OpenAPI Journals (11.0.2)

Download OpenAPI specification:Download

E-mail: api@e-conomic.com URL: https://www.e-conomic.com/

Changelog

Click to see changelog.
Version Description Date
11.0.2 draft-entries Fixed an issue with SupplierPaymentType validation December, 2024
11.0.1 draft-entries Fixed an issue where editing an entry with SupplierPaymentType -1 (None) was not possible. Updated documentation to show available options for SupplierPaymentType November, 2024
11.0.0 1. draft-entries Fixed an issue where projectId was not persisted when part of a draft entry with entryTypeNumber 5.
2. draft-entries Fixed issue with wrongly validating supplierPayment properties.
3. Deprecating isCredit property for DraftEntry model, so this prperty is no longer availabe for CRUD operations		 November, 2024
10.0.0 draft-entries Added Payment details properties to Supplier invoices, for GET, PUT and POST October, 2024
9.0.0 Dimensions deprecated. Please use Dimensions API instead. October, 2024
8.0.0 Updated PUT endpoint for journals to no longer use journalNumber in path. draft-entries Exchange rate can now be left out (or null) when creating and updating draft entries. A default exchange rate will be set based on entry date and currency October, 2024
7.0.0 draft-entries Filtering by AccountNumber has been fixed. Additionally EntryNumber, JournalNumber, AccountNumber, StartDate, EndDate are now required October, 2024
6.0.0 draft-entries Added correct error code for trying to change journal number through an update. Updated PUT endpoint for draft-entries to no longer use draftEntryNumber in path. Added list of possible error codes for journals July, 2024
5.2.0 draft-entries endpoints added for managing accruals on draft entries July, 2024
5.1.1 draft-entries Added extra error handling July, 2024
5.1.0 Added /delete/[journalNumber] endpoint on draft-entries to delete all draft entries within a journal July, 2024
5.0.0 1. The Name property is now required on journals.
2. JournalNumber and VoucherNumber is now required on draft-entries.
3. Sorting disabled on draft-entries for the following properties: Date, AccountNumber, VatCode, Amount, Currency, ContraAccountNumber, ContraVatCode, Text, ProjectNumber, CostTypeNumber, SupplierNumber.
4. Filtering disabled on draft-entries for the following properties: VatCode, Amount, ContraVatCode, Text CostTypeNumber.
5. Sorting disabled on journals for the following properties: BalancingBehavior, AutoApprove, Type, IsStandingJournal, RequireAdminApproval, LockVatCodes, NextVoucherNumber, MinimumVoucherNumber, MaximumVoucherNumber, CustomerContraAccount, SupplierContraAccount, CustomerPaymentText, SupplierPaymentText, Name, Priority, AllowPartialBooking, RequireBalancePerVoucherId, RepeatText, PaymentMessageText, DefaultDepartment.
6. Filtering disabled on journals for the following properties: AutoApprove, RequireAdminApproval, LockVatCodes, NextVoucherNumber, MinimumVoucherNumber MaximumVoucherNumber, SupplierContraAccount, CustomerContraAccount, CustomerPaumentText, SupplierPaymentText, Name, Priority, AllowPartialBooking, RequireBalancePerVoucherId, RepeatText, PaymentMessageText, DefaultDepartment.		 July, 2024
4.0.0 Added the ObjectVersion property to draft-entries and draft-entries/dimensions. OperationId updated for POST, Bulk POST, PUT and Bulk PUT in draft-entries. OperationId updated for PUT, GET Count in draft-entries/dimensions. OperationId updated for POST, PUT, DELETE, GET All Cursor, GET All Paged in journals June, 2024
3.2.0 draft-entries /count endpoint added 07/05/2024
3.1.1 Description updated. 07/05/2024
3.1.0 journals Added GET, POST, PUT and DELETE endpoints for managing journals 01/05/2024
3.0.0 entries/booked Moved to /booked-entries/.\ Booking of journals has moved to journals/[id]/book.\ draft-entries endpoint added 01/04/2024
2.0.0 entries/booked CustomerNumber added. 13/02/2024
1.1.2 Description updated. 06/02/2024
1.1.1 Fixed response type in documentation for entries/draft/book and entries/draft/bookwithdateinterval endpoints. 05/02/2024
1.1.0 entries/draft/book and entries/draft/bookwithdateinterval endpoints added. 31/01/2024
1.0.0 entries/booked endpoints added. 02/10/2023

TL;DR

Create tokens as instructed here and then 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.

Examples

jQuery

$.ajax({
    url: "https://apis.e-conomic.com/journalsapi/v11.0.2/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

curl -H "X-AppSecretToken: demo" -H "X-AgreementGrantToken: demo" https://apis.e-conomic.com/journalsapi/v11.0.2/the_resource

Introduction

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.

Usage

Versioning

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.

Demo authentication

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.

Retrieving data

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

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.

Filterable properties

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.

Specifying Operator affinity

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 Encoding

URL parameter values should always be URL compatible. Always URL encode filter strings.

Filter Operators

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:

Substring matching

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.

Escaping special characters in your filter

To not interfere with the parsing of the filter expression, certain escape sequences are necessary.

  • “$” is escaped with “$$”
  • “(” is escaped with “$(”
  • “)” is escaped with “$)”
  • “*” is escaped with “$*”
  • “,” is escaped with “$,”
  • “[” is escaped with “$[”
  • “]” is escaped with “$]”

Using null values in your filter

Should you want to filter for the nonexistence of a property (i.e. null value) you can use the null escape sequence.

$null:

Using in and not in operators

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

Sorting on strings is case insensitive.

Sort ascending

Sorting on collections can be done using the query string parameter ‘sort’.

?sort=name

Sort descending

The default sort direction is ascending, but this can be turned by prepending a minus (-).

?sort=-name

Sort by multiple properties

If you need to sort by multiple properties these can just be separated by commas. Mixing of directions is allowed.

?sort=-name,age

Sort alphabetically

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

Sortable properties

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.

Pagination

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)

    • This is the recommended approach, and the one you should use by default.
    • The endpoint naming scheme is "Retrieve all Items". (Usage: /{ITEM}?cursor={CURSOR_VALUE})
    • The maximum number of items returned in a single call is defined in the 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)

    • You should only consider using classic pagination, if you rely on loading pages (i.e. for list views or table/grid-based UI's).
    • The endpoint naming scheme is "Retrieve a page of Items". (Usage: /{ITEM}/paged?skippages=0&pagesize=20)
      * It's important to note that there is a limit of 10.000 items using this approach. Any items outside of the first 10.000 items will not be loaded.

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.

Which approach should you use?

We highly recommend that you use cursor-based pagination because:

  • It is more performant and offers much faster retrieval of items;
  • It can be used for very large collections of many thousands or millions of items, whereas classic pagination is limited to only returning 10.000 results, everything else is ignored;
    Classic pagination is only appropriate when you have an app with a table/grid-based UI.

Cursor-based pagination

How it works

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 don't need to send a second request).

The first set of items usually consists of 1000 results. If the cursor is not present in the response, it means that there are no more items in the results.

Please note that the cursor represents the identifier 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.

Real world example

I want to retrieve all subscriptions.

  1. 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

  2. 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

  3. 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.

Classic pagination

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.

Real world example

I want to show a grid with page size of 50 and pagination navigation buttons.

  1. 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.

  2. 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.

  3. 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.

Number of items in a collection

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

HTTP Status Codes

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.

Required and Readonly Properties

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).

Resource encoding

All non-alphanumeric characters in resource URLs are standard URL encoded. Please refer to standard URL encoding.

Implementation specifics

Helpful details to know when implementing e-conomic REST.

Booleans

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.

Nulling

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.

Object version

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

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 of resources

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/journalsapi/v11.0.2/the_resource?filter$eq:lastUpdated$gt:2024-02-24 This will return all resources which have been updated since 24.02.2024.

Custom extensions in OpenAPI specification

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-.

  1. x-required-roles: The list of roles that are required for each group of endpoints.
  2. x-error-codes: The list of error codes that are potentially returned from each group of endpoints.
  3. x-cursor-page-size: The maximum number of items in CursorResults that can be returned in a single call.

Authentication

X-AppSecretToken

Application secret token needed to access the endpoints.

Security Scheme Type: API Key
Header parameter name: X-AppSecretToken

X-AgreementGrantToken

Agreement grant token needed to access the endpoints.

Security Scheme Type: API Key
Header parameter name: X-AgreementGrantToken

DraftEntries

draft-entries endpoints allow draft entries to created, fetched, updated and deleted.

Examples of use cases:

  • Create new draft entry
  • Update existing draft entry
  • Get all draft entries
  • Get single draft entry
  • Create up to 500 draft entries in bulk
  • Update up to 500 draft entries in bulk
  • Delete all draft entries within a journal

Required application roles: SuperUser or Bookkeeping More info

Get all draft entries

Use this endpoint to fetch all draft

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
query Parameters
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

Responses

Response Schema: application/json
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

Response samples

Content type
application/json
{
  • "cursor": "234",
  • "items": [
    ]
}

Create new draft entry

Use this endpoint to create a single new draft entry

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
Request Body schema: application/json
amount
required
number <double>

The amount of the entry

Filterable: not filterable

Sortable: false

currency
required
string non-empty

The currency of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

date
required
string <date-time>

The date of the entry.

Filterable: eq, ne, lt, lte, gt, gte

Sortable: false

entryTypeNumber
required
integer <int32> 2|3|4|5|10

The entry type.
It has 5 types:

  • 2: Customer Payment
  • 3: Supplier Invoice
  • 4: Supplier Payment
  • 5: Finance Voucher
  • 10: Manual Customer Invoice

    Filterable: eq, ne, lt, lte, gt, gte, in, nin

    Sortable: true

journalNumber
required
integer <int32>

The number of the journal that this entry belongs to.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

voucherNumber
required
integer <int32>

The voucher number of the entry.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

accountNumber
integer or null <int32>

The account number of the entry.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

contraAccountNumber
integer or null <int32>

The contra account number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

contraVatCode
string or null

The contra VAT code of the entry

Filterable: not filterable

Sortable: false

costTypeNumber
integer or null <int32>

The cost type number of the entry

Filterable: not filterable

Sortable: false

customerInvoiceNumber
string or null

The customer invoice number of the entry

Filterable: not filterable

Sortable: false

customerNumber
integer or null <int32>

The customer number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

dueDate
string or null <date-time>

The due date of the entry

Filterable: not filterable

Sortable: false

exchangeRate
number or null <double>

The exchange rate of the entry

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

projectNumber
integer or null <int32>

The project number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

supplierInvoiceNumber
string or null

The supplier invoice number

Filterable: not filterable

Sortable: false

supplierNumber
integer or null <int32>

The supplier number

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

supplierPaymentBank
string or null

The supplier payment bank details

Filterable: not filterable

Sortable: false

supplierPaymentMessage
string or null

The supplier payment message

Filterable: not filterable

Sortable: false

supplierPaymentType
integer or null <int32> ^(-1|1|2|5|7|10|14|17)$

description: "The supplier payment type. It has 8 types:

  • -1: None
  • 1: Plus71
  • 2: Plus73
  • 5: Plus04
  • 7: BankTransfer
  • 10: Iban
  • 14: EntryOnly
  • 17: Plus75

    Filterable: not filterable

    Sortable: false

text
string or null

Text description of the entry

Filterable: not filterable

Sortable: false

vatCode
string or null

The VAT code of the entry.

Filterable: not filterable

Sortable: false

Responses

Response Schema: application/json
entryNumber
integer or null <int32>

The unique number of the entry.

Read-only: true

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

Request samples

Content type
application/json
{
  • "entryTypeNumber": 0,
  • "voucherNumber": 0,
  • "journalNumber": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "amount": 0,
  • "currency": "string"
}

Response samples

Content type
application/json
{
  • "entryNumber": 0
}

Update existing draft entry

Use this endpoint to update a single draft entry

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
Request Body schema: application/json
amount
required
number <double>

The amount of the entry

Filterable: not filterable

Sortable: false

currency
required
string non-empty

The currency of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

date
required
string <date-time>

The date of the entry.

Filterable: eq, ne, lt, lte, gt, gte

Sortable: false

entryTypeNumber
required
integer <int32> 2|3|4|5|10

The entry type.
It has 5 types:

  • 2: Customer Payment
  • 3: Supplier Invoice
  • 4: Supplier Payment
  • 5: Finance Voucher
  • 10: Manual Customer Invoice

    Filterable: eq, ne, lt, lte, gt, gte, in, nin

    Sortable: true

journalNumber
required
integer <int32>

The number of the journal that this entry belongs to.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

voucherNumber
required
integer <int32>

The voucher number of the entry.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

accountNumber
integer or null <int32>

The account number of the entry.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

contraAccountNumber
integer or null <int32>

The contra account number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

contraVatCode
string or null

The contra VAT code of the entry

Filterable: not filterable

Sortable: false

costTypeNumber
integer or null <int32>

The cost type number of the entry

Filterable: not filterable

Sortable: false

customerInvoiceNumber
string or null

The customer invoice number of the entry

Filterable: not filterable

Sortable: false

customerNumber
integer or null <int32>

The customer number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

dueDate
string or null <date-time>

The due date of the entry

Filterable: not filterable

Sortable: false

exchangeRate
number or null <double>

The exchange rate of the entry

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

projectNumber
integer or null <int32>

The project number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

supplierInvoiceNumber
string or null

The supplier invoice number

Filterable: not filterable

Sortable: false

supplierNumber
integer or null <int32>

The supplier number

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

supplierPaymentBank
string or null

The supplier payment bank details

Filterable: not filterable

Sortable: false

supplierPaymentMessage
string or null

The supplier payment message

Filterable: not filterable

Sortable: false

supplierPaymentType
integer or null <int32> ^(-1|1|2|5|7|10|14|17)$

description: "The supplier payment type. It has 8 types:

  • -1: None
  • 1: Plus71
  • 2: Plus73
  • 5: Plus04
  • 7: BankTransfer
  • 10: Iban
  • 14: EntryOnly
  • 17: Plus75

    Filterable: not filterable

    Sortable: false

text
string or null

Text description of the entry

Filterable: not filterable

Sortable: false

vatCode
string or null

The VAT code of the entry.

Filterable: not filterable

Sortable: false

Responses

Request samples

Content type
application/json
{
  • "entryTypeNumber": 0,
  • "voucherNumber": 0,
  • "journalNumber": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "amount": 0,
  • "currency": "string"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": [
    ],
  • "traceId": "string",
  • "errorCode": "string",
  • "traceTimeUtc": "string"
}

Get all draft entries paged

Use this endpoint to fetch all draft paged

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
query Parameters
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

Responses

Response Schema: application/json
Array
amount
required
number <double>

The amount of the entry

Filterable: not filterable

Sortable: false

currency
required
string non-empty

The currency of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

date
required
string <date-time>

The date of the entry.

Filterable: eq, ne, lt, lte, gt, gte

Sortable: false

entryTypeNumber
required
integer <int32> 2|3|4|5|10

The entry type.
It has 5 types:

  • 2: Customer Payment
  • 3: Supplier Invoice
  • 4: Supplier Payment
  • 5: Finance Voucher
  • 10: Manual Customer Invoice

    Filterable: eq, ne, lt, lte, gt, gte, in, nin

    Sortable: true

journalNumber
required
integer <int32>

The number of the journal that this entry belongs to.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

voucherNumber
required
integer <int32>

The voucher number of the entry.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

accountNumber
integer or null <int32>

The account number of the entry.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

contraAccountNumber
integer or null <int32>

The contra account number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

contraVatCode
string or null

The contra VAT code of the entry

Filterable: not filterable

Sortable: false

costTypeNumber
integer or null <int32>

The cost type number of the entry

Filterable: not filterable

Sortable: false

customerInvoiceNumber
string or null

The customer invoice number of the entry

Filterable: not filterable

Sortable: false

customerNumber
integer or null <int32>

The customer number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

dueDate
string or null <date-time>

The due date of the entry

Filterable: not filterable

Sortable: false

entryNumber
integer or null <int32>

The unique number of the entry.

Read-only: true

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

exchangeRate
number or null <double>

The exchange rate of the entry

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

projectNumber
integer or null <int32>

The project number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

supplierInvoiceNumber
string or null

The supplier invoice number

Filterable: not filterable

Sortable: false

supplierNumber
integer or null <int32>

The supplier number

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

supplierPaymentBank
string or null

The supplier payment bank details

Filterable: not filterable

Sortable: false

supplierPaymentMessage
string or null

The supplier payment message

Filterable: not filterable

Sortable: false

supplierPaymentType
integer or null <int32> ^(-1|1|2|5|7|10|14|17)$

description: "The supplier payment type. It has 8 types:

  • -1: None
  • 1: Plus71
  • 2: Plus73
  • 5: Plus04
  • 7: BankTransfer
  • 10: Iban
  • 14: EntryOnly
  • 17: Plus75

    Filterable: not filterable

    Sortable: false

text
string or null

Text description of the entry

Filterable: not filterable

Sortable: false

vatCode
string or null

The VAT code of the entry.

Filterable: not filterable

Sortable: false

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve the number of DraftEntries

Call this endpoint to get the number of DraftEntries. You can use filtering as well.

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
query Parameters
filter
string

Use this parameter to set the filtering for fields. Filtering instructions

Responses

Response Schema: application/json
integer <int32>

Response samples

Content type
application/json
0
0

Get a single draft entry

Use this endpoint to fetch a single draft entry

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
path Parameters
entryNumber
required
integer <int32>

Responses

Response Schema: application/json
amount
required
number <double>

The amount of the entry

Filterable: not filterable

Sortable: false

currency
required
string non-empty

The currency of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

date
required
string <date-time>

The date of the entry.

Filterable: eq, ne, lt, lte, gt, gte

Sortable: false

entryTypeNumber
required
integer <int32> 2|3|4|5|10

The entry type.
It has 5 types:

  • 2: Customer Payment
  • 3: Supplier Invoice
  • 4: Supplier Payment
  • 5: Finance Voucher
  • 10: Manual Customer Invoice

    Filterable: eq, ne, lt, lte, gt, gte, in, nin

    Sortable: true

journalNumber
required
integer <int32>

The number of the journal that this entry belongs to.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

voucherNumber
required
integer <int32>

The voucher number of the entry.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

accountNumber
integer or null <int32>

The account number of the entry.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

contraAccountNumber
integer or null <int32>

The contra account number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

contraVatCode
string or null

The contra VAT code of the entry

Filterable: not filterable

Sortable: false

costTypeNumber
integer or null <int32>

The cost type number of the entry

Filterable: not filterable

Sortable: false

customerInvoiceNumber
string or null

The customer invoice number of the entry

Filterable: not filterable

Sortable: false

customerNumber
integer or null <int32>

The customer number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

dueDate
string or null <date-time>

The due date of the entry

Filterable: not filterable

Sortable: false

entryNumber
integer or null <int32>

The unique number of the entry.

Read-only: true

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

exchangeRate
number or null <double>

The exchange rate of the entry

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

projectNumber
integer or null <int32>

The project number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

supplierInvoiceNumber
string or null

The supplier invoice number

Filterable: not filterable

Sortable: false

supplierNumber
integer or null <int32>

The supplier number

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

supplierPaymentBank
string or null

The supplier payment bank details

Filterable: not filterable

Sortable: false

supplierPaymentMessage
string or null

The supplier payment message

Filterable: not filterable

Sortable: false

supplierPaymentType
integer or null <int32> ^(-1|1|2|5|7|10|14|17)$

description: "The supplier payment type. It has 8 types:

  • -1: None
  • 1: Plus71
  • 2: Plus73
  • 5: Plus04
  • 7: BankTransfer
  • 10: Iban
  • 14: EntryOnly
  • 17: Plus75

    Filterable: not filterable

    Sortable: false

text
string or null

Text description of the entry

Filterable: not filterable

Sortable: false

vatCode
string or null

The VAT code of the entry.

Filterable: not filterable

Sortable: false

Response samples

Content type
application/json
{
  • "entryNumber": 0,
  • "entryTypeNumber": 0,
  • "voucherNumber": 0,
  • "journalNumber": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "accountNumber": 0,
  • "vatCode": "string",
  • "amount": 0,
  • "currency": "string",
  • "exchangeRate": 0,
  • "contraAccountNumber": 0,
  • "contraVatCode": "string",
  • "text": "string",
  • "projectNumber": 0,
  • "costTypeNumber": 0,
  • "customerNumber": 0,
  • "customerInvoiceNumber": "string",
  • "supplierNumber": 0,
  • "supplierInvoiceNumber": "string",
  • "supplierPaymentType": 0,
  • "supplierPaymentBank": "string",
  • "supplierPaymentMessage": "string",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "objectVersion": "string"
}

Delete existing draft entry

Use this endpoint to delete a single draft entry

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
path Parameters
entryNumber
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": [
    ],
  • "traceId": "string",
  • "errorCode": "string",
  • "traceTimeUtc": "string"
}

Create multiple new draft entries

Use this endpoint to create up to 500 new draft entries

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
Request Body schema: application/json
Array of objects or null (DraftEntry)

List of entries

Filterable: not filterable

Sortable: false

Responses

Response Schema: application/json
entryNumber
integer or null <int32>

The unique number of the entry.

Read-only: true

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "entryNumber": 0
}

Update multiple draft entries

Use this endpoint to update up to 500 draft entries

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
Request Body schema: application/json
Array of objects or null (DraftEntry)

List of entries

Filterable: not filterable

Sortable: false

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": [
    ],
  • "traceId": "string",
  • "errorCode": "string",
  • "traceTimeUtc": "string"
}

Delete all draft entries within a journal

Use this endpoint to delete all draft entries within the specified journal

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
path Parameters
journalNumber
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": [
    ],
  • "traceId": "string",
  • "errorCode": "string",
  • "traceTimeUtc": "string"
}

DraftEntryAccruals

draft-entries endpoints allow draft entries to created, fetched, updated and deleted.

Examples of use cases:

  • Create new draft entry
  • Update existing draft entry
  • Get all draft entries
  • Get single draft entry
  • Create up to 500 draft entries in bulk
  • Update up to 500 draft entries in bulk
  • Delete all draft entries within a journal
Click to see the list of possible error codes.
Error Code Description
JournalVoucherNull Journal voucher is null
JournalVoucherAccountingYearDoesNotExist The accounting year for the journal voucher does not exist
JournalVoucherAccountingYearClosed The accounting year for the journal voucher is closed
JournalVoucherDataIntegrityError Journal voucher data integrity error occurred
JournalVoucherEntityAlreadyExistsError Journal voucher already exists
JournalVoucherEntriesEmptyOrNull Journal voucher entries are empty or null
JournalVoucherNullEntry Journal voucher contains a null entry
JournalVoucherNextNumberNotWithinBoundaries The next journal voucher number is not within the allowed boundaries
JournalEntryDateAccountingYearDoesNotExist The entry date's accounting year does not exist
JournalEntryDateAccountingYearClosed The entry date's accounting year is closed
JournalEntryDateAccountingYearPeriodBarred The entry date is within a period that is barred
JournalEntryDueDateNotSet Due date for the journal entry is not set
JournalEntryDueDateNotInRange The due date for the journal entry is not within the allowed range
JournalEntryNotWithinEnclosingVoucherAccountingYear The journal entry is not within the enclosing voucher's accounting year
JournalEntryVoucherNumberNotWithinBoundaries The voucher number for the journal entry is not within the allowed boundaries
JournalEntryAccountNotFound The account for the journal entry could not be found
JournalEntryAccountNotAccessible The account for the journal entry is not accessible
JournalEntryWrongAccountType The account type for the journal entry is incorrect
JournalEntryAccountIsBlockedForDirectEntries The account is blocked for direct entries
JournalEntryContraAccountIsBlockedForDirectEntries The contra account is blocked for direct entries
JournalEntryContraAccountAndDistributionCannotBeUsedSimultaneously The contra account and distributions cannot be used together
JournalEntryWrongContraAccountType The contra account type is incorrect
JournalEntryExchangeRateError Exchange rate error occurred in the journal entry
JournalEntryExchangeRateMustBeOneHundredForBaseCurrency Exchange rate must be 100 for base currency
JournalEntryExchangeRateScalePrecisionError Exchange rate precision exceeds the allowed scale in the journal entry
JournalEntryContraAccountNotFound The contra account for the journal entry could not be found
JournalEntryContraAccountNotAccessible The contra account for the journal entry is not accessible
JournalEntryAccountAndContraAccountNotSet Neither the account nor the contra account is set for the journal entry
JournalEntryCurrencyNotFound The currency for the journal entry could not be found
JournalEntryCurrencyNotSet The currency for the journal entry is not set
JournalEntrySupplierNotFound The supplier for the journal entry could not be found
JournalEntrySupplierNotAccessible The supplier for the journal entry is not accessible
JournalEntrySupplierNotSet The supplier for the journal entry is not set
JournalEntrySupplierAndAccountNotSet Neither the supplier nor the account is set for the journal entry
JournalEntryDistributionDimensionAccessNotAccessible Access to the distribution dimension for the journal entry is not allowed
JournalEntryMultipleDimensionAccessNotAccessible Access to multiple dimensions for the journal entry is not allowed
JournalEntryMultipleDimensionRequired Multiple dimensions are required for the journal entry
JournalEntryDepartmentalDistributionNotFound The departmental distribution for the journal entry could not be found
JournalEntryDepartmentalDistributionNotAccessible The departmental distribution for the journal entry is not accessible
JournalEntryEmployeeNotFound The employee for the journal entry could not be found
JournalEntryEmployeeNotAccessible The employee for the journal entry is not accessible
JournalEntryEitherAmountsNotSet Neither the amounts for the journal entry are set
JournalEntryAmountExceedsDigitLimit The amount cannot be more than 18 digits
JournalEntryTypeNotCorrect The journal entry type is incorrect
JournalEntryCustomerAndAccountNotSet Neither the customer nor the account is set for the journal entry
JournalEntryCustomerNotFound The customer for the journal entry could not be found
JournalEntryCustomerNotAccessible The customer for the journal entry is not accessible
JournalEntryPaymentDetailsRequiredFieldsWrong Required payment details for the journal entry are incorrect
JournalEntryDimensionUnit1NotFound The first dimension unit for the journal entry could not be found
JournalEntryDimensionUnit2NotFound The second dimension unit for the journal entry could not be found
JournalEntryDimensionOrUnit1NotAccessible The first dimension or unit for the journal entry is not accessible
JournalEntryDimensionOrUnit2NotAccessible The second dimension or unit for the journal entry is not accessible
JournalEntryDimensionQuantity1SetWithoutAccess Dimension quantity 1 is set without access for the journal entry
JournalEntryDimensionQuantity2SetWithoutAccess Dimension quantity 2 is set without access for the journal entry
JournalEntryProjectIdSetWithoutModuleAccess Project ID is set without module access in the journal entry
JournalEntryCostTypeSetWithoutModuleAccess Cost type is set without module access in the journal entry
JournalEntryProjectNotFound The project for the journal entry could not be found
JournalEntryProjectNotAccessible The project for the journal entry is not accessible
JournalEntryCostTypeNotFound The cost type for the journal entry could not be found
JournalEntryCostTypeNotAccessible The cost type for the journal entry is not accessible
JournalEntryProjectCostTypeSetMismatch Mismatch between the project and cost type in the journal entry
JournalEntryProjectSetIsClosed The project set for the journal entry is closed
JournalEntryProjectSetIsMainProject The project set for the journal entry is a main project
JournalEntryPaymentDetailsPaymentIdWrongLength The payment ID length is incorrect for the journal entry
JournalEntryPaymentDetailsPaymentIdTooShort The payment ID for the journal entry is too short
JournalEntryPaymentDetailsPaymentIdTooLong The payment ID for the journal entry is too long
JournalEntryPaymentDetailsPaymentIdDoesNotMatchStringPattern The payment ID does not match the required pattern for the journal entry
JournalEntryPaymentDetailsPaymentIdMustBeNumeric The payment ID for the journal entry must be numeric
JournalEntryAccrualEndBeforeStart Accrual end date is before the start date in the journal entry
JournalEntryAccrualAccountNotFound The accrual account for the journal entry could not be found
JournalEntryAssetGroupNotFound The asset group for the journal entry could not be found
JournalEntryAssetNumberMustBePositive The asset number for the journal entry must be positive
JournalEntryAssetStartNotInAccountingYear The asset start date for the journal entry is not within the accounting year
JournalEntryAssetLifeTimeMustBePositive The asset lifetime for the journal entry must be positive
JournalEntryAssetWrongEntryType The entry type for the asset in the journal entry is incorrect
JournalEntryAccrualWrongEntryType The entry type for the accrual in the journal entry is incorrect
JournalEntryAssetAccrualError An error occurred with the asset accrual in the journal entry
JournalEntryPaymentDetailsCreditorIdDoesNotMatchStringPattern The creditor ID for the journal entry does not match the required pattern
JournalEntryTextTooLong The text for the journal entry is too long
JournalEntrySupplierInvoiceTooBig The supplier invoice for the journal entry is too large
JournalEntryUnitAndQuantityNotSet Neither unit nor quantity is set for the journal entry
Customer_Invoice_Is_Not_Numeric The customer invoice is not numeric for the journal entry
Customer_invoice_too_big The customer invoice for the journal entry is too large
JournalEntryDoesNotExist Journal entry does not exist
OneAPIEntriesListCannotBeEmpty Entries list cannot be empty
OneAPITooManyEntries Entries list cannot contain more than 500 entries
OneAPIDraftEntryAccrualAlreadyExist Acruals already exists on draft entry
OneAPIDraftEntryAccrualRequiredAccountNumber Account number is required
JournalNumberCannotBeChangedOnDraftEntry JournalNumber cannot be changed on draft entry

Required application roles: SuperUser or Bookkeeping More info

Get a single accrual by journal and draft entry number

Use this endpoint to fetch a single accrual by its journal number and draft entry number

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
path Parameters
entryNumber
required
integer <int32>
journalNumber
required
integer <int32>

Responses

Response Schema: application/json
accountNumber
required
integer <int32>

The account number associated with the accrual

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

endDate
required
string <date-time>

The end date for the accrual

Filterable: not filterable

Sortable: false

entryNumber
required
integer <int32>

The unique entry number that relates to this accrual.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

journalNumber
required
integer <int32>

The journal number where the related entry belongs

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

startDate
required
string <date-time>

The start date for the accrual

Filterable: not filterable

Sortable: false

months
integer or null <int32>

The duration of the accrual in months

Read-only: true

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

Response samples

Content type
application/json
{
  • "entryNumber": 0,
  • "journalNumber": 0,
  • "accountNumber": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "months": 0,
  • "objectVersion": "string"
}

Get all draft entry accruals

Use this endpoint to fetch all draft entry accruals

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
query Parameters
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

Responses

Response Schema: application/json
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 (DraftEntryAccrual)

Max number of items returned is 1000.

Filterable: not filterable

Sortable: false

Response samples

Content type
application/json
{
  • "cursor": "234",
  • "items": [
    ]
}

Create accrual on existing draft entry

Use this endpoint to create a single draft entry accrual

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
Request Body schema: application/json
accountNumber
required
integer <int32>

The account number associated with the accrual

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

endDate
required
string <date-time>

The end date for the accrual

Filterable: not filterable

Sortable: false

entryNumber
required
integer <int32>

The unique entry number that relates to this accrual.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

journalNumber
required
integer <int32>

The journal number where the related entry belongs

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

startDate
required
string <date-time>

The start date for the accrual

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

Responses

Response Schema: application/json
entryNumber
integer <int32>

The unique entry number that relates to this accrual.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

Request samples

Content type
application/json
{
  • "entryNumber": 0,
  • "journalNumber": 0,
  • "accountNumber": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "entryNumber": 0
}

Update an existing draft entry accrual

Use this endpoint to update a single draft entry accrual

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
Request Body schema: application/json
accountNumber
required
integer <int32>

The account number associated with the accrual

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

endDate
required
string <date-time>

The end date for the accrual

Filterable: not filterable

Sortable: false

entryNumber
required
integer <int32>

The unique entry number that relates to this accrual.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

journalNumber
required
integer <int32>

The journal number where the related entry belongs

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

startDate
required
string <date-time>

The start date for the accrual

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

Responses

Request samples

Content type
application/json
{
  • "entryNumber": 0,
  • "journalNumber": 0,
  • "accountNumber": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": [
    ],
  • "traceId": "string",
  • "errorCode": "string",
  • "traceTimeUtc": "string"
}

Delete an existing draft entry accrual

Use this endpoint to delete a single draft entry accrual

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
Request Body schema: application/json
accountNumber
required
integer <int32>

The account number associated with the accrual

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

endDate
required
string <date-time>

The end date for the accrual

Filterable: not filterable

Sortable: false

entryNumber
required
integer <int32>

The unique entry number that relates to this accrual.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

journalNumber
required
integer <int32>

The journal number where the related entry belongs

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

startDate
required
string <date-time>

The start date for the accrual

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

Responses

Request samples

Content type
application/json
{
  • "entryNumber": 0,
  • "journalNumber": 0,
  • "accountNumber": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": [
    ],
  • "traceId": "string",
  • "errorCode": "string",
  • "traceTimeUtc": "string"
}

Get all draft entry accruals paged

Use this endpoint to fetch all draft entry accruals paged

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
query Parameters
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

Responses

Response Schema: application/json
Array
accountNumber
required
integer <int32>

The account number associated with the accrual

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

endDate
required
string <date-time>

The end date for the accrual

Filterable: not filterable

Sortable: false

entryNumber
required
integer <int32>

The unique entry number that relates to this accrual.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

journalNumber
required
integer <int32>

The journal number where the related entry belongs

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

startDate
required
string <date-time>

The start date for the accrual

Filterable: not filterable

Sortable: false

months
integer or null <int32>

The duration of the accrual in months

Read-only: true

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

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve the number of DraftEntryAccruals

Call this endpoint to get the number of DraftEntryAccruals. You can use filtering as well.

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
query Parameters
filter
string

Use this parameter to set the filtering for fields. Filtering instructions

Responses

Response Schema: application/json
integer <int32>

Response samples

Content type
application/json
0
0

JournalBooking

journals endpoints allow draft entries to be booked and journals to be managed

Examples of use cases:

  • Book all entries within a given interval
  • Book all entries in a journal
  • Fetch all journals in an agreement
  • Create new journals
  • Update existing journals
  • Delete existing journals

Related guide for users: e-copedia (Danish)

Required application roles: SuperUser or Bookkeeping More info

Book Entries

Use this endpoint to book all draft entries in a journal.

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
path Parameters
journalNumber
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": [
    ],
  • "traceId": "string",
  • "errorCode": "string",
  • "traceTimeUtc": "string"
}

Book Entries with date interval

Use this endpoint to book draft entries contained in a time interval from a journal.

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
path Parameters
journalNumber
required
integer <int32>
Request Body schema: application/json
fromDate
required
string <date-time>

Start date of the booking interval

Filterable: not filterable

Sortable: false

toDate
required
string <date-time>

End date of the booking interval

Filterable: not filterable

Sortable: false

Responses

Request samples

Content type
application/json
{
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": [
    ],
  • "traceId": "string",
  • "errorCode": "string",
  • "traceTimeUtc": "string"
}

Journals

journals endpoints allow draft entries to be booked and journals to be managed

Examples of use cases:

  • Book all entries within a given interval
  • Book all entries in a journal
  • Fetch all journals in an agreement
  • Create new journals
  • Update existing journals
  • Delete existing journals

Related guide for users: e-copedia (Danish)

Click to see the list of possible error codes.
Error Code Description
JournalMustBeEmptyBeforeDeleting Journal must be empty before deleting it

Required application roles: SuperUser or Bookkeeping More info

Get all journals

Use this endpoint to fetch all journals

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
query Parameters
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

Responses

Response Schema: application/json
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 (Journal)

Max number of items returned is 1000.

Filterable: not filterable

Sortable: false

Response samples

Content type
application/json
{
  • "cursor": "234",
  • "items": [
    ]
}

Create a single Journal

Use this endpoint to create a single Journal.

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
Request Body schema: application/json
allowPartialBooking
required
boolean

When booking multiple entries with both approved and unapproved entries this controls whether to allow booking of the approved entries or none at all

Filterable: not filterable

Sortable: false

autoApprove
required
boolean

Auto approve entries created by an admin

Filterable: not filterable

Sortable: false

balancingBehavior
required
boolean

If set to true the balance is summed by month. If set to false the balance is summed by date.

Filterable: eq, ne, lt, lte, gt, gte

Sortable: false

isStandingJournal
required
boolean

Controls if the entries in the journal will stay after booking

Filterable: eq, ne, lt, lte, gt, gte

Sortable: false

lockVatCodes
required
boolean

Controls if VAT codes are locked (only affects e-conomic UI)

Filterable: not filterable

Sortable: false

name
required
string non-empty

The name of the journal

Filterable: not filterable

Sortable: false

repeatText
required
boolean

Controls whether to repeat text when creating multi legged entries

Filterable: not filterable

Sortable: false

requireAdminApproval
required
boolean

Controls if the entries requires approval from an admin

Filterable: not filterable

Sortable: false

requireBalancePerVoucherId
required
boolean

When booking multiple entries with both balanced and unbalanced entries this controls whether to allow booking of the balanced entries or none at all

Filterable: not filterable

Sortable: false

type
required
integer <int32>
Enum: 1 2 3 4

Type of the journal. Available types are Classic = 1, JournalPro = 2, JournalProTemporaryBooking = 3, JournalProSynchronization = 4

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

customerContraAccount
integer or null <int32>

Defines a contra account automatically set when creating customer entries

Filterable: not filterable

Sortable: false

customerPaymentText
string or null

Defines a payment text automatically set when creating customer entries

Filterable: not filterable

Sortable: false

defaultDepartment
integer or null <int32>

Defines a default department for entries

Filterable: not filterable

Sortable: false

maximumVoucherNumber
integer or null <int32>

Defines the maximum voucher number used by journal entries

Filterable: not filterable

Sortable: false

minimumVoucherNumber
integer or null <int32>

Defines the miminum voucher number used by journal entries

Filterable: not filterable

Sortable: false

nextVoucherNumber
integer or null <int32>

Defined the next voucher number used by journal entries

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

paymentMessageText
string or null

Defines a text that is automatically applied to the message on payments

Filterable: not filterable

Sortable: false

priority
integer or null <int32>

Defines the UI order of all journals in e-conomic

Filterable: not filterable

Sortable: false

supplierContraAccount
integer or null <int32>

Defines a contra account automatically set when creating supplier entries

Filterable: not filterable

Sortable: false

supplierPaymentText
string or null

Defines a payment text automatically set when creating supplier entries

Filterable: not filterable

Sortable: false

Responses

Response Schema: application/json
number
integer <int32>

Filterable: not filterable

Sortable: false

Request samples

Content type
application/json
{
  • "balancingBehavior": true,
  • "autoApprove": true,
  • "type": 1,
  • "isStandingJournal": true,
  • "requireAdminApproval": true,
  • "lockVatCodes": true,
  • "name": "string",
  • "allowPartialBooking": true,
  • "requireBalancePerVoucherId": true,
  • "repeatText": true
}

Response samples

Content type
application/json
{
  • "number": 0
}

Update existing journal

Use this endpoint to update journal

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
Request Body schema: application/json
allowPartialBooking
required
boolean

When booking multiple entries with both approved and unapproved entries this controls whether to allow booking of the approved entries or none at all

Filterable: not filterable

Sortable: false

autoApprove
required
boolean

Auto approve entries created by an admin

Filterable: not filterable

Sortable: false

balancingBehavior
required
boolean

If set to true the balance is summed by month. If set to false the balance is summed by date.

Filterable: eq, ne, lt, lte, gt, gte

Sortable: false

isStandingJournal
required
boolean

Controls if the entries in the journal will stay after booking

Filterable: eq, ne, lt, lte, gt, gte

Sortable: false

lockVatCodes
required
boolean

Controls if VAT codes are locked (only affects e-conomic UI)

Filterable: not filterable

Sortable: false

name
required
string non-empty

The name of the journal

Filterable: not filterable

Sortable: false

repeatText
required
boolean

Controls whether to repeat text when creating multi legged entries

Filterable: not filterable

Sortable: false

requireAdminApproval
required
boolean

Controls if the entries requires approval from an admin

Filterable: not filterable

Sortable: false

requireBalancePerVoucherId
required
boolean

When booking multiple entries with both balanced and unbalanced entries this controls whether to allow booking of the balanced entries or none at all

Filterable: not filterable

Sortable: false

type
required
integer <int32>
Enum: 1 2 3 4

Type of the journal. Available types are Classic = 1, JournalPro = 2, JournalProTemporaryBooking = 3, JournalProSynchronization = 4

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

customerContraAccount
integer or null <int32>

Defines a contra account automatically set when creating customer entries

Filterable: not filterable

Sortable: false

customerPaymentText
string or null

Defines a payment text automatically set when creating customer entries

Filterable: not filterable

Sortable: false

defaultDepartment
integer or null <int32>

Defines a default department for entries

Filterable: not filterable

Sortable: false

maximumVoucherNumber
integer or null <int32>

Defines the maximum voucher number used by journal entries

Filterable: not filterable

Sortable: false

minimumVoucherNumber
integer or null <int32>

Defines the miminum voucher number used by journal entries

Filterable: not filterable

Sortable: false

nextVoucherNumber
integer or null <int32>

Defined the next voucher number used by journal entries

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

paymentMessageText
string or null

Defines a text that is automatically applied to the message on payments

Filterable: not filterable

Sortable: false

priority
integer or null <int32>

Defines the UI order of all journals in e-conomic

Filterable: not filterable

Sortable: false

supplierContraAccount
integer or null <int32>

Defines a contra account automatically set when creating supplier entries

Filterable: not filterable

Sortable: false

supplierPaymentText
string or null

Defines a payment text automatically set when creating supplier entries

Filterable: not filterable

Sortable: false

Responses

Request samples

Content type
application/json
{
  • "balancingBehavior": true,
  • "autoApprove": true,
  • "type": 1,
  • "isStandingJournal": true,
  • "requireAdminApproval": true,
  • "lockVatCodes": true,
  • "name": "string",
  • "allowPartialBooking": true,
  • "requireBalancePerVoucherId": true,
  • "repeatText": true
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": [
    ],
  • "traceId": "string",
  • "errorCode": "string",
  • "traceTimeUtc": "string"
}

Get all journals paged

Use this endpoint to fetch all journals paged

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
query Parameters
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

Responses

Response Schema: application/json
Array
allowPartialBooking
required
boolean

When booking multiple entries with both approved and unapproved entries this controls whether to allow booking of the approved entries or none at all

Filterable: not filterable

Sortable: false

autoApprove
required
boolean

Auto approve entries created by an admin

Filterable: not filterable

Sortable: false

balancingBehavior
required
boolean

If set to true the balance is summed by month. If set to false the balance is summed by date.

Filterable: eq, ne, lt, lte, gt, gte

Sortable: false

isStandingJournal
required
boolean

Controls if the entries in the journal will stay after booking

Filterable: eq, ne, lt, lte, gt, gte

Sortable: false

lockVatCodes
required
boolean

Controls if VAT codes are locked (only affects e-conomic UI)

Filterable: not filterable

Sortable: false

name
required
string non-empty

The name of the journal

Filterable: not filterable

Sortable: false

repeatText
required
boolean

Controls whether to repeat text when creating multi legged entries

Filterable: not filterable

Sortable: false

requireAdminApproval
required
boolean

Controls if the entries requires approval from an admin

Filterable: not filterable

Sortable: false

requireBalancePerVoucherId
required
boolean

When booking multiple entries with both balanced and unbalanced entries this controls whether to allow booking of the balanced entries or none at all

Filterable: not filterable

Sortable: false

type
required
integer <int32>
Enum: 1 2 3 4

Type of the journal. Available types are Classic = 1, JournalPro = 2, JournalProTemporaryBooking = 3, JournalProSynchronization = 4

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

customerContraAccount
integer or null <int32>

Defines a contra account automatically set when creating customer entries

Filterable: not filterable

Sortable: false

customerPaymentText
string or null

Defines a payment text automatically set when creating customer entries

Filterable: not filterable

Sortable: false

defaultDepartment
integer or null <int32>

Defines a default department for entries

Filterable: not filterable

Sortable: false

maximumVoucherNumber
integer or null <int32>

Defines the maximum voucher number used by journal entries

Filterable: not filterable

Sortable: false

minimumVoucherNumber
integer or null <int32>

Defines the miminum voucher number used by journal entries

Filterable: not filterable

Sortable: false

nextVoucherNumber
integer or null <int32>

Defined the next voucher number used by journal entries

Filterable: not filterable

Sortable: false

number
integer <int32>

The unique number of the journal.

Read-only: true

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

paymentMessageText
string or null

Defines a text that is automatically applied to the message on payments

Filterable: not filterable

Sortable: false

priority
integer or null <int32>

Defines the UI order of all journals in e-conomic

Filterable: not filterable

Sortable: false

supplierContraAccount
integer or null <int32>

Defines a contra account automatically set when creating supplier entries

Filterable: not filterable

Sortable: false

supplierPaymentText
string or null

Defines a payment text automatically set when creating supplier entries

Filterable: not filterable

Sortable: false

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve the number of journals

Call this endpoint to get the number of Journals. You can use filtering as well.

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
query Parameters
filter
string

Use this parameter to set the filtering for fields. Filtering instructions

Responses

Response Schema: application/json
integer <int32>

Response samples

Content type
application/json
0
0

Get a single journal

Use this endpoint to fetch a single journal

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
path Parameters
number
required
integer <int32>

Responses

Response Schema: application/json
allowPartialBooking
required
boolean

When booking multiple entries with both approved and unapproved entries this controls whether to allow booking of the approved entries or none at all

Filterable: not filterable

Sortable: false

autoApprove
required
boolean

Auto approve entries created by an admin

Filterable: not filterable

Sortable: false

balancingBehavior
required
boolean

If set to true the balance is summed by month. If set to false the balance is summed by date.

Filterable: eq, ne, lt, lte, gt, gte

Sortable: false

isStandingJournal
required
boolean

Controls if the entries in the journal will stay after booking

Filterable: eq, ne, lt, lte, gt, gte

Sortable: false

lockVatCodes
required
boolean

Controls if VAT codes are locked (only affects e-conomic UI)

Filterable: not filterable

Sortable: false

name
required
string non-empty

The name of the journal

Filterable: not filterable

Sortable: false

repeatText
required
boolean

Controls whether to repeat text when creating multi legged entries

Filterable: not filterable

Sortable: false

requireAdminApproval
required
boolean

Controls if the entries requires approval from an admin

Filterable: not filterable

Sortable: false

requireBalancePerVoucherId
required
boolean

When booking multiple entries with both balanced and unbalanced entries this controls whether to allow booking of the balanced entries or none at all

Filterable: not filterable

Sortable: false

type
required
integer <int32>
Enum: 1 2 3 4

Type of the journal. Available types are Classic = 1, JournalPro = 2, JournalProTemporaryBooking = 3, JournalProSynchronization = 4

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

customerContraAccount
integer or null <int32>

Defines a contra account automatically set when creating customer entries

Filterable: not filterable

Sortable: false

customerPaymentText
string or null

Defines a payment text automatically set when creating customer entries

Filterable: not filterable

Sortable: false

defaultDepartment
integer or null <int32>

Defines a default department for entries

Filterable: not filterable

Sortable: false

maximumVoucherNumber
integer or null <int32>

Defines the maximum voucher number used by journal entries

Filterable: not filterable

Sortable: false

minimumVoucherNumber
integer or null <int32>

Defines the miminum voucher number used by journal entries

Filterable: not filterable

Sortable: false

nextVoucherNumber
integer or null <int32>

Defined the next voucher number used by journal entries

Filterable: not filterable

Sortable: false

number
integer <int32>

The unique number of the journal.

Read-only: true

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

paymentMessageText
string or null

Defines a text that is automatically applied to the message on payments

Filterable: not filterable

Sortable: false

priority
integer or null <int32>

Defines the UI order of all journals in e-conomic

Filterable: not filterable

Sortable: false

supplierContraAccount
integer or null <int32>

Defines a contra account automatically set when creating supplier entries

Filterable: not filterable

Sortable: false

supplierPaymentText
string or null

Defines a payment text automatically set when creating supplier entries

Filterable: not filterable

Sortable: false

Response samples

Content type
application/json
{
  • "number": 0,
  • "balancingBehavior": true,
  • "autoApprove": true,
  • "type": 1,
  • "isStandingJournal": true,
  • "requireAdminApproval": true,
  • "lockVatCodes": true,
  • "nextVoucherNumber": 0,
  • "minimumVoucherNumber": 0,
  • "maximumVoucherNumber": 0,
  • "customerContraAccount": 0,
  • "supplierContraAccount": 0,
  • "customerPaymentText": "string",
  • "supplierPaymentText": "string",
  • "name": "string",
  • "priority": 0,
  • "allowPartialBooking": true,
  • "requireBalancePerVoucherId": true,
  • "repeatText": true,
  • "paymentMessageText": "string",
  • "defaultDepartment": 0,
  • "objectVersion": "string"
}

Delete existing journal

Use this endpoint to delete a journal

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
path Parameters
number
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": [
    ],
  • "traceId": "string",
  • "errorCode": "string",
  • "traceTimeUtc": "string"
}

BookedEntries

BookedEntries allows booked entries and its related data to be fetched.

Notice

This endpoint is being deprecated in favor of /bookedEntriesApi/booked-entries/

Examples of use cases:

  • Retrieve all booked entries
  • Retrieve all dimensions related with booked entries

Required application roles: SuperUser or Bookkeeping More info

DraftEntries

draft-entries endpoints allow draft entries to created, fetched, updated and deleted.

Examples of use cases:

  • Create new draft entry
  • Update existing draft entry
  • Get all draft entries
  • Get single draft entry
  • Create up to 500 draft entries in bulk
  • Update up to 500 draft entries in bulk
  • Delete all draft entries within a journal

Required application roles: SuperUser or Bookkeeping More info

Get all draft entries

Use this endpoint to fetch all draft

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
query Parameters
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

Responses

Response Schema: application/json
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

Response samples

Content type
application/json
{
  • "cursor": "234",
  • "items": [
    ]
}

Create new draft entry

Use this endpoint to create a single new draft entry

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
Request Body schema: application/json
amount
required
number <double>

The amount of the entry

Filterable: not filterable

Sortable: false

currency
required
string non-empty

The currency of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

date
required
string <date-time>

The date of the entry.

Filterable: eq, ne, lt, lte, gt, gte

Sortable: false

entryTypeNumber
required
integer <int32> 2|3|4|5|10

The entry type.
It has 5 types:

  • 2: Customer Payment
  • 3: Supplier Invoice
  • 4: Supplier Payment
  • 5: Finance Voucher
  • 10: Manual Customer Invoice

    Filterable: eq, ne, lt, lte, gt, gte, in, nin

    Sortable: true

journalNumber
required
integer <int32>

The number of the journal that this entry belongs to.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

voucherNumber
required
integer <int32>

The voucher number of the entry.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

accountNumber
integer or null <int32>

The account number of the entry.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

contraAccountNumber
integer or null <int32>

The contra account number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

contraVatCode
string or null

The contra VAT code of the entry

Filterable: not filterable

Sortable: false

costTypeNumber
integer or null <int32>

The cost type number of the entry

Filterable: not filterable

Sortable: false

customerInvoiceNumber
string or null

The customer invoice number of the entry

Filterable: not filterable

Sortable: false

customerNumber
integer or null <int32>

The customer number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

dueDate
string or null <date-time>

The due date of the entry

Filterable: not filterable

Sortable: false

exchangeRate
number or null <double>

The exchange rate of the entry

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

projectNumber
integer or null <int32>

The project number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

supplierInvoiceNumber
string or null

The supplier invoice number

Filterable: not filterable

Sortable: false

supplierNumber
integer or null <int32>

The supplier number

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

supplierPaymentBank
string or null

The supplier payment bank details

Filterable: not filterable

Sortable: false

supplierPaymentMessage
string or null

The supplier payment message

Filterable: not filterable

Sortable: false

supplierPaymentType
integer or null <int32> ^(-1|1|2|5|7|10|14|17)$

description: "The supplier payment type. It has 8 types:

  • -1: None
  • 1: Plus71
  • 2: Plus73
  • 5: Plus04
  • 7: BankTransfer
  • 10: Iban
  • 14: EntryOnly
  • 17: Plus75

    Filterable: not filterable

    Sortable: false

text
string or null

Text description of the entry

Filterable: not filterable

Sortable: false

vatCode
string or null

The VAT code of the entry.

Filterable: not filterable

Sortable: false

Responses

Response Schema: application/json
entryNumber
integer or null <int32>

The unique number of the entry.

Read-only: true

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

Request samples

Content type
application/json
{
  • "entryTypeNumber": 0,
  • "voucherNumber": 0,
  • "journalNumber": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "amount": 0,
  • "currency": "string"
}

Response samples

Content type
application/json
{
  • "entryNumber": 0
}

Update existing draft entry

Use this endpoint to update a single draft entry

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
Request Body schema: application/json
amount
required
number <double>

The amount of the entry

Filterable: not filterable

Sortable: false

currency
required
string non-empty

The currency of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

date
required
string <date-time>

The date of the entry.

Filterable: eq, ne, lt, lte, gt, gte

Sortable: false

entryTypeNumber
required
integer <int32> 2|3|4|5|10

The entry type.
It has 5 types:

  • 2: Customer Payment
  • 3: Supplier Invoice
  • 4: Supplier Payment
  • 5: Finance Voucher
  • 10: Manual Customer Invoice

    Filterable: eq, ne, lt, lte, gt, gte, in, nin

    Sortable: true

journalNumber
required
integer <int32>

The number of the journal that this entry belongs to.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

voucherNumber
required
integer <int32>

The voucher number of the entry.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

accountNumber
integer or null <int32>

The account number of the entry.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

contraAccountNumber
integer or null <int32>

The contra account number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

contraVatCode
string or null

The contra VAT code of the entry

Filterable: not filterable

Sortable: false

costTypeNumber
integer or null <int32>

The cost type number of the entry

Filterable: not filterable

Sortable: false

customerInvoiceNumber
string or null

The customer invoice number of the entry

Filterable: not filterable

Sortable: false

customerNumber
integer or null <int32>

The customer number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

dueDate
string or null <date-time>

The due date of the entry

Filterable: not filterable

Sortable: false

exchangeRate
number or null <double>

The exchange rate of the entry

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

projectNumber
integer or null <int32>

The project number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

supplierInvoiceNumber
string or null

The supplier invoice number

Filterable: not filterable

Sortable: false

supplierNumber
integer or null <int32>

The supplier number

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

supplierPaymentBank
string or null

The supplier payment bank details

Filterable: not filterable

Sortable: false

supplierPaymentMessage
string or null

The supplier payment message

Filterable: not filterable

Sortable: false

supplierPaymentType
integer or null <int32> ^(-1|1|2|5|7|10|14|17)$

description: "The supplier payment type. It has 8 types:

  • -1: None
  • 1: Plus71
  • 2: Plus73
  • 5: Plus04
  • 7: BankTransfer
  • 10: Iban
  • 14: EntryOnly
  • 17: Plus75

    Filterable: not filterable

    Sortable: false

text
string or null

Text description of the entry

Filterable: not filterable

Sortable: false

vatCode
string or null

The VAT code of the entry.

Filterable: not filterable

Sortable: false

Responses

Request samples

Content type
application/json
{
  • "entryTypeNumber": 0,
  • "voucherNumber": 0,
  • "journalNumber": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "amount": 0,
  • "currency": "string"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": [
    ],
  • "traceId": "string",
  • "errorCode": "string",
  • "traceTimeUtc": "string"
}

Get all draft entries paged

Use this endpoint to fetch all draft paged

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
query Parameters
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

Responses

Response Schema: application/json
Array
amount
required
number <double>

The amount of the entry

Filterable: not filterable

Sortable: false

currency
required
string non-empty

The currency of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

date
required
string <date-time>

The date of the entry.

Filterable: eq, ne, lt, lte, gt, gte

Sortable: false

entryTypeNumber
required
integer <int32> 2|3|4|5|10

The entry type.
It has 5 types:

  • 2: Customer Payment
  • 3: Supplier Invoice
  • 4: Supplier Payment
  • 5: Finance Voucher
  • 10: Manual Customer Invoice

    Filterable: eq, ne, lt, lte, gt, gte, in, nin

    Sortable: true

journalNumber
required
integer <int32>

The number of the journal that this entry belongs to.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

voucherNumber
required
integer <int32>

The voucher number of the entry.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

accountNumber
integer or null <int32>

The account number of the entry.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

contraAccountNumber
integer or null <int32>

The contra account number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

contraVatCode
string or null

The contra VAT code of the entry

Filterable: not filterable

Sortable: false

costTypeNumber
integer or null <int32>

The cost type number of the entry

Filterable: not filterable

Sortable: false

customerInvoiceNumber
string or null

The customer invoice number of the entry

Filterable: not filterable

Sortable: false

customerNumber
integer or null <int32>

The customer number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

dueDate
string or null <date-time>

The due date of the entry

Filterable: not filterable

Sortable: false

entryNumber
integer or null <int32>

The unique number of the entry.

Read-only: true

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

exchangeRate
number or null <double>

The exchange rate of the entry

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

projectNumber
integer or null <int32>

The project number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

supplierInvoiceNumber
string or null

The supplier invoice number

Filterable: not filterable

Sortable: false

supplierNumber
integer or null <int32>

The supplier number

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

supplierPaymentBank
string or null

The supplier payment bank details

Filterable: not filterable

Sortable: false

supplierPaymentMessage
string or null

The supplier payment message

Filterable: not filterable

Sortable: false

supplierPaymentType
integer or null <int32> ^(-1|1|2|5|7|10|14|17)$

description: "The supplier payment type. It has 8 types:

  • -1: None
  • 1: Plus71
  • 2: Plus73
  • 5: Plus04
  • 7: BankTransfer
  • 10: Iban
  • 14: EntryOnly
  • 17: Plus75

    Filterable: not filterable

    Sortable: false

text
string or null

Text description of the entry

Filterable: not filterable

Sortable: false

vatCode
string or null

The VAT code of the entry.

Filterable: not filterable

Sortable: false

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve the number of DraftEntries

Call this endpoint to get the number of DraftEntries. You can use filtering as well.

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
query Parameters
filter
string

Use this parameter to set the filtering for fields. Filtering instructions

Responses

Response Schema: application/json
integer <int32>

Response samples

Content type
application/json
0
0

Get a single draft entry

Use this endpoint to fetch a single draft entry

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
path Parameters
entryNumber
required
integer <int32>

Responses

Response Schema: application/json
amount
required
number <double>

The amount of the entry

Filterable: not filterable

Sortable: false

currency
required
string non-empty

The currency of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

date
required
string <date-time>

The date of the entry.

Filterable: eq, ne, lt, lte, gt, gte

Sortable: false

entryTypeNumber
required
integer <int32> 2|3|4|5|10

The entry type.
It has 5 types:

  • 2: Customer Payment
  • 3: Supplier Invoice
  • 4: Supplier Payment
  • 5: Finance Voucher
  • 10: Manual Customer Invoice

    Filterable: eq, ne, lt, lte, gt, gte, in, nin

    Sortable: true

journalNumber
required
integer <int32>

The number of the journal that this entry belongs to.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

voucherNumber
required
integer <int32>

The voucher number of the entry.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

accountNumber
integer or null <int32>

The account number of the entry.

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

contraAccountNumber
integer or null <int32>

The contra account number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

contraVatCode
string or null

The contra VAT code of the entry

Filterable: not filterable

Sortable: false

costTypeNumber
integer or null <int32>

The cost type number of the entry

Filterable: not filterable

Sortable: false

customerInvoiceNumber
string or null

The customer invoice number of the entry

Filterable: not filterable

Sortable: false

customerNumber
integer or null <int32>

The customer number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

dueDate
string or null <date-time>

The due date of the entry

Filterable: not filterable

Sortable: false

entryNumber
integer or null <int32>

The unique number of the entry.

Read-only: true

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

exchangeRate
number or null <double>

The exchange rate of the entry

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

projectNumber
integer or null <int32>

The project number of the entry

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

supplierInvoiceNumber
string or null

The supplier invoice number

Filterable: not filterable

Sortable: false

supplierNumber
integer or null <int32>

The supplier number

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: false

supplierPaymentBank
string or null

The supplier payment bank details

Filterable: not filterable

Sortable: false

supplierPaymentMessage
string or null

The supplier payment message

Filterable: not filterable

Sortable: false

supplierPaymentType
integer or null <int32> ^(-1|1|2|5|7|10|14|17)$

description: "The supplier payment type. It has 8 types:

  • -1: None
  • 1: Plus71
  • 2: Plus73
  • 5: Plus04
  • 7: BankTransfer
  • 10: Iban
  • 14: EntryOnly
  • 17: Plus75

    Filterable: not filterable

    Sortable: false

text
string or null

Text description of the entry

Filterable: not filterable

Sortable: false

vatCode
string or null

The VAT code of the entry.

Filterable: not filterable

Sortable: false

Response samples

Content type
application/json
{
  • "entryNumber": 0,
  • "entryTypeNumber": 0,
  • "voucherNumber": 0,
  • "journalNumber": 0,
  • "date": "2019-08-24T14:15:22Z",
  • "accountNumber": 0,
  • "vatCode": "string",
  • "amount": 0,
  • "currency": "string",
  • "exchangeRate": 0,
  • "contraAccountNumber": 0,
  • "contraVatCode": "string",
  • "text": "string",
  • "projectNumber": 0,
  • "costTypeNumber": 0,
  • "customerNumber": 0,
  • "customerInvoiceNumber": "string",
  • "supplierNumber": 0,
  • "supplierInvoiceNumber": "string",
  • "supplierPaymentType": 0,
  • "supplierPaymentBank": "string",
  • "supplierPaymentMessage": "string",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "objectVersion": "string"
}

Delete existing draft entry

Use this endpoint to delete a single draft entry

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
path Parameters
entryNumber
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": [
    ],
  • "traceId": "string",
  • "errorCode": "string",
  • "traceTimeUtc": "string"
}

Create multiple new draft entries

Use this endpoint to create up to 500 new draft entries

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
Request Body schema: application/json
Array of objects or null (DraftEntry)

List of entries

Filterable: not filterable

Sortable: false

Responses

Response Schema: application/json
entryNumber
integer or null <int32>

The unique number of the entry.

Read-only: true

Filterable: eq, ne, lt, lte, gt, gte, in, nin

Sortable: true

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "entryNumber": 0
}

Update multiple draft entries

Use this endpoint to update up to 500 draft entries

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
Request Body schema: application/json
Array of objects or null (DraftEntry)

List of entries

Filterable: not filterable

Sortable: false

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": [
    ],
  • "traceId": "string",
  • "errorCode": "string",
  • "traceTimeUtc": "string"
}

Delete all draft entries within a journal

Use this endpoint to delete all draft entries within the specified journal

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
path Parameters
journalNumber
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": [
    ],
  • "traceId": "string",
  • "errorCode": "string",
  • "traceTimeUtc": "string"
}