Schedule the Termination of a Contract

POST /v2/contracts/{contractId}/termination/

API version

v2

Request method

POST

Operation ID

contract-terminate-contract

---

Request

• contractIdstring (uuid)

  required

  The uuid of the Contract to be terminated.

  Example:"f6bb2d44-e6be-46dc-96f7-9602a7177a75"

Responses

Format

application/json

Description

Returns the contractId, the date on which the Termination will take place and the list of affected ContractItems.

Schema documentation

• contractIdstring (uuid)
• itemsScheduledForTerminationarray of string (uuid)
  • Array[
  • *string (uuid)
  ]

reasonstring

terminationTargetDatestring (date)

Example

null

JSON Schema

{
  "properties": {
    "contractId": {
      "format": "uuid",
      "type": "string"
    },
    "itemsScheduledForTermination": {
      "items": {
        "format": "uuid",
        "type": "string"
      },
      "type": "array"
    },
    "reason": {
      "example": "Projekt wird nicht mehr benötigt",
      "type": "string"
    },
    "terminationTargetDate": {
      "format": "date",
      "type": "string"
    }
  }
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/contracts/f0f86186-0a5a-45b2-aa33-502777496347/termination

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.contract.terminateContract({
  "contractId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 201);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Contract\TerminateContract\TerminateContractRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Contract\TerminateContract\TerminateContractRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// TerminateContractRequestBody to learn how to construct a valid instance
$body = new TerminateContractRequestBody(/* TODO: ... */);

$request = (new TerminateContractRequest(
  contractId: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->contract()->terminateContract($request);

var_dump($response->getBody();