Skip to main content

[Beta] Reconciles financial records for an existing contact group

Beta · access by arrangement

This endpoint is in beta. Its behaviour and contract may change as it is refined. Confirm availability with LMG before depending on it in a production integration.

Temporary beta response: 423 Locked. A response with code feature_not_enabled means beta access is not enabled for the resolved user, or a valid user could not be resolved. This is a temporary restriction during the endpoint’s beta period, not an ongoing requirement for its general availability.

Normal OAuth, scope and resource-access checks still apply. Check the adviser context and arrange beta enablement before retrying; repeated retries will not unlock access. Read the beta endpoint guidance →

POST/jsonapi/contact-groups/{contactGroupId}/financial-snapshotBeta

Requires the feature to be enabled for the resolved user. A disabled feature or unresolved user returns 423 Locked with error code feature_not_enabled. Normal authorization and resource access rules still apply. Enable the feature before retrying this error.

Updates an existing contact group's financial position from a single snapshot of its assets, liabilities, incomes, expenses and employments.

Beta endpoint. Availability is by arrangement and the contract may change during beta. Temporary beta response: 423 Locked with feature_not_enabled means beta access is not enabled for the resolved user, or a valid user could not be resolved. This restriction applies during beta; it is not an ongoing general-availability requirement. Check the adviser context and arrange enablement before retrying. Normal OAuth, scope and resource-access checks still apply. See beta endpoint guidance.

For client-credentials integrations, supply your assigned adviser identifier in the UserId header. See request headers and data access.

Access

Bearer authentication. Confirm your scopes, data access and required adviser context.

Request parameters

contactGroupId path required

contactGroupIdinteger

format: int32

fields query

Select response attributes and relationships by resource type, including included resources. Each value is a comma-separated list of public field names, for example fields[articles]=title,body. Does not affect which request fields are written.

fieldsobject
Additional propertystring

Request body

application/vnd.api+json

Example request body

Generated from the OpenAPI Specification with illustrative values. Replace sample values, resource types and IDs with your own. Optional fields are shown for illustration; follow the field descriptions and business rules.

{
"data": {
"type": "financial-snapshots",
"attributes": {
"assetsMode": "Merge",
"assets": [
{
"lid": "string",
"assetId": 1,
"assetTypeId": 1,
"assetSubTypeId": 1,
"description": "string",
"value": 1,
"institution": "string",
"accountName": "string",
"bsb": "string",
"accountNumber": "string",
"vehicleMake": "string",
"vehicleYear": 1,
"propertyTypeId": 1,
"propertyPrimaryPurpose": "PurchaseOwnerOccupied",
"valueBasis": "ApplicantEstimate",
"address": {
"lid": "string"
},
"ownership": [
{
"id": 1
}
]
}
],
"expensesMode": "Merge",
"expenses": [
{
"lid": "string",
"expenseId": 1,
"expenseTypeId": 1,
"description": "string",
"value": 1,
"frequency": "Yearly",
"ownership": [
{
"id": 1
}
]
}
],
"incomesMode": "Merge",
"incomes": [
{
"lid": "string",
"incomeId": 1,
"incomeTypeId": 1,
"description": "string",
"value": 1,
"frequency": "Yearly",
"nzIsGross": false,
"nzRentalType": "RentalIncome",
"isEvidenceOfTenancy": false,
"nzRentalVerificationTypeId": 1,
"incomeVerificationId": 1,
"ownership": [
{
"id": 1
}
],
"linkedAsset": {
"lid": "string",
"id": 1
},
"employment": {
"lid": "string",
"id": 1
}
}
],
"liabilitiesMode": "Merge",
"liabilities": [
{
"lid": "string",
"liabilityId": 1,
"liabilityTypeId": 1,
"liabilitySubTypeId": 1,
"accountName": "string",
"bsb": "string",
"accountNumber": "string",
"value": 1,
"limit": 1,
"repayment": 1,
"repaymentFrequency": "Yearly",
"interestRate": 1,
"interestTaxDeductible": false,
"creditorName": "string",
"loanTerm": 1,
"loanRepaymentType": "InterestOnly",
"mortgagePriority": "First",
"nzIsInArrears": false,
"nzLoanStartDate": "2026-01-15",
"nzDocumentedLoanTermMonths": 1,
"nzInterestOnlyStartDate": "2026-01-15",
"nzInterestOnlyTermMonths": 1,
"nzRevolvingCreditRedraw": false,
"isClearingFromThisLoan": false,
"linkedAsset": {
"lid": "string",
"id": 1
},
"ownership": [
{
"id": 1
}
]
}
],
"employmentsMode": "Merge",
"employments": [
{
"lid": "string",
"employmentId": 1,
"contactId": 1,
"employmentStatus": "PrimaryEmployment",
"employmentType": "PAYG",
"dateStarted": "2026-01-15",
"dateEnded": "2026-01-15",
"employmentRoleName": "string",
"employmentBasis": "FullTime",
"isProbation": false,
"businessNumber": "string",
"companyNumber": "string",
"employerName": "string",
"employerContactTitle": "Mr",
"employerContactFirstName": "string",
"employerContactLastName": "string",
"employerType": "Private",
"employerPhone": "string",
"address": {
"lid": "string"
}
}
],
"addresses": [
{
"lid": "string",
"formattedAddress": "string",
"streetAddress": "string",
"suburb": "string",
"state": "string",
"postCode": "stri",
"country": "string"
}
]
}
}
}
Request documentobjectFinancialSnapshotDocument ↗
dataobjectrequiredFinancialSnapshot ↗

Example request

Use your supplied API base URL and replace path placeholders such as {id}. These examples run in your backend or terminal, where your credentials are kept.

curl --globoff --request POST "${API_BASE_URL}/jsonapi/contact-groups/{contactGroupId}/financial-snapshot" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "UserId: $ADVISER_CONTACT_ID" \
--header 'Accept: application/vnd.api+json' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "financial-snapshots",
"attributes": {
"assetsMode": "Merge",
"assets": [
{
"lid": "string",
"assetId": 1,
"assetTypeId": 1,
"assetSubTypeId": 1,
"description": "string",
"value": 1,
"institution": "string",
"accountName": "string",
"bsb": "string",
"accountNumber": "string",
"vehicleMake": "string",
"vehicleYear": 1,
"propertyTypeId": 1,
"propertyPrimaryPurpose": "PurchaseOwnerOccupied",
"valueBasis": "ApplicantEstimate",
"address": {
"lid": "string"
},
"ownership": [
{
"id": 1
}
]
}
],
"expensesMode": "Merge",
"expenses": [
{
"lid": "string",
"expenseId": 1,
"expenseTypeId": 1,
"description": "string",
"value": 1,
"frequency": "Yearly",
"ownership": [
{
"id": 1
}
]
}
],
"incomesMode": "Merge",
"incomes": [
{
"lid": "string",
"incomeId": 1,
"incomeTypeId": 1,
"description": "string",
"value": 1,
"frequency": "Yearly",
"nzIsGross": false,
"nzRentalType": "RentalIncome",
"isEvidenceOfTenancy": false,
"nzRentalVerificationTypeId": 1,
"incomeVerificationId": 1,
"ownership": [
{
"id": 1
}
],
"linkedAsset": {
"lid": "string",
"id": 1
},
"employment": {
"lid": "string",
"id": 1
}
}
],
"liabilitiesMode": "Merge",
"liabilities": [
{
"lid": "string",
"liabilityId": 1,
"liabilityTypeId": 1,
"liabilitySubTypeId": 1,
"accountName": "string",
"bsb": "string",
"accountNumber": "string",
"value": 1,
"limit": 1,
"repayment": 1,
"repaymentFrequency": "Yearly",
"interestRate": 1,
"interestTaxDeductible": false,
"creditorName": "string",
"loanTerm": 1,
"loanRepaymentType": "InterestOnly",
"mortgagePriority": "First",
"nzIsInArrears": false,
"nzLoanStartDate": "2026-01-15",
"nzDocumentedLoanTermMonths": 1,
"nzInterestOnlyStartDate": "2026-01-15",
"nzInterestOnlyTermMonths": 1,
"nzRevolvingCreditRedraw": false,
"isClearingFromThisLoan": false,
"linkedAsset": {
"lid": "string",
"id": 1
},
"ownership": [
{
"id": 1
}
]
}
],
"employmentsMode": "Merge",
"employments": [
{
"lid": "string",
"employmentId": 1,
"contactId": 1,
"employmentStatus": "PrimaryEmployment",
"employmentType": "PAYG",
"dateStarted": "2026-01-15",
"dateEnded": "2026-01-15",
"employmentRoleName": "string",
"employmentBasis": "FullTime",
"isProbation": false,
"businessNumber": "string",
"companyNumber": "string",
"employerName": "string",
"employerContactTitle": "Mr",
"employerContactFirstName": "string",
"employerContactLastName": "string",
"employerType": "Private",
"employerPhone": "string",
"address": {
"lid": "string"
}
}
],
"addresses": [
{
"lid": "string",
"formattedAddress": "string",
"streetAddress": "string",
"suburb": "string",
"state": "string",
"postCode": "stri",
"country": "string"
}
]
}
}
}'

Responses

200 response

application/vnd.api+json

200 responseobjectFinancialSnapshotDocument ↗
metaobjectread only
jsonApiobjectread only
linksall ofread only
dataobjectrequiredFinancialSnapshot ↗
includedarray · nullableread only

For guidance beyond this operation's schema, see troubleshooting and JSON:API explained.