Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Supplier

List suppliers

Lists existing suppliers

get/api/v1/suppliers

Query parameters

OR
{
  "id": [
    "17"
  ]
}
numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

field'id' | 'name' | 'number' | 'country' | 'zip' | 'city' | 'project' | 'projectName' | 'telephone' | 'fax' | 'mobile' | 'email' | 'addressNote' | 'department' | 'subdivision' | 'vatNumber' | 'taxNumber' | 'gln' | 'tag' | 'tagName'
dir'asc' | 'desc'

Response

Supplier list.

Example response

{
  "data": [
    {
      "id": "17",
      "type": "Regular supplier",
      "project": {
        "id": "1337",
        "name": "Diamond"
      },
      "general": {
        "number": "123456789",
        "fax": null,
        "mobile": "987654321",
        "department": "Sales",
        "subdivision": "North Region",
        "vatNumber": "VAT123456",
        "taxNumber": null,
        "gln": "GLN123456789",
        "employeeNumber": "EMP001",
        "honorific": "Mr.",
        "title": "Sales Manager",
        "name": "John Doe",
        "birthday": null,
        "tags": [
          {
            "id": "tag1",
            "name": "Active",
            "color": "ff0000"
          },
          {
            "id": "tag2",
            "name": "Active",
            "color": "ff0000"
          }
        ],
        "supplierNumber": "SUP123456",
        "phone": null,
        "email": "johndoe@example.com",
        "address": {
          "street": "Hauptstraße 15",
          "zip": "10115",
          "city": "Berlin",
          "state": null,
          "country": "DE",
          "note": "Hauptsitz"
        }
      },
      "tags": [
        {
          "color": "ff0000"
        }
      ],
      "freeFields": [
        {
          "id": "17"
        }
      ]
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}