API: Accounting

This page assumes the X-Api-Key header and the ?companyId= parameter described in the REST API for developers overview.

Accounting (read-only)

These endpoints expose the data produced by the depreciation engine, the journal generator, disposals and revaluations. They are all GET only, require X-Api-Key and ?companyId=, and return the standard paged envelope ({items, total, skip, take}) - except the single-item queries, which return the object directly.

GET /api/v1/fiscal-years

A paged list of fiscal years.

{ "id": "...", "year": 2025, "startDate": "2025-01-01", "endDate": "2025-12-31", "isClosed": false }

GET /api/v1/depreciation-runs

A paged list of Depreciation runs. Use ?skip=&take= to page.

curl -s "https://acme.activohq.cloud/api/v1/depreciation-runs?companyId=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "X-Api-Key: $ACTIVOHQ_API_KEY"

Response items:

{
  "id": "...",
  "postingPeriodId": "...",
  "depreciationBookId": "...",
  "runDate": "2025-03-31",
  "status": "Posted",
  "totalDepreciation": 4250.00,
  "entryCount": 17
}

GET /api/v1/depreciation-runs/

A single depreciation run - the same fields as above (without the envelope).

GET /api/v1/depreciation-entries

A paged list of individual depreciation lines. Narrow the results with ?runId= and/or ?assetId=.

Response items:

{
  "id": "...",
  "depreciationRunId": "...",
  "assetId": "...",
  "year": 2025,
  "month": 3,
  "openingNbv": 10000.00,
  "depreciationAmount": 250.00,
  "closingNbv": 9750.00,
  "accumulatedDepreciation": 2500.00
}

GET /api/v1/journal-batches

A paged list of Journal batches (one batch per accounting event - depreciation, disposal, revaluation and so on).

GET /api/v1/journal-batches/

A single journal batch. The single-item query includes a lines array:

{
  "id": "...",
  "eventType": "Depreciation",
  "sourceId": "...",
  "postedDate": "2025-03-31",
  "status": "Posted",
  "totalDebit": 250.00,
  "totalCredit": 250.00,
  "lines": [
    { "id": "...", "accountCode": "6200", "debit": 250.00, "credit": 0.00, "description": "Depreciation - LAP-0042", "assetId": "..." },
    { "id": "...", "accountCode": "1510", "debit": 0.00, "credit": 250.00, "description": "Acc. Depreciation - LAP-0042", "assetId": "..." }
  ]
}

GET /api/v1/disposals

A paged list of Asset disposals.

{
  "id": "...",
  "assetId": "...",
  "disposalDate": "2025-06-15",
  "type": "Sale",
  "proceeds": 500.00,
  "nbvAtDisposal": 400.00,
  "gainLoss": 100.00,
  "notes": "Sold at auction."
}

GET /api/v1/revaluations

A paged list of asset revaluations and impairments.

{
  "id": "...",
  "assetId": "...",
  "revaluationDate": "2025-06-01",
  "type": "Upward",
  "amount": 5000.00,
  "carryingBefore": 20000.00,
  "carryingAfter": 25000.00,
  "notes": "Market appraisal June 2025."
}