Get a resident payment by ID

GET
/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.

Path parameters

resident_payment_idstringRequired

The ID of the resource.

Query parameters

order-bystringOptional

Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc

offsetintegerOptional

Can be used for paginating results

limitintegerOptional

A number between 1 and 250 to determine the number of results to return in a single query

Response

Successful response

metaobject
resultsobject

Errors

Built with