CRMPersonContactData

CRM6 EndpunkteCRM / CRMPersonContactData

Diese Methode liefert alle CRMPersonContactData-Objekte

GET/api/crm/crmpersoncontactdatas

Query-Parameter

`id`string
`person`string
`type`string
`value`string
`label`string
`searchString`string	Text, nach dem in der Liste gesucht wird
`orderFieldName`string	Name des Bestellfelds
`orderFieldSort`string	SortiermodusErlaubt: `DESCASC`
`page`integer	Seite der Liste
`pageSize`integer	Anzahl der Einträge je Seite
`withMaxPageNumber`string	gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

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

Felder anzeigen (6)

idinteger
Primärschlüssel des Kontaktdaten-Eintrags. Interne ID.
namestring
Name des Kontaktdateneintrags.
valuestring
Wert des Kontaktdateneintrags, z. B. eine Telefonnummer oder E-Mail-Adresse.
generated_valuestring
Aus dem eingegebenen Wert erzeugter Wert.
contact_data_typeContactDataType
Art der Kontaktdaten.
Felder anzeigen (5)
- idinteger
  Primärschlüssel des Kontaktdatentyps. Interne ID.
- namestring
  Name des Kontaktdatentyps, zum Beispiel Telefon oder E-Mail.
- valuestring
  Wert des Kontaktdatentyps.
- allow_self_serviceboolean
  Mitglieder dürfen diesen Kontaktdatentyp im Selbstservice bearbeiten.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
search_stringstring
Text, unter dem die Entität gesucht werden kann.

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/crm_person_contact_data_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await CrmPersonContactDataController.getAll();
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

[
  {
    "id": 42,
    "name": "Beispiel",
    "value": "string",
    "generated_value": "string",
    "contact_data_type": {
      "id": 42,
      "name": "Beispiel",
      "value": "string",
      "allow_self_service": true,
      "deleted": true
    },
    "search_string": "string"
  }
]

CRMPersonContactData neu anlegen

POST/api/crm/crmpersoncontactdatas

Antworten

200CRMPersonContactData neu anlegenCRMPersonContactData2

Felder anzeigen (7)

idinteger
Primärschlüssel des Kontaktdaten-Eintrags. Interne ID.
namestring
Name des Kontaktdateneintrags.
valuestring
Wert des Kontaktdateneintrags, z. B. eine Telefonnummer oder E-Mail-Adresse.
generated_valuestring
Aus dem eingegebenen Wert erzeugter Wert.
contact_data_typeContactDataType
Art der Kontaktdaten.
Felder anzeigen (5)
- idinteger
  Primärschlüssel des Kontaktdatentyps. Interne ID.
- namestring
  Name des Kontaktdatentyps, zum Beispiel Telefon oder E-Mail.
- valuestring
  Wert des Kontaktdatentyps.
- allow_self_serviceboolean
  Mitglieder dürfen diesen Kontaktdatentyp im Selbstservice bearbeiten.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
companyCRMCompany
Unternehmen, zu dem die Kontaktdaten gehören.
Felder anzeigen (55)
- idinteger
  Primärschlüssel des Unternehmens. Interne ID.
- short_namestring
  Kurzname des Unternehmens.
- company_namestring
  Rechtlicher Name der Firma.
- secondary_namestring
  Zweite Namenszeile des Unternehmens.
- direct_dialstring
  Durchwahl der Firma.
- invoice_emailstring
  E-Mail-Adresse für Rechnungen.
- send_invoice_emailboolean
  Rechnungen per E-Mail versenden.
- send_invoice_letterboolean
  Rechnungen per Brief versenden.
- time_report_emailstring
  E-Mail-Adresse für Zeitberichte.
- payment_goalPaymentGoal
  Zahlungsbedingung der Firma.
- payment_intervalstring
  Intervall der Zahlungen.
- vatidstring
  Umsatzsteuer-Identifikationsnummer.
- taxnumberstring
  Steuernummer des Unternehmens.
- buyer_reference_idstring
  Leitweg-ID oder vom Kunden definierte individuelle Referenz-ID
