Rodzaje bonów

Aplikacja Rodzaje bonów pochodzi z modułu Sprzedaż wielokanałowa systemu Comarch ERP Enterprise. Aplikacja umożliwia definiowanie szablonów (rodzajów) bonów, które są wykorzystywane przy tworzeniu pojedynczych bonów. Rodzaj bonu determinuje domyślne ustawienia i zachowanie wszystkich bonów utworzonych na jego podstawie, co zapewnia spójność konfiguracji i zmniejsza nakład pracy potrzebny do założenia każdego bonu.

Dane wprowadzone w rodzaju bony są wykorzystywane między innymi w aplikacjach Bony, Lista: Bony oraz Eksport bonów. Konfiguracja rodzaju bonu jest również przekazywana do systemów zewnętrznych (Comarch POS, Cloud) za pośrednictwem aplikacji eksportujących.

Opis aplikacji

Aplikacja składa się z nagłówka oraz obszaru roboczego podzielonego na zakładki. Część pól w nagłówku oraz w zakładkach uzależniona jest od konfiguracji innych pól (np. od oznaczenia bonu jako zewnętrznego) – pola niedostępne są wyszarzone lub ukryte.

Nagłówek

W nagłówku aplikacji znajdują się pola identyfikujące rodzaj bonu oraz jego podstawowe parametry biznesowe. Pola w nagłówku:

