Skip to main content
POST
Update organisation opening balances by tax year

Authorizations

X-Auth-Token
string
header
required

Access token obtained from OAuth2 client credentials flow

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

taxYear
integer
required

The tax year to update balances for

Required range: 1800 <= x <= 3000

Body

application/json
baseValues
object
required
apprenticeshipLevyAllowanceYtd
object
apprenticeshipLevyYtd
number<decimal>

Apprenticeship levy owed YTD

Example:

100

employmentAllowanceYtd
object
cisDeductions
object
statutoryPaymentsReclaims
object

Dictionary where keys should be one of the StatutoryTypeEnum values (StatutorySickPay, StatutoryMaternityPay, StatutoryPaternityPay, StatutoryAdoptionPay, SharedParentalPay, StatutoryParentalBereavementPay, StatutorySharedParentalPay, StatutoryNeoNatalCarePay)

Response

Successfully updated balances

message
object
content
object
validationIssues
object[]
messageToken
string
data
object