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>"
}
]
}Leases
List lease transactions
GET
/
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
The unique identifier of the lease
Maximum number of transactions to return (0-100)
Cursor for pagination. Pass the id of the last transaction from the previous page to get the next page.
Response
Show child attributes
Show child attributes
Unique identifier for the transaction
Transaction type: “Payment” or “Charge”
Sequential transaction number within the lease
Date the transaction was registered (ISO 8601: YYYY-MM-DD)
Date of payment (for payment transactions, nullable)
Date the charge applies to
Payment due date (nullable)
Associated product ID (nullable)
Product reference key (nullable)
Whether the transaction has been cancelled
Reason for cancellation (nullable, only if annulled)
Plain text description override (nullable)
Link to associated payment (nullable)
Link to associated bill (nullable)
Link to move-out statement (nullable)
Link to default notice document (nullable)
⌘I