Accounting API

POST /accounting/accounts

Create Chart of Accounts Account

Create a chart of accounts account from the supplied request data.

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/accounts \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /accounting/accounts/import/batch

Import Chart of Accounts

Add accounts from a chart of accounts file. Existing codes are kept exactly as they are and listed as skipped, so running the same file again adds nothing. The whole chart is sent in one request so parents resolve across the file.

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/accounts/import/batch \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /accounting/accounts/import/preview

Preview Chart of Accounts Import

Show what importing these chart of accounts rows would do now. Nothing is written. Each row is checked on its own, so one malformed row is reported instead of refusing the whole file. The import only adds accounts and never updates existing ones.

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/accounts/import/preview \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

PATCH /accounting/accounts/{code}

Update Chart of Accounts Account

Update chart of accounts account with the supplied fields.

Parameters

Request body

Responses

Example

curl -X PATCH http://localhost:8000/accounting/accounts/:code \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /accounting/balance-sheet

Get Balance Sheet

Return the company's balance sheet as of the requested date using posted accounting entries.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/balance-sheet \
  -H "Authorization: Bearer $TOKEN"

GET /accounting/bank-accounts

List Bank and Card Accounts

Return bank and card accounts matching the documented filters and pagination options.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/bank-accounts \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/bank-accounts

Create Bank or Card Account

Create a bank or card account from the supplied request data.

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/bank-accounts \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /accounting/bank-accounts/{bank_id}

Get Bank or Card Account

Return bank or card account.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/bank-accounts/:bank_id \
  -H "Authorization: Bearer $TOKEN"

PATCH /accounting/bank-accounts/{bank_id}

Update Bank or Card Account

Update bank or card account with the supplied fields.

Parameters

Request body

Responses

Example

curl -X PATCH http://localhost:8000/accounting/bank-accounts/:bank_id \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /accounting/bank-accounts/{bank_id}/reconciliations

List Bank Reconciliations

Every reconciliation of one bank account, newest statement date first.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/bank-accounts/:bank_id/reconciliations \
  -H "Authorization: Bearer $TOKEN"

GET /accounting/cash-flow

Get Cash Flow Statement

Return the company's cash flow statement for the requested period, including direct and indirect cash-flow views derived from posted accounting entries.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/cash-flow \
  -H "Authorization: Bearer $TOKEN"

GET /accounting/chart

Get Chart of Accounts

Return the full chart of accounts ordered by account code.

Responses

Example

curl -X GET http://localhost:8000/accounting/chart \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/chart/seed

Seed Default Chart of Accounts

Add any missing accounts from Celerp's default chart of accounts without replacing existing accounts.

Responses

Example

curl -X POST http://localhost:8000/accounting/chart/seed \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/close-year

Close Fiscal Year

Close the selected fiscal year by clearing revenue and expense balances and transferring net income to retained earnings.

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/close-year \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /accounting/extended-journal

Get Item-Expanded Journal

Return the general journal with item-level detail added where journal postings can be reliably tied to document lines.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/extended-journal \
  -H "Authorization: Bearer $TOKEN"

GET /accounting/general-ledger

Get General Ledger

Return opening balance, period debits and credits, and closing balance for each account. Optionally narrow the report to a single contact and include ledger lines.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/general-ledger \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/import/batch

Batch Import Accounting Records

Import multiple accounting records in one request.

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/import/batch \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /accounting/journal

Get General Journal

Return posted and voided journal entries with their lines, source-document references, and foreign-currency information. Date and search filters narrow the returned journal and its totals.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/journal \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/journal-entries

Create Manual Journal Entry

Create and post a balanced manual journal entry after validating the referenced accounts and accounting period.

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/journal-entries \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /accounting/journal-entries/bulk-void

Bulk Void Manual Journal Entries

Void multiple eligible manual journal entries.

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/journal-entries/bulk-void \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /accounting/journal-entries/from-accountant

Journals From Accountant

The journal entries the accountant posted in these books, newest first.

Responses

Example

curl -X GET http://localhost:8000/accounting/journal-entries/from-accountant \
  -H "Authorization: Bearer $TOKEN"

GET /accounting/journal-entries/{entity_id}/prefill

