JUMP TOOverviewAuthenticationQueryingPaginationOrdering resultsErrorsPortal for developersCodat APICompaniesAll companiesgetCreate companypostUpdate companyputDelete companydeleteSingle companygetConnectionsAll connectionsgetCreate connectionpostSingle connectiongetDelete connectiondeleteDisconnect a data source from a companypatchData - PullInitiates the process of capturing a new data snapshot for a companypostInitiates the process of capturing a data snapshot of a specified type for a companypostFetch a list of all data snapshots captured for a companygetFetch metadata on a single data synchronisationgetGet the status for each datatypegetData - PushGets all available push options for the given data typegetGets the POST push options for the given data typegetGets the PUT push options for the given data typegetGets the push options for the given data typegetGets paged push operation recordsgetGets a single push operation recordgetAccounting - Bank statementsAll bank statementsgetGets the latest bank statements for a company, with paginationgetMetricsView linked company metricsgetProfileFetch your organisations company profilegetUpdate your organisations company profileputRefresh the existing API key for your clients.putSettingsGet company specific settingsgetSet company specific settingsputGet company specific synchronisation settingsgetSet company specific synchronisation settingspostGet your sync settingsgetUpdate your sync settingspostFetch your settingsgetUpdate your settingspatchFetch your organisations integration settingsgetUpdate your organisations integration settingspatchIntegrationsGet all integrationsgetGet a single integrationgetGets the branding and logos for the given integrationgetRulesAll rulesgetCreate rulepostUpdate ruleputSingle rulegetDelete ruledeleteAll alertsgetAlerts for a given rulegetSingle alertgetAccounting APIAccounting - Account transactionsAll account transactionsgetSingle account transactiongetAccounting - AttachmentsAll attachments billgetSingle bill attachmentgetDownload bill attachmentgetCreate bill attachmentpostAll attachments customergetSingle customer attachmentgetDownload customer attachmentgetAll attachments invoicegetSingle invoice attachmentgetDownload invoice attachmentgetCreate invoice attachmentpostAll attachments suppliergetSingle supplier attachmentgetDownload supplier attachmentgetAccounting - Bank accountsAll bank accountsgetSingle bank accountgetGets bank transactions for a given bank account IDgetGets the bank account for given account ID.getGets the latest bank transactions for given account ID and company.getGets the options of pushing bank account transactions.getCreate bank accountpostPosts bank transactions to the accounting package for a given company.postAccounting - Bill credit notesAll bill credit notesgetSingle bill credit notegetCreate bill credit notepostUpdate bill credit noteputAccounting - Bill paymentsAll bill paymentsgetSingle bill paymentgetCreate bill paymentpostAccounting - BillsAll billsgetSingle billgetCreate billpostUpdate billputAccounting - Credit notesAll credit notesgetSingle credit notegetCreate credit notepostAccounting - CustomersAll customersgetSingle customergetCreate customerpostUpdate customerputAccounting - Direct costsAll direct costsgetSingle direct costgetCreate direct costpostAccounting - Direct incomesAll direct incomesgetSingle direct incomegetPosts a new direct income to the accounting package for a given company.postAccounting - FinancialsGets the latest balance sheet for a company.getGets the latest profit and loss for a company.getGets the latest cashflow statement for a company.getAccounting - InfoGets the latest basic info for a company.getAccounting - InvoicesAll invoicesgetSingle invoicegetSingle invoice as PDFgetCreate invoicepostUpdate invoiceputAccounting - ItemsAll itemsgetSingle itemgetCreate itempostAccounting - Journal entriesAll journal entriesgetSingle journal entrygetCreate journal entrypostAccounting - Nominal accountsAll nominal accountsgetSingle nominal accountgetCreate nominal accountpostAccounting - PaymentsAll paymentsgetSingle paymentgetCreate paymentpostAccounting - Purchase ordersAll purchase ordersgetSingle purchase ordergetCreate purchase orderpostUpdate purchase orderputAccounting - ReportsGet is the aged debtor report is availablegetGet if the aged creditor report is availablegetGets the aged debtor report for a company.getGets the aged creditor report for a company.getAccounting - SuppliersAll suppliersgetSingle suppliergetCreate supplierpostAccounting - Tax ratesAll tax ratesgetSingle tax rategetAccounting - Tracking categoriesAll tracking categoriesgetSingle tracking categorygetAccounting - TransfersAll transfersgetSingle transfergetCreate transferpostBanking APIBanking - Account balancesList balances for an accountgetBanking - AccountsList Bank AccountsgetSingle Bank AccountgetBanking - Transaction categoriesList transaction categoriesgetGet a bank transaction categorygetBanking - TransactionsList transactionsgetGet a bank transactiongetCommerce APICommerce - CustomersAll customersgetSingle customergetCommerce - DisputesAll disputesgetSingle disputegetCommerce - InfoGets the latest basic info for a commerce company.getCommerce - OrdersAll ordersgetSingle ordergetCommerce - PaymentsAll paymentsgetSingle paymentgetCommerce - ProductsAll productsgetSingle productgetCommerce - TransactionsAll transactionsgetSingle transactiongetSync for CommerceCompany ManagementList CompaniesgetCreate a Sync for Commerce CompanypostList Data Connections for a companygetCreate Data ConnectionpostUpdate Data ConnectionpatchSync ConfigurationGet Sync for Commerce Status for a companygetPost Sync for Commerce settingspostGet options for Sync for Commerce settingsgetGet Sync Flow UrlgetIntegrationsList Codat's integrationsgetGet branding for an integrationgetSync DataSend Orders DatapostSend Payments DatapostSend Transactions DatapostCheck Dataset StatusgetAssessAccounts categorizationGets a list of all the Codat standard categories.getGet account categories (suggested and confirmed) for a company connection.getUpdates the categories for all or a batch of accounts for a specific connection.patchGets the suggested and/or confirmed category for a specific account.getUpdates or removes the confirmed category of a specific account.patchMetricsGets all the available financial metrics for a given company, over one or more periods.getGets the revenue and revenue growth for a specific company connection, over one or more periods of time.getGets the order information for a specific company connection, over one or more periods of time.getGets the refunds information for a specific company connection, over one or more periods of time.getGets the customer retention metrics for a specific company connection, over one or more periods of time.getGets the lifetime value metric for a specific company connection, over one or more periods of time.getGets the marketing metrics from an accounting source for a given company, over one or more periods of time.getGets key metrics for subscription revenue.getStatementsGets a fully categorized profit and loss statement for a given company, over one or more period(s).getGets a fully categorized balance sheet statement for a given company, over one or more period(s).getData integrityGets match status for a given company and datatype.getGets match summary for a given company and datatype, optionally restricted by a Codat query string.getGets record-by-record match results for a given company and datatype, optionally restricted by a Codat query string.getAll paymentsget https://api.codat.io/companies/{companyId}/data/paymentsReturns a list of the payments for a company. You can use the query and orderBy parameters to filter and sort the results.
