Partnertörzs API

Partnerek (vevők, szállítók) kezelése — lekérés, létrehozás és módosítás

Alap URL

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

Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0.

GET /api/partner/get

Egyetlen partner lekérése azonosító, cégnév vagy adószám alapján, teljes részletekkel (cím, kapcsolattartók).

Query paraméterek

ParaméterTípusKötelezőLeírás
idintPartner egyedi azonosítója
company_namestringCégnév (LIKE keresés)
taxcodestringAdószám alapján keresés
identifystringEgyedi azonosító kód
fullint1 = teljes adatokkal (tranzakciók, statisztika)

Példa kérés

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

Partnerek lapozható listájának lekérése szűrési lehetőségekkel.

Query paraméterek

ParaméterTípusKötelezőLeírás
list_offsetintLapozás eltolása (alapértelmezett: 0)
list_countintOldalanként megjelenő rekordok száma
list_condition[company_name]stringSzűrés cégnévre (LIKE)
list_condition[taxcode]stringSzűrés adószámra
list_condition[bank_account]stringSzűrés bankszámlaszámra
list_condition[company_email]stringSzűrés e-mail címre (LIKE)
list_condition[partner_user_telephone]stringSzűrés telefonszámra

Példa kérés

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

Partner létrehozása vagy módosítása. Új partnerhez data[id] = 0.

POST mezők — data objektum

MezőTípusKötelezőLeírás
idint0 = új partner, >0 = módosítás
company_namestringCégnév / partner neve
type_idintPartner típus azonosítója (vevő, szállító stb.)
legal_entity_type_idintJogi entitás típusa
paymod_idintAlapértelmezett fizetési mód azonosítója
taxcodestringBelföldi adószám
taxcode_internationalstringKözösségi adószám (EU VAT)
taxcode_groupstringCsoportos adószám
bank_accountstringBankszámlaszám
ibanstringIBAN bankszámlaszám
swiftstringSWIFT/BIC kód
registration_numberstringCégjegyzékszám
company_emailstringCég e-mail cím
identifystringEgyedi azonosítókód — ha üres, a rendszer automatikusan generálja
enolve_idstringKülső rendszer azonosítója
pay_limitfloatHitelkeret összege (alapértelmezett: 0)
language_idintNyelv azonosítója
currency_out_idintKimenő (kiállított) bizonylatok devizája
currency_in_idintBejövő bizonylatok devizája
tax_idintAlapértelmezett kimenő ÁFA sablon azonosítója
tax_in_idintAlapértelmezett bejövő ÁFA sablon azonosítója
ledger_number_in_idintBejövő főkönyvi szám azonosítója
ledger_number_out_idintKimenő főkönyvi szám azonosítója
commission_percentfloatJutalék százalék (alapértelmezett: 0)
relationship_idintKapcsolat típusának azonosítója
satisfaction_idintElégedettségi szint azonosítója
source_idintForrás azonosítója (lead eredete)
loss_reasonstringElvesztés oka
paymod_forbiddenobjectTiltott fizetési módok — kulcs-érték objektum (pl. {"1": true, "3": true}), a kulcsok vesszővel tárolódnak
sms_enableintSMS küldés engedélyezve (0 = nem, 1 = igen). Alapértelmezett: 0. Ha nincs megadva, a meglévő érték nem változik
email_enableintE-mail küldés engedélyezve (0 = nem, 1 = igen). Alapértelmezett: 1. Ha nincs megadva, a meglévő érték nem változik
addressarrayCím(ek) tömbje (ld. alább)
userarrayKapcsolattartó(k) tömbje (ld. alább)

Cím mezők — data[address][]

MezőTípusKötelezőLeírás
partner_address_idint0 = új cím, >0 = meglévő cím módosítása
country_idintOrszág azonosítója
zipstringIrányítószám
citystringVáros
addressstringUtca, házszám
partner_address_type_idintCím típus azonosítója (számlázási, szállítási stb.)
partner_address_status_idintCím állapot azonosítója
address_user_namestringFogadó neve
address_numberstringHázszám (max 50 karakter)
address_buildingstringÉpület (max 50 karakter)
address_stairwellstringLépcsőház (max 50 karakter)
address_floorstringEmelet (max 50 karakter)
address_doorstringAjtó (max 50 karakter)
districtstringKerület
address_commentstringMegjegyzés a címhez
removeint1 = cím törlésének jelölése

Kapcsolattartó mezők — data[user][]

MezőTípusKötelezőLeírás
partner_user_idint0 = új kapcsolattartó, >0 = meglévő módosítása
namestringKapcsolattartó neve
emailstringE-mail cím
telephonestringTelefonszám
partner_user_status_idintStátusz azonosítója
invocationstringMegszólítás / titulus
faxstringFax szám
removeint1 = kapcsolattartó törlésének jelölése

Példa kérés

POST /api/partner/save
X-API-KEY: {az_api_kulcsod}
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

Partner törlése (logikai törlés). Csak olyan partner törölhető, amelyhez nincs aktív bizonylat.

POST mezők — data objektum

MezőTípusKötelezőLeírás
idintA törlendő partner azonosítója

Példa kérés

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

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

Vedd fel a kapcsolatot velünk

Érdeklődsz a szoftverünkkel kapcsolatban, írj bátran!

Segítségre van szükséged?

Ha nem találod a választ és szükséged van segítségre

Regisztrációdat hozd létre most,
fizess később!

Próbáld ki 3 napig ingyen, kockázatok és kötöttségek nélkül!