API Data Provider - Online Help

Harvest Tables

The provider models the data in API into a list of tables that can be queried using standard SQL statements.

Generally, querying API tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Harvest Tables

Name Description
AuthenticatedUser Returns a list of your users.
Clients Returns a list of your clients.
Company Retrieves the company for the currently authenticated user.
Contacts Returns a list of your contacts
EstimateItemCategories Returns a list of your estimate item categories.
EstimateMessages Returns a list of messages associated with a given estimate
Estimates Returns a list of your estimates
ExpenseCategories Returns a list of your expense categories.
Expenses Returns a list of your expenses
InvoiceItemCategories Returns a list of your invoice item categories.
InvoiceMessages Returns a list of messages associated with a given invoice
InvoicePayments Returns a list of payments associate with a given invoice
Invoices Returns a list of your invoices
Projects Returns a list of your projects
ProjectTaskAssignments Returns a list of your task assignments.
ProjectUserAssignments Returns a list of your user assignments.
Roles Returns a list of roles in the account
Tasks Returns a list of your tasks.
TimeEntries Returns a list of your expenses
UserCostRates Returns a list of cost rates for the specified user.
ProjectUserAssignments Returns a list of your project assignments for the specified user.
Users Returns a list of your users.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8487.0