API reference · Communities & institutions

Rentals estates

POST/rental/estateMake a community an estate
POST/rental/estate-charge/{reference}/payPay an estate charge
GET/rental/estate/{reference}An estate
GET/rental/estate/{reference}/arrearsArrears by unit and age
GET/rental/estate/{reference}/chargeThe estate's charges
POST/rental/estate/{reference}/chargeDefine a charge on the estate's units
POST/rental/estate/{reference}/obligation/{obligationReference}/cashRecord cash the estate collected
POST/rental/estate/{reference}/obligation/{obligationReference}/waiveWaive a charge
POST/rental/estate/{reference}/property/{propertyReference}Bring a property into the estate
POST/rental/estate/{reference}/unit/{unitReference}/flagFlag a unit
POST/rental/estate/{reference}/unit/{unitReference}/flag/liftLift a unit's flag
GET/rental/estate/{reference}/unit/{unitReference}/obligationEvery charge raised on one unit
POST/rental/tenancy/{reference}/endEnd a tenancy on a move-out date
GET/rental/tenancy/{reference}/estate-chargesEstate charges on your tenancy
GET/rental/unit/{reference}/arrearsEstate arrears that stay with a unit

POST Make a community an estate

POST /rental/estate

The community keeps governance, roles, the pot and multi-signature payouts; the estate adds units. Needs MANAGE_COMMUNITY on the community, and opens the pot in the market's currency if it has none.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Example

Request body: EstateRequest · Response: GenericResponseEstateResponse

curl -X POST "https://api.bridgemoni.com/rental/estate" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "communityReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "name": "Adeola Gardens Estate",
  "marketCode": "NG-LA",
  "propertyReferences": [
    "string"
  ]
}'

{
  "communityReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "name": "Adeola Gardens Estate",
  "marketCode": "NG-LA",
  "propertyReferences": [
    "string"
  ]
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "communityReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "operatorPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": "string",
    "marketCode": "string",
    "currencyCode": "string",
    "propertyReferences": [
      "string"
    ],
    "unitCount": 0,
    "potAccountNumber": "string",
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Estate created successfully"
}

Responses

Status	When
`200`	Estate created successfully
`409`	The community is already an estate, or a property belongs to another estate

POST Pay an estate charge

POST /rental/estate-charge/{reference}/pay

From your main wallet. The estate is paid into its community pot on the next settlement run.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`

Example

Request body: ChargePaymentRequest · Response: GenericResponseRentPaymentResponse

curl -X POST "https://api.bridgemoni.com/rental/estate-charge/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/pay" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 0,
  "collectedBy": "string",
  "idempotencyKey": "string"
}'

{
  "amount": 0,
  "collectedBy": "string",
  "idempotencyKey": "string"
}

{
  "data": {
    "paymentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "financialTransactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "RECEIVED",
    "rail": "WALLET",
    "amount": 0,
    "currencyCode": "string",
    "valueDate": "2026-09-25",
    "assuranceGrade": "G0_ASSERTED",
    "allocations": [
      {
        "chargeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "chargeType": "RENT",
        "periodStart": "2026-09-25",
        "periodEnd": "2026-09-25",
        "amountApplied": 0,
        "chargeStatus": "BEFORE_REGISTRATION"
      }
    ],
    "charges": [
      {
        "category": "string",
        "narrative": "string",
        "amount": 0,
        "borneBy": "OCCUPANT"
      }
    ],
    "obligations": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "payeeRole": "LANDLORD",
        "obligationType": "RENT",
        "grossAmount": 0,
        "netAmount": 0,
        "status": "PENDING",
        "releaseAt": "2026-09-25T10:00:00Z",
        "holdReason": "string"
      }
    ],
    "receipt": {
      "receiptNumber": "string",
      "issuedAt": "2026-09-25T10:00:00Z"
    }
  },
  "description": "Estate charge paid successfully"
}

Responses

Status	When
`200`	Estate charge paid successfully

GET An estate

GET /rental/estate/{reference}

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseEstateResponse

curl -X GET "https://api.bridgemoni.com/rental/estate/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "communityReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "operatorPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": "string",
    "marketCode": "string",
    "currencyCode": "string",
    "propertyReferences": [
      "string"
    ],
    "unitCount": 0,
    "potAccountNumber": "string",
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Estate retrieved successfully"
}

Responses

Status	When
`200`	Estate retrieved successfully

GET Arrears by unit and age

GET /rental/estate/{reference}/arrears

Outstanding charges past their due date, grouped by unit, largest first. Needs VIEW_LEDGER.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseEstateArrearsResponse

curl -X GET "https://api.bridgemoni.com/rental/estate/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/arrears" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "estateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "totalOutstanding": 0,
    "unitsInArrears": 0,
    "unitsExamined": 0,
    "units": [
      {
        "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "unitLabel": "string",
        "outstanding": 0,
        "oldestDueDate": "2026-09-25",
        "ageBucket": "string",
        "openObligations": 0,
        "flagged": true
      }
    ]
  },
  "description": "Arrears retrieved successfully"
}

Responses

Status	When
`200`	Arrears retrieved successfully

GET The estate's charges

GET /rental/estate/{reference}/charge

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseListUnitChargeResponse

curl -X GET "https://api.bridgemoni.com/rental/estate/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/charge" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "estateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "chargeType": "SERVICE_CHARGE",
      "name": "string",
      "amount": 0,
      "currencyCode": "string",
      "cadence": "MONTHLY",
      "unitsCovered": 0,
      "nextRunOn": "2026-09-25",
      "firstObligationCount": 0,
      "payoutApprovalsRequired": 0
    }
  ],
  "description": "Charges retrieved successfully"
}

Responses

Status	When
`200`	Charges retrieved successfully

POST Define a charge on the estate's units

POST /rental/estate/{reference}/charge

Raises one obligation per unit per period from the effective date, each resolved to whoever occupies the unit. Refused until the pot has as many signatories as the community requires approvals.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`

