UC Statements

API reference for Universal Credit statement management and the UC calculator.

List UC Statements#

const statements = await $fetch('https://taxmtd.uk/api/uc-statements')
// Returns: Array<UCStatement>

Create UC Statement#

Full UC statement with DWP breakdown fields.

await $fetch('https://taxmtd.uk/api/uc-statements', {
  method: 'POST',
  body: {
    // Period
    periodId: 1,
    assessmentStart: '2026-01-30',
    assessmentEnd: '2026-02-27',

    // Payment
    paymentDate: '2026-03-15',
    paymentAmount: 312.45,

    // Entitlement
    standardAllowance: 393.45,
    housingElement: 450.00,
    childrenElement: 269.58,
    totalEntitlement: 1112.03,

    // Claimants
    claimant1Name: 'Jane Doe',
    claimant1Earnings: 800.00,
    claimant2Name: 'John Doe',
    claimant2SelfEmploymentEarnings: 1200.00,
    claimant2PreviousLosses: 0,
    claimant2TotalEarnings: 1200.00,

    // Calculation
    minimumIncomeFloor: 1400.00,
    usedEarnings: 1400.00,
    workAllowance: 411.00,
    taperRate: 0.55,

    // Deductions
    takeHomePay: 440.00,
    savingsDeduction: 0,
    totalDeductions: 984.50,

    // Legacy
    reportedIncome: 1200,
    reportedExpenses: 300,

    // Source file
    sourceFilename: 'uc-statement-march.pdf',
    sourceMimeType: 'application/pdf',
    sourceFile: 'base64-encoded-file-data...'
  }
})

Update UC Statement#

await $fetch('https://taxmtd.uk/api/uc-statements', {
  method: 'PUT',
  body: { id: 1, paymentAmount: 320.00, notes: 'Corrected amount' }
})

Delete UC Statement#

await $fetch('https://taxmtd.uk/api/uc-statements', {
  method: 'DELETE',
  body: { id: 1 }
})

UC Statement Data Model#

Field	Type	Description
`paymentDate`	`string`	Date payment received
`paymentAmount`	`number`	Headline payment amount
`standardAllowance`	`number`	Base UC amount
`housingElement`	`number`	Housing costs support
`childrenElement`	`number`	Child element totals
`totalEntitlement`	`number`	Sum of all elements
`claimant1Name`	`string`	Name of claimant 1
`claimant1Earnings`	`number`	Claimant 1 earnings
`claimant2Name`	`string`	Self-employed claimant
`claimant2SelfEmploymentEarnings`	`number`	SE gross income
`claimant2PreviousLosses`	`number`	Carried-forward losses
`minimumIncomeFloor`	`number`	MIF threshold
`usedEarnings`	`number`	Earnings used by DWP
`workAllowance`	`number`	Earnings before taper
`taperRate`	`number`	Deduction rate (0.55)
`takeHomePay`	`number`	Total earnings deduction
`savingsDeduction`	`number`	Capital/savings deduction
`totalDeductions`	`number`	Combined deductions
`sourceFile`	`string`	Base64-encoded UC letter
`sourceFilename`	`string`	Original filename
`sourceMimeType`	`string`	MIME type of source

Was this page helpful? Share it.