Download the PHP package thelogicstudio/codat-php without Composer

On this page you can find all versions of the php package thelogicstudio/codat-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of thelogicstudio/codat-php

Informations about the package codat-php

Codat SDK

See Codat's API changes

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, navigate to where your composer.json file is and run the command:

Manual Installation

Download the files and include autoload.php:

Getting Started

Please follow the installation procedure and then run the following:

API Endpoints

All URIs are relative to https://api.codat.io

Class Method HTTP request Description
AccountTransactionsApi companiesCompanyIdConnectionsConnectionIdDataAccountTransactionsAccountTransactionIdGet GET /companies/{companyId}/connections/{connectionId}/data/accountTransactions/{accountTransactionId} Gets the specified account transaction for a given company and connection.
AccountTransactionsApi companiesCompanyIdConnectionsConnectionIdDataAccountTransactionsGet GET /companies/{companyId}/connections/{connectionId}/data/accountTransactions Gets the account transactions for a given company.
AccountsApi companiesCompanyIdConnectionsConnectionIdPushAccountsPost POST /companies/{companyId}/connections/{connectionId}/push/accounts Posts an individual account for a given company.
AccountsApi companiesCompanyIdDataAccountsAccountIdGet GET /companies/{companyId}/data/accounts/{accountId} Gets a single account corresponding to the supplied Id
AccountsApi companiesCompanyIdDataAccountsGet GET /companies/{companyId}/data/accounts Gets the latest chart of accounts for a company
AssessApi companiesCompanyIdReportsEnhancedBalanceSheetAccountsGet GET /companies/{companyId}/reports/enhancedBalanceSheet/accounts Gets a list of accounts with account categories per statement period, specific to balance sheet
AssessApi companiesCompanyIdReportsEnhancedCashFlowTransactionsGet GET /companies/{companyId}/reports/enhancedCashFlow/transactions Gets a list of banking transactions and their categories.
AssessApi companiesCompanyIdReportsEnhancedInvoicesGet GET /companies/{companyId}/reports/enhancedInvoices
AssessApi companiesCompanyIdReportsEnhancedProfitAndLossAccountsGet GET /companies/{companyId}/reports/enhancedProfitAndLoss/accounts Gets a list of accounts with account categories per statement period, specific to profit and loss
AssessApi dataCompaniesCompanyIdAssessDataTypesDataTypeDataIntegrityDetailsGet GET /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/details Gets record-by-record match results for a given company and datatype, optionally restricted by a Codat query string.
AssessApi dataCompaniesCompanyIdAssessDataTypesDataTypeDataIntegrityStatusGet GET /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status Gets match status for a given company and datatype.
AssessApi dataCompaniesCompanyIdAssessDataTypesDataTypeDataIntegritySummariesGet GET /data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/summaries Gets match summary for a given company and datatype, optionally restricted by a Codat query string.
AssessApi dataCompaniesCompanyIdAssessExcelDownloadGet GET /data/companies/{companyId}/assess/excel/download Download the Excel report to a local drive.
AssessApi dataCompaniesCompanyIdAssessExcelGet GET /data/companies/{companyId}/assess/excel Returns the status of the latest report requested.
AssessApi dataCompaniesCompanyIdAssessExcelPost POST /data/companies/{companyId}/assess/excel Request an Excel report for download.
AssessApi dataCompaniesCompanyIdConnectionsConnectionIdAssessCommerceMetricsCustomerRetentionGet GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/customerRetention Gets the customer retention metrics for a specific company connection, over one or more periods of time.
AssessApi dataCompaniesCompanyIdConnectionsConnectionIdAssessCommerceMetricsLifetimeValueGet GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/lifetimeValue Gets the lifetime value metric for a specific company connection, over one or more periods of time.
AssessApi dataCompaniesCompanyIdConnectionsConnectionIdAssessCommerceMetricsOrdersGet GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/orders Gets the order information for a specific company connection, over one or more periods of time.
AssessApi dataCompaniesCompanyIdConnectionsConnectionIdAssessCommerceMetricsRefundsGet GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/refunds Gets the refunds information for a specific company connection, over one or more periods of time.
AssessApi dataCompaniesCompanyIdConnectionsConnectionIdAssessCommerceMetricsRevenueGet GET /data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenue Gets the revenue and revenue growth for a specific company connection, over one or more periods of time.
AssessApi dataCompaniesCompanyIdConnectionsConnectionIdAssessSubscriptionsMrrGet GET /data/companies/{companyId}/connections/{connectionId}/assess/subscriptions/mrr Gets key metrics for subscription revenue.
AssessApi dataCompaniesCompanyIdConnectionsConnectionIdAssessSubscriptionsProcessGet GET /data/companies/{companyId}/connections/{connectionId}/assess/subscriptions/process Gets key metrics for subscription revenue.
BankAccountsApi companiesCompanyIdConnectionsConnectionIdDataBankAccountsAccountIdBankTransactionsGet GET /companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}/bankTransactions Gets bank transactions for a given bank account ID
BankAccountsApi companiesCompanyIdConnectionsConnectionIdDataBankAccountsAccountIdGet GET /companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId} Gets the bank account with a given ID
BankAccountsApi companiesCompanyIdConnectionsConnectionIdDataBankAccountsGet GET /companies/{companyId}/connections/{connectionId}/data/bankAccounts Gets the list of bank accounts for a given connection
BankAccountsApi companiesCompanyIdConnectionsConnectionIdOptionsBankAccountsAccountIdBankTransactionsGet GET /companies/{companyId}/connections/{connectionId}/options/bankAccounts/{accountId}/bankTransactions Gets the options of pushing bank account transactions.
BankAccountsApi companiesCompanyIdConnectionsConnectionIdPushBankAccountsAccountIdBankTransactionsPost POST /companies/{companyId}/connections/{connectionId}/push/bankAccounts/{accountId}/bankTransactions Posts bank transactions to the accounting package for a given company.
BankAccountsApi companiesCompanyIdConnectionsConnectionIdPushBankAccountsBankAccountIdPut PUT /companies/{companyId}/connections/{connectionId}/push/bankAccounts/{bankAccountId} Posts an updated bank account to the accounting package for a given company.
BankAccountsApi companiesCompanyIdConnectionsConnectionIdPushBankAccountsPost POST /companies/{companyId}/connections/{connectionId}/push/bankAccounts Posts a new bank account to the accounting package for a given company.
BankAccountsApi companiesCompanyIdDataBankAccountsAccountIdGet GET /companies/{companyId}/data/bankAccounts/{accountId} Gets the bank account for given account ID.
BankAccountsApi companiesCompanyIdDataBankAccountsAccountIdTransactionsGet GET /companies/{companyId}/data/bankAccounts/{accountId}/transactions Gets the latest bank transactions for given account ID and company.
BankingAccountBalancesApi companiesCompanyIdConnectionsConnectionIdDataBankingAccountBalancesGet GET /companies/{companyId}/connections/{connectionId}/data/banking-accountBalances Gets a list of balances for a bank account including end-of-day batch balance or running balances per transaction.
BankingAccountsApi companiesCompanyIdConnectionsConnectionIdDataBankingAccountsAccountIdGet GET /companies/{companyId}/connections/{connectionId}/data/banking-accounts/{accountId} Gets a specified bank account for a given company
BankingAccountsApi companiesCompanyIdConnectionsConnectionIdDataBankingAccountsGet GET /companies/{companyId}/connections/{connectionId}/data/banking-accounts Gets a list of all bank accounts of the SMB, with rich data like balances, account numbers and institutions holding the accounts.
BankingTransactionCategoriesApi companiesCompanyIdConnectionsConnectionIdDataBankingTransactionCategoriesGet GET /companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories Gets a list of hierarchical categories associated with a transaction for greater contextual meaning to transaction activity.
BankingTransactionCategoriesApi companiesCompanyIdConnectionsConnectionIdDataBankingTransactionCategoriesTransactionCategoryIdGet GET /companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories/{transactionCategoryId} Gets a specified bank transaction category for a given company
BankingTransactionsApi companiesCompanyIdConnectionsConnectionIdDataBankingTransactionsGet GET /companies/{companyId}/connections/{connectionId}/data/banking-transactions Gets a list of transactions incurred by a bank account.
BankingTransactionsApi companiesCompanyIdConnectionsConnectionIdDataBankingTransactionsTransactionIdGet GET /companies/{companyId}/connections/{connectionId}/data/banking-transactions/{transactionId} Gets a specified bank transaction for a given company
BankingTransactionsApi companiesCompanyIdDataBankingTransactionsGet GET /companies/{companyId}/data/banking-transactions Gets a list of transactions incurred by a company across all bank accounts.
BillCreditNotesApi companiesCompanyIdConnectionsConnectionIdPushBillCreditNotesBillCreditNoteIdPut PUT /companies/{companyId}/connections/{connectionId}/push/billCreditNotes/{billCreditNoteId} Posts an updated billCreditNote to the accounting package for a given company.
BillCreditNotesApi companiesCompanyIdConnectionsConnectionIdPushBillCreditNotesPost POST /companies/{companyId}/connections/{connectionId}/push/billCreditNotes Posts a new billCreditNote to the accounting package for a given company.
BillCreditNotesApi companiesCompanyIdDataBillCreditNotesBillCreditNoteIdGet GET /companies/{companyId}/data/billCreditNotes/{billCreditNoteId} Gets a single billCreditNote corresponding to the supplied Id
BillCreditNotesApi companiesCompanyIdDataBillCreditNotesGet GET /companies/{companyId}/data/billCreditNotes Gets a list of all bill credit notes for a company, with pagination
BillPaymentsApi companiesCompanyIdConnectionsConnectionIdPushBillPaymentsPost POST /companies/{companyId}/connections/{connectionId}/push/billPayments Posts a new bill payment to the accounting package for a given company.
BillPaymentsApi companiesCompanyIdDataBillPaymentsBillPaymentIdGet GET /companies/{companyId}/data/billPayments/{billPaymentId}
BillPaymentsApi companiesCompanyIdDataBillPaymentsGet GET /companies/{companyId}/data/billPayments Gets the latest billPayments for a company, with pagination
BillsApi companiesCompanyIdConnectionsConnectionIdDataBillsBillIdAttachmentsAttachmentIdDownloadGet GET /companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}/download
BillsApi companiesCompanyIdConnectionsConnectionIdDataBillsBillIdAttachmentsAttachmentIdGet GET /companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}
BillsApi companiesCompanyIdConnectionsConnectionIdDataBillsBillIdAttachmentsGet GET /companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments
BillsApi companiesCompanyIdConnectionsConnectionIdPushBillsBillIdAttachmentsPost POST /companies/{companyId}/connections/{connectionId}/push/bills/{billId}/attachments
BillsApi companiesCompanyIdConnectionsConnectionIdPushBillsBillIdPut PUT /companies/{companyId}/connections/{connectionId}/push/bills/{billId} Posts an updated bill to the accounting package for a given company.
BillsApi companiesCompanyIdConnectionsConnectionIdPushBillsPost POST /companies/{companyId}/connections/{connectionId}/push/bills Posts a new bill to the accounting package for a given company.
BillsApi companiesCompanyIdDataBillsBillIdGet GET /companies/{companyId}/data/bills/{billId}
BillsApi companiesCompanyIdDataBillsGet GET /companies/{companyId}/data/bills Gets the latest bills for a company, with pagination
CommerceCustomersApi companiesCompanyIdConnectionsConnectionIdDataCommerceCustomersCustomerIdGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-customers/{customerId} Gets the specified commerce customer for a given company
CommerceCustomersApi companiesCompanyIdConnectionsConnectionIdDataCommerceCustomersGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-customers Gets the latest commerce customers for a company, with pagination
CommerceDisputesApi companiesCompanyIdConnectionsConnectionIdDataCommerceDisputesDisputeIdGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-disputes/{disputeId} Gets the specified commerce dispute for a given company
CommerceDisputesApi companiesCompanyIdConnectionsConnectionIdDataCommerceDisputesGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-disputes Gets the latest commerce disputes for a company, with pagination
CommerceInfoApi companiesCompanyIdConnectionsConnectionIdDataCommerceInfoGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-info Gets the latest basic info for a commerce company.
CommerceLocationsApi companiesCompanyIdConnectionsConnectionIdDataCommerceLocationsGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-locations Gets the latest commerce locations for a company, with pagination
CommerceLocationsApi companiesCompanyIdConnectionsConnectionIdDataCommerceLocationsLocationIdGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-locations/{locationId} Gets the specified commerce location for a given company
CommerceOrdersApi companiesCompanyIdConnectionsConnectionIdDataCommerceOrdersGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-orders Gets the latest commerce orders for a company, with pagination
CommerceOrdersApi companiesCompanyIdConnectionsConnectionIdDataCommerceOrdersOrderIdGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-orders/{orderId} Gets the specified commerce order for a given company
CommercePaymentMethodsApi companiesCompanyIdConnectionsConnectionIdDataCommercePaymentMethodsGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods Gets a list of all payment methods from a data connection
CommercePaymentMethodsApi companiesCompanyIdConnectionsConnectionIdDataCommercePaymentMethodsPaymentMethodIdGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods/{paymentMethodId} Gets the details of an individual payment method.
CommercePaymentsApi companiesCompanyIdConnectionsConnectionIdDataCommercePaymentsGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-payments Gets the latest commerce payments for a company, with pagination
CommercePaymentsApi companiesCompanyIdConnectionsConnectionIdDataCommercePaymentsPaymentIdGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-payments/{paymentId} Gets the specified commerce payment for a given company
CommerceProductCategoriesApi companiesCompanyIdConnectionsConnectionIdDataCommerceProductCategoriesGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-productCategories Gets the latest commerce product categories for a company, with pagination
CommerceProductCategoriesApi companiesCompanyIdConnectionsConnectionIdDataCommerceProductCategoriesProductIdGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-productCategories/{productId} Gets the specified commerce product category for a given company
CommerceProductsApi companiesCompanyIdConnectionsConnectionIdDataCommerceProductsGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-products Gets the latest commerce products for a company, with pagination
CommerceProductsApi companiesCompanyIdConnectionsConnectionIdDataCommerceProductsProductIdGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-products/{productId} Gets the specified commerce product for a given company
CommerceTransactionsApi companiesCompanyIdConnectionsConnectionIdDataCommerceTransactionsGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-transactions Gets the latest commerce transactions for a company, with pagination
CommerceTransactionsApi companiesCompanyIdConnectionsConnectionIdDataCommerceTransactionsTransactionIdGet GET /companies/{companyId}/connections/{connectionId}/data/commerce-transactions/{transactionId} Gets the specified commerce transaction for a given company
CompaniesApi companiesCompanyIdDelete DELETE /companies/{companyId} Deletes a company, this is not reversible.
CompaniesApi companiesCompanyIdGet GET /companies/{companyId} Fetch metadata on a single company.
CompaniesApi companiesCompanyIdPut PUT /companies/{companyId} Update a company with a new name and optional description
CompaniesApi companiesCompanyIdSettingsGet GET /companies/{companyId}/settings Fetch settings on a single company.
CompaniesApi companiesCompanyIdSettingsPut PUT /companies/{companyId}/settings Update settings on a single company.
CompaniesApi companiesCompanyIdSyncSettingsGet GET /companies/{companyId}/syncSettings
CompaniesApi companiesCompanyIdSyncSettingsPost POST /companies/{companyId}/syncSettings
CompaniesApi companiesGet GET /companies Fetch a list of all companies metadata with accounting links on the Codat platform
CompaniesApi companiesPost POST /companies Initiate the process of onboarding a new company on the Codat platform
ConnectionApi companiesCompanyIdConnectionsConnectionIdAuthorizationPut PUT /companies/{companyId}/connections/{connectionId}/authorization Put authorization information for a single data source connected to a single company.
ConnectionApi companiesCompanyIdConnectionsConnectionIdConnectionInfoBankFeedAccountsBankAccountIdPatch PATCH /companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts/{bankAccountId} Update a single BankFeed BankAccount for a single data source connected to a single company.
ConnectionApi companiesCompanyIdConnectionsConnectionIdConnectionInfoBankFeedAccountsGet GET /companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts Get BankFeed BankAccounts for a single data source connected to a single company.
ConnectionApi companiesCompanyIdConnectionsConnectionIdConnectionInfoBankFeedAccountsPut PUT /companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts Put BankFeed BankAccounts for a single data source connected to a single company.
ConnectionApi companiesCompanyIdConnectionsConnectionIdDelete DELETE /companies/{companyId}/connections/{connectionId} Disconnect and delete a data source from a company
ConnectionApi companiesCompanyIdConnectionsConnectionIdGet GET /companies/{companyId}/connections/{connectionId} Retrieve a single data source connected to a single company, including its connection status
ConnectionApi companiesCompanyIdConnectionsConnectionIdPatch PATCH /companies/{companyId}/connections/{connectionId} Disconnect a data source from a company
ConnectionApi companiesCompanyIdConnectionsGet GET /companies/{companyId}/connections Retrieve all data sources connected to a single company, including their connection statuses
ConnectionApi companiesCompanyIdConnectionsPost POST /companies/{companyId}/connections Connect a data source to a company
CreditNotesApi companiesCompanyIdConnectionsConnectionIdPushCreditNotesCreditNoteIdPut PUT /companies/{companyId}/connections/{connectionId}/push/creditNotes/{creditNoteId} Posts an updated credit note to the accounting package for a given company.
CreditNotesApi companiesCompanyIdConnectionsConnectionIdPushCreditNotesPost POST /companies/{companyId}/connections/{connectionId}/push/creditNotes
CreditNotesApi companiesCompanyIdDataCreditNotesCreditNoteIdGet GET /companies/{companyId}/data/creditNotes/{creditNoteId} Gets a single creditNote corresponding to the supplied Id
CreditNotesApi companiesCompanyIdDataCreditNotesGet GET /companies/{companyId}/data/creditNotes Gets a list of all credit notes for a company, with pagination
CustomersApi companiesCompanyIdConnectionsConnectionIdDataCustomersCustomerIdAttachmentsAttachmentIdDownloadGet GET /companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}/download
CustomersApi companiesCompanyIdConnectionsConnectionIdDataCustomersCustomerIdAttachmentsAttachmentIdGet GET /companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}
CustomersApi companiesCompanyIdConnectionsConnectionIdDataCustomersCustomerIdAttachmentsGet GET /companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments
CustomersApi companiesCompanyIdConnectionsConnectionIdPushCustomersCustomerIdPut PUT /companies/{companyId}/connections/{connectionId}/push/customers/{customerId} Posts an updated customer for a given company.
CustomersApi companiesCompanyIdConnectionsConnectionIdPushCustomersPost POST /companies/{companyId}/connections/{connectionId}/push/customers Posts an individual customer for a given company.
CustomersApi companiesCompanyIdDataCustomersCustomerIdGet GET /companies/{companyId}/data/customers/{customerId} Gets a single customer corresponding to the supplied Id
CustomersApi companiesCompanyIdDataCustomersGet GET /companies/{companyId}/data/customers Gets the latest customers for a company, with pagination
DataApi companiesCompanyIdDataAllPost POST /companies/{companyId}/data/all Initiates the process of capturing a new data snapshot for a company
DataApi companiesCompanyIdDataHistoryDatasetIdGet GET /companies/{companyId}/data/history/{datasetId} Fetch metadata on a single data synchronisation
DataApi companiesCompanyIdDataHistoryGet GET /companies/{companyId}/data/history Fetch a list of all data snapshots captured for a company
DataApi companiesCompanyIdDataQueueDataTypePost POST /companies/{companyId}/data/queue/{dataType} Initiates the process of capturing a data snapshot of a specified type for a company
DataStatusApi companiesCompanyIdDataStatusGet GET /companies/{companyId}/dataStatus
DataTypesApi companiesCompanyIdConnectionsConnectionIdDataTypesDataTypeOptionsGet GET /companies/{companyId}/connections/{connectionId}/dataTypes/{dataType}/options Gets all available push options for the given data type
DataTypesApi companiesCompanyIdConnectionsConnectionIdDataTypesDataTypeOptionsPOSTGet GET /companies/{companyId}/connections/{connectionId}/dataTypes/{dataType}/options/POST Gets the POST push options for the given data type
DataTypesApi companiesCompanyIdConnectionsConnectionIdDataTypesDataTypeOptionsPUTGet GET /companies/{companyId}/connections/{connectionId}/dataTypes/{dataType}/options/PUT Gets the PUT push options for the given data type
DatasetLogsApi companiesCompanyIdDataDatasetLogsDatasetIdGet GET /companies/{companyId}/data/datasetLogs/{datasetId} Gets dataset messages for a given dataset
DirectCostsApi companiesCompanyIdConnectionsConnectionIdDataDirectCostsDirectCostIdAttachmentsAttachmentIdDownloadGet GET /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId}/download Downloads an attachment for the specified direct cost for a given company.
DirectCostsApi companiesCompanyIdConnectionsConnectionIdDataDirectCostsDirectCostIdAttachmentsAttachmentIdGet GET /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId} Gets the specified direct cost attachment for a given company.
DirectCostsApi companiesCompanyIdConnectionsConnectionIdDataDirectCostsDirectCostIdAttachmentsGet GET /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments Gets all attachments for the specified direct cost for a given company.
DirectCostsApi companiesCompanyIdConnectionsConnectionIdDataDirectCostsDirectCostIdGet GET /companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId} Gets the specified direct cost for a given company.
DirectCostsApi companiesCompanyIdConnectionsConnectionIdDataDirectCostsGet GET /companies/{companyId}/connections/{connectionId}/data/directCosts Gets the direct costs for the company.
DirectCostsApi companiesCompanyIdConnectionsConnectionIdPushDirectCostsDirectCostIdAttachmentPost POST /companies/{companyId}/connections/{connectionId}/push/directCosts/{directCostId}/attachment Posts a new direct cost attachment for a given company.
DirectCostsApi companiesCompanyIdConnectionsConnectionIdPushDirectCostsPost POST /companies/{companyId}/connections/{connectionId}/push/directCosts Posts a new direct cost to the accounting package for a given company.
DirectIncomesApi companiesCompanyIdConnectionsConnectionIdDataDirectIncomesDirectIncomeIdAttachmentsAttachmentIdDownloadGet GET /companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId}/download Downloads an attachment for the specified direct income for a given company.
DirectIncomesApi companiesCompanyIdConnectionsConnectionIdDataDirectIncomesDirectIncomeIdAttachmentsAttachmentIdGet GET /companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId} Gets the specified direct income attachment for a given company.
DirectIncomesApi companiesCompanyIdConnectionsConnectionIdDataDirectIncomesDirectIncomeIdAttachmentsGet GET /companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments Gets all attachments for the specified direct income for a given company.
DirectIncomesApi companiesCompanyIdConnectionsConnectionIdDataDirectIncomesDirectIncomeIdGet GET /companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId} Gets the specified direct income for a given company and connection.
DirectIncomesApi companiesCompanyIdConnectionsConnectionIdDataDirectIncomesGet GET /companies/{companyId}/connections/{connectionId}/data/directIncomes Gets the direct incomes for a given company.
DirectIncomesApi companiesCompanyIdConnectionsConnectionIdPushDirectIncomesDirectIncomeIdAttachmentPost POST /companies/{companyId}/connections/{connectionId}/push/directIncomes/{directIncomeId}/attachment Posts a new direct income attachment for a given company.
DirectIncomesApi companiesCompanyIdConnectionsConnectionIdPushDirectIncomesPost POST /companies/{companyId}/connections/{connectionId}/push/directIncomes Posts a new direct income to the accounting package for a given company.
FilesApi companiesCompanyIdConnectionsConnectionIdFilesPost POST /companies/{companyId}/connections/{connectionId}/files Upload files for a company
FilesApi companiesCompanyIdFilesDownloadGet GET /companies/{companyId}/files/download Download all files for a company. You can specify a date to download specific files for.
FilesApi companiesCompanyIdFilesGet GET /companies/{companyId}/files View all files uploaded by a specified company
FinancialsApi companiesCompanyIdDataFinancialsBalanceSheetGet GET /companies/{companyId}/data/financials/balanceSheet Gets the latest balance sheet for a company.
FinancialsApi companiesCompanyIdDataFinancialsCashFlowStatementGet GET /companies/{companyId}/data/financials/cashFlowStatement Gets the latest cash flow statement for a company.
FinancialsApi companiesCompanyIdDataFinancialsProfitAndLossGet GET /companies/{companyId}/data/financials/profitAndLoss Gets the latest profit and loss for a company.
InfoApi companiesCompanyIdDataInfoGet GET /companies/{companyId}/data/info Gets the latest basic info for a company.
InfoApi companiesCompanyIdDataInfoPost POST /companies/{companyId}/data/info Initiates the process of synchronising basic info for a company
IntegrationsApi integrationsBankSettingsGet GET /integrations/bankSettings
IntegrationsApi integrationsBankSettingsPut PUT /integrations/bankSettings
IntegrationsApi integrationsCredentialsPlatformKeyDelete DELETE /integrations/credentials/{platformKey} Delete credentials used to authenticate with an accounting platform
IntegrationsApi integrationsCredentialsPlatformKeyGet GET /integrations/credentials/{platformKey} Fetch credentials required to authenticate with an accounting platform.
IntegrationsApi integrationsCredentialsPlatformKeyPut PUT /integrations/credentials/{platformKey} Update credentials required to authenticate with an accounting platform
IntegrationsApi integrationsGet GET /integrations
IntegrationsApi integrationsPlatformKeyBrandingGet GET /integrations/{platformKey}/branding
IntegrationsApi integrationsPlatformKeyEnabledPut PUT /integrations/{platformKey}/enabled
IntegrationsApi integrationsPlatformKeyGet GET /integrations/{platformKey}
InvoicesApi companiesCompanyIdConnectionsConnectionIdDataInvoicesInvoiceIdAttachmentsAttachmentIdDownloadGet GET /companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}/download
InvoicesApi companiesCompanyIdConnectionsConnectionIdDataInvoicesInvoiceIdAttachmentsAttachmentIdGet GET /companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}
InvoicesApi companiesCompanyIdConnectionsConnectionIdDataInvoicesInvoiceIdAttachmentsGet GET /companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments
InvoicesApi companiesCompanyIdConnectionsConnectionIdPushInvoicesInvoiceIdAttachmentPost POST /companies/{companyId}/connections/{connectionId}/push/invoices/{invoiceId}/attachment
InvoicesApi companiesCompanyIdConnectionsConnectionIdPushInvoicesInvoiceIdPut PUT /companies/{companyId}/connections/{connectionId}/push/invoices/{invoiceId} Posts an updated invoice to the accounting package for a given company.
InvoicesApi companiesCompanyIdConnectionsConnectionIdPushInvoicesPost POST /companies/{companyId}/connections/{connectionId}/push/invoices Posts a new invoice to the accounting package for a given company.
InvoicesApi companiesCompanyIdDataInvoicesGet GET /companies/{companyId}/data/invoices Gets the latest invoices for a company, with pagination
InvoicesApi companiesCompanyIdDataInvoicesInvoiceIdGet GET /companies/{companyId}/data/invoices/{invoiceId}
InvoicesApi companiesCompanyIdDataInvoicesInvoiceIdPdfGet GET /companies/{companyId}/data/invoices/{invoiceId}/pdf
ItemsApi companiesCompanyIdConnectionsConnectionIdPushItemsPost POST /companies/{companyId}/connections/{connectionId}/push/items Posts a new item to the accounting package for a given company.
ItemsApi companiesCompanyIdDataItemsGet GET /companies/{companyId}/data/items Gets the items for a given company.
ItemsApi companiesCompanyIdDataItemsItemIdGet GET /companies/{companyId}/data/items/{itemId} Gets the specified item for a given company.
JournalEntriesApi companiesCompanyIdConnectionsConnectionIdPushJournalEntriesPost POST /companies/{companyId}/connections/{connectionId}/push/journalEntries Posts a new journalEntry to the accounting package for a given company.
JournalEntriesApi companiesCompanyIdDataJournalEntriesGet GET /companies/{companyId}/data/journalEntries Gets the latest journal entries for a company, with pagination
JournalEntriesApi companiesCompanyIdDataJournalEntriesJournalEntryIdGet GET /companies/{companyId}/data/journalEntries/{journalEntryId} Gets a single JournalEntry corresponding to the supplied Id
JournalsApi companiesCompanyIdConnectionsConnectionIdPushJournalsPost POST /companies/{companyId}/connections/{connectionId}/push/journals Posts a new journal to the accounting package for a given company.
JournalsApi companiesCompanyIdDataJournalsGet GET /companies/{companyId}/data/journals Gets the latest journals for a company, with pagination
JournalsApi companiesCompanyIdDataJournalsJournalIdGet GET /companies/{companyId}/data/journals/{journalId} Gets a single journal corresponding to the supplied Id
MetricsApi metricsCompaniesGet GET /metrics/companies
PaymentMethodsApi companiesCompanyIdDataPaymentMethodsGet GET /companies/{companyId}/data/paymentMethods Gets the payment methods for a given company.
PaymentMethodsApi companiesCompanyIdDataPaymentMethodsPaymentMethodIdGet GET /companies/{companyId}/data/paymentMethods/{paymentMethodId} Gets the specified payment method for a given company.
PaymentsApi companiesCompanyIdConnectionsConnectionIdPushPaymentsPost POST /companies/{companyId}/connections/{connectionId}/push/payments Posts a new payment to the accounting package for a given company.
PaymentsApi companiesCompanyIdDataPaymentsGet GET /companies/{companyId}/data/payments Gets the latest payments for a company, with pagination
PaymentsApi companiesCompanyIdDataPaymentsPaymentIdGet GET /companies/{companyId}/data/payments/{paymentId}
ProfileApi profileApiKeyPut PUT /profile/apiKey Refresh the existing API key for your clients.
ProfileApi profileGet GET /profile Fetch your organisations company profile
ProfileApi profilePut PUT /profile Update your organisations company profile
ProfileApi profileSyncSettingsDataTypePut PUT /profile/syncSettings/{dataType}
ProfileApi profileSyncSettingsGet GET /profile/syncSettings
ProfileApi profileSyncSettingsPost POST /profile/syncSettings
PurchaseOrdersApi companiesCompanyIdConnectionsConnectionIdPushPurchaseOrdersPost POST /companies/{companyId}/connections/{connectionId}/push/purchaseOrders Posts a new purchase order to the accounting package for a given company.
PurchaseOrdersApi companiesCompanyIdConnectionsConnectionIdPushPurchaseOrdersPurchaseOrderIdPut PUT /companies/{companyId}/connections/{connectionId}/push/purchaseOrders/{purchaseOrderId} Posts an updated purchase order to the accounting package for a given company.
PurchaseOrdersApi companiesCompanyIdDataPurchaseOrdersGet GET /companies/{companyId}/data/purchaseOrders
PurchaseOrdersApi companiesCompanyIdDataPurchaseOrdersPurchaseOrderIdGet GET /companies/{companyId}/data/purchaseOrders/{purchaseOrderId}
PushApi companiesCompanyIdConnectionsConnectionIdOptionsDataTypeGet GET /companies/{companyId}/connections/{connectionId}/options/{dataType} Gets the push options for the given data type
PushApi companiesCompanyIdPushGet GET /companies/{companyId}/push Gets paged push operation records
PushApi companiesCompanyIdPushPushOperationKeyGet GET /companies/{companyId}/push/{pushOperationKey} Gets a single push operation record
ReportsApi companiesCompanyIdReportsAgedCreditorAvailableGet GET /companies/{companyId}/reports/agedCreditor/available
ReportsApi companiesCompanyIdReportsAgedCreditorGet GET /companies/{companyId}/reports/agedCreditor Gets the aged creditor report for a company.
ReportsApi companiesCompanyIdReportsAgedDebtorAvailableGet GET /companies/{companyId}/reports/agedDebtor/available
ReportsApi companiesCompanyIdReportsAgedDebtorGet GET /companies/{companyId}/reports/agedDebtor Gets the aged debtor report for a company.
ReportsApi companiesCompanyIdReportsEventsGet GET /companies/{companyId}/reports/events
RulesApi rulesAlertsAlertIdGet GET /rules/alerts/{alertId}
RulesApi rulesAlertsGet GET /rules/alerts
RulesApi rulesGet GET /rules Fetch a list of rules
RulesApi rulesPost POST /rules Subscribe to a rule
RulesApi rulesRuleIdAlertsGet GET /rules/{ruleId}/alerts
RulesApi rulesRuleIdDelete DELETE /rules/{ruleId}
RulesApi rulesRuleIdGet GET /rules/{ruleId}
RulesApi rulesRuleIdPut PUT /rules/{ruleId}
SalesOrdersApi companiesCompanyIdDataSalesOrdersGet GET /companies/{companyId}/data/salesOrders
SalesOrdersApi companiesCompanyIdDataSalesOrdersSalesOrderIdGet GET /companies/{companyId}/data/salesOrders/{salesOrderId}
SettingsApi settingsGet GET /settings Fetch your settings
SettingsApi settingsIntegrationsIntegrationIdGet GET /settings/integrations/{integrationId} Fetch your organisations integration settings
SettingsApi settingsIntegrationsIntegrationIdPatch PATCH /settings/integrations/{integrationId} Update your organisations integration settings
SettingsApi settingsPatch PATCH /settings Update your settings
SuppliersApi companiesCompanyIdConnectionsConnectionIdDataSuppliersSupplierIdAttachmentsAttachmentIdDownloadGet GET /companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}/download
SuppliersApi companiesCompanyIdConnectionsConnectionIdDataSuppliersSupplierIdAttachmentsAttachmentIdGet GET /companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}
SuppliersApi companiesCompanyIdConnectionsConnectionIdDataSuppliersSupplierIdAttachmentsGet GET /companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments
SuppliersApi companiesCompanyIdConnectionsConnectionIdPushSuppliersPost POST /companies/{companyId}/connections/{connectionId}/push/suppliers
SuppliersApi companiesCompanyIdConnectionsConnectionIdPushSuppliersSupplierIdPut PUT /companies/{companyId}/connections/{connectionId}/push/suppliers/{supplierId}
SuppliersApi companiesCompanyIdDataSuppliersGet GET /companies/{companyId}/data/suppliers Gets the latest suppliers for a company, with pagination
SuppliersApi companiesCompanyIdDataSuppliersSupplierIdGet GET /companies/{companyId}/data/suppliers/{supplierId} Gets a single supplier corresponding to the supplied Id
TaxRatesApi companiesCompanyIdDataTaxRatesGet GET /companies/{companyId}/data/taxRates Gets the latest tax rates for a given company.
TaxRatesApi companiesCompanyIdDataTaxRatesTaxRateIdGet GET /companies/{companyId}/data/taxRates/{taxRateId} Gets the specified tax rate for a given company.
TrackingCategoriesApi companiesCompanyIdDataTrackingCategoriesGet GET /companies/{companyId}/data/trackingCategories Gets the latest tracking categories for a given company.
TrackingCategoriesApi companiesCompanyIdDataTrackingCategoriesTrackingCategoryIdGet GET /companies/{companyId}/data/trackingCategories/{trackingCategoryId} Gets the specified tracking categories for a given company.
TransfersApi companiesCompanyIdConnectionsConnectionIdDataTransfersGet GET /companies/{companyId}/connections/{connectionId}/data/transfers Gets the transfers for a given company.
TransfersApi companiesCompanyIdConnectionsConnectionIdDataTransfersTransferIdGet GET /companies/{companyId}/connections/{connectionId}/data/transfers/{transferId} Gets the specified transfer for a given company.
TransfersApi companiesCompanyIdConnectionsConnectionIdPushTransfersPost POST /companies/{companyId}/connections/{connectionId}/push/transfers Posts a new transfer to the accounting package for a given company.

Models

Authorization

Authentication schemes defined for the API:

APIKeyAuth

CodatLogin

Tests

To run the tests, use:

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

All versions of codat-php with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package thelogicstudio/codat-php contains the following files

Loading the files please wait ....