e-invoice-api/src/resources/validate.ts

The official TypeScript library for the e-invoice API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../core/resource';
import * as InboxAPI from './inbox';
import * as DocumentsAPI from './documents/documents';
import { APIPromise } from '../core/api-promise';
import { type Uploadable } from '../core/uploads';
import { RequestOptions } from '../internal/request-options';
import { multipartFormRequestOptions } from '../internal/uploads';

export class Validate extends APIResource {
  /**
   * Validate if the JSON document can be converted to a valid UBL document
   */
  validateJson(
    body: ValidateValidateJsonParams,
    options?: RequestOptions,
  ): APIPromise<UblDocumentValidation> {
    return this._client.post('/api/validate/json', { body, ...options });
  }

  /**
   * Validate if a Peppol ID exists in the Peppol network and retrieve supported
   * document types. The peppol_id must be in the form of `<scheme>:<id>`. The scheme
   * is a 4-digit code representing the identifier scheme, and the id is the actual
   * identifier value. For example, for a Belgian company it is `0208:0123456789`
   * (where 0208 is the scheme for Belgian enterprises, followed by the 10 digits of
   * the official BTW / KBO number).
   */
  validatePeppolID(
    query: ValidateValidatePeppolIDParams,
    options?: RequestOptions,
  ): APIPromise<ValidateValidatePeppolIDResponse> {
    return this._client.get('/api/validate/peppol-id', { query, ...options });
  }

  /**
   * Validate the correctness of a UBL document
   */
  validateUbl(body: ValidateValidateUblParams, options?: RequestOptions): APIPromise<UblDocumentValidation> {
    return this._client.post(
      '/api/validate/ubl',
      multipartFormRequestOptions({ body, ...options }, this._client),
    );
  }
}

export interface UblDocumentValidation {
  id: string;

  file_name: string | null;

  is_valid: boolean;

  issues: Array<UblDocumentValidation.Issue>;

  ubl_document?: string | null;
}

export namespace UblDocumentValidation {
  export interface Issue {
    message: string;

    schematron: string;

    type: 'error' | 'warning';

    flag?: string | null;

    location?: string | null;

    rule_id?: string | null;

    test?: string | null;
  }
}

/**
 * Response for a Peppol ID validation request.
 *
 * This model represents the validation result of a Peppol ID in the Peppol
 * network, including whether the ID is valid and what document types it supports.
 */
export interface ValidateValidatePeppolIDResponse {
  /**
   * Business card information for the Peppol ID
   */
  business_card: ValidateValidatePeppolIDResponse.BusinessCard | null;

  /**
   * Whether a business card is set at the SMP
   */
  business_card_valid: boolean;

  /**
   * Whether the DNS resolves to a valid SMP
   */
  dns_valid: boolean;

  /**
   * Whether the Peppol ID is valid and registered in the Peppol network
   */
  is_valid: boolean;

  supported_document_types?: Array<string>;
}

export namespace ValidateValidatePeppolIDResponse {
  /**
   * Business card information for the Peppol ID
   */
  export interface BusinessCard {
    country_code?: string | null;

    name?: string | null;

    registration_date?: string | null;
  }
}

export interface ValidateValidateJsonParams {
  allowances?: Array<ValidateValidateJsonParams.Allowance> | null;

  /**
   * The amount due for payment. Must be positive and rounded to maximum 2 decimals
   */
  amount_due?: number | string | null;

  attachments?: Array<DocumentsAPI.DocumentAttachmentCreate> | null;

  /**
   * The billing address (if different from customer address)
   */
  billing_address?: string | null;

  /**
   * The recipient name at the billing address
   */
  billing_address_recipient?: string | null;

  charges?: Array<ValidateValidateJsonParams.Charge> | null;

  /**
   * Currency of the invoice (ISO 4217 currency code)
   */
  currency?: DocumentsAPI.CurrencyCode;

