easybill_client/generated/sync/docs/PostBoxApi.md

easybill_generated_sync.PostBoxApi

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

Method	HTTP request	Description
post_boxes_get	GET /post-boxes	Fetch post box list
post_boxes_id_delete	DELETE /post-boxes/{id}	Delete post box
post_boxes_id_get	GET /post-boxes/{id}	Fetch post box

post_boxes_get

PostBoxes post_boxes_get(limit=limit, page=page, type=type, status=status, document_id=document_id)

Fetch post box list

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (Bearer):

import easybill_generated_sync
from easybill_generated_sync.models.post_boxes import PostBoxes
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.PostBoxApi(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)
    type = 'type_example' # str | Filter post boxes by type. Multiple typs seperate with , like type=EMAIL,FAX. (optional)
    status = 'status_example' # str | Filter post boxes by status. (optional)
    document_id = 'document_id_example' # str | Filter post boxes by document_id. You can add multiple document ids separate by comma like id,id,id. (optional)

    try:
        # Fetch post box list
        api_response = await api_instance.post_boxes_get(limit=limit, page=page, type=type, status=status, document_id=document_id)
        print("The response of PostBoxApi->post_boxes_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostBoxApi->post_boxes_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]
type	str	Filter post boxes by type. Multiple typs seperate with , like type=EMAIL,FAX.	[optional]
status	str	Filter post boxes by status.	[optional]
document_id	str	Filter post boxes by document_id. You can add multiple document ids separate by comma like id,id,id.	[optional]

Return type

PostBoxes

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]

post_boxes_id_delete

post_boxes_id_delete(id)

Delete post box

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.PostBoxApi(api_client)
    id = 56 # int | ID of post box

    try:
        # Delete post box
        await api_instance.post_boxes_id_delete(id)
    except Exception as e:
        print("Exception when calling PostBoxApi->post_boxes_id_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	ID of post box

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]

post_boxes_id_get

PostBox post_boxes_id_get(id)

Fetch post box

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (Bearer):

import easybill_generated_sync
from easybill_generated_sync.models.post_box import PostBox
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.PostBoxApi(api_client)
    id = 56 # int | ID of post box

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

Parameters

Name	Type	Description	Notes
id	int	ID of post box

Return type

PostBox

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]