Get repayment

GET /api/v2/household/{HouseholdGUID}/liabilities/{LiabilityGUID}/repayments/{RepaymentGUID}

Bearer auth

This endpoint allows users to retrieve a repayment for a clients household liability.

Path parameters

HouseholdGUID string(uuid) Required

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

The LiabilityGUID for the repayment you want to retrieve.
RepaymentGUID string(uuid) Required

The RepaymentGUID 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
  
  LiabilityGUID string(uuid)
  
  TransactionAmount number(float)
  
  InterestPayment integer
  
  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}/liabilities/{LiabilityGUID}/repayments/{RepaymentGUID}

curl \
 -X GET https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/liabilities/{LiabilityGUID}/repayments/{RepaymentGUID} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "success": true,
  "data": [
    {
      "TransactionGUID": "055CAE9F-6167-4186-8DE2-EC994D2222A2",
      "TransactionType": 4,
      "LiabilityGUID": "246C6E3A-3A3D-42A6-BEA3-85A8E3272C2C",
      "TransactionAmount": 5000.1,
      "InterestPayment": 1,
      "Frequency": 26,
      "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": "Specific Date",
        "Frequency": "per fortnight",
        "StartDate": "01/01/2024",
        "StartBasis": "Specific Date",
        "LiabilityGUID": "API Test",
        "TransactionType": "Liability Repayment",
        "TransactionAmount": "£5,000"
      }
    }
  ]
}

Response examples (403)

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

Response examples (404)

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