  /**
   * The address of the customer/buyer
   */
  customer_address?: string | null;

  /**
   * The recipient name at the customer address
   */
  customer_address_recipient?: string | null;

  /**
   * Customer company ID. For Belgium this is the CBE number or their EUID (European
   * Unique Identifier) number. In the Netherlands this is the KVK number.
   */
  customer_company_id?: string | null;

  /**
   * The email address of the customer
   */
  customer_email?: string | null;

  /**
   * The unique identifier for the customer in your system
   */
  customer_id?: string | null;

  /**
   * The company name of the customer/buyer
   */
  customer_name?: string | null;

  /**
   * Customer tax ID. For Belgium this is the VAT number. Must include the country
   * prefix
   */
  customer_tax_id?: string | null;

  /**
   * The direction of the document: INBOUND (purchases) or OUTBOUND (sales)
   */
  direction?: DocumentsAPI.DocumentDirection;

  /**
   * The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE
   */
  document_type?: DocumentsAPI.DocumentType;

  /**
   * The date when payment is due
   */
  due_date?: string | null;

  /**
   * The date when the invoice was issued
   */
  invoice_date?: string | null;

  /**
   * The unique invoice identifier/number
   */
  invoice_id?: string | null;

  /**
   * The total amount of the invoice including tax (invoice_total = subtotal +
   * total_tax + total_discount). Must be positive and rounded to maximum 2 decimals
   */
  invoice_total?: number | string | null;

  /**
   * At least one line item is required
   */
  items?: Array<ValidateValidateJsonParams.Item>;

  /**
   * Additional notes or comments for the invoice
   */
  note?: string | null;

  payment_details?: Array<DocumentsAPI.PaymentDetailCreate> | null;

  /**
   * The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')
   */
  payment_term?: string | null;

  /**
   * The previous unpaid balance from prior invoices, if any. Must be positive and
   * rounded to maximum 2 decimals
   */
  previous_unpaid_balance?: number | string | null;

  /**
   * The purchase order reference number
   */
  purchase_order?: string | null;

  /**
   * The address where payment should be sent or remitted to
   */
  remittance_address?: string | null;

  /**
   * The recipient name at the remittance address
   */
  remittance_address_recipient?: string | null;

  /**
   * The address where services were performed or goods were delivered
   */
  service_address?: string | null;

  /**
   * The recipient name at the service address
   */
  service_address_recipient?: string | null;

  /**
   * The end date of the service period or delivery period
   */
  service_end_date?: string | null;

  /**
   * The start date of the service period or delivery period
   */
  service_start_date?: string | null;

  /**
   * The shipping/delivery address
   */
  shipping_address?: string | null;

  /**
   * The recipient name at the shipping address
   */
  shipping_address_recipient?: string | null;

  /**
   * The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or RECEIVED
   */
  state?: InboxAPI.DocumentState;

  /**
   * The taxable base of the invoice. Should be the sum of all line items -
   * allowances (for example commercial discounts) + charges with impact on VAT. Must
   * be positive and rounded to maximum 2 decimals
   */
  subtotal?: number | string | null;

  /**
   * Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E
   * for exempt)
   */
  tax_code?: 'AE' | 'E' | 'S' | 'Z' | 'G' | 'O' | 'K' | 'L' | 'M' | 'B';

  tax_details?: Array<ValidateValidateJsonParams.TaxDetail> | null;

  /**
   * The net financial discount/charge of the invoice (non-VAT charges minus non-VAT
   * allowances). Can be positive (net charge), negative (net discount), or zero.
   * Must be rounded to maximum 2 decimals
   */
  total_discount?: number | string | null;

  /**
   * The total tax amount of the invoice. Must be positive and rounded to maximum 2
   * decimals
   */
  total_tax?: number | string | null;

