In our next release, planned for mid-Februay, some amendments will be made to the API. Please be aware that this release will be successively rolled out to our customers during the time span of around two-three weeks. That means that during this transition period, your integrations need to be able to handle both customers that have and do not have these new properties simultaneously.

Labels

Labels are new properties on orders, offers and invoices that can be used to tag them for various reasons. Examples could be custom statuses or any other type of information needed to keep track of certain items. The labels to use must exist in the labels register, in the same manner as for example articles are used today, and are referenced using their IDs.

Affected resources: Order, Offers, Invoices

  • Visible in list-view: No
  • Visible in detailed view: Yes
  • Type: Array
  • Readable: Yes
  • Writable: Yes
  • Searchable: Yes
  • Sortable: No
  • Required: No
  • Default value: None

Example:

[...]
   "Labels": [
      {
          "Id": 3
      },
      {
          "Id": 2
      }
   ],
[...]

New resource: Labels

This register contains all labels to be used in order, offers or invoices and has two properties:

Id

  • Type: Integer
  • Readable: Yes
  • Writable: No
  • Searchable: No
  • Sortable: Yes
  • Required: N/A
  • Default value: Next available number in series

Description

  • Type: String (alpha-numeric, max 25 characters)
  • Readable: Yes
  • Writable: Yes
  • Searchable: No
  • Sortable: Yes
  • Required: Yes
  • Default value: None

Available methods

  • GET
  • POST
  • PUT
  • DELETE

Example:

[...]
{
   "Labels": [
      {
         "Id": 1,
         "Description": "Campaign"
      },
      {
         "Id": 2,
         "Description": "Open"
      },
      {
         "Id": 3,
         "Description": "Closed"
      }
   ]
}
[...]

VAT added in list-view

Affected resource: Articles

The property VAT – that was previously only available in the detailed view – will be added in the list-view as well, reducing the number of requests necessary for certain types of integrations such as POS solutions.

  • Type: Float
  • Readable: Yes
  • Writable: Yes
  • Searchable: No
  • Sortable: No
  • Required: No
  • Default value: VAT percentage from predefined sales account for article

Example:

[...]
    "@url": "https://api.fortnox.se/3/articles/A-1234",
    "ArticleNumber": "A-1234",
    "Description": "Article 1234",
    "DisposableQuantity": "0",
    "EAN": "",
    "Housework": false,
    "PurchasePrice": "0",
    "QuantityInStock": "0",
    "ReservedQuantity": "0",
    "SalesPrice": 10,
    "StockPlace": "",
    "StockValue": "0",
    "Unit": null,
    "VAT": 25,
    "WebshopArticle": false
[...]

Quantities

Affected resources: Vouchers, Accounts

Last October, some API changes were implemented that at the time weren’t of any practical use for the majority of our customers, as the corresponding functionality in the client (frontend) was then only made available to selected pilot customers. Now however, this functionality will become generally available for all customers.

There are no new API changes related to this in the upcoming release, but the earlier added fields will now be possible to actually make use of, and might start to contain actual data if the functionality is used.