Name – Nazwa program lojalnościowego
SettleDocumentsValue – flaga bitowa określająca na jakich dokumentach bierze udział program lojalnościowy
- Typy dokumentów i wartości
- 1 –OS
- 2 –ZS
- 4 – FS
- 8 – PA
- 16 – WZ
- 32 – WM
- Wartość pola 5 oznaczać będzie, że rozliczenie punktów dostępne będzie na dokumentach OS i FS (1+4).
CheckContractorStatusQuery – Zapytanie sprawdzające czy dany kontrahent bierze udział w programie lojalnościowym oraz zwraca liczbę punktów dostępnych dla kontrahenta. Zwrócenie wiersza oznacza, że kontrahent bierze udział w programie lojalnościowym. Parametry wejściowe:
- @DocumentType – typ dokumentu. Wartość zgodna z wartościami z punktu drugiego.
- @ContractorId – identyfikator kontrahenta
- @LoyaltyProgramId – identyfikator programu lojalnościowego
- @EditedDocumentId – identyfikator dokumentu, który jest teraz aktualnie reedytowany (został tylko zapisany wcześniej, został cofnięty do bufora)
- Kolumny wyjściowe
- Liczba punktów dostępnych do zużycia przez kontrahenta
CheckArticleStatusQuery – Zapytanie sprawdzające czy dany towar jest dostępny w danym programie lojalnościowym oraz zwraca liczbę punktów do rozliczenia na pozycji. Parametry wejściowe:
- @ArticleId – identyfikator towaru na który wystawiana jest pozycja
- @StartGrossPrice – początkowa cena brutto
- @StartNetPrice – początkowa cena netto
- @Quantity – ilość w jednostce bazowej
- @AvailablePoints – liczba dostępnych punktów kontrahenta
- @EditedDocumentId – identyfikator edytowanego dokumentu
- @VatRate – stawka VAT (np. dla 23% – parametr ten będzie miał wartość 23)
- @VatDirection – kierunek VAT (0 – Netto, 1 – Brutto)
- Kolumny wyjściowe
- MaxPointsToSettleValue – maksymalna liczba punktów możliwa do rozliczenia na pozycji
- EndGrossPrice – końcowa cena brutto na pozycji po rozliczeniu punktów MaxPointsToSettleValue
InitialMessageQuery – Zapytanie tworzące komunikat powitalny. Parametry wejściowe:
- @DocumentType – typ dokumentu. Wartość zgodna z wartościami z punktu drugiego.
- @ContractorId – identyfikator kontrahenta
- @LoyaltyProgramId – identyfikator programu lojalnościowego
- @EditedDocumentId – identyfikator dokumentu, który jest teraz aktualnie reedytowany (został tylko zapisany wcześniej, został cofnięty do bufora)
- Kolumny wyjściowe
- InitialMessageText – komunikat powitalny. Może zawierać proste tagi html’owe w celu sformatowania tekstu. (np. Dodanie nowej linii <br />, Zmiana koloru fragmentu tekstu <font color=”#FF0000″></font>, itd.)
AfterRemovePositionLoyaltyProgramQuery – Zapytanie wykonywane po usunięciu rozliczenia programu lojalnościowego na pozycji. Służy do wycofania zmian wykonanych w AfterAddPositionLoyaltyProgramQuery. Parametry wejściowe:
- @LoyaltyProgramId – identyfikator programu lojalnościowego
- @ProgramName – nazwa programu lojalnościowego
- @AttributeObjectType – typ atrybutów dla pozycji
- @ObjectId – identyfikator dokumentu
- @ObjectIsLocal – identyfikator dokumentu
- @ObjectSubId – identyfikator pozycji
- @ObjectSubIsLocal – identyfikator pozycji
- Obsługiwane jest wiele zapytań w ramach tej samej definicji. Separator skryptów „;GO;”
AfterAddPositionLoyaltyProgramQuery – Zapytanie wykonywane po zapisie dokumentu – dla każdej pozycji, która zostaje rozliczona za pomocą programu lojalnościowego. Parametry wejściowe:
- @LoyaltyProgramId
- @ProgramName
- @SettledPoints
- @AttributeObjectType
- @ObjectId
- @ObjectIsLocal
- @ObjectSubId
- @ObjectSubIsLocal
- @StartGrossPrice – cena początkowa brutto
- @StartNetPrice – cena początkowa netto
- @StartGrossValue – wartość brutto
- @StartNetValue – wartość netto
- Obsługiwane jest wiele zapytań w ramach tej samej definicji. Separator skryptów „;GO;”
AfterRemoveDocumentLoyaltyProgramQuery – Zapytanie wykonywane po usunięciu rozliczenia programu lojalnościowego z dokumentu. Służy do wycofywania zmian wykonanych w AfterAddDocumentLoyaltyProgramQuery. Parametry wejściowe:
- @LoyaltyProgramId
- @ProgramName
- @SettledPoints
- @AttributeObjectType
- @ObjectId
- @ObjectIsLocal
- @ObjectSubId
- @ObjectSubIsLocal
- Obsługiwane jest wiele zapytań w ramach tej samej definicji. Separator skryptów „;GO;”
AfterAddDocumentLoyaltyProgramQuery – Zapytanie wykonywane po zapisie dokumentu z rozliczeniem programu lojalnościowego. Parametry wejściowe:
- @LoyaltyProgramId
- @ProgramName
- @SettledPoints
- @AttributeObjectType
- @ObjectId
- @ObjectIsLocal
- @ObjectSubId
- @ObjectSubIsLocal
- Obsługiwane jest wiele zapytań w ramach tej samej definicji. Separator skryptów „;GO;”