This integration is powered by Singer's Codat tap. For support, visit the GitHub repo or join the Singer Slack.
Codat integration summary
Stitch’s Codat integration replicates data using the Codat API . Refer to the Schema section for a list of objects available for replication.
Codat feature snapshot
A high-level look at Stitch's Codat integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release Status |
Released |
Supported By | |
Stitch Plan |
Free |
Singer GitHub Repository | |
DATA SELECTION | |||
Table Selection |
Supported |
Column Selection |
Unsupported |
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Unsupported |
Table-level Reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Codat
Codat setup requirements
To set up Codat in Stitch, you need:
-
Administrator or Developer privileges in Codat. These are required to generate an API key. Refer to Codat’s documentation for more info.
Step 1: Retrieve your Codat API key
- Sign into your Codat account.
- Click Accounts > Profile in the sidenav.
- On the Manage Profile page, locate the API Key field.
- Click the copy icon to copy the API key.
Paste the API key somewhere handy - you’ll need it in the next step.
Step 2: Add Codat as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Codat icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Codat” would create a schema called
stitch_codat
in the destination. Note: Schema names cannot be changed after you save the integration. - In the API Key field, paste the Codat API key you generated in Step 1.
-
Check the Use Codat UAT environment box if you’re connecting to your UAT (sandbox) environment in Codat.
Note: Use this setting only if you are connecting to a UAT (sandbox) Codat instance. Checking this box when the instance isn’t a sandbox will prevent a successful connection and
401 Bad Credentials
errors in the connection check logs.
Step 3: Define the historical sync
The Sync Historical Data setting will define the starting date for your Codat integration. This means that:
- For tables using Incremental Replication, data equal to or newer than this date will be replicated to your data warehouse.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond Codat’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 4: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Codat integrations support the following replication scheduling methods:
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 5: Set tables to replicate
To complete the setup, you’ll need to select the tables you want to replicate to your data warehouse.
Check out the Schema section to learn more about the available tables in Codat and how they replicate.
- In the list of tables that displays - or in the Tables to Replicate tab, if you skipped this step during setup - locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A green checkmark means the table is set to replicate.
- Repeat this process for all the tables you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
Note: If you change these settings while a replication job is still in progress, they will not be used until the next job starts.
Initial and historical replication jobs
After you finish setting up Codat, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Codat table schemas
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
accounts
Replication Method : |
Full Table |
Primary Key : |
id : companyId |
API endpoint : |
The accounts
table contains info about the accounts in your Codat instance. In Codat, an account is a category used to record accounting transactions for a business.
id
The account ID. Reference:
|
companyId
The ID of the company associated with the account. Reference: |
currency
The currency of the account. |
currentBalance
The current balance of the account. |
fullyQualifiedName
The full name of the account. For example: |
isBankAccount
Indicates if the account is a bank account. |
name
The name of the account. |
nominalCode
The reference given to each nominal account for a business. |
status
The status of the account. Possible values are:
|
type
The type of account. Possible values are:
|
balance_sheets
Replication Method : |
Full Table |
Primary Key : |
companyId |
API endpoint : |
The balance_sheets
table contains info about the balance sheets in your Codat instance. A balance sheet is a snapshot at a point in time of a company’s accounts.
companyId
The ID of the company the balance sheet is for. |
||||||||||||||
currency
The currency of the balance sheet. |
||||||||||||||
mostRecentAvailableMonth
The most recent available month from which report data can be shown. |
||||||||||||||
reports
A list of balance sheet reports.
|
||||||||||||||
status
|
bank_statements
Replication Method : |
Full Table |
Primary Key : |
id : companyId |
API endpoint : |
The bank_statements
table contains info about bank statement report data for a company over a time period.
id
The bank statement ID. |
||||||
companyId
The ID of the company associated with the account. |
||||||
accountName
The name of the bank account. |
||||||
accountNumber
The account number for the bank account. |
||||||
availableBalance
The total available balance of the bank account, as reported by the underlying data source. |
||||||
balance
The balance of the bank account. |
||||||
currency
The currency of the bank account. |
||||||
details
Details about the transactions contained in the bank statement.
|
||||||
fromDate
|
||||||
iban
The international bank account number of the account. |
||||||
sortCode
The sort code for the bank account. |
||||||
toDate
|
Replication Method : |
Full Table |
Primary Key : |
companyId : id |
API endpoint : |
The bills
table contains info about the bills in your Codat account. A bill is an itemized record of goods or services purchased from a supplier.
companyId
The ID of the company associated with the bill. |
id
The bill ID. |
amountDue
The amount due for the bill. |
currency
The currency of the bill. |
dueDate
The date the bill is due to be paid by. |
issueDate
The date the bill was recorded in the accounting system. |
reference
A user-friendly identifier for the bill. |
status
The status of the bill. Possible values are:
|
subTotal
The total amount of the bill, excluding any taxes. |
supplierRef
The supplier the bill has been received from. Reference: |
taxAmount
The amount of tax on the bill. |
totalAmount
The total amount of the bill, including tax. |
companies
Replication Method : |
Full Table |
Primary Key : |
id |
API endpoint : |
The companies
table contains info about the companies in your Codat instance. A company represents a business who can share the connection to their financial data sources.
id
The company ID. |
lastSync
|
name
The name of the company. |
platform
|
redirect
|
status
|
company_info
Replication Method : |
Full Table |
Primary Key : |
companyId |
API endpoint : |
The company_info
table contains company info. In Codat, company info includes information about a linked company such as address, phone number and company registration.
companyId
The company ID. Reference: |
|||||||
accountingPlatformRef
A company reference as provided by some accounting platforms. |
|||||||
addresses
A list of addresses associated with the company.
|
|||||||
baseCurrency
The currency set in the linked company’s accounting platform. |
|||||||
companyLegalName
The legal registered name of the linked company. |
|||||||
companyName
The name of the linked company. |
|||||||
createdDate
The date the linked company was created in the accounting platform. |
|||||||
financialYearStartDate
The date for the start of the company’s financial year. |
|||||||
phoneNumbers
A list of phone numbers associated with the linked company.
|
|||||||
registrationNumber
The registration number given to the linked company by the companies authority in the country of origin. |
|||||||
taxNumber
The company tax number. |
|||||||
webLinks
A list of web links associated with the company.
|
credit_notes
Replication Method : |
Full Table |
Primary Key : |
id : companyId |
API endpoint : |
The credit_notes
table contains info about the credit notes in your Codat instance.
id
The credit note ID. Reference: |
|||||
companyId
The ID of the company associated with the credit note. |
|||||
creditNoteNumber
A user-friendly reference for the credit note. |
|||||
currency
The currency for the credit note. |
|||||
customerRef
Details about the customer the credit note has been issued to.
|
|||||
issueDate
The date of the credit note as recorded in the accounting system. |
|||||
paymentAllocations
A list of credit note payment allocations.
|
|||||
remainingCredit
The unused balance of the |
|||||
status
The status of the credit note. Possible values are:
|
|||||
totalAmount
The total amount of the credit that has been applied to the customer’s account receivable. |
customers
Replication Method : |
Full Table |
Primary Key : |
companyId : id |
API endpoint : |
The customers
table contains info about the customers in your Codat instance. A customer is a person or organisation that buys goods or services.
companyId
The ID of the company associated with the customer. Reference: |
|||||||||||||||
id
The customer ID. Reference: |
|||||||||||||||
addresses
A list of addresses associated with the customer.
|
|||||||||||||||
contactName
The name of the main contact for the customer. |
|||||||||||||||
contacts
An array of contacts associated with the customer.
|
|||||||||||||||
customerName
The name of the customer. |
|||||||||||||||
defaultCurrency
The default currency the customer’s transactional data is recorded in. |
|||||||||||||||
emailAddress
The customer’s email address. |
|||||||||||||||
modifiedDate
The time the customer was last modified. |
|||||||||||||||
phone
The phone number for the contact. |
|||||||||||||||
registrationNumber
The company number. |
|||||||||||||||
status
The status. Possible values are:
|
|||||||||||||||
taxNumber
The company tax number. |
invoices
Replication Method : |
Full Table |
Primary Key : |
companyId : id |
API endpoint : |
The invoices
table contains info about the invoices in your Codat instance. An invoice is an itemized record of goods or services sold to a customer.
companyId
The ID of the company associated with the invoice. Reference: |
|||||||
id
The invoice ID. Reference: |
|||||||
amountDue
The amount outstanding on the invoice. |
|||||||
currency
The currency of the invoice. |
|||||||
customerRef
Details about the customer the invoice is for.
|
|||||||
dueDate
The date the invoice is due to be paid by. |
|||||||
invoiceNumber
A user-friendly reference for the invoice. |
|||||||
issueDate
The date the invoice was recorded in the accounting system. |
|||||||
lineItems
A list of line items in the invoice.
|
|||||||
modifiedDate
The time the invoice was last modified. |
|||||||
paidOnDate
The date the invoice was marked as paid. |
|||||||
paymentAllocations
A list of payment allocations associated with the invoice.
|
|||||||
status
The status of the invoice. Possible values are:
|
|||||||
subTotal
The total amount of the invoice, excluding tax. |
|||||||
totalAmount
The amount of the invoice, including tax. |
|||||||
totalDiscount
The numerical value of discounts applied to the invoice. |
|||||||
totalTaxAmount
The amount of tax on the invoice. |
payments
Replication Method : |
Full Table |
Primary Key : |
companyId : id |
API endpoint : |
The payments
table contains info about the payments, or Accounts Receivable transactions, in your Codat instance. This includes details about invoices and credit notes.
companyId
The ID of the company associated with the payment. Reference: |
||||
id
The payment ID. |
||||
currency
The ISO currency code the payment was recorded in. |
||||
customerRef
Details about the customer the payment was recorded against.
|
||||
date
The date the payment was recorded. |
||||
lines
A list of lines associated with the payment.
|
||||
note
Additional information about the payment. |
||||
totalAmount
The amount of the payment in the payment currency. |
profit_and_loss
Replication Method : |
Full Table |
Primary Key : |
companyId |
API endpoint : |
The profit_and_loss
table contains profit and loss report data for a company over a time period.
companyId
The company ID. Reference: |
||||||||||||||||||||||||||
currency
The base currency for the company. |
||||||||||||||||||||||||||
mostRecentAvailableMonth
The most recent available month from which report data can be shown. |
||||||||||||||||||||||||||
reportBasis
The basis of the report. Possible values are:
|
||||||||||||||||||||||||||
reports
A list of profit and loss reports.
|
suppliers
Replication Method : |
Full Table |
Primary Key : |
companyId : id |
API endpoint : |
The suppliers
table contains info about the suppliers in your Codat instance. A supplier is a person or organization that provides a product or service.
companyId
The company ID. Reference: |
|||||||
id
The supplier ID. |
|||||||
addresses
A list of addresses associated with the supplier.
|
|||||||
contactName
The name of the main contact for the supplier. |
|||||||
emailAddress
The supplier’s email address. |
|||||||
phone
The supplier’s phone number. |
|||||||
registrationNumber
The company number of the supplier. |
|||||||
status
The status of the supplier. Possible values are:
|
|||||||
supplierName
The name of the supplier as recorded in the accounting system. |
|||||||
taxNumber
The supplier’s company tax number. |
Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.