• Rodzaj – trzyznakowy kod jednoznacznie identyfikujący rodzaj bonu w systemie. Pole obowiązkowe, edytowalne wyłącznie przed pierwszym zapisem rodzaju. Po utworzeniu pierwszego bonu na podstawie tego rodzaju zmiana kodu nie jest możliwa.
• Długość numerów – liczba całkowita określająca długość numerów bonów generowanych dla tego rodzaju. Pole obowiązkowe. Wartość musi być większa od zera i nie większa niż 50.
• Prefiks – opcjonalne pole, pozwalające określić prefiks dla numerów bonów. Prefiks może zawierać tylko wielkie litery, numery oraz niektóre znaki (na przykład myślnik)
• Sufiks – opcjonalne pole, pozwalające określić sufiks dla numerów bonów. Sufiks może zawierać tylko wielkie litery, numery oraz niektóre znaki (na przykład myślnik)
• Regex – parametr typu tekstowego pozwalający na bezpośrednie zdefiniowanie wyrażenia regularnego identyfikującego bonu tego rodzaju. Jeżeli pole jest wypełnione, adapter wykorzystuje wprowadzoną wartość. Jeżeli pole jest puste, adapter POS buduje wyrażenie regex na podstawie pól Prefiks, Długość numeru i Sufiks. Pole jest dostępne, jeśli parametr Zewnętrzny jest zaznaczony.
• Artykuł – artykuł reprezentujący bon na dokumentach sprzedaży. Bon nie może zostać bezpośrednio dodany jako pozycja na dokumencie – jest reprezentowana przez powiązany artykuł. Pole obowiązkowe dla bonów wewnętrznych. Po utworzeniu pierwszego bonu na podstawie tego rodzaju zmiana artykułu nie jest możliwa.
• Opis – krótki opis rodzaju bonu
• Pełna nazwa– długi opis rodzaju bonu. Pełny opis może pełnić rolę tekstu domyślnego nadrukowywanego na bonowi (np. „Karta może zostać wykorzystana wyłącznie na artykuły z 21% VAT”).
• Właściwa organizacja – organizacja odpowiedzialna za rodzaj bonu. Domyślną wartością jest aktualnie wybrana organizacja. Organizacja musi być zgodna z organizacją odpowiedzialną przypisaną do artykułu reprezentującego rodzaj bonu. Po utworzeniu pierwszego bonu na podstawie tego rodzaju zmiana organizacji nie jest możliwa.
• Kwota bonu – wartość pieniężna bonu (kwota i waluta), która zostanie wstępnie ustawiona na każdym bonie utworzonym w tym rodzaju. Wartość 0 oznacza, że bon nie ma wartości domyślnej i jego wartość jest ustalana w procesie sprzedaży. Domyślną walutą jest waluta wiodąca pobierana z Konfiguracji. Waluta musi odpowiadać walucie wewnętrznej organizacji przetwarzającej dane bonu.
• Zewnętrzny – parametr typu logicznego określający, czy bon jest wystawiany przez system Comarch ERP Enterprise (parametr odznaczony – bon wewnętrzny), czy też przez podmiot zewnętrzny (parametr zaznaczony – bon zewnętrzny). Dla bonu zewnętrznego system pełni jedynie rolę śledzącą i nie odpowiada za walidację bonu. Wartość pola po pierwszym zapisie nie może zostać zmieniona.
• Przyporządkowana organizacja – lista organizacji, w których bonu tego rodzaju mogą zostać sprzedane i zrealizowane. Pole obsługuje wybór wielu wartości za pomocą przycisku rombu. Pole obowiązkowe.
• Generowanie numeru bonu przez adapter – po zaznaczeniu pola nowy numer bonu jest tworzony przez adapter w momencie sprzedaży bonu. Działanie zależy również od pola Do sprzedaży w sklepie stacjonarnym (offline): gdy oba pola są odznaczone, adapter musi najpierw zlecić systemowi CEE weryfikację wprowadzonego numeru; gdy oba są zaznaczone, adapter tworzy numer bonu bez weryfikacji CEE; gdy zaznaczone jest tylko pole sprzedaży w sklepie stacjonarnym, numer można wprowadzić bezpośrednio z bonu papierowego bez weryfikacji CEE. Pole jest edytowalne wyłącznie, gdy pole Zewnętrzny ma wartość Nie, a pole sprzedaży w sklepie stacjonarnym ma wartość Tak, i tylko dopóki rodzaj bonu nie został zapisany po raz pierwszy.
• Stałe znaki identyfikacji miejsca utworzenia – liczba znaków zarezerwowanych w numerze bonu na identyfikator miejsca utworzenia (kanału sprzedaży lub terminala POS). Pole wypełniane automatycznie wartością z Konfiguracji (parametr Stałe znaki dla numeru bonu w funkcji Ogólne) podczas pierwszego zapisu rodzaju, gdy zaznaczony jest parametr Generowanie numeru bonu przez adapter. Pole nie jest edytowalne. Po pierwszym zapisie wartość nie podlega aktualizacji.
• Aktywne – parametr informujący, czy rodzaj bonu może być wykorzystywany przez adaptery do tworzenia nowych bonów. Wartość ustawiana automatycznie przez system na podstawie zgodności konfiguracji pola Stałe znaki identyfikacji miejsca utworzenia z najwyższym identyfikatorem kanału sprzedaży lub terminala POS. Wartość domyślna: Aktywne. Pole nie jest edytowalne i nie może zostać zmienione przez import BIS.

Obszar roboczy

Obszar roboczy aplikacji podzielony jest na zakładki grupujące parametry rodzaju bonu według ich przeznaczenia: parametry ogólne sposobu użycia oraz parametry księgowe.

Zakładka Ogólne

Zakładka Ogólne zawiera parametry definiujące sposób użytkowania bonów tego rodzaju w procesie sprzedaży i realizacji.

