hris
earning

Update an earning

patch/hris/{connection_id}/earning/{id}

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/hris/{connection_id}/earning/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Earning

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

user_idstring

employee ID (reference to HrisEmployee)

company_idstring

(reference to HrisCompany)

paycode_idstring

the hris_paycode (earning code) this earning is paid under

amountnumber

money amount added to each pay run it applies to

currencystring
hoursnumber
rate_amountnumber

rate per hour/unit

frequency'ONE_TIME' | 'DAY' | 'QUARTER' | 'YEAR' | 'HOUR' | 'MONTH' | 'WEEK' | 'BIWEEKLY' | 'SEMIMONTHLY'

ONE_TIME for a single addition to the next unprocessed pay run, otherwise recurring

start_atstring date-time

recurring: first effective date; ONE_TIME: requested pay date (empty = next unprocessed pay run) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time

recurring: last effective date (empty = until stopped) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

status'PENDING' | 'ACTIVE' | 'PROCESSED' | 'ENDED' | 'CANCELLED' | 'FAILED'
payroll_idstring

the hris_payroll (pay run) a ONE_TIME earning targets or was paid in

payslip_idstring

the hris_payslip a ONE_TIME earning was paid on

notesstring
rawunknown

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

user_idstring

employee ID (reference to HrisEmployee)

company_idstring

(reference to HrisCompany)

paycode_idstring

the hris_paycode (earning code) this earning is paid under

amountnumber

money amount added to each pay run it applies to

currencystring
hoursnumber
rate_amountnumber

rate per hour/unit

frequency'ONE_TIME' | 'DAY' | 'QUARTER' | 'YEAR' | 'HOUR' | 'MONTH' | 'WEEK' | 'BIWEEKLY' | 'SEMIMONTHLY'

ONE_TIME for a single addition to the next unprocessed pay run, otherwise recurring

start_atstring date-time

recurring: first effective date; ONE_TIME: requested pay date (empty = next unprocessed pay run) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time

recurring: last effective date (empty = until stopped) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

status'PENDING' | 'ACTIVE' | 'PROCESSED' | 'ENDED' | 'CANCELLED' | 'FAILED'
payroll_idstring

the hris_payroll (pay run) a ONE_TIME earning targets or was paid in

payslip_idstring

the hris_payslip a ONE_TIME earning was paid on

notesstring
rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.