Review Contract Breach

Record or independently review breach evidence; does not create financial credits.

POST/api/v1/contracts/dispatch

Request

curl -X POST "<BASE_URL>/api/v1/contracts/dispatch" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-CQRS-Action: REVIEW_CONTRACT_BREACH" \
  -H "Content-Type: application/json" \
  -d '{
    "breach_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "confirmed": true,
    "contract_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "expected_version": 1,
    "note": "string"
  }'

Authorization

Minimum role: Deal desk approverThe caller must hold this role or a higher one.
Multi-factor sign-in: Required. The access token must come from a session that completed multi-factor sign-in.
Action: REVIEW_CONTRACT_BREACH

Headers

AuthorizationstringRequired
Access token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.
X-CQRS-ActionstringRequired
Names the command to run. Must be REVIEW_CONTRACT_BREACH for this endpoint.
Content-TypestringRequired
Always application/json.
X-Idempotency-KeystringOptional
A key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.
X-Correlation-IdstringOptional
Your own identifier for the request. Returned in the x-correlation-id response header; generated when you leave it out.

Request body

breach_iduuidRequired
No description yet.
confirmedbooleanRequired
No description yet.
contract_iduuidRequired
No description yet.
expected_versionintegerRequired
No description yet.
notestringRequired
No description yet.

Response

Status 202. The command was applied. The body reports the outcome and, where the command changes a record, that record's new state.

successbooleanRequired
true when the command was applied.
error_messagestringRequired
Empty when the command was applied.
projected_stateobjectOptional
The record as it stands after the command.
event_payloadobjectOptional
The event the command recorded.
insightsarray of objectOptional
Advisory notes about the result. Each has a code, a message and an impact number.

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

400X-CQRS-Action is missing or names a command this route does not accept. Send REVIEW_CONTRACT_BREACH.
400DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types.
401The access token is missing, expired or not valid.
401L1_AUTHThe caller's role is below dealdeskapprover, the session has not completed multi-factor sign-in, or the caller has no access to this record.
403L1_POLICYA business rule refused the command. The message names the rule.
409L1_VERSIONexpected_version is not the record's current version. Read the record again, then retry.
409L1_IDEMPOTENCYA command with this idempotency key was already applied.
409CONFLICTThe command would duplicate a record that must be unique.
500L3_COMMITThe command was valid but could not be saved.