company logo

Help Center

Sapera
All collectionsIntegrationsSyncToolAction: Gift card settlement

Action: Gift card settlement

Settles gift cards redeemed across organizational units by creating matching sales invoices and purchase invoices between the selling and redeeming units.

Settles gift cards redeemed across organizational units by creating matching sales invoices and purchase invoices between the selling and redeeming units.

How to use the action

The action runs as a step in a SyncTool configuration. You configure the step's settings (e.g. server, login, path, format or SQL depending on the action) and run the configuration. The action fetches the data it needs from Sapera or the external source itself – you do not map source columns as you would for a regular import. Any parameters are described below.

How the action works

The action reconciles gift cards that were sold in one department and redeemed in another: it creates matching sales and purchase invoices between the selling and the redeeming department, so the value ends up in the right place.

  • Direction: creates invoices between the departments in Sapera.

  • Line format: every redeemed gift card becomes one priced line on the document.

  • Settlement key: the key lives in the document’s subject. Settlements created before the key moved there carry it in the requisition number and still count as settled, so an old month is not invoiced twice.

Key parameters

Parameter

Explanation

CreatePurchaseInvoice

Also creates the matching purchase invoice in the department mapped through OuCustomerMapping. Off by default, so only the sales invoice is created; turn it on to create both documents.

DiscountPct

A percentage discount applied to every settlement line on both the sales invoice and the purchase invoice. Give it as a number between 0 and 100; both 2.5 and 2,5 are accepted. Blank or 0 means no discount, and a value outside 0-100 stops the step rather than settling at full price. The discount is calculated and rounded per line, so a document’s lines and its total agree.

ExemptVat

Marks the settlement lines as exempt from VAT, and is on by default: a gift card is not a supply in itself, and the redeeming department has already accounted for the VAT on the sale to the customer, so the settlement only moves the money. Turn it off when the settlement is a real supply between two separate legal entities - the line then follows the VAT type on the account behind the invoice product.

InvoiceProduct

Identifier of the product used for the settlement amount line.

OptionalFromDate

Optional start date limiting which gift card withdrawals are settled.

OptionalToDate

Optional end date limiting which gift card withdrawals are settled.

OuCustomerMapping

Maps each selling organizational unit to the customer identifier used on the settlement invoice.

OuSupplierMapping

Maps each redeeming organizational unit to the supplier identifier used on the settlement purchase invoice.

TextProduct

Identifier of the product used for the descriptive text lines.


See also the overview SyncTool – actions.

On settlement lines for vouchers and refund coupons, the original amount is now shown next to the amount withdrawn.


Want to know more?

Read more in these related articles:

Standard parameters for all actions

The general parameters available on most SyncTool actions: step control, error handling, timeout, etc.

Did this answer your question?
😞
😐
😁