Skip to content

Latest commit

 

History

History
99 lines (69 loc) · 5.24 KB

DocumentBlockApi.md

File metadata and controls

99 lines (69 loc) · 5.24 KB

clientapi_billingo.DocumentBlockApi

All URIs are relative to https://api.billingo.hu/v3

Method HTTP request Description
list_document_block GET /document-blocks List all document blocks

list_document_block

DocumentBlockList list_document_block(page=page, per_page=per_page, type=type)

List all document blocks

Returns a list of your document blocks. The document blocks are returned sorted by creation date, with the most recent document blocks appearing first.

Example

  • Api Key Authentication (api_key):
import clientapi_billingo
from clientapi_billingo.models.document_block_list import DocumentBlockList
from clientapi_billingo.models.document_block_type import DocumentBlockType
from clientapi_billingo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.billingo.hu/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_billingo.Configuration(
    host = "https://api.billingo.hu/v3"
)

# 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 API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_billingo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_billingo.DocumentBlockApi(api_client)
    page = 56 # int |  (optional)
    per_page = 25 # int |  (optional) (default to 25)
    type = clientapi_billingo.DocumentBlockType() # DocumentBlockType | Filter document blocks by type (optional)

    try:
        # List all document blocks
        api_response = api_instance.list_document_block(page=page, per_page=per_page, type=type)
        print("The response of DocumentBlockApi->list_document_block:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DocumentBlockApi->list_document_block: %s\n" % e)

Parameters

Name Type Description Notes
page int [optional]
per_page int [optional] [default to 25]
type DocumentBlockType Filter document blocks by type [optional]

Return type

DocumentBlockList

Authorization

api_key

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success response * X-RateLimit-Limit - Request limit per minute.
* X-RateLimit-Remaining - The number of requests left for the time window.
* X-RateLimit-Reset - The timestamp at which the current rate limit window resets.
* Retry-After - How many seconds you have to wait before making new request.
400 The request is malformed. * X-RateLimit-Limit - Request limit per minute.
* X-RateLimit-Remaining - The number of requests left for the time window.
* X-RateLimit-Reset - The timestamp at which the current rate limit window resets.
* Retry-After - How many seconds you have to wait before making new request.
401 Authorization information is missing or invalid. * X-RateLimit-Limit - Request limit per minute.
* X-RateLimit-Remaining - The number of requests left for the time window.
* X-RateLimit-Reset - The timestamp at which the current rate limit window resets.
* Retry-After - How many seconds you have to wait before making new request.
402 Authenticated user doesn't have subscription. -
422 Validation errors occured. * X-RateLimit-Limit - Request limit per minute.
* X-RateLimit-Remaining - The number of requests left for the time window.
* X-RateLimit-Reset - The timestamp at which the current rate limit window resets.
* Retry-After - How many seconds you have to wait before making new request.
429 Too many requests * X-RateLimit-Limit - Request limit per minute.
* X-RateLimit-Remaining - The number of requests left for the time window.
* X-RateLimit-Reset - The timestamp at which the current rate limit window resets.
* Retry-After - How many seconds you have to wait before making new request.
500 Internal server error. * X-RateLimit-Limit - Request limit per minute.
* X-RateLimit-Remaining - The number of requests left for the time window.
* X-RateLimit-Reset - The timestamp at which the current rate limit window resets.
* Retry-After - How many seconds you have to wait before making new request.

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