PUQ Mautic

PL instrukcja WHMCS CF

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.

System pomaga poznać realny przychów podliczając przychody z faktów wystawionych w WHMCS z fakturami czy dokumentami kosztowymi wgranymi i opisanymi ręcznie do modułu bez wychodzenia z WHMCS. System bazuje na pojęciu umów i zobowiązań i umożliwia pokazanie przepływów finansowych w dłuższym przedziale czasu.

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:

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:

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:

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.

 

 

 

 

 

 

 

 

 

 

Jak zacząć używać

Jak zacząć używać

Wymagania

 

Zainstalowany i poprawnie skonfigurowany WHMCS

Moduł testowany na wersji WHMCS 8.1

Konto serwera NextCloud z dostępem przez protokół WebDAV - moduł działa, na tym etapie, poprawnie tylko z NextCloud

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 poprawnej pracy modułu wymagane są parametry PHP:

PHP >= 7.2
file_uploads On
post_max_size 80M ;(Kieruj się rozmiarem plików PDF)
upload_max_filesize 80M ;(Kieruj się rozmiarem plików PDF)
max_file_uploads 40

 

 

Jak zacząć używać

Instalacja

Na tym etapie moduł nie zawiera samodzielnego instalatora.

Instalacja sprowadza się do wgrania plików modułu do odpowiedniego katalogu addons w instalacji WHMCS a nastepnie aktywacji pluginu. 

Instalacja wymaga podstawowej wiedzy. Jeśli jesteś użytkownikiem WHMCS i nie masz dostępu do serwera gdzie zainstalowany jest WHMCS nie uda ci się zainstalować modułu. 

Wymagany jest dostęp do terminala serwera z instalacją WHMCS lub możliwość wgrania plików przez FTP.

Uwaga!!! Przypominamy - dla poprawnego działania modułu jest potrzebny serwer/konto WebDAV od NextCloud. Brak zapewniania tego warunku uniemożliwia korzystanie z systemu.

Pliki PDF są magazynowane na serwerze NextCloud i katalogowane po rodzaju oraz daty dokumentu (data wprowadzona w dokumencie przykład: data otrzymania faktury)

Aby zainstalować moduł należy skopiować folder modułu do folderu „modules/addons” systemu WHMCS.

git clone https://github.com/PUQ-sp-z-o-o/puq_commitments_forecaster.git
cp -r puq_commitments_forecaster WHMCS_DIR/modules/addons

lub

wget https://cf.puq.info/whmcs-module/puq_cf_WHMCS-latest.tar.gz
tar -xzvf puq_cf_WHMCS-latest.tar.gz
cp -r puq_commitments_forecaster WHMCS_DIR/modules/addons/

 

Jak zacząć używać

Aktywacja

W panelu administratora systemu WHMCS przejrzeć do:

System Settings -> Addons Modules

Aktywuj moduł, klikając przycisk "Activate" w module "Commitments forecaster".

 

2021-11-03_16-43.png

 

Aktywacja modułu automatycznie tworzy tabele w bazie danych WHMCS posiadających prefiks "puq_"

 

Jak zacząć używać

Dezaktywacja

Uwaga!!!
Dezaktywacja modułu powoduje automatyczne usunięcie tabel w bazie danych powiązanych z tym modułem.

 

W panelu administratora systemu WHMCS przejrzeć do:

Dezaktywuj moduł, klikając przycisk "Deactivate" w module "Commitments forecaster".

2021-11-03_16-44.png

Jak zacząć używać

Konfiguracja parametrów modułu

 

W panelu administratora systemu WHMCS przejrzeć do:

System Settings -> Addons Modules -> Commitments forecaster

Kliknij przycisk "Configure"

2021-11-04_18-10.png

Wprowadź dane logowania do serwera NextCloud:

WebDAV URL HTTPS:// - {SERWER}/remote.php/dav/files/{USER}/
Uwaga: link bez "https://" oraz na końcu "/"
WebDAV user
WebDAV password
Access Control - zaznacz grupy użytkowników które muszą mieć dostęp do modułu.

2021-11-03_16-47.png

Po wprowadzeniu wszystkich danych kliknij przycisk "Save Changes"

 

Kontrahenci

Kontrahenci

Dodawanie kontrahenta

