Tax Rules

  1. List tax rules
  2. Get a single tax rule

Parameters

Name Type Read/Write Description
id Integer Read Tax Rule’s id.
comparator String Read Sign used to compare, possible values: < <= == >= >.
compared_attribute String Read Name of the attribute to compare.
ruleable_id Integer Read Id of the owner of the Tax Rule.
ruleable_type String Read Type of the owner of the Tax Rule, either RentalsTax or Tax.
value String Read Value of the compared_attribute.
created_at Time Read Tax Rule’s create time.
updated_at Time Read Tax Rule’s update time.

List tax rules

List all tax rules for a given account(s).

GET /tax_rules

Response

{
  "tax_rules": [
    {
      "id": 3,
      "comparator": "==",
      "compared_attribute": "start_at",
      "ruleable_id": 2,
      "ruleable_type": "Tax",
      "value": "4",
      "created_at": "2015-08-04T15:23:27Z",
      "updated_at": "2015-08-04T15:23:27Z"
    }
  ]
}

Get a single tax rule

Returns a single tax rule identified by ID.

GET /tax_rules/:tax_rule_id

Response

{
  "tax_rules": [
    {
      "id": 3,
      "comparator": "==",
      "compared_attribute": "start_at",
      "ruleable_id": 2,
      "ruleable_type": "Tax",
      "value": "4",
      "created_at": "2015-08-04T15:23:27Z",
      "updated_at": "2015-08-04T15:23:27Z"
    }
  ]
}