API Data Provider - Online Help

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

ZarMoney Tables

Name Description
Classes Returns all classes.
Customers Returns all customers.
CustomerTransactions Retrieves a list of customer transaction objects based on a given criteria.
ExpenseAttachments Retrieves a list of expense attachments.
Expenses Retrieves a list of expense objects based on a given criteria.
FinancialAccounts Returns a list of available financial accounts.
FinancialAccountTypes Returns a list of available financial account types.
ItemCustomFields Retrieves a list of available itemCustomField objects for a given item.
ItemImages Retrieves a list of available itemImages objects for a given item.
ItemPriceLevels Retrieves a list of available itemPriceLevel objects for a given item.
ItemQuantities Retrieves a list of available itemQuantity objects for a given Inventory, Non-Inventory, or Service item.
Items Returns all items.
PaymentMethods Returns all payments.
Payments Returns all payments.
PaymentTerms Returns all payments.
PriceLevels Retrieves a list of available price level objects.
ProfitLossReport Retrieves the profit and loss stats for the 'current year'.
PurchaseAttachments Retrieves a list of purchase attachments.
PurchaseCustomFields Retrieves a list of available purchase custom field objects.
Purchases Retrieves a list of purchase objects based on a given criteria.
PurchasesReport Retrieves the purchases stats for the 'current year'.
SaleAttachments Retrieves a list of sale attachments.
SaleCustomFields Retrieves a list of available sale custom field objects.
Sales Retrieves a list of sale objects based on a given criteria.
SalesReport Retrieves the sales stats for the 'current year'.
SaleStatuses Retrieves a list of available sale statuses.
ShippingMethods Retrieves a list of shipping methods.
Sites Retrieves a list of site objects.
TaxAgencies Retrieves a list of all tax agencies.
TaxGroups Retrieves a list of all tax groups.
TaxItems Retrieves a list of all tax items.
TaxTypes Retrieves a list of all tax types.
UmSets Retrieves a list of all umSet objects.
Users Returns all users.
Vendors Returns all vendors.
VendorTransactions Retrieves a list of vendor transaction objects based on a given criteria.

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