API Docs / Schemas / VatPeriodTokens

VatPeriodTokens

Computed VAT period tokens for the client's currently open VAT period.
Usage: {{ Vat.Period }}, {{ Vat.PeriodStart | formatDate: "dd MMM yyyy" }}, {{ Vat.SubmissionDeadline | formatDate: "dd MMM yyyy" }}.
Empty when the client is not VAT-registered, has no reporting period, or is on the Annual scheme.

Properties

Name Type Description
periodstring

Human label for the current period (e.g. "May 2026" or "Apr-Jun 2026").

Human label for the current period (e.g. "May 2026" or "Apr-Jun 2026").

periodStartstring

First day of the current VAT period.

First day of the current VAT period.

periodEndstring

Last day of the current VAT period.

Last day of the current VAT period.

submissionDeadlinestring

HMRC submission deadline - one calendar month and seven days after the period end.

HMRC submission deadline - one calendar month and seven days after the period end.

previousVatPeriodTokens
nextVatPeriodTokens

JSON Example

{
  "period": "string",
  "periodStart": "2024-01-01",
  "periodEnd": "2024-01-01",
  "submissionDeadline": "2024-01-01",
  "previous": {
    "period": "string",
    "periodStart": "2024-01-01",
    "periodEnd": "2024-01-01",
    "submissionDeadline": "2024-01-01",
    "previous": "..."
  }
}

Contained in Schemas