Create Resident Credit: Rentvine

POST

/v1/resident-credits/rentvine/

POST

/v1/resident-credits/rentvine/

curl -X POST https://api.propexo.com/v1/resident-credits/rentvine/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e",
  "lease_id": "lease_1234567890abcdef",
  "financial_account_id": "finacct_0987654321fedcba",
  "amount_in_cents": 15000,
  "transaction_date": "2024-01-15T09:30:00Z",
  "description": "January rent credit adjustment"
}'

{
  "meta": {
    "job_id": "job_abcdef1234567890"
  },
  "result": {
    "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e",
    "lease_id": "lease_1234567890abcdef",
    "financial_account_id": "finacct_0987654321fedcba",
    "amount_in_cents": 15000,
    "transaction_date": "2024-01-15T09:30:00Z",
    "description": "January rent credit adjustment"
  }
}

Note that credits are stored as negative charges when they’re read in through Propexo.

Method	Interface
POST /api/manager/accounting/leases/{leaseID}/credits	Accounting

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.

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

amount_in_centsintegerRequired

The amount of the resident credit, in cents

transaction_datestringRequired

The transaction date of the resident credit

descriptionstringRequired

Description of the resident credit

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error