Visma e-conomic OpenAPI Customers (1.0.4)

Download OpenAPI specification:Download

Changelog

Click to see changelog.
Version Description Date
1.0.4 Small fixes for the OpenAPI specification json file. 26/03/2024
1.0.3 Added x-required-roles and x-error-codes extensions for delivery locations. 20/02/2024
1.0.2 Added Location header on responses from POST requests. 24/11/2023
1.0.1 Updated descriptions for model properties. 01/11/2023
1.0.0 deliveryLocations and contacts endpoints added. 21/08/2023

TL;DR

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/customersapi/v1.0.4/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/customersapi/v1.0.4/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 dont need to send a second request).

The first set of items usually consists of 1000 results, but in some cases, where we explicitly state so, there may be fewer.

Please note that the cursor is currently the id of the first item on the next set and it should not be mistaken for the number of items which are yet to be displayed. Also, if the cursor is not present in the response, it means that there are no more items in the results.

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.

Compound cursor pagination

We also provide compound cursor pagination for endpoints which return all sales document lines.

Usage: /{ITEM}?cursor={DOCUMENT_NUMBER}_{LINE_NUMBER}

This will return all the first 1000 items ordered by document number and by line number.

Real world example

I want to retrieve all subscription lines

  1. I send a request to https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptionlines and get back an array of 1.000 lines and a cursor with value 20_100. This means that the first 1000 lines belong to subscriptions 1-20 and stopped at line 99 (or whichever the last line before 100 was) of subscription 20.

  2. I send a request for the next items in the resulting collection: https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptionlines?cursor=20_100 and get back an array of 1.000 lines starting with subscription number 20, line number 100 and a cursor with value 70_25

  3. I send a request for the next items in the result: https://apis.e-conomic.com/subscriptionsapi/v1.0.0/subscriptionlines?cursor=70_25 and get back an array of 56 items and no cursor.

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

Custom resource encoding

For some resource ids (the direct URL path to a resource) the question of non-alphanumeric characters must be solved in REST APIs by either encoding or replacement to ensure URL compatibility.

In the e-conomic REST API a subset of non-alphanumeric characters are replaced using a custom scheme for resource URLs:

Character Replacement
“<” 0
“>” 1
“*” 2
“%” 3
“:” 4
“&” 5
“/” 6
“\” 7
“_” 8
“ ” (whitespace) 9
“?” 10
“.” 11
“#” 12
“+” 13

Example: Product “My Awesome Product_Discount5%” Resource URL (self): https://apis.e-conomic.com/products/My_9_Awesome_9_Product_8_Discount5_3_

All other non-alphanumeric characters in resource URLs are standard URL encoded. Please refer to standard URL encoding for characters not mentioned above.

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.

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

Contacts

Contacts endpoints return a collection of contacts for all the customers that an agreement has.

Example of use cases:

  • Retrieve all contacts for all customers
  • Retrieve all contacts for a single customer.

Related guide for users: e-copedia (Danish)

Click to see the list of possible error codes.
Error Code Description
CustomerContactNameAlreadyExists This customer already has a contact with the same name.
CustomerContactNameNullOrEmpty Contact name cannot be empty.
CustomerContactIsInUse Contact cannot be deleted, it is used as a reference for a customer, a sales document or a project.
CustomerDoesNotExist The customer number you provided does not exist.
CustomerNumberMismatch The customer number cannot be updated.

Required application roles: SuperUser or Sales More info

Retrieve a page of Contacts

Use this endpoint to load a page of Contacts.

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
customerNumber
required
integer <int32> [ 1 .. 999999999 ]

The unique number of the customer that the contact is linked to.

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

Sortable: true

name
required
string [ 0 .. 255 ] characters

The name of the customer contact.

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

Sortable: false

eInvoiceId
string or null [ 0 .. 50 ] characters

The contact Id as you want it to appear on electronic invoices.

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

Sortable: false

email
string or null [ 0 .. 255 ] characters

The customer contact e-mail address. This is where copies of sales documents are sent.

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

Sortable: false

isDeleted
boolean

Flag indicating if the contact person was deleted or not.

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

Sortable: false

lastUpdated
string <date-time>

The date when the customer contact was last updated.

Read-only: true

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

