Sign in

v1

latestOpenAPI 3.0.32026-07-268955212.1 KB
suppliers

[Preview] Get suppliers

Get all suppliers for the company. Use the query parameters to filter and navigate through the results.

Scope: suppliers:read

get/companies/{companyId}/suppliers

Query parameters

pageinteger

Page number

pageSizeinteger

Number of items per page

querystring

Optional query to filter the data set with supported fields listed below and available operations.

FieldType
namestring
vatNumberstring
orgNumberstring

Response

Suppliers found

totalItemsinteger
totalPagesinteger
currentPageinteger

Example response

{
  "totalItems": 1,
  "totalPages": 1,
  "currentPage": 1,
  "items": [
    {
      "id": "12345678-abcd-1234-abcd-1234567890ab",
      "name": "Example Supplier",
      "orgNumber": "556677-8899",
      "vatNumber": "SE123456789001",
      "currency": "SEK",
      "address": {
        "line1": "Älvsborgsvägen 10",
        "line2": "c/o Test",
        "city": "Gothenburg",
        "postalCode": "123 45",
        "country": "SE"
      },
      "paymentDetails": {
        "type": "bankgiro",
        "bankgiroNumber": "1234-5678"
      }
    }
  ]
}