Doc 1383/add documentation and a guide about updating a capital deposit

docs/topics/capital-deposits/guide-update-shareholder-amount.mdx

@@ -0,0 +1,67 @@
+---
+title: Update a deposit amount
+---
+
+# Update a shareholder's capital deposit amount
+
+Use the API to update the deposit amount associated with a shareholder in a capital deposit case.
+
+import UpdateShareholderPrereqs from './partials/_update-shareholder-prereqs.mdx';
+
+:::tip Prerequisites
+<UpdateShareholderPrereqs />
+:::
+
+## Guide {#steps}
+
+1. Call the `updateCapitalDepositShareholderAmount` mutation (line 2).
+1. Add the shareholder ID (line 3).
+1. Add the updated amount in the `amount` field (line 3).
+1. Add the `UpdateCapitalDepositShareholderAmountSuccessPayload` and any information you'd like to receive.
+1. Add rejections (not shown).
+
+:::info Automatic recalculation
+Updating a shareholder's deposit amount automatically triggers a recalculation of the total capital deposit amount for the case.
+:::
+
+## Mutation {#mutation}
+
+<a href="https://explorer.swan.io?query=bXV0YXRpb24gVXBkYXRlU2hhcmVob2xkZXJBbW91bnQgewogIHVwZGF0ZUNhcGl0YWxEZXBvc2l0U2hhcmVob2xkZXJBbW91bnQoCiAgICBpbnB1dDogeyBpZDogIiRTSEFSRUhPTERFUl9JRCIsIGFtb3VudDogeyBjdXJyZW5jeTogIkVVUiIsIHZhbHVlOiAiMTAwMCIgfSB9CiAgKSB7CiAgICAuLi4gb24gVXBkYXRlQ2FwaXRhbERlcG9zaXRTaGFyZWhvbGRlckFtb3VudFN1Y2Nlc3NQYXlsb2FkIHsKICAgICAgX190eXBlbmFtZQogICAgICBzaGFyZWhvbGRlciB7CiAgICAgICAgaWQKICAgICAgICBjYXBpdGFsRGVwb3NpdEFtb3VudCB7CiAgICAgICAgICBjdXJyZW5jeQogICAgICAgICAgdmFsdWUKICAgICAgICB9CiAgICAgIH0KICAgIH0KICAgIC4uLiBvbiBGb3JiaWRkZW5SZWplY3Rpb24gewogICAgICBfX3R5cGVuYW1lCiAgICAgIG1lc3NhZ2UKICAgIH0KICAgIC4uLiBvbiBJbnRlcm5hbEVycm9yUmVqZWN0aW9uIHsKICAgICAgX190eXBlbmFtZQogICAgICBtZXNzYWdlCiAgICB9CiAgICAuLi4gb24gQ2FwaXRhbERlcG9zaXRTaGFyZWhvbGRlck5vdEZvdW5kUmVqZWN0aW9uIHsKICAgICAgaWQKICAgICAgbWVzc2FnZQogICAgfQogICAgLi4uIG9uIENhcGl0YWxEZXBvc2l0U2hhcmVob2xkZXJDYW5Ob3RCZVVwZGF0ZWRSZWplY3Rpb24gewogICAgICBpZAogICAgICBtZXNzYWdlCiAgICB9CiAgfQp9Cg%3D%3D&tab=api" className="explorer-badge">Open in API Explorer</a>
+
+```graphql {2-3} showLineNumbers
+mutation UpdateShareholderAmount {
+  updateCapitalDepositShareholderAmount(
+    input: { id: "$SHAREHOLDER_ID", amount: { currency: "EUR", value: "1000" } }
+  ) {
+    ... on UpdateCapitalDepositShareholderAmountSuccessPayload {
+      __typename
+      shareholder {
+        id
+        capitalDepositAmount {
+          currency
+          value
+        }
+      }
+    }
+  }
+}
+```
+
+## Payload {#payload}
+
+```graphql {6,8-10} showLineNumbers
+{
+  "data": {
+    "updateCapitalDepositShareholderAmount": {
+      "__typename": "UpdateCapitalDepositShareholderAmountSuccessPayload",
+      "shareholder": {
+        "id": "$SHAREHOLDER_ID",
+        "capitalDepositAmount": {
+          "currency": "EUR",
+          "value": "1000"
+        }
+      }
+    }
+  }
+}
+```

docs/topics/capital-deposits/index.mdx

@@ -269,6 +269,18 @@ participant N as Notary
     N -->> S: Transfers funds to Swan company account
 ```
 
+## Updating a shareholder's deposit amount {#update-amount}
+
+You can update a shareholder's deposit amount directly through the API.
+
+import UpdateShareholderPrereqs from './partials/_update-shareholder-prereqs.mdx';
+
+<UpdateShareholderPrereqs />
+
+Updating a shareholder's deposit amount automatically triggers a recalculation of the total capital deposit amount for the case.
+
+Follow the guide to [update a shareholder's capital deposit amount](./guide-update-shareholder-amount.mdx).
+
 ## Canceling a capital deposit {#cancel}
 
 If needed, it's possible to cancel an ongoing capital deposit.

docs/topics/capital-deposits/partials/_update-shareholder-prereqs.mdx

@@ -0,0 +1,6 @@
+<p>All of the following conditions must be met:</p>
+
+<ol>
+<li>The capital deposit [case status](../index.mdx#case-statuses) is `WaitingForInitialRequirements`, `PendingInternalReview`, or `WaitingForAdditionalInformation`.</li>
+<li>The [shareholder status](../index.mdx#shareholders-statuses) is `PendingOnboarding`, `WaitingForVerification`, or `WaitingForTransfer`.</li>
+</ol>

sidebars.js

@@ -191,6 +191,7 @@ module.exports = {
           link: { type: "doc", id: "topics/capital-deposits/index" },
           collapsed: true,
           items: [
+            "topics/capital-deposits/guide-update-shareholder-amount",
             "topics/capital-deposits/guide-cancel",
           ],
         },
@@ -788,4 +789,4 @@ module.exports = {
       ],
     },
   ],
-};
+};