Skip to content

client-api/billingo-python

BranchesTags

Repository files navigation

clientapi-billingo

This is a Billingo API v3 documentation. Our API based on REST software architectural style. API has resource-oriented URLs, accepts JSON-encoded request bodies and returns JSON-encoded responses. To use this API you have to generate a new API key on our site. After that, you can test your API key on this page.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 3.0.14
  • Package version: 1.0.1
  • Generator version: 7.9.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.billingo.hu/kapcsolat

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

# from pypi
pip install clientapi_billingo

# from source
pip install git+https://github.com/client-api/billingo-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/client-api/billingo-python.git)

Then import the package:

import clientapi_billingo

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import clientapi_billingo

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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.BankAccountApi(api_client)
    bank_account = clientapi_billingo.BankAccount() # BankAccount | BankAccount object that you would like to store.

    try:
        # Create a bank account
        api_response = api_instance.create_bank_account(bank_account)
        print("The response of BankAccountApi->create_bank_account:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BankAccountApi->create_bank_account: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
BankAccountApi create_bank_account POST /bank-accounts Create a bank account
BankAccountApi delete_bank_account DELETE /bank-accounts/{id} Delete a bank account
BankAccountApi get_bank_account GET /bank-accounts/{id} Retrieve a bank account
BankAccountApi list_bank_account GET /bank-accounts List all bank account
BankAccountApi update_bank_account PUT /bank-accounts/{id} Update a bank account
CurrencyApi get_conversion_rate GET /currencies Get currencies exchange rate.
DocumentApi archive_document PUT /documents/{id}/archive Archive a proforma document.
DocumentApi cancel_document POST /documents/{id}/cancel Cancel a document
DocumentApi create_document POST /documents Create a document
DocumentApi create_document_from_draft PUT /documents/{id} Converts a draft to an invoice.
DocumentApi create_document_from_proforma POST /documents/{id}/create-from-proforma Create a document from proforma.
DocumentApi create_modification_document POST /documents/{id}/create-modification-document Create a modification document.
DocumentApi create_receipt POST /documents/receipt Create a receipt
DocumentApi create_receipt_from_draft PUT /documents/receipt/{id} Converts a draft to a receipt.
DocumentApi delete_document DELETE /documents/{id} Delete a draft.
DocumentApi delete_payment DELETE /documents/{id}/payments Delete all payment history on document
DocumentApi document_copy POST /documents/{id}/copy Copy a document
DocumentApi download_document GET /documents/{id}/download Download a document in PDF format.
DocumentApi get_document GET /documents/{id} Retrieve a document
DocumentApi get_document_by_vendor_id GET /documents/vendor/{vendor_id} Retrieve a document by vendor id
DocumentApi get_online_szamla_status GET /documents/{id}/online-szamla Retrieve a document Online Számla status
DocumentApi get_payment GET /documents/{id}/payments Retrieve a payment histroy
DocumentApi get_public_url GET /documents/{id}/public-url Retrieve a document download public url.
DocumentApi list_document GET /documents List all documents
DocumentApi pos_print GET /documents/{id}/print/pos Returns a printable POS PDF
DocumentApi send_document POST /documents/{id}/send Send invoice to given email adresses.
DocumentApi update_payment PUT /documents/{id}/payments Update payment history
DocumentBlockApi list_document_block GET /document-blocks List all document blocks
DocumentExportApi create POST /document-export Create document export.
DocumentExportApi download GET /document-export/{id}/download Return exported binary file.
DocumentExportApi poll GET /document-export/{id}/poll Retrieve export state.
OrganizationApi get_organization_data GET /organization Retrieve a organization data.
PartnerApi create_partner POST /partners Create a partner
PartnerApi delete_partner DELETE /partners/{id} Delete a partner
PartnerApi get_partner GET /partners/{id} Retrieve a partner
PartnerApi list_partner GET /partners List all partners
PartnerApi update_partner PUT /partners/{id} Update a partner
ProductApi create_product POST /products Create a product
ProductApi delete_product DELETE /products/{id} Delete a product
ProductApi get_product GET /products/{id} Retrieve a product
ProductApi list_product GET /products List all product
ProductApi update_product PUT /products/{id} Update a product
SpendingApi spending_delete DELETE /spendings/{id} Deletes a spending.
SpendingApi spending_list GET /spendings Lists all spending
SpendingApi spending_save POST /spendings Creates a new spending.
SpendingApi spending_show GET /spendings/{id} Retrieves one specific spending.
SpendingApi spending_update PUT /spendings/{id} Updates a spending item.
UtilApi check_tax_number GET /utils/check-tax-number/{tax_number} Check tax number.
UtilApi get_id GET /utils/convert-legacy-id/{id} Convert legacy ID to v3 ID.
UtilApi get_server_time GET /utils/time Get the server time

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

api_key

  • Type: API key
  • API key parameter name: X-API-KEY
  • Location: HTTP header

Author

[email protected]

About

pypi.org/project/clientapi-billingo/

Resources

Readme

License

Apache-2.0 license
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases 3

v2.1.0 Latest
Mar 22, 2025
+ 2 releases

Packages

No packages published

Languages