API


getCompany($id)
Funkcia vrati detaily o partnerovi.

Parameters:
  • id - ID partnera

Returns:
  • not_exists - partner neexistuje
  • ok - data structure:
    • count - number of all items
    • data - array of items:
      • id - item ID
      • personType - typ osoby, hodnoty:
        • 1 - fyzicka osoba
        • 2 - fyzicka osoba podnikatel
        • 3 - pravnicka osoba
        • 4 - pravnicka osoba (ina)
      • email - e-mailova adresa
      • invoiceVat - oslobodenie od DPH, hodnoty:
        • 0 - neoslobodeny (fakturovat DPH)
        • 1 - oslobodeny (nefakturovat DPH)
      • name - meno / obchodne meno
      • firstname - meno kontaktnej osoby
      • lastname - priezvisko kontaktnej osoby
      • street - ulica
      • city - mesto
      • zip - PSC
      • country - ISO kod statu
      • cid - ICO
      • tid - DIC
      • vid - IC DPH
      • namePost - meno (posta)
      • streetPost - ulica (posta)
      • cityPost - mesto (pocta)
      • zipPost - PSC (posta)
      • countryPost - ISO kod statu (posta)
getDocument($gid)
Funkcia vrati detaily o dokumente.

Parameters:
  • gid - GID dokumentu

Returns:
  • not_exists - dokument neexistuje
  • ok - data structure:
    • gid - ID dokumentu
    • id - cislo dokumentu
    • fkType - typ dokumentu, hodnoty:
      • 1 - faktura
      • 2 - vyzva k platbe
      • 3 - dobropis
    • fkDocumentGid - ID nadradeneho dokumentu
    • fkDocumentId - cislo nadradeneho dokumentu
    • fkCurrency - mena
    • fkLanguage - jazyk
    • issueDate - datum vystavenia, format YYYY-MM-DD
    • deliveryDate - datum dodania, format YYYY-MM-DD
    • invoiceVat -
    • advancePayment -
    • maturityDays - splatnost (pocet dni)
    • prepaid -
    • ready -
    • generated -
    • keyhash - keyhash
    • paid - stav dokumentu, hodnoty:
      • -1 - stornovany
      • 0 - neuhradeny
      • 1 - uhradeny
    • fkCompany - ID partnera (odberatel)
    • name - meno (odberatel)
    • street - ulica (odberatel)
    • city - mesto (odberatel)
    • zip - PSC (odberatel)
    • country - ISO kod statu (odberatel)
    • cid - ICO (odberatel)
    • tid - DIC (odberatel)
    • vid - IC DPH (odberatel)
    • fkCompanyFrom - ID partnera (dodavatel)
    • companyFromName - meno (dodavatel)
    • companyFromStreet - ulica (dodavatel)
    • companyFromCity - mesto (dodavatel)
    • companyFromZip - PSC (dodavatel)
    • companyFromCountry - ISO kod statu (dodavatel)
    • companyFromCid - ICO (dodavatel)
    • companyFromTid - DIC (dodavatel)
    • companyFromVid - IC DPH (dodavatel)
    • totalVat - celkova suma vratane DPH (oslobodenie od DPH sa berie do uvahy)
    • items - array of items:
      • label - popis
      • unit - jednotka
      • unitPrice - cena za kus
      • unitCount - pocet kusov
      • vat - DPH v %
listCompanies($pagingOffset, $pagingCount, $filName=null, $filFirstname=null, $filLastname=null, $filStreet=null, $filCity=null, $filZip=null, $filCountry=null, $filEmail=null, $filCid=null, $filTid=null, $filVid=null, $filInvoiceVat=null, $filNamePost=null, $filStreetPost=null, $filCityPost=null, $filZipPost=null, $filCountryPost=null)
Zoznam partnerov.

Parameters:
  • pagingOffset - paging, offset
  • pagingCount - paging, number of items
  • filName - filtrovanie podla mena
  • filFirstname - filtrovanie podla mena kontaktnej osoby
  • filLastname - filtrovanie podla priezviska kontaktnej osoby
  • filStreet - filtrovanie podla ulice
  • filCity - filtrovanie podla mesta
  • filZip - filtrovanie podla PSC
  • filCountry - filtrovanie podla ISO kodu statu
  • filEmail - filtrovanie podla e-mailu
  • filCid - filtrovanie podla ICO
  • filTid - filtrovanie podla DIC
  • filVid - filtrovanie podla IC DPH
  • filInvoiceVat - filtrovanie podla oslobodenia od DPH:
    • 0 - neoslobodeny (fakturovat DPH)
    • 1 - oslobodeny (nefakturovat DPH)
  • filNamePost - filtrovanie podla mena (posta)
  • filStreetPost - filtrovanie podla ulice (posta)
  • filCityPost - filtrovanie podla mesta (posta)
  • filZipPost - filtrovanie podla PSC (posta)
  • filCountryPost - filtrovanie podla ISO kodu statu (posta)

