Skip to main content
GET
Retrieve cancellation

Authorizations

Authorization
string
header
required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Headers

x-simple-workspace
string
required

Workspace (account) identifier. Required for every request.

x-piriod-test-mode
boolean
default:false

Whether to operate against test-mode data. Defaults to false.

Path Parameters

id
string
required

Resource identifier.

Response

The cancellation.

Cancellation document issued against a previously finalized retention.

retention
integer
required

Retention ID being cancelled.

document
integer
required

Cancellation document type.

number
integer
required
date
string<date>
required
id
integer
read-only
note
string | null
Maximum string length: 64
internal_note
string | null
Maximum string length: 1024
biller_status
string
read-only
tax_agency
object
read-only
local_file
string<uri> | null
read-only
imported
boolean
read-only
test_mode
boolean
read-only
created
string<date-time>
read-only
updated
string<date-time>
read-only