List income and expense entries
get
https://api.flactrum.com/v1/transactions
| Required scope | transactions.read |
| Panel screen | Finance → Income & expenses |
| Success status | 200 |
| Returns | A paginated list of Transaction objects |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| branch_id | query | string | — |
| type | query | string | — |
| category | query | string | — |
| affects_cash | query | boolean | — |
| manual | query | boolean | true for hand-entered rows, false for ones produced by sales. |
| from | query | string | — |
| to | query | string | — |
| page | query | integer | Page number. |
| per_page | query | integer | Page size. Values above the maximum are rejected rather than silently clamped. |
| updated_since | query | string | Only records changed at or after this instant. Use it for incremental sync. |
| sort | query | string | Column to sort by. Each endpoint lists what it accepts. |
| direction | query | string | Sort direction. |
Response fields
| Field | Type | Description |
|---|---|---|
| id | string | — |
| branch_id | string | — |
| type | string | — |
| category | string | — |
| amount | number | Always positive; the direction comes from type. |
| affects_cash | boolean | Whether it passes through the till. A bill paid by bank transfer is an expense but does not change the day-end cash count. |
| payment_method_id | string|null | — |
| order_id | string|null | Set when the entry came from a sale rather than being typed in. |
| transaction_date | string | — |
| receipt_url | string|null | Photo or PDF of the receipt, when one was attached. |
Examples
No recorded example yet.