API Documentation

This documentation is intended for payroll software developers who need to use the States of Guernsey SPCM API to report Secondary Pensions returns to the Revenue Service.

• Overview: Start here for a high-level view of the API and schema
• Authentication: How to obtain and use a sender key to submit returns to the API
• Examples:
  • Secondary Pensions: Example JSON files for common Secondary Pensions return scenarios
  • Economic Statistics: Returning information for Economic Statistics (on its own, or in a combined file with Secondary Pensions)
  • Employees Tax Instalment (ETI): Examples for submitting information about income tax deductions made under the ETI scheme
  • Social Security Contributions: Examples for submitting information about employer and employee social security contributions
  • Combined File: A combined return for all of the above purposes
  • Pension Provider: Sending contributions data to a Pension Provider
• Error responses: Describes the circumstances in which SPCM may reject a return, and the error responses given
• Corrections: Best practice guidance for submitting corrections to previously submitted data
• Behaviour specification: Describes how SPCM is specified to behave, and how you can submit data incrementally, or resubmit data which contains errors
• JSON editor: JSON editor with schema auto-completion and validation
• Swagger: API reference and test tool
• Test Employers: Test employers which can be used with the test endpoint