afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/CartTax.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "associated_objects",
    "field_reference"
  ],
  "title": "CartTax - Data API",
  "description": "Represents taxes for a line item in a WebCart that’s active in a store built with B2B Commerce or D2C Commerce. This object is available in API version 49.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "refers_to"
  ],
  "fields": {
    "AdjustmentTargetType": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Target for the price adjustment (the cart itself or individual items). This field is available in API version 52.0 and later. Possible values are: Cart Item"
    },
    "Amount": {
      "type": "currency",
      "properties": "Create, Filter, Sort, Update",
      "description": "Calculated tax amount."
    },
    "CartId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the WebCart being taxed."
    },
    "CartItemId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "The ID of a cart item being taxed."
    },
    "CartItemPriceAdjustmentId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "The ID of a price adjustment for a cart item being taxed. (This field is available in API version 52.0 and later.)",
      "refers_to": "CartItemPriceAdjustment"
    },
    "CurrencyIsoCode": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "The ISO code for the currency that’s specified on the buyer’s account. Default value is USD. Valid values include: USD—U.S. Dollar"
    },
    "Description": {
      "type": "textarea",
      "properties": "Create, Nillable, Update",
      "description": "A description of the tax. Enter up to 2000 characters."
    },
    "Name": {
      "type": "string",
      "properties": "Create, Filter, Group, idLookup, Sort, Update",
      "description": "The name of this CartTax record. Name can be up to 255 characters."
    },
    "TaxCalculationDate": {
      "type": "date",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The date this tax was calculated."
    },
    "TaxRate": {
      "type": "percent",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The applied tax rate for this line of tax."
    },
    "TaxType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "The type of tax for this line of tax. Possible values are: Actual Estimated"
    }
  },
  "special_access_rules": "The CartTax object is available only if the B2B Commerce or D2C Commerce license is enabled.",
  "associated_objects": "This object has the following associated objects. Unless it’s noted, associated objects are available in the same API version as this object.\n\n- **CartTaxChangeEvent (API version 58.0)**: Change events are available for the object.",
  "field_reference": {
    "AdjustmentTargetType": {
      "field_label": "Target Type for the Adjustment",
      "type": "picklist",
      "length": "255"
    },
    "Amount": {
      "field_label": "Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "CartId": {
      "field_label": "Cart ID",
      "type": "reference",
      "length": "18"
    },
    "CartItemId": {
      "field_label": "Cart Item ID",
      "type": "reference",
      "length": "18"
    },
    "CartItemPriceAdjustmentId": {
      "field_label": "Cart Item Price Adjustment ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "Description": {
      "field_label": "Description",
      "type": "textarea",
      "length": "2000"
    },
    "Id": {
      "field_label": "Cart Tax ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "Name": {
      "field_label": "Cart Tax Name",
      "type": "string",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "TaxCalculationDate": {
      "field_label": "Tax Calculation Date",
      "type": "date"
    },
    "TaxRate": {
      "field_label": "Tax Rate",
      "type": "percent",
      "precision": "5",
      "scale": "2"
    },
    "TaxType": {
      "field_label": "Tax Type",
      "type": "picklist",
      "length": "255"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "precision",
    "scale"
  ]
}