  /**
   * VATEX code list for VAT exemption reasons
   *
   * Agency: CEF Identifier: vatex
   */
  vatex?:
    | 'VATEX-EU-79-C'
    | 'VATEX-EU-132'
    | 'VATEX-EU-132-1A'
    | 'VATEX-EU-132-1B'
    | 'VATEX-EU-132-1C'
    | 'VATEX-EU-132-1D'
    | 'VATEX-EU-132-1E'
    | 'VATEX-EU-132-1F'
    | 'VATEX-EU-132-1G'
    | 'VATEX-EU-132-1H'
    | 'VATEX-EU-132-1I'
    | 'VATEX-EU-132-1J'
    | 'VATEX-EU-132-1K'
    | 'VATEX-EU-132-1L'
    | 'VATEX-EU-132-1M'
    | 'VATEX-EU-132-1N'
    | 'VATEX-EU-132-1O'
    | 'VATEX-EU-132-1P'
    | 'VATEX-EU-132-1Q'
    | 'VATEX-EU-143'
    | 'VATEX-EU-143-1A'
    | 'VATEX-EU-143-1B'
    | 'VATEX-EU-143-1C'
    | 'VATEX-EU-143-1D'
    | 'VATEX-EU-143-1E'
    | 'VATEX-EU-143-1F'
    | 'VATEX-EU-143-1FA'
    | 'VATEX-EU-143-1G'
    | 'VATEX-EU-143-1H'
    | 'VATEX-EU-143-1I'
    | 'VATEX-EU-143-1J'
    | 'VATEX-EU-143-1K'
    | 'VATEX-EU-143-1L'
    | 'VATEX-EU-144'
    | 'VATEX-EU-146-1E'
    | 'VATEX-EU-148'
    | 'VATEX-EU-148-A'
    | 'VATEX-EU-148-B'
    | 'VATEX-EU-148-C'
    | 'VATEX-EU-148-D'
    | 'VATEX-EU-148-E'
    | 'VATEX-EU-148-F'
    | 'VATEX-EU-148-G'
    | 'VATEX-EU-151'
    | 'VATEX-EU-151-1A'
    | 'VATEX-EU-151-1AA'
    | 'VATEX-EU-151-1B'
    | 'VATEX-EU-151-1C'
    | 'VATEX-EU-151-1D'
    | 'VATEX-EU-151-1E'
    | 'VATEX-EU-159'
    | 'VATEX-EU-309'
    | 'VATEX-EU-AE'
    | 'VATEX-EU-D'
    | 'VATEX-EU-F'
    | 'VATEX-EU-G'
    | 'VATEX-EU-I'
    | 'VATEX-EU-IC'
    | 'VATEX-EU-O'
    | 'VATEX-EU-J'
    | 'VATEX-FR-FRANCHISE'
    | 'VATEX-FR-CNWVAT'
    | null;

  /**
   * Textual explanation for VAT exemption
   */
  vatex_note?: string | null;

  /**
   * The address of the vendor/seller
   */
  vendor_address?: string | null;

  /**
   * The recipient name at the vendor address
   */
  vendor_address_recipient?: string | null;

  /**
   * Vendor company ID. For Belgium this is the CBE number or their EUID (European
   * Unique Identifier) number. In the Netherlands this is the KVK number.
   */
  vendor_company_id?: string | null;

  /**
   * The email address of the vendor
   */
  vendor_email?: string | null;

  /**
   * The name of the vendor/seller/supplier
   */
  vendor_name?: string | null;

  /**
   * Vendor tax ID. For Belgium this is the VAT number. Must include the country
   * prefix
   */
  vendor_tax_id?: string | null;
}

export namespace ValidateValidateJsonParams {
  /**
   * An allowance is a discount for example for early payment, volume discount, etc.
   */
  export interface Allowance {
    /**
     * The allowance amount, without VAT. Must be rounded to maximum 2 decimals
     */
    amount?: number | string | null;

    /**
     * The base amount that may be used, in conjunction with the allowance percentage,
     * to calculate the allowance amount. Must be rounded to maximum 2 decimals
     */
    base_amount?: number | string | null;

