Firmy

Obsah

Zoznam firiem #

Rozhranie dodáva zoznam firiem.

• URL: GET /interface/{db}/eshop/v1/firmy/zoznam
• Status: implementované
• Bearer: áno

Parametre:

• id=X (voliteľný) - Dodá informáciu o konkrétnej firme.
• nazov=X (voliteľný) - Dodá informáciu o konkrétnej firme. Hľadá sa podreťazec v názve firmy.
• ico=X (voliteľný) - Dodá informáciu o konkrétnej firme. Hľadá sa celý reťazec v IČO firmy.

Zoznam firiem V2 #

Rozhranie dodáva komplexnejší zoznam firiem vrátane priradených kategórií (kategoria) a ďalších kontaktných údajov.

• URL: GET /interface/{db}/eshop/v2/firmy/zoznam
• Status: implementované
• Bearer: áno

Parametre:

• id=X (voliteľný) - Dodá informáciu o konkrétnej firme podľa ID.
• nazov=X (voliteľný) - Hľadá sa podreťazec v názve firmy.
• ico=X (voliteľný) - Hľadá sa celý reťazec v IČO firmy.
• kategoria_id=X alebo kategoria=X (voliteľný) - Vyfiltruje firmy priradené k danej kategórii.
• offset=X (voliteľný) - Od ktorého záznamu sa majú dáta vrátiť (predvolené 0).
• limit=X (voliteľný) - Počet vrátených záznamov (predvolené 100, maximum 1000).

Vrátené stĺpce #

• firma_id (int) - Identifikátor firmy.
• nazov (varchar) - Názov firmy.
• ulica (varchar) - Ulica.
• mesto (varchar) - Mesto.
• psc (varchar) - PSČ.
• stat (varchar) - Štát.
• ico (varchar) - IČO.
• dic (varchar) - DIČ.
• icdph (varchar) - IČ DPH.
• iban (varchar) - IBAN.
• swift (varchar) - SWIFT kód.
• setdph (boolean) - Platiteľ DPH.
• email (varchar) - E-mailová adresa.
• tel (varchar) - Telefónne číslo.
• mobil (varchar) - Mobilné číslo.
• kategoria (array[int]) - Pole ID kategórií priradených k firme (z tabuľky firmy_kategorie).

Príklad odpovede #

