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

# Create or replace the organisation's salary configuration

> Sets the default pro-rating method and switches the module on or off. Every employee of the organisation is re-previewed on any open pay run, so the change reaches the current period as well as future ones.



## OpenAPI

````yaml /api-reference/specs/salary.json put /organisation
openapi: 3.0.1
info:
  title: Salary Service
  description: >-
    Salary module API for FlowPayroll: organisation and employee
    calculation-method configuration, statutory leave policies, and a
    side-effect-free pro-rata calculation. Enums may gain values and objects may
    gain properties without a new version, so a client should ignore properties
    it does not know and treat an enum value it does not recognise as
    unsupported.
  version: v1
servers:
  - url: https://api.sandbox.flowpayroll.ai/v1/salary
security:
  - X-Auth-Token: []
    X-Org-Id: []
paths:
  /organisation:
    put:
      tags:
        - Salary organisation configuration
      summary: Create or replace the organisation's salary configuration
      description: >-
        Sets the default pro-rating method and switches the module on or off.
        Every employee of the organisation is re-previewed on any open pay run,
        so the change reaches the current period as well as future ones.
      operationId: PutSalaryOrganisationConfig
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertSalaryOrganisationConfigRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SalaryOrganisationConfigResponseResponseBody
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
components:
  schemas:
    UpsertSalaryOrganisationConfigRequest:
      required:
        - calculationMethod
        - enabled
      type: object
      properties:
        calculationMethod:
          enum:
            - CalendarDays
            - WorkingDays
          type: string
          description: The pro-rating method for partial periods.
          nullable: true
        enabled:
          type: boolean
          description: Whether the module posts salary lines for this organisation.
      additionalProperties: false
      description: Creates or replaces the organisation's salary configuration.
    SalaryOrganisationConfigResponseResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          $ref: '#/components/schemas/SalaryOrganisationConfigResponseContentResponse'
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
          nullable: true
      additionalProperties: false
    ObjectResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          $ref: '#/components/schemas/ObjectContentResponse'
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
          nullable: true
      additionalProperties: false
    MessageWithTokenResponse:
      type: object
      properties:
        text:
          type: string
        token:
          type: string
        tokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
          nullable: true
      additionalProperties: false
    SalaryOrganisationConfigResponseContentResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SalaryOrganisationConfigResponse'
        metadata:
          $ref: '#/components/schemas/ContentMetadataResponse'
      additionalProperties: false
    ValidationIssue:
      type: object
      properties:
        field:
          type: string
        reason:
          type: string
        reasonToken:
          type: string
        reasonTokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
          nullable: true
      additionalProperties: false
    ObjectContentResponse:
      type: object
      properties:
        data:
          nullable: true
        metadata:
          $ref: '#/components/schemas/ContentMetadataResponse'
      additionalProperties: false
    ValidationIssueArgument:
      type: object
      properties:
        name:
          type: string
        value:
          nullable: true
      additionalProperties: false
    SalaryOrganisationConfigResponse:
      type: object
      properties:
        organisationId:
          type: string
        calculationMethod:
          enum:
            - CalendarDays
            - WorkingDays
          type: string
          description: >-
            How a partial pay period is pro-rated: `CalendarDays` or
            `WorkingDays`.
        enabled:
          type: boolean
        createdBy:
          type: string
        createdDate:
          type: string
        updatedBy:
          type: string
        updatedDate:
          type: string
      additionalProperties: false
    ContentMetadataResponse:
      type: object
      properties:
        dateFormat:
          type: string
        dateTimeFormat:
          type: string
        paginationToken:
          type: string
          nullable: true
      additionalProperties: false
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      description: FlowPayroll JWT (raw token, no Bearer prefix)
      name: X-Auth-Token
      in: header
    X-Org-Id:
      type: apiKey
      description: >-
        Organisation to scope the request to. Required when the principal can
        access more than one organisation; optional for single-organisation
        principals (the authorizer resolves it automatically).
      name: X-Org-Id
      in: header

````

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