easybill_client/generated/async/docs/ContactApi.md
claudi caacb339dd Add unit tests for authentication and webhook parsing
- Implement tests for basic and bearer authentication headers in `test_auth.py`.
- Create tests for the `EasybillWebhookParser` in `test_webhooks.py`, covering JSON and form-encoded payloads, as well as a generic parse and acknowledgement method.
2026-04-17 10:20:12 +02:00

15 KiB

easybill_generated_async.ContactApi

All URIs are relative to https://api.easybill.de/rest/v1

Method HTTP request Description
customers_customer_id_contacts_get GET /customers/{customerId}/contacts Fetch customer contact list
customers_customer_id_contacts_id_delete DELETE /customers/{customerId}/contacts/{id} Delete contact
customers_customer_id_contacts_id_get GET /customers/{customerId}/contacts/{id} Fetch contact
customers_customer_id_contacts_id_put PUT /customers/{customerId}/contacts/{id} Update Contact
customers_customer_id_contacts_post POST /customers/{customerId}/contacts Create new contact

customers_customer_id_contacts_get

Contacts customers_customer_id_contacts_get(customer_id, limit=limit, page=page)

Fetch customer contact list

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (Bearer):
import easybill_generated_async
from easybill_generated_async.models.contacts import Contacts
from easybill_generated_async.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_async.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_async.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_async.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = easybill_generated_async.ContactApi(api_client)
    customer_id = 56 # int | ID of customer that needs to be fetched
    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 contact list
        api_response = await api_instance.customers_customer_id_contacts_get(customer_id, limit=limit, page=page)
        print("The response of ContactApi->customers_customer_id_contacts_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContactApi->customers_customer_id_contacts_get: %s\n" % e)

Parameters

Name Type Description Notes
customer_id int ID of customer that needs to be fetched
limit int Limited the result. Default is 100. Maximum can be 1000. [optional]
page int Set current Page. Default is 1. [optional]

Return type

Contacts

Authorization

basicAuth, 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] [Back to Model list] [Back to README]

customers_customer_id_contacts_id_delete

customers_customer_id_contacts_id_delete(customer_id, id)

Delete contact

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (Bearer):
import easybill_generated_async
from easybill_generated_async.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_async.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_async.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_async.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = easybill_generated_async.ContactApi(api_client)
    customer_id = 56 # int | ID of customer
    id = 56 # int | ID of contact

    try:
        # Delete contact
        await api_instance.customers_customer_id_contacts_id_delete(customer_id, id)
    except Exception as e:
        print("Exception when calling ContactApi->customers_customer_id_contacts_id_delete: %s\n" % e)

Parameters

Name Type Description Notes
customer_id int ID of customer
id int ID of contact

Return type

void (empty response body)

Authorization

basicAuth, 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] [Back to Model list] [Back to README]

customers_customer_id_contacts_id_get

Contact customers_customer_id_contacts_id_get(customer_id, id)

Fetch contact

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (Bearer):
import easybill_generated_async
from easybill_generated_async.models.contact import Contact
from easybill_generated_async.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_async.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_async.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_async.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = easybill_generated_async.ContactApi(api_client)
    customer_id = 56 # int | ID of customer
    id = 56 # int | ID of contact

    try:
        # Fetch contact
        api_response = await api_instance.customers_customer_id_contacts_id_get(customer_id, id)
        print("The response of ContactApi->customers_customer_id_contacts_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContactApi->customers_customer_id_contacts_id_get: %s\n" % e)

Parameters

Name Type Description Notes
customer_id int ID of customer
id int ID of contact

Return type

Contact

Authorization

basicAuth, 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] [Back to Model list] [Back to README]

customers_customer_id_contacts_id_put

Contact customers_customer_id_contacts_id_put(customer_id, id, body=body)

Update Contact

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (Bearer):
import easybill_generated_async
from easybill_generated_async.models.contact import Contact
from easybill_generated_async.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_async.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_async.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_async.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = easybill_generated_async.ContactApi(api_client)
    customer_id = 56 # int | ID of customer
    id = 56 # int | ID of contact
    body = easybill_generated_async.Contact() # Contact |  (optional)

    try:
        # Update Contact
        api_response = await api_instance.customers_customer_id_contacts_id_put(customer_id, id, body=body)
        print("The response of ContactApi->customers_customer_id_contacts_id_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContactApi->customers_customer_id_contacts_id_put: %s\n" % e)

Parameters

Name Type Description Notes
customer_id int ID of customer
id int ID of contact
body Contact [optional]

Return type

Contact

Authorization

basicAuth, Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -
400 Invalid contact -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

customers_customer_id_contacts_post

Contact customers_customer_id_contacts_post(customer_id, body=body)

Create new contact

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (Bearer):
import easybill_generated_async
from easybill_generated_async.models.contact import Contact
from easybill_generated_async.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_async.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_async.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_async.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = easybill_generated_async.ContactApi(api_client)
    customer_id = 56 # int | ID of customer
    body = easybill_generated_async.Contact() # Contact |  (optional)

    try:
        # Create new contact
        api_response = await api_instance.customers_customer_id_contacts_post(customer_id, body=body)
        print("The response of ContactApi->customers_customer_id_contacts_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContactApi->customers_customer_id_contacts_post: %s\n" % e)

Parameters

Name Type Description Notes
customer_id int ID of customer
body Contact [optional]

Return type

Contact

Authorization

basicAuth, Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -
400 Invalid contact -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]