Kunden-Angebotsversand API

Verwaltung ausgehender Kundenangebote — Abrufen, Erstellen, Ändern, Abschließen und Dokument-Download

Basis-URL

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

Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, im Fehlerfall result.code == 0.

GET /api/offer_send/get

Abrufen eines einzelnen Kundenangebots anhand der Kennung, mit vollständigen Details.

Query-Parameter

ParameterTypPflichtfeldBeschreibung
idintEindeutige Kennung des Angebots

Beispielanfrage

GET /api/offer_send/get?id=15
X-API-KEY: {ihr_api_schluessel}

Beispielantwort

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 15,
    "identify": "AJ-2024-0015",
    "date_create": "2024-05-01 09:00:00",
    "date_perform": "2024-05-15",
    "status_id": 1,
    "partner_company_name": "Minta Kft.",
    "price_netto": 80000,
    "price_brutto": 101600,
    "currency_name": "HUF",
    "item": [
      { "product_id": 3, "quantity": 2, "price": 40000, "tax_id": 2 }
    ]
  }
}
GET /api/offer_send/list

Seitenweises Abrufen der Liste der Kundenangebote mit Filtermöglichkeiten.

Query-Parameter

ParameterTypPflichtfeldBeschreibung
list_offsetintVersatz für die Seitennummerierung (Standard: 0)
list_countintAnzahl der Datensätze pro Seite
list_sort[field]stringName des Sortierfelds
list_sort[sort]stringSortierrichtung: ASC oder DESC
list_condition[identify]stringFilter nach Kennung (LIKE)
list_condition[company_name]stringFilter nach Partnername (LIKE)
list_condition[status_id]intFilter nach Status
list_condition[date_create_from]dateErstellungsdatum — von (YYYY-MM-DD)
list_condition[date_create_to]dateErstellungsdatum — bis (YYYY-MM-DD)

Beispielanfrage

GET /api/offer_send/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": "AJ-2024-0015", "partner_company_name": "Minta Kft.", "status_id": 1, "price_brutto": 101600 }
  ],
  "params": { "list_count": 20, "list_offset": 0, "list_all": 42 }
}
POST /api/offer_send/save

Erstellen oder Ändern eines Kundenangebots. Für ein neues Angebot data[id] = 0, zum Ändern die vorhandene ID angeben.

POST-Felder — data Objekt

FeldTypPflichtfeldBeschreibung
idint0 = neues Angebot, >0 = Änderung
company_idintKennung des Unternehmens
company_user_idintKennung des zuständigen Mitarbeiters
company_address_idintKennung der Niederlassung
currency_idintKennung der Währung
partner_idintKennung des Partners/Kunden
date_performdateGültigkeitsdatum (YYYY-MM-DD)
comment_topstringFür den Kunden sichtbarer Kommentar
comment_bottomstringInterner Kommentar
jobnumber_idintKennung der Auftragsnummer
project_idintKennung des Projekts
itemarrayArray der Positionen (siehe unten)

Positionsfelder — data[item][]

FeldTypPflichtfeldBeschreibung
product_idintKennung des Produkts
quantityfloatMenge
pricefloatNetto-Einzelpreis
tax_idintKennung des Mehrwertsteuersatzes
price_discountfloatRabatt in Prozent
removeint1 = Position bei Änderung löschen

POST-Felder — params Objekt (optional)

FeldTypPflichtfeldBeschreibung
closeint1 = automatischer Abschluss nach dem Speichern
downloadint1 = PDF-Erzeugung nach dem Speichern

Beispielanfrage

POST /api/offer_send/save
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "company_address_id": 1,
    "currency_id": 1,
    "partner_id": 12,
    "date_perform": "2024-06-30",
    "comment_top": "Az ajánlat 30 napig érvényes.",
    "item": [
      { "product_id": 5, "quantity": 10, "price": 8000, "tax_id": 2 }
    ]
  },
  "params": { "close": 0, "download": 0 }
}

Beispielantwort

{
  "result": { "code": 1, "message": "success" },
  "data": { "id": 16, "identify": "AJ-2024-0016" }
}
POST /api/offer_send/delete

Löschen eines Kundenangebots. Nur ein offenes Angebot (status_id=1) kann gelöscht werden.

POST-Felder — data Objekt

FeldTypPflichtfeldBeschreibung
receipt_idintKennung des zu löschenden Angebots

Beispielanfrage

POST /api/offer_send/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json

{ "data": { "receipt_id": 15 } }

Beispielantwort

{ "result": { "code": 1, "message": "success" }, "data": {} }
POST /api/offer_send/close

Abschließen eines offenen Kundenangebots. Nur ein Angebot mit status_id = 1 (offen) kann abgeschlossen werden.

POST-Felder — data Objekt

FeldTypPflichtfeldBeschreibung
receipt_idintKennung des abzuschließenden Angebots

Beispielanfrage

POST /api/offer_send/close
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json

{ "data": { "receipt_id": 15 } }

Beispielantwort

{ "result": { "code": 1, "message": "success" }, "data": {} }
GET /api/offer_send/download

Herunterladen des Dokuments zum Kundenangebot in verschiedenen Formaten.

Query-Parameter

ParameterTypPflichtfeldBeschreibung
receipt_idintKennung des Angebots
file_typestringpdf, pdf-string, pdf-string-sample, stream
languagestringName des Sprachordners der Vorlage (z. B. hungarian)
template_idintKennung der individuellen Druckvorlage

Beispielanfrage

GET /api/offer_send/download?receipt_id=15&file_type=pdf
X-API-KEY: {ihr_api_schluessel}

Nimm Kontakt mit uns auf

Interessierst du dich für unsere Software? Schreib uns einfach!

Brauchst du Hilfe?

Wenn du keine Antwort findest und Unterstützung brauchst

Jetzt registrieren,
später bezahlen!

Teste es 3 Tage kostenlos, ohne Risiko und Verpflichtungen!