Skip to main content
GET
Get the contract of the version this subscription files

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

subscriptionId
string
required

Unique subscription identifier.

Query Parameters

version
string

A version this subscription adopted at some point — the one a filing was generated with. Absent: the version in force. One it never adopted answers 404.

Response

OK

calendar
object
required

Business-day calendar the document is filed by, from the subscription's pinned copy. Null when the contract declares none.

datasets
object[] | null
required

Every set the file carries and every field of it.

filing
object
required

What makes two generations the same filing and which remittance is the original, as the contract declares it. Null when the contract declares no filing block.

knownGaps
object[] | null
required

What this contract knowingly does not yet cover.

metadata
object
required

Which obligation this is, at which version.

parameters
object[] | null
required

What the generation must be told, answered per request.

reportTimezone
string
required

IANA time zone whose calendar decides when a period has closed (REPORT_TIMEZONE).

Example:

"America/Sao_Paulo"

rules
object[] | null
required

Every rule of the document: what the engine transforms and checks.

tables
object[] | null
required

Lookup tables published beside the contract, which its rules read.

apiVersion
string

Format identifier of the contract document.

Example:

"reporter.lerian.io/v1alpha1"

kind
string

Document kind; always DocumentContract.

Example:

"DocumentContract"