Path parameters

• employer_id string Required
• employee_id string Required

Query parameters

• page_size integer

  The maximum number of contributions to return per page.

  Minimum value is 100, maximum value is 500. Default value is 200.

• page_number integer

  The page number to return in the list of contributions.

  Minimum value is 1. Default value is 1.

• sort_by string

  Sort Contributions by date

  Values are pay_period_start_date, pay_period_end_date, or created_at. Default value is created_at.

• sort_order string

  Sort order (ascending or descending)

  Values are asc or desc. Default value is desc.

Responses

• 200 application/json

  A list of contributions for the specified employee.

  Hide response attributes Show response attributes object

  • page_number integer

    The current page number.

  • page_size integer

    The number of items per page.

  • total_items integer

    The total number of items available.

  • items array[object]

    An array of Contribution objects on the current page.

    Hide items attributes Show items attributes object

    • id string Required

      Unique identifier for the contribution record.

    • upload_id string

      ID of the file upload from which the contribution was created (if applicable).

    • employee_id string Required

      Identifier for the employee associated with the contribution.

    • employer_contributions_amount number Required

      The amount of the employer's contribution for the given pay period.

    • employee_contributions_amount number Required

      The amount of the employee's contribution for the given pay period.

    • employer_contributions_percent number | null Required

      The employer's contribution for the given pay period expressed as a percentage.

      Minimum value is 0, maximum value is 100.

    • employee_contributions_percent number | null Required

      The employee's contribution for the given pay period expressed as a percentage.

      Minimum value is 0, maximum value is 100.

    • created_at string(date-time) Required

      The date and time the contribution record was created, in ISO 8601 format.

    • pay_period_start_date string(date) Required

      The start date of the pay period for which the contributions were made, in YYYY-MM-DD format.

    • pay_period_end_date string(date) Required

      The end date of the pay period for which the contributions were made, in YYYY-MM-DD format.

    • status string Required

      The status of the contribution. Note this does not represent the status of processing but rather the underlying payment. Possible values are: - Cancelled: The contribution has been cancelled. - NotSubmitted: The contribution has not been submitted. - Deleted: The contribution has been deleted. - Pending: The contribution is currently being processed. - Completed: The contribution has been successfully processed.

      Values are Cancelled, NotSubmitted, Deleted, Pending, or Completed.

• 400 application/json

  Bad request, the request is malformed or contains invalid data.

  Hide response attribute Show response attribute object

  • error string

    A descriptive error message.

• 401 application/json

  Unauthorized, the request requires authentication, and the provided credentials are either missing or incorrect.

  Hide response attribute Show response attribute object

  • error string

    A descriptive error message.

• 404 application/json

  Employee or employer not found, the specified employee_id or employer_id does not match any existing records.

  Hide response attribute Show response attribute object

  • error string

    A descriptive error message.