Documentation
Log inGet started

FR Payslip OCR Python

Suggest Edits

The Python OCR SDK supports the Payslip API.

Using the sample below, we are going to illustrate how to extract the data that we want using the OCR SDK.
Payslip sample

Quick-Start

from mindee import Client, product, AsyncPredictResponse

# Init a new client
mindee_client = Client(api_key="my-api-key")

# Load a file from disk
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")

# Load a file from disk and enqueue it.
result: AsyncPredictResponse = mindee_client.enqueue_and_parse(
    product.fr.PayslipV2,
    input_doc,
)

# Print a brief summary of the parsed data
print(result.document)

Output (RST):

########
Document
########
:Mindee ID: 972edba5-25aa-49d0-8431-e2557ddd788e
:Filename: default_sample.jpg

Inference
#########
:Product: mindee/payslip_fra v2.0
:Rotation applied: No

Prediction
==========
:Employee:
  :Address: 52 RUE DES FLEURS 33500 LIBOURNE FRANCE
  :Date of Birth:
  :First Name: Jean Luc
  :Last Name: Picard
  :Phone Number:
  :Registration Number:
  :Social Security Number: 123456789012345
:Employer:
  :Address: 1 RUE DU TONNOT 25210 DOUBS
  :Company ID: 12345678901234
  :Company Site:
  :NAF Code: 1234A
  :Name: DEMO COMPANY
  :Phone Number:
  :URSSAF Number:
:Bank Account Details:
  :Bank Name:
  :IBAN:
  :SWIFT:
:Employment:
  :Category: Cadre
  :Coefficient: 600.00
  :Collective Agreement: Construction -- Promotion
  :Job Title: Directeur Régional du Développement
  :Position Level:
  :Start Date: 2022-05-01
:Salary Details:
  +--------------+-----------+--------------------------------------+-----------+
  | Amount       | Base      | Description                          | Rate      |
  +==============+===========+======================================+===========+
  | 6666.67      |           | Salaire de base                      |           |
  +--------------+-----------+--------------------------------------+-----------+
  | 9.30         |           | Part patronale Mutuelle NR           |           |
  +--------------+-----------+--------------------------------------+-----------+
  | 508.30       |           | Avantages en nature voiture          |           |
  +--------------+-----------+--------------------------------------+-----------+
:Pay Detail:
  :Gross Salary: 7184.27
  :Gross Salary YTD: 18074.81
  :Income Tax Rate: 17.60
  :Income Tax Withheld: 1030.99
  :Net Paid: 3868.32
  :Net Paid Before Tax: 4899.31
  :Net Taxable: 5857.90
  :Net Taxable YTD: 14752.73
  :Total Cost Employer: 10486.94
  :Total Taxes and Deductions: 1650.36
:PTO:
  :Accrued This Period: 6.17
  :Balance End of Period: 6.17
  :Used This Period:
:Pay Period:
  :End Date: 2023-03-31
  :Month: 03
  :Payment Date: 2023-03-29
  :Start Date: 2023-03-01
  :Year: 2023

Field Types

Standard Fields

These fields are generic and used in several products.

BaseField

Each prediction object contains a set of fields that inherit from the generic BaseField class.
A typical BaseField object will have the following attributes:

  • value (Union[float, str]): corresponds to the field value. Can be None if no value was extracted.
  • confidence (float): the confidence score of the field prediction.
  • bounding_box ([Point, Point, Point, Point]): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
  • polygon (List[Point]): contains the relative vertices coordinates (Point) of a polygon containing the field in the image.
  • page_id (int): the ID of the page, always None when at document-level.
  • reconstructed (bool): indicates whether an object was reconstructed (not extracted as the API gave it).

Note: A Point simply refers to a List of two numbers ([float, float]).

Aside from the previous attributes, all basic fields have access to a custom __str__ 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:

  • bank_name (str): The name of the bank.
  • iban (str): The IBAN of the bank account.
  • swift (str): 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 (str): The address of the employee.
  • date_of_birth (str): The date of birth of the employee.
  • first_name (str): The first name of the employee.
  • last_name (str): The last name of the employee.
  • phone_number (str): The phone number of the employee.
  • registration_number (str): The registration number of the employee.
  • social_security_number (str): 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 (str): The address of the employer.
  • company_id (str): The company ID of the employer.
  • company_site (str): The site of the company.
  • naf_code (str): The NAF code of the employer.
  • name (str): The name of the employer.
  • phone_number (str): The phone number of the employer.
  • urssaf_number (str): 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 (str): The category of the employment.
  • coefficient (float): The coefficient of the employment.
  • collective_agreement (str): The collective agreement of the employment.
  • job_title (str): The job title of the employee.
  • position_level (str): The position level of the employment.
  • start_date (str): 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:

  • gross_salary (float): The gross salary of the employee.
  • gross_salary_ytd (float): The year-to-date gross salary of the employee.
  • income_tax_rate (float): The income tax rate of the employee.
  • income_tax_withheld (float): The income tax withheld from the employee's pay.
  • net_paid (float): The net paid amount of the employee.
  • net_paid_before_tax (float): The net paid amount before tax of the employee.
  • net_taxable (float): The net taxable amount of the employee.
  • net_taxable_ytd (float): The year-to-date net taxable amount of the employee.
  • total_cost_employer (float): The total cost to the employer.
  • total_taxes_and_deductions (float): 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:

  • end_date (str): The end date of the pay period.
  • month (str): The month of the pay period.
  • payment_date (str): The date of payment for the pay period.
  • start_date (str): The start date of the pay period.
  • year (str): 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:

  • accrued_this_period (float): The amount of paid time off accrued in this period.
  • balance_end_of_period (float): The balance of paid time off at the end of the period.
  • used_this_period (float): 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 (float): The amount of the earnings.
  • base (float): The base value of the earnings.
  • description (str): The description of the earnings.
  • rate (float): The rate of the earnings.

Attributes

The following fields are extracted for Payslip V2:

Bank Account Details

bank_account_details (PayslipV2BankAccountDetail): Information about the employee's bank account.

print(result.document.inference.prediction.bank_account_details.value)

Employee

employee (PayslipV2Employee): Information about the employee.

print(result.document.inference.prediction.employee.value)

Employer

employer (PayslipV2Employer): Information about the employer.

print(result.document.inference.prediction.employer.value)

Employment

employment (PayslipV2Employment): Information about the employment.

print(result.document.inference.prediction.employment.value)

Pay Detail

pay_detail (PayslipV2PayDetail): Detailed information about the pay.

print(result.document.inference.prediction.pay_detail.value)

Pay Period

pay_period (PayslipV2PayPeriod): Information about the pay period.

print(result.document.inference.prediction.pay_period.value)

PTO

pto (PayslipV2Pto): Information about paid time off.

print(result.document.inference.prediction.pto.value)

Salary Details

salary_details (List[PayslipV2SalaryDetail]): Detailed information about the earnings.

for salary_details_elem in result.document.inference.prediction.salary_details:
    print(salary_details_elem.value)

Questions?

Join our Slack

Updated about 1 month ago