List Employee Payouts

---

GET /services/api/v1/employee_payouts

Returns a list of employees payouts.

Optional Query Parameters

Parameter	Type	Description
employee_id	string	Only return employee payouts that belong to the specified employee.
created_at_since	timestamp	Only return employee payouts that have been created since the specified timestamp.
updated_at_since	timestamp	Only return employee payouts that have been updated since the specified timestamp.

Response

200

Results list.

Example

{
  "entries": [
    {
      "id": "7bBJADz2",
      "employee_id": "rQ6ZV6W5",
      "from": "2024-08-25",
      "to": "2024-12-18",
      "gross": 4000.00,
      "net": 2000.00,
      "created_at": "2024-10-10T13:43:56.347Z",
      "updated_at": "2024-10-14T10:06:50.112Z"
    },
    {
      "id": "AmYlkGBD",
      "employee_id": "52B4yOY0",
      "from": "2024-10-10",
      "to": null,
      "gross": 2000.31,
      "net": 1500.00,
      "created_at": "2024-10-10T13:40:33.120Z",
      "updated_at": "2024-10-14T14:19:46.272Z"
    }
  ],
  "current_page": 1,
  "per_page": 30,
  "total_entries": 2
}

Schema

Attribute	Type	Required	Description
id	string	readonly	Id of the employee payout.
created_at	datetime	readonly	Employee payout creation date.
updated_at	datetime	readonly	Employee payout last updated at.
employee_id	string	true	Id of the employee the payout belongs to.
from	date	true	Start date of the employee payout (ISO8601).
to	date	false	End date of the employee payout (ISO8601). Null if unlimited.

Note that the fields above are only the fixed fields. All custom fields are provided by the Employee Payout Fields API endpoint.