Skip to content

Latest commit

 

History

History
293 lines (236 loc) · 13.7 KB

api-list.md

File metadata and controls

293 lines (236 loc) · 13.7 KB
Raw

Warning: this list was generated by running get_endpoint_list.rb and is not updated automatically. The list is generated based on the content of the public API documentation. To generate an up-to-date list, run get_endpoint_list.rb.

API: Business Details (Sandbox: 1.0, Production: 1.0)

  • Endpoint: List All Businesses
  • Endpoint: Retrieve Business Details
  • Endpoint: Create and Amend Quarterly Period Type for a Business

API: Business Income Source Summary (Sandbox: 2.0, Production: 2.0)

  • Endpoint: Retrieve a Business Income Source Summary (BISS)

API: Business Source Adjustable Summary (Sandbox: 5.0, Production: 5.0)

  • Endpoint: List Business Source Adjustable Summaries
  • Endpoint: Trigger a Business Source Adjustable Summary
  • Endpoint: Retrieve a Self-Employment Business Source Adjustable Summary (BSAS)
  • Endpoint: Submit Self-Employment Accounting Adjustments
  • Endpoint: Retrieve a UK Property Business Source Adjustable Summary (BSAS)
  • Endpoint: Submit UK Property Accounting Adjustments
  • Endpoint: Retrieve a Foreign Property Business Source Adjustable Summary (BSAS)
  • Endpoint: Submit Foreign Property Accounting Adjustments

API: CIS Deductions (Sandbox: 2.0, Production: 2.0)

  • Endpoint: Retrieve CIS Deductions for Subcontractor
  • Endpoint: Create CIS Deductions for Subcontractor
  • Endpoint: Amend CIS Deductions for Subcontractor
  • Endpoint: Delete CIS Deductions for Subcontractor

API: Individual Calculations (Sandbox: 5.0, Production: 5.0)

  • Endpoint: List Self Assessment Tax Calculations
  • Endpoint: Trigger a Self Assessment Tax Calculation
  • Endpoint: Retrieve a Self Assessment Tax Calculation
  • Endpoint: Submit a Self Assessment Final Declaration

API: Individual Losses (Sandbox: 4.0, Production: 4.0)

  • Endpoint: Create a Brought Forward Loss
  • Endpoint: Amend a Brought Forward Loss Amount
  • Endpoint: List Brought Forward Losses
  • Endpoint: Retrieve a Brought Forward Loss
  • Endpoint: Delete a Brought Forward Loss
  • Endpoint: Create a Loss Claim
  • Endpoint: List Loss Claims
  • Endpoint: Retrieve a Loss Claim
  • Endpoint: Delete a Loss Claim
  • Endpoint: Amend a Loss Claim Type
  • Endpoint: Amend Loss Claims Order

API: Individuals Business End of Period Statement (Sandbox: 3.0, Production: 3.0)

  • Endpoint: Submit End of Period Statement for a Business

API: Individuals Capital Gains Income (Sandbox: 1.0, Production: 1.0)

  • Endpoint: Retrieve All CGT Residential Property Disposals and Overrides
  • Endpoint: Create and Amend CGT Residential Property Disposals (non-PPD)
  • Endpoint: Delete CGT Residential Property Disposals (non-PPD)
  • Endpoint: Create and Amend 'Report and Pay Capital Gains Tax on Residential Property' Overrides (PPD)
  • Endpoint: Delete 'Report and Pay Capital Gains Tax on Residential Property' Overrides (PPD)
  • Endpoint: Retrieve Other Capital Gains and Disposals
  • Endpoint: Create and Amend Other Capital Gains and Disposals
  • Endpoint: Delete Other Capital Gains and Disposals

API: Individuals Charges (Sandbox: 2.0, Production: 2.0)

  • Endpoint: Retrieve Pension Charges
  • Endpoint: Create and Amend Pension Charges
  • Endpoint: Delete Pension Charges

API: Individuals Disclosures (Sandbox: 1.0, Production: 1.0)

  • Endpoint: Create Marriage Allowance
  • Endpoint: Retrieve Disclosures
  • Endpoint: Create and Amend Disclosures
  • Endpoint: Delete Disclosures

API: Individuals Dividends Income (Sandbox: 1.0, Production: 1.0)

  • Endpoint: Retrieve Dividends Income
  • Endpoint: Create and Amend Dividends Income
  • Endpoint: Delete Dividends Income
  • Endpoint: Retrieve a UK Dividends Income Annual Summary
  • Endpoint: Create and Amend a UK Dividends Income Annual Summary
  • Endpoint: Delete a UK Dividends Income Annual Summary

