Login
Search...
/
Documentation
API Reference
Use Cases
Introduction
Overview
API Reference
Admin
Amenities
Applicants
Applications
Appointments
Billing and Payments
GET
Get all charge codes
GET
Get a charge code by ID
GET
Get all financial accounts
GET
Get a financial account by ID
GET
Get all resident charges
POST
Create resident charge
GET
Get a resident charge by ID
GET
Get all recurring resident charges
POST
Create a recurring resident charge
GET
Get recurring resident charge by ID
PUT
Update a recurring resident charge
GET
Get all resident payments
POST
Create resident payment
GET
Get a resident payment by ID
Construction Job Cost
Employees
Events
Files
Invoices
Leads
Leases
Listings
Owners
Properties
Purchase Orders
Residents
Service Requests
Timezones
Units
Vendors
Webhooks Configuration
Login
API Reference
Billing and Payments
Create resident payment
POST
https://
api.propexo.com
/
v1
/
resident-payments
/
Create a resident payment for an integration.
Request
This endpoint expects an object.
integration_id
string
Required
lease_id
string
Optional
The Propexo unique identifier for the lease
financial_account_id
string
Optional
The Propexo unique identifier for the financial account
resident_id
string
Optional
The Propexo unique identifier for the resident
transaction_date
datetime
Optional
The transaction date of the resident payment
amount_in_cents
integer
Optional
The amount of the resident payment, in cents
payment_method_raw
enum
Optional
The raw method of payment for the resident payment
Show 7 enum values
send_email_receipt
boolean
Optional
Indicates whether the payee would like to have a receipt emailed
description
string
Optional
Description of the resident payment
reference_number
string
Optional
The reference number for the resident payment
payment_type
enum
Optional
The method of payment
Show 8 enum values
charge_code_id
string
Optional
The Propexo unique identifier for the charge code
notes
string
Optional
Notes associated with the resident payment
batch_id
string
Optional
An identifier for the transaction batch. This should be unique to your system.
property_id
string
Optional
The Propexo unique identifier for the property
unit_id
string
Optional
The Propexo unique identifier for the unit
Response
This endpoint returns an object.
job_id
string
The ID of the job created to handle this operation
data
object
Errors
400
Bad Request
Built with