• Zastosowanie – definiuje, czy bonu tego rodzaju mogą zostać wykorzystane jednorazowo, czy też wielokrotnie. Dostępne wartości: Jednorazowego użytku (bon jest realizowany w całości na jednym dokumencie) oraz Wielokrotnego użytku (bon może być realizowany częściowo na wielu dokumentach do wyczerpania salda). Po utworzeniu pierwszego bonu na podstawie tego rodzaju zmiana sposobu użycia nie jest możliwa.
• Okres obowiązywania w dniach – liczba dni, przez którą bon jest ważny, licząc od dnia sprzedaży. Wartość 0 oznacza, że bon nie ma daty ważności (jest ważny bezterminowo). Wartość musi być większa lub równa 0.
• Środki możliwe do doładowania – parametr określa, czy możliwe jest dodanie środków do bonu po jego pierwszym zakupie. Pole jest informacją przekazywaną do adapterów.
• Zezwalaj na zwrot gotówki – pole określa, czy dla danego rodzaju bonu dozwolony jest zwrot gotówki. Pole jest dostępne i edytowalne, a jego wartość można zmieniać również wtedy, gdy istnieją bony tego rodzaju. Wartość domyślna: Nie. Pole nie jest edytowalne, gdy zaznaczone jest pole Limit użycia
• Do sprzedaży w sklepie stacjonarnym – definiuje, czy bon może zostać sprzedany w trybie offline na stanowisku POS. Pole jest informacją przekazywaną do adapterów.
• Do realizacji w sklepie stacjonarnym – definiuje, czy bon może zostać realizowany w trybie offline na stanowisku POS. Pole jest informacją przekazywaną do adapterów.
• Spersonalizowane – określa, czy bony tego rodzaju są przypisywane do konkretnego klienta. Dla bonów spersonalizowanych obowiązkowe jest wskazanie klienta (partnera o roli Klient) podczas tworzenia bonu. Realizacja bonu spersonalizowanego przez innego klienta podlega kontroli zgodnie z parametrem Realizuj bon przez innego klienta w Konfiguracji (Sprzedaż wielokanałowa, funkcja Ogólne).
• Można stosować przez x dni po dacie obowiązywania – liczba dni, w trakcie których bon jest akceptowany po upływie oficjalnego okresu ważności. Pole edytowalne wyłącznie, gdy zaznaczone jest pole Limit użycia (dla bonów żywieniowych) lub Bon usługowy. Wartość domyślna: 0. Dopuszczalne są wartości będące dodatnimi liczbami całkowitymi. Jeżeli pole Limit wykorzystania zostanie odznaczone, wartość zostaje przywrócona do 0.
• Limit użycia – parametr typu logicznego oznaczający, że bon zewnętrzny jest bonem żywieniowym z limitem wartości i ograniczeniem do określonych artykułów. Pole jest edytowalne, gdy zaznaczono parametr Zewnętrzny. Po eksporcie rodzaju bonu do systemu zewnętrznego (Comarch POS) parametr nie jest edytowalny. Jeżeli pole Zewnętrzny jest odznaczone, pole zostaje przywrócone do wartości domyślnej. Zaznaczenie parametru blokuje edycję pól Zezwalaj na zwrot gotówki oraz Okres obowiązywania w dniach.
• Bon usługowy – parametr typu logicznego oznaczający, że bon zewnętrzny jest bonem usługowym (np. bon socjalny wystawiany przez podmioty publiczne). Pole jest dostępne wyłącznie dla bonów zewnętrznych. Zaznaczenie parametru umożliwia wykorzystanie pola Można stosować przez x dni po dacie obowiązywania.
• Kod wystawcy (Emitter code) – kod wystawcy bonu zgodny ze strukturą numeru GS1-128. Pole edytowalne wyłącznie, gdy zaznaczone są parametry Zewnętrzny oraz Aktywne. Dozwolone są wyłącznie cyfry o długości od 6 do 12 cyfr. Po utworzeniu pierwszego bonu na podstawie tego rodzaju zmiana wartości nie jest możliwa. Pole może być ustawiane za pomocą BIS.
• Kontrola sprzedaży nie jest wymagana – parametr decydujący, czy bon tego rodzaju musi zostać sprzedany przed jej realizacją. Wartość domyślna: parametr odznaczony – bon musi być sprzedany przed realizacją. Po zaznaczeniu walidacja sprzedaży przed realizacją zostaje pominięta. Pole edytowalne wyłącznie dla bonów wewnętrznych. Dla bonów zewnętrznych kontrola sprzedaży nie jest wykonywana niezależnie od ustawienia tego parametru.

