Overview
The Lyftron Provider for Codat offers the most natural way to access Codat data from Lyftron with ease and also enables to connect with BI, MDM & ML tools, Data warehouses, Databases and other SAAS based applications with zero code and zero infrastructure requirements. The provider wraps the complexity of accessing Codat data into easy-to-integrate relational fully managed ANSI Sql format. Make faster and better business decisions with Lyftron’s Codat data provider and automatically build your data migration pipelines in minutes, not months
The provider hides the complexity of accessing data and provides additional powerful security features, smart caching, batching, socket management, and more.
Key Features
- Comprehensive Delta load mechanism.
- Real-time access to Codat.
- Comprehensive full support of ANSI Sql to query data with ease.
- Collaborative query processing.
Prerequisites
The user must have credentials for Codat, Lyftron and your destination data warehouse, lake or database to perform the data pipeline operation with Lyftron
Establishing a Connection with Lyftron's Quickstart Steps
Create your Codat connection with Lyftron by following the 5 easy steps show below:
Step1. Add your connection
Click on Connect section on the left panel → Click on Add Connection button
Step2. Select your connector
In the connector selection panel, search and click Codat for your connection
Step3. Enter your connection details
In the Connection String section enter the values of the below parameters. The following connection string is required to establish Codat connection with Lyftron.
Profile=C:\profiles\Codat.apip;ProfileSettings='Api-Key=my_api_token'Key | Value | Field |
Connection Name | Enter your connection details | Required |
Profile | C:\profiles\Codat.apip | Required |
Api-Key | your Codat api_token | Required |
Logfile** | Use the logfile option to debug your job and provide your connection name to generate the log file. [ConnectionConfigurationPath]\Connection_name_log.tx | Optional |
Verbosity** | Choose verbosity 1-5 based on the severity of debugging | Optional |
** For more information, check the Lyftron logging and debugging section.
If you want more detailed information about how to establish a connection with Lyftron, click on Lyftron Connection Quick Start guide.
Step4. Test your connection
Once you are done entering your connection details, simply click on the Test Connection button to test the connectivity. In case your connection fails, add Logfile and Verbosity parameters and check the Lyftron logging and debugging section, to debug the error.
Step5. Save your connection
Hurray! Now you have successfully connected with the Lyftron Codat connector and can utilize the connector to Extract, Warehouse, Analyze, Visualize and Share your data.
Data Model
The provider models the data in APIs into a list of tables that can be queried using standard SQL statements.
Generally, querying APIs 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.
Name | Type | Description |
Accounts | Tables | Gets the latest chart of accounts for a company |
AgedCreditorReport | Tables | Gets the aged creditor report for a company |
AgedDebtorReport | Tables | Gets the aged debtor report for a company |
BalanceSheet | Tables | Gets the latest balance sheet for a company. |
BankAccounts | Tables | Gets bank accounts info |
BankStatements | Tables | Gets the latest bank statements for a company |
BankStatementsAccounts | Tables | Gets the latest bank statements for a company |
BillPayments | Tables | Gets the latest billPayments for a company |
Bills | Tables | Gets the latest bills for a company |
Companies | Tables | Fetch a list of all companies metadata with accounting links on the Codat platform |
CompanyInfo | Tables | Gets the latest basic info for a company |
Connections | Tables | Gets connections for a company |
CreditNotes | Tables | Gets a list of all credit notes for a company |
Customers | Tables | Gets the latest bank statements for a company |
DataSets | Tables | Fetch a list of all data snapshots captured for a company |
IntegrationBankSettings | Tables | Gets Bank Settings for integrations for your account |
Integrations | Tables | Gets integrations for your account |
Invoices | Tables | Gets the latest invoices for a company |
Items | Tables | Gets the items for a given company |
Journals | Tables | Gets the latest journal entries for a company |
Payments | Tables | Gets the latest payments for a company |
Profile | Tables | Fetch your organisations company profile |
ProfileSyncSettings | Tables | Fetch your profile sync settings |
ProfitAndLoss | Tables | Gets the latest profit and loss for a company. |
Suppliers | Tables | Gets the latest suppliers for a company |
TaxRates | Tables | Gets the latest tax rates for a given company. |
Transactions | Tables | Gets the latest bank transactions for given account ID and company. |
Advanced Settings
To view a detailed advanced settings options, go to Codat Advanced Settings. Complete list of the parameters you can configure in the connection string can be found by clicking Connection String Parameters.