---
title: "Create cancellation"
method: POST
path: "/cancellations/"
tags: ["Procurement"]
---

# Create cancellation

`POST /cancellations/`

## Headers

- `x-simple-workspace` string, required
- `x-piriod-test-mode` boolean

## Request body

- Cancellation — Cancellation document issued against a previously finalized retention.
  - `id` integer
  - `retention` integer, required — Retention ID being cancelled.
  - `document` integer, required — Cancellation document type.
  - `number` integer, required
  - `date` string, date, required
  - `note` string, nullable
  - `internal_note` string, nullable
  - `biller_status` string
  - `tax_agency` object
  - `local_file` string, uri, nullable
  - `imported` boolean
  - `test_mode` boolean
  - `created` string, date-time
  - `updated` string, date-time

## Response `201`

Cancellation created.

- Cancellation — Cancellation document issued against a previously finalized retention.
  - `id` integer
  - `retention` integer, required — Retention ID being cancelled.
  - `document` integer, required — Cancellation document type.
  - `number` integer, required
  - `date` string, date, required
  - `note` string, nullable
  - `internal_note` string, nullable
  - `biller_status` string
  - `tax_agency` object
  - `local_file` string, uri, nullable
  - `imported` boolean
  - `test_mode` boolean
  - `created` string, date-time
  - `updated` string, date-time

## Other responses

- `400` — Request body or query parameters failed validation.

---

[API](https://skmtc.net/piriod/apis/piriod-api.md) · [All operations](https://skmtc.net/piriod/apis/piriod-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/piriod/piriod-api/revisions/70cbc827dc7b/schema)