@spaceinvoices/js-sdk 13.0.0 → 13.1.0

package/dist/generated/model/index.d.cts

@@ -1411,6 +1411,10 @@ export * from './ticketBaiSettingsTerritory.cjs';
 export * from './transactionTypeCheckRequest.cjs';
 export * from './transactionTypeCheckRequestCustomer.cjs';
 export * from './transactionTypeCheckRequestIssuer.cjs';
+export * from './transactionTypeCheckRequestItemsItem.cjs';
+export * from './transactionTypeCheckRequestItemsItemClassification.cjs';
+export * from './transactionTypeCheckRequestItemsItemType.cjs';
+export * from './transactionTypeCheckRequestSupplyType.cjs';
 export * from './transactionTypeCheckResponse.cjs';
 export * from './transactionTypeCheckResponseTransactionType.cjs';
 export * from './travelOrder.cjs';

package/dist/generated/model/index.d.ts

@@ -1411,6 +1411,10 @@ export * from './ticketBaiSettingsTerritory.js';
 export * from './transactionTypeCheckRequest.js';
 export * from './transactionTypeCheckRequestCustomer.js';
 export * from './transactionTypeCheckRequestIssuer.js';
+export * from './transactionTypeCheckRequestItemsItem.js';
+export * from './transactionTypeCheckRequestItemsItemClassification.js';
+export * from './transactionTypeCheckRequestItemsItemType.js';
+export * from './transactionTypeCheckRequestSupplyType.js';
 export * from './transactionTypeCheckResponse.js';
 export * from './transactionTypeCheckResponseTransactionType.js';
 export * from './travelOrder.js';

package/dist/generated/model/transactionTypeCheckRequest.d.cts

@@ -7,9 +7,21 @@
  */
 import type { TransactionTypeCheckRequestCustomer } from './transactionTypeCheckRequestCustomer.cjs';
 import type { TransactionTypeCheckRequestIssuer } from './transactionTypeCheckRequestIssuer.cjs';
+import type { TransactionTypeCheckRequestItemsItem } from './transactionTypeCheckRequestItemsItem.cjs';
+import type { TransactionTypeCheckRequestSupplyType } from './transactionTypeCheckRequestSupplyType.cjs';
 export interface TransactionTypeCheckRequest {
     /** Issuer (seller) information */
     issuer: TransactionTypeCheckRequestIssuer;
     /** Customer (buyer) information */
     customer: TransactionTypeCheckRequestCustomer;
+    /**
+     * What is being supplied. Only sales between the EU and Northern Ireland (country_code XI, or GB with an XI-prefixed VAT number) depend on it: goods are an intra-EU supply and the XI number is checked in VIES, services are a third-country supply. When it is omitted or null and no items are given, such a sale is classified as third-country and the response carries a warning. Ignored for every other country pair.
+     * @nullable
+     */
+    supply_type?: TransactionTypeCheckRequestSupplyType;
+    /**
+     * The document's lines, as an alternative to supply_type: the supply type is derived from them with the rule a saved document uses (every line product = goods, every line service = services, anything else = not known). Ignored when supply_type is given.
+     * @nullable
+     */
+    items?: TransactionTypeCheckRequestItemsItem[] | null;
 }

package/dist/generated/model/transactionTypeCheckRequest.d.ts

@@ -7,9 +7,21 @@
  */
 import type { TransactionTypeCheckRequestCustomer } from './transactionTypeCheckRequestCustomer.js';
 import type { TransactionTypeCheckRequestIssuer } from './transactionTypeCheckRequestIssuer.js';
+import type { TransactionTypeCheckRequestItemsItem } from './transactionTypeCheckRequestItemsItem.js';
+import type { TransactionTypeCheckRequestSupplyType } from './transactionTypeCheckRequestSupplyType.js';
 export interface TransactionTypeCheckRequest {
     /** Issuer (seller) information */
     issuer: TransactionTypeCheckRequestIssuer;
     /** Customer (buyer) information */
     customer: TransactionTypeCheckRequestCustomer;
+    /**
+     * What is being supplied. Only sales between the EU and Northern Ireland (country_code XI, or GB with an XI-prefixed VAT number) depend on it: goods are an intra-EU supply and the XI number is checked in VIES, services are a third-country supply. When it is omitted or null and no items are given, such a sale is classified as third-country and the response carries a warning. Ignored for every other country pair.
+     * @nullable
+     */
+    supply_type?: TransactionTypeCheckRequestSupplyType;
+    /**
+     * The document's lines, as an alternative to supply_type: the supply type is derived from them with the rule a saved document uses (every line product = goods, every line service = services, anything else = not known). Ignored when supply_type is given.
+     * @nullable
+     */
+    items?: TransactionTypeCheckRequestItemsItem[] | null;
 }

