Skip to content
English - United Kingdom
  • There are no suggestions because the search field is empty.

How do I use the V4 Deposits API to export tenancy deposit data?

The V4 Deposits API provides branch-based export of tenancy deposit information including tenant details, deposit amounts, and protection scheme data for compliance and financial reporting. All endpoints are at https://live-api.letmc.com/v4/deposits/.

The V4 Deposits API is a focused export tool for tenancy deposit data. It is designed for compliance reporting, financial reconciliation, deposit protection scheme submissions, and third-party accounting system integration.

Deposit export workflow

  1. Get branches — GET /v4/deposits/{shortName}/company/branches/{offset}/{count}
  2. Export deposit data — GET /v4/deposits/{shortName}/deposits/{branchID}/tenancies/{offset}/{count} Returns comprehensive deposit information for all tenancies managed by the specified branch.

What the export includes

For each tenancy:

  • Tenancy OID (unique identifier)
  • Property address including postcode
  • Deposit amount required
  • Deposit protection scheme type
  • Deposit classification type

For each tenant within the tenancy:

  • Tenant OID
  • Full name
  • Bond outstanding (amount still owed)
  • Bond paid (amount already paid)

Common use cases

  • Submitting to government-approved deposit protection schemes
  • Financial reconciliation of deposit amounts paid versus outstanding
  • Regulatory compliance and internal audit reporting
  • Exporting to external accounting systems or reporting tools

Additional endpoints

  • Specific branch: GET /company/branches/{branchID}
  • Custom field definition: GET /company/object/{objectID}/customfield
  • Custom field value: GET /company/objects/{objectID}/{fieldID}/value
  • Set custom field: POST /company/objects/{objectID}/{fieldID}/customfield

Best practices

  • Process deposits by branch to manage data volumes
  • Set up regular exports for ongoing compliance requirements
  • Validate deposit amounts before submitting to external systems
  • Handle deposit data securely — it contains sensitive financial and personal information

Test with Swagger: Select "V4.Deposits" from the tier dropdown.