Article File Connections

Table of content

GET

Description

Retrieves a list of article file connections or a single article file connection.

URL structure

https://api.fortnox.se/3/articlefileconnections/{FileId}

Method

GET

Version

3

Response

The article file connections register can return a list of records or a single record. By specifying a FileId in the URL, a single record will be returned. Not specifying a FileId will return a list of records.

<?xml version="1.0" encoding="UTF-8"?>
<ArticleFileConnections TotalResources="3" TotalPages="1" CurrentPage="1">
  <ArticleFileConnectionSubset url="https://api.fortnox.se/3/articlefileconnections/70309094-9176-45b8-9eb7-881cca53b266">
    <FileId>70309094-9176-45b8-9eb7-881cca53b266</FileId>
    <ArticleNumber>1</ArticleNumber>
  </ArticleFileConnectionSubset>

  [...]

  <ArticleFileConnectionSubset url="https://api.fortnox.se/3/articlefileconnections/b4f6d500-fb23-4066-a7b9-ee3489e770b8">
    <FileId>b4f6d500-fb23-4066-a7b9-ee3489e770b8</FileId>
    <ArticleNumber>201</ArticleNumber>
  </ArticleFileConnectionSubset>
</ArticleFileConnections>
<?xml version="1.0" encoding="UTF-8"?>
<ArticleFileConnection url="https://api.fortnox.se/3/articlefileconnections/70309094-9176-45b8-9eb7-881cca53b266">
  <FileId>70309094-9176-45b8-9eb7-881cca53b266</FileId>
  <ArticleNumber>1</ArticleNumber>
</ArticleFileConnection>
{
  "MetaInformation": {
    "@TotalResources": 3,
    "@TotalPages": 1,
    "@CurrentPage": 1
  },
  "ArticleFileConnections": [
    {
      "@url": "https://api.fortnox.se/3/articlefileconnections/70309094-9176-45b8-9eb7-881cca53b266",
      "FileId": "70309094-9176-45b8-9eb7-881cca53b266",
      "ArticleNumber": "1"
    },

    [...]

    {
      "@url": "https://api.fortnox.se/3/articlefileconnections/b4f6d500-fb23-4066-a7b9-ee3489e770b8",
      "FileId": "b4f6d500-fb23-4066-a7b9-ee3489e770b8",
      "ArticleNumber": "201"
    }
  ]
}
{
  "ArticleFileConnection": {
    "@url": "https://api.fortnox.se/3/articlefileconnections/70309094-9176-45b8-9eb7-881cca53b266",
    "FileId": "70309094-9176-45b8-9eb7-881cca53b266",
    "ArticleNumber": "1"
  }
}

POST

Description

Creates an article file connection.

URL structure

https://api.fortnox.se/3/articlefileconnections

Method

POST

Version

3

Request

The request body should contain a structure of a article file connection, either in JSON or XML.

<?xml version="1.0" encoding="UTF-8"?>
<ArticleFileConnection>
  <FileId>12158ab8-391f-4a03-8a49-e923dd5b7364</FileId>
  <ArticleNumber>1</ArticleNumber>
</ArticleFileConnection>
{
  "ArticleFileConnection": {
    "FileId": "12158ab8-391f-4a03-8a49-e923dd5b7364",
    "ArticleNumber": "1"
  }
}

Response

The response should contain the created article file connection, in either JSON or XML.

<?xml version="1.0" encoding="UTF-8"?>
<ArticleFileConnection url="https://api.fortnox.se/3/articlefileconnections/12158ab8-391f-4a03-8a49-e923dd5b7364">
  <FileId>12158ab8-391f-4a03-8a49-e923dd5b7364</FileId>
  <ArticleNumber>1</ArticleNumber>
</ArticleFileConnection>
{
  "ArticleFileConnection": {
    "@url": "https://api.fortnox.se/3/articlefileconnections/12158ab8-391f-4a03-8a49-e923dd5b7364",
    "FileId": "12158ab8-391f-4a03-8a49-e923dd5b7364",
    "ArticleNumber": "1"
  }
}

DELETE

Description

Removes an article file connection.

URL structure

https://api.fortnox.se/3/articlefileconnections/{FileId}

Method

DELETE

Version

3

Request

The request body should be empty.

Response

The response body should be empty.

Fields

Field Description Limits Type Searchable Sortable Required R/W
Url Direct URL to the record – String – – – R
FileId Id of the file – String – – Yes R/W
ArticleNumber Article number – String Yes – Yes R/W