Retrieve contributions for an upload.

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://docs.getpenfold.dev/mcp

Standard setup for AI tools providing an mcp.json file

      
          mcp.json

"Penfold Partner API MCP server": {
  "url": "https://docs.getpenfold.dev/mcp"
}

GET /uploads/{upload_id}/contributions

O auth2 client credentials

Get the contributions created for an upload.

Path parameters

employer_id string Required
upload_id string Required

Query parameters

page_size integer

The maximum number of records 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 records.

Minimum value is 1. Default value is 1.

Responses

200 application/json

Retrieved the upload contributions successfully.
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

The employer or upload was not found.
Hide response attribute Show response attribute object
- error string
  
  A descriptive error message.

GET /uploads/{upload_id}/contributions

curl \
 --request GET 'https://payroll-api.getpenfold.dev/v4/uploads/{upload_id}/contributions' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "page_number": 1,
  "page_size": 200,
  "total_items": 1,
  "items": [
    {
      "id": "c1234-abcd-5678-efgh",
      "upload_id": "string",
      "employee_id": "e9876-wxyz-4321-stuv",
      "employer_contributions_amount": 1000.0,
      "employee_contributions_amount": 250.0,
      "employer_contributions_percent": 10,
      "employee_contributions_percent": 20,
      "created_at": "2023-03-22T12:00:00Z",
      "pay_period_start_date": "2023-03-01",
      "pay_period_end_date": "2023-03-15",
      "status": "Pending"
    }
  ]
}

Response examples (400)

{
  "error": "Bad request: invalid data provided."
}

Response examples (401)

{
  "error": "Bad request: invalid data provided."
}

Response examples (404)

{
  "error": "Bad request: invalid data provided."
}