Skip to main content

Opis i definicje.

Cel projektu

Projekt powstał z potrzeby zaplanowania, sklasyfikowania, uporządkowania i raportowania kosztów w firmie. WHMCS w dostateczny sposób zarządza i raportuje przychody lecz niestety po stronie kosztów nie ma odpowiednich mechanizmów.

Postanowiliśmy przygotować własny moduł ponieważ nie znaleźliśmy żadnego który realizował by potrzebne nam funkcje.

Projekt powstał amatorsko, na potrzeby naszej firmy, ale z profesjonalnym podejściem.
Projekt jest w całości finansowany przez firmę PUQ sp. z o.o. https://puq.pl/ 

Projekt potrzebuje Twojego wsparcia aby funkcjonował i dalej się rozwijał.
Jeśli masz chęć pomocy w rozwoju projektu czy to finansowo, merytorycznie, tłumaczenia, pisania/korekty dokumentacji lub w jakikolwiek inny sposób, daj nam znać cf@puq.info



Głównym celem modułu jest zbieranie dokumentów w postaci PDF, poprawne opisywanie dokumentów (Umów, faktur). Na podstawie wprowadzonych danych oraz zaimportowanych faktur z systemów księgowych, w czytelnej formie generujemy raporty i prognozy dotyczące finansów firmy.

Do zapisywania plików moduł wykorzystuje połączenie z serwerem WebDAV, co oznacza, że ​​pliki nie są fizycznie przechowywane na serwerze WHMCS i będą dostępne nawet po usunięciu modułu.

System wymaga wykorzystania i został w pełni przetestowany z NEXTCLOUD, uznanym oprogramowaniem typu opensource. Możesz skorzystać z własnej instalacji Nextcloud lub skorzystać z naszego darmowego rozwiązania dostępnego pod tym linkiem: https://crm.puq.pl/store/za-darmo

Do synchronizacji faktur moduł wykorzystuje połączenie API do WHMCS.
Oznacza to, że moduł można zainstalować nie na serwerze produkcyjnym WHMCS, ale np. na serwerze dewelopera, co w żadnym wypadku nie wpłynie na funkcjonalność tego modułu. Możliwe jest również połączenie kilku systemów WHMCS w celu synchronizacji faktur.

Moduł tworzy niezbędne tabele w bazie danych WHMCS i tylko je wykorzystuje w swojej pracy.
Nie używa żadnych innych tabel WHMCS.

Moduł przesyła dane do serwera projektu w postaci kodu instalacyjnego, który jest generowany podczas instalacji w celach statystycznych. W odpowiedzi serwery dostarczają dane o nowej wersji oraz ważne informacje, które wyświetlają się na w Panelu modułu.

Moduł obsługuje wielojęzyczność. Ustawienia języka można zmienić w konfiguracji użytkownika systemu WHMCS.
Dostępne języki: angielski, polski, rosyjski.

Definicje

Kontrahent - obiekt w systemie, oznacza osobę fizyczną lub prawną, będącą stroną umowy lub faktury.

Dane dla klasyfikacji w systemie:

  • Nazwa firmy
  • NIP

Dokumenty - pliki PDF w postaci niesklasyfikowanych, oraz ich klasyfikacja (Faktura, Umowa, Aneks od umowy)

Zobowiązanie - obiekt w systemie który charakteryzuje grupę kosztów które ponoszone w stosunku do kontrahenta na podstawie umowy oraz/lub faktur.

Dane dla klasyfikacji w systemie:

  • Nazwa zobowiązania
  • Data rozpoczęcia (Wartość jest wyliczana z faktur lub umowy)
  • Data zakończenia (Wartość jest wyliczana z faktur lub umowy)
  • Czas nieokreślony (Wartość jest wyliczana z umowy lub ustawiona ręcznie)

Zobowiązania jako podstawa organizacji dokumentów

Zobowiązanie umożliwia grupowanie faktur oraz/lub podpięcie ich do odpowiedniej umowy.

Założenie 1

Mapować można tylko jedną umowę i fakturę, dotyczące obowiązywania umowy.
W tym przypadku parametry zobowiązania (Data rozpoczęcia, Data zakończenia, Czas nieokreślony) są wyliczone z parametrów umowy.

Założenie 2

W przypadku braku umowy, mapowanie tylko pokrewnych kontrahentowi faktur.
W tym przypadku parametry zobowiązania pobierane są z podlinkowanych faktur gdzie:

  • Data rozpoczęcia jest datą najstarszej faktury,
  • Data zakończenia jest datą najnowszej faktury.

W przypadku zaznaczenia opcji Czas nieokreślony Data zakończenia jest datą najnowszej faktury + 12 miesiące.

Globalne założenie

Każda faktura ma być mapowana do zobowiązania.

Uwaga!!! Do zobowiązania da się mapować faktury tylko jednego kontrahenta.

Systemy księgowe - System który posiada zbiór faktur przychodowych, oraz ma możliwość wyeksportowania.
-apiWHMCS: dowolny system WHMCS z odpowiednio skonfigurowanym API.