Show a tax preset

GET/v1/api/store/{team_slug}/setting/tax_type/{hash_id}

v1Operation ID v1_public_custom_tax_show

Returns one tax preset, deleted or not.

Permission

Any team member can call it. Reading needs no extra permission.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• hash_idstringrequired

  The tax preset's id: a hash id from an earlier answer. Only hash ids work here; anything else answers 404 page_not_found.

  • Example kazdbC5ICA0kV0

Request body

This operation takes no request body.

Response

200Successful response.

• dataobjectrequired
  Child fields (18)

  • apply_before_discbooleanrequired

    Whether tax is calculated before the discount (Calculate Taxes Before Discount). Normally false: tax comes after the discount.

  • defaultbooleanrequired

    Whether it is the team's default tax preset. At most one preset is the default.

  • enablebooleanrequired
  • idstringrequired
  • line_taxesarray of objectsrequired

    The parts of a line_tax preset, as they were sent. Empty for the others.

    Fields of each item (2)

    • namestringrequired

      The part's name, such as State or County.

    • totalintegerrequired

      The part's rate. A percentage ×1000: 8250 is 8.25%. With X-Yoprint-Decimal-Format: exact-v1, a value that isn't a whole number comes back as a string.

      • Minimum 0
  • namestringrequired
  • secondary_typestring | nullrequired

    For system presets, which one: auto is Auto Tax, YoPrint's automatic US sales tax; other is a 0% preset some teams have, whose name always reads Tax Exempt. Null for your own presets.

  • shipping_taxablebooleanrequired

    Whether shipping is taxed (Tax Shipping).

  • totalintegerrequired

    The rate. For line_tax, the sum of the parts. Auto Tax shows 0: its rate is looked up per invoice. A percentage ×1000: 8250 is 8.25%. With X-Yoprint-Decimal-Format: exact-v1, a value that isn't a whole number comes back as a string.

    • Minimum 0
  • trashedbooleanrequired

    True for a deleted preset. Restore it with Restore a tax preset.

  • typestringrequired

    simple (Single Line Tax): one rate. line_tax (Multi Line Tax): parts that add up. system: made by YoPrint, such as Auto Tax.

    • One of: "simple", "line_tax", "system"
  • can_override_ratesboolean
  • can_override_rulesboolean
  • errorstring
  • hiddenboolean
  • override_ratesarray of objects
  • override_rulesarray of objects
  • supported_placearray of objects
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Related

• PATCHUpdate a tax preset (same as PUT)/v1/api/store/{team_slug}/setting/tax_type/{hash_id}

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/setting/tax_type/kazdbC5ICA0kV0' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": {
    "apply_before_disc": false,
    "can_override_rates": false,
    "can_override_rules": false,
    "default": true,
    "enable": true,
    "error": "",
    "hidden": false,
    "id": "kazdbC5ICA0kV0",
    "line_taxes": [],
    "name": "State sales tax",
    "override_rates": [],
    "override_rules": [],
    "secondary_type": null,
    "shipping_taxable": true,
    "supported_place": [],
    "total": 6000,
    "trashed": false,
    "type": "simple"
  },
  "status": 200,
  "success": true
}