easybill_client/generated/sync/docs/AttachmentApi.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

16 KiB

easybill_generated_sync.AttachmentApi

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

Method HTTP request Description
attachments_get GET /attachments Fetch attachments list
attachments_id_content_get GET /attachments/{id}/content Fetch attachment content
attachments_id_delete DELETE /attachments/{id} Delete attachment
attachments_id_get GET /attachments/{id} Fetch attachment
attachments_id_put PUT /attachments/{id} Update attachment
attachments_post POST /attachments Create attachment

attachments_get

Attachments attachments_get(limit=limit, page=page)

Fetch attachments list

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (Bearer):
import easybill_generated_sync
from easybill_generated_sync.models.attachments import Attachments
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.AttachmentApi(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 attachments list
        api_response = await api_instance.attachments_get(limit=limit, page=page)
        print("The response of AttachmentApi->attachments_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AttachmentApi->attachments_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

Attachments

Authorization

basicAuth, Bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful operation -

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

attachments_id_content_get

bytes attachments_id_content_get(id)

Fetch attachment content

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (Bearer):
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.AttachmentApi(api_client)
    id = 56 # int | ID of attachment

    try:
        # Fetch attachment content
        api_response = await api_instance.attachments_id_content_get(id)
        print("The response of AttachmentApi->attachments_id_content_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AttachmentApi->attachments_id_content_get: %s\n" % e)

Parameters

Name Type Description Notes
id int ID of attachment

Return type

bytes

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]

attachments_id_delete

attachments_id_delete(id)

Delete attachment

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (Bearer):
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.AttachmentApi(api_client)
    id = 56 # int | ID of attachment

    try:
        # Delete attachment
        await api_instance.attachments_id_delete(id)
    except Exception as e:
        print("Exception when calling AttachmentApi->attachments_id_delete: %s\n" % e)

Parameters

Name Type Description Notes
id int ID of attachment

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]

attachments_id_get

Attachment attachments_id_get(id)

Fetch attachment

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (Bearer):
import easybill_generated_sync
from easybill_generated_sync.models.attachment import Attachment
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.AttachmentApi(api_client)
    id = 56 # int | ID of attachment

    try:
        # Fetch attachment
        api_response = await api_instance.attachments_id_get(id)
        print("The response of AttachmentApi->attachments_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AttachmentApi->attachments_id_get: %s\n" % e)

Parameters

Name Type Description Notes
id int ID of attachment

Return type

Attachment

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]

attachments_id_put

Attachment attachments_id_put(id, body)

Update attachment

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (Bearer):
import easybill_generated_sync
from easybill_generated_sync.models.attachment import Attachment
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.AttachmentApi(api_client)
    id = 56 # int | ID of attachment
    body = easybill_generated_sync.Attachment() # Attachment | 

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

Parameters

Name Type Description Notes
id int ID of attachment
body Attachment

Return type

Attachment

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 attachment -
429 Too Many Requests -

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

attachments_post

Attachment attachments_post(file)

Create attachment

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (Bearer):
import easybill_generated_sync
from easybill_generated_sync.models.attachment import Attachment
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.AttachmentApi(api_client)
    file = None # bytes | 

    try:
        # Create attachment
        api_response = await api_instance.attachments_post(file)
        print("The response of AttachmentApi->attachments_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AttachmentApi->attachments_post: %s\n" % e)

Parameters

Name Type Description Notes
file bytes

Return type

Attachment

Authorization

basicAuth, Bearer

HTTP request headers

  • Content-Type: multipart/form-data
  • 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] [Back to Model list] [Back to README]