{
  "items": [
    {
      "firma_id": 123,
      "nazov": "Moja Firma s.r.o.",
      "ulica": "Hlavná 1",
      "mesto": "Banská Bystrica",
      "psc": "97401",
      "stat": "Slovensko",
      "ico": "12345678",
      "dic": "2020123456",
      "icdph": "SK2020123456",
      "iban": "SK1200000000001234567890",
      "swift": "TATRSKBF",
      "setdph": true,
      "email": "firma@example.com",
      "tel": "048/123456",
      "mobil": "0901234567",
      "Row#": "1",
      "kategoria": [1, 2]
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 100
  }
}

Pridanie novej firmy #

Rozhranie vytvorí novú firmu.

• URL: POST /interface/{db}/eshop/v1/firmy/vytvor
• Status: implementované
• Bearer: áno

Limity na zasielané parametre:

• nazov(255) - Nesmie mať nulovú dĺžku.
• ulica(50)
• mesto(60)
• psc(10)
• stat(30) - Názov štátu. Predvolená hodnota je Slovensko.
• ico(20) - Ak sa zadá, overí sa existencia firmy s týmto IČO. Ak existuje, firma sa nevytvorí.
• dic(17)
• dph(20) alebo icdph(20) - ak sa zadá icdph, automaticky sa premenuje na dph
• iban(29)
• swift(11)
• setdph(boolean) - ak je true, firme sa nastaví dph. To znamená, že firma je platiteľom DPH. Predvolená hodnota je true. Ak nastavíte hodnotu na false, firme sa automaticky vypne dph.
• email(100)
• tel(30) alebo tel1(30) - ak sa zadá tel1, automaticky sa premenuje na tel
• mobil(30)

Príklad požiadavky #

{
  "nazov": "Moja Firma s.r.o.",
  "ulica": "Hlavná 1",
  "mesto": "Banská Bystrica",
  "psc": "97401",
  "ico": "12345678",
  "dic": "2020123456",
  "icdph": "SK2020123456",
  "iban": "SK1200000000001234567890",
  "swift": "TATRSKBF",
  "setdph": true,
  "email": "[EMAIL_ADDRESS]",
  "tel": "123456789"
}

Príklad odpovede #

{
  "id": 123
}

Aktualizácia firmy #

Rozhranie aktualizuje existujúcu firmu. Identifikácia firmy prebieha pomocou parametra ico alebo firma_id.

• URL: POST /interface/{db}/eshop/v1/firmy/aktualizuj
• Status: implementované
• Bearer: áno

Identifikačné parametre (povinný aspoň jeden z nich):

• firma_id - Explicitné ID firmy.
• ico - IČO firmy (podľa neho sa dohľadá firma_id).

Limity na zasielané parametre na aktualizáciu sú zhodné s vytváraním firmy. Ak sa nejaký parameter neuvedie, jeho hodnota sa v databáze nemení. Zoznam parametrov:

• nazov(255)
• ulica(50)
• mesto(60)
• psc(10)
• stat(30)
• ico(20)
• dic(17)
• dph(20) alebo icdph(20)
• iban(29)
• swift(11)
• setdph(boolean) - ak je true, firma je platiteľom DPH. Ak je false, firma nie je platiteľom DPH.
• email(100)
• tel1(30) alebo tel(30)
• mobil(30)

Príklad požiadavky #

Identifikácia pomocou IČO a zmena názvu:

{
  "ico": "12345678",
  "nazov": "Môj Nový Názov Firmy s.r.o."
}

Identifikácia pomocou ID a zmena mesta:

{
  "firma_id": 123,
  "mesto": "Zvolen"
}

Príklad odpovede #

{
  "id": 123
}

Pridanie novej firmy V2 #

Rozhranie vytvorí novú firmu vrátane priradenia kategórií.

• URL: POST /interface/{db}/eshop/v2/firmy/vytvor
• Status: implementované
• Bearer: áno

Limity na zasielané parametre:

• nazov(255) - Nesmie mať nulovú dĺžku.
• ulica(50)
• mesto(60)
• psc(10)
• stat(30) - Názov štátu. Predvolená hodnota je Slovensko.
• ico(20) - Ak sa zadá, overí sa existencia firmy s týmto IČO. Ak existuje, firma sa nevytvorí.
• dic(17)
• dph(20) alebo icdph(20) - ak sa zadá icdph, automaticky sa premenuje na dph
• iban(29)
• swift(11)
• setdph(boolean) - ak je true, firme sa nastaví dph. To znamená, že firma je platiteľom DPH. Predvolená hodnota je true. Ak nastavíte hodnotu na false, firme sa automaticky vypne dph.
• email(100)
• tel(30) alebo tel1(30) - ak sa zadá tel1, automaticky sa premenuje na tel
• mobil(30)
• kategoria(array[int] alebo int) - Pole ID kategórií priradených k firme (napr. [1, 2]).

Príklad požiadavky #

{
  "nazov": "Moja Firma s.r.o.",
  "ulica": "Hlavná 1",
  "mesto": "Banská Bystrica",
  "psc": "97401",
  "ico": "12345678",
  "dic": "2020123456",
  "icdph": "SK2020123456",
  "iban": "SK1200000000001234567890",
  "swift": "TATRSKBF",
  "setdph": true,
  "email": "firma@example.com",
  "tel": "048/123456",
  "kategoria": [1, 2]
}

Príklad odpovede #

{
  "id": 123
}

Aktualizácia firmy V2 #

Rozhranie aktualizuje existujúcu firmu vrátane nastavenia kategórií. Identifikácia firmy prebieha pomocou parametra ico alebo firma_id.

• URL: POST /interface/{db}/eshop/v2/firmy/aktualizuj
• Status: implementované
• Bearer: áno

Identifikačné parametre (povinný aspoň jeden z nich):

• firma_id - Explicitné ID firmy.
• ico - IČO firmy (podľa neho sa dohľadá firma_id).

Zoznam voliteľných parametrov:

• nazov(255)
• ulica(50)
• mesto(60)
• psc(10)
• stat(30)
• ico(20)
• dic(17)
• dph(20) alebo icdph(20)
• iban(29)
• swift(11)
• setdph(boolean) - ak je true, firma je platiteľom DPH. Ak je false, firma nie je platiteľom DPH.
• email(100)
• tel1(30) alebo tel(30)
• mobil(30)
• kategoria(array[int] alebo int) - Nové pole ID kategórií priradených k firme. Ak sa pošle prázdne pole [], kategórie firmy sa vymažú. Ak sa parameter neuvedie, existujúce kategórie firmy sa nemenia.

Príklad požiadavky #

Zmena názvu a nastavenie kategórií:

{
  "firma_id": 123,
  "nazov": "Môj Nový Názov Firmy s.r.o.",
  "kategoria": [2, 4]
}

Príklad odpovede #

{
  "id": 123
}

Číselník kategórií firiem #

Rozhranie dodáva číselník kategórií (tabuľka kategorie).

• URL: GET /interface/{db}/eshop/v1/firmy/kategorie/zoznam (alebo alias GET /interface/{db}/eshop/v1/firmy/kategorie)
• Status: implementované
• Bearer: áno

Parametre:

• id=X (voliteľný) - Dodá informáciu o konkrétnej kategórii podľa ID (kategoria_id).
• nazov=X (voliteľný) - Vyhľadávanie podľa podreťazca v názve kategórie.
• show_firma=1 / true (voliteľný) - Filtrovanie kategórií určených pre firmy (1 alebo 0).
• show_osoba=1 / true (voliteľný) - Filtrovanie kategórií určených pre osoby (1 alebo 0).
• offset=X (voliteľný) - Od ktorého záznamu sa majú dáta vrátiť (predvolené 0).
• limit=X (voliteľný) - Počet vrátených záznamov (predvolené 100, maximum 1000).

Vrátené stĺpce #

• kategoria_id (int) - Jedinečný identifikátor kategórie.
• nazov (varchar) - Názov kategórie.
• show_firma (boolean) - Príznak zobrazenia pre firmy.
• show_osoba (boolean) - Príznak zobrazenia pre osoby.
• cforeground (int) - Farba popredia.
• cbackground (int) - Farba pozadia.
• shortcut (varchar) - Skratka kategórie.
• hlasenie (varchar) - Hlásenie / upozornenie pri výbere kategórie.

Príklad odpovede #

{
  "items": [
    {
      "kategoria_id": 1,
      "nazov": "Dodávatelia",
      "show_firma": true,
      "show_osoba": true,
      "cforeground": null,
      "cbackground": null,
      "shortcut": null,
      "hlasenie": null,
      "Row#": "1"
    },
    {
      "kategoria_id": 2,
      "nazov": "Odberatelia",
      "show_firma": true,
      "show_osoba": true,
      "cforeground": null,
      "cbackground": null,
      "shortcut": null,
      "hlasenie": null,
      "Row#": "2"
    }
  ],
  "paging": {
    "offset": 0,
    "limit": 100
  }
}