Firmy

Práca s firmami.

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.

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. Predvolená hodnota je true.
  • 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)
  • 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
}