Overview
This document outlines the configuration for automatically synchronizing Transaction records from the Clover Transaction entity to the iPaaS Transaction entity. The integration uses an API-based sync that triggers whenever a Transaction record is created or updated in Clover using polling.
Mapping Collection Status
Mapping Status: Enabled.
Trigger Events:
The sync is triggered by updates to Transactions in Clover.
ID Format:
When manually syncing, the Transaction ID from iPaaS is used. This can be resolved via an external ID.
Conflicting Mappings
This mapping applies only to Transactions. Ensure no other mappings target the same Clover entity to prevent data from being overwritten.
System Caveats
Clover Caveats
Transaction records with paymentState is “PAID” can be transferred to Clover.
iPaaS Caveats
TransactionNumber must be unique.
Setup Requirements
Clover Configuration
Ensure paymentState is “PAID”; otherwise, the record is excluded from the sync.
Transaction address fields should be valid where available.
iPaaS Configuration
Ensure TransactionNumber follows the standard format and does not end with excluded suffixes.
Provide valid total amounts.
Authentication & Security
Clover2 MerchantId: Used to access the iPaaS API for fetching data.
Clover2 API Key: Used to access the iPaaS API for fetching data.
Integration Flow
Retrieve Data: Fetch Transaction data from Clover.
Map Fields: Map Clover Transaction fields to iPaaS destination fields.
Sync Data: Push Transaction information to iPaaS, maintaining ID relationships.
Mappings
Clover Transaction Complete To iPaaS
Mapping Filter
PaymentState == "PAID"
Mapping Type | Source Field (Clover) | Destination Field (iPaaS) | Description |
Dynamic Formula |
| Clover Update Date (custom field) | Sets the field to the current date and time. |
Dynamic Formula |
| TransactionNumber | Required: Uses Title if available; otherwise, falls back to Id. |
Static | Order | Type | Required |
Static | Complete | Status | Required |
Dynamic Formula |
| EmailAddress | Required: Uses the customer’s email if available; otherwise, defaults to guest@customerdomain.com. |
Dynamic Formula |
| Total | Converts the Total amount from cents to dollars by dividing by 100 (defaults to 0 if null). |
Dynamic Formula |
| TotalQty | Calculates the total quantity from all order line items, converting from thousandths by dividing by 1000. |
Error Handling
Invalid Totals
Total non-numeric.
Description: Clover requires integer values.
Resolution: Verify formulas return valid integers.
Missing Transaction ID
Transaction ID missing in Clover record.
Description: Without a valid ID, the TransactionNumber cannot be generated.
Resolution: Ensure Clover Transaction records contain a valid Id field.
Validation Rules & Testing
Validation Rules
TransactionNumber must exist in iPaaS.
Total must convert correctly to cents.
Line creation timestamps must be valid.
Test Scenarios
New Transaction Sync: Create a Clover Transaction with a valid Id and verify creation in iPaaS.
Update Transaction: Update the transaction in Clover and confirm that the changes are reflected in iPaaS.
Additional Notes
The PaymentState field is required due to the filter.