Docs
V2 APIFees

Create fee assignment

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.

POST/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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v2/fee-assignments" \  -H "Content-Type: application/json" \  -d '{    "fee_id": "6a6e29c0-8cb8-4e1c-8beb-6b16e737bdd5",    "assignable_type": "property",    "assignable_id": "5a6d606d-d781-4b21-b020-db1cc2eaeed2"  }'
{  "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"  }}

List fee assignments GET

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 fee assignment GET

Next Page