Skip to main content
POST
Archive a document type

Authorizations

Authorization
string
header
required

A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.

Path Parameters

type
string
required

The document type key, such as payslip, from list_document_types.

Required string length: 1 - 60

Body

application/json

The body is of type object.

Response

Success.

object
enum<string>
required
Available options:
document_type
id
string | null
required

Null for a built-in type.

key
string
required

Such as payslip or super_statement, or firm_ and a slug for the firm's own.

label
string
required
description
string
required
group
enum<string>
required

The heading it is picked under: banking (Banking and loans), income (Income and tax), investments (Investments and super), property (Property and insurance), structure (Entities and structure), other (Other).

Available options:
banking,
income,
investments,
property,
structure,
other
origin
enum<string>
required

redbark for Redbark's own, which cannot be changed; firm for the firm's own.

Available options:
redbark,
firm
holds
enum<string>
required

values: values on the page are read into its fields. file: kept as a file, nothing read. Fixed once made.

Available options:
values,
file
archived
boolean
required

A firm type no longer sorted into or offered. Documents already read as it keep it.

field_count
number
required

Fields read from new documents: built-in and the firm’s, archived ones left out.

fact_keys
string[]
required

The client facts its fields fill.

read_last_30_days
number
required

Documents of this type read in the last 30 days.

sections
object[]
required