> ## Documentation Index
> Fetch the complete documentation index at: https://docs.envoi.no/llms.txt
> Use this file to discover all available pages before exploring further.

# List accounts

> The account's chart of accounts: the NS 4102 standard accounts and any accounts the company added
itself (`isCustom`). Not paged.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/accounts
openapi: 3.0.4
info:
  title: Envoi API
  description: >-
    The Envoi API lets your own systems work with an Envoi account: create and
    send invoices, record payments,

    keep the customer register in step, and read the books. An online store such
    as Nordvik Handel AS can, for example,

    create an invoice in Envoi for every B2B order from its web shop and mark it
    paid when the money arrives.


    **Base URL.** `https://api.envoi.no`. Every path starts with `/v1`.


    **Authentication.** An Owner or Admin creates an API client in Envoi under
    *Settings → API clients* (in the app: *Innstillinger → API-klienter*) and

    gets a Client ID and a client secret (shown once). Exchange them for an
    access token at `POST /v1/oauth/token`

    (OAuth 2.0 client credentials) and send it as `Authorization: Bearer
    {access_token}`. A token lives 15 minutes;

    ask for a new one when it expires. Every request is checked against Envoi's
    database, not only the token:

    deleting the client, rotating its secret or removing a scope takes effect on
    the next request.


    **Accounts and environments.** A token acts on one account, named by its
    Account ID in the token request's

    `audience`: `P11112001` is the production account, `T11112001` its test
    environment. Nothing done

    in the test environment reaches a real customer: emails are captured, not
    delivered. An id from another account, or

    from the other environment, is `404 not-found`, never `403`.


    **Scopes.** Each endpoint needs one scope, such as `invoices:read`. Levels
    nest: `admin` includes `write`,

    `write` includes `read`. A request without the scope is `403
    insufficient_scope`.


    **Errors.** Every error is JSON: `{ "code": "...", "message": "..." }`,
    sometimes with `details`, and with

    `errors` (one entry per field) on `400 validation-failed`. Branch on `code`;
    the message is for developers

    and may change. The token endpoint uses the OAuth shape `{ "error": "..." }`
    instead.


    **Idempotency.** Every POST needs an `Idempotency-Key` header. A retry with
    the same key and the same request

    gets the first answer again instead of creating a second invoice or payment.


    **Paging.** Lists take `page` (from 1) and `pageSize` (1 to 100) and answer

    `{ "items": [...], "page": 1, "pageSize": 20, "totalCount": 57, "hasMore":
    true }`.


    **Values.** JSON in camelCase. Dates are `yyyy-MM-dd`; timestamps ISO 8601
    in UTC. Money is in kroner as a

    decimal number; `currency` is always `NOK` in v1. VAT codes are the SAF-T
    standard codes (for sales:

    `3` = 25 %, `31` = 15 %, `33` = 12 %, `5` = exempt, `6` = outside the VAT
    Act, `7` = no VAT treatment, `52` = export).


    **Rate limits.** Each API client may send 600 requests a minute; the token
    endpoint allows 60 requests a minute

    per IP address and 30 per Client ID. Above that the answer is `429` with a
    `Retry-After` header.
  version: v1
servers:
  - url: https://api.envoi.no
    description: >-
      Production and test environment (the token's audience picks the
      environment)
security: []
tags:
  - name: Authentication
    description: >-
      Get an access token with the OAuth 2.0 client credentials grant, and see
      which API client and account a token belongs to.
  - name: Invoices
    description: >-
      Create draft invoices, send them, record payments, and read invoices. The
      same rules as in the Envoi app.
  - name: Clients
    description: The account's customer register.
  - name: Accounting
    description: >-
      Read-only views of the built-in books: the chart of accounts and journal
      entries. Only when Envoi's built-in accounting is turned on for the
      account.
