Dokumentacia / Identifikačné karty klientov

Identifikačné karty klientov

Modul pre evidenciu klientov (odberateľov). Karta klienta obsahuje firemné údaje, kontakty a nastavenia pre fakturáciu.

Zoznam klientov

GET /api/client-identity-card

Oprávnenie: CLIENT_IDENTITY_CARD_LIST

Filtre (query parametre):

Parameter Typ Popis
per_page number Počet záznamov na stránku
page number Číslo stránky
sort_by_column string Stĺpec na triedenie
sort_by_order string Smer: asc alebo desc
search string Vyhľadávanie (názov, IČO, ...)

Vytvorenie karty klienta

POST /api/client-identity-card

Oprávnenie: CLIENT_IDENTITY_CARD_CREATE

Parameter Typ Povinný Popis
name string áno Názov firmy (max. 255 znakov)
address string áno Adresa (max. 255 znakov)
email string (email) áno Hlavný email
ico string áno IČO (presne 8 znakov, unikátne)
dic number áno DIČ (10 číslic, unikátne)
ic_dph string nie IČ DPH (formát: SK1234567890, unikátne)
yearlong_order_number string nie Číslo celoročnej objednávky
yearlong_order_file file nie Súbor celoročnej objednávky
optional_emails array nie Ďalšie emailové adresy
optional_emails.* string (email) áno Email
send_invoices_in_english boolean nie Posielať faktúry v angličtine

Úprava karty klienta

POST /api/client-identity-card/{uuid}/update

Oprávnenie: CLIENT_IDENTITY_CARD_UPDATE

Parametre sú rovnaké ako pri vytvorení (bez ico, to sa nedá meniť), plus:

Parameter Typ Povinný Popis
yearlong_order_file_deleted boolean nie Zmazať existujúci súbor objednávky

Zmazanie karty klienta

DELETE /api/client-identity-card/{uuid}

Oprávnenie: CLIENT_IDENTITY_CARD_DELETE

Overenie IČO

Overenie konkrétneho IČO

POST /api/client-identity-card/ico

Overí IČO voči obchodnému registru a vráti údaje o firme.

Parameter Typ Povinný Popis
ico string áno IČO na overenie (8 číslic)

Návrhy IČO

POST /api/client-identity-card/ico/suggestion

Vráti návrhy IČO na základe čiastočného zadania.

Parameter Typ Povinný Popis
ico string áno Čiastočné IČO (3-8 číslic)

Návrhy podľa názvu firmy

POST /api/client-identity-card/name/suggestion

Vyhľadá firmy podľa názvu.

Parameter Typ Povinný Popis
name string áno Názov firmy (min. 3, max. 255 znakov)

Overenie IČO (globálne)

Rovnaké endpointy sú dostupné aj globálne:

  • POST /api/ico - Overenie IČO
  • POST /api/ico/suggestion - Návrhy IČO
  • POST /api/name/suggestion - Návrhy podľa názvu