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

# Get a control account mapping

> Retrieve a single control account mapping from a template.



## OpenAPI

````yaml /api-reference/specs/journal.json get /templates/{templateId}/control-account-mappings/{account}
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}/control-account-mappings/{account}:
    get:
      tags:
        - Control account mappings
      summary: Get a control account mapping
      description: Retrieve a single control account mapping from a template.
      operationId: GetControlAccountMapping
      parameters:
        - name: templateId
          in: path
          required: true
          schema:
            type: string
        - name: account
          in: path
          description: >-
            The control account kind, matched case-insensitively. Any other
            value — including withdrawn kinds such as StatutoryRecoverySsp
            (removed 2026-08-07: SSP is not recoverable) — is rejected with a
            400 envelope.
          required: true
          schema:
            enum:
              - Paye
              - EeNi
              - ErNi
              - ErNiClass1A
              - EePensionTotal
              - EePensionNetPayArrangement
              - EePensionReliefAtSource
              - EePensionSalarySacrifice
              - ErPension
              - StudentLoan
              - PostgraduateLoan
              - NetPay
              - StatutoryRecoverySmp
              - StatutoryRecoverySpp
              - StatutoryRecoveryShpp
              - StatutoryRecoverySap
              - StatutoryRecoverySpbp
              - StatutoryRecoverySncp
              - StatutoryRecoveryCompensation
              - ApprenticeshipLevy
              - EmploymentAllowance
              - CourtOrderAdminFee
              - ApprenticeshipLevyAllowance
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControlAccountMappingResponseResponseBody'
        '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:
    ControlAccountMappingResponseResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          allOf:
            - $ref: >-
                #/components/schemas/ControlAccountMappingResponseContentResponse
          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
    ControlAccountMappingResponseContentResponse:
      type: object
      properties:
        data:
          allOf:
            - $ref: '#/components/schemas/ControlAccountMappingResponse'
          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
    ControlAccountMappingResponse:
      type: object
      properties:
        organisationId:
          type: string
        templateId:
          type: string
        account:
          enum:
            - None
            - Paye
            - EeNi
            - ErNi
            - ErNiClass1A
            - EePensionTotal
            - EePensionNetPayArrangement
            - EePensionReliefAtSource
            - EePensionSalarySacrifice
            - ErPension
            - StudentLoan
            - PostgraduateLoan
            - NetPay
            - StatutoryRecoverySmp
            - StatutoryRecoverySpp
            - StatutoryRecoveryShpp
            - StatutoryRecoverySap
            - StatutoryRecoverySpbp
            - StatutoryRecoverySncp
            - StatutoryRecoveryCompensation
            - ApprenticeshipLevy
            - EmploymentAllowance
            - CourtOrderAdminFee
            - ApprenticeshipLevyAllowance
          type: string
        accountCode:
          type: string
        description:
          type: string
        taxCode:
          type: string
        groupAs:
          type: string
          nullable: true
        createdBy:
          type: string
        createdDate:
          type: string
        updatedBy:
          type: string
        updatedDate:
          type: string
        creditAccountCode:
          type: string
          nullable: true
        creditGroupAs:
          type: string
          nullable: true
      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

````