Accounting Interface
The personal-area pages provide information for a single client or supplier account only, after a secure login process.The API starts with functions for an authenticated client or supplier, but also includes an additional general accounting layer that does not require authentication for each account separately.
To save you from searching, below is a list of function links by access type:
For a Single Authenticated Account
Through the API, the following functions require an account number in the'Account'
field (or 'ClientNumber'
;
both are equivalent, including for suppliers) and the account access password in the
'API_Password'
field.
All functions listed here also appear in the personal area (HTML), so there is no need to add parallel links to them.
- Get_Client_Balance_json Real-time balance management. After the first request, the engine remains in memory for the lifetime of the session and responds within 0.1-0.2 seconds.
- Get_Client_Ledger_Report_Json Ledger report. Each request accesses the database, so the response time depends on the amount of data on the database.
- Create_Receipt_Json Creates a receipt document (deposit).
- Create_Refund_Json Creates a refund document (withdrawal).
General Accounting - Less Protected
These endpoints are intended for trusted internal integrations only!You need to enable 'Unprotected Accounting API' inside
[Domain Enabled Modules]
field.
-
Get_Account_Ledger_Report_Json
Ledger report by a single account number per request.
It can be used for any account (General Account, Client, Supplier, Project). Access to salary accounts (hired workers) is blocked. - Get_TrialBalance_Report_Json Trial Balance report. You can request individual accounts or accounts by category. Access to salary accounts (hired workers) is blocked.
- Query_Refunds_API_Queue_json Lists withdrawal forms waiting to be processed by an external payment interface (for example, a bank transfer).
- Update_Refunds_API_Queue_json Updates a withdrawal form with its processing status ("In Process" / Success / Failure).
- Create_Journal_Entry_json Adds a new journal entry to Hyper. This endpoint is allowed to post to all accounts, including salary accounts.