Get an employee payroll

GET 
/api/employee-payrolls/{id}

Required permissions:

• payroll.employees: allows view of employee payrolls.

Request

Path Parameters

id integerrequired

Possible values: Value must match regular expression [0-9]+

The ID of the employee payroll to view

Header Parameters

Wethod-Company stringrequired

The company you want to interact with

Wethod-Version stringrequired

The API version you want to use

Responses

200

Returns the requested employee payroll.

application/json

Schema

Schema

id integerrequired

Possible values: >= 1

The unique identifier of the resource

created_at date-timerequired

The date and time when the resource was created

updated_at date-timerequired

The date and time when the resource was last updated

employee_id integerrequired

The ID of the employee

business_unit_id integernullable

The ID of the business unit

cost floatrequired

The yearly cost of the employee payroll (excluding taxes)

taxes integerrequired

The total taxes of the employee payroll

from YYYY-MMrequired

The start date of the employee payroll period

to YYYY-MMrequired

The end date of the employee payroll period

Example (from schema)

{
  "id": 1,
  "created_at": "2026-02-20T17:23:21.551Z",
  "updated_at": "2026-02-20T17:23:21.551Z",
  "employee_id": 1,
  "business_unit_id": 1,
  "cost": 12000,
  "taxes": 10,
  "from": "2025-01",
  "to": "2025-12"
}

400

Validation failed

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

failures

object[]

List of validation errors

Array [

field string

Name of the field causing the error

message string

Human-readable description of the error

]

Example (from schema)

{
  "key": "invalid_data",
  "message": "You provided invalid data. Check 'failures' for details.",
  "failures": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

403

Forbidden

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

404

Not found

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "not_found",
  "message": "string"
}

412

Precondition failed

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "precondition_failure",
  "message": "string"
}

Loading...