CRMCompanyCategory
Diese Methode liefert alle CRMCompanyCategory-Objekte
GET/api/crm/crmcompanycategory
Query-Parameter
idstring | |
namestring | |
externalDescriptionstring | |
internalDescriptionstring | |
createdstring | |
updatedstring | |
searchStringstring | Text, nach dem in der Liste gesucht wird |
orderFieldNamestring | Name des Bestellfelds |
orderFieldSortstring | SortiermodusErlaubt: DESCASC |
pageinteger | Seite der Liste |
pageSizeinteger | Anzahl der Einträge je Seite |
withMaxPageNumberstring | gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist |
Antworten
200Liefert eine Liste der CRMCompanyCategory-Objekte.array<CRMCompanyCategory>
Felder anzeigen (10)
idintegerPrimärschlüssel der Unternehmenskategorie. Interne ID.
namestringName der Firmenkategorie.
descriptionstringBeschreibung der Firmenkategorie.
deletedbooleanDie Kategorie ist gelöscht.
global_defaultbooleanStandardkategorie für neue Firmen.
enabled_customer_portalbooleanUnternehmen dieser Kategorie dürfen das Kundenportal nutzen.
g_drive_root_dirstringStammordner in Google Drive für Unternehmen dieser Kategorie.
g_drive_root_dir_archivedstringStammordner in Google Drive für archivierte Unternehmen dieser Kategorie.
require_company_addressbooleanFür Unternehmen dieser Kategorie muss eine Adresse eingegeben werden.
require_company_billingbooleanFür Unternehmen dieser Kategorie müssen Abrechnungsdaten eingegeben werden.
Anfrage
curl --request GET \
--url https://eure-instanz.iw-erp.de/api/crm/crmcompanycategory \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://eure-instanz.iw-erp.de/api/crm/crmcompanycategory', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://eure-instanz.iw-erp.de/api/crm/crmcompanycategory"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://eure-instanz.iw-erp.de/api/crm/crmcompanycategory', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/crm/crmcompanycategory"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://eure-instanz.iw-erp.de/api/crm/crmcompanycategory")
.get()
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://eure-instanz.iw-erp.de/api/crm/crmcompanycategory"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart mit dem Package iw_erp_api
import 'package:iw_erp_api/clients/crm_company_category_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await CrmCompanyCategoryController.getAll();
if (result.success) {
print(result.data);
}Antwort 200 application/json
[
{
"id": 42,
"name": "Beispiel",
"description": "Text",
"deleted": true,
"global_default": true,
"enabled_customer_portal": true,
"g_drive_root_dir": "string",
"g_drive_root_dir_archived": "string",
"require_company_address": true,
"require_company_billing": true
}
]