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 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: Rentvine
        • POSTCreate Resident Credit: Rentvine
        • POSTCreate Recurring Resident Charge: Rentvine
        • POSTCreate Resident Payment: Rentvine
    • CRM APIs
    • Download OpenAPI Spec
Dashboard
LogoLogo
RentvineBilling and Payments

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"
>}'
1{
2  "meta": {
3    "job_id": "job_abcdef1234567890"
4  },
5  "result": {
6    "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e",
7    "lease_id": "lease_1234567890abcdef",
8    "financial_account_id": "finacct_0987654321fedcba",
9    "amount_in_cents": 15000,
10    "transaction_date": "2024-01-15T09:30:00Z",
11    "description": "January rent credit adjustment"
12  }
13}
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 | <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>
Was this page helpful?
Previous

Create Recurring Resident Charge: Rentvine

Next
Built with

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

MethodInterface
POST /api/manager/accounting/leases/{leaseID}/creditsAccounting
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