API: Individuals Employments Income (Sandbox: 1.0, Production: 1.0)

  • Endpoint: List Employments
  • Endpoint: Add a Custom Employment
  • Endpoint: Retrieve an Employment
  • Endpoint: Amend a Custom Employment
  • Endpoint: Delete a Custom Employment
  • Endpoint: Ignore Employment
  • Endpoint: Unignore Employment
  • Endpoint: Retrieve an Employment and its Financial Details
  • Endpoint: Create and Amend Employment Financial Details
  • Endpoint: Delete Employment Financial Details
  • Endpoint: Retrieve Non-PAYE Employment Income
  • Endpoint: Create and Amend Non-PAYE Employment Income
  • Endpoint: Delete Non-PAYE Employment Income
  • Endpoint: Retrieve Other Employment Income
  • Endpoint: Create and Amend Other Employment Income
  • Endpoint: Delete Other Employment Income

API: Individuals Expenses (Sandbox: 2.0, Production: 2.0)

  • Endpoint: Retrieve Employment Expenses
  • Endpoint: Create and Amend Employment Expenses
  • Endpoint: Delete Employment Expenses
  • Endpoint: Ignore Employment Expenses
  • Endpoint: Retrieve Other Expenses
  • Endpoint: Create and Amend Other Expenses
  • Endpoint: Delete Other Expenses

API: Individuals Foreign Income (Sandbox: 1.0, Production: 1.0)

  • Endpoint: Retrieve Foreign Income
  • Endpoint: Create and Amend Foreign Income
  • Endpoint: Delete Foreign Income

API: Individuals Insurance Policies Income (Sandbox: 1.0, Production: 1.0)

  • Endpoint: Retrieve Insurance Policies Income
  • Endpoint: Create and Amend Insurance Policies Income
  • Endpoint: Delete Insurance Policies Income

API: Individuals Other Income (Sandbox: 1.0, Production: 1.0)

  • Endpoint: Retrieve Other Income
  • Endpoint: Create and Amend Other Income
  • Endpoint: Delete Other Income

API: Individuals Pensions Income (Sandbox: 1.0, Production: 1.0)

  • Endpoint: Retrieve Pensions Income
  • Endpoint: Create and Amend Pensions Income
  • Endpoint: Delete Pensions Income

API: Individuals Reliefs (Sandbox: 1.0, Production: 1.0)

  • Endpoint: Retrieve Relief Investments
  • Endpoint: Create and Amend Relief Investments
  • Endpoint: Delete Relief Investments
  • Endpoint: Retrieve Other Reliefs
  • Endpoint: Create and Amend Other Reliefs
  • Endpoint: Delete Other Reliefs
  • Endpoint: Retrieve Foreign Reliefs
  • Endpoint: Create and Amend Foreign Reliefs
  • Endpoint: Delete Foreign Reliefs
  • Endpoint: Retrieve Pensions Reliefs
  • Endpoint: Create and Amend Pensions Reliefs
  • Endpoint: Delete Pensions Reliefs
  • Endpoint: Retrieve Charitable Giving Tax Relief
  • Endpoint: Create and Amend Charitable Giving Tax Relief
  • Endpoint: Delete Charitable Giving Tax Relief

API: Individuals Savings Income (Sandbox: 1.0, Production: 1.0)

  • Endpoint: List All UK Savings Accounts
  • Endpoint: Add a UK Savings Account
  • Endpoint: Retrieve UK Savings Account Annual Summary
  • Endpoint: Create and Amend a UK Savings Account Annual Summary
  • Endpoint: Retrieve Savings Income
  • Endpoint: Create and Amend Savings Income
  • Endpoint: Delete Savings Income

API: Individuals State Benefits (Sandbox: 1.0, Production: 1.0)

  • Endpoint: List State Benefits
  • Endpoint: Create State Benefit
  • Endpoint: Amend State Benefit
  • Endpoint: Delete State Benefit
  • Endpoint: Amend State Benefit Amounts
  • Endpoint: Delete State Benefit Amounts
  • Endpoint: Ignore State Benefit
  • Endpoint: Unignore State Benefit

API: Obligations (Sandbox: 2.0, Production: 2.0)

  • Endpoint: Retrieve Income Tax (Self Assessment) Income and Expenditure Obligations
  • Endpoint: Retrieve Income Tax (Self Assessment) Final Declaration Obligations
  • Endpoint: Retrieve Income Tax (Self Assessment) End of Period Statement Obligations

