# Get a pay period for an employer

**GET /employers/{employer_id}/pay_periods/{pay_period_id}**

**Partner organisations only.** A Payroll organisation calling this
endpoint receives `405 Method Not Allowed`.

Returns a single pay period for the employer. The response shape matches
list items. Returns 404 when the pay period is missing, belongs to another
employer, or has no active contributions.



## Servers
- https://payroll-api.getpenfold.dev/v4: https://payroll-api.getpenfold.dev/v4 ()


## Authentication methods
- O auth2 client credentials


## Parameters

### Path parameters

- **employer_id** (string)

- **pay_period_id** (string)
  Unique identifier for the pay period.




## Responses
### 200
Pay period retrieved successfully.

#### Body: application/json (object)
- **id** (string)
  Unique identifier for the pay period.

- **pay_period_start_date** (string(date))
  Start date of the pay period (YYYY-MM-DD, UTC calendar date).

- **pay_period_end_date** (string(date))
  End date of the pay period (YYYY-MM-DD, UTC calendar date).

- **frequency** (string)
  Cadence of the pay period. `Unknown` is returned when the stored frequency
  is not set.

- **total_contributions_pence** (integer)
  Sum of employee and employer contribution expectation amounts in pence
  for active contributions in this period.

- **employee_contributions_pence** (integer)
  Sum of employee contribution expectation amounts in pence for active
  contributions in this period.

- **employer_contributions_pence** (integer)
  Sum of employer contribution expectation amounts in pence for active
  contributions in this period.

- **upload_ids** (array[string])
  Distinct file upload ids associated with this pay period (via
  contributions and/or payments). May contain multiple ids when several
  uploads share the same period dates.

- **payments** (array[object])
  Collection payments linked to this period. Empty when contributions
  exist but no Direct Debit or Bank Transfer payment has been created yet.


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

#### Body: application/json (object)
- **error** (string)
  A descriptive error message.


### 404
Employer or pay period not found. Also returned when the pay period
belongs to another employer or has no active contributions.


#### Body: application/json (object)
- **error** (string)
  A descriptive error message.


### 405
Method not allowed for this client type.

#### Body: application/json (object)
- **error** (string)
  A descriptive error message.



[Powered by Bump.sh](https://bump.sh)