Zum Inhalt springen
Developer

CRMCompanyCategory

CRM1 EndpunkteCRM / CRMCompanyCategory

Diese Methode liefert alle CRMCompanyCategory-Objekte

GET/api/crm/crmcompanycategory

Query-Parameter

idstring
namestring
externalDescriptionstring
internalDescriptionstring
createdstring
updatedstring
searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste der CRMCompanyCategory-Objekte.array<CRMCompanyCategory>

Felder anzeigen (10)
  • idinteger

    Primärschlüssel der Unternehmenskategorie. Interne ID.

  • namestring

    Name der Firmenkategorie.

  • descriptionstring

    Beschreibung der Firmenkategorie.

  • deletedboolean

    Die Kategorie ist gelöscht.

  • global_defaultboolean

    Standardkategorie für neue Firmen.

  • enabled_customer_portalboolean

    Unternehmen dieser Kategorie dürfen das Kundenportal nutzen.

  • g_drive_root_dirstring

    Stammordner in Google Drive für Unternehmen dieser Kategorie.

  • g_drive_root_dir_archivedstring

    Stammordner in Google Drive für archivierte Unternehmen dieser Kategorie.

  • require_company_addressboolean

    Für Unternehmen dieser Kategorie muss eine Adresse eingegeben werden.

  • require_company_billingboolean

    Für Unternehmen dieser Kategorie müssen Abrechnungsdaten eingegeben werden.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/crm/crmcompanycategory \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "name": "Beispiel",
    "description": "Text",
    "deleted": true,
    "global_default": true,
    "enabled_customer_portal": true,
    "g_drive_root_dir": "string",
    "g_drive_root_dir_archived": "string",
    "require_company_address": true,
    "require_company_billing": true
  }
]