> ## Documentation Index > Fetch the complete documentation index at: https://www.finta.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve total > Calculates one signed total for the requested category and its descendants. Check the category's `point_in_time` field from `GET /categories` before choosing date parameters. Periodic categories (`point_in_time: false`), such as income-statement and cash-flow categories, require `start_date` and `end_date`. Point-in-time categories (`point_in_time: true`), such as balance-sheet categories, require `date` and reject `start_date` and `end_date`. Existing integrations may continue using the deprecated month contract. Periodic categories accept `start_month` and `end_month`; point-in-time categories accept only `end_month`. Month parameters use `YYYY-MM` and cannot be combined with full-date parameters. Responses include both representations so clients can migrate independently. Dates use `YYYY-MM-DD`, but totals have monthly granularity and ignore the day (`DD`). For example, `2026-02-03` and `2026-02-28` select the same February total. Periodic totals include both selected months. Point-in-time totals are cumulative through the selected month. Assets use debit minus credit. All other categories use credit minus debit. `merchant` is an exact, case-sensitive match. A blank value means all merchants. `refreshed_at` is the Unix timestamp of the most recent change to data included in the result. It is null when no data matches. Newly imported activity may not appear immediately. The API rejects `period` and `department_id`. It ignores other unknown query parameters. ## OpenAPI ````yaml /openapi.yaml get /aggregations/total openapi: 3.0.3 info: title: Finta API version: '1.0' description: > The Finta API provides programmatic access to your company's financial data, including transactions, journal entries, categories, financial reports, and the team directory. ## Authentication Each API key is scoped to a single company. There is no company ID parameter. The key already knows which company it belongs to. If you have access to multiple companies, create a separate key for each. A key acts as its owner; it does not have a separate permission snapshot. The owner must currently have **API access: Manage**, plus the permission required by the endpoint: | Endpoint | Required permission | |----------|---------------------| | `GET /company` | Company: View | | `GET /team` | Team & access: View | | `DELETE /team/invitations/{id}` | Team & access: Manage; target-management limits apply. No additional Growth/RBAC gate. | | `POST /team/invitations/{id}/resend` | Team & access: Manage; target-management limits apply. No additional Growth/RBAC gate. | | `PATCH /team/invitations/{id}` | Team & access: Manage; RBAC and active/trialing Growth required, with grant and target limits. | | `POST /team/invitations` | Team & access: Manage; requested grants must also be allowed for the person and plan. | | `GET /categories`, `GET /departments` | Accounting setup: View | | `GET /integrations` | Integrations: View | | `GET /reports/*` | Reports: View | | `GET /transactions`, `GET /transactions/{id}` | Transactions: View | | `PATCH /transactions/{id}` | Transactions: Manage | | `GET /journal_entries`, `GET /aggregations/total`, `GET /parties/merchants` | Reports: View | Permission changes apply to the next request. Removing API access permanently revokes the owner's active keys for that company; restoring access requires creating a new key. Authenticate by including your API key in the `Authorization` header: ``` Authorization: Bearer finta_... ``` ### Key prefix convention Every Finta credential is prefixed so it can be recognized at a glance in logs, error messages, and secret scanners. Today there is one credential type and its prefix is `finta_`. As additional credential or token types are introduced (for example restricted keys or webhook signing secrets), each will have its own distinct prefix that stacks on the brand prefix (e.g. `finta__...`). Treat the prefix as load-bearing: do not strip it before sending, and do not assume a missing or unknown prefix is still a Finta credential. ## Rate Limits The API enforces two independent limits. Both surface as `429 Too Many Requests`, but they are distinct error codes with different retry guidance. ### Per-minute burst limit Authenticated requests are limited to **6,000 requests per 60 seconds** (100 per second) per API key. Unauthenticated requests (missing or invalid key) are limited to **120 requests per 60 seconds** per IP address. The window is **fixed**, not rolling. Each 60-second wall-clock interval is its own counter; all requests within that interval share it, and the counter resets to 0 in a single step at the next boundary. Available budget jumps from `0` back to the full bucket size (`6000` for authenticated API keys, `120` for unauthenticated IP buckets) instantaneously at the boundary, rather than aging out one slot at a time. Trust `X-RateLimit-Reset` for the exact reset timestamp. Successful responses and burst-limit rejections include the following headers. Do not assume they are present on other errors: early authentication, authorization, and monthly-limit rejections can omit them. This describes existing header behavior, not a new quota policy. | Header | Description | |--------|-------------| | `X-RateLimit-Limit` | Maximum requests per window (`6000` for authenticated requests, `120` for unauthenticated). | | `X-RateLimit-Remaining` | Requests remaining in the current window. | | `X-RateLimit-Reset` | Unix timestamp when the window resets. | On a 429 for this case, an additional header is included: | Header | Description | |--------|-------------| | `Retry-After` | Number of seconds until the next request is safe. | The error body is `type: rate_limit_error` / `code: rate_limit_exceeded`. **Retry guidance:** This case is retryable. Honor `Retry-After` as the minimum wait, then apply exponential backoff with jitter for any retries beyond the first (cap at a few minutes; abandon after a small number of attempts to avoid retry storms). Do not retry tighter than `Retry-After`. ### Monthly per-company limit Each company has a monthly cap on total API calls, independent of the per-minute burst: | Plan | Monthly cap | |------|-------------| | Formation | 10 | | Startup | 300 | | Growth | 30,000 | Counts reset at **midnight Pacific Time (US & Canada)** on the 1st of each month. This is the Finta application's configured time zone; the cap is computed in that zone, not in UTC. Consumers in other time zones should convert the local-midnight Pacific boundary to their own clock; note that the absolute UTC offset shifts by one hour twice a year for daylight saving (PST is UTC-8, PDT is UTC-7). Blocked requests are not counted toward the limit. The error body is `type: limit_error` / `code: monthly_limit_exceeded`, and the `message` field includes the reset date in human-readable form. **Retry guidance:** This case is **not retryable in the short term.** No `Retry-After` header is sent, deliberately, because the only meaningful remediation is to upgrade the plan (Settings -> Plans at app.finta.com) or wait until the 1st of the next month. Naive retry loops should branch on `error.code` and stop retrying when they see `monthly_limit_exceeded`. SDKs that auto-retry on 429 should look at `error.code` (or the absence of `Retry-After`) before re-issuing. Existing temporary user/company limit overrides may change the allowance and wording of the monthly-limit message. The error code and no-short-term-retry rule remain unchanged. ## Pagination List endpoints use cursor-based pagination. Pass `limit` to control page size (default 100, max 500). To fetch the next page, pass `starting_after` with the `next_cursor` value from the previous response. Responses include `object: "list"`, `url` (the canonical path of the collection, relative to the API host), `has_more` (whether more results exist), `next_cursor` (an opaque value to pass unchanged as `starting_after`), and `data` (the page of items). ## Amounts Every monetary field in the API follows two non-negotiable rules: 1. **Integer cents.** Monetary values are integers, never floats and never formatted strings. `$499.00` is `49900`. `$1,500.00` is `150000`. Divide by 100 to get dollars. This avoids floating-point precision errors in financial calculations. 2. **`_cents` suffix.** The field name always ends in `_cents` (e.g. `amount_cents`, `balance_cents`, `total_cents`, `net_income_cents`, `change_in_cash_cents`, `cash_cents`). If a field name does not end in `_cents`, it is not a monetary value. These rules apply to every monetary field across every endpoint (transactions, journal entries, income statement, balance sheet, cash flow). There are no exceptions and there is no "summary" or "display" sibling field that returns the same amount in dollars or as a string. If you encounter a field that appears to hold a monetary value but does not end in `_cents`, or whose value is not an integer, treat it as a bug and report it. Sign conventions: - **Income statement**: revenue/income amounts are positive, expense amounts are negative. Summing every section's `total_cents` yields net income without sign-flipping. - **Balance sheet**: `balance_cents` carries the natural-sign cumulative balance for that account at the report date. - **Cash flow**: `amount_cents` is positive for cash inflows and negative for cash outflows. ## Errors Errors return a consistent JSON structure: ```json { "error": { "type": "invalid_request_error", "code": "resource_missing", "message": "The requested resource was not found.", "doc_url": "https://www.finta.com/docs/api-reference/errors#resource_missing" } } ``` ### Status codes | Status | Meaning | |--------|---------| | `200 OK` | Request succeeded. | | `201 Created` | A new invitation was created. | | `400 Bad Request` | Request was malformed or had invalid parameters. | | `401 Unauthorized` | The bearer credential is missing, malformed, or unrecognized. The fix is to obtain a valid API key. | | `403 Forbidden` | The API key is valid, but the caller does not have permission to access the resource. The fix is to regain the required company or product-area access. See the `Forbidden` response component for the specific codes. | | `404 Not Found` | The requested resource, or the endpoint itself, does not exist. Unknown or renamed paths (for example an old hyphenated report path like `/reports/income-statement` instead of `/reports/income_statement`) return this same envelope with `type: invalid_request_error` and `code: resource_missing`, as JSON, regardless of the `Accept` header. | | `422 Unprocessable Entity` | Invitation data failed validation, for example an invalid email or a conflicting invitation or existing teammate. | | `429 Too Many Requests` | Either the per-minute burst rate limit (retryable, with `Retry-After`) or the monthly per-company API call limit (not retryable in the short term, no `Retry-After`). Branch on `error.code` to distinguish the two and avoid retry storms on monthly exhaustion. See the Rate Limits section for the full retry guidance. | | `5xx` | An unexpected error on Finta's side. Retry with exponential backoff. | The `error.type` and `error.code` fields are stable identifiers safe to switch on programmatically. The `error.message` is human-readable and may change without notice. servers: - url: https://app.finta.com/api/v1 description: Production security: - bearerAuth: [] tags: - name: Company description: Retrieve company metadata - name: Team description: Retrieve company members and manage invitations - name: Categories description: List your chart of accounts categories - name: Departments description: List the departments available to the authenticated company - name: Integrations description: List the authenticated company's integrations and their connection status - name: Aggregations description: Compute a single figure for one category and its descendants - name: Transactions description: > Transactions are what your bank shows you: a single line like "AWS charged you $499." Most API consumers want transactions. For accounting-level detail, see Journal Entries. Amounts are in cents (e.g. `amount_cents: 49900` = $499.00). - name: Journal Entries description: > Journal entries are the accounting records that transactions create. A single $499 AWS charge becomes two journal entries: debit Software $499, credit Cash $499 (double-entry bookkeeping). Use journal entries when you need accounting-level detail. Amounts are in cents (e.g. `amount_cents: 49900` = $499.00). - name: Parties description: Discover observed counterparties for category-scoped financial queries. - name: Reports description: > Financial statements: income statement, balance sheet, and cash flow. Each report returns the complete statement for a single period. You cannot filter to one category or request multiple periods in one call. paths: /aggregations/total: get: tags: - Aggregations summary: Retrieve total description: > Calculates one signed total for the requested category and its descendants. Check the category's `point_in_time` field from `GET /categories` before choosing date parameters. Periodic categories (`point_in_time: false`), such as income-statement and cash-flow categories, require `start_date` and `end_date`. Point-in-time categories (`point_in_time: true`), such as balance-sheet categories, require `date` and reject `start_date` and `end_date`. Existing integrations may continue using the deprecated month contract. Periodic categories accept `start_month` and `end_month`; point-in-time categories accept only `end_month`. Month parameters use `YYYY-MM` and cannot be combined with full-date parameters. Responses include both representations so clients can migrate independently. Dates use `YYYY-MM-DD`, but totals have monthly granularity and ignore the day (`DD`). For example, `2026-02-03` and `2026-02-28` select the same February total. Periodic totals include both selected months. Point-in-time totals are cumulative through the selected month. Assets use debit minus credit. All other categories use credit minus debit. `merchant` is an exact, case-sensitive match. A blank value means all merchants. `refreshed_at` is the Unix timestamp of the most recent change to data included in the result. It is null when no data matches. Newly imported activity may not appear immediately. The API rejects `period` and `department_id`. It ignores other unknown query parameters. operationId: retrieveTotal parameters: - name: category_id in: query required: true description: A `cat_` ID returned by `GET /categories`. schema: type: string pattern: ^cat_[A-Za-z0-9]+$ example: cat_o5p6q7r8s9t0u1 - name: start_month in: query required: false deprecated: true description: >- Deprecated first month for a periodic category, as `YYYY-MM`. Use with `end_month`, not with full-date parameters. schema: type: string pattern: ^\d{4}-(0[1-9]|1[0-2])$ example: 2026-01 - name: end_month in: query required: false deprecated: true description: >- Deprecated last month for a periodic category or cutoff month for a point-in-time category, as `YYYY-MM`. Do not combine with full-date parameters. schema: type: string pattern: ^\d{4}-(0[1-9]|1[0-2])$ example: 2026-03 - name: start_date in: query required: false description: >- First selected month for a periodic category, as `YYYY-MM-DD`. Required when `point_in_time` is false and rejected when it is true. The day is ignored. schema: type: string format: date example: '2026-01-15' - name: end_date in: query required: false description: >- Last selected month for a periodic category, as `YYYY-MM-DD`. Required when `point_in_time` is false and rejected when it is true. The day is ignored. schema: type: string format: date example: '2026-03-20' - name: date in: query required: false description: >- Selected month for a point-in-time category, as `YYYY-MM-DD`. Required when `point_in_time` is true and rejected when it is false. The day is ignored. schema: type: string format: date example: '2026-03-20' - name: merchant in: query required: false description: >- Exact, case-sensitive merchant or counterparty name. Blank means all merchants. schema: type: string example: AWS responses: '200': description: The requested total content: application/json: schema: $ref: '#/components/schemas/Total' example: object: total category_id: cat_o5p6q7r8s9t0u1 merchant: AWS start_month: 2026-01 end_month: 2026-03 start_date: '2026-01-15' end_date: '2026-03-20' date: null point_in_time: false total_cents: -182340 currency: USD debit_cents: 182340 credit_cents: 0 refreshed_at: 1786992120 '400': description: >- A required parameter is missing, a date is invalid, or the request uses parameters for the wrong category type content: application/json: schema: $ref: '#/components/schemas/Error' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: >- The category ID is malformed, unknown, unavailable through the API, or belongs to another company content: application/json: schema: $ref: '#/components/schemas/Error' '429': $ref: '#/components/responses/RateLimited' components: schemas: Total: type: object required: - object - category_id - merchant - start_month - end_month - start_date - end_date - date - point_in_time - total_cents - currency - debit_cents - credit_cents - refreshed_at properties: object: type: string enum: - total category_id: type: string pattern: ^cat_[A-Za-z0-9]+$ description: The requested public category ID. example: cat_o5p6q7r8s9t0u1 merchant: type: string nullable: true description: >- The exact merchant filter, or null when no merchant filter was applied. example: AWS start_month: type: string nullable: true pattern: ^\d{4}-(0[1-9]|1[0-2])$ description: >- The selected first month for a periodic total. Derived from `start_date` for full-date requests and null for point-in-time totals. example: 2026-01 end_month: type: string pattern: ^\d{4}-(0[1-9]|1[0-2])$ description: >- The selected last or cutoff month. Derived from `end_date` or `date` for full-date requests. example: 2026-03 start_date: type: string format: date nullable: true description: >- The requested periodic start date. For a legacy month request, this is the first day of `start_month`. Null when `point_in_time` is true. example: '2026-01-15' end_date: type: string format: date nullable: true description: >- The requested periodic end date. For a legacy month request, this is the last day of `end_month`. Null when `point_in_time` is true. example: '2026-03-20' date: type: string format: date nullable: true description: >- The requested point-in-time date. For a legacy month request, this is the last day of `end_month`. Null when `point_in_time` is false. example: null point_in_time: type: boolean description: >- When true, request the total with `date`. When false, request it with `start_date` and `end_date`. example: false total_cents: type: integer description: >- Signed total in cents. Assets use debit minus credit; all other categories use credit minus debit. example: -182340 currency: type: string enum: - USD description: ISO 4217 currency code for the total. example: USD debit_cents: type: integer description: Contributing debit amount in cents before sign calculation. example: 182340 credit_cents: type: integer description: Contributing credit amount in cents before sign calculation. example: 0 refreshed_at: type: integer nullable: true description: >- Unix timestamp of the most recent change to data included in the result. Null when no data matches. example: 1786992120 Error: type: object required: - error properties: error: type: object required: - type - code - message - doc_url properties: type: type: string enum: - authentication_error - permission_error - invalid_request_error - rate_limit_error - limit_error - api_error description: >- The error category. `authentication_error` (401) means the bearer credential was missing, malformed, or unrecognized. `permission_error` (403) means the credential was valid but the caller is not allowed to access the resource. `invalid_request_error` covers invalid parameters, unavailable resources, and invitation validation failures. `rate_limit_error` is for per-minute burst limits (retry shortly). `limit_error` is for monthly API call limits per company (upgrade or wait for reset). `api_error` denotes an operation failure on the server (500); retry the same invitation body with exponential backoff. code: type: string enum: - invalid_api_key - user_inactive - user_removed_from_company - company_closed - subscription_required - staging_access_denied - insufficient_permission - resource_missing - parameter_missing - category_update_failed - transaction_update_failed - rate_limit_exceeded - monthly_limit_exceeded - invalid_date_range - invalid_date - invalid_request - plan_upgrade_required - feature_disabled - invitation_invalid - invitation_create_failed - permissions_update_failed - invitation_resend_failed - invitation_revoke_failed description: A specific error code. message: type: string description: A human-readable description of the error. doc_url: type: string format: uri description: A link to documentation about this error. example: https://www.finta.com/docs/api-reference/errors#invalid_api_key param: type: string nullable: true description: The parameter that caused the error, if applicable. responses: Unauthorized: description: >- Authentication failed. Returned when the bearer credential itself is missing, malformed, or unrecognized. The consumer should obtain a valid API key and retry. This is distinct from `403 Forbidden`, which is returned when the credential is valid but the caller is not allowed to access the resource. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: type: authentication_error code: invalid_api_key message: >- Invalid API key provided. Check that your API key is correct and active. doc_url: https://www.finta.com/docs/api-reference/errors#invalid_api_key Forbidden: description: >- The API key was successfully authenticated, but the caller is not allowed to access this resource. The fix is not "get a new key" (that returns 401) but "regain access" (reactivate the user, restore company access, restore an active subscription, or ask an administrator for the required product permission). These codes can be returned, distinguished by `error.code`: - `user_inactive` - the user that owns the API key has been deactivated. - `user_removed_from_company` - the user no longer has access to the company the key was created for. - `company_closed` - the company is closed, closing, or deleted. - `subscription_required` - the company does not have an active subscription. - `staging_access_denied` - the staging environment is restricted to Finta users. - `insufficient_permission` - the key owner lacks API access or the endpoint's required area permission. content: application/json: schema: $ref: '#/components/schemas/Error' examples: user_inactive: summary: User has been deactivated value: error: type: permission_error code: user_inactive message: >- The user associated with this API key is no longer active. Reactivate the user or create a new API key under an active user. doc_url: >- https://www.finta.com/docs/api-reference/errors#user_inactive user_removed_from_company: summary: User no longer has access to this company value: error: type: permission_error code: user_removed_from_company message: >- The user associated with this API key no longer has access to this company. Ask a company admin to re-grant access, then create a new API key. doc_url: >- https://www.finta.com/docs/api-reference/errors#user_removed_from_company company_closed: summary: Company is closed value: error: type: permission_error code: company_closed message: >- This company is closed. The API is not available for closed companies. doc_url: >- https://www.finta.com/docs/api-reference/errors#company_closed subscription_required: summary: Company subscription is not active value: error: type: permission_error code: subscription_required message: >- This company does not have an active subscription. Visit Settings -> Plans at app.finta.com to resolve, then retry. doc_url: >- https://www.finta.com/docs/api-reference/errors#subscription_required staging_access_denied: summary: Staging access is restricted value: error: type: permission_error code: staging_access_denied message: This staging environment is restricted to Finta users. doc_url: >- https://www.finta.com/docs/api-reference/errors#staging_access_denied insufficient_permission: summary: Key owner lacks the required product permission value: error: type: permission_error code: insufficient_permission message: >- The API key owner needs the Transactions: View permission to use this endpoint. doc_url: >- https://www.finta.com/docs/api-reference/errors#insufficient_permission RateLimited: description: >- Too many requests. Two distinct limits can trigger a 429: (1) Per-minute burst limit (6,000 requests per 60 seconds per API key) returns `rate_limit_error` / `rate_limit_exceeded` with `Retry-After` header. (2) Monthly API call limit per company returns `limit_error` / `monthly_limit_exceeded` with the reset date in the message. Monthly limits vary by plan: Formation (10/month), Startup (300/month), Growth (30,000/month). Blocked requests do not count toward the limit. headers: Retry-After: schema: type: integer description: >- Seconds until the burst rate limit resets. Only present for rate_limit_error responses. X-RateLimit-Limit: schema: type: integer description: >- Maximum requests per burst window. Only present for rate_limit_error responses. X-RateLimit-Remaining: schema: type: integer description: >- Requests remaining in burst window (0 when rate limited). Only present for rate_limit_error responses. X-RateLimit-Reset: schema: type: integer description: >- Unix timestamp when the burst window resets. Only present for rate_limit_error responses. content: application/json: schema: $ref: '#/components/schemas/Error' examples: burst_rate_limit: summary: Per-minute burst rate limit exceeded value: error: type: rate_limit_error code: rate_limit_exceeded message: >- Too many requests. Please retry after the Retry-After period. doc_url: >- https://www.finta.com/docs/api-reference/errors#rate_limit_exceeded monthly_limit: summary: Monthly API call limit exceeded value: error: type: limit_error code: monthly_limit_exceeded message: >- Monthly API limit reached. Your plan allows 300 calls per company per month. Resets on April 1, 2026. Upgrade in Settings -> Plans at app.finta.com. doc_url: >- https://www.finta.com/docs/api-reference/errors#monthly_limit_exceeded securitySchemes: bearerAuth: type: http scheme: bearer description: API key prefixed with `finta_` ````