v1

latestOpenAPI 3.0.02026-07-1315476656.4 KB

Contact

Retrieve contacts

There are a multitude of parameter which can be used to filter.<br> A few of them are attached but for a complete list please check out <a href='#tag/Contact/How-to-filter-for-certain-contacts'>this</a> list

get/Contact

Query parameters

depth'0' | '1'

Defines if both organizations <b>and</b> persons should be returned.<br> '0' -> only organizations, '1' -> organizations and persons

customerNumberstring

Retrieve all contacts with this customer number

Response

Successful operation

Example response

{
  "objects": [
    {
      "id": "0",
      "objectName": "Contact",
      "name": "string",
      "status": "100",
      "customerNumber": "Customer-1337",
      "parent": {
        "id": "0",
        "objectName": "Contact"
      },
      "surename": "John",
      "familyname": "Snow",
      "titel": "Commander",
      "category": {
        "id": "3",
        "objectName": "Category"
      },
      "description": "Rightful king of the seven kingdoms",
      "sevClient": {
        "objectName": "SevClient"
      },
      "name2": "Targaryen",
      "defaultCashbackTime": "string",
      "defaultCashbackPercent": "string",
      "defaultTimeToPay": "string",
      "taxOffice": "string",
      "exemptVat": "false",
      "defaultDiscountAmount": "string",
      "defaultDiscountPercentage": "false",
      "buyerReference": "string",
      "governmentAgency": "false",
      "additionalInformation": "string"
    }
  ]
}