- taxTax
  Für das Unternehmen verwendeter Steuersatz.
- infostring
  Informationen zur Firma.
- numberstring
  Kunden- oder Lieferantennummer des Unternehmens.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Unternehmensnummer als Text, einschließlich Präfix.
- is_customerboolean
  Das Unternehmen ist ein Kunde.
- is_supplierboolean
  Das Unternehmen ist ein Lieferant.
- is_otherboolean
  Das Unternehmen ist weder Kunde noch Lieferant.
- is_memberboolean
  Das Unternehmen ist ein Mitglied.
- archivedboolean
  Das Unternehmen ist archiviert.
- categoryCRMCompanyCategory
  Kategorie des Unternehmens.
- visible_for_customerboolean
  Ob das Unternehmen für den Kunden sichtbar ist.
- founding_datestring (date-time)
  Gründungsdatum des Unternehmens.
- nace_sectionstring
  NACE-Abschnittscode (Buchstabe A-U)
- nace_codestring
  NACE-Code (numerisch, z. B. 01.11, 62.01)
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- payment_typePaymentType
- company_employee_countinteger
  Anzahl der Mitarbeitenden der Firma.
- company_founding_yearinteger
  Gründungsjahr des Unternehmens.
- company_family_ownedboolean
  Ob das Unternehmen familiengeführt ist.
- company_sales_volumestring
  Umsatzvolumen des Unternehmens.
- company_segmentstring
  Marktsegment der Firma.
search_stringstring
Text, unter dem die Entität gesucht werden kann.

Anfrage

curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.post(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas")
  .post(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/crm_person_contact_data_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/crm_person_contact_data.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await CrmPersonContactDataController.post(CrmPersonContactData.fromJson({}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "value": "string",
  "generated_value": "string",
  "contact_data_type": {
    "id": 42,
    "name": "Beispiel",
    "value": "string",
    "allow_self_service": true,
    "deleted": true
  },
  "company": {
    "id": 42,
    "short_name": "Beispiel",
    "company_name": "Beispiel",
    "secondary_name": "Beispiel",
    "invoice_email": "lena.hartmann@example.org",
    "send_invoice_email": true,
    "time_report_email": "lena.hartmann@example.org",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "search_string": "string"
}

Diese Methode liefert ein einzelnes CRMPersonContactData-Objekt mit der angegebenen ID

GET/api/crm/crmpersoncontactdatas/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Liefert ein einzelnes CRMPersonContactData-Objekt.CRMPersonContactData2

Felder anzeigen (7)

idinteger
Primärschlüssel des Kontaktdaten-Eintrags. Interne ID.
namestring
Name des Kontaktdateneintrags.
valuestring
Wert des Kontaktdateneintrags, z. B. eine Telefonnummer oder E-Mail-Adresse.
generated_valuestring
Aus dem eingegebenen Wert erzeugter Wert.
contact_data_typeContactDataType
Art der Kontaktdaten.
Felder anzeigen (5)
- idinteger
  Primärschlüssel des Kontaktdatentyps. Interne ID.
- namestring
  Name des Kontaktdatentyps, zum Beispiel Telefon oder E-Mail.
- valuestring
  Wert des Kontaktdatentyps.
- allow_self_serviceboolean
  Mitglieder dürfen diesen Kontaktdatentyp im Selbstservice bearbeiten.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
companyCRMCompany
Unternehmen, zu dem die Kontaktdaten gehören.
Felder anzeigen (55)
- idinteger
  Primärschlüssel des Unternehmens. Interne ID.
- short_namestring
  Kurzname des Unternehmens.
- company_namestring
  Rechtlicher Name der Firma.
- secondary_namestring
  Zweite Namenszeile des Unternehmens.
- direct_dialstring
  Durchwahl der Firma.
- invoice_emailstring
  E-Mail-Adresse für Rechnungen.
- send_invoice_emailboolean
  Rechnungen per E-Mail versenden.
- send_invoice_letterboolean
  Rechnungen per Brief versenden.
- time_report_emailstring
  E-Mail-Adresse für Zeitberichte.
- payment_goalPaymentGoal
  Zahlungsbedingung der Firma.
- payment_intervalstring
  Intervall der Zahlungen.
- vatidstring
  Umsatzsteuer-Identifikationsnummer.
- taxnumberstring
  Steuernummer des Unternehmens.
- buyer_reference_idstring
  Leitweg-ID oder vom Kunden definierte individuelle Referenz-ID
- taxTax
  Für das Unternehmen verwendeter Steuersatz.
- infostring
  Informationen zur Firma.
- numberstring
  Kunden- oder Lieferantennummer des Unternehmens.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Unternehmensnummer als Text, einschließlich Präfix.
- is_customerboolean
  Das Unternehmen ist ein Kunde.
- is_supplierboolean
  Das Unternehmen ist ein Lieferant.
- is_otherboolean
  Das Unternehmen ist weder Kunde noch Lieferant.
- is_memberboolean
  Das Unternehmen ist ein Mitglied.
- archivedboolean
  Das Unternehmen ist archiviert.
- categoryCRMCompanyCategory
  Kategorie des Unternehmens.
- visible_for_customerboolean
  Ob das Unternehmen für den Kunden sichtbar ist.
- founding_datestring (date-time)
  Gründungsdatum des Unternehmens.
- nace_sectionstring
  NACE-Abschnittscode (Buchstabe A-U)
- nace_codestring
  NACE-Code (numerisch, z. B. 01.11, 62.01)
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- payment_typePaymentType
- company_employee_countinteger
  Anzahl der Mitarbeitenden der Firma.
- company_founding_yearinteger
  Gründungsjahr des Unternehmens.
- company_family_ownedboolean
  Ob das Unternehmen familiengeführt ist.
- company_sales_volumestring
  Umsatzvolumen des Unternehmens.
- company_segmentstring
  Marktsegment der Firma.
search_stringstring
Text, unter dem die Entität gesucht werden kann.

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/crm_person_contact_data_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await CrmPersonContactDataController.get('42');
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "value": "string",
  "generated_value": "string",
  "contact_data_type": {
    "id": 42,
    "name": "Beispiel",
    "value": "string",
    "allow_self_service": true,
    "deleted": true
  },
  "company": {
    "id": 42,
    "short_name": "Beispiel",
    "company_name": "Beispiel",
    "secondary_name": "Beispiel",
    "invoice_email": "lena.hartmann@example.org",
    "send_invoice_email": true,
    "time_report_email": "lena.hartmann@example.org",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "search_string": "string"
}

Diese Methode aktualisiert ein CRMPersonContactData-Objekt

PUT/api/crm/crmpersoncontactdatas/{id}

Pfad-Parameter

idPflichtstring

Antworten

200CRMPersonContactData aktualisierenCRMPersonContactData2

Felder anzeigen (7)

idinteger
Primärschlüssel des Kontaktdaten-Eintrags. Interne ID.
namestring
Name des Kontaktdateneintrags.
valuestring
Wert des Kontaktdateneintrags, z. B. eine Telefonnummer oder E-Mail-Adresse.
generated_valuestring
Aus dem eingegebenen Wert erzeugter Wert.
contact_data_typeContactDataType
Art der Kontaktdaten.
Felder anzeigen (5)
- idinteger
  Primärschlüssel des Kontaktdatentyps. Interne ID.
- namestring
  Name des Kontaktdatentyps, zum Beispiel Telefon oder E-Mail.
- valuestring
  Wert des Kontaktdatentyps.
- allow_self_serviceboolean
  Mitglieder dürfen diesen Kontaktdatentyp im Selbstservice bearbeiten.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
companyCRMCompany
Unternehmen, zu dem die Kontaktdaten gehören.
Felder anzeigen (55)
- idinteger
  Primärschlüssel des Unternehmens. Interne ID.
- short_namestring
  Kurzname des Unternehmens.
- company_namestring
  Rechtlicher Name der Firma.
- secondary_namestring
  Zweite Namenszeile des Unternehmens.
- direct_dialstring
  Durchwahl der Firma.
- invoice_emailstring
  E-Mail-Adresse für Rechnungen.
- send_invoice_emailboolean
  Rechnungen per E-Mail versenden.
- send_invoice_letterboolean
  Rechnungen per Brief versenden.
- time_report_emailstring
  E-Mail-Adresse für Zeitberichte.
- payment_goalPaymentGoal
  Zahlungsbedingung der Firma.
- payment_intervalstring
  Intervall der Zahlungen.
- vatidstring
  Umsatzsteuer-Identifikationsnummer.
- taxnumberstring
  Steuernummer des Unternehmens.
- buyer_reference_idstring
  Leitweg-ID oder vom Kunden definierte individuelle Referenz-ID
- taxTax
  Für das Unternehmen verwendeter Steuersatz.
- infostring
  Informationen zur Firma.
- numberstring
  Kunden- oder Lieferantennummer des Unternehmens.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Unternehmensnummer als Text, einschließlich Präfix.
- is_customerboolean
  Das Unternehmen ist ein Kunde.
- is_supplierboolean
  Das Unternehmen ist ein Lieferant.
- is_otherboolean
  Das Unternehmen ist weder Kunde noch Lieferant.
- is_memberboolean
  Das Unternehmen ist ein Mitglied.
- archivedboolean
  Das Unternehmen ist archiviert.
- categoryCRMCompanyCategory
  Kategorie des Unternehmens.
- visible_for_customerboolean
  Ob das Unternehmen für den Kunden sichtbar ist.
- founding_datestring (date-time)
  Gründungsdatum des Unternehmens.
- nace_sectionstring
  NACE-Abschnittscode (Buchstabe A-U)
- nace_codestring
  NACE-Code (numerisch, z. B. 01.11, 62.01)
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- payment_typePaymentType
- company_employee_countinteger
  Anzahl der Mitarbeitenden der Firma.
- company_founding_yearinteger
  Gründungsjahr des Unternehmens.
- company_family_ownedboolean
  Ob das Unternehmen familiengeführt ist.
- company_sales_volumestring
  Umsatzvolumen des Unternehmens.
- company_segmentstring
  Marktsegment der Firma.
search_stringstring
Text, unter dem die Entität gesucht werden kann.

Anfrage

curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'PUT', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.put(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42")
  .put(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/crm_person_contact_data_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/crm_person_contact_data.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await CrmPersonContactDataController.put(CrmPersonContactData.fromJson({}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "value": "string",
  "generated_value": "string",
  "contact_data_type": {
    "id": 42,
    "name": "Beispiel",
    "value": "string",
    "allow_self_service": true,
    "deleted": true
  },
  "company": {
    "id": 42,
    "short_name": "Beispiel",
    "company_name": "Beispiel",
    "secondary_name": "Beispiel",
    "invoice_email": "lena.hartmann@example.org",
    "send_invoice_email": true,
    "time_report_email": "lena.hartmann@example.org",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "search_string": "string"
}

Diese Methode aktualisiert ein CRMPersonContactData-Objekt

PATCH/api/crm/crmpersoncontactdatas/{id}

Pfad-Parameter

idPflichtstring

Antworten

200CRMPersonContactData aktualisierenCRMPersonContactData2

Felder anzeigen (7)

idinteger
Primärschlüssel des Kontaktdaten-Eintrags. Interne ID.
namestring
Name des Kontaktdateneintrags.
valuestring
Wert des Kontaktdateneintrags, z. B. eine Telefonnummer oder E-Mail-Adresse.
generated_valuestring
Aus dem eingegebenen Wert erzeugter Wert.
contact_data_typeContactDataType
Art der Kontaktdaten.
Felder anzeigen (5)
- idinteger
  Primärschlüssel des Kontaktdatentyps. Interne ID.
- namestring
  Name des Kontaktdatentyps, zum Beispiel Telefon oder E-Mail.
- valuestring
  Wert des Kontaktdatentyps.
- allow_self_serviceboolean
  Mitglieder dürfen diesen Kontaktdatentyp im Selbstservice bearbeiten.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
companyCRMCompany
Unternehmen, zu dem die Kontaktdaten gehören.
Felder anzeigen (55)
- idinteger
  Primärschlüssel des Unternehmens. Interne ID.
- short_namestring
  Kurzname des Unternehmens.
- company_namestring
  Rechtlicher Name der Firma.
- secondary_namestring
  Zweite Namenszeile des Unternehmens.
- direct_dialstring
  Durchwahl der Firma.
- invoice_emailstring
  E-Mail-Adresse für Rechnungen.
- send_invoice_emailboolean
  Rechnungen per E-Mail versenden.
- send_invoice_letterboolean
  Rechnungen per Brief versenden.
- time_report_emailstring
  E-Mail-Adresse für Zeitberichte.
- payment_goalPaymentGoal
  Zahlungsbedingung der Firma.
- payment_intervalstring
  Intervall der Zahlungen.
- vatidstring
  Umsatzsteuer-Identifikationsnummer.
- taxnumberstring
  Steuernummer des Unternehmens.
- buyer_reference_idstring
  Leitweg-ID oder vom Kunden definierte individuelle Referenz-ID
- taxTax
  Für das Unternehmen verwendeter Steuersatz.
- infostring
  Informationen zur Firma.
- numberstring
  Kunden- oder Lieferantennummer des Unternehmens.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Unternehmensnummer als Text, einschließlich Präfix.
- is_customerboolean
  Das Unternehmen ist ein Kunde.
- is_supplierboolean
  Das Unternehmen ist ein Lieferant.
- is_otherboolean
  Das Unternehmen ist weder Kunde noch Lieferant.
- is_memberboolean
  Das Unternehmen ist ein Mitglied.
- archivedboolean
  Das Unternehmen ist archiviert.
- categoryCRMCompanyCategory
  Kategorie des Unternehmens.
- visible_for_customerboolean
  Ob das Unternehmen für den Kunden sichtbar ist.
- founding_datestring (date-time)
  Gründungsdatum des Unternehmens.
- nace_sectionstring
  NACE-Abschnittscode (Buchstabe A-U)
- nace_codestring
  NACE-Code (numerisch, z. B. 01.11, 62.01)
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- payment_typePaymentType
- company_employee_countinteger
  Anzahl der Mitarbeitenden der Firma.
- company_founding_yearinteger
  Gründungsjahr des Unternehmens.
- company_family_ownedboolean
  Ob das Unternehmen familiengeführt ist.
- company_sales_volumestring
  Umsatzvolumen des Unternehmens.
- company_segmentstring
  Marktsegment der Firma.
search_stringstring
Text, unter dem die Entität gesucht werden kann.

Anfrage

curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'PATCH', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.patch(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Patch,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42")
  .patch(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42"

	req, _ := http.NewRequest("PATCH", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit package:http (kein Controller im Package iw_erp_api)

import 'package:http/http.dart' as http;

final response = await http.patch(
  Uri.parse('https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "value": "string",
  "generated_value": "string",
  "contact_data_type": {
    "id": 42,
    "name": "Beispiel",
    "value": "string",
    "allow_self_service": true,
    "deleted": true
  },
  "company": {
    "id": 42,
    "short_name": "Beispiel",
    "company_name": "Beispiel",
    "secondary_name": "Beispiel",
    "invoice_email": "lena.hartmann@example.org",
    "send_invoice_email": true,
    "time_report_email": "lena.hartmann@example.org",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "search_string": "string"
}

Diese Methode löscht ein einzelnes CRMPersonContactData-Objekt mit der angegebenen ID

DELETE/api/crm/crmpersoncontactdatas/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Eine CRMPersonContactData löschenCRMPersonContactData2

Felder anzeigen (7)

idinteger
Primärschlüssel des Kontaktdaten-Eintrags. Interne ID.
namestring
Name des Kontaktdateneintrags.
valuestring
Wert des Kontaktdateneintrags, z. B. eine Telefonnummer oder E-Mail-Adresse.
generated_valuestring
Aus dem eingegebenen Wert erzeugter Wert.
contact_data_typeContactDataType
Art der Kontaktdaten.
Felder anzeigen (5)
- idinteger
  Primärschlüssel des Kontaktdatentyps. Interne ID.
- namestring
  Name des Kontaktdatentyps, zum Beispiel Telefon oder E-Mail.
- valuestring
  Wert des Kontaktdatentyps.
- allow_self_serviceboolean
  Mitglieder dürfen diesen Kontaktdatentyp im Selbstservice bearbeiten.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
companyCRMCompany
Unternehmen, zu dem die Kontaktdaten gehören.
Felder anzeigen (55)
- idinteger
  Primärschlüssel des Unternehmens. Interne ID.
- short_namestring
  Kurzname des Unternehmens.
- company_namestring
  Rechtlicher Name der Firma.
- secondary_namestring
  Zweite Namenszeile des Unternehmens.
- direct_dialstring
  Durchwahl der Firma.
- invoice_emailstring
  E-Mail-Adresse für Rechnungen.
- send_invoice_emailboolean
  Rechnungen per E-Mail versenden.
- send_invoice_letterboolean
  Rechnungen per Brief versenden.
- time_report_emailstring
  E-Mail-Adresse für Zeitberichte.
- payment_goalPaymentGoal
  Zahlungsbedingung der Firma.
- payment_intervalstring
  Intervall der Zahlungen.
- vatidstring
  Umsatzsteuer-Identifikationsnummer.
- taxnumberstring
  Steuernummer des Unternehmens.
- buyer_reference_idstring
  Leitweg-ID oder vom Kunden definierte individuelle Referenz-ID
- taxTax
  Für das Unternehmen verwendeter Steuersatz.
- infostring
  Informationen zur Firma.
- numberstring
  Kunden- oder Lieferantennummer des Unternehmens.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Unternehmensnummer als Text, einschließlich Präfix.
- is_customerboolean
  Das Unternehmen ist ein Kunde.
- is_supplierboolean
  Das Unternehmen ist ein Lieferant.
- is_otherboolean
  Das Unternehmen ist weder Kunde noch Lieferant.
- is_memberboolean
  Das Unternehmen ist ein Mitglied.
- archivedboolean
  Das Unternehmen ist archiviert.
- categoryCRMCompanyCategory
  Kategorie des Unternehmens.
- visible_for_customerboolean
  Ob das Unternehmen für den Kunden sichtbar ist.
- founding_datestring (date-time)
  Gründungsdatum des Unternehmens.
- nace_sectionstring
  NACE-Abschnittscode (Buchstabe A-U)
- nace_codestring
  NACE-Code (numerisch, z. B. 01.11, 62.01)
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- payment_typePaymentType
- company_employee_countinteger
  Anzahl der Mitarbeitenden der Firma.
- company_founding_yearinteger
  Gründungsjahr des Unternehmens.
- company_family_ownedboolean
  Ob das Unternehmen familiengeführt ist.
- company_sales_volumestring
  Umsatzvolumen des Unternehmens.
- company_segmentstring
  Marktsegment der Firma.
search_stringstring
Text, unter dem die Entität gesucht werden kann.

Anfrage

curl --request DELETE \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'DELETE', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.delete(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Delete,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42")
  .delete(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/crm/crmpersoncontactdatas/42"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/crm_person_contact_data_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await CrmPersonContactDataController.delete('42');
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "value": "string",
  "generated_value": "string",
  "contact_data_type": {
    "id": 42,
    "name": "Beispiel",
    "value": "string",
    "allow_self_service": true,
    "deleted": true
  },
  "company": {
    "id": 42,
    "short_name": "Beispiel",
    "company_name": "Beispiel",
    "secondary_name": "Beispiel",
    "invoice_email": "lena.hartmann@example.org",
    "send_invoice_email": true,
    "time_report_email": "lena.hartmann@example.org",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "search_string": "string"
}