    /**
     * The percentage that may be used, in conjunction with the allowance base amount,
     * to calculate the allowance amount. To state 20%, use value 20. Must be rounded
     * to maximum 2 decimals
     */
    multiplier_factor?: number | string | null;

    /**
     * The reason for the allowance
     */
    reason?: string | null;

    /**
     * Allowance reason codes for invoice discounts and charges
     */
    reason_code?:
      | '41'
      | '42'
      | '60'
      | '62'
      | '63'
      | '64'
      | '65'
      | '66'
      | '67'
      | '68'
      | '70'
      | '71'
      | '88'
      | '95'
      | '100'
      | '102'
      | '103'
      | '104'
      | '105'
      | null;

    /**
     * The VAT category code that applies to the allowance
     */
    tax_code?: 'AE' | 'E' | 'S' | 'Z' | 'G' | 'O' | 'K' | 'L' | 'M' | 'B';

    /**
     * The VAT rate, represented as percentage that applies to the allowance. Must be
     * rounded to maximum 2 decimals
     */
    tax_rate?: number | string | null;
  }

  /**
   * A charge is an additional fee for example for late payment, late delivery, etc.
   */
  export interface Charge {
    /**
     * The charge amount, without VAT. Must be rounded to maximum 2 decimals
     */
    amount?: number | string | null;

    /**
     * The base amount that may be used, in conjunction with the charge percentage, to
     * calculate the charge amount. Must be rounded to maximum 2 decimals
     */
    base_amount?: number | string | null;

    /**
     * The percentage that may be used, in conjunction with the charge base amount, to
     * calculate the charge amount. To state 20%, use value 20
     */
    multiplier_factor?: number | string | null;

    /**
     * The reason for the charge
     */
    reason?: string | null;

    /**
     * Charge reason codes for invoice charges and fees
     */
    reason_code?:
      | 'AA'
      | 'AAA'
      | 'AAC'
      | 'AAD'
      | 'AAE'
      | 'AAF'
      | 'AAH'
      | 'AAI'
      | 'AAS'
      | 'AAT'
      | 'AAV'
      | 'AAY'
      | 'AAZ'
      | 'ABA'
      | 'ABB'
      | 'ABC'
      | 'ABD'
      | 'ABF'
      | 'ABK'
      | 'ABL'
      | 'ABN'
      | 'ABR'
      | 'ABS'
      | 'ABT'
      | 'ABU'
      | 'ACF'
      | 'ACG'
      | 'ACH'
      | 'ACI'
      | 'ACJ'
      | 'ACK'
      | 'ACL'
      | 'ACM'
      | 'ACS'
      | 'ADC'
      | 'ADE'
      | 'ADJ'
      | 'ADK'
      | 'ADL'
      | 'ADM'
      | 'ADN'
      | 'ADO'
      | 'ADP'
      | 'ADQ'
      | 'ADR'
      | 'ADT'
      | 'ADW'
      | 'ADY'
      | 'ADZ'
      | 'AEA'
      | 'AEB'
      | 'AEC'
      | 'AED'
      | 'AEF'
      | 'AEH'
      | 'AEI'
      | 'AEJ'
      | 'AEK'
      | 'AEL'
      | 'AEM'
      | 'AEN'
      | 'AEO'
      | 'AEP'
      | 'AES'
      | 'AET'
      | 'AEU'
      | 'AEV'
      | 'AEW'
      | 'AEX'
      | 'AEY'
      | 'AEZ'
      | 'AJ'
      | 'AU'
      | 'CA'
      | 'CAB'
      | 'CAD'
      | 'CAE'
      | 'CAF'
      | 'CAI'
      | 'CAJ'
      | 'CAK'
      | 'CAL'
      | 'CAM'
      | 'CAN'
      | 'CAO'
      | 'CAP'
      | 'CAQ'
      | 'CAR'
      | 'CAS'
      | 'CAT'
      | 'CAU'
      | 'CAV'
      | 'CAW'
      | 'CAX'
      | 'CAY'
      | 'CAZ'
      | 'CD'
      | 'CG'
      | 'CS'
      | 'CT'
      | 'DAB'
      | 'DAC'
      | 'DAD'
      | 'DAF'
      | 'DAG'
      | 'DAH'
      | 'DAI'
      | 'DAJ'
      | 'DAK'
      | 'DAL'
      | 'DAM'
      | 'DAN'
      | 'DAO'
      | 'DAP'
      | 'DAQ'
      | 'DL'
      | 'EG'
      | 'EP'
      | 'ER'
      | 'FAA'
      | 'FAB'
      | 'FAC'
      | 'FC'
      | 'FH'
      | 'FI'
      | 'GAA'
      | 'HAA'
      | 'HD'
      | 'HH'
      | 'IAA'
      | 'IAB'
      | 'ID'
      | 'IF'
      | 'IR'
      | 'IS'
      | 'KO'
      | 'L1'
      | 'LA'
      | 'LAA'
      | 'LAB'
      | 'LF'
      | 'MAE'
      | 'MI'
      | 'ML'
      | 'NAA'
      | 'OA'
      | 'PA'
      | 'PAA'
      | 'PC'
      | 'PL'
      | 'PRV'
      | 'RAB'
      | 'RAC'
      | 'RAD'
      | 'RAF'
      | 'RE'
      | 'RF'
      | 'RH'
      | 'RV'
      | 'SA'
      | 'SAA'
      | 'SAD'
      | 'SAE'
      | 'SAI'
      | 'SG'
      | 'SH'
      | 'SM'
      | 'SU'
      | 'TAB'
      | 'TAC'
      | 'TT'
      | 'TV'
      | 'V1'
      | 'V2'
      | 'WH'
      | 'XAA'
      | 'YY'
      | 'ZZZ'
      | null;

