> ## 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 update a split value mapping

> Map a split dimension value to its tracking code or account segment.



## OpenAPI

````yaml /api-reference/specs/journal.json put /templates/{templateId}/split-dimensions/{sequence}/values/{splitValueKey}
openapi: 3.0.1
info:
  title: Journal Service
  description: Journal API for FlowPayroll
  version: v1
servers:
  - url: https://api.sandbox.flowpayroll.ai/v1/journal
security:
  - X-Auth-Token: []
    X-Org-Id: []
tags:
  - name: Journals
    description: >-
      The accounting journals produced from each finalised pay run: list them,
      retrieve the latest or a specific version for a pay run, review history,
      rebuild or reissue, and download exports.
  - name: Journal templates
    description: >-
      Define how a pay run becomes an accounting journal. Create, update, clone,
      preview (as data, CSV, or PDF), import, export, and view the history of
      templates.
  - name: Pay element mappings
    description: Map each pay element to the nominal code it posts to within a template.
  - name: Control account mappings
    description: >-
      Map control accounts (net pay, PAYE, NI, pension, and other liabilities)
      to nominal codes within a template.
  - name: Split dimensions
    description: >-
      Analysis dimensions such as department or cost centre that split journal
      lines into tracking categories or account-code segments.
  - name: Split value mappings
    description: >-
      Map each value of a split dimension to its tracking code or account
      segment.
  - name: Org journal settings
    description: Read and update the organisation-level journal defaults.
  - name: Journal export metadata
    description: >-
      Reference data for building templates: export presets, date-format
      presets, narration and reference tokens, and account-code separators.
paths:
  /templates/{templateId}/split-dimensions/{sequence}/values/{splitValueKey}:
    put:
      tags:
        - Split value mappings
      summary: Create or update a split value mapping
      description: Map a split dimension value to its tracking code or account segment.
      operationId: PutSplitValueMapping
      parameters:
        - name: templateId
          in: path
          required: true
          schema:
            type: string
        - name: sequence
          in: path
          required: true
          schema:
            type: integer
            format: int32
        - name: splitValueKey
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutSplitValueMappingRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SplitValueMappingResponseResponseBody'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
components:
  schemas:
    PutSplitValueMappingRequest:
      type: object
      properties:
        displayName:
          type: string
        accountSegment:
          type: string
        employerCostsAccountSegment:
          type: string
          nullable: true
        deductionAccountSegment:
          type: string
          nullable: true
      additionalProperties: false
    SplitValueMappingResponseResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          allOf:
            - $ref: '#/components/schemas/SplitValueMappingResponseContentResponse'
          nullable: true
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
          nullable: true
      additionalProperties: false
    ObjectResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          allOf:
            - $ref: '#/components/schemas/ObjectContentResponse'
          nullable: true
        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
    SplitValueMappingResponseContentResponse:
      type: object
      properties:
        data:
          allOf:
            - $ref: '#/components/schemas/SplitValueMappingResponse'
          nullable: true
        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
    SplitValueMappingResponse:
      type: object
      properties:
        organisationId:
          type: string
        templateId:
          type: string
        dimensionSequence:
          type: integer
          format: int32
        splitValueKey:
          type: string
        displayName:
          type: string
        accountSegment:
          type: string
        createdBy:
          type: string
        createdDate:
          type: string
        updatedBy:
          type: string
        updatedDate:
          type: string
        employerCostsAccountSegment:
          type: string
        deductionAccountSegment:
          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

````