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.
This commit is contained in:
claudi 2026-04-17 10:20:12 +02:00
commit caacb339dd
550 changed files with 127217 additions and 0 deletions

8
.gitignore vendored Normal file
View file

@ -0,0 +1,8 @@
.venv/
__pycache__/
.pytest_cache/
.coverage
*.pyc
build/
dist/
*.egg-info/

34
README.md Normal file
View file

@ -0,0 +1,34 @@
# easybill client
Python client for the easybill REST API with a generated API layer, Pydantic-based convenience models, and webhook parsing helpers for middleware integration.
## Current status
The initial implementation is in place and includes:
- a project scaffold with packaging and tests
- sync and async wrapper clients
- authentication helpers for bearer and basic auth
- a webhook parser for JSON and form payloads
- a reproducible generation script based on the provided Swagger specification
## Development
Install the local project dependencies and run the tests:
```powershell
python -m pytest -q
```
Generate the raw clients from the API description:
```powershell
python scripts/generate_client.py --mode both
```
## Structure
- `src/easybill_client`: public package and middleware-friendly helpers
- `tests`: focused verification for auth and webhook behavior
- `scripts/generate_client.py`: generation entrypoint for the raw REST layer
- `generated`: generated sync and async clients derived from the Swagger description

View file

@ -0,0 +1,10 @@
from easybill_client import EasybillWebhookParser
def handle_easybill_webhook(headers: dict[str, str], payload: dict, content_type: str) -> tuple[int, dict]:
parser = EasybillWebhookParser()
envelope = parser.parse(headers=headers, payload=payload, content_type=content_type)
print(f"Received easybill event: {envelope.event} for resource {envelope.resource_id}")
return 200, parser.build_acknowledgement()

View file

@ -0,0 +1,34 @@
# NOTE: This file is auto generated by OpenAPI Generator.
# URL: https://openapi-generator.tech
#
# ref: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
name: easybill_generated_async Python package
on: [push, pull_request]
permissions:
contents: read
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install -r test-requirements.txt
- name: Test with pytest
run: |
pytest --cov=easybill_generated_async

66
generated/async/.gitignore vendored Normal file
View file

@ -0,0 +1,66 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/
venv/
.venv/
.python-version
.pytest_cache
# Translations
*.mo
*.pot
# Django stuff:
*.log
# Sphinx documentation
docs/_build/
# PyBuilder
target/
# Ipython Notebook
.ipynb_checkpoints

View file

@ -0,0 +1,31 @@
# NOTE: This file is auto generated by OpenAPI Generator.
# URL: https://openapi-generator.tech
#
# ref: https://docs.gitlab.com/ee/ci/README.html
# ref: https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Python.gitlab-ci.yml
stages:
- test
.pytest:
stage: test
script:
- pip install -r requirements.txt
- pip install -r test-requirements.txt
- pytest --cov=easybill_generated_async
pytest-3.10:
extends: .pytest
image: python:3.10-alpine
pytest-3.11:
extends: .pytest
image: python:3.11-alpine
pytest-3.12:
extends: .pytest
image: python:3.12-alpine
pytest-3.13:
extends: .pytest
image: python:3.13-alpine
pytest-3.14:
extends: .pytest
image: python:3.14-alpine

View file

@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.
# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md

View file

@ -0,0 +1,266 @@
.github/workflows/python.yml
.gitignore
.gitlab-ci.yml
.openapi-generator-ignore
.travis.yml
README.md
docs/AdvancedDataField.md
docs/Attachment.md
docs/AttachmentApi.md
docs/Attachments.md
docs/Contact.md
docs/ContactApi.md
docs/Contacts.md
docs/Customer.md
docs/CustomerApi.md
docs/CustomerGroup.md
docs/CustomerGroupApi.md
docs/CustomerGroups.md
docs/CustomerSnapshot.md
docs/Customers.md
docs/Discount.md
docs/DiscountApi.md
docs/DiscountPosition.md
docs/DiscountPositionGroup.md
docs/DiscountPositionGroups.md
docs/DiscountPositions.md
docs/Document.md
docs/DocumentAddress.md
docs/DocumentApi.md
docs/DocumentPayment.md
docs/DocumentPaymentApi.md
docs/DocumentPayments.md
docs/DocumentPosition.md
docs/DocumentRecurring.md
docs/DocumentVersion.md
docs/DocumentVersionApi.md
docs/DocumentVersionItem.md
docs/DocumentVersions.md
docs/Documents.md
docs/FileFormatConfig.md
docs/List.md
docs/Login.md
docs/LoginSecurity.md
docs/Logins.md
docs/LoginsApi.md
docs/PDFTemplate.md
docs/PDFTemplateSettings.md
docs/PDFTemplateSettingsEmail.md
docs/PDFTemplates.md
docs/PdfTemplatesApi.md
docs/Position.md
docs/PositionApi.md
docs/PositionExportIdentifierExtended.md
docs/PositionGroup.md
docs/PositionGroupApi.md
docs/PositionGroups.md
docs/Positions.md
docs/PostBox.md
docs/PostBoxApi.md
docs/PostBoxRequest.md
docs/PostBoxes.md
docs/Project.md
docs/ProjectApi.md
docs/Projects.md
docs/SEPAPayment.md
docs/SEPAPayments.md
docs/SepaPaymentApi.md
docs/SerialNumber.md
docs/SerialNumberApi.md
docs/SerialNumbers.md
docs/ServiceDate.md
docs/Stock.md
docs/StockApi.md
docs/Stocks.md
docs/Task.md
docs/TaskApi.md
docs/Tasks.md
docs/TextTemplate.md
docs/TextTemplateApi.md
docs/TextTemplates.md
docs/TimeTracking.md
docs/TimeTrackingApi.md
docs/TimeTrackings.md
docs/WebHook.md
docs/WebHookLastResponse.md
docs/WebHooks.md
docs/WebhookApi.md
easybill_generated_async/__init__.py
easybill_generated_async/api/__init__.py
easybill_generated_async/api/attachment_api.py
easybill_generated_async/api/contact_api.py
easybill_generated_async/api/customer_api.py
easybill_generated_async/api/customer_group_api.py
easybill_generated_async/api/discount_api.py
easybill_generated_async/api/document_api.py
easybill_generated_async/api/document_payment_api.py
easybill_generated_async/api/document_version_api.py
easybill_generated_async/api/logins_api.py
easybill_generated_async/api/pdf_templates_api.py
easybill_generated_async/api/position_api.py
easybill_generated_async/api/position_group_api.py
easybill_generated_async/api/post_box_api.py
easybill_generated_async/api/project_api.py
easybill_generated_async/api/sepa_payment_api.py
easybill_generated_async/api/serial_number_api.py
easybill_generated_async/api/stock_api.py
easybill_generated_async/api/task_api.py
easybill_generated_async/api/text_template_api.py
easybill_generated_async/api/time_tracking_api.py
easybill_generated_async/api/webhook_api.py
easybill_generated_async/api_client.py
easybill_generated_async/api_response.py
easybill_generated_async/configuration.py
easybill_generated_async/exceptions.py
easybill_generated_async/models/__init__.py
easybill_generated_async/models/advanced_data_field.py
easybill_generated_async/models/attachment.py
easybill_generated_async/models/attachments.py
easybill_generated_async/models/contact.py
easybill_generated_async/models/contacts.py
easybill_generated_async/models/customer.py
easybill_generated_async/models/customer_group.py
easybill_generated_async/models/customer_groups.py
easybill_generated_async/models/customer_snapshot.py
easybill_generated_async/models/customers.py
easybill_generated_async/models/discount.py
easybill_generated_async/models/discount_position.py
easybill_generated_async/models/discount_position_group.py
easybill_generated_async/models/discount_position_groups.py
easybill_generated_async/models/discount_positions.py
easybill_generated_async/models/document.py
easybill_generated_async/models/document_address.py
easybill_generated_async/models/document_payment.py
easybill_generated_async/models/document_payments.py
easybill_generated_async/models/document_position.py
easybill_generated_async/models/document_recurring.py
easybill_generated_async/models/document_version.py
easybill_generated_async/models/document_version_item.py
easybill_generated_async/models/document_versions.py
easybill_generated_async/models/documents.py
easybill_generated_async/models/file_format_config.py
easybill_generated_async/models/list.py
easybill_generated_async/models/login.py
easybill_generated_async/models/login_security.py
easybill_generated_async/models/logins.py
easybill_generated_async/models/pdf_template.py
easybill_generated_async/models/pdf_template_settings.py
easybill_generated_async/models/pdf_template_settings_email.py
easybill_generated_async/models/pdf_templates.py
easybill_generated_async/models/position.py
easybill_generated_async/models/position_export_identifier_extended.py
easybill_generated_async/models/position_group.py
easybill_generated_async/models/position_groups.py
easybill_generated_async/models/positions.py
easybill_generated_async/models/post_box.py
easybill_generated_async/models/post_box_request.py
easybill_generated_async/models/post_boxes.py
easybill_generated_async/models/project.py
easybill_generated_async/models/projects.py
easybill_generated_async/models/sepa_payment.py
easybill_generated_async/models/sepa_payments.py
easybill_generated_async/models/serial_number.py
easybill_generated_async/models/serial_numbers.py
easybill_generated_async/models/service_date.py
easybill_generated_async/models/stock.py
easybill_generated_async/models/stocks.py
easybill_generated_async/models/task.py
easybill_generated_async/models/tasks.py
easybill_generated_async/models/text_template.py
easybill_generated_async/models/text_templates.py
easybill_generated_async/models/time_tracking.py
easybill_generated_async/models/time_trackings.py
easybill_generated_async/models/web_hook.py
easybill_generated_async/models/web_hook_last_response.py
easybill_generated_async/models/web_hooks.py
easybill_generated_async/py.typed
easybill_generated_async/rest.py
git_push.sh
pyproject.toml
requirements.txt
setup.cfg
setup.py
test-requirements.txt
test/__init__.py
test/test_advanced_data_field.py
test/test_attachment.py
test/test_attachment_api.py
test/test_attachments.py
test/test_contact.py
test/test_contact_api.py
test/test_contacts.py
test/test_customer.py
test/test_customer_api.py
test/test_customer_group.py
test/test_customer_group_api.py
test/test_customer_groups.py
test/test_customer_snapshot.py
test/test_customers.py
test/test_discount.py
test/test_discount_api.py
test/test_discount_position.py
test/test_discount_position_group.py
test/test_discount_position_groups.py
test/test_discount_positions.py
test/test_document.py
test/test_document_address.py
test/test_document_api.py
test/test_document_payment.py
test/test_document_payment_api.py
test/test_document_payments.py
test/test_document_position.py
test/test_document_recurring.py
test/test_document_version.py
test/test_document_version_api.py
test/test_document_version_item.py
test/test_document_versions.py
test/test_documents.py
test/test_file_format_config.py
test/test_list.py
test/test_login.py
test/test_login_security.py
test/test_logins.py
test/test_logins_api.py
test/test_pdf_template.py
test/test_pdf_template_settings.py
test/test_pdf_template_settings_email.py
test/test_pdf_templates.py
test/test_pdf_templates_api.py
test/test_position.py
test/test_position_api.py
test/test_position_export_identifier_extended.py
test/test_position_group.py
test/test_position_group_api.py
test/test_position_groups.py
test/test_positions.py
test/test_post_box.py
test/test_post_box_api.py
test/test_post_box_request.py
test/test_post_boxes.py
test/test_project.py
test/test_project_api.py
test/test_projects.py
test/test_sepa_payment.py
test/test_sepa_payment_api.py
test/test_sepa_payments.py
test/test_serial_number.py
test/test_serial_number_api.py
test/test_serial_numbers.py
test/test_service_date.py
test/test_stock.py
test/test_stock_api.py
test/test_stocks.py
test/test_task.py
test/test_task_api.py
test/test_tasks.py
test/test_text_template.py
test/test_text_template_api.py
test/test_text_templates.py
test/test_time_tracking.py
test/test_time_tracking_api.py
test/test_time_trackings.py
test/test_web_hook.py
test/test_web_hook_last_response.py
test/test_web_hooks.py
test/test_webhook_api.py
tox.ini

View file

@ -0,0 +1 @@
7.22.0-SNAPSHOT

View file

@ -0,0 +1,17 @@
# ref: https://docs.travis-ci.com/user/languages/python
language: python
python:
- "3.10"
- "3.11"
- "3.12"
- "3.13"
- "3.14"
# uncomment the following if needed
#- "3.14-dev" # 3.14 development branch
#- "nightly" # nightly build
# command to install dependencies
install:
- "pip install -r requirements.txt"
- "pip install -r test-requirements.txt"
# command to run tests
script: pytest --cov=easybill_generated_async

344
generated/async/README.md Normal file
View file

