Create Resident Charge: Yardi

POST

/v1/resident-charges/yardi/

POST

/v1/resident-charges/yardi/

$ curl -X POST https://api.propexo.com/v1/resident-charges/yardi/ \
>      -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-0987654321fedcba",
>   "financial_account_id": "finacc-1122334455667788",
>   "charge_code_id": "charge-556677889900aabb",
>   "transaction_date": "2024-01-15T09:30:00Z",
>   "amount_in_cents": 125000
> }'

1 {
2   "meta": {
3     "job_id": "job-20240115-093000-xyz123"
4   },
5   "result": {
6     "integration_id": "intg-9f8b7c6d5e4a3b2c1d0e",
7     "property_id": "prop-1234567890abcdef",
8     "resident_id": "res-abcdef1234567890",
9     "unit_id": "unit-0987654321fedcba",
10     "financial_account_id": "finacc-1122334455667788",
11     "charge_code_id": "charge-556677889900aabb",
12     "transaction_date": "2024-01-15T09:30:00Z",
13     "post_month": "2024-01-01",
14     "amount_in_cents": 125000,
15     "description": "Monthly rent charge for January 2024"
16   }
17 }

Create Resident Charge: Yardi

Interface	Method
Billing and Payments	ImportCharge_Login

Notice

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

Create Resident Charge: Yardi | Interface | Method | |---|---| | Billing and Payments | ImportCharge_Login | <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>

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

charge_code_idstringRequired

The Propexo ID for the charge code associated with this new charge

transaction_datestringRequiredformat: "date-time"

The transaction date of the resident charge

amount_in_centsintegerRequired

The amount of the resident charge, in cents

post_monthstringOptional

The post month for the resident charge. We will strip all data out of the datetime except the year and month.

descriptionstringOptional

Description of the resident charge

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error