Prefill Journal

A new journal entry's fields copied from this one, dated on the first open day.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/journal-entries/:entity_id/prefill \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/journal-entries/{entity_id}/reverse

Reverse From Accountant

Reverse a journal entry the accountant posted, or undo that reversal.

Parameters

Responses

Example

curl -X POST http://localhost:8000/accounting/journal-entries/:entity_id/reverse \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/journal-entries/{entity_id}/void

Void Manual Journal Entry

Void an eligible manual journal entry while retaining it in the accounting audit trail.

Parameters

Request body

ManualJEVoidPayload, optional

Responses

Example

curl -X POST http://localhost:8000/accounting/journal-entries/:entity_id/void \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /accounting/ledger/{account_code}

Get Account Ledger

Return the account ledger with opening balance, posted lines, running balance, closing balance, and source-document references. Optionally filter the ledger to one customer or supplier.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/ledger/:account_code \
  -H "Authorization: Bearer $TOKEN"

GET /accounting/older-stock

List Older Stock

Return older stock placed automatically: a page each of its lots, placements, moves and corrections, a summary per inventory account, and the accounts the lots can be moved to. Each list pages from its own offset, with its total returned alongside.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/older-stock \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/older-stock/corrections

Correct Older Stock Placements

Correct how placements treated their difference. `recognize` books what a placement left unresolved against retained earnings. `unresolve` takes what a placement recognized back off the books and leaves it unresolved. All the placements are corrected or none. A placement with nothing to move is skipped, so a correction sent twice books once.

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/older-stock/corrections \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /accounting/older-stock/move

Move Older Stock

Move the selected older lots onto another inventory account, with their value, in one entry dated today. `key` identifies the move, so a request sent twice moves once and returns the first result. A lot already on the account is skipped. Nothing is moved when any lot cannot move, for example because an unshipped invoice holds it or the period is locked.

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/older-stock/move \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /accounting/older-stock/move-all

Move All Matching Older Stock

Move every older lot that matches the `account` and `q` filters onto another inventory account as one move, across all pages. `selection` is the fingerprint of the lots the user confirmed. The request is refused when the matching lots have changed since.

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/older-stock/move-all \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /accounting/older-stock/moves/{move_id}/undo

Undo Older Stock Move

Put the lots of one move back on the accounts they came from, with their value, in one entry dated today. A move can be undone once, and only while every lot is still where the move put it, no unshipped invoice holds it, and the period is open.

Parameters

Responses

Example

curl -X POST http://localhost:8000/accounting/older-stock/moves/:move_id/undo \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/older-stock/retry

Retry Older Stock Placement

Try again to place the older stock that is still waiting for an account, after a failure.

Responses

Example

curl -X POST http://localhost:8000/accounting/older-stock/retry \
  -H "Authorization: Bearer $TOKEN"

GET /accounting/opening-tie-out

Get Opening Balance Tie-Out

Compare the documents imported as already in the opening balances with what the ledger holds on the opening balance date. It is read only: a difference is shown, never corrected. With no opening balance date set there is nothing to compare, so `checks` is empty.

Responses

Example

curl -X GET http://localhost:8000/accounting/opening-tie-out \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/peer/added/{item_id}

Settle Peer Added

Keep an account sync added, archive it, or remove it while it is unused; each closes its notice. Remove also drops the link, so a later record adds it again.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/peer/added/:item_id \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /accounting/peer/holds

Peer Holds

Records a connected company sent that wait for one of their accounts to be fixed, and the accounts sync added here, newest first; each added account says whether it can still be removed, or why it can only be archived.

Responses

Example

curl -X GET http://localhost:8000/accounting/peer/holds \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/peer/holds/{item_id}/fix

Fix Peer Hold

Use another account for a held record's account, add it under a free code, or unarchive the account it posts to; the record posts on the next sync, and until then it shows as fixed (a sync that holds it again replaces its fix).

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/peer/holds/:item_id/fix \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /accounting/peer/journals

Peer Journal Feed

This company's own journal entries, for the client its key belongs to; a connected company's key only.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/peer/journals \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/peer/journals

Peer Journal Receive

A client's journal entries and its answers to this company's; a connected company's key only.

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/peer/journals \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /accounting/peer/lock