@ -0,0 +1,344 @@
# easybill-generated-async
The first version of the easybill REST API. [CHANGELOG](https://api.easybill.de/rest/v1/CHANGELOG.md)
## Authentication
You can choose between two available methods: `Basic Auth` or `Bearer Token`.
In each HTTP request, one of the following HTTP headers is required:
```
# Basic Auth
Authorization: Basic base64_encode('<email>:<api_key>')
# Bearer Token
Authorization: Bearer <api_key>
```
## Limitations
### Request Limit
* PLUS: 10 requests per minute
* BUSINESS: 60 requests per minute
If the limit is exceeded, you will receive the HTTP error: `429 Too Many Requests`
### Result Limit
All result lists are limited to 100 by default. This limit can be increased by the query parameter `limit` to a maximum of 1000.
## Query filter
Many list resources can be filtered. In `/documents` you can filter e.g. by number with `/documents?number=111028654`. If you want to filter multiple numbers, you can either enter them separated by commas `/documents?number=111028654,222006895` or as an array `/documents?number[]=111028654&number[]=222006895`.
**Warning**: The maximum size of an HTTP request line in bytes is 4094. If this limit is exceeded, you will receive the HTTP error: `414 Request-URI Too Large`
### Escape commas in query
You can escape commans in query `name=Patrick\\, Peter` if you submit the header `X-Easybill-Escape: true` in your request.
## Property login_id
This is the login of your admin or employee account.
## Date and Date-Time format
Please use the timezone `Europe/Berlin`.
* **date** = *Y-m-d* = `2016-12-31`
* **date-time** = *Y-m-d H:i:s* = `2016-12-31 03:13:37`
Date or datetime can be `null` because the attributes have been added later and the entry is older.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.96.0
- Package version: 1.0.0
- Generator version: 7.22.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.10+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import easybill_generated_async
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import easybill_generated_async
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
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.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 ApiException as e:
print("Exception when calling AttachmentApi->attachments_get: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.easybill.de/rest/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AttachmentApi* | [**attachments_get**](docs/AttachmentApi.md#attachments_get) | **GET** /attachments | Fetch attachments list
*AttachmentApi* | [**attachments_id_content_get**](docs/AttachmentApi.md#attachments_id_content_get) | **GET** /attachments/{id}/content | Fetch attachment content
*AttachmentApi* | [**attachments_id_delete**](docs/AttachmentApi.md#attachments_id_delete) | **DELETE** /attachments/{id} | Delete attachment
*AttachmentApi* | [**attachments_id_get**](docs/AttachmentApi.md#attachments_id_get) | **GET** /attachments/{id} | Fetch attachment
*AttachmentApi* | [**attachments_id_put**](docs/AttachmentApi.md#attachments_id_put) | **PUT** /attachments/{id} | Update attachment
*AttachmentApi* | [**attachments_post**](docs/AttachmentApi.md#attachments_post) | **POST** /attachments | Create attachment
*ContactApi* | [**customers_customer_id_contacts_get**](docs/ContactApi.md#customers_customer_id_contacts_get) | **GET** /customers/{customerId}/contacts | Fetch customer contact list
*ContactApi* | [**customers_customer_id_contacts_id_delete**](docs/ContactApi.md#customers_customer_id_contacts_id_delete) | **DELETE** /customers/{customerId}/contacts/{id} | Delete contact
*ContactApi* | [**customers_customer_id_contacts_id_get**](docs/ContactApi.md#customers_customer_id_contacts_id_get) | **GET** /customers/{customerId}/contacts/{id} | Fetch contact
*ContactApi* | [**customers_customer_id_contacts_id_put**](docs/ContactApi.md#customers_customer_id_contacts_id_put) | **PUT** /customers/{customerId}/contacts/{id} | Update Contact
*ContactApi* | [**customers_customer_id_contacts_post**](docs/ContactApi.md#customers_customer_id_contacts_post) | **POST** /customers/{customerId}/contacts | Create new contact
*CustomerApi* | [**customers_get**](docs/CustomerApi.md#customers_get) | **GET** /customers | Fetch customers list
*CustomerApi* | [**customers_id_delete**](docs/CustomerApi.md#customers_id_delete) | **DELETE** /customers/{id} | Delete customer
*CustomerApi* | [**customers_id_get**](docs/CustomerApi.md#customers_id_get) | **GET** /customers/{id} | Fetch customer
*CustomerApi* | [**customers_id_put**](docs/CustomerApi.md#customers_id_put) | **PUT** /customers/{id} | Update Customer
*CustomerApi* | [**customers_post**](docs/CustomerApi.md#customers_post) | **POST** /customers | Create customer
*CustomerGroupApi* | [**customer_groups_get**](docs/CustomerGroupApi.md#customer_groups_get) | **GET** /customer-groups | Fetch customer group list
*CustomerGroupApi* | [**customer_groups_id_delete**](docs/CustomerGroupApi.md#customer_groups_id_delete) | **DELETE** /customer-groups/{id} | Delete customer group
*CustomerGroupApi* | [**customer_groups_id_get**](docs/CustomerGroupApi.md#customer_groups_id_get) | **GET** /customer-groups/{id} | Fetch customer group
*CustomerGroupApi* | [**customer_groups_id_put**](docs/CustomerGroupApi.md#customer_groups_id_put) | **PUT** /customer-groups/{id} | Update customer group
*CustomerGroupApi* | [**customer_groups_post**](docs/CustomerGroupApi.md#customer_groups_post) | **POST** /customer-groups | Create customer group
*DiscountApi* | [**discounts_position_get**](docs/DiscountApi.md#discounts_position_get) | **GET** /discounts/position | Fetch list of position discounts
*DiscountApi* | [**discounts_position_group_get**](docs/DiscountApi.md#discounts_position_group_get) | **GET** /discounts/position-group | Fetch list of position-group discounts
*DiscountApi* | [**discounts_position_group_id_delete**](docs/DiscountApi.md#discounts_position_group_id_delete) | **DELETE** /discounts/position-group/{id} | Delete the specified position-group discount
*DiscountApi* | [**discounts_position_group_id_get**](docs/DiscountApi.md#discounts_position_group_id_get) | **GET** /discounts/position-group/{id} | Fetch specified position-group discount by id
*DiscountApi* | [**discounts_position_group_id_put**](docs/DiscountApi.md#discounts_position_group_id_put) | **PUT** /discounts/position-group/{id} | Update a position-group discount
*DiscountApi* | [**discounts_position_group_post**](docs/DiscountApi.md#discounts_position_group_post) | **POST** /discounts/position-group | Create a new position-group discount
*DiscountApi* | [**discounts_position_id_delete**](docs/DiscountApi.md#discounts_position_id_delete) | **DELETE** /discounts/position/{id} | Delete the specified position discount
*DiscountApi* | [**discounts_position_id_get**](docs/DiscountApi.md#discounts_position_id_get) | **GET** /discounts/position/{id} | Fetch specified position discount by id
*DiscountApi* | [**discounts_position_id_put**](docs/DiscountApi.md#discounts_position_id_put) | **PUT** /discounts/position/{id} | Update a position discount
*DiscountApi* | [**discounts_position_post**](docs/DiscountApi.md#discounts_position_post) | **POST** /discounts/position | Create a new position discount
*DocumentApi* | [**documents_get**](docs/DocumentApi.md#documents_get) | **GET** /documents | Fetch documents list
*DocumentApi* | [**documents_id_cancel_post**](docs/DocumentApi.md#documents_id_cancel_post) | **POST** /documents/{id}/cancel | Cancel document
*DocumentApi* | [**documents_id_delete**](docs/DocumentApi.md#documents_id_delete) | **DELETE** /documents/{id} | Delete document
*DocumentApi* | [**documents_id_done_put**](docs/DocumentApi.md#documents_id_done_put) | **PUT** /documents/{id}/done | To complete a document.
*DocumentApi* | [**documents_id_download_get**](docs/DocumentApi.md#documents_id_download_get) | **GET** /documents/{id}/download | Fetch the document in best fitting format to the given Accept header
*DocumentApi* | [**documents_id_get**](docs/DocumentApi.md#documents_id_get) | **GET** /documents/{id} | Fetch document
*DocumentApi* | [**documents_id_jpg_get**](docs/DocumentApi.md#documents_id_jpg_get) | **GET** /documents/{id}/jpg | Download a document as an jpeg-image
*DocumentApi* | [**documents_id_pdf_get**](docs/DocumentApi.md#documents_id_pdf_get) | **GET** /documents/{id}/pdf | Fetch pdf document
*DocumentApi* | [**documents_id_put**](docs/DocumentApi.md#documents_id_put) | **PUT** /documents/{id} | Update document
*DocumentApi* | [**documents_id_send_type_post**](docs/DocumentApi.md#documents_id_send_type_post) | **POST** /documents/{id}/send/{type} | Send document
*DocumentApi* | [**documents_id_type_post**](docs/DocumentApi.md#documents_id_type_post) | **POST** /documents/{id}/{type} | Convert an existing document to one of a different type
*DocumentApi* | [**documents_post**](docs/DocumentApi.md#documents_post) | **POST** /documents | Create document
*DocumentPaymentApi* | [**document_payments_get**](docs/DocumentPaymentApi.md#document_payments_get) | **GET** /document-payments | Fetch document payments list
*DocumentPaymentApi* | [**document_payments_id_delete**](docs/DocumentPaymentApi.md#document_payments_id_delete) | **DELETE** /document-payments/{id} | Delete document payment
*DocumentPaymentApi* | [**document_payments_id_get**](docs/DocumentPaymentApi.md#document_payments_id_get) | **GET** /document-payments/{id} | Fetch document payment
*DocumentPaymentApi* | [**document_payments_post**](docs/DocumentPaymentApi.md#document_payments_post) | **POST** /document-payments | Create document payment
*DocumentVersionApi* | [**documents_id_versions_get**](docs/DocumentVersionApi.md#documents_id_versions_get) | **GET** /documents/{id}/versions | List all versions of a given document
*DocumentVersionApi* | [**documents_id_versions_version_id_get**](docs/DocumentVersionApi.md#documents_id_versions_version_id_get) | **GET** /documents/{id}/versions/{versionId} | Show a single version of a given document
*DocumentVersionApi* | [**documents_id_versions_version_id_items_version_item_id_download_get**](docs/DocumentVersionApi.md#documents_id_versions_version_id_items_version_item_id_download_get) | **GET** /documents/{id}/versions/{versionId}/items/{versionItemId}/download | Download a specific file for a single version of a given document
*LoginsApi* | [**logins_get**](docs/LoginsApi.md#logins_get) | **GET** /logins |
*LoginsApi* | [**logins_id_get**](docs/LoginsApi.md#logins_id_get) | **GET** /logins/{id} |
*PdfTemplatesApi* | [**pdf_templates_get**](docs/PdfTemplatesApi.md#pdf_templates_get) | **GET** /pdf-templates | Fetch PDF Templates list
*PositionApi* | [**positions_get**](docs/PositionApi.md#positions_get) | **GET** /positions | Fetch positions list
*PositionApi* | [**positions_id_delete**](docs/PositionApi.md#positions_id_delete) | **DELETE** /positions/{id} | Delete position
*PositionApi* | [**positions_id_get**](docs/PositionApi.md#positions_id_get) | **GET** /positions/{id} | Fetch position
*PositionApi* | [**positions_id_put**](docs/PositionApi.md#positions_id_put) | **PUT** /positions/{id} | Update position
*PositionApi* | [**positions_post**](docs/PositionApi.md#positions_post) | **POST** /positions | Create position
*PositionGroupApi* | [**position_groups_get**](docs/PositionGroupApi.md#position_groups_get) | **GET** /position-groups | Fetch position group list
*PositionGroupApi* | [**position_groups_id_delete**](docs/PositionGroupApi.md#position_groups_id_delete) | **DELETE** /position-groups/{id} | Delete position group
*PositionGroupApi* | [**position_groups_id_get**](docs/PositionGroupApi.md#position_groups_id_get) | **GET** /position-groups/{id} | Fetch position group
*PositionGroupApi* | [**position_groups_id_put**](docs/PositionGroupApi.md#position_groups_id_put) | **PUT** /position-groups/{id} | Update position group
*PositionGroupApi* | [**position_groups_post**](docs/PositionGroupApi.md#position_groups_post) | **POST** /position-groups | Create position group
*PostBoxApi* | [**post_boxes_get**](docs/PostBoxApi.md#post_boxes_get) | **GET** /post-boxes | Fetch post box list
*PostBoxApi* | [**post_boxes_id_delete**](docs/PostBoxApi.md#post_boxes_id_delete) | **DELETE** /post-boxes/{id} | Delete post box
*PostBoxApi* | [**post_boxes_id_get**](docs/PostBoxApi.md#post_boxes_id_get) | **GET** /post-boxes/{id} | Fetch post box
*ProjectApi* | [**projects_get**](docs/ProjectApi.md#projects_get) | **GET** /projects | Fetch projects list
*ProjectApi* | [**projects_id_delete**](docs/ProjectApi.md#projects_id_delete) | **DELETE** /projects/{id} | Delete project
*ProjectApi* | [**projects_id_get**](docs/ProjectApi.md#projects_id_get) | **GET** /projects/{id} | Fetch project
*ProjectApi* | [**projects_id_put**](docs/ProjectApi.md#projects_id_put) | **PUT** /projects/{id} | Update project
*ProjectApi* | [**projects_post**](docs/ProjectApi.md#projects_post) | **POST** /projects | Create project
*SepaPaymentApi* | [**sepa_payments_get**](docs/SepaPaymentApi.md#sepa_payments_get) | **GET** /sepa-payments | Fetch SEPA payments list
*SepaPaymentApi* | [**sepa_payments_id_delete**](docs/SepaPaymentApi.md#sepa_payments_id_delete) | **DELETE** /sepa-payments/{id} | Delete SEPA payment
*SepaPaymentApi* | [**sepa_payments_id_get**](docs/SepaPaymentApi.md#sepa_payments_id_get) | **GET** /sepa-payments/{id} | Fetch SEPA payment
*SepaPaymentApi* | [**sepa_payments_id_put**](docs/SepaPaymentApi.md#sepa_payments_id_put) | **PUT** /sepa-payments/{id} | Update SEPA payment
*SepaPaymentApi* | [**sepa_payments_post**](docs/SepaPaymentApi.md#sepa_payments_post) | **POST** /sepa-payments | Create SEPA payment
*SerialNumberApi* | [**serial_numbers_get**](docs/SerialNumberApi.md#serial_numbers_get) | **GET** /serial-numbers | Fetch a list of serial numbers for positions
*SerialNumberApi* | [**serial_numbers_id_delete**](docs/SerialNumberApi.md#serial_numbers_id_delete) | **DELETE** /serial-numbers/{id} | Delete a serial number for a position
*SerialNumberApi* | [**serial_numbers_id_get**](docs/SerialNumberApi.md#serial_numbers_id_get) | **GET** /serial-numbers/{id} | Fetch a serial number for a position
*SerialNumberApi* | [**serial_numbers_post**](docs/SerialNumberApi.md#serial_numbers_post) | **POST** /serial-numbers | Create s serial number for a position
*StockApi* | [**stocks_get**](docs/StockApi.md#stocks_get) | **GET** /stocks | Fetch a list of stock entries for positions
*StockApi* | [**stocks_id_get**](docs/StockApi.md#stocks_id_get) | **GET** /stocks/{id} | Fetch an stock entry for a position
*StockApi* | [**stocks_post**](docs/StockApi.md#stocks_post) | **POST** /stocks | Create a stock entry for a position
*TaskApi* | [**tasks_get**](docs/TaskApi.md#tasks_get) | **GET** /tasks | Fetch tasks list
*TaskApi* | [**tasks_id_delete**](docs/TaskApi.md#tasks_id_delete) | **DELETE** /tasks/{id} | Delete task
*TaskApi* | [**tasks_id_get**](docs/TaskApi.md#tasks_id_get) | **GET** /tasks/{id} | Fetch task
*TaskApi* | [**tasks_id_put**](docs/TaskApi.md#tasks_id_put) | **PUT** /tasks/{id} | Update task
*TaskApi* | [**tasks_post**](docs/TaskApi.md#tasks_post) | **POST** /tasks | Create task
*TextTemplateApi* | [**text_templates_get**](docs/TextTemplateApi.md#text_templates_get) | **GET** /text-templates | Fetch text templates list
*TextTemplateApi* | [**text_templates_id_delete**](docs/TextTemplateApi.md#text_templates_id_delete) | **DELETE** /text-templates/{id} | Delete text template
*TextTemplateApi* | [**text_templates_id_get**](docs/TextTemplateApi.md#text_templates_id_get) | **GET** /text-templates/{id} | Fetch text template
*TextTemplateApi* | [**text_templates_id_put**](docs/TextTemplateApi.md#text_templates_id_put) | **PUT** /text-templates/{id} | Update text template
*TextTemplateApi* | [**text_templates_post**](docs/TextTemplateApi.md#text_templates_post) | **POST** /text-templates | Create text template
*TimeTrackingApi* | [**time_trackings_get**](docs/TimeTrackingApi.md#time_trackings_get) | **GET** /time-trackings | Fetch time trackings list
*TimeTrackingApi* | [**time_trackings_id_delete**](docs/TimeTrackingApi.md#time_trackings_id_delete) | **DELETE** /time-trackings/{id} | Delete time tracking
*TimeTrackingApi* | [**time_trackings_id_get**](docs/TimeTrackingApi.md#time_trackings_id_get) | **GET** /time-trackings/{id} | Fetch time tracking
*TimeTrackingApi* | [**time_trackings_id_put**](docs/TimeTrackingApi.md#time_trackings_id_put) | **PUT** /time-trackings/{id} | Update time tracking
*TimeTrackingApi* | [**time_trackings_post**](docs/TimeTrackingApi.md#time_trackings_post) | **POST** /time-trackings | Create time tracking
*WebhookApi* | [**webhooks_get**](docs/WebhookApi.md#webhooks_get) | **GET** /webhooks | Fetch WebHooks list
*WebhookApi* | [**webhooks_id_delete**](docs/WebhookApi.md#webhooks_id_delete) | **DELETE** /webhooks/{id} | Delete WebHook
*WebhookApi* | [**webhooks_id_get**](docs/WebhookApi.md#webhooks_id_get) | **GET** /webhooks/{id} | Fetch WebHook
*WebhookApi* | [**webhooks_id_put**](docs/WebhookApi.md#webhooks_id_put) | **PUT** /webhooks/{id} | Update WebHook
*WebhookApi* | [**webhooks_post**](docs/WebhookApi.md#webhooks_post) | **POST** /webhooks | Create WebHook
## Documentation For Models
- [AdvancedDataField](docs/AdvancedDataField.md)
- [Attachment](docs/Attachment.md)
- [Attachments](docs/Attachments.md)
- [Contact](docs/Contact.md)
- [Contacts](docs/Contacts.md)
- [Customer](docs/Customer.md)
- [CustomerGroup](docs/CustomerGroup.md)
- [CustomerGroups](docs/CustomerGroups.md)
- [CustomerSnapshot](docs/CustomerSnapshot.md)
- [Customers](docs/Customers.md)
- [Discount](docs/Discount.md)
- [DiscountPosition](docs/DiscountPosition.md)
- [DiscountPositionGroup](docs/DiscountPositionGroup.md)
- [DiscountPositionGroups](docs/DiscountPositionGroups.md)
- [DiscountPositions](docs/DiscountPositions.md)
- [Document](docs/Document.md)
- [DocumentAddress](docs/DocumentAddress.md)
- [DocumentPayment](docs/DocumentPayment.md)
- [DocumentPayments](docs/DocumentPayments.md)
- [DocumentPosition](docs/DocumentPosition.md)
- [DocumentRecurring](docs/DocumentRecurring.md)
- [DocumentVersion](docs/DocumentVersion.md)
- [DocumentVersionItem](docs/DocumentVersionItem.md)
- [DocumentVersions](docs/DocumentVersions.md)
- [Documents](docs/Documents.md)
- [FileFormatConfig](docs/FileFormatConfig.md)
- [List](docs/List.md)
- [Login](docs/Login.md)
- [LoginSecurity](docs/LoginSecurity.md)
- [Logins](docs/Logins.md)
- [PDFTemplate](docs/PDFTemplate.md)
- [PDFTemplateSettings](docs/PDFTemplateSettings.md)
- [PDFTemplateSettingsEmail](docs/PDFTemplateSettingsEmail.md)
- [PDFTemplates](docs/PDFTemplates.md)
- [Position](docs/Position.md)
- [PositionExportIdentifierExtended](docs/PositionExportIdentifierExtended.md)
- [PositionGroup](docs/PositionGroup.md)
- [PositionGroups](docs/PositionGroups.md)
- [Positions](docs/Positions.md)
- [PostBox](docs/PostBox.md)
- [PostBoxRequest](docs/PostBoxRequest.md)
- [PostBoxes](docs/PostBoxes.md)
- [Project](docs/Project.md)
- [Projects](docs/Projects.md)
- [SEPAPayment](docs/SEPAPayment.md)
- [SEPAPayments](docs/SEPAPayments.md)
- [SerialNumber](docs/SerialNumber.md)
- [SerialNumbers](docs/SerialNumbers.md)
- [ServiceDate](docs/ServiceDate.md)
- [Stock](docs/Stock.md)
- [Stocks](docs/Stocks.md)
- [Task](docs/Task.md)
- [Tasks](docs/Tasks.md)
- [TextTemplate](docs/TextTemplate.md)
- [TextTemplates](docs/TextTemplates.md)
- [TimeTracking](docs/TimeTracking.md)
- [TimeTrackings](docs/TimeTrackings.md)
- [WebHook](docs/WebHook.md)
- [WebHookLastResponse](docs/WebHookLastResponse.md)
- [WebHooks](docs/WebHooks.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="Bearer"></a>
### Bearer
- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header
<a id="basicAuth"></a>
### basicAuth
- **Type**: HTTP basic authentication
## Author

View file

@ -0,0 +1,31 @@
# AdvancedDataField
EN16931 Business Term (BT field) for structured invoice data
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identifier** | **str** | BT field identifier (e.g. &#39;BT-10&#39; for Buyer reference, &#39;BT-84&#39; for Payment account identifier) |
**value** | **str** | Field value |
## Example
```python
from easybill_generated_async.models.advanced_data_field import AdvancedDataField
# TODO update the JSON string below
json = "{}"
# create an instance of AdvancedDataField from a JSON string
advanced_data_field_instance = AdvancedDataField.from_json(json)
# print the JSON string representation of the object
print(AdvancedDataField.to_json())
# convert the object into a dict
advanced_data_field_dict = advanced_data_field_instance.to_dict()
# create an instance of AdvancedDataField from a dict
advanced_data_field_from_dict = AdvancedDataField.from_dict(advanced_data_field_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,36 @@
# Attachment
If customer_id, project_id and document_id are null, the attachment has a global context and is accessible from the web ui. Keep in mind only to provide one of the four context. You can't attach a file to several context in one request. A error is thrown if you provide two or more context (i. E. sending customer_id, document_id and project_id in combination).
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created_at** | **date** | | [optional] [readonly]
**customer_id** | **int** | | [optional]
**document_id** | **int** | | [optional]
**file_name** | **str** | | [optional] [readonly]
**id** | **int** | | [optional] [readonly]
**project_id** | **int** | | [optional]
**size** | **int** | In byte | [optional] [readonly]
## Example
```python
from easybill_generated_async.models.attachment import Attachment
# TODO update the JSON string below
json = "{}"
# create an instance of Attachment from a JSON string
attachment_instance = Attachment.from_json(json)
# print the JSON string representation of the object
print(Attachment.to_json())
# convert the object into a dict
attachment_dict = attachment_instance.to_dict()
# create an instance of Attachment from a dict
attachment_from_dict = Attachment.from_dict(attachment_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,527 @@
# easybill_generated_async.AttachmentApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**attachments_get**](AttachmentApi.md#attachments_get) | **GET** /attachments | Fetch attachments list
[**attachments_id_content_get**](AttachmentApi.md#attachments_id_content_get) | **GET** /attachments/{id}/content | Fetch attachment content
[**attachments_id_delete**](AttachmentApi.md#attachments_id_delete) | **DELETE** /attachments/{id} | Delete attachment
[**attachments_id_get**](AttachmentApi.md#attachments_id_get) | **GET** /attachments/{id} | Fetch attachment
[**attachments_id_put**](AttachmentApi.md#attachments_id_put) | **PUT** /attachments/{id} | Update attachment
[**attachments_post**](AttachmentApi.md#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):
```python
import easybill_generated_async
from easybill_generated_async.models.attachments import Attachments
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.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**](Attachments.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 | - |
[[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)
# **attachments_id_content_get**
> bytes attachments_id_content_get(id)
Fetch attachment content
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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.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](../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)
# **attachments_id_delete**
> attachments_id_delete(id)
Delete attachment
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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.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](../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)
# **attachments_id_get**
> Attachment attachments_id_get(id)
Fetch attachment
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.attachment import Attachment
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.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**](Attachment.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)
# **attachments_id_put**
> Attachment attachments_id_put(id, body)
Update attachment
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.attachment import Attachment
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.AttachmentApi(api_client)
id = 56 # int | ID of attachment
body = easybill_generated_async.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**](Attachment.md)| |
### Return type
[**Attachment**](Attachment.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 attachment | - |
**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)
# **attachments_post**
> Attachment attachments_post(file)
Create attachment
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.attachment import Attachment
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.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**](Attachment.md)
### Authorization
[basicAuth](../README.md#basicAuth), [Bearer](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

View file

@ -0,0 +1,33 @@
# Attachments
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[Attachment]**](Attachment.md) | | [optional]
## Example
```python
from easybill_generated_async.models.attachments import Attachments
# TODO update the JSON string below
json = "{}"
# create an instance of Attachments from a JSON string
attachments_instance = Attachments.from_json(json)
# print the JSON string representation of the object
print(Attachments.to_json())
# convert the object into a dict
attachments_dict = attachments_instance.to_dict()
# create an instance of Attachments from a dict
attachments_from_dict = Attachments.from_dict(attachments_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,52 @@
# Contact
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**city** | **str** | |
**state** | **str** | | [optional]
**company_name** | **str** | | [optional]
**country** | **str** | Two-letter country code | [optional]
**department** | **str** | | [optional] [default to 'null']
**emails** | **List[str]** | | [optional]
**fax** | **str** | | [optional] [default to 'null']
**first_name** | **str** | | [optional] [default to 'null']
**id** | **int** | | [optional] [readonly]
**last_name** | **str** | | [optional] [default to 'null']
**login_id** | **int** | | [optional] [readonly]
**mobile** | **str** | | [optional] [default to 'null']
**note** | **str** | | [optional] [default to 'null']
**personal** | **bool** | | [optional] [default to False]
**phone_1** | **str** | | [optional] [default to 'null']
**phone_2** | **str** | | [optional] [default to 'null']
**salutation** | **int** | 0: empty&lt;br/&gt; 1: Herrn&lt;br/&gt; 2: Frau&lt;br/&gt; 3: Firma&lt;br/&gt; 4: Herrn und Frau&lt;br/&gt; 5: Eheleute&lt;br/&gt; 6: Familie | [optional]
**street** | **str** | |
**suffix_1** | **str** | | [optional] [default to 'null']
**suffix_2** | **str** | | [optional] [default to 'null']
**title** | **str** | | [optional] [default to 'null']
**zip_code** | **str** | | [optional] [default to 'null']
**created_at** | **str** | | [optional] [readonly]
**updated_at** | **str** | | [optional] [readonly]
## Example
```python
from easybill_generated_async.models.contact import Contact
# TODO update the JSON string below
json = "{}"
# create an instance of Contact from a JSON string
contact_instance = Contact.from_json(json)
# print the JSON string representation of the object
print(Contact.to_json())
# convert the object into a dict
contact_dict = contact_instance.to_dict()
# create an instance of Contact from a dict
contact_from_dict = Contact.from_dict(contact_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,453 @@
# easybill_generated_async.ContactApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**customers_customer_id_contacts_get**](ContactApi.md#customers_customer_id_contacts_get) | **GET** /customers/{customerId}/contacts | Fetch customer contact list
[**customers_customer_id_contacts_id_delete**](ContactApi.md#customers_customer_id_contacts_id_delete) | **DELETE** /customers/{customerId}/contacts/{id} | Delete contact
[**customers_customer_id_contacts_id_get**](ContactApi.md#customers_customer_id_contacts_id_get) | **GET** /customers/{customerId}/contacts/{id} | Fetch contact
[**customers_customer_id_contacts_id_put**](ContactApi.md#customers_customer_id_contacts_id_put) | **PUT** /customers/{customerId}/contacts/{id} | Update Contact
[**customers_customer_id_contacts_post**](ContactApi.md#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):
```python
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**](Contacts.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)
# **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):
```python
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](../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)
# **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):
```python
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**](Contact.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)
# **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):
```python
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**](Contact.md)| | [optional]
### Return type
[**Contact**](Contact.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 contact | - |
**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)
# **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):
```python
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**](Contact.md)| | [optional]
### Return type
[**Contact**](Contact.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 contact | - |
**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)

View file

@ -0,0 +1,33 @@
# Contacts
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[Contact]**](Contact.md) | | [optional]
## Example
```python
from easybill_generated_async.models.contacts import Contacts
# TODO update the JSON string below
json = "{}"
# create an instance of Contacts from a JSON string
contacts_instance = Contacts.from_json(json)
# print the JSON string representation of the object
print(Contacts.to_json())
# convert the object into a dict
contacts_dict = contacts_instance.to_dict()
# create an instance of Contacts from a dict
contacts_from_dict = Contacts.from_dict(contacts_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,106 @@
# Customer
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**acquire_options** | **int** | 1 &#x3D; Empfehlung eines anderen Kunden, 2 &#x3D; Zeitungsanzeige, 3 &#x3D; Eigene Akquisition, 4 &#x3D; Mitarbeiter Akquisition, 5 &#x3D; Google, 6 &#x3D; Gelbe Seiten, 7 &#x3D; Kostenlose Internet Plattform, 8 &#x3D; Bezahlte Internet Plattform | [optional]
**additional_groups_ids** | **List[int]** | | [optional]
**bank_account** | **str** | | [optional]
**bank_account_owner** | **str** | | [optional]
**bank_bic** | **str** | | [optional]
**bank_code** | **str** | | [optional]
**bank_iban** | **str** | | [optional]
**bank_name** | **str** | | [optional]
**birth_date** | **date** | | [optional]
**cash_allowance** | **float** | | [optional]
**cash_allowance_days** | **int** | | [optional]
**cash_discount** | **float** | | [optional]
**cash_discount_type** | **str** | | [optional]
**city** | **str** | | [optional]
**state** | **str** | | [optional]
**company_name** | **str** | |
**country** | **str** | | [optional]
**created_at** | **date** | | [optional] [readonly]
**updated_at** | **str** | | [optional] [readonly]
**delivery_title** | **str** | | [optional]
**delivery_city** | **str** | | [optional]
**delivery_state** | **str** | | [optional]
**delivery_company_name** | **str** | | [optional]
**delivery_country** | **str** | | [optional]
**delivery_first_name** | **str** | | [optional]
**delivery_last_name** | **str** | | [optional]
**delivery_personal** | **bool** | | [optional]
**delivery_salutation** | **int** | 0 &#x3D; nothing, 1 &#x3D; Mr, 2 &#x3D; Mrs, 3 &#x3D; Company, 4 &#x3D; Mr &amp; Mrs, 5 &#x3D; Married couple, 6 &#x3D; Family | [optional]
**delivery_street** | **str** | | [optional]
**delivery_suffix_1** | **str** | | [optional]
**delivery_suffix_2** | **str** | | [optional]
**delivery_zip_code** | **str** | | [optional]
**display_name** | **str** | | [optional] [readonly]
**emails** | **List[str]** | | [optional]
**fax** | **str** | | [optional]
**first_name** | **str** | | [optional]
**grace_period** | **int** | will be replaced by its alias due_in_days. | [optional]
**due_in_days** | **int** | due date in days | [optional]
**group_id** | **int** | | [optional]
**id** | **int** | | [optional] [readonly]
**info_1** | **str** | | [optional]
**info_2** | **str** | | [optional]
**internet** | **str** | | [optional]
**last_name** | **str** | |
**login_id** | **int** | | [optional]
**mobile** | **str** | | [optional]
**note** | **str** | | [optional]
**number** | **str** | Automatically generated if empty/omitted and when no type in query is provided or the type &#39;CUSTOMER&#39;, &#39;CUSTOMER,SUPPLIER&#39; | [optional]
**supplier_number** | **str** | Automatically generated if the type SUPPLIER or &#39;CUSTOMER,SUPPLIER&#39; is provided as query parameter and the field supplier_number is empty/omitted. | [optional]
**payment_options** | **int** | 1 &#x3D; Stets pünktliche Zahlung, 2 &#x3D; überwiegend pünktliche Zahlung, 3 &#x3D; überwiegend verspätete Zahlung, 5 &#x3D; Grundsätzlich verspätete Zahlung | [optional]
**personal** | **bool** | | [optional] [default to False]
**phone_1** | **str** | | [optional]
**phone_2** | **str** | | [optional]
**postbox** | **str** | | [optional]
**postbox_city** | **str** | | [optional]
**postbox_state** | **str** | | [optional]
**postbox_country** | **str** | | [optional]
**postbox_zip_code** | **str** | | [optional]
**sale_price_level** | **str** | | [optional]
**salutation** | **int** | 0 &#x3D; nothing, 1 &#x3D; Mr, 2 &#x3D; Mrs, 3 &#x3D; Company, 4 &#x3D; Mr &amp; Mrs, 5 &#x3D; Married couple, 6 &#x3D; Family | [optional]
**sepa_agreement** | **str** | BASIC &#x3D; SEPA-Basislastschrift, COR1 &#x3D; SEPA-Basislastschrift COR1 (deprecated use BASIC instead), COMPANY &#x3D; SEPA-Firmenlastschrift, NULL &#x3D; Noch kein Mandat erteilt | [optional]
**sepa_agreement_date** | **date** | | [optional]
**sepa_mandate_reference** | **str** | | [optional]
**since_date** | **date** | | [optional]
**street** | **str** | | [optional]
**suffix_1** | **str** | | [optional]
**suffix_2** | **str** | | [optional]
**tax_number** | **str** | | [optional]
**court** | **str** | | [optional]
**court_registry_number** | **str** | | [optional]
**tax_options** | **str** | nStb &#x3D; Nicht steuerbar (Drittland), nStbUstID &#x3D; Nicht steuerbar (EU mit USt-IdNr.), nStbNoneUstID &#x3D; Nicht steuerbar (EU ohne USt-IdNr.), revc &#x3D; Steuerschuldwechsel §13b (Inland), IG &#x3D; Innergemeinschaftliche Lieferung, AL &#x3D; Ausfuhrlieferung, sStfr &#x3D; sonstige Steuerbefreiung, NULL &#x3D; Umsatzsteuerpflichtig | [optional]
**title** | **str** | | [optional]
**archived** | **bool** | | [optional]
**vat_identifier** | **str** | | [optional]
**zip_code** | **str** | | [optional]
**document_pdf_type** | **str** | Type of PDF to use when sending a Document to the Customer. | [optional] [default to 'default']
**buyer_reference** | **str** | Used as \&quot;buyerReference\&quot; in ZUGFeRD and as \&quot;Leitweg-ID\&quot; in the XRechnung format. | [optional]
**foreign_supplier_number** | **str** | The ID given to your company by the customer in his system. | [optional]
## Example
```python
from easybill_generated_async.models.customer import Customer
# TODO update the JSON string below
json = "{}"
# create an instance of Customer from a JSON string
customer_instance = Customer.from_json(json)
# print the JSON string representation of the object
print(Customer.to_json())
# convert the object into a dict
customer_dict = customer_instance.to_dict()
# create an instance of Customer from a dict
customer_from_dict = Customer.from_dict(customer_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,467 @@
# easybill_generated_async.CustomerApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**customers_get**](CustomerApi.md#customers_get) | **GET** /customers | Fetch customers list
[**customers_id_delete**](CustomerApi.md#customers_id_delete) | **DELETE** /customers/{id} | Delete customer
[**customers_id_get**](CustomerApi.md#customers_id_get) | **GET** /customers/{id} | Fetch customer
[**customers_id_put**](CustomerApi.md#customers_id_put) | **PUT** /customers/{id} | Update Customer
[**customers_post**](CustomerApi.md#customers_post) | **POST** /customers | Create customer
# **customers_get**
> Customers customers_get(limit=limit, page=page, group_id=group_id, additional_group_id=additional_group_id, number=number, country=country, zip_code=zip_code, emails=emails, first_name=first_name, last_name=last_name, company_name=company_name, created_at=created_at)
Fetch customers list
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.customers import Customers
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.CustomerApi(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)
group_id = 'group_id_example' # str | Filter customers by group_id. You can add multiple group ids separate by comma like id,id,id. (optional)
additional_group_id = 'additional_group_id_example' # str | Filter customers by additional_group_id. You can add multiple group ids separate by comma like id,id,id. (optional)
number = 'number_example' # str | Filter customers by number. You can add multiple numbers separate by comma like no,no,no. (optional)
country = 'country_example' # str | Filter customers by country. You can add multiple countries separate by comma like DE,PL,FR. (optional)
zip_code = 'zip_code_example' # str | Filter customers by zip_code. You can add multiple zip codes separate by comma like zip,zip,zip. (optional)
emails = 'emails_example' # str | Filter customers by emails. You can add multiple emails separate by comma like mail,mail,mail. (optional)
first_name = 'first_name_example' # str | Filter customers by first_name. You can add multiple names separate by comma like name,name,name. (optional)
last_name = 'last_name_example' # str | Filter customers by first_name. You can add multiple names separate by comma like name,name,name. (optional)
company_name = 'company_name_example' # str | Filter customers by first_name. You can add multiple names separate by comma like name,name,name. (optional)
created_at = 'created_at_example' # str | Filter customers by created_at. You can filter one date with created_at=2014-12-10 or between like 2015-01-01,2015-12-31. (optional)
try:
# Fetch customers list
api_response = await api_instance.customers_get(limit=limit, page=page, group_id=group_id, additional_group_id=additional_group_id, number=number, country=country, zip_code=zip_code, emails=emails, first_name=first_name, last_name=last_name, company_name=company_name, created_at=created_at)
print("The response of CustomerApi->customers_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CustomerApi->customers_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]
**group_id** | **str**| Filter customers by group_id. You can add multiple group ids separate by comma like id,id,id. | [optional]
**additional_group_id** | **str**| Filter customers by additional_group_id. You can add multiple group ids separate by comma like id,id,id. | [optional]
**number** | **str**| Filter customers by number. You can add multiple numbers separate by comma like no,no,no. | [optional]
**country** | **str**| Filter customers by country. You can add multiple countries separate by comma like DE,PL,FR. | [optional]
**zip_code** | **str**| Filter customers by zip_code. You can add multiple zip codes separate by comma like zip,zip,zip. | [optional]
**emails** | **str**| Filter customers by emails. You can add multiple emails separate by comma like mail,mail,mail. | [optional]
**first_name** | **str**| Filter customers by first_name. You can add multiple names separate by comma like name,name,name. | [optional]
**last_name** | **str**| Filter customers by first_name. You can add multiple names separate by comma like name,name,name. | [optional]
**company_name** | **str**| Filter customers by first_name. You can add multiple names separate by comma like name,name,name. | [optional]
**created_at** | **str**| Filter customers by created_at. You can filter one date with created_at&#x3D;2014-12-10 or between like 2015-01-01,2015-12-31. | [optional]
### Return type
[**Customers**](Customers.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)
# **customers_id_delete**
> customers_id_delete(id)
Delete customer
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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.CustomerApi(api_client)
id = 56 # int | ID of customer that needs to be deleted
try:
# Delete customer
await api_instance.customers_id_delete(id)
except Exception as e:
print("Exception when calling CustomerApi->customers_id_delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of customer that needs to be deleted |
### 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)
# **customers_id_get**
> Customer customers_id_get(id)
Fetch customer
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.customer import Customer
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.CustomerApi(api_client)
id = 56 # int | ID of customer that needs to be fetched
try:
# Fetch customer
api_response = await api_instance.customers_id_get(id)
print("The response of CustomerApi->customers_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CustomerApi->customers_id_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of customer that needs to be fetched |
### Return type
[**Customer**](Customer.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)
# **customers_id_put**
> Customer customers_id_put(id, body, type=type)
Update Customer
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.customer import Customer
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.CustomerApi(api_client)
id = 56 # int | ID of customer that needs to be updated
body = easybill_generated_async.Customer() # Customer |
type = CUSTOMER # str | Controls the type of the customer. If provided and the field \"number\" or \"supplier_number\" is empty or omitted, the type will force the generation of the relevant number if applicable. I. e. omitting \"supplier_number\" but providing the query parameter \"SUPPLIER\" will generate a \"supplier_number\". (optional) (default to CUSTOMER)
try:
# Update Customer
api_response = await api_instance.customers_id_put(id, body, type=type)
print("The response of CustomerApi->customers_id_put:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CustomerApi->customers_id_put: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of customer that needs to be updated |
**body** | [**Customer**](Customer.md)| |
**type** | **str**| Controls the type of the customer. If provided and the field \&quot;number\&quot; or \&quot;supplier_number\&quot; is empty or omitted, the type will force the generation of the relevant number if applicable. I. e. omitting \&quot;supplier_number\&quot; but providing the query parameter \&quot;SUPPLIER\&quot; will generate a \&quot;supplier_number\&quot;. | [optional] [default to CUSTOMER]
### Return type
[**Customer**](Customer.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 | - |
**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)
# **customers_post**
> Customer customers_post(body, type=type)
Create customer
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.customer import Customer
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.CustomerApi(api_client)
body = easybill_generated_async.Customer() # Customer |
type = CUSTOMER # str | Controls the type of the customer. If provided and the field \"number\" or \"supplier_number\" is empty or omitted, the type will force the generation of the relevant number if applicable. I. e. omitting \"supplier_number\" but providing the query parameter \"SUPPLIER\" will generate a \"supplier_number\". (optional) (default to CUSTOMER)
try:
# Create customer
api_response = await api_instance.customers_post(body, type=type)
print("The response of CustomerApi->customers_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling CustomerApi->customers_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Customer**](Customer.md)| |
**type** | **str**| Controls the type of the customer. If provided and the field \&quot;number\&quot; or \&quot;supplier_number\&quot; is empty or omitted, the type will force the generation of the relevant number if applicable. I. e. omitting \&quot;supplier_number\&quot; but providing the query parameter \&quot;SUPPLIER\&quot; will generate a \&quot;supplier_number\&quot;. | [optional] [default to CUSTOMER]
### Return type
[**Customer**](Customer.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 | - |
**400** | Invalid Customer | - |
**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)

View file

@ -0,0 +1,33 @@
# CustomerGroup
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | |
**description** | **str** | | [optional] [default to 'null']
**number** | **str** | Can be chosen freely |
**display_name** | **str** | | [optional] [readonly]
**id** | **int** | | [optional] [readonly]
## Example
```python
from easybill_generated_async.models.customer_group import CustomerGroup
# TODO update the JSON string below
json = "{}"
# create an instance of CustomerGroup from a JSON string
customer_group_instance = CustomerGroup.from_json(json)
# print the JSON string representation of the object
print(CustomerGroup.to_json())
# convert the object into a dict
customer_group_dict = customer_group_instance.to_dict()
# create an instance of CustomerGroup from a dict
customer_group_from_dict = CustomerGroup.from_dict(customer_group_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,442 @@
# easybill_generated_async.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_async
from easybill_generated_async.models.customer_groups import CustomerGroups
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.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_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.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_async
from easybill_generated_async.models.customer_group import CustomerGroup
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.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_async
from easybill_generated_async.models.customer_group import CustomerGroup
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.CustomerGroupApi(api_client)
id = 56 # int | ID of customer goup
body = easybill_generated_async.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_async
from easybill_generated_async.models.customer_group import CustomerGroup
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.CustomerGroupApi(api_client)
body = easybill_generated_async.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)

View file

@ -0,0 +1,33 @@
# CustomerGroups
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[CustomerGroup]**](CustomerGroup.md) | | [optional]
## Example
```python
from easybill_generated_async.models.customer_groups import CustomerGroups
# TODO update the JSON string below
json = "{}"
# create an instance of CustomerGroups from a JSON string
customer_groups_instance = CustomerGroups.from_json(json)
# print the JSON string representation of the object
print(CustomerGroups.to_json())
# convert the object into a dict
customer_groups_dict = customer_groups_instance.to_dict()
# create an instance of CustomerGroups from a dict
customer_groups_from_dict = CustomerGroups.from_dict(customer_groups_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,107 @@
# CustomerSnapshot
A snapshot of the customer model which belongs to a document. This model is readonly and the state is final after finalization of the document. It's is identical to the state of the customer model at the time of finalization. Updates to the actual customer dataset won't affect this snapshot, however if you update the document the customer and therefore the customer snapshot may reflect a different state.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**acquire_options** | **int** | 1 &#x3D; Empfehlung eines anderen Kunden, 2 &#x3D; Zeitungsanzeige, 3 &#x3D; Eigene Akquisition, 4 &#x3D; Mitarbeiter Akquisition, 5 &#x3D; Google, 6 &#x3D; Gelbe Seiten, 7 &#x3D; Kostenlose Internet Plattform, 8 &#x3D; Bezahlte Internet Plattform | [optional]
**additional_groups_ids** | **List[int]** | | [optional]
**bank_account** | **str** | | [optional]
**bank_account_owner** | **str** | | [optional]
**bank_bic** | **str** | | [optional]
**bank_code** | **str** | | [optional]
**bank_iban** | **str** | | [optional]
**bank_name** | **str** | | [optional]
**birth_date** | **date** | | [optional]
**cash_allowance** | **float** | | [optional]
**cash_allowance_days** | **int** | | [optional]
**cash_discount** | **float** | | [optional]
**cash_discount_type** | **str** | | [optional]
**city** | **str** | | [optional]
**state** | **str** | | [optional]
**company_name** | **str** | |
**country** | **str** | | [optional]
**created_at** | **date** | | [optional] [readonly]
**updated_at** | **str** | | [optional] [readonly]
**delivery_title** | **str** | | [optional]
**delivery_city** | **str** | | [optional]
**delivery_state** | **str** | | [optional]
**delivery_company_name** | **str** | | [optional]
**delivery_country** | **str** | | [optional]
**delivery_first_name** | **str** | | [optional]
**delivery_last_name** | **str** | | [optional]
**delivery_personal** | **bool** | | [optional]
**delivery_salutation** | **int** | 0 &#x3D; nothing, 1 &#x3D; Mr, 2 &#x3D; Mrs, 3 &#x3D; Company, 4 &#x3D; Mr &amp; Mrs, 5 &#x3D; Married couple, 6 &#x3D; Family | [optional]
**delivery_street** | **str** | | [optional]
**delivery_suffix_1** | **str** | | [optional]
**delivery_suffix_2** | **str** | | [optional]
**delivery_zip_code** | **str** | | [optional]
**display_name** | **str** | | [optional] [readonly]
**emails** | **List[str]** | | [optional]
**fax** | **str** | | [optional]
**first_name** | **str** | | [optional]
**grace_period** | **int** | will be replaced by its alias due_in_days. | [optional]
**due_in_days** | **int** | due date in days | [optional]
**group_id** | **int** | | [optional]
**id** | **int** | | [optional] [readonly]
**info_1** | **str** | | [optional]
**info_2** | **str** | | [optional]
**internet** | **str** | | [optional]
**last_name** | **str** | |
**login_id** | **int** | | [optional]
**mobile** | **str** | | [optional]
**note** | **str** | | [optional]
**number** | **str** | Automatically generated if empty/omitted and when no type in query is provided or the type &#39;CUSTOMER&#39;, &#39;CUSTOMER,SUPPLIER&#39; | [optional]
**supplier_number** | **str** | Automatically generated if the type SUPPLIER or &#39;CUSTOMER,SUPPLIER&#39; is provided as query parameter and the field supplier_number is empty/omitted. | [optional]
**payment_options** | **int** | 1 &#x3D; Stets pünktliche Zahlung, 2 &#x3D; überwiegend pünktliche Zahlung, 3 &#x3D; überwiegend verspätete Zahlung, 5 &#x3D; Grundsätzlich verspätete Zahlung | [optional]
**personal** | **bool** | | [optional] [default to False]
**phone_1** | **str** | | [optional]
**phone_2** | **str** | | [optional]
**postbox** | **str** | | [optional]
**postbox_city** | **str** | | [optional]
**postbox_state** | **str** | | [optional]
**postbox_country** | **str** | | [optional]
**postbox_zip_code** | **str** | | [optional]
**sale_price_level** | **str** | | [optional]
**salutation** | **int** | 0 &#x3D; nothing, 1 &#x3D; Mr, 2 &#x3D; Mrs, 3 &#x3D; Company, 4 &#x3D; Mr &amp; Mrs, 5 &#x3D; Married couple, 6 &#x3D; Family | [optional]
**sepa_agreement** | **str** | BASIC &#x3D; SEPA-Basislastschrift, COR1 &#x3D; SEPA-Basislastschrift COR1 (deprecated use BASIC instead), COMPANY &#x3D; SEPA-Firmenlastschrift, NULL &#x3D; Noch kein Mandat erteilt | [optional]
**sepa_agreement_date** | **date** | | [optional]
**sepa_mandate_reference** | **str** | | [optional]
**since_date** | **date** | | [optional]
**street** | **str** | | [optional]
**suffix_1** | **str** | | [optional]
**suffix_2** | **str** | | [optional]
**tax_number** | **str** | | [optional]
**court** | **str** | | [optional]
**court_registry_number** | **str** | | [optional]
**tax_options** | **str** | nStb &#x3D; Nicht steuerbar (Drittland), nStbUstID &#x3D; Nicht steuerbar (EU mit USt-IdNr.), nStbNoneUstID &#x3D; Nicht steuerbar (EU ohne USt-IdNr.), revc &#x3D; Steuerschuldwechsel §13b (Inland), IG &#x3D; Innergemeinschaftliche Lieferung, AL &#x3D; Ausfuhrlieferung, sStfr &#x3D; sonstige Steuerbefreiung, NULL &#x3D; Umsatzsteuerpflichtig | [optional]
**title** | **str** | | [optional]
**archived** | **bool** | | [optional]
**vat_identifier** | **str** | | [optional]
**zip_code** | **str** | | [optional]
**document_pdf_type** | **str** | Type of PDF to use when sending a Document to the Customer. | [optional] [default to 'default']
**buyer_reference** | **str** | Used as \&quot;buyerReference\&quot; in ZUGFeRD and as \&quot;Leitweg-ID\&quot; in the XRechnung format. | [optional]
**foreign_supplier_number** | **str** | The ID given to your company by the customer in his system. | [optional]
## Example
```python
from easybill_generated_async.models.customer_snapshot import CustomerSnapshot
# TODO update the JSON string below
json = "{}"
# create an instance of CustomerSnapshot from a JSON string
customer_snapshot_instance = CustomerSnapshot.from_json(json)
# print the JSON string representation of the object
print(CustomerSnapshot.to_json())
# convert the object into a dict
customer_snapshot_dict = customer_snapshot_instance.to_dict()
# create an instance of CustomerSnapshot from a dict
customer_snapshot_from_dict = CustomerSnapshot.from_dict(customer_snapshot_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,33 @@
# Customers
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[Customer]**](Customer.md) | | [optional]
## Example
```python
from easybill_generated_async.models.customers import Customers
# TODO update the JSON string below
json = "{}"
# create an instance of Customers from a JSON string
customers_instance = Customers.from_json(json)
# print the JSON string representation of the object
print(Customers.to_json())
# convert the object into a dict
customers_dict = customers_instance.to_dict()
# create an instance of Customers from a dict
customers_from_dict = Customers.from_dict(customers_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,32 @@
# Discount
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional] [readonly]
**customer_id** | **int** | |
**discount** | **int** | The discount value depending on \&quot;discount_type\&quot;. If not provided, inherits from customer when available | [optional]
**discount_type** | **str** | AMOUNT subtracts the value in \&quot;discount\&quot; from the total&lt;br/&gt; QUANTITY subtracts the value in \&quot;discount\&quot; multiplied by quantity&lt;br/&gt; PERCENT uses the value in \&quot;discount\&quot; as a percentage&lt;br/&gt; FIX sets the value in \&quot;discount\&quot; as the new price. If not provided, inherits from customer when available | [optional] [default to 'PERCENT']
## Example
```python
from easybill_generated_async.models.discount import Discount
# TODO update the JSON string below
json = "{}"
# create an instance of Discount from a JSON string
discount_instance = Discount.from_json(json)
# print the JSON string representation of the object
print(Discount.to_json())
# convert the object into a dict
discount_dict = discount_instance.to_dict()
# create an instance of Discount from a dict
discount_from_dict = Discount.from_dict(discount_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,888 @@
# easybill_generated_async.DiscountApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**discounts_position_get**](DiscountApi.md#discounts_position_get) | **GET** /discounts/position | Fetch list of position discounts
[**discounts_position_group_get**](DiscountApi.md#discounts_position_group_get) | **GET** /discounts/position-group | Fetch list of position-group discounts
[**discounts_position_group_id_delete**](DiscountApi.md#discounts_position_group_id_delete) | **DELETE** /discounts/position-group/{id} | Delete the specified position-group discount
[**discounts_position_group_id_get**](DiscountApi.md#discounts_position_group_id_get) | **GET** /discounts/position-group/{id} | Fetch specified position-group discount by id
[**discounts_position_group_id_put**](DiscountApi.md#discounts_position_group_id_put) | **PUT** /discounts/position-group/{id} | Update a position-group discount
[**discounts_position_group_post**](DiscountApi.md#discounts_position_group_post) | **POST** /discounts/position-group | Create a new position-group discount
[**discounts_position_id_delete**](DiscountApi.md#discounts_position_id_delete) | **DELETE** /discounts/position/{id} | Delete the specified position discount
[**discounts_position_id_get**](DiscountApi.md#discounts_position_id_get) | **GET** /discounts/position/{id} | Fetch specified position discount by id
[**discounts_position_id_put**](DiscountApi.md#discounts_position_id_put) | **PUT** /discounts/position/{id} | Update a position discount
[**discounts_position_post**](DiscountApi.md#discounts_position_post) | **POST** /discounts/position | Create a new position discount
# **discounts_position_get**
> DiscountPositions discounts_position_get(limit=limit, page=page, customer_id=customer_id)
Fetch list of position discounts
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.discount_positions import DiscountPositions
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.DiscountApi(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)
customer_id = 'customer_id_example' # str | Filter discounts by customer_id. You can add multiple customer_ids separate by comma like id,id,id. (optional)
try:
# Fetch list of position discounts
api_response = await api_instance.discounts_position_get(limit=limit, page=page, customer_id=customer_id)
print("The response of DiscountApi->discounts_position_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DiscountApi->discounts_position_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]
**customer_id** | **str**| Filter discounts by customer_id. You can add multiple customer_ids separate by comma like id,id,id. | [optional]
### Return type
[**DiscountPositions**](DiscountPositions.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)
# **discounts_position_group_get**
> DiscountPositionGroups discounts_position_group_get(limit=limit, page=page, customer_id=customer_id)
Fetch list of position-group discounts
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.discount_position_groups import DiscountPositionGroups
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.DiscountApi(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)
customer_id = 'customer_id_example' # str | Filter discounts by customer_id. You can add multiple customer_ids separate by comma like id,id,id. (optional)
try:
# Fetch list of position-group discounts
api_response = await api_instance.discounts_position_group_get(limit=limit, page=page, customer_id=customer_id)
print("The response of DiscountApi->discounts_position_group_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DiscountApi->discounts_position_group_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]
**customer_id** | **str**| Filter discounts by customer_id. You can add multiple customer_ids separate by comma like id,id,id. | [optional]
### Return type
[**DiscountPositionGroups**](DiscountPositionGroups.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)
# **discounts_position_group_id_delete**
> discounts_position_group_id_delete(id)
Delete the specified position-group discount
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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.DiscountApi(api_client)
id = 56 # int | ID of the to be soon deleted discount
try:
# Delete the specified position-group discount
await api_instance.discounts_position_group_id_delete(id)
except Exception as e:
print("Exception when calling DiscountApi->discounts_position_group_id_delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of the to be soon deleted discount |
### 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)
# **discounts_position_group_id_get**
> DiscountPositionGroup discounts_position_group_id_get(id, limit=limit, page=page)
Fetch specified position-group discount by id
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.discount_position_group import DiscountPositionGroup
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.DiscountApi(api_client)
id = 56 # int | ID of the discount
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 specified position-group discount by id
api_response = await api_instance.discounts_position_group_id_get(id, limit=limit, page=page)
print("The response of DiscountApi->discounts_position_group_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DiscountApi->discounts_position_group_id_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of the discount |
**limit** | **int**| Limited the result. Default is 100. Maximum can be 1000. | [optional]
**page** | **int**| Set current Page. Default is 1. | [optional]
### Return type
[**DiscountPositionGroup**](DiscountPositionGroup.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)
# **discounts_position_group_id_put**
> DiscountPositionGroup discounts_position_group_id_put(id, body=body)
Update a position-group discount
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.discount_position_group import DiscountPositionGroup
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.DiscountApi(api_client)
id = 56 # int | ID of the to be soon updated discount
body = easybill_generated_async.DiscountPositionGroup() # DiscountPositionGroup | (optional)
try:
# Update a position-group discount
api_response = await api_instance.discounts_position_group_id_put(id, body=body)
print("The response of DiscountApi->discounts_position_group_id_put:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DiscountApi->discounts_position_group_id_put: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of the to be soon updated discount |
**body** | [**DiscountPositionGroup**](DiscountPositionGroup.md)| | [optional]
### Return type
[**DiscountPositionGroup**](DiscountPositionGroup.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 | - |
**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)
# **discounts_position_group_post**
> DiscountPositionGroup discounts_position_group_post(body)
Create a new position-group discount
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.discount_position_group import DiscountPositionGroup
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.DiscountApi(api_client)
body = easybill_generated_async.DiscountPositionGroup() # DiscountPositionGroup |
try:
# Create a new position-group discount
api_response = await api_instance.discounts_position_group_post(body)
print("The response of DiscountApi->discounts_position_group_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DiscountApi->discounts_position_group_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**DiscountPositionGroup**](DiscountPositionGroup.md)| |
### Return type
[**DiscountPositionGroup**](DiscountPositionGroup.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)
# **discounts_position_id_delete**
> discounts_position_id_delete(id)
Delete the specified position discount
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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.DiscountApi(api_client)
id = 56 # int | ID of the to be soon deleted discount
try:
# Delete the specified position discount
await api_instance.discounts_position_id_delete(id)
except Exception as e:
print("Exception when calling DiscountApi->discounts_position_id_delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of the to be soon deleted discount |
### 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)
# **discounts_position_id_get**
> DiscountPosition discounts_position_id_get(id, limit=limit, page=page)
Fetch specified position discount by id
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.discount_position import DiscountPosition
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.DiscountApi(api_client)
id = 56 # int | ID of the discount
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 specified position discount by id
api_response = await api_instance.discounts_position_id_get(id, limit=limit, page=page)
print("The response of DiscountApi->discounts_position_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DiscountApi->discounts_position_id_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of the discount |
**limit** | **int**| Limited the result. Default is 100. Maximum can be 1000. | [optional]
**page** | **int**| Set current Page. Default is 1. | [optional]
### Return type
[**DiscountPosition**](DiscountPosition.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)
# **discounts_position_id_put**
> DiscountPosition discounts_position_id_put(id, body=body)
Update a position discount
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.discount_position import DiscountPosition
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.DiscountApi(api_client)
id = 56 # int | ID of the to be soon updated discount
body = easybill_generated_async.DiscountPosition() # DiscountPosition | (optional)
try:
# Update a position discount
api_response = await api_instance.discounts_position_id_put(id, body=body)
print("The response of DiscountApi->discounts_position_id_put:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DiscountApi->discounts_position_id_put: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of the to be soon updated discount |
**body** | [**DiscountPosition**](DiscountPosition.md)| | [optional]
### Return type
[**DiscountPosition**](DiscountPosition.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 | - |
**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)
# **discounts_position_post**
> DiscountPosition discounts_position_post(body)
Create a new position discount
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.discount_position import DiscountPosition
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.DiscountApi(api_client)
body = easybill_generated_async.DiscountPosition() # DiscountPosition |
try:
# Create a new position discount
api_response = await api_instance.discounts_position_post(body)
print("The response of DiscountApi->discounts_position_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DiscountApi->discounts_position_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**DiscountPosition**](DiscountPosition.md)| |
### Return type
[**DiscountPosition**](DiscountPosition.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)

View file

@ -0,0 +1,33 @@
# DiscountPosition
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional] [readonly]
**customer_id** | **int** | |
**discount** | **int** | The discount value depending on \&quot;discount_type\&quot;. If not provided, inherits from customer when available | [optional]
**discount_type** | **str** | AMOUNT subtracts the value in \&quot;discount\&quot; from the total&lt;br/&gt; QUANTITY subtracts the value in \&quot;discount\&quot; multiplied by quantity&lt;br/&gt; PERCENT uses the value in \&quot;discount\&quot; as a percentage&lt;br/&gt; FIX sets the value in \&quot;discount\&quot; as the new price. If not provided, inherits from customer when available | [optional] [default to 'PERCENT']
**position_id** | **int** | |
## Example
```python
from easybill_generated_async.models.discount_position import DiscountPosition
# TODO update the JSON string below
json = "{}"
# create an instance of DiscountPosition from a JSON string
discount_position_instance = DiscountPosition.from_json(json)
# print the JSON string representation of the object
print(DiscountPosition.to_json())
# convert the object into a dict
discount_position_dict = discount_position_instance.to_dict()
# create an instance of DiscountPosition from a dict
discount_position_from_dict = DiscountPosition.from_dict(discount_position_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,33 @@
# DiscountPositionGroup
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional] [readonly]
**customer_id** | **int** | |
**discount** | **int** | The discount value depending on \&quot;discount_type\&quot;. If not provided, inherits from customer when available | [optional]
**discount_type** | **str** | AMOUNT subtracts the value in \&quot;discount\&quot; from the total&lt;br/&gt; QUANTITY subtracts the value in \&quot;discount\&quot; multiplied by quantity&lt;br/&gt; PERCENT uses the value in \&quot;discount\&quot; as a percentage&lt;br/&gt; FIX sets the value in \&quot;discount\&quot; as the new price. If not provided, inherits from customer when available | [optional] [default to 'PERCENT']
**position_group_id** | **int** | |
## Example
```python
from easybill_generated_async.models.discount_position_group import DiscountPositionGroup
# TODO update the JSON string below
json = "{}"
# create an instance of DiscountPositionGroup from a JSON string
discount_position_group_instance = DiscountPositionGroup.from_json(json)
# print the JSON string representation of the object
print(DiscountPositionGroup.to_json())
# convert the object into a dict
discount_position_group_dict = discount_position_group_instance.to_dict()
# create an instance of DiscountPositionGroup from a dict
discount_position_group_from_dict = DiscountPositionGroup.from_dict(discount_position_group_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,33 @@
# DiscountPositionGroups
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[DiscountPositionGroup]**](DiscountPositionGroup.md) | | [optional]
## Example
```python
from easybill_generated_async.models.discount_position_groups import DiscountPositionGroups
# TODO update the JSON string below
json = "{}"
# create an instance of DiscountPositionGroups from a JSON string
discount_position_groups_instance = DiscountPositionGroups.from_json(json)
# print the JSON string representation of the object
print(DiscountPositionGroups.to_json())
# convert the object into a dict
discount_position_groups_dict = discount_position_groups_instance.to_dict()
# create an instance of DiscountPositionGroups from a dict
discount_position_groups_from_dict = DiscountPositionGroups.from_dict(discount_position_groups_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,33 @@
# DiscountPositions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[DiscountPosition]**](DiscountPosition.md) | | [optional]
## Example
```python
from easybill_generated_async.models.discount_positions import DiscountPositions
# TODO update the JSON string below
json = "{}"
# create an instance of DiscountPositions from a JSON string
discount_positions_instance = DiscountPositions.from_json(json)
# print the JSON string representation of the object
print(DiscountPositions.to_json())
# convert the object into a dict
discount_positions_dict = discount_positions_instance.to_dict()
# create an instance of DiscountPositions from a dict
discount_positions_from_dict = DiscountPositions.from_dict(discount_positions_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,97 @@
# Document
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**address** | [**DocumentAddress**](DocumentAddress.md) | | [optional]
**advanced_data_fields** | [**List[AdvancedDataField]**](AdvancedDataField.md) | EN16931 Business Terms (BT fields) for structured invoice data. On update the submitted list fully replaces the existing fields — send an empty array to clear all. | [optional]
**attachment_ids** | **List[int]** | | [optional] [readonly]
**label_address** | [**DocumentAddress**](DocumentAddress.md) | | [optional]
**amount** | **int** | Amount in cents (e.g. \&quot;150\&quot; &#x3D; 1.50€) | [optional] [readonly]
**amount_net** | **int** | Amount in cents (e.g. \&quot;150\&quot; &#x3D; 1.50€) | [optional] [readonly]
**anonymize_due_date** | **date** | A date which signals when to anonymize the document. Must be in the future. Turns into a read only field if the document is anonymized | [optional]
**anonymize_status** | **str** | This field signals if the document was anonymized | [optional] [readonly] [default to 'NOT_ANONYMIZED']
**anonymized_at** | **str** | | [optional] [readonly]
**bank_debit_form** | **str** | | [optional] [default to 'null']
**billing_country** | **str** | | [optional] [readonly]
**calc_vat_from** | **int** | 0 &#x3D;&#x3D;&#x3D; Net, 1 &#x3D;&#x3D;&#x3D; Gross. | [optional]
**cancel_id** | **int** | ID from the cancel document. Only for document type INVOICE. | [optional] [readonly]
**cash_allowance** | **float** | Cash allowance percentage. If not provided, inherits from customer when available. | [optional]
**cash_allowance_days** | **int** | Days for cash allowance. If not provided, inherits from customer when available. | [optional]
**cash_allowance_text** | **str** | | [optional] [default to 'null']
**contact_id** | **int** | | [optional]
**contact_label** | **str** | | [optional] [default to '']
**contact_text** | **str** | | [optional] [default to '']
**created_at** | **datetime** | | [optional] [readonly]
**currency** | **str** | | [optional] [default to 'EUR']
**customer_id** | **int** | | [optional]
**customer_snapshot** | [**CustomerSnapshot**](CustomerSnapshot.md) | | [optional]
**discount** | **str** | | [optional] [default to 'null']
**discount_type** | **str** | | [optional] [default to null]
**document_date** | **date** | | [optional]
**due_date** | **date** | To change the value use grace_period. | [optional] [readonly]
**edited_at** | **datetime** | | [optional] [readonly]
**external_id** | **str** | | [optional] [default to 'null']
**replica_url** | **str** | | [optional] [default to 'null']
**grace_period** | **int** | will be replaced by its alias due_in_days. | [optional]
**due_in_days** | **int** | due date in days. If not provided, inherits from customer when available | [optional]
**id** | **int** | | [optional] [readonly]
**is_acceptable_on_public_domain** | **bool** | Indicates if a document can be accepted by the end customer through the document&#39;s public access page. | [optional] [default to False]
**is_archive** | **bool** | | [optional] [default to False]
**is_draft** | **bool** | This property is read only. To finish the document call /documents/{id}/done. | [optional] [readonly]
**is_replica** | **bool** | Marks a document as a replica from another software. | [optional] [default to False]
**is_oss** | **bool** | Indicates if a document is a one-stop-shop document | [optional] [default to False]
**item_notes** | **List[str]** | Field holds all unique document_note of items for the document | [optional] [readonly]
**items** | [**List[DocumentPosition]**](DocumentPosition.md) | | [optional]
**last_postbox_id** | **int** | | [optional] [readonly]
**login_id** | **int** | If omitted or null, the currently active login is used. | [optional]
**number** | **str** | | [optional] [default to 'null']
**order_number** | **str** | | [optional] [default to '']
**buyer_reference** | **str** | | [optional] [default to '']
**paid_amount** | **int** | | [optional] [readonly]
**paid_at** | **date** | | [optional] [readonly]
**pdf_pages** | **int** | | [optional] [readonly]
**pdf_template** | **str** | Default template is null or &#39;DE&#39;, default english is &#39;EN&#39; and for all others use the numeric template ID. | [optional]
**payment_link_enabled** | **bool** | Whether the payment link is shown on this document. Overrides the setting from the referenced template. | [optional] [default to False]
**payment_link_locale** | **str** | Language of the payment link text on the document. | [optional] [default to 'de']
**project_id** | **int** | | [optional]
**recurring_options** | [**DocumentRecurring**](DocumentRecurring.md) | | [optional]
**ref_id** | **int** | Reference document id | [optional]
**root_id** | **int** | Root document id | [optional] [readonly]
**service_date** | [**ServiceDate**](ServiceDate.md) | | [optional]
**shipping_country** | **str** | | [optional] [default to 'null']
**status** | **str** | This value can only be used in document type DELIVERY, ORDER, CHARGE or OFFER. NULL is default &#x3D; not set. | [optional] [default to null]
**text** | **str** | | [optional]
**text_prefix** | **str** | | [optional]
**text_tax** | **str** | Overwrites the default vat-option text from the document layout. It is only displayed in documents with the type other than: Delivery, Dunning, Reminder or Letter and a different vat-option than null | [optional] [default to 'null']
**title** | **str** | | [optional] [default to 'null']
**type** | **str** | Can only set on create. | [optional] [default to 'INVOICE']
**use_shipping_address** | **bool** | If true and customer has shipping address then it will be used. | [optional] [default to False]
**vat_country** | **str** | | [optional] [default to 'null']
**vat_id** | **str** | | [optional] [readonly] [default to '']
**fulfillment_country** | **str** | | [optional] [default to 'null']
**vat_option** | **str** | NULL: Normal steuerbar&lt;br/&gt; nStb: Nicht steuerbar (Drittland)&lt;br/&gt; nStbUstID: Nicht steuerbar (EU mit USt-IdNr.)&lt;br/&gt; nStbNoneUstID: Nicht steuerbar (EU ohne USt-IdNr.)&lt;br/&gt; nStbIm: Nicht steuerbarer Innenumsatz&lt;br/&gt; revc: Steuerschuldwechsel §13b (Inland)&lt;br/&gt; IG: Innergemeinschaftliche Lieferung&lt;br/&gt; AL: Ausfuhrlieferung&lt;br/&gt; sStfr: sonstige Steuerbefreiung&lt;br/&gt; smallBusiness: Kleinunternehmen (Keine MwSt.) | [optional] [default to null]
**file_format_config** | [**List[FileFormatConfig]**](FileFormatConfig.md) | | [optional]
## Example
```python
from easybill_generated_async.models.document import Document
# TODO update the JSON string below
json = "{}"
# create an instance of Document from a JSON string
document_instance = Document.from_json(json)
# print the JSON string representation of the object
print(Document.to_json())
# convert the object into a dict
document_dict = document_instance.to_dict()
# create an instance of Document from a dict
document_from_dict = Document.from_dict(document_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,42 @@
# DocumentAddress
This information comes from the customer which can be set with customer_id.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**salutation** | **int** | 0: empty&lt;br/&gt; 1: Herrn&lt;br/&gt; 2: Frau&lt;br/&gt; 3: Firma&lt;br/&gt; 4: Herrn und Frau&lt;br/&gt; 5: Eheleute&lt;br/&gt; 6: Familie | [optional] [readonly]
**personal** | **bool** | | [optional] [readonly]
**title** | **str** | | [optional] [readonly]
**first_name** | **str** | | [optional] [readonly]
**last_name** | **str** | | [optional] [readonly]
**suffix_1** | **str** | | [optional] [readonly]
**suffix_2** | **str** | | [optional] [readonly]
**company_name** | **str** | | [optional] [readonly]
**street** | **str** | | [optional] [readonly]
**zip_code** | **str** | | [optional] [readonly]
**city** | **str** | | [optional] [readonly]
**state** | **str** | | [optional] [readonly]
**country** | **str** | | [optional] [readonly]
## Example
```python
from easybill_generated_async.models.document_address import DocumentAddress
# TODO update the JSON string below
json = "{}"
# create an instance of DocumentAddress from a JSON string
document_address_instance = DocumentAddress.from_json(json)
# print the JSON string representation of the object
print(DocumentAddress.to_json())
# convert the object into a dict
document_address_dict = document_address_instance.to_dict()
# create an instance of DocumentAddress from a dict
document_address_from_dict = DocumentAddress.from_dict(document_address_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,38 @@
# DocumentPayment
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**amount** | **int** | |
**document_id** | **int** | |
**id** | **int** | | [optional] [readonly]
**is_overdue_fee** | **bool** | | [optional]
**login_id** | **int** | | [optional] [readonly]
**notice** | **str** | | [optional] [default to '']
**payment_at** | **date** | | [optional]
**type** | **str** | | [optional] [default to '']
**provider** | **str** | | [optional] [default to '']
**reference** | **str** | | [optional] [default to '']
## Example
```python
from easybill_generated_async.models.document_payment import DocumentPayment
# TODO update the JSON string below
json = "{}"
# create an instance of DocumentPayment from a JSON string
document_payment_instance = DocumentPayment.from_json(json)
# print the JSON string representation of the object
print(DocumentPayment.to_json())
# convert the object into a dict
document_payment_dict = document_payment_instance.to_dict()
# create an instance of DocumentPayment from a dict
document_payment_from_dict = DocumentPayment.from_dict(document_payment_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,361 @@
# easybill_generated_async.DocumentPaymentApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**document_payments_get**](DocumentPaymentApi.md#document_payments_get) | **GET** /document-payments | Fetch document payments list
[**document_payments_id_delete**](DocumentPaymentApi.md#document_payments_id_delete) | **DELETE** /document-payments/{id} | Delete document payment
[**document_payments_id_get**](DocumentPaymentApi.md#document_payments_id_get) | **GET** /document-payments/{id} | Fetch document payment
[**document_payments_post**](DocumentPaymentApi.md#document_payments_post) | **POST** /document-payments | Create document payment
# **document_payments_get**
> DocumentPayments document_payments_get(limit=limit, page=page, document_id=document_id, payment_at=payment_at, reference=reference)
Fetch document payments list
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.document_payments import DocumentPayments
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.DocumentPaymentApi(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 payments by document_id. You can add multiple ids separate by comma like id,id,id. (optional)
payment_at = 'payment_at_example' # str | Filter payments by payment_at. You can filter one date with payment_at=2014-12-10 or between like 2015-01-01,2015-12-31. (optional)
reference = 'reference_example' # str | Filter payments by reference. You can add multiple references separate by comma like id,id,id. (optional)
try:
# Fetch document payments list
api_response = await api_instance.document_payments_get(limit=limit, page=page, document_id=document_id, payment_at=payment_at, reference=reference)
print("The response of DocumentPaymentApi->document_payments_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentPaymentApi->document_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 payments by document_id. You can add multiple ids separate by comma like id,id,id. | [optional]
**payment_at** | **str**| Filter payments by payment_at. You can filter one date with payment_at&#x3D;2014-12-10 or between like 2015-01-01,2015-12-31. | [optional]
**reference** | **str**| Filter payments by reference. You can add multiple references separate by comma like id,id,id. | [optional]
### Return type
[**DocumentPayments**](DocumentPayments.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)
# **document_payments_id_delete**
> document_payments_id_delete(id)
Delete document payment
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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.DocumentPaymentApi(api_client)
id = 56 # int | ID of document payment
try:
# Delete document payment
await api_instance.document_payments_id_delete(id)
except Exception as e:
print("Exception when calling DocumentPaymentApi->document_payments_id_delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of document payment |
### 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)
# **document_payments_id_get**
> DocumentPayment document_payments_id_get(id)
Fetch document payment
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.document_payment import DocumentPayment
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.DocumentPaymentApi(api_client)
id = 56 # int | ID of document payment
try:
# Fetch document payment
api_response = await api_instance.document_payments_id_get(id)
print("The response of DocumentPaymentApi->document_payments_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentPaymentApi->document_payments_id_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of document payment |
### Return type
[**DocumentPayment**](DocumentPayment.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)
# **document_payments_post**
> DocumentPayment document_payments_post(body, paid=paid)
Create document payment
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.document_payment import DocumentPayment
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.DocumentPaymentApi(api_client)
body = easybill_generated_async.DocumentPayment() # DocumentPayment |
paid = True # bool | Mark document as paid when amount less then payment amount. (optional)
try:
# Create document payment
api_response = await api_instance.document_payments_post(body, paid=paid)
print("The response of DocumentPaymentApi->document_payments_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentPaymentApi->document_payments_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**DocumentPayment**](DocumentPayment.md)| |
**paid** | **bool**| Mark document as paid when amount less then payment amount. | [optional]
### Return type
[**DocumentPayment**](DocumentPayment.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)

View file

@ -0,0 +1,33 @@
# DocumentPayments
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[DocumentPayment]**](DocumentPayment.md) | | [optional]
## Example
```python
from easybill_generated_async.models.document_payments import DocumentPayments
# TODO update the JSON string below
json = "{}"
# create an instance of DocumentPayments from a JSON string
document_payments_instance = DocumentPayments.from_json(json)
# print the JSON string representation of the object
print(DocumentPayments.to_json())
# convert the object into a dict
document_payments_dict = document_payments_instance.to_dict()
# create an instance of DocumentPayments from a dict
document_payments_from_dict = DocumentPayments.from_dict(document_payments_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,56 @@
# DocumentPosition
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**number** | **str** | | [optional] [default to 'null']
**description** | **str** | | [optional] [default to 'null']
**document_note** | **str** | This field can be used in the document text areas with the liquid placeholder {{document.item_notes}}. Every note is only displayed once for every kind of product. This is useful if you want to add something like an instruction. | [optional]
**quantity** | **float** | | [optional] [default to 1.0]
**quantity_str** | **str** | Use quantity_str if you want to set a quantity like: 1:30 h or 3x5 m. quantity_str overwrites quantity. | [optional]
**unit** | **str** | | [optional] [default to 'null']
**type** | **str** | | [optional] [default to 'POSITION']
**position** | **int** | Automatic by default (first item: 1, second item: 2, ...) | [optional]
**single_price_net** | **float** | Price in cents, despite being of type float (e.g. 150 &#x3D; 1.50€, but also 150.0 &#x3D; 1.50€) | [optional]
**single_price_gross** | **float** | Price in cents, despite being of type float (e.g. 150 &#x3D; 1.50€, but also 150.0 &#x3D; 1.50€) | [optional]
**vat_percent** | **float** | | [optional] [default to 0.0]
**discount** | **float** | | [optional]
**discount_type** | **str** | | [optional] [default to null]
**position_id** | **int** | If set, values are copied from the referenced position | [optional]
**total_price_net** | **float** | Price in cents, despite being of type float (e.g. 150 &#x3D; 1.50€, but also 150.0 &#x3D; 1.50€) | [optional] [readonly]
**total_price_gross** | **float** | Price in cents, despite being of type float (e.g. 150 &#x3D; 1.50€, but also 150.0 &#x3D; 1.50€) | [optional] [readonly]
**total_vat** | **float** | | [optional] [readonly]
**serial_number_id** | **str** | | [optional] [readonly]
**serial_number** | **str** | | [optional] [readonly]
**booking_account** | **str** | | [optional] [default to 'null']
**export_cost_1** | **str** | | [optional] [default to 'null']
**export_cost_2** | **str** | | [optional] [default to 'null']
**cost_price_net** | **float** | Price in cents, despite being of type float (e.g. 150 &#x3D; 1.50€, but also 150.0 &#x3D; 1.50€) | [optional]
**cost_price_total** | **float** | Price in cents, despite being of type float (e.g. 150 &#x3D; 1.50€, but also 150.0 &#x3D; 1.50€) | [optional] [readonly]
**cost_price_charge** | **float** | | [optional] [readonly]
**cost_price_charge_type** | **str** | | [optional] [readonly]
**item_type** | **str** | | [optional] [default to 'UNDEFINED']
**id** | **int** | | [optional] [readonly]
## Example
```python
from easybill_generated_async.models.document_position import DocumentPosition
# TODO update the JSON string below
json = "{}"
# create an instance of DocumentPosition from a JSON string
document_position_instance = DocumentPosition.from_json(json)
# print the JSON string representation of the object
print(DocumentPosition.to_json())
# convert the object into a dict
document_position_dict = document_position_instance.to_dict()
# create an instance of DocumentPosition from a dict
document_position_from_dict = DocumentPosition.from_dict(document_position_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,47 @@
# DocumentRecurring
This object is only available in document type RECURRING.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**next_date** | **date** | Must be in the future |
**frequency** | **str** | | [optional] [default to 'MONTHLY']
**frequency_special** | **str** | | [optional] [default to null]
**interval** | **int** | | [optional]
**end_date_or_count** | **str** | Date of last exectution day or number of times to exectute | [optional] [default to 'null']
**status** | **str** | | [optional] [default to 'WAITING']
**as_draft** | **bool** | | [optional] [default to False]
**is_notify** | **bool** | | [optional] [default to False]
**send_as** | **str** | | [optional] [default to null]
**is_sign** | **bool** | | [optional] [default to False]
**is_paid** | **bool** | | [optional] [default to False]
**paid_date_option** | **str** | Option is used to determine what date is used for the payment if is_paid is true. \&quot;next_valid_date\&quot; selects the next workday in regards to the created date of the document if the date falls on a saturday or sunday. | [optional] [default to 'created_date']
**is_sepa** | **bool** | | [optional] [default to False]
**sepa_local_instrument** | **str** | COR1 is deprecated use CORE instead. | [optional] [default to null]
**sepa_sequence_type** | **str** | | [optional] [default to null]
**sepa_reference** | **str** | | [optional] [default to 'null']
**sepa_remittance_information** | **str** | | [optional] [default to 'null']
**target_type** | **str** | The document type that will be generated. Can not be changed on existing documents. | [optional] [default to 'INVOICE']
## Example
```python
from easybill_generated_async.models.document_recurring import DocumentRecurring
# TODO update the JSON string below
json = "{}"
# create an instance of DocumentRecurring from a JSON string
document_recurring_instance = DocumentRecurring.from_json(json)
# print the JSON string representation of the object
print(DocumentRecurring.to_json())
# convert the object into a dict
document_recurring_dict = document_recurring_instance.to_dict()
# create an instance of DocumentRecurring from a dict
document_recurring_from_dict = DocumentRecurring.from_dict(document_recurring_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,33 @@
# DocumentVersion
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created_at** | **datetime** | | [optional] [readonly]
**document_id** | **int** | | [optional] [readonly]
**id** | **int** | | [optional] [readonly]
**items** | [**List[DocumentVersionItem]**](DocumentVersionItem.md) | | [optional]
**reason** | **str** | | [optional] [readonly]
## Example
```python
from easybill_generated_async.models.document_version import DocumentVersion
# TODO update the JSON string below
json = "{}"
# create an instance of DocumentVersion from a JSON string
document_version_instance = DocumentVersion.from_json(json)
# print the JSON string representation of the object
print(DocumentVersion.to_json())
# convert the object into a dict
document_version_dict = document_version_instance.to_dict()
# create an instance of DocumentVersion from a dict
document_version_from_dict = DocumentVersion.from_dict(document_version_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,277 @@
# easybill_generated_async.DocumentVersionApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**documents_id_versions_get**](DocumentVersionApi.md#documents_id_versions_get) | **GET** /documents/{id}/versions | List all versions of a given document
[**documents_id_versions_version_id_get**](DocumentVersionApi.md#documents_id_versions_version_id_get) | **GET** /documents/{id}/versions/{versionId} | Show a single version of a given document
[**documents_id_versions_version_id_items_version_item_id_download_get**](DocumentVersionApi.md#documents_id_versions_version_id_items_version_item_id_download_get) | **GET** /documents/{id}/versions/{versionId}/items/{versionItemId}/download | Download a specific file for a single version of a given document
# **documents_id_versions_get**
> DocumentVersions documents_id_versions_get(id, limit=limit, page=page)
List all versions of a given document
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.document_versions import DocumentVersions
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.DocumentVersionApi(api_client)
id = 56 # int | ID of document
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:
# List all versions of a given document
api_response = await api_instance.documents_id_versions_get(id, limit=limit, page=page)
print("The response of DocumentVersionApi->documents_id_versions_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentVersionApi->documents_id_versions_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of document |
**limit** | **int**| Limited the result. Default is 100. Maximum can be 1000. | [optional]
**page** | **int**| Set current Page. Default is 1. | [optional]
### Return type
[**DocumentVersions**](DocumentVersions.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)
# **documents_id_versions_version_id_get**
> DocumentVersion documents_id_versions_version_id_get(id, version_id)
Show a single version of a given document
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.document_version import DocumentVersion
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.DocumentVersionApi(api_client)
id = 56 # int | ID of document
version_id = 56 # int | ID of document version
try:
# Show a single version of a given document
api_response = await api_instance.documents_id_versions_version_id_get(id, version_id)
print("The response of DocumentVersionApi->documents_id_versions_version_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentVersionApi->documents_id_versions_version_id_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of document |
**version_id** | **int**| ID of document version |
### Return type
[**DocumentVersion**](DocumentVersion.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** | Document Version does not exist | - |
**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)
# **documents_id_versions_version_id_items_version_item_id_download_get**
> bytes documents_id_versions_version_id_items_version_item_id_download_get(id, version_id, version_item_id)
Download a specific file for a single version of a given document
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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.DocumentVersionApi(api_client)
id = 56 # int | ID of document
version_id = 56 # int | ID of document version
version_item_id = 56 # int | ID of document version item
try:
# Download a specific file for a single version of a given document
api_response = await api_instance.documents_id_versions_version_id_items_version_item_id_download_get(id, version_id, version_item_id)
print("The response of DocumentVersionApi->documents_id_versions_version_id_items_version_item_id_download_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentVersionApi->documents_id_versions_version_id_items_version_item_id_download_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of document |
**version_id** | **int**| ID of document version |
**version_item_id** | **int**| ID of document version item |
### Return type
**bytes**
### Authorization
[basicAuth](../README.md#basicAuth), [Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/pdf, text/xml
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful operation | - |
**404** | Document Version does not exist | - |
**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)

View file

@ -0,0 +1,30 @@
# DocumentVersionItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**document_version_item_type** | **str** | | [optional] [readonly]
**id** | **int** | | [optional] [readonly]
## Example
```python
from easybill_generated_async.models.document_version_item import DocumentVersionItem
# TODO update the JSON string below
json = "{}"
# create an instance of DocumentVersionItem from a JSON string
document_version_item_instance = DocumentVersionItem.from_json(json)
# print the JSON string representation of the object
print(DocumentVersionItem.to_json())
# convert the object into a dict
document_version_item_dict = document_version_item_instance.to_dict()
# create an instance of DocumentVersionItem from a dict
document_version_item_from_dict = DocumentVersionItem.from_dict(document_version_item_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,33 @@
# DocumentVersions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[DocumentVersion]**](DocumentVersion.md) | | [optional]
## Example
```python
from easybill_generated_async.models.document_versions import DocumentVersions
# TODO update the JSON string below
json = "{}"
# create an instance of DocumentVersions from a JSON string
document_versions_instance = DocumentVersions.from_json(json)
# print the JSON string representation of the object
print(DocumentVersions.to_json())
# convert the object into a dict
document_versions_dict = document_versions_instance.to_dict()
# create an instance of DocumentVersions from a dict
document_versions_from_dict = DocumentVersions.from_dict(document_versions_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,33 @@
# Documents
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[Document]**](Document.md) | | [optional]
## Example
```python
from easybill_generated_async.models.documents import Documents
# TODO update the JSON string below
json = "{}"
# create an instance of Documents from a JSON string
documents_instance = Documents.from_json(json)
# print the JSON string representation of the object
print(Documents.to_json())
# convert the object into a dict
documents_dict = documents_instance.to_dict()
# create an instance of Documents from a dict
documents_from_dict = Documents.from_dict(documents_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,29 @@
# FileFormatConfig
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | |
## Example
```python
from easybill_generated_async.models.file_format_config import FileFormatConfig
# TODO update the JSON string below
json = "{}"
# create an instance of FileFormatConfig from a JSON string
file_format_config_instance = FileFormatConfig.from_json(json)
# print the JSON string representation of the object
print(FileFormatConfig.to_json())
# convert the object into a dict
file_format_config_dict = file_format_config_instance.to_dict()
# create an instance of FileFormatConfig from a dict
file_format_config_from_dict = FileFormatConfig.from_dict(file_format_config_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,32 @@
# List
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
## Example
```python
from easybill_generated_async.models.list import List
# TODO update the JSON string below
json = "{}"
# create an instance of List from a JSON string
list_instance = List.from_json(json)
# print the JSON string representation of the object
print(List.to_json())
# convert the object into a dict
list_dict = list_instance.to_dict()
# create an instance of List from a dict
list_from_dict = List.from_dict(list_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,39 @@
# Login
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional] [readonly]
**first_name** | **str** | | [optional]
**last_name** | **str** | | [optional]
**display_name** | **str** | | [optional] [readonly]
**phone** | **str** | | [optional]
**email** | **str** | | [optional]
**email_signature** | **str** | | [optional]
**login_type** | **str** | | [optional] [default to 'ASSISTANT']
**locale** | **str** | | [optional]
**time_zone** | **str** | | [optional]
**security** | [**LoginSecurity**](LoginSecurity.md) | | [optional]
## Example
```python
from easybill_generated_async.models.login import Login
# TODO update the JSON string below
json = "{}"
# create an instance of Login from a JSON string
login_instance = Login.from_json(json)
# print the JSON string representation of the object
print(Login.to_json())
# convert the object into a dict
login_dict = login_instance.to_dict()
# create an instance of Login from a dict
login_from_dict = Login.from_dict(login_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,32 @@
# LoginSecurity
This object is only displayed if your request the login resource as an admin. Otherwise this property will be null.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**two_factor_enabled** | **bool** | Shows if the login has two factor enabled for the login process | [optional] [readonly] [default to False]
**recovery_codes_enabled** | **bool** | Shows if the login has recovery codes enabled to bypass two factor | [optional] [readonly] [default to False]
**notify_on_new_login_enabled** | **bool** | Shows if the login has enabled to be notified if a new login is made from an unknown device. | [optional] [readonly] [default to True]
## Example
```python
from easybill_generated_async.models.login_security import LoginSecurity
# TODO update the JSON string below
json = "{}"
# create an instance of LoginSecurity from a JSON string
login_security_instance = LoginSecurity.from_json(json)
# print the JSON string representation of the object
print(LoginSecurity.to_json())
# convert the object into a dict
login_security_dict = login_security_instance.to_dict()
# create an instance of LoginSecurity from a dict
login_security_from_dict = LoginSecurity.from_dict(login_security_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,33 @@
# Logins
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[Login]**](Login.md) | | [optional]
## Example
```python
from easybill_generated_async.models.logins import Logins
# TODO update the JSON string below
json = "{}"
# create an instance of Logins from a JSON string
logins_instance = Logins.from_json(json)
# print the JSON string representation of the object
print(Logins.to_json())
# convert the object into a dict
logins_dict = logins_instance.to_dict()
# create an instance of Logins from a dict
logins_from_dict = Logins.from_dict(logins_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,176 @@
# easybill_generated_async.LoginsApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**logins_get**](LoginsApi.md#logins_get) | **GET** /logins |
[**logins_id_get**](LoginsApi.md#logins_id_get) | **GET** /logins/{id} |
# **logins_get**
> Logins logins_get(limit=limit, page=page)
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.logins import Logins
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.LoginsApi(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:
api_response = await api_instance.logins_get(limit=limit, page=page)
print("The response of LoginsApi->logins_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling LoginsApi->logins_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
[**Logins**](Logins.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)
# **logins_id_get**
> Login logins_id_get(id)
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.login import Login
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.LoginsApi(api_client)
id = 56 # int | ID of the login that needs to be fetched
try:
api_response = await api_instance.logins_id_get(id)
print("The response of LoginsApi->logins_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling LoginsApi->logins_id_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of the login that needs to be fetched |
### Return type
[**Login**](Login.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)

View file

@ -0,0 +1,33 @@
# PDFTemplate
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [optional] [default to 'INVOICE-DE']
**name** | **str** | | [optional] [default to 'Default template']
**pdf_template** | **str** | | [optional] [default to 'DE']
**document_type** | **str** | | [optional] [default to 'INVOICE']
**settings** | [**PDFTemplateSettings**](PDFTemplateSettings.md) | | [optional]
## Example
```python
from easybill_generated_async.models.pdf_template import PDFTemplate
# TODO update the JSON string below
json = "{}"
# create an instance of PDFTemplate from a JSON string
pdf_template_instance = PDFTemplate.from_json(json)
# print the JSON string representation of the object
print(PDFTemplate.to_json())
# convert the object into a dict
pdf_template_dict = pdf_template_instance.to_dict()
# create an instance of PDFTemplate from a dict
pdf_template_from_dict = PDFTemplate.from_dict(pdf_template_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,31 @@
# PDFTemplateSettings
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**text_prefix** | **str** | | [optional] [default to '']
**text** | **str** | | [optional] [default to '']
**email** | [**PDFTemplateSettingsEmail**](PDFTemplateSettingsEmail.md) | | [optional]
## Example
```python
from easybill_generated_async.models.pdf_template_settings import PDFTemplateSettings
# TODO update the JSON string below
json = "{}"
# create an instance of PDFTemplateSettings from a JSON string
pdf_template_settings_instance = PDFTemplateSettings.from_json(json)
# print the JSON string representation of the object
print(PDFTemplateSettings.to_json())
# convert the object into a dict
pdf_template_settings_dict = pdf_template_settings_instance.to_dict()
# create an instance of PDFTemplateSettings from a dict
pdf_template_settings_from_dict = PDFTemplateSettings.from_dict(pdf_template_settings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,30 @@
# PDFTemplateSettingsEmail
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**subject** | **str** | | [optional] [default to '']
**message** | **str** | | [optional] [default to '']
## Example
```python
from easybill_generated_async.models.pdf_template_settings_email import PDFTemplateSettingsEmail
# TODO update the JSON string below
json = "{}"
# create an instance of PDFTemplateSettingsEmail from a JSON string
pdf_template_settings_email_instance = PDFTemplateSettingsEmail.from_json(json)
# print the JSON string representation of the object
print(PDFTemplateSettingsEmail.to_json())
# convert the object into a dict
pdf_template_settings_email_dict = pdf_template_settings_email_instance.to_dict()
# create an instance of PDFTemplateSettingsEmail from a dict
pdf_template_settings_email_from_dict = PDFTemplateSettingsEmail.from_dict(pdf_template_settings_email_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,29 @@
# PDFTemplates
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**items** | [**List[PDFTemplate]**](PDFTemplate.md) | | [optional]
## Example
```python
from easybill_generated_async.models.pdf_templates import PDFTemplates
# TODO update the JSON string below
json = "{}"
# create an instance of PDFTemplates from a JSON string
pdf_templates_instance = PDFTemplates.from_json(json)
# print the JSON string representation of the object
print(PDFTemplates.to_json())
# convert the object into a dict
pdf_templates_dict = pdf_templates_instance.to_dict()
# create an instance of PDFTemplates from a dict
pdf_templates_from_dict = PDFTemplates.from_dict(pdf_templates_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,94 @@
# easybill_generated_async.PdfTemplatesApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**pdf_templates_get**](PdfTemplatesApi.md#pdf_templates_get) | **GET** /pdf-templates | Fetch PDF Templates list
# **pdf_templates_get**
> PDFTemplates pdf_templates_get(type=type)
Fetch PDF Templates list
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.pdf_templates import PDFTemplates
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.PdfTemplatesApi(api_client)
type = ['type_example'] # List[str] | Filters the templates by the specified type. You can specify several types comma-separated, like type,type,type. (optional)
try:
# Fetch PDF Templates list
api_response = await api_instance.pdf_templates_get(type=type)
print("The response of PdfTemplatesApi->pdf_templates_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PdfTemplatesApi->pdf_templates_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**type** | [**List[str]**](str.md)| Filters the templates by the specified type. You can specify several types comma-separated, like type,type,type. | [optional]
### Return type
[**PDFTemplates**](PDFTemplates.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)

View file

@ -0,0 +1,61 @@
# Position
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional] [readonly]
**type** | **str** | | [optional] [default to 'PRODUCT']
**number** | **str** | |
**description** | **str** | The positions name or description |
**document_note** | **str** | This field can be used in the document text areas with the liquid placeholder {{document.item_notes}}. Every note is only displayed once for every kind of product. This is useful if you want to add something like an instruction. | [optional]
**note** | **str** | Note for internal use | [optional] [default to 'null']
**unit** | **str** | | [optional] [default to 'null']
**export_identifier** | **str** | The FAS-Account is the four-digit revenue account, in which the revenue will be entered when doing the export to your tax consultant. In case you want to split your revenue to several revenue accounts, please talk to your tax consultant before, to guarantee an unobstructed use of the interface. For every revenue element, there are number ranges, which can be used. Please avoid using combinations of numbers, which can not be used by your tax consultant. | [optional] [default to 'null']
**export_identifier_extended** | [**PositionExportIdentifierExtended**](PositionExportIdentifierExtended.md) | | [optional]
**login_id** | **int** | | [optional] [readonly]
**price_type** | **str** | | [optional] [default to 'NETTO']
**vat_percent** | **float** | | [optional] [default to 19.0]
**sale_price** | **float** | Price in cents (e.g. \&quot;150\&quot; &#x3D; 1.50€) |
**sale_price2** | **float** | Price for customers of group 2 in cents (e.g. \&quot;150\&quot; &#x3D; 1.50€) | [optional]
**sale_price3** | **float** | Price for customers of group 3 in cents (e.g. \&quot;150\&quot; &#x3D; 1.50€) | [optional]
**sale_price4** | **float** | Price for customers of group 4 in cents (e.g. \&quot;150\&quot; &#x3D; 1.50€) | [optional]
**sale_price5** | **float** | Price for customers of group 5 in cents (e.g. \&quot;150\&quot; &#x3D; 1.50€) | [optional]
**sale_price6** | **float** | Price for customers of group 6 in cents (e.g. \&quot;150\&quot; &#x3D; 1.50€) | [optional]
**sale_price7** | **float** | Price for customers of group 7 in cents (e.g. \&quot;150\&quot; &#x3D; 1.50€) | [optional]
**sale_price8** | **float** | Price for customers of group 8 in cents (e.g. \&quot;150\&quot; &#x3D; 1.50€) | [optional]
**sale_price9** | **float** | Price for customers of group 9 in cents (e.g. \&quot;150\&quot; &#x3D; 1.50€) | [optional]
**sale_price10** | **float** | Price for customers of group 10 in cents (e.g. \&quot;150\&quot; &#x3D; 1.50€) | [optional]
**cost_price** | **float** | Price in cents (e.g. \&quot;150\&quot; &#x3D; 1.50€) | [optional]
**export_cost1** | **str** | | [optional] [default to 'null']
**export_cost2** | **str** | | [optional] [default to 'null']
**group_id** | **int** | | [optional]
**stock** | **str** | Activates stock management for this position | [optional] [default to 'NO']
**stock_count** | **int** | Current stock count | [optional] [readonly]
**stock_limit_notify** | **bool** | Notify when stock_count is lower than stock_limit | [optional] [default to False]
**stock_limit_notify_frequency** | **str** | Notify frequency when stock_count is lower than stock_limit (ALWAYS, ONCE) | [optional] [default to 'ALWAYS']
**stock_limit** | **int** | | [optional]
**quantity** | **float** | Used as the default quantity when adding this position to a document | [optional]
**archived** | **bool** | | [optional] [default to False]
## Example
```python
from easybill_generated_async.models.position import Position
# TODO update the JSON string below
json = "{}"
# create an instance of Position from a JSON string
position_instance = Position.from_json(json)
# print the JSON string representation of the object
print(Position.to_json())
# convert the object into a dict
position_dict = position_instance.to_dict()
# create an instance of Position from a dict
position_from_dict = Position.from_dict(position_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,446 @@
# easybill_generated_async.PositionApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**positions_get**](PositionApi.md#positions_get) | **GET** /positions | Fetch positions list
[**positions_id_delete**](PositionApi.md#positions_id_delete) | **DELETE** /positions/{id} | Delete position
[**positions_id_get**](PositionApi.md#positions_id_get) | **GET** /positions/{id} | Fetch position
[**positions_id_put**](PositionApi.md#positions_id_put) | **PUT** /positions/{id} | Update position
[**positions_post**](PositionApi.md#positions_post) | **POST** /positions | Create position
# **positions_get**
> Positions positions_get(limit=limit, page=page, type=type, number=number)
Fetch positions list
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.positions import Positions
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.PositionApi(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 positions by type. (optional)
number = 'number_example' # str | Filter positions by number. You can add multiple numbers separate by comma like no,no,no. (optional)
try:
# Fetch positions list
api_response = await api_instance.positions_get(limit=limit, page=page, type=type, number=number)
print("The response of PositionApi->positions_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PositionApi->positions_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 positions by type. | [optional]
**number** | **str**| Filter positions by number. You can add multiple numbers separate by comma like no,no,no. | [optional]
### Return type
[**Positions**](Positions.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)
# **positions_id_delete**
> positions_id_delete(id)
Delete position
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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.PositionApi(api_client)
id = 56 # int | ID of position
try:
# Delete position
await api_instance.positions_id_delete(id)
except Exception as e:
print("Exception when calling PositionApi->positions_id_delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of position |
### 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)
# **positions_id_get**
> Position positions_id_get(id)
Fetch position
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.position import Position
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.PositionApi(api_client)
id = 56 # int | ID of position
try:
# Fetch position
api_response = await api_instance.positions_id_get(id)
print("The response of PositionApi->positions_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PositionApi->positions_id_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of position |
### Return type
[**Position**](Position.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)
# **positions_id_put**
> Position positions_id_put(id, body)
Update position
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.position import Position
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.PositionApi(api_client)
id = 56 # int | ID of position
body = easybill_generated_async.Position() # Position |
try:
# Update position
api_response = await api_instance.positions_id_put(id, body)
print("The response of PositionApi->positions_id_put:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PositionApi->positions_id_put: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of position |
**body** | [**Position**](Position.md)| |
### Return type
[**Position**](Position.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 position | - |
**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)
# **positions_post**
> Position positions_post(body)
Create position
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.position import Position
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.PositionApi(api_client)
body = easybill_generated_async.Position() # Position |
try:
# Create position
api_response = await api_instance.positions_post(body)
print("The response of PositionApi->positions_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PositionApi->positions_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Position**](Position.md)| |
### Return type
[**Position**](Position.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)

View file

@ -0,0 +1,38 @@
# PositionExportIdentifierExtended
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**null** | **str** | Umsatzsteuerpflichtig | [optional] [default to 'null']
**n_stb** | **str** | Nicht steuerbar (Drittland) | [optional] [default to 'null']
**n_stb_ust_id** | **str** | Nicht steuerbar (EU mit USt-IdNr.) | [optional] [default to 'null']
**n_stb_none_ust_id** | **str** | Nicht steuerbar (EU ohne USt-IdNr.) | [optional] [default to 'null']
**n_stb_im** | **str** | Nicht steuerbarer Innenumsatz | [optional] [default to 'null']
**revc** | **str** | Steuerschuldwechsel §13b (Inland) | [optional] [default to 'null']
**ig** | **str** | Innergemeinschaftliche Lieferung | [optional] [default to 'null']
**al** | **str** | Ausfuhrlieferung | [optional] [default to 'null']
**s_stfr** | **str** | sonstige Steuerbefreiung | [optional] [default to 'null']
**small_business** | **str** | Kleinunternehmen (Keine MwSt.) | [optional] [default to 'null']
## Example
```python
from easybill_generated_async.models.position_export_identifier_extended import PositionExportIdentifierExtended
# TODO update the JSON string below
json = "{}"
# create an instance of PositionExportIdentifierExtended from a JSON string
position_export_identifier_extended_instance = PositionExportIdentifierExtended.from_json(json)
# print the JSON string representation of the object
print(PositionExportIdentifierExtended.to_json())
# convert the object into a dict
position_export_identifier_extended_dict = position_export_identifier_extended_instance.to_dict()
# create an instance of PositionExportIdentifierExtended from a dict
position_export_identifier_extended_from_dict = PositionExportIdentifierExtended.from_dict(position_export_identifier_extended_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,34 @@
# PositionGroup
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | | [optional] [default to 'null']
**login_id** | **int** | | [optional] [readonly]
**name** | **str** | |
**number** | **str** | |
**display_name** | **str** | | [optional] [readonly]
**id** | **int** | | [optional] [readonly]
## Example
```python
from easybill_generated_async.models.position_group import PositionGroup
# TODO update the JSON string below
json = "{}"
# create an instance of PositionGroup from a JSON string
position_group_instance = PositionGroup.from_json(json)
# print the JSON string representation of the object
print(PositionGroup.to_json())
# convert the object into a dict
position_group_dict = position_group_instance.to_dict()
# create an instance of PositionGroup from a dict
position_group_from_dict = PositionGroup.from_dict(position_group_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,442 @@
# easybill_generated_async.PositionGroupApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**position_groups_get**](PositionGroupApi.md#position_groups_get) | **GET** /position-groups | Fetch position group list
[**position_groups_id_delete**](PositionGroupApi.md#position_groups_id_delete) | **DELETE** /position-groups/{id} | Delete position group
[**position_groups_id_get**](PositionGroupApi.md#position_groups_id_get) | **GET** /position-groups/{id} | Fetch position group
[**position_groups_id_put**](PositionGroupApi.md#position_groups_id_put) | **PUT** /position-groups/{id} | Update position group
[**position_groups_post**](PositionGroupApi.md#position_groups_post) | **POST** /position-groups | Create position group
# **position_groups_get**
> PositionGroups position_groups_get(limit=limit, page=page)
Fetch position group list
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.position_groups import PositionGroups
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.PositionGroupApi(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 position group list
api_response = await api_instance.position_groups_get(limit=limit, page=page)
print("The response of PositionGroupApi->position_groups_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PositionGroupApi->position_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
[**PositionGroups**](PositionGroups.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)
# **position_groups_id_delete**
> position_groups_id_delete(id)
Delete position group
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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.PositionGroupApi(api_client)
id = 56 # int | ID of position group
try:
# Delete position group
await api_instance.position_groups_id_delete(id)
except Exception as e:
print("Exception when calling PositionGroupApi->position_groups_id_delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of position 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)
# **position_groups_id_get**
> PositionGroup position_groups_id_get(id)
Fetch position group
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.position_group import PositionGroup
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.PositionGroupApi(api_client)
id = 56 # int | ID of position group
try:
# Fetch position group
api_response = await api_instance.position_groups_id_get(id)
print("The response of PositionGroupApi->position_groups_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PositionGroupApi->position_groups_id_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of position group |
### Return type
[**PositionGroup**](PositionGroup.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)
# **position_groups_id_put**
> PositionGroup position_groups_id_put(id, body)
Update position group
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.position_group import PositionGroup
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.PositionGroupApi(api_client)
id = 56 # int | ID of position goup
body = easybill_generated_async.PositionGroup() # PositionGroup |
try:
# Update position group
api_response = await api_instance.position_groups_id_put(id, body)
print("The response of PositionGroupApi->position_groups_id_put:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PositionGroupApi->position_groups_id_put: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of position goup |
**body** | [**PositionGroup**](PositionGroup.md)| |
### Return type
[**PositionGroup**](PositionGroup.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 position 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)
# **position_groups_post**
> PositionGroup position_groups_post(body)
Create position group
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.position_group import PositionGroup
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.PositionGroupApi(api_client)
body = easybill_generated_async.PositionGroup() # PositionGroup |
try:
# Create position group
api_response = await api_instance.position_groups_post(body)
print("The response of PositionGroupApi->position_groups_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PositionGroupApi->position_groups_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**PositionGroup**](PositionGroup.md)| |
### Return type
[**PositionGroup**](PositionGroup.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)

View file

@ -0,0 +1,33 @@
# PositionGroups
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[PositionGroup]**](PositionGroup.md) | | [optional]
## Example
```python
from easybill_generated_async.models.position_groups import PositionGroups
# TODO update the JSON string below
json = "{}"
# create an instance of PositionGroups from a JSON string
position_groups_instance = PositionGroups.from_json(json)
# print the JSON string representation of the object
print(PositionGroups.to_json())
# convert the object into a dict
position_groups_dict = position_groups_instance.to_dict()
# create an instance of PositionGroups from a dict
position_groups_from_dict = PositionGroups.from_dict(position_groups_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,33 @@
# Positions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[Position]**](Position.md) | | [optional]
## Example
```python
from easybill_generated_async.models.positions import Positions
# TODO update the JSON string below
json = "{}"
# create an instance of Positions from a JSON string
positions_instance = Positions.from_json(json)
# print the JSON string representation of the object
print(Positions.to_json())
# convert the object into a dict
positions_dict = positions_instance.to_dict()
# create an instance of Positions from a dict
positions_from_dict = Positions.from_dict(positions_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,47 @@
# PostBox
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional] [readonly]
**document_id** | **int** | | [optional]
**to** | **str** | | [optional]
**cc** | **str** | | [optional]
**var_from** | **str** | | [optional]
**subject** | **str** | | [optional]
**message** | **str** | | [optional]
**var_date** | **date** | | [optional]
**created_at** | **datetime** | | [optional]
**processed_at** | **datetime** | | [optional]
**send_by_self** | **bool** | | [optional]
**send_with_attachment** | **bool** | | [optional]
**type** | **str** | | [optional]
**status** | **str** | | [optional]
**status_msg** | **str** | | [optional]
**login_id** | **int** | | [optional] [readonly]
**document_file_type** | **str** | | [optional]
**post_send_type** | **str** | This value indicates what method is used when the document is send via mail. The different types are offered by the german post as additional services. The registered mail options will include a tracking number which will be added to the postbox when known. If the value is omitted or empty when a postbox is created with the type \&quot;POST\&quot; post_send_type_standard will be used. For postbox with a different type than \&quot;POST\&quot; this field will hold a empty string. | [optional]
**tracking_identifier** | **str** | If the document is send with one of the registered send types stated for post_send_type, a tracking identifier will be added to the postbox at a later point when the tracking identifier is provided by our service partner. | [optional] [readonly]
## Example
```python
from easybill_generated_async.models.post_box import PostBox
# TODO update the JSON string below
json = "{}"
# create an instance of PostBox from a JSON string
post_box_instance = PostBox.from_json(json)
# print the JSON string representation of the object
print(PostBox.to_json())
# convert the object into a dict
post_box_dict = post_box_instance.to_dict()
# create an instance of PostBox from a dict
post_box_from_dict = PostBox.from_dict(post_box_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,273 @@
# easybill_generated_async.PostBoxApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**post_boxes_get**](PostBoxApi.md#post_boxes_get) | **GET** /post-boxes | Fetch post box list
[**post_boxes_id_delete**](PostBoxApi.md#post_boxes_id_delete) | **DELETE** /post-boxes/{id} | Delete post box
[**post_boxes_id_get**](PostBoxApi.md#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):
```python
import easybill_generated_async
from easybill_generated_async.models.post_boxes import PostBoxes
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.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&#x3D;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**](PostBoxes.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)
# **post_boxes_id_delete**
> post_boxes_id_delete(id)
Delete post box
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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.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](../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)
# **post_boxes_id_get**
> PostBox post_boxes_id_get(id)
Fetch post box
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.post_box import PostBox
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.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**](PostBox.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)

View file

@ -0,0 +1,38 @@
# PostBoxRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**to** | **str** | | [optional]
**cc** | **str** | | [optional]
**var_from** | **str** | | [optional]
**subject** | **str** | | [optional]
**message** | **str** | | [optional]
**var_date** | **date** | | [optional]
**send_by_self** | **bool** | | [optional]
**send_with_attachment** | **bool** | | [optional] [default to True]
**document_file_type** | **str** | When set to null, the setting on the customer is used | [optional]
**post_send_type** | **str** | This value indicates what method is used when the document is send via mail. The different types are offered by the german post as additional services. The registered mail options will include a tracking number which will be added to the postbox when known. If the value is omitted or empty when a postbox is created with the type \&quot;POST\&quot; post_send_type_standard will be used. For postbox with a different type than \&quot;POST\&quot; this field will hold a empty string. | [optional]
## Example
```python
from easybill_generated_async.models.post_box_request import PostBoxRequest
# TODO update the JSON string below
json = "{}"
# create an instance of PostBoxRequest from a JSON string
post_box_request_instance = PostBoxRequest.from_json(json)
# print the JSON string representation of the object
print(PostBoxRequest.to_json())
# convert the object into a dict
post_box_request_dict = post_box_request_instance.to_dict()
# create an instance of PostBoxRequest from a dict
post_box_request_from_dict = PostBoxRequest.from_dict(post_box_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,33 @@
# PostBoxes
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[PostBox]**](PostBox.md) | | [optional]
## Example
```python
from easybill_generated_async.models.post_boxes import PostBoxes
# TODO update the JSON string below
json = "{}"
# create an instance of PostBoxes from a JSON string
post_boxes_instance = PostBoxes.from_json(json)
# print the JSON string representation of the object
print(PostBoxes.to_json())
# convert the object into a dict
post_boxes_dict = post_boxes_instance.to_dict()
# create an instance of PostBoxes from a dict
post_boxes_from_dict = PostBoxes.from_dict(post_boxes_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,41 @@
# Project
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**budget_amount** | **int** | Project budget in cents (e.g. \&quot;150\&quot; &#x3D; 1.50€) | [optional]
**budget_time** | **int** | Time budget in minutes (e.g. \&quot;90\&quot; &#x3D; 1 hour and 30 minutes) | [optional]
**customer_id** | **int** | | [optional]
**hourly_rate** | **float** | Hourly rate in cents (e.g. \&quot;150\&quot; &#x3D; 1.50€) | [optional]
**id** | **int** | | [optional] [readonly]
**login_id** | **int** | If omitted or null, the currently active login is used | [optional]
**name** | **str** | |
**note** | **str** | | [optional] [default to 'null']
**status** | **str** | | [optional] [default to 'OPEN']
**due_at** | **date** | | [optional]
**budget_notify_frequency** | **str** | | [optional] [default to 'ALWAYS']
**consumed_time** | **int** | | [optional] [readonly]
**consumed_amount** | **int** | | [optional] [readonly]
## Example
```python
from easybill_generated_async.models.project import Project
# TODO update the JSON string below
json = "{}"
# create an instance of Project from a JSON string
project_instance = Project.from_json(json)
# print the JSON string representation of the object
print(Project.to_json())
# convert the object into a dict
project_dict = project_instance.to_dict()
# create an instance of Project from a dict
project_from_dict = Project.from_dict(project_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,446 @@
# easybill_generated_async.ProjectApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**projects_get**](ProjectApi.md#projects_get) | **GET** /projects | Fetch projects list
[**projects_id_delete**](ProjectApi.md#projects_id_delete) | **DELETE** /projects/{id} | Delete project
[**projects_id_get**](ProjectApi.md#projects_id_get) | **GET** /projects/{id} | Fetch project
[**projects_id_put**](ProjectApi.md#projects_id_put) | **PUT** /projects/{id} | Update project
[**projects_post**](ProjectApi.md#projects_post) | **POST** /projects | Create project
# **projects_get**
> Projects projects_get(limit=limit, page=page, customer_id=customer_id, status=status)
Fetch projects list
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.projects import Projects
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.ProjectApi(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)
customer_id = 'customer_id_example' # str | Filter projects by customer_id. You can add multiple ids separate by comma like id,id,id. (optional)
status = 'status_example' # str | Filter projects by status. (optional)
try:
# Fetch projects list
api_response = await api_instance.projects_get(limit=limit, page=page, customer_id=customer_id, status=status)
print("The response of ProjectApi->projects_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ProjectApi->projects_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]
**customer_id** | **str**| Filter projects by customer_id. You can add multiple ids separate by comma like id,id,id. | [optional]
**status** | **str**| Filter projects by status. | [optional]
### Return type
[**Projects**](Projects.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)
# **projects_id_delete**
> projects_id_delete(id)
Delete project
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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.ProjectApi(api_client)
id = 56 # int | ID of project
try:
# Delete project
await api_instance.projects_id_delete(id)
except Exception as e:
print("Exception when calling ProjectApi->projects_id_delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of project |
### 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)
# **projects_id_get**
> Project projects_id_get(id)
Fetch project
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.project import Project
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.ProjectApi(api_client)
id = 56 # int | ID of project
try:
# Fetch project
api_response = await api_instance.projects_id_get(id)
print("The response of ProjectApi->projects_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ProjectApi->projects_id_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of project |
### Return type
[**Project**](Project.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)
# **projects_id_put**
> Project projects_id_put(id, body)
Update project
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.project import Project
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.ProjectApi(api_client)
id = 56 # int | ID of project
body = easybill_generated_async.Project() # Project |
try:
# Update project
api_response = await api_instance.projects_id_put(id, body)
print("The response of ProjectApi->projects_id_put:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ProjectApi->projects_id_put: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of project |
**body** | [**Project**](Project.md)| |
### Return type
[**Project**](Project.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 project | - |
**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)
# **projects_post**
> Project projects_post(body)
Create project
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.project import Project
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.ProjectApi(api_client)
body = easybill_generated_async.Project() # Project |
try:
# Create project
api_response = await api_instance.projects_post(body)
print("The response of ProjectApi->projects_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ProjectApi->projects_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Project**](Project.md)| |
### Return type
[**Project**](Project.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)

View file

@ -0,0 +1,33 @@
# Projects
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[Project]**](Project.md) | | [optional]
## Example
```python
from easybill_generated_async.models.projects import Projects
# TODO update the JSON string below
json = "{}"
# create an instance of Projects from a JSON string
projects_instance = Projects.from_json(json)
# print the JSON string representation of the object
print(Projects.to_json())
# convert the object into a dict
projects_dict = projects_instance.to_dict()
# create an instance of Projects from a dict
projects_from_dict = Projects.from_dict(projects_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,52 @@
# SEPAPayment
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**amount** | **int** | Amount in cents (e.g. \&quot;150\&quot; &#x3D; 1.50€) |
**created_at** | **datetime** | | [optional] [readonly]
**creditor_bic** | **str** | If type is DEBIT, this field is overwritten with the selected bank account data on export. | [optional] [default to 'null']
**creditor_iban** | **str** | Mandatory if type is CREDIT. If type is DEBIT, this field is overwritten with the selected bank account data on export. | [optional]
**creditor_name** | **str** | Mandatory if type is CREDIT. If type is DEBIT, this field is overwritten with the selected bank account data on export. | [optional]
**debitor_bic** | **str** | If type is CREDIT, this field is overwritten with the selected bank account data on export. | [optional] [default to 'null']
**debitor_iban** | **str** | Mandatory if type is DEBIT. If type is CREDIT, this field is overwritten with the selected bank account data on export. |
**debitor_name** | **str** | Mandatory if type is DEBIT. If type is CREDIT, this field is overwritten with the selected bank account data on export. |
**debitor_address_line_1** | **str** | Mandatory if type is DEBIT and the debitor&#39;s IBAN belongs to a country outside the EEA | [optional]
**debitor_address_line2** | **str** | string | [optional]
**debitor_country** | **str** | Mandatory if type is DEBIT and the debitor&#39;s IBAN belongs to a country outside the EEA | [optional]
**document_id** | **int** | |
**export_at** | **datetime** | If a date is set, this record is marked as exported | [optional]
**export_error** | **str** | | [optional] [readonly]
**id** | **int** | | [optional] [readonly]
**local_instrument** | **str** | CORE: SEPA Core Direct Debit&lt;br/&gt; COR1: SEPA-Basislastschrift COR1 (deprecated use CORE instead)&lt;br/&gt; B2B: SEPA Business to Business Direct Debit |
**mandate_date_of_signature** | **date** | |
**mandate_id** | **str** | |
**reference** | **str** | |
**remittance_information** | **str** | | [optional] [default to 'null']
**requested_at** | **date** | Booking date | [optional]
**sequence_type** | **str** | FRST: Erstlastschrift&lt;br/&gt; RCUR: Folgelastschrift&lt;br/&gt; OOFF: Einmallastschrift&lt;br/&gt; FNAL: Letztmalige Lastschrift |
**updated_at** | **str** | | [optional] [readonly]
**type** | **str** | | [optional] [default to 'DEBIT']
## Example
```python
from easybill_generated_async.models.sepa_payment import SEPAPayment
# TODO update the JSON string below
json = "{}"
# create an instance of SEPAPayment from a JSON string
sepa_payment_instance = SEPAPayment.from_json(json)
# print the JSON string representation of the object
print(SEPAPayment.to_json())
# convert the object into a dict
sepa_payment_dict = sepa_payment_instance.to_dict()
# create an instance of SEPAPayment from a dict
sepa_payment_from_dict = SEPAPayment.from_dict(sepa_payment_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,33 @@
# SEPAPayments
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[SEPAPayment]**](SEPAPayment.md) | | [optional]
## Example
```python
from easybill_generated_async.models.sepa_payments import SEPAPayments
# TODO update the JSON string below
json = "{}"
# create an instance of SEPAPayments from a JSON string
sepa_payments_instance = SEPAPayments.from_json(json)
# print the JSON string representation of the object
print(SEPAPayments.to_json())
# convert the object into a dict
sepa_payments_dict = sepa_payments_instance.to_dict()
# create an instance of SEPAPayments from a dict
sepa_payments_from_dict = SEPAPayments.from_dict(sepa_payments_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,444 @@
# easybill_generated_async.SepaPaymentApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**sepa_payments_get**](SepaPaymentApi.md#sepa_payments_get) | **GET** /sepa-payments | Fetch SEPA payments list
[**sepa_payments_id_delete**](SepaPaymentApi.md#sepa_payments_id_delete) | **DELETE** /sepa-payments/{id} | Delete SEPA payment
[**sepa_payments_id_get**](SepaPaymentApi.md#sepa_payments_id_get) | **GET** /sepa-payments/{id} | Fetch SEPA payment
[**sepa_payments_id_put**](SepaPaymentApi.md#sepa_payments_id_put) | **PUT** /sepa-payments/{id} | Update SEPA payment
[**sepa_payments_post**](SepaPaymentApi.md#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):
```python
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**](SEPAPayments.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)
# **sepa_payments_id_delete**
> sepa_payments_id_delete(id)
Delete SEPA payment
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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](../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)
# **sepa_payments_id_get**
> SEPAPayment sepa_payments_id_get(id)
Fetch SEPA payment
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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**](SEPAPayment.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)
# **sepa_payments_id_put**
> SEPAPayment sepa_payments_id_put(id, body)
Update SEPA payment
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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**](SEPAPayment.md)| |
### Return type
[**SEPAPayment**](SEPAPayment.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 SEPA payment | - |
**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)
# **sepa_payments_post**
> SEPAPayment sepa_payments_post(body)
Create SEPA payment
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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**](SEPAPayment.md)| |
### Return type
[**SEPAPayment**](SEPAPayment.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)

View file

@ -0,0 +1,35 @@
# SerialNumber
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional] [readonly]
**serial_number** | **str** | |
**position_id** | **int** | |
**document_id** | **int** | | [optional] [readonly]
**document_position_id** | **int** | | [optional] [readonly]
**used_at** | **str** | | [optional] [readonly]
**created_at** | **str** | | [optional] [readonly]
## Example
```python
from easybill_generated_async.models.serial_number import SerialNumber
# TODO update the JSON string below
json = "{}"
# create an instance of SerialNumber from a JSON string
serial_number_instance = SerialNumber.from_json(json)
# print the JSON string representation of the object
print(SerialNumber.to_json())
# convert the object into a dict
serial_number_dict = serial_number_instance.to_dict()
# create an instance of SerialNumber from a dict
serial_number_from_dict = SerialNumber.from_dict(serial_number_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,361 @@
# easybill_generated_async.SerialNumberApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**serial_numbers_get**](SerialNumberApi.md#serial_numbers_get) | **GET** /serial-numbers | Fetch a list of serial numbers for positions
[**serial_numbers_id_delete**](SerialNumberApi.md#serial_numbers_id_delete) | **DELETE** /serial-numbers/{id} | Delete a serial number for a position
[**serial_numbers_id_get**](SerialNumberApi.md#serial_numbers_id_get) | **GET** /serial-numbers/{id} | Fetch a serial number for a position
[**serial_numbers_post**](SerialNumberApi.md#serial_numbers_post) | **POST** /serial-numbers | Create s serial number for a position
# **serial_numbers_get**
> SerialNumbers serial_numbers_get(limit=limit, page=page, position_id=position_id, document_id=document_id, in_use=in_use)
Fetch a list of serial numbers for positions
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.serial_numbers import SerialNumbers
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.SerialNumberApi(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)
position_id = 'position_id_example' # str | Filter serial numbers by position id. (optional)
document_id = 'document_id_example' # str | Filter serial numbers by document id. (optional)
in_use = True # bool | Filter serial numbers by usage. (optional)
try:
# Fetch a list of serial numbers for positions
api_response = await api_instance.serial_numbers_get(limit=limit, page=page, position_id=position_id, document_id=document_id, in_use=in_use)
print("The response of SerialNumberApi->serial_numbers_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling SerialNumberApi->serial_numbers_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]
**position_id** | **str**| Filter serial numbers by position id. | [optional]
**document_id** | **str**| Filter serial numbers by document id. | [optional]
**in_use** | **bool**| Filter serial numbers by usage. | [optional]
### Return type
[**SerialNumbers**](SerialNumbers.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)
# **serial_numbers_id_delete**
> serial_numbers_id_delete(id)
Delete a serial number for a position
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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.SerialNumberApi(api_client)
id = 56 # int | ID of the serial number that needs to be deleted
try:
# Delete a serial number for a position
await api_instance.serial_numbers_id_delete(id)
except Exception as e:
print("Exception when calling SerialNumberApi->serial_numbers_id_delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of the serial number that needs to be deleted |
### 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 | - |
**400** | Serial number in use. Operation failed. | - |
**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)
# **serial_numbers_id_get**
> SerialNumber serial_numbers_id_get(id)
Fetch a serial number for a position
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.serial_number import SerialNumber
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.SerialNumberApi(api_client)
id = 56 # int | ID of the serial number that needs to be fetched
try:
# Fetch a serial number for a position
api_response = await api_instance.serial_numbers_id_get(id)
print("The response of SerialNumberApi->serial_numbers_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling SerialNumberApi->serial_numbers_id_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of the serial number that needs to be fetched |
### Return type
[**SerialNumber**](SerialNumber.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)
# **serial_numbers_post**
> SerialNumber serial_numbers_post(body=body)
Create s serial number for a position
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.serial_number import SerialNumber
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.SerialNumberApi(api_client)
body = easybill_generated_async.SerialNumber() # SerialNumber | (optional)
try:
# Create s serial number for a position
api_response = await api_instance.serial_numbers_post(body=body)
print("The response of SerialNumberApi->serial_numbers_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling SerialNumberApi->serial_numbers_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**SerialNumber**](SerialNumber.md)| | [optional]
### Return type
[**SerialNumber**](SerialNumber.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 PositionID | - |
**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)

View file

@ -0,0 +1,33 @@
# SerialNumbers
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[SerialNumber]**](SerialNumber.md) | | [optional]
## Example
```python
from easybill_generated_async.models.serial_numbers import SerialNumbers
# TODO update the JSON string below
json = "{}"
# create an instance of SerialNumbers from a JSON string
serial_numbers_instance = SerialNumbers.from_json(json)
# print the JSON string representation of the object
print(SerialNumbers.to_json())
# convert the object into a dict
serial_numbers_dict = serial_numbers_instance.to_dict()
# create an instance of SerialNumbers from a dict
serial_numbers_from_dict = SerialNumbers.from_dict(serial_numbers_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,34 @@
# ServiceDate
This object is only available in document type INVOICE or CREDIT.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | With DEFAULT no other fields are required and this message will be printed: &#39;Invoice date coincides with the time of supply&#39;.&lt;br/&gt; For SERVICE or DELIVERY exactly one of the following fields must be set: date, date_from and date_to or text. | [optional]
**var_date** | **date** | | [optional]
**date_from** | **date** | | [optional]
**date_to** | **date** | | [optional]
**text** | **str** | | [optional] [default to 'null']
## Example
```python
from easybill_generated_async.models.service_date import ServiceDate
# TODO update the JSON string below
json = "{}"
# create an instance of ServiceDate from a JSON string
service_date_instance = ServiceDate.from_json(json)
# print the JSON string representation of the object
print(ServiceDate.to_json())
# convert the object into a dict
service_date_dict = service_date_instance.to_dict()
# create an instance of ServiceDate from a dict
service_date_from_dict = ServiceDate.from_dict(service_date_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,37 @@
# Stock
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional] [readonly]
**note** | **str** | | [optional]
**stock_count** | **int** | |
**position_id** | **int** | |
**document_id** | **int** | | [optional] [readonly]
**document_position_id** | **int** | | [optional] [readonly]
**stored_at** | **str** | | [optional]
**created_at** | **str** | | [optional] [readonly]
**updated_at** | **str** | | [optional] [readonly]
## Example
```python
from easybill_generated_async.models.stock import Stock
# TODO update the JSON string below
json = "{}"
# create an instance of Stock from a JSON string
stock_instance = Stock.from_json(json)
# print the JSON string representation of the object
print(Stock.to_json())
# convert the object into a dict
stock_dict = stock_instance.to_dict()
# create an instance of Stock from a dict
stock_from_dict = Stock.from_dict(stock_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,274 @@
# easybill_generated_async.StockApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**stocks_get**](StockApi.md#stocks_get) | **GET** /stocks | Fetch a list of stock entries for positions
[**stocks_id_get**](StockApi.md#stocks_id_get) | **GET** /stocks/{id} | Fetch an stock entry for a position
[**stocks_post**](StockApi.md#stocks_post) | **POST** /stocks | Create a stock entry for a position
# **stocks_get**
> Stocks stocks_get(limit=limit, page=page, position_id=position_id, document_id=document_id)
Fetch a list of stock entries for positions
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.stocks import Stocks
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.StockApi(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)
position_id = 'position_id_example' # str | Filter stock entries by position id. (optional)
document_id = 'document_id_example' # str | Filter stock entries by document id. (optional)
try:
# Fetch a list of stock entries for positions
api_response = await api_instance.stocks_get(limit=limit, page=page, position_id=position_id, document_id=document_id)
print("The response of StockApi->stocks_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling StockApi->stocks_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]
**position_id** | **str**| Filter stock entries by position id. | [optional]
**document_id** | **str**| Filter stock entries by document id. | [optional]
### Return type
[**Stocks**](Stocks.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)
# **stocks_id_get**
> Stock stocks_id_get(id)
Fetch an stock entry for a position
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.stock import Stock
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.StockApi(api_client)
id = 56 # int | ID of the stock entry that needs to be fetched
try:
# Fetch an stock entry for a position
api_response = await api_instance.stocks_id_get(id)
print("The response of StockApi->stocks_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling StockApi->stocks_id_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of the stock entry that needs to be fetched |
### Return type
[**Stock**](Stock.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)
# **stocks_post**
> Stock stocks_post(body)
Create a stock entry for a position
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.stock import Stock
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.StockApi(api_client)
body = easybill_generated_async.Stock() # Stock |
try:
# Create a stock entry for a position
api_response = await api_instance.stocks_post(body)
print("The response of StockApi->stocks_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling StockApi->stocks_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Stock**](Stock.md)| |
### Return type
[**Stock**](Stock.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 | - |
**400** | Invalid position_id or stock_count | - |
**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)

View file

@ -0,0 +1,33 @@
# Stocks
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[Stock]**](Stock.md) | | [optional]
## Example
```python
from easybill_generated_async.models.stocks import Stocks
# TODO update the JSON string below
json = "{}"
# create an instance of Stocks from a JSON string
stocks_instance = Stocks.from_json(json)
# print the JSON string representation of the object
print(Stocks.to_json())
# convert the object into a dict
stocks_dict = stocks_instance.to_dict()
# create an instance of Stocks from a dict
stocks_from_dict = Stocks.from_dict(stocks_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,45 @@
# Task
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**category** | **str** | | [optional] [default to null]
**category_custom** | **str** | The name of your custom category. Can only have a value if \&quot;category\&quot; is \&quot;CUSTOM\&quot;. | [optional] [default to 'null']
**created_at** | **datetime** | | [optional] [readonly]
**customer_id** | **int** | | [optional]
**description** | **str** | | [optional] [default to 'null']
**document_id** | **int** | | [optional]
**end_at** | **datetime** | The deadline | [optional]
**finish_at** | **datetime** | The time when the task was marked as done | [optional] [readonly]
**id** | **int** | | [optional] [readonly]
**login_id** | **int** | When omitted or null, the currently active login is used | [optional]
**name** | **str** | |
**position_id** | **int** | | [optional]
**priority** | **str** | | [optional] [default to 'NORMAL']
**project_id** | **int** | | [optional]
**start_at** | **datetime** | | [optional]
**status** | **str** | |
**status_percent** | **int** | | [optional]
## Example
```python
from easybill_generated_async.models.task import Task
# TODO update the JSON string below
json = "{}"
# create an instance of Task from a JSON string
task_instance = Task.from_json(json)
# print the JSON string representation of the object
print(Task.to_json())
# convert the object into a dict
task_dict = task_instance.to_dict()
# create an instance of Task from a dict
task_from_dict = Task.from_dict(task_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,442 @@
# easybill_generated_async.TaskApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**tasks_get**](TaskApi.md#tasks_get) | **GET** /tasks | Fetch tasks list
[**tasks_id_delete**](TaskApi.md#tasks_id_delete) | **DELETE** /tasks/{id} | Delete task
[**tasks_id_get**](TaskApi.md#tasks_id_get) | **GET** /tasks/{id} | Fetch task
[**tasks_id_put**](TaskApi.md#tasks_id_put) | **PUT** /tasks/{id} | Update task
[**tasks_post**](TaskApi.md#tasks_post) | **POST** /tasks | Create task
# **tasks_get**
> Tasks tasks_get(limit=limit, page=page)
Fetch tasks list
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.tasks import Tasks
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.TaskApi(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 tasks list
api_response = await api_instance.tasks_get(limit=limit, page=page)
print("The response of TaskApi->tasks_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TaskApi->tasks_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
[**Tasks**](Tasks.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)
# **tasks_id_delete**
> tasks_id_delete(id)
Delete task
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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.TaskApi(api_client)
id = 56 # int | ID of task
try:
# Delete task
await api_instance.tasks_id_delete(id)
except Exception as e:
print("Exception when calling TaskApi->tasks_id_delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of task |
### 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)
# **tasks_id_get**
> Task tasks_id_get(id)
Fetch task
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.task import Task
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.TaskApi(api_client)
id = 56 # int | ID of task
try:
# Fetch task
api_response = await api_instance.tasks_id_get(id)
print("The response of TaskApi->tasks_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TaskApi->tasks_id_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of task |
### Return type
[**Task**](Task.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)
# **tasks_id_put**
> Task tasks_id_put(id, body)
Update task
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.task import Task
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.TaskApi(api_client)
id = 56 # int | ID of task
body = easybill_generated_async.Task() # Task |
try:
# Update task
api_response = await api_instance.tasks_id_put(id, body)
print("The response of TaskApi->tasks_id_put:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TaskApi->tasks_id_put: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of task |
**body** | [**Task**](Task.md)| |
### Return type
[**Task**](Task.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 task | - |
**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)
# **tasks_post**
> Task tasks_post(body)
Create task
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.task import Task
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.TaskApi(api_client)
body = easybill_generated_async.Task() # Task |
try:
# Create task
api_response = await api_instance.tasks_post(body)
print("The response of TaskApi->tasks_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TaskApi->tasks_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Task**](Task.md)| |
### Return type
[**Task**](Task.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)

View file

@ -0,0 +1,33 @@
# Tasks
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[Task]**](Task.md) | | [optional]
## Example
```python
from easybill_generated_async.models.tasks import Tasks
# TODO update the JSON string below
json = "{}"
# create an instance of Tasks from a JSON string
tasks_instance = Tasks.from_json(json)
# print the JSON string representation of the object
print(Tasks.to_json())
# convert the object into a dict
tasks_dict = tasks_instance.to_dict()
# create an instance of Tasks from a dict
tasks_from_dict = Tasks.from_dict(tasks_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,32 @@
# TextTemplate
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**can_modify** | **bool** | Deprecated, field is always true. | [optional] [readonly]
**id** | **int** | | [optional] [readonly]
**text** | **str** | |
**title** | **str** | |
## Example
```python
from easybill_generated_async.models.text_template import TextTemplate
# TODO update the JSON string below
json = "{}"
# create an instance of TextTemplate from a JSON string
text_template_instance = TextTemplate.from_json(json)
# print the JSON string representation of the object
print(TextTemplate.to_json())
# convert the object into a dict
text_template_dict = text_template_instance.to_dict()
# create an instance of TextTemplate from a dict
text_template_from_dict = TextTemplate.from_dict(text_template_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,442 @@
# easybill_generated_async.TextTemplateApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**text_templates_get**](TextTemplateApi.md#text_templates_get) | **GET** /text-templates | Fetch text templates list
[**text_templates_id_delete**](TextTemplateApi.md#text_templates_id_delete) | **DELETE** /text-templates/{id} | Delete text template
[**text_templates_id_get**](TextTemplateApi.md#text_templates_id_get) | **GET** /text-templates/{id} | Fetch text template
[**text_templates_id_put**](TextTemplateApi.md#text_templates_id_put) | **PUT** /text-templates/{id} | Update text template
[**text_templates_post**](TextTemplateApi.md#text_templates_post) | **POST** /text-templates | Create text template
# **text_templates_get**
> TextTemplates text_templates_get(limit=limit, page=page)
Fetch text templates list
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.text_templates import TextTemplates
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.TextTemplateApi(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 text templates list
api_response = await api_instance.text_templates_get(limit=limit, page=page)
print("The response of TextTemplateApi->text_templates_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TextTemplateApi->text_templates_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
[**TextTemplates**](TextTemplates.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)
# **text_templates_id_delete**
> text_templates_id_delete(id)
Delete text template
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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.TextTemplateApi(api_client)
id = 56 # int | ID of text template
try:
# Delete text template
await api_instance.text_templates_id_delete(id)
except Exception as e:
print("Exception when calling TextTemplateApi->text_templates_id_delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of text template |
### 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)
# **text_templates_id_get**
> TextTemplate text_templates_id_get(id)
Fetch text template
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.text_template import TextTemplate
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.TextTemplateApi(api_client)
id = 56 # int | ID of text template
try:
# Fetch text template
api_response = await api_instance.text_templates_id_get(id)
print("The response of TextTemplateApi->text_templates_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TextTemplateApi->text_templates_id_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of text template |
### Return type
[**TextTemplate**](TextTemplate.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)
# **text_templates_id_put**
> TextTemplate text_templates_id_put(id, body)
Update text template
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.text_template import TextTemplate
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.TextTemplateApi(api_client)
id = 56 # int | ID of text template
body = easybill_generated_async.TextTemplate() # TextTemplate |
try:
# Update text template
api_response = await api_instance.text_templates_id_put(id, body)
print("The response of TextTemplateApi->text_templates_id_put:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TextTemplateApi->text_templates_id_put: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of text template |
**body** | [**TextTemplate**](TextTemplate.md)| |
### Return type
[**TextTemplate**](TextTemplate.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 text template | - |
**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)
# **text_templates_post**
> TextTemplate text_templates_post(body)
Create text template
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.text_template import TextTemplate
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.TextTemplateApi(api_client)
body = easybill_generated_async.TextTemplate() # TextTemplate |
try:
# Create text template
api_response = await api_instance.text_templates_post(body)
print("The response of TextTemplateApi->text_templates_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TextTemplateApi->text_templates_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**TextTemplate**](TextTemplate.md)| |
### Return type
[**TextTemplate**](TextTemplate.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)

View file

@ -0,0 +1,33 @@
# TextTemplates
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[TextTemplate]**](TextTemplate.md) | | [optional]
## Example
```python
from easybill_generated_async.models.text_templates import TextTemplates
# TODO update the JSON string below
json = "{}"
# create an instance of TextTemplates from a JSON string
text_templates_instance = TextTemplates.from_json(json)
# print the JSON string representation of the object
print(TextTemplates.to_json())
# convert the object into a dict
text_templates_dict = text_templates_instance.to_dict()
# create an instance of TextTemplates from a dict
text_templates_from_dict = TextTemplates.from_dict(text_templates_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,41 @@
# TimeTracking
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cleared_at** | **datetime** | | [optional]
**created_at** | **datetime** | | [optional] [readonly]
**date_from_at** | **datetime** | | [optional]
**date_thru_at** | **datetime** | | [optional]
**description** | **str** | |
**hourly_rate** | **float** | Hourly rate in cents (e.g. \&quot;150\&quot; &#x3D; 1.50€) | [optional] [default to 0.0]
**id** | **int** | | [optional] [readonly]
**note** | **str** | | [optional] [default to 'null']
**number** | **str** | Can be chosen freely | [optional]
**position_id** | **int** | | [optional]
**project_id** | **int** | | [optional]
**login_id** | **int** | If omitted or null, the currently active login is used. | [optional]
**timer_value** | **int** | Tracked time in minutes | [optional]
## Example
```python
from easybill_generated_async.models.time_tracking import TimeTracking
# TODO update the JSON string below
json = "{}"
# create an instance of TimeTracking from a JSON string
time_tracking_instance = TimeTracking.from_json(json)
# print the JSON string representation of the object
print(TimeTracking.to_json())
# convert the object into a dict
time_tracking_dict = time_tracking_instance.to_dict()
# create an instance of TimeTracking from a dict
time_tracking_from_dict = TimeTracking.from_dict(time_tracking_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,450 @@
# easybill_generated_async.TimeTrackingApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**time_trackings_get**](TimeTrackingApi.md#time_trackings_get) | **GET** /time-trackings | Fetch time trackings list
[**time_trackings_id_delete**](TimeTrackingApi.md#time_trackings_id_delete) | **DELETE** /time-trackings/{id} | Delete time tracking
[**time_trackings_id_get**](TimeTrackingApi.md#time_trackings_id_get) | **GET** /time-trackings/{id} | Fetch time tracking
[**time_trackings_id_put**](TimeTrackingApi.md#time_trackings_id_put) | **PUT** /time-trackings/{id} | Update time tracking
[**time_trackings_post**](TimeTrackingApi.md#time_trackings_post) | **POST** /time-trackings | Create time tracking
# **time_trackings_get**
> TimeTrackings time_trackings_get(limit=limit, page=page, login_id=login_id, project_id=project_id, date_from_at=date_from_at, date_thru_at=date_thru_at)
Fetch time trackings list
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.time_trackings import TimeTrackings
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.TimeTrackingApi(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)
login_id = 'login_id_example' # str | Filter time-tracking by login_id. You can add multiple ids separate by comma like id,id,id. (optional)
project_id = 'project_id_example' # str | Filter time-tracking by project_id. You can add multiple ids separate by comma like id,id,id. (optional)
date_from_at = 'date_from_at_example' # str | Filter time-tracking by date_from_at. You can filter one date with date_from_at=2014-12-10 or between like 2015-01-01,2015-12-31. You can also specify a specific time with date_from_at=2014-12-10 12:30:00 or between like 2015-01-01 12:30:00,2015-01-01 13:00:00. (optional)
date_thru_at = 'date_thru_at_example' # str | Filter time-tracking by date_thru_at. You can filter one date with date_thru_at=2014-12-10 or between like 2015-01-01,2015-12-31. You can also specify a specific time with date_thru_at=2014-12-10 12:30:00 or between like 2015-01-01 12:30:00,2015-01-01 13:00:00. (optional)
try:
# Fetch time trackings list
api_response = await api_instance.time_trackings_get(limit=limit, page=page, login_id=login_id, project_id=project_id, date_from_at=date_from_at, date_thru_at=date_thru_at)
print("The response of TimeTrackingApi->time_trackings_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TimeTrackingApi->time_trackings_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]
**login_id** | **str**| Filter time-tracking by login_id. You can add multiple ids separate by comma like id,id,id. | [optional]
**project_id** | **str**| Filter time-tracking by project_id. You can add multiple ids separate by comma like id,id,id. | [optional]
**date_from_at** | **str**| Filter time-tracking by date_from_at. You can filter one date with date_from_at&#x3D;2014-12-10 or between like 2015-01-01,2015-12-31. You can also specify a specific time with date_from_at&#x3D;2014-12-10 12:30:00 or between like 2015-01-01 12:30:00,2015-01-01 13:00:00. | [optional]
**date_thru_at** | **str**| Filter time-tracking by date_thru_at. You can filter one date with date_thru_at&#x3D;2014-12-10 or between like 2015-01-01,2015-12-31. You can also specify a specific time with date_thru_at&#x3D;2014-12-10 12:30:00 or between like 2015-01-01 12:30:00,2015-01-01 13:00:00. | [optional]
### Return type
[**TimeTrackings**](TimeTrackings.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)
# **time_trackings_id_delete**
> time_trackings_id_delete(id)
Delete time tracking
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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.TimeTrackingApi(api_client)
id = 56 # int | ID of time tracking
try:
# Delete time tracking
await api_instance.time_trackings_id_delete(id)
except Exception as e:
print("Exception when calling TimeTrackingApi->time_trackings_id_delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of time tracking |
### 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)
# **time_trackings_id_get**
> TimeTracking time_trackings_id_get(id)
Fetch time tracking
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.time_tracking import TimeTracking
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.TimeTrackingApi(api_client)
id = 56 # int | ID of time tracking
try:
# Fetch time tracking
api_response = await api_instance.time_trackings_id_get(id)
print("The response of TimeTrackingApi->time_trackings_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TimeTrackingApi->time_trackings_id_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of time tracking |
### Return type
[**TimeTracking**](TimeTracking.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)
# **time_trackings_id_put**
> TimeTracking time_trackings_id_put(id, body)
Update time tracking
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.time_tracking import TimeTracking
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.TimeTrackingApi(api_client)
id = 56 # int | ID of time tracking
body = easybill_generated_async.TimeTracking() # TimeTracking |
try:
# Update time tracking
api_response = await api_instance.time_trackings_id_put(id, body)
print("The response of TimeTrackingApi->time_trackings_id_put:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TimeTrackingApi->time_trackings_id_put: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of time tracking |
**body** | [**TimeTracking**](TimeTracking.md)| |
### Return type
[**TimeTracking**](TimeTracking.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 time tracking | - |
**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)
# **time_trackings_post**
> TimeTracking time_trackings_post(body)
Create time tracking
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.time_tracking import TimeTracking
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.TimeTrackingApi(api_client)
body = easybill_generated_async.TimeTracking() # TimeTracking |
try:
# Create time tracking
api_response = await api_instance.time_trackings_post(body)
print("The response of TimeTrackingApi->time_trackings_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling TimeTrackingApi->time_trackings_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**TimeTracking**](TimeTracking.md)| |
### Return type
[**TimeTracking**](TimeTracking.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)

View file

@ -0,0 +1,33 @@
# TimeTrackings
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[TimeTracking]**](TimeTracking.md) | | [optional]
## Example
```python
from easybill_generated_async.models.time_trackings import TimeTrackings
# TODO update the JSON string below
json = "{}"
# create an instance of TimeTrackings from a JSON string
time_trackings_instance = TimeTrackings.from_json(json)
# print the JSON string representation of the object
print(TimeTrackings.to_json())
# convert the object into a dict
time_trackings_dict = time_trackings_instance.to_dict()
# create an instance of TimeTrackings from a dict
time_trackings_from_dict = TimeTrackings.from_dict(time_trackings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,36 @@
# WebHook
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**content_type** | **str** | |
**description** | **str** | |
**events** | **List[str]** | |
**id** | **int** | | [optional] [readonly]
**is_active** | **bool** | | [optional] [default to False]
**last_response** | [**WebHookLastResponse**](WebHookLastResponse.md) | | [optional]
**secret** | **str** | |
**url** | **str** | |
## Example
```python
from easybill_generated_async.models.web_hook import WebHook
# TODO update the JSON string below
json = "{}"
# create an instance of WebHook from a JSON string
web_hook_instance = WebHook.from_json(json)
# print the JSON string representation of the object
print(WebHook.to_json())
# convert the object into a dict
web_hook_dict = web_hook_instance.to_dict()
# create an instance of WebHook from a dict
web_hook_from_dict = WebHook.from_dict(web_hook_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,31 @@
# WebHookLastResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**var_date** | **datetime** | | [optional] [readonly]
**code** | **int** | | [optional] [readonly]
**response** | **str** | | [optional] [readonly]
## Example
```python
from easybill_generated_async.models.web_hook_last_response import WebHookLastResponse
# TODO update the JSON string below
json = "{}"
# create an instance of WebHookLastResponse from a JSON string
web_hook_last_response_instance = WebHookLastResponse.from_json(json)
# print the JSON string representation of the object
print(WebHookLastResponse.to_json())
# convert the object into a dict
web_hook_last_response_dict = web_hook_last_response_instance.to_dict()
# create an instance of WebHookLastResponse from a dict
web_hook_last_response_from_dict = WebHookLastResponse.from_dict(web_hook_last_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,33 @@
# WebHooks
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**page** | **int** | The current page |
**pages** | **int** | Max possible pages |
**limit** | **int** | Items limitation. Max 1000 |
**total** | **int** | Total Items |
**items** | [**List[WebHook]**](WebHook.md) | | [optional]
## Example
```python
from easybill_generated_async.models.web_hooks import WebHooks
# TODO update the JSON string below
json = "{}"
# create an instance of WebHooks from a JSON string
web_hooks_instance = WebHooks.from_json(json)
# print the JSON string representation of the object
print(WebHooks.to_json())
# convert the object into a dict
web_hooks_dict = web_hooks_instance.to_dict()
# create an instance of WebHooks from a dict
web_hooks_from_dict = WebHooks.from_dict(web_hooks_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,442 @@
# easybill_generated_async.WebhookApi
All URIs are relative to *https://api.easybill.de/rest/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**webhooks_get**](WebhookApi.md#webhooks_get) | **GET** /webhooks | Fetch WebHooks list
[**webhooks_id_delete**](WebhookApi.md#webhooks_id_delete) | **DELETE** /webhooks/{id} | Delete WebHook
[**webhooks_id_get**](WebhookApi.md#webhooks_id_get) | **GET** /webhooks/{id} | Fetch WebHook
[**webhooks_id_put**](WebhookApi.md#webhooks_id_put) | **PUT** /webhooks/{id} | Update WebHook
[**webhooks_post**](WebhookApi.md#webhooks_post) | **POST** /webhooks | Create WebHook
# **webhooks_get**
> WebHooks webhooks_get(limit=limit, page=page)
Fetch WebHooks list
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.web_hooks import WebHooks
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.WebhookApi(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 WebHooks list
api_response = await api_instance.webhooks_get(limit=limit, page=page)
print("The response of WebhookApi->webhooks_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling WebhookApi->webhooks_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
[**WebHooks**](WebHooks.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)
# **webhooks_id_delete**
> webhooks_id_delete(id)
Delete WebHook
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
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.WebhookApi(api_client)
id = 56 # int | ID of WebHook
try:
# Delete WebHook
await api_instance.webhooks_id_delete(id)
except Exception as e:
print("Exception when calling WebhookApi->webhooks_id_delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of WebHook |
### 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)
# **webhooks_id_get**
> WebHook webhooks_id_get(id)
Fetch WebHook
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.web_hook import WebHook
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.WebhookApi(api_client)
id = 56 # int | ID of WebHook
try:
# Fetch WebHook
api_response = await api_instance.webhooks_id_get(id)
print("The response of WebhookApi->webhooks_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling WebhookApi->webhooks_id_get: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of WebHook |
### Return type
[**WebHook**](WebHook.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)
# **webhooks_id_put**
> WebHook webhooks_id_put(id, body)
Update WebHook
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.web_hook import WebHook
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.WebhookApi(api_client)
id = 56 # int | ID of WebHook
body = easybill_generated_async.WebHook() # WebHook |
try:
# Update WebHook
api_response = await api_instance.webhooks_id_put(id, body)
print("The response of WebhookApi->webhooks_id_put:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling WebhookApi->webhooks_id_put: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| ID of WebHook |
**body** | [**WebHook**](WebHook.md)| |
### Return type
[**WebHook**](WebHook.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 | - |
**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)
# **webhooks_post**
> WebHook webhooks_post(body)
Create WebHook
### Example
* Basic Authentication (basicAuth):
* Api Key Authentication (Bearer):
```python
import easybill_generated_async
from easybill_generated_async.models.web_hook import WebHook
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.WebhookApi(api_client)
body = easybill_generated_async.WebHook() # WebHook |
try:
# Create WebHook
api_response = await api_instance.webhooks_post(body)
print("The response of WebhookApi->webhooks_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling WebhookApi->webhooks_post: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**WebHook**](WebHook.md)| |
### Return type
[**WebHook**](WebHook.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)

View file

@ -0,0 +1,208 @@
# coding: utf-8
# flake8: noqa
"""
easybill REST API
The first version of the easybill REST API. [CHANGELOG](https://api.easybill.de/rest/v1/CHANGELOG.md) ## Authentication You can choose between two available methods: `Basic Auth` or `Bearer Token`. In each HTTP request, one of the following HTTP headers is required: ``` # Basic Auth Authorization: Basic base64_encode('<email>:<api_key>') # Bearer Token Authorization: Bearer <api_key> ``` ## Limitations ### Request Limit * PLUS: 10 requests per minute * BUSINESS: 60 requests per minute If the limit is exceeded, you will receive the HTTP error: `429 Too Many Requests` ### Result Limit All result lists are limited to 100 by default. This limit can be increased by the query parameter `limit` to a maximum of 1000. ## Query filter Many list resources can be filtered. In `/documents` you can filter e.g. by number with `/documents?number=111028654`. If you want to filter multiple numbers, you can either enter them separated by commas `/documents?number=111028654,222006895` or as an array `/documents?number[]=111028654&number[]=222006895`. **Warning**: The maximum size of an HTTP request line in bytes is 4094. If this limit is exceeded, you will receive the HTTP error: `414 Request-URI Too Large` ### Escape commas in query You can escape commans in query `name=Patrick\\, Peter` if you submit the header `X-Easybill-Escape: true` in your request. ## Property login_id This is the login of your admin or employee account. ## Date and Date-Time format Please use the timezone `Europe/Berlin`. * **date** = *Y-m-d* = `2016-12-31` * **date-time** = *Y-m-d H:i:s* = `2016-12-31 03:13:37` Date or datetime can be `null` because the attributes have been added later and the entry is older.
The version of the OpenAPI document: 1.96.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
__version__ = "1.0.0"
# Define package exports
__all__ = [
"AttachmentApi",
"ContactApi",
"CustomerApi",
"CustomerGroupApi",
"DiscountApi",
"DocumentApi",
"DocumentPaymentApi",
"DocumentVersionApi",
"LoginsApi",
"PdfTemplatesApi",
"PositionApi",
"PositionGroupApi",
"PostBoxApi",
"ProjectApi",
"SepaPaymentApi",
"SerialNumberApi",
"StockApi",
"TaskApi",
"TextTemplateApi",
"TimeTrackingApi",
"WebhookApi",
"ApiResponse",
"ApiClient",
"Configuration",
"OpenApiException",
"ApiTypeError",
"ApiValueError",
"ApiKeyError",
"ApiAttributeError",
"ApiException",
"AdvancedDataField",
"Attachment",
"Attachments",
"Contact",
"Contacts",
"Customer",
"CustomerGroup",
"CustomerGroups",
"CustomerSnapshot",
"Customers",
"Discount",
"DiscountPosition",
"DiscountPositionGroup",
"DiscountPositionGroups",
"DiscountPositions",
"Document",
"DocumentAddress",
"DocumentPayment",
"DocumentPayments",
"DocumentPosition",
"DocumentRecurring",
"DocumentVersion",
"DocumentVersionItem",
"DocumentVersions",
"Documents",
"FileFormatConfig",
"List",
"Login",
"LoginSecurity",
"Logins",
"PDFTemplate",
"PDFTemplateSettings",
"PDFTemplateSettingsEmail",
"PDFTemplates",
"Position",
"PositionExportIdentifierExtended",
"PositionGroup",
"PositionGroups",
"Positions",
"PostBox",
"PostBoxRequest",
"PostBoxes",
"Project",
"Projects",
"SEPAPayment",
"SEPAPayments",
"SerialNumber",
"SerialNumbers",
"ServiceDate",
"Stock",
"Stocks",
"Task",
"Tasks",
"TextTemplate",
"TextTemplates",
"TimeTracking",
"TimeTrackings",
"WebHook",
"WebHookLastResponse",
"WebHooks",
]
# import apis into sdk package
from easybill_generated_async.api.attachment_api import AttachmentApi as AttachmentApi
from easybill_generated_async.api.contact_api import ContactApi as ContactApi
from easybill_generated_async.api.customer_api import CustomerApi as CustomerApi
from easybill_generated_async.api.customer_group_api import CustomerGroupApi as CustomerGroupApi
from easybill_generated_async.api.discount_api import DiscountApi as DiscountApi
from easybill_generated_async.api.document_api import DocumentApi as DocumentApi
from easybill_generated_async.api.document_payment_api import DocumentPaymentApi as DocumentPaymentApi
from easybill_generated_async.api.document_version_api import DocumentVersionApi as DocumentVersionApi
from easybill_generated_async.api.logins_api import LoginsApi as LoginsApi
from easybill_generated_async.api.pdf_templates_api import PdfTemplatesApi as PdfTemplatesApi
from easybill_generated_async.api.position_api import PositionApi as PositionApi
from easybill_generated_async.api.position_group_api import PositionGroupApi as PositionGroupApi
from easybill_generated_async.api.post_box_api import PostBoxApi as PostBoxApi
from easybill_generated_async.api.project_api import ProjectApi as ProjectApi
from easybill_generated_async.api.sepa_payment_api import SepaPaymentApi as SepaPaymentApi
from easybill_generated_async.api.serial_number_api import SerialNumberApi as SerialNumberApi
from easybill_generated_async.api.stock_api import StockApi as StockApi
from easybill_generated_async.api.task_api import TaskApi as TaskApi
from easybill_generated_async.api.text_template_api import TextTemplateApi as TextTemplateApi
from easybill_generated_async.api.time_tracking_api import TimeTrackingApi as TimeTrackingApi
from easybill_generated_async.api.webhook_api import WebhookApi as WebhookApi
# import ApiClient
from easybill_generated_async.api_response import ApiResponse as ApiResponse
from easybill_generated_async.api_client import ApiClient as ApiClient
from easybill_generated_async.configuration import Configuration as Configuration
from easybill_generated_async.exceptions import OpenApiException as OpenApiException
from easybill_generated_async.exceptions import ApiTypeError as ApiTypeError
from easybill_generated_async.exceptions import ApiValueError as ApiValueError
from easybill_generated_async.exceptions import ApiKeyError as ApiKeyError
from easybill_generated_async.exceptions import ApiAttributeError as ApiAttributeError
from easybill_generated_async.exceptions import ApiException as ApiException
# import models into sdk package
from easybill_generated_async.models.advanced_data_field import AdvancedDataField as AdvancedDataField
from easybill_generated_async.models.attachment import Attachment as Attachment
from easybill_generated_async.models.attachments import Attachments as Attachments
from easybill_generated_async.models.contact import Contact as Contact
from easybill_generated_async.models.contacts import Contacts as Contacts
from easybill_generated_async.models.customer import Customer as Customer
from easybill_generated_async.models.customer_group import CustomerGroup as CustomerGroup
from easybill_generated_async.models.customer_groups import CustomerGroups as CustomerGroups
from easybill_generated_async.models.customer_snapshot import CustomerSnapshot as CustomerSnapshot
from easybill_generated_async.models.customers import Customers as Customers
from easybill_generated_async.models.discount import Discount as Discount
from easybill_generated_async.models.discount_position import DiscountPosition as DiscountPosition
from easybill_generated_async.models.discount_position_group import DiscountPositionGroup as DiscountPositionGroup
from easybill_generated_async.models.discount_position_groups import DiscountPositionGroups as DiscountPositionGroups
from easybill_generated_async.models.discount_positions import DiscountPositions as DiscountPositions
from easybill_generated_async.models.document import Document as Document
from easybill_generated_async.models.document_address import DocumentAddress as DocumentAddress
from easybill_generated_async.models.document_payment import DocumentPayment as DocumentPayment
from easybill_generated_async.models.document_payments import DocumentPayments as DocumentPayments
from easybill_generated_async.models.document_position import DocumentPosition as DocumentPosition
from easybill_generated_async.models.document_recurring import DocumentRecurring as DocumentRecurring
from easybill_generated_async.models.document_version import DocumentVersion as DocumentVersion
from easybill_generated_async.models.document_version_item import DocumentVersionItem as DocumentVersionItem
from easybill_generated_async.models.document_versions import DocumentVersions as DocumentVersions
from easybill_generated_async.models.documents import Documents as Documents
from easybill_generated_async.models.file_format_config import FileFormatConfig as FileFormatConfig
from easybill_generated_async.models.list import List as List
from easybill_generated_async.models.login import Login as Login
from easybill_generated_async.models.login_security import LoginSecurity as LoginSecurity
from easybill_generated_async.models.logins import Logins as Logins
from easybill_generated_async.models.pdf_template import PDFTemplate as PDFTemplate
from easybill_generated_async.models.pdf_template_settings import PDFTemplateSettings as PDFTemplateSettings
from easybill_generated_async.models.pdf_template_settings_email import PDFTemplateSettingsEmail as PDFTemplateSettingsEmail
from easybill_generated_async.models.pdf_templates import PDFTemplates as PDFTemplates
from easybill_generated_async.models.position import Position as Position
from easybill_generated_async.models.position_export_identifier_extended import PositionExportIdentifierExtended as PositionExportIdentifierExtended
from easybill_generated_async.models.position_group import PositionGroup as PositionGroup
from easybill_generated_async.models.position_groups import PositionGroups as PositionGroups
from easybill_generated_async.models.positions import Positions as Positions
from easybill_generated_async.models.post_box import PostBox as PostBox
from easybill_generated_async.models.post_box_request import PostBoxRequest as PostBoxRequest
from easybill_generated_async.models.post_boxes import PostBoxes as PostBoxes
from easybill_generated_async.models.project import Project as Project
from easybill_generated_async.models.projects import Projects as Projects
from easybill_generated_async.models.sepa_payment import SEPAPayment as SEPAPayment
from easybill_generated_async.models.sepa_payments import SEPAPayments as SEPAPayments
from easybill_generated_async.models.serial_number import SerialNumber as SerialNumber
from easybill_generated_async.models.serial_numbers import SerialNumbers as SerialNumbers
from easybill_generated_async.models.service_date import ServiceDate as ServiceDate
from easybill_generated_async.models.stock import Stock as Stock
from easybill_generated_async.models.stocks import Stocks as Stocks
from easybill_generated_async.models.task import Task as Task
from easybill_generated_async.models.tasks import Tasks as Tasks
from easybill_generated_async.models.text_template import TextTemplate as TextTemplate
from easybill_generated_async.models.text_templates import TextTemplates as TextTemplates
from easybill_generated_async.models.time_tracking import TimeTracking as TimeTracking
from easybill_generated_async.models.time_trackings import TimeTrackings as TimeTrackings
from easybill_generated_async.models.web_hook import WebHook as WebHook
from easybill_generated_async.models.web_hook_last_response import WebHookLastResponse as WebHookLastResponse
from easybill_generated_async.models.web_hooks import WebHooks as WebHooks

View file

@ -0,0 +1,25 @@
# flake8: noqa
# import apis into api package
from easybill_generated_async.api.attachment_api import AttachmentApi
from easybill_generated_async.api.contact_api import ContactApi
from easybill_generated_async.api.customer_api import CustomerApi
from easybill_generated_async.api.customer_group_api import CustomerGroupApi
from easybill_generated_async.api.discount_api import DiscountApi
from easybill_generated_async.api.document_api import DocumentApi
from easybill_generated_async.api.document_payment_api import DocumentPaymentApi
from easybill_generated_async.api.document_version_api import DocumentVersionApi
from easybill_generated_async.api.logins_api import LoginsApi
from easybill_generated_async.api.pdf_templates_api import PdfTemplatesApi
from easybill_generated_async.api.position_api import PositionApi
from easybill_generated_async.api.position_group_api import PositionGroupApi
from easybill_generated_async.api.post_box_api import PostBoxApi
from easybill_generated_async.api.project_api import ProjectApi
from easybill_generated_async.api.sepa_payment_api import SepaPaymentApi
from easybill_generated_async.api.serial_number_api import SerialNumberApi
from easybill_generated_async.api.stock_api import StockApi
from easybill_generated_async.api.task_api import TaskApi
from easybill_generated_async.api.text_template_api import TextTemplateApi
from easybill_generated_async.api.time_tracking_api import TimeTrackingApi
from easybill_generated_async.api.webhook_api import WebhookApi

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

Some files were not shown because too many files have changed in this diff Show more