> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.propexo.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.propexo.com/_mcp/server. # Get a resident payment by ID GET https://api.propexo.com/v1/resident-payments/{resident_payment_id} The Resident Payments model provides a limited, one-sided view of a resident's financial history with a PMC and should not be treated as a comprehensive report of all payments that the resident has made. Due to the PMS API structure, this is a naturally high-volume endpoint. Since Propexo pricing is based on records returned, this may result in signficantly higher overall costs. We encourage you to reach out to support before activating. Reference: https://docs.propexo.com/api-reference/real-page-app-partner/billing-and-payments/get-a-resident-payment-by-id ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Servers - `https://api.propexo.com` (Production, default) - `https://api.sandbox.propexo.com` (Sandbox) ## Request ### Path parameters - `resident_payment_id` (string, required) — The ID of the resource. ### Query parameters - `order-by` (string, optional, default: created_at:desc) — Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc - `updated_at_gte` (string, optional, nullable) — Filter to records updated at or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z) - `updated_at_lte` (string, optional, nullable) — Filter to records updated at or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z) - `last_seen_gte` (string, optional, nullable) — Filter to records whose last_seen date is on or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z) - `last_seen_lte` (string, optional, nullable) — Filter to records whose last_seen date is on or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z) - `offset` (integer, optional, nullable, default: 0) — Can be used for paginating results - `limit` (integer, optional, nullable, default: 100) — A number between 1 and 250 to determine the number of results to return in a single query ## Response ### 200 Successful response - `meta` (ResponseMeta, required) - `results` (V1ResidentPaymentsResidentPaymentIdGetOutputResults, required) ## Errors ### 400 Bad Request Error Bad Request - `error` (ErrorResponseError, required) ## Types ### ResponseMeta - `orderBy` (list of ResponseMetaOrderByItems, required) — The order of the results - `offset` (integer, optional) — The offset of the first result - `limit` (integer, optional) — The number of results to return - `hasMore` (boolean, optional, nullable) — Whether there are more results - `total` (integer, optional) — The total number of results ### V1ResidentPaymentsResidentPaymentIdGetOutputResults - `id` (string, required) — The Propexo unique identifier for the resident payment - `created_at` (string, required) — The date record first entered Propexo - `updated_at` (string, required) — The date record was last updated in Propexo - `last_seen` (string, required, nullable) — The date the record was last seen from the PMS - `x_id` (string, required) — The external ID from the integration vendor | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `x_property_id` (string, required) — The external ID of the property from the integration vendor | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `x_gl_account_id` (string, required, nullable) — The external ID of the general ledger account from the integration vendor | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `x_location_id` (any, required) — The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations.This field will always be null for REALPAGE\_RPX - `x_lease_id` (string, required, nullable) — The external ID of the lease from the integration vendor | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `x_resident_id` (string, required, nullable) — The external ID of the resident from the integration vendor | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `x_unit_id` (string, required, nullable) — The external ID of the unit from the integration vendor | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `x_charge_code_id` (string, required, nullable) — The external ID of the charge code from the integration vendor | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `payment_method_normalized` (any, required) — The normalized method of payment for the resident paymentThis field will always be null for REALPAGE\_RPX - `payment_method_raw` (any, required) — The raw method of payment for the resident paymentThis field will always be null for REALPAGE\_RPX - `amount_in_cents` (double, required, nullable) — The amount of the resident payment, in cents | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `amount_raw` (string, required, nullable) — The raw value for amount from the PMS | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `name` (string, required, nullable) — The name associated with the resident payment | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `description` (string, required, nullable) — Description of the resident payment | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `reference_number` (string, required, nullable) — The reference number for the resident payment | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `transaction_date` (string, required, nullable) — The transaction date of the resident payment | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `is_open` (boolean, required, nullable) — Whether the resident payment is open and not yet settled | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `post_month` (string, required, nullable) — The post month for the resident payment | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `custom_data` (V1ResidentPaymentsResidentPaymentIdGetOutputResultsCustomData, required, nullable) - `integration_id` (string, required) — The Propexo unique identifier for the integration - `integration_vendor` (enum, required) — The property management system of record - Allowed values: `REALPAGE_RPX`, `APPFOLIO`, `BUILDIUM`, `ENTRATA`, `MRI`, `PROPERTYWARE`, `PROPERTYWARE_REST`, `REALPAGE`, `RENTMANAGER`, `RENTVINE`, `RESMAN`, `YARDI`, `YARDI_REST` - `property_id` (string, required) — The Propexo unique identifier for the property - `resident_id` (string, required, nullable) — The Propexo unique identifier for the resident | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `financial_account_id` (string, required, nullable) — The Propexo unique identifier for the financial account | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `unit_id` (any, required) — The Propexo unique identifier for the unitThis field will always be null for REALPAGE\_RPX - `lease_id` (string, required, nullable) — The Propexo unique identifier for the lease | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `charge_code_id` (string, required, nullable) — The Propexo unique identifier for the charge code | Method | Interface | |---|---| | GetResidentLedger | Transactions | - `allocations` (list of V1ResidentPaymentsResidentPaymentIdGetOutputResultsAllocationsItems, required) — Array of payment allocations, splits, and related transactions associated with the resident payment ### ErrorResponseError - `code` (string, required) - `message` (string, required) - `details` (map from string to any, optional) ### ResponseMetaOrderByItems ### V1ResidentPaymentsResidentPaymentIdGetOutputResultsCustomData ### V1ResidentPaymentsResidentPaymentIdGetOutputResultsAllocationsItems - `id` (string, required) — The Propexo unique identifier for the resident allocation - `x_id` (string, required) — The external ID from the integration vendor - `x_source_id` (string, required, nullable) — The external ID of the source transaction from the integration vendorThis field is not currently hydrated for REALPAGE\_RPX - `x_destination_id` (string, required, nullable) — The external ID of the destination transaction from the integration vendorThis field is not currently hydrated for REALPAGE\_RPX - `financial_account_id` (string, required, nullable) — The Propexo unique identifier for the financial accountThis field is not currently hydrated for REALPAGE\_RPX - `amount_in_cents` (double, required, nullable) — The amount of the resident allocation, in centsThis field is not currently hydrated for REALPAGE\_RPX - `amount_raw` (string, required, nullable) — The raw value for amount from the PMSThis field is not currently hydrated for REALPAGE\_RPX - `resident_charge_id` (string, required, nullable) — The Propexo unique identifier for the resident chargeThis field is not currently hydrated for REALPAGE\_RPX - `resident_payment_id` (string, required, nullable) — The Propexo unique identifier for the resident payment - `created_at` (string, required) — The date record first entered Propexo - `updated_at` (string, required) — The date record was last updated in Propexo - `last_seen` (string, required, nullable) — The date the record was last seen from the PMS - `custom_data` (V1ResidentPaymentsResidentPaymentIdGetOutputResultsAllocationsItemsCustomData, required, nullable) ### V1ResidentPaymentsResidentPaymentIdGetOutputResultsAllocationsItemsCustomData ## Examples **Request** ```json {} ``` **Response** ```json { "meta": { "orderBy": [ { "field": "created_at", "direction": "desc" } ], "offset": 0, "limit": 100, "hasMore": true, "total": 1000 }, "results": { "id": "clwktsp9v000008l31iv218hn", "created_at": "2024-03-21T15:38:08.337Z", "updated_at": "2024-03-22T10:59:45.119Z", "last_seen": "2024-03-22T10:59:45.119Z", "x_id": "TXN-20240321-987654", "x_property_id": "PROP-1001", "x_gl_account_id": "GL-4500", "x_location_id": null, "x_lease_id": "LEASE-2024-001", "x_resident_id": "RES-7890", "x_unit_id": "UNIT-12B", "x_charge_code_id": "13121", "payment_method_normalized": null, "payment_method_raw": null, "amount_in_cents": 325000, "amount_raw": "3250.00", "name": "March Rent Payment", "description": "Payment for March 2024 rent", "reference_number": "REF-20240321-001", "transaction_date": "2024-03-21", "is_open": true, "post_month": "2024-02", "custom_data": {}, "integration_id": "clwh5u07w000508me66sfh3um", "integration_vendor": "REALPAGE_RPX", "property_id": "clwi5xiix000008l6ctdgafyh", "resident_id": "clwktsp9v000008l31iv218ha", "financial_account_id": "finacct-2024-03", "unit_id": null, "lease_id": "testintegration:123:456", "charge_code_id": "cm7jclb5o3805238169fbbucm1ar587b", "allocations": [ { "id": "clwktsp9v000008l31iv218ho", "x_id": "ALLOC-20240321-001", "x_source_id": "TXN-20240321-987654", "x_destination_id": "CHG-20240301-100", "financial_account_id": "finacct-2024-03", "amount_in_cents": 325000, "amount_raw": "3250.00", "resident_charge_id": "chg-2024-03-01", "resident_payment_id": "clwktsp9v000008l31iv218hn", "created_at": "2024-03-21T15:38:08.337Z", "updated_at": "2024-03-22T10:59:45.119Z", "last_seen": "2024-03-22T10:59:45.119Z", "custom_data": {} } ] } } ``` **SDK Code** ```python import requests url = "https://api.propexo.com/v1/resident-payments/resident_payment_id" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.propexo.com/v1/resident-payments/resident_payment_id'; const options = { method: 'GET', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.propexo.com/v1/resident-payments/resident_payment_id" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.propexo.com/v1/resident-payments/resident_payment_id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.propexo.com/v1/resident-payments/resident_payment_id") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.propexo.com/v1/resident-payments/resident_payment_id', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.propexo.com/v1/resident-payments/resident_payment_id"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.propexo.com/v1/resident-payments/resident_payment_id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```