e-invoice-api/resources/validate.d.mts

The official TypeScript library for the e-invoice API

import { APIResource } from "../core/resource.mjs";
import * as InboxAPI from "./inbox.mjs";
import * as DocumentsAPI from "./documents/documents.mjs";
import { APIPromise } from "../core/api-promise.mjs";
import { type Uploadable } from "../core/uploads.mjs";
import { RequestOptions } from "../internal/request-options.mjs";
export declare class Validate extends APIResource {
    /**
     * Validate if the JSON document can be converted to a valid UBL document
     */
    validateJson(body: ValidateValidateJsonParams, options?: RequestOptions): APIPromise<UblDocumentValidation>;
    /**
     * 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>;
    /**
     * Validate the correctness of a UBL document
     */
    validateUbl(body: ValidateValidateUblParams, options?: RequestOptions): APIPromise<UblDocumentValidation>;
}
export interface UblDocumentValidation {
    id: string;
    file_name: string | null;
    is_valid: boolean;
    issues: Array<UblDocumentValidation.Issue>;
    ubl_document?: string | null;
}
export declare namespace UblDocumentValidation {
    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 declare namespace ValidateValidatePeppolIDResponse {
    /**
     * Business card information for the Peppol ID
     */
    interface BusinessCard {
        country_code?: string | null;
        name?: string | null;
        registration_date?: string | null;
    }
}
export interface ValidateValidateJsonParams {
    amount_due?: number | string | null;
    attachments?: Array<DocumentsAPI.DocumentAttachmentCreate> | null;
    billing_address?: string | null;
    billing_address_recipient?: string | null;
    /**
     * Currency of the invoice
     */
    currency?: DocumentsAPI.CurrencyCode;
    customer_address?: string | null;
    customer_address_recipient?: string | null;
    customer_email?: string | null;
    customer_id?: string | null;
    customer_name?: string | null;
    customer_tax_id?: string | null;
    direction?: DocumentsAPI.DocumentDirection;
    document_type?: DocumentsAPI.DocumentType;
    due_date?: string | null;
    invoice_date?: string | null;
    invoice_id?: string | null;
    invoice_total?: number | string | null;
    items?: Array<ValidateValidateJsonParams.Item> | null;
    note?: string | null;
    payment_details?: Array<DocumentsAPI.PaymentDetailCreate> | null;
    payment_term?: string | null;
    previous_unpaid_balance?: number | string | null;
    purchase_order?: string | null;
    remittance_address?: string | null;
    remittance_address_recipient?: string | null;
    service_address?: string | null;
    service_address_recipient?: string | null;
    service_end_date?: string | null;
    service_start_date?: string | null;
    shipping_address?: string | null;
    shipping_address_recipient?: string | null;
    state?: InboxAPI.DocumentState;
    subtotal?: number | string | null;
    tax_details?: Array<ValidateValidateJsonParams.TaxDetail> | null;
    total_discount?: number | string | null;
    total_tax?: number | string | null;
    vendor_address?: string | null;
    vendor_address_recipient?: string | null;
    vendor_email?: string | null;
    vendor_name?: string | null;
    vendor_tax_id?: string | null;
}
export declare namespace ValidateValidateJsonParams {
    interface Item {
        amount?: number | string | null;
        date?: null;
        description?: string | null;
        product_code?: string | null;
        quantity?: number | string | null;
        tax?: number | string | null;
        tax_rate?: string | null;
        /**
         * Unit of Measure Codes from UNECERec20 used in Peppol BIS Billing 3.0.
         */
        unit?: DocumentsAPI.UnitOfMeasureCode | null;
        unit_price?: number | string | null;
    }
    interface TaxDetail {
        amount?: number | string | null;
        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, };
}
//# sourceMappingURL=validate.d.mts.map