@reapit/gbl-pp-owner-api-ts-definitions 1.0.0 → 1.0.4

package/dist/owner-api/beneficiaries.d.ts

@@ -0,0 +1,85 @@
+import type { AddressModel, AgencyBasicModel, DateString, ExternalID, PaginationModel } from "./shared";
+/**
+ * Full beneficiary entity. Contains all beneficiary details including
+ * address and ownership information.
+ */
+export interface BeneficiaryModel {
+    /** Address associated with the beneficiary. */
+    address: AddressModel;
+    /** Minimal information about the agency associated with this beneficiary. */
+    agency: AgencyBasicModel;
+    /** Business name. */
+    business_name: string;
+    /** Formatted beneficiary display name used on the platform. */
+    display_name: string;
+    /** Beneficiary first name. */
+    first_name: string;
+    /** PayProp external ID. */
+    id: ExternalID;
+    /** Beneficiary last name. */
+    last_name: string;
+    /** Number of unique properties the beneficiary has an ownership. */
+    number_of_properties: number;
+}
+/**
+ * Paginated response from `GET /beneficiaries`.
+ */
+export interface BeneficiariesPagedResult {
+    /** List of beneficiary entities. */
+    items: BeneficiaryModel[];
+    /** Pagination metadata. */
+    pagination: PaginationModel;
+}
+/**
+ * Query parameters for `GET /beneficiaries`.
+ */
+export interface BeneficiariesQueryParams {
+    /**
+     * Number of rows to return.
+     * Must be between 1 and 25.
+     * @example 12
+     */
+    rows?: number;
+    /**
+     * Page number to return.
+     * Must be >= 1.
+     * @example 3
+     */
+    page?: number;
+    /**
+     * Filter beneficiaries based on ownership start date.
+     *
+     * If `end_date` is not provided, ownerships are filtered to those whose start date is on or after the given `start_date`.
+     *
+     * If both `start_date` and `end_date` are provided, ownerships are filtered where the ownership start date
+     * is on or before `end_date`, and the ownership end date is either not set or on or after `start_date`.
+     * @example '2025-10-21'
+     */
+    start_date?: DateString;
+    /**
+     * Filter beneficiaries based on ownership end date.
+     *
+     * If `start_date` is not provided, ownerships are filtered to those whose start date is on or before `end_date`,
+     * and whose end date is either not set or on or after `end_date`.
+     *
+     * If both `start_date` and `end_date` are provided, ownerships are filtered where the ownership start date
+     * is on or before `end_date`, and the ownership end date is either not set or on or after `start_date`.
+     * @example '2025-10-21'
+     */
+    end_date?: DateString;
+    /**
+     * Filter by one or more agency IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    agency_id?: ExternalID[];
+    /**
+     * Filter by one or more property IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    property_id?: ExternalID[];
+    /**
+     * Filter by one or more beneficiary IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    beneficiary_id?: ExternalID[];
+}

package/dist/owner-api/csv.d.ts

@@ -0,0 +1,96 @@
+import type { DateString, ExternalID } from "./shared";
+/**
+ * Query parameters for `GET /documents/csv/payments/incoming`.
+ */
+export interface DocumentsCsvPaymentsIncomingQueryParams {
+    /**
+     * Filter report from date (inclusive).
+     * @example '2025-10-21'
+     */
+    from_date: DateString;
+    /**
+     * Filter report to date (inclusive).
+     * @example '2025-10-21'
+     */
+    to_date: DateString;
+    /**
+     * Filter by one or more property IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    property_id?: ExternalID[];
+    /**
+     * Filter by one or more agency IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    agency_id?: ExternalID[];
+    /**
+     * Filter by one or more beneficiary IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    beneficiary_id?: ExternalID[];
+    /**
+     * Filter by one or more tenant IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    tenant_id?: ExternalID[];
+}
+/**
+ * Query parameters for `GET /documents/csv/payments/outgoing`.
+ */
+export interface DocumentsCsvPaymentsOutgoingQueryParams {
+    /**
+     * Filter report from date (inclusive).
+     * @example '2025-10-21'
+     */
+    from_date: DateString;
+    /**
+     * Filter report to date (inclusive).
+     * @example '2025-10-21'
+     */
+    to_date: DateString;
+    /**
+     * Filter by one or more property IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    property_id?: ExternalID[];
+    /**
+     * Filter by one or more agency IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    agency_id?: ExternalID[];
+    /**
+     * Filter by one or more beneficiary IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    beneficiary_id?: ExternalID[];
+}
+/**
+ * Query parameters for `GET /documents/csv/payments/combined`.
+ */
+export interface DocumentsCsvPaymentsCombinedQueryParams {
+    /**
+     * Filter report from date (inclusive).
+     * @example '2025-10-21'
+     */
+    from_date: DateString;
+    /**
+     * Filter report to date (inclusive).
+     * @example '2025-10-21'
+     */
+    to_date: DateString;
+    /**
+     * Filter by one or more property IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    property_id?: ExternalID[];
+    /**
+     * Filter by one or more agency IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    agency_id?: ExternalID[];
+    /**
+     * Filter by one or more beneficiary IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    beneficiary_id?: ExternalID[];
+}

package/dist/owner-api/index.d.ts

@@ -0,0 +1,10 @@
+export * from "./shared";
+export * from "./agency";
+export * from "./attachment";
+export * from "./beneficiaries";
+export * from "./properties";
+export * from "./payment";
+export * from "./ownerships";
+export * from "./tenant";
+export * from "./csv";
+export * from "../error";

package/dist/owner-api/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./shared"), exports);
+__exportStar(require("./agency"), exports);
+__exportStar(require("./attachment"), exports);
+__exportStar(require("./beneficiaries"), exports);
+__exportStar(require("./properties"), exports);
+__exportStar(require("./payment"), exports);
+__exportStar(require("./ownerships"), exports);
+__exportStar(require("./tenant"), exports);
+__exportStar(require("./csv"), exports);
+__exportStar(require("../error"), exports);

package/dist/{types/ownership.d.ts → owner-api/ownerships.d.ts}

@@ -1,4 +1,49 @@
 import type { AgencyBasicModel, AmountBase, BeneficiaryBasicModel, DateString, DateStringNullable, ExternalID, PaginationModel, PropertyBasicModel } from "./shared";
+/**
+ * Query parameters for `GET /ownerships`.
+ */
+export interface OwnershipsQueryParams {
+    /**
+     * Number of rows to return.
+     * Must be between 1 and 25.
+     * @example 12
+     */
+    rows?: number;
+    /**
+     * Page number to return.
+     * Must be >= 1.
+     * @example 3
+     */
+    page?: number;
+    /**
+     * Return ownership entries where the start_date is before or on the given value.
+     * If both `start_date` and `end_date` are given, return entries that overlap the given range.
+     * @example '2025-10-21'
+     */
+    start_date?: DateStringNullable;
+    /**
+     * Return ownership entries where the start_date is before or on the given value
+     * and end_date is after or on the given value, or indefinite.
+     * If both `start_date` and `end_date` are given, return entries that overlap the given range.
+     * @example '2025-10-21'
+     */
+    end_date?: DateStringNullable;
+    /**
+     * Filter by one or more agency IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    agency_id?: ExternalID[];
+    /**
+     * Filter by one or more property IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    property_id?: ExternalID[];
+    /**
+     * Filter by one or more beneficiary IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    beneficiary_id?: ExternalID[];
+}
 /**
  * Ownership record linking a beneficiary to a property for a specific date range.
  *

package/dist/{types → owner-api}/payment.d.ts

@@ -58,6 +58,70 @@ export interface PaymentsOutgoingOriginModel {
      */
     transaction_type: "payment" | "debit_note" | "posted_payment" | "payment_prop_acc" | "deposit_repayment" | "unknown";
 }
+/**
+ * Query parameters for `GET /payments/incoming`.
+ */
+export interface PaymentsIncomingQueryParams {
+    /**
+     * Number of rows to return.
+     * Must be between 1 and 25.
+     * @example 12
+     */
+    rows?: number;
+    /**
+     * Page number to return.
+     * Must be >= 1.
+     * @example 3
+     */
+    page?: number;
+    /**
+     * Filter report from date (inclusive).
+     * @example '2025-10-21'
+     */
+    from_date: DateString;
+    /**
+     * Filter report to date (inclusive).
+     * @example '2025-10-21'
+     */
+    to_date: DateString;
+    /**
+     * Sort order for the results. Comma-separated list of `FIELD_NAME:ORDER` pairs.
+     * Accepted field names: `reconciliation_date`, `property.name`.
+     * Up to 10 conditions may be provided.
+     * @example 'reconciliation_date:asc,property.name:desc'
+     */
+    order_by?: string;
+    /**
+     * Filter payments by transaction type.
+     * @example ['invoice', 'payment']
+     */
+    transaction_type?: ("invoice" | "payment" | "payment_prop_acc" | "deposit_repayment")[];
+    /**
+     * Filter by one or more incoming transaction IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    id?: ExternalID[];
+    /**
+     * Filter by one or more property IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    property_id?: ExternalID[];
+    /**
+     * Filter by one or more tenant IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    tenant_id?: ExternalID[];
+    /**
+     * Filter by one or more agency IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    agency_id?: ExternalID[];
+    /**
+     * Filter by one or more beneficiary IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    beneficiary_id?: ExternalID[];
+}
 /**
  * Individual incoming payment from the "Money in" section.
  */
@@ -124,6 +188,76 @@ export interface PaymentsIncomingPagedResult {
     /** Pagination metadata. */
     pagination: PaginationModel;
 }
+/**
+ * Query parameters for `GET /payments/outgoing`.
+ */
+export interface PaymentsOutgoingQueryParams {
+    /**
+     * Number of rows to return.
+     * Must be between 1 and 25.
+     * @example 12
+     */
+    rows?: number;
+    /**
+     * Page number to return.
+     * Must be >= 1.
+     * @example 3
+     */
+    page?: number;
+    /**
+     * Filter report from date (inclusive).
+     * @example '2025-10-21'
+     */
+    from_date: DateString;
+    /**
+     * Filter report to date (inclusive).
+     * @example '2025-10-21'
+     */
+    to_date: DateString;
+    /**
+     * Sort order for the results. Comma-separated list of `FIELD_NAME:ORDER` pairs.
+     * Accepted field names: `transaction_date`, `property.name`.
+     * Up to 10 conditions may be provided.
+     * @example 'transaction_date:asc,property.name:desc'
+     */
+    order_by?: string;
+    /**
+     * Filter by one or more payment origin IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    payment_origin_id?: ExternalID[];
+    /**
+     * Filter by one or more payment batch IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    payment_batch_id?: ExternalID[];
+    /**
+     * Filter by one or more property IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    property_id?: ExternalID[];
+    /**
+     * Filter by one or more agency IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    agency_id?: ExternalID[];
+    /**
+     * Filter by one or more beneficiary IDs. Filters across all properties related to the beneficiary,
+     * not payments made to the beneficiary itself. Use `payment_target_type` and `payment_target_id`
+     * to filter by payment recipient.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    beneficiary_id?: ExternalID[];
+    /**
+     * Outgoing payment beneficiary type. Required if `payment_target_id` is provided.
+     */
+    payment_target_type?: "agency" | "beneficiary" | "global_beneficiary";
+    /**
+     * Outgoing payment beneficiary ID.
+     * @example 'zJBv2E5aJQ'
+     */
+    payment_target_id?: ExternalID;
+}
 /**
  * Outgoing payment item from the "Money out" section.
  *
@@ -202,6 +336,60 @@ export interface PaymentsOutgoingPagedResult {
     /** Pagination metadata. */
     pagination: PaginationModel;
 }
+/**
+ * Query parameters for `GET /payments/combined`.
+ */
+export interface PaymentsCombinedQueryParams {
+    /**
+     * Number of rows to return.
+     * Must be between 1 and 25.
+     * @example 12
+     */
+    rows?: number;
+    /**
+     * Page number to return.
+     * Must be >= 1.
+     * @example 3
+     */
+    page?: number;
+    /**
+     * Filter report from date (inclusive).
+     * @example '2025-10-21'
+     */
+    from_date: DateString;
+    /**
+     * Filter report to date (inclusive).
+     * @example '2025-10-21'
+     */
+    to_date: DateString;
+    /**
+     * Sort order for the results. Comma-separated list of `FIELD_NAME:ORDER` pairs.
+     * Accepted field names: `date`, `property.name`.
+     * Up to 10 conditions may be provided.
+     * @example 'date:asc,property.name:desc'
+     */
+    order_by?: string;
+    /**
+     * Filter payments by type.
+     * @example ['in', 'out']
+     */
+    payment_type?: ("in" | "out" | "invoice")[];
+    /**
+     * Filter by one or more property IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    property_id?: ExternalID[];
+    /**
+     * Filter by one or more agency IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    agency_id?: ExternalID[];
+    /**
+     * Filter by one or more beneficiary IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    beneficiary_id?: ExternalID[];
+}
 /**
  * A single entry in the combined payments view, which may represent an incoming
  * payment, an outgoing payment, or an invoice.
@@ -336,6 +524,42 @@ export interface PaymentsCombinedPagedResult {
     /** Pagination metadata. */
     pagination: PaginationModel;
 }
+/**
+ * Query parameters for `GET /payments/summary`.
+ */
+export interface PaymentsSummaryQueryParams {
+    /**
+     * Filter report from date (inclusive).
+     * @example '2025-10-21'
+     */
+    from_date: DateString;
+    /**
+     * Filter report to date (inclusive).
+     * @example '2025-10-21'
+     */
+    to_date: DateString;
+    /**
+     * Return only specific summary payload fields.
+     * For optimal performance, specify only the fields you require.
+     * @example ['invoiced', 'money_in']
+     */
+    filter_field?: ("invoiced" | "money_in" | "money_out" | "properties" | "paid_to_owner" | "property_accounts" | "tenants_in_arrears")[];
+    /**
+     * Filter by one or more property IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    property_id?: ExternalID[];
+    /**
+     * Filter by one or more agency IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    agency_id?: ExternalID[];
+    /**
+     * Filter by one or more beneficiary IDs. Filters the summary across all properties related to the beneficiary.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    beneficiary_id?: ExternalID[];
+}
 /**
  * Summary of money flow for a given date range.
  * Returned from `GET /payments/summary`.

package/dist/owner-api/properties.d.ts

@@ -0,0 +1,100 @@
+import type { AddressModel, AgencyBasicModel, BeneficiaryBasicModel, DateString, ExternalID, PaginationModel } from "./shared";
+/**
+ * Query parameters for `GET /properties`.
+ */
+export interface PropertiesQueryParams {
+    /**
+     * Number of rows to return.
+     * Must be between 1 and 25.
+     * @example 12
+     */
+    rows?: number;
+    /**
+     * Page number to return.
+     * Must be >= 1.
+     * @example 3
+     */
+    page?: number;
+    /**
+     * Filter properties based on ownership start date.
+     *
+     * If `end_date` is not provided, ownerships are filtered to those whose start date is on or after the given `start_date`.
+     *
+     * If both `start_date` and `end_date` are provided, ownerships are filtered where the ownership start date
+     * is on or before `end_date`, and the ownership end date is either not set or on or after `start_date`.
+     * @example '2025-10-21'
+     */
+    start_date?: DateString;
+    /**
+     * Filter properties based on ownership end date.
+     *
+     * If `start_date` is not provided, ownerships are filtered to those whose start date is on or before `end_date`,
+     * and whose end date is either not set or on or after `end_date`.
+     *
+     * If both `start_date` and `end_date` are provided, ownerships are filtered where the ownership start date
+     * is on or before `end_date`, and the ownership end date is either not set or on or after `start_date`.
+     * @example '2025-10-21'
+     */
+    end_date?: DateString;
+    /**
+     * Include list of beneficiaries that have an ownership of the property for the specified ownership range.
+     * Defaults to `false`.
+     * @example true
+     */
+    with_beneficiaries?: boolean;
+    /**
+     * Filter by one or more agency IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    agency_id?: ExternalID[];
+    /**
+     * Filter by one or more property IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    property_id?: ExternalID[];
+    /**
+     * Filter by one or more beneficiary IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    beneficiary_id?: ExternalID[];
+    /**
+     * Search properties based on multiple conditionals. Each value is applied as an OR filter.
+     * Up to 5 values, each between 2 and 10 characters.
+     * @example ['Boston street', 'House 47']
+     */
+    search_value?: string[];
+}
+/**
+ * Full property entity. Contains all property details including address,
+ * agency association, and optional beneficiary list.
+ */
+export interface PropertyModel {
+    /** Address of the property. */
+    address: AddressModel;
+    /** Minimal information about the agency managing this property. */
+    agency: AgencyBasicModel;
+    /**
+     * List of beneficiaries that have an ownership of the property for the specified ownership range.
+     * Only present when the `with_beneficiaries` query parameter is set to `true`.
+     */
+    beneficiaries?: BeneficiaryBasicModel[] | null;
+    /** PayProp external ID. */
+    id: ExternalID;
+    /** URL of the property image, or null if no image has been set. */
+    image: string | null;
+    /** Indicates if the property is active on PayProp. */
+    is_active: boolean;
+    /** Property name. */
+    name: string;
+    /** Number of unique tenants that have an active tenancy on the property. */
+    number_of_tenants: number;
+}
+/**
+ * Paginated response from `GET /properties`.
+ */
+export interface PropertiesPagedResult {
+    /** List of property entities. */
+    items: PropertyModel[];
+    /** Pagination metadata. */
+    pagination: PaginationModel;
+}

package/dist/owner-api/shared.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });