PayrollRun.md

MergeHRISClient::PayrollRun

Properties

Name	Type	Description	Notes
id	String		[optional][readonly]
remote_id	String	The third-party API ID of the matching object.	[optional]
created_at	Time	The datetime that this object was created by Merge.	[optional][readonly]
modified_at	Time	The datetime that this object was modified by Merge.	[optional][readonly]
run_state	RunStateEnum	The state of the payroll run * `PAID` - PAID * `DRAFT` - DRAFT * `APPROVED` - APPROVED * `FAILED` - FAILED * `CLOSED` - CLOSED	[optional]
run_type	RunTypeEnum	The type of the payroll run * `REGULAR` - REGULAR * `OFF_CYCLE` - OFF_CYCLE * `CORRECTION` - CORRECTION * `TERMINATION` - TERMINATION * `SIGN_ON_BONUS` - SIGN_ON_BONUS	[optional]
start_date	Time	The day and time the payroll run started.	[optional]
end_date	Time	The day and time the payroll run ended.	[optional]
check_date	Time	The day and time the payroll run was checked.	[optional]
remote_was_deleted	Boolean	Indicates whether or not this object has been deleted in the third party platform.	[optional][readonly]
field_mappings	Object		[optional][readonly]
remote_data	Array<RemoteData>		[optional][readonly]

Example

require 'merge_hris_client'

instance = MergeHRISClient::PayrollRun.new(
  id: 37336947-b3d4-4a4c-a310-ab6ab510e079,
  remote_id: 19202938,
  created_at: 2021-09-15T00:00Z,
  modified_at: 2021-10-16T00:00Z,
  run_state: PAID,
  run_type: REGULAR,
  start_date: 2020-11-08T00:00Z,
  end_date: 2020-11-15T00:00Z,
  check_date: 2020-11-15T00:00Z,
  remote_was_deleted: null,
  field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
  remote_data: [{"path":"/payroll","data":["Varies by platform"]}]
)