package/dist/generated/model/transactionTypeCheckRequestIssuer.d.cts

@@ -19,4 +19,9 @@ export type TransactionTypeCheckRequestIssuer = {
     country_code?: string;
     /** Whether the issuer is a tax subject. Set false for small businesses or tax-exempt organizations. */
     is_tax_subject?: boolean;
+    /**
+     * Issuer VAT number. Only used to recognise a Northern Ireland issuer: country_code GB with an XI-prefixed number (or country_code XI).
+     * @nullable
+     */
+    tax_number?: string | null;
 };

package/dist/generated/model/transactionTypeCheckRequestIssuer.d.ts

@@ -19,4 +19,9 @@ export type TransactionTypeCheckRequestIssuer = {
     country_code?: string;
     /** Whether the issuer is a tax subject. Set false for small businesses or tax-exempt organizations. */
     is_tax_subject?: boolean;
+    /**
+     * Issuer VAT number. Only used to recognise a Northern Ireland issuer: country_code GB with an XI-prefixed number (or country_code XI).
+     * @nullable
+     */
+    tax_number?: string | null;
 };

package/dist/generated/model/transactionTypeCheckRequestItemsItem.d.cts

@@ -0,0 +1,26 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Space Invoices API
+ * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking.
+ * OpenAPI spec version: 1.0.0
+ */
+import type { TransactionTypeCheckRequestItemsItemClassification } from './transactionTypeCheckRequestItemsItemClassification.cjs';
+import type { TransactionTypeCheckRequestItemsItemType } from './transactionTypeCheckRequestItemsItemType.cjs';
+export type TransactionTypeCheckRequestItemsItem = {
+    /**
+     * Set to 'separator' for a section header line; separators are ignored.
+     * @nullable
+     */
+    type?: TransactionTypeCheckRequestItemsItemType;
+    /**
+     * The line's classification, as on a document line. Leave it out for a line that takes its classification from the catalog item in item_id; null means the line is unclassified.
+     * @nullable
+     */
+    classification?: TransactionTypeCheckRequestItemsItemClassification;
+    /**
+     * Catalog item the line references. Used to inherit the item's classification when the line has none of its own. This needs a selected entity (X-Entity-Id header or an entity-scoped API key) on POST /transaction-type/check; without one, and on the deprecated POST /vies/check, such a line counts as unclassified.
+     * @nullable
+     */
+    item_id?: string | null;
+};

package/dist/generated/model/transactionTypeCheckRequestItemsItem.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Space Invoices API
+ * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking.
+ * OpenAPI spec version: 1.0.0
+ */
+import type { TransactionTypeCheckRequestItemsItemClassification } from './transactionTypeCheckRequestItemsItemClassification.js';
+import type { TransactionTypeCheckRequestItemsItemType } from './transactionTypeCheckRequestItemsItemType.js';
+export type TransactionTypeCheckRequestItemsItem = {
+    /**
+     * Set to 'separator' for a section header line; separators are ignored.
+     * @nullable
+     */
+    type?: TransactionTypeCheckRequestItemsItemType;
+    /**
+     * The line's classification, as on a document line. Leave it out for a line that takes its classification from the catalog item in item_id; null means the line is unclassified.
+     * @nullable
+     */
+    classification?: TransactionTypeCheckRequestItemsItemClassification;
+    /**
+     * Catalog item the line references. Used to inherit the item's classification when the line has none of its own. This needs a selected entity (X-Entity-Id header or an entity-scoped API key) on POST /transaction-type/check; without one, and on the deprecated POST /vies/check, such a line counts as unclassified.
+     * @nullable
+     */
+    item_id?: string | null;
+};

package/dist/generated/model/transactionTypeCheckRequestItemsItemClassification.d.cts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Space Invoices API
+ * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking.
+ * OpenAPI spec version: 1.0.0
+ */
+/**
+ * The line's classification, as on a document line. Leave it out for a line that takes its classification from the catalog item in item_id; null means the line is unclassified.
+ * @nullable
+ */
+export type TransactionTypeCheckRequestItemsItemClassification = typeof TransactionTypeCheckRequestItemsItemClassification[keyof typeof TransactionTypeCheckRequestItemsItemClassification] | null;
+export declare const TransactionTypeCheckRequestItemsItemClassification: {
+    readonly product: "product";
+    readonly service: "service";
+    readonly advance: "advance";
+};

