easybill_client/generated/async/docs/SepaPaymentApi.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

14 KiB

easybill_generated_async.SepaPaymentApi

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

Method HTTP request Description
sepa_payments_get GET /sepa-payments Fetch SEPA payments list
sepa_payments_id_delete DELETE /sepa-payments/{id} Delete SEPA payment
sepa_payments_id_get GET /sepa-payments/{id} Fetch SEPA payment
sepa_payments_id_put PUT /sepa-payments/{id} Update SEPA payment
sepa_payments_post POST /sepa-payments Create SEPA payment

sepa_payments_get

SEPAPayments sepa_payments_get(limit=limit, page=page, document_id=document_id)

Fetch SEPA payments list

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (Bearer):
import easybill_generated_async
from easybill_generated_async.models.sepa_payments import SEPAPayments
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.SepaPaymentApi(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)
    document_id = 'document_id_example' # str | Filter SEPA payment by document_id. You can add multiple ids separate by comma like id,id,id. (optional)

    try:
        # Fetch SEPA payments list
        api_response = await api_instance.sepa_payments_get(limit=limit, page=page, document_id=document_id)
        print("The response of SepaPaymentApi->sepa_payments_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SepaPaymentApi->sepa_payments_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]
document_id str Filter SEPA payment by document_id. You can add multiple ids separate by comma like id,id,id. [optional]

Return type

SEPAPayments

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]

sepa_payments_id_delete

sepa_payments_id_delete(id)

Delete SEPA payment

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.SepaPaymentApi(api_client)
    id = 56 # int | ID of SPEA payment

    try:
        # Delete SEPA payment
        await api_instance.sepa_payments_id_delete(id)
    except Exception as e:
        print("Exception when calling SepaPaymentApi->sepa_payments_id_delete: %s\n" % e)

Parameters

Name Type Description Notes
id int ID of SPEA payment

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]

sepa_payments_id_get

SEPAPayment sepa_payments_id_get(id)

Fetch SEPA payment

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (Bearer):
import easybill_generated_async
from easybill_generated_async.models.sepa_payment import SEPAPayment
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.SepaPaymentApi(api_client)
    id = 56 # int | ID of SEPA payment

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

Parameters

Name Type Description Notes
id int ID of SEPA payment

Return type

SEPAPayment

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]

sepa_payments_id_put

SEPAPayment sepa_payments_id_put(id, body)

Update SEPA payment

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (Bearer):
import easybill_generated_async
from easybill_generated_async.models.sepa_payment import SEPAPayment
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.SepaPaymentApi(api_client)
    id = 56 # int | ID of SEPA payment
    body = easybill_generated_async.SEPAPayment() # SEPAPayment | 

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

Parameters

Name Type Description Notes
id int ID of SEPA payment
body SEPAPayment

Return type

SEPAPayment

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

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

sepa_payments_post

SEPAPayment sepa_payments_post(body)

Create SEPA payment

Example

  • Basic Authentication (basicAuth):
  • Api Key Authentication (Bearer):
import easybill_generated_async
from easybill_generated_async.models.sepa_payment import SEPAPayment
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.SepaPaymentApi(api_client)
    body = easybill_generated_async.SEPAPayment() # SEPAPayment | 

    try:
        # Create SEPA payment
        api_response = await api_instance.sepa_payments_post(body)
        print("The response of SepaPaymentApi->sepa_payments_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SepaPaymentApi->sepa_payments_post: %s\n" % e)

Parameters

Name Type Description Notes
body SEPAPayment

Return type

SEPAPayment

Authorization

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