Specyfikacja funkcjonalna aplikacji
Audyt zwrotów Allegro × Base
Dokument do weryfikacji, czy aplikacja działa dokładnie zgodnie z procesem biznesowym.
Zakres MVP: Allegro Polska • zamówienia opłacone z góry • ręczne uruchamianie kontroli
1. Cel aplikacji
Aplikacja ma zastąpić ręczne, codzienne sprawdzanie, czy dla zwrotów środków wykonanych na Allegro została prawidłowo wystawiona faktura korygująca w Base oraz czy jej wartość odpowiada wartości zwrotu.
Najważniejsza zasada kontrolna:
wartość korekty w Base = kwota zwrócona na Allegro
Aplikacja pełni funkcję kontrolną. Nie wystawia korekt, nie zleca zwrotów, nie zmienia zamówień i nie zapisuje danych do Allegro ani Base.
2. Zakres pierwszej wersji
Do kontroli wchodzą wyłącznie zamówienia spełniające jednocześnie następujące warunki:
- źródło zamówienia: Allegro,
- rynek / dostawa: Polska,
- waluta: PLN,
- płatność: z góry,
- dla zamówienia wystąpił zwrot środków w Allegro w wybranym dniu.
Poza zakresem MVP: zagraniczne Allegro i zagraniczne zamówienia za pobraniem. Ten moduł będzie można dołożyć później.
3. Sposób uruchamiania
Kontrola nie uruchamia się automatycznie. Użytkownik sam decyduje, kiedy ją wykonać.
Krok 1
Wybór datyDomyślnie bieżący dzień.Krok 2
Kliknięcie „Sprawdź zwroty”Ręczne rozpoczęcie audytu.Krok 3
Pobranie danychAllegro + Base.Krok 4
RaportOK i wszystkie wykryte niezgodności.
4. Proces kontroli krok po kroku
- Aplikacja pobiera z Allegro wszystkie zwroty płatności z wybranego dnia.
- Zwroty są grupowane według numeru / ID zamówienia Allegro.
- Jeżeli do jednego zamówienia wykonano kilka zwrotów, ich kwoty są sumowane.
- Aplikacja odnajduje odpowiadające zamówienie w Base po zewnętrznym ID zamówienia Allegro.
- Sprawdza, czy zamówienie należy do zakresu MVP: Allegro, Polska, PLN, płatność z góry.
- Pobiera dokumenty sprzedażowe powiązane z zamówieniem.
- Wyszukuje fakturę lub faktury korygujące.
- Ustala łączną wartość korekty do porównania.
- Porównuje łączną wartość korekty z łączną wartością zwrotu w Allegro.
- Nadaje wynik audytu i pokazuje go w panelu.
5. Reguły porównania kwot
| Allegro – zwrot |
Base – korekta |
Wynik |
| 129,99 zł | 129,99 zł | POPRAWNIE |
| 129,99 zł | 119,99 zł | BŁĘDNA KWOTA różnica 10,00 zł |
| 129,99 zł | brak korekty | BRAK KOREKTY |
| 50,00 + 30,00 zł | 80,00 zł | POPRAWNIE |
| 50,00 + 30,00 zł | 50,00 zł | BŁĘDNA KWOTA brak 30,00 zł |
Aplikacja nie wylicza wartości korekty na podstawie faktury pierwotnej. Przyjmuje kwotę korekty zapisaną / pokazywaną w Base i porównuje ją bezpośrednio z kwotą zwrotu Allegro.
6. Statusy, które aplikacja powinna pokazywać
| Status | Znaczenie | Reakcja użytkownika |
|---|
| POPRAWNIE |
Korekta istnieje i jej wartość zgadza się ze zwrotem Allegro. |
Brak działania. |
| BRAK KOREKTY |
Dla zwrotu nie znaleziono faktury korygującej. |
Sprawdzić zamówienie i wystawienie korekty. |
| BŁĘDNA KWOTA |
Korekta istnieje, ale kwota nie odpowiada zwrotowi Allegro. |
Sprawdzić korektę i/lub zwrot. |
| ZWROT W TOKU |
Zwrot został zlecony, ale Allegro nie zakończyło jeszcze operacji. |
Zweryfikować po zakończeniu zwrotu. |
| ZWROT ANULOWANY |
Zwrot nie został skutecznie wykonany. |
Sprawdzić przyczynę i ewentualnie zlecić ponownie poza aplikacją. |
| BRAK ZAMÓWIENIA W BASE |
Aplikacja nie potrafi dopasować zamówienia Allegro do rekordu w Base. |
Sprawdzić synchronizację / ID zamówienia. |
| DO RĘCZNEJ KONTROLI |
Nietypowy przypadek, np. mieszane statusy kilku zwrotów. |
Sprawdzić szczegóły rekordu. |
7. Informacje widoczne w raporcie
Dla każdego kontrolowanego zamówienia użytkownik powinien widzieć co najmniej:
- ID / numer zamówienia Allegro,
- ID / numer zamówienia Base,
- datę zwrotu,
- status zwrotu Allegro,
- kwotę zwróconą na Allegro,
- numer faktury pierwotnej, jeżeli jest dostępny,
- numer faktury korygującej,
- wartość faktury korygującej w Base,
- różnicę kwot, jeżeli występuje,
- wynik końcowy kontroli.
Panel powinien umożliwiać wyświetlenie tylko problemów, aby użytkownik nie musiał analizować poprawnych zamówień.
8. Obsługa wielu zwrotów i wielu korekt
Jeżeli w wybranym dniu do jednego zamówienia wystąpi więcej niż jeden zwrot Allegro, aplikacja traktuje je jako jeden przypadek audytowy i sumuje wartości.
Przykład:
Zwrot nr 1: 50,00 zł
Zwrot nr 2: 30,00 zł
Łączny zwrot Allegro: 80,00 zł
Korekta / korekty w Base muszą łącznie dawać 80,00 zł.
9. Data korekty
Aplikacja może pracować w dwóch trybach:
- Tryb rygorystyczny: kontrolowane są korekty wystawione w dniu zwrotu.
- Tryb rozszerzony: jeżeli w dniu zwrotu nie ma korekty, aplikacja może poszukać korekty z innego dnia i dopasować ją po kwocie / zamówieniu.
Domyślnie zalecany jest tryb rygorystyczny, ponieważ najlepiej odpowiada kontroli wykonywanej na koniec dnia.
10. Integracja z Allegro
Aplikacja korzysta z API Allegro wyłącznie do odczytu informacji potrzebnych do audytu.
Wymagane / zalecane uprawnienia aplikacji Allegro:
allegro:api:payments:read – odczyt historii płatności i zwrotów,allegro:api:orders:read – odczyt informacji o zamówieniach.
Nie jest potrzebne allegro:api:payments:write, ponieważ aplikacja nie wykonuje zwrotów.
11. Integracja z Base
Base jest wykorzystywany do:
- odnalezienia zamówienia po zewnętrznym ID Allegro,
- sprawdzenia kraju, waluty i sposobu płatności,
- pobrania dokumentów sprzedażowych,
- odczytu faktur korygujących i ich wartości.
Token API Base jest przechowywany lokalnie w konfiguracji aplikacji.
12. Bezpieczeństwo i ograniczenia
- Aplikacja działa lokalnie na komputerze użytkownika.
- Nie wysyła tokenów integracji do zewnętrznego serwera aplikacji.
- Nie zmienia danych w Allegro ani Base.
- Nie wykonuje automatycznych zwrotów.
- Nie wystawia faktur ani korekt.
- Wyniki kontroli mogą być zapisane lokalnie i eksportowane do CSV.
13. Scenariusze testowe do walidacji aplikacji
| # |
Przypadek |
Oczekiwany wynik |
| 1 | Zwrot 100 zł, korekta 100 zł | POPRAWNIE |
| 2 | Zwrot 100 zł, brak korekty | BRAK KOREKTY |
| 3 | Zwrot 100 zł, korekta 90 zł | BŁĘDNA KWOTA, różnica 10 zł |
| 4 | Dwa zwroty: 60 zł + 40 zł, korekta 100 zł | POPRAWNIE |
| 5 | Dwa zwroty: 60 zł + 40 zł, korekta 60 zł | BŁĘDNA KWOTA, różnica 40 zł |
| 6 | Zwrot ma status w toku | ZWROT W TOKU |
| 7 | Zwrot anulowany | ZWROT ANULOWANY |
| 8 | Zamówienie Allegro nie występuje w Base | BRAK ZAMÓWIENIA W BASE |
| 9 | Zamówienie PL za pobraniem | POMINIĘTE – poza zakresem MVP |
| 10 | Zamówienie zagraniczne | POMINIĘTE – poza zakresem MVP |
15. Kryterium odbioru aplikacji
Aplikację można uznać za działającą poprawnie, jeżeli dla zestawu rzeczywistych zamówień wynik automatycznego audytu jest zgodny z ręczną kontrolą użytkownika, szczególnie w zakresie:
istnienia korekty, wartości korekty oraz wartości zwrotu Allegro.
16. Rozwój w kolejnym etapie
- Allegro zagraniczne,
- zamówienia zagraniczne za pobraniem,
- dodatkowe reguły kontroli,
- opcjonalne powiadomienia,
- opcjonalna automatyzacja uruchamiania audytu.