package/dist/generated/model/transactionTypeCheckRequestItemsItemClassification.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Space Invoices API
+ * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking.
+ * OpenAPI spec version: 1.0.0
+ */
+/**
+ * The line's classification, as on a document line. Leave it out for a line that takes its classification from the catalog item in item_id; null means the line is unclassified.
+ * @nullable
+ */
+export type TransactionTypeCheckRequestItemsItemClassification = typeof TransactionTypeCheckRequestItemsItemClassification[keyof typeof TransactionTypeCheckRequestItemsItemClassification] | null;
+export declare const TransactionTypeCheckRequestItemsItemClassification: {
+    readonly product: "product";
+    readonly service: "service";
+    readonly advance: "advance";
+};

package/dist/generated/model/transactionTypeCheckRequestItemsItemType.d.cts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Space Invoices API
+ * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking.
+ * OpenAPI spec version: 1.0.0
+ */
+/**
+ * Set to 'separator' for a section header line; separators are ignored.
+ * @nullable
+ */
+export type TransactionTypeCheckRequestItemsItemType = typeof TransactionTypeCheckRequestItemsItemType[keyof typeof TransactionTypeCheckRequestItemsItemType] | null;
+export declare const TransactionTypeCheckRequestItemsItemType: {
+    readonly separator: "separator";
+};

package/dist/generated/model/transactionTypeCheckRequestItemsItemType.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Space Invoices API
+ * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking.
+ * OpenAPI spec version: 1.0.0
+ */
+/**
+ * Set to 'separator' for a section header line; separators are ignored.
+ * @nullable
+ */
+export type TransactionTypeCheckRequestItemsItemType = typeof TransactionTypeCheckRequestItemsItemType[keyof typeof TransactionTypeCheckRequestItemsItemType] | null;
+export declare const TransactionTypeCheckRequestItemsItemType: {
+    readonly separator: "separator";
+};

package/dist/generated/model/transactionTypeCheckRequestSupplyType.d.cts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Space Invoices API
+ * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking.
+ * OpenAPI spec version: 1.0.0
+ */
+/**
+ * What is being supplied. Only sales between the EU and Northern Ireland (country_code XI, or GB with an XI-prefixed VAT number) depend on it: goods are an intra-EU supply and the XI number is checked in VIES, services are a third-country supply. When it is omitted or null and no items are given, such a sale is classified as third-country and the response carries a warning. Ignored for every other country pair.
+ * @nullable
+ */
+export type TransactionTypeCheckRequestSupplyType = typeof TransactionTypeCheckRequestSupplyType[keyof typeof TransactionTypeCheckRequestSupplyType] | null;
+export declare const TransactionTypeCheckRequestSupplyType: {
+    readonly goods: "goods";
+    readonly services: "services";
+};

package/dist/generated/model/transactionTypeCheckRequestSupplyType.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.5.3 🍺
+ * Do not edit manually.
+ * Space Invoices API
+ * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking.
+ * OpenAPI spec version: 1.0.0
+ */
+/**
+ * What is being supplied. Only sales between the EU and Northern Ireland (country_code XI, or GB with an XI-prefixed VAT number) depend on it: goods are an intra-EU supply and the XI number is checked in VIES, services are a third-country supply. When it is omitted or null and no items are given, such a sale is classified as third-country and the response carries a warning. Ignored for every other country pair.
+ * @nullable
+ */
+export type TransactionTypeCheckRequestSupplyType = typeof TransactionTypeCheckRequestSupplyType[keyof typeof TransactionTypeCheckRequestSupplyType] | null;
+export declare const TransactionTypeCheckRequestSupplyType: {
+    readonly goods: "goods";
+    readonly services: "services";
+};

package/dist/generated/model/transactionTypeCheckResponse.d.cts

@@ -34,10 +34,15 @@ export interface TransactionTypeCheckResponse {
      */
     vies_valid: boolean | null;
     /**
-     * Warning message if VIES validation was unavailable or tax number was invalid
+     * Warning message if VIES validation was unavailable or the tax number was invalid, if a GB- or XI-prefixed UK VAT number failed the format check or the HMRC check, or if a Northern Ireland sale has no supply_type
      * @nullable
      */
     warning: string | null;
     /** False when issuer is not a tax subject (transaction treated as B2C) */
     is_tax_subject?: boolean;
+    /**
+     * Present when the customer is in the United Kingdom with a tax number that VIES does not cover (Great Britain, or Northern Ireland services). True or false is HMRC's answer for the UK VAT number; null means HMRC was not asked (lookup not enabled, or the number failed the format check) or gave no answer. Informational: it never changes transaction_type.
+     * @nullable
+     */
+    hmrc_valid?: boolean | null;
 }