Example

Request body: UnitChargeRequest · Response: GenericResponseUnitChargeResponse

curl -X POST "https://api.bridgemoni.com/rental/estate/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/charge" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "chargeType": "SERVICE_CHARGE",
  "name": "Quarterly service charge 2026",
  "amount": 75000.0,
  "cadence": "MONTHLY",
  "dueDay": 5,
  "effectiveFrom": "2026-09-25",
  "effectiveTo": "2026-09-25",
  "scope": "ALL_UNITS",
  "unitReferences": [
    "string"
  ],
  "prorateOnOccupancyChange": true,
  "gracePeriodDays": 14
}'

{
  "chargeType": "SERVICE_CHARGE",
  "name": "Quarterly service charge 2026",
  "amount": 75000.0,
  "cadence": "MONTHLY",
  "dueDay": 5,
  "effectiveFrom": "2026-09-25",
  "effectiveTo": "2026-09-25",
  "scope": "ALL_UNITS",
  "unitReferences": [
    "string"
  ],
  "prorateOnOccupancyChange": true,
  "gracePeriodDays": 14
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "estateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "chargeType": "SERVICE_CHARGE",
    "name": "string",
    "amount": 0,
    "currencyCode": "string",
    "cadence": "MONTHLY",
    "unitsCovered": 0,
    "nextRunOn": "2026-09-25",
    "firstObligationCount": 0,
    "payoutApprovalsRequired": 0
  },
  "description": "Charge defined successfully"
}

Responses

Status	When
`200`	Charge defined successfully
`400`	The charge definition is not valid
`409`	Signatories not yet seated

POST Record cash the estate collected

POST /rental/estate/{reference}/obligation/{obligationReference}/cash

Settles the charge on the estate's word. No money moves on the platform, so the receipt is graded as counterparty-confirmed, not observed.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`
`obligationReference`

Example

Request body: ChargePaymentRequest · Response: GenericResponseChargeObligationResponse

curl -X POST "https://api.bridgemoni.com/rental/estate/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/obligation/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/cash" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 0,
  "collectedBy": "string",
  "idempotencyKey": "string"
}'

{
  "amount": 0,
  "collectedBy": "string",
  "idempotencyKey": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unitChargeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "chargeType": "SERVICE_CHARGE",
    "periodStart": "2026-09-25",
    "periodEnd": "2026-09-25",
    "dueDate": "2026-09-25",
    "amount": 0,
    "amountSettled": 0,
    "currencyCode": "string",
    "status": "DUE"
  },
  "description": "Cash receipt recorded successfully"
}

Responses

Status	When
`200`	Cash receipt recorded successfully

POST Waive a charge

POST /rental/estate/{reference}/obligation/{obligationReference}/waive

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`
`obligationReference`

Example

Request body: ChargeWaiverRequest · Response: GenericResponseChargeObligationResponse

curl -X POST "https://api.bridgemoni.com/rental/estate/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/obligation/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/waive" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "string"
}'

{
  "reason": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unitChargeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "chargeType": "SERVICE_CHARGE",
    "periodStart": "2026-09-25",
    "periodEnd": "2026-09-25",
    "dueDate": "2026-09-25",
    "amount": 0,
    "amountSettled": 0,
    "currencyCode": "string",
    "status": "DUE"
  },
  "description": "Charge waived successfully"
}

Responses

Status	When
`200`	Charge waived successfully

POST Bring a property into the estate

POST /rental/estate/{reference}/property/{propertyReference}

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`
`propertyReference`

