Kunde v2 /api/v2/:principal_slug/business/partner/clients

Überblick

Klasse / Datentyp
Kunde
Response Formats
JSON
API Version
v2
Öffentlich erreichbar
false
HTTP Methode
GET
Zuletzt aktualisiert

Parameter

Query Parameter

Schlüssel
business_clients optional

Geschäftskunden

inactive optional

Inaktivie Kunden

private_clients optional

Privatkunden

regular optional

Reguläre Kunden Auf diese Kunden kann bspw. rapportiert werden

webshop optional

Webshop Kunden

workshop optional

Workshop Kunden

principal_slug Pflicht

Backend::Principal Slug / ID

page optional

Seite Definition der darzustellenden Seite. Standardwert: 1

per optional

Anzahl Datensätze pro Seite Definition der darzustellenden Datensätze pro Seite.

account_id optional

Business::Account ID

classification_id optional

Business::Partner::ClientClassification ID

payment_term_id optional

Business::Order::PaymentTerm ID

tax_type_id optional

Business::Partner::TaxType ID

backend_application_id optional

Backend::Application ID

Beispiel Rückgabe

{
  "data" : [
    {
      "id"             : "54e8becf6f7269239a440000",
      "name"           : "4Car",
      "email"          : "XXXXXXXXX",
      "resource_class" : "Business::Partner::Client::BusinessClient",
      "classification" : {
        "id"     : "54fdc4666f726947ac5f0000",
        "label"  : "Schweiz",
        "number" : 6120,
        "path"   : "1.60.6120"
      }
    },
    {
      "id"             : "55d480c96f72695a8f020000",
      "name"           : "AB Photography",
      "email"          : "XXXXXXXXX",
      "resource_class" : "Business::Partner::Client::BusinessClient",
      "classification" : {
        "id"     : "54fdc4666f726947ac5f0000",
        "label"  : "Schweiz",
        "number" : 6120,
        "path"   : "1.60.6120"
      }
    },
    {
      "id"             : "55bf25566f7269079a100000",
      "name"           : "ACTIV FITNESS Altstetten",
      "email"          : "",
      "resource_class" : "Business::Partner::Client::BusinessClient",
      "classification" : {
        "id"     : "54fdc4666f726947ac5f0000",
        "label"  : "Schweiz",
        "number" : 6120,
        "path"   : "1.60.6120"
      }
    }
  ],
  "meta" : {
    "resource_class" : "Business::Partner::Client",
    "max_updated_at" : "2016-11-10T21:59:33.193Z",
    "page"           : 1,
    "per"            : 3,
    "total_pages"    : 58,
    "total_count"    : 173
  }
}