List lease transactions
curl --request GET \
--url https://api.helloproper.com/leases/{leaseId}/transactions \
--header 'Authorization: <api-key>'import requests
url = "https://api.helloproper.com/leases/{leaseId}/transactions"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.helloproper.com/leases/{leaseId}/transactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.helloproper.com/leases/{leaseId}/transactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.helloproper.com/leases/{leaseId}/transactions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.helloproper.com/leases/{leaseId}/transactions")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helloproper.com/leases/{leaseId}/transactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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>'import requests
url = "https://api.helloproper.com/leases/{leaseId}/transactions"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.helloproper.com/leases/{leaseId}/transactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.helloproper.com/leases/{leaseId}/transactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.helloproper.com/leases/{leaseId}/transactions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.helloproper.com/leases/{leaseId}/transactions")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helloproper.com/leases/{leaseId}/transactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
string
required
The unique identifier of the lease
integer
default:10
Maximum number of transactions to return (0-100)
string
Cursor for pagination. Pass the id of the last transaction from the previous page to get the next page.
Response
array
Show child attributes
Show child attributes
string
Unique identifier for the transaction
string
Transaction type: “Payment” or “Charge”
integer
Sequential transaction number within the lease
Money Object
Tax Object
date
Date the transaction was registered (ISO 8601: YYYY-MM-DD)
date
Date of payment (for payment transactions, nullable)
date
Date the charge applies to
date
Payment due date (nullable)
SmartText Object
string
Associated product ID (nullable)
string
Product reference key (nullable)
object
Money Object
boolean
Whether the transaction has been cancelled
string
Reason for cancellation (nullable, only if annulled)
string
Plain text description override (nullable)
string
Link to associated payment (nullable)
string
Link to associated bill (nullable)
string
Link to move-out statement (nullable)
string
Link to default notice document (nullable)
⌘I