Skip to main content
GET
https://api.helloproper.com
/
leases
/
{leaseId}
/
transactions
List lease transactions
curl --request GET \
  --url https://api.helloproper.com/leases/{leaseId}/transactions \
  --header 'Authorization: <api-key>'
{
  "transactions": [
    {
      "id": "<string>",
      "type": "<string>",
      "transactionNumber": 123,
      "amount": {
        "currency": "<string>",
        "amount": 123
      },
      "vat": {
        "taxMode": "<string>",
        "taxRate": 123
      },
      "registrationDate": "<string>",
      "paymentDate": "<string>",
      "chargeDate": "<string>",
      "dueDate": "<string>",
      "description": {
        "key": "<string>",
        "params": {}
      },
      "productId": "<string>",
      "productKey": "<string>",
      "productName": {
        "en": "<string>",
        "da": "<string>"
      },
      "balance": {
        "currency": "<string>",
        "amount": 123
      },
      "annulled": true,
      "annulledReason": "<string>",
      "descriptionText": "<string>",
      "paymentId": "<string>",
      "billId": "<string>",
      "moveOutStatementId": "<string>",
      "defaultNoticeDocumentId": "<string>"
    }
  ]
}
Returns a paginated list of all transactions for a specific lease.

Params

leaseId
string
required
The unique identifier of the lease
limit
integer
default:10
Maximum number of transactions to return (0-100)
startingAfter
string
Cursor for pagination. Pass the id of the last transaction from the previous page to get the next page.

Response

transactions
array