API partnerov

Správa partnerov (odberateľov, dodávateľov) — získanie, vytvorenie a úprava

Základná URL

https://{tenant}.logzi.com/api/partner/

Každá požiadavka vracia JSON odpoveď. V prípade úspešnej odpovede je result.code == 1, v prípade chyby result.code == 0.

GET /api/partner/get

Získanie jedného partnera na základe identifikátora, názvu spoločnosti alebo daňového čísla, s úplnými podrobnosťami (adresa, kontaktné osoby).

Query parametre

ParameterTypPovinnéPopis
idintJedinečný identifikátor partnera
company_namestringNázov spoločnosti (vyhľadávanie LIKE)
taxcodestringVyhľadávanie podľa daňového čísla
identifystringJedinečný identifikačný kód
fullint1 = s úplnými údajmi (transakcie, štatistiky)

Príklad požiadavky

GET /api/partner/get?id=42
X-API-KEY: {vas_api_kluc}
GET /api/partner/list

Získanie stránkovateľného zoznamu partnerov s možnosťami filtrovania.

Query parametre

ParameterTypPovinnéPopis
list_offsetintPosun stránkovania (predvolené: 0)
list_countintPočet záznamov zobrazených na stránku
list_condition[company_name]stringFiltrovanie podľa názvu spoločnosti (LIKE)
list_condition[taxcode]stringFiltrovanie podľa daňového čísla
list_condition[bank_account]stringFiltrovanie podľa čísla bankového účtu
list_condition[company_email]stringFiltrovanie podľa e-mailovej adresy (LIKE)
list_condition[partner_user_telephone]stringFiltrovanie podľa telefónneho čísla

Príklad požiadavky

GET /api/partner/list?list_offset=0&list_condition[company_name]=Kft
X-API-KEY: {vas_api_kluc}
POST /api/partner/save

Vytvorenie alebo úprava partnera. Pre nového partnera data[id] = 0.

POST polia — objekt data

PoleTypPovinnéPopis
idint0 = nový partner, >0 = úprava
company_namestringNázov spoločnosti / meno partnera
type_idintIdentifikátor typu partnera (odberateľ, dodávateľ atď.)
legal_entity_type_idintTyp právnej entity
paymod_idintIdentifikátor predvoleného spôsobu platby
taxcodestringTuzemské daňové číslo
taxcode_internationalstringKomunitné daňové číslo (EU VAT)
taxcode_groupstringSkupinové daňové číslo
bank_accountstringČíslo bankového účtu
ibanstringBankový účet IBAN
swiftstringKód SWIFT/BIC
registration_numberstringČíslo obchodného registra
company_emailstringE-mailová adresa spoločnosti
identifystringJedinečný identifikačný kód — ak je prázdny, systém ho automaticky vygeneruje
enolve_idstringIdentifikátor externého systému
pay_limitfloatVýška úverového limitu (predvolené: 0)
language_idintIdentifikátor jazyka
currency_out_idintMena odchádzajúcich (vystavených) dokladov
currency_in_idintMena prichádzajúcich dokladov
tax_idintIdentifikátor predvolenej šablóny DPH pre odchádzajúce doklady
tax_in_idintIdentifikátor predvolenej šablóny DPH pre prichádzajúce doklady
ledger_number_in_idintIdentifikátor hlavnej knihy pre prichádzajúce doklady
ledger_number_out_idintIdentifikátor hlavnej knihy pre odchádzajúce doklady
commission_percentfloatPercento provízie (predvolené: 0)
relationship_idintIdentifikátor typu vzťahu
satisfaction_idintIdentifikátor úrovne spokojnosti
source_idintIdentifikátor zdroja (pôvod leadu)
loss_reasonstringDôvod straty
paymod_forbiddenobjectZakázané spôsoby platby — objekt kľúč-hodnota (napr. {"1": true, "3": true}), kľúče sa ukladajú oddelené čiarkou
sms_enableintOdosielanie SMS povolené (0 = nie, 1 = áno). Predvolené: 0. Ak nie je zadané, existujúca hodnota sa nezmení
email_enableintOdosielanie e-mailov povolené (0 = nie, 1 = áno). Predvolené: 1. Ak nie je zadané, existujúca hodnota sa nezmení
addressarrayPole adries (pozri nižšie)
userarrayPole kontaktných osôb (pozri nižšie)

Polia adresy — data[address][]

PoleTypPovinnéPopis
partner_address_idint0 = nová adresa, >0 = úprava existujúcej adresy
country_idintIdentifikátor krajiny
zipstringPSČ
citystringMesto
addressstringUlica, popisné číslo
partner_address_type_idintIdentifikátor typu adresy (fakturačná, dodacia atď.)
partner_address_status_idintIdentifikátor stavu adresy
address_user_namestringMeno príjemcu
address_numberstringPopisné číslo (max. 50 znakov)
address_buildingstringBudova (max. 50 znakov)
address_stairwellstringSchodisko (max. 50 znakov)
address_floorstringPoschodie (max. 50 znakov)
address_doorstringDvere (max. 50 znakov)
districtstringMestská časť
address_commentstringPoznámka k adrese
removeint1 = označenie adresy na zmazanie

Polia kontaktnej osoby — data[user][]

PoleTypPovinnéPopis
partner_user_idint0 = nová kontaktná osoba, >0 = úprava existujúcej
namestringMeno kontaktnej osoby
emailstringE-mailová adresa
telephonestringTelefónne číslo
partner_user_status_idintIdentifikátor stavu
invocationstringOslovenie / titul
faxstringFaxové číslo
removeint1 = označenie kontaktnej osoby na zmazanie

Príklad požiadavky

POST /api/partner/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_name": "Minta Kft.",
    "type_id": 1,
    "legal_entity_type_id": 1,
    "paymod_id": 1,
    "taxcode": "12345678-2-41",
    "taxcode_international": "HU12345678",
    "bank_account": "12345678-12345678-12345678",
    "iban": "HU42117730161111101800000000",
    "registration_number": "01-09-123456",
    "company_email": "info@minta.hu",
    "pay_limit": 500000,
    "currency_out_id": 1,
    "address": [
      {
        "partner_address_id": 0,
        "country_id": 1,
        "zip": "1234",
        "city": "Budapest",
        "address": "Fő utca 1.",
        "partner_address_type_id": 1,
        "partner_address_status_id": 1
      }
    ],
    "user": [
      {
        "partner_user_id": 0,
        "name": "Minta János",
        "email": "janos@minta.hu",
        "telephone": "+36301234567",
        "partner_user_status_id": 1,
        "invocation": "Tisztelt Uram",
        "fax": ""
      }
    ]
  }
}
POST /api/partner/delete

Zmazanie partnera (logické zmazanie). Zmazať možno iba partnera, ku ktorému neexistuje aktívny doklad.

POST polia — objekt data

PoleTypPovinnéPopis
idintIdentifikátor partnera, ktorý sa má zmazať

Príklad požiadavky

POST /api/partner/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{ "data": { "id": 42 } }

Kontaktuj nás

Zaujíma ťa náš softvér? Pokojne nám napíš!

Potrebuješ pomoc?

Ak nevieš nájsť odpoveď a potrebuješ pomoc

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!