API: Other Deductions (Sandbox: 1.0, Production: 1.0)

  • Endpoint: Retrieve Deductions
  • Endpoint: Create and Amend Deductions
  • Endpoint: Delete Deductions

API: Property Business (Sandbox: 4.0, Production: 4.0)

  • Endpoint: Retrieve a UK Property Business Annual Submission
  • Endpoint: Create and Amend a UK Property Business Annual Submission
  • Endpoint: Create a UK Property Income & Expenses Period Summary
  • Endpoint: Retrieve a UK Property Income & Expenses Period Summary
  • Endpoint: Amend a UK Property Income & Expenses Period Summary
  • Endpoint: Retrieve a Historic FHL UK Property Business Annual Submission
  • Endpoint: Create and Amend a Historic FHL UK Property Business Annual Submission
  • Endpoint: Delete a Historic FHL UK Property Business Annual Submission
  • Endpoint: Retrieve a Historic Non-FHL UK Property Business Annual Submission
  • Endpoint: Create and Amend a Historic Non-FHL UK Property Business Annual Submission
  • Endpoint: Delete a Historic Non-FHL UK Property Business Annual Submission
  • Endpoint: List Historic FHL UK Property Income & Expenses Period Summaries
  • Endpoint: Create a Historic FHL UK Property Income & Expenses Period Summary
  • Endpoint: Retrieve a Historic FHL UK Property Income & Expenses Period Summary
  • Endpoint: Amend a Historic FHL UK Property Income & Expenses Period Summary
  • Endpoint: List Historic Non-FHL UK Property Income & Expenses Period Summaries
  • Endpoint: Create a Historic Non-FHL UK Property Income & Expenses Period Summary
  • Endpoint: Retrieve a Historic Non-FHL UK Property Income and Expenses Period Summary
  • Endpoint: Amend a Historic Non-FHL UK Property Income & Expenses Period Summary
  • Endpoint: Create a Foreign Property Income & Expenses Period Summary
  • Endpoint: Retrieve a Foreign Property Income & Expenses Period Summary
  • Endpoint: Amend a Foreign Property Income & Expenses Period Summary
  • Endpoint: Retrieve a Foreign Property Annual Submission
  • Endpoint: Create and Amend a Foreign Property Annual Submission
  • Endpoint: Delete a Property Annual Submission
  • Endpoint: List Property Income and Expenses Period Summaries

API: Self Assessment Accounts (Sandbox: 3.0, Production: 3.0)

  • Endpoint: Retrieve History of a Self Assessment Charge
  • Endpoint: Retrieve Self Assessment Balance and Transactions
  • Endpoint: List Self Assessment Payments & Allocation Details
  • Endpoint: Retrieve Coding Out Underpayments and Debt Amounts
  • Endpoint: Create or Amend Coding Out Underpayments and Debt Amounts
  • Endpoint: Delete Coding Out Underpayments and Debt Amounts
  • Endpoint: Opt Out of Coding Out
  • Endpoint: Retrieve Coding Out Status
  • Endpoint: Opt In to Coding Out

API: Self Assessment Assist (Sandbox: 1.0, Production: N/A)

  • Endpoint: Produce a HMRC Self Assessment Assist Report
  • Endpoint: Acknowledge a HMRC Self Assessment Assist Report

API: Self Assessment Individual Details (Sandbox: 2.0, Production: 2.0)

  • Endpoint: Retrieve ITSA Status

API: Self Employment Business (Sandbox: 3.0, Production: 3.0)

  • Endpoint: Retrieve a Self-Employment Annual Submission
  • Endpoint: Create and Amend Self-Employment Annual Submission
  • Endpoint: Delete a Self-Employment Annual Submission
  • Endpoint: List Self-Employment Period Summaries
  • Endpoint: Create a Self-Employment Period Summary
  • Endpoint: Retrieve a Self-Employment Period Summary
  • Endpoint: Amend a Self-Employment Period Summary

API: Self-Assessment Test Support (Sandbox: 1.0, Production: N/A)

  • Endpoint: Delete Stateful Test Data
  • Endpoint: List Checkpoints
  • Endpoint: Create a Checkpoint
  • Endpoint: Delete a Checkpoint
  • Endpoint: Restore to Checkpoint
  • Endpoint: Create a Test Business
  • Endpoint: Delete a Test Business
  • Endpoint: Create and Amend Test ITSA Status