Import & Export per API

Fynex stellt API-Endpoints bereit, um Accounts per Bulk-Import in Ihr Portfolio zu laden und Daten für externes Reporting oder Analysen zu exportieren.

Accounts importieren

Senden Sie ein JSON-Array von Accounts an den Import-Endpoint. Jeder Account kann Kontaktdaten, Salden und externe Kennungen enthalten.

Anfrage

curl -X POST https://api.fynex.solutions/api/v1/import \
  -H "X-API-Key: fynex_k_abc123..." \
  -H "Content-Type: application/json" \
  -d '{
    "accounts": [
      {
        "contact": { "name": "María García", "phone": "+5491155551234" },
        "total_amount": 45000,
        "external_id": "INV-2026-0042",
        "source_system": "SAP",
        "due_date": "2026-01-15",
        "currency": "ARS",
        "notes": "60 days past due, prior arrangement lapsed"
      },
      {
        "contact": { "name": "Carlos López", "phone": "+5491155555678", "email": "[email protected]" },
        "total_amount": 12500,
        "external_id": "INV-2026-0099",
        "source_system": "SAP"
      }
    ]
  }'

Antwort

{
  "job_id": "imp_a1b2c3d4-...",
  "status": "processing",
  "total_records": 2
}

Der Import läuft asynchron. Nutzen Sie job_id, um den Fortschritt abzufragen.

Import-Felder

Feld	Erforderlich	Beschreibung
contact.name	Ja	Vollständiger Name des Hauptkontakts
total_amount	Ja	Gesamtforderungsbetrag
external_id	Nein	Eindeutige Kennung Ihres Systems für diesen Account
source_system	Nein	Name des Quellsystems (z. B. „SAP“, „Salesforce“)
contact.phone	Nein	Telefonnummer im E.164-Format
contact.email	Nein	E-Mail-Adresse
due_date	Nein	Ursprüngliches Fälligkeitsdatum (ISO 8601)
currency	Nein	Währungscode (Standard: Währung der Organisation)
notes	Nein	Freitext-Notizen am Account

TIP

Geben Sie für jeden Account eine external_id an. Damit greift Upsert-Verhalten — existiert bereits ein Account mit derselben external_id, wird er aktualisiert statt dupliziert.

Import-Status prüfen

curl -H "X-API-Key: fynex_k_abc123..." \
     https://api.fynex.solutions/api/v1/import/imp_a1b2c3d4-...

{
  "job_id": "imp_a1b2c3d4-...",
  "status": "completed",
  "total_records": 2,
  "imported": 2,
  "updated": 0,
  "errors": []
}

Mögliche Status: processing, completed, completed_with_errors, failed.

Ist der Status completed_with_errors, enthält das Array errors Details je fehlgeschlagenem Datensatz inkl. Zeilenindex und Grund.

Accounts exportieren

Fordern Sie einen Export Ihrer Account-Daten im Format JSON oder CSV an, optional mit Filtern.

Anfrage

curl -X POST https://api.fynex.solutions/api/v1/export/accounts \
  -H "X-API-Key: fynex_k_abc123..." \
  -H "Content-Type: application/json" \
  -d '{
    "format": "csv",
    "filters": {
      "status": "active",
      "min_amount": 5000,
      "days_past_due_min": 30
    }
  }'

Antwort

Bei Format JSON enthält der Response-Body direkt das Account-Array. Bei CSV ist die Response eine herunterladbare Datei mit Content-Type: text/csv.

Verfügbare Filter

Filter	Typ	Beschreibung
status	string	Account-Status (active, resolved, escalated usw.)
min_amount	number	Mindest-Gesamtbetrag
max_amount	number	Höchst-Gesamtbetrag
days_past_due_min	number	Mindesttage überfällig
days_past_due_max	number	Höchsttage überfällig
campaign_id	string	Nur Accounts in dieser Campaign
source_system	string	Nur Accounts aus diesem Quellsystem

External-ID-Zuordnung

Das Feld external_id verbindet Fynex mit Ihrem Quellsystem. Nutzen Sie es, um:

• Duplikate zu vermeiden — Import mit bestehender external_id aktualisiert den Datensatz statt einen neuen anzulegen (Upsert).
• Querzuweisung — Fynex-Account-IDs Ihrem ERP, CRM oder Billing zuzuordnen.
• Zahlungen abzugleichen — Beim Export external_id nutzen, um Fynex-Zahlungen mit Ihrem internen Ledger abzugleichen.

WARNING

Die external_id muss innerhalb Ihrer Organisation eindeutig sein. Teilen sich zwei Datensätze im selben Import-Batch dieselbe external_id, bleibt nur der letzte erhalten.

Erforderliche Scopes

Operation	Erforderlicher API-Key-Scope
Import	import
Status prüfen	import
Export	export

Anleitung zum Anlegen von Keys mit bestimmten Scopes finden Sie im Leitfaden API-Keys.