    /**
     * Duty or tax or fee category codes (Subset of UNCL5305)
     *
     * Agency: UN/CEFACT Version: D.16B Subset: OpenPEPPOL
     */
    tax_code?: 'AE' | 'E' | 'S' | 'Z' | 'G' | 'O' | 'K' | 'L' | 'M' | 'B' | null;

    /**
     * The VAT rate, represented as percentage that applies to the charge
     */
    tax_rate?: number | string | null;
  }

  export interface Item {
    /**
     * The allowances of the line item.
     */
    allowances?: Array<Item.Allowance> | null;

    /**
     * The invoice line net amount (BT-131), exclusive of VAT, inclusive of line level
     * allowances and charges. Calculated as: ((unit_price / price_base_quantity) \*
     * quantity) - allowances + charges. Must be rounded to maximum 2 decimals. Can be
     * negative for credit notes or corrections.
     */
    amount?: number | string | null;

    /**
     * The charges of the line item.
     */
    charges?: Array<Item.Charge> | null;

    date?: null;

    /**
     * The description of the line item.
     */
    description?: string | null;

    /**
     * The product code of the line item.
     */
    product_code?: string | null;

    /**
     * The quantity of items (goods or services) that is the subject of the line item.
     * Must be rounded to maximum 4 decimals. Can be negative for credit notes or
     * corrections.
     */
    quantity?: number | string | null;

    /**
     * The total VAT amount for the line item. Must be rounded to maximum 2 decimals.
     * Can be negative for credit notes or corrections.
     */
    tax?: number | string | null;

    /**
     * The VAT rate of the line item expressed as percentage with 2 decimals
     */
    tax_rate?: number | string | null;

    /**
     * Unit of Measure Codes from UNECERec20 used in Peppol BIS Billing 3.0.
     */
    unit?: DocumentsAPI.UnitOfMeasureCode | null;

    /**
     * The item net price (BT-146). The price of an item, exclusive of VAT, after
     * subtracting item price discount. Must be rounded to maximum 4 decimals
     */
    unit_price?: number | string | null;
  }

