For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
How It WorksKnowledge BaseOnboardingVideo TutorialsPMS GuidanceAPI ReferenceRelease Notes
    • Overview
    • PMS Generic APIs
    • CRM Generic APIs
    • PMS APIs
        • GETGet all charge codes
        • GETGet a charge code by ID
        • GETGet all financial accounts
        • GETGet a financial account by ID
        • GETGet all resident charges
        • GETGet a resident charge by ID
        • GETGet all recurring resident charges
        • GETGet recurring resident charge by ID
        • GETGet all resident payments
        • GETGet a resident payment by ID
        • POSTCreate Resident Charge: Yardi REST
        • POSTCreate Resident Payment: Yardi REST
    • CRM APIs
    • Download OpenAPI Spec
Dashboard
LogoLogo
Yardi RESTBilling and Payments

Create Resident Payment: Yardi REST

Beta
POST
/v1/resident-payments/yardi_rest/
POST
/v1/resident-payments/yardi_rest/
$curl -X POST https://api.propexo.com/v1/resident-payments/yardi_rest/ \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "integration_id": "intg-9f8b7c6d5e4a3b2c1d0e",
>  "property_id": "prop-1234567890abcdef",
>  "resident_id": "res-abcdef1234567890",
>  "unit_id": "unit-001A",
>  "financial_account_id": "finacct-0987654321fedcba",
>  "transaction_date": "2024-01-15T09:30:00Z",
>  "amount_in_cents": 125000,
>  "reference_number": "RCPT-20240115-0001"
>}'
1{
2  "meta": {
3    "job_id": "job-20240115-9a8b7c6d5e4f3a2b1c0d"
4  },
5  "result": {
6    "integration_id": "intg-9f8b7c6d5e4a3b2c1d0e",
7    "property_id": "prop-1234567890abcdef",
8    "resident_id": "res-abcdef1234567890",
9    "unit_id": "unit-001A",
10    "financial_account_id": "finacct-0987654321fedcba",
11    "transaction_date": "2024-01-15T09:30:00Z",
12    "amount_in_cents": 125000,
13    "reference_number": "RCPT-20240115-0001",
14    "description": "January rent payment for unit 001A"
15  }
16}
Create Resident Payment: Yardi REST | Interface | Method | |---|---| | Resident Transactions | /ItfResidentTransactions/ImportReceipts | <Note title="Notice">Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync.</Note>
Was this page helpful?
Previous

Get all construction jobs

Next
Built with

Create Resident Payment: Yardi REST

InterfaceMethod
Resident Transactions/ItfResidentTransactions/ImportReceipts
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