Example

Response: GenericResponseEstateResponse

curl -X POST "https://api.bridgemoni.com/rental/estate/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/property/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "communityReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "operatorPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": "string",
    "marketCode": "string",
    "currencyCode": "string",
    "propertyReferences": [
      "string"
    ],
    "unitCount": 0,
    "potAccountNumber": "string",
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Property added successfully"
}

Responses

Status	When
`200`	Property added successfully
`409`	The property is in another estate or another market

POST Flag a unit

POST /rental/estate/{reference}/unit/{unitReference}/flag

An estate decision with a recorded author. Nothing flags a unit automatically.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`
`unitReference`

Example

Request body: EstateFlagRequest · Response: GenericResponseEstateFlagResponse

curl -X POST "https://api.bridgemoni.com/rental/estate/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/unit/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/flag" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "string"
}'

{
  "reason": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "ACTIVE",
    "reason": "string",
    "flaggedByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Unit flagged successfully"
}

Responses

Status	When
`200`	Unit flagged successfully

POST Lift a unit's flag

POST /rental/estate/{reference}/unit/{unitReference}/flag/lift

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`
`unitReference`

Example

Request body: EstateFlagRequest · Response: GenericResponseEstateFlagResponse

curl -X POST "https://api.bridgemoni.com/rental/estate/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/unit/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/flag/lift" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "string"
}'

{
  "reason": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "ACTIVE",
    "reason": "string",
    "flaggedByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Flag lifted successfully"
}

Responses

Status	When
`200`	Flag lifted successfully

GET Every charge raised on one unit

GET /rental/estate/{reference}/unit/{unitReference}/obligation

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`
`unitReference`

Example

Response: GenericResponseListChargeObligationResponse

curl -X GET "https://api.bridgemoni.com/rental/estate/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/unit/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/obligation" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "unitChargeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "chargeType": "SERVICE_CHARGE",
      "periodStart": "2026-09-25",
      "periodEnd": "2026-09-25",
      "dueDate": "2026-09-25",
      "amount": 0,
      "amountSettled": 0,
      "currencyCode": "string",
      "status": "DUE"
    }
  ],
  "description": "Unit charges retrieved successfully"
}

Responses

Status	When
`200`	Unit charges retrieved successfully

POST End a tenancy on a move-out date

POST /rental/tenancy/{reference}/end

Unpaid rent after the move-out date is cancelled. Estate charges spanning the date are split by days where the charge says so; the rest stay with the unit for the next occupant.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`

Example

Request body: TenancyEndRequest · Response: GenericResponseTenancyResponse

curl -X POST "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/end" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "moveOutDate": "2026-09-25",
  "narrative": "string"
}'

{
  "moveOutDate": "2026-09-25",
  "narrative": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "landlordName": {
      "name": "string"
    },
    "landlordContact": "string",
    "landlordUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "agentName": {
      "name": "string"
    },
    "termStart": "2026-09-25",
    "termEnd": "2026-09-25",
    "rentBand": "string",
    "currencyCode": "string",
    "paymentFrequency": "WEEKLY",
    "agreementDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "attestationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyStatus": "PENDING",
    "active": "true",
    "currentlyResident": "true",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Tenancy ended successfully"
}

Responses

Status	When
`200`	Tenancy ended successfully
`409`	The tenancy cannot be ended in its current state

GET Estate charges on your tenancy

GET /rental/tenancy/{reference}/estate-charges

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseListChargeObligationResponse

curl -X GET "https://api.bridgemoni.com/rental/tenancy/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/estate-charges" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "unitChargeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "chargeType": "SERVICE_CHARGE",
      "periodStart": "2026-09-25",
      "periodEnd": "2026-09-25",
      "dueDate": "2026-09-25",
      "amount": 0,
      "amountSettled": 0,
      "currencyCode": "string",
      "status": "DUE"
    }
  ],
  "description": "Estate charges retrieved successfully"
}

Responses

Status	When
`200`	Estate charges retrieved successfully

GET Estate arrears that stay with a unit

GET /rental/unit/{reference}/arrears

What an incoming occupant should see before they sign: unpaid estate charges attach to the flat, not to whoever lived there.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseUnitArrearsResponse

curl -X GET "https://api.bridgemoni.com/rental/unit/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/arrears" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unitLabel": "string",
    "outstanding": 0,
    "oldestDueDate": "2026-09-25",
    "ageBucket": "string",
    "openObligations": 0,
    "flagged": true
  },
  "description": "Unit arrears retrieved successfully"
}

Responses

Status	When
`200`	Unit arrears retrieved successfully

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors