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

Singer Community
Stitch plan

Standard

 API availability

Available
Singer GitHub repository

singer-io/tap-invoiced
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

  1. Sign into your Invoiced account.
  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 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.

  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 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:

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:

  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.
  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 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.

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

credit_notes

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List all 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.

credit_notes table schema

id
INTEGER

The credit note ID.

Reference:

updated_at
DATE-TIME

The timestamp when the credit note was last updated.

balance
NUMBER

The balance owed on the credit note.

closed
BOOLEAN

If true, the credit note has been closed and is considered bad debt. No further payments are allowed.

created_at
DATE-TIME

The timestamp when the credit note was created.

currency
STRING

The three letter ISO code for the currency used in the credit note.

customer
INTEGER

The ID of the customer associated with the credit note.

Reference:

date
DATE-TIME

The date of the credit note.

discounts
ARRAY

The discounts associated with the credit note.

Click to expand discounts

id
INTEGER

The discount ID.

Reference:

object
STRING

This will be discount.

amount
INTEGER

The amount of the discount.

coupon
OBJECT

The coupon the discount was calculated from, if applicable.

expires
DATE-TIME

The time until the discount expires.
credit_notes (table), discounts (attribute)

draft
BOOLEAN

If false, the credit note is considered outstanding. If true, the credit note is a draft.

invoice
INTEGER

The ID of the invoice associated with the credit note.

Reference:

items
ARRAY

The line items associated with the credit note.

Click to expand items

id
INTEGER

The line item ID.

Reference:

object
STRING

This will be line_item.

catalog_item
STRING

The catalog item ID.

type
STRING

The line item type.

name
STRING

The name of the line item.

description
STRING

The description of the line item.

quantity
INTEGER

The quantity of the line item.

unit_cost
INTEGER

The unit cost or rate of the line item.

amount
INTEGER

The total amount of the line item, calculated as quantity x unit_cost.

discountable
BOOLEAN

If true, the line item is discountable and included in the credit note’s total discounts.

discounts
ARRAY

The discounts applicable to the line item.

Click to expand discounts

id
INTEGER

The discount ID.

Reference:

object
STRING

This will be discount.

amount
INTEGER

The amount of the discount.

coupon
OBJECT

The coupon the discount was calculated from, if applicable.

expires
DATE-TIME

The time until the discount expires.
credit_notes (table), discounts (attribute)

taxable
BOOLEAN

If true, the line item is taxable and included in the credit note’s total taxes.

taxes
ARRAY

The taxes applicable to the line item.

Click to expand taxes

id
INTEGER

The tax ID.

Reference:

object
STRING

This will be tax.

amount
NUMBER

The amount of tax.

tax_rate
NUMBER

The tax rate the tax was calculated from.
credit_notes (table), taxes (attribute)

metadata
OBJECT

Additional information about the line item.

Click to expand metadata


credit_notes (table), metadata (attribute)
credit_notes (table), items (attribute)

metadata
OBJECT

Additional information about the credit note.

Click to expand metadata


credit_notes (table), metadata (attribute)

name
STRING

The internal name of the credit note.

notes
STRING

Additional notes displayed on the credit note.

number
STRING

The reference number assigned to the credit note, used in the Invoiced dashboard.

paid
BOOLEAN

If true, the credit note has been paid in full.

status
STRING

The status of the credit note. Possible values are:

  • draft
  • open
  • paid
  • closed

subtotal
NUMBER

The subtotal of the credit note.

taxes
ARRAY

The taxes associated with the credit note.

Click to expand taxes

id
INTEGER

The tax ID.

Reference:

object
STRING

This will be tax.

amount
NUMBER

The amount of tax.

tax_rate
NUMBER

The tax rate the tax was calculated from.
credit_notes (table), taxes (attribute)

total
NUMBER

The total of the credit note.

customers

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List all customers

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

customers table schema

id
INTEGER

The customer ID.

Reference:

updated_at
DATE-TIME

The time the customer was last updated.

address1
STRING

The first line of the customer’s address.

