github-mirrors/superfaktura-client
1
0
Fork 0
mirror of https://github.com/Eledio/superfaktura-client.git synced 2025-10-31 16:11:20 +01:00
Code Issues Packages Projects Releases 2 Wiki Activity
Files
16046c56b2a70957859a4041e78e113b932a6d35
superfaktura-client/superfaktura.html

1398 lines
200 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>SuperFaktura API client &mdash; SuperFaktura API client documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installation" href="installation.html" />
<link rel="prev" title="Welcome to SuperFaktura Client’s documentation" href="index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
SuperFaktura API client
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">SuperFaktura API client</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#module-superfaktura.bank_account">Bank account</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.bank_account.BankAccount"><code class="docutils literal notranslate"><span class="pre">BankAccount</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.bank_account.BankAccount.default"><code class="docutils literal notranslate"><span class="pre">BankAccount.default()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.bank_account.BankAccount.list"><code class="docutils literal notranslate"><span class="pre">BankAccount.list()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.bank_account.BankAccountModel"><code class="docutils literal notranslate"><span class="pre">BankAccountModel</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.bank_account.BankAccountModel.account"><code class="docutils literal notranslate"><span class="pre">BankAccountModel.account</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.bank_account.BankAccountModel.as_dict"><code class="docutils literal notranslate"><span class="pre">BankAccountModel.as_dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.bank_account.BankAccountModel.bank_code"><code class="docutils literal notranslate"><span class="pre">BankAccountModel.bank_code</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.bank_account.BankAccountModel.bank_name"><code class="docutils literal notranslate"><span class="pre">BankAccountModel.bank_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.bank_account.BankAccountModel.default"><code class="docutils literal notranslate"><span class="pre">BankAccountModel.default</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.bank_account.BankAccountModel.from_dict"><code class="docutils literal notranslate"><span class="pre">BankAccountModel.from_dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.bank_account.BankAccountModel.iban"><code class="docutils literal notranslate"><span class="pre">BankAccountModel.iban</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.bank_account.BankAccountModel.id"><code class="docutils literal notranslate"><span class="pre">BankAccountModel.id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.bank_account.BankAccountModel.show"><code class="docutils literal notranslate"><span class="pre">BankAccountModel.show</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.bank_account.BankAccountModel.swift"><code class="docutils literal notranslate"><span class="pre">BankAccountModel.swift</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.bank_account.NoDefaultBankAccountException"><code class="docutils literal notranslate"><span class="pre">NoDefaultBankAccountException</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-superfaktura.client_contacts">Client contacts</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.client_contacts.ClientContact"><code class="docutils literal notranslate"><span class="pre">ClientContact</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContact.add_contact"><code class="docutils literal notranslate"><span class="pre">ClientContact.add_contact()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContact.get_client"><code class="docutils literal notranslate"><span class="pre">ClientContact.get_client()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContact.list"><code class="docutils literal notranslate"><span class="pre">ClientContact.list()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel"><code class="docutils literal notranslate"><span class="pre">ClientContactModel</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.address"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.address</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.as_dict"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.as_dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.bank_account"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.bank_account</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.bank_code"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.bank_code</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.city"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.city</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.comment"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.comment</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.country"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.country</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.country_id"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.country_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.currency"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.currency</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.default_variable"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.default_variable</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.delivery_address"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.delivery_address</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.delivery_city"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.delivery_city</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.delivery_country"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.delivery_country</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.delivery_country_id"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.delivery_country_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.delivery_name"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.delivery_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.delivery_phone"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.delivery_phone</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.delivery_zip"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.delivery_zip</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.dic"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.dic</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.discount"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.discount</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.due_date"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.due_date</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.email"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.email</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.fax"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.fax</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.from_dict"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.from_dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.iban"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.iban</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.ic_dph"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.ic_dph</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.ico"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.ico</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.id"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.match_address"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.match_address</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.name"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.phone"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.phone</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.swift"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.swift</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.tags"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.tags</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.update"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.update</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.uuid"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.uuid</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.client_contacts.ClientContactModel.zip"><code class="docutils literal notranslate"><span class="pre">ClientContactModel.zip</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.client_contacts.ClientException"><code class="docutils literal notranslate"><span class="pre">ClientException</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-superfaktura.invoice">Invoice</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.invoice.Invoice"><code class="docutils literal notranslate"><span class="pre">Invoice</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.Invoice.add"><code class="docutils literal notranslate"><span class="pre">Invoice.add()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.Invoice.get_pdf"><code class="docutils literal notranslate"><span class="pre">Invoice.get_pdf()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.invoice.InvoiceItem"><code class="docutils literal notranslate"><span class="pre">InvoiceItem</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceItem.as_dict"><code class="docutils literal notranslate"><span class="pre">InvoiceItem.as_dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceItem.description"><code class="docutils literal notranslate"><span class="pre">InvoiceItem.description</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceItem.discount"><code class="docutils literal notranslate"><span class="pre">InvoiceItem.discount</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceItem.discount_description"><code class="docutils literal notranslate"><span class="pre">InvoiceItem.discount_description</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceItem.load_data_from_stock"><code class="docutils literal notranslate"><span class="pre">InvoiceItem.load_data_from_stock</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceItem.name"><code class="docutils literal notranslate"><span class="pre">InvoiceItem.name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceItem.quantity"><code class="docutils literal notranslate"><span class="pre">InvoiceItem.quantity</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceItem.sku"><code class="docutils literal notranslate"><span class="pre">InvoiceItem.sku</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceItem.stock_item_id"><code class="docutils literal notranslate"><span class="pre">InvoiceItem.stock_item_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceItem.tax"><code class="docutils literal notranslate"><span class="pre">InvoiceItem.tax</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceItem.unit"><code class="docutils literal notranslate"><span class="pre">InvoiceItem.unit</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceItem.unit_price"><code class="docutils literal notranslate"><span class="pre">InvoiceItem.unit_price</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceItem.use_document_currency"><code class="docutils literal notranslate"><span class="pre">InvoiceItem.use_document_currency</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel"><code class="docutils literal notranslate"><span class="pre">InvoiceModel</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.add_rounding_item"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.add_rounding_item</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.already_paid"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.already_paid</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.as_dict"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.as_dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.bank_accounts"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.bank_accounts</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.comment"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.comment</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.constant"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.constant</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.created"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.created</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.delivery"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.delivery</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.delivery_type"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.delivery_type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.deposit"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.deposit</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.discount"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.discount</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.discount_total"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.discount_total</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.due"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.due</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.estimate_id"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.estimate_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.header_comment"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.header_comment</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.internal_comment"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.internal_comment</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.invoice_currency"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.invoice_currency</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.invoice_no_formatted"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.invoice_no_formatted</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.issued_by"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.issued_by</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.issued_by_email"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.issued_by_email</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.issued_by_phone"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.issued_by_phone</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.issued_by_web"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.issued_by_web</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.logo_id"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.logo_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.mark_sent"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.mark_sent</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.mark_sent_message"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.mark_sent_message</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.mark_sent_subject"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.mark_sent_subject</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.name"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.order_no"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.order_no</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.parent_id"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.parent_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.paydate"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.paydate</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.payment_type"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.payment_type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.proforma_id"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.proforma_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.rounding"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.rounding</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.sequence_id"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.sequence_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.specific"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.specific</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.tax_document"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.tax_document</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.to_dict"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.to_dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.type"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.variable"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.variable</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.vat_transfer"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.vat_transfer</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel"><code class="docutils literal notranslate"><span class="pre">InvoiceRespModel</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel.error"><code class="docutils literal notranslate"><span class="pre">InvoiceRespModel.error</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel.error_message"><code class="docutils literal notranslate"><span class="pre">InvoiceRespModel.error_message</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel.invoice_id"><code class="docutils literal notranslate"><span class="pre">InvoiceRespModel.invoice_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel.invoice_token"><code class="docutils literal notranslate"><span class="pre">InvoiceRespModel.invoice_token</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.as_dict"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.as_dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.bysquare"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.bysquare</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.callback_payment"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.callback_payment</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.language"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.language</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.online_payment"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.online_payment</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.payment_info"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.payment_info</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.paypal"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.paypal</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.show_prices"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.show_prices</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.signature"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.signature</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceSettings.summary_bg_color"><code class="docutils literal notranslate"><span class="pre">InvoiceSettings.summary_bg_color</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.invoice.InvoiceType"><code class="docutils literal notranslate"><span class="pre">InvoiceType</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceType.INVOICE"><code class="docutils literal notranslate"><span class="pre">InvoiceType.INVOICE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceType.PROFORMA"><code class="docutils literal notranslate"><span class="pre">InvoiceType.PROFORMA</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-superfaktura.superfaktura_api">SuperFaktura API</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.superfaktura_api.SuperFakturaAPI"><code class="docutils literal notranslate"><span class="pre">SuperFakturaAPI</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.superfaktura_api.SuperFakturaAPI.get"><code class="docutils literal notranslate"><span class="pre">SuperFakturaAPI.get()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.superfaktura_api.SuperFakturaAPI.post"><code class="docutils literal notranslate"><span class="pre">SuperFakturaAPI.post()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.superfaktura_api.SuperFakturaAPIException"><code class="docutils literal notranslate"><span class="pre">SuperFakturaAPIException</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.superfaktura_api.SuperFakturaAPIMissingCredentialsException"><code class="docutils literal notranslate"><span class="pre">SuperFakturaAPIMissingCredentialsException</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of SuperFaktura API client usage</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">SuperFaktura API client</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">SuperFaktura API client</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/superfaktura.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="superfaktura-api-client">
<h1>SuperFaktura API client<a class="headerlink" href="#superfaktura-api-client" title="Link to this heading"></a></h1>
<section id="module-superfaktura.bank_account">
<span id="bank-account"></span><h2>Bank account<a class="headerlink" href="#module-superfaktura.bank_account" title="Link to this heading"></a></h2>
<p>Bank Account Module.</p>
<p>This module provides classes and functions for working with bank accounts in the SuperFaktura API.
It allows for retrieving, creating, updating, and deleting bank accounts.</p>
<dl>
<dt>Classes:</dt><dd><ul class="simple">
<li><p>BankAccountModel: Dataclass representing a bank account.</p></li>
<li><p>BankAccount: Class for interacting with bank accounts.</p></li>
</ul>
</dd>
<dt>Exceptions:</dt><dd><ul class="simple">
<li><p>NoDefaultBankAccountException: Exception for when no default bank account is found.</p></li>
</ul>
</dd>
<dt>Functions:</dt><dd><ul class="simple">
<li><p>(none)</p></li>
</ul>
</dd>
<dt>Usage:</dt><dd><p>import superfaktura.bank_account</p>
<p># Create an instance of BankAccount
bank = superfaktura.bank_account.BankAccount()</p>
<p># Retrieve a list of bank accounts
accounts = bank.list()</p>
<p># Get the default bank account
default_account = bank.default()</p>
<p># Create or update a bank account
data = {“account”: “1234567890”, “bank_code”: “1234567890”, “default”: True}
bank.post(data)</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccount">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.bank_account.</span></span><span class="sig-name descname"><span class="pre">BankAccount</span></span><a class="headerlink" href="#superfaktura.bank_account.BankAccount" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="superfaktura.superfaktura_api.html#superfaktura.superfaktura_api.SuperFakturaAPI" title="superfaktura.superfaktura_api.SuperFakturaAPI"><code class="xref py py-class docutils literal notranslate"><span class="pre">SuperFakturaAPI</span></code></a></p>
<p>Bank Account Class.</p>
<p>This class provides methods for interacting with bank accounts in the SuperFaktura API.
It allows for retrieving, creating, updating, and deleting bank accounts.</p>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">list</span></span></dt>
<dd><p>Retrieves a list of bank accounts.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">default</span></span></dt>
<dd><p>Retrieves the default bank account.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">post</span></span></dt>
<dd><p>Creates or updates a bank account.</p>
</dd></dl>
<dl class="simple">
<dt>Usage:</dt><dd><p>bank = BankAccount()
accounts = bank.list()
default_account = bank.default()
data = {“account”: “1234567890”, “bank_code”: “1234567890”, “default”: True}
bank.post(data)</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccount.default">
<span class="sig-name descname"><span class="pre">default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccountModel" title="superfaktura.bank_account.BankAccountModel"><span class="pre">BankAccountModel</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#superfaktura.bank_account.BankAccount.default" title="Link to this definition"></a></dt>
<dd><p>Retrieves the default bank account.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccount.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#superfaktura.bank_account.BankAccount.list" title="Link to this definition"></a></dt>
<dd><p>Retrieves a list of bank accounts.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.bank_account.</span></span><span class="sig-name descname"><span class="pre">BankAccountModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">account</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bank_code</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bank_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iban</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">swift</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Dataclass representing a bank account.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.account">
<span class="sig-name descname"><span class="pre">account</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.account" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.as_dict">
<span class="sig-name descname"><span class="pre">as_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.as_dict" title="Link to this definition"></a></dt>
<dd><p>Returns a dictionary representation of the BankAccountModel.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.bank_code">
<span class="sig-name descname"><span class="pre">bank_code</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.bank_code" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.bank_name">
<span class="sig-name descname"><span class="pre">bank_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.bank_name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.default">
<span class="sig-name descname"><span class="pre">default</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.default" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.from_dict">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccountModel" title="superfaktura.bank_account.BankAccountModel"><span class="pre">BankAccountModel</span></a></span></span><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.from_dict" title="Link to this definition"></a></dt>
<dd><p>Creates a BankAccountModel from a dictionary.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.iban">
<span class="sig-name descname"><span class="pre">iban</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.iban" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.id">
<span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.id" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.show">
<span class="sig-name descname"><span class="pre">show</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.show" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.swift">
<span class="sig-name descname"><span class="pre">swift</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.swift" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="superfaktura.bank_account.NoDefaultBankAccountException">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.bank_account.</span></span><span class="sig-name descname"><span class="pre">NoDefaultBankAccountException</span></span><a class="headerlink" href="#superfaktura.bank_account.NoDefaultBankAccountException" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
<p>Exception for when no default bank account is found.</p>
</dd></dl>
</section>
<section id="module-superfaktura.client_contacts">
<span id="client-contacts"></span><h2>Client contacts<a class="headerlink" href="#module-superfaktura.client_contacts" title="Link to this heading"></a></h2>
<p>Module for interacting with client contacts in SuperFaktura.</p>
<p>This module provides classes and functions for working with client contacts,
including creating, reading, and updating contact information.</p>
<dl class="simple">
<dt>Classes:</dt><dd><p>ClientException: Base class for client exceptions.
ClientContactModel: Dataclass representing a client contact.</p>
</dd>
<dt>Functions:</dt><dd><p>(none)</p>
</dd>
<dt>Variables:</dt><dd><p>(none)</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>This module uses the SuperFaktura API to interact with client contacts.
You must have a valid API key and credentials to use this module.</p>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContact">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.client_contacts.</span></span><span class="sig-name descname"><span class="pre">ClientContact</span></span><a class="headerlink" href="#superfaktura.client_contacts.ClientContact" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="superfaktura.superfaktura_api.html#superfaktura.superfaktura_api.SuperFakturaAPI" title="superfaktura.superfaktura_api.SuperFakturaAPI"><code class="xref py py-class docutils literal notranslate"><span class="pre">SuperFakturaAPI</span></code></a></p>
<p>Client contact class.</p>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContact.add_contact">
<span class="sig-name descname"><span class="pre">add_contact</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">contact</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel" title="superfaktura.client_contacts.ClientContactModel"><span class="pre">ClientContactModel</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#superfaktura.client_contacts.ClientContact.add_contact" title="Link to this definition"></a></dt>
<dd><p>Adds a new client contact.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContact.get_client">
<span class="sig-name descname"><span class="pre">get_client</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel" title="superfaktura.client_contacts.ClientContactModel"><span class="pre">ClientContactModel</span></a></span></span><a class="headerlink" href="#superfaktura.client_contacts.ClientContact.get_client" title="Link to this definition"></a></dt>
<dd><p>Gets a client contact by ID.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContact.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#superfaktura.client_contacts.ClientContact.list" title="Link to this definition"></a></dt>
<dd><p>Lists all exists client contacts.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.client_contacts.</span></span><span class="sig-name descname"><span class="pre">ClientContactModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bank_account</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bank_code</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">city</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">country</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">country_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">currency</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_variable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">delivery_address</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">delivery_city</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">delivery_country</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">delivery_country_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">delivery_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">delivery_phone</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">delivery_zip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dic</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">discount</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">due_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">email</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fax</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iban</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ic_dph</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ico</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">match_address</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">phone</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">swift</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">zip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Client contact model.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.address">
<span class="sig-name descname"><span class="pre">address</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.address" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.as_dict">
<span class="sig-name descname"><span class="pre">as_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.as_dict" title="Link to this definition"></a></dt>
<dd><p>Returns a dictionary representation of the ClientContactModel.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.bank_account">
<span class="sig-name descname"><span class="pre">bank_account</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.bank_account" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.bank_code">
<span class="sig-name descname"><span class="pre">bank_code</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.bank_code" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.city">
<span class="sig-name descname"><span class="pre">city</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.city" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.comment">
<span class="sig-name descname"><span class="pre">comment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.comment" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.country">
<span class="sig-name descname"><span class="pre">country</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.country" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.country_id">
<span class="sig-name descname"><span class="pre">country_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.country_id" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.currency">
<span class="sig-name descname"><span class="pre">currency</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.currency" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.default_variable">
<span class="sig-name descname"><span class="pre">default_variable</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.default_variable" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.delivery_address">
<span class="sig-name descname"><span class="pre">delivery_address</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.delivery_address" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.delivery_city">
<span class="sig-name descname"><span class="pre">delivery_city</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.delivery_city" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.delivery_country">
<span class="sig-name descname"><span class="pre">delivery_country</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.delivery_country" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.delivery_country_id">
<span class="sig-name descname"><span class="pre">delivery_country_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.delivery_country_id" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.delivery_name">
<span class="sig-name descname"><span class="pre">delivery_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.delivery_name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.delivery_phone">
<span class="sig-name descname"><span class="pre">delivery_phone</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.delivery_phone" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.delivery_zip">
<span class="sig-name descname"><span class="pre">delivery_zip</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.delivery_zip" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.dic">
<span class="sig-name descname"><span class="pre">dic</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.dic" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.discount">
<span class="sig-name descname"><span class="pre">discount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.discount" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.due_date">
<span class="sig-name descname"><span class="pre">due_date</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.due_date" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.email">
<span class="sig-name descname"><span class="pre">email</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.email" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.fax">
<span class="sig-name descname"><span class="pre">fax</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.fax" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.from_dict">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel" title="superfaktura.client_contacts.ClientContactModel"><span class="pre">ClientContactModel</span></a></span></span><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.from_dict" title="Link to this definition"></a></dt>
<dd><p>Creates a ClientContactModel from a dictionary.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.iban">
<span class="sig-name descname"><span class="pre">iban</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.iban" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.ic_dph">
<span class="sig-name descname"><span class="pre">ic_dph</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.ic_dph" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.ico">
<span class="sig-name descname"><span class="pre">ico</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.ico" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.id">
<span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.id" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.match_address">
<span class="sig-name descname"><span class="pre">match_address</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.match_address" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.name">
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.phone">
<span class="sig-name descname"><span class="pre">phone</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.phone" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.swift">
<span class="sig-name descname"><span class="pre">swift</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.swift" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.tags">
<span class="sig-name descname"><span class="pre">tags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.tags" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.update">
<span class="sig-name descname"><span class="pre">update</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.update" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.uuid">
<span class="sig-name descname"><span class="pre">uuid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.uuid" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientContactModel.zip">
<span class="sig-name descname"><span class="pre">zip</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.client_contacts.ClientContactModel.zip" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="superfaktura.client_contacts.ClientException">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.client_contacts.</span></span><span class="sig-name descname"><span class="pre">ClientException</span></span><a class="headerlink" href="#superfaktura.client_contacts.ClientException" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
<p>Base class for client exceptions.</p>
</dd></dl>
</section>
<section id="module-superfaktura.invoice">
<span id="invoice"></span><h2>Invoice<a class="headerlink" href="#module-superfaktura.invoice" title="Link to this heading"></a></h2>
<p>Invoice Module.</p>
<p>This module provides classes and functions for working with invoices in the SuperFaktura API.
It allows for retrieving, creating, updating, and deleting invoices.</p>
<dl>
<dt>Classes:</dt><dd><ul class="simple">
<li><p>InvoiceModel: Dataclass representing an invoice.</p></li>
<li><p>InvoiceItem: Dataclass representing an invoice item.</p></li>
<li><p>Invoice: Class for interacting with invoices.</p></li>
</ul>
</dd>
<dt>Exceptions:</dt><dd><ul class="simple">
<li><p>NoDefaultBankAccountException: Exception for when no default bank account is found.</p></li>
</ul>
</dd>
<dt>Functions:</dt><dd><ul class="simple">
<li><p>(none)</p></li>
</ul>
</dd>
<dt>Usage:</dt><dd><p>import superfaktura.invoice</p>
<p># Create an instance of Invoice
invoice = superfaktura.invoice.Invoice()</p>
<p># Create an invoice
invoice.add(</p>
<blockquote>
<div><dl class="simple">
<dt>invoice=superfaktura.invoice.InvoiceModel(</dt><dd><p>type=superfaktura.invoice.InvoiceType.PROFORMA,
name=”Invoice 3”,
due=superfaktura.invoice.Date(“2025-02-01”),
invoice_currency=superfaktura.invoice.Currencies.CZK,
header_comment=”We invoice you for services”,
bank_accounts=[bank.default().as_dict()],</p>
</dd>
</dl>
<p>),
items=[</p>
<blockquote>
<div><dl class="simple">
<dt>superfaktura.invoice.InvoiceItem(name=”Services”, unit_price=100, quantity=1,</dt><dd><p>unit=”ks”, tax=21),</p>
</dd>
<dt>superfaktura.invoice.InvoiceItem(name=”SIM card”, unit_price=50, quantity=1,</dt><dd><p>tax=21, unit=”ks”),</p>
</dd>
<dt>superfaktura.invoice.InvoiceItem(</dt><dd><p>name=”SIM card 2”, unit_price=75, quantity=1, tax=21, unit=”ks”</p>
</dd>
</dl>
<p>),</p>
</div></blockquote>
<p>],
contact=superfaktura.client_contacts.ClientContactModel(</p>
<blockquote>
<div><p>name=”Richard Kubíček”,
email=”<a class="reference external" href="mailto:kubicekr&#37;&#52;&#48;eledio&#46;com">kubicekr<span>&#64;</span>eledio<span>&#46;</span>com</a>”,
phone=”+420 123 456 789”,
address=”Jaroslava Foglara 861/1”,
ico=”123”,
update=True,
country_id=57,</p>
</div></blockquote>
<p>),</p>
</div></blockquote>
<p>)</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.invoice.Invoice">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.invoice.</span></span><span class="sig-name descname"><span class="pre">Invoice</span></span><a class="headerlink" href="#superfaktura.invoice.Invoice" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="superfaktura.superfaktura_api.html#superfaktura.superfaktura_api.SuperFakturaAPI" title="superfaktura.superfaktura_api.SuperFakturaAPI"><code class="xref py py-class docutils literal notranslate"><span class="pre">SuperFakturaAPI</span></code></a></p>
<p>Invoice Class.</p>
<p>This class provides methods for interacting with invoices in the SuperFaktura API.
It allows for retrieving, creating, updating, and deleting invoices.</p>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">add</span></span></dt>
<dd><p>Creates a new invoice.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">get</span></span></dt>
<dd><p>Retrieves an invoice by ID.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">list</span></span></dt>
<dd><p>Retrieves a list of invoices.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">update</span></span></dt>
<dd><p>Updates an existing invoice.</p>
</dd></dl>
<dl>
<dt>Usage:</dt><dd><p>invoice = Invoice()
invoice.add(</p>
<blockquote>
<div><dl class="simple">
<dt>invoice=InvoiceModel(</dt><dd><p>type=InvoiceType.PROFORMA,
name=”Invoice 3”,
due=Date(“2025-02-01”),
invoice_currency=Currencies.CZK,
header_comment=”We invoice you for services”,
bank_accounts=[bank.default().as_dict()],</p>
</dd>
</dl>
<p>),
items=[</p>
<blockquote>
<div><p>InvoiceItem(name=”Services”, unit_price=100, quantity=1, unit=”ks”, tax=21),
InvoiceItem(name=”SIM card”, unit_price=50, quantity=1, tax=21, unit=”ks”),
InvoiceItem(</p>
<blockquote>
<div><p>name=”SIM card 2”, unit_price=75, quantity=1, tax=21, unit=”ks”</p>
</div></blockquote>
<p>),</p>
</div></blockquote>
<p>],
contact=ClientContactModel(</p>
<blockquote>
<div><p>name=”Richard Kubíček”,
email=”<a class="reference external" href="mailto:kubicekr&#37;&#52;&#48;eledio&#46;com">kubicekr<span>&#64;</span>eledio<span>&#46;</span>com</a>”,
phone=”+420 123 456 789”,
address=”Jaroslava Foglara 861/1”,
ico=”123”,
update=True,
country_id=57,</p>
</div></blockquote>
<p>),</p>
</div></blockquote>
<p>)</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.invoice.Invoice.add">
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invoice_model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel" title="superfaktura.invoice.InvoiceModel"><span class="pre">InvoiceModel</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem" title="superfaktura.invoice.InvoiceItem"><span class="pre">InvoiceItem</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">contact</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel" title="superfaktura.client_contacts.ClientContactModel"><span class="pre">ClientContactModel</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">invoice_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings" title="superfaktura.invoice.InvoiceSettings"><span class="pre">InvoiceSettings</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel"><span class="pre">InvoiceRespModel</span></a></span></span><a class="headerlink" href="#superfaktura.invoice.Invoice.add" title="Link to this definition"></a></dt>
<dd><p>Adds a new invoice.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>invoice_model</strong> (<a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel" title="superfaktura.invoice.InvoiceModel"><em>InvoiceModel</em></a>) – The invoice model.</p></li>
<li><p><strong>items</strong> (<em>List</em><em>[</em><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem" title="superfaktura.invoice.InvoiceItem"><em>InvoiceItem</em></a><em>]</em>) – List of invoice items.</p></li>
<li><p><strong>contact</strong> (<a class="reference internal" href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel" title="superfaktura.client_contacts.ClientContactModel"><em>ClientContactModel</em></a>) – The client contact model.</p></li>
<li><p><strong>invoice_settings</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings" title="superfaktura.invoice.InvoiceSettings"><em>InvoiceSettings</em></a><em>]</em>) – The invoice settings.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The response model for the invoice.
:param invoice_settings:
:param contact:
:param items:
:param invoice_model:</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel">InvoiceRespModel</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.invoice.Invoice.get_pdf">
<span class="sig-name descname"><span class="pre">get_pdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invoice</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel"><span class="pre">InvoiceRespModel</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">language</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'cze'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#superfaktura.invoice.Invoice.get_pdf" title="Link to this definition"></a></dt>
<dd><p>Retrieves the PDF of the invoice.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>invoice</strong> (<a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel"><em>InvoiceRespModel</em></a>) – The response model for the invoice.</p></li>
<li><p><strong>language</strong> (<em>str</em>) – The language for the PDF.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A bytes containing the PDF data.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bytes</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceItem">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.invoice.</span></span><span class="sig-name descname"><span class="pre">InvoiceItem</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unit_price</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">discount</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">discount_description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">load_data_from_stock</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quantity</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sku</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stock_item_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tax</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_document_currency</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.invoice.InvoiceItem" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This dataclass represents an invoice item in the SuperFaktura API.</p>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceItem.as_dict">
<span class="sig-name descname"><span class="pre">as_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#superfaktura.invoice.InvoiceItem.as_dict" title="Link to this definition"></a></dt>
<dd><p>Returns a dictionary representation of the InvoiceItem.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceItem.description">
<span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceItem.description" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceItem.discount">
<span class="sig-name descname"><span class="pre">discount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceItem.discount" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceItem.discount_description">
<span class="sig-name descname"><span class="pre">discount_description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceItem.discount_description" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceItem.load_data_from_stock">
<span class="sig-name descname"><span class="pre">load_data_from_stock</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceItem.load_data_from_stock" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceItem.name">
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceItem.name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceItem.quantity">
<span class="sig-name descname"><span class="pre">quantity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceItem.quantity" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceItem.sku">
<span class="sig-name descname"><span class="pre">sku</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceItem.sku" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceItem.stock_item_id">
<span class="sig-name descname"><span class="pre">stock_item_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceItem.stock_item_id" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceItem.tax">
<span class="sig-name descname"><span class="pre">tax</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceItem.tax" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceItem.unit">
<span class="sig-name descname"><span class="pre">unit</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceItem.unit" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceItem.unit_price">
<span class="sig-name descname"><span class="pre">unit_price</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceItem.unit_price" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceItem.use_document_currency">
<span class="sig-name descname"><span class="pre">use_document_currency</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceItem.use_document_currency" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.invoice.</span></span><span class="sig-name descname"><span class="pre">InvoiceModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">add_rounding_item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">already_paid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bank_accounts</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">constant</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.utils.data_types.html#superfaktura.utils.data_types.Date" title="superfaktura.utils.data_types.Date"><span class="pre">Date</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">delivery</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.utils.data_types.html#superfaktura.utils.data_types.Date" title="superfaktura.utils.data_types.Date"><span class="pre">Date</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">delivery_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deposit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">discount</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">discount_total</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">due</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.utils.data_types.html#superfaktura.utils.data_types.Date" title="superfaktura.utils.data_types.Date"><span class="pre">Date</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">estimate_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">header_comment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">internal_comment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">invoice_currency</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">invoice_no_formatted</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issued_by</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issued_by_email</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issued_by_phone</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issued_by_web</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logo_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mark_sent</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mark_sent_message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mark_sent_subject</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">order_no</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">paydate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.utils.data_types.html#superfaktura.utils.data_types.Date" title="superfaktura.utils.data_types.Date"><span class="pre">Date</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payment_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">proforma_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rounding</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sequence_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">specific</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tax_document</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">variable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vat_transfer</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.invoice.InvoiceModel" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This dataclass represents an invoice in the SuperFaktura API.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.add_rounding_item">
<span class="sig-name descname"><span class="pre">add_rounding_item</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.add_rounding_item" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.already_paid">
<span class="sig-name descname"><span class="pre">already_paid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.already_paid" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.as_dict">
<span class="sig-name descname"><span class="pre">as_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.as_dict" title="Link to this definition"></a></dt>
<dd><p>Returns a dictionary representation of the InvoiceModel.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.bank_accounts">
<span class="sig-name descname"><span class="pre">bank_accounts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.bank_accounts" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.comment">
<span class="sig-name descname"><span class="pre">comment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.comment" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.constant">
<span class="sig-name descname"><span class="pre">constant</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.constant" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.created">
<span class="sig-name descname"><span class="pre">created</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="superfaktura.utils.data_types.html#superfaktura.utils.data_types.Date" title="superfaktura.utils.data_types.Date"><span class="pre">Date</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.created" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.delivery">
<span class="sig-name descname"><span class="pre">delivery</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="superfaktura.utils.data_types.html#superfaktura.utils.data_types.Date" title="superfaktura.utils.data_types.Date"><span class="pre">Date</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.delivery" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.delivery_type">
<span class="sig-name descname"><span class="pre">delivery_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.delivery_type" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.deposit">
<span class="sig-name descname"><span class="pre">deposit</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.deposit" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.discount">
<span class="sig-name descname"><span class="pre">discount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.discount" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.discount_total">
<span class="sig-name descname"><span class="pre">discount_total</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.discount_total" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.due">
<span class="sig-name descname"><span class="pre">due</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="superfaktura.utils.data_types.html#superfaktura.utils.data_types.Date" title="superfaktura.utils.data_types.Date"><span class="pre">Date</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.due" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.estimate_id">
<span class="sig-name descname"><span class="pre">estimate_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.estimate_id" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.header_comment">
<span class="sig-name descname"><span class="pre">header_comment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.header_comment" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.internal_comment">
<span class="sig-name descname"><span class="pre">internal_comment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.internal_comment" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.invoice_currency">
<span class="sig-name descname"><span class="pre">invoice_currency</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.invoice_currency" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.invoice_no_formatted">
<span class="sig-name descname"><span class="pre">invoice_no_formatted</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.invoice_no_formatted" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.issued_by">
<span class="sig-name descname"><span class="pre">issued_by</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.issued_by" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.issued_by_email">
<span class="sig-name descname"><span class="pre">issued_by_email</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.issued_by_email" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.issued_by_phone">
<span class="sig-name descname"><span class="pre">issued_by_phone</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.issued_by_phone" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.issued_by_web">
<span class="sig-name descname"><span class="pre">issued_by_web</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.issued_by_web" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.logo_id">
<span class="sig-name descname"><span class="pre">logo_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.logo_id" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.mark_sent">
<span class="sig-name descname"><span class="pre">mark_sent</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.mark_sent" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.mark_sent_message">
<span class="sig-name descname"><span class="pre">mark_sent_message</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.mark_sent_message" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.mark_sent_subject">
<span class="sig-name descname"><span class="pre">mark_sent_subject</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.mark_sent_subject" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.name">
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.order_no">
<span class="sig-name descname"><span class="pre">order_no</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.order_no" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.parent_id">
<span class="sig-name descname"><span class="pre">parent_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.parent_id" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.paydate">
<span class="sig-name descname"><span class="pre">paydate</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="superfaktura.utils.data_types.html#superfaktura.utils.data_types.Date" title="superfaktura.utils.data_types.Date"><span class="pre">Date</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.paydate" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.payment_type">
<span class="sig-name descname"><span class="pre">payment_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.payment_type" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.proforma_id">
<span class="sig-name descname"><span class="pre">proforma_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.proforma_id" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.rounding">
<span class="sig-name descname"><span class="pre">rounding</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.rounding" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.sequence_id">
<span class="sig-name descname"><span class="pre">sequence_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.sequence_id" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.specific">
<span class="sig-name descname"><span class="pre">specific</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.specific" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.tax_document">
<span class="sig-name descname"><span class="pre">tax_document</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.tax_document" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.to_dict">
<span class="sig-name descname"><span class="pre">to_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.to_dict" title="Link to this definition"></a></dt>
<dd><p>Converts the Record object to a dictionary for JSON serialization.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.type">
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.type" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.variable">
<span class="sig-name descname"><span class="pre">variable</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.variable" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceModel.vat_transfer">
<span class="sig-name descname"><span class="pre">vat_transfer</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceModel.vat_transfer" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.invoice.</span></span><span class="sig-name descname"><span class="pre">InvoiceRespModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">invoice_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">invoice_token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This dataclass represents the response model for an invoice in the SuperFaktura API.</p>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">error</span></span></dt>
<dd><p>The error code.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">error_message</span></span></dt>
<dd><p>The error message.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">invoice_id</span></span></dt>
<dd><p>The ID of the invoice.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[int]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">invoice_token</span></span></dt>
<dd><p>The token of</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[str]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel.error">
<span class="sig-name descname"><span class="pre">error</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel.error" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel.error_message">
<span class="sig-name descname"><span class="pre">error_message</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel.error_message" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel.invoice_id">
<span class="sig-name descname"><span class="pre">invoice_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel.invoice_id" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel.invoice_token">
<span class="sig-name descname"><span class="pre">invoice_token</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel.invoice_token" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.invoice.</span></span><span class="sig-name descname"><span class="pre">InvoiceSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">language</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bysquare</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callback_payment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">online_payment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payment_info</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">paypal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_prices</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">signature</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">summary_bg_color</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This dataclass represents the settings for an invoice in the SuperFaktura API.</p>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.as_dict">
<span class="sig-name descname"><span class="pre">as_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.as_dict" title="Link to this definition"></a></dt>
<dd><p>Returns a dictionary representation of the ClientContactModel.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.bysquare">
<span class="sig-name descname"><span class="pre">bysquare</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.bysquare" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.callback_payment">
<span class="sig-name descname"><span class="pre">callback_payment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.callback_payment" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.language">
<span class="sig-name descname"><span class="pre">language</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.language" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.online_payment">
<span class="sig-name descname"><span class="pre">online_payment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.online_payment" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.payment_info">
<span class="sig-name descname"><span class="pre">payment_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.payment_info" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.paypal">
<span class="sig-name descname"><span class="pre">paypal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.paypal" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.show_prices">
<span class="sig-name descname"><span class="pre">show_prices</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.show_prices" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.signature">
<span class="sig-name descname"><span class="pre">signature</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.signature" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.summary_bg_color">
<span class="sig-name descname"><span class="pre">summary_bg_color</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.summary_bg_color" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.invoice.</span></span><span class="sig-name descname"><span class="pre">InvoiceType</span></span><a class="headerlink" href="#superfaktura.invoice.InvoiceType" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Invoice Type Enumeration.</p>
<p>This enumeration represents the different types of invoices that can be created.</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>invoice_type = InvoiceType.PROFORMA</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceType.INVOICE">
<span class="sig-name descname"><span class="pre">INVOICE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'regular'</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceType.INVOICE" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceType.PROFORMA">
<span class="sig-name descname"><span class="pre">PROFORMA</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'proforma'</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceType.PROFORMA" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-superfaktura.superfaktura_api">
<span id="superfaktura-api"></span><h2>SuperFaktura API<a class="headerlink" href="#module-superfaktura.superfaktura_api" title="Link to this heading"></a></h2>
<p>SuperFaktura API Client.</p>
<p>This module provides classes and functions for working with the SuperFaktura API.
It allows for reading, creating, updating, and deleting data in SuperFaktura.</p>
<dl>
<dt>Classes:</dt><dd><ul class="simple">
<li><p>SuperFakturaAPI: The base class for working with the SuperFaktura API.</p></li>
<li><p>SuperFakturaAPIException: An exception for errors when working with the SuperFaktura API.</p></li>
<li><p>SuperFakturaAPIMissingCredentialsException: An exception for missing login credentials.</p></li>
</ul>
</dd>
<dt>Functions:</dt><dd><ul class="simple">
<li><p>get: Retrieves data from the SuperFaktura API.</p></li>
<li><p>post: Creates or updates data in the SuperFaktura API.</p></li>
</ul>
</dd>
<dt>Usage:</dt><dd><p>import superfaktura.superfaktura_api</p>
<p># Create an instance of SuperFakturaAPI
api = superfaktura.superfaktura_api.SuperFakturaAPI()</p>
<p># Retrieve data from the SuperFaktura API
data = api.get(‘endpoint’)</p>
<p># Create or update data in the SuperFaktura API
api.post(‘endpoint’, data)</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.superfaktura_api.SuperFakturaAPI">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.superfaktura_api.</span></span><span class="sig-name descname"><span class="pre">SuperFakturaAPI</span></span><a class="headerlink" href="#superfaktura.superfaktura_api.SuperFakturaAPI" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Base class for working with the SuperFaktura API.</p>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.superfaktura_api.SuperFakturaAPI.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFormat</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">DataFormat.JSON</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">5</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#superfaktura.superfaktura_api.SuperFakturaAPI.get" title="Link to this definition"></a></dt>
<dd><p>Retrieves data from the SuperFaktura API.</p>
<p>Retrieves data from the specified endpoint in the SuperFaktura API.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>endpoint</strong> (<em>str</em>) – The API endpoint to retrieve data from (e.g. ‘invoices’, ‘clients’,
etc.).</p></li>
<li><p><strong>timeout</strong> (<em>int</em><em>, </em><em>optional</em>) – The timeout for the API request in seconds. Defaults to 5.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The retrieved data in JSON format.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Dict</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="superfaktura.superfaktura_api.html#superfaktura.superfaktura_api.SuperFakturaAPIException" title="superfaktura.superfaktura_api.SuperFakturaAPIException"><strong>SuperFakturaAPIException</strong></a> – If the API request fails or returns an error.</p>
</dd>
</dl>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">api</span> <span class="o">=</span> <span class="n">SuperFakturaAPI</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">data</span> <span class="o">=</span> <span class="n">api</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;invoices&#39;</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
</pre></div>
</div>
<p class="rubric">Notes</p>
<p>The available endpoints can be found in the SuperFaktura API documentation.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.superfaktura_api.SuperFakturaAPI.post">
<span class="sig-name descname"><span class="pre">post</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">5</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#superfaktura.superfaktura_api.SuperFakturaAPI.post" title="Link to this definition"></a></dt>
<dd><p>Creates or updates data in the SuperFaktura API.</p>
<p>Creates or updates data in the specified endpoint in the SuperFaktura API.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>endpoint</strong> (<em>str</em>) – The API endpoint to create or update data in (e.g. ‘invoices’,
‘clients’, etc.).</p></li>
<li><p><strong>data</strong> (<em>str</em>) – The data to be created or updated in JSON format.</p></li>
<li><p><strong>timeout</strong> (<em>int</em><em>, </em><em>optional</em>) – The timeout for the API request in seconds. Defaults
to 5.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The created or updated data in JSON format.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Dict</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="superfaktura.superfaktura_api.html#superfaktura.superfaktura_api.SuperFakturaAPIException" title="superfaktura.superfaktura_api.SuperFakturaAPIException"><strong>SuperFakturaAPIException</strong></a> – If the API request fails or returns an error.</p>
</dd>
</dl>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">api</span> <span class="o">=</span> <span class="n">SuperFakturaAPI</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">data</span> <span class="o">=</span> <span class="s1">&#39;{&quot;name&quot;: &quot;Example Invoice&quot;, &quot;amount&quot;: 100.0}&#39;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">response</span> <span class="o">=</span> <span class="n">api</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s1">&#39;invoices&#39;</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">response</span><span class="p">)</span>
</pre></div>
</div>
<p class="rubric">Notes</p>
<p>The available endpoints can be found in the SuperFaktura API documentation.
The data should be a valid JSON string.</p>
</dd></dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="superfaktura.superfaktura_api.SuperFakturaAPIException">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.superfaktura_api.</span></span><span class="sig-name descname"><span class="pre">SuperFakturaAPIException</span></span><a class="headerlink" href="#superfaktura.superfaktura_api.SuperFakturaAPIException" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
<p>Exception for errors when working with the SuperFaktura API.</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="superfaktura.superfaktura_api.SuperFakturaAPIMissingCredentialsException">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.superfaktura_api.</span></span><span class="sig-name descname"><span class="pre">SuperFakturaAPIMissingCredentialsException</span></span><a class="headerlink" href="#superfaktura.superfaktura_api.SuperFakturaAPIMissingCredentialsException" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
<p>Exception for missing login credentials.</p>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to SuperFaktura Client’s documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025, Richard Kubíček, Eledio s.r.o..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink