Updates the attributes and/or relationships of an existing deal structure. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced

PATCH/jsonapi/deal-structures/{id}

Where id is the identifier of the deal structure

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

id path required

·idinteger

format: int32

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. Send only the attributes or relationships you want to change, and match data.id to the ID in the URL.

{
  "data": {
    "type": "deal-structures",
    "id": "1001",
    "attributes": {
      "rateTermYears": 1,
      "loanStructureType": "PrincipalInterest",
      "interestRate": 1,
      "amount": 1,
      "rateType": "string",
      "paymentAmount": 1,
      "accountNumber": "string",
      "capitaliseLmi": false,
      "isLinkRateExpiry": false,
      "repaymentFrequency": "Yearly",
      "lmiPremium": 1,
      "fixedRateExpiryDate": "2026-01-15",
      "fixedRateBeginDate": "2026-01-15",
      "loanTermYears": 1,
      "interestOnlyTermYears": 1
    }
  }
}

Request documentobjectDealStructurePatchDocument ↗

dataobjectrequiredDealStructurePatch ↗

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 PATCH "${API_BASE_URL}/jsonapi/deal-structures/{id}" \
  --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": "deal-structures",
    "id": "1001",
    "attributes": {
      "rateTermYears": 1,
      "loanStructureType": "PrincipalInterest",
      "interestRate": 1,
      "amount": 1,
      "rateType": "string",
      "paymentAmount": 1,
      "accountNumber": "string",
      "capitaliseLmi": false,
      "isLinkRateExpiry": false,
      "repaymentFrequency": "Yearly",
      "lmiPremium": 1,
      "fixedRateExpiryDate": "2026-01-15",
      "fixedRateBeginDate": "2026-01-15",
      "loanTermYears": 1,
      "interestOnlyTermYears": 1
    }
  }
}'

Responses

200 response

application/vnd.api+json

200 responseobjectDealStructureDocument ↗

metaobjectread only

jsonApiobjectread only

linksall ofread only

dataobjectrequiredDealStructure ↗

includedarray · nullableread only

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