address2
STRING

The second line of the customer’s address.

attention_to
STRING

Used for ATTN: address line if type: company.

autopay
BOOLEAN

If true, AutoPay is enabled for the customer.

chase
BOOLEAN

chasing_cadence
INTEGER

city
STRING

The city of the customer’s address.

country
STRING

The two-letter ISO code of the customer’s country.

created_at
DATE-TIME

The time the customer was created.

credit_hold
BOOLEAN

credit_limit
NUMBER

The credit limit for the customer.

email
STRING

The customer’s email address.

language
STRING

The two-letter ISO code of the customer’s language.

metadata
OBJECT

Additional information about the customer.

name
STRING

The name of the customer.

next_chase_step
INTEGER

notes
STRING

Additional notes about the customer.

number
STRING

A unique ID used to tie the customer to external systems.

parent_customer
INTEGER

payment_source
OBJECT

The customer’s payment source, if attached.

Click to expand payment_source

id
INTEGER

The payment source’s ID.

object
STRING

The object type of the payment source. Possible values are:

  • card
  • bank_account

brand
STRING

Applicable to object: card only. The card brand.

last4
STRING

The last four digits of the card or bank account.

exp_month
INTEGER

Applicable to object: card only. The expiry month.

exp_year
INTEGER

Applicable to object: card only. The expiry year.

funding
STRING

Applicable to object: card only. The funding instrument of the card. Possible values are:

  • credit
  • debit
  • prepaid
  • unknown

bank_name
STRING

Applicable to object: bank_account only. The name of the bank.

routing_number
STRING

Applicable to object: bank_account only. The routing number.

verified
BOOLEAN

Applicable to object: bank_account only. Indicates whether the bank account has been verified with instant verification or microdeposits.

currency
STRING

Applicable to object: bank_account only. The three letter ISO code used by the bank account.
customers (table), payment_source (attribute)

payment_terms
STRING

The payment terms for the customer when AutoPay is not enabled.

phone
STRING

The customer’s phone number.

postal_code
STRING

The customer’s postal code.

sign_up_page
INTEGER

The ID of the sign up page used by the customer.

state
STRING

The customer’s state.

tax_id
STRING

The customer’s tax ID.

taxable
BOOLEAN

If true, the customer is not tax exempt.

taxes
ARRAY

The taxes applicable to the customer.

Click to expand taxes

id
INTEGER

The tax ID.

Reference:

object
STRING

This will be tax.

amount
NUMBER

The amount of tax.

tax_rate
NUMBER

The tax rate the tax was calculated from.
customers (table), taxes (attribute)

type
STRING

The customer’s type. Possible values are:

  • company
  • person

estimates

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List all estimates

The estimates table contains info about the estimates, or quotes you provide to customers, in your Invoiced account.

estimates table schema

id
INTEGER

The estimate ID.

updated_at
DATE-TIME

The time the estimate was last updated.

approved
BOOLEAN

Indicates whether the estimate has been approved.

balance
NUMBER

The balance of the estimate.

closed
BOOLEAN

If true, an estimate is closed and considered bad debt. No further payments are allowed.

created_at
DATE-TIME

The time the estimate was created.

currency
STRING

The three letter ISO code used by the estimate.

customer
INTEGER

The ID of the customer associated with the estimate.

Reference:

date
DATE-TIME

The date of the estimate.

deposit
NUMBER

The deposit required for the estimate.

deposit_paid
BOOLEAN

Indicates whether the deposit has been paid in full.

discounts
ARRAY

The discounts applicable to the estimate.

Click to expand discounts

id
INTEGER

The discount ID.

Reference:

object
STRING

This will be discount.

amount
INTEGER

The amount of the discount.

coupon
OBJECT

The coupon the discount was calculated from, if applicable.

expires
DATE-TIME

The time until the discount expires.
estimates (table), discounts (attribute)

draft
BOOLEAN

If true, the estimate is a draft. If false, the estimate is considered outstanding.

expiration_date
DATE-TIME

