Heartland API

Does Heartland have a public API?

Heartland publishes developer documentation for its payments products, and integrations with the Heartland Restaurant POS have historically run through partner arrangements rather than a self-serve key an operator's own team can create. Integuru generates a production-ready HTTP API for Heartland from your back-office login at hrpos.heartland.us, with 15 verified actions across sales, orders, labor, cash handling and the menu, so the reports a manager reads each night are reachable from code.

What you can do with the Heartland API

Last table gone, lights half down: the manager pulls up the sales summary, counts the drawers, scans the punches for whoever forgot to clock out, and opens the two orders that looked wrong on the floor. Each of those is one action here.

Close the night

• sales_summary returns the summary from a required begin_date, optionally to end_date, scoped by account_id or account_name and location_id.
• cash_drawers returns drawer activity for the same date and scope options.
• order_details returns orders for the range, with include_modifiers for line-level modifiers.

Report the period

• sales_reports runs a named report over begin_date to end_date, with staff_breakout to split by employee.
• location_financials returns a location's financials for a required date range.

Check labor

• time_punches returns punches from begin_date, and schedule returns the schedule for the same window.
• staff_directory returns staff and access_control returns roles and permissions.

Read the setup

• menu_catalog, list_menu_items, ingredients_catalog and pricing_config return the menu, items, ingredients and price configuration; hardware_layout and account_overview return the store's terminal layout and account record. Each catalogue action accepts an optional resource selector.

Who uses this

Back-office and accounting tools poll sales_summary and cash_drawers after each closeout to post daily sales and cash entries without a manager exporting them, alongside the same figures from the Square, SmartTab and Silverware POS pages. Labor tools compare time_punches against schedule for the same range to flag early clock-ins and missed breaks. Menu and food-cost platforms sync menu_catalog and ingredients_catalog so recipe costs line up with what the POS actually sells, and pair this page with Restaurant365 for the P&L. The restaurants industry page covers the daily close end to end.

Setup notes

Integuru authenticates against hrpos.heartland.us with your Heartland back-office user. Multi-location accounts should pass account_id or location_id explicitly; the name variants (account_name, location_name) are accepted where listed. Dates are YYYY-MM-DD. sales_reports requires a report name in addition to both dates.

Get started

Install the CLI and connect your Heartland login:

npm install -g integuru

Or sign in at app.integuru.com, add Heartland, and call the same 15 actions from the dashboard. For a report or write action this page does not list, the Managed Service scopes and builds it against your account.