# Invoiced

Invoiced offers tools to simplify invoicing, payment tracking, and account reconciliation.

Invoiced integration replicates data using the [Invoiced REST API](https://developer.invoiced.com/api).

See the [Schema](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#Schema) section for a list of objects available for replication.

## Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Information noteMake sure that the account you use has read access to the tables you want to fetch.

To create an API key:

1. Log into your [Invoiced](https://app.invoiced.com/login) account.
2. Navigate to Settings &gt; Integrations &gt; Developer &gt; New API Key.
3. Copy and paste your API key into a secured file.

## Creating the connection

For more information, see [Connecting to SaaS applications](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/Landing/connecting-web-applications.htm).

1. Fill in the required connection properties.

2. Provide a name for the connection in Connection name.

3. Select Open connection metadata to define metadata for the connection when it has been created.

4. Click Create.

Connection settings

| Setting | Description |
| --- | --- |
| Data gateway | Select a Data Movement gateway if required by your use case.<br><br>Information note<br><br>This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None.<br><br>For information on the benefits of Data Movement gateway and use cases that require it, see [Qlik Data Gateway - Data Movement](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Gateways/replication-gateway.htm). |
| Start Date | Enter the date, in the format `MM/DD/YYYY`, from which the data must be replicated from your source to your target. |
| API Key | API key. |
| Connect to a sandbox environment | Select this option if you are connecting to a sandbox environment. |

## Schema

Information note

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

Depending on your destination, table and column names may not appear as they are outlined below.

### 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** | CDC |
| --- | --- |
| **Primary Key** | id |
| **Replication Key** | updated\_at |
| **Useful links** | [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/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#customers) | ```<br>credit_notes.customer = customers.id<br>``` |
| [estimates](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#estimates) | ```<br>credit_notes.customer = estimates.customer<br>```<br><br>```<br>credit_notes.id = estimates.id<br>``` |
| [invoices](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#invoices) | ```<br>credit_notes.customer = invoices.customer<br>```<br><br>```<br>credit_notes.id = invoices.id<br>``` |
| [subscriptions](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#subscriptions) | ```<br>credit_notes.customer = subscriptions.customer<br>``` |
| [transactions](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#transactions) | ```<br>credit_notes.customer = transactions.customer<br>```<br><br>```<br>credit_notes.id = transactions.id<br>``` |

credit\_notes table schema

| **balance**<br><br><br>NUMBER |
| --- |
| **closed**<br><br><br>BOOLEAN |
| **created\_at**<br><br><br>DATE-TIME |
| **currency**<br><br><br>STRING |
| **customer**<br><br><br>INTEGER |
| **date**<br><br><br>DATE-TIME |
| **discounts**<br><br><br>ARRAY |
| **draft**<br><br><br>BOOLEAN |
| **id**<br><br><br>INTEGER |
| **invoice**<br><br><br>INTEGER |
| **items**<br><br><br>ARRAY |
| **metadata**<br><br><br>OBJECT |
| **name**<br><br><br>STRING |
| **notes**<br><br><br>STRING |
| **number**<br><br><br>STRING |
| **paid**<br><br><br>BOOLEAN |
| **status**<br><br><br>STRING |
| **subtotal**<br><br><br>NUMBER |
| **taxes**<br><br><br>ARRAY |
| **total**<br><br><br>NUMBER |
| **updated\_at**<br><br><br>DATE-TIME |

### customers

The `customers` table contains info about the customers in your Invoiced account.

| **Replication Method** | CDC |
| --- | --- |
| **Primary Key** | id |
| **Replication Key** | updated\_at |
| **Useful links** | [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/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#credit-notes) | ```<br>customers.id = credit_notes.customer<br>``` |
| [estimates](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#estimates) | ```<br>customers.id = estimates.customer<br>``` |
| [invoices](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#invoices) | ```<br>customers.id = invoices.customer<br>``` |
| [subscriptions](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#subscriptions) | ```<br>customers.id = subscriptions.customer<br>``` |
| [transactions](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#transactions) | ```<br>customers.id = transactions.customer<br>``` |

customers table schema

| **address1**<br><br><br>STRING |
| --- |
| **address2**<br><br><br>STRING |
| **attention\_to**<br><br><br>STRING |
| **autopay**<br><br><br>BOOLEAN |
| **chase**<br><br><br>BOOLEAN |
| **chasing\_cadence**<br><br><br>INTEGER |
| **city**<br><br><br>STRING |
| **country**<br><br><br>STRING |
| **created\_at**<br><br><br>DATE-TIME |
| **credit\_hold**<br><br><br>BOOLEAN |
| **credit\_limit**<br><br><br>NUMBER |
| **email**<br><br><br>STRING |
| **id**<br><br><br>INTEGER |
| **language**<br><br><br>STRING |
| **metadata**<br><br><br>OBJECT |
| **name**<br><br><br>STRING |
| **next\_chase\_step**<br><br><br>INTEGER |
| **notes**<br><br><br>STRING |
| **number**<br><br><br>STRING |
| **parent\_customer**<br><br><br>INTEGER |
| **payment\_source**<br><br><br>OBJECT |
| **payment\_terms**<br><br><br>STRING |
| **phone**<br><br><br>STRING |
| **postal\_code**<br><br><br>STRING |
| **sign\_up\_page**<br><br><br>INTEGER |
| **state**<br><br><br>STRING |
| **tax\_id**<br><br><br>STRING |
| **taxable**<br><br><br>BOOLEAN |
| **taxes**<br><br><br>ARRAY |
| **type**<br><br><br>STRING |
| **updated\_at**<br><br><br>DATE-TIME |

### estimates

The `estimates` table contains info about the estimates in your Invoiced account.

| **Replication Method** | CDC |
| --- | --- |
| **Primary Key** | id |
| **Replication Key** | updated\_at |
| **Useful links** | [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/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#credit-notes) | ```<br>estimates.customer = credit_notes.customer<br>```<br><br>```<br>estimates.id = credit_notes.id<br>``` |
| [customers](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#customers) | ```<br>estimates.customer = customers.id<br>``` |
| [invoices](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#invoices) | ```<br>estimates.customer = invoices.customer<br>```<br><br>```<br>estimates.id = invoices.id<br>``` |
| [subscriptions](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#subscriptions) | ```<br>estimates.customer = subscriptions.customer<br>``` |
| [transactions](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#transactions) | ```<br>estimates.customer = transactions.customer<br>```<br><br>```<br>estimates.id = transactions.id<br>``` |

estimates table schema

| **approval**<br><br><br>OBJECT |
| --- |
| **approved**<br><br><br>BOOLEAN |
| **balance**<br><br><br>NUMBER |
| **closed**<br><br><br>BOOLEAN |
| **created\_at**<br><br><br>DATE-TIME |
| **currency**<br><br><br>STRING |
| **customer**<br><br><br>INTEGER |
| **date**<br><br><br>DATE-TIME |
| **deposit**<br><br><br>NUMBER |
| **deposit\_paid**<br><br><br>BOOLEAN |
| **discounts**<br><br><br>ARRAY |
| **draft**<br><br><br>BOOLEAN |
| **expiration\_date**<br><br><br>DATE-TIME |
| **id**<br><br><br>INTEGER |
| **invoice**<br><br><br>INTEGER |
| **items**<br><br><br>ARRAY |
| **metadata**<br><br><br>OBJECT |
| **name**<br><br><br>STRING |
| **notes**<br><br><br>STRING |
| **number**<br><br><br>STRING |
| **paid**<br><br><br>BOOLEAN |
| **payment\_terms**<br><br><br>STRING |
| **status**<br><br><br>STRING |
| **subtotal**<br><br><br>NUMBER |
| **taxes**<br><br><br>ARRAY |
| **total**<br><br><br>NUMBER |
| **updated\_at**<br><br><br>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.

| **Replication Method** | CDC |
| --- | --- |
| **Primary Key** | id |
| **Replication Key** | updated\_at |
| **Useful links** | [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/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#credit-notes) | ```<br>invoices.customer = credit_notes.customer<br>```<br><br>```<br>invoices.id = credit_notes.id<br>``` |
| [customers](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#customers) | ```<br>invoices.customer = customers.id<br>``` |
| [estimates](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#estimates) | ```<br>invoices.customer = estimates.customer<br>```<br><br>```<br>invoices.id = estimates.id<br>``` |
| [subscriptions](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#subscriptions) | ```<br>invoices.customer = subscriptions.customer<br>```<br><br>```<br>invoices.subscription = subscriptions.id<br>``` |
| [transactions](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#transactions) | ```<br>invoices.customer = transactions.customer<br>```<br><br>```<br>invoices.id = transactions.id<br>``` |

invoices table schema

| **attempt\_count**<br><br><br>INTEGER |
| --- |
| **autopay**<br><br><br>BOOLEAN |
| **balance**<br><br><br>NUMBER |
| **closed**<br><br><br>BOOLEAN |
| **created\_at**<br><br><br>DATE-TIME |
| **currency**<br><br><br>STRING |
| **customer**<br><br><br>INTEGER |
| **date**<br><br><br>DATE-TIME |
| **discounts**<br><br><br>ARRAY |
| **draft**<br><br><br>BOOLEAN |
| **due\_date**<br><br><br>DATE-TIME |
| **id**<br><br><br>INTEGER |
| **items**<br><br><br>ARRAY |
| **metadata**<br><br><br>OBJECT |
| **name**<br><br><br>STRING |
| **needs\_attention**<br><br><br>BOOLEAN |
| **next\_payment\_attempt**<br><br><br>DATE-TIME |
| **notes**<br><br><br>STRING |
| **number**<br><br><br>STRING |
| **paid**<br><br><br>BOOLEAN |
| **payment\_terms**<br><br><br>STRING |
| **status**<br><br><br>STRING |
| **subscription**<br><br><br>INTEGER |
| **subtotal**<br><br><br>NUMBER |
| **taxes**<br><br><br>ARRAY |
| **total**<br><br><br>NUMBER |
| **updated\_at**<br><br><br>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.

| **Replication Method** | CDC |
| --- | --- |
| **Primary Key** | id |
| **Replication Key** | updated\_at |
| **Useful links** | [Invoiced API method](https://developer.invoiced.com/api/#list-all-plans "Opens in new tab: Invoiced API method") |

plans table schema

| **amount**<br><br><br>NUMBER |
| --- |
| **catalog\_item**<br><br><br>STRING |
| **created\_at**<br><br><br>INTEGER |
| **currency**<br><br><br>STRING |
| **description**<br><br><br>STRING |
| **id**<br><br><br>STRING |
| **interval**<br><br><br>STRING |
| **interval\_count**<br><br><br>INTEGER |
| **metadata**<br><br><br>OBJECT |
| **name**<br><br><br>STRING |
| **notes**<br><br><br>STRING |
| **object**<br><br><br>STRING |
| **pricing\_mode**<br><br><br>STRING |
| **quantity\_type**<br><br><br>STRING |
| **tiers**<br><br><br>OBJECT |
| **updated\_at**<br><br><br>INTEGER |

### subscriptions

The `subscriptions` table contains info about the subscriptions in your Invoiced account.

| **Replication Method** | CDC |
| --- | --- |
| **Primary Key** | id |
| **Replication Key** | updated\_at |
| **Useful links** | [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/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#credit-notes) | ```<br>subscriptions.customer = credit_notes.customer<br>``` |
| [customers](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#customers) | ```<br>subscriptions.customer = customers.id<br>``` |
| [estimates](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#estimates) | ```<br>subscriptions.customer = estimates.customer<br>``` |
| [invoices](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#invoices) | ```<br>subscriptions.customer = invoices.customer<br>```<br><br>```<br>subscriptions.id = invoices.subscription<br>``` |
| [transactions](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#transactions) | ```<br>subscriptions.customer = transactions.customer<br>``` |

subscriptions table schema

| **addons**<br><br><br>ARRAY |
| --- |
| **approval**<br><br><br>OBJECT |
| **cancel\_at\_period\_end**<br><br><br>BOOLEAN |
| **canceled\_at**<br><br><br>DATE-TIME |
| **contract\_period\_end**<br><br><br>DATE-TIME |
| **contract\_period\_start**<br><br><br>DATE-TIME |
| **contract\_renewal\_cycles**<br><br><br>INTEGER |
| **contract\_renewal\_mode**<br><br><br>STRING |
| **created\_at**<br><br><br>DATE-TIME |
| **customer**<br><br><br>INTEGER |
| **cycles**<br><br><br>INTEGER |
| **discounts**<br><br><br>ARRAY |
| **id**<br><br><br>INTEGER |
| **metadata**<br><br><br>OBJECT |
| **mrr**<br><br><br>NUMBER |
| **period\_end**<br><br><br>DATE-TIME |
| **period\_start**<br><br><br>DATE-TIME |
| **plan**<br><br><br>STRING |
| **quantity**<br><br><br>NUMBER |
| **recurring\_total**<br><br><br>NUMBER |
| **renewed\_last**<br><br><br>DATE-TIME |
| **renews\_next**<br><br><br>DATE-TIME |
| **start\_date**<br><br><br>DATE-TIME |
| **status**<br><br><br>STRING |
| **taxes**<br><br><br>ARRAY |
| **updated\_at**<br><br><br>DATE-TIME |

### transactions

The `transactions` table contains info about the transactions in your Invoiced account.

| **Replication Method** | CDC |
| --- | --- |
| **Primary Key** | id |
| **Replication Key** | updated\_at |
| **Useful links** | [Invoiced API method](https://developer.invoiced.com/api/#list-all-transactions "Opens in new tab: Invoiced API method") |

transactions table foreign keys

| Join transactions with | on |
| --- | --- |
| [credit_notes](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#credit-notes) | ```<br>transactions.customer = credit_notes.customer<br>```<br><br>```<br>transactions.id = credit_notes.id<br>``` |
| [customers](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#customers) | ```<br>transactions.customer = customers.id<br>``` |
| [estimates](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#estimates) | ```<br>transactions.customer = estimates.customer<br>```<br><br>```<br>transactions.id = estimates.id<br>``` |
| [invoices](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#invoices) | ```<br>transactions.customer = invoices.customer<br>```<br><br>```<br>transactions.id = invoices.id<br>``` |
| [subscriptions](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Invoiced.htm#subscriptions) | ```<br>transactions.customer = subscriptions.customer<br>``` |

transactions table schema

| **amount**<br><br><br>NUMBER |
| --- |
| **created\_at**<br><br><br>DATE-TIME |
| **credit\_note**<br><br><br>INTEGER |
| **currency**<br><br><br>STRING |
| **customer**<br><br><br>INTEGER |
| **date**<br><br><br>DATE-TIME |
| **failure\_reason**<br><br><br>STRING |
| **gateway**<br><br><br>STRING |
| **gateway\_id**<br><br><br>STRING |
| **id**<br><br><br>INTEGER |
| **invoice**<br><br><br>INTEGER |
| **metadata**<br><br><br>OBJECT |
| **method**<br><br><br>STRING |
| **notes**<br><br><br>STRING |
| **parent\_transaction**<br><br><br>INTEGER |
| **payment\_source**<br><br><br>OBJECT |
| **status**<br><br><br>STRING |
| **type**<br><br><br>STRING |
| **updated\_at**<br><br><br>DATE-TIME |