import type * as Merge from "../../../index"; /** * # The TaxRate Object * ### Description * The `TaxRate` object is used to represent a tax rate. * * ### Usage Example * Fetch from the `LIST TaxRates` endpoint and view tax rates relevant to a company. */ export interface TaxRate { id?: string; /** The third-party API ID of the matching object. */ remoteId?: string; /** The datetime that this object was created by Merge. */ createdAt?: Date; /** The datetime that this object was modified by Merge. */ modifiedAt?: Date; /** The subsidiary that the tax rate belongs to (in the case of multi-entity systems). */ company?: Merge.accounting.TaxRateCompany; /** The tax code associated with this tax rate or group of tax rates from the third-party platform. */ code?: string; /** The tax rate’s name. */ name?: string; /** The tax rate's description. */ description?: string; /** * The tax rate’s status - `ACTIVE` if an active tax rate, `ARCHIVED` if not active. * * * `ACTIVE` - ACTIVE * * `ARCHIVED` - ARCHIVED */ status?: Merge.accounting.TaxRateStatus; /** The country the tax rate is associated with. */ country?: string; /** The tax’s total tax rate - sum of the tax components (not compounded). */ totalTaxRate?: number; /** The tax rate’s effective tax rate - total amount of tax with compounding. */ effectiveTaxRate?: number; /** The related tax components of the tax rate. */ taxComponents?: Merge.accounting.TaxComponent[]; /** Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). */ remoteWasDeleted?: boolean; fieldMappings?: Record; remoteData?: Merge.accounting.RemoteData[]; }