Sortable: false

notes
string or null [ 0 .. 255 ] characters

Any extra information related to the customer contact.

Filterable: not filterable

Sortable: false

number
integer <int32>

The unique number of the customer contact.

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

phone
string or null [ 0 .. 50 ] characters

The customer contact phone number.

Filterable: not filterable

Sortable: false

receiveEInvoices
boolean

Flag indicating if the contact person is to receive email notifications on e-invoices.

Filterable: not filterable

Sortable: false

receiveInvoices
boolean

Flag indicating if the contact person is to receive email notifications on invoices.

Filterable: not filterable

Sortable: false

receiveOrders
boolean

Flag indicating if the contact person is to receive email notifications on orders.

Filterable: not filterable

Sortable: false

receiveQuotes
boolean

Flag indicating if the contact person is to receive email notifications on quotes.

Filterable: not filterable

Sortable: false

receiveReminders
boolean

Flag indicating if the contact person is to receive email notifications on reminders.

Filterable: not filterable

Sortable: false

receiveStatementOfAccounts
boolean

Flag indicating if the contact person is to receive email notifications on statements of accounts.

Filterable: not filterable

Sortable: false

userInterfaceNumber
integer <int32>

The customer contact number displayed in the e-conomic web interface.
In the UI, numbering for contacts starts from 1 for each customer, which is why the number displayed in the UI is different from the contact unique identifier.

Read-only: true

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

Sortable: false

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all Contacts

Use this endpoint to retrieve all Contacts 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.
Use the continuation cursor parameter to set the cursor for retrieval of the next set of data.
Please check the pagination instructions.

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 (Contact)

Max number of items returned is 1000.

Filterable: not filterable

Sortable: false

Response samples

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

Create a single Contact

Use this endpoint to create a single Contact.

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
Request Body schema: application/json
customerNumber
required
integer <int32> [ 1 .. 999999999 ]

The unique number of the customer that the contact is linked to.

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

Sortable: true

name
required
string [ 0 .. 255 ] characters

The name of the customer contact.

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

Sortable: false

eInvoiceId
string or null [ 0 .. 50 ] characters

The contact Id as you want it to appear on electronic invoices.

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

Sortable: false

email
string or null [ 0 .. 255 ] characters

The customer contact e-mail address. This is where copies of sales documents are sent.

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

Sortable: false

isDeleted
boolean

Flag indicating if the contact person was deleted or not.

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

Sortable: false

notes
string or null [ 0 .. 255 ] characters

Any extra information related to the customer contact.

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

phone
string or null [ 0 .. 50 ] characters

The customer contact phone number.

Filterable: not filterable

Sortable: false

receiveEInvoices
boolean

Flag indicating if the contact person is to receive email notifications on e-invoices.

Filterable: not filterable

Sortable: false

receiveInvoices
boolean

Flag indicating if the contact person is to receive email notifications on invoices.

Filterable: not filterable

Sortable: false

receiveOrders
boolean

Flag indicating if the contact person is to receive email notifications on orders.

Filterable: not filterable

Sortable: false

receiveQuotes
boolean

Flag indicating if the contact person is to receive email notifications on quotes.

Filterable: not filterable

Sortable: false

receiveReminders
boolean

Flag indicating if the contact person is to receive email notifications on reminders.

Filterable: not filterable

Sortable: false

receiveStatementOfAccounts
boolean

Flag indicating if the contact person is to receive email notifications on statements of accounts.

Filterable: not filterable

Sortable: false

Responses

Response Schema: application/json
number
integer <int32>

Filterable: not filterable

Sortable: false

Request samples

Content type
application/json
{
  • "customerNumber": 1,
  • "name": "string"
}

Response samples

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

Update a single Contact

Use this endpoint to update a single Contact.

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
Request Body schema: application/json
customerNumber
required
integer <int32> [ 1 .. 999999999 ]

The unique number of the customer that the contact is linked to.

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

Sortable: true

name
required
string [ 0 .. 255 ] characters

The name of the customer contact.

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

Sortable: false

eInvoiceId
string or null [ 0 .. 50 ] characters

The contact Id as you want it to appear on electronic invoices.

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

Sortable: false

email
string or null [ 0 .. 255 ] characters

