Skip to main content

API releases — 2022

All API releases · How to read this history

8 November 2022 — External integration references and notifications​

  • Lead and structured lead inputs gain externalIntegration, externalIntegrationAllowCreate and externalReference.
  • The external integration name supports up to 100 characters and the external reference up to 255.
  • sendNotification is corrected from read-only to write-only, making its intended use as an input explicit.

387 operations after this release · 0 added · 0 removed · 0 updated. Schema changes are counted separately below.

Schema details — 0 added, 0 removed, 2 updated

Updated schemas and changed locations

  • LeadAttributes: /properties/externalIntegration, /properties/externalIntegrationAllowCreate, /properties/externalReference, /properties/sendNotification/readOnly, /properties/sendNotification/writeOnly
  • StructuredLeadAttributes: /properties/externalIntegration, /properties/externalIntegrationAllowCreate, /properties/externalReference, /properties/sendNotification/readOnly, /properties/sendNotification/writeOnly

4 October 2022 — Additional lead source context​

  • Adds sourceAdditionalDetails, up to 255 characters, to contact-group, lead and structured lead attributes.
  • The lead input models mark this additional source context as write-only.

387 operations after this release · 0 added · 0 removed · 0 updated. Schema changes are counted separately below.

Schema details — 0 added, 0 removed, 3 updated

Updated schemas and changed locations

  • ContactGroupAttributes: /properties/sourceAdditionalDetails
  • LeadAttributes: /properties/sourceAdditionalDetails
  • StructuredLeadAttributes: /properties/sourceAdditionalDetails

24 August 2022 — Lead notification field​

  • Adds sendNotification to lead and structured lead schemas. This revision marks it read-only; the November release corrects it to an input field.

387 operations after this release · 0 added · 0 removed · 0 updated. Schema changes are counted separately below.

Schema details — 0 added, 0 removed, 2 updated

Updated schemas and changed locations

  • LeadAttributes: /properties/sendNotification
  • StructuredLeadAttributes: /properties/sendNotification

4 August 2022 — Non-empty resource identifiers​

  • Resource identifiers require non-empty id and type values.
  • The local lid identifier on structured lead address, asset, contact and employment reference models must also be non-empty.

Compatibility: Do not send empty strings for resource or local identifiers.

387 operations after this release · 0 added · 0 removed · 0 updated. Schema changes are counted separately below.

Schema details — 0 added, 0 removed, 6 updated

Updated schemas and changed locations

  • IncludedResource: /properties/type/minLength
  • LeadAddressReference: /properties/lid/minLength
  • LeadAssetReference: /properties/lid/minLength
  • LeadContactReference: /properties/lid/minLength
  • LeadEmploymentReference: /properties/lid/minLength
  • ResourceIdentifier: /properties/id/minLength, /properties/type/minLength

26 July 2022 — Lead address input​

  • Adds the write-only formattedAddress lead input, accepting up to 500 characters.

387 operations after this release · 0 added · 0 removed · 0 updated. Schema changes are counted separately below.

Schema details — 0 added, 0 removed, 1 updated

Updated schemas and changed locations

  • LeadAttributes: /properties/formattedAddress

5 May 2022 — Contact address relationships​

  • Contact addresses use a contacts relationship. An obsolete address relationship and its supporting schema are removed from the contract.

Compatibility: Review contact and contact-address relationship handling against the updated models.

387 operations after this release · 0 added · 0 removed · 0 updated. Schema changes are counted separately below.

Schema details — 0 added, 1 removed, 2 updated

Removed schemas

  • ApiAddressClientEntity

Updated schemas and changed locations

  • ContactAddressRelationships: /properties/apiAddressClientEntity, /properties/contacts
  • ContactRelationships: /properties/apiAddressClientEntity

3 May 2022 — JSON:API error and document schemas​

  • Refreshes shared JSON:API document and resource schemas, replacing the earlier error models with ErrorObject.
  • Error links gain a type link, error sources gain header, and the top-level described-by link is named describedby.

Compatibility: Regenerate typed clients that use the former error models or the describedBy spelling.

387 operations after this release · 0 added · 0 removed · 0 updated. Schema changes are counted separately below.

Schema details — 9 added, 2 removed, 8 updated

