Basis-URL
https://{tenant}.logzi.com/api/crm/
Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, bei einem Fehler result.code == 0.
/api/crm/get
Abruf eines einzelnen CRM-Eintrags anhand der ID, mit vollständigen Details.
Query-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
id |
int | Eindeutige Kennung des CRM-Eintrags |
Beispielanfrage
GET /api/crm/get?id=15
X-API-KEY: {ihr_api_schluessel}
Beispielantwort
{
"result": { "code": 1, "message": "success" },
"data": {
"id": 15,
"identify": "CRM-2024-0015",
"date_create": "2024-05-01 10:00:00",
"date_perform": "2024-05-10",
"status_id": 1,
"subject": "Ügyféltárgyalás",
"partner_company_name": "Minta Kft.",
"company_user_name": "Kovács János",
"crm_source_name": "Telefon",
"comment_top": "Előzetes egyeztetés.",
"comment_bottom": "Belső megjegyzés."
}
}
/api/crm/list
Paginierter Abruf der Liste der CRM-Einträge mit Filtermöglichkeiten.
Query-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
list_offset |
int | Versatz für die Seitennummerierung (Standard: 0) | |
list_condition[identify] |
string | Filter nach Belegnummer (LIKE) | |
list_condition[company_name] |
string | Filter nach Partnername (LIKE) | |
list_condition[status_id] |
int | Filter nach Status (1 = offen, 2 = abgeschlossen) | |
list_condition[crm_source_id] |
int | Filter nach Quellen-ID | |
list_condition[company_user_id] |
int | Filter nach ID des zuständigen Mitarbeiters | |
list_condition[date_create_from] |
date | Erstellungsdatum — von (YYYY-MM-DD) | |
list_condition[date_create_to] |
date | Erstellungsdatum — bis (YYYY-MM-DD) |
Beispielanfrage
GET /api/crm/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {ihr_api_schluessel}
Beispielantwort
{
"result": { "code": 1, "message": "success" },
"data": [
{
"id": 15,
"identify": "CRM-2024-0015",
"date_create": "2024-05-01",
"status_name": "Nyitott",
"subject": "Ügyféltárgyalás",
"partner_company_name": "Minta Kft."
}
],
"params": {
"list_count": 10,
"list_offset": 0,
"list_all": 42
}
}
/api/crm/save
Erstellen oder Bearbeiten eines CRM-Eintrags. Für einen neuen Eintrag data[id] = 0 angeben, für eine Bearbeitung die vorhandene ID.
POST-Felder — data-Objekt
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
id |
int | 0 = neuer CRM-Eintrag, >0 = Bearbeitung | |
company_id |
int | Kennung des Unternehmens | |
company_user_id |
int | ID des zuständigen Mitarbeiters | |
partner_id |
int | Kennung des Partners/Kunden | |
crm_source_id |
int | Kennung der Quelle | |
subject |
string | Betreff | |
date_perform |
datetime | Leistungsdatum (YYYY-MM-DD HH:MM:SS) | |
comment_top |
string | Für den Kunden sichtbare Anmerkung | |
comment_bottom |
string | Interne Anmerkung | |
status_id |
int | Kennung des Status |
POST-Felder — params-Objekt (optional)
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
close |
int | 1 = automatischer Abschluss nach dem Speichern | |
download |
int | 1 = PDF-Generierung nach dem Speichern |
Beispielanfrage
POST /api/crm/save
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{
"data": {
"id": 0,
"company_id": 1,
"company_user_id": 3,
"partner_id": 12,
"crm_source_id": 2,
"subject": "Termékbemutató egyeztetés",
"date_perform": "2024-06-20 14:00:00",
"comment_top": "Ügyfél érdeklődik az új termékcsalád iránt.",
"status_id": 1
},
"params": {
"close": 0,
"download": 0
}
}
Beispielantwort
{
"result": { "code": 1, "message": "success" },
"data": {
"id": 16,
"identify": "CRM-2024-0016"
}
}
/api/crm/delete
Löschen eines CRM-Eintrags. Es kann nur ein Eintrag mit offenem Status gelöscht werden.
POST-Felder — data-Objekt
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
receipt_id |
int | Kennung des zu löschenden CRM-Eintrags |
Beispielanfrage
POST /api/crm/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{
"data": {
"receipt_id": 15
}
}
Beispielantwort
{
"result": { "code": 1, "message": "success" },
"data": {}
}
/api/crm/close
Abschließen eines offenen CRM-Eintrags. Es kann nur ein Eintrag mit status_id = 1 (offen) abgeschlossen werden.
POST-Felder — data-Objekt
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
receipt_id |
int | Kennung des abzuschließenden CRM-Eintrags |
Beispielanfrage
POST /api/crm/close
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{
"data": {
"receipt_id": 15
}
}
Beispielantwort
{
"result": { "code": 1, "message": "success" },
"data": {}
}
/api/crm/download
Herunterladen/Generieren des Dokuments eines CRM-Eintrags in verschiedenen Formaten (PDF, Base64-String, Stream).
Query-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
receipt_id |
int | Kennung des CRM-Eintrags | |
file_type |
string | Ausgabeformat: pdf, pdf-string, stream |
|
language |
string | Name des Sprachordners der Vorlage (z. B. hungarian) |
|
template_id |
int | ID der individuellen Druckvorlage |
Beispielanfrage
GET /api/crm/download?receipt_id=15&file_type=pdf
X-API-KEY: {ihr_api_schluessel}
Beispielantwort (file_type=pdf)
{
"result": { "code": 1, "message": "success" },
"data": {
"name": "CRM-2024-0015.pdf",
"content": "JVBERi0xLjQK...",
"receipt": { ... }
}
}
Interessierst du dich für unsere Software? Schreib uns einfach!
Jetzt registrieren,
später bezahlen!