The expiration date of the estimate.

invoice
INTEGER

The ID of the invoice associated with the estimate.

Reference:

items
ARRAY

The line items associated with the estimate.

Click to expand items

id
INTEGER

The line item ID.

Reference:

object
STRING

This will be line_item.

catalog_item
STRING

The catalog item ID.

type
STRING

The line item type.

name
STRING

The name of the line item.

description
STRING

The description of the line item.

quantity
INTEGER

The quantity of the line item.

unit_cost
INTEGER

The unit cost or rate of the line item.

amount
INTEGER

The total amount of the line item, calculated as quantity x unit_cost.

discountable
BOOLEAN

If true, the line item is discountable and included in the credit note’s total discounts.

discounts
ARRAY

The discounts applicable to the line item.

taxable
BOOLEAN

If true, the line item is taxable and included in the credit note’s total taxes.

taxes
ARRAY

The taxes applicable to the line item.

Click to expand taxes

id
INTEGER

The tax ID.

Reference:

object
STRING

This will be tax.

amount
NUMBER

The amount of tax.

tax_rate
NUMBER

The tax rate the tax was calculated from.
estimates (table), taxes (attribute)

metadata
OBJECT

Additional information about the line item.

Click to expand metadata


estimates (table), metadata (attribute)
estimates (table), items (attribute)

metadata
OBJECT

Additional information about the estimate.

name
STRING

The name of the estimate.

notes
STRING

Additional notes about the estimate.

number
STRING

The reference number assigned to the estimate.

paid
BOOLEAN

Indicates if the estimate has been paid.

payment_terms
STRING

The payment terms for the estimate.

status
STRING

The status of the estimate. Possible values are:

  • draft
  • not_sent
  • sent
  • approved
  • invoiced
  • declined

subtotal
NUMBER

The subtotal of the estimate.

taxes
ARRAY

The taxes applicable to the estimate.

Click to expand taxes

id
INTEGER

The tax ID.

Reference:

object
STRING

This will be tax.

amount
NUMBER

The amount of tax.

tax_rate
NUMBER

The tax rate the tax was calculated from.
estimates (table), taxes (attribute)

total
NUMBER

The total of the estimate.

invoices

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List all invoices

The invoices table contains info about the invoices in your Invoiced account. An invoice represents a balance owed to you by a customer.

invoices table schema

id
INTEGER

The invoice ID.

Reference:

updated_at
DATE-TIME

The time the invoice was last updated.

attempt_count
INTEGER

The number of payment attempts for the invoice.

autopay
BOOLEAN

If true, AutoPay is enabled for the invoice.

balance
NUMBER

The balance of the invoice.

closed
BOOLEAN

If true, an invoice is closed and considered bad debt. No further payments are allowed.

created_at
DATE-TIME

The time the invoice was created.

currency
STRING

The three letter ISO code used by the invoice.

customer
INTEGER

The ID of the customer associated with the invoice.

Reference:

date
DATE-TIME

The date of the invoice.

discounts
ARRAY

The discounts applicable to the estimate.

Click to expand discounts

id
INTEGER

The discount ID.

Reference:

object
STRING

This will be discount.

amount
INTEGER

The amount of the discount.

coupon
OBJECT

The coupon the discount was calculated from, if applicable.

expires
DATE-TIME

The time until the discount expires.
invoices (table), discounts (attribute)

draft
BOOLEAN

If true, the invoice is a draft. If false, the invoice is considered outstanding.

due_date
DATE-TIME

The due date of the invoice.

items
ARRAY

The line items associated with the invoice.

Click to expand items

id
INTEGER

The line item ID.

Reference:

object
STRING

This will be line_item.

catalog_item
STRING

The catalog item ID.

type
STRING

The line item type.

name
STRING

The name of the line item.

description
STRING

The description of the line item.

quantity
INTEGER

The quantity of the line item.

unit_cost
INTEGER

The unit cost or rate of the line item.

amount
INTEGER

The total amount of the line item, calculated as quantity x unit_cost.