Zakładka Rachunkowość

Zakładka Rachunkowość zawiera parametry dotyczące rozliczeń podatkowych i księgowych sprzedaży oraz realizacji bonów.

• Zastosowanie – pole określa model rozliczenia podatku VAT dla bonów danego rodzaju. Decyduje o tym, w którym momencie naliczany jest podatek. Dostępne wartości:
  • Różnego przeznaczenia – bon może zostać zrealizowany na zakup artykułu o dowolnej stawce VAT. Podatek nie jest naliczany w chwili sprzedaży bonu, lecz dopiero w momencie jego realizacji, przy dostawie towaru lub usługi.
  • Jednego przeznaczenia – bon może zostać użyty wyłącznie na zakup artykułów o jednej, określonej stawce VAT. Podatek jest naliczany już w chwili sprzedaży bonu, a nie podczas jego realizacji.

Pole jest widoczne, ale niedostępne do edycji – przyjmuje stałą wartość Różnego przeznaczenia.

Współpraca z adapterami

Bony są wymieniane między systemem a adapterami za pośrednictwem aplikacji Eksport bonów oraz webserwisów i interfejsów BIS. Sposób obsługi bonu może różnić się w zależności od adaptera.

Comarch POS

Adapter Comarch POS obsługuje pełen cykl życia bonu wewnętrznego.

Informacje na temat obsługi bonów w Comarch POS można znaleźć w dokumencie Obsługa bonów.

Cloud

Adapter Cloud udostępnia webserwis com.sem.ext.app.mcs.loyalty.giftcard.rest.GiftCardsService obsługujący tworzenie i realizację bonów w sklepach internetowych. W zakresie obsługiwanym przez adapter:

• sklep internetowy wywołuje webserwis żądający utworzenia nowego bonu (lub kilku bonów) podając rodzaj bonu oraz opcjonalnie wartość i okres ważności; jeżeli wartość lub okres ważności nie są podane, używane są wartości domyślne z rodzaju bonu
• po utworzeniu bonu webserwis zwraca numer bonu oraz jej status (początkowo Utworzony)
• bon może zostać aktywowany w dowolnym momencie po jej utworzeniu (np. po potwierdzeniu płatności) za pomocą metody activateGiftCard – status zmienia się z Utworzony na Aktywne
• przy dodaniu bonu do koszyka sklep internetowy może opcjonalnie wywołać webserwis weryfikujący ważność bonu i jej dostępne saldo
• przed potwierdzeniem zamówienia sklep wykonuje obowiązkową weryfikację bonu – blokuje to wykorzystanie tej samego bonu równolegle w innym kanale
• po potwierdzeniu płatności sklep przekazuje numer bonu oraz wykorzystaną kwotę; system aktualizuje saldo bonu i jeżeli saldo wyniesie zero, automatycznie zmienia status bonu na Nieaktywne

REST

Ścieżka bazowa: com.sem.ext.app.mcs.loyalty.giftcard.rest.GiftCardsService

Wszystkie punkty końcowe: POST,

Format danych wejściowych i wyjściowych: application/json

Dostępne metody:

• POST /createGiftCards

Tworzy jeden lub więcej bonów.

Treść żądania: List<GiftCardCreateData> (tablica JSON).

Pole wymagane: rodzaj. Pola opcjonalne: wartość, data ważności od, data ważności do, klient.

• POST /isGiftCardValid

Zwraca aktualny stan istniejącego bonu.

Treść żądania: pojedynczy obiekt GiftCardData

Pola wymagane: numer, rodzaj..

• POST /redeemGiftCard

Pobiera kwotę z aktywnego bonu i zapisuje wpis w historii.

Treść żądania: GiftCardData

Pola wymagane: numer, rodzaj, kwota. Pole opcjonalne: documentData.

• POST /activateGiftCard

Zmienia status karty podarunkowej z CREATED na ACTIVE.

Treść żądania: GiftCardData

Pola wymagane: numer, rodzaj.