All URIs are relative to https://api.billingo.hu/v3
| Method | HTTP request | Description |
|---|---|---|
| archive_document | PUT /documents/{id}/archive | Archive a proforma document. |
| cancel_document | POST /documents/{id}/cancel | Cancel a document |
| create_document | POST /documents | Create a document |
| create_document_from_draft | PUT /documents/{id} | Converts a draft to an invoice. |
| create_document_from_proforma | POST /documents/{id}/create-from-proforma | Create a document from proforma. |
| create_modification_document | POST /documents/{id}/create-modification-document | Create a modification document. |
| create_receipt | POST /documents/receipt | Create a receipt |
| create_receipt_from_draft | PUT /documents/receipt/{id} | Converts a draft to a receipt. |
| delete_document | DELETE /documents/{id} | Delete a draft. |
| delete_payment | DELETE /documents/{id}/payments | Delete all payment history on document |
| document_copy | POST /documents/{id}/copy | Copy a document |
| download_document | GET /documents/{id}/download | Download a document in PDF format. |
| get_document | GET /documents/{id} | Retrieve a document |
| get_document_by_vendor_id | GET /documents/vendor/{vendor_id} | Retrieve a document by vendor id |
| get_online_szamla_status | GET /documents/{id}/online-szamla | Retrieve a document Online Számla status |
| get_payment | GET /documents/{id}/payments | Retrieve a payment histroy |
| get_public_url | GET /documents/{id}/public-url | Retrieve a document download public url. |
| list_document | GET /documents | List all documents |
| pos_print | GET /documents/{id}/print/pos | Returns a printable POS PDF |
| send_document | POST /documents/{id}/send | Send invoice to given email adresses. |
| update_payment | PUT /documents/{id}/payments | Update payment history |
archive_document(id)
Archive a proforma document.
Archive an existing proforma document.
- Api Key Authentication (api_key):
import clientapi_billingo
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.DocumentApi(api_client)
id = 56 # int |
try:
# Archive a proforma document.
api_instance.archive_document(id)
except Exception as e:
print("Exception when calling DocumentApi->archive_document: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | Document archived successfully. | * 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. | - |
| 403 | Authenticated user doesn't have access to the resource. | * 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. |
| 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. |
| 404 | Non-existent resource is requested. | * 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]
Document cancel_document(id, document_cancellation=document_cancellation)
Cancel a document
Cancel a document. Returns a cancellation document object if the cancellation is succeded.
- Api Key Authentication (api_key):
import clientapi_billingo
from clientapi_billingo.models.document import Document
from clientapi_billingo.models.document_cancellation import DocumentCancellation
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.DocumentApi(api_client)
id = 56 # int |
document_cancellation = clientapi_billingo.DocumentCancellation() # DocumentCancellation | Comment and notifiable email addresses - comma separated for multiple email addresses (optional)
try:
# Cancel a document
api_response = api_instance.cancel_document(id, document_cancellation=document_cancellation)
print("The response of DocumentApi->cancel_document:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->cancel_document: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | ||
| document_cancellation | DocumentCancellation | Comment and notifiable email addresses - comma separated for multiple email addresses | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Document cancellation successfully. Cancel document returned. | * 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. | - |
| 403 | Authenticated user doesn't have access to the resource. | * 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. |
| 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. |
| 404 | Non-existent resource is requested. | * 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]
Document create_document(document_insert)
Create a document
Create a new document. Returns a document object if the create is succeded.
- Api Key Authentication (api_key):
import clientapi_billingo
from clientapi_billingo.models.document import Document
from clientapi_billingo.models.document_insert import DocumentInsert
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.DocumentApi(api_client)
document_insert = clientapi_billingo.DocumentInsert() # DocumentInsert | DocumentInsert object that you would like to store.
try:
# Create a document
api_response = api_instance.create_document(document_insert)
print("The response of DocumentApi->create_document:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->create_document: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| document_insert | DocumentInsert | DocumentInsert object that you would like to store. |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Document created successfully. | * 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. | - |
| 403 | Authenticated user doesn't have access to the resource. | * 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. |
| 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]
Document create_document_from_draft(id, document_insert)
Converts a draft to an invoice.
Converts a draft to an invoice. Returns the invoice object if the convert is succeded.
- Api Key Authentication (api_key):
import clientapi_billingo
from clientapi_billingo.models.document import Document
from clientapi_billingo.models.document_insert import DocumentInsert
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.DocumentApi(api_client)
id = 56 # int |
document_insert = clientapi_billingo.DocumentInsert() # DocumentInsert | DocumentInsert object that you would like to store.
try:
# Converts a draft to an invoice.
api_response = api_instance.create_document_from_draft(id, document_insert)
print("The response of DocumentApi->create_document_from_draft:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->create_document_from_draft: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | ||
| document_insert | DocumentInsert | DocumentInsert object that you would like to store. |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Draft converted successfully. | * 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. | - |
| 403 | Authenticated user doesn't have access to the resource. | * 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. |
| 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. |
| 404 | Non-existent resource is requested. | * 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]
Document create_document_from_proforma(id, invoice_settings=invoice_settings)
Create a document from proforma.
Create a new document from proforma. Returns a document object if the create is succeded.
- Api Key Authentication (api_key):
import clientapi_billingo
from clientapi_billingo.models.document import Document
from clientapi_billingo.models.invoice_settings import InvoiceSettings
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.DocumentApi(api_client)
id = 56 # int |
invoice_settings = clientapi_billingo.InvoiceSettings() # InvoiceSettings | InvoiceSettings object. (optional)
try:
# Create a document from proforma.
api_response = api_instance.create_document_from_proforma(id, invoice_settings=invoice_settings)
print("The response of DocumentApi->create_document_from_proforma:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->create_document_from_proforma: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | ||
| invoice_settings | InvoiceSettings | InvoiceSettings object. | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Document created successfully. | * 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. | - |
| 403 | Authenticated user doesn't have access to the resource. | * 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. |
| 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. |
| 404 | Non-existent resource is requested. | * 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]
Document create_modification_document(id, modification_document_insert)
Create a modification document.
Create a modification document for the given document. Returns a new document object if the create is successful.
- Api Key Authentication (api_key):
import clientapi_billingo
from clientapi_billingo.models.document import Document
from clientapi_billingo.models.modification_document_insert import ModificationDocumentInsert
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.DocumentApi(api_client)
id = 56 # int |
modification_document_insert = clientapi_billingo.ModificationDocumentInsert() # ModificationDocumentInsert | ModificationDocumentInsert object that you would like to store.
try:
# Create a modification document.
api_response = api_instance.create_modification_document(id, modification_document_insert)
print("The response of DocumentApi->create_modification_document:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->create_modification_document: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | ||
| modification_document_insert | ModificationDocumentInsert | ModificationDocumentInsert object that you would like to store. |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Modification document created successfully. | * 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. | - |
| 403 | Authenticated user doesn't have access to the resource. | * 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. |
| 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. |
| 404 | Non-existent resource is requested. | * 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]
Document create_receipt(receipt_insert)
Create a receipt
Create a new receipt. Returns a document object if the create is succeded.
- Api Key Authentication (api_key):
import clientapi_billingo
from clientapi_billingo.models.document import Document
from clientapi_billingo.models.receipt_insert import ReceiptInsert
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.DocumentApi(api_client)
receipt_insert = clientapi_billingo.ReceiptInsert() # ReceiptInsert | ReceiptInsert object that you would like to store.
try:
# Create a receipt
api_response = api_instance.create_receipt(receipt_insert)
print("The response of DocumentApi->create_receipt:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->create_receipt: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| receipt_insert | ReceiptInsert | ReceiptInsert object that you would like to store. |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Receipt created successfully. | * 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. | - |
| 403 | Authenticated user doesn't have access to the resource. | * 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. |
| 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]
Document create_receipt_from_draft(id, receipt_insert)
Converts a draft to a receipt.
Converts a draft to a receipt. Returns the receipt object if the convert is succeded.
- Api Key Authentication (api_key):
import clientapi_billingo
from clientapi_billingo.models.document import Document
from clientapi_billingo.models.receipt_insert import ReceiptInsert
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.DocumentApi(api_client)
id = 56 # int |
receipt_insert = clientapi_billingo.ReceiptInsert() # ReceiptInsert | ReceiptInsert object that you would like to store.
try:
# Converts a draft to a receipt.
api_response = api_instance.create_receipt_from_draft(id, receipt_insert)
print("The response of DocumentApi->create_receipt_from_draft:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->create_receipt_from_draft: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | ||
| receipt_insert | ReceiptInsert | ReceiptInsert object that you would like to store. |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Draft converted successfully. | * 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. | - |
| 403 | Authenticated user doesn't have access to the resource. | * 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. |
| 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. |
| 404 | Non-existent resource is requested. | * 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]
delete_document(id)
Delete a draft.
Delete an existing draft.
- Api Key Authentication (api_key):
import clientapi_billingo
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.DocumentApi(api_client)
id = 56 # int |
try:
# Delete a draft.
api_instance.delete_document(id)
except Exception as e:
print("Exception when calling DocumentApi->delete_document: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | Draft deleted successfully. | * 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. | - |
| 403 | Authenticated user doesn't have access to the resource. | * 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. |
| 404 | Non-existent resource is requested. | * 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]
List[PaymentHistory] delete_payment(id)
Delete all payment history on document
Delete all exist payment history on document.
- Api Key Authentication (api_key):
import clientapi_billingo
from clientapi_billingo.models.payment_history import PaymentHistory
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.DocumentApi(api_client)
id = 56 # int |
try:
# Delete all payment history on document
api_response = api_instance.delete_payment(id)
print("The response of DocumentApi->delete_payment:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->delete_payment: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Payment history deleted successfully. | * 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. | - |
| 403 | Authenticated user doesn't have access to the resource. | * 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. |
| 404 | Non-existent resource is requested. | * 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]
Document document_copy(id)
Copy a document
Copy a document. Returns the new document if the copy was succeded.
- Api Key Authentication (api_key):
import clientapi_billingo
from clientapi_billingo.models.document import Document
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.DocumentApi(api_client)
id = 56 # int |
try:
# Copy a document
api_response = api_instance.document_copy(id)
print("The response of DocumentApi->document_copy:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->document_copy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Document copied successfully. The created document returned. | * 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. | - |
| 403 | Authenticated user doesn't have access to the resource. | * 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. |
| 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. |
| 404 | Non-existent resource is requested. | * 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]
bytearray download_document(id)
Download a document in PDF format.
Download a document. Returns a document in PDF format.
- Api Key Authentication (api_key):
import clientapi_billingo
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.DocumentApi(api_client)
id = 56 # int |
try:
# Download a document in PDF format.
api_response = api_instance.download_document(id)
print("The response of DocumentApi->download_document:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->download_document: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int |
bytearray
- Content-Type: Not defined
- Accept: application/pdf, application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Document PDF file. | * 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. |
| 202 | Document PDF has not generated yet. You should try to download again later. | * 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. |
| 404 | Non-existent resource is requested. | * 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]
Document get_document(id)
Retrieve a document
Retrieves the details of an existing document.
- Api Key Authentication (api_key):
import clientapi_billingo
from clientapi_billingo.models.document import Document
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.DocumentApi(api_client)
id = 56 # int |
try:
# Retrieve a document
api_response = api_instance.get_document(id)
print("The response of DocumentApi->get_document:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->get_document: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int |
- Content-Type: Not defined
- Accept: application/json
| 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. |
| 404 | Non-existent resource is requested. | * 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]
Document get_document_by_vendor_id(vendor_id)
Retrieve a document by vendor id
Retrieves the details of an existing document by vendor id.
- Api Key Authentication (api_key):
import clientapi_billingo
from clientapi_billingo.models.document import Document
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.DocumentApi(api_client)
vendor_id = 'vendor_id_example' # str |
try:
# Retrieve a document by vendor id
api_response = api_instance.get_document_by_vendor_id(vendor_id)
print("The response of DocumentApi->get_document_by_vendor_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->get_document_by_vendor_id: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | str |
- Content-Type: Not defined
- Accept: application/json
| 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]
OnlineSzamlaStatus get_online_szamla_status(id)
Retrieve a document Online Számla status
Retrieves the details of an existing document status.
- Api Key Authentication (api_key):
import clientapi_billingo
from clientapi_billingo.models.online_szamla_status import OnlineSzamlaStatus
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.DocumentApi(api_client)
id = 56 # int |
try:
# Retrieve a document Online Számla status
api_response = api_instance.get_online_szamla_status(id)
print("The response of DocumentApi->get_online_szamla_status:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->get_online_szamla_status: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int |
- Content-Type: Not defined
- Accept: application/json
| 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. |
| 404 | Non-existent resource is requested. | * 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]
List[PaymentHistory] get_payment(id)
Retrieve a payment histroy
Retrieves the details of payment history an existing document.
- Api Key Authentication (api_key):
import clientapi_billingo
from clientapi_billingo.models.payment_history import PaymentHistory
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.DocumentApi(api_client)
id = 56 # int |
try:
# Retrieve a payment histroy
api_response = api_instance.get_payment(id)
print("The response of DocumentApi->get_payment:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->get_payment: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int |
- Content-Type: Not defined
- Accept: application/json
| 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. |
| 404 | Non-existent resource is requested. | * 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]
DocumentPublicUrl get_public_url(id)
Retrieve a document download public url.
Retrieves public url to download an existing document.
- Api Key Authentication (api_key):
import clientapi_billingo
from clientapi_billingo.models.document_public_url import DocumentPublicUrl
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.DocumentApi(api_client)
id = 56 # int |
try:
# Retrieve a document download public url.
api_response = api_instance.get_public_url(id)
print("The response of DocumentApi->get_public_url:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->get_public_url: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int |
- Content-Type: Not defined
- Accept: application/json
| 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. |
| 404 | Non-existent resource is requested. | * 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]
DocumentList list_document(page=page, per_page=per_page, block_id=block_id, partner_id=partner_id, payment_method=payment_method, payment_status=payment_status, start_date=start_date, end_date=end_date, start_number=start_number, end_number=end_number, start_year=start_year, end_year=end_year, type=type, query=query, paid_start_date=paid_start_date, paid_end_date=paid_end_date, fulfillment_start_date=fulfillment_start_date, fulfillment_end_date=fulfillment_end_date, last_modified_date=last_modified_date)
List all documents
Returns a list of your documents. The documents are returned sorted by creation date, with the most recent documents appearing first.
- Api Key Authentication (api_key):
import clientapi_billingo
from clientapi_billingo.models.document_list import DocumentList
from clientapi_billingo.models.document_type import DocumentType
from clientapi_billingo.models.payment_method import PaymentMethod
from clientapi_billingo.models.payment_status import PaymentStatus
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.DocumentApi(api_client)
page = 56 # int | (optional)
per_page = 25 # int | (optional) (default to 25)
block_id = 56 # int | Filter documents by the identifier of your DocumentBlock. (optional)
partner_id = 56 # int | Filter documents by the identifier of your Partner. (optional)
payment_method = clientapi_billingo.PaymentMethod() # PaymentMethod | Filter documents by PaymentMethod value. (optional)
payment_status = clientapi_billingo.PaymentStatus() # PaymentStatus | Filter documents by PaymentStatus value. (optional)
start_date = '2020-05-15' # date | Filter documents by their invoice date. (optional)
end_date = '2020-05-15' # date | Filter documents by their invoice date. (optional)
start_number = 1 # int | Starting number of the document, should not contain year or any other formatting. Required if `start_year` given (optional)
end_number = 10 # int | Ending number of the document, should not contain year or any other formatting. Required if `end_year` given (optional)
start_year = 2020 # int | Year for `start_number` parameter. Required if `start_number` given. (optional)
end_year = 2020 # int | Year for `end_number` parameter. Required if `end_number` given. (optional)
type = clientapi_billingo.DocumentType() # DocumentType | Filter documents by type (optional)
query = 'query_example' # str | Filter documents by the given text (optional)
paid_start_date = '2020-05-15' # date | Filter documents by their payment date. (optional)
paid_end_date = '2020-05-15' # date | Filter documents by their payment date. (optional)
fulfillment_start_date = '2020-05-15' # date | Filter documents by their fulfillment date. (optional)
fulfillment_end_date = '2020-05-15' # date | Filter documents by their fulfillment date. (optional)
last_modified_date = '2021-09-03 11:27:00' # str | Filter documents by their last modified date. (optional)
try:
# List all documents
api_response = api_instance.list_document(page=page, per_page=per_page, block_id=block_id, partner_id=partner_id, payment_method=payment_method, payment_status=payment_status, start_date=start_date, end_date=end_date, start_number=start_number, end_number=end_number, start_year=start_year, end_year=end_year, type=type, query=query, paid_start_date=paid_start_date, paid_end_date=paid_end_date, fulfillment_start_date=fulfillment_start_date, fulfillment_end_date=fulfillment_end_date, last_modified_date=last_modified_date)
print("The response of DocumentApi->list_document:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->list_document: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| page | int | [optional] | |
| per_page | int | [optional] [default to 25] | |
| block_id | int | Filter documents by the identifier of your DocumentBlock. | [optional] |
| partner_id | int | Filter documents by the identifier of your Partner. | [optional] |
| payment_method | PaymentMethod | Filter documents by PaymentMethod value. | [optional] |
| payment_status | PaymentStatus | Filter documents by PaymentStatus value. | [optional] |
| start_date | date | Filter documents by their invoice date. | [optional] |
| end_date | date | Filter documents by their invoice date. | [optional] |
| start_number | int | Starting number of the document, should not contain year or any other formatting. Required if `start_year` given | [optional] |
| end_number | int | Ending number of the document, should not contain year or any other formatting. Required if `end_year` given | [optional] |
| start_year | int | Year for `start_number` parameter. Required if `start_number` given. | [optional] |
| end_year | int | Year for `end_number` parameter. Required if `end_number` given. | [optional] |
| type | DocumentType | Filter documents by type | [optional] |
| query | str | Filter documents by the given text | [optional] |
| paid_start_date | date | Filter documents by their payment date. | [optional] |
| paid_end_date | date | Filter documents by their payment date. | [optional] |
| fulfillment_start_date | date | Filter documents by their fulfillment date. | [optional] |
| fulfillment_end_date | date | Filter documents by their fulfillment date. | [optional] |
| last_modified_date | str | Filter documents by their last modified date. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]
bytearray pos_print(id, size)
Returns a printable POS PDF
Returns a printable POS PDF file of a particular document.
- Api Key Authentication (api_key):
import clientapi_billingo
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.DocumentApi(api_client)
id = 56 # int |
size = 3.4 # float | In which size the POS PDF should be rendered.
try:
# Returns a printable POS PDF
api_response = api_instance.pos_print(id, size)
print("The response of DocumentApi->pos_print:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->pos_print: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | ||
| size | float | In which size the POS PDF should be rendered. |
bytearray
- Content-Type: Not defined
- Accept: application/pdf, application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A printable PDF document | * 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. |
| 404 | Non-existent resource is requested. | * 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]
SendDocument send_document(id, send_document=send_document)
Send invoice to given email adresses.
Returns a list of emails, where the invoice is sent.
- Api Key Authentication (api_key):
import clientapi_billingo
from clientapi_billingo.models.send_document import SendDocument
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.DocumentApi(api_client)
id = 56 # int |
send_document = clientapi_billingo.SendDocument() # SendDocument | List of email-s where you want to send the invoice. (optional)
try:
# Send invoice to given email adresses.
api_response = api_instance.send_document(id, send_document=send_document)
print("The response of DocumentApi->send_document:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->send_document: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | ||
| send_document | SendDocument | List of email-s where you want to send the invoice. | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | List of email adresses where the invoice sent. | * 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. | - |
| 403 | Authenticated user doesn't have access to the resource. | * 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. |
| 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. |
| 404 | Non-existent resource is requested. | * 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]
List[PaymentHistory] update_payment(id, payment_history)
Update payment history
Update payment history an existing document. Returns a payment history object if the update is succeded.
- Api Key Authentication (api_key):
import clientapi_billingo
from clientapi_billingo.models.payment_history import PaymentHistory
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.DocumentApi(api_client)
id = 56 # int |
payment_history = [clientapi_billingo.PaymentHistory()] # List[PaymentHistory] | Payment history object that you would like to update.
try:
# Update payment history
api_response = api_instance.update_payment(id, payment_history)
print("The response of DocumentApi->update_payment:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DocumentApi->update_payment: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | ||
| payment_history | List[PaymentHistory] | Payment history object that you would like to update. |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Payment history updated successfully. | * 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. | - |
| 403 | Authenticated user doesn't have access to the resource. | * 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. |
| 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. |
| 404 | Non-existent resource is requested. | * 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]