discountable
BOOLEAN

If true, the line item is discountable and included in the credit note’s total discounts.

discounts
ARRAY

The discounts applicable to the line item.

Click to expand discounts

id
INTEGER

The discount ID.

Reference:

object
STRING

This will be discount.

amount
INTEGER

The amount of the discount.

coupon
OBJECT

The coupon the discount was calculated from, if applicable.

expires
DATE-TIME

The time until the discount expires.
invoices (table), discounts (attribute)

taxable
BOOLEAN

If true, the line item is taxable and included in the credit note’s total taxes.

taxes
ARRAY

The taxes applicable to the line item.

Click to expand taxes

id
INTEGER

The tax ID.

Reference:

object
STRING

This will be tax.

amount
NUMBER

The amount of tax.

tax_rate
NUMBER

The tax rate the tax was calculated from.
invoices (table), taxes (attribute)

metadata
OBJECT

Additional information about the line item.

Click to expand metadata


invoices (table), metadata (attribute)
invoices (table), items (attribute)

metadata
OBJECT

Additional information about the invoice.

name
STRING

The name of the invoice.

needs_attention
BOOLEAN

next_payment_attempt
DATE-TIME

The time of the next scheduled payment attempt, when in automatic collection.

notes
STRING

Additional notes about the invoice.

number
STRING

The reference number assigned to the invoice.

paid
BOOLEAN

Indicates whether an invoice has been paid in full.

payment_terms
STRING

The payment terms for the invoice.

status
STRING

The status of the invoice. Possible values are:

  • draft
  • not_sent
  • sent
  • viewed
  • past_due
  • pending
  • paid

subscription
INTEGER

The subscription ID, if the invoice came from a subscription.

Reference:

subtotal
NUMBER

The subtotal of the invoice.

taxes
ARRAY

The taxes applicable to the invoice.

Click to expand taxes

id
INTEGER

The tax ID.

Reference:

object
STRING

This will be tax.

amount
NUMBER

The amount of tax.

tax_rate
NUMBER

The tax rate the tax was calculated from.
invoices (table), taxes (attribute)

total
NUMBER

The total of the invoice.

plans

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List all 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.

plans table schema

amount
NUMBER

Plan amount. Not applicable when pricing mode is custom.

catalog_item
STRING

Item ID the plan belongs to

created_at
INTEGER

Timestamp when created

currency
STRING

3-letter ISO code

description
STRING

id
STRING

The plan’s unique ID

interval
STRING

One of day, week, month, year. The frequency with which a subscription should be billed.

interval_count
INTEGER

The number of intervals between each subscription billing. Defaults to 1.

metadata
OBJECT

A hash of key/value pairs that can store additional information about this object.

name
STRING

Plan name

notes
STRING

object
STRING

Object type, plan

pricing_mode
STRING

per_unit, volume, tiered or custom

quantity_type
STRING

constant or usage

tiers
OBJECT

updated_at
INTEGER

Timestamp when updated

subscriptions

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List all subscriptions

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

subscriptions table schema

id
INTEGER

The subscription ID.

Reference:

updated_at
DATE-TIME

The time the subscription was last updated.

addons
ARRAY

Details about subscription’s add ons.

Click to expand addons

id
INTEGER

The subscription ID.

object
STRING

This will be subscription_addon.

plan
INTEGER

The ID of the plan associated with the subscription.

Reference:

quantity
INTEGER

The quantity of the subscription add on.

description
STRING

The description of the add on.

created_at
DATE-TIME

The time when the add on was created.
subscriptions (table), addons (attribute)

cancel_at_period_end
BOOLEAN

If true, the subscription will be canceled at the end of the current billing period.

canceled_at
DATE-TIME

The time when the subscription was canceled.

contract_period_end
DATE-TIME

contract_period_start
DATE-TIME

contract_renewal_cycles
INTEGER

contract_renewal_mode
STRING

created_at
DATE-TIME

The time when the subscription was created.

customer
INTEGER

The ID of the customer associated with the subscription.

Reference:

