Företaget

Företaget som nyckeln eller appen gäller.

Hämta företaget

GET /company getCompany

Företaget som nyckeln eller token är bunden till, och vilken nyckel eller app det är. Kräver ingen särskild behörighet.

Mer i detalj (på engelska)

The company the credential is bound to, plus what the credential is (type, name, effective scopes on the credential). Needs no scope: every valid token or API key can read it. Use it to confirm which company a token belongs to.

Behörighet

Ingen särskild behörighet, bara en giltig nyckel eller token.

Svar

200 OK – The company.

application/jsonobject

data CompanyWithCredential krävs
16 fält
- id integer
- name string
- legal_name string kan vara null
- org_number string kan vara null
- legal_form string kan vara null
  
  Värden: AB, EF, HB, KB, EK_FORENING, IDEELL_FORENING, STIFTELSE
- vat_number string kan vara null
- vat_registered boolean
- vat_period string
  
  Värden: MONTHLY, QUARTERLY, YEARLY, NONE
- accounting_method string
  
  Värden: FAKTURAMETODEN, KONTANTMETODEN
- reporting_framework string
  
  Värden: K1, K2, K3
- fiscal_year_start_month integer
  
  minst 1 · högst 12
- base_currency string
- locked_until_date string (date) kan vara null
  
  Postings on or before this date are refused.
- archived boolean
  
  An archived company is read-only.
- address object
  5 fält
  - line1 string kan vara null
  - line2 string kan vara null
  - postal_code string kan vara null
  - city string kan vara null
  - country string kan vara null
    
    ISO 3166-1 alpha-2.
- credential Credential
  3 fält
  - type string
    
    Värden: oauth, api_key
  - name string
    
    App name or API key name.
  - scopes array<string>

Svarshuvuden: X-Request-Id, RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset

401 Unauthorized – Missing, invalid, expired or revoked token or API key. Also returned when the person behind the credential has left the company (an OAuth grant is then revoked for good).

Alla felkoder · application/problem+json

unauthenticatedNo valid credential

Nyckeln eller token saknas, är ogiltig, har gått ut eller har återkallats.

Svarshuvuden: X-Request-Id, RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, WWW-Authenticate

403 Forbidden – The credential may not do this: a scope is missing, the granting person no longer has the permission, the address is not allowed, the company is archived (read-only) or no longer allows the app.

Alla felkoder · application/problem+json

insufficient_scopeScope missing or permission lost

Nyckeln eller appen saknar behörigheten vouchers:post, eller så har personen som gav den inte längre den behörigheten i företaget.
forbiddenThe action refuses (for example changing a posted voucher)

Behörighet saknas för det här.
ip_not_allowedOutside the IP allowlist

Företaget tillåter inte anrop från den här adressen.
company_archivedWrite to an archived company

Företaget är arkiverat och kan bara läsas.
app_not_allowedThe company no longer allows the app

Företaget tillåter inte längre den här appen.

Svarshuvuden: X-Request-Id, RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset

404 Not Found – Not found. Also the answer for another company's ids (existence is never revealed) and for every call while NONOX Connect is turned off for the company.

Alla felkoder · application/problem+json

not_foundUnknown id, other company's id, or module off

Det du söker finns inte.

Svarshuvuden: X-Request-Id, RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset

429 Too Many Requests – Rate limit exceeded (per credential, per company or per address). Wait Retry-After seconds.

Alla felkoder · application/problem+json

rate_limitedOver the limit

För många anrop. Försök igen om 23 sekunder.

Svarshuvuden: X-Request-Id, RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, Retry-After

Kodexempel

curl

curl "https://nonox.app/api/v1/company" \
  -H "Authorization: Bearer $NONOX_TOKEN" \
  -H "Accept: application/json"

PHP (Laravel)

use Illuminate\Support\Facades\Http;

$response = Http::withToken(config('services.nonox.token'))
    ->acceptJson()
    ->get('https://nonox.app/api/v1/company');

$response->throw();

$data = $response->json('data');

PHP (Guzzle)

$client = new \GuzzleHttp\Client(['timeout' => 30]);

$response = $client->request('GET', 'https://nonox.app/api/v1/company', [
    'headers' => [
        'Authorization' => 'Bearer '.getenv('NONOX_TOKEN'),
        'Accept' => 'application/json',
    ],
]);

$data = json_decode((string) $response->getBody(), true, flags: JSON_THROW_ON_ERROR)['data'];

JavaScript

const response = await fetch('https://nonox.app/api/v1/company', {
  headers: {
    Authorization: `Bearer ${process.env.NONOX_TOKEN}`,
    Accept: 'application/json',
  },
});

