GET
/
payroll
/
{user_id}
curl --request GET \
  --url https://api.sandbox.goteal.co/payroll/{user_id} \
  --header 'X-API-KEY: <api-key>'
{
  "pagination": {
    "offset": 75,
    "limit": 25,
    "count": 14,
    "total_count": 89
  },
  "payroll_submissions": [
    {
      "id": "95a0e70b-fe02-4f47-aef9-2efff279df71",
      "account_id": "674744df-9626-47ef-ae2b-4a491be136b5",
      "entry_id": "be770ba4-1362-46cd-8c1c-2330ce3a8b69",
      "created_at": "2019-05-17T00:00:00.000Z",
      "document_id": "95a0e70b-fe02-4f47-aef9-2efff279df71",
      "document_external_id": "payslip123456",
      "document_filename": "file1-payslip.pdf",
      "identity_information": {
        "name": "John Smith",
        "date_of_birth": "2019-05-17T00:00:00.000Z",
        "address": {
          "street": "123 Main Street",
          "county": "Greater London",
          "city": "London",
          "post_code": "SW1A 1AA",
          "country": "United Kingdom"
        },
        "email": "john.smith@company.com",
        "phone": 447123456789,
        "NI_number": "AB123456C"
      },
      "employment_information": {
        "employer_name": "Acme Ltd",
        "role": "Software Engineer",
        "type": "Full-time",
        "status": "active",
        "start_date": "2019-05-17T00:00:00.000Z",
        "leave_date": "2019-05-17T00:00:00.000Z"
      },
      "income_information": {
        "pay_date": "2023-05-27T00:00:00.000Z",
        "pay_interval_start": "2023-05-01T00:00:00.000Z",
        "pay_interval_end": "2023-05-31T00:00:00.000Z",
        "pay_frequency": "Monthly",
        "earnings": {
          "gross_pay": 3500,
          "net_pay": 2500,
          "base_salary": 3000,
          "bonus": 500
        },
        "deductions": {
          "income_tax": 500,
          "employee_ni": 200,
          "employee_pension": 300,
          "total_deductions": 1000
        }
      },
      "fraud_risk": "Low"
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
user_id
string
required

ID of the user to get payroll for

Query Parameters

​
orederd_by
enum<string>
default:created_at

The field of the user to order by

Available options:
account_id,
entry_id,
created_at
Example:

"name"

​
offset
integer
default:0

The offset to start at

Required range: x >= 1
​
limit
integer
default:20

The number of items to return

Required range: 1 <= x <= 100
​
account_id
string

The account_id to fileter on

​
entry_id
string

The account_id to fileter on

​
document_external_id
string

The document_external_id to fileter on

​
created_after
string

Filter out payroll dated before the given date

Example:

"2019-05-17T00:00:00.000Z"

​
created_before
string

Filter out payroll dated after the given date

Example:

"2019-05-17T00:00:00.000Z"

Response

200
application/json

Plant response

The response is of type object.