# easybill_generated_sync.CustomerGroupApi All URIs are relative to *https://api.easybill.de/rest/v1* Method | HTTP request | Description ------------- | ------------- | ------------- [**customer_groups_get**](CustomerGroupApi.md#customer_groups_get) | **GET** /customer-groups | Fetch customer group list [**customer_groups_id_delete**](CustomerGroupApi.md#customer_groups_id_delete) | **DELETE** /customer-groups/{id} | Delete customer group [**customer_groups_id_get**](CustomerGroupApi.md#customer_groups_id_get) | **GET** /customer-groups/{id} | Fetch customer group [**customer_groups_id_put**](CustomerGroupApi.md#customer_groups_id_put) | **PUT** /customer-groups/{id} | Update customer group [**customer_groups_post**](CustomerGroupApi.md#customer_groups_post) | **POST** /customer-groups | Create customer group # **customer_groups_get** > CustomerGroups customer_groups_get(limit=limit, page=page) Fetch customer group list ### Example * Basic Authentication (basicAuth): * Api Key Authentication (Bearer): ```python import easybill_generated_sync from easybill_generated_sync.models.customer_groups import CustomerGroups from easybill_generated_sync.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://api.easybill.de/rest/v1 # See configuration.py for a list of all supported configuration parameters. configuration = easybill_generated_sync.Configuration( host = "https://api.easybill.de/rest/v1" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure HTTP basic authorization: basicAuth configuration = easybill_generated_sync.Configuration( username = os.environ["USERNAME"], password = os.environ["PASSWORD"] ) # Configure API key authorization: Bearer configuration.api_key['Bearer'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Bearer'] = 'Bearer' # Enter a context with an instance of the API client async with easybill_generated_sync.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = easybill_generated_sync.CustomerGroupApi(api_client) limit = 56 # int | Limited the result. Default is 100. Maximum can be 1000. (optional) page = 56 # int | Set current Page. Default is 1. (optional) try: # Fetch customer group list api_response = await api_instance.customer_groups_get(limit=limit, page=page) print("The response of CustomerGroupApi->customer_groups_get:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomerGroupApi->customer_groups_get: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Limited the result. Default is 100. Maximum can be 1000. | [optional] **page** | **int**| Set current Page. Default is 1. | [optional] ### Return type [**CustomerGroups**](CustomerGroups.md) ### Authorization [basicAuth](../README.md#basicAuth), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful operation | - | **429** | Too Many Requests | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **customer_groups_id_delete** > customer_groups_id_delete(id) Delete customer group ### Example * Basic Authentication (basicAuth): * Api Key Authentication (Bearer): ```python import easybill_generated_sync from easybill_generated_sync.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://api.easybill.de/rest/v1 # See configuration.py for a list of all supported configuration parameters. configuration = easybill_generated_sync.Configuration( host = "https://api.easybill.de/rest/v1" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure HTTP basic authorization: basicAuth configuration = easybill_generated_sync.Configuration( username = os.environ["USERNAME"], password = os.environ["PASSWORD"] ) # Configure API key authorization: Bearer configuration.api_key['Bearer'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Bearer'] = 'Bearer' # Enter a context with an instance of the API client async with easybill_generated_sync.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = easybill_generated_sync.CustomerGroupApi(api_client) id = 56 # int | ID of customer group try: # Delete customer group await api_instance.customer_groups_id_delete(id) except Exception as e: print("Exception when calling CustomerGroupApi->customer_groups_id_delete: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **int**| ID of customer group | ### Return type void (empty response body) ### Authorization [basicAuth](../README.md#basicAuth), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | Successful operation | - | **404** | Not found | - | **429** | Too Many Requests | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **customer_groups_id_get** > CustomerGroup customer_groups_id_get(id) Fetch customer group ### Example * Basic Authentication (basicAuth): * Api Key Authentication (Bearer): ```python import easybill_generated_sync from easybill_generated_sync.models.customer_group import CustomerGroup from easybill_generated_sync.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://api.easybill.de/rest/v1 # See configuration.py for a list of all supported configuration parameters. configuration = easybill_generated_sync.Configuration( host = "https://api.easybill.de/rest/v1" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure HTTP basic authorization: basicAuth configuration = easybill_generated_sync.Configuration( username = os.environ["USERNAME"], password = os.environ["PASSWORD"] ) # Configure API key authorization: Bearer configuration.api_key['Bearer'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Bearer'] = 'Bearer' # Enter a context with an instance of the API client async with easybill_generated_sync.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = easybill_generated_sync.CustomerGroupApi(api_client) id = 56 # int | ID of customer group try: # Fetch customer group api_response = await api_instance.customer_groups_id_get(id) print("The response of CustomerGroupApi->customer_groups_id_get:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomerGroupApi->customer_groups_id_get: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **int**| ID of customer group | ### Return type [**CustomerGroup**](CustomerGroup.md) ### Authorization [basicAuth](../README.md#basicAuth), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful operation | - | **404** | Not found | - | **429** | Too Many Requests | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **customer_groups_id_put** > CustomerGroup customer_groups_id_put(id, body) Update customer group ### Example * Basic Authentication (basicAuth): * Api Key Authentication (Bearer): ```python import easybill_generated_sync from easybill_generated_sync.models.customer_group import CustomerGroup from easybill_generated_sync.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://api.easybill.de/rest/v1 # See configuration.py for a list of all supported configuration parameters. configuration = easybill_generated_sync.Configuration( host = "https://api.easybill.de/rest/v1" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure HTTP basic authorization: basicAuth configuration = easybill_generated_sync.Configuration( username = os.environ["USERNAME"], password = os.environ["PASSWORD"] ) # Configure API key authorization: Bearer configuration.api_key['Bearer'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Bearer'] = 'Bearer' # Enter a context with an instance of the API client async with easybill_generated_sync.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = easybill_generated_sync.CustomerGroupApi(api_client) id = 56 # int | ID of customer goup body = easybill_generated_sync.CustomerGroup() # CustomerGroup | try: # Update customer group api_response = await api_instance.customer_groups_id_put(id, body) print("The response of CustomerGroupApi->customer_groups_id_put:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomerGroupApi->customer_groups_id_put: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **int**| ID of customer goup | **body** | [**CustomerGroup**](CustomerGroup.md)| | ### Return type [**CustomerGroup**](CustomerGroup.md) ### Authorization [basicAuth](../README.md#basicAuth), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful operation | - | **400** | Invalid customer group | - | **429** | Too Many Requests | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **customer_groups_post** > CustomerGroup customer_groups_post(body) Create customer group ### Example * Basic Authentication (basicAuth): * Api Key Authentication (Bearer): ```python import easybill_generated_sync from easybill_generated_sync.models.customer_group import CustomerGroup from easybill_generated_sync.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://api.easybill.de/rest/v1 # See configuration.py for a list of all supported configuration parameters. configuration = easybill_generated_sync.Configuration( host = "https://api.easybill.de/rest/v1" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure HTTP basic authorization: basicAuth configuration = easybill_generated_sync.Configuration( username = os.environ["USERNAME"], password = os.environ["PASSWORD"] ) # Configure API key authorization: Bearer configuration.api_key['Bearer'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Bearer'] = 'Bearer' # Enter a context with an instance of the API client async with easybill_generated_sync.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = easybill_generated_sync.CustomerGroupApi(api_client) body = easybill_generated_sync.CustomerGroup() # CustomerGroup | try: # Create customer group api_response = await api_instance.customer_groups_post(body) print("The response of CustomerGroupApi->customer_groups_post:\n") pprint(api_response) except Exception as e: print("Exception when calling CustomerGroupApi->customer_groups_post: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**CustomerGroup**](CustomerGroup.md)| | ### Return type [**CustomerGroup**](CustomerGroup.md) ### Authorization [basicAuth](../README.md#basicAuth), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful operation | - | **429** | Too Many Requests | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)