Aby dodać kontrahenta przejdź do pozycji menu Kontrahenci i kliknij pozycję Dodaj kontrahenta.

2021-11-04_19-12.png

Po wypełnieniu formularza kliknij przycisk "Zapisz"

Uwaga! Po utworzeniu kontrahenta nie będzie można zmienić "Nazwa firmy" i numer "NIP".

Jeżeli z jakiegoś powodu kontrahent zmienił swoją nazwę i numer NIP, to konieczne jest utworzenie nowego kontrahenta w systemie.

 

Kontrahenci

Edycja kontrahenta

Aby wyświetlić listę wszystkich kontrahentów, przejdź do menu "Kontrahenci" i kliknij "Lista kontrahentów".

Klikając na kontrahenta otworzy się formularz z informacjami o kontrahencie, a także możliwością zmiany jego danych.

2021-11-04_19-23.png

Po wypełnieniu formularza kliknij przycisk "Zapisz"

Uwaga! Po utworzeniu kontrahenta nie będzie można zmienić "Nazwa firmy" i numer "NIP".
Jeżeli z jakiegoś powodu kontrahent zmienił swoją nazwę i numer NIP, to konieczne jest utworzenie nowego kontrahenta w systemie.

Kontrahenci

Informacje zawarte w profilu kontrahenta.

Profil kontrahenta zawiera informacje takie jak:

2021-11-04_19-33.png


 

Lista faktur

2021-11-04_19-34.png


Lista umów2021-11-04_19-35.png

Lista zobowiązań

2021-11-04_19-38.png

Zobowiązania

Zobowiązania

Dodawanie zobowiązania

Aby dodać zobowiązanie, przejdź do pozycji menu "Zobowiązania" i kliknij "Dodaj zobowiązanie".

2021-11-04_19-44.png

Po wypełnieniu formularza kliknij przycisk "Zapisz"

 

Zobowiązania

Edycja zobowiązania

Aby wyświetlić listę wszystkich zobowiązań, przejdź do menu "Zobowiązania" i kliknij "Lista zobowiązań".

Klikając na zobowiązanie otworzy się formularz z informacjami o zobowiązaniu, a także możliwością zmiany danych.

2021-11-04_19-52.png

Po wypełnieniu formularza kliknij przycisk "Zapisz"

 

 

Dokumenty

Dokumenty

Dodawanie dokumentu

Dokumenty można dodawać na kilka sposobów:

  1. Możemy skorzystać z opcji masowego wgrania i wgrać kilka, kilkanaście plików na raz jako dokumenty niesklasyfikowane aby je potem opisać poprawnie
  2. dodawać bezpośrednio z okna kontrahenta.

Dokument które nie są sklasyfikowane i oczekują na klasyfikację w zakładce "Lista niesklasyfikowanych" nie są w żaden sposób przetwarzane przez system i nie biorą udziału w podsumowaniach, raportach. Usuwanie ich w żaden sposób nie wpływa na wartości zapisane w systemie.

Dokument musi być dopięty do kontrahenta aby był analizowany przez system i był widoczny w raportach i innych podsumowaniach.

Przejdź do pozycji menu Dokumenty i kliknij pozycję Dodaj dokument. 

Wybierz żądanego kontrahenta z listy kontrahentów i kliknij przycisk Dodaj dokument.

2021-11-05_10-20.png

Następnie musisz wybrać plik i sklasyfikować go. 

W końcu trzeba kliknąć przycisk Zapisz.

2021-11-05_10-23.png

 

Dokumenty

Masowe wgrywanie plików PDF

System zapewnia możliwość zbiorczego przesyłania plików PDF do systemu.

Masowe wgrywanie plików pomaga w codziennej pracy z systemem.

Proszę pamiętać o 2 kwestiach:

Dokument które nie są sklasyfikowane i oczekują na klasyfikację w zakładce "Lista niesklasyfikowanych" nie są w żaden sposób przetwarzane przez system i nie biorą udziału w podsumowaniach, raportach. Usuwanie ich w żaden sposób nie wpływa na wartości zapisane w systemie.

Dokument musi być dopięty do kontrahenta aby był analizowany przez system i był widoczny w raportach i innych podsumowaniach.

Aby skorzystać z tej funkcjonalności:

I. Przejdź do pozycji menu Dokumenty i kliknij pozycję Lista niesklasyfikowanych.