easybill_client/generated/async/docs/StockApi.md

easybill_generated_async.StockApi

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

Method	HTTP request	Description
stocks_get	GET /stocks	Fetch a list of stock entries for positions
stocks_id_get	GET /stocks/{id}	Fetch an stock entry for a position
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):

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

Authorization

basicAuth, Bearer

HTTP request headers

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

HTTP response details

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

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

stocks_id_get

Stock stocks_id_get(id)

Fetch an stock entry for a position

Example

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

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

Authorization

basicAuth, Bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
404	Not found	-
429	Too Many Requests	-

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

stocks_post

Stock stocks_post(body)

Create a stock entry for a position

Example

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

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

Return type

Stock

Authorization

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