Returns:
  • ok - data structure:
    • count - number of all items
    • data - array of items:
      • id - ID
      • name - meno
      • cid - ICO
      • email - e-mail
listDocuments($pagingOffset, $pagingCount, $filId=null, $filVS=null, $filFkInvoice=null, $filFkType=null, $filName=null, $filStreet=null, $filCity=null, $filZip=null, $filCountry=null, $filCid=null, $filTid=null, $filVid=null, $filFkCurrency=null, $filFkLanguage=null, $filIssueDateFrom=null, $filIssueDateTo=null, $filDeliveryDateFrom=null, $filDeliveryDateTo=null, $filInvoiceVat=null, $filAdvancePayment=null, $filMaturityDays=null, $filPrepaid=null, $filKeyhash=null, $filItemLabel=null, $filPaid=null)
Zoznam dokumentov.

Parameters:
  • pagingOffset - paging, offset
  • pagingCount - paging, number of items
  • filId - filtrovanie podla cisla dokumentu
  • filVS - filtrovanie podla gid / variabilneho symbolu
  • filFkInvoice - filtrovanie podla ID nadradeneho dokumentu
  • filFkType - filtrovanie podla typu dokumentu:
    • 1 - faktury
    • 2 - vyzvy k platbe
    • 3 - dobropisy
  • filName - filtrovanie podla mena (odberatel)
  • filStreet - filtrovanie podla ulice (odberatel)
  • filCity - filtrovanie podla mesta (odberatel)
  • filZip - filtrovanie podla PSC (odberatel)
  • filCountry - filtrovanie podla ISO kodu statu (odberatel)
  • filCid - filtrovanie podla ICO (odberatel)
  • filTid - filtrovanie podla DIC (odberatel)
  • filVid - filtrovanie podla IC DPH (odberatel)
  • filFkCurrency - filtrovanie podla meny
  • filFkLanguage - filtrovanie podla jazyku
  • filIssueDateFrom - filtrovanie podla datumu vystavenia (od)
  • filIssueDateTo - filtrovanie podla datumu vystavenia (do)
  • filDeliveryDateFrom - filtrovanie podla datumu dodania (od)
  • filDeliveryDateTo - filtrovanie podla datumu dodania (do)
  • filInvoiceVat - filtrovanie podla
  • filAdvancePayment - filtrovanie podla
  • filMaturityDays - filtrovanie podla splatnosti (pocet dni)
  • filPrepaid - filtrovanie podla
  • filKeyhash - filtrovanie podla keyhash
  • filItemLabel - filtrovanie podla popisu polozky
  • filPaid - filtrovanie podla stavu dokumentu:
    • -1 - stornovany
    • 0 - neuhradeny
    • 1 - uhradeny
Returns:
  • ok - data structure:
    • count - number of all items
    • data - array of items:
      • gid - ID dokumentu
      • id - cislo dokumentu
      • name - meno (odberatel)
      • issueDate - datum vystavenia, format YYYY-MM-DD
      • maturityDays - splatnost (pocet dni)
      • keyhash - keyhash
      • paid - stav dokumentu, hodnoty:
        • -1 - stornovany
        • 0 - neuhradeny
        • 1 - uhradeny
setDocumentPaid($gid, $paid)
Oznacenie uhrady dokumentu.

Parameters:
  • gid - gid dokumentu
  • paid - hodnoty:
    • 0 - neuhradeny
    • 1 - uhradeny

Vracia:
  • not_exists - dokument neexistuje
  • ok - operacia uspesne prebehla
setDocumentStorno($gid, $storno)
Oznacenie storna dokumentu.

Parameters:
  • gid - gid dokumentu
  • storno - hodnoty:
    • 0 - nestornovany
    • 1 - stornovany

Returns:
  • not_exists - dokument neexistuje
  • ok - operacia uspesne prebehla
createInvoiceFromTicket($gid, $issueDate, $deliveryDate, $advancePayment, $maturityDays, $prepaid)
Vytvorenie faktury na zaklade vyzvy k platbe.

Parameters:
  • gid - gid vyzvy k platbe
  • issueDate - datum vystavenia, format YYYY-MM-DD
  • deliveryDate - datum dodania, format YYYY-MM-DD
  • advancePayment - aka ciastka uz bola z fakturovanej sumy uhradena
  • maturityDays - splatnost (pocet dni)
  • prepaid - hodnoty:
    • 0 - faktura zatial nebola cela uhradena, uhradena cast sa zoberie z parametru 'advancePayment'
    • 1 - faktura uz bola uhradena cela, parameter 'advancePayment' sa ignoruje

Returns:
  • not_exists - vyzva k platbe neexistuje
  • ok - data structure:
    • id - cislo vystavenej faktury
    • gid - gid vystavenej faktury