Payruns

GET /2023-03-01/xhr/payruns
Access token

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

Query parameters

  • start_date string(date) Required

    The start date of the search period

  • end_date string(date) Required

    The end date of the search period

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • id string Required

      The Affix-assigned id of the individual

    • remote_id string Required

      the remote system-assigned id of the payrun

    • state string | null Required

      Values are paid, pending, or null.

    • type string | null Required

      Values are regular, one_time, off_cycle, correction, reversal, or null.

    • start_date string(date) | null Required

      Payrun period start date

    • end_date string(date) | null Required

      Payrun period end date

    • payment_date string(date) | null Required

      Payment date / check date
  • 202 application/json

    Accepted + pending (async job started)

    Hide headers attribute Show headers attribute
    • Retry-After integer

      Retry your call after the specified amount of seconds

    Hide response attribute Show response attribute object
  • 401 application/json

    Authentication Error

    Hide response attributes Show response attributes object
    • error string Required

      The type of error

      Value is authentication_error.

    • message string Required

      A descriptive description of the error

    • code string Required

      Values are incorrect_username_or_password, incorrect_mfa_or_otp, reauthentication_required // cookies are now expired, additional_account_setup_required // password reset, etc, captcha_challenge // amazon type1 captcha challenge (currently unsovable), no_valid_accounts // not used currently but reserved for future use, or insufficient_permission // not enough privileges (ie not an admin, or not enough provider scopes on a provider api token for the Affix scopes requested).
  • 429 application/json

    Rate Limited / Too Many Requests

    Hide headers attribute Show headers attribute
    • Retry-After integer

      Retry your call after the specified amount of seconds

    Hide response attribute Show response attribute object
  • 500 application/json

    Server Error

    Hide response attribute Show response attribute object
  • 501 application/json

    Not Implemented

    Hide response attribute Show response attribute object
GET /2023-03-01/xhr/payruns 
curl \
 -X GET https://api.affixapi.com/2023-03-01/xhr/payruns?start_date=2021-01-01&end_date=2021-12-31 \
 -H "Authorization: $API_KEY"
Response examples (200) 
[
  {
    "id": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
    "remote_id": "19202938",
    "state": "paid",
    "type": "regular",
    "start_date": "2020-01-01",
    "end_date": "2020-01-31",
    "payment_date": "2020-01-27"
  }
]
Response examples (202) 
# Headers
Retry-After: 42

# Payload
{
  "message": "string"
}
Response examples (401) 
{
  "error": "authentication_error",
  "message": "Your password is incorrect",
  "code": "incorrect_username_or_password"
}
Response examples (429) 
# Headers
Retry-After: 42

# Payload
{
  "message": "string"
}
Response examples (500) 
{
  "message": "string"
}
Response examples (501) 
{
  "message": "string"
}