cycles
INTEGER

The number of billing cycles the subscription runs for. When null, the subscription will run until canceled.

discounts
ARRAY

The discounts applicable to the subscription.

Click to expand discounts

id
INTEGER

The discount ID.

Reference:

object
STRING

This will be discount.

amount
INTEGER

The amount of the discount.

coupon
OBJECT

The coupon the discount was calculated from, if applicable.

expires
DATE-TIME

The time until the discount expires.
subscriptions (table), discounts (attribute)

metadata
OBJECT

mrr
NUMBER

The amount the subscription contributes to monthly recurring revenue.

period_end
DATE-TIME

The start of the current billing period.

period_start
DATE-TIME

The end of the current billing period.

plan
STRING

The ID of the plan associated with the subscription.

Reference:

quantity
NUMBER

The plan quantity.

recurring_total
NUMBER

The total recurring amount, including taxes.

renewed_last
DATE-TIME

The date the subscription was last renewed.

renews_next
DATE-TIME

The date the subscription renews next.

start_date
DATE-TIME

The time the subscription starts, or started.

status
STRING

The status of the subscription. Possible values are:

  • not_started
  • active
  • past_due
  • finished
  • canceled

taxes
ARRAY

The taxes applicable to the subscription.

Click to expand taxes

id
INTEGER

The tax ID.

Reference:

object
STRING

This will be tax.

amount
NUMBER

The amount of tax.

tax_rate
NUMBER

The tax rate the tax was calculated from.
subscriptions (table), taxes (attribute)

transactions

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

updated_at
Primary Key :

id

 API endpoint :

List all transactions

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

transactions table schema

id
INTEGER

The transaction ID.

Reference:

updated_at
DATE-TIME

The time the transaction was last updated.

amount
NUMBER

The amount of the transaction.

created_at
DATE-TIME

The time the transaction was created.

credit_note
INTEGER

The ID of the credit note associated with the transaction, if any.

Reference:

currency
STRING

The three letter ISO code used by the transaction.

customer
INTEGER

The ID of the customer associated with the estimate.

Reference:

date
DATE-TIME

The date of the transaction.

failure_reason
STRING

The failure message from the payment gateway when status: failed.

gateway
STRING

The payment gateway that processed the transaction, if any.

gateway_id
STRING

The transaction ID from the payment gateway.

invoice
INTEGER

The ID of the invoice associated with the transaction, if any.

metadata
OBJECT

Additional details about the transaction.

method
STRING

The payment instrument used to facilitate the transaction. Possible values are:

  • credit_card
  • ach
  • direct_debit
  • paypal
  • wire_transfer
  • check
  • cash
  • other

notes
STRING

Additional notes about the transaction.

parent_transaction
INTEGER

For refunds, the ID of the original transaction.

Reference:

payment_source
OBJECT

The transactions’s payment source, if attached.

Click to expand payment_source

id
INTEGER

The payment source’s ID.

object
STRING

The object type of the payment source. Possible values are:

  • card
  • bank_account

brand
STRING

Applicable to object: card only. The card brand.

last4
STRING

The last four digits of the card or bank account.

exp_month
INTEGER

Applicable to object: card only. The expiry month.

exp_year
INTEGER

Applicable to object: card only. The expiry year.

funding
STRING

Applicable to object: card only. The funding instrument of the card. Possible values are:

  • credit
  • debit
  • prepaid
  • unknown

bank_name
STRING

Applicable to object: bank_account only. The name of the bank.

routing_number
STRING

Applicable to object: bank_account only. The routing number.

verified
BOOLEAN

Applicable to object: bank_account only. Indicates whether the bank account has been verified with instant verification or microdeposits.

currency
STRING

Applicable to object: bank_account only. The three letter ISO code used by the bank account.
transactions (table), payment_source (attribute)

status
STRING

The status of the transaction. Possible values are:

  • succeeded
  • pending
  • failed

type
STRING

The type of the transaction. Possible values are:

  • charge
  • payment
  • refund
  • adjustment
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.