The customer contact e-mail address. This is where copies of sales documents are sent.

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

Sortable: false

isDeleted
boolean

Flag indicating if the contact person was deleted or not.

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

Sortable: false

notes
string or null [ 0 .. 255 ] characters

Any extra information related to the customer contact.

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

phone
string or null [ 0 .. 50 ] characters

The customer contact phone number.

Filterable: not filterable

Sortable: false

receiveEInvoices
boolean

Flag indicating if the contact person is to receive email notifications on e-invoices.

Filterable: not filterable

Sortable: false

receiveInvoices
boolean

Flag indicating if the contact person is to receive email notifications on invoices.

Filterable: not filterable

Sortable: false

receiveOrders
boolean

Flag indicating if the contact person is to receive email notifications on orders.

Filterable: not filterable

Sortable: false

receiveQuotes
boolean

Flag indicating if the contact person is to receive email notifications on quotes.

Filterable: not filterable

Sortable: false

receiveReminders
boolean

Flag indicating if the contact person is to receive email notifications on reminders.

Filterable: not filterable

Sortable: false

receiveStatementOfAccounts
boolean

Flag indicating if the contact person is to receive email notifications on statements of accounts.

Filterable: not filterable

Sortable: false

Responses

Request samples

Content type
application/json
{
  • "customerNumber": 1,
  • "name": "string"
}

Response samples

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

Retrieve the number of Contacts

Call this endpoint to get the number of Contacts. 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

Retrieve single Contact

Use this endpoint to load a single Contact by number.

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

Responses

Response Schema: application/json
customerNumber
required
integer <int32> [ 1 .. 999999999 ]

The unique number of the customer that the contact is linked to.

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

Sortable: true

name
required
string [ 0 .. 255 ] characters

The name of the customer contact.

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

Sortable: false

eInvoiceId
string or null [ 0 .. 50 ] characters

The contact Id as you want it to appear on electronic invoices.

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

Sortable: false

email
string or null [ 0 .. 255 ] characters

The customer contact e-mail address. This is where copies of sales documents are sent.

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

Sortable: false

isDeleted
boolean

Flag indicating if the contact person was deleted or not.

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

Sortable: false

lastUpdated
string <date-time>

The date when the customer contact was last updated.

Read-only: true

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

Sortable: false

notes
string or null [ 0 .. 255 ] characters

Any extra information related to the customer contact.

Filterable: not filterable

Sortable: false

number
integer <int32>

The unique number of the customer contact.

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

phone
string or null [ 0 .. 50 ] characters

The customer contact phone number.

Filterable: not filterable

Sortable: false

receiveEInvoices
boolean

Flag indicating if the contact person is to receive email notifications on e-invoices.

Filterable: not filterable

Sortable: false

receiveInvoices
boolean

Flag indicating if the contact person is to receive email notifications on invoices.

Filterable: not filterable

Sortable: false

receiveOrders
boolean

Flag indicating if the contact person is to receive email notifications on orders.

Filterable: not filterable

Sortable: false

receiveQuotes
boolean

Flag indicating if the contact person is to receive email notifications on quotes.

Filterable: not filterable

Sortable: false

receiveReminders
boolean

Flag indicating if the contact person is to receive email notifications on reminders.

Filterable: not filterable

Sortable: false

receiveStatementOfAccounts
boolean

Flag indicating if the contact person is to receive email notifications on statements of accounts.

Filterable: not filterable

Sortable: false

userInterfaceNumber
integer <int32>

The customer contact number displayed in the e-conomic web interface.
In the UI, numbering for contacts starts from 1 for each customer, which is why the number displayed in the UI is different from the contact unique identifier.

Read-only: true

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

Sortable: false

Response samples

Content type
application/json
{
  • "number": 0,
  • "customerNumber": 1,
  • "userInterfaceNumber": 0,
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "notes": "string",
  • "eInvoiceId": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "receiveQuotes": true,
  • "receiveOrders": true,
  • "receiveInvoices": true,
  • "receiveEInvoices": true,
  • "receiveStatementOfAccounts": true,
  • "receiveReminders": true,
  • "objectVersion": "string",
  • "isDeleted": true
}

Delete single Contact

