import {z} from 'zod' export type GetApiOrganisationsVatVrnPenaltiesArgs = {vrn: string, 'Gov-Test-Scenario'?: string | undefined}; export type GetApiOrganisationsVatVrnPenaltiesOptions = {baseUrl?: string | undefined, userRestricted?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiOrganisationsVatVrnPenaltiesResponse = z.object({totalisations: z.object({lateSubmissionPenaltyTotalValue: z.number().gte(-9999999999999.99).lte(9999999999999.99).multipleOf(0.01).optional(), penalisedPrincipalTotal: z.number().gte(-9999999999999.99).lte(9999999999999.99).multipleOf(0.01).optional(), latePaymentPenaltyPostedTotal: z.number().gte(-9999999999999.99).lte(9999999999999.99).multipleOf(0.01).optional(), latePaymentPenaltyEstimateTotal: z.number().gte(-9999999999999.99).lte(9999999999999.99).multipleOf(0.01).optional()}).optional(), lateSubmissionPenalty: z.object({summary: z.object({activePenaltyPoints: z.number().gte(0).multipleOf(1), inactivePenaltyPoints: z.number().gte(0).multipleOf(1), periodOfComplianceAchievement: z.string(), regimeThreshold: z.number().gte(0).multipleOf(1), penaltyChargeAmount: z.number().gte(-9999999999999.99).lte(9999999999999.99).multipleOf(0.01)}), details: z.array(z.object({penaltyNumber: z.string(), penaltyOrder: z.string(), penaltyCategory: z.enum(["point", "charge", "threshold"]), penaltyStatus: z.enum(["active", "inactive"]), frequencyAdjustmentPointIndicator: z.literal("X").optional(), penaltyCreationDate: z.string(), penaltyExpiryDate: z.string(), expiryReason: z.enum(["appeal", "submission-frequency-change", "obligations-reversed", "HMRC-removed", "natural-expiry", "penalty-removed", "expiry-conditions-met", "HMRC-reset"]).optional(), communicationsDate: z.string().optional(), lateSubmissions: z.array(z.object({lateSubmissionID: z.string(), taxReturnStatus: z.enum(["Open", "Fulfilled", "Reversed"]), taxPeriodStartDate: z.string().optional(), taxPeriodEndDate: z.string().optional(), taxPeriodDueDate: z.string().optional(), returnReceiptDate: z.string().optional()})).optional(), appealInformation: z.array(z.object({appealStatus: z.enum(["under-appeal", "appeal-upheld", "appeal-rejected", "cannot-be-appealed"]), appealLevel: z.enum(["statutory-review", "appeal-first-tier-tribunal"])})).optional(), chargeReference: z.string().optional(), chargeAmount: z.number().gte(-9999999999999.99).lte(9999999999999.99).multipleOf(0.01).optional(), chargeOutstandingAmount: z.number().gte(-9999999999999.99).lte(9999999999999.99).multipleOf(0.01).optional(), chargeDueDate: z.string().optional()}))}).optional(), latePaymentPenalty: z.object({details: z.array(z.object({principalChargeReference: z.string(), penaltyCategory: z.string(), penaltyStatus: z.enum(["accruing", "posted"]), penaltyAmountAccruing: z.number().gte(-9999999999999.99).lte(9999999999999.99).multipleOf(0.01), penaltyAmountPosted: z.number().gte(-9999999999999.99).lte(9999999999999.99).multipleOf(0.01), penaltyAmountPaid: z.number().gte(-9999999999999.99).lte(9999999999999.99).multipleOf(0.01).optional(), penaltyAmountOutstanding: z.number().gte(-9999999999999.99).lte(9999999999999.99).multipleOf(0.01).optional(), latePaymentPenalty1LowerRateCalculationAmount: z.number().gte(-9999999999999.99).lte(9999999999999.99).multipleOf(0.01).optional(), latePaymentPenalty1LowerRatePercentage: z.number().gte(-99.99).lte(99.99).multipleOf(0.01).optional(), latePaymentPenalty1HigherRateCalculationAmount: z.number().gte(-9999999999999.99).lte(9999999999999.99).multipleOf(0.01).optional(), latePaymentPenalty1HigherRatePercentage: z.number().gte(-99.99).lte(99.99).multipleOf(0.01).optional(), latePaymentPenalty2Days: z.string().optional(), latePaymentPenalty2Percentage: z.number().gte(-99.99).lte(99.99).multipleOf(0.01).optional(), penaltyChargeCreationDate: z.string().optional(), communicationsDate: z.string().optional(), penaltyChargeReference: z.string().optional(), penaltyChargeDueDate: z.string().optional(), appealInformation: z.array(z.object({appealStatus: z.enum(["under-appeal", "appeal-upheld", "appeal-rejected", "cannot-be-appealed"]), appealLevel: z.enum(["statutory-review", "appeal-first-tier-tribunal"])})).optional(), principalChargeDocNumber: z.string(), principalChargeBillingFrom: z.string(), principalChargeBillingTo: z.string(), principalChargeDueDate: z.string(), principalChargeLatestClearing: z.string().optional(), timeToPay: z.array(z.object({timeToPayStartDate: z.string().optional(), timeToPayEndDate: z.string().optional()})).optional()})).optional()}).optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Retrieve VAT penalties * * GET /organisations/vat/{vrn}/penalties */ export const getApiOrganisationsVatVrnPenalties = async (args: GetApiOrganisationsVatVrnPenaltiesArgs, options?: GetApiOrganisationsVatVrnPenaltiesOptions) => { const {baseUrl = "https://test-api.service.hmrc.gov.uk", fetch: fetchFn = fetch, userRestricted} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['Gov-Test-Scenario'] != null) headers.set("Gov-Test-Scenario", String(args['Gov-Test-Scenario'])) if (userRestricted !== undefined) headers.set('authorization', `Bearer ${userRestricted}`) const url = `${baseUrl.replace(/\/+$/, '')}/organisations/vat/${encodeURIComponent(String(args.vrn))}/penalties${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(getApiOrganisationsVatVrnPenaltiesResponse, await res.json()) };