Create Resident Credit: Propertyware REST

Method	Interface
POST /v1/leases/adjustments	Leases

Notice

This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately.

Create Resident Credit: Propertyware REST | Method | Interface | |---|---| | POST /v1/leases/adjustments | Leases | <Note title="Notice">This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately.</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

lease_idstringRequired

The Propexo unique identifier for the lease

amount_in_centsintegerRequired>=0

The amount of the resident charge, in cents. This value is required to be positive, but is given to Propertyware as a negative

transaction_datestringRequired

The transaction date of the resident charge

descriptionstringOptional

Description of the resident charge

reference_numberstringOptional

The reference number for the resident charge

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error

$	curl -X POST https://api.propexo.com/v1/resident-credits/propertyware_rest/ \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"integration_id": "intg_9f8b7c6d5e4a3b2c1d0e",
>	"lease_id": "lease_1234567890abcdef",
>	"amount_in_cents": 15000,
>	"transaction_date": "2024-04-10T14:00:00Z"
>	}'

1	{
2	"meta": {
3	"job_id": "job_abcdef1234567890"
4	},
5	"result": {
6	"integration_id": "intg_9f8b7c6d5e4a3b2c1d0e",
7	"lease_id": "lease_1234567890abcdef",
8	"amount_in_cents": 15000,
9	"transaction_date": "2024-04-10T14:00:00Z",
10	"description": "Resident credit for early lease termination",
11	"reference_number": "RC-20240410-001"
12	}
13	}