This integration is powered by Singer's Invoiced tap. For support, visit the GitHub repo or join the Singer Slack.
Invoiced integration summary
Stitch’s Invoiced integration replicates data using the Invoiced REST API. Refer to the Schema section for a list of objects available for replication.
Invoiced feature snapshot
A high-level look at Stitch's Invoiced (v1) integration, including release status, useful links, and the features supported in Stitch.
| STITCH | |||
| Release status |
Released on March 21, 2019 |
Supported by | |
| Stitch plan |
Standard |
API availability |
Available |
| Singer GitHub repository | |||
| REPLICATION SETTINGS | |||
| Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
| Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
| DATA SELECTION | |||
| Table selection |
Supported |
Column selection |
Supported |
| Select all |
Supported |
||
| TRANSPARENCY | |||
| Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Invoiced
Step 1: Generate an Invoiced API key
- Sign into your Invoiced account.
- Click Settings on the left side of the page.
- In the Business Settings section, click Developers.
- On the Developers page, click the New API Key button. A New API Key window will display.
- In the Key Description field, enter a description that identifies the API key. For example:
Stitch - Click Save. This will direct you back to the Developers page after the API key is created.
-
A section for the new API key will display on the Developers page. Click the Show Secret link next to the name of the API key to display it:
Leave this page open for now - you’ll need it to complete the setup in Stitch.
Step 2: Add Invoiced as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Invoiced icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Invoiced” would create a schema called
stitch_invoicedin the destination. Note: Schema names cannot be changed after you save the integration. - In the API Key field, paste your Invoiced API key.
- If the Invoiced instance you’re connecting to is a sandbox, check the Is this a sandbox connection? box.
Step 3: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Invoiced integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond Invoiced’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 4: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Invoiced integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For Invoiced integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up Invoiced, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Invoiced table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the Invoiced integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.
credit_notes
The credit_notes table contains info about the credit notes in your Invoiced account. A credit note represents a balance you owe to a customer.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
| Join credit_notes with | on |
|---|---|
| customers |
credit_notes.customer = customers.id |
| estimates |
credit_notes.customer = estimates.customer credit_notes.id = estimates.id |
| invoices |
credit_notes.customer = invoices.customer credit_notes.id = invoices.id |
| subscriptions |
credit_notes.customer = subscriptions.customer |
| transactions |
credit_notes.customer = transactions.customer credit_notes.id = transactions.id |
|
balance NUMBER |
|
closed BOOLEAN |
|
created_at DATE-TIME |
|
currency STRING |
|
customer INTEGER |
|
date DATE-TIME |
|
discounts ARRAY |
|
draft BOOLEAN |
|
id
INTEGER |
|
invoice INTEGER |
|
items ARRAY |
|
metadata OBJECT |
|
name STRING |
|
notes STRING |
|
number STRING |
|
paid BOOLEAN |
|
status STRING |
|
subtotal NUMBER |
|
taxes ARRAY |
|
total NUMBER |
|
updated_at
DATE-TIME |
customers
The customers table contains info about the customers in your Invoiced account.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
| Join customers with | on |
|---|---|
| credit_notes |
customers.id = credit_notes.customer |
| estimates |
customers.id = estimates.customer |
| invoices |
customers.id = invoices.customer |
| subscriptions |
customers.id = subscriptions.customer |
| transactions |
customers.id = transactions.customer |
|
address1 STRING |
|
address2 STRING |
|
attention_to STRING |
|
autopay BOOLEAN |
|
chase BOOLEAN |
|
chasing_cadence INTEGER |
|
city STRING |
|
country STRING |
|
created_at DATE-TIME |
|
credit_hold BOOLEAN |
|
credit_limit NUMBER |
|
STRING |
|
id
INTEGER |
|
language STRING |
|
metadata OBJECT |
|
name STRING |
|
next_chase_step INTEGER |
|
notes STRING |
|
number STRING |
|
parent_customer INTEGER |
|
payment_source OBJECT |
|
payment_terms STRING |
|
phone STRING |
|
postal_code STRING |
|
sign_up_page INTEGER |
|
state STRING |
|
tax_id STRING |
|
taxable BOOLEAN |
|
taxes ARRAY |
|
type STRING |
|
updated_at
DATE-TIME |
estimates
The estimates table contains info about the estimates in your Invoiced account.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
| Join estimates with | on |
|---|---|
| credit_notes |
estimates.customer = credit_notes.customer estimates.id = credit_notes.id |
| customers |
estimates.customer = customers.id |
| invoices |
estimates.customer = invoices.customer estimates.id = invoices.id |
| subscriptions |
estimates.customer = subscriptions.customer |
| transactions |
estimates.customer = transactions.customer estimates.id = transactions.id |
|
approval OBJECT |
|
approved BOOLEAN |
|
balance NUMBER |
|
closed BOOLEAN |
|
created_at DATE-TIME |
|
currency STRING |
|
customer INTEGER |
|
date DATE-TIME |
|
deposit NUMBER |
|
deposit_paid BOOLEAN |
|
discounts ARRAY |
|
draft BOOLEAN |
|
expiration_date DATE-TIME |
|
id
INTEGER |
|
invoice INTEGER |
|
items ARRAY |
|
metadata OBJECT |
|
name STRING |
|
notes STRING |
|
number STRING |
|
paid BOOLEAN |
|
payment_terms STRING |
|
status STRING |
|
subtotal NUMBER |
|
taxes ARRAY |
|
total NUMBER |
|
updated_at
DATE-TIME |
invoices
The invoices table contains info about the invoices in your Invoiced account. An invoice represents a balance owed to you by a customer.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
| Join invoices with | on |
|---|---|
| credit_notes |
invoices.customer = credit_notes.customer invoices.id = credit_notes.id |
| customers |
invoices.customer = customers.id |
| estimates |
invoices.customer = estimates.customer invoices.id = estimates.id |
| subscriptions |
invoices.customer = subscriptions.customer invoices.subscription = subscriptions.id |
| transactions |
invoices.customer = transactions.customer invoices.id = transactions.id |
|
attempt_count INTEGER |
|
autopay BOOLEAN |
|
balance NUMBER |
|
closed BOOLEAN |
|
created_at DATE-TIME |
|
currency STRING |
|
customer INTEGER |
|
date DATE-TIME |
|
discounts ARRAY |
|
draft BOOLEAN |
|
due_date DATE-TIME |
|
id
INTEGER |
|
items ARRAY |
|
metadata OBJECT |
|
name STRING |
|
needs_attention BOOLEAN |
|
next_payment_attempt DATE-TIME |
|
notes STRING |
|
number STRING |
|
paid BOOLEAN |
|
payment_terms STRING |
|
status STRING |
|
subscription INTEGER |
|
subtotal NUMBER |
|
taxes ARRAY |
|
total NUMBER |
|
updated_at
DATE-TIME |
plans
The plans table contains info about the plans in your Invoiced account. A plan describes a fixed amount that is billed to customers over a recurring interval.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
|
amount NUMBER |
|
catalog_item STRING |
|
created_at INTEGER |
|
currency STRING |
|
description STRING |
|
id
STRING |
|
interval STRING |
|
interval_count INTEGER |
|
metadata OBJECT |
|
name STRING |
|
notes STRING |
|
object STRING |
|
pricing_mode STRING |
|
quantity_type STRING |
|
tiers OBJECT |
|
updated_at
INTEGER |
subscriptions
The subscriptions table contains info about the subscriptions in your Invoiced account.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
| Join subscriptions with | on |
|---|---|
| credit_notes |
subscriptions.customer = credit_notes.customer |
| customers |
subscriptions.customer = customers.id |
| estimates |
subscriptions.customer = estimates.customer |
| invoices |
subscriptions.customer = invoices.customer subscriptions.id = invoices.subscription |
| transactions |
subscriptions.customer = transactions.customer |
|
addons ARRAY |
|
approval OBJECT |
|
cancel_at_period_end BOOLEAN |
|
canceled_at DATE-TIME |
|
contract_period_end DATE-TIME |
|
contract_period_start DATE-TIME |
|
contract_renewal_cycles INTEGER |
|
contract_renewal_mode STRING |
|
created_at DATE-TIME |
|
customer INTEGER |
|
cycles INTEGER |
|
discounts ARRAY |
|
id
INTEGER |
|
metadata OBJECT |
|
mrr NUMBER |
|
period_end DATE-TIME |
|
period_start DATE-TIME |
|
plan STRING |
|
quantity NUMBER |
|
recurring_total NUMBER |
|
renewed_last DATE-TIME |
|
renews_next DATE-TIME |
|
start_date DATE-TIME |
|
status STRING |
|
taxes ARRAY |
|
updated_at
DATE-TIME |
transactions
The transactions table contains info about the transactions in your Invoiced account.
|
Key-based Incremental |
|
|
Primary Key |
id |
|
Replication Key |
updated_at |
| Useful links |
| Join transactions with | on |
|---|---|
| credit_notes |
transactions.customer = credit_notes.customer transactions.id = credit_notes.id |
| customers |
transactions.customer = customers.id |
| estimates |
transactions.customer = estimates.customer transactions.id = estimates.id |
| invoices |
transactions.customer = invoices.customer transactions.id = invoices.id |
| subscriptions |
transactions.customer = subscriptions.customer |
|
amount NUMBER |
|
created_at DATE-TIME |
|
credit_note INTEGER |
|
currency STRING |
|
customer INTEGER |
|
date DATE-TIME |
|
failure_reason STRING |
|
gateway STRING |
|
gateway_id STRING |
|
id
INTEGER |
|
invoice INTEGER |
|
metadata OBJECT |
|
method STRING |
|
notes STRING |
|
parent_transaction INTEGER |
|
payment_source OBJECT |
|
status STRING |
|
type STRING |
|
updated_at
DATE-TIME |
| Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.