VatPeriodTokens
Computed VAT period tokens for the return the client is currently filing - the most recently
closed period whose submission deadline has not yet passed (falling through to the open period
once that deadline is behind us). Anchored on a supplied reference date, so an email generated
from a task can resolve the return the task is for, independent of when the email is sent.
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 |
|---|---|---|
| period | string | Human label for the period (e.g. "May 2026" or "Apr-Jun 2026"). |
Human label for the period (e.g. "May 2026" or "Apr-Jun 2026"). | ||
| periodStart | string | First day of the VAT return period being filed. |
First day of the VAT return period being filed. | ||
| periodEnd | string | Last day of the VAT return period being filed. |
Last day of the VAT return period being filed. | ||
| submissionDeadline | string | 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. | ||
| previous | VatPeriodTokens | |
| next | VatPeriodTokens | |
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": "..."
}
}