Use this endpoint to delete a single Contact by number.

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",
  • "traceId": "string",
  • "errorCode": "string",
  • "traceTimeUtc": "string",
  • "errors": [
    ]
}

DeliveryLocations

DeliveryLocations endpoints return a collection of delivery locations for all the customers that an agreement has.

Example of use cases:

  • Retrieve all delivery locations for all customers
  • Retrieve all delivery locations for a single customer.

Related guide for users: e-copedia (Danish)

Click to see the list of possible error codes.
Error Code Description
DeliveryLocationUsedOnInvoices Delivery location cannot be deleted since it's used on at least one invoice.
DeliveryLocationUsedOnCustomers Delivery location cannot be deleted since it's used on at least one customer.
DeliveryLocationUsedOnQuotes Delivery location cannot be deleted since it's used on at least one quote.
DeliveryLocationUsedOnOrders Delivery location cannot be deleted since it's used on at least one order.
DeliveryLocationNumberAlreadyExists Delivery location cannot be created since the given number already exists.
CustomerNotFound Delivery location cannot be created or updated since the customer was not found.
CustomerIsBarred Delivery location cannot be created or updated since the customer is barred.
CustomerNumberMismatch Customer number cannot be updated.

Required application roles: SuperUser or Sales More info

Retrieve a page of DeliveryLocations

Use this endpoint to load a page of DeliveryLocations.

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
customerNumber
required
integer <int32> [ 1 .. 999999999 ]

The unique number of the customer that the delivery location belongs to.

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

Sortable: true

address
string or null [ 0 .. 255 ] characters

The address of the delivery location, including street and number.

Filterable: not filterable

Sortable: false

city
string or null [ 0 .. 50 ] characters

The city of the delivery location.

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

Sortable: false

country
string or null [ 0 .. 50 ] characters

The country of the delivery location.

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

Sortable: false

eInvoiceId
string or null [ 0 .. 50 ] characters

The delivery location Id used on electronic invoices.
It can be, for example, a store number provided by the customer, i.e. AppleStore 6.

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

Sortable: false

isBarred
boolean

Flag indicating if the delivery location is barred from usage.
The default value is false.

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

Sortable: false

lastUpdated
string <date-time>

The date when the delivery location was last updated.

Read-only: true

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

Sortable: false

number
integer <int32>

The unique number of the delivery location.

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

postalCode
string or null [ 0 .. 15 ] characters

The postal code of the delivery location.

Filterable: not filterable

Sortable: false

termsOfDelivery
string or null [ 0 .. 100 ] characters

Special delivery terms that apply to the delivery location.
For example 'ex factory' or 'to the kerb'

Filterable: not filterable

Sortable: false

userInterfaceNumber
integer <int32>

The delivery location number displayed in the UI.
In the UI, numbering for delivery locations starts from 1 for each customer, which is why the number shown in the UI is different from the delivery location unique identifier.

Read-only: true

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

Sortable: false

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all DeliveryLocations

Use this endpoint to retrieve all DeliveryLocations 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.
Use the continuation cursor parameter to set the cursor for retrieval of the next set of data.
Please check the pagination instructions.

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 (DeliveryLocation)

Max number of items returned is 1000.

Filterable: not filterable

Sortable: false

Response samples

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

Create a single DeliveryLocation

Use this endpoint to create a single DeliveryLocation.

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
Request Body schema: application/json
customerNumber
required
integer <int32> [ 1 .. 999999999 ]

The unique number of the customer that the delivery location belongs to.

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

Sortable: true

address
string or null [ 0 .. 255 ] characters

The address of the delivery location, including street and number.

Filterable: not filterable

Sortable: false

city
string or null [ 0 .. 50 ] characters

The city of the delivery location.

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

Sortable: false

country
string or null [ 0 .. 50 ] characters

The country of the delivery location.

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

Sortable: false

eInvoiceId
string or null [ 0 .. 50 ] characters

The delivery location Id used on electronic invoices.
It can be, for example, a store number provided by the customer, i.e. AppleStore 6.

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

Sortable: false

isBarred
boolean

Flag indicating if the delivery location is barred from usage.
The default value is false.

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

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

postalCode
string or null [ 0 .. 15 ] characters

The postal code of the delivery location.

Filterable: not filterable