Peer Lock

This company's lock date, for the client its key belongs to.

Responses

Example

curl -X GET http://localhost:8000/accounting/peer/lock \
  -H "Authorization: Bearer $TOKEN"

GET /accounting/peer/review

Peer Review

Each client whose accounts wait for this company's review, with the accounts.

Responses

Example

curl -X GET http://localhost:8000/accounting/peer/review \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/peer/review

Answer Peer Review

Link or add a client's reviewed accounts; ``finish`` ends the review.

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/peer/review \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /accounting/period-lock

Get Accounting Period Lock

Return the current accounting period lock date.

Responses

Example

curl -X GET http://localhost:8000/accounting/period-lock \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/period-lock

Set Accounting Period Lock

Set the accounting period lock date used to prevent normal posting changes in closed periods.

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/period-lock \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /accounting/pnl

Get Profit and Loss Statement

Return the profit and loss statement for the requested period, including revenue, cost of goods sold, expenses, and resulting profit.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/pnl \
  -H "Authorization: Bearer $TOKEN"

GET /accounting/posting-accounts

List Posting Accounts

Return each posting role's account and whether it can take new postings, with the older stock candidates for each inventory account.

Responses

Example

curl -X GET http://localhost:8000/accounting/posting-accounts \
  -H "Authorization: Bearer $TOKEN"

PUT /accounting/posting-accounts/{role}

Set Posting Account

Point a role at another account for new postings. Balances already posted stay where they are; the earlier account stays with the role for them. Fixing Purchased inventory or Retained earnings places older stock that waited on it at once, and the notice of missing posting accounts follows what is still missing.

Parameters

Request body

Responses

Example

curl -X PUT http://localhost:8000/accounting/posting-accounts/:role \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /accounting/reconciliation/start

Start Bank Reconciliation

Start a bank or card reconciliation for the selected account, statement date, and ending statement balance.

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/reconciliation/start \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /accounting/reconciliation/{session_id}

Get Bank Reconciliation

Return the selected bank reconciliation session and its current reconciliation state.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/reconciliation/:session_id \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/reconciliation/{session_id}/auto-match

Auto-Match Bank Statement Lines

Compare unmatched statement lines with eligible book entries.

Parameters

Responses

Example

curl -X POST http://localhost:8000/accounting/reconciliation/:session_id/auto-match \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/reconciliation/{session_id}/bulk-confirm

Confirm Suggested Reconciliation Matches

Confirm all currently suggested reconciliation matches.

Parameters

Request body

BulkConfirmPayload, optional

Responses

Example

curl -X POST http://localhost:8000/accounting/reconciliation/:session_id/bulk-confirm \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /accounting/reconciliation/{session_id}/complete

Complete Bank Reconciliation

Complete the reconciliation after the remaining difference reaches zero.

Parameters

Responses

Example

curl -X POST http://localhost:8000/accounting/reconciliation/:session_id/complete \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/reconciliation/{session_id}/import-csv

Import Bank Statement CSV

Upload a bank statement CSV and add its lines to the reconciliation. Lines already imported are skipped.

Parameters

Responses

Example

curl -X POST http://localhost:8000/accounting/reconciliation/:session_id/import-csv \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/reconciliation/{session_id}/import-file

Import Bank Statement File

Import a supported CSV or XLSX bank statement file into the reconciliation using the supplied file and column mapping.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/reconciliation/:session_id/import-file \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

PATCH /accounting/reconciliation/{session_id}/lines/{line_id}

Update Bank Statement Line

Update the selected bank statement line's reconciliation status, such as marking a line that requires no book entry.

Parameters

Request body

Responses

Example

curl -X PATCH http://localhost:8000/accounting/reconciliation/:session_id/lines/:line_id \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /accounting/reconciliation/{session_id}/lines/{line_id}/attach

Attach File to Bank Statement Line

Attach a supporting file to the selected bank statement line.

Parameters

Responses

Example

curl -X POST http://localhost:8000/accounting/reconciliation/:session_id/lines/:line_id/attach \
  -H "Authorization: Bearer $TOKEN"

DELETE /accounting/reconciliation/{session_id}/lines/{line_id}/attach/{att_id}

