CustomerCollection

Stránkovaný seznam zákazníků.

_links objectpovinné

HAL odkaz na samotný zdroj.

self objectpovinné

hrefstringpovinné

Cesta ke zdroji včetně prefixu verze API, například /1.3/{zdroj}/{id}.

pageCountinteger

Celkový počet stránek.

např. 22

pageinteger

Číslo aktuální stránky.

např. 1

pageSizeinteger

Počet záznamů na stránce.

např. 50

_embedded object

customer object[]

Pole zákazníků.

Array [

_links object

HAL odkaz na samotný zdroj.

self objectpovinné

hrefstringpovinné

Cesta ke zdroji včetně prefixu verze API, například /1.3/{zdroj}/{id}.

idintegerpovinné

ID zákazníka.

namestringpovinnémax. délka 100

Jméno nebo název zákazníka.

např. Jan Novák

comidstringmax. délka 20

IČO.

např. 12345679

emailstringmax. délka 100

E-mail.

např. novak.jan@example.org

phonestringmax. délka 20

Telefon.

např. +420123123123

cellphonestringmax. délka 20

Mobil.

např. +420123123123

customer_group_idinteger

ID skupiny zákazníků.

external_codestringmax. délka 50

Vlastní identifikátor zákazníka v cizím systému.

např. CC123

vat_payerbooleanpovinné

Zákazník je plátce DPH.

vatidstringmax. délka 20

DIČ. Vyplňuje se u plátce DPH.

např. CZ12345679

]

CustomerCollection

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "pageCount": 22,
  "page": 1,
  "pageSize": 50,
  "_embedded": {
    "customer": [
      {
        "_links": {
          "self": {
            "href": "string"
          }
        },
        "id": 123,
        "name": "Jan Novák",
        "comid": "12345679",
        "email": "novak.jan@example.org",
        "phone": "+420123123123",
        "cellphone": "+420123123123",
        "customer_group_id": 78,
        "external_code": "CC123",
        "vat_payer": false,
        "vatid": "CZ12345679"
      }
    ]
  }
}