Docs
V2 APIFees

List fee assignments

Where a fee applies: a property, a floor plan or a unit, optionally narrowed to bedroom counts or floor plans and to dates, with the fee's amount, frequency or requirement overridden for that scope. The most specific assignment wins: unit, then floor plan, then property. Every change reprices the property's floor plans and units in the background, usually within seconds. Requires permission to update the fee.

GET/api/v2/fee-assignments

Where a fee applies: a property, a floor plan or a unit, optionally narrowed to bedroom counts or floor plans and to dates, with the fee's amount, frequency or requirement overridden for that scope. The most specific assignment wins: unit, then floor plan, then property. Every change reprices the property's floor plans and units in the background, usually within seconds. Requires permission to update the fee.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

account_id?string

Optional account to run this request against. Defaults to the account the API token is scoped to, so callers with a single account can omit it. Must be an account the authenticated user belongs to; staff may target any account. For write requests the value may be sent in the JSON body instead of the query string. The resolved account is returned on the X-Resi-Account-Id response header.

Formatuuid
per_page?integer
Range1 <= value <= 200
Default15
fee_id?string

Only assignments of this fee.

Formatuuid
property_id?string

Only assignments on this property, its floor plans and its units.

Formatuuid
assignable_type?string

Only assignments at this level.

Value in

  • "property"
  • "floor_plan"
  • "unit"
assignable_id?string

Only assignments on this record.

Formatuuid
is_enabled?boolean

Filter on enabled.

created_at?string

Exact created_at, or a range with created_at[gte], created_at[lte], created_at[gt] and created_at[lt].

updated_at?string

Exact updated_at, or a range with updated_at[gte], updated_at[lte], updated_at[gt] and updated_at[lt].

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/fee-assignments"
{  "data": [    {      "id": 0,      "fee_id": "6a6e29c0-8cb8-4e1c-8beb-6b16e737bdd5",      "assignable_type": "property",      "assignable_id": "5a6d606d-d781-4b21-b020-db1cc2eaeed2",      "is_enabled": true,      "effective_start": "2019-08-24",      "effective_end": "2019-08-24",      "priority": 0,      "unit_types": [        "Studio"      ],      "floor_plan_ids": [        "3c9ff231-e3de-4724-ac4a-8bf606e6a487"      ],      "settings": {},      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "links": {    "first": "string",    "last": "string",    "prev": "string",    "next": "string"  },  "meta": {    "current_page": 0,    "from": 0,    "last_page": 0,    "links": [      {        "url": "string",        "label": "string",        "page": 0,        "active": true      }    ],    "path": "string",    "per_page": 200,    "to": 0,    "total": 0  }}

Delete fee DELETE

Previous Page

Create fee assignment POST

Where a fee applies: a property, a floor plan or a unit, optionally narrowed to bedroom counts or floor plans and to dates, with the fee's amount, frequency or requirement overridden for that scope. The most specific assignment wins: unit, then floor plan, then property. Every change reprices the property's floor plans and units in the background, usually within seconds. Requires permission to update the fee.