Remove Bank Statement Line Attachment

Remove the selected attachment from the bank statement line.

Parameters

Responses

Example

curl -X DELETE http://localhost:8000/accounting/reconciliation/:session_id/lines/:line_id/attach/:att_id \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/reconciliation/{session_id}/lines/{line_id}/create

Create Journal Entry from Statement Line

Create a journal entry from a bank statement line and match the new entry to that line.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/reconciliation/:session_id/lines/:line_id/create \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /accounting/reconciliation/{session_id}/lines/{line_id}/match

Match Statement Line to Journal Entry

Match the selected bank statement line to an existing journal entry.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/reconciliation/:session_id/lines/:line_id/match \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /accounting/reconciliation/{session_id}/lines/{line_id}/split

Split Bank Statement Line

Split one bank statement line across multiple accounting entries or accounts.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/reconciliation/:session_id/lines/:line_id/split \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /accounting/reconciliation/{session_id}/lines/{line_id}/unmatch

Unmatch Bank Statement Line

Remove the current book-entry match from the selected statement line.

Parameters

Responses

Example

curl -X POST http://localhost:8000/accounting/reconciliation/:session_id/lines/:line_id/unmatch \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/reconciliation/{session_id}/match

Match Reconciliation Entries

Match the selected journal entries within the reconciliation.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/reconciliation/:session_id/match \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /accounting/reconciliation/{session_id}/reopen

Put a completed reconciliation back in progress

Reopen a completed reconciliation so its matches can be changed. Its matches stay as they are and no journal entry is written; the reopening is recorded as an event. Reopening one that is already in progress changes nothing.

Parameters

Responses

Example

curl -X POST http://localhost:8000/accounting/reconciliation/:session_id/reopen \
  -H "Authorization: Bearer $TOKEN"

GET /accounting/reconciliation/{session_id}/statement-lines

List Bank Statement Lines

Return the bank statement lines imported into the selected reconciliation session.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/reconciliation/:session_id/statement-lines \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/reconciliation/{session_id}/unmatch

Undo matching book entries that no statement line holds

The undo of ``match_reconciliation``. An entry a statement line holds is let go of by undoing that line, so the line and the session never disagree.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/reconciliation/:session_id/unmatch \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /accounting/reconciliation/{session_id}/workbench

Get Reconciliation Workbench

Return unresolved statement lines, unreconciled book entries, and the remaining reconciliation difference.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/reconciliation/:session_id/workbench \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/reconciliation/{session_id}/write-off

Write Off Reconciliation Difference

Create a small adjustment journal entry to clear an eligible remaining reconciliation difference.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/reconciliation/:session_id/write-off \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /accounting/rules

List Reconciliation Rules

Return bank reconciliation rules, optionally filtered to a specific bank or card account.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/rules \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/rules

Create Reconciliation Rule

Create a bank reconciliation rule that matches statement data and proposes the configured accounting treatment.

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/rules \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

PATCH /accounting/rules/{rule_id}

Update Reconciliation Rule

Update the selected bank reconciliation rule.

Parameters

Request body

Responses

Example

curl -X PATCH http://localhost:8000/accounting/rules/:rule_id \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

DELETE /accounting/rules/{rule_id}

Delete Reconciliation Rule

Delete the selected bank reconciliation rule.

Parameters

Responses

Example

curl -X DELETE http://localhost:8000/accounting/rules/:rule_id \
  -H "Authorization: Bearer $TOKEN"

GET /accounting/soa/{contact_id}

Get Customer or Supplier Statement of Account

Return a statement of account for one customer or supplier, including opening balance, dated activity, running balance, and closing balance in the company's base currency.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/soa/:contact_id \
  -H "Authorization: Bearer $TOKEN"

POST /accounting/transfers

Create Bank Transfer

Record a transfer between two bank or card accounts.

Request body

Responses

Example

curl -X POST http://localhost:8000/accounting/transfers \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /accounting/trial-balance

Get Trial Balance

Return one trial-balance row per account with debit and credit totals for the requested period.

Parameters

Responses

Example

curl -X GET http://localhost:8000/accounting/trial-balance \
  -H "Authorization: Bearer $TOKEN"