v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB
Labor

ListEmployeeWages

Returns a paginated list of EmployeeWage instances for a business.

get/v2/labor/employee-wages

Query parameters

employee_idstring

Filter the returned wages to only those that are associated with the specified employee.

limitinteger

The maximum number of EmployeeWage results to return per page. The number can range between 1 and 200. The default is 200.

cursorstring

A pointer to the next page of EmployeeWage results to fetch.

Response

Success

cursorstring

The value supplied in the subsequent request to fetch the next page of EmployeeWage results.

Example response

{
  "cursor": "2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED",
  "employee_wages": [
    {
      "employee_id": "33fJchumvVdJwxV0H6L9",
      "hourly_rate": {
        "amount": 3250,
        "currency": "USD"
      },
      "id": "pXS3qCv7BERPnEGedM4S8mhm",
      "title": "Manager"
    },
    {
      "employee_id": "33fJchumvVdJwxV0H6L9",
      "hourly_rate": {
        "amount": 2600,
        "currency": "USD"
      },
      "id": "rZduCkzYDUVL3ovh1sQgbue6",
      "title": "Cook"
    },
    {
      "employee_id": "33fJchumvVdJwxV0H6L9",
      "hourly_rate": {
        "amount": 1600,
        "currency": "USD"
      },
      "id": "FxLbs5KpPUHa8wyt5ctjubDX",
      "title": "Barista"
    },
    {
      "employee_id": "33fJchumvVdJwxV0H6L9",
      "hourly_rate": {
        "amount": 1700,
        "currency": "USD"
      },
      "id": "vD1wCgijMDR3cX5TPnu7VXto",
      "title": "Cashier"
    }
  ]
}