Journal types that are built into AlayaCare Resi and available in every organization.
Use the journalTypeID or journalTypeName values below with the
journalTypes and journalTypeNames filters of the
Journals API.
| Journal Type ID | Journal Type Name | Transaction Types |
|---|---|---|
| 1 | New Deposit | — |
| 2 | Deposit Refund | — |
| 3 | Transaction Reversal | — |
| 4 | Over Payment Settlement | — |
| 5 | Reviewed Invoice | — |
| 6 | Deposit Settlement | — |
| 7 | Separation Interest | EX:11 |
| 8 | Accommodation Drawdown | AR:1, DP:4, RV:7 |
| 9 | Fee Drawdown | AR:1, DP:4, RV:7 |
| 10 | Finance Adjustments | DP:12, PM:13, EX:14, AR:16, RV:17, TX:18 |
| 11 | Reviewed Invoice - Fee Statement | — |
| 12 | Direct Debit Payments | PM:5 |
| 13 | Subsidy Reconciliation | — |
| 14 | Automatic Settlement | AR:1, DP:4, AR:15 |
| 15 | Credit Settlement | AR:1, CR:21 |
| 16 | Manual Deposit Interest | DP:4, EX:19 |
| 17 | Deposit Transfer | DP:4, TR:22 |
| 18 | Accommodation Deposit Retentions | DP:4, RV:7 |
Transaction Types lists the transaction types mapped to the journal type, in the format
<transaction_code>:<transaction_type_id>. The transactionTypeID is the value returned in
transactionTypeIDs by the API. See Transaction Types for the full list.
The mapping is configurable and can differ between organizations; a dash means no transaction types are mapped. Organizations can also define their own journal types, which are not listed here.
GET …/api/Billings/JournalTypes
returns all journal types for the organization, including any user-defined types.
Each journal type returned by the API has an accessType value of type
RecordAccessType
that shows whether it is built into the product or created by a user.
| Name | Value | Meaning |
|---|---|---|
System | 2 | Built into AlayaCare Resi. These are the journal types listed on this page. |
User | 3 | Created by a user in the organization. |
Use the AccessTypes query parameter of
GET …/api/Billings/JournalTypes
to choose which journal types are returned:
| Purpose | Typical Request |
|---|---|
| System journal types | GET …/api/Billings/JournalTypes?AccessTypes=2 |
| User journal types | GET …/api/Billings/JournalTypes?AccessTypes=3 |
| System and user journal types | GET …/api/Billings/JournalTypes?AccessTypes=2&AccessTypes=3 |