Skip to content
Submit a Request
  • There are no suggestions because the search field is empty.

How to Ingest Data

Contents

 

The “Ingest” page simplifies the data ingestion process, enabling you to upload CSV and/or JSONL files, identify any data formatting errors, and track the ingestion status of a file, without assistance from the Taxbit team.

We currently support the upload of the following file types to the Taxbit Dashboard. Please refer to the guides linked below for the supported templates for each:


Upload a File



Step 1: Select the relevant data type of the file you want to upload (i.e., Accounts, Transactions, Form Data), by clicking on the appropriate type from the drop-down.

Please note: In some cases, there may be multiple templates for a given data type. Please select the specific template that you are looking to upload.

Step 2: Download the relevant Taxbit CSV template by selecting the type of template from the drop-down, then selecting the “Download Template” button on the right.

Your data must be organized according to this CSV template for successful ingestion into the Dashboard. Additionally, a guide is available for download to clarify the requirements for each column in the CSV template, which can be downloaded by selecting the “Follow the guide” link in the Upload File section.

Step 3: Next, to upload a file, either drag and drop it into the uploader or select browse files to choose the appropriate file(s). Before uploading, you can use the auto-ingest toggle to determine whether the file should move forward automatically after validation when no errors or warnings are found. If there are any errors or warnings, the file will require manual approval before ingesting – more details in Step 4. Once your file(s) are selected, select Upload File from the bottom to begin the upload.

Please note the following:

  • Only CSV or JSONL files are accepted (a JSONL file is only acceptable for Transaction data). All other file types (for example, XLSX files) will be rejected.
  • Up to 10 files can be uploaded at one time. If more than one file is uploaded, the files will queue and process sequentially.
  • An error message will alert you immediately if the headers included in your CSV file do not align with those in the relevant, acceptable template.
  • You must remain on the Ingest page of the Taxbit Dashboard until the upload is complete, which is indicated by the file appearing in the file history table at the bottom of the screen with a status of Validating or Queued.


Validation & Review

After your file is uploaded, it will undergo validation to verify that all fields are correctly formatted and meet Taxbit's system requirements. Throughout this period, you may see the following statuses reflected under the Status column:

  • Queued
    • The file has been uploaded successfully and is waiting for the currently processing file to complete before validation or processing begins.
  • Validating
    • The file is being validated for any errors before ingesting.
  • Invalid
    • All rows in the file have an error that prevents ingestion. Please refer to the template guides outlined in the first section to correct the file before attempting to ingest it again.
  • Contact Support
    • There was a problem during validation. Please contact our support team via the online support form or via the in-app widget, with the name of your organization and the file that caused the error, and we will investigate further.
  • Needs Review
    • Validation has completed, and the file requires user review before ingestion. This status applies when auto-ingest is turned off, or when the file contains errors or warnings that must be reviewed before approval. Files with auto-ingest enabled and zero errors or warnings will bypass Needs Review and move directly to Processing.

 

 

Step 4: Once the file has been validated and is in a state of Needs Review, you’ll need to choose if you’d like to approve or reject the ingestion. To review the validations, select the three dots on the right side of the file and Download Summary Reports. The summary reports will include the following:

  • Error & Warnings Details
    • The detailed report offers a line-by-line breakdown of errors and warnings encountered during validation. This report will only be available after validation if errors and/or warnings are identified in your data.
  • Error & Warnings Summary
    • The summary report gives an overview/count of the errors and warnings detected. This report will only be available after validation if errors and/or warnings are identified in your data.
  • New Records
    • The New Records report provides a list of IDs that do not currently exist in Taxbit’s system and will be created if the file is approved.
  • Updated Records
    • The Updated Records report provides a list of IDs that already exist in Taxbit’s system and will be updated (i.e., overwritten) if the file is approved.

 


Approve or Reject

This step is only required when auto-ingest is turned off, or when a file contains errors or warnings that require user review. Files that are auto-ingested and have zero errors or warnings will skip this step and move directly to Processing:

Step 5: Select the three dots to the right of the file.

Step 6: Select “Review File”.

Step 7: Review the next window to ensure the number of rows of data you intend to ingest

Step 8: Select “Approve File” to ingest all Valid data. Or select “Reject File” to reject the entire file from ingesting.

Once you’ve reviewed the file, the status will update to one of the following:

  • Processing
    • The file has been approved and is in the process of being ingested into the Dashboard. Once processing has finished, the file will move to a status of Complete.
  • Rejected
    • The file has been rejected and will not be ingested into the Dashboard.


Other Available Options

Cancel Queued File

This option is available from the row menu for any file in Queued status. Selecting this option cancels the file before it begins processing. The file will still remain downloadable after it has been canceled.

Download File

Select this button to download the ingested file from the Dashboard to your device.

Edit Description

From here, you can edit the file "Description" to include any important information/information about that particular file as needed. This will appear under the "Description" column next to the associated file on the Ingest page.

Remove

For any files with the status of “Invalid” or “Rejected”, a button will appear at the bottom of this box to remove the file, as it will not be ingested.