# superfaktura.client_contacts module

Module for interacting with client contacts in SuperFaktura.

This module provides classes and functions for working with client contacts, including creating, reading, and updating contact information.

Classes:

  ClientException: Base class for client exceptions. ClientContactModel: Dataclass representing a client contact.

Functions:

  (none)

Variables:

  (none)

Notes

This module uses the SuperFaktura API to interact with client contacts. You must have a valid API key and credentials to use this module.

class superfaktura.client_contacts.ClientContact

  Bases: `SuperFakturaAPI`

  Client contact class.

  add_contact(contact: ClientContactModel ) → bool

    Adds a new client contact.

  get_client(client_id: int) → ClientContactModel

    Gets a client contact by ID.

  list() → dict

    Lists all exists client contacts.

class superfaktura.client_contacts.ClientContactModel(name: str, address: str | None = None, bank_account: str | None = None, bank_code: str | None = None, city: str | None = None, comment: str | None = None, country: str | None = None, country_id: int | None = None, currency: str | None = None, default_variable: str | None = None, delivery_address: str | None = None, delivery_city: str | None = None, delivery_country: str | None = None, delivery_country_id: int | None = None, delivery_name: str | None = None, delivery_phone: str | None = None, delivery_zip: str | None = None, dic: str | None = None, discount: float | None = None, due_date: int | None = None, email: str | None = None, fax: str | None = None, iban: str | None = None, ic_dph: str | None = None, ico: str | None = None, match_address: int | None = None, phone: str | None = None, swift: str | None = None, tags: str | None = None, uuid: str | None = None, zip: str | None = None, update: bool | None = None, id: int | None = None)

  Bases: `object`

  Client contact model.

  address: str | None = None
  as_dict() → dict

    Returns a dictionary representation of the ClientContactModel.

  bank_account: str | None = None
  bank_code: str | None = None
  city: str | None = None
  comment: str | None = None
  country: str | None = None
  country_id: int | None = None
  currency: str | None = None
  default_variable: str | None = None
  delivery_address: str | None = None
  delivery_city: str | None = None
  delivery_country: str | None = None
  delivery_country_id: int | None = None
  delivery_name: str | None = None
  delivery_phone: str | None = None
  delivery_zip: str | None = None
  dic: str | None = None
  discount: float | None = None
  due_date: int | None = None
  email: str | None = None
  fax: str | None = None
  static from_dict(data: dict) → ClientContactModel

    Creates a ClientContactModel from a dictionary.

  iban: str | None = None
  ic_dph: str | None = None
  ico: str | None = None
  id: int | None = None
  match_address: int | None = None
  name: str
  phone: str | None = None
  swift: str | None = None
  tags: str | None = None
  update: bool | None = None
  uuid: str | None = None
  zip: str | None = None

exception superfaktura.client_contacts.ClientException

  Bases: `Exception`

  Base class for client exceptions.