package/dist/generated/model/transactionTypeCheckResponse.d.ts

@@ -34,10 +34,15 @@ export interface TransactionTypeCheckResponse {
      */
     vies_valid: boolean | null;
     /**
-     * Warning message if VIES validation was unavailable or tax number was invalid
+     * Warning message if VIES validation was unavailable or the tax number was invalid, if a GB- or XI-prefixed UK VAT number failed the format check or the HMRC check, or if a Northern Ireland sale has no supply_type
      * @nullable
      */
     warning: string | null;
     /** False when issuer is not a tax subject (transaction treated as B2C) */
     is_tax_subject?: boolean;
+    /**
+     * Present when the customer is in the United Kingdom with a tax number that VIES does not cover (Great Britain, or Northern Ireland services). True or false is HMRC's answer for the UK VAT number; null means HMRC was not asked (lookup not enabled, or the number failed the format check) or gave no answer. Informational: it never changes transaction_type.
+     * @nullable
+     */
+    hmrc_valid?: boolean | null;
 }

package/dist/generated/transaction-type/transaction-type.d.cts

@@ -25,6 +25,12 @@ Applies when:
 - Issuer is an EU tax subject
 - Customer is in a different EU country with valid tax number, OR customer is outside EU
 
+**Northern Ireland:**
+A customer is in Northern Ireland when its country_code is `XI`, or `GB` with an `XI`-prefixed VAT number. Great Britain and Northern Ireland are one country for domestic sales. Between the EU and Northern Ireland, `supply_type` decides: `goods` are an intra-EU supply (`intra_eu_b2b` when VIES confirms the XI number or VIES is unavailable, `intra_eu_b2c` when VIES rejects it or there is no number), `services` are a third-country supply (`3w_b2b` / `3w_b2c`). Instead of `supply_type` you can send the document's `items` (classification and item_id per line): the supply type is then derived exactly as for a saved document. Without either, the sale is classified as third-country and `warning` says so.
+
+**UK VAT numbers:**
+A UK customer's tax number with a GB or XI prefix that VIES does not cover gets a format check (9 or 12 digits with valid check digits); a failed check is reported in `warning`. A number without the prefix that is not a VAT number (a company number, a UTR) is ignored. `hmrc_valid` carries HMRC's answer when the HMRC lookup is enabled. Neither changes `transaction_type`.
+
 **End Consumer Override:**
 When customer.is_end_consumer is true, forces B2C classification for non-EU transactions even if the customer has a tax number. For intra-EU transactions, VIES validation takes precedence.
 
@@ -32,7 +38,7 @@ When customer.is_end_consumer is true, forces B2C classification for non-EU tran
 When issuer.is_tax_subject is false, all transactions are treated as B2C (no VIES validation, no reverse charge).
 
 **Entity VIES setting:**
-When the request selects an entity (X-Entity-Id header or an entity-scoped API key) whose `tax_rules.eu.vies_validate_vat` is false, no VIES request is made and the customer tax number is trusted as provided, the same as when saving a document for that entity. Without an entity, VIES validation runs as before.
+When the request selects an entity (X-Entity-Id header or an entity-scoped API key) whose `tax_rules.eu.vies_validate_vat` is false, no VIES request and no UK VAT number check is made and the customer tax number is trusted as provided, the same as when saving a document for that entity. Without an entity, VIES validation runs as before.
  * @summary Check transaction type
  */
 export type checkTransactionTypeResponse200 = {

package/dist/generated/transaction-type/transaction-type.d.ts

@@ -25,6 +25,12 @@ Applies when:
 - Issuer is an EU tax subject
 - Customer is in a different EU country with valid tax number, OR customer is outside EU
 
+**Northern Ireland:**
+A customer is in Northern Ireland when its country_code is `XI`, or `GB` with an `XI`-prefixed VAT number. Great Britain and Northern Ireland are one country for domestic sales. Between the EU and Northern Ireland, `supply_type` decides: `goods` are an intra-EU supply (`intra_eu_b2b` when VIES confirms the XI number or VIES is unavailable, `intra_eu_b2c` when VIES rejects it or there is no number), `services` are a third-country supply (`3w_b2b` / `3w_b2c`). Instead of `supply_type` you can send the document's `items` (classification and item_id per line): the supply type is then derived exactly as for a saved document. Without either, the sale is classified as third-country and `warning` says so.
+
+**UK VAT numbers:**
+A UK customer's tax number with a GB or XI prefix that VIES does not cover gets a format check (9 or 12 digits with valid check digits); a failed check is reported in `warning`. A number without the prefix that is not a VAT number (a company number, a UTR) is ignored. `hmrc_valid` carries HMRC's answer when the HMRC lookup is enabled. Neither changes `transaction_type`.
+
 **End Consumer Override:**
 When customer.is_end_consumer is true, forces B2C classification for non-EU transactions even if the customer has a tax number. For intra-EU transactions, VIES validation takes precedence.
 
@@ -32,7 +38,7 @@ When customer.is_end_consumer is true, forces B2C classification for non-EU tran
 When issuer.is_tax_subject is false, all transactions are treated as B2C (no VIES validation, no reverse charge).
 
 **Entity VIES setting:**
-When the request selects an entity (X-Entity-Id header or an entity-scoped API key) whose `tax_rules.eu.vies_validate_vat` is false, no VIES request is made and the customer tax number is trusted as provided, the same as when saving a document for that entity. Without an entity, VIES validation runs as before.
+When the request selects an entity (X-Entity-Id header or an entity-scoped API key) whose `tax_rules.eu.vies_validate_vat` is false, no VIES request and no UK VAT number check is made and the customer tax number is trusted as provided, the same as when saving a document for that entity. Without an entity, VIES validation runs as before.
  * @summary Check transaction type
  */
 export type checkTransactionTypeResponse200 = {

package/dist/generated/vies/vies.d.cts

@@ -8,6 +8,8 @@
 import type { Error, TransactionTypeCheckRequest, TransactionTypeCheckResponse, ValidationError } from '../model/index.cjs';
 /**
  * **Deprecated:** Use `POST /transaction-type/check` instead. This endpoint is kept for backward compatibility.
+
+This endpoint never selects an entity. When `items` are sent, a line's own `classification` is used, but a line that only has an `item_id` cannot take its classification from the catalog here and counts as unclassified. Use `POST /transaction-type/check` with the entity selected for that.
  * @deprecated
  * @summary Check VIES status (deprecated)
  */

package/dist/generated/vies/vies.d.ts

@@ -8,6 +8,8 @@
 import type { Error, TransactionTypeCheckRequest, TransactionTypeCheckResponse, ValidationError } from '../model/index.js';
 /**
  * **Deprecated:** Use `POST /transaction-type/check` instead. This endpoint is kept for backward compatibility.
+
+This endpoint never selects an entity. When `items` are sent, a line's own `classification` is used, but a line that only has an `item_id` cannot take its classification from the catalog here and counts as unclassified. Use `POST /transaction-type/check` with the entity selected for that.
  * @deprecated
  * @summary Check VIES status (deprecated)
  */

package/dist/generated-zod/transaction-type/transaction-type.d.cts

@@ -25,6 +25,12 @@ Applies when:
 - Issuer is an EU tax subject
 - Customer is in a different EU country with valid tax number, OR customer is outside EU
 
+**Northern Ireland:**
+A customer is in Northern Ireland when its country_code is `XI`, or `GB` with an `XI`-prefixed VAT number. Great Britain and Northern Ireland are one country for domestic sales. Between the EU and Northern Ireland, `supply_type` decides: `goods` are an intra-EU supply (`intra_eu_b2b` when VIES confirms the XI number or VIES is unavailable, `intra_eu_b2c` when VIES rejects it or there is no number), `services` are a third-country supply (`3w_b2b` / `3w_b2c`). Instead of `supply_type` you can send the document's `items` (classification and item_id per line): the supply type is then derived exactly as for a saved document. Without either, the sale is classified as third-country and `warning` says so.
+
+**UK VAT numbers:**
+A UK customer's tax number with a GB or XI prefix that VIES does not cover gets a format check (9 or 12 digits with valid check digits); a failed check is reported in `warning`. A number without the prefix that is not a VAT number (a company number, a UTR) is ignored. `hmrc_valid` carries HMRC's answer when the HMRC lookup is enabled. Neither changes `transaction_type`.
+
 **End Consumer Override:**
 When customer.is_end_consumer is true, forces B2C classification for non-EU transactions even if the customer has a tax number. For intra-EU transactions, VIES validation takes precedence.
 
@@ -32,7 +38,7 @@ When customer.is_end_consumer is true, forces B2C classification for non-EU tran
 When issuer.is_tax_subject is false, all transactions are treated as B2C (no VIES validation, no reverse charge).
 
 **Entity VIES setting:**
-When the request selects an entity (X-Entity-Id header or an entity-scoped API key) whose `tax_rules.eu.vies_validate_vat` is false, no VIES request is made and the customer tax number is trusted as provided, the same as when saving a document for that entity. Without an entity, VIES validation runs as before.
+When the request selects an entity (X-Entity-Id header or an entity-scoped API key) whose `tax_rules.eu.vies_validate_vat` is false, no VIES request and no UK VAT number check is made and the customer tax number is trusted as provided, the same as when saving a document for that entity. Without an entity, VIES validation runs as before.
  * @summary Check transaction type
  */
 export declare const CheckTransactionTypeHeader: zod.ZodObject<{
@@ -48,6 +54,7 @@ export declare const CheckTransactionTypeBody: zod.ZodObject<{
         country: zod.ZodOptional<zod.ZodString>;
         country_code: zod.ZodOptional<zod.ZodString>;
         is_tax_subject: zod.ZodDefault<zod.ZodBoolean>;
+        tax_number: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
     }, zod.z.core.$strip>;
     customer: zod.ZodObject<{
         country: zod.ZodOptional<zod.ZodString>;
@@ -55,6 +62,12 @@ export declare const CheckTransactionTypeBody: zod.ZodObject<{
         tax_number: zod.ZodOptional<zod.ZodString>;
         is_end_consumer: zod.ZodOptional<zod.ZodBoolean>;
     }, zod.z.core.$strip>;
+    supply_type: zod.ZodOptional<zod.ZodNullable<zod.ZodUnion<readonly [zod.ZodLiteral<"goods">, zod.ZodLiteral<"services">, zod.ZodLiteral<null>]>>>;
+    items: zod.ZodOptional<zod.ZodNullable<zod.ZodArray<zod.ZodObject<{
+        type: zod.ZodOptional<zod.ZodNullable<zod.ZodUnion<readonly [zod.ZodLiteral<"separator">, zod.ZodLiteral<null>]>>>;
+        classification: zod.ZodOptional<zod.ZodNullable<zod.ZodUnion<readonly [zod.ZodLiteral<"product">, zod.ZodLiteral<"service">, zod.ZodLiteral<"advance">, zod.ZodLiteral<null>]>>>;
+        item_id: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
+    }, zod.z.core.$strip>>>>;
 }, zod.z.core.$strip>;
 export declare const checkTransactionTypeResponseIssuerCountryCodeMin = 2;
 export declare const checkTransactionTypeResponseIssuerCountryCodeMax = 2;
@@ -68,4 +81,5 @@ export declare const CheckTransactionTypeResponse: zod.ZodObject<{
     vies_valid: zod.ZodNullable<zod.ZodBoolean>;
     warning: zod.ZodNullable<zod.ZodString>;
     is_tax_subject: zod.ZodOptional<zod.ZodBoolean>;
+    hmrc_valid: zod.ZodOptional<zod.ZodNullable<zod.ZodBoolean>>;
 }, zod.z.core.$strip>;

package/dist/generated-zod/transaction-type/transaction-type.d.ts

@@ -25,6 +25,12 @@ Applies when:
 - Issuer is an EU tax subject
 - Customer is in a different EU country with valid tax number, OR customer is outside EU
 
+**Northern Ireland:**
+A customer is in Northern Ireland when its country_code is `XI`, or `GB` with an `XI`-prefixed VAT number. Great Britain and Northern Ireland are one country for domestic sales. Between the EU and Northern Ireland, `supply_type` decides: `goods` are an intra-EU supply (`intra_eu_b2b` when VIES confirms the XI number or VIES is unavailable, `intra_eu_b2c` when VIES rejects it or there is no number), `services` are a third-country supply (`3w_b2b` / `3w_b2c`). Instead of `supply_type` you can send the document's `items` (classification and item_id per line): the supply type is then derived exactly as for a saved document. Without either, the sale is classified as third-country and `warning` says so.
+
+**UK VAT numbers:**
+A UK customer's tax number with a GB or XI prefix that VIES does not cover gets a format check (9 or 12 digits with valid check digits); a failed check is reported in `warning`. A number without the prefix that is not a VAT number (a company number, a UTR) is ignored. `hmrc_valid` carries HMRC's answer when the HMRC lookup is enabled. Neither changes `transaction_type`.
+
 **End Consumer Override:**
 When customer.is_end_consumer is true, forces B2C classification for non-EU transactions even if the customer has a tax number. For intra-EU transactions, VIES validation takes precedence.
 
@@ -32,7 +38,7 @@ When customer.is_end_consumer is true, forces B2C classification for non-EU tran
 When issuer.is_tax_subject is false, all transactions are treated as B2C (no VIES validation, no reverse charge).
 
 **Entity VIES setting:**
-When the request selects an entity (X-Entity-Id header or an entity-scoped API key) whose `tax_rules.eu.vies_validate_vat` is false, no VIES request is made and the customer tax number is trusted as provided, the same as when saving a document for that entity. Without an entity, VIES validation runs as before.
+When the request selects an entity (X-Entity-Id header or an entity-scoped API key) whose `tax_rules.eu.vies_validate_vat` is false, no VIES request and no UK VAT number check is made and the customer tax number is trusted as provided, the same as when saving a document for that entity. Without an entity, VIES validation runs as before.
  * @summary Check transaction type
  */
 export declare const CheckTransactionTypeHeader: zod.ZodObject<{
@@ -48,6 +54,7 @@ export declare const CheckTransactionTypeBody: zod.ZodObject<{
         country: zod.ZodOptional<zod.ZodString>;
         country_code: zod.ZodOptional<zod.ZodString>;
         is_tax_subject: zod.ZodDefault<zod.ZodBoolean>;
+        tax_number: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
     }, zod.z.core.$strip>;
     customer: zod.ZodObject<{
         country: zod.ZodOptional<zod.ZodString>;
@@ -55,6 +62,12 @@ export declare const CheckTransactionTypeBody: zod.ZodObject<{
         tax_number: zod.ZodOptional<zod.ZodString>;
         is_end_consumer: zod.ZodOptional<zod.ZodBoolean>;
     }, zod.z.core.$strip>;
+    supply_type: zod.ZodOptional<zod.ZodNullable<zod.ZodUnion<readonly [zod.ZodLiteral<"goods">, zod.ZodLiteral<"services">, zod.ZodLiteral<null>]>>>;
+    items: zod.ZodOptional<zod.ZodNullable<zod.ZodArray<zod.ZodObject<{
+        type: zod.ZodOptional<zod.ZodNullable<zod.ZodUnion<readonly [zod.ZodLiteral<"separator">, zod.ZodLiteral<null>]>>>;
+        classification: zod.ZodOptional<zod.ZodNullable<zod.ZodUnion<readonly [zod.ZodLiteral<"product">, zod.ZodLiteral<"service">, zod.ZodLiteral<"advance">, zod.ZodLiteral<null>]>>>;
+        item_id: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
+    }, zod.z.core.$strip>>>>;
 }, zod.z.core.$strip>;
 export declare const checkTransactionTypeResponseIssuerCountryCodeMin = 2;
 export declare const checkTransactionTypeResponseIssuerCountryCodeMax = 2;
@@ -68,4 +81,5 @@ export declare const CheckTransactionTypeResponse: zod.ZodObject<{
     vies_valid: zod.ZodNullable<zod.ZodBoolean>;
     warning: zod.ZodNullable<zod.ZodString>;
     is_tax_subject: zod.ZodOptional<zod.ZodBoolean>;
+    hmrc_valid: zod.ZodOptional<zod.ZodNullable<zod.ZodBoolean>>;
 }, zod.z.core.$strip>;

package/dist/generated-zod/vies/vies.d.cts

@@ -8,6 +8,8 @@
 import * as zod from "zod";
 /**
  * **Deprecated:** Use `POST /transaction-type/check` instead. This endpoint is kept for backward compatibility.
+
+This endpoint never selects an entity. When `items` are sent, a line's own `classification` is used, but a line that only has an `item_id` cannot take its classification from the catalog here and counts as unclassified. Use `POST /transaction-type/check` with the entity selected for that.
  * @deprecated
  * @summary Check VIES status (deprecated)
  */
@@ -21,6 +23,7 @@ export declare const CheckViesBody: zod.ZodObject<{
         country: zod.ZodOptional<zod.ZodString>;
         country_code: zod.ZodOptional<zod.ZodString>;
         is_tax_subject: zod.ZodDefault<zod.ZodBoolean>;
+        tax_number: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
     }, zod.z.core.$strip>;
     customer: zod.ZodObject<{
         country: zod.ZodOptional<zod.ZodString>;
@@ -28,6 +31,12 @@ export declare const CheckViesBody: zod.ZodObject<{
         tax_number: zod.ZodOptional<zod.ZodString>;
         is_end_consumer: zod.ZodOptional<zod.ZodBoolean>;
     }, zod.z.core.$strip>;
+    supply_type: zod.ZodOptional<zod.ZodNullable<zod.ZodUnion<readonly [zod.ZodLiteral<"goods">, zod.ZodLiteral<"services">, zod.ZodLiteral<null>]>>>;
+    items: zod.ZodOptional<zod.ZodNullable<zod.ZodArray<zod.ZodObject<{
+        type: zod.ZodOptional<zod.ZodNullable<zod.ZodUnion<readonly [zod.ZodLiteral<"separator">, zod.ZodLiteral<null>]>>>;
+        classification: zod.ZodOptional<zod.ZodNullable<zod.ZodUnion<readonly [zod.ZodLiteral<"product">, zod.ZodLiteral<"service">, zod.ZodLiteral<"advance">, zod.ZodLiteral<null>]>>>;
+        item_id: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
+    }, zod.z.core.$strip>>>>;
 }, zod.z.core.$strip>;
 export declare const checkViesResponseIssuerCountryCodeMin = 2;
 export declare const checkViesResponseIssuerCountryCodeMax = 2;
@@ -41,4 +50,5 @@ export declare const CheckViesResponse: zod.ZodObject<{
     vies_valid: zod.ZodNullable<zod.ZodBoolean>;
     warning: zod.ZodNullable<zod.ZodString>;
     is_tax_subject: zod.ZodOptional<zod.ZodBoolean>;
+    hmrc_valid: zod.ZodOptional<zod.ZodNullable<zod.ZodBoolean>>;
 }, zod.z.core.$strip>;

package/dist/generated-zod/vies/vies.d.ts

@@ -8,6 +8,8 @@
 import * as zod from "zod";
 /**
  * **Deprecated:** Use `POST /transaction-type/check` instead. This endpoint is kept for backward compatibility.
+
+This endpoint never selects an entity. When `items` are sent, a line's own `classification` is used, but a line that only has an `item_id` cannot take its classification from the catalog here and counts as unclassified. Use `POST /transaction-type/check` with the entity selected for that.
  * @deprecated
  * @summary Check VIES status (deprecated)
  */
@@ -21,6 +23,7 @@ export declare const CheckViesBody: zod.ZodObject<{
         country: zod.ZodOptional<zod.ZodString>;
         country_code: zod.ZodOptional<zod.ZodString>;
         is_tax_subject: zod.ZodDefault<zod.ZodBoolean>;
+        tax_number: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
     }, zod.z.core.$strip>;
     customer: zod.ZodObject<{
         country: zod.ZodOptional<zod.ZodString>;
@@ -28,6 +31,12 @@ export declare const CheckViesBody: zod.ZodObject<{
         tax_number: zod.ZodOptional<zod.ZodString>;
         is_end_consumer: zod.ZodOptional<zod.ZodBoolean>;
     }, zod.z.core.$strip>;
+    supply_type: zod.ZodOptional<zod.ZodNullable<zod.ZodUnion<readonly [zod.ZodLiteral<"goods">, zod.ZodLiteral<"services">, zod.ZodLiteral<null>]>>>;
+    items: zod.ZodOptional<zod.ZodNullable<zod.ZodArray<zod.ZodObject<{
+        type: zod.ZodOptional<zod.ZodNullable<zod.ZodUnion<readonly [zod.ZodLiteral<"separator">, zod.ZodLiteral<null>]>>>;
+        classification: zod.ZodOptional<zod.ZodNullable<zod.ZodUnion<readonly [zod.ZodLiteral<"product">, zod.ZodLiteral<"service">, zod.ZodLiteral<"advance">, zod.ZodLiteral<null>]>>>;
+        item_id: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
+    }, zod.z.core.$strip>>>>;
 }, zod.z.core.$strip>;
 export declare const checkViesResponseIssuerCountryCodeMin = 2;
 export declare const checkViesResponseIssuerCountryCodeMax = 2;
@@ -41,4 +50,5 @@ export declare const CheckViesResponse: zod.ZodObject<{
     vies_valid: zod.ZodNullable<zod.ZodBoolean>;
     warning: zod.ZodNullable<zod.ZodString>;
     is_tax_subject: zod.ZodOptional<zod.ZodBoolean>;
+    hmrc_valid: zod.ZodOptional<zod.ZodNullable<zod.ZodBoolean>>;
 }, zod.z.core.$strip>;