Factuarea APIDevelopers
Support
Open app

Change the access level on a managed account

Change the level (none, view or operate) your account keeps on one of its managed accounts. - Before the claim you can raise or lower; after it, raising returns 422 access_level_raise_forbidden. - A foreign or non-managed account returns 404 account_not_found. - Requires the privileged accounts:write scope.

PATCH
/accounts/{account}/access-level

Authorization

AuthorizationBearer <token>

Your API key as a bearer token: fact_live_… in production, fact_test_… in sandbox. See the authentication guide.

In: header

Path Parameters

account*string

Public identifier (UUID v7) of the managed account provisioned by your account (its id in GET /v1/accounts).

Formatuuid

Headers

Idempotency-Key?string

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide.

Length1 <= length <= 255
Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

Previous/v1/accounts/imports
POST

Apply a bulk import of managed accounts

Apply a bulk import of managed accounts and own tax IDs from files (multipart/form-data); returns 201. Declarative and NOT atomic: each row is applied on its own; failures come back as BLOCKED or ERROR. Idempotency-Key required; vouchers are returned EXACTLY ONCE, or emailed with options.send_email. Requires the privileged accounts:write scope.

Next/v1/accounts/{account}/plan
PATCH

Change the plan of a managed account

Change the plan of a managed account your account pays. An upgrade applies and is charged at once; a downgrade stays pending until period end (pending_plan). Irreversible: Idempotency-Key required; enterprise returns 422 managed_account_plan_not_self_serve. Requires operate access on the account (403 forbidden_action) and the privileged accounts:write scope.