Class StampDutyRate

Hierarchy

default<DBAPIStampDutyRateData>
- StampDutyRate

Index

Properties

Accessors

additionalPropertySurcharge baseLbttRate baseLttRate baseSdltRate countryName firstTimeBuyerCap firstTimeBuyerRate id maximumPropertyPrice minimumPropertyPrice nonUkResidentSurcharge taxType

Methods

get toJSON findAll

Properties

`Static`serializer

serializer: (model: any) => any

serializer is a pure function that takes a model instance and returns a plain object that describes how to convert the model to JSON

Accessors

additionalPropertySurcharge

get additionalPropertySurcharge(): string | number | null
Returns string | number | null
- Defined in src/api/models/stamp-duty-rate.ts:65

baseLbttRate

get baseLbttRate(): string | number | null
Returns string | number | null
- Defined in src/api/models/stamp-duty-rate.ts:57

baseLttRate

get baseLttRate(): string | number | null
Returns string | number | null
- Defined in src/api/models/stamp-duty-rate.ts:61

baseSdltRate

get baseSdltRate(): string | number | null
Returns string | number | null
- Defined in src/api/models/stamp-duty-rate.ts:53

countryName

get countryName(): SelectableCountries
Returns SelectableCountries
- Defined in src/api/models/stamp-duty-rate.ts:40

firstTimeBuyerCap

get firstTimeBuyerCap(): string | number | null
Returns string | number | null
- Defined in src/api/models/stamp-duty-rate.ts:77

firstTimeBuyerRate

get firstTimeBuyerRate(): string | number | null
Returns string | number | null
- Defined in src/api/models/stamp-duty-rate.ts:69

id

get id(): number | null
Returns number | null
- Defined in src/api/models/stamp-duty-rate.ts:36

maximumPropertyPrice

get maximumPropertyPrice(): number | null
Returns number | null
- Defined in src/api/models/stamp-duty-rate.ts:49

minimumPropertyPrice

get minimumPropertyPrice(): number | null
Returns number | null
- Defined in src/api/models/stamp-duty-rate.ts:45

nonUkResidentSurcharge

get nonUkResidentSurcharge(): string | number | null
Returns string | number | null
- Defined in src/api/models/stamp-duty-rate.ts:73

taxType

get taxType(): TaxTypes | null
Returns TaxTypes | null
- Defined in src/api/models/stamp-duty-rate.ts:81

Methods

get

get(key: string): any
Retrieves a value from raw API data. Prioritises DBAPI data if available
Parameters
- key: string
Returns any
Inherited from Model.get
- Defined in src/api/models/model.ts:121

toJSON

toJSON(): any
Special method to define behaviour of JSON.stringify() on model instance

Returns any
Inherited from Model.toJSON
- Defined in src/api/models/model.ts:130

`Static`findAll

findAll(
    __namedParameters?: { searchParams?: Country },
): Promise<
    {
        errors: ModelError[]
        | null;
        pagination: Pagination | null;
        results: StampDutyRate[];
    },
>
Parameters
- __namedParameters: { searchParams?: Country } = {}
Returns Promise<
    {
        errors: ModelError[]
        | null;
        pagination: Pagination | null;
        results: StampDutyRate[];
    },
>
- Defined in src/api/models/stamp-duty-rate.ts:15