> This page is for Unified. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.merge.dev/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server. The `EmployeePayrollRun` object is used to represent an employee's pay statement for a specific payroll run. ### The EmployeePayrollRun Object ```json { "id": "string", "remote_id": "string", "created_at": "2023-01-01T00:00:00Z", "modified_at": "2023-01-01T00:00:00Z", "employee": "string", "payroll_run": "string", "gross_pay": 1, "net_pay": 1, "start_date": "2023-01-01T00:00:00Z", "end_date": "2023-01-01T00:00:00Z", "check_date": "2023-01-01T00:00:00Z", "earnings": [ { "id": "string", "remote_id": "string", "created_at": "2023-01-01T00:00:00Z", "modified_at": "2023-01-01T00:00:00Z", "employee_payroll_run": "string", "amount": 1, "type": "SALARY", "remote_was_deleted": true, "field_mappings": { "organization_defined_targets": { "string": {} }, "linked_account_defined_targets": { "string": {} } }, "remote_data": [ { "path": "string", "data": {} } ] } ], "deductions": [ { "id": "string", "remote_id": "string", "created_at": "2023-01-01T00:00:00Z", "modified_at": "2023-01-01T00:00:00Z", "employee_payroll_run": "string", "name": "string", "employee_deduction": 1, "company_deduction": 1, "remote_was_deleted": true, "field_mappings": { "organization_defined_targets": { "string": {} }, "linked_account_defined_targets": { "string": {} } }, "remote_data": [ { "path": "string", "data": {} } ] } ], "taxes": [ { "id": "string", "remote_id": "string", "created_at": "2023-01-01T00:00:00Z", "modified_at": "2023-01-01T00:00:00Z", "employee_payroll_run": "string", "name": "string", "amount": 1, "employer_tax": true, "remote_was_deleted": true, "field_mappings": { "organization_defined_targets": { "string": {} }, "linked_account_defined_targets": { "string": {} } }, "remote_data": [ { "path": "string", "data": {} } ] } ], "remote_was_deleted": true, "field_mappings": { "organization_defined_targets": { "string": {} }, "linked_account_defined_targets": { "string": {} } }, "remote_data": [ { "path": "string", "data": {} } ] } ``` ### Schema (`EmployeePayrollRun`) ```yaml components: schemas: EarningTypeEnum: type: string enum: - SALARY - REIMBURSEMENT - OVERTIME - BONUS title: EarningTypeEnum EarningFieldMappings: type: object properties: organization_defined_targets: type: object additionalProperties: description: Any type linked_account_defined_targets: type: object additionalProperties: description: Any type title: EarningFieldMappings RemoteData: type: object properties: path: type: string description: The third-party API path that is being called. data: description: >- The data returned from the third-party for this object in its original, unnormalized format. required: - path description: >- # The RemoteData Object ### Description The `RemoteData` object is used to represent the full data pulled from the third-party API for an object. ### Usage Example TODO title: RemoteData Earning: type: object properties: id: type: string format: uuid remote_id: type: - string - 'null' description: The third-party API ID of the matching object. created_at: type: string format: date-time description: The datetime that this object was created by Merge. modified_at: type: string format: date-time description: The datetime that this object was modified by Merge. employee_payroll_run: type: - string - 'null' format: uuid amount: type: - number - 'null' format: double description: The amount earned. type: oneOf: - $ref: '#/components/schemas/EarningTypeEnum' - type: 'null' description: The type of earning. remote_was_deleted: type: boolean description: >- Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). field_mappings: oneOf: - $ref: '#/components/schemas/EarningFieldMappings' - type: 'null' remote_data: type: - array - 'null' items: $ref: '#/components/schemas/RemoteData' description: >- # The Earning Object ### Description The `Earning` object is used to represent an array of different compensations that an employee receives within specific wage categories. ### Usage Example Fetch from the `LIST Earnings` endpoint and filter by `ID` to show all earnings. title: Earning DeductionFieldMappings: type: object properties: organization_defined_targets: type: object additionalProperties: description: Any type linked_account_defined_targets: type: object additionalProperties: description: Any type title: DeductionFieldMappings Deduction: type: object properties: id: type: string format: uuid remote_id: type: - string - 'null' description: The third-party API ID of the matching object. created_at: type: string format: date-time description: The datetime that this object was created by Merge. modified_at: type: string format: date-time description: The datetime that this object was modified by Merge. employee_payroll_run: type: - string - 'null' format: uuid name: type: - string - 'null' description: The deduction's name. employee_deduction: type: - number - 'null' format: double description: >- The amount of money that is withheld from an employee's gross pay by the employee. company_deduction: type: - number - 'null' format: double description: >- The amount of money that is withheld on behalf of an employee by the company. remote_was_deleted: type: boolean description: >- Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). field_mappings: oneOf: - $ref: '#/components/schemas/DeductionFieldMappings' - type: 'null' remote_data: type: - array - 'null' items: $ref: '#/components/schemas/RemoteData' description: >- # The Deduction Object ### Description The `Deduction` object is used to represent an array of the wages withheld from total earnings for the purpose of paying taxes. ### Usage Example Fetch from the `LIST Deductions` endpoint and filter by `ID` to show all deductions. title: Deduction TaxFieldMappings: type: object properties: organization_defined_targets: type: object additionalProperties: description: Any type linked_account_defined_targets: type: object additionalProperties: description: Any type title: TaxFieldMappings Tax: type: object properties: id: type: string format: uuid remote_id: type: - string - 'null' description: The third-party API ID of the matching object. created_at: type: string format: date-time description: The datetime that this object was created by Merge. modified_at: type: string format: date-time description: The datetime that this object was modified by Merge. employee_payroll_run: type: - string - 'null' format: uuid name: type: - string - 'null' description: The tax's name. amount: type: - number - 'null' format: double description: The tax amount. employer_tax: type: - boolean - 'null' description: Whether or not the employer is responsible for paying the tax. remote_was_deleted: type: boolean description: >- Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). field_mappings: oneOf: - $ref: '#/components/schemas/TaxFieldMappings' - type: 'null' remote_data: type: - array - 'null' items: $ref: '#/components/schemas/RemoteData' description: >- # The Tax Object ### Description The `Tax` object is used to represent an array of the tax deductions for a given employee's payroll run. ### Usage Example Fetch from the `LIST Taxes` endpoint and filter by `ID` to show all taxes. title: Tax EmployeePayrollRunFieldMappings: type: object properties: organization_defined_targets: type: object additionalProperties: description: Any type linked_account_defined_targets: type: object additionalProperties: description: Any type title: EmployeePayrollRunFieldMappings EmployeePayrollRun: type: object properties: id: type: string format: uuid remote_id: type: - string - 'null' description: The third-party API ID of the matching object. created_at: type: string format: date-time description: The datetime that this object was created by Merge. modified_at: type: string format: date-time description: The datetime that this object was modified by Merge. employee: type: - string - 'null' format: uuid description: The employee whose payroll is being run. payroll_run: type: - string - 'null' format: uuid description: The payroll being run. gross_pay: type: - number - 'null' format: double description: >- The total earnings throughout a given period for an employee before any deductions are made. net_pay: type: - number - 'null' format: double description: >- The take-home pay throughout a given period for an employee after deductions are made. start_date: type: - string - 'null' format: date-time description: The day and time the payroll run started. end_date: type: - string - 'null' format: date-time description: The day and time the payroll run ended. check_date: type: - string - 'null' format: date-time description: The day and time the payroll run was checked. earnings: type: array items: $ref: '#/components/schemas/Earning' deductions: type: array items: $ref: '#/components/schemas/Deduction' taxes: type: array items: $ref: '#/components/schemas/Tax' remote_was_deleted: type: boolean description: >- Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). field_mappings: oneOf: - $ref: '#/components/schemas/EmployeePayrollRunFieldMappings' - type: 'null' remote_data: type: - array - 'null' items: $ref: '#/components/schemas/RemoteData' title: EmployeePayrollRun ```