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

How do I use the V4 Reporting API to access business intelligence and analytics?

The V4 Reporting API provides access to financial reports, lettings analytics, sales progression data, and audit trails for business intelligence tools and reporting dashboards. All endpoints are at https://live-api.letmc.com/v4/reporting/.

  • All branches: GET /v4/reporting/{shortName}/company/branches/{offset}/{count}
  • Specific branch: GET /company/branches/{branchID}
  • Finance sales types: GET /company/finance/salestypes/{offset}/{count}
  • Maintenance certificate types: GET /company/maintenance/certificatetypes/{offset}/{count}

Financial reporting

  • Latest rent collection report — GET /financials/reports/rentcollected/latest Optional queryDate parameter: searches 30 days from that date. Defaults to the latest month.
  • Invoiced sales by type — GET /financials/reports/invoicedSales/{salesTypeID} Optional queryDate: searches 30 days from that date. Defaults to current month.
  • Landlord transactions (active properties) — GET /financials/transactions/landlords/{offset}/{count} Optional queryDate. Defaults to last 30 days.
  • All landlord transactions — GET /financials/transactions/landlords/all/{offset}/{count} Includes archived and inactive properties. Optional queryDate.

Lettings analytics

  • Failed tenancy applications — GET /lettings/applications/failed Optional queryDate: searches 30 days from that date. Defaults to past 30 days.
  • Maintenance certificates — GET /lettings/certificates/{certificateTypeID} All certificates of a given type — useful for compliance and expiry tracking.
  • All tenancies — GET /lettings/tenancies/{offset}/{count} Comprehensive tenancy data for portfolio analysis.
  • Property shareholders/owners — GET /lettings/{propertyID}/shareholder All landlords/shareholders for a property, including ownership percentage.

Progression tracking

  • Property progression checklist: GET /lettings/properties/{propertyID}/progressionchecklist
  • Tenancy progression checklist: GET /lettings/{tenancyID}/progressionchecklist
  • Tenancy special conditions: GET /lettings/{tenancyID}/specialconditions

Sales analytics

  • Sales progression checklist: GET /sales/{salesID}/progressionchecklist

Data audit and compliance

  • Data audit report: GET /company/dataAudit/{offset}/{count} Required: startDate and endDate. Tracks all system data changes within the period — essential for compliance and audit trails.

Custom fields

  • Get definition: /company/object/{objectID}/customfield
  • Get value: /company/objects/{objectID}/{fieldID}/value
  • Set value: POST /company/objects/{objectID}/{fieldID}/customfield

Test with Swagger: Select "V4.Reporting" from the tier dropdown. Start with company/branches to understand your data structure before querying reporting endpoints.