FR Payslip OCR Node.js
The Node.js OCR SDK supports the Payslip API.
The sample below can be used for testing purposes.
Quick-Start
const mindee = require("mindee");
// for TS or modules:
// import * as mindee from "mindee";
// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
// Load a file from disk
const inputSource = mindeeClient.docFromPath("/path/to/the/file.ext");
// Parse the file
const apiResponse = mindeeClient.enqueueAndParse(
mindee.product.fr.PayslipV2,
inputSource
);
// Handle the response Promise
apiResponse.then((resp) => {
// print a string summary
console.log(resp.document.toString());
});
Field Types
Standard Fields
These fields are generic and used in several products.
Basic Field
Each prediction object contains a set of fields that inherit from the generic Field
class.
A typical Field
object will have the following attributes:
- value (
number | string
): corresponds to the field value. Can beundefined
if no value was extracted. - confidence (
number
): the confidence score of the field prediction. - boundingBox (
[Point, Point, Point, Point]
): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document. - polygon (
Point[]
): contains the relative vertices coordinates (Point
) of a polygon containing the field in the image. - pageId (
number
): the ID of the page, alwaysundefined
when at document-level. - reconstructed (
boolean
): indicates whether an object was reconstructed (not extracted as the API gave it).
Note: A
Point
simply refers to an array of two numbers ([number, number]
).
Aside from the previous attributes, all basic fields have access to a toString()
method that can be used to print their value as a string.
Specific Fields
Fields which are specific to this product; they are not used in any other product.
Bank Account Details Field
Information about the employee's bank account.
A PayslipV2BankAccountDetail
implements the following attributes:
bankName
(string): The name of the bank.iban
(string): The IBAN of the bank account.swift
(string): The SWIFT code of the bank.
Fields which are specific to this product; they are not used in any other product.
Employee Field
Information about the employee.
A PayslipV2Employee
implements the following attributes:
address
(string): The address of the employee.dateOfBirth
(string): The date of birth of the employee.firstName
(string): The first name of the employee.lastName
(string): The last name of the employee.phoneNumber
(string): The phone number of the employee.registrationNumber
(string): The registration number of the employee.socialSecurityNumber
(string): The social security number of the employee.
Fields which are specific to this product; they are not used in any other product.
Employer Field
Information about the employer.
A PayslipV2Employer
implements the following attributes:
address
(string): The address of the employer.companyId
(string): The company ID of the employer.companySite
(string): The site of the company.nafCode
(string): The NAF code of the employer.name
(string): The name of the employer.phoneNumber
(string): The phone number of the employer.urssafNumber
(string): The URSSAF number of the employer.
Fields which are specific to this product; they are not used in any other product.
Employment Field
Information about the employment.
A PayslipV2Employment
implements the following attributes:
category
(string): The category of the employment.coefficient
(number): The coefficient of the employment.collectiveAgreement
(string): The collective agreement of the employment.jobTitle
(string): The job title of the employee.positionLevel
(string): The position level of the employment.startDate
(string): The start date of the employment.
Fields which are specific to this product; they are not used in any other product.
Pay Detail Field
Detailed information about the pay.
A PayslipV2PayDetail
implements the following attributes:
grossSalary
(number): The gross salary of the employee.grossSalaryYtd
(number): The year-to-date gross salary of the employee.incomeTaxRate
(number): The income tax rate of the employee.incomeTaxWithheld
(number): The income tax withheld from the employee's pay.netPaid
(number): The net paid amount of the employee.netPaidBeforeTax
(number): The net paid amount before tax of the employee.netTaxable
(number): The net taxable amount of the employee.netTaxableYtd
(number): The year-to-date net taxable amount of the employee.totalCostEmployer
(number): The total cost to the employer.totalTaxesAndDeductions
(number): The total taxes and deductions of the employee.
Fields which are specific to this product; they are not used in any other product.
Pay Period Field
Information about the pay period.
A PayslipV2PayPeriod
implements the following attributes:
endDate
(string): The end date of the pay period.month
(string): The month of the pay period.paymentDate
(string): The date of payment for the pay period.startDate
(string): The start date of the pay period.year
(string): The year of the pay period.
Fields which are specific to this product; they are not used in any other product.
PTO Field
Information about paid time off.
A PayslipV2Pto
implements the following attributes:
accruedThisPeriod
(number): The amount of paid time off accrued in this period.balanceEndOfPeriod
(number): The balance of paid time off at the end of the period.usedThisPeriod
(number): The amount of paid time off used in this period.
Fields which are specific to this product; they are not used in any other product.
Salary Details Field
Detailed information about the earnings.
A PayslipV2SalaryDetail
implements the following attributes:
amount
(number): The amount of the earnings.base
(number): The base value of the earnings.description
(string): The description of the earnings.rate
(number): The rate of the earnings.
Attributes
The following fields are extracted for Payslip V2:
Bank Account Details
bankAccountDetails (PayslipV2BankAccountDetail): Information about the employee's bank account.
console.log(result.document.inference.prediction.bankAccountDetails.value);
Employee
employee (PayslipV2Employee): Information about the employee.
console.log(result.document.inference.prediction.employee.value);
Employer
employer (PayslipV2Employer): Information about the employer.
console.log(result.document.inference.prediction.employer.value);
Employment
employment (PayslipV2Employment): Information about the employment.
console.log(result.document.inference.prediction.employment.value);
Pay Detail
payDetail (PayslipV2PayDetail): Detailed information about the pay.
console.log(result.document.inference.prediction.payDetail.value);
Pay Period
payPeriod (PayslipV2PayPeriod): Information about the pay period.
console.log(result.document.inference.prediction.payPeriod.value);
PTO
pto (PayslipV2Pto): Information about paid time off.
console.log(result.document.inference.prediction.pto.value);
Salary Details
salaryDetails (PayslipV2SalaryDetail[]): Detailed information about the earnings.
for (const salaryDetailsElem of result.document.inference.prediction.salaryDetails) {
console.log(salaryDetailsElem.value);
}
Questions?
Updated 22 days ago