> ## 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.

# Update invoice settings

> Update the sender details, defaults and branding.

Only the fields you send change, and `null` clears a field. See [Invoice settings](/docs/v2/invoices/creating-and-sending#invoice-settings).


## OpenAPI

````yaml /openapi-v2.json patch /v2/invoices/settings
openapi: 3.1.0
info:
  title: Slash Public API V2
  description: >-
    Send money for a Slash legal entity. Every request uses an API key. Transfer
    creation returns a Transfer that links its resulting transactions.
  version: 0.0.1
servers:
  - url: https://api.slash.com
    description: production
security:
  - api_key: []
paths:
  /v2/invoices/settings:
    parameters:
      - name: x-legal-entity
        in: header
        required: true
        description: >-
          The legal entity to act on. Required on every request; a user API key
          can act on any legal entity its user has access to.
        schema:
          type: string
          pattern: ^le_[a-zA-Z0-9]+$
    patch:
      summary: Update invoice settings
      description: >-
        Update the sender details, defaults and branding. Only the fields you
        send change, and `null` clears a field. See [Invoice
        settings](/docs/v2/invoices/creating-and-sending#invoice-settings).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/invoice-settings-update'
            example:
              defaultPaymentTermsDays: 30
              logoDocumentId: st_2rj4l7hmrrrcv
              branding:
                backgroundColor: '#1F2937'
                titleColor: '#FFFFFF'
      responses:
        '200':
          description: The updated invoice settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/invoice-settings'
        '400':
          $ref: '#/components/responses/PublicApiV2Error400InvoicesSettingsUpdate'
        '401':
          $ref: '#/components/responses/PublicApiV2Error401Unauthorized'
        '403':
          $ref: >-
            #/components/responses/PublicApiV2Error403FeatureNotEnabledForbiddenForbiddenLegalEntityNotAvailableUserApiKeyRequired
        '404':
          $ref: '#/components/responses/PublicApiV2Error404InvoicesSettingsUpdate'
        '429':
          $ref: '#/components/responses/PublicApiV2RateLimited'
        '500':
          $ref: '#/components/responses/PublicApiV2Error500Internal'
      security:
        - api_key: []
components:
  schemas:
    invoice-settings-update:
      title: InvoiceSettingsUpdate
      description: >-
        Partial update. An omitted field is left unchanged; `null` clears a
        clearable field. `address` and `branding` are replaced as a whole.
      type: object
      properties:
        companyName:
          type: string
          minLength: 1
          maxLength: 255
        email:
          type: string
          format: email
        address:
          $ref: '#/components/schemas/address'
        defaultMemo:
          type: string
          nullable: true
          minLength: 1
          maxLength: 500
        defaultPaymentTermsDays:
          type: integer
          nullable: true
          minimum: 0
          maximum: 365
        logoDocumentId:
          type: string
          nullable: true
          description: >-
            A document uploaded with purpose `invoice_logo`, with the `st_`
            prefix. `null` removes the logo.
        branding:
          type: object
          nullable: true
          properties:
            backgroundColor:
              type: string
              pattern: ^#[0-9A-Fa-f]{6}$
              example: '#1F2937'
            titleColor:
              type: string
              pattern: ^#[0-9A-Fa-f]{6}$
              example: '#FFFFFF'
          additionalProperties: false
      additionalProperties: false
    invoice-settings:
      title: InvoiceSettings
      description: >-
        What every invoice from the legal entity shows: who it's from, the
        defaults new invoices start with, and the logo and colors on the PDF and
        payment page.
      type: object
      properties:
        companyName:
          type: string
          description: Who invoices are from.
        email:
          type: string
          description: The reply-to address on invoice emails.
        address:
          $ref: '#/components/schemas/address'
        defaultMemo:
          type: string
          description: The memo the dashboard fills in on new invoices.
        defaultPaymentTermsDays:
          type: integer
          description: How many days after issue the dashboard makes new invoices due.
        logoDocumentId:
          type: string
          description: >-
            The logo, a [document](/api-reference/documents/retrieve) uploaded
            with purpose `invoice_logo`.
        branding:
          type: object
          properties:
            backgroundColor:
              type: string
              description: Six-digit hex color.
              example: '#1F2937'
            titleColor:
              type: string
              description: Six-digit hex color.
              example: '#FFFFFF'
        nextInvoiceNumber:
          type: string
          description: The number the next invoice gets when it doesn't name one.
          example: INV-1043
      required:
        - companyName
        - email
        - address
        - nextInvoiceNumber
    address:
      title: Address
      type: object
      properties:
        line1:
          type: string
          minLength: 1
        line2:
          type: string
        city:
          type: string
          minLength: 1
        state:
          type: string
        postalCode:
          type: string
        countryCode:
          type: string
          minLength: 2
          maxLength: 2
          description: ISO 3166-1 alpha-2 country code.
      required:
        - line1
        - city
      additionalProperties: false
    PublicApiV2ErrorDocumentPurposeMismatch:
      title: PublicApiV2ErrorDocumentPurposeMismatch
      description: The document was uploaded with a different `purpose`.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - document_purpose_mismatch
            details:
              type: object
              properties:
                expected:
                  type: string
                  description: The `purpose` this field takes.
                  example: bill_invoice
                purpose:
                  type: string
                  description: The document’s `purpose`.
                  example: accounting_receipt
                field:
                  type: string
                  description: Dot path of the request field at fault.
                id:
                  type: string
                  description: The identifier that field carried, when it is one.
              required:
                - expected
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorInvalidRequestShape:
      title: PublicApiV2ErrorInvalidRequestShape
      description: >-
        The body, query, or headers failed validation, or a required header is
        missing. `details` has one entry per failing location, keyed by JSON
        pointer or header name.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - invalid_request
            details:
              type: object
              properties: {}
              additionalProperties:
                type: string
          required:
            - code
            - details
    PublicApiV2ErrorUnauthorized:
      title: PublicApiV2ErrorUnauthorized
      description: API key authentication is missing or invalid.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - unauthorized
            details:
              type: object
              properties: {}
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorFeatureNotEnabled:
      title: PublicApiV2ErrorFeatureNotEnabled
      description: >-
        The feature this request uses is not enabled for the legal entity.
        Contact Slash support to enable it.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - feature_not_enabled
            details:
              type: object
              properties: {}
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorForbidden:
      title: PublicApiV2ErrorForbidden
      description: >-
        The credential is not permitted to perform this action on the resource.
        When the resource is a field of the request, `details` names that
        `field` and the `id` it received.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - forbidden
            details:
              type: object
              properties:
                field:
                  type: string
                  description: Dot path of the request field at fault.
                id:
                  type: string
                  description: The identifier that field carried, when it is one.
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorForbiddenLegalEntity:
      title: PublicApiV2ErrorForbiddenLegalEntity
      description: The credential is not permitted to act for the selected legal entity.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - forbidden
            details:
              type: object
              properties: {}
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorNotAvailable:
      title: PublicApiV2ErrorNotAvailable
      description: >-
        Public API v2 is not yet available. Use [Public API
        v1](https://docs.slash.com/introduction) in the meantime.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - not_available
            details:
              type: object
              properties: {}
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorUserApiKeyRequired:
      title: PublicApiV2ErrorUserApiKeyRequired
      description: >-
        The API key is scoped to a legal entity rather than a user. Every v2
        request needs a user API key, created under Settings → API keys in the
        Slash dashboard, together with the `x-legal-entity` header.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - user_api_key_required
            details:
              type: object
              properties: {}
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorNotFound:
      title: PublicApiV2ErrorNotFound
      description: >-
        No resource matches the identifier. When the identifier is a field of
        the request, `details` names that `field` and the `id` it received.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - not_found
            details:
              type: object
              properties:
                field:
                  type: string
                  description: Dot path of the request field at fault.
                id:
                  type: string
                  description: The identifier that field carried, when it is one.
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorInternal:
      title: PublicApiV2ErrorInternal
      description: >-
        Slash could not complete the request. Quote `referenceId` when
        contacting Slash support.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - internal
            details:
              type: object
              properties: {}
              additionalProperties: false
          required:
            - code
            - details
    Error:
      type: object
      properties:
        code:
          type: string
          description: >-
            Machine-readable reason; branch on this, not on `message`. Every
            code an endpoint can return is listed on its reference page; the
            ones shared by all endpoints are explained in the Errors guide.
          example: invalid_request
        message:
          type: string
          description: >-
            Human-readable explanation, safe to show to an operator. Wording may
            change; use `code` and `details` programmatically.
        details:
          type: object
          description: >-
            The values behind `message`, keyed per `code`. For example
            `insufficient_funds` carries `available` and `requested`;
            `invalid_request` from contract validation carries one entry per
            failing field, keyed by JSON pointer. Empty when the code has no
            variable data.
          additionalProperties:
            type: string
          example:
            available: $120.00
            requested: $500.00
        referenceId:
          type: string
          description: Unique id of this failure. Quote it when contacting Slash support.
          example: 4001-2alj5if
      required:
        - code
        - message
        - details
        - referenceId
      additionalProperties: false
      title: Error
  responses:
    PublicApiV2Error400InvoicesSettingsUpdate:
      description: >-
        - `document_purpose_mismatch` — The document was uploaded with a
        different `purpose`.

        - `invalid_request (request shape)` — The body, query, or headers failed
        validation, or a required header is missing. `details` has one entry per
        failing location, keyed by JSON pointer or header name.
      content:
        application/json:
          schema:
            anyOf:
              - title: document_purpose_mismatch
                allOf:
                  - $ref: >-
                      #/components/schemas/PublicApiV2ErrorDocumentPurposeMismatch
              - title: invalid_request (request shape)
                allOf:
                  - $ref: '#/components/schemas/PublicApiV2ErrorInvalidRequestShape'
          examples:
            document_purpose_mismatch_logo_document_id:
              summary: document_purpose_mismatch (logoDocumentId)
              value:
                code: document_purpose_mismatch
                message: >-
                  Only documents uploaded with purpose bill_invoice can be used
                  here.
                details:
                  expected: bill_invoice
                  purpose: accounting_receipt
                  field: logoDocumentId
                  id: st_2rj4l7hmrrrcv
                referenceId: 4001-2alj5if
            invalid_request_request_shape:
              summary: invalid_request (request shape)
              value:
                code: invalid_request
                message: >-
                  Invalid `logoDocumentId`: Expected a valid ID beginning with
                  "st_".
                details:
                  /logoDocumentId: Expected a valid ID beginning with "st_".
                referenceId: 4001-2alj5if
    PublicApiV2Error401Unauthorized:
      description: '- `unauthorized` — API key authentication is missing or invalid.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiV2ErrorUnauthorized'
          examples:
            unauthorized:
              summary: unauthorized
              value:
                code: unauthorized
                message: API key authentication is missing or invalid.
                details: {}
                referenceId: 4011-2alj5if
    PublicApiV2Error403FeatureNotEnabledForbiddenForbiddenLegalEntityNotAvailableUserApiKeyRequired:
      description: >-
        - `feature_not_enabled` — The feature this request uses is not enabled
        for the legal entity. Contact Slash support to enable it.

        - `forbidden` — The credential is not permitted to perform this action
        on the resource. When the resource is a field of the request, `details`
        names that `field` and the `id` it received.

        - `forbidden (legal entity)` — The credential is not permitted to act
        for the selected legal entity.

        - `not_available` — Public API v2 is not yet available. Use [Public API
        v1](https://docs.slash.com/introduction) in the meantime.

        - `user_api_key_required` — The API key is scoped to a legal entity
        rather than a user. Every v2 request needs a user API key, created under
        Settings → API keys in the Slash dashboard, together with the
        `x-legal-entity` header.
      content:
        application/json:
          schema:
            anyOf:
              - title: feature_not_enabled
                allOf:
                  - $ref: '#/components/schemas/PublicApiV2ErrorFeatureNotEnabled'
              - title: forbidden
                allOf:
                  - $ref: '#/components/schemas/PublicApiV2ErrorForbidden'
              - title: forbidden (legal entity)
                allOf:
                  - $ref: '#/components/schemas/PublicApiV2ErrorForbiddenLegalEntity'
              - title: not_available
                allOf:
                  - $ref: '#/components/schemas/PublicApiV2ErrorNotAvailable'
              - title: user_api_key_required
                allOf:
                  - $ref: '#/components/schemas/PublicApiV2ErrorUserApiKeyRequired'
          examples:
            feature_not_enabled:
              summary: feature_not_enabled
              value:
                code: feature_not_enabled
                message: >-
                  This feature is not enabled for you. Please contact support to
                  get it.
                details: {}
                referenceId: 4031-2alj5if
            forbidden:
              summary: forbidden
              value:
                code: forbidden
                message: This credential is not permitted to do that.
                details: {}
                referenceId: 4031-2alj5if
            forbidden_legal_entity:
              summary: forbidden (legal entity)
              value:
                code: forbidden
                message: This credential is not permitted to do that.
                details: {}
                referenceId: 4031-2alj5if
            not_available:
              summary: not_available
              value:
                code: not_available
                message: >-
                  Public API v2 is not yet available. Use Public API v1
                  (https://docs.slash.com/introduction) in the meantime.
                details: {}
                referenceId: 4031-2alj5if
            user_api_key_required:
              summary: user_api_key_required
              value:
                code: user_api_key_required
                message: >-
                  Public API v2 requires a user API key. Create one under
                  Settings → API keys in the Slash dashboard.
                details: {}
                referenceId: 4031-2alj5if
    PublicApiV2Error404InvoicesSettingsUpdate:
      description: >-
        - `not_found` — No resource matches the identifier. When the identifier
        is a field of the request, `details` names that `field` and the `id` it
        received.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiV2ErrorNotFound'
          examples:
            not_found_logo_document_id:
              summary: not_found (logoDocumentId)
              value:
                code: not_found
                message: '`logoDocumentId` st_2rj4l7hmrrrcv was not found.'
                details:
                  field: logoDocumentId
                  id: st_2rj4l7hmrrrcv
                referenceId: 4041-2alj5if
    PublicApiV2RateLimited:
      description: >-
        The request exceeded the applicable rate limit. The response body is
        plain text, not the error object; clients must not depend on its
        wording.
      content:
        text/plain:
          schema:
            type: string
          example: You are rate limited
    PublicApiV2Error500Internal:
      description: >-
        - `internal` — Slash could not complete the request. Quote `referenceId`
        when contacting Slash support.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiV2ErrorInternal'
          examples:
            internal:
              summary: internal
              value:
                code: internal
                message: >-
                  An unexpected error occurred. If this keeps happening, contact
                  Slash support with the reference id below.
                details: {}
                referenceId: 5001-2alj5if
  securitySchemes:
    api_key:
      type: apiKey
      name: X-API-Key
      in: header
      description: >-
        User API key authentication. Create a key under Settings → API keys in
        the Slash dashboard (https://app.slash.com/global-settings/api-keys) and
        send the `x-legal-entity` header naming the legal entity to act on with
        every request. Keys scoped to a legal entity are rejected with `403
        user_api_key_required`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.