# Payruns

**GET /2023-03-01/xhr/payruns**

List all the pay runs that occurred during the respective period.

Supported integrations:
  - brain payroll
  - brightpay connect
  - deel
  - gusto
  - justworks
  - moorepay
  - onpay
  - oyster
  - parolla.ie
  - paycircle
  - payfit
  - pento.io
  - quickbooks online
  - remote.com
  - sageone
  - shape payroll
  - simplepay.ie
  - staffology
  - xero uk



## Servers
- Production server (EU): https://api.affixapi.com (Production server (EU))
- Development server (EU): https://dev.api.affixapi.com (Development server (EU))


## Authentication methods
- Access token


## Parameters


### Query parameters
- **start_date** (string(date))
  The start date of the search period
- **end_date** (string(date))
  The end date of the search period


## Responses
### 200
Success

#### Body: application/json (array[object])
- **id** (string)
  The Affix-assigned id of the individual
- **remote_id** (string)
  the remote system-assigned id of the payrun
- **state** (string | null)

- **type** (string | null)

- **start_date** (string(date) | null)
  Payrun period start date
- **end_date** (string(date) | null)
  Payrun period end date
- **payment_date** (string(date) | null)
  Payment date / check date

### 202
Accepted + pending (async job started)
#### Headers
- **Retry-After** (integer)
  Retry your call after the specified amount of seconds

#### Body: application/json (object)
- **message** (string)


### 401
Authentication Error

#### Body: application/json (object)
- **error** (string)
  The type of error
- **message** (string)
  A descriptive description of the error
- **code** (string)


### 429
Rate Limited / Too Many Requests
#### Headers
- **Retry-After** (integer)
  Retry your call after the specified amount of seconds

#### Body: application/json (object)
- **message** (string)


### 500
Server Error

#### Body: application/json (object)
- **message** (string)


### 501
Not Implemented

#### Body: application/json (object)
- **message** (string)



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