Get all resident payments | Propexo

curl https://api.propexo.com/v1/resident-payments/ \
     -H "Authorization: Bearer <token>"

{
  "meta": {
    "orderBy": [
      {}
    ],
    "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": "78676782",
      "x_property_id": "eidsnge",
      "x_gl_account_id": "8879388635",
      "x_resident_id": "t900345",
      "x_unit_id": "312441",
      "amount_in_cents": -70000,
      "amount_raw": "700.00",
      "description": "Debit card payment",
      "reference_number": "Batch payment ID #993882",
      "transaction_date": "2021-03-25T00:00:00.000Z",
      "custom_data": {},
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "YARDI_REST",
      "property_id": "clwi5xiix000008l6ctdgafyh",
      "resident_id": "clwqs19bb000008l1bbcv2bs4",
      "financial_account_id": "clwqscdbx000108js2rc35l3f",
      "allocations": [
        {
          "id": "clwktsp9v000008l31iv218hn",
          "x_id": "string",
          "x_source_id": "string",
          "x_destination_id": "string",
          "financial_account_id": "string",
          "amount_in_cents": 325000,
          "amount_raw": "string",
          "resident_charge_id": "string",
          "resident_payment_id": "string",
          "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": {}
        }
      ]
    }
  ]
}

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.

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

order-bystringOptionalDefaults to 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

offsetinteger or nullOptional>=0Defaults to 0

Can be used for paginating results

limitinteger or nullOptional0-250Defaults to 100

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

property_idstringOptional

The Propexo unique identifier for the property

integration_idstringOptional

The Propexo unique identifier for the integration

integration_vendorenumOptional

The property management system of record

resident_idstringOptional

The Propexo unique identifier for the resident

lease_idstringOptional

The Propexo unique identifier for the lease

transaction_date_startstring or nullOptional

The start of the transaction date range to search. Inclusive.

transaction_date_endstring or nullOptional

The end of the transaction date range to search. Inclusive.

Response

Successful response

metaobject

resultslist of objects

Errors

400

Bad Request Error