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

# Search vacation pay settings



## OpenAPI

````yaml /spec/openapi.json post /vacation_pay_settings/search
openapi: 3.0.0
info:
  title: Nmbr API
  description: API to interact with Nmbr Payroll
  version: 1.0.0
servers:
  - url: https://sandbox.nmbr.co/services/payroll
security:
  - CompanyToken: []
tags:
  - name: Accounting Codes
  - name: Accounting Code Rules
  - name: Adjustments
  - name: Allowances
  - name: Allowance Line Items
  - name: Allowance Types
  - name: Async Tasks
  - name: Bank Accounts
  - name: Business Entities
  - name: Business Entity Verifications
  - name: Business Entity ROE Authorizations
  - name: Business Presets
  - name: Calculations
  - name: Companies
  - name: Contractors
  - name: Deductions
  - name: Deduction Line Items
  - name: Deduction Types
  - name: Earnings
  - name: Earning Line Items
  - name: Earning Types
  - name: Effective Tax Properties
  - name: Employees
  - name: Employee Benefits
  - name: Employee Benefit Line Items
  - name: Employee Benefit Types
  - name: Employer Benefits
  - name: Employer Benefit Line Items
  - name: Employer Benefit Types
  - name: Employer Statutory Withholding Line Items
  - name: Employer Statutory Withholding Types
  - name: Forms
  - name: Form Batches
  - name: Form Types
  - name: Holidays
  - name: Integrations
  - name: Journal Entries
  - name: Overtime Rates
  - name: Partners
  - name: Pay Rates
  - name: Pay Schedules
  - name: Pay Splits
  - name: Pay Stubs
  - name: Payments
  - name: Payrolls
  - name: Reimbursements
  - name: Reimbursement Line Items
  - name: Reimbursement Types
  - name: Remittance Accounts
  - name: Remittance Account Enrollments
  - name: Remittance Totals
  - name: Reports
  - name: ROE SAT Agreements
  - name: Statutory Withholding Line Items
  - name: Statutory Withholding Types
  - name: Tags
  - name: Tag Groups
  - name: Tax Properties
  - name: Tax Property Templates
  - name: Tokens
  - name: Usage Records
  - name: Usage Summaries
  - name: Vacation Pay
  - name: Vacation Pay Settings
  - name: Webhooks
  - name: Work Assignments
paths:
  /vacation_pay_settings/search:
    post:
      tags:
        - Vacation Pay Settings
      summary: Search vacation pay settings
      operationId: vacation-pay-settings-search
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    description: The type of the object in Nmbr (`"list"`).
                    readOnly: true
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: The unique identifier of the object in Nmbr.
                          readOnly: true
                        object:
                          type: string
                          description: >-
                            The type of the object in Nmbr
                            (`"vacation_pay_setting"`).
                          readOnly: true
                        data:
                          $ref: '#/components/schemas/VacationPaySetting'
              example:
                object: list
                data:
                  - id: <id>
                    object: vacation_pay_setting
                    data:
                      percentage: 4
                      vacation_pay_method: manual
                      effective_from: '2026-01-01'
                      effective_to: null
                      earliest_valid_effective_to: '2026-01-01'
                      is_editable: true
                      is_deletable: true
                      work_assignment:
                        id: <id>
                        object: work_assignment
                        links:
                          self: /work_assignments/<id>
                      business_preset: null
                      note: null
                      created_at: '2026-01-01T00:00:00.000000Z'
                      updated_at: '2026-01-01T00:00:00.000000Z'
                    links:
                      self: /vacation_pay_settings/<id>
                links:
                  first: http://localhost/vacation_pay_settings/search?page=1
                  last: http://localhost/vacation_pay_settings/search?page=1
                  prev: null
                  next: null
                meta:
                  current_page: 1
                  last_page: 1
                  per_page: 15
                  total: 1
                  has_more: false
components:
  schemas:
    VacationPaySetting:
      type: object
      title: Vacation Pay Setting
      properties:
        percentage:
          type: number
          format: decimal
        vacation_pay_method:
          type: string
          enum:
            - manual
            - per_period
        effective_from:
          type: string
          format: date
        effective_to:
          type: string
          nullable: true
          format: date
        earliest_valid_effective_to:
          type: string
          nullable: true
          format: date
        is_editable:
          type: boolean
          description: >-
            When false, only the `effective_to`, `business_preset_id`, and
            `note` attributes may be updated.
        is_deletable:
          type: boolean
        work_assignment:
          type: object
          properties:
            id:
              type: string
              description: The unique identifier of the object in Nmbr.
              readOnly: true
            object:
              type: string
              description: The type of the object in Nmbr (`"work_assignment"`).
              readOnly: true
        business_preset:
          description: >-
            The Business Preset the generated vacation payout line item is
            created from. The payout carries the preset's title and accounting
            codes, and accounting code rules that target the preset apply to it.
            When the preset sets no title, the payout keeps its default
            "Vacation Pay Out" title. `null` when the setting names no preset.
        note:
          type: string
          nullable: true
        created_at:
          type: string
          description: The date and time the object was created in Nmbr.
          readOnly: true
          format: dateTime
        updated_at:
          type: string
          description: The date and time the object was last updated in Nmbr.
          readOnly: true
          format: dateTime
  securitySchemes:
    CompanyToken:
      type: http
      scheme: bearer

````