  export namespace Item {
    /**
     * An allowance is a discount for example for early payment, volume discount, etc.
     */
    export interface Allowance {
      /**
       * The allowance amount, without VAT. Must be rounded to maximum 2 decimals
       */
      amount?: number | string | null;

      /**
       * The base amount that may be used, in conjunction with the allowance percentage,
       * to calculate the allowance amount. Must be rounded to maximum 2 decimals
       */
      base_amount?: number | string | null;

      /**
       * The percentage that may be used, in conjunction with the allowance base amount,
       * to calculate the allowance amount. To state 20%, use value 20. Must be rounded
       * to maximum 2 decimals
       */
      multiplier_factor?: number | string | null;

      /**
       * The reason for the allowance
       */
      reason?: string | null;

      /**
       * Allowance reason codes for invoice discounts and charges
       */
      reason_code?:
        | '41'
        | '42'
        | '60'
        | '62'
        | '63'
        | '64'
        | '65'
        | '66'
        | '67'
        | '68'
        | '70'
        | '71'
        | '88'
        | '95'
        | '100'
        | '102'
        | '103'
        | '104'
        | '105'
        | null;

      /**
       * The VAT category code that applies to the allowance
       */
      tax_code?: 'AE' | 'E' | 'S' | 'Z' | 'G' | 'O' | 'K' | 'L' | 'M' | 'B';

      /**
       * The VAT rate, represented as percentage that applies to the allowance. Must be
       * rounded to maximum 2 decimals
       */
      tax_rate?: number | string | null;
    }

    /**
     * A charge is an additional fee for example for late payment, late delivery, etc.
     */
    export interface Charge {
      /**
       * The charge amount, without VAT. Must be rounded to maximum 2 decimals
       */
      amount?: number | string | null;

      /**
       * The base amount that may be used, in conjunction with the charge percentage, to
       * calculate the charge amount. Must be rounded to maximum 2 decimals
       */
      base_amount?: number | string | null;

      /**
       * The percentage that may be used, in conjunction with the charge base amount, to
       * calculate the charge amount. To state 20%, use value 20
       */
      multiplier_factor?: number | string | null;

      /**
       * The reason for the charge
       */
      reason?: string | null;

      /**
       * Charge reason codes for invoice charges and fees
       */
      reason_code?:
        | 'AA'
        | 'AAA'
        | 'AAC'
        | 'AAD'
        | 'AAE'
        | 'AAF'
        | 'AAH'
        | 'AAI'
        | 'AAS'
        | 'AAT'
        | 'AAV'
        | 'AAY'
        | 'AAZ'
        | 'ABA'
        | 'ABB'
        | 'ABC'
        | 'ABD'
        | 'ABF'
        | 'ABK'
        | 'ABL'
        | 'ABN'
        | 'ABR'
        | 'ABS'
        | 'ABT'
        | 'ABU'
        | 'ACF'
        | 'ACG'
        | 'ACH'
        | 'ACI'
        | 'ACJ'
        | 'ACK'
        | 'ACL'
        | 'ACM'
        | 'ACS'
        | 'ADC'
        | 'ADE'
        | 'ADJ'
        | 'ADK'
        | 'ADL'
        | 'ADM'
        | 'ADN'
        | 'ADO'
        | 'ADP'
        | 'ADQ'
        | 'ADR'
        | 'ADT'
        | 'ADW'
        | 'ADY'
        | 'ADZ'
        | 'AEA'
        | 'AEB'
        | 'AEC'
        | 'AED'
        | 'AEF'
        | 'AEH'
        | 'AEI'
        | 'AEJ'
        | 'AEK'
        | 'AEL'
        | 'AEM'
        | 'AEN'
        | 'AEO'
        | 'AEP'
        | 'AES'
        | 'AET'
        | 'AEU'
        | 'AEV'
        | 'AEW'
        | 'AEX'
        | 'AEY'
        | 'AEZ'
        | 'AJ'
        | 'AU'
        | 'CA'
        | 'CAB'
        | 'CAD'
        | 'CAE'
        | 'CAF'
        | 'CAI'
        | 'CAJ'
        | 'CAK'
        | 'CAL'
        | 'CAM'
        | 'CAN'
        | 'CAO'
        | 'CAP'
        | 'CAQ'
        | 'CAR'
        | 'CAS'
        | 'CAT'
        | 'CAU'
        | 'CAV'
        | 'CAW'
        | 'CAX'
        | 'CAY'
        | 'CAZ'
        | 'CD'
        | 'CG'
        | 'CS'
        | 'CT'
        | 'DAB'
        | 'DAC'
        | 'DAD'
        | 'DAF'
        | 'DAG'
        | 'DAH'
        | 'DAI'
        | 'DAJ'
        | 'DAK'
        | 'DAL'
        | 'DAM'
        | 'DAN'
        | 'DAO'
        | 'DAP'
        | 'DAQ'
        | 'DL'
        | 'EG'
        | 'EP'
        | 'ER'
        | 'FAA'
        | 'FAB'
        | 'FAC'
        | 'FC'
        | 'FH'
        | 'FI'
        | 'GAA'
        | 'HAA'
        | 'HD'
        | 'HH'
        | 'IAA'
        | 'IAB'
        | 'ID'
        | 'IF'
        | 'IR'
        | 'IS'
        | 'KO'
        | 'L1'
        | 'LA'
        | 'LAA'
        | 'LAB'
        | 'LF'
        | 'MAE'
        | 'MI'
        | 'ML'
        | 'NAA'
        | 'OA'
        | 'PA'
        | 'PAA'
        | 'PC'
        | 'PL'
        | 'PRV'
        | 'RAB'
        | 'RAC'
        | 'RAD'
        | 'RAF'
        | 'RE'
        | 'RF'
        | 'RH'
        | 'RV'
        | 'SA'
        | 'SAA'
        | 'SAD'
        | 'SAE'
        | 'SAI'
        | 'SG'
        | 'SH'
        | 'SM'
        | 'SU'
        | 'TAB'
        | 'TAC'
        | 'TT'
        | 'TV'
        | 'V1'
        | 'V2'
        | 'WH'
        | 'XAA'
        | 'YY'
        | 'ZZZ'
        | null;

      /**
       * Duty or tax or fee category codes (Subset of UNCL5305)
       *
       * Agency: UN/CEFACT Version: D.16B Subset: OpenPEPPOL
       */
      tax_code?: 'AE' | 'E' | 'S' | 'Z' | 'G' | 'O' | 'K' | 'L' | 'M' | 'B' | null;

      /**
       * The VAT rate, represented as percentage that applies to the charge
       */
      tax_rate?: number | string | null;
    }
  }

  export interface TaxDetail {
    /**
     * The tax amount for this tax category. Must be rounded to maximum 2 decimals
     */
    amount?: number | string | null;

    /**
     * The tax rate as a percentage (e.g., '21.00', '6.00', '0.00')
     */
    rate?: string | null;
  }
}

export interface ValidateValidatePeppolIDParams {
  /**
   * Peppol ID in the format `<scheme>:<id>`. Example: `0208:1018265814` for a
   * Belgian company.
   */
  peppol_id: string;
}

export interface ValidateValidateUblParams {
  file: Uploadable;
}

export declare namespace Validate {
  export {
    type UblDocumentValidation as UblDocumentValidation,
    type ValidateValidatePeppolIDResponse as ValidateValidatePeppolIDResponse,
    type ValidateValidateJsonParams as ValidateValidateJsonParams,
    type ValidateValidatePeppolIDParams as ValidateValidatePeppolIDParams,
    type ValidateValidateUblParams as ValidateValidateUblParams,
  };
}