CRMDepartment

CRM7 EndpointsCRM / CRMDepartment

This method will get all CRMDepartment Objects

GET/api/crm/crmdepartments

Query parameters

`id`string
`name`string
`externalDescription`string
`internalDescription`string
`address`string
`addressStreet`string
`addressHouseNumber`string
`addressStreetLevel`string
`addressCo`string
`addressCity`string
`addressZip`string
`addressAdminLevel1`string
`addressCountry`string
`addressFullCountry`string
`addressGeoLat`string
`addressGeoLng`string
`created`string
`updated`string
`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns a list of CRMDepartment objectsarray<CRMDepartment>

Show fields (23)

idinteger
Primary key of the department. Internal ID.
companiesarray<CRMCompany>
Companies the department belongs to.
Show fields (55)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- secondary_namestring
  Second name line of the company.
- direct_dialstring
  Direct dial number of the company.
- invoice_emailstring
  E-mail address for invoices.
- send_invoice_emailboolean
  Send invoices by e-mail.
- send_invoice_letterboolean
  Send invoices by letter.
- time_report_emailstring
  E-mail address for time reports.
- payment_goalPaymentGoal
  Payment term of the company.
- payment_intervalstring
  Interval of the payments.
- vatidstring
  VAT identification number.
- taxnumberstring
  Tax number of the company.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- taxTax
  Tax rate used for the company.
- infostring
  Information about the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
- is_customerboolean
  The company is a customer.
- is_supplierboolean
  The company is a supplier.
- is_otherboolean
  The company is neither customer nor supplier.
- is_memberboolean
  The company is a member.
- archivedboolean
  The company is archived.
- categoryCRMCompanyCategory
  Category of the company.
- visible_for_customerboolean
  Whether the company is visible to the customer.
- founding_datestring (date-time)
  Founding date of the company.
- nace_sectionstring
  NACE section code (letter A-U)
- nace_codestring
  NACE code (numeric like 01.11, 62.01)
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- payment_typePaymentType
- company_employee_countinteger
  Number of employees of the company.
- company_founding_yearinteger
  Founding year of the company.
- company_family_ownedboolean
  Whether the company is family-owned.
- company_sales_volumestring
  Sales volume of the company.
- company_segmentstring
  Market segment of the company.
personsarray<CRMPerson10>
Persons assigned to the department.
Show fields (81)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- confirmed_gtc_timestring (date-time)
  Time the general terms and conditions were confirmed.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Time the person opted in to the chatbot.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Contact data of the person, for example phone and e-mail.
- archivedboolean
  Whether the person is archived.
- subscribed_newsletterboolean
  Whether the person subscribed to the newsletter.
- subscribed_magazineboolean
  Whether the person subscribed to the magazine.
- printed_member_cardboolean
  Whether a member card has been printed for the person.
- has_login_userboolean
  Whether the person has a login user.
- profile_picture_urlstring
  URL of the profile picture of the person.
- log_book_staffboolean
  Log book flag: staff.
- log_book_staff1boolean
  Log book flag: staff, level 1.
- log_book_staff2boolean
  Log book flag: staff, level 2.
- log_book_memberboolean
  Log book flag: member.
- log_book_trainerboolean
  Log book flag: trainer.
- log_book_trainer1boolean
  Log book flag: trainer, level 1.
- log_book_trainer2boolean
  Log book flag: trainer, level 2.
- log_book_head_of_departmentboolean
  Log book flag: head of department.
- log_book_supervisory_boardboolean
  Log book flag: supervisory board.
- log_book_board_of_directorsboolean
  Log book flag: board of directors.
- log_book_honorary_memberboolean
  Log book flag: honorary member.
- log_book_club_card_oneboolean
  Log book flag: club card.
- log_book_health_recoveredboolean
  Log book flag: recovered from illness.
- log_book_health_vaccinatedboolean
  Log book flag: vaccinated.
- log_book_health_vaccinated_additionstring
  Details of the vaccination.
- log_book_good_conductboolean
  Log book flag: certificate of good conduct.
- log_book_first_aidboolean
  Log book flag: first aid training.
- log_book_measles_vaccinationboolean
  Log book flag: measles vaccination.
- sync_lanistaboolean
  Whether the person is synchronized with Lanista.
- categoryCRMPersonCategory
  Person category.
- nicknamestring
  Nickname of the person.
- preferred_color_hexstring
  Preferred color of the person as hex value.
- avatar_tokenstring
  Token of the avatar image.
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Point in time the entity was created.
- … 2 more fields
addressstring
Address as text.
address_streetstring
Street of the address.
address_house_numberstring
House number of the address.
address_street_levelstring
Street and house number of the address.
address_costring
Care-of line of the address.
address_citystring
City of the address.
address_zipstring
Postal code of the address.
address_admin_level1string
First administrative level of the address, e.g. the federal state.
address_countrystring
Country code of the address.
address_full_countrystring
Full name of the country of the address.
address_geo_latstring
Latitude of the address.
address_geo_lngstring
Longitude of the address.
address_external_provider_idstring
field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
namestring
Name of the entity.
main_phonestring
Main phone number.
main_faxstring
Main fax number.
main_emailstring
Main e-mail address.
websitestring
Website address.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/crm/crmdepartments \
  --header 'x-iw-jwt-token: <TOKEN>'

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

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

import requests

url = "https://your-instance.iw-erp.de/api/crm/crmdepartments"

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://your-instance.iw-erp.de/api/crm/crmdepartments', [
  '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://your-instance.iw-erp.de/api/crm/crmdepartments"),
  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://your-instance.iw-erp.de/api/crm/crmdepartments")
  .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://your-instance.iw-erp.de/api/crm/crmdepartments"

	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 with package:http (no controller in the iw_erp_api package)

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

final response = await http.get(
  Uri.parse('https://your-instance.iw-erp.de/api/crm/crmdepartments'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);

Response 200 application/json

[
  {
    "id": 42,
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "name": "Beispiel",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "address": "string"
  }
]

Add a new CRMDepartment

POST/api/crm/crmdepartments

Responses

200Add a new CRMDepartmentCRMDepartment

Show fields (23)

idinteger
Primary key of the department. Internal ID.
companiesarray<CRMCompany>
Companies the department belongs to.
Show fields (55)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- secondary_namestring
  Second name line of the company.
- direct_dialstring
  Direct dial number of the company.
- invoice_emailstring
  E-mail address for invoices.
- send_invoice_emailboolean
  Send invoices by e-mail.
- send_invoice_letterboolean
  Send invoices by letter.
- time_report_emailstring
  E-mail address for time reports.
- payment_goalPaymentGoal
  Payment term of the company.
- payment_intervalstring
  Interval of the payments.
- vatidstring
  VAT identification number.
- taxnumberstring
  Tax number of the company.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- taxTax
  Tax rate used for the company.
- infostring
  Information about the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
- is_customerboolean
  The company is a customer.
- is_supplierboolean
  The company is a supplier.
- is_otherboolean
  The company is neither customer nor supplier.
- is_memberboolean
  The company is a member.
- archivedboolean
  The company is archived.
- categoryCRMCompanyCategory
  Category of the company.
- visible_for_customerboolean
  Whether the company is visible to the customer.
- founding_datestring (date-time)
  Founding date of the company.
- nace_sectionstring
  NACE section code (letter A-U)
- nace_codestring
  NACE code (numeric like 01.11, 62.01)
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- payment_typePaymentType
- company_employee_countinteger
  Number of employees of the company.
- company_founding_yearinteger
  Founding year of the company.
- company_family_ownedboolean
  Whether the company is family-owned.
- company_sales_volumestring
  Sales volume of the company.
- company_segmentstring
  Market segment of the company.
personsarray<CRMPerson10>
Persons assigned to the department.
Show fields (81)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- confirmed_gtc_timestring (date-time)
  Time the general terms and conditions were confirmed.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Time the person opted in to the chatbot.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Contact data of the person, for example phone and e-mail.
- archivedboolean
  Whether the person is archived.
- subscribed_newsletterboolean
  Whether the person subscribed to the newsletter.
- subscribed_magazineboolean
  Whether the person subscribed to the magazine.
- printed_member_cardboolean
  Whether a member card has been printed for the person.
- has_login_userboolean
  Whether the person has a login user.
- profile_picture_urlstring
  URL of the profile picture of the person.
- log_book_staffboolean
  Log book flag: staff.
- log_book_staff1boolean
  Log book flag: staff, level 1.
- log_book_staff2boolean
  Log book flag: staff, level 2.
- log_book_memberboolean
  Log book flag: member.
- log_book_trainerboolean
  Log book flag: trainer.
- log_book_trainer1boolean
  Log book flag: trainer, level 1.
- log_book_trainer2boolean
  Log book flag: trainer, level 2.
- log_book_head_of_departmentboolean
  Log book flag: head of department.
- log_book_supervisory_boardboolean
  Log book flag: supervisory board.
- log_book_board_of_directorsboolean
  Log book flag: board of directors.
- log_book_honorary_memberboolean
  Log book flag: honorary member.
- log_book_club_card_oneboolean
  Log book flag: club card.
- log_book_health_recoveredboolean
  Log book flag: recovered from illness.
- log_book_health_vaccinatedboolean
  Log book flag: vaccinated.
- log_book_health_vaccinated_additionstring
  Details of the vaccination.
- log_book_good_conductboolean
  Log book flag: certificate of good conduct.
- log_book_first_aidboolean
  Log book flag: first aid training.
- log_book_measles_vaccinationboolean
  Log book flag: measles vaccination.
- sync_lanistaboolean
  Whether the person is synchronized with Lanista.
- categoryCRMPersonCategory
  Person category.
- nicknamestring
  Nickname of the person.
- preferred_color_hexstring
  Preferred color of the person as hex value.
- avatar_tokenstring
  Token of the avatar image.
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Point in time the entity was created.
- … 2 more fields
addressstring
Address as text.
address_streetstring
Street of the address.
address_house_numberstring
House number of the address.
address_street_levelstring
Street and house number of the address.
address_costring
Care-of line of the address.
address_citystring
City of the address.
address_zipstring
Postal code of the address.
address_admin_level1string
First administrative level of the address, e.g. the federal state.
address_countrystring
Country code of the address.
address_full_countrystring
Full name of the country of the address.
address_geo_latstring
Latitude of the address.
address_geo_lngstring
Longitude of the address.
address_external_provider_idstring
field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
namestring
Name of the entity.
main_phonestring
Main phone number.
main_faxstring
Main fax number.
main_emailstring
Main e-mail address.
websitestring
Website address.

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/crm/crmdepartments \
  --header 'x-iw-jwt-token: <TOKEN>'

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

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

import requests

url = "https://your-instance.iw-erp.de/api/crm/crmdepartments"

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://your-instance.iw-erp.de/api/crm/crmdepartments', [
  '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://your-instance.iw-erp.de/api/crm/crmdepartments"),
  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://your-instance.iw-erp.de/api/crm/crmdepartments")
  .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://your-instance.iw-erp.de/api/crm/crmdepartments"

	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 with package:http (no controller in the iw_erp_api package)

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

final response = await http.post(
  Uri.parse('https://your-instance.iw-erp.de/api/crm/crmdepartments'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);

Response 200 application/json

{
  "id": 42,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "companies": [
    {
      "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"
    }
  ]
}

This method will get a single CRMDepartment Object with the given id

GET/api/crm/crmdepartments/{id}

Path parameters

idrequiredstring

Responses

200Returns a single CRMDepartmentCRMDepartment

Show fields (23)

idinteger
Primary key of the department. Internal ID.
companiesarray<CRMCompany>
Companies the department belongs to.
Show fields (55)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- secondary_namestring
  Second name line of the company.
- direct_dialstring
  Direct dial number of the company.
- invoice_emailstring
  E-mail address for invoices.
- send_invoice_emailboolean
  Send invoices by e-mail.
- send_invoice_letterboolean
  Send invoices by letter.
- time_report_emailstring
  E-mail address for time reports.
- payment_goalPaymentGoal
  Payment term of the company.
- payment_intervalstring
  Interval of the payments.
- vatidstring
  VAT identification number.
- taxnumberstring
  Tax number of the company.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- taxTax
  Tax rate used for the company.
- infostring
  Information about the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
- is_customerboolean
  The company is a customer.
- is_supplierboolean
  The company is a supplier.
- is_otherboolean
  The company is neither customer nor supplier.
- is_memberboolean
  The company is a member.
- archivedboolean
  The company is archived.
- categoryCRMCompanyCategory
  Category of the company.
- visible_for_customerboolean
  Whether the company is visible to the customer.
- founding_datestring (date-time)
  Founding date of the company.
- nace_sectionstring
  NACE section code (letter A-U)
- nace_codestring
  NACE code (numeric like 01.11, 62.01)
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- payment_typePaymentType
- company_employee_countinteger
  Number of employees of the company.
- company_founding_yearinteger
  Founding year of the company.
- company_family_ownedboolean
  Whether the company is family-owned.
- company_sales_volumestring
  Sales volume of the company.
- company_segmentstring
  Market segment of the company.
personsarray<CRMPerson10>
Persons assigned to the department.
Show fields (81)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- confirmed_gtc_timestring (date-time)
  Time the general terms and conditions were confirmed.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Time the person opted in to the chatbot.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Contact data of the person, for example phone and e-mail.
- archivedboolean
  Whether the person is archived.
- subscribed_newsletterboolean
  Whether the person subscribed to the newsletter.
- subscribed_magazineboolean
  Whether the person subscribed to the magazine.
- printed_member_cardboolean
  Whether a member card has been printed for the person.
- has_login_userboolean
  Whether the person has a login user.
- profile_picture_urlstring
  URL of the profile picture of the person.
- log_book_staffboolean
  Log book flag: staff.
- log_book_staff1boolean
  Log book flag: staff, level 1.
- log_book_staff2boolean
  Log book flag: staff, level 2.
- log_book_memberboolean
  Log book flag: member.
- log_book_trainerboolean
  Log book flag: trainer.
- log_book_trainer1boolean
  Log book flag: trainer, level 1.
- log_book_trainer2boolean
  Log book flag: trainer, level 2.
- log_book_head_of_departmentboolean
  Log book flag: head of department.
- log_book_supervisory_boardboolean
  Log book flag: supervisory board.
- log_book_board_of_directorsboolean
  Log book flag: board of directors.
- log_book_honorary_memberboolean
  Log book flag: honorary member.
- log_book_club_card_oneboolean
  Log book flag: club card.
- log_book_health_recoveredboolean
  Log book flag: recovered from illness.
- log_book_health_vaccinatedboolean
  Log book flag: vaccinated.
- log_book_health_vaccinated_additionstring
  Details of the vaccination.
- log_book_good_conductboolean
  Log book flag: certificate of good conduct.
- log_book_first_aidboolean
  Log book flag: first aid training.
- log_book_measles_vaccinationboolean
  Log book flag: measles vaccination.
- sync_lanistaboolean
  Whether the person is synchronized with Lanista.
- categoryCRMPersonCategory
  Person category.
- nicknamestring
  Nickname of the person.
- preferred_color_hexstring
  Preferred color of the person as hex value.
- avatar_tokenstring
  Token of the avatar image.
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Point in time the entity was created.
- … 2 more fields
addressstring
Address as text.
address_streetstring
Street of the address.
address_house_numberstring
House number of the address.
address_street_levelstring
Street and house number of the address.
address_costring
Care-of line of the address.
address_citystring
City of the address.
address_zipstring
Postal code of the address.
address_admin_level1string
First administrative level of the address, e.g. the federal state.
address_countrystring
Country code of the address.
address_full_countrystring
Full name of the country of the address.
address_geo_latstring
Latitude of the address.
address_geo_lngstring
Longitude of the address.
address_external_provider_idstring
field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
namestring
Name of the entity.
main_phonestring
Main phone number.
main_faxstring
Main fax number.
main_emailstring
Main e-mail address.
websitestring
Website address.

Request

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

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

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

import requests

url = "https://your-instance.iw-erp.de/api/crm/crmdepartments/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://your-instance.iw-erp.de/api/crm/crmdepartments/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://your-instance.iw-erp.de/api/crm/crmdepartments/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://your-instance.iw-erp.de/api/crm/crmdepartments/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://your-instance.iw-erp.de/api/crm/crmdepartments/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 with package:http (no controller in the iw_erp_api package)

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

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

Response 200 application/json

{
  "id": 42,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "companies": [
    {
      "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"
    }
  ]
}

This method will update a CRMDepartment Object

PUT/api/crm/crmdepartments/{id}

Path parameters

idrequiredstring

Responses

200Update a CRMDepartmentCRMDepartment

Show fields (23)

idinteger
Primary key of the department. Internal ID.
companiesarray<CRMCompany>
Companies the department belongs to.
Show fields (55)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- secondary_namestring
  Second name line of the company.
- direct_dialstring
  Direct dial number of the company.
- invoice_emailstring
  E-mail address for invoices.
- send_invoice_emailboolean
  Send invoices by e-mail.
- send_invoice_letterboolean
  Send invoices by letter.
- time_report_emailstring
  E-mail address for time reports.
- payment_goalPaymentGoal
  Payment term of the company.
- payment_intervalstring
  Interval of the payments.
- vatidstring
  VAT identification number.
- taxnumberstring
  Tax number of the company.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- taxTax
  Tax rate used for the company.
- infostring
  Information about the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
- is_customerboolean
  The company is a customer.
- is_supplierboolean
  The company is a supplier.
- is_otherboolean
  The company is neither customer nor supplier.
- is_memberboolean
  The company is a member.
- archivedboolean
  The company is archived.
- categoryCRMCompanyCategory
  Category of the company.
- visible_for_customerboolean
  Whether the company is visible to the customer.
- founding_datestring (date-time)
  Founding date of the company.
- nace_sectionstring
  NACE section code (letter A-U)
- nace_codestring
  NACE code (numeric like 01.11, 62.01)
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- payment_typePaymentType
- company_employee_countinteger
  Number of employees of the company.
- company_founding_yearinteger
  Founding year of the company.
- company_family_ownedboolean
  Whether the company is family-owned.
- company_sales_volumestring
  Sales volume of the company.
- company_segmentstring
  Market segment of the company.
personsarray<CRMPerson10>
Persons assigned to the department.
Show fields (81)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- confirmed_gtc_timestring (date-time)
  Time the general terms and conditions were confirmed.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Time the person opted in to the chatbot.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Contact data of the person, for example phone and e-mail.
- archivedboolean
  Whether the person is archived.
- subscribed_newsletterboolean
  Whether the person subscribed to the newsletter.
- subscribed_magazineboolean
  Whether the person subscribed to the magazine.
- printed_member_cardboolean
  Whether a member card has been printed for the person.
- has_login_userboolean
  Whether the person has a login user.
- profile_picture_urlstring
  URL of the profile picture of the person.
- log_book_staffboolean
  Log book flag: staff.
- log_book_staff1boolean
  Log book flag: staff, level 1.
- log_book_staff2boolean
  Log book flag: staff, level 2.
- log_book_memberboolean
  Log book flag: member.
- log_book_trainerboolean
  Log book flag: trainer.
- log_book_trainer1boolean
  Log book flag: trainer, level 1.
- log_book_trainer2boolean
  Log book flag: trainer, level 2.
- log_book_head_of_departmentboolean
  Log book flag: head of department.
- log_book_supervisory_boardboolean
  Log book flag: supervisory board.
- log_book_board_of_directorsboolean
  Log book flag: board of directors.
- log_book_honorary_memberboolean
  Log book flag: honorary member.
- log_book_club_card_oneboolean
  Log book flag: club card.
- log_book_health_recoveredboolean
  Log book flag: recovered from illness.
- log_book_health_vaccinatedboolean
  Log book flag: vaccinated.
- log_book_health_vaccinated_additionstring
  Details of the vaccination.
- log_book_good_conductboolean
  Log book flag: certificate of good conduct.
- log_book_first_aidboolean
  Log book flag: first aid training.
- log_book_measles_vaccinationboolean
  Log book flag: measles vaccination.
- sync_lanistaboolean
  Whether the person is synchronized with Lanista.
- categoryCRMPersonCategory
  Person category.
- nicknamestring
  Nickname of the person.
- preferred_color_hexstring
  Preferred color of the person as hex value.
- avatar_tokenstring
  Token of the avatar image.
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Point in time the entity was created.
- … 2 more fields
addressstring
Address as text.
address_streetstring
Street of the address.
address_house_numberstring
House number of the address.
address_street_levelstring
Street and house number of the address.
address_costring
Care-of line of the address.
address_citystring
City of the address.
address_zipstring
Postal code of the address.
address_admin_level1string
First administrative level of the address, e.g. the federal state.
address_countrystring
Country code of the address.
address_full_countrystring
Full name of the country of the address.
address_geo_latstring
Latitude of the address.
address_geo_lngstring
Longitude of the address.
address_external_provider_idstring
field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
namestring
Name of the entity.
main_phonestring
Main phone number.
main_faxstring
Main fax number.
main_emailstring
Main e-mail address.
websitestring
Website address.

Request

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

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

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

import requests

url = "https://your-instance.iw-erp.de/api/crm/crmdepartments/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://your-instance.iw-erp.de/api/crm/crmdepartments/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://your-instance.iw-erp.de/api/crm/crmdepartments/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://your-instance.iw-erp.de/api/crm/crmdepartments/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://your-instance.iw-erp.de/api/crm/crmdepartments/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 with package:http (no controller in the iw_erp_api package)

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

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

Response 200 application/json

{
  "id": 42,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "companies": [
    {
      "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"
    }
  ]
}

This method will update a CRMDepartment Object

PATCH/api/crm/crmdepartments/{id}

Path parameters

idrequiredstring

Responses

200Update a CRMDepartmentCRMDepartment

Show fields (23)

idinteger
Primary key of the department. Internal ID.
companiesarray<CRMCompany>
Companies the department belongs to.
Show fields (55)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- secondary_namestring
  Second name line of the company.
- direct_dialstring
  Direct dial number of the company.
- invoice_emailstring
  E-mail address for invoices.
- send_invoice_emailboolean
  Send invoices by e-mail.
- send_invoice_letterboolean
  Send invoices by letter.
- time_report_emailstring
  E-mail address for time reports.
- payment_goalPaymentGoal
  Payment term of the company.
- payment_intervalstring
  Interval of the payments.
- vatidstring
  VAT identification number.
- taxnumberstring
  Tax number of the company.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- taxTax
  Tax rate used for the company.
- infostring
  Information about the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
- is_customerboolean
  The company is a customer.
- is_supplierboolean
  The company is a supplier.
- is_otherboolean
  The company is neither customer nor supplier.
- is_memberboolean
  The company is a member.
- archivedboolean
  The company is archived.
- categoryCRMCompanyCategory
  Category of the company.
- visible_for_customerboolean
  Whether the company is visible to the customer.
- founding_datestring (date-time)
  Founding date of the company.
- nace_sectionstring
  NACE section code (letter A-U)
- nace_codestring
  NACE code (numeric like 01.11, 62.01)
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- payment_typePaymentType
- company_employee_countinteger
  Number of employees of the company.
- company_founding_yearinteger
  Founding year of the company.
- company_family_ownedboolean
  Whether the company is family-owned.
- company_sales_volumestring
  Sales volume of the company.
- company_segmentstring
  Market segment of the company.
personsarray<CRMPerson10>
Persons assigned to the department.
Show fields (81)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- confirmed_gtc_timestring (date-time)
  Time the general terms and conditions were confirmed.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Time the person opted in to the chatbot.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Contact data of the person, for example phone and e-mail.
- archivedboolean
  Whether the person is archived.
- subscribed_newsletterboolean
  Whether the person subscribed to the newsletter.
- subscribed_magazineboolean
  Whether the person subscribed to the magazine.
- printed_member_cardboolean
  Whether a member card has been printed for the person.
- has_login_userboolean
  Whether the person has a login user.
- profile_picture_urlstring
  URL of the profile picture of the person.
- log_book_staffboolean
  Log book flag: staff.
- log_book_staff1boolean
  Log book flag: staff, level 1.
- log_book_staff2boolean
  Log book flag: staff, level 2.
- log_book_memberboolean
  Log book flag: member.
- log_book_trainerboolean
  Log book flag: trainer.
- log_book_trainer1boolean
  Log book flag: trainer, level 1.
- log_book_trainer2boolean
  Log book flag: trainer, level 2.
- log_book_head_of_departmentboolean
  Log book flag: head of department.
- log_book_supervisory_boardboolean
  Log book flag: supervisory board.
- log_book_board_of_directorsboolean
  Log book flag: board of directors.
- log_book_honorary_memberboolean
  Log book flag: honorary member.
- log_book_club_card_oneboolean
  Log book flag: club card.
- log_book_health_recoveredboolean
  Log book flag: recovered from illness.
- log_book_health_vaccinatedboolean
  Log book flag: vaccinated.
- log_book_health_vaccinated_additionstring
  Details of the vaccination.
- log_book_good_conductboolean
  Log book flag: certificate of good conduct.
- log_book_first_aidboolean
  Log book flag: first aid training.
- log_book_measles_vaccinationboolean
  Log book flag: measles vaccination.
- sync_lanistaboolean
  Whether the person is synchronized with Lanista.
- categoryCRMPersonCategory
  Person category.
- nicknamestring
  Nickname of the person.
- preferred_color_hexstring
  Preferred color of the person as hex value.
- avatar_tokenstring
  Token of the avatar image.
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Point in time the entity was created.
- … 2 more fields
addressstring
Address as text.
address_streetstring
Street of the address.
address_house_numberstring
House number of the address.
address_street_levelstring
Street and house number of the address.
address_costring
Care-of line of the address.
address_citystring
City of the address.
address_zipstring
Postal code of the address.
address_admin_level1string
First administrative level of the address, e.g. the federal state.
address_countrystring
Country code of the address.
address_full_countrystring
Full name of the country of the address.
address_geo_latstring
Latitude of the address.
address_geo_lngstring
Longitude of the address.
address_external_provider_idstring
field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
namestring
Name of the entity.
main_phonestring
Main phone number.
main_faxstring
Main fax number.
main_emailstring
Main e-mail address.
websitestring
Website address.

Request

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

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

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

import requests

url = "https://your-instance.iw-erp.de/api/crm/crmdepartments/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://your-instance.iw-erp.de/api/crm/crmdepartments/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://your-instance.iw-erp.de/api/crm/crmdepartments/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://your-instance.iw-erp.de/api/crm/crmdepartments/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://your-instance.iw-erp.de/api/crm/crmdepartments/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 with package:http (no controller in the iw_erp_api package)

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

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

Response 200 application/json

{
  "id": 42,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "companies": [
    {
      "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"
    }
  ]
}

Add a CRMPerson to a CRMDepartment

POST/api/crm/crmdepartments/{id}/adds/people

Path parameters

idrequiredstring

Responses

200Add a CRMPerson to a CRMDepartmentCRMDepartment

Show fields (23)

idinteger
Primary key of the department. Internal ID.
companiesarray<CRMCompany>
Companies the department belongs to.
Show fields (55)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- secondary_namestring
  Second name line of the company.
- direct_dialstring
  Direct dial number of the company.
- invoice_emailstring
  E-mail address for invoices.
- send_invoice_emailboolean
  Send invoices by e-mail.
- send_invoice_letterboolean
  Send invoices by letter.
- time_report_emailstring
  E-mail address for time reports.
- payment_goalPaymentGoal
  Payment term of the company.
- payment_intervalstring
  Interval of the payments.
- vatidstring
  VAT identification number.
- taxnumberstring
  Tax number of the company.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- taxTax
  Tax rate used for the company.
- infostring
  Information about the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
- is_customerboolean
  The company is a customer.
- is_supplierboolean
  The company is a supplier.
- is_otherboolean
  The company is neither customer nor supplier.
- is_memberboolean
  The company is a member.
- archivedboolean
  The company is archived.
- categoryCRMCompanyCategory
  Category of the company.
- visible_for_customerboolean
  Whether the company is visible to the customer.
- founding_datestring (date-time)
  Founding date of the company.
- nace_sectionstring
  NACE section code (letter A-U)
- nace_codestring
  NACE code (numeric like 01.11, 62.01)
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- payment_typePaymentType
- company_employee_countinteger
  Number of employees of the company.
- company_founding_yearinteger
  Founding year of the company.
- company_family_ownedboolean
  Whether the company is family-owned.
- company_sales_volumestring
  Sales volume of the company.
- company_segmentstring
  Market segment of the company.
personsarray<CRMPerson10>
Persons assigned to the department.
Show fields (81)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- confirmed_gtc_timestring (date-time)
  Time the general terms and conditions were confirmed.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Time the person opted in to the chatbot.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Contact data of the person, for example phone and e-mail.
- archivedboolean
  Whether the person is archived.
- subscribed_newsletterboolean
  Whether the person subscribed to the newsletter.
- subscribed_magazineboolean
  Whether the person subscribed to the magazine.
- printed_member_cardboolean
  Whether a member card has been printed for the person.
- has_login_userboolean
  Whether the person has a login user.
- profile_picture_urlstring
  URL of the profile picture of the person.
- log_book_staffboolean
  Log book flag: staff.
- log_book_staff1boolean
  Log book flag: staff, level 1.
- log_book_staff2boolean
  Log book flag: staff, level 2.
- log_book_memberboolean
  Log book flag: member.
- log_book_trainerboolean
  Log book flag: trainer.
- log_book_trainer1boolean
  Log book flag: trainer, level 1.
- log_book_trainer2boolean
  Log book flag: trainer, level 2.
- log_book_head_of_departmentboolean
  Log book flag: head of department.
- log_book_supervisory_boardboolean
  Log book flag: supervisory board.
- log_book_board_of_directorsboolean
  Log book flag: board of directors.
- log_book_honorary_memberboolean
  Log book flag: honorary member.
- log_book_club_card_oneboolean
  Log book flag: club card.
- log_book_health_recoveredboolean
  Log book flag: recovered from illness.
- log_book_health_vaccinatedboolean
  Log book flag: vaccinated.
- log_book_health_vaccinated_additionstring
  Details of the vaccination.
- log_book_good_conductboolean
  Log book flag: certificate of good conduct.
- log_book_first_aidboolean
  Log book flag: first aid training.
- log_book_measles_vaccinationboolean
  Log book flag: measles vaccination.
- sync_lanistaboolean
  Whether the person is synchronized with Lanista.
- categoryCRMPersonCategory
  Person category.
- nicknamestring
  Nickname of the person.
- preferred_color_hexstring
  Preferred color of the person as hex value.
- avatar_tokenstring
  Token of the avatar image.
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Point in time the entity was created.
- … 2 more fields
addressstring
Address as text.
address_streetstring
Street of the address.
address_house_numberstring
House number of the address.
address_street_levelstring
Street and house number of the address.
address_costring
Care-of line of the address.
address_citystring
City of the address.
address_zipstring
Postal code of the address.
address_admin_level1string
First administrative level of the address, e.g. the federal state.
address_countrystring
Country code of the address.
address_full_countrystring
Full name of the country of the address.
address_geo_latstring
Latitude of the address.
address_geo_lngstring
Longitude of the address.
address_external_provider_idstring
field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
namestring
Name of the entity.
main_phonestring
Main phone number.
main_faxstring
Main fax number.
main_emailstring
Main e-mail address.
websitestring
Website address.

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/crm/crmdepartments/42/adds/people \
  --header 'x-iw-jwt-token: <TOKEN>'

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

fetch('https://your-instance.iw-erp.de/api/crm/crmdepartments/42/adds/people', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/crm/crmdepartments/42/adds/people"

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://your-instance.iw-erp.de/api/crm/crmdepartments/42/adds/people', [
  '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://your-instance.iw-erp.de/api/crm/crmdepartments/42/adds/people"),
  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://your-instance.iw-erp.de/api/crm/crmdepartments/42/adds/people")
  .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://your-instance.iw-erp.de/api/crm/crmdepartments/42/adds/people"

	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 with package:http (no controller in the iw_erp_api package)

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

final response = await http.post(
  Uri.parse('https://your-instance.iw-erp.de/api/crm/crmdepartments/42/adds/people'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);

Response 200 application/json

{
  "id": 42,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "companies": [
    {
      "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"
    }
  ]
}

Delete a CRMPerson from a CRMDepartment

POST/api/crm/crmdepartments/{id}/deletes/people

Path parameters

idrequiredstring

Responses

200Delete a CRMPerson from a CRMDepartmentCRMDepartment

Show fields (23)

idinteger
Primary key of the department. Internal ID.
companiesarray<CRMCompany>
Companies the department belongs to.
Show fields (55)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- secondary_namestring
  Second name line of the company.
- direct_dialstring
  Direct dial number of the company.
- invoice_emailstring
  E-mail address for invoices.
- send_invoice_emailboolean
  Send invoices by e-mail.
- send_invoice_letterboolean
  Send invoices by letter.
- time_report_emailstring
  E-mail address for time reports.
- payment_goalPaymentGoal
  Payment term of the company.
- payment_intervalstring
  Interval of the payments.
- vatidstring
  VAT identification number.
- taxnumberstring
  Tax number of the company.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- taxTax
  Tax rate used for the company.
- infostring
  Information about the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
- is_customerboolean
  The company is a customer.
- is_supplierboolean
  The company is a supplier.
- is_otherboolean
  The company is neither customer nor supplier.
- is_memberboolean
  The company is a member.
- archivedboolean
  The company is archived.
- categoryCRMCompanyCategory
  Category of the company.
- visible_for_customerboolean
  Whether the company is visible to the customer.
- founding_datestring (date-time)
  Founding date of the company.
- nace_sectionstring
  NACE section code (letter A-U)
- nace_codestring
  NACE code (numeric like 01.11, 62.01)
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- payment_typePaymentType
- company_employee_countinteger
  Number of employees of the company.
- company_founding_yearinteger
  Founding year of the company.
- company_family_ownedboolean
  Whether the company is family-owned.
- company_sales_volumestring
  Sales volume of the company.
- company_segmentstring
  Market segment of the company.
personsarray<CRMPerson10>
Persons assigned to the department.
Show fields (81)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- confirmed_gtc_timestring (date-time)
  Time the general terms and conditions were confirmed.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Time the person opted in to the chatbot.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Contact data of the person, for example phone and e-mail.
- archivedboolean
  Whether the person is archived.
- subscribed_newsletterboolean
  Whether the person subscribed to the newsletter.
- subscribed_magazineboolean
  Whether the person subscribed to the magazine.
- printed_member_cardboolean
  Whether a member card has been printed for the person.
- has_login_userboolean
  Whether the person has a login user.
- profile_picture_urlstring
  URL of the profile picture of the person.
- log_book_staffboolean
  Log book flag: staff.
- log_book_staff1boolean
  Log book flag: staff, level 1.
- log_book_staff2boolean
  Log book flag: staff, level 2.
- log_book_memberboolean
  Log book flag: member.
- log_book_trainerboolean
  Log book flag: trainer.
- log_book_trainer1boolean
  Log book flag: trainer, level 1.
- log_book_trainer2boolean
  Log book flag: trainer, level 2.
- log_book_head_of_departmentboolean
  Log book flag: head of department.
- log_book_supervisory_boardboolean
  Log book flag: supervisory board.
- log_book_board_of_directorsboolean
  Log book flag: board of directors.
- log_book_honorary_memberboolean
  Log book flag: honorary member.
- log_book_club_card_oneboolean
  Log book flag: club card.
- log_book_health_recoveredboolean
  Log book flag: recovered from illness.
- log_book_health_vaccinatedboolean
  Log book flag: vaccinated.
- log_book_health_vaccinated_additionstring
  Details of the vaccination.
- log_book_good_conductboolean
  Log book flag: certificate of good conduct.
- log_book_first_aidboolean
  Log book flag: first aid training.
- log_book_measles_vaccinationboolean
  Log book flag: measles vaccination.
- sync_lanistaboolean
  Whether the person is synchronized with Lanista.
- categoryCRMPersonCategory
  Person category.
- nicknamestring
  Nickname of the person.
- preferred_color_hexstring
  Preferred color of the person as hex value.
- avatar_tokenstring
  Token of the avatar image.
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Point in time the entity was created.
- … 2 more fields
addressstring
Address as text.
address_streetstring
Street of the address.
address_house_numberstring
House number of the address.
address_street_levelstring
Street and house number of the address.
address_costring
Care-of line of the address.
address_citystring
City of the address.
address_zipstring
Postal code of the address.
address_admin_level1string
First administrative level of the address, e.g. the federal state.
address_countrystring
Country code of the address.
address_full_countrystring
Full name of the country of the address.
address_geo_latstring
Latitude of the address.
address_geo_lngstring
Longitude of the address.
address_external_provider_idstring
field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
namestring
Name of the entity.
main_phonestring
Main phone number.
main_faxstring
Main fax number.
main_emailstring
Main e-mail address.
websitestring
Website address.

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/crm/crmdepartments/42/deletes/people \
  --header 'x-iw-jwt-token: <TOKEN>'

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

fetch('https://your-instance.iw-erp.de/api/crm/crmdepartments/42/deletes/people', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/crm/crmdepartments/42/deletes/people"

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://your-instance.iw-erp.de/api/crm/crmdepartments/42/deletes/people', [
  '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://your-instance.iw-erp.de/api/crm/crmdepartments/42/deletes/people"),
  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://your-instance.iw-erp.de/api/crm/crmdepartments/42/deletes/people")
  .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://your-instance.iw-erp.de/api/crm/crmdepartments/42/deletes/people"

	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 with package:http (no controller in the iw_erp_api package)

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

final response = await http.post(
  Uri.parse('https://your-instance.iw-erp.de/api/crm/crmdepartments/42/deletes/people'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);

Response 200 application/json

{
  "id": 42,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "companies": [
    {
      "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"
    }
  ]
}