{ "openapi": "3.1.1", "info": { "title": "Visma e-conomic OpenAPI Documents", "description": "# Changelog\n
\nClick to see changelog.\n\n| Version | Description | Date |\n|:--------|:------------|:-----|\n|4.0.2| Minor API improvements and maintenance. | 09/10/2026|\r\n|4.0.1| Minor API improvements and maintenance. | 23/06/2026|\r\n|4.0.0| [`attachedDocuments`](#tag/AttachedDocuments) Added optional `OnConflict` property to the attach endpoint payload. Use `Merge` (default) to merge with an existing attached document, or `Fail` to reject the request when the voucher already has a document attached. | 29/05/2026|\r\n|3.0.1| [`attachedDocuments`](#tag/AttachedDocuments) Add support for attaching image files to entries (JPG, PNG). | 21/04/2026|\r\n|3.0.0| [`attachedDocuments`](#tag/AttachedDocuments) Deprecate the `File` property from the `GET` endpoints and make it non-mandatory. | 02/04/2026|\r\n|2.2.0| [`attachedDocuments`](#tag/AttachedDocuments) Added endpoint for bulk deleting attached documents. The endpoint will detach the documents from the associated voucher numbers and delete them from storage.| 30/12/2025|\r\n|2.1.0| [`attachedDocuments`](#tag/AttachedDocuments) Added endpoint for deleting an attached document. The endpoint will deattach the document from the associated voucher number and delete it from storage.| 06/06/2025|\r\n|2.0.0| [`attachedDocuments`](#tag/AttachedDocuments) Added endpoint for uploading PDF files to entries.
The body of the endpoint requires: File, AccountingYear and VoucherNumber.| 26/02/2025|\r\n|1.0.1| Minor changes in the specification: Capital letters in the URLs and improvements in the API description | 04/02/2025|\r\n|1.0.0| [`attachedDocuments`](#tag/AttachedDocuments) endpoints added. | 26/03/2023|\n\n
\n\n# TL;DR\n\n**Create tokens as instructed [here](https://www.e-conomic.com/developer/connect) and then add these three headers to your requests:**\n\n| Header | Value | What is this? |\n| :-------------------- | :------------------------- | :----------------------------------------------------------- |\n| X-AppSecretToken | YOUR_PRIVATE_TOKEN | This identifies your app. This is your secret token. Try using the value `demo`. |\n| 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`. |\n| Content-Type | application/json | We’re a JSON based API. This tells us that you agree with us on using JSON. |\n\n**Optional headers:**\n\n| Header | Value | What is this? |\n| :-------------------- | :------------------------- | :----------------------------------------------------------- |\n| Idempotency-Key | YOUR_IDEMPOTENCY_KEY | This represents your own unique idempotency key. Enables you to make use of our [Idempotency Tokens](#section/Retrieving-data/Idempotency-tokens) feature. You can't use this feature with GET requests. |\n\n### Examples\n\n#### jQuery\n\n```javascript/jQuery\n$.ajax({\n url: \"https://apis.e-conomic.com/documentsapi/v4.0.2/the_resource\",\n dataType: \"json\",\n headers: {\n 'X-AppSecretToken': \"demo\",\n 'X-AgreementGrantToken': \"demo\",\n 'Accept': \"application/json\"\n },\n type: \"GET\"\n})\n .always(function (data) {\n $(\"#output\").text(JSON.stringify(data, null, 4));\n});\n```\n\n#### cURL\n\n```curl\ncurl -H \"X-AppSecretToken: demo\" -H \"X-AgreementGrantToken: demo\" https://apis.e-conomic.com/documentsapi/v4.0.2/the_resource\n```\n\n\n\n# Introduction\n\nWelcome to the **Visma e-conomic OpenAPI** documentation!\n\nThe e-conomic API is a document-based JSON REST API. \n\nFor more in-depth information about e-conomic itself, please have a look at the e-copedia [http://wiki.e-conomic.dk](http://wiki.e-conomic.dk/).\n\n## Usage\n\n- **Generating a client** can easily be done using tools like [swagger-codegen](https://github.com/swagger-api/swagger-codegen) or others that work with [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification) specs.\n\n\n## Versioning\n\nAPI releases are versioned using a three-part versioning scheme: `{major version}.{minor version}.{patch version}`.\n\nWe broadly follow [Semantic Versioning](https://semver.org/) principles when versioning the API. The major version number is incremented when a breaking change occurs. \n\nThe format is:\n\n`/{resource-api}/v{major version}.{minor version}.{patch version}/{resource-name}`\n\nEach value of the above are integers and you should configure the specific version in each API call. \n\nAn example could be: `/subscriptionsapi/v1.0.0/subscriptions`\n\nTo track the changes of versions, please see our [changelog](#section/Changelog).\n\nWe reserve the right to deprecate versions at intervals since this allows for moving into a friendly environment for you faster.\n\n## Demo authentication\n\nIf 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.\n\n# Retrieving data\n\nOur 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. \n\n## Filtering\n\nFiltering is enabled on all collection endpoints but not on all properties.\n\nFiltering 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.\n\nExample: `?filter=name$eq:Joe`\n\nThis matches all resources with the value Joe in the property name.\n\nPredicates can be chained using either of the logical operators AND and OR.\n\nExample: `?filter=name$eq:Joe$and:city$like:*port`\n\nFiltering on strings is case insensitive.\n\n#### Filterable properties\nInformation 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.\n\n#### Specifying Operator affinity\nIf you want to control the operator affinity then you can use parentheses.\n\nAn example is: `?filter=name$eq:Joe$and:(city$like:*port$or:age$lt:40)`\n\n#### URL Encoding\nURL parameter values should always be URL compatible. Always URL encode filter strings.\n\n#### Filter Operators\nThe possible filtering operators are:\n\n| Operator | Syntax |\n| -------- | ------ |\n|Equals | $eq:|\n|Not equals | $ne:|\n|Greater than | $gt:|\n|Greater than or equal | $gte:|\n|Less than | $lt:|\n|Less than or equal | $lte:|\n|Substring match\t| $like:|\n|And also | $and:|\n|Or else | $or:|\n|In | $in:|\n|Not In | $nin:|\n\n#### Substring matching\n\nThe `$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.\n\n#### Escaping special characters in your filter\nTo not interfere with the parsing of the filter expression, certain escape sequences are necessary.\n\n- “$” is escaped with “$$”\n- “(” is escaped with “$(”\n- “)” is escaped with “$)”\n- “*” is escaped with “$*”\n- “,” is escaped with “$,”\n- “[” is escaped with “$[”\n- “]” is escaped with “$]”\n\n#### Using null values in your filter\nShould you want to filter for the nonexistence of a property (i.e. null value) you can use the null escape sequence.\n\n`$null:`\n\n#### Using in and not in operators\nTo 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.\n\n`customerNumber$in:[2,5,7,22,45]`\n\n\nIt 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.\n\n\n## Sorting\n\nSorting on strings is case insensitive.\n\n### Sort ascending\n\nSorting on collections can be done using the query string parameter ‘sort’.\n\n```\n?sort=name\n```\n\n### Sort descending\n\nThe default sort direction is ascending, but this can be turned by prepending a minus (-).\n\n```\n?sort=-name\n```\n\n### Sort by multiple properties\n\nIf you need to sort by multiple properties these can just be separated by commas. Mixing of directions is allowed.\n\n```\n?sort=-name,age\n```\n\n### Sort alphabetically\n\nIn 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 (~).\n\n```\n?sort=~name\n```\n\n#### Sortable properties\nInformation 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.\n\n#### Important: Sorting with pagination\nPlease note that sorting is **only available with classic pagination** (using `skippages` and `pagesize`). Sorting is **not supported when using cursor-based pagination**, as the cursor points to a specific record with a fixed ordering.\n\n\n## Pagination\n\nWhen it comes to retrieving a collection of items, you can use two distinct approaches:\n\n* **Cursor-based pagination** (continued loading of items using a `cursor` as a query parameter to get the next page of items)\n * This is the recommended approach, and the one you should use by default.\n * The endpoint naming scheme is **\"Retrieve all `Items`\"**. (Usage: `/{ITEM}?cursor={CURSOR_VALUE}`)\n * 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.\n\n\n* **Classic pagination** (limited functionality*. Specify `skippages` and `pagesize ` as query parameters to get a specific page of items)\n * You should only consider using classic pagination, if you rely on loading pages (i.e. for list views or table/grid-based UI's).\n * The endpoint naming scheme is **\"Retrieve a page of `Items`\"**. (Usage: `/{ITEM}/paged?skippages=0&pagesize=20`) \n \\* 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.\n\nPlease bear in mind that the two approaches are supported by **separate endpoints**. To use classic pagination, add `/paged` to your request URL.\n\nIf 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`\"**. \nYou can also use the result of this endpoint to calculate the pagination navigation buttons for a table/grid-based UI.\n\n\n### Which approach should you use?\nWe highly recommend that you use cursor-based pagination because:\n- It is more performant and offers much faster retrieval of items;\n- 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; \n Classic pagination is only appropriate when you have an app with a table/grid-based UI.\n\n### Cursor-based pagination\n\n#### How it works\n\nWhen 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).\n\nThe 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. \n\nPlease 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.\n\n##### Real world example\n\nI want to retrieve all subscriptions.\n\n1) I send a request to https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptions \n and get back an array of 1.000 subscriptions, and a cursor with value 34781\n\n2) I send a request for the next items in the resulting collection:\n https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptions?cursor=34781\n and get back an array of 1.000 subscriptions and a cursor with value 87695\n\n3) I send a request for the next items in the result:\n https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptions?cursor=87695\n and get back an array of 56 items and no cursor.\n No cursor means I have retrieved all the subscriptions, i.e. I have reached the end of the list.\n\n### Classic pagination\n\nIf 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.\n\n##### Real world example\n\nI want to show a grid with page size of 50 and pagination navigation buttons.\n\n1) I send a request to see how many subscriptions there are in the collection: \n `https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptions/count` \n 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.\n\n\n2) I send a request to retrieve the first page of subscriptions that my user will see: \n `https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptions/paged?pagesize=50&sort=-number` \n with this I get back an array of 50 subscriptions, sorted by number in descending order.\n\n\n3) 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: \n `https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptions/paged?pagesize=50&skippages=5&sort=-number` \n I get back an array of 50 subscriptions that belong to page number 6 when sorting by number in descending order.\n\n\n\n### Number of items in a collection\n\nAs 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.\n\nExample `https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptions/count`\n\n\n## HTTP Status Codes\n\nThe Open API returns these HTTP status codes.\n\n| Code | Text | Description |\n| :--- | :--------------------- | :----------------------------------------------------------- |\n| 200 | OK | Everything is OK |\n| 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. |\n| 204 | No Content | In certain cases there is nothing to return. So we will let you know by returning a 204. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n\n\n## Required and Readonly Properties\n\nSince 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.\n\nThis 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.\n\nWhen a property is marked as `required` it means you need to provide a value on each POST and PUT requests.\n\nWhen 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).\n\n## Resource encoding\n\nAll non-alphanumeric characters in resource URLs are standard URL encoded. Please refer to standard URL encoding.\n\n## Implementation specifics\n\nHelpful details to know when implementing e-conomic REST.\n\n### Booleans\n\nBooleans 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.\n\n### Nulling\n\nWe 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.\n\n## Object version\n\nObjectVersion is the mechanism that enforces updates only on latest state of an object.\nObjectVersion property is mandatory in Put Requests.\nObjectVersion property is retrieved on Get Request and needs to be included in Put Request.\nIf object was modified between Get and Put requests, Put request will fail with error code `409 Conflict`\n\n```\n{\n \"message\": \"Update conflict. Version does not match.\",\n \"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.\",\n \"logId\": \"09580053-1141-4e7f-85e1-bed8600e0278\",\n \"logTimeUtc\": \"2021-11-04T09:07:56\",\n \"property\": \"version\"\n}\n```\n\n## Idempotency tokens\n 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.\n \n 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. \n \n Keep in mind that this is cached for only **one hour** window. \n \n When we return a response from the cache, we set a response header `X-ResultFromCache` to true.\n\n It’s important to note that **you will be responsible for generating and keeping track of these keys**.\n\n The [Idempotency Tokens feature](https://techtalk.e-conomic.com/idempotency-tokens-in-e-conomic-apis/) is not available for GET requests.\n\n## The LastUpdated property of resources\nThe `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.\n \nPlease 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.\nFor example, when an invoice line is created, the LastUpdated field on the invoice is modified.\n \nThe 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.\n \nUsage example: https://apis.e-conomic.com/documentsapi/v4.0.2/the_resource?filter=lastUpdated$gt:2024-02-24\nThis will return all resources which have been updated since 24.02.2024.\n \n## Custom extensions in OpenAPI specification\n\nIn the specification file, there are some custom extensions that developers can make use of when consuming endpoints. Those extensions are always prefixed by `x-`.\n\n1) `x-required-roles`: The list of roles that are required for each group of endpoints.\n2) `x-error-codes`: The list of error codes that are potentially returned from each group of endpoints.\n3) `x-cursor-page-size`: The maximum number of items in `CursorResults` that can be returned in a single call.\n\n\n# Authentication\n\n**Create tokens as instructed [here](https://www.e-conomic.com/developer/connect) and then add these two authentication headers to your requests:**\n\n", "contact": { "url": "https://www.e-conomic.com/", "email": "api@e-conomic.com" }, "version": "4.0.2", "x-logo": { "url": "", "altText": "Visma e-conomic" } }, "servers": [ { "url": "https://apis.e-conomic.com/documentsapi/v4.0.2/" } ], "paths": { "/AttachedDocuments": { "get": { "tags": [ "AttachedDocuments" ], "summary": "Retrieve all AttachedDocuments", "description": "Use this endpoint to retrieve all AttachedDocuments in bulk.
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 than that.
Use the continuation cursor parameter to set the cursor for retrieval of the next set of data.
Please check the [pagination instructions](#section/Retrieving-data/Pagination).", "operationId": "GetAllAttachedDocuments", "parameters": [ { "name": "cursor", "in": "query", "description": "Use this parameter to set the continuation cursor for paging. [Pagination instructions](#section/Retrieving-data/Pagination)", "schema": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Use this parameter to set the continuation cursor for paging. [Pagination instructions](#section/Retrieving-data/Pagination)" } }, { "name": "filter", "in": "query", "description": "Use this parameter to set the filtering for fields. [filtering instructions](#section/Retrieving-data/Filtering)", "schema": { "type": "string", "description": "Use this parameter to set the filtering for fields. [filtering instructions](#section/Retrieving-data/Filtering)" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "description": "Array of objects along with a cursor.", "$ref": "#/components/schemas/AttachedDocumentCursorResults" } } } }, "400": { "description": "**Bad request.** Your request does not pass our validation. Check the errors array for more details.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "**Unauthorized access.** Please take a look at https://apis.e-conomic.com and follow the links to help on authorization, or use the word demo for both tokens.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "**Access 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.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "**Too many requests.** You have made too many calls towards our API. You are over your quota. Need to wait a bit. Check info in the response headers.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "**Internal server error.** Something went wrong but the error has been logged. If you continue to see errors here, please contact api@e-conomic.com. Remember to include log id and agreement number when contacting support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "AttachedDocuments" ], "summary": "Attach PDF/JPG/PNG", "description": "Use this endpoint to attach a PDF or an image (JPG or PNG) to Booked or Draft Entries.", "operationId": "AttachPdfAsync", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AttachedDocumentCreate" }, "example": "Content-Type: multipart/form-data; boundary=----boundary\n\n------boundary\nContent-Disposition: form-data; name=\"File\"; filename=\"[file name here]\"\nContent-Type: [content type here]\n\n\n------boundary\nContent-Disposition: form-data; name=\"VoucherNumber\"\n\n\n------boundary\nContent-Disposition: form-data; name=\"AccountingYear\"\n\nstring\n------boundary--\n", "encoding": { "File": { "contentType": "application/pdf, image/jpeg, image/png" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResult" } } } }, "400": { "description": "**Bad request.** Your request does not pass our validation. Check the errors array for more details.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "**Unauthorized access.** Please take a look at https://apis.e-conomic.com and follow the links to help on authorization, or use the word demo for both tokens.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "**Access 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.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "**Too many requests.** You have made too many calls towards our API. You are over your quota. Need to wait a bit. Check info in the response headers.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "**Internal server error.** Something went wrong but the error has been logged. If you continue to see errors here, please contact api@e-conomic.com. Remember to include log id and agreement number when contacting support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/AttachedDocuments/paged": { "get": { "tags": [ "AttachedDocuments" ], "summary": "Retrieve a page of AttachedDocuments", "description": "Use this endpoint to load a page of AttachedDocuments.", "operationId": "GetPageOfAttachedDocuments", "parameters": [ { "name": "filter", "in": "query", "description": "Use this parameter to set the filtering for fields. [Filtering instructions](#section/Retrieving-data/Filtering)", "schema": { "type": "string", "description": "Use this parameter to set the filtering for fields. [Filtering instructions](#section/Retrieving-data/Filtering)" } }, { "name": "sort", "in": "query", "description": "Use this parameter to set the sort fields and direction. [Sort instructions](#section/Retrieving-data/Sorting)", "schema": { "type": "string", "description": "Use this parameter to set the sort fields and direction. [Sort instructions](#section/Retrieving-data/Sorting)" } }, { "name": "pageSize", "in": "query", "description": "Use this parameter to set the page size. [Pagination instructions](#section/Retrieving-data/Pagination)", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "description": "Use this parameter to set the page size. [Pagination instructions](#section/Retrieving-data/Pagination)", "format": "int32", "default": 20 } }, { "name": "skipPages", "in": "query", "description": "Use this parameter to set number of pages to skip. [Pagination instructions](#section/Retrieving-data/Pagination)", "schema": { "maximum": 100, "minimum": 0, "type": "integer", "description": "Use this parameter to set number of pages to skip. [Pagination instructions](#section/Retrieving-data/Pagination)", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttachedDocument" } } } } }, "400": { "description": "**Bad request.** Your request does not pass our validation. Check the errors array for more details.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "**Unauthorized access.** Please take a look at https://apis.e-conomic.com and follow the links to help on authorization, or use the word demo for both tokens.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "**Access 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.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "**Too many requests.** You have made too many calls towards our API. You are over your quota. Need to wait a bit. Check info in the response headers.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "**Internal server error.** Something went wrong but the error has been logged. If you continue to see errors here, please contact api@e-conomic.com. Remember to include log id and agreement number when contacting support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/AttachedDocuments/count": { "get": { "tags": [ "AttachedDocuments" ], "summary": "Retrieve the number of AttachedDocuments", "description": "Call this endpoint to get the number of AttachedDocuments. You can use filtering as well.", "operationId": "GetNumberOfAttachedDocuments", "parameters": [ { "name": "filter", "in": "query", "description": "Use this parameter to set the filtering for fields. [Filtering instructions](#section/Retrieving-data/Filtering)", "schema": { "type": "string", "description": "Use this parameter to set the filtering for fields. [Filtering instructions](#section/Retrieving-data/Filtering)" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "400": { "description": "**Bad request.** Your request does not pass our validation. Check the errors array for more details.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "**Unauthorized access.** Please take a look at https://apis.e-conomic.com and follow the links to help on authorization, or use the word demo for both tokens.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "**Access 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.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "**Too many requests.** You have made too many calls towards our API. You are over your quota. Need to wait a bit. Check info in the response headers.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "**Internal server error.** Something went wrong but the error has been logged. If you continue to see errors here, please contact api@e-conomic.com. Remember to include log id and agreement number when contacting support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/AttachedDocuments/{number}": { "get": { "tags": [ "AttachedDocuments" ], "summary": "Retrieve single AttachedDocument", "description": "Use this endpoint to load a single AttachedDocument by number.", "operationId": "GetAttachedDocumentById", "parameters": [ { "name": "number", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachedDocument" } } } }, "400": { "description": "**Bad request.** Your request does not pass our validation. Check the errors array for more details.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "**Unauthorized access.** Please take a look at https://apis.e-conomic.com and follow the links to help on authorization, or use the word demo for both tokens.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "**Access 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.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "**Resource not found.** The resource you have been looking for does not exist.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "**Too many requests.** You have made too many calls towards our API. You are over your quota. Need to wait a bit. Check info in the response headers.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "**Internal server error.** Something went wrong but the error has been logged. If you continue to see errors here, please contact api@e-conomic.com. Remember to include log id and agreement number when contacting support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "AttachedDocuments" ], "summary": "Delete single AttachedDocument", "description": "Use this endpoint to delete a single AttachedDocument by number.", "operationId": "DeleteAttachedDocumentById", "parameters": [ { "name": "number", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "**Bad request.** Your request does not pass our validation. Check the errors array for more details.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "**Unauthorized access.** Please take a look at https://apis.e-conomic.com and follow the links to help on authorization, or use the word demo for both tokens.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "**Access 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.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "**Resource not found.** The resource you have been looking for does not exist.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "**Too many requests.** You have made too many calls towards our API. You are over your quota. Need to wait a bit. Check info in the response headers.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "**Internal server error.** Something went wrong but the error has been logged. If you continue to see errors here, please contact api@e-conomic.com. Remember to include log id and agreement number when contacting support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/AttachedDocuments/{number}/pdf": { "get": { "tags": [ "AttachedDocuments" ], "summary": "Retrieve the pdf file for a single AttachedDocument", "description": "Call this endpoint to retrieve the pdf file for a single AttachedDocument.", "operationId": "GetPdfForAttachedDocument", "parameters": [ { "name": "number", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "**Unauthorized access.** Please take a look at https://apis.e-conomic.com and follow the links to help on authorization, or use the word demo for both tokens.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "**Access 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.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "**Resource not found.** The resource you have been looking for does not exist.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "**Too many requests.** You have made too many calls towards our API. You are over your quota. Need to wait a bit. Check info in the response headers.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "**Internal server error.** Something went wrong but the error has been logged. If you continue to see errors here, please contact api@e-conomic.com. Remember to include log id and agreement number when contacting support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/AttachedDocuments/deletebulk": { "delete": { "tags": [ "AttachedDocuments" ], "summary": "Bulk delete AttachedDocuments", "description": "Use this endpoint to bulk delete AttachedDocuments by numbers.", "operationId": "BulkDeleteAttachedDocumentsByIds", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachedDocuments" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "**Bad request.** Your request does not pass our validation. Check the errors array for more details.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "**Unauthorized access.** Please take a look at https://apis.e-conomic.com and follow the links to help on authorization, or use the word demo for both tokens.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "**Access 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.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "**Too many requests.** You have made too many calls towards our API. You are over your quota. Need to wait a bit. Check info in the response headers.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "**Internal server error.** Something went wrong but the error has been logged. If you continue to see errors here, please contact api@e-conomic.com. Remember to include log id and agreement number when contacting support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } } }, "components": { "schemas": { "AttachedDocument": { "required": [ "accountingYear", "voucherNumber" ], "type": "object", "properties": { "number": { "type": "integer", "description": "The unique number of the attached document

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

Sortable: true

", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true }, "note": { "maxLength": 250, "minLength": 0, "type": [ "null", "string" ], "description": "The note of the attached document

Filterable: not filterable

Sortable: false

", "x-filterable": "not filterable", "x-sortable": false }, "pageCount": { "type": [ "null", "integer" ], "description": "The number of pages of the attached document

Filterable: not filterable

Sortable: false

", "format": "int32", "x-filterable": "not filterable", "x-sortable": false }, "voucherNumber": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "The number of the voucher that the document is attached to

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

Sortable: false

", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": false }, "accountingYear": { "maxLength": 11, "minLength": 0, "type": "string", "description": "The accounting year of the voucher that the document is attached to

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

Sortable: false

", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": false } }, "additionalProperties": false }, "AttachedDocumentCreate": { "required": [ "accountingYear", "file", "voucherNumber" ], "type": "object", "properties": { "number": { "type": "integer", "description": "The unique number of the attached document

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

Sortable: true

", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true }, "note": { "maxLength": 250, "minLength": 0, "type": [ "null", "string" ], "description": "The note of the attached document

Filterable: not filterable

Sortable: false

", "x-filterable": "not filterable", "x-sortable": false }, "pageCount": { "type": [ "null", "integer" ], "description": "The number of pages of the attached document

Filterable: not filterable

Sortable: false

", "format": "int32", "x-filterable": "not filterable", "x-sortable": false }, "voucherNumber": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "The number of the voucher that the document is attached to

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

Sortable: false

", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": false }, "accountingYear": { "maxLength": 11, "minLength": 0, "type": "string", "description": "The accounting year of the voucher that the document is attached to

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

Sortable: false

", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": false }, "file": { "type": "string", "description": "

Filterable: not filterable

Sortable: false

Max allowed file size: 9 MB

Allowed content types: application/pdf (.pdf), image/jpeg (.jpg), image/jpeg (.jpeg), image/png (.png)

", "format": "binary", "x-filterable": "not filterable", "x-sortable": false, "x-max-file-upload-size-in-bytes": "9437184" }, "onConflict": { "allOf": [ { "description": "
Click to see the list of possible values.\n\n| Value | Name | Description |\n| ----- | ---- | ----------- |\n| 0 | Merge | |\n| 1 | Fail | |\n
", "$ref": "#/components/schemas/VoucherDocumentConflictAction" } ], "description": "Action when the voucher already has a document attached. 0 = Merge (default), 1 = Fail.\n\n
Click to see the list of possible values.\n\n| Value | Name | Description |\n| ----- | ---- | ----------- |\n| 0 | Merge | |\n| 1 | Fail | |\n

Filterable: not filterable

Sortable: false

", "default": 0, "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false }, "AttachedDocumentCursorResults": { "type": "object", "properties": { "cursor": { "type": [ "null", "string" ], "description": "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

", "readOnly": true, "x-filterable": "not filterable", "x-sortable": false }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AttachedDocument" }, "description": "Max number of items returned is 1000.

Filterable: not filterable

Sortable: false

", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false, "description": "Array of objects along with a cursor.", "example": { "cursor": "234", "items": [ { "id": "13", "name": "Patrick" }, { "id": "16", "name": "John" } ] }, "x-cursor-page-size": 1000 }, "AttachedDocuments": { "type": "object", "properties": { "documentNumbers": { "maxItems": 500, "type": [ "null", "array" ], "items": { "type": "integer", "format": "int32" }, "description": "List of document numbers for bulk delete

Filterable: not filterable

Sortable: false

", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false }, "CreatedResult": { "type": "object", "properties": { "number": { "type": "integer", "description": "

Filterable: not filterable

Sortable: false

", "format": "int32", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false }, "Error": { "type": "object", "properties": { "message": { "type": [ "null", "string" ], "description": "

Filterable: not filterable

Sortable: false

", "x-filterable": "not filterable", "x-sortable": false }, "errorCode": { "type": [ "null", "string" ], "description": "

Filterable: not filterable

Sortable: false

", "x-filterable": "not filterable", "x-sortable": false }, "property": { "type": [ "null", "string" ], "description": "

Filterable: not filterable

Sortable: false

", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Error" } }, "traceId": { "type": "string" }, "errorCode": { "type": "string" }, "traceTimeUtc": { "type": "string" } }, "additionalProperties": false }, "VoucherDocumentConflictAction": { "type": "integer", "oneOf": [ { "const": 0, "title": "Merge" }, { "const": 1, "title": "Fail" } ], "description": "
Click to see the list of possible values.\n\n| Value | Name | Description |\n| ----- | ---- | ----------- |\n| 0 | Merge | |\n| 1 | Fail | |\n
" } }, "securitySchemes": { "X-AppSecretToken": { "type": "apiKey", "description": "Application secret token needed to access the endpoints.", "name": "X-AppSecretToken", "in": "header" }, "X-AgreementGrantToken": { "type": "apiKey", "description": "Agreement grant token needed to access the endpoints.", "name": "X-AgreementGrantToken", "in": "header" } } }, "security": [ { "X-AppSecretToken": [ ], "X-AgreementGrantToken": [ ] } ], "tags": [ { "name": "AttachedDocuments", "description": "AttachedDocuments endpoints help attach Pdf or retrieve the documents attached to booked entries.\n\n\n#### Examples of use cases:\n\n* Retrieve the document attached to a specific entry;\n* Retrieve the .pdf file of the attached document;\n* Attach a Pdf file to a specific entry;\n\n\n
Click to see the list of possible error codes.\n\n| Error Code | Description |\n| ---------- | ----------- |\n| AccountingYearNotFound | Accounting year name was not found |\n| InvalidVoucherNumber | Voucher number does not exist in the specified accounting year |\n| InvalidFileData | Failed attaching file, perhaps the file is corrupt or not of a supported file type (.pdf). |\n| UnableToAttach | File was uploaded, but it was not attached to the entry due to errors |\n| CannotAttachToElectronicInvoice | The entry has an electronic invoice. This endpoint does not support merging a pdf into an electronic invoice |\n| DocumentAlreadyAttachedToVoucher | The voucher already has a document attached and merging was not allowed |\n| DocumentAlreadyAttachedToAnotherVoucher | The document is already attached to another voucher and cannot be moved |\n
\n\n**Required application roles:** SuperUser or Bookkeeping [More info](https://www.e-conomic.com/developer/permissions)", "x-error-codes": [ "AccountingYearNotFound", "CannotAttachToElectronicInvoice", "DocumentAlreadyAttachedToAnotherVoucher", "DocumentAlreadyAttachedToVoucher", "InvalidFileData", "InvalidVoucherNumber", "UnableToAttach" ], "x-required-roles": [ "Bookkeeping", "SuperUser" ] } ], "x-tagGroups": [ { "name": "Endpoints", "tags": [ "AttachedDocuments" ] } ] }