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

Mindee Client Library for Node.js

import { StringDict } from "../../../parsing/common";
import { Polygon } from "../../../geometry";
/**
 * Detailed information about the pay.
 */
export declare class PayslipV2PayDetail {
    #private;
    /** The gross salary of the employee. */
    grossSalary: number | null;
    /** The year-to-date gross salary of the employee. */
    grossSalaryYtd: number | null;
    /** The income tax rate of the employee. */
    incomeTaxRate: number | null;
    /** The income tax withheld from the employee's pay. */
    incomeTaxWithheld: number | null;
    /** The net paid amount of the employee. */
    netPaid: number | null;
    /** The net paid amount before tax of the employee. */
    netPaidBeforeTax: number | null;
    /** The net taxable amount of the employee. */
    netTaxable: number | null;
    /** The year-to-date net taxable amount of the employee. */
    netTaxableYtd: number | null;
    /** The total cost to the employer. */
    totalCostEmployer: number | null;
    /** The total taxes and deductions of the employee. */
    totalTaxesAndDeductions: number | 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;
}