Merge · Schema

TaxComponent

# The TaxRate Object ### Description The `TaxComponent` object is used to represent any sub-taxes that make up the `TaxRate`. ### Usage Example Fetch from the `LIST TaxRates` endpoint and view tax components relevant to a tax rate.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
id	string
remote_id	stringnull	The third-party API ID of the matching object.
created_at	string	The datetime that this object was created by Merge.
modified_at	string	The datetime that this object was modified by Merge.
name	stringnull	The tax rate’s name.
rate	stringnull	The tax component’s rate.
is_compound	booleannull	Returns True if the tax component is compound, False if not.
component_type	object	Returns PURCHASE if the tax component corresponds to a purchase tax or SALES if the tax component corresponds to a sales tax.
remote_was_deleted	boolean	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 cove

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TaxComponent",
  "title": "TaxComponent",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was created by Merge."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was modified by Merge."
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The tax rate\u2019s name."
    },
    "rate": {
      "type": [
        "string",
        "null"
      ],
      "format": "decimal",
      "description": "The tax component\u2019s rate."
    },
    "is_compound": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Returns True if the tax component is compound, False if not."
    },
    "component_type": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/ComponentTypeEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "Returns PURCHASE if the tax component corresponds to a purchase tax or SALES if the tax component corresponds to a sales tax."
    },
    "remote_was_deleted": {
      "type": "boolean",
      "description": "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/)."
    }
  },
  "description": "# The TaxRate Object\n### Description\nThe `TaxComponent` object is used to represent any sub-taxes that make up the `TaxRate`.\n\n### Usage Example\nFetch from the `LIST TaxRates` endpoint and view tax components relevant to a tax rate."
}