Skip to main content
PUT
Create or update a control account mapping

Authorizations

X-Auth-Token
string
header
required

FlowPayroll JWT (raw token, no Bearer prefix)

X-Org-Id
string
header
required

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

Path Parameters

templateId
string
required
account
enum<string>
required

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.

Available options:
Paye,
EeNi,
ErNi,
ErNiClass1A,
EePensionTotal,
EePensionNetPayArrangement,
EePensionReliefAtSource,
EePensionSalarySacrifice,
ErPension,
StudentLoan,
PostgraduateLoan,
NetPay,
StatutoryRecoverySmp,
StatutoryRecoverySpp,
StatutoryRecoveryShpp,
StatutoryRecoverySap,
StatutoryRecoverySpbp,
StatutoryRecoverySncp,
StatutoryRecoveryCompensation,
ApprenticeshipLevy,
EmploymentAllowance,
CourtOrderAdminFee,
ApprenticeshipLevyAllowance

Body

application/json
accountCode
string
description
string
taxCode
string | null
groupAs
string | null
creditAccountCode
string | null
creditGroupAs
string | null

Response

OK

message
object
content
object | null
validationIssues
object[] | null