> ## 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. # Grant integration access > Records that the user has invited Finta as a user in the provider's own app, for a `grant_access` connection method whose `connect_via` is `provider_app` in `GET /integrations`. Finta can't see the invite, so it relies on this. Call it only once the user says the invite is sent. Granting access also closes the Finta inbox item that asked for it, such as Mercury Treasury's or Ramp Checking's `grant_access` item. Calling it again once access is granted changes nothing and returns the same integration. Carta and Pulley also need `url`, the company's page at the provider, such as `https://app.carta.com/corporations/12345` or `https://pulley.com/companies/1234`. Finta then checks the invite in the background (for Carta from that page, for Pulley once Pulley's invite email arrives), and the integration's `status` is `connecting` until it has. Other integrations reject `url`. For Gusto and Rippling, granting access connects the payroll integration: its `status` and its `grant_access` method read `connected`, and Finta's team is told to review it. Any other integration, or Mercury and Ramp while Finta isn't asking for access, returns `400` `integration_not_grantable`. ## OpenAPI ````yaml /openapi.yaml post /integrations/{key}/grant_access 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, sheets, 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 /sheets`, `GET /sheets/{id}`, `GET /sheets/{id}/cells` | Forecast: View | | `POST /sheets`, `PATCH /sheets/{id}`, `DELETE /sheets/{id}` | Forecast: Manage; existing sheet entitlements apply | | `GET /company` | Company: View | | `GET /onboarding`, `PATCH /onboarding` | Company: Manage and Integrations: Manage, as onboarding needs in the web app | | `GET /taxes`, `GET /taxes/{id}` | Taxes: View | | `POST /files`, `POST /file_uploads` | Depends on `purpose`: Taxes: Manage for `tax_document` (the default), Reconciliation: Manage for `bank_statement` | | `POST /taxes/income_uploads`, `POST /taxes/franchise_uploads` | Taxes: Manage | | `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` | Admin role required. 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` | Admin role required; requested access must also be allowed by the plan. | | `GET /categories`, `GET /departments`, `GET /rules`, `GET /rules/{id}` | Accounting setup: View | | `GET /tags` | Accounting setup: View | | `POST /tags`, `PATCH /tags/{id}`, `DELETE /tags/{id}` | Accounting setup: Manage | | `POST /categories` | Accounting setup: Manage; some templates also need the Startup plan, and some only Finta adds | | `POST /rules` | Accounting setup: Manage; applying to existing transactions (`apply_to_existing_transactions`, default true) also requires Transactions: Manage | | `PATCH /rules/{id}` | Accounting setup: Manage; Transactions: Manage is not required | | `DELETE /rules/{id}` | Accounting setup: Manage and Transactions: Manage, including absent retries | | `GET /integrations` | Integrations: View | | `GET /tax_credits`, `GET /tax_credits/{id}` | Taxes: View | | `GET /reports/*`, `POST /reports/exports` | Reports: View | | `GET /metrics`, `GET /metric_values` | Reports: View | | `GET /accounts`, `GET /cards`, `GET /transactions`, `GET /transactions/{id}`, `GET /transactions/splits`, `GET /spreads` | Transactions: View | | `GET /forms/1099`, `GET /forms/1099/{id}` | Taxes: View | | `POST /transactions/bulk/update`, `GET /jobs/{id}` | Transactions: Manage | | `PATCH /transactions/{id}`, `POST /transactions/{id}/split`, `PATCH /transactions/{id}/split`, `DELETE /transactions/{id}/split`, `POST /accounts`, `POST /transaction_uploads`, `POST /transfers`, `DELETE /transfers/{id}` | Transactions: Manage | | `GET /journal_entries`, `GET /journal_entries/{id}`, `GET /aggregations/total`, `GET /aggregations/totals`, `GET /parties/merchants` | Reports: View | | `GET /invoices`, `GET /invoices/{id}` | Invoices: View | | `POST /invoices`, `POST /invoices/{id}/void` | Invoices: Manage | | `POST /invoices/{id}/match`, `POST /invoices/{id}/unmatch`, `POST /transactions/{id}/match_invoices` | Invoices: Manage and Transactions: Manage | | `GET /reconciliations`, `GET /reconciliations/{id}` | Reconciliation: View | | `POST /reconciliations/{id}/reconcile`, `POST /reconciliations/{id}/unreconcile` | Reconciliation: Manage | 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. ## Onboarding A company starts using Finta by onboarding: it answers a short questionnaire, Finta decides whether it can take the company on, the company connects the banks and cards it selected, and Finta syncs them for the first time. Until the company is onboarded, every endpoint returns `403 Forbidden` with `type: permission_error` and `code: onboarding_incomplete`, except these: | Endpoint | Why | |----------|-----| | `GET /onboarding`, `PATCH /onboarding` | Onboarding itself | | `GET /integrations` | To see the banks and cards to connect | | `POST /integrations/{key}/connect`, `GET /integrations/{key}/connect` | To connect them, only once Finta has approved the company (`onboarding_status` `connect_banks` or `syncing`) | | `POST /team/invitations` | To invite the teammate who can approve a connection, such as a Brex account admin | | `POST /feedback` | To write to Finta support | The error's `onboarding_status` says where the company is (the `status` of `GET /onboarding`): ```json { "error": { "type": "permission_error", "code": "onboarding_incomplete", "message": "This company hasn’t finished onboarding with Finta, so this endpoint isn’t available yet. Call GET /api/v1/onboarding and follow its next_step.", "doc_url": "https://www.finta.com/docs/api-reference/errors#onboarding_incomplete", "onboarding_status": "connect_banks" } } ``` Call `GET /onboarding` and follow its `next_step` until its `status` is `complete`. A company Finta needs a call with (`call_required`) or can't onboard (`not_eligible`) stays here, as it does in the web app. Nothing counts toward the monthly limit until the company is onboarded. Connecting banks is part of onboarding, but only after Finta approves the company, as in the web app: a bank connected earlier would sync outside onboarding, and onboarding's first sync would never start. Before approval, both connect endpoints return `onboarding_incomplete` with a message to finish the questionnaire first. `GET /integrations` answers throughout. ## 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, or per Finta CLI login. 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 | | Enterprise | Unlimited | Enterprise is enabled internally by Finta for contract-managed companies. It bypasses commercial monthly API/MCP quotas and ordinary subscription lockouts, even when the Stripe subscription is absent or canceled. Requests and MCP tool calls are still counted. Enterprise does not bypass valid credentials, company/user permissions, company closure, request validation, payload bounds, or per-minute abuse limits. Disabling Enterprise restores ordinary plan gates using the current billing state; it does not change Stripe billing. Nothing counts until the company finishes onboarding, and `GET /onboarding` and `PATCH /onboarding` never count. 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. A temporary company limit override, set by Finta support for the current month, may change the allowance and the wording of the monthly-limit message. It applies to every user and API key in the company. 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). ## Reporting dates and freshness Reports and category totals use calendar dates in **America/Los_Angeles (Pacific Time)**, including defaults such as today and the current quarter. Periodic requests include both `start_date` and `end_date` exactly. Point-in-time requests include activity through the exact `date`. Response dates identify the boundaries actually used, not rounded months. Whole months read whole-month rollups. The current month's first day through today in Pacific Time reads month-to-date (MTD) rollups when fresh. Other partial-month boundaries, including a midmonth start, read raw journal entries for just those partial months and are slower; any whole months in the same request still use rollups. Stale or unfilled MTD rollups safely fall back to raw entries. Whole-month requests and month-aligned month-start-to-today or year-to-date requests stay on the fast rollup path when MTD is fresh. Fresh MTD must end at exactly the requested cutoff. If a refresh advances the rollup across Pacific midnight during a request, exact live entries preserve the original cutoff; later-day MTD is never included in that answer. `refreshed_at` is a Unix timestamp covering the entire report, total, or grouped page, including partial months. For rollup-only reads it is the maximum contributing rollup timestamp, including MTD. Any live raw-entry portion is current as of the call, even when no raw entries match. A fresh MTD row contributes its timestamp even when it contains zero activity through today; future-only merchants do not appear as empty merchant groups. A grouped page covers its returned groups; a later month's refresh does not advance an earlier monthly page's timestamp. It is null only when no contributing timestamp or live raw read is available. Rollup-backed activity may lag newly imported or edited entries. ## Amounts Financial resource fields follow these two rules. Generic spreadsheet cell arrays are a scoped exception, described below: 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 monetary resource fields (transactions, journal entries, income statement, balance sheet, cash flow). There is no "summary" or "display" sibling field that returns the same financial-resource amount in dollars or as a string. **Spreadsheet exception:** `/sheets` range `values` are generic spreadsheet cells, not financial-resource amount fields. They preserve the existing sheet engine's units: for example, a sheet amount of $20,000 is entered as `20000`, not `2000000`. Formatting does not trigger a cents conversion. Formula results use the existing spreadsheet evaluator and FINTA behavior. Do not apply the financial-resource cents convention to cell arrays. 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 resource was created, such as an invitation, an account, or a transaction upload draft. | | `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 (`invalid_api_key`), or, for a Finta CLI login (`invalid_token`), to sign in again with `finta login`. | | `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. | | `409 Conflict` | The request conflicts with the resource's current state, for example changing an onboarding answer after Finta decided. | | `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. ### Overdue billing invoices A company with an unpaid billing invoice explicitly linked by Finta loses access when that invoice's due date ends in America/Los_Angeles, independently of its subscription or plan. Every API endpoint then returns `403 permission_error` with code `invoice_overdue`, before running the endpoint or changing data. Pay all overdue linked invoices at app.finta.com or contact support@finta.com; replacing the API key or buying another plan does not resolve this refusal. There is no payment-processing grace period: payment must have settled and Stripe must mark each overdue invoice paid. A linked invoice only counts while its corresponding Enterprise product is enabled. Unpaid status can be cached for up to 60 seconds. Access returns automatically within a minute after every overdue linked invoice is paid. Paid status is final. Companies with no linked invoices do not perform this payment-status check. Amounts in the human-readable message reflect the unsettled balance after partial payments. Whole-dollar amounts omit decimal places; non-zero cents remain exact. Only invoice status paid clears an overdue invoice. The lock is not latched: when an overdue invoice is paid and the only remaining unpaid invoice is not due yet, access resumes until that later invoice misses its cutoff. If payment status cannot be verified after the due-date cutoff, every endpoint can instead return `503 api_error` with code `invoice_status_unavailable` and `Retry-After: 60`. Retry after that interval, then use bounded exponential backoff if the service remains unavailable. This response never treats an unknown payment as paid. A Stripe outage before the cutoff does not refuse access for this reason. MCP connections remain connected, but every tool call is refused for these same reasons, including tools that normally do not consume the monthly allowance. A refused tool result has `isError: true`, uses the API's message, and is not counted against the monthly allowance. Its transport remains HTTP 200; a temporary payment-status failure includes `Retry-After: 60` on that response. ### Early access endpoints Some features are in early access: turned on per company while they roll out. A feature can be whole endpoints, such as invoices, or inputs on endpoints everyone uses, such as a department filter or a department to set or clear. For a company that doesn't have the feature yet, every request to its endpoints, and every request that sends one of its inputs, returns `403 Forbidden` with `type: permission_error` and `code: feature_disabled`, and changes nothing: ```json { "error": { "type": "permission_error", "code": "feature_disabled", "message": "This feature isn’t turned on for this company yet. Contact Finta to request access.", "doc_url": "https://www.finta.com/docs/api-reference/errors#feature_disabled" } } ``` It is not retryable: contact Finta to request access for the company, then retry. Once the feature is on for the company, the same requests work normally. If the plan doesn't include departments, a request that names one gets `plan_upgrade_required` instead. Department reports always get `feature_disabled`. servers: - url: https://app.finta.com/api/v1 description: Production security: - bearerAuth: [] tags: - name: Onboarding description: Create a Finta account through an agent and verify the user's email - name: Sheets description: > Create, read, edit and delete spreadsheet documents, worksheets, cell ranges and embedded charts. Existing Sheets access includes tag-filtered financial formulas, including Other, without separate Dashboard, Transactions or Accounting settings access. API calls still require API access: Manage; reads require Forecast: View and mutations require Forecast: Manage, with existing company, subscription and financial authorization checks. Existing web link sharing requires Forecast: Manage and the existing sharing entitlement; the sharing owner's current access and revocation checks remain authoritative. Guests can evaluate authorized saved formulas, not arbitrary financial queries or the full tag catalog. This adds no public sharing or tag-management endpoint. - name: Onboarding description: >- Answer the onboarding questionnaire, follow Finta's decision, and connect the company's banks until it's onboarded - name: Company description: Retrieve company metadata - name: Plans & billing description: >- The plans Finta offers, what the company pays, and how much of each plan limit it has used. - name: Team description: Retrieve company members and manage invitations - name: Categories description: List your chart of accounts categories and add Finta's standard ones - name: Rules description: Company automation rule definitions. - name: Departments description: List the departments available to the authenticated company - name: Tags description: >- Company-defined transaction labels managed in Settings that break categories down further, such as Vercel and Webshare under Infrastructure. Each transaction has at most one tag; untagged amounts appear as Other. Tags do not change the books, taxes or reports. - name: Integrations description: List the authenticated company's integrations and their connection status - name: Inbox description: >- What Finta needs from the company, from its Finta inbox, and how each item gets done - name: Aggregations description: >- Compute totals for one category and its descendants, as a single figure or grouped by merchant or month - 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: Invoices description: > Invoices the company sent, and the bank deposits that paid them. Recording an invoice books its revenue; Finta doesn't send invoices to customers. Amounts are in cents (e.g. `amount_cents: 49900` = $499.00). - name: Reconciliation description: > Reconciling an account's period confirms Finta's balance matches the statement's ending balance, and locks the period's transactions. Each account has one reconciliation per period (the calendar month, or the bank statement's dates for statement-dated accounts), whether or not it's reconciled yet. Amounts are in cents in the statement's terms: a credit card's balance owed is positive. - name: Parties description: Discover observed counterparties for category-scoped financial queries. - name: Forms description: Discover vendor compliance filing records and yearly progress. - 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. - name: Metrics description: > Key metrics month by month, such as cash, runway, revenue growth, gross margin and net income. Each metric is either point in time, read on a date, or over a period. - name: Feedback description: Send questions, feedback and bug reports to Finta support - name: Tax Credits description: Credit amounts and claim progress by type, jurisdiction, and tax year - name: Taxes description: >- Discover income-tax and Delaware franchise-tax filing records and available PDFs. - name: Files description: Upload the PDFs that tax uploads attach to the company's tax records. paths: /integrations/{key}/grant_access: post: tags: - Integrations summary: Grant integration access description: > Records that the user has invited Finta as a user in the provider's own app, for a `grant_access` connection method whose `connect_via` is `provider_app` in `GET /integrations`. Finta can't see the invite, so it relies on this. Call it only once the user says the invite is sent. Granting access also closes the Finta inbox item that asked for it, such as Mercury Treasury's or Ramp Checking's `grant_access` item. Calling it again once access is granted changes nothing and returns the same integration. Carta and Pulley also need `url`, the company's page at the provider, such as `https://app.carta.com/corporations/12345` or `https://pulley.com/companies/1234`. Finta then checks the invite in the background (for Carta from that page, for Pulley once Pulley's invite email arrives), and the integration's `status` is `connecting` until it has. Other integrations reject `url`. For Gusto and Rippling, granting access connects the payroll integration: its `status` and its `grant_access` method read `connected`, and Finta's team is told to review it. Any other integration, or Mercury and Ramp while Finta isn't asking for access, returns `400` `integration_not_grantable`. operationId: grantIntegrationAccess parameters: - $ref: '#/components/parameters/IntegrationKey' requestBody: required: false content: application/json: schema: type: object additionalProperties: false properties: url: type: string description: >- Carta and Pulley only, and required for them: the company's page URL at the provider, or just its numeric ID there. example: https://app.carta.com/corporations/12345 example: url: https://app.carta.com/corporations/12345 responses: '200': description: >- The integration, as `GET /integrations` lists it, with its `grant_access` method `granted` (`connecting` for Carta and Pulley, `connected` for Gusto and Rippling). content: application/json: schema: $ref: '#/components/schemas/Integration' example: key: ramp object: integration name: Ramp type: banking status: connected connection_methods: - type: oauth status: connected connect_via: api - type: grant_access status: granted connect_via: provider_app quality: great signup_referral: null '400': description: >- Finta isn't asking for access to this integration (integration_not_grantable), or `url` is missing or unreadable for Carta or Pulley, or passed for another integration (invalid_request, param url). content: application/json: schema: $ref: '#/components/schemas/Error' '401': $ref: '#/components/responses/Unauthorized' '403': description: >- Existing API access checks failed, or the key owner lacks the Integrations: Manage permission (insufficient_permission). content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: >- No integration with this key is available to the company (resource_missing). content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: >- For Carta or Pulley: that account is already connected to another company, or this company already has a different one (integration_already_connected). content: application/json: schema: $ref: '#/components/schemas/Error' '429': $ref: '#/components/responses/RateLimited' '500': description: >- Access could not be recorded (access_grant_failed). Retry with exponential backoff. content: application/json: schema: $ref: '#/components/schemas/Error' '503': $ref: '#/components/responses/InvoiceStatusUnavailable' components: parameters: IntegrationKey: name: key in: path required: true description: The integration's `key` from `GET /integrations`, e.g. `mercury`. schema: type: string example: mercury schemas: Integration: type: object required: - key - object - name - type - status - connection_methods - quality - signup_referral properties: key: type: string description: >- Stable identifier for the integration, e.g. `mercury`, `ramp`, `carta`. example: mercury object: type: string enum: - integration name: type: string description: Human-readable vendor name. example: Mercury type: type: string enum: - banking - cap_table - payroll - revenue - notifications - legal description: What kind of integration this is. status: type: string enum: - not_connected - connected - connecting - requires_reconnect description: >- Connection state. `connecting` means Finta has the connection but isn't done setting it up, such as a Carta or Pulley connection whose invite Finta is still checking. `requires_reconnect` means a previously working connection needs the user to reauthenticate. connection_methods: type: array description: >- Each way this integration can be connected, with where it stands. Every integration has the method it connects with. Mercury and Ramp also list a `grant_access` method once Finta asks the company to invite Finta for Mercury Treasury or Ramp Checking, data their sign-in connection doesn't include. Order is not significant. items: $ref: '#/components/schemas/ConnectionMethod' quality: type: string enum: - great - good - third_party description: >- How reliable this integration's data is, the same rating the Finta web app shows. `great` is an OAuth or API connection with real-time updates, `good` is read-only access straight from the source that is not real-time, and `third_party` is a Plaid-based bank connection whose data can be incomplete or error-prone. signup_referral: type: object nullable: true description: >- A referral offer for opening an account with this provider. Present only while `status` is `not_connected` and the provider has a Finta referral; `null` otherwise. required: - reward - link properties: reward: type: string description: >- What signing up through the link earns, as shown in the Finta web app. example: $500 sign up bonus link: type: string format: uri description: The provider's sign-up page for Finta's referral. example: https://mercury.com/r/fintadotcom 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, invitation validation failures, and requests that conflict with current state (409). `rate_limit_error` is for per-minute burst limits or signup email limits (wait for Retry-After). `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), or temporarily unavailable rule definitions (503 rules_not_ready). Retry with exponential backoff; persistent 503 errors require operator attention. For 503 totals_timeout on transaction totals, narrow the filters (for example start_date and end_date) before retrying instead. code: type: string enum: - invalid_api_key - invalid_token - user_inactive - user_removed_from_company - company_closed - subscription_required - invoice_overdue - invoice_status_unavailable - staging_access_denied - insufficient_permission - resource_missing - parameter_missing - invalid_email - category_update_failed - transaction_update_failed - totals_timeout - rate_limit_exceeded - monthly_limit_exceeded - invalid_date_range - invalid_date - invalid_request - idempotency_key_conflict - plan_upgrade_required - request_required - feature_disabled - invitation_invalid - invitation_create_failed - permissions_update_failed - invitation_resend_failed - invitation_revoke_failed - integration_not_connectable - integration_already_connected - connect_link_in_progress - connect_link_failed - rules_not_ready - forms_not_ready - taxes_not_ready - rule_already_exists - rule_busy - tag_already_exists - tag_busy - tag_deletion_failed - revision_conflict - revision_history_mismatch - rule_deletion_failed - account_create_failed - category_create_failed - upload_committed - upload_commit_failed - upload_in_progress - upload_delete_failed - reconciliation_locked - feedback_unavailable - billing_unavailable - closed_books - invoice_already_exists - invoice_not_open - invoice_not_matched - payment_already_matched - transaction_not_matchable - invoice_operation_failed - transaction_already_matched - transfer_not_eligible - transfer_operation_failed - transaction_already_split - transaction_not_splittable - transaction_not_split - split_operation_failed - journal_entries_unbalanced - journal_entries_reconciled - report_export_failed - report_export_limit_exceeded - invalid_file - wrong_document_type - file_already_attached - tax_upload_not_allowed - tax_upload_failed - integration_not_grantable - access_grant_failed - onboarding_incomplete - answers_incomplete - onboarding_locked - onboarding_complete - balance_mismatch - already_reconciled - account_closed - concurrent_change - not_reconciled - not_latest_reconciliation - reconciliation_failed - unreconcile_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 current_revision: type: integer minimum: 0 description: >- Current sheet revision, returned on a revision conflict when available. finta_balance_cents: type: integer description: On balance_mismatch, Finta's balance through the period's end. statement_balance_cents: type: integer description: On balance_mismatch, the statement balance that was sent. difference_cents: type: integer description: >- On balance_mismatch, Finta's balance minus the statement balance. last_reconciliation_id: type: string nullable: true description: >- On not_latest_reconciliation, the recon_ ID of the account's latest reconciliation, which has to be undone first. param: type: string nullable: true description: The parameter that caused the error, if applicable. missing: type: array items: type: string description: >- With `answers_incomplete`, the onboarding answer keys still required before submitting. onboarding_status: type: string enum: - questionnaire - ready_to_submit - call_required - not_eligible - connect_banks - syncing - complete description: >- With `onboarding_incomplete`, where the company is in onboarding, as `GET /onboarding` returns it in `status`. ConnectionMethod: type: object required: - type - status - connect_via properties: type: type: string enum: - oauth - plaid - api_key - grant_access description: >- How this method connects. `oauth`: the user signs in to the provider and approves Finta. `plaid`: the user signs in to their bank through Plaid. `api_key`: the user gives Finta an API key from the provider. `grant_access`: the user invites Finta as a user in the provider. New values may be added; treat an unknown one like `connect_via` says. status: type: string enum: - not_connected - requested - granted - connecting - connected - requires_reconnect description: >- Where this method stands. `requested`: Finta has asked the company to do it, in the Finta inbox. `granted`: `POST /integrations/{key}/grant_access` recorded that the company invited Finta, as that inbox item asked. The other values mean what they do on the integration's `status`. connect_via: type: string enum: - api - provider_app - web_app description: >- How to start or redo it. `api`: `POST /integrations/{key}/connect` returns a link the user opens. `provider_app`: the user invites Finta as a user in the provider's own app, then `POST /integrations/{key}/grant_access` records it. `web_app`: the user does it in the Finta web app (Settings → Integrations). New values may be added. responses: Unauthorized: description: >- Authentication failed. Returned when the bearer credential itself is missing, malformed, or unrecognized. This is distinct from `403 Forbidden`, which is returned when the credential is valid but the caller is not allowed to access the resource. These codes can be returned, distinguished by `error.code`: - `invalid_api_key` - no credential, or an API key that is unknown or revoked. Obtain a valid API key and retry. - `invalid_token` - the access token from a Finta CLI browser login (`finta_oat_`) has expired, its login was disconnected (logged out, replaced by a new login, or removed under Connected apps), or it was not issued for this API. Sign in again with `finta login`. 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 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). Enterprise bypasses commercial monthly quotas, but still counts requests and enforces per-minute abuse limits. 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 InvoiceStatusUnavailable: description: >- Payment status for a linked billing invoice could not be verified after its Pacific due-date cutoff. No endpoint data or mutation is returned. The error type is api_error and the code is invoice_status_unavailable. Retry after 60 seconds, then use bounded exponential backoff while the status service is unavailable. This refusal does not apply to unlinked companies or before the cutoff. headers: Retry-After: description: >- Seconds to wait before retrying this temporary payment-status failure. schema: type: integer example: 60 content: application/json: schema: $ref: '#/components/schemas/Error' example: error: type: api_error code: invoice_status_unavailable message: >- We couldn’t verify your invoice payment status. Please try again shortly. doc_url: >- https://www.finta.com/docs/api-reference/errors#invoice_status_unavailable securitySchemes: bearerAuth: type: http scheme: bearer description: >- An API key prefixed with `finta_`, or the access token from a Finta CLI browser login (`finta login`), prefixed with `finta_oat_`. A CLI login's access token lasts one hour and the CLI renews it itself. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.