paths:
  /v1/accounts:
    get:
      tags:
        - Accounting
      summary: List accounts
      description: >-
        The account's chart of accounts: the NS 4102 standard accounts and any
        accounts the company added

        itself (`isCustom`). Not paged.
      operationId: listAccounts
      responses:
        '200':
          description: Every account in the chart.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountList'
              example:
                items:
                  - number: '1500'
                    name: Kundefordringer
                    class: 1
                    type: Asset
                    nature: Debit
                    acceptsVat: false
                    defaultVatCode: null
                    isCustom: false
                  - number: '1920'
                    name: Bankinnskudd
                    class: 1
                    type: Asset
                    nature: Debit
                    acceptsVat: false
                    defaultVatCode: null
                    isCustom: false
                  - number: '3000'
                    name: Salgsinntekt handelsvarer, avgiftspliktig, høy sats
                    class: 3
                    type: Income
                    nature: Credit
                    acceptsVat: true
                    defaultVatCode: '3'
                    isCustom: false
        '401':
          description: >-
            - `unauthorized`: no token, an invalid or expired one, or a token
            the per-request check refuses (the client or its grant was deleted,
            the secret was rotated, or the account is being closed). Header
            `WWW-Authenticate: Bearer error="invalid_token"`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                unauthorized:
                  summary: unauthorized
                  value:
                    code: unauthorized
                    message: A valid API client access token is required.
        '403':
          description: >-
            - `insufficient_scope`: the grant does not hold `bilag:read` (or a
            higher level of it).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                insufficient_scope:
                  summary: insufficient_scope
                  value:
                    code: insufficient_scope
                    message: This API client needs bilag:read.
        '409':
          description: >-
            - `accounting-not-enabled`: Envoi's built-in accounting is not
            turned on for this account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                accounting-not-enabled:
                  summary: accounting-not-enabled
                  value:
                    code: accounting-not-enabled
                    message: Accounting is not enabled for this account.
        '429':
          description: >-
            - `rate_limited`: this API client sent too many requests. Wait the
            number of seconds in `Retry-After`.
          headers:
            Retry-After:
              description: Seconds to wait before the next request.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                rate_limited:
                  summary: rate_limited
                  value:
                    code: rate_limited
                    message: Too many requests; try again later.
        '500':
          description: >-
            - `server-error`: something unexpected went wrong. The message never
            contains details. On a POST the `Idempotency-Key` is released, so
            retrying with the same key is safe.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                server-error:
                  summary: server-error
                  value:
                    code: server-error
                    message: >-
                      The request could not be completed. It is safe to retry
                      with the same Idempotency-Key.
      security:
        - oauth2:
            - bilag:read
        - bearerAuth: []
components:
  schemas:
    AccountList:
      required:
        - items
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Account'
          description: Every item.
      description: A list that is not paged.
    Error:
      required:
        - code
        - message
      type: object
      properties:
        code:
          type: string
          description: >-
            A stable, machine-readable code, for example `not-found` or
            `insufficient_scope`. Branch on this, never on the message.
        message:
          type: string
          description: >-
            A short English sentence for a developer. Never contains customer
            data and may change.
        details:
          type: object
          additionalProperties: {}
          description: >-
            Extra facts for some codes, for example `existingId` on
            `client-exists`, `outstanding` on `payment-exceeds-outstanding`,
            `maxMonths` on `period-too-long`. Absent otherwise.
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
          description: >-
            Present only on `validation-failed`: one entry per field that
            failed.
          nullable: true
      description: The error body of every `/v1` endpoint except the token endpoint.
    Account:
      required:
        - acceptsVat
        - class
        - isCustom
        - name
        - nature
        - number
        - type
      type: object
      properties:
        number:
          type: string
          description: The account number, for example `1920`.
        name:
          type: string
          description: The account's name.
        class:
          type: integer
          description: 'The account class: the number''s first digit.'
          format: int32
        type:
          type: string
          description: '`Asset`, `Liability`, `Equity`, `Income` or `Expense`.'
        nature:
          type: string
          description: '`Debit` or `Credit`: the side the account''s balance normally is on.'
        acceptsVat:
          type: boolean
          description: True when postings to the account can carry a VAT code.
        defaultVatCode:
          type: string
          description: The account's default VAT code, or null.
          nullable: true
        isCustom:
          type: boolean
          description: True for an account the company added itself.
      description: An account in the chart of accounts.
    FieldError:
      required:
        - code
        - field
      type: object
      properties:
        field:
          type: string
          description: >-
            The field's path in the request, for example `dueDate` or
            `lines[0].quantity`.
        code:
          type: string
          description: A stable kebab-case code, for example `required` or `greater-than`.
      description: A field that failed validation.
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        OAuth 2.0 client credentials. The token request also needs the
        `audience` form field (the Account ID), which OAuth tooling does not
        always send; see `POST /v1/oauth/token`.
      flows:
        clientCredentials:
          tokenUrl: https://api.envoi.no/v1/oauth/token
          scopes:
            bilag:read: >-
              Read access to the books (the chart of accounts and journal
              entries).
            bilag:write: >-
              Write access to the books (the chart of accounts and journal
              entries). Includes bilag:read.
            clients:admin: Admin access to clients. Includes clients:write and clients:read.
            clients:read: Read access to clients.
            clients:write: Write access to clients. Includes clients:read.
            invoices:admin: >-
              Admin access to invoices. Includes invoices:write and
              invoices:read.
            invoices:read: Read access to invoices.
            invoices:write: Write access to invoices. Includes invoices:read.
    bearerAuth:
      type: http
      description: >-
        The `access_token` from `POST /v1/oauth/token`, as `Authorization:
        Bearer {access_token}`. It lives 15 minutes.
      scheme: bearer
      bearerFormat: JWT

````