Create Resident Payment: Yardi

POST

/v1/resident-payments/yardi/

POST

/v1/resident-payments/yardi/

curl -X POST https://api.propexo.com/v1/resident-payments/yardi/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "intg-7890abcd1234",
  "property_id": "prop-4567efgh8901",
  "resident_id": "res-2345ijkl6789",
  "unit_id": "unit-3456mnop1234",
  "financial_account_id": "finacc-5678qrst9012",
  "transaction_date": "2024-01-15T09:30:00Z",
  "amount_in_cents": 125000,
  "reference_number": "RCPT-20240115-9876"
}'

{
  "meta": {
    "job_id": "job-20240115-abc123xyz"
  },
  "result": {
    "integration_id": "intg-7890abcd1234",
    "property_id": "prop-4567efgh8901",
    "resident_id": "res-2345ijkl6789",
    "unit_id": "unit-3456mnop1234",
    "financial_account_id": "finacc-5678qrst9012",
    "transaction_date": "2024-01-15T09:30:00Z",
    "amount_in_cents": 125000,
    "reference_number": "RCPT-20240115-9876",
    "description": "January rent payment for unit 3456"
  }
}

Create Resident Payment: Yardi

Interface	Method
Billing and Payments	ImportReceipt_Login

Notice

Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

integration_idstringRequired

The Propexo unique identifier for the integration

property_idstringRequired

The Propexo unique identifier for the property

resident_idstringRequired

The Propexo unique identifier for the resident

unit_idstringRequired

The Propexo unique identifier for the unit

financial_account_idstringRequired

The Propexo unique identifier for the financial account

transaction_datestringRequiredformat: "date-time"

The transaction date of the resident payment

amount_in_centsintegerRequired

The amount of the resident payment, in cents

reference_numberstringRequired

The reference number for the resident payment

descriptionstringOptional

Description of the resident payment

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error