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

# Get AR settings

> Retrieve the Client's accounts-receivable settings (applied to every organisation under the client) — currently the AR-email kill switch. Readable by any signed-in portal user with client OR organisation context (org-scoped callers resolve their owning client); not available to API keys. Only Client admins may change the values via PATCH.

**Authentication.** A JWT Bearer token. API keys are not accepted.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/settings/ar
openapi: 3.1.1
info:
  title: Dolfin API
  description: >-
    Dolfin API for AR & AP. Each operation documents its accepted credentials
    under **Authentication** — typically an `x-dolfin-api-key` header (with
    `x-dolfin-organisation-id`) or a JWT Bearer token.
  version: v1
servers:
  - url: https://api.dolfinai.co
    description: Production
security: []
tags:
  - name: Users
  - name: TaxRates
  - name: Suppliers
  - name: Supplier Credit Notes
  - name: Bills
  - name: Payables
  - name: RecurringInvoices
  - name: Receivables
  - name: Purchase Orders
  - name: Products
  - name: Payments
  - name: Invoices
  - name: Organisations
  - name: Clients
  - name: MCP
  - name: Matching
  - name: Invoice Reminders
  - name: Industries
  - name: Gmail
  - name: Delivery Notes
  - name: Customers
  - name: Currencies
  - name: Credit Notes
  - name: Companies
  - name: BankPayments
  - name: Bank details
  - name: Auth
  - name: ApprovalPolicies
  - name: Agent
paths:
  /v1/settings/ar:
    get:
      tags:
        - Clients
      summary: Get AR settings
      description: >-
        Retrieve the Client's accounts-receivable settings (applied to every
        organisation under the client) — currently the AR-email kill switch.
        Readable by any signed-in portal user with client OR organisation
        context (org-scoped callers resolve their owning client); not available
        to API keys. Only Client admins may change the values via PATCH.


        **Authentication.** A JWT Bearer token. API keys are not accepted.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArSettingsResponse'
        '403':
          description: >-
            Module.NotEntitled — the client's plan does not include the module
            this endpoint requires
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
        - Bearer: []
components:
  schemas:
    ArSettingsResponse:
      required:
        - arEmailsEnabled
        - integratedPaymentsEnabled
      type: object
      properties:
        arEmailsEnabled:
          type: boolean
          description: >-
            Client-level kill switch for outbound AR (invoice) emails. When
            false, sending an invoice still marks it Sent, but no customer email
            is dispatched and no reminders are scheduled — the client handles
            delivery out-of-band. Default true.
        integratedPaymentsEnabled:
          type: boolean
          description: >-
            Whether this client uses integrated Dolfin/Stripe payments. When
            true (default), invoices carry a Dolfin-generated payment link. When
            false, the client brings its own payment link (see
            defaultPaymentLinkUrl).
        defaultPaymentLinkUrl:
          type:
            - 'null'
            - string
          description: >-
            Bring-your-own payment link template, used only when integrated
            payments are off. Supports the tokens {invoiceId}, {organisationId}
            and {invoiceNumber}, expanded per invoice. Null when not set.
        supportedPaymentLinkTokens:
          type: array
          items:
            type: string
          description: The template tokens supported in defaultPaymentLinkUrl.
    ProblemDetails:
      type: object
      properties:
        type:
          type:
            - 'null'
            - string
        title:
          type:
            - 'null'
            - string
        status:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - 'null'
            - integer
            - string
          format: int32
        detail:
          type:
            - 'null'
            - string
        instance:
          type:
            - 'null'
            - string
  securitySchemes:
    Bearer:
      type: http
      description: >-
        A session JWT obtained via the OAuth flow (`POST /auth/codes` → `POST
        /auth/exchange`). Its claims carry the caller's organisation and/or
        client scope.
      scheme: bearer
      bearerFormat: JWT

````