Payslip

Automatically parse payslips and extract structured salary data using the pre-trained Payslip model template available in the Catalog.

Documentation for the data schema of the Payslip model template.

Payslip Fields

Documentation for all fields present in the data schema.

Field accessors are used as the keys for accessing the values in the returned data. On the data schema interface, this is the "Field Name".

Field value types indicate how the value is returned by the API. On the data schema interface, this is the "Field Type".

First Name

Employee's first name

Accessor: first_name Value Type: string

Has a single value.

Last Name

Employee's last name

Accessor: last_name Value Type: string

Has a single value.

Employee Address

Employee's address

Accessor: employee_address Value Type: string

Has a single value.

Pay Period Start Date

Start date of the pay period

Accessor: pay_period_start_date Value Type: date

Has a single value.

Pay Period End Date

End date of the pay period

Accessor: pay_period_end_date Value Type: date

Has a single value.

Gross Pay

Gross pay amount

Accessor: gross_pay Value Type: number

Has a single value.

Net Pay

Net pay amount

Accessor: net_pay Value Type: number

Has a single value.

Deductions

List of deductions

Accessor: deductions

Subfields

• Name Name of the deduction Accessor: name Value Type: string
• Amount Amount of the deduction Accessor: amount Value Type: number

Can have multiple values (is a list/array).

Taxes

List of taxes

Accessor: taxes

Subfields

• Name Name of the tax Accessor: name Value Type: string
• Amount Amount of the tax Accessor: amount Value Type: number

Can have multiple values (is a list/array).

Employer Name

Name of the employer

Accessor: employer_name Value Type: string

Has a single value.

Employer Address

Address of the employer

Accessor: employer_address Value Type: string

Has a single value.

Social Security Number

Employee's Social Security Number

Accessor: social_security_number Value Type: string

Has a single value.

Employee ID

Employee's ID

Accessor: employee_id Value Type: string

Has a single value.