Heartland 1 Way Integration
Last Updated 3/12/2024
Overview
The sync with Heartland POS is a 1-Way interface where Yellow Dog Inventory pulls sales data and reduces inventory levels based on transactions.
Sync Approach
Yellow Dog Inventory uses a microservices sync application to pulls sales data from Heartland’s API.
Sync Frequency
The sync can be scheduled as often as every 30 minutes or as seldom as once a day, although by default, it will be run at the top of every hour during business hours.
Configuration
The Yellow Dog inventory system can be set up with multiple stores. In order to pull in sales from multiple stores in Heartland, sites will need to have Multi-store setup and provide separate API keys for each store. Your Heartland rep will be able to provide additional detail on this.
This integration also supports multiple instances of Heartland connected to a single Yellow Dog database.
Requirements
Client
Inventory items must be mapped in Yellow Dog to POS Items to report sales and deplete inventory. The client must run the end of day process in order for Yellow Dog to pull in sales.
POS Partner
The POS partner is responsible for providing the API Key - specific to the client and ensuring the scheduling of the End of Day Process.
Yellow Dog
Yellow Dog will need to configure the SyncWithMicrosServices to pull in Sales Data.
Data Exchange and Mapping
Sales Data
We pull in the following data from Heartland:
| Heartland Field | Yellow Dog Field |
|---|---|
| Ticket Closed DateTime | Check Closed |
| Heartland Unique Item Id | Item Number |
| Description | Item |
| Unit Price | Item Retail |
| Unit Discount | Item Discount |
| Discount Description | Discount Description |
| Quantity | Quantity |
| Employee ID | Employee Number |
| Microservice_HeartlandSales | Source |
| Ticket Number | Transaction Number |
| For Modifier lines, ID of the item being modified | Parent Number |
| void_dt | If this field is not null or blank, we set Reference="VOID" and Quantity=0 |
Additional Information
Limitations
End of day process is required to run before we see sales
Check discounts are treated as line items. Since the check discount is not applied to the item on the Heartland side we divide discounts among line items in the check.
Forced or required modifiers may not appear on the check but are pulled into Yellow Dog with the main item’s transaction.
Currently the Heartland API doesn’t provide detail on Context items in the sales information provided.
Items will not appear in POS mapping until sold in the POS
This integration is only compatible with Yellow Dog version 362 and higher
