Organization
The organization endpoint returns metadata about the organization the access token is scoped to. This is useful for displaying context in your integration or reading configuration like the base currency and tax mode.
Requires the org:read scope. See Authentication.
Endpoint
Section titled “Endpoint”| Method | Path | Scope | Description |
|---|---|---|---|
GET | /api/v1/organisation | org:read | Fetch organization metadata. |
Fetch organization metadata
Section titled “Fetch organization metadata”Request
Section titled “Request”curl https://app.accountfun.com/api/v1/organisation \ -H "Authorization: Bearer $ACCESS_TOKEN"Response — 200 OK
Section titled “Response — 200 OK”{ "organization": { "id": "00000000-0000-0000-0000-000000000000", "name": "Acme Widget Co", "tradeName": "Acme", "baseCurrency": "USD", "taxMode": "exclusive", "timezone": "America/New_York", "registrationNumber": "12-3456789", "address": "123 Main St, Springfield", "phone": "+1-555-0100", "website": "https://acme.example", "sandbox": false }}Fields
Section titled “Fields”| Field | Description |
|---|---|
id | The organization’s UUID. Matches the organization_id returned in the token response. |
name | Legal organization name. |
tradeName | Trading name (if different from the legal name). |
baseCurrency | The organization’s functional/reporting currency. This is locked at creation and cannot change. |
taxMode | Legacy organization-wide tax setting: exclusive or inclusive. Each invoice and bill carries its own taxMode, so read it from the document rather than relying on this field. |
timezone | IANA timezone identifier (e.g. America/New_York). |
registrationNumber | Company / tax registration number. |
address | Postal address. |
phone | Primary phone number. |
website | Website URL. |
sandbox | true when the token is connected to a sandbox organization (demo data, tighter limits); false for a live organization. |
Using the base currency
Section titled “Using the base currency”The baseCurrency is the currency all financial statements are reported in.
When you create a foreign-currency invoice, the exchangeRate you send
converts line amounts into this base currency. Read this field once when your
integration connects, and use it to validate currency choices.