# Invoiced (v1)
Information note **Invoiced is supported by the Singer community**
This integration is powered by [Singer's](https://www.singer.io/) Invoiced tap. For support, [visit the GitHub repo](https://github.com/singer-io/tap-invoiced) or [join the Singer Slack](https://singer-slackin.herokuapp.com/).
## Invoiced integration summary
Stitch’s Invoiced integration replicates data using the [Invoiced REST API](https://invoiced.com/docs/api/). Refer to the [Schema](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#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](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Released on March 21, 2019 | **Supported by**
the Info icon
Indicates if the integration is supported by Stitch or the Singer community. | [Singer Community](https://www.singer.io/) |
| **Stitch plan**
the Info icon
The type of Stitch plan required to use the integration. | Standard | **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**
the Info icon
Indicates if the integration is available as a source in Stitch Connect. | the Success icon
This version of the integration is available via the API.
Available |
| **Singer GitHub repository** | [singer-io/tap-invoiced](https://github.com/singer-io/tap-invoiced) | | |
| **REPLICATION SETTINGS** | | | |
| **[Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)**
the Info icon
A type of replication scheduling where an integration's Replication Frequency is anchored to a time you select. | the Success icon
This feature is supported for this version of the integration.
Supported | **[Advanced Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling)**
the Info icon
A type of replication scheduling that allows you to specify granular start times for data extraction using cron expressions. | the Success icon
This feature is supported for this version of the integration.
Supported |
| **Table-level reset**
the Info icon
Indicates if data can be reset at the table level. If unsupported, data can only be reset at the integration level. | the Remove icon
Table-level resets are not supported for this integration. Resets are only supported at the integration level.
Unsupported | **[Configurable Replication Methods](https://help.qlik.com/en-US/stitch/replication/replication-methods)**
the Info icon
Indicates if Replication Methods can be defined by you for tables in the integration. | the Remove icon
Configurable Replication Methods are not supported for this integration. Stitch will use pre-defined replication methods for tables you set to replicate.
Unsupported |
| **DATA SELECTION** | | | |
| **Table selection**
the Info icon
The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Success icon
This feature is supported for this version of the integration.
Supported | **Column selection**
the Info icon
The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Success icon
This feature is supported for this version of the integration.
Supported |
| **Select all**
the Info icon
Indicates if the integration supports selecting all available tables and columns. | the Success icon
Supported
Supported | | |
| **TRANSPARENCY** | | | |
| **[Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs)**
the Info icon
Logs detailing the Extraction phase of the replication process for a given integration. Includes error info, should an error occur. | the Success icon
This feature is supported for this version of the integration.
Supported | **[Loading Reports](https://help.qlik.com/en-US/stitch/replication/integration-loading-reports)**
the Info icon
Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon
This feature is supported for this version of the integration.
Supported |
## Connecting Invoiced
### Step 1: Generate an Invoiced API key
1. [Sign into your Invoiced account](https://dashboard.invoiced.com/login).
2. Click **Settings** on the left side of the page.
3. In the **Business Settings** section, click **Developers**.
4. On the Developers page, click the **New API Key** button. A **New API Key** window will display.
5. In the **Key Description** field, enter a description that identifies the API key. For example: `Stitch`
6. Click **Save**. This will direct you back to the Developers page after the API key is created.
7. 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:
A highlighted API key field on the Developers page in the Invoiced appA highlighted API key field on the Developers page in the Invoiced app
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
1. [Sign into your Stitch account](https://app.stitchdata.com/).
2. On the Stitch Dashboard page, click the **Add Integration** button.
3. Click the **Invoiced** icon.
4. 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_invoiced` in the destination. **Note**: Schema names cannot be changed after you save the integration.
5. In the **API Key** field, paste your Invoiced API key.
6. 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](https://help.qlik.com/en-US/stitch/replication/syncing-historical-saas-data-resetting-replication-keys) guide.
### Step 4: Create a replication schedule
Information note Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the [Replication Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling) documentation for more information.
In the **Replication Frequency** section, you’ll create the integration’s [replication schedule](https://help.qlik.com/en-US/stitch/replication/replication-scheduling). 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:
* [Replication Frequency](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency)
* [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)
* [Advanced Scheduling using Cron](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling) (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](https://help.qlik.com/en-US/stitch/getting-started/understanding-stitch-usage) for tips on reducing your usage.
### Step 5: Set objects to replicate
Information note **Is an object missing or not replicating?** Verify that the object meets the requirements for [selection](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#selection-requirements) and [replication](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#replication-requirements).
The last step is to select the tables and columns you want to replicate. [Learn about the available tables for this integration.](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#schema)
**Note**: If a replication job is currently in progress, new selections won’t be used until the next job starts.
* Selection options
* Individual tables and columns
* All tables and columns
For Invoiced integrations, you can select:
1. **Individual tables and columns**
2. **All tables and columns**
Click the tabs to view instructions for each selection method.
1. In the integration’s **Tables to Replicate tab**, locate a table you want to replicate.
2. To track a table, click the **checkbox** next to the table’s name. A blue checkmark means the table is set to replicate.
3. To track a column, click the **checkbox** next to the column’s name. A blue checkmark means the column is set to replicate.
4. Repeat this process for all the tables and columns you want to replicate.
5. When finished, click the **Finalize Your Selections** button at the bottom of the screen to save your selections.
Information note **Important**: Using the **Select All** feature will overwrite any previous selections. However, selections aren’t final until **Finalize Your Selections** is clicked. Clicking **Cancel** will restore your previous selections. Refer to the [Select All guide](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#set-all-data-to-replicate) for more info about this feature.
1. Click into the integration from the Stitch Dashboard page.
2. Click the **Tables to Replicate** tab.
3. In the list of tables, click the box next to the **Table Names** column.
4. In the menu that displays, click **Track all Tables and Fields**:
The Track all Tables and Fields menu in the Tables to Replicate tabThe Track all Tables and Fields menu in the Tables to Replicate tab
5. 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.**
Information note
**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](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) 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.
Information note **Replication will continue after the seven days are over**. If you’re no longer interested in this source, be sure to **pause** or **delete** the integration to prevent unwanted usage.
## Invoiced table reference
Information note
**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.
Information note
**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](https://help.qlik.com/en-US/stitch/replication/loading/destination-guides) 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.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [credit_notes schema on GitHub](https://github.com/singer-io/tap-invoiced/blob/master/tap_invoiced/schemas/credit_notes.json "Opens in new tab: credit_notes schema on GitHub")
[Invoiced API method](https://developer.invoiced.com/api/#list-all-credit-notes "Opens in new tab: Invoiced API method") |
credit\_notes table foreign keys
| Join credit\_notes with | on |
| --- | --- |
| [customers](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#customers) | ```
credit_notes.customer = customers.id
``` |
| [estimates](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#estimates) | ```
credit_notes.customer = estimates.customer
```
```
credit_notes.id = estimates.id
``` |
| [invoices](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#invoices) | ```
credit_notes.customer = invoices.customer
```
```
credit_notes.id = invoices.id
``` |
| [subscriptions](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#subscriptions) | ```
credit_notes.customer = subscriptions.customer
``` |
| [transactions](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#transactions) | ```
credit_notes.customer = transactions.customer
```
```
credit_notes.id = transactions.id
``` |
credit\_notes table schema
| **id**
INTEGER |
| --- |
| **balance**
NUMBER |
| **closed**
BOOLEAN |
| **currency**
STRING |
| **customer**
INTEGER |
| **date**
STRING |
| **discounts**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **draft**
BOOLEAN |
| **items**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **invoice**
INTEGER |
| **metadata**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **name**
STRING |
| **notes**
STRING |
| **number**
STRING |
| **paid**
BOOLEAN |
| **status**
STRING |
| **subtotal**
NUMBER |
| **taxes**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **total**
NUMBER |
| **created\_at**
STRING |
| **updated\_at**
STRING |
| **purchase\_order**
STRING |
| **url**
STRING |
| **pdf\_url**
STRING |
| **object**
STRING |
### customers
The `customers` table contains info about the customers in your Invoiced account.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [customers schema on GitHub](https://github.com/singer-io/tap-invoiced/blob/master/tap_invoiced/schemas/customers.json "Opens in new tab: customers schema on GitHub")
[Invoiced API method](https://developer.invoiced.com/api/#list-all-customers "Opens in new tab: Invoiced API method") |
customers table foreign keys
| Join customers with | on |
| --- | --- |
| [credit_notes](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#credit-notes) | ```
customers.id = credit_notes.customer
``` |
| [estimates](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#estimates) | ```
customers.id = estimates.customer
``` |
| [invoices](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#invoices) | ```
customers.id = invoices.customer
``` |
| [subscriptions](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#subscriptions) | ```
customers.id = subscriptions.customer
``` |
| [transactions](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#transactions) | ```
customers.id = transactions.customer
``` |
customers table schema
| **id**
INTEGER |
| --- |
| **address1**
STRING |
| **address2**
STRING |
| **attention\_to**
STRING |
| **autopay**
BOOLEAN |
| **chase**
BOOLEAN |
| **chasing\_cadence**
INTEGER |
| **city**
STRING |
| **country**
STRING |
| **credit\_hold**
BOOLEAN |
| **credit\_limit**
NUMBER |
| **email**
STRING |
| **language**
STRING |
| **metadata**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **name**
STRING |
| **next\_chase\_step**
INTEGER |
| **notes**
STRING |
| **number**
STRING |
| **parent\_customer**
INTEGER |
| **payment\_source**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **payment\_terms**
STRING |
| **phone**
STRING |
| **postal\_code**
STRING |
| **sign\_up\_page**
INTEGER |
| **state**
STRING |
| **tax\_id**
STRING |
| **taxable**
BOOLEAN |
| **taxes**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **type**
STRING |
| **created\_at**
STRING |
| **updated\_at**
STRING |
| **currency**
STRING |
| **owner**
INTEGER |
| **avalara\_entity\_use\_code**
STRING |
| **avalara\_exemption\_number**
STRING |
| **sign\_up\_url**
STRING |
| **statement\_pdf\_url**
STRING |
| **ach\_gateway**
INTEGER |
| **cc\_gateway**
INTEGER |
| **autopay\_delay\_days**
INTEGER |
| **object**
STRING |
### estimates
The `estimates` table contains info about the estimates in your Invoiced account.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [estimates schema on GitHub](https://github.com/singer-io/tap-invoiced/blob/master/tap_invoiced/schemas/estimates.json "Opens in new tab: estimates schema on GitHub")
[Invoiced API method](https://developer.invoiced.com/api/#list-all-estimates "Opens in new tab: Invoiced API method") |
estimates table foreign keys
| Join estimates with | on |
| --- | --- |
| [credit_notes](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#credit-notes) | ```
estimates.customer = credit_notes.customer
```
```
estimates.id = credit_notes.id
``` |
| [customers](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#customers) | ```
estimates.customer = customers.id
``` |
| [invoices](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#invoices) | ```
estimates.customer = invoices.customer
```
```
estimates.id = invoices.id
``` |
| [subscriptions](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#subscriptions) | ```
estimates.customer = subscriptions.customer
``` |
| [transactions](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#transactions) | ```
estimates.customer = transactions.customer
```
```
estimates.id = transactions.id
``` |
estimates table schema
| **id**
INTEGER |
| --- |
| **approved**
BOOLEAN |
| **balance**
NUMBER |
| **closed**
BOOLEAN |
| **currency**
STRING |
| **customer**
INTEGER |
| **date**
STRING |
| **deposit**
NUMBER |
| **deposit\_paid**
BOOLEAN |
| **discounts**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **draft**
BOOLEAN |
| **expiration\_date**
STRING |
| **items**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **invoice**
INTEGER |
| **metadata**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **name**
STRING |
| **notes**
STRING |
| **number**
STRING |
| **payment\_terms**
STRING |
| **status**
STRING |
| **subtotal**
NUMBER |
| **taxes**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **total**
NUMBER |
| **created\_at**
STRING |
| **updated\_at**
STRING |
| **purchase\_order**
STRING |
| **ship\_to**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **url**
STRING |
| **pdf\_url**
STRING |
| **object**
STRING |
### invoices
The `invoices` table contains info about the invoices in your Invoiced account. An invoice represents a balance owed to you by a customer.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [invoices schema on GitHub](https://github.com/singer-io/tap-invoiced/blob/master/tap_invoiced/schemas/invoices.json "Opens in new tab: invoices schema on GitHub")
[Invoiced API method](https://developer.invoiced.com/api/#list-all-invoices "Opens in new tab: Invoiced API method") |
invoices table foreign keys
| Join invoices with | on |
| --- | --- |
| [credit_notes](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#credit-notes) | ```
invoices.customer = credit_notes.customer
```
```
invoices.id = credit_notes.id
``` |
| [customers](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#customers) | ```
invoices.customer = customers.id
``` |
| [estimates](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#estimates) | ```
invoices.customer = estimates.customer
```
```
invoices.id = estimates.id
``` |
| [subscriptions](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#subscriptions) | ```
invoices.customer = subscriptions.customer
```
```
invoices.subscription = subscriptions.id
``` |
| [transactions](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#transactions) | ```
invoices.customer = transactions.customer
```
```
invoices.id = transactions.id
``` |
invoices table schema
| **id**
INTEGER |
| --- |
| **attempt\_count**
INTEGER |
| **autopay**
BOOLEAN |
| **balance**
NUMBER |
| **closed**
BOOLEAN |
| **currency**
STRING |
| **customer**
INTEGER |
| **date**
STRING |
| **discounts**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **draft**
BOOLEAN |
| **due\_date**
STRING |
| **items**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **metadata**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **name**
STRING |
| **next\_payment\_attempt**
STRING |
| **notes**
STRING |
| **number**
STRING |
| **paid**
BOOLEAN |
| **payment\_terms**
STRING |
| **status**
STRING |
| **subscription**
INTEGER |
| **subtotal**
NUMBER |
| **taxes**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **total**
NUMBER |
| **created\_at**
STRING |
| **updated\_at**
STRING |
| **purchase\_order**
STRING |
| **ship\_to**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **payment\_plan**
INTEGER |
| **url**
STRING |
| **payment\_url**
STRING |
| **pdf\_url**
STRING |
| **object**
STRING |
### 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.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [plans schema on GitHub](https://github.com/singer-io/tap-invoiced/blob/master/tap_invoiced/schemas/plans.json "Opens in new tab: plans schema on GitHub")
[Invoiced API method](https://developer.invoiced.com/api/#list-all-plans "Opens in new tab: Invoiced API method") |
plans table schema
| **amount**
NUMBER |
| --- |
| **catalog\_item**
STRING |
| **created\_at**
INTEGER |
| **currency**
STRING |
| **description**
STRING |
| **id**
STRING |
| **interval**
STRING |
| **interval\_count**
INTEGER |
| **metadata**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **name**
STRING |
| **notes**
STRING |
| **object**
STRING |
| **pricing\_mode**
STRING |
| **quantity\_type**
STRING |
| **tiers**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **updated\_at**
INTEGER |
### subscriptions
The `subscriptions` table contains info about the subscriptions in your Invoiced account.
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental |
| --- | --- |
| **Primary Key ** | id |
| **Replication Key ** | updated\_at |
| **Useful links** | [subscriptions schema on GitHub](https://github.com/singer-io/tap-invoiced/blob/master/tap_invoiced/schemas/subscriptions.json "Opens in new tab: subscriptions schema on GitHub")
[Invoiced API method](https://developer.invoiced.com/api/#list-all-subscriptions "Opens in new tab: Invoiced API method") |
subscriptions table foreign keys
| Join subscriptions with | on |
| --- | --- |
| [credit_notes](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#credit-notes) | ```
subscriptions.customer = credit_notes.customer
``` |
| [customers](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#customers) | ```
subscriptions.customer = customers.id
``` |
| [estimates](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#estimates) | ```
subscriptions.customer = estimates.customer
``` |
| [invoices](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#invoices) | ```
subscriptions.customer = invoices.customer
```
```
subscriptions.id = invoices.subscription
``` |
| [transactions](https://help.qlik.com/en-US/stitch/integrations/saas/invoiced#transactions) | ```
subscriptions.customer = transactions.customer
``` |
subscriptions table schema
| **id**
INTEGER |
| --- |
| **addons**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **cancel\_at\_period\_end**
BOOLEAN |
| **canceled\_at**
STRING |
| **contract\_period\_end**
STRING |
| **contract\_period\_start**
STRING |
| **contract\_renewal\_cycles**
INTEGER |
| **contract\_renewal\_mode**
STRING |
| **customer**
INTEGER |
| **cycles**
INTEGER |
| **discounts**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **metadata**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **mrr**
NUMBER |
| **period\_end**
STRING |
| **period\_start**
STRING |
| **plan**
STRING |
| **quantity**
INTEGER |
| **recurring\_total**
NUMBER |
| **start\_date**
STRING |
| **status**
STRING |
| **taxes**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **created\_at**
STRING |
| **updated\_at**
STRING |
| **amount**
STRING |
| **bill\_in**
STRING |
| **bill\_in\_advance\_days**
INTEGER |
| **paused**
BOOLEAN |
| **url**
STRING |
| **object**
STRING |
| **ship\_to**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |