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.
/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
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Jedinečný identifikátor partnera | |
company_name | string | Názov spoločnosti (vyhľadávanie LIKE) | |
taxcode | string | Vyhľadávanie podľa daňového čísla | |
identify | string | Jedinečný identifikačný kód | |
full | int | 1 = s úplnými údajmi (transakcie, štatistiky) |
Príklad požiadavky
GET /api/partner/get?id=42
X-API-KEY: {vas_api_kluc}
/api/partner/list
Získanie stránkovateľného zoznamu partnerov s možnosťami filtrovania.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_offset | int | Posun stránkovania (predvolené: 0) | |
list_count | int | Počet záznamov zobrazených na stránku | |
list_condition[company_name] | string | Filtrovanie podľa názvu spoločnosti (LIKE) | |
list_condition[taxcode] | string | Filtrovanie podľa daňového čísla | |
list_condition[bank_account] | string | Filtrovanie podľa čísla bankového účtu | |
list_condition[company_email] | string | Filtrovanie podľa e-mailovej adresy (LIKE) | |
list_condition[partner_user_telephone] | string | Filtrovanie 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}
/api/partner/save
Vytvorenie alebo úprava partnera. Pre nového partnera data[id] = 0.
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | int | 0 = nový partner, >0 = úprava | |
company_name | string | Názov spoločnosti / meno partnera | |
type_id | int | Identifikátor typu partnera (odberateľ, dodávateľ atď.) | |
legal_entity_type_id | int | Typ právnej entity | |
paymod_id | int | Identifikátor predvoleného spôsobu platby | |
taxcode | string | Tuzemské daňové číslo | |
taxcode_international | string | Komunitné daňové číslo (EU VAT) | |
taxcode_group | string | Skupinové daňové číslo | |
bank_account | string | Číslo bankového účtu | |
iban | string | Bankový účet IBAN | |
swift | string | Kód SWIFT/BIC | |
registration_number | string | Číslo obchodného registra | |
company_email | string | E-mailová adresa spoločnosti | |
identify | string | Jedinečný identifikačný kód — ak je prázdny, systém ho automaticky vygeneruje | |
enolve_id | string | Identifikátor externého systému | |
pay_limit | float | Výška úverového limitu (predvolené: 0) | |
language_id | int | Identifikátor jazyka | |
currency_out_id | int | Mena odchádzajúcich (vystavených) dokladov | |
currency_in_id | int | Mena prichádzajúcich dokladov | |
tax_id | int | Identifikátor predvolenej šablóny DPH pre odchádzajúce doklady | |
tax_in_id | int | Identifikátor predvolenej šablóny DPH pre prichádzajúce doklady | |
ledger_number_in_id | int | Identifikátor hlavnej knihy pre prichádzajúce doklady | |
ledger_number_out_id | int | Identifikátor hlavnej knihy pre odchádzajúce doklady | |
commission_percent | float | Percento provízie (predvolené: 0) | |
relationship_id | int | Identifikátor typu vzťahu | |
satisfaction_id | int | Identifikátor úrovne spokojnosti | |
source_id | int | Identifikátor zdroja (pôvod leadu) | |
loss_reason | string | Dôvod straty | |
paymod_forbidden | object | Zakázané spôsoby platby — objekt kľúč-hodnota (napr. {"1": true, "3": true}), kľúče sa ukladajú oddelené čiarkou | |
sms_enable | int | Odosielanie SMS povolené (0 = nie, 1 = áno). Predvolené: 0. Ak nie je zadané, existujúca hodnota sa nezmení | |
email_enable | int | Odosielanie e-mailov povolené (0 = nie, 1 = áno). Predvolené: 1. Ak nie je zadané, existujúca hodnota sa nezmení | |
address | array | Pole adries (pozri nižšie) | |
user | array | Pole kontaktných osôb (pozri nižšie) |
Polia adresy — data[address][]
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
partner_address_id | int | 0 = nová adresa, >0 = úprava existujúcej adresy | |
country_id | int | Identifikátor krajiny | |
zip | string | PSČ | |
city | string | Mesto | |
address | string | Ulica, popisné číslo | |
partner_address_type_id | int | Identifikátor typu adresy (fakturačná, dodacia atď.) | |
partner_address_status_id | int | Identifikátor stavu adresy | |
address_user_name | string | Meno príjemcu | |
address_number | string | Popisné číslo (max. 50 znakov) | |
address_building | string | Budova (max. 50 znakov) | |
address_stairwell | string | Schodisko (max. 50 znakov) | |
address_floor | string | Poschodie (max. 50 znakov) | |
address_door | string | Dvere (max. 50 znakov) | |
district | string | Mestská časť | |
address_comment | string | Poznámka k adrese | |
remove | int | 1 = označenie adresy na zmazanie |
Polia kontaktnej osoby — data[user][]
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
partner_user_id | int | 0 = nová kontaktná osoba, >0 = úprava existujúcej | |
name | string | Meno kontaktnej osoby | |
email | string | E-mailová adresa | |
telephone | string | Telefónne číslo | |
partner_user_status_id | int | Identifikátor stavu | |
invocation | string | Oslovenie / titul | |
fax | string | Faxové číslo | |
remove | int | 1 = 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": ""
}
]
}
}
/api/partner/delete
Zmazanie partnera (logické zmazanie). Zmazať možno iba partnera, ku ktorému neexistuje aktívny doklad.
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifiká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 } }
Zaregistruj sa teraz,
zaplať neskôr!