Automated exports let you keep selected Hyperline datasets available in your own database for analysis, reporting, and finance operations. Instead of downloading CSV files manually, you can create a Data sync that writes Hyperline data to a destination database on a recurring schedule. Each selected dataset is written to its own table.Documentation Index
Fetch the complete documentation index at: https://docs.hyperline.co/llms.txt
Use this file to discover all available pages before exploring further.
In-app setup currently supports PostgreSQL destinations. Use a dedicated
database, schema, or write user for Hyperline exports whenever possible.
Before you start
To create a data sync, make sure that:- You have access to Settings in Hyperline
- Your destination PostgreSQL database can receive connections from Hyperline
- The database user can create tables and write rows
- The connection URL is available
15.188.105.16315.188.215.10535.181.129.14
Create a data sync
- Go to Settings > Data syncs
- Click New sync
- Select an existing PostgreSQL connection, or choose Create new connection
- Enter the connection name and database connection details
- Select the sync status:
- Active: run automatically on the configured schedule
- Paused: keep the configuration without scheduled runs
- Select the sync frequency:
- Every 12 hours
- Every 24 hours
- Select the data to sync
- Click Save changes
Available data
You can sync invoice exports and Hyperline reports.| Data | Destination table |
|---|---|
| Invoices | hyperline_invoices |
| Invoice line items | hyperline_invoice_line_items |
| Aged balances | hyperline_report_aged_balances |
| All customers | hyperline_report_all_customers |
| All subscriptions | hyperline_report_all_subscriptions |
| Detailed revenue | hyperline_report_detailed_revenue |
| Draft invoices | hyperline_report_draft_invoices |
| Line by line revenue | hyperline_report_line_by_line_revenue |
| Live subscriptions | hyperline_report_live_subscriptions |
| Open invoices | hyperline_report_open_invoices |
| Outstanding invoices | hyperline_report_outstanding_invoices |
| Renewals | hyperline_report_renewals |
| Revenue per country | hyperline_report_revenue_per_country |
| Revenue per line item name | hyperline_report_revenue_per_line_item_name |
| Revenue per plan | hyperline_report_revenue_per_plan |
| Revenue per product | hyperline_report_revenue_per_product |
How syncs write data
Each selected dataset is refreshed as a snapshot. Hyperline creates the destination table if it does not exist, then replaces the table content during each successful sync. If the table already exists, its schema must be compatible with the expected Hyperline columns. Extra columns can exist, but required columns must be present with compatible types. Every exported table includes Hyperline metadata columns, such as:| Column | Description |
|---|---|
_hyperline_source_id | Stable row identifier used by the sync |
_hyperline_synced_at | Time when the row was written to the destination |
_hyperline_sync_run_id | Identifier of the sync run that wrote the row |
_hyperline_report_generated_at | Time when the report snapshot was generated |
_hyperline_report_template | Source report template |
_hyperline_row_index | Row position in the generated report |
_hyperline_row_hash | Hash of the source row content |
Run and monitor syncs
Scheduled syncs run only when the sync is Active. You can also click Run now from the sync list or sync detail page to start a manual run. Open a sync to review Run history. Each run shows:- Whether it was manual or scheduled
- Status:
pending,processing,done,partial, orerror - Start time
- Number of selected tables
- Rows written
- Error message, when available