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

# Get invoice settings

> Get the current invoice display settings for your legal entity.



## OpenAPI

````yaml get /invoice/settings
openapi: 3.1.0
info:
  title: Slash Public API
  description: API description
  version: 0.0.1
  contact: {}
servers:
  - url: https://api.slash.com
    description: production
security:
  - api_key: []
  - partner_api_key: []
  - bearer: []
  - developer_application: []
paths:
  /invoice/settings:
    get:
      description: Get the current invoice display settings for your legal entity.
      parameters:
        - name: filter:legalEntityId
          description: >-
            The legal entity ID. Required if authenticating with access to
            multiple legal entities.
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  invoiceSettings:
                    $ref: >-
                      #/components/schemas/slashfi.models.entity.Invoice.InvoiceSettings.yaml
                    x-entrypoint:
                      virtualPath: entity/Invoice/InvoiceSettings
                      sourcePath: entity/Invoice/InvoiceSettings.yaml
                      title: InvoiceSettings
                      origin: >-
                        /home/packages/api-specs/server-api-v2/node_modules/@slashfi/models/schemas
                      globalImport: true
                      typescript:
                        importPath: import  * as models from '@slashfi/models';
                        symbolValue: models.entity.Invoice.InvoiceSettings
                        typeValue: models.entity.Invoice.InvoiceSettings
                required:
                  - invoiceSettings
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: TooManyRequests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - api_key: []
        - bearer: []
components:
  schemas:
    slashfi.models.entity.Invoice.InvoiceSettings.yaml:
      type: object
      description: Full invoice settings entity for a legal entity, including metadata.
      properties:
        $entity:
          type: string
          enum:
            - invoice_settings
        id:
          type: string
        legalEntityId:
          type: string
        settings:
          $ref: >-
            #/components/schemas/slashfi.models.entity.Invoice.InvoiceSettingsData.yaml
          x-entrypoint:
            virtualPath: entity/Invoice/InvoiceSettingsData
            sourcePath: entity/Invoice/InvoiceSettingsData.yaml
            title: InvoiceSettingsData
            origin: >-
              /home/packages/api-specs/server-api-v2/node_modules/@slashfi/models/schemas
            globalImport: true
        timestamp:
          type: string
          format: date-time
      required:
        - $entity
        - id
        - legalEntityId
        - settings
        - timestamp
      x-entrypoint:
        virtualPath: entity/Invoice/InvoiceSettings
        sourcePath: entity/Invoice/InvoiceSettings.yaml
        title: InvoiceSettings
        origin: >-
          /home/packages/api-specs/server-api-v2/node_modules/@slashfi/models/schemas
        globalImport: true
      title: InvoiceSettings
    Error:
      type: object
      properties:
        message:
          type: string
        name:
          type: string
        identifier:
          type: string
        rawStatus:
          type: number
        meta:
          type: object
          additionalProperties: true
      required:
        - message
        - name
        - identifier
        - rawStatus
      x-entrypoint:
        origin: ./src/publicApi
        sourcePath: ./src/publicApi/main.yaml
        title: Error
        virtualPath: components/Error
      title: Error
    slashfi.models.entity.Invoice.InvoiceSettingsData.yaml:
      type: object
      description: Invoice display settings for a legal entity.
      properties:
        companyName:
          type: string
          description: The company name to display on invoices.
          minLength: 1
        email:
          type: string
          format: email
          description: The email address to display on invoices.
          minLength: 1
        address:
          $ref: '#/components/schemas/slashfi.models.entity.IAddressModel.yaml'
          description: The company address to display on invoices.
          x-entrypoint:
            virtualPath: entity/IAddressModel
            sourcePath: entity/IAddressModel.yaml
            title: IAddressModel
            origin: >-
              /home/packages/api-specs/server-api-v2/node_modules/@slashfi/models/schemas
            globalImport: true
        defaultMemo:
          type: string
          description: Default memo text to pre-fill when creating new invoices.
          maxLength: 500
        invoiceTerms:
          type: string
          description: >-
            Terms text to display on invoices. Only shown when
            INVOICE_TERMS_MAR_2026 feature flag is enabled.
          maxLength: 2000
        defaultPaymentTermsDays:
          type: integer
          description: >-
            Default payment terms in days (Net N). Used to auto-calculate due
            date from issue date when creating invoices.
          minimum: 0
        logoDocumentId:
          type: string
          description: Document ID of the company logo to display on invoices.
        unitPriceDecimalPlaces:
          type: integer
          description: >-
            Number of decimal places allowed for unit prices (in dollars).
            Defaults to 2 if not set.
          minimum: 2
          maximum: 6
        branding:
          type: object
          description: >-
            Custom branding settings for invoice styling. Extensible for future
            branding options.
          properties:
            backgroundColor:
              type: string
              description: >-
                Hex color code for header background and accent elements (e.g.,
                pay button).
              pattern: ^#[0-9A-Fa-f]{6}$
            titleColor:
              type: string
              description: Hex color code for title text, amounts, and section headings.
              pattern: ^#[0-9A-Fa-f]{6}$
      required:
        - companyName
        - email
        - address
      x-entrypoint:
        virtualPath: entity/Invoice/InvoiceSettingsData
        sourcePath: entity/Invoice/InvoiceSettingsData.yaml
        title: InvoiceSettingsData
        origin: >-
          /home/packages/api-specs/server-api-v2/node_modules/@slashfi/models/schemas
        globalImport: true
      title: InvoiceSettingsData
    slashfi.models.entity.IAddressModel.yaml:
      title: IAddressModel
      type: object
      properties:
        addressLine:
          type: string
        addressLine2:
          type: string
        addressCity:
          type: string
        addressState:
          type: string
        addressZip:
          type: string
        addressCountry:
          type: string
          minLength: 2
          maxLength: 2
          description: ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
      required:
        - addressLine
        - addressCity
        - addressState
        - addressZip
      x-entrypoint:
        virtualPath: entity/IAddressModel
        sourcePath: entity/IAddressModel.yaml
        title: IAddressModel
        origin: >-
          /home/packages/api-specs/server-api-v2/node_modules/@slashfi/models/schemas
        globalImport: true
  securitySchemes:
    api_key:
      type: apiKey
      description: |
        API key authentication for public API requests.

        Keys come in two flavors:

        - *Legal-entity-scoped keys* are pinned to a single legal entity.
          Minted via the dashboard under a specific entity; every request
          acts on that entity.
        - *User-scoped keys* are pinned to a user and span every legal
          entity that user has access to. Every request made with a
          user-scoped key (except `GET /legal-entity`, which lists the
          legal entities the user can access) must include an
          `x-legal-entity` header naming the legal entity the request is
          operating on. Requests without the header are rejected with
          `400`. The authenticated user must have an active permission
          role on the supplied legal entity, otherwise the request is
          rejected with `403`.
      name: X-API-Key
      in: header
    partner_api_key:
      type: apiKey
      description: |
        Partner-program API key authentication.

        Keys are minted in the partner dashboard (Developers → API Keys),
        are scoped to a single partner program, and are prefixed with
        `sk_partner_`. Partner keys are only accepted by routes that
        declare this scheme; they are rejected by `api_key` routes and
        vice versa.
      name: X-API-Key
      in: header
    bearer:
      type: http
      scheme: bearer
    developer_application:
      type: http
      scheme: basic

````