Skip to main content

List person payrolls

GET 
/api/person-payrolls

Required permissions:

  • payroll.employees: allows view of person payrolls.

Request​

Query Parameters

    person_id integer

    Possible values: >= 1

    Filter items by the person_id field.

    business_unit_id integer

    Possible values: >= 1

    Filter items by the business_unit_id field.

    limit integer

    Possible values: >= 1 and <= 100

    Default value: 100

    The number of items to include in the response.

    offset integer

    Default value: 0

    The offset of the first returned item.

    updated_at date-time

    Filter items by the updated_at field.

    Operators:

    Usage: eq:{value}

Header Parameters

    Wethod-Company stringrequired

    The company you want to interact with

    Wethod-Version stringrequired

    The API version you want to use

Responses​

Returns the list of person payrolls.

Schema

  • Array [

    • 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

    person_id integerrequired

    The ID of the person

    business_unit_id integernullable

    The ID of the business unit

    cost floatrequired

    The yearly cost of the person payroll (excluding taxes)

    taxes integerrequired

    The total taxes of the person payroll

    from YYYY-MMrequired

    The start date of the person payroll period

    to YYYY-MMrequired

    The end date of the person payroll period

  • ]

Loading...