Base Accounting API¶

Accounts List¶

To view all accounts, use the GET /api/accounting/accounts/ REST API. It also supports pagination.

Journal Entry List¶

To view all accounting entries, use the GET /api/accounting/entries/ REST API. It also supports pagination.

Filtering¶

The list endpoint supports exact-match and some operational filtering via query parameters:

Multiple filters can be combined: ?status=1&date=2026-01-15.

Create Journal Entry¶

Creating accounting entries is one of the most common accounting operations. To create a new entry, use POST /api/accounting/entries/. The main parameters are listed below.

You may also want to specify the following optional parameters in more specific use cases:

Entry Lines¶

Each entry has multiple lines. Each line is a single credit or debit action. Final entries must have at least two entry lines, and the total value of their debit and credits must be equal (balanced). Parameters for each line are described in this table:

Note that exactly one of the credit and debit parameters must be set for each line. Zero values are allowed and treated as if the value is not passed.

You may also want to specify the following optional parameters for each entry line:

Sample Requests¶

Buying a office:

{
    "date": "2026-01-08",
    "description": "پرداخت بابت خرید دفتر ۱",
    "lines": [
        {"account": "2104", "debit": "20000000000", "description": "زمین"},
        {"account": "2103", "debit": "80000000000", "description": "ساختمان"},
        {"account": "1101", "credit": "100000000000", "description": "موجودی نقد - بانک"}
    ]
}

Early salary payment to an employee:

{
    "date": "2026-01-08",
    "description": "پرداخت مساعده به کارمند ۱۰۱",
    "lines": [
        {"account": "1402", "tafsil": "101", "debit": "50000000", "description": "کارمند ۱۰۱"},
        {"account": "1101", "credit": "50000000", "description": "موجودی نقد - بانک"}
    ]
}

Success Response¶

A 201 response with the serialized data of the created entry will be returned if the operation is successful.

You can store the returned number or reference_number of the created entry if you want to lookup or reference it later.

Error Responses¶

Bulk Create Journal Entries¶

To create multiple entries in a single request, use POST /api/accounting/entries/bulk/. The request body must be a JSON list where each item has the same fields as Create Journal Entry.

Success Response¶

A 201 response with a list of serialized entries in the same order as the request. Each item may include post_errors or validation_errors just like the single-entry endpoint.

Error Responses¶

If any entry fails validation, a 400 response is returned immediately and none of the entries are saved. The error message is only provided for the first entry with error.

Delete Journal Entry¶

To delete an accounting entry, use the DELETE /api/accounting/entries/PK/ REST API. On successful deletion, an HTTP 204 response is returned and the entry and all of its related lines and transfers are deleted. If the entry is finalized and cannot be deleted, an HTTP 400 response is returned.

Multiple Journal Support¶

Larger organizations with a large number of entries or with multiple accounting teams may want to group their entries in multiple journals. For creating multiple journals, first ensure that your installation supports this feature, and then use the admin interface or the journals API to manage journals.

When multiple journals are enabled and configured, you can pass the journal parameter to Create Journal Entry endpoint to select the journal to add the entry: