Get contribution

GET /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/contributions/{PensionContributionGUID}

Bearer auth

This endpoint allows users to retrieve a contribution for a clients household pension.

Path parameters

HouseholdGUID string(uuid) Required

The HouseholdGUID of the client.
PensionGUID string(uuid) Required

The PensionGUID for the contribution you want to retrieve.
PensionContributionGUID string(uuid) Required

The PensionContributionGUID you want to retrieve.

Responses

200 application/json

Success
Hide response attributes Show response attributes object
- success boolean
  
  Default value is true.
- data array[object]
  
  Hide data attributes Show data attributes object
  
  TransactionGUID string(uuid)
  
  TransactionType integer
  
  PensionGUID string(uuid)
  
  LinkedIncomeGUID string(uuid)
  
  LinkedSavingsGUID string(uuid)
  
  ContributionMethod integer
  
  TransactionAmount number(float)
  
  TransactionPercentage number(float)
  
  EmployerAmount number(float)
  
  EmployerPercentage number(float)
  
  Frequency integer
  
  StartBasis integer
  
  StartEventGUID string(uuid)
  
  StartAge integer
  
  StartDate string
  
  EndBasis integer
  
  EndEventGUID string(uuid)
  
  EndAge integer
  
  EndDate string
  
  BackOfficeID string
  
  BackOfficeSync integer
  
  FormattedValues object
  
  Additional properties are allowed.
403 application/json

Permission error.
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string
404 application/json

Household not found
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string

GET /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/contributions/{PensionContributionGUID}

curl \
 -X GET https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/contributions/{PensionContributionGUID} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "success": true,
  "data": [
    {
      "TransactionGUID": "055CAE9F-6167-4186-8DE2-EC994D2222A2",
      "TransactionType": 1,
      "PensionGUID": "2A05D34A-7B97-40F6-B7B6-11D77C7A8A8A",
      "LinkedIncomeGUID": "681C02ED-0D67-4392-A1C2-6856C84E4E4E",
      "LinkedSavingsGUID": "6B25H34A-6697-40F6-B7B6-11D77C7A77AA",
      "ContributionMethod": 1,
      "TransactionAmount": 1500,
      "TransactionPercentage": 1,
      "EmployerAmount": 1500,
      "EmployerPercentage": 1,
      "Frequency": 52,
      "StartBasis": 3,
      "StartEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
      "StartAge": 42,
      "StartDate": "2024-01-01",
      "EndBasis": 3,
      "EndEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
      "EndAge": 65,
      "EndDate": "2025-01-01",
      "BackOfficeID": 13573,
      "BackOfficeSync": 1,
      "FormattedValues": {
        "EndDate": "01/01/2025",
        "EndBasis": "Event",
        "Frequency": "Paid Weekly",
        "StartDate": "01/01/2024",
        "StartBasis": "Specific Age",
        "PensionGUID": "My Big Pension",
        "EndEventGUID": "API Tester",
        "EmployerAmount": "£1,500",
        "TransactionType": "Pension Contribution",
        "LinkedIncomeGUID": "Salary",
        "LinkedSavingsGUID": "Current Account",
        "TransactionAmount": "£1,500",
        "ContributionMethod": "Relief at source",
        "EmployerPercentage": "1%",
        "TransactionPercentage": "1%"
      }
    }
  ]
}

Response examples (403)

{
  "success": false,
  "message": "You do not have permission to view the household."
}

Response examples (404)

{
  "success": false,
  "message": "Household not found."
}