Create Resident Payment: Rentvine

Rentvine only allows primary residents to have payments assigned to them. This can be seen in the residents_meta_data or leases_meta_data API fields on their resident_type_normalized field. This field must be set to PRIMARY. | Method | Interface | |---|---| | POST /api/manager/accounting/leases/{leaseID}/payments | Accounting |

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
financial_account_idstringRequired
The Propexo unique identifier for the financial account. This must be a bank account
resident_idstringRequired
The Propexo unique identifier for the resident. The resident must be a primary.
amount_in_centsintegerRequired
The amount of the resident payment, in cents
payment_typeenumRequired
The type of payment used for the resident payment
transaction_datestringRequired
The transaction date of the resident payment
send_email_receiptbooleanRequired
Indicates whether the payee would like to have a receipt emailed
descriptionstringOptional
Description of the resident payment
reference_numberstringOptional
The reference number for the resident payment

Response

Successful response
metaobject
resultobject

Errors