Get client by back office ID

GET /api/v2/clients/backoffice/{BackOfficeID}

Bearer auth

Get full client record via the clients back office ID.

Path parameters

BackOfficeID string(uuid) Required

The BackOfficeID of the client you want to retrieve.

Query parameters

ExcludeFormattedValues string

If set to any value, formatted values will be excluded from the response.

Responses

200 application/json

Success
Hide response attributes Show response attributes object
- success boolean
  
  Default value is true.
- data object
  
  Hide data attributes Show data attributes object
  
  Title string
  
  FirstName string
  
  Surname string
  
  KnownAs string
  
  Gender integer
  
  EmailAddress string(email)
  
  Mobile string
  
  DateOfBirth string(date)
  
  MaritalStatus integer
  
  MarriageAllowance integer
  
  NINumber string
  
  EmploymentStatus integer
  
  OccupationCode string
  
  RetirementPlanned integer
  
  RetirementDate string(date)
  
  RetirementAge integer
  
  AddressCountryCode integer
  
  AddressLine1 string
  
  AddressLine2 string
  
  AddressLine3 string
  
  AddressLine4 string
  
  AddressTown string
  
  AddressCounty string
  
  AddressPostCode string
  
  IncomeTaxArea integer
  
  AdviserUserGUID string(uuid)
  
  Reference string
  
  ATRGUID string(uuid)
  
  ClientTierGUID string(uuid)
  
  FinancialDependenceAge integer
  
  AddressFrom string(date)
  
  NextReviewDate string(date)
  
  LTA object
  
  Hide LTA attributes Show LTA attributes object
  
  MPAATriggered integer
  
  MpaTriggerDate string(date)
  
  LTARemainingLumpSum number(float) | null
  
  LTARemainingLumpSumDeath number(float) | null
  
  LTAHMRCertificateValue number(float)
  
  LTAProtectedCashAmount number(float)
  
  LTAProtectedCashPercentage number(float)
  
  LTAPrevBCEs integer
  
  LTAPercentageLeft number(float)
  
  LTAAppliedFor integer
  
  LTAProtectionType integer
  
  LTAEnhancementFactor number(float)
  
  LTAProtectedLumpSum integer
  
  InheritedNilRateBand integer
  
  InheritedResidenceNilRateBand integer
  
  CGTLossesAvailable number(float)
  
  BADRLossesAvailable number(float)
  
  BADRReliefAvailable number(float)
  
  InvestorsReliefAvailable number(float)
  
  FormattedValues object
  
  TaxFreeCash array[object]
  
  Hide TaxFreeCash attributes Show TaxFreeCash attributes object
  
  BCEDate string(date)
  
  BCETFC integer
  
  BCEAmount integer
  
  FormattedValues object
  
  Hide FormattedValues attributes Show FormattedValues attributes object
  
  BCEDate string(date)
  
  BCETFC string
  
  BCEAmount string
  
  FormattedValues object
403 application/json

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

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

GET /api/v2/clients/backoffice/{BackOfficeID}

curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/clients/backoffice/{BackOfficeID}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "success": true,
  "data": {
    "Title": "Mr",
    "FirstName": "John",
    "Surname": "Smith",
    "KnownAs": "Big John",
    "Gender": 1,
    "EmailAddress": "hello@example.com",
    "Mobile": "07777000858",
    "DateOfBirth": "1990-05-04",
    "MaritalStatus": 1,
    "MarriageAllowance": 1,
    "NINumber": "JW001100A",
    "EmploymentStatus": 1,
    "OccupationCode": "AAB00001",
    "RetirementPlanned": 1,
    "RetirementDate": "1990-05-04",
    "RetirementAge": 69,
    "AddressCountryCode": 826,
    "AddressLine1": "216 Newgate Street",
    "AddressLine2": "Address Line 2",
    "AddressLine3": "Address Line 3",
    "AddressLine4": "Address Line 4",
    "AddressTown": "Westminister",
    "AddressCounty": "London",
    "AddressPostCode": "SW1A 1AA",
    "IncomeTaxArea": 1,
    "AdviserUserGUID": "string",
    "Reference": "API Client",
    "ATRGUID": "A2BCFEE4-7F3B-4F90-8FDD-BDD3CA40DEE0",
    "ClientTierGUID": "1DFA0267-58CF-432B-BA93-BF1865B638F1",
    "FinancialDependenceAge": 1,
    "AddressFrom": "1990-05-04",
    "NextReviewDate": "1990-05-04",
    "LTA": {
      "MPAATriggered": 1,
      "MpaTriggerDate": "1990-05-04",
      "LTARemainingLumpSum": 1500.0,
      "LTARemainingLumpSumDeath": 3000.0,
      "LTAHMRCertificateValue": 42.0,
      "LTAProtectedCashAmount": 42.0,
      "LTAProtectedCashPercentage": 42.0,
      "LTAPrevBCEs": 1,
      "LTAPercentageLeft": 42.0,
      "LTAAppliedFor": 1,
      "LTAProtectionType": 1,
      "LTAEnhancementFactor": 42.0,
      "LTAProtectedLumpSum": 42,
      "InheritedNilRateBand": 42,
      "InheritedResidenceNilRateBand": 42,
      "CGTLossesAvailable": 42.0,
      "BADRLossesAvailable": 42.0,
      "BADRReliefAvailable": 42.0,
      "InvestorsReliefAvailable": 42.0,
      "FormattedValues": {
        "LTAPrevBCEs": "Yes",
        "LTAAppliedFor": "Yes",
        "MPAATriggered": "Yes",
        "MpaTriggerDate": "04/05/1990",
        "LTAProtectionType": "Primary Protection",
        "CGTLossesAvailable": "£42",
        "BADRLossesAvailable": "£42",
        "BADRReliefAvailable": "£42",
        "LTAProtectedLumpSum": "Yes",
        "LTARemainingLumpSum": "£1500.00",
        "LTAProtectedCashAmount": "£42",
        "InvestorsReliefAvailable": "£42",
        "LTARemainingLumpSumDeath": "£3000.00",
        "LTAProtectedCashPercentage": "42%"
      },
      "TaxFreeCash": [
        {
          "BCETFC": 1000000,
          "BCEDate": "2006-04-07",
          "BCEAmount": 1000000,
          "FormattedValues": {
            "BCETFC": "£1,000,000",
            "BCEDate": "07/04/2006",
            "BCEAmount": "£1,000,000"
          }
        },
        {
          "BCETFC": 2000000,
          "BCEDate": "2006-04-05",
          "BCEAmount": 2000000,
          "FormattedValues": {
            "BCETFC": "£2,000,000",
            "BCEDate": "05/04/2006",
            "BCEAmount": "£2,000,000"
          }
        }
      ]
    },
    "FormattedValues": {
      "Gender": "Male",
      "ATRGUID": "High",
      "AddressFrom": "04/05/1990",
      "DateOfBirth": "04/05/1990",
      "IncomeTaxArea": "UK excluding Scotland",
      "MaritalStatus": "Yes",
      "ClientTierGUID": "London Branch",
      "NextReviewDate": "04/05/1990",
      "OccupationCode": "Abattoir Inspector",
      "RetirementDate": "04/05/1990",
      "AdviserUserGUID": "Jonathan Thomas",
      "EmploymentStatus": "Employed",
      "MarriageAllowance": "Yes",
      "RetirementPlanned": "Age",
      "AddressCountryCode": "United Kingdom",
      "FinancialDependenceAge": "Not Applicable"
    }
  }
}

Response examples (403)

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

Response examples (404)

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