Create an accounting transaction

Creates a manual double-entry accounting transaction.

Use this endpoint for explicit accounting adjustments, such as transferring an
amount from a landlord or agency account to a tenant account after the tenant paid
an invoice directly. Account and leasing-contract references must be public IDs
returned by the corresponding Rivage API endpoints.

Send these fields at the root of the JSON body. A body wrapped in an
accounting_transaction object is accepted as well.

Requirements:

  • At least two accounting entries
  • Total debits must equal total credits
  • Every line must contain exactly one positive debit or credit amount, as an integer number of cents
  • All referenced accounts and leasing contracts must belong to the authenticated customer
  • leasing_contract_id, when provided, must belong to the scope of the line's accounting account
  • operation_date is optional and defaults to effective_date

The transaction is created in the manual_entry journal. Rivage also creates the
corresponding accounting event and runs the same balance refresh and downstream
processing as a manual journal entry created in the application.

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

Date when the transaction takes effect in the books

date

Date when the underlying operation occurred; defaults to effective_date

string

Human-readable transaction description

accounting_entries
array of objects
required
length ≥ 2
accounting_entries*
string
required

Public ID of the accounting account

string | null

Optional public ID of the leasing contract attributed to this line

integer
required
≥ 0
integer
required
≥ 0
string | null

Optional line-specific description

string
required

Public ID of the accounting account

string | null

Optional public ID of the leasing contract attributed to this line

integer
required
≥ 0
integer
required
≥ 0
string | null

Optional line-specific description

Responses

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