if (!response.ok) {
  const problem = await response.json();
  throw new Error(`${problem.code}: ${problem.detail}`);
}

const { data } = await response.json();

Python

import os
import requests

response = requests.get(
    "https://nonox.app/api/v1/company",
    headers={
        "Authorization": f"Bearer {os.environ['NONOX_TOKEN']}",
        "Accept": "application/json",
    },
    timeout=30,
)
response.raise_for_status()

data = response.json()["data"]

Svar · 200

application/json

{
  "data": {
    "id": 42,
    "name": "Exempelbolaget AB",
    "legal_name": "Exempelbolaget AB",
    "org_number": "556677-1233",
    "legal_form": "AB",
    "vat_number": "SE556677123301",
    "vat_registered": true,
    "vat_period": "QUARTERLY",
    "accounting_method": "FAKTURAMETODEN",
    "reporting_framework": "K2",
    "fiscal_year_start_month": 1,
    "base_currency": "SEK",
    "locked_until_date": "2026-06-30",
    "archived": false,
    "address": {
      "line1": "Exempelgatan 1",
      "line2": null,
      "postal_code": "111 22",
      "city": "Exempelstad",
      "country": "SE"
    },
    "credential": {
      "type": "oauth",
      "name": "Exempelappen",
      "scopes": [
        "vouchers:view",
        "vouchers:create",
        "vouchers:post"
      ]
    }
  }
}

Fel

4011 exempel

No valid credential

{
  "type": "urn:nonox:problem:unauthenticated",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthenticated",
  "detail": "Nyckeln eller token saknas, är ogiltig, har gått ut eller har återkallats.",
  "instance": "urn:nonox:request:7f3c2a9e-4b1d-4c8e-9a51-2d6f0e8b3c17"
}

4035 exempel

Scope missing or permission lost

{
  "type": "urn:nonox:problem:insufficient_scope",
  "title": "Forbidden",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "Nyckeln eller appen saknar behörigheten vouchers:post, eller så har personen som gav den inte längre den behörigheten i företaget.",
  "instance": "urn:nonox:request:7f3c2a9e-4b1d-4c8e-9a51-2d6f0e8b3c17",
  "required_scopes": [
    "vouchers:post"
  ]
}

The action refuses (for example changing a posted voucher)

{
  "type": "urn:nonox:problem:forbidden",
  "title": "Forbidden",
  "status": 403,
  "code": "forbidden",
  "detail": "Behörighet saknas för det här.",
  "instance": "urn:nonox:request:7f3c2a9e-4b1d-4c8e-9a51-2d6f0e8b3c17"
}

Outside the IP allowlist

{
  "type": "urn:nonox:problem:ip_not_allowed",
  "title": "Forbidden",
  "status": 403,
  "code": "ip_not_allowed",
  "detail": "Företaget tillåter inte anrop från den här adressen.",
  "instance": "urn:nonox:request:7f3c2a9e-4b1d-4c8e-9a51-2d6f0e8b3c17"
}

Write to an archived company

{
  "type": "urn:nonox:problem:company_archived",
  "title": "Forbidden",
  "status": 403,
  "code": "company_archived",
  "detail": "Företaget är arkiverat och kan bara läsas.",
  "instance": "urn:nonox:request:7f3c2a9e-4b1d-4c8e-9a51-2d6f0e8b3c17"
}

The company no longer allows the app

{
  "type": "urn:nonox:problem:app_not_allowed",
  "title": "Forbidden",
  "status": 403,
  "code": "app_not_allowed",
  "detail": "Företaget tillåter inte längre den här appen.",
  "instance": "urn:nonox:request:7f3c2a9e-4b1d-4c8e-9a51-2d6f0e8b3c17"
}

4041 exempel

Unknown id, other company's id, or module off

{
  "type": "urn:nonox:problem:not_found",
  "title": "Not Found",
  "status": 404,
  "code": "not_found",
  "detail": "Det du söker finns inte.",
  "instance": "urn:nonox:request:7f3c2a9e-4b1d-4c8e-9a51-2d6f0e8b3c17"
}

4291 exempel

Over the limit

{
  "type": "urn:nonox:problem:rate_limited",
  "title": "Too Many Requests",
  "status": 429,
  "code": "rate_limited",
  "detail": "För många anrop. Försök igen om 23 sekunder.",
  "instance": "urn:nonox:request:7f3c2a9e-4b1d-4c8e-9a51-2d6f0e8b3c17"
}