samantha/FPandA-Engine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update API Reference

samantha
2026-03-21 07:42:44 +00:00
parent 9602107dea
commit a0ede4d3c9
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
API-Reference.md

@@ -133,7 +133,7 @@ Delete a budget line by ID.
#### `POST /actuals/ingest` #### `POST /actuals/ingest`
Upsert an actual. Idempotent by `(fiscal_year, fiscal_period, department_id, gl_account_id)` — posting the same period twice updates the amount rather than creating a duplicate. Upsert an actual. Idempotent by `(fiscal_year, fiscal_period, department_id, gl_account_id)` - posting the same period twice updates the amount rather than creating a duplicate.
**Request body:** **Request body:**
```json ```json
@@ -159,8 +159,8 @@ Designed to accept bulk ERP export feeds. POST each line individually or build a
| Parameter | Example | Description | | Parameter | Example | Description |
|---|---|---| |---|---|---|
| `year` | `2024` | Fiscal year (required) | | `year` | `2024` | Fiscal year (required) |
| `period` | `9` | Fiscal period 1–12 (required) | | `period` | `9` | Fiscal period 1-12 (required) |
| `dept` | `ENG` | Department code — omit to return all departments | | `dept` | `ENG` | Department code - omit to return all departments |
| `version` | `original` | Budget version (defaults to `original`) | | `version` | `original` | Budget version (defaults to `original`) |
--- ---
@@ -213,9 +213,9 @@ GET /api/v1/variance?year=2024&period=9&dept=ENG
} }
``` ```
`variance_abs` = actual − budget. Positive means over-budget for costs, under-budget for revenue. `variance_abs` = actual - budget. Positive means over-budget for costs, under-budget for revenue.
`status` is `"favourable"` or `"unfavourable"` based on the account's `favour_high` flag — see [Finance Concepts](Finance-Concepts). `status` is `"favourable"` or `"unfavourable"` based on the account's `favour_high` flag - see [Finance Concepts](Finance-Concepts).
--- ---