Fakturačné adresy

Prostredníctvom služby Swiftyper Business API je možné vyhľadať právnické osoby a SZČO viacerými spôsobmi - prostredníctvom identifikačného čísla organizácie a na základe názvu právnickej osoby prípadne SZČO.

Definícia modelu

Atribúty

  • Name
    business_id
    Type
    string
    Description

    Unikátny identifikátor subjektu.

  • Name
    highlight
    Type
    string
    Description

    Zvýraznená časť zhodná s dopytom vyhľadávania.

  • Name
    name
    Type
    string
    Description

    Názov subjektu.

  • Name
    established_on
    Type
    string
    Description

    Dátum vzniku.

  • Name
    terminated_on
    Type
    string
    Description

    Dátum zániku.

  • Name
    cin
    Type
    string
    Description

    Identifikačné číslo organizácie (IČO).

  • Name
    tin
    Type
    string
    Description

    Daňové identifikačné číslo (DIČ).

  • Name
    vatin
    Type
    string
    Description

    Identifikačné číslo pre daň z pridanej hodnoty (IČ DPH).

  • Name
    formatted_address
    Type
    string
    Description

    Naformátovaná adresa.

  • Name
    street
    Type
    string
    Description

    Názov ulice.

  • Name
    formatted_street
    Type
    string
    Description

    Naformátovaná ulica.

  • Name
    street_number
    Type
    string
    Description

    Súpisné číslo.

  • Name
    building_number
    Type
    string
    Description

    Orientačné číslo.

  • Name
    formatted_number
    Type
    string
    Description

    Naformátované číslo ulice.

  • Name
    postal_code
    Type
    string
    Description

    PSČ.

  • Name
    municipality
    Type
    string
    Description

    Názov obce.

  • Name
    legal_form
    Type
    string
    Description

    Názov právnej formy.

  • Name
    segment
    Type
    string
    Description

    Odvetvie.

  • Name
    organization_size
    Type
    string
    Description

    Veľkosť organizácie.

  • Name
    object
    Type
    string
    Description

    Typ objektu, vždy bude business.

  • Name
    formatted_country
    Type
    string
    Description

    Názov krajiny.

  • Name
    country
    Type
    string
    Description

    Kód krajiny (dvojmiestny alfabetický kód ISO 3166).

POST/v1/business/query

Vyhľadanie subjektu

Vyhľadanie kontaktných a fakturačných údajov o právnických osobách a SZČO na základe názvu právnickej osoby prípadne SZČO.

Povinné parametre

  • Name
    query
    Type
    string
    Description

    Výraz vyhľadávania.

  • Name
    api_key
    Type
    string
    Description

    Prístupový API kľúč môžete použiť ako parameter api_key alebo v hlavičke požiadavky X-Swiftyper-API-Key.

Parametre

  • Name
    active
    Type
    string
    Description

    Filtrovanie existujúcich (nezaniknutých) subjektov. Predvolene sa zobrazujú všetky subjekty.

  • Name
    country
    Type
    string · obsahuje kód dostupnej krajiny
    Description

    Krajiny v ktorých sa adresa bude vyhľadávať.

  • Name
    limit
    Type
    string
    Description

    Počet zobrazených výsledkov. Hodnota môže byť v rozmedzí 1 až 20. Predvolená hodnota je 7 výsledkov.

Výstup

Výstupom je množina údajov reprezentujúca objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba. Bežným zdrojom chýb je nezadanie API kľúču, alebo presiahnutie mesačného limitu na vyhľadávanie.

Požiadavka

curl -X POST https://api.swiftyper.sk/v1/business/query \
   -H 'X-Swiftyper-API-Key: v6S9BbdkN817Rvaw15RLsaVo7bZCBNH63wgPgTcqaxO9' \
   -d query=Alza.cz \
   -d country=CZ

Odpoveď

[
    {
        "business_id": "cz_Rif84y2TQtAubtFdgaUDNA",
        "highlight": "<em>Alza.cz</em> a.s.",
        "name": "Alza.cz a.s.",
        "established_on": "2003-08-26",
        "terminated_on": null,
        "cin": "27082440",
        "tin": null,
        "vatin": "CZ27082440",
        "formatted_address": "Jankovcova 1522, 17000 Praha, Česká republika",
        "street_number": null,
        "building_number": "1522",
        "street": "Jankovcova",
        "formatted_street": "Jankovcova 1522",
        "postal_code": "17000",
        "municipality": "Praha",
        "legal_form": "Akciová společnost",
        "segment": "",
        "organization_size": "2000 - 2499 zaměstnanců",
        "object": "business",
        "formatted_country": "Česká republika",
        "country": "CZ"
    }
]
POST/v1/business/identifier

Vyhľadanie podľa IČO

Vyhľadanie kontaktných a fakturačných údajov o právnických osobách a SZČO na základe identifikačného čísla organizácie.

Povinné parametre

  • Name
    query
    Type
    string
    Description

    Výraz vyhľadávania.

  • Name
    api_key
    Type
    string
    Description

    Prístupový API kľúč môžete použiť ako parameter api_key alebo v hlavičke požiadavky X-Swiftyper-API-Key.

