Create a person payroll

POST 
/api/person-payrolls

Required permissions:

• payroll.employees: allows creating person payrolls.

Request

Header Parameters

Wethod-Company stringrequired

The company you want to interact with

Wethod-Version stringrequired

The API version you want to use

application/json

Body

person_id integerrequired

The ID of the person

business_unit_id integernullable

The ID of the business unit

cost numberrequired

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

Responses

201

Returns the person payroll created.

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

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

Example (from schema)

{
  "id": 1,
  "created_at": "2026-03-13T17:09:41.238Z",
  "updated_at": "2026-03-13T17:09:41.238Z",
  "person_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"
}

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...