Retrieve company data
Learn how to manage companies, their connections, and their data via API
Once you've create a companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources., you can start retrieving data.
Reading data
Once companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. is onboarded, you can start retrieving their financial data.
Queue a new data syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. (Optional)
If there are datasets which are not as up-to-date as you require, you can queue a data syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. as described here.
Once you've queued the syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule., you can poll the GET /companies/{companyId}/dataStatus endpoint (as described above) to monitor progress of the sync.
You can configure a syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. schedule in the Codat portal to keep each data type at an acceptable freshness. For more information, please refer to your onboarding docs or raise a ticket with our support team through the support request form.
Request a specific data type
Codat exposes endpoints that enable you to easily query each of the supported data types.
For example, when querying invoices, you can use the GET /companies/{companyId}/data/invoices endpoint, with query string parameters as below:
pageSize– the size of page you wish to retrievepage– which page number you wish to retrieveorderBy– the property you wish to order the response byquery– any filter you wish to perform on the returned data (see Querying for details)