Parametre

  • Name
    active
    Type
    string
    Description

    Filtrovanie existujúcich (nezaniknutých) subjektov. Predvolene sa zobrazujú všetky subjekty.

  • Name
    country
    Type
    string · obsahuje kód dostupnej krajiny
    Description

    Krajiny v ktorých sa adresa bude vyhľadávať.

  • Name
    limit
    Type
    string
    Description

    Počet zobrazených výsledkov. Hodnota môže byť v rozmedzí 1 až 20. Predvolená hodnota je 7 výsledkov.

Výstup

Výstupom je množina údajov reprezentujúca objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba. Bežným zdrojom chýb je nezadanie API kľúču, alebo presiahnutie mesačného limitu na vyhľadávanie.

Požiadavka

curl -X POST https://api.swiftyper.sk/v1/business/identifier \
   -H 'X-Swiftyper-API-Key: v6S9BbdkN817Rvaw15RLsaVo7bZCBNH63wgPgTcqaxO9' \
   -d query=51251761 \
   -d country=SK

Odpoveď

[
    {
        "business_id": "sk_GPAyoJMt_qOd8EJAsqX7og",
        "highlight": "Ringier Axel Springer SK, a.s.",
        "name": "Ringier Axel Springer SK, a.s.",
        "established_on": "2017-12-01",
        "terminated_on": null,
        "cin": "51251761",
        "tin": "2120650609",
        "vatin": "SK2120650609",
        "formatted_address": "Prievozská 14, 821 09 Bratislava - mestská časť Ružinov, Slovenská republika",
        "street_number": null,
        "building_number": "14",
        "street": "Prievozská",
        "formatted_street": "Prievozská 14",
        "postal_code": "821 09",
        "municipality": "Bratislava - mestská časť Ružinov",
        "legal_form": "Akciová spoločnosť",
        "segment": "Média, vydavateľstvá a kultúra",
        "organization_size": "150-199 zamestnancov",
        "object": "business",
        "formatted_country": "Slovenská republika",
        "country": "SK"
    }
]
POST/v1/business/{business_id}

Detail subjektu

Načítanie podrobností právnickej osoby a SZČO na základe identifikátora subjektu.

Povinné parametre

  • Name
    query
    Type
    string
    Description

    Výraz vyhľadávania.

  • Name
    api_key
    Type
    string
    Description

    Prístupový API kľúč môžete použiť ako parameter api_key alebo v hlavičke požiadavky X-Swiftyper-API-Key.

Parametre

  • Name
    postal_code
    Type
    string
    Description

    Výraz na upresnenie poštového smerovacieho čísla.

  • Name
    context
    Type
    string[]
    Description

    Nastavenie oblastí pre vyhľadávanie (kľúč place_id). Výsledky vyhľadávania môžete odfiltrovať pre konkrétny kraj, okres alebo obec.

  • Name
    contextType
    Type
    string
    Description

    Nastavenie typu vyhľadávacieho kontextu. Použite strict ak chcete vyhľadávať adresu s ďalšími zadanými parametrami (postal_code) alebo preference pokiaľ chcete adresy zo zadaného miesta uprednostniť.

  • Name
    around_latlng
    Type
    string
    Description

    Prispôsobenie výsledkov vyhľadávania zadanej lokalite vo formáte latitude,longitude napr. 49.1992988,18.8211994.

  • Name
    around_latlng_via_ip
    Type
    string
    Description

    Prispôsobenie výsledkov vyhľadávania aktuálnej lokalite používateľa.

  • Name
    country
    Type
    string · obsahuje kód dostupnej krajiny
    Description

    Krajiny v ktorých sa obec bude vyhľadávať.

  • Name
    limit
    Type
    string
    Description

    Počet zobrazených výsledkov. Hodnota môže byť v rozmedzí 1 až 20. Predvolená hodnota je 7 výsledkov.

Výstup

Výstupom je množina údajov reprezentujúca objekt s popísanými atribútmi. V prípade chyby alebo nesprávnosti parametrov sa zobrazí chyba. Bežným zdrojom chýb je nezadanie API kľúču, alebo presiahnutie mesačného limitu na vyhľadávanie.

Požiadavka

curl -X POST https://api.swiftyper.sk/v1/business/sk_o4kAaWja_nJrxO49lQB4qg \
   -H 'X-Swiftyper-API-Key: v6S9BbdkN817Rvaw15RLsaVo7bZCBNH63wgPgTcqaxO9'

Odpoveď

[
    {
        "business_id": "sk_GPAyoJMt_qOd8EJAsqX7og",
        "highlight": "Ringier Axel Springer SK, a.s.",
        "name": "Ringier Axel Springer SK, a.s.",
        "established_on": "2017-12-01",
        "terminated_on": null,
        "cin": "51251761",
        "tin": "2120650609",
        "vatin": "SK2120650609",
        "formatted_address": "Prievozská 14, 821 09 Bratislava - mestská časť Ružinov, Slovenská republika",
        "street_number": null,
        "building_number": "14",
        "street": "Prievozská",
        "formatted_street": "Prievozská 14",
        "postal_code": "821 09",
        "municipality": "Bratislava - mestská časť Ružinov",
        "legal_form": "Akciová spoločnosť",
        "segment": "Média, vydavateľstvá a kultúra",
        "organization_size": "150-199 zamestnancov",
        "object": "business",
        "formatted_country": "Slovenská republika",
        "country": "SK"
    }
]