Sortable: false

termsOfDelivery
string or null [ 0 .. 100 ] characters

Special delivery terms that apply to the delivery location.
For example 'ex factory' or 'to the kerb'

Filterable: not filterable

Sortable: false

Responses

Response Schema: application/json
number
integer <int32>

Filterable: not filterable

Sortable: false

Request samples

Content type
application/json
{
  • "customerNumber": 1
}

Response samples

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

Update a single DeliveryLocation

Use this endpoint to update a single DeliveryLocation.

Authorizations:
(X-AppSecretTokenX-AgreementGrantToken)
Request Body schema: application/json
customerNumber
required
integer <int32> [ 1 .. 999999999 ]

The unique number of the customer that the delivery location belongs to.

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

Sortable: true

address
string or null [ 0 .. 255 ] characters

The address of the delivery location, including street and number.

Filterable: not filterable

Sortable: false

city
string or null [ 0 .. 50 ] characters

The city of the delivery location.

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

Sortable: false

country
string or null [ 0 .. 50 ] characters

The country of the delivery location.

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

Sortable: false

eInvoiceId
string or null [ 0 .. 50 ] characters

The delivery location Id used on electronic invoices.
It can be, for example, a store number provided by the customer, i.e. AppleStore 6.

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

Sortable: false

isBarred
boolean

Flag indicating if the delivery location is barred from usage.
The default value is false.

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

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

postalCode
string or null [ 0 .. 15 ] characters

The postal code of the delivery location.

Filterable: not filterable

Sortable: false

termsOfDelivery
string or null [ 0 .. 100 ] characters

Special delivery terms that apply to the delivery location.
For example 'ex factory' or 'to the kerb'

Filterable: not filterable

Sortable: false

Responses

Request samples

Content type
application/json
{
  • "customerNumber": 1
}

Response samples

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

Retrieve the number of DeliveryLocations

Call this endpoint to get the number of DeliveryLocations. 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

Retrieve single DeliveryLocation

Use this endpoint to load a single DeliveryLocation by number.

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

Responses

Response Schema: application/json
customerNumber
required
integer <int32> [ 1 .. 999999999 ]

The unique number of the customer that the delivery location belongs to.

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

Sortable: true

address
string or null [ 0 .. 255 ] characters

The address of the delivery location, including street and number.

Filterable: not filterable

Sortable: false

city
string or null [ 0 .. 50 ] characters

The city of the delivery location.

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

Sortable: false

country
string or null [ 0 .. 50 ] characters

The country of the delivery location.

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

Sortable: false

eInvoiceId
string or null [ 0 .. 50 ] characters

The delivery location Id used on electronic invoices.
It can be, for example, a store number provided by the customer, i.e. AppleStore 6.

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

Sortable: false

isBarred
boolean

Flag indicating if the delivery location is barred from usage.
The default value is false.

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

Sortable: false

lastUpdated
string <date-time>

The date when the delivery location was last updated.

Read-only: true

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

Sortable: false

number
integer <int32>

The unique number of the delivery location.

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

postalCode
string or null [ 0 .. 15 ] characters

The postal code of the delivery location.

Filterable: not filterable

Sortable: false

termsOfDelivery
string or null [ 0 .. 100 ] characters

Special delivery terms that apply to the delivery location.
For example 'ex factory' or 'to the kerb'

Filterable: not filterable

Sortable: false

userInterfaceNumber
integer <int32>

The delivery location number displayed in the UI.
In the UI, numbering for delivery locations starts from 1 for each customer, which is why the number shown in the UI is different from the delivery location unique identifier.

Read-only: true

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

Sortable: false

Response samples

Content type
application/json
{
  • "number": 0,
  • "customerNumber": 1,
  • "userInterfaceNumber": 0,
  • "address": "string",
  • "city": "string",
  • "country": "string",
  • "postalCode": "string",
  • "termsOfDelivery": "string",
  • "eInvoiceId": "string",
  • "isBarred": true,
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "objectVersion": "string"
}

Delete single DeliveryLocation

Use this endpoint to delete a single DeliveryLocation by number.

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",
  • "traceId": "string",
  • "errorCode": "string",
  • "traceTimeUtc": "string",
  • "errors": [
    ]
}