--- title: "Get tax rate" method: GET path: "/companies/{companyId}/data/taxRates/{taxRateId}" tags: ["Tax rates"] --- # Get tax rate `GET /companies/{companyId}/data/taxRates/{taxRateId}` The *Get tax rate* endpoint returns a single tax rate for a given taxRateId. [Tax rates](https://docs.codat.io/accounting-api#/schemas/TaxRate) are a set of taxes and associated rates within the SMB's accounting software. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data). ## Response `200` Success - TaxRate, nullable — ## Overview Accounting systems typically store a set of taxes and associated rates within the accounting software. This means that users don't have to look up or remember the rates for each type of tax. For example, applying the tax "UK sales VAT" to line items of an invoice adds the correct rate of 20%. ### Tax components In some cases, a tax is made up of multiple sub taxes, often called _components_ of the tax. For example, you may have an item that is charged a tax rate called "City import tax (8%)" that has two components: - A city tax of 5% - An import tax of 3% > **Effective tax rates** > - Where there are multiple components of a tax, each component may be calculated on the original amount and added together. Alternatively, one tax may be calculated on the sub-total of the original amount plus another tax, which is referred to as _compounding_. When there is compounding, the effective tax rate is the rate that, if applied to the original amount, would result in the total amount of tax with compounding. > > **Example:** > A tax has two components. Both components have a rate of 10%, and one component is compound. In this case, there is a total tax rate of 20% but an effective tax rate of 21%. > > - For QuickBooks Online, Codat doesn't use compound rates. Instead, the calculated effective tax rate for each component is shown. This means that the effective and total rates are the same because the total tax rate is a sum of the component rates. - `id` string — Identifier for the tax rate, unique for the company in the accounting software. - `name` string, nullable — Codat-augmented name of the tax rate in the accounting software. - `code` string, nullable — Code for the tax rate from the accounting software. - `status` TaxRateStatus — unresolved $ref - `effectiveTaxRate` number, nullable — See Effective tax rates description. - `totalTaxRate` number, nullable — Total (not compounded) sum of the components of a tax rate. - `components` TaxRateComponent[], nullable — unresolved $ref - `validDatatypeLinks` ValidDataTypeLinks[], nullable - `property` string, nullable — The property from the account that can be linked. - `links` string[], nullable — Supported `dataTypes` that the record can be linked to. - `metadata` Metadata - `isDeleted` boolean, nullable — Indicates whether the record has been deleted in the third-party system this record originated from. - `supplementalData` SupplementalData — Supplemental data is additional data you can include in our standard data types. It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. - `content` object, nullable - `modifiedDate` string — The date when the record was last fetched from the accounting software, commerce software, or open banking provider and updated in Codat’s data cache. Use it to identify and retrieve records that have changed since your last fetch. For example, filtering `modifiedDate` to today will provide new records updated in Codat today. This date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports ([read more](https://docs.codat.io/using-the-api/modified-dates#modified-date)). In Codat's data model, dates and times are represented using the ISO 8601 standard. - `sourceModifiedDate` string — The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice. It is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when: - Pulling attachments - The accounting software does not provide modification dates for a data type - A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred - A record has been voided. For certain platforms that soft delete records, `isDeleted` metadata is used to identify void records In Codat's data model, dates and times are represented using the ISO 8601 standard. ## Other responses - `401` — Your API request was not properly authorized. - `402` — An account limit has been exceeded. The type of limit is described in the error property: - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io. - `403` — You are using an outdated API key or a key not associated with that resource. - `404` — One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted. - `409` — The data type's dataset has not been requested or is still syncing. - `429` — Too many requests were made in a given amount of time. Wait a short period and then try again. - `500` — There is a problem with our server. Please try again later. - `503` — The Codat API is temporarily offline for maintenance. Please try again later. --- [API](https://skmtc.net/codatio/apis/accounting-api.md) · [All operations](https://skmtc.net/codatio/apis/accounting-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/codatio/accounting-api/revisions/21d41189c461/schema)