Create deduction from deposit

Creates an accounting deduction against the tenant's deposit for the given leasing contract.
This endpoint triggers the dedicated service that builds the accounting transaction and links it
to the refund deposit accounting event group.

Request body format:
Send description and amount_in_cents at the root of the JSON body, as shown below.
A body wrapped in an accounting_transaction object is accepted as well.

Optional document attachment:
You can attach a supporting document to the deduction by providing a document_url parameter
with a publicly accessible URL to the file. The document will be automatically downloaded and
stored as a supporting document for the deduction.

Optional invoice cross-reference:
Send invoice_id (the invoice's public id) to link the deduction line to an invoice for
cross-reference. This has no financial impact.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Leasing contract unique identifier

Query Params
string

URL to a supporting document to attach to the deduction (e.g., invoice, receipt)

Body Params
string
required
integer
required
string

Public id of the invoice to cross-reference (optional)

Responses

404

leasing contract not found

Language
Credentials
Bearer
pk_...:sk_...
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json