HomeDashHomeDash
API reference

Rent invoices via API

Send the same invoice or receipt email as the landlord dashboard, or download the PDF bytes, using the public API. Works with Zapier, Make, n8n, curl, and custom scripts.

Endpoints

ActionMethodPathScopePlan
Download PDFGET/rent/{id}/invoice/pdfread_onlyPortfolio or Enterprise
Email to tenantPOST/rent/{id}/invoice/emailread_writeEnterprise

Replace {id} with the rent payment UUID from GET /rent or webhook field rent_payment_id.

Download PDF (curl)

BASH
curl -H "Authorization: Bearer hd_live_YOUR_KEY" \
  -o invoice.pdf \
  "https://app.homedash.co.uk/api/public/v1/rent/RENT_PAYMENT_UUID/invoice/pdf"

Response is 200 with Content-Type: application/pdf. The body starts with %PDF-1.4 — that is the file, not an error.

Send invoice email (curl)

BASH
curl -X POST \
  "https://app.homedash.co.uk/api/public/v1/rent/RENT_PAYMENT_UUID/invoice/email" \
  -H "Authorization: Bearer hd_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Optional body: {"email":"tenant@example.com"}. Optional header Idempotency-Key (max 128 chars).

Common mistakes

  • 405 on email: use POST for /invoice/email, not GET.
  • Invalid JSON body: include Content-Type: application/json and at least in the body.
  • Zapier PDF: raw %PDF in the test panel is success — add Drive/Dropbox to save the file.
  • Dedup: one successful email per rent via public API; retries return 200 with the stored payload.

Related docs