Added schemas

  • ApiFamilyFranchisee
  • ErrorObject
  • RelationshipObject
  • ResourceObject
  • ResourceObjectAttributes
  • ResourceObjectDocument
  • ResourceObjectRelationships
  • ResourceObjectsDocument
  • SingleOrManyData`1

Removed schemas

  • Error
  • ErrorMeta

Updated schemas and changed locations

  • AdviserRelationships: /properties/familyFranchisees
  • AgreementHolderRelationships: /properties/apiFamilyFranchisees
  • ContactAddressRelationships: /properties/apiAddressClientEntity, /properties/contactAddress
  • ContactRelationships: /properties/apiAddressClientEntity
  • ErrorDocument: /properties/errors/items/$ref, /properties/links
  • ErrorLinks: /properties/type
  • ErrorSource: /properties/header
  • TopLevelLinks: /properties/describedBy, /properties/describedby

13 April 2022 — References within structured lead payloads​

  • Introduces dedicated address, asset, contact and employment reference models for nested structured lead data.
  • Updates links between lead assets, contacts, employments, incomes and liabilities to use those reference models.

Compatibility: Review nested objects and ownership references when generating or serialising structured lead requests.

387 operations after this release · 0 added · 0 removed · 0 updated. Schema changes are counted separately below.

Schema details — 4 added, 0 removed, 7 updated

Added schemas

  • LeadAddressReference
  • LeadAssetReference
  • LeadContactReference
  • LeadEmploymentReference

Updated schemas and changed locations

  • DealNoteAttributes: /properties/title/maxLength
  • LeadAsset: /properties/address/$ref, /properties/ownership/items/$ref
  • LeadContact: /properties/addresses/items/$ref, /properties/employments/items/$ref
  • LeadEmployment: /properties/address/$ref
  • LeadExpense: /properties/ownership/items/$ref
  • LeadIncome: /properties/asset/$ref, /properties/employment/$ref, /properties/ownership/items/$ref
  • LeadLiability: /properties/asset/$ref, /properties/ownership/items/$ref

7 April 2022 — More complete structured leads​

  • Adds GET and HEAD access to property types and their generic relationship routes.
  • Structured leads gain employment, income and liability collections. Contacts gain additional phone and email fields, while lead contacts gain employment details.
  • Lead assets gain address, property purpose, type, zoning and value-basis fields. Lead address and contact fields receive explicit length limits.

Compatibility: Lead asset and expense ownership shapes change, and several earlier asset flags and the property-type enum are removed. Review structured lead payloads against this release’s OpenAPI Specification.

387 operations after this release · 8 added · 0 removed · 0 updated. Schema changes are counted separately below.

Endpoint details

Added

  • GET /jsonapi/property-types
  • GET /jsonapi/property-types/{id}
  • GET /jsonapi/property-types/{id}/relationships/{relationshipName}
  • GET /jsonapi/property-types/{id}/{relationshipName}
  • HEAD /jsonapi/property-types
  • HEAD /jsonapi/property-types/{id}
  • HEAD /jsonapi/property-types/{id}/relationships/{relationshipName}
  • HEAD /jsonapi/property-types/{id}/{relationshipName}
Schema details — 19 added, 2 removed, 9 updated

Added schemas

  • ApiClientEntityEmployment
  • EmployerType
  • EmploymentBasis
  • EmploymentStatus
  • EmploymentType
  • IncomeVerificationEnum
  • LeadEmployment
  • LeadIncome
  • LeadLiability
  • MortgagePriority
  • PropertyPrimaryPurpose
  • PropertyType
  • PropertyTypeAttributes
  • PropertyTypeDocument
  • PropertyTypeRelationships
  • PropertyTypesDocument
  • PropertyTypesEntityType
  • PropertyValueEstimatedBasis
  • PropertyZoningTypesEntityType

Removed schemas

  • AddressPropertyType
  • LeadOwnership

Updated schemas and changed locations

  • BusinessRelationships: /properties/employments
  • ContactAttributes: /properties/businessPhone, /properties/homePhone, /properties/secondaryEmail
  • ContactRelationships: /properties/employments
  • IncludedResource: /discriminator/mapping/property-types
  • LeadAddress: /properties/country/maxLength, /properties/country/minLength, /properties/formattedAddress/maxLength, /properties/formattedAddress/minLength, /properties/postCode/maxLength, /properties/postCode/minLength, /properties/state/maxLength, /properties/state/minLength, /properties/streetAddress/maxLength, /properties/streetAddress/minLength, /properties/suburb/maxLength, /properties/suburb/minLength
  • LeadAsset: /properties/address, /properties/description/maxLength, /properties/description/minLength, /properties/isAccountDetailsKnown, /properties/isExistingMortgages, /properties/isRentalIncome, /properties/ownership/items/$ref, /properties/propertyPrimaryPurpose, /properties/propertyType, /properties/propertyTypeId, /properties/propertyZoningId, /properties/valueBasis
  • LeadContact: /properties/businessPhone, /properties/email/maxLength, /properties/email/minLength, /properties/employments, /properties/firstName/maxLength, /properties/firstName/minLength, /properties/homePhone, /properties/lastName/maxLength, /properties/lastName/minLength, /properties/mobile/maxLength, /properties/mobile/minLength, /properties/preferredName/maxLength, /properties/preferredName/minLength
  • LeadExpense: /properties/ownership/items/$ref
  • StructuredLeadAttributes: /properties/employments, /properties/incomes, /properties/liabilities

5 April 2022 — Richer adviser, contact and opportunity details​

  • Adviser details gain country and website information; adviser-detail and contact schemas gain gender fields.
  • Contacts gain primary-contact and role fields. High-level summaries and opportunities gain loanPurpose.

379 operations after this release · 0 added · 0 removed · 0 updated. Schema changes are counted separately below.

Schema details — 3 added, 0 removed, 5 updated

Added schemas

  • ContactRole
  • CountryCode
  • GenderCode

Updated schemas and changed locations

  • AdviserAttributes: /properties/countryCode, /properties/website
  • AdviserDetailAttributes: /properties/gender
  • ContactAttributes: /properties/gender, /properties/isPrimary, /properties/role
  • HighLevelSummaryAttributes: /properties/loanPurpose
  • Opportunity: /properties/loanPurpose

16 February 2022 — Financial relationship cleanup​

  • Removes the financial relationship from asset, expense, income, liability and owner response models.

Compatibility: Clients should not rely on the removed relationship being present in these resources.

379 operations after this release · 0 added · 0 removed · 0 updated. Schema changes are counted separately below.

Schema details — 0 added, 0 removed, 5 updated

Updated schemas and changed locations

  • AssetRelationships: /properties/financial
  • ExpenseRelationships: /properties/financial
  • IncomeRelationships: /properties/financial
  • LiabilityRelationships: /properties/financial
  • OwnerRelationships: /properties/financial

15 February 2022 — Clearer relationship descriptions​

  • Adds descriptions explaining which parent record identifies each related-resource and relationship request.
  • This is a reference clarification; operation availability and schemas are unchanged.

379 operations after this release · 0 added · 0 removed · 68 updated. Schema changes are counted separately below.

Endpoint details

Updated definitions

  • GET /jsonapi/adviser-details/{id}/adviser
  • GET /jsonapi/adviser-details/{id}/relationships/adviser
  • GET /jsonapi/advisers/{id}/addresses
  • GET /jsonapi/advisers/{id}/adviserDetails
  • GET /jsonapi/advisers/{id}/agreementHolders
  • GET /jsonapi/advisers/{id}/contactGroups
  • GET /jsonapi/advisers/{id}/organisation
  • GET /jsonapi/advisers/{id}/relationships/addresses
  • GET /jsonapi/advisers/{id}/relationships/adviserDetails
  • GET /jsonapi/advisers/{id}/relationships/agreementHolders
  • GET /jsonapi/advisers/{id}/relationships/contactGroups
  • GET /jsonapi/advisers/{id}/relationships/organisation
  • GET /jsonapi/asset-categories/{id}/relationships/{relationshipName}
  • GET /jsonapi/asset-categories/{id}/{relationshipName}
  • GET /jsonapi/asset-sub-types/{id}/relationships/{relationshipName}
  • GET /jsonapi/asset-sub-types/{id}/{relationshipName}
  • GET /jsonapi/asset-types/{id}/relationships/{relationshipName}
  • GET /jsonapi/asset-types/{id}/{relationshipName}
  • GET /jsonapi/assets/{id}/addresses
  • GET /jsonapi/assets/{id}/ownership
  • GET /jsonapi/assets/{id}/relationships/addresses
  • GET /jsonapi/assets/{id}/relationships/ownership
  • GET /jsonapi/deal-participants/{id}/contact
  • GET /jsonapi/deal-participants/{id}/deal
  • GET /jsonapi/deal-participants/{id}/relationships/contact
  • GET /jsonapi/deal-participants/{id}/relationships/deal
  • GET /jsonapi/deals/{id}/adviser
  • GET /jsonapi/deals/{id}/contacts
  • GET /jsonapi/deals/{id}/dealNotes
  • GET /jsonapi/deals/{id}/dealScenario
  • GET /jsonapi/deals/{id}/dealStructures
  • GET /jsonapi/deals/{id}/externalReferences
  • GET /jsonapi/deals/{id}/importantDates
  • GET /jsonapi/deals/{id}/participants
  • GET /jsonapi/deals/{id}/relationships/adviser
  • GET /jsonapi/deals/{id}/relationships/contacts
  • GET /jsonapi/deals/{id}/relationships/dealNotes
  • GET /jsonapi/deals/{id}/relationships/dealScenario
  • GET /jsonapi/deals/{id}/relationships/dealStructures
  • GET /jsonapi/deals/{id}/relationships/externalReferences
  • GET /jsonapi/deals/{id}/relationships/importantDates
  • GET /jsonapi/deals/{id}/relationships/participants
  • GET /jsonapi/expense-categories/{id}/expenseTypes
  • GET /jsonapi/expense-categories/{id}/relationships/expenseTypes
  • GET /jsonapi/expense-types/{id}/expenseCategory
  • GET /jsonapi/expense-types/{id}/relationships/expenseCategory
  • GET /jsonapi/expenses/{id}/ownership
  • GET /jsonapi/expenses/{id}/relationships/ownership
  • GET /jsonapi/income-categories/{id}/incomeTypes
  • GET /jsonapi/income-categories/{id}/relationships/incomeTypes
  • GET /jsonapi/income-types/{id}/incomeCategory
  • GET /jsonapi/income-types/{id}/relationships/incomeCategory
  • GET /jsonapi/incomes/{id}/linkedAsset
  • GET /jsonapi/incomes/{id}/ownership
  • GET /jsonapi/incomes/{id}/relationships/linkedAsset
  • GET /jsonapi/incomes/{id}/relationships/ownership
  • GET /jsonapi/liabilities/{id}/linkedAsset
  • GET /jsonapi/liabilities/{id}/ownership
  • GET /jsonapi/liabilities/{id}/relationships/linkedAsset
  • GET /jsonapi/liabilities/{id}/relationships/ownership
  • GET /jsonapi/liability-categories/{id}/liabilityTypes
  • GET /jsonapi/liability-categories/{id}/relationships/liabilityTypes
  • GET /jsonapi/liability-types/{id}/liabilityCategory
  • GET /jsonapi/liability-types/{id}/relationships/liabilityCategory
  • GET /jsonapi/organisations/{id}/addresses
  • GET /jsonapi/organisations/{id}/relationships/addresses
  • GET /jsonapi/referrers/{id}/relationships/{relationshipName}
  • GET /jsonapi/referrers/{id}/{relationshipName}

15 February 2022 — Directory coverage and supported operations​

  • Expands adviser, adviser-detail, organisation and referrer coverage, along with related-resource and relationship lookup routes.
  • Removes write operations for assets, deals, deal participants, expenses, incomes and liabilities from the contract, and removes the contact-group-referrer routes.

Compatibility: This revision adds 76 operations and removes 83. Check the endpoint list below if your integration used one of the removed operations.

379 operations after this release · 76 added · 83 removed · 40 updated. Schema changes are counted separately below.

Endpoint details

Added

  • GET /jsonapi/advisers/{id}/addresses
  • GET /jsonapi/advisers/{id}/adviserDetails
  • GET /jsonapi/advisers/{id}/agreementHolders
  • GET /jsonapi/advisers/{id}/contactGroups
  • GET /jsonapi/advisers/{id}/organisation
  • GET /jsonapi/advisers/{id}/relationships/addresses
  • GET /jsonapi/advisers/{id}/relationships/adviserDetails
  • GET /jsonapi/advisers/{id}/relationships/agreementHolders
  • GET /jsonapi/advisers/{id}/relationships/contactGroups
  • GET /jsonapi/advisers/{id}/relationships/organisation
  • GET /jsonapi/asset-categories/{id}/relationships/{relationshipName}
  • GET /jsonapi/asset-categories/{id}/{relationshipName}
  • GET /jsonapi/asset-sub-types/{id}/relationships/{relationshipName}
  • GET /jsonapi/asset-sub-types/{id}/{relationshipName}
  • GET /jsonapi/asset-types/{id}/relationships/{relationshipName}
  • GET /jsonapi/asset-types/{id}/{relationshipName}
  • GET /jsonapi/expense-categories/{id}/expenseTypes
  • GET /jsonapi/expense-categories/{id}/relationships/expenseTypes
  • GET /jsonapi/expense-types/{id}/expenseCategory
  • GET /jsonapi/expense-types/{id}/relationships/expenseCategory
  • GET /jsonapi/income-categories/{id}/incomeTypes
  • GET /jsonapi/income-categories/{id}/relationships/incomeTypes
  • GET /jsonapi/income-types/{id}/incomeCategory
  • GET /jsonapi/income-types/{id}/relationships/incomeCategory
  • GET /jsonapi/liability-categories/{id}/liabilityTypes
  • GET /jsonapi/liability-categories/{id}/relationships/liabilityTypes
  • GET /jsonapi/liability-types/{id}/liabilityCategory
  • GET /jsonapi/liability-types/{id}/relationships/liabilityCategory
  • GET /jsonapi/organisations/{id}/addresses
  • GET /jsonapi/organisations/{id}/relationships/addresses
  • GET /jsonapi/referrers
  • GET /jsonapi/referrers/{id}
  • GET /jsonapi/referrers/{id}/relationships/{relationshipName}
  • GET /jsonapi/referrers/{id}/{relationshipName}
  • HEAD /jsonapi/adviser-details
  • HEAD /jsonapi/adviser-details/{id}
  • HEAD /jsonapi/adviser-details/{id}/adviser
  • HEAD /jsonapi/adviser-details/{id}/relationships/adviser
  • HEAD /jsonapi/advisers
  • HEAD /jsonapi/advisers/{id}
  • HEAD /jsonapi/advisers/{id}/addresses
  • HEAD /jsonapi/advisers/{id}/adviserDetails
  • HEAD /jsonapi/advisers/{id}/agreementHolders
  • HEAD /jsonapi/advisers/{id}/contactGroups
  • HEAD /jsonapi/advisers/{id}/organisation
  • HEAD /jsonapi/advisers/{id}/relationships/addresses
  • HEAD /jsonapi/advisers/{id}/relationships/adviserDetails
  • HEAD /jsonapi/advisers/{id}/relationships/agreementHolders
  • HEAD /jsonapi/advisers/{id}/relationships/contactGroups
  • HEAD /jsonapi/advisers/{id}/relationships/organisation
  • HEAD /jsonapi/asset-categories/{id}/relationships/{relationshipName}
  • HEAD /jsonapi/asset-categories/{id}/{relationshipName}
  • HEAD /jsonapi/asset-sub-types/{id}/relationships/{relationshipName}
  • HEAD /jsonapi/asset-sub-types/{id}/{relationshipName}
  • HEAD /jsonapi/asset-types/{id}/relationships/{relationshipName}
  • HEAD /jsonapi/asset-types/{id}/{relationshipName}
  • HEAD /jsonapi/expense-categories/{id}/expenseTypes
  • HEAD /jsonapi/expense-categories/{id}/relationships/expenseTypes
  • HEAD /jsonapi/expense-types/{id}/expenseCategory
  • HEAD /jsonapi/expense-types/{id}/relationships/expenseCategory
  • HEAD /jsonapi/income-categories/{id}/incomeTypes
  • HEAD /jsonapi/income-categories/{id}/relationships/incomeTypes
  • HEAD /jsonapi/income-types/{id}/incomeCategory
  • HEAD /jsonapi/income-types/{id}/relationships/incomeCategory
  • HEAD /jsonapi/liability-categories/{id}/liabilityTypes
  • HEAD /jsonapi/liability-categories/{id}/relationships/liabilityTypes
  • HEAD /jsonapi/liability-types/{id}/liabilityCategory
  • HEAD /jsonapi/liability-types/{id}/relationships/liabilityCategory
  • HEAD /jsonapi/organisations
  • HEAD /jsonapi/organisations/{id}
  • HEAD /jsonapi/organisations/{id}/addresses
  • HEAD /jsonapi/organisations/{id}/relationships/addresses
  • HEAD /jsonapi/referrers
  • HEAD /jsonapi/referrers/{id}
  • HEAD /jsonapi/referrers/{id}/relationships/{relationshipName}
  • HEAD /jsonapi/referrers/{id}/{relationshipName}

Removed

  • DELETE /jsonapi/assets/{id}
  • DELETE /jsonapi/assets/{id}/relationships/addresses
  • DELETE /jsonapi/assets/{id}/relationships/ownership
  • DELETE /jsonapi/contact-group-referrers/{id}
  • DELETE /jsonapi/contact-group-referrers/{id}/relationships/{relationshipName}
  • DELETE /jsonapi/deal-participants/{id}
  • DELETE /jsonapi/deal-participants/{id}/relationships/contact
  • DELETE /jsonapi/deal-participants/{id}/relationships/deal
  • DELETE /jsonapi/deals/{id}
  • DELETE /jsonapi/deals/{id}/relationships/adviser
  • DELETE /jsonapi/deals/{id}/relationships/contacts
  • DELETE /jsonapi/deals/{id}/relationships/dealNotes
  • DELETE /jsonapi/deals/{id}/relationships/dealScenario
  • DELETE /jsonapi/deals/{id}/relationships/dealStructures
  • DELETE /jsonapi/deals/{id}/relationships/externalReferences
  • DELETE /jsonapi/deals/{id}/relationships/importantDates
  • DELETE /jsonapi/deals/{id}/relationships/participants
  • DELETE /jsonapi/expenses/{id}
  • DELETE /jsonapi/expenses/{id}/relationships/ownership
  • DELETE /jsonapi/incomes/{id}
  • DELETE /jsonapi/incomes/{id}/relationships/linkedAsset
  • DELETE /jsonapi/incomes/{id}/relationships/ownership
  • DELETE /jsonapi/liabilities/{id}
  • DELETE /jsonapi/liabilities/{id}/relationships/linkedAsset
  • DELETE /jsonapi/liabilities/{id}/relationships/ownership
  • GET /jsonapi/contact-group-referrers
  • GET /jsonapi/contact-group-referrers/{id}
  • GET /jsonapi/contact-group-referrers/{id}/relationships/{relationshipName}
  • GET /jsonapi/contact-group-referrers/{id}/{relationshipName}
  • HEAD /jsonapi/contact-group-referrers
  • HEAD /jsonapi/contact-group-referrers/{id}
  • HEAD /jsonapi/contact-group-referrers/{id}/relationships/{relationshipName}
  • HEAD /jsonapi/contact-group-referrers/{id}/{relationshipName}
  • PATCH /jsonapi/assets/{id}
  • PATCH /jsonapi/assets/{id}/relationships/addresses
  • PATCH /jsonapi/assets/{id}/relationships/ownership
  • PATCH /jsonapi/contact-group-referrers/{id}
  • PATCH /jsonapi/contact-group-referrers/{id}/relationships/{relationshipName}
  • PATCH /jsonapi/deal-participants/{id}
  • PATCH /jsonapi/deal-participants/{id}/relationships/contact
  • PATCH /jsonapi/deal-participants/{id}/relationships/deal
  • PATCH /jsonapi/deals/{id}
  • PATCH /jsonapi/deals/{id}/relationships/adviser
  • PATCH /jsonapi/deals/{id}/relationships/contacts
  • PATCH /jsonapi/deals/{id}/relationships/dealNotes
  • PATCH /jsonapi/deals/{id}/relationships/dealScenario
  • PATCH /jsonapi/deals/{id}/relationships/dealStructures
  • PATCH /jsonapi/deals/{id}/relationships/externalReferences
  • PATCH /jsonapi/deals/{id}/relationships/importantDates
  • PATCH /jsonapi/deals/{id}/relationships/participants
  • PATCH /jsonapi/expenses/{id}
  • PATCH /jsonapi/expenses/{id}/relationships/ownership
  • PATCH /jsonapi/incomes/{id}
  • PATCH /jsonapi/incomes/{id}/relationships/linkedAsset
  • PATCH /jsonapi/incomes/{id}/relationships/ownership
  • PATCH /jsonapi/liabilities/{id}
  • PATCH /jsonapi/liabilities/{id}/relationships/linkedAsset
  • PATCH /jsonapi/liabilities/{id}/relationships/ownership
  • POST /jsonapi/assets
  • POST /jsonapi/assets/{id}/relationships/addresses
  • POST /jsonapi/assets/{id}/relationships/ownership
  • POST /jsonapi/contact-group-referrers
  • POST /jsonapi/contact-group-referrers/{id}/relationships/{relationshipName}
  • POST /jsonapi/deal-participants
  • POST /jsonapi/deal-participants/{id}/relationships/contact
  • POST /jsonapi/deal-participants/{id}/relationships/deal
  • POST /jsonapi/deals
  • POST /jsonapi/deals/{id}/relationships/adviser
  • POST /jsonapi/deals/{id}/relationships/contacts
  • POST /jsonapi/deals/{id}/relationships/dealNotes
  • POST /jsonapi/deals/{id}/relationships/dealScenario
  • POST /jsonapi/deals/{id}/relationships/dealStructures
  • POST /jsonapi/deals/{id}/relationships/externalReferences
  • POST /jsonapi/deals/{id}/relationships/importantDates
  • POST /jsonapi/deals/{id}/relationships/participants
  • POST /jsonapi/expenses
  • POST /jsonapi/expenses/{id}/relationships/ownership
  • POST /jsonapi/incomes
  • POST /jsonapi/incomes/{id}/relationships/linkedAsset
  • POST /jsonapi/incomes/{id}/relationships/ownership
  • POST /jsonapi/liabilities
  • POST /jsonapi/liabilities/{id}/relationships/linkedAsset
  • POST /jsonapi/liabilities/{id}/relationships/ownership

Updated definitions

  • GET /jsonapi/adviser-details
  • GET /jsonapi/adviser-details/{id}
  • GET /jsonapi/adviser-details/{id}/adviser
  • GET /jsonapi/adviser-details/{id}/relationships/adviser
  • GET /jsonapi/advisers/{id}
  • GET /jsonapi/assets/{id}/addresses
  • GET /jsonapi/assets/{id}/ownership
  • GET /jsonapi/assets/{id}/relationships/addresses
  • GET /jsonapi/assets/{id}/relationships/ownership
  • GET /jsonapi/deal-participants/{id}/contact
  • GET /jsonapi/deal-participants/{id}/deal
  • GET /jsonapi/deal-participants/{id}/relationships/contact
  • GET /jsonapi/deal-participants/{id}/relationships/deal
  • GET /jsonapi/deals/{id}/adviser
  • GET /jsonapi/deals/{id}/contacts
  • GET /jsonapi/deals/{id}/dealNotes
  • GET /jsonapi/deals/{id}/dealScenario
  • GET /jsonapi/deals/{id}/dealStructures
  • GET /jsonapi/deals/{id}/externalReferences
  • GET /jsonapi/deals/{id}/importantDates
  • GET /jsonapi/deals/{id}/participants
  • GET /jsonapi/deals/{id}/relationships/adviser
  • GET /jsonapi/deals/{id}/relationships/contacts
  • GET /jsonapi/deals/{id}/relationships/dealNotes
  • GET /jsonapi/deals/{id}/relationships/dealScenario
  • GET /jsonapi/deals/{id}/relationships/dealStructures
  • GET /jsonapi/deals/{id}/relationships/externalReferences
  • GET /jsonapi/deals/{id}/relationships/importantDates
  • GET /jsonapi/deals/{id}/relationships/participants
  • GET /jsonapi/expenses/{id}/ownership
  • GET /jsonapi/expenses/{id}/relationships/ownership
  • GET /jsonapi/incomes/{id}/linkedAsset
  • GET /jsonapi/incomes/{id}/ownership
  • GET /jsonapi/incomes/{id}/relationships/linkedAsset
  • GET /jsonapi/incomes/{id}/relationships/ownership
  • GET /jsonapi/liabilities/{id}/linkedAsset
  • GET /jsonapi/liabilities/{id}/ownership
  • GET /jsonapi/liabilities/{id}/relationships/linkedAsset
  • GET /jsonapi/liabilities/{id}/relationships/ownership
  • GET /jsonapi/organisations/{id}
Schema details — 0 added, 6 removed, 2 updated

Removed schemas

  • ContactGroupReferrer
  • ContactGroupReferrerAttributes
  • ContactGroupReferrerDocument
  • ContactGroupReferrerRelationships
  • ContactGroupReferrersDocument
  • ContactGroupReferrersEntityType

Updated schemas and changed locations

  • FinancialRelationships: /properties/incomes
  • IncludedResource: /discriminator/mapping/contact-group-referrers

14 February 2022 — Asset classification lookups​

  • Adds collection and individual-record GET and HEAD operations for asset categories, asset types and asset sub-types.
  • Asset details gain classification identifiers. Structured lead asset schemas use assetTypeId and assetSubTypeId in place of the earlier enum fields.

Compatibility: Review clients that populated the former asset type and sub-type enum fields.

386 operations after this release · 12 added · 0 removed · 0 updated. Schema changes are counted separately below.

Endpoint details

Added

  • GET /jsonapi/asset-categories
  • GET /jsonapi/asset-categories/{id}
  • GET /jsonapi/asset-sub-types
  • GET /jsonapi/asset-sub-types/{id}
  • GET /jsonapi/asset-types
  • GET /jsonapi/asset-types/{id}
  • HEAD /jsonapi/asset-categories
  • HEAD /jsonapi/asset-categories/{id}
  • HEAD /jsonapi/asset-sub-types
  • HEAD /jsonapi/asset-sub-types/{id}
  • HEAD /jsonapi/asset-types
  • HEAD /jsonapi/asset-types/{id}
Schema details — 16 added, 0 removed, 5 updated

Added schemas

  • AssetCategoriesDocument
  • AssetCategoriesEntityType
  • AssetCategory
  • AssetCategoryAttributes
  • AssetCategoryDocument
  • AssetCategoryRelationships
  • AssetSubTypeAttributes
  • AssetSubTypeDocument
  • AssetSubTypeRelationships
  • AssetSubTypesDocument
  • AssetSubTypesEntityType
  • AssetTypeAttributes
  • AssetTypeDocument
  • AssetTypeRelationships
  • AssetTypesDocument
  • AssetTypesEntityType

Updated schemas and changed locations

  • AssetAttributes: /properties/assetCategory, /properties/assetCategoryId, /properties/assetSubTypeId, /properties/assetTypeId
  • AssetSubType: /additionalProperties, /allOf, /enum, /properties, /required, /type, /x-ms-enum
  • AssetType: /additionalProperties, /allOf, /enum, /properties, /required, /type, /x-ms-enum
  • IncludedResource: /discriminator/mapping/asset-categories, /discriminator/mapping/asset-sub-types, /discriminator/mapping/asset-types
  • LeadAsset: /properties/assetSubType, /properties/assetSubTypeId, /properties/assetType, /properties/assetTypeId

9 February 2022 — API naming refinement​

  • The specification title becomes “MyCRM API”. Endpoint definitions and schemas are unchanged.

374 operations after this release · 0 added · 0 removed · 0 updated. Schema changes are counted separately below.

9 February 2022 — Initial API reference​

  • The first preserved API contract covers leads and structured leads, contacts and contact groups, deals and notes, advisers and organisations, and financial resources.
  • Use this snapshot as the starting point for the release history. It does not establish when these capabilities were first introduced.

This is the earliest OpenAPI Specification snapshot in the repository: 374 operations across 121 paths. It establishes the comparison baseline; earlier API releases cannot be reconstructed from this repository.