API Data Provider - Online Help

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

FreeAgent Tables

Name Description
BankAccounts Returns bank account info.
BankTransactionExplanations Returns bank transaction explanations.
BankTransactions List all bank transactions under a certain bank account.
Bills Returns all bills.
CapitalAssets Returns all bills related to a Project.
Company Returns company info.
ContactBills Returns all bills related to a contact.
ContactCreditNotes Returns all credit notes related to a contact.
ContactEstimates Returns all estimates related to a contact.
ContactInvoices Returns all invoices related to a contact.
ContactNotes Returns all notes related to a contact.
ContactProjects Returns all projects related to a contact.
ContactRecurringInvoices Returns all recurring invoices related to a contact.
Contacts Returns all contacts.
CreditNoteReconciliations Returns all credit note reconciliations.
CreditNotes Returns all credit notes.
Estimates Returns all estimates.
Expenses Returns all expenses.
InvoiceEstimates Returns all estimates related to an invoice.
Invoices Returns all invoices.
InvoicesTimeline Returns all invoices timeline.
JournalSets Returns all journal sets.
OpeningBalances Returns the opening balances.
PayrollPeriods Returns the list of all payroll periods for the given year end. For example, for the payroll year April 2020 - March 2021, the Year parameter should be 2021.
Payslips Returns the list of all payslips for the given year and period.
PriceListItems Returns all price list items.
ProfitAndLoss Returns the profit and loss for the current accounting period.
ProjectBills Returns all bills related to a Project.
ProjectCreditNotes Returns all credit notes related to a project.
ProjectEstimates Returns all estimates related to a project.
ProjectInvoices Returns all invoices related to a project.
ProjectNotes Returns all notes related to a project.
Projects Returns all projects.
ProjectTasks Returns all tasks related to a project.
ProjectTimeslips Returns all timeslips related to a project.
RecurringInvoices Returns all recurring invoices.
SalesTaxPeriods Returns all sales tax periods for a company. Only available to US and Universal companies.
StockItems Returns all stock items.
Tasks Returns all tasks.
TaskTimeslips Returns all timeslips related to a task.
Timeslips Returns all timeslips.
TrialBalance Returns the trial balance summary.
TrialBalanceOpeningBalances Returns the opening balances.
Users Returns all users.
UserTimeslips Returns all timeslips related to a user.

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