Skip to main content

Overview

Journal entry tools provide full CRUD operations plus multi-level approval workflow for general ledger entries.

CRUD Tools

finance_journal_entry_create

Create a new journal entry. Parameters:
ParameterTypeRequiredDescription
entry_idstringYesUnique entry ID
tran_datestringYesTransaction date (YYYY-MM-DD)
posting_period_idstringYesAccounting period
memostringNoEntry description
linesarrayYesJournal entry lines
Lines array format:
{
  "lines": [
    {
      "account_id": "1000",
      "debit": 1000.00,
      "credit": 0,
      "memo": "Line memo"
    },
    {
      "account_id": "2000",
      "debit": 0,
      "credit": 1000.00
    }
  ]
}

finance_journal_entry_get

Retrieve a journal entry by ID. Parameters:
ParameterTypeRequiredDescription
entry_idstringYesJournal entry ID

finance_journal_entry_list

List journal entries with filters. Parameters:
ParameterTypeRequiredDescription
statusstringNoFilter by status
posting_period_idstringNoFilter by period
start_datestringNoFilter by date range
end_datestringNoFilter by date range
limitnumberNoResults per page
offsetnumberNoPagination offset

finance_journal_entry_update

Update a draft journal entry. Parameters:
ParameterTypeRequiredDescription
entry_idstringYesJournal entry ID
memostringNoUpdated memo
linesarrayNoUpdated lines

finance_journal_entry_delete

Delete a draft journal entry. Parameters:
ParameterTypeRequiredDescription
entry_idstringYesJournal entry ID

Workflow Tools

finance_journal_entry_submit

Submit a journal entry for approval. Parameters:
ParameterTypeRequiredDescription
entry_idstringYesJournal entry ID
idempotency_keystringNoPrevent duplicates

finance_journal_entry_approve_l1

Level 1 approval. Parameters:
ParameterTypeRequiredDescription
entry_idstringYesJournal entry ID
commentsstringNoApproval comments
idempotency_keystringNoPrevent duplicates

finance_journal_entry_approve_l2

Level 2 approval. Parameters:
ParameterTypeRequiredDescription
entry_idstringYesJournal entry ID
commentsstringNoApproval comments
idempotency_keystringNoPrevent duplicates

finance_journal_entry_reject

Reject a journal entry. Parameters:
ParameterTypeRequiredDescription
entry_idstringYesJournal entry ID
reasonstringYesRejection reason

finance_journal_entry_request_change

Request changes to a journal entry. Parameters:
ParameterTypeRequiredDescription
entry_idstringYesJournal entry ID
commentsstringYesRequested changes

finance_journal_entry_hold

Place a journal entry on hold. Parameters:
ParameterTypeRequiredDescription
entry_idstringYesJournal entry ID
reasonstringNoHold reason

finance_journal_entry_unhold

Remove a journal entry from hold. Parameters:
ParameterTypeRequiredDescription
entry_idstringYesJournal entry ID

finance_journal_entry_post

Post a journal entry to the general ledger. Parameters:
ParameterTypeRequiredDescription
entry_idstringYesJournal entry ID
idempotency_keystringNoPrevent duplicates

finance_journal_entry_reverse

Create a reversing entry. Parameters:
ParameterTypeRequiredDescription
entry_idstringYesOriginal entry ID
reversal_datestringYesDate for reversal
memostringNoReversal memo

finance_journal_entry_void

Void a journal entry. Parameters:
ParameterTypeRequiredDescription
entry_idstringYesJournal entry ID
reasonstringYesVoid reason