mindee/src/product/fr/payslip/payslipV2PayPeriod.d.ts

Mindee Client Library for Node.js

import { StringDict } from "../../../parsing/common";
import { Polygon } from "../../../geometry";
/**
 * Information about the pay period.
 */
export declare class PayslipV2PayPeriod {
    #private;
    /** The end date of the pay period. */
    endDate: string | null;
    /** The month of the pay period. */
    month: string | null;
    /** The date of payment for the pay period. */
    paymentDate: string | null;
    /** The start date of the pay period. */
    startDate: string | null;
    /** The year of the pay period. */
    year: string | null;
    /** Confidence score */
    confidence: number;
    /** The document page on which the information was found. */
    pageId: number;
    /**
     * Contains the relative vertices coordinates (points) of a polygon containing
     * the field in the document.
     */
    polygon: Polygon;
    constructor({ prediction }: StringDict);
    /**
     * Default string representation.
     */
    toString(): string;
    /**
     * Output in a format suitable for inclusion in a field list.
     */
    toFieldList(): string;
}