diff --git a/docs/topics/capital-deposits/guide-update-company.mdx b/docs/topics/capital-deposits/guide-update-company.mdx
index 781017f17e..6d0819b34f 100644
--- a/docs/topics/capital-deposits/guide-update-company.mdx
+++ b/docs/topics/capital-deposits/guide-update-company.mdx
@@ -14,11 +14,11 @@ import UpdateCompanyPrereqs from './partials/_update-company-prereqs.mdx';
## Guide {#steps}
-1. Call the `updateCapitalDepositCompany` mutation.
+1. Call the `updateCapitalDepositCaseCompany` mutation.
1. Add the capital deposit case ID.
1. Add the fields you want to update: `companyName` and/or `residencyAddress`.
1. Add the success payload and any information you'd like to receive.
-1. Add rejections (not shown).
+1. Add rejections.
:::info Automatic synchronization
Updating these fields automatically syncs the data across both the capital deposit case and the associated account holder.
@@ -26,13 +26,13 @@ Updating these fields automatically syncs the data across both the capital depos
## Mutation {#mutation}
-Open in API Explorer
+Open in API Explorer
-```graphql {2-4} showLineNumbers
+```graphql {2-6,15} showLineNumbers
mutation UpdateCompany {
- updateCapitalDepositCompany(
+ updateCapitalDepositCaseCompany(
input: {
- id: "$CAPITAL_DEPOSIT_CASE_ID"
+ capitalDepositCaseId: "$CAPITAL_DEPOSIT_CASE_ID"
companyName: "Acme"
residencyAddress: {
addressLine1: "10 Rue de Rivoli"
@@ -43,7 +43,7 @@ mutation UpdateCompany {
}
}
) {
- ... on UpdateCapitalDepositCompanySuccessPayload {
+ ... on UpdateCapitalDepositCaseCompanySuccessPayload {
__typename
capitalDepositCase {
id
@@ -63,19 +63,39 @@ mutation UpdateCompany {
}
}
}
+ ... on CapitalDepositCaseCanNotBeFoundRejection {
+ __typename
+ message
+ }
+ ... on BadRequestRejection {
+ __typename
+ message
+ }
+ ... on ValidationRejection {
+ __typename
+ message
+ }
+ ... on ForbiddenRejection {
+ __typename
+ message
+ }
+ ... on InternalErrorRejection {
+ __typename
+ message
+ }
}
}
```
## Payload {#payload}
-```graphql {6-7,11,14-18} showLineNumbers
+```graphql {} showLineNumbers
{
"data": {
- "updateCapitalDepositCompany": {
- "__typename": "UpdateCapitalDepositCompanySuccessPayload",
+ "updateCapitalDepositCaseCompany": {
+ "__typename": "UpdateCapitalDepositCaseCompanySuccessPayload",
"capitalDepositCase": {
- "id": "$CAPITAL_DEPOSIT_CASE_ID",
+ "id": "a4c9da36-56e1-4ed8-b0a1-2c9f3d7e8b12",
"companyName": "Acme",
"companyOnboarding": {
"accountHolder": {
diff --git a/docs/topics/capital-deposits/guide-update-shareholder-amount.mdx b/docs/topics/capital-deposits/guide-update-shareholder-amount.mdx
index c9eb43802a..df2e077b49 100644
--- a/docs/topics/capital-deposits/guide-update-shareholder-amount.mdx
+++ b/docs/topics/capital-deposits/guide-update-shareholder-amount.mdx
@@ -15,10 +15,10 @@ import UpdateShareholderPrereqs from './partials/_update-shareholder-prereqs.mdx
## 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 shareholder ID (line 4).
+1. Add the updated amount in the `shareholderAmount` field (line 5).
1. Add the `UpdateCapitalDepositShareholderAmountSuccessPayload` and any information you'd like to receive.
-1. Add rejections (not shown).
+1. Add rejections.
:::info Automatic recalculation
Updating a shareholder's deposit amount automatically triggers a recalculation of the total capital deposit amount for the case.
@@ -26,12 +26,14 @@ Updating a shareholder's deposit amount automatically triggers a recalculation o
## Mutation {#mutation}
-Open in API Explorer
-
-```graphql {2-3} showLineNumbers
+Open in API Explorer
+```graphql {2-5,8} showLineNumbers
mutation UpdateShareholderAmount {
updateCapitalDepositShareholderAmount(
- input: { id: "$SHAREHOLDER_ID", amount: { currency: "EUR", value: "1000" } }
+ input: {
+ shareholderId: "$SHAREHOLDER_ID",
+ shareholderAmount: { currency: "EUR", value: "1000" }
+ }
) {
... on UpdateCapitalDepositShareholderAmountSuccessPayload {
__typename
@@ -43,22 +45,45 @@ mutation UpdateShareholderAmount {
}
}
}
+ ... on CapitalDepositCaseCanNotBeFoundRejection {
+ __typename
+ message
+ }
+ ... on CapitalDepositShareholderCannotBeFoundRejection {
+ __typename
+ message
+ }
+ ... on CapitalDepositShareholderCanNotBeUpdatedRejection {
+ __typename
+ message
+ }
+ ... on ValidationRejection {
+ __typename
+ message
+ }
+ ... on ForbiddenRejection {
+ __typename
+ message
+ }
+ ... on InternalErrorRejection {
+ __typename
+ message
+ }
}
}
```
## Payload {#payload}
-
-```graphql {6,8-10} showLineNumbers
+```graphql {6,8-9} showLineNumbers
{
"data": {
"updateCapitalDepositShareholderAmount": {
"__typename": "UpdateCapitalDepositShareholderAmountSuccessPayload",
"shareholder": {
- "id": "$SHAREHOLDER_ID",
+ "id": "fc995f3f-09aa-42e4-9e2f-c4e1185e6b57",
"capitalDepositAmount": {
"currency": "EUR",
- "value": "1000"
+ "value": "1000.00"
}
}
}