Movatterモバイル変換


[0]ホーム

URL:


DOCS >INTEGRATIONS >SAAS >INVOICED (V1)

Get started with a free trial today

Already have an account? Sign in

Invoiced (v1)

Invoiced is supported by the Singer community
This integration is powered bySinger's Invoiced tap. For support,visit the GitHub repo orjoin the Singer Slack.

Invoiced integration summary

Stitch’s Invoiced integration replicates data using theInvoiced REST API. Refer to theSchema 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. ClickSettings on the left side of the page.
  3. In theBusiness Settings section, clickDevelopers.
  4. On the Developers page, click theNew API Key button. ANew API Key window will display.
  5. In theKey Description field, enter a description that identifies the API key. For example:Stitch
  6. ClickSave. 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 theShow 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 theAdd Integration button.

  3. Click theInvoiced 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 calledstitch_invoiced in the destination.Note: Schema names cannot be changed after you save the integration.

  5. In theAPI Key field, paste your Invoiced API key.
  6. If the Invoiced instance you’re connecting to is a sandbox, check theIs 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 dataequal 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 of1 year. For a detailed look at historical replication jobs, check out theSyncing Historical SaaS Data guide.

Step 4: Create a replication schedule

Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to theReplication Scheduling documentation for more information.

In theReplication Frequency section, you’ll create the integration’sreplication 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 theUnderstanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 5: Set objects to replicate

Is an object missing or not replicating? Verify that the object meets the requirements forselection andreplication.

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’sTables to Replicate tab, locate a table you want to replicate.
  2. To track a table, click thecheckbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click thecheckbox 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 theFinalize Your Selections button at the bottom of the screen to save your selections.
Important: Using theSelect All feature will overwrite any previous selections. However, selections aren’t final untilFinalize Your Selections is clicked. ClickingCancel will restore your previous selections.Refer to theSelect All guide for more info about this feature.
  1. Click into the integration from the Stitch Dashboard page.
  2. Click theTables to Replicate tab.

  3. In the list of tables, click the box next to theTable Names column.
  4. In the menu that displays, clickTrack all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab

  5. Click theFinalize 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, itsSync Status may show asPending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, aPending 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 theAnchor 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.

Replication will continue after the seven days are over. If you’re no longer interested in this source, be sure topause ordelete the integration to prevent unwanted usage.

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 forversion 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 theLoading Guide for your destination for more info.

credit_notes

Thecredit_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

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

credit_notes schema on GitHub

Invoiced API method

Join credit_notes withon
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

id

INTEGER

balance

NUMBER

closed

BOOLEAN

currency

STRING

customer

INTEGER

date

STRING

discounts

ARRAY

draft

BOOLEAN

items

ARRAY

invoice

INTEGER

metadata

OBJECT

name

STRING

notes

STRING

number

STRING

paid

BOOLEAN

status

STRING

subtotal

NUMBER

taxes

ARRAY

total

NUMBER

created_at

STRING

updated_at

STRING

purchase_order

STRING

url

STRING

pdf_url

STRING

object

STRING

customers

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

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

customers schema on GitHub

Invoiced API method

Join customers withon
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

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

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

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

Theestimates table contains info about the estimates in your Invoiced account.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

estimates schema on GitHub

Invoiced API method

Join estimates withon
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

id

INTEGER

approved

BOOLEAN

balance

NUMBER

closed

BOOLEAN

currency

STRING

customer

INTEGER

date

STRING

deposit

NUMBER

deposit_paid

BOOLEAN

discounts

ARRAY

draft

BOOLEAN

expiration_date

STRING

items

ARRAY

invoice

INTEGER

metadata

OBJECT

name

STRING

notes

STRING

number

STRING

payment_terms

STRING

status

STRING

subtotal

NUMBER

taxes

ARRAY

total

NUMBER

created_at

STRING

updated_at

STRING

purchase_order

STRING

ship_to

OBJECT

url

STRING

pdf_url

STRING

object

STRING

invoices

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

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

invoices schema on GitHub

Invoiced API method

Join invoices withon
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

id

INTEGER

attempt_count

INTEGER

autopay

BOOLEAN

balance

NUMBER

closed

BOOLEAN

currency

STRING

customer

INTEGER

date

STRING

discounts

ARRAY

draft

BOOLEAN

due_date

STRING

items

ARRAY

metadata

OBJECT

name

STRING

next_payment_attempt

STRING

notes

STRING

number

STRING

paid

BOOLEAN

payment_terms

STRING

status

STRING

subscription

INTEGER

subtotal

NUMBER

taxes

ARRAY

total

NUMBER

created_at

STRING

updated_at

STRING

purchase_order

STRING

ship_to

OBJECT

payment_plan

INTEGER

url

STRING

payment_url

STRING

pdf_url

STRING

object

STRING

plans

Theplans 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

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

plans schema on GitHub

Invoiced API method

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

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

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

subscriptions schema on GitHub

Invoiced API method

Join subscriptions withon
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

id

INTEGER

addons

ARRAY

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

metadata

OBJECT

mrr

NUMBER

period_end

STRING

period_start

STRING

plan

STRING

quantity

INTEGER

recurring_total

NUMBER

start_date

STRING

status

STRING

taxes

ARRAY

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

RelatedTroubleshooting

Questions? Feedback?

Did this article help? If you have questions or feedback, feel free tosubmit a pull request with your suggestions,open an issue on GitHub, orreach out to us.


[8]ページ先頭

©2009-2026 Movatter.jp