Invoiced

Invoiced is an accounts receivable automation solution designed for growing businesses. It is a billing system that allows businesses to accept online payments in just a few clicks from multiple modes, including credit cards, ACH, Bitcoin, and PayPal. The app aims to effectively help businesses get paid on time with less effort.

You can replicate the data from your Invoiced account to a Destination database or data warehouse using Hevo Pipelines. Hevo ingests the data objects in Full Load mode. Refer to section, Data Model for the list of supported objects.

Invoiced authenticates API requests from Hevo to access your account data with HTTP Basic authentication.


Prerequisites

  • An active Invoiced account from which data is to be ingested.

  • An API key is available to authenticate Hevo on your Invoiced account.

  • You are logged in as an Admin user, to generate or obtain the API key. Else, you can obtain the API key from your administrator. Read Roles for information on user roles in Invoiced.


Obtaining the API Key

The API keys you generate in Invoiced do not expire. Therefore, you can use an existing key or create one now to authenticate Hevo on your Invoiced account. Invoiced recommends creating a separate API key for each application that will be making calls on your behalf. For example, you can create one API key for Hevo, to be used across all your Pipelines. However, you can also use a different API key for each Pipeline.

Note: You must be logged in as an Admin user to obtain the API key.

To retrieve the API key:

  1. Sign in to your account on invoiced.com.

    Invoiced Login

  2. In the dashboard, click on Settings in the left pane.

    Invoiced settings

  3. Scroll down to the Integrations block and click on Developers.

    Developers section

  4. In the Developers page, do one of the following:

    • Create an API key:

      1. Click New API Key.

        New API Key

      2. Provide a Description for the API key that helps you easily identify it later.

      3. Click Save. The new key is added to the API Keys list.

      4. Click on Show in the SECRET column to reveal the key.

        Copy the new API key

    • Use an existing API key.

      1. Scroll to the desired key description and click on Show in the SECRET column, to reveal the key.

        Copy an existing API key

  5. Copy the API key and save it securely like any other password.


Configuring Invoiced as a Source

Perform the following steps to configure Invoiced as the Source in your Pipeline:

  1. Click PIPELINES in the Asset Palette.

  2. Click + CREATE in the Pipelines List View.

  3. In the Select Source Type page, select Invoiced.

  4. In the Configure your Invoiced Source page, specify the following:

  5. Click TEST & CONTINUE.

  6. Proceed to configuring the data ingestion and setting up the Destination.


Data Replication

Default Pipeline Frequency Minimum Pipeline Frequency Maximum Pipeline Frequency Custom Frequency Range (Hrs)
1 Hr 1 Hr 24 Hrs 1-24

Note: You must set the custom frequency in hours as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.

Hevo fetches all the objects in Full Load mode in each run of the Pipeline.


Source Considerations

None.

Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination:


Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:

Object Description
Customers Contains details about the entity that you are billing, for example, an organization or individual.
Invoices Contains details of the balance owed by a customer. Each invoice has a collection of line items that detail the products or services that are now due.
Payments Contains details of a customer payment. Payments can include payments processed through Invoiced, cash receipts such as wire transfers and check, and application of credit note and spending credit balances.
Subscriptions Contains details of any recurring billing that you set up for your customers.
Credit Notes Contains details of the balance you owe to a customer. Like an invoice, each credit note has a collection of line items that detail the products or services that are credited to the customer.
Estimates Contains details of any quote provided to a customer. Like an invoice, each estimate has a collection of line items that detail the products or services that might be credited to the customer.
Credit balance adjustments Contains an account credit system that lets you grant credits to customers, which can be applied to future invoices.

Limitations

  • Hevo currently does not support deletes. Therefore, any data deleted in the Source may continue to exist in the Destination.

  • The data is loaded in Full Load mode in each Pipeline run. As a result, you cannot load the historical data alone at any time.


Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Jun-06-2022 1.90 New document.
Last updated on 29 Jun 2022