TRANXACT.AI ヘルプ

API endpoints: HRMS

The 168 HRMS resources: their published and service-account paths, what may be done with each, and every field with its type.

Every HRMS resource another product can reach, 168 in all. Each one is reached two ways: through the published API at /api/v1/<code> once an administrator has published it (its code is the resource name unless they chose another), or with a service account at /api/hrms/<resource>. The verbs, parameters, filters and answers are the same for every resource and are in API endpoint reference: how to call TRANXACT.

Fields: * means required when creating; (read-only) means it is returned but not accepted on a create or change. org_id, created_at, updated_at, created_by and updated_by are on most records and are set by TRANXACT. The id is a uuid unless the table says otherwise. Field names are the JSON keys.

利点

リソースEndpoints業務フィールズ
Benefit Elections (benefit-elections)/api/v1/benefit-elections · /api/hrms/benefit-elections · /{id}list, getid uuid (read-only), employee_id uuid (read-only), employee_no text (read-only), employee_name text (read-only), plan_code text (read-only), plan_name text (read-only), category text (read-only), carrier text (read-only), tier_code text (read-only), tier_name text (read-only), status text (read-only), effective_date date (read-only), end_date date (read-only), waived boolean (read-only), waiver_reason text (read-only), employee_cost numeric (read-only), employer_cost numeric (read-only), employee_annual numeric (read-only), employer_annual numeric (read-only), coverage_amount numeric (read-only), annual_election numeric (read-only), dependants integer (read-only), plan_year text (read-only)
Benefit Eligibility Rules (benefit-eligibility-rules)/api/v1/benefit-eligibility-rules · /api/hrms/benefit-eligibility-rules · /{id}list, get, create, change, deleteid uuid (read-only), plan_id uuid, code* text, name* text, applies_at text, min_age integer, max_age integer, countries _text, regions _text, location_ids _uuid, min_grade_level numeric, max_grade_level numeric, min_tenure_days integer, employment_types _text, min_dependents integer, max_dependents integer, effective_from date, effective_to date, message text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Benefit Enrollments (benefit-enrollments)/api/v1/benefit-enrollments · /api/hrms/benefit-enrollments · /{id}list, get, create, change, deleteid uuid (read-only), employee_id* uuid, plan_id* uuid, coverage_tier text, effective_date* date, end_date date, status text, plan_year_id uuid (read-only), tier_id uuid, employee_cost numeric (read-only), employer_cost numeric (read-only), coverage_amount numeric (read-only), annual_election numeric (read-only), elected_at timestamp with time zone (read-only), elected_by uuid (read-only), reason text (read-only), life_event_id uuid (read-only), waived boolean (read-only), waiver_reason text (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Benefit Plans (benefit-plans)/api/v1/benefit-plans · /api/hrms/benefit-plans · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, plan_type text, employee_cost_per_period numeric, employer_cost_per_period numeric, org_unit_id uuid (read-only), plan_year_id uuid, category text, carrier text, policy_number text, deduction_code text, is_pretax boolean, allows_dependants boolean, requires_evidence boolean (read-only), waiting_period_days integer, min_hours_week numeric, min_fte numeric, eligible_employment_types _text, annual_limit numeric, employer_contribution_percent numeric (read-only), is_default boolean (read-only), is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), tax_treatment text, w2_box text, carrier_id uuid (read-only), is_mec boolean (read-only), is_min_value boolean (read-only), self_insured boolean (read-only)
Dependents (dependants)/api/v1/dependants · /api/hrms/dependants · /{id}list, get, create, change, deleteid uuid (read-only), person_id* uuid, first_name* text, last_name* text, relationship* text, date_of_birth date, gender text, national_id_last4 text (read-only), is_student boolean, is_disabled boolean, ages_off_on date, verified_at timestamp with time zone (read-only), is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), national_id_cipher bytea (read-only), verification_status text (read-only)
Life Events (life-events)/api/v1/life-events · /api/hrms/life-events · /{id}list, get, create, change, deleteid uuid (read-only), event_no text (read-only), employee_id* uuid, event_type* text, event_date* date, reported_on date (read-only), window_days integer, window_closes date (read-only), status text, evidence_document_id uuid (read-only), notes text, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Plan Years (plan-years)/api/v1/plan-years · /api/hrms/plan-years · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, start_date* date, end_date* date, enrollment_opens date, enrollment_closes date, status text, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Carriers & ACA

リソースEndpoints業務フィールズ
ACA Settings (aca-settings)/api/v1/aca-settings · /api/hrms/aca-settings · /{id}list, get, create, change, deleteid uuid (read-only), measurement_method text, standard_measurement_months integer, administrative_days integer, stability_months integer, initial_measurement_months integer, ft_hours_month numeric, salaried_hours_week numeric, plan_start_month integer, affordability_percent numeric, safe_harbor text, fpl_amount numeric, waiting_period_days integer, ale_name text, ale_ein text, ale_address text, ale_city text, ale_state text, ale_zip text, contact_name text, contact_phone text, is_aggregated_group boolean, transmitter_tcc text, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Carriers & Recordkeepers (benefit-carriers)/api/v1/benefit-carriers · /api/hrms/benefit-carriers · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, carrier_kind text, file_format text, isa_sender_qual text, isa_sender_id text, isa_receiver_qual text, isa_receiver_id text, gs_sender_id text, gs_receiver_id text, usage_indicator text, isa_control_last integer (read-only), sponsor_name text, sponsor_tax_id text, insurer_name text, insurer_tax_id text, master_policy_no text, line_codes jsonb, layout jsonb, delimiter text, include_header boolean, date_format text, plan_number text, deduction_map jsonb, auto_after_post boolean, delivery_method text, endpoint_url text, sftp_host text, sftp_port integer, sftp_user text, sftp_path text, credential_sealed text (read-only), file_name_pattern text, contact_email text, notes text, is_active boolean, org_unit_id uuid (read-only), sftp_host_key_sha256 text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Certifications & Skills

リソースEndpoints業務フィールズ
Certifications & Licenses (employee-credentials)/api/v1/employee-credentials · /api/hrms/employee-credentials · /{id}list, get, create, change, deleteid uuid (read-only), credential_no text (read-only), employee_id* uuid, credential_type text, name* text, issuing_body text, credential_number text, jurisdiction text, issued_on date, expires_on date, is_required boolean, renewal_course_id uuid, skill_id uuid, status text, verified boolean (read-only), verified_by uuid (read-only), verified_on date (read-only), document_id uuid, last_alert_days integer (read-only), renewal_status text, renewal_due_on date (read-only), renewal_raised_on date (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Job Skill Requirements (job-skill-requirements)/api/v1/job-skill-requirements · /api/hrms/job-skill-requirements · /{id}list, get, create, change, deleteid uuid (read-only), job_id uuid, position_id uuid, skill_id* uuid, required_level integer, is_mandatory boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Skill Gaps (skill-gaps)/api/v1/skill-gaps · /api/hrms/skill-gaps · /{id}list, getid text (read-only), employee_id uuid (read-only), employee_no text (read-only), employee_name text (read-only), org_unit_id uuid (read-only), position_id uuid (read-only), position_title text (read-only), job_id uuid (read-only), job_title text (read-only), skill_id uuid (read-only), skill_code text (read-only), skill_name text (read-only), skill_category text (read-only), required_level integer (read-only), is_mandatory boolean (read-only), current_level integer (read-only), verified boolean (read-only), source text (read-only), gap integer (read-only), meets boolean (read-only)
Skills (skills)/api/v1/skills · /api/hrms/skills · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, category text, description text, max_level integer, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Skills a Course Teaches (course-skills)/api/v1/course-skills · /api/hrms/course-skills · /{id}list, get, create, change, deleteid uuid (read-only), course_id* uuid, skill_id* uuid, level integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Skills Inventory (employee-skills)/api/v1/employee-skills · /api/hrms/employee-skills · /{id}list, get, create, change, deleteid uuid (read-only), employee_id* uuid, skill_id* uuid, proficiency integer, source text, verified boolean, verified_by uuid (read-only), verified_on date (read-only), assessed_on date, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

補償

リソースEndpoints業務フィールズ
Compensation Awards (comp-awards)/api/v1/comp-awards · /api/hrms/comp-awards · /{id}list, get, create, change, deleteid uuid (read-only), cycle_id* uuid, employee_id* uuid, award_type text, rating text, current_pay numeric (read-only), current_grade_id uuid (read-only), compa_ratio numeric (read-only), quartile integer (read-only), guideline_percent numeric (read-only), guideline_amount numeric (read-only), proposed_percent numeric, proposed_amount numeric, new_pay numeric (read-only), new_grade_id uuid (read-only), new_compa_ratio numeric (read-only), justification text, status text, proposed_by uuid (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), applied_at timestamp with time zone (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Compensation Cycles (comp-cycles)/api/v1/comp-cycles · /api/hrms/comp-cycles · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, cycle_type text, plan_year* integer, effective_date* date, opens_on date, closes_on date, budget_percent numeric, budget_amount numeric, eligible_pay_bill numeric (read-only), proposed_amount numeric (read-only), approved_amount numeric (read-only), status text, min_months_service integer, approved_by uuid (read-only), approved_at timestamp with time zone (read-only), applied_at timestamp with time zone (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Equity Grants (equity-grants)/api/v1/equity-grants · /api/hrms/equity-grants · /{id}list, get, create, change, deleteid uuid (read-only), grant_no text (read-only), employee_id* uuid, instrument text, grant_date* date, units* numeric, strike_price numeric, grant_price numeric, vest_start date, vest_months integer, cliff_months integer, vest_frequency text, units_vested numeric, units_exercised numeric (read-only), units_forfeited numeric (read-only), expires_on date, status text, cycle_id uuid (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Pay Position (pay-position)/api/v1/pay-position · /api/hrms/pay-position · /{employee_id}list, getemployee_id uuid (read-only), org_unit_id uuid (read-only), employee_no text (read-only), employee_name text (read-only), position_title text (read-only), department text (read-only), base_pay numeric (read-only), currency text (read-only), pay_type text (read-only), fte numeric (read-only), hire_date date (read-only), grade_code text (read-only), grade_name text (read-only), grade_level integer (read-only), range_min numeric (read-only), range_mid numeric (read-only), range_max numeric (read-only), market_reference numeric (read-only), bonus_target_percent numeric (read-only), annualised_pay numeric (read-only), compa_ratio numeric (read-only), range_penetration numeric (read-only), quartile integer (read-only), standing text (read-only)
Salary Grade Steps (salary-grade-steps)/api/v1/salary-grade-steps · /api/hrms/salary-grade-steps · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), grade_id* uuid, step_no* integer, rate* numeric, rate_basis text, effective_from date, notes text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Salary Grades (salary-grades)/api/v1/salary-grades · /api/hrms/salary-grades · /{id}list, get, create, change, deleteid uuid (read-only), structure_id* uuid, code* text, name* text, grade_level* integer, range_min* numeric, range_mid* numeric, range_max* numeric, market_reference numeric, bonus_target_percent numeric, equity_target numeric, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Salary Structures (salary-structures)/api/v1/salary-structures · /api/hrms/salary-structures · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, currency text, country text, effective_from date, effective_to date, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Total Rewards (total-rewards)/api/v1/total-rewards · /api/hrms/total-rewards · /{employee_id}list, getemployee_id uuid (read-only), employee_no text (read-only), employee_name text (read-only), currency text (read-only), base_pay numeric (read-only), bonus_target_percent numeric (read-only), bonus_target numeric (read-only), employer_benefits numeric (read-only), employee_benefit_cost numeric (read-only), employer_taxes numeric (read-only), equity_units numeric (read-only), leave_days_available numeric (read-only)

Employee Relations & Records

リソースEndpoints業務フィールズ
Disciplinary Actions (disciplinary-actions)/api/v1/disciplinary-actions · /api/hrms/disciplinary-actions · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), action_no text (read-only), employee_id* uuid, incident_date* date, action_type* text, category text, description* text, policy_reference text, issued_by uuid, issued_on date, acknowledged_on date, appeal_status text, outcome text, status text, closed_on date, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Document Types (document-types)/api/v1/document-types · /api/hrms/document-types · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, category text, is_mandatory boolean, requires_signature boolean, expires boolean, valid_months integer, retention_years integer, applies_to text, country text, description text, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Employee Documents (employee-documents)/api/v1/employee-documents · /api/hrms/employee-documents · /{id}list, getid uuid (read-only), employee_id uuid (read-only), person_id uuid (read-only), document_type_id uuid (read-only), content_document_id uuid (read-only), reference_no text (read-only), issued_on date (read-only), expires_on date (read-only), status text (read-only), verified_by uuid (read-only), verified_at timestamp with time zone (read-only), signed_at timestamp with time zone (read-only), signed_by_name text (read-only), signature_method text (read-only), notes text (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Garnishments

リソースEndpoints業務フィールズ
Garnishment Orders (garnishment-orders)/api/v1/garnishment-orders · /api/hrms/garnishment-orders · /{id}list, get, create, change, deleteid uuid (read-only), employee_id* uuid, deduction_code_id* uuid, amount numeric, percent numeric, employer_amount numeric (read-only), effective_from date, effective_to date, goal_amount numeric, taken_to_date numeric (read-only), case_number text, payee text, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), order_type text, order_priority integer, order_received_on date, issuing_state text, issuing_authority text, remit_to_address text, remit_fips text, remit_method text, medical_support boolean, order_notes text

健康と安全

リソースEndpoints業務フィールズ
Safety Incidents (safety-incidents)/api/v1/safety-incidents · /api/hrms/safety-incidents · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid, incident_no text (read-only), employee_id uuid, person_description text, occurred_at* timestamp with time zone, reported_at timestamp with time zone (read-only), reported_by uuid, location_id uuid, warehouse_id uuid, location_description text, incident_type* text, severity text, description* text, immediate_action text, is_lost_time boolean, days_lost integer, days_restricted integer, required_medical_treatment boolean, body_part text, injury_nature text, is_reportable boolean, reporting_scheme text, reported_to_authority_on date, authority_reference text, investigation_status text, root_cause text, contributing_factors text, corrective_actions text, closed_on date, closed_by uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Identity Verification

リソースEndpoints業務フィールズ
Identity Verifications (identity-verifications)/api/v1/identity-verifications · /api/hrms/identity-verifications · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), verification_no text (read-only), employee_id uuid (read-only), i9_record_id uuid (read-only), country text (read-only), kind text (read-only), provider text (read-only), mode text (read-only), connection_id uuid (read-only), case_number text (read-only), reference text (read-only), subject_last4 text (read-only), status text (read-only), status_detail text (read-only), due_by date (read-only), tnc_notified_at timestamp with time zone (read-only), further_action_notice_id uuid (read-only), employee_decision text (read-only), employee_decided_at timestamp with time zone (read-only), referred_at timestamp with time zone (read-only), referral_due date (read-only), closure_reason text (read-only), closed_at timestamp with time zone (read-only), late_reason text (read-only), request_summary jsonb (read-only), result jsonb (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Labor Distribution & GL Interface

リソースEndpoints業務フィールズ
GL Interface Code Crosswalk (gl-code-map)/api/v1/gl-code-map · /api/hrms/gl-code-map · /{id}list, get, create, change, deleteid uuid (read-only), interface_id* uuid, dimension* text, source_code* text, target_code* text, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
GL Interface Exceptions (gl-exceptions)/api/v1/gl-exceptions · /api/hrms/gl-exceptions · /{id}list, getid uuid (read-only), interface_id uuid (read-only), interface_run_id uuid (read-only), payroll_run_id uuid (read-only), kind text (read-only), severity text (read-only), message text (read-only), context jsonb (read-only), status text (read-only), resolved_by uuid (read-only), resolved_at timestamp with time zone (read-only), resolution_note text (read-only), reprocessed_run_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
GL Interface Files (gl-files)/api/v1/gl-files · /api/hrms/gl-files · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), run_no text (read-only), interface_id uuid (read-only), payroll_run_id uuid (read-only), version integer (read-only), mode text (read-only), status text (read-only), profile text (read-only), transport text (read-only), file_name text (read-only), content_type text (read-only), content text (read-only), checksum_sha256 text (read-only), record_count integer (read-only), total_debit numeric (read-only), total_credit numeric (read-only), balanced boolean (read-only), controls_ok boolean (read-only), control_totals jsonb (read-only), exception_count integer (read-only), trigger text (read-only), reason text (read-only), supersedes_id uuid (read-only), sent_at timestamp with time zone (read-only), attempts integer (read-only), last_error text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
GL Interface Mappings (gl-mappings)/api/v1/gl-mappings · /api/hrms/gl-mappings · /{id}list, get, create, change, deleteid uuid (read-only), interface_id* uuid, source_kind* text, source_code text, cost_center_id uuid, department text, location_id uuid, fund_id uuid, grant_id uuid, program_id uuid, job_id uuid, target_account* text, target_property text, segment_1 text, segment_2 text, description text, priority integer, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
GL Interface Valid Codes (gl-valid-codes)/api/v1/gl-valid-codes · /api/hrms/gl-valid-codes · /{id}list, get, create, change, deleteid uuid (read-only), interface_id* uuid, kind* text, code* text, description text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
GL Interfaces (gl-interfaces)/api/v1/gl-interfaces · /api/hrms/gl-interfaces · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, profile text, mode text, is_active boolean, detail_level text, liability_split text, dimensions _text, default_property_code text, entity_code text, journal_prefix text, book_code text, person_code text, column_overrides jsonb, account_pattern text, property_pattern text, require_valid_list boolean, schedule text, transport text, sftp_host text, sftp_port integer, sftp_username text, sftp_auth text, sftp_host_key_sha256 text, sftp_directory text, sftp_test_directory text, https_url text, https_test_url text, https_header_name text, file_name_pattern text, notify_emails text, go_live_at timestamp with time zone (read-only), go_live_by uuid (read-only), last_test_run_id uuid (read-only), notes text, scope_pay_group_ids _uuid, scope_org_unit_id uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Labor Splits (labor-splits)/api/v1/labor-splits · /api/hrms/labor-splits · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), employee_id uuid, position_id uuid, percent* numeric, cost_center_id uuid, department text, location_id uuid, fund_id uuid, grant_id uuid, program_id uuid, job_id uuid, effective_from date, effective_to date, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Payslip Allocations (payslip-allocations)/api/v1/payslip-allocations · /api/hrms/payslip-allocations · /{id}list, getid uuid (read-only), payroll_run_id uuid (read-only), payslip_id uuid (read-only), employee_id uuid (read-only), line_no integer (read-only), basis text (read-only), share numeric (read-only), hours numeric (read-only), cost_center_id uuid (read-only), department text (read-only), location_id uuid (read-only), fund_id uuid (read-only), grant_id uuid (read-only), program_id uuid (read-only), job_id uuid (read-only), earnings numeric (read-only), employer_taxes numeric (read-only), employer_benefits numeric (read-only), employee_taxes numeric (read-only), deductions numeric (read-only), net_pay numeric (read-only), detail jsonb (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Learning

リソースEndpoints業務フィールズ
Completion History (course-completions)/api/v1/course-completions · /api/hrms/course-completions · /{id}list, getid uuid (read-only), enrollment_id uuid (read-only), course_id uuid (read-only), employee_id uuid (read-only), completed_at timestamp with time zone (read-only), score numeric (read-only), due_date date (read-only), on_time boolean (read-only), valid_until date (read-only), source text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Compliance Training (training-compliance)/api/v1/training-compliance · /api/hrms/training-compliance · /{id}list, getid uuid (read-only), course_id uuid (read-only), employee_id uuid (read-only), status text (read-only), due_date date (read-only), assigned_on date (read-only), completed_at timestamp with time zone (read-only), valid_until date (read-only), score numeric (read-only), source text (read-only), rule_id uuid (read-only), course_code text (read-only), course_name text (read-only), is_compliance boolean (read-only), category text (read-only), employee_no text (read-only), employee_name text (read-only), org_unit_id uuid (read-only), org_unit_name text (read-only), manager_id uuid (read-only), work_location_id uuid (read-only), compliant boolean (read-only), overdue boolean (read-only), days_overdue integer (read-only), lapsed boolean (read-only)
Course Enrollments (course-enrollments)/api/v1/course-enrollments · /api/hrms/course-enrollments · /{id}list, get, create, change, deleteid uuid (read-only), course_id* uuid, employee_id* uuid, status text, completed_at timestamp with time zone, score numeric, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), due_date date, assigned_on date (read-only), source text (read-only), rule_id uuid (read-only), path_enrollment_id uuid (read-only), session_id uuid, started_at timestamp with time zone (read-only), valid_until date (read-only), reminder_count integer (read-only), last_reminded_on date (read-only), escalated_on date (read-only), external_ref text (read-only), evaluation_requested_on date (read-only), evaluation_reminded_on date (read-only), evaluation_reminders integer (read-only)
Course Evaluations (course-evaluations)/api/v1/course-evaluations · /api/hrms/course-evaluations · /{id}list, get, create, change, deleteid uuid (read-only), enrollment_id uuid, course_id* uuid, employee_id* uuid, session_id uuid, overall_rating integer, content_rating integer, instructor_rating integer, relevance_rating integer, would_recommend boolean, comments text, submitted_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Learning Path Assignments (learning-path-enrollments)/api/v1/learning-path-enrollments · /api/hrms/learning-path-enrollments · /{id}list, get, create, change, deleteid uuid (read-only), path_id* uuid, employee_id* uuid, assigned_on date (read-only), due_date date, source text (read-only), rule_id uuid (read-only), status text, completed_on date (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Learning Path Courses (learning-path-courses)/api/v1/learning-path-courses · /api/hrms/learning-path-courses · /{id}list, get, create, change, deleteid uuid (read-only), path_id* uuid, course_id* uuid, seq integer, is_required boolean, due_days integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Learning Paths (learning-paths)/api/v1/learning-paths · /api/hrms/learning-paths · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, description text, is_mandatory boolean, sequential boolean, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Learning Reminders (learning-reminders)/api/v1/learning-reminders · /api/hrms/learning-reminders · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), enrollment_id uuid (read-only), employee_id uuid (read-only), course_id uuid (read-only), due_date date (read-only), kind text (read-only), sent_to_user_id uuid (read-only), days_left integer (read-only), sent_on date (read-only), sent_at timestamp with time zone (read-only), status text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Programme Effectiveness (course-effectiveness)/api/v1/course-effectiveness · /api/hrms/course-effectiveness · /{id}list, getid uuid (read-only), code text (read-only), name text (read-only), category text (read-only), is_compliance boolean (read-only), enrolled integer (read-only), completed integer (read-only), completion_pct numeric (read-only), avg_score numeric (read-only), evaluations integer (read-only), avg_rating numeric (read-only), recommend_pct numeric (read-only), evaluations_requested integer (read-only), evaluations_outstanding integer (read-only)
Session Attendance (session-attendance)/api/v1/session-attendance · /api/hrms/session-attendance · /{id}list, get, create, change, deleteid uuid (read-only), session_id uuid (read-only), employee_id uuid (read-only), enrollment_id uuid (read-only), status text, marked_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Training Assignment Rules (training-rules)/api/v1/training-rules · /api/hrms/training-rules · /{id}list, get, create, change, deleteid uuid (read-only), rule_no text (read-only), name* text, course_id uuid, path_id uuid, job_id uuid, position_id uuid, org_unit_id uuid, include_sub_units boolean, location_id uuid, employment_type text, new_hire_only boolean, new_hire_within_days integer, due_days integer, recurrence_months integer, remind_days_before integer, escalate_days_after integer, is_active boolean, last_run_at timestamp with time zone (read-only), last_run_enrolled integer (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Training Courses (training-courses)/api/v1/training-courses · /api/hrms/training-courses · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, delivery text, duration_hours numeric, is_compliance boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), description text, category text, provider text, validity_months integer, evaluation_required boolean, passing_score numeric, is_active boolean, external_id text, external_source text, self_register boolean
Training Sessions (training-sessions)/api/v1/training-sessions · /api/hrms/training-sessions · /{id}list, get, create, change, deleteid uuid (read-only), session_no text (read-only), course_id* uuid, title text, starts_at* timestamp with time zone, ends_at timestamp with time zone, delivery text, location_id uuid, room text, virtual_link text, instructor_employee_id uuid, instructor_name text, capacity integer, status text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

離れる

リソースEndpoints業務フィールズ
Holiday Calendars (holiday-calendars)/api/v1/holiday-calendars · /api/hrms/holiday-calendars · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, country text, region text, is_default boolean, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Leave Balances (leave-balances)/api/v1/leave-balances · /api/hrms/leave-balances · /{id}list, getid uuid (read-only), employee_id uuid (read-only), leave_type_id uuid (read-only), leave_year integer (read-only), employee_no text (read-only), employee_name text (read-only), leave_code text (read-only), leave_name text (read-only), category text (read-only), unit text (read-only), accrual_method text (read-only), max_carryover numeric (read-only), max_balance numeric (read-only), opening_balance numeric (read-only), carried_over numeric (read-only), accrued numeric (read-only), adjusted numeric (read-only), taken numeric (read-only), pending numeric (read-only), forfeited numeric (read-only), available numeric (read-only), standing text (read-only)
Leave Movements (leave-movements)/api/v1/leave-movements · /api/hrms/leave-movements · /{id}list, getid uuid (read-only), employee_id uuid (read-only), leave_type_id uuid (read-only), leave_year integer (read-only), entry_date date (read-only), movement text (read-only), quantity numeric (read-only), balance_after numeric (read-only), reason text (read-only), leave_request_id uuid (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Leave Requests (leave-requests)/api/v1/leave-requests · /api/hrms/leave-requests · /{id}list, get, create, change, deleteid uuid (read-only), employee_id* uuid, leave_type_id* uuid, start_date* date, end_date* date, days* numeric, status text, approved_by uuid (read-only), notes text, request_no text (read-only), hours numeric (read-only), half_day_start boolean (read-only), half_day_end boolean (read-only), approver_id uuid (read-only), decided_at timestamp with time zone (read-only), decision_note text (read-only), certificate_document_id uuid (read-only), working_days numeric (read-only), cancelled_at timestamp with time zone (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Leave Types (leave-types)/api/v1/leave-types · /api/hrms/leave-types · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, annual_accrual_days numeric, paid boolean, org_unit_id uuid (read-only), category text, unit text, accrual_method text, accrual_rate numeric, accrual_per_hours_worked numeric, max_balance numeric, max_carryover numeric, carryover_expires_on text, waiting_period_days integer, requires_approval boolean, allows_negative boolean, requires_certificate_after integer, earning_code text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), accrual_basis text, accrual_periods_per_year integer
Who Is Off (absence-calendar)/api/v1/absence-calendar · /api/hrms/absence-calendar · /{id}list, getid uuid (read-only), employee_id uuid (read-only), employee_no text (read-only), employee_name text (read-only), manager_id uuid (read-only), leave_code text (read-only), leave_name text (read-only), category text (read-only), start_date date (read-only), end_date date (read-only), days numeric (read-only), working_days numeric (read-only), status text (read-only), department text (read-only), off_today boolean (read-only)

LMS Integration

リソースEndpoints業務フィールズ
LMS Connectors (lms-connectors)/api/v1/lms-connectors · /api/hrms/lms-connectors · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, platform text, transport text, base_url text, auth_type text, username text, api_key_header text, secret_cipher bytea (read-only), secret_last4 text (read-only), endpoints jsonb, field_map jsonb, employee_match text, enroll_on_completion boolean, create_courses boolean, delimiter text, import_entities _text, export_entities _text, schedule text, is_active boolean, last_run_at timestamp with time zone (read-only), last_status text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
LMS Error Log (lms-errors)/api/v1/lms-errors · /api/hrms/lms-errors · /{id}list, get, create, change, deleteid uuid (read-only), run_id uuid (read-only), connector_id uuid (read-only), entity text (read-only), row_no integer (read-only), external_ref text (read-only), payload jsonb (read-only), error text (read-only), status text, resolved_by uuid (read-only), resolved_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
LMS Sync Runs (lms-runs)/api/v1/lms-runs · /api/hrms/lms-runs · /{id}list, getid uuid (read-only), run_no text (read-only), connector_id uuid (read-only), direction text (read-only), entity text (read-only), trigger text (read-only), file_name text (read-only), status text (read-only), records_read integer (read-only), records_created integer (read-only), records_updated integer (read-only), records_failed integer (read-only), message text (read-only), triggered_by uuid (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

その他のリソース

リソースEndpoints業務フィールズ
Comp cycle status (comp-cycle-status)/api/v1/comp-cycle-status · /api/hrms/comp-cycle-status · /{id}list, getid uuid (read-only), code text (read-only), name text (read-only), cycle_type text (read-only), plan_year integer (read-only), effective_date date (read-only), status text (read-only), budget_percent numeric (read-only), budget_amount numeric (read-only), eligible_pay_bill numeric (read-only), proposed numeric (read-only), approved numeric (read-only), remaining numeric (read-only), awards integer (read-only), above_guideline integer (read-only), standing text (read-only)
Cost center lookup (cost-center-lookup)/api/v1/cost-center-lookup · /api/hrms/cost-center-lookup · /{id}list, getid uuid (read-only), code text (read-only), name text (read-only), is_active boolean (read-only), org_unit_id uuid (read-only), parent_id uuid (read-only), profit_center_id uuid (read-only), center_type text (read-only), manager_employee_id uuid (read-only), valid_from date (read-only), valid_to date (read-only), is_blocked boolean (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), responsible_user_id uuid (read-only)
Jobs (jobs)/api/v1/jobs · /api/hrms/jobs · /{id}list, getid uuid (read-only), code text (read-only), title text (read-only), job_family_id uuid (read-only), job_level text (read-only), description text (read-only), responsibilities text (read-only), requirements text (read-only), flsa_status text (read-only), eeo_category text (read-only), soc_code text (read-only), is_active boolean (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Labor lookup (labor-lookup)/api/v1/labor-lookup · /api/hrms/labor-lookup · /{id}list, getid uuid (read-only), kind text (read-only), code text (read-only), name text (read-only), fund_id uuid (read-only), is_active boolean (read-only)
Learning path progress (learning-path-progress)/api/v1/learning-path-progress · /api/hrms/learning-path-progress · /{id}list, getid uuid (read-only), path_id uuid (read-only), employee_id uuid (read-only), assigned_on date (read-only), due_date date (read-only), status text (read-only), completed_on date (read-only), source text (read-only), path_code text (read-only), path_name text (read-only), is_mandatory boolean (read-only), employee_no text (read-only), employee_name text (read-only), org_unit_id uuid (read-only), courses_required integer (read-only), courses_completed integer (read-only), completion_pct numeric (read-only)
Merit matrix (merit-matrix)/api/v1/merit-matrix · /api/hrms/merit-matrix · /{id}list, get, create, change, deleteid uuid (read-only), cycle_id* uuid, rating* text, quartile* integer, increase_percent* numeric, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Persons (persons)/api/v1/persons · /api/hrms/persons · /{id}list, getid uuid (read-only), person_no text (read-only), first_name text (read-only), middle_name text (read-only), last_name text (read-only), preferred_name text (read-only), date_of_birth date (read-only), gender text (read-only), marital_status text (read-only), nationality text (read-only), national_id_cipher bytea (read-only), national_id_last4 text (read-only), national_id_type text (read-only), personal_email text (read-only), mobile_phone text (read-only), home_phone text (read-only), address_line1 text (read-only), address_line2 text (read-only), city text (read-only), state_province text (read-only), postal_code text (read-only), country text (read-only), emergency_contact_name text (read-only), emergency_contact_phone text (read-only), emergency_contact_relation text (read-only), ethnicity text (read-only), veteran_status text (read-only), disability_status text (read-only), self_id_declined boolean (read-only), photo_url text (read-only), is_active boolean (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Requisition status (requisition-status)/api/v1/requisition-status · /api/hrms/requisition-status · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), requisition_no text (read-only), title text (read-only), department text (read-only), status text (read-only), openings integer (read-only), filled integer (read-only), still_open integer (read-only), reason text (read-only), target_start date (read-only), opened_on date (read-only), budget_min numeric (read-only), budget_max numeric (read-only), currency text (read-only), grade_code text (read-only), range_min numeric (read-only), range_mid numeric (read-only), range_max numeric (read-only), hiring_manager_no text (read-only), hiring_manager text (read-only), applications integer (read-only), in_pipeline integer (read-only), rejected integer (read-only), offers_out integer (read-only), live_postings integer (read-only), days_open integer (read-only), standing text (read-only)

Parallel Payroll

リソースEndpoints業務フィールズ
Legacy Payroll Registers (parallel-registers)/api/v1/parallel-registers · /api/hrms/parallel-registers · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), register_no text (read-only), legacy_system text (read-only), cycle_label text (read-only), period_start date (read-only), period_end date (read-only), pay_date date (read-only), source_file_name text (read-only), employee_count integer (read-only), totals jsonb (read-only), unmatched jsonb (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Parallel Payroll Comparisons (parallel-comparisons)/api/v1/parallel-comparisons · /api/hrms/parallel-comparisons · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), comparison_no text (read-only), register_id uuid (read-only), payroll_run_id uuid (read-only), interface_id uuid (read-only), cycle_no integer (read-only), tolerance_amount numeric (read-only), tolerance_pct numeric (read-only), status text (read-only), summary jsonb (read-only), variance_count integer (read-only), employees_compared integer (read-only), within_tolerance boolean (read-only), signed_off_by uuid (read-only), signed_off_at timestamp with time zone (read-only), sign_off_note text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

給与処理

リソースEndpoints業務フィールズ
Direct Deposits (direct-deposits)/api/v1/direct-deposits · /api/hrms/direct-deposits · /{id}list, getid uuid (read-only), employee_id uuid (read-only), employee_no text (read-only), employee_name text (read-only), sequence_no integer (read-only), bank_name text (read-only), account_name text (read-only), account_type text (read-only), country text (read-only), routing_masked text (read-only), ifsc_masked text (read-only), iban_masked text (read-only), account_masked text (read-only), split_type text (read-only), split_amount numeric (read-only), split_percent numeric (read-only), status text (read-only), effective_from date (read-only), effective_to date (read-only), prenote_status text (read-only), source_request_id uuid (read-only), source_request_no text (read-only)
Pay Files (pay-files)/api/v1/pay-files · /api/hrms/pay-files · /{id}list, getid uuid (read-only), payroll_run_id uuid (read-only), run_no text (read-only), period_start date (read-only), period_end date (read-only), pay_date date (read-only), run_status text (read-only), paid_at timestamp with time zone (read-only), version integer (read-only), format text (read-only), format_label text (read-only), status text (read-only), file_name text (read-only), sha256 text (read-only), entry_count integer (read-only), employee_count integer (read-only), total_amount numeric (read-only), currency text (read-only), entry_hash text (read-only), block_count integer (read-only), line_count integer (read-only), effective_date date (read-only), controls jsonb (read-only), exception_count integer (read-only), exceptions jsonb (read-only), created_by_name text (read-only), confirmed_at timestamp with time zone (read-only), confirmed_by_name text (read-only), downloads integer (read-only)
Payroll Readiness (payroll-readiness)/api/v1/payroll-readiness · /api/hrms/payroll-readiness · /{pay_group_id}list, getpay_group_id uuid (read-only), pay_group_code text (read-only), pay_group_name text (read-only), pay_frequency text (read-only), calculation_mode text (read-only), country text (read-only), pay_period_id uuid (read-only), period_no integer (read-only), period_start date (read-only), period_end date (read-only), pay_date date (read-only), cutoff_date date (read-only), days_to_pay integer (read-only), employees integer (read-only), cycle_status text (read-only), periods_not_closed integer (read-only), unapproved_time_entries integer (read-only), unapproved_hours numeric (read-only), missing_timecards integer (read-only), retro_pending integer (read-only), retro_pending_amount numeric (read-only), off_cycle_runs integer (read-only), pay_rate_changes integer (read-only), deduction_changes integer (read-only), tax_setup_gaps integer (read-only), direct_deposit_gaps integer (read-only), corrections_this_year integer (read-only), runs_waiting integer (read-only), last_run_at timestamp with time zone (read-only)
Payroll Register (payroll-register)/api/v1/payroll-register · /api/hrms/payroll-register · /{payslip_id}list, getpayslip_id uuid (read-only), run_no text (read-only), period_start date (read-only), period_end date (read-only), pay_date date (read-only), run_status text (read-only), run_type text (read-only), calculation_mode text (read-only), engine_name text (read-only), employee_no text (read-only), employee_name text (read-only), work_state text (read-only), pay_group text (read-only), regular_hours numeric (read-only), overtime_hours numeric (read-only), gross_pay numeric (read-only), pretax_deductions numeric (read-only), fit_wages numeric (read-only), fica_wages numeric (read-only), taxes numeric (read-only), deductions numeric (read-only), posttax_deductions numeric (read-only), net_pay numeric (read-only), employer_taxes numeric (read-only), employer_contributions numeric (read-only), total_cost numeric (read-only), calculated_by_engine text (read-only), is_retro boolean (read-only)
Payroll Runs (payroll-runs)/api/v1/payroll-runs · /api/hrms/payroll-runs · /{id}list, getid uuid (read-only), run_no text (read-only), period_start date (read-only), period_end date (read-only), pay_date date (read-only), status text (read-only), total_gross numeric (read-only), total_net numeric (read-only), total_taxes numeric (read-only), total_deductions numeric (read-only), journal_id uuid (read-only), calculated_by uuid (read-only), approved_by uuid (read-only), org_unit_id uuid (read-only), cost_center_id uuid (read-only), profit_center_id uuid (read-only), pay_group_id uuid (read-only), pay_period_id uuid (read-only), run_type text (read-only), tax_year integer (read-only), quarter integer (read-only), employer_taxes numeric (read-only), employer_contributions numeric (read-only), employee_count integer (read-only), calculation_mode text (read-only), engine_name text (read-only), paid_at timestamp with time zone (read-only), reversal_of uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), fund_id uuid (read-only), grant_id uuid (read-only), program_id uuid (read-only), function_id uuid (read-only), derivation_trace jsonb (read-only), left_out jsonb (read-only), ytd_posted_at timestamp with time zone (read-only), paid_by uuid (read-only)
Retroactive Pay (retro-adjustments)/api/v1/retro-adjustments · /api/hrms/retro-adjustments · /{id}list, get, create, change, deleteid uuid (read-only), employee_id* uuid, reason* text, earning_code_id uuid, affected_from* date, affected_to* date, old_rate numeric, new_rate numeric, periods_affected integer, amount* numeric, source_action_id uuid (read-only), status text, payroll_run_id uuid, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), mode text (read-only), detail jsonb (read-only)
Year to Date (ytd-balances)/api/v1/ytd-balances · /api/hrms/ytd-balances · /{id}list, getid uuid (read-only), employee_id uuid (read-only), tax_year integer (read-only), gross_pay numeric (read-only), fit_wages numeric (read-only), fit_withheld numeric (read-only), ss_wages numeric (read-only), ss_withheld numeric (read-only), medicare_wages numeric (read-only), medicare_withheld numeric (read-only), addl_medicare_withheld numeric (read-only), sit_wages numeric (read-only), sit_withheld numeric (read-only), local_withheld numeric (read-only), futa_wages numeric (read-only), suta_wages numeric (read-only), pretax_401k numeric (read-only), roth_401k numeric (read-only), pretax_medical numeric (read-only), dependent_care numeric (read-only), hsa_employee numeric (read-only), hsa_employer numeric (read-only), imputed_income numeric (read-only), net_pay numeric (read-only), employer_ss numeric (read-only), employer_medicare numeric (read-only), employer_futa numeric (read-only), employer_suta numeric (read-only), work_state text (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Year to Date by Jurisdiction (ytd-tax-jurisdictions)/api/v1/ytd-tax-jurisdictions · /api/hrms/ytd-tax-jurisdictions · /{id}list, getid uuid (read-only), employee_id uuid (read-only), tax_year integer (read-only), tax_code text (read-only), kind text (read-only), jurisdiction text (read-only), state_code text (read-only), locality_name text (read-only), wages numeric (read-only), withheld numeric (read-only), employer_amount numeric (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

支払い設定

リソースEndpoints業務フィールズ
Deduction Codes (deduction-codes)/api/v1/deduction-codes · /api/hrms/deduction-codes · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, category text, calculation text, amount numeric, percent numeric, reduces_fit boolean, reduces_fica boolean, reduces_sit boolean, employer_paid boolean, employer_match_percent numeric, employer_match_limit_percent numeric, annual_limit numeric, priority integer, max_percent_of_disposable numeric, w2_box text, gl_account_no text, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), tax_treatment text, required_by_law boolean
Earning Codes (earning-codes)/api/v1/earning-codes · /api/hrms/earning-codes · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, category text, calculation text, multiplier numeric, subject_to_fit boolean, subject_to_fica boolean, subject_to_futa boolean, subject_to_sit boolean, is_imputed boolean, includes_in_regular_rate boolean, supplemental boolean, w2_box text, gl_account_no text, is_active boolean, sort_order integer, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Employee Deductions (employee-deductions)/api/v1/employee-deductions · /api/hrms/employee-deductions · /{id}list, get, create, change, deleteid uuid (read-only), employee_id* uuid, deduction_code_id* uuid, amount numeric, percent numeric, employer_amount numeric, effective_from date, effective_to date, goal_amount numeric, taken_to_date numeric, case_number text, payee text, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), order_type text (read-only), order_priority integer (read-only), order_received_on date (read-only), issuing_state text (read-only), issuing_authority text (read-only), remit_to_address text (read-only), remit_fips text (read-only), remit_method text (read-only), medical_support boolean (read-only), order_notes text (read-only)
Local Tax Assignments (employee-local-taxes)/api/v1/employee-local-taxes · /api/hrms/employee-local-taxes · /{id}list, get, create, change, deleteid uuid (read-only), employee_id* uuid, jurisdiction_code* text, role text, effective_from date, effective_to date, exempt boolean, exemptions integer, extra_withholding numeric, exempt_reason text, notes text, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Pay Calendar (pay-periods)/api/v1/pay-periods · /api/hrms/pay-periods · /{id}list, get, create, change, deleteid uuid (read-only), pay_group_id* uuid, period_no* integer, tax_year* integer, quarter* integer, period_start* date, period_end* date, pay_date* date, cutoff_date date, status text, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Pay Formulas (pay-formulas)/api/v1/pay-formulas · /api/hrms/pay-formulas · /{id}list, get, create, change, deleteid uuid (read-only), element_kind* text, code* text, version integer (read-only), formula* text, effective_from date, effective_to date, status text (read-only), description text, tested_ok boolean (read-only), last_test jsonb (read-only), activated_by uuid (read-only), activated_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Pay Groups (pay-groups)/api/v1/pay-groups · /api/hrms/pay-groups · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, country text, currency text, pay_frequency text, calculation_mode text, tax_engine_id uuid, payroll_engine_id uuid, legal_entity text, employer_ein text, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), establishment_id text, payer_bank_code text, payer_iban text, overtime_rule_id uuid, fund_id uuid
Payroll Tax Accounts (payroll-tax-accounts)/api/v1/payroll-tax-accounts · /api/hrms/payroll-tax-accounts · /{id}list, get, create, change, deleteid uuid (read-only), tax_type* text, description text, side text, liability_account_no text, expense_account_no text, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), pay_group_id uuid, jurisdiction text, fund_id uuid
Recurring Earnings (employee-earnings)/api/v1/employee-earnings · /api/hrms/employee-earnings · /{id}list, get, create, change, deleteid uuid (read-only), employee_id* uuid, earning_code_id* uuid, amount numeric, rate numeric, hours numeric, percent numeric, effective_from date, effective_to date, frequency text, reference text, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Withholding (W-4) (employee-tax-setup)/api/v1/employee-tax-setup · /api/hrms/employee-tax-setup · /{id}list, get, create, change, deleteid uuid (read-only), employee_id* uuid, jurisdiction text, authority text, effective_from date, effective_to date, filing_status text, multiple_jobs boolean, dependents_amount numeric, other_income numeric, deductions numeric, extra_withholding numeric, allowances integer, is_legacy_w4 boolean, exempt_from_withholding boolean, additional_percent numeric, signed_on date, source text, org_unit_id uuid (read-only), additional_allowances integer, dependents_count integer, elected_rate numeric, reciprocity_waived boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

給与税

リソースEndpoints業務フィールズ
Payroll Tax Calendar (payroll-tax-calendar)/api/v1/payroll-tax-calendar · /api/hrms/payroll-tax-calendar · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), registration_id uuid (read-only), obligation_kind text (read-only), event_kind text (read-only), period_kind text (read-only), period_code text (read-only), period_from date (read-only), period_to date (read-only), due_date date (read-only), form_code text (read-only), run_id uuid (read-only), status text, completed_at timestamp with time zone (read-only), amount numeric (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Payroll Tax Deposits (payroll-tax-deposits)/api/v1/payroll-tax-deposits · /api/hrms/payroll-tax-deposits · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), deposit_no text (read-only), run_id uuid, registration_id uuid, obligation_kind text, period_code text, deposit_date* date, due_date date, amount* numeric, currency text, method text, reference text, challan_no text, bank_account_id uuid (read-only), confirmed boolean, confirmed_at timestamp with time zone (read-only), days_late integer (read-only), penalty_amount numeric (read-only), journal_id uuid (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Payroll Tax Findings (payroll-tax-findings)/api/v1/payroll-tax-findings · /api/hrms/payroll-tax-findings · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), run_id uuid (read-only), step_id uuid (read-only), step_key text (read-only), finding_kind text (read-only), severity text (read-only), title text (read-only), title_local text (read-only), detail text (read-only), detail_local text (read-only), employee_id uuid (read-only), registration_id uuid (read-only), target_module text (read-only), target_resource text (read-only), target_id uuid (read-only), amount numeric (read-only), expected_amount numeric (read-only), difference numeric (read-only), recommendation text (read-only), recommendation_local text (read-only), status text, resolved_by uuid (read-only), resolved_at timestamp with time zone (read-only), resolution text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Payroll Tax Liabilities (payroll-tax-liabilities)/api/v1/payroll-tax-liabilities · /api/hrms/payroll-tax-liabilities · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), run_id uuid (read-only), registration_id uuid (read-only), registration_code text (read-only), obligation_kind text (read-only), level text (read-only), region_code text (read-only), authority_name text (read-only), registration_no text (read-only), employee_count integer (read-only), gross_wages numeric (read-only), taxable_wages numeric (read-only), excess_wages numeric (read-only), wage_base_cap numeric (read-only), employee_rate_pct numeric (read-only), employer_rate_pct numeric (read-only), employee_tax numeric (read-only), employer_tax numeric (read-only), total_tax numeric (read-only), already_deposited numeric (read-only), net_due numeric (read-only), deposit_due_date date (read-only), return_due_date date (read-only), form_code text (read-only), status text (read-only), deposited_at timestamp with time zone (read-only), deposit_reference text (read-only), variance numeric (read-only), notes text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Payroll Tax Periods (payroll-tax-runs)/api/v1/payroll-tax-runs · /api/hrms/payroll-tax-runs · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), run_no text (read-only), pack_id uuid (read-only), country text (read-only), purpose text (read-only), period_kind text (read-only), period_code text (read-only), period_from date (read-only), period_to date (read-only), payroll_run_ids _uuid (read-only), pay_date_from date (read-only), pay_date_to date (read-only), deposit_due_date date (read-only), return_due_date date (read-only), currency text (read-only), status text (read-only), current_step integer (read-only), steps_total integer (read-only), steps_done integer (read-only), employee_count integer (read-only), gross_wages numeric (read-only), taxable_wages numeric (read-only), exempt_wages numeric (read-only), employee_tax numeric (read-only), employer_tax numeric (read-only), total_liability numeric (read-only), already_deposited numeric (read-only), net_due numeric (read-only), penalty_amount numeric (read-only), interest_amount numeric (read-only), open_findings integer (read-only), blocking_findings integer (read-only), registration_count integer (read-only), journal_id uuid (read-only), deposited_at timestamp with time zone (read-only), deposit_reference text (read-only), filed_at timestamp with time zone (read-only), filed_by uuid (read-only), filing_reference text (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), started_by uuid (read-only), started_at timestamp with time zone (read-only), closed_at timestamp with time zone (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Payroll Tax Registrations (payroll-tax-registrations)/api/v1/payroll-tax-registrations · /api/hrms/payroll-tax-registrations · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, name_local text, country* text, level text, region_code text, authority_name text, authority_code text, obligation_kind* text, registration_no text, employer_rate_pct numeric, employee_rate_pct numeric, wage_base_cap numeric, wage_base_period text, deposit_frequency text, deposit_due_days integer, return_frequency text, return_due_day integer, return_form text, annual_form text, lookback_determines_schedule boolean, lookback_threshold numeric, filing_portal text, filing_method text, effective_from date, effective_to date, status text, notes text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

人々

リソースEndpoints業務フィールズ
Employees (employees)/api/v1/employees · /api/hrms/employees · /{id}list, get, create, change, deleteid uuid (read-only), employee_no* text, user_id uuid, first_name* text, last_name* text, email text, worker_type text, position_id uuid, manager_id uuid, hire_date* date, termination_date date (read-only), pay_type text, base_pay numeric, currency text, work_state text, status text, org_unit_id uuid (read-only), person_id uuid, employment_type text (read-only), is_primary boolean (read-only), fte numeric (read-only), standard_hours_week numeric (read-only), pay_frequency text, original_hire_date date (read-only), seniority_date date (read-only), probation_end_date date (read-only), contract_end_date date (read-only), notice_days integer (read-only), work_country text, work_location_id uuid, work_email text (read-only), work_phone text (read-only), exempt boolean (read-only), union_code text (read-only), termination_reason text (read-only), termination_type text (read-only), eligible_for_rehire boolean (read-only), last_working_day date (read-only), grade_id uuid (read-only), agency_name text (read-only), agency_rate numeric (read-only), purchase_order_id uuid (read-only), pay_group_id uuid, resident_state text, work_locality text, resident_locality text, holiday_calendar_id uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), pan text (read-only), aadhaar_last4 text (read-only), uan text, pf_number text (read-only), esi_number text (read-only), basic_wage numeric, dearness_allowance numeric, hra numeric, special_allowance numeric, pt_state_code text, is_pf_applicable boolean, is_esi_applicable boolean, tax_regime text, ifsc text (read-only), housing_allowance numeric, transport_allowance numeric, gosi_number text, gosi_category text, gosi_registered_on date, iqama_number text, merged_into_id uuid (read-only), overtime_rule_id uuid
Personnel Actions (personnel-actions)/api/v1/personnel-actions · /api/hrms/personnel-actions · /{id}list, get, create, change, deleteid uuid (read-only), employee_id* uuid, action_type* text, effective_date* date, reason text, detail jsonb, approved_by uuid (read-only), action_no text (read-only), status text (read-only), requested_by uuid (read-only), requested_at timestamp with time zone (read-only), approved_at timestamp with time zone (read-only), rejected_reason text (read-only), proposed jsonb (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), to_position_id uuid, to_manager_id uuid, to_org_unit_id uuid, to_base_pay numeric, to_pay_type text, to_work_state text, applied_at timestamp with time zone (read-only), applied_change jsonb (read-only), from_values jsonb (read-only), rejected_by uuid (read-only), rejected_at timestamp with time zone (read-only), cancelled_by uuid (read-only), cancelled_at timestamp with time zone (read-only), type_override_reason text (read-only), type_override_by uuid (read-only), type_override_at timestamp with time zone (read-only), to_pay_group_id uuid
Positions (positions)/api/v1/positions · /api/hrms/positions · /{id}list, get, create, change, deleteid uuid (read-only), code* text, title* text, department* text, cost_center_id uuid, headcount_budget integer, is_active boolean, org_unit_id uuid (read-only), job_id uuid, parent_position_id uuid (read-only), location_id uuid, fte_budget numeric (read-only), status text (read-only), effective_from date, effective_to date (read-only), grade_id uuid, is_shared boolean (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), first_in_force date (read-only), fund_id uuid, grant_id uuid, program_id uuid
Possible Duplicate Employees (employee-duplicates)/api/v1/employee-duplicates · /api/hrms/employee-duplicates · /{id}list, getid uuid (read-only), employee_no text (read-only), user_id uuid (read-only), first_name text (read-only), last_name text (read-only), email text (read-only), worker_type text (read-only), position_id uuid (read-only), manager_id uuid (read-only), hire_date date (read-only), termination_date date (read-only), pay_type text (read-only), base_pay numeric (read-only), currency text (read-only), work_state text (read-only), status text (read-only), org_unit_id uuid (read-only), person_id uuid (read-only), employment_type text (read-only), is_primary boolean (read-only), fte numeric (read-only), standard_hours_week numeric (read-only), pay_frequency text (read-only), original_hire_date date (read-only), seniority_date date (read-only), probation_end_date date (read-only), contract_end_date date (read-only), notice_days integer (read-only), work_country text (read-only), work_location_id uuid (read-only), work_email text (read-only), work_phone text (read-only), exempt boolean (read-only), union_code text (read-only), termination_reason text (read-only), termination_type text (read-only), eligible_for_rehire boolean (read-only), last_working_day date (read-only), grade_id uuid (read-only), agency_name text (read-only), agency_rate numeric (read-only), purchase_order_id uuid (read-only), pay_group_id uuid (read-only), resident_state text (read-only), work_locality text (read-only), resident_locality text (read-only), holiday_calendar_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), pan text (read-only), aadhaar_last4 text (read-only), uan text (read-only), pf_number text (read-only), esi_number text (read-only), basic_wage numeric (read-only), dearness_allowance numeric (read-only), hra numeric (read-only), special_allowance numeric (read-only), pt_state_code text (read-only), is_pf_applicable boolean (read-only), is_esi_applicable boolean (read-only), tax_regime text (read-only), ifsc text (read-only), housing_allowance numeric (read-only), transport_allowance numeric (read-only), gosi_number text (read-only), gosi_category text (read-only), gosi_registered_on date (read-only), iqama_number text (read-only), merged_into_id uuid (read-only), overtime_rule_id uuid (read-only)

パフォーマンスと才能

リソースEndpoints業務フィールズ
Check-in Status (goal-checkin-status)/api/v1/goal-checkin-status · /api/hrms/goal-checkin-status · /{id}list, getid uuid (read-only), employee_id uuid (read-only), cycle_id uuid (read-only), title text (read-only), status text (read-only), progress_pct numeric (read-only), due_date date (read-only), goal_level text (read-only), parent_goal_id uuid (read-only), last_checkin_on date (read-only), cycle_name text (read-only), checkin_cadence text (read-only), checkin_grace_days integer (read-only), employee_no text (read-only), employee_name text (read-only), manager_id uuid (read-only), org_unit_id uuid (read-only), checkins integer (read-only), checkins_90d integer (read-only), cadence_days integer (read-only), next_checkin_due date (read-only), checkin_overdue boolean (read-only)
Development Actions (development-plan-actions)/api/v1/development-plan-actions · /api/hrms/development-plan-actions · /{id}list, get, create, change, deleteid uuid (read-only), plan_id* uuid, line_no integer, action* text, action_type text, course_id uuid, skill_id uuid, target_level integer, due_date date, status text, completed_on date, enrollment_id uuid (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Development Plans (development-plans)/api/v1/development-plans · /api/hrms/development-plans · /{id}list, get, create, change, deleteid uuid (read-only), plan_no text (read-only), employee_id* uuid, title* text, cycle_id uuid, review_id uuid, plan_type text, start_date date, end_date date, status text, objective text, manager_id uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Goal Check-ins (goal-checkins)/api/v1/goal-checkins · /api/hrms/goal-checkins · /{id}list, get, create, change, deleteid uuid (read-only), goal_id* uuid, employee_id uuid (read-only), checkin_date date, progress_pct numeric, goal_status text, update_text text, blockers text, manager_comment text, manager_reviewed_by uuid (read-only), manager_reviewed_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Goals (performance-goals)/api/v1/performance-goals · /api/hrms/performance-goals · /{id}list, get, create, change, deleteid uuid (read-only), employee_id uuid, cycle_id uuid, review_id uuid, parent_goal_id uuid, title* text, description text, goal_type text, category text, weight_pct numeric, measure text, target_value text, actual_value text, start_date date, due_date date, completed_on date, progress_pct numeric, status text, rating text, is_private boolean, org_unit_id uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), goal_level text, last_checkin_on date (read-only)
Performance Cycles (performance-cycles)/api/v1/performance-cycles · /api/hrms/performance-cycles · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, period_start* date, period_end* date, review_type text, rating_scale jsonb, forced_distribution jsonb, self_review_required boolean, peer_review_enabled boolean, upward_review_enabled boolean, calibration_required boolean, status text, opens_on date, closes_on date, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), review_workflow_id uuid, checkin_cadence text, checkin_grace_days integer
Performance Reviews (performance-reviews)/api/v1/performance-reviews · /api/hrms/performance-reviews · /{id}list, get, create, change, deleteid uuid (read-only), cycle_id* uuid, employee_id* uuid, reviewer_id uuid, overall_rating text, rating_value numeric, potential_rating text, self_rating text, calibrated_rating text, calibrated_by uuid, strengths text, development_areas text, manager_comments text, employee_comments text, triggers_pip boolean, merit_eligible boolean, promotion_recommended boolean, status text, submitted_at timestamp with time zone, acknowledged_at timestamp with time zone, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), workflow_id uuid (read-only), step_seq integer (read-only), step_due_on date (read-only), step_actor text (read-only), step_role_code text (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), last_reminded_on date (read-only)
Review History (review-steps)/api/v1/review-steps · /api/hrms/review-steps · /{id}list, getid uuid (read-only), review_id uuid (read-only), from_status text (read-only), to_status text (read-only), action text (read-only), acted_by uuid (read-only), comments text (read-only), acted_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Review Workflow Steps (review-workflow-steps)/api/v1/review-workflow-steps · /api/hrms/review-workflow-steps · /{id}list, get, create, change, deleteid uuid (read-only), workflow_id* uuid, seq* integer, step* text, actor text, role_code text, due_days integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Review Workflows (review-workflows)/api/v1/review-workflows · /api/hrms/review-workflows · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, review_type text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Succession Candidates (succession-candidates)/api/v1/succession-candidates · /api/hrms/succession-candidates · /{id}list, get, create, change, deleteid uuid (read-only), plan_id* uuid, employee_id* uuid, readiness text, rank_order integer, is_informed boolean, readiness_gaps text, development_actions text, assessed_on date, assessed_by uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Succession Plans (succession-plans)/api/v1/succession-plans · /api/hrms/succession-plans · /{id}list, get, create, change, deleteid uuid (read-only), position_id uuid, job_id uuid, org_unit_id uuid, incumbent_id uuid, criticality text, vacancy_risk text, impact_of_vacancy text, time_to_fill_months integer, status text, reviewed_on date, next_review_on date, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Talent Profiles (talent-profiles)/api/v1/talent-profiles · /api/hrms/talent-profiles · /{id}list, get, create, change, deleteid uuid (read-only), employee_id* uuid, performance_rating text, potential_rating text, talent_segment text, flight_risk text, retention_criticality text, career_aspiration text, mobility text, willing_to_relocate boolean, ready_for_promotion text, development_plan text, mentor_id uuid, last_reviewed_on date, reviewed_by uuid, effective_from date, effective_to date, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
リソースEndpoints業務フィールズ
Identifiers & Right to Work (person-identifiers)/api/v1/person-identifiers · /api/hrms/person-identifiers · /{id}list, get, create, change, deleteid uuid (read-only), person_id* uuid, identifier_type* text, number_cipher bytea (read-only), number_last4 text, issuing_country text, issuing_authority text, issued_on date, expires_on date, grants_right_to_work boolean, work_restrictions text, max_hours_per_week numeric, restricted_to_employer boolean, restricted_to_role text, status text, alert_days_before integer, on_expiry text, verified_by uuid, verified_on date, document_id uuid, notes text, effective_from date, effective_to date, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Offboarding (offboarding)/api/v1/offboarding · /api/hrms/offboarding · /{id}list, get, create, change, deleteid uuid (read-only), employee_id* uuid, work_relationship_id uuid, offboarding_no text (read-only), leaving_type* text, reason text, is_retirement boolean, retirement_type text, pension_scheme text, pension_start_date date, is_phased boolean, phased_hours_pct numeric, notified_on date, last_working_day date, termination_date* date, notice_worked boolean, notice_paid_in_lieu boolean, garden_leave boolean, exit_interview_on date, exit_interview_by uuid, exit_reason_category text, would_recommend boolean, would_return boolean, exit_feedback text, final_pay_calculated boolean, final_pay_date date, accrued_leave_days numeric, accrued_leave_paid boolean, severance_amount numeric, assets_returned boolean, assets_outstanding text, system_access_revoked boolean, access_revoked_on timestamp with time zone, building_access_revoked boolean, knowledge_transfer_done boolean, handover_to_id uuid, reference_policy text, has_restrictive_covenant boolean, covenant_months integer, is_rehire_eligible boolean, checklist_id uuid, status text, completed_on date, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Payroll Tax Run Steps (payroll-tax-steps)/api/v1/payroll-tax-steps · /api/hrms/payroll-tax-steps · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), run_id uuid (read-only), step_no integer (read-only), step_key text (read-only), title text (read-only), stage text (read-only), auto_kind text (read-only), is_mandatory boolean (read-only), needs_approval boolean (read-only), status text (read-only), result jsonb (read-only), findings_found integer (read-only), skip_reason text (read-only), ran_by uuid (read-only), ran_at timestamp with time zone (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), duration_ms integer (read-only), error_message text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Work Relationships (work-relationships)/api/v1/work-relationships · /api/hrms/work-relationships · /{id}list, get, create, change, deleteid uuid (read-only), person_id* uuid, employee_id uuid, relationship_no text (read-only), legal_employer_org_unit_id uuid, worker_type text, is_primary boolean, start_date* date, end_date date, original_hire_date date, continuous_service_date date, service_break_days integer, employment_basis text, contract_end_date date, probation_end_date date, notice_period_days integer, notice_period_days_employer integer, status text, termination_reason text, termination_type text, is_rehire_eligible boolean, effective_from date, effective_to date, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Worker Compliance (compliance-items)/api/v1/compliance-items · /api/hrms/compliance-items · /{id}list, get, create, change, deleteid uuid (read-only), employee_id uuid, person_id uuid, requirement* text, requirement_type* text, required_by_job_id uuid, required_by_position_id uuid, regulatory_basis text, status text, satisfied_on date, expires_on date, evidence_reference text, document_id uuid, verified_by uuid, verified_on date, on_failure text, waived_by uuid, waiver_reason text, notes text, effective_from date, effective_to date, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

採用と入社手続き

リソースEndpoints業務フィールズ
Applications (applications)/api/v1/applications · /api/hrms/applications · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), application_no text (read-only), applied_on date (read-only), status text (read-only), rating integer (read-only), rejected_reason text (read-only), candidate_no text (read-only), candidate_name text (read-only), email text (read-only), is_internal boolean (read-only), source text (read-only), current_employer text (read-only), current_title text (read-only), requisition_no text (read-only), role text (read-only), department text (read-only), stage_code text (read-only), stage text (read-only), stage_order integer (read-only), is_terminal boolean (read-only), days_since_applied integer (read-only), interviews integer (read-only), interviews_done integer (read-only), average_score numeric (read-only), offer_no text (read-only), offer_status text (read-only)
Candidate Messages (candidate-message-templates)/api/v1/candidate-message-templates · /api/hrms/candidate-message-templates · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, event text, stage_id uuid, channel text, subject text, body* text, auto_send boolean, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Candidate Ranking (panel-rankings)/api/v1/panel-rankings · /api/hrms/panel-rankings · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), requisition_id uuid (read-only), requisition_no text (read-only), role text (read-only), openings integer (read-only), application_no text (read-only), status text (read-only), applied_on date (read-only), candidate_no text (read-only), candidate_name text (read-only), stage text (read-only), panel_score numeric (read-only), rank_no integer (read-only), interviews_scored integer (read-only), latest_outcome text (read-only), outlier_marks integer (read-only), is_selected boolean (read-only), selected_out_of_rank boolean (read-only), selection_reason text (read-only), selected_at timestamp with time zone (read-only), selected_by_name text (read-only), display_name text (read-only)
Candidates (candidates)/api/v1/candidates · /api/hrms/candidates · /{id}list, get, create, change, deleteid uuid (read-only), candidate_no text (read-only), first_name* text, last_name* text, email text, phone text, city text, country text, linkedin_url text, current_employer text, current_title text, years_experience numeric, is_internal boolean, employee_id uuid, source text, referred_by_id uuid, consent_given_on date (read-only), consent_expires_on date (read-only), delete_after date (read-only), talent_pool text, rating integer, notes text, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), email_opt_out boolean (read-only), sms_opt_out boolean (read-only), opted_out_at timestamp with time zone (read-only), opt_out_reason text (read-only)
Careers Site (careers-site)/api/v1/careers-site · /api/hrms/careers-site · /{org_id}list, get, create, change, deleteenabled boolean, slug text (read-only), slug_kind text (read-only), headline text, intro text, privacy_notice text, retention_days integer, eeo_invitation boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Hiring Approval Rules (requisition-approval-rules)/api/v1/requisition-approval-rules · /api/hrms/requisition-approval-rules · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, priority integer, amount_threshold numeric, department text, employment_type text, reason text, due_in_hours integer, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Hiring Approvals (requisition-approvals)/api/v1/requisition-approvals · /api/hrms/requisition-approvals · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), requisition_id uuid (read-only), level_no integer (read-only), status text (read-only), approver_kind text (read-only), approver_role text (read-only), approver_user_id uuid (read-only), approver_employee_id uuid (read-only), routed_by text (read-only), amount numeric (read-only), currency text (read-only), requested_at timestamp with time zone (read-only), due_at timestamp with time zone (read-only), decided_at timestamp with time zone (read-only), decided_by uuid (read-only), comment text (read-only), requisition_no text (read-only), role_title text (read-only), department text (read-only), openings integer (read-only), requisition_status text (read-only), approval_status text (read-only), rule_code text (read-only), rule_name text (read-only), approver_name text (read-only), approver_email text (read-only), decided_by_name text (read-only), raised_by_name text (read-only), overdue boolean (read-only), is_current boolean (read-only)
Hiring Requisitions (requisitions)/api/v1/requisitions · /api/hrms/requisitions · /{id}list, get, create, change, deleteid uuid (read-only), requisition_no text (read-only), title* text, position_id uuid, job_id uuid, grade_id uuid, department text, location_id uuid, cost_center_id uuid, hiring_manager_id uuid, recruiter_id uuid, openings integer, filled integer (read-only), reason text, replacing_employee_id uuid (read-only), employment_type text, target_start date, budget_min numeric, budget_max numeric, currency text (read-only), description text, requirements text, status text, approved_by uuid (read-only), approved_at timestamp with time zone (read-only), rejected_reason text (read-only), opened_on date (read-only), closed_on date (read-only), org_unit_id uuid (read-only), justification text, budget_annual_cost numeric, approval_status text (read-only), submitted_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Interview Panels (interview-panels)/api/v1/interview-panels · /api/hrms/interview-panels · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), interview_id uuid (read-only), employee_id uuid (read-only), user_id uuid (read-only), panelist_name text (read-only), panel_role text (read-only), weight numeric (read-only), is_voting boolean (read-only), recommendation text (read-only), weighted_score numeric (read-only), criteria_scored integer (read-only), is_complete boolean (read-only), deviation numeric (read-only), is_outlier boolean (read-only), submitted_at timestamp with time zone (read-only), strengths text (read-only), concerns text (read-only), comments text (read-only), sort_order integer (read-only), employee_no text (read-only), round_no integer (read-only), interview_type text (read-only), scheduled_at timestamp with time zone (read-only), interview_status text (read-only), interview_outcome text (read-only), panel_score numeric (read-only), criteria_count integer (read-only), application_id uuid (read-only), application_no text (read-only), candidate_no text (read-only), candidate_name text (read-only), requisition_id uuid (read-only), requisition_no text (read-only), role text (read-only), standing text (read-only)
Interview Scorecards (interview-scorecards)/api/v1/interview-scorecards · /api/hrms/interview-scorecards · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, requisition_id uuid, job_id uuid, is_default boolean, aggregation_rule text, pass_score numeric, tie_rule text, outlier_points numeric, description text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Interviews (interviews)/api/v1/interviews · /api/hrms/interviews · /{id}list, get, create, change, deleteid uuid (read-only), application_id* uuid, round_no integer, interview_type text, scheduled_at timestamp with time zone, duration_minutes integer, location text, meeting_url text, status text, outcome text, average_score numeric (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), scorecard_id uuid (read-only), aggregation_rule text (read-only), pass_score numeric (read-only), tie_rule text (read-only), panel_score numeric (read-only), panel_size integer (read-only), panel_submitted integer (read-only), votes_for integer (read-only), votes_against integer (read-only), derived_outcome text (read-only), outcome_basis text (read-only), outcome_overridden boolean (read-only), outcome_override_reason text (read-only), outcome_overridden_by uuid (read-only), outcome_overridden_at timestamp with time zone (read-only)
Job Postings (job-postings)/api/v1/job-postings · /api/hrms/job-postings · /{id}list, get, create, change, deleteid uuid (read-only), requisition_id* uuid, channel text, channel_name text, headline* text, body text, show_pay_range boolean, posted_on date, closes_on date, external_url text, external_ref text (read-only), status text, views integer (read-only), applications integer (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), screening_questions jsonb (read-only)
Joining & Leaving (checklists)/api/v1/checklists · /api/hrms/checklists · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), checklist_no text (read-only), purpose text (read-only), anchor_date date (read-only), status text (read-only), employee_no text (read-only), employee_name text (read-only), candidate_no text (read-only), candidate_name text (read-only), template text (read-only), tasks integer (read-only), done integer (read-only), overdue integer (read-only), blocking integer (read-only), standing text (read-only)
Messages to Candidates (candidate-communications)/api/v1/candidate-communications · /api/hrms/candidate-communications · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), candidate_id uuid (read-only), application_id uuid (read-only), offer_id uuid (read-only), template_id uuid (read-only), event text (read-only), channel text (read-only), automatic boolean (read-only), to_address text (read-only), subject text (read-only), body text (read-only), reason text (read-only), sent_by uuid (read-only), status text (read-only), sent_at timestamp with time zone (read-only), candidate_no text (read-only), candidate_name text (read-only), application_no text (read-only), template_code text (read-only), sent_by_name text (read-only)
Offer Letter Templates (offer-letter-templates)/api/v1/offer-letter-templates · /api/hrms/offer-letter-templates · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, title text, body* text, signatory_name text, signatory_title text, is_default boolean, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Offers (offers)/api/v1/offers · /api/hrms/offers · /{id}list, get, create, change, deleteid uuid (read-only), offer_no text (read-only), application_id* uuid, position_id uuid, grade_id uuid, employment_type text, base_pay* numeric, pay_type text, currency text (read-only), bonus_percent numeric, sign_on_bonus numeric, equity_units numeric, start_date* date, expires_on date, compa_ratio numeric (read-only), outside_range boolean (read-only), justification text, status text, approved_by uuid (read-only), approved_at timestamp with time zone (read-only), sent_at timestamp with time zone (read-only), responded_at timestamp with time zone (read-only), decline_reason text (read-only), signed_at timestamp with time zone (read-only), signature_method text (read-only), signed_by_name text (read-only), hired_employee_id uuid (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), letter_template_id uuid (read-only), letter_body text (read-only), letter_document_id uuid (read-only), esign_envelope_id uuid (read-only), signed_document_id uuid (read-only), signature_status text (read-only)
Onboarding Checklists (checklist-templates)/api/v1/checklist-templates · /api/hrms/checklist-templates · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, purpose text, applies_to text, description text, is_default boolean, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Pipeline Stages (pipeline-stages)/api/v1/pipeline-stages · /api/hrms/pipeline-stages · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, sort_order* integer, is_terminal boolean, is_offer boolean, is_hired boolean, requires_interview boolean, requires_feedback boolean, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Recruiting Settings (recruiting-settings)/api/v1/recruiting-settings · /api/hrms/recruiting-settings · /{org_id}list, get, create, change, deleteeeo_min_cell_size integer, eeo_link_days integer, offer_esign boolean, offer_countersigner_id uuid, task_due_soon_days integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Task Departments (checklist-owner-departments)/api/v1/checklist-owner-departments · /api/hrms/checklist-owner-departments · /{id}list, get, create, change, deleteid uuid (read-only), owner_role* text, department* text, department_unit_id uuid, contact_user_id uuid, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

サウジアラビアの給与計算

リソースEndpoints業務フィールズ
GOSI Rates (gosi-rates)/api/v1/gosi-rates · /api/hrms/gosi-rates · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), rate_set* text, effective_from* date, annuity_employee_pct numeric, annuity_employer_pct numeric, saned_employee_pct numeric, saned_employer_pct numeric, hazards_employer_pct numeric, wage_floor numeric, wage_cap numeric, notes text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Statutory Regimes

リソースEndpoints業務フィールズ
Regime Components (regime-components)/api/v1/regime-components · /api/hrms/regime-components · /{id}list, get, create, change, deleteid uuid (read-only), profile_id* uuid, kind* text, code* text, name text, base text, employee_rate numeric, employer_rate numeric, wage_floor_monthly numeric, wage_ceiling_monthly numeric, annual_allowance numeric, annual_rebate numeric, gl_account_no text, sort_order integer, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Regime Filings (regime-filings)/api/v1/regime-filings · /api/hrms/regime-filings · /{id}list, get, create, change, deleteid uuid (read-only), profile_id* uuid, code* text, name* text, frequency text, due_day integer, authority text, columns _text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Regime Tax Slabs (regime-slabs)/api/v1/regime-slabs · /api/hrms/regime-slabs · /{id}list, get, create, change, deleteid uuid (read-only), component_id* uuid, slab_no* integer, income_from numeric, income_to numeric, rate* numeric, fixed_amount numeric, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Statutory Regimes (regime-profiles)/api/v1/regime-profiles · /api/hrms/regime-profiles · /{id}list, get, create, change, deleteid uuid (read-only), country* text, code* text, name* text, currency text, status text (read-only), effective_from date, effective_to date, is_sample boolean (read-only), description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

税務申告

リソースEndpoints業務フィールズ
Engine Exchanges (payroll-interfaces)/api/v1/payroll-interfaces · /api/hrms/payroll-interfaces · /{id}list, getid uuid (read-only), interface_no text (read-only), engine_kind text (read-only), tax_engine_id uuid (read-only), payroll_engine_id uuid (read-only), payroll_run_id uuid (read-only), direction text (read-only), operation text (read-only), request_summary jsonb (read-only), response_summary jsonb (read-only), records_sent integer (read-only), records_accepted integer (read-only), records_rejected integer (read-only), status text (read-only), error_detail text (read-only), duration_ms integer (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), run_by uuid (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Local Brackets (local-tax-brackets)/api/v1/local-tax-brackets · /api/hrms/local-tax-brackets · /{id}list, get, create, change, deleteid uuid (read-only), tax_year* integer, jurisdiction_code* text, filing_status text, bracket_no* integer, income_from* numeric, income_to numeric, base_tax numeric, rate* numeric, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Local Tax Jurisdictions (local-tax-jurisdictions)/api/v1/local-tax-jurisdictions · /api/hrms/local-tax-jurisdictions · /{id}list, get, create, change, deleteid uuid (read-only), tax_year* integer, code* text, name* text, state_code* text, jurisdiction_type text, psd_code text, tax_kind text, method text, wage_basis text, resident_rate numeric, nonresident_rate numeric, resident_applies boolean, nonresident_applies boolean, nonresident_out_of_state_only boolean, resident_requires_work_here boolean, pa_act32 boolean, flat_amount numeric, employer_flat_amount numeric, flat_frequency text, exempt_below numeric, exempt_below_period text, employer_rate numeric, wage_base numeric, annual_max numeric, exemption_amount numeric, standard_deduction_single numeric, standard_deduction_married numeric, credit_factor numeric, credit_rate_limit numeric, auto_apply text, collector text, w2_locality_name text, source_note text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
State Brackets (state-tax-brackets)/api/v1/state-tax-brackets · /api/hrms/state-tax-brackets · /{id}list, get, create, change, deleteid uuid (read-only), tax_year* integer, state_code* text, filing_status text, bracket_no* integer, income_from* numeric, income_to numeric, base_tax numeric, rate* numeric, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
State Programs (state-payroll-programs)/api/v1/state-payroll-programs · /api/hrms/state-payroll-programs · /{id}list, get, create, change, deleteid uuid (read-only), tax_year* integer, state_code* text, program_code* text, name* text, program_type text, employee_rate numeric, employer_rate numeric, wage_base numeric, employee_max_weekly numeric, weekly_wage_cap numeric, wage_basis text, box14_label text, source_note text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
State Rates (state-tax-rates)/api/v1/state-tax-rates · /api/hrms/state-tax-rates · /{id}list, get, create, change, deleteid uuid (read-only), tax_year* integer, state_code* text, state_name text, has_income_tax boolean, flat_rate numeric, personal_exemption numeric, standard_deduction numeric, supplemental_rate numeric, suta_rate numeric, suta_wage_base numeric, disability_rate numeric (read-only), disability_wage_base numeric (read-only), paid_leave_rate numeric (read-only), reciprocity_states _text, method text, standard_deduction_married numeric, standard_deduction_hoh numeric, allowance_credit numeric, dependent_exemption numeric, low_income_exempt_single numeric, low_income_exempt_married numeric, federal_tax_deductible boolean, federal_deduction_cap numeric, resident_credit boolean, nonresidents_exempt boolean, source_note text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Tax Constants (tax-constants)/api/v1/tax-constants · /api/hrms/tax-constants · /{id}list, get, create, change, deleteid uuid (read-only), tax_year* integer, jurisdiction text, ss_rate numeric, ss_wage_base numeric, medicare_rate numeric, addl_medicare_rate numeric, addl_medicare_threshold numeric, futa_rate numeric, futa_wage_base numeric, suta_rate numeric (read-only), suta_wage_base numeric (read-only), supplemental_rate numeric, standard_deduction_single numeric (read-only), standard_deduction_married numeric (read-only), deferral_limit_401k numeric, catchup_limit_401k numeric, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Withholding Tables (tax-brackets)/api/v1/tax-brackets · /api/hrms/tax-brackets · /{id}list, get, create, change, deleteid uuid (read-only), tax_year* integer, jurisdiction text, filing_status* text, table_variant text, bracket_no* integer, income_from* numeric, income_to numeric, base_tax numeric, rate* numeric, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

勤怠管理

リソースEndpoints業務フィールズ
Clock Punches (time-punches)/api/v1/time-punches · /api/hrms/time-punches · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), employee_id uuid (read-only), employee_no text (read-only), employee_name text (read-only), manager_id uuid (read-only), punch_type text (read-only), status_code text (read-only), punched_at timestamp with time zone (read-only), work_date date (read-only), local_time time without time zone (read-only), time_zone text (read-only), source text (read-only), ip_address text (read-only), latitude numeric (read-only), longitude numeric (read-only), accuracy_m numeric (read-only), geo_status text (read-only), location_id uuid (read-only), location_code text (read-only), grant_id uuid (read-only), grant_code text (read-only), fund_id uuid (read-only), fund_code text (read-only), program_id uuid (read-only), program_code text (read-only), cost_center_id uuid (read-only), cost_center_code text (read-only), department text (read-only), is_void boolean (read-only), correction_id uuid (read-only), voided_by_correction_id uuid (read-only), time_entry_id uuid (read-only), notes text (read-only), recorded_by uuid (read-only), recorded_by_name text (read-only), recorded_time_zone text (read-only), recorded_local_time time without time zone (read-only)
Overtime Rules (overtime-rules)/api/v1/overtime-rules · /api/hrms/overtime-rules · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, jurisdiction text, applies_to text, union_code text, daily_threshold numeric, daily_double_threshold numeric, weekly_threshold numeric, seventh_day_rule boolean, seventh_day_double_after numeric, overtime_multiplier numeric, double_multiplier numeric, paid_leave_counts boolean, week_starts_on integer, priority integer, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), country text, premium_basis text, public_employer_applies boolean
Punch Corrections (punch-corrections)/api/v1/punch-corrections · /api/hrms/punch-corrections · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), correction_no text (read-only), employee_id uuid (read-only), employee_no text (read-only), employee_name text (read-only), manager_id uuid (read-only), action text (read-only), punch_id uuid (read-only), punch_type text (read-only), status_code text (read-only), corrected_at timestamp with time zone (read-only), original_at timestamp with time zone (read-only), reason text (read-only), status text (read-only), requested_by uuid (read-only), requested_by_name text (read-only), requested_at timestamp with time zone (read-only), decided_by uuid (read-only), decided_by_name text (read-only), decided_at timestamp with time zone (read-only), decision_note text (read-only), applied_punch_id uuid (read-only)
Roster (shift-assignments)/api/v1/shift-assignments · /api/hrms/shift-assignments · /{id}list, get, create, change, deleteid uuid (read-only), employee_id* uuid, shift_id* uuid, work_date* date, status text, swapped_with uuid, notes text, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Schedule Assignments (employee-schedules)/api/v1/employee-schedules · /api/hrms/employee-schedules · /{id}list, get, create, change, deleteid uuid (read-only), employee_id* uuid, schedule_id* uuid, effective_from* date, effective_to date, cycle_offset integer, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Shifts (shifts)/api/v1/shifts · /api/hrms/shifts · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, start_time* time without time zone, end_time* time without time zone, break_minutes integer, premium_earning_code text, premium_percent numeric, premium_amount numeric, crosses_midnight boolean, min_staff integer, location_id uuid, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Time Entries (time-entries)/api/v1/time-entries · /api/hrms/time-entries · /{id}list, get, create, change, deleteid uuid (read-only), employee_id* uuid, work_date* date, hours* numeric, entry_type text, project_ref text, status text, approved_by uuid (read-only), cost_center_id uuid, profit_center_id uuid (read-only), timesheet_id uuid (read-only), shift_id uuid (read-only), start_time time without time zone (read-only), end_time time without time zone (read-only), break_minutes integer (read-only), premium_type text (read-only), regular_hours numeric (read-only), overtime_hours numeric (read-only), double_hours numeric (read-only), evaluation_basis text (read-only), work_order_id uuid (read-only), notes text (read-only), approved_at timestamp with time zone (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), fund_id uuid, grant_id uuid, program_id uuid, location_id uuid, department text, source text (read-only), raw_start_time time without time zone (read-only), raw_end_time time without time zone (read-only), raw_hours numeric (read-only), rounding_basis text (read-only), premium_earning_code text (read-only), premium_hours numeric (read-only), premium_multiplier numeric (read-only), premium_amount numeric (read-only), premium_basis text (read-only)
Time Exceptions (time-exceptions)/api/v1/time-exceptions · /api/hrms/time-exceptions · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), employee_id uuid (read-only), manager_id uuid (read-only), work_date date (read-only), kind text (read-only), detail text (read-only), hours numeric (read-only), status text, resolution text, resolved_by uuid (read-only), resolved_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Time Policies (time-policies)/api/v1/time-policies · /api/hrms/time-policies · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, description text, pay_group_id uuid, overtime_rule_id uuid, location_id uuid, is_default boolean, punch_policy text, geolocation text, round_interval_minutes integer, round_method text, round_grace_start_minutes integer, round_grace_end_minutes integer, holiday_premium_earning_code text, holiday_premium_multiplier numeric, holiday_premium_flat_amount numeric, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Timesheets (timesheets)/api/v1/timesheets · /api/hrms/timesheets · /{id}list, getid uuid (read-only), timesheet_no text (read-only), employee_id uuid (read-only), employee_no text (read-only), employee_name text (read-only), period_start date (read-only), period_end date (read-only), status text (read-only), total_hours numeric (read-only), regular_hours numeric (read-only), overtime_hours numeric (read-only), double_hours numeric (read-only), leave_hours numeric (read-only), holiday_hours numeric (read-only), overtime_rule text (read-only), overtime_rule_name text (read-only), evaluated_at timestamp with time zone (read-only), submitted_at timestamp with time zone (read-only), approved_at timestamp with time zone (read-only), approved_by_name text (read-only), entries integer (read-only), standing text (read-only)
Work Schedules (work-schedules)/api/v1/work-schedules · /api/hrms/work-schedules · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, description text, cycle_days integer, hours_per_week numeric, is_rotating boolean, country text, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

出張・経費報告書

リソースEndpoints業務フィールズ
Corporate Cards (corporate-cards)/api/v1/corporate-cards · /api/hrms/corporate-cards · /{id}list, get, create, change, deleteid uuid (read-only), card_no_last4* text, card_brand text, employee_id uuid, bank_account_id uuid, monthly_limit numeric, status text, issued_on date, expires_on date, org_unit_id uuid (read-only), card_type text, issuer text, liability text, cost_center_id uuid, currency text, credit_limit numeric, single_txn_limit numeric, cancelled_on date, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Expense Policy (expense-policies)/api/v1/expense-policies · /api/hrms/expense-policies · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, expense_type* text, max_amount numeric, max_per_day numeric, requires_receipt_above numeric, requires_approval_above numeric, requires_pre_approval boolean, gl_account_id uuid, guidance text, is_active boolean, org_unit_id uuid (read-only), expense_type_id uuid, country text, city text, grade text, worker_type text, currency text, limit_type text, limit_amount numeric, enforcement text, approver_role text, justification_required boolean, advance_days_required integer, cabin_class_allowed text, flight_hours_threshold numeric, valid_from date, valid_to date, priority integer, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Expense Reports (expense-reports)/api/v1/expense-reports · /api/hrms/expense-reports · /{id}list, get, create, change, deleteid uuid (read-only), report_no text (read-only), employee_id uuid, travel_request_id uuid, title* text, period_start date, period_end date, currency text, total_amount numeric (read-only), reimbursable numeric (read-only), company_paid numeric (read-only), advance_applied numeric, violation_count integer (read-only), cost_center_id uuid, status text (read-only), submitted_at timestamp with time zone (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), rejection_reason text (read-only), journal_id uuid (read-only), org_unit_id uuid (read-only), claimant_id uuid, submitted_on_behalf boolean, project_id uuid, wbs_element_id uuid, period_code text, total_approved numeric (read-only), due_to_company numeric (read-only), tax_reclaimable numeric (read-only), billable_amount numeric (read-only), audit_status text (read-only), audit_reason text (read-only), auditor_id uuid (read-only), audited_at timestamp with time zone (read-only), audit_findings text (read-only), risk_score numeric (read-only), policy_violations jsonb (read-only), ap_invoice_id uuid (read-only), ap_payment_id uuid (read-only), payroll_run_id uuid (read-only), paid_at timestamp with time zone (read-only), notes text, exchange_rate numeric (read-only), base_total_amount numeric (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Per Diem Rates (per-diem-rates)/api/v1/per-diem-rates · /api/hrms/per-diem-rates · /{id}list, get, create, change, deleteid uuid (read-only), country text, city text, currency text, lodging numeric, meals numeric, incidentals numeric, valid_from date, valid_to date, org_unit_id uuid (read-only), code text, name text, region text, grade text, breakfast_deduction_pct numeric, lunch_deduction_pct numeric, dinner_deduction_pct numeric, first_last_day_pct numeric, tax_free_limit numeric, source text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Travel Requests (travel-requests)/api/v1/travel-requests · /api/hrms/travel-requests · /{id}list, get, create, change, deleteid uuid (read-only), request_no text (read-only), employee_id uuid, purpose* text, destination text, country text, depart_on date, return_on date, estimated_cost numeric, advance_requested numeric, cost_center_id uuid, project_ref text, status text (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), rejection_reason text (read-only), org_unit_id uuid (read-only), requested_by uuid, trip_type text, city text, days integer, currency text, project_id uuid, wbs_element_id uuid, account_id uuid, is_billable boolean, estimated_airfare numeric, estimated_hotel numeric, estimated_other numeric, advance_paid numeric (read-only), advance_recovered numeric (read-only), advance_journal_id uuid (read-only), policy_violations jsonb (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), submitted_at timestamp with time zone (read-only), approver_id uuid (read-only), approver_role text (read-only), routing_note text (read-only), completed_at timestamp with time zone (read-only), cancelled_at timestamp with time zone (read-only), cancel_reason text (read-only)

US Employment Forms

リソースEndpoints業務フィールズ
FMLA Cases (fmla-cases)/api/v1/fmla-cases · /api/hrms/fmla-cases · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), case_no text (read-only), employee_id uuid (read-only), reason text (read-only), family_relation text (read-only), leave_pattern text (read-only), start_date date (read-only), end_date date (read-only), reduced_hours_per_week numeric (read-only), intermittent_estimate text (read-only), employee_note text (read-only), status text (read-only), eligible boolean (read-only), eligibility jsonb (read-only), hours_per_week numeric (read-only), entitlement_hours numeric (read-only), certification_due date (read-only), certification_document_id uuid (read-only), certification_received_at timestamp with time zone (read-only), certification_status text (read-only), eligibility_notice_id uuid (read-only), designation_notice_id uuid (read-only), designated_by uuid (read-only), designated_at timestamp with time zone (read-only), decision_note text (read-only), requested_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
FMLA Settings (fmla-settings)/api/v1/fmla-settings · /api/hrms/fmla-settings · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), entitlement_weeks numeric, caregiver_weeks numeric, year_method text, fixed_year_start text, concurrent_paid_leave boolean, min_service_months integer, min_hours numeric, worksite_50_in_75 boolean, default_hours_per_week numeric, certification_days integer, leave_type_id uuid, hr_contact text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Form I-9 (i9-records)/api/v1/i9-records · /api/hrms/i9-records · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), record_no text (read-only), employee_id uuid (read-only), tax_form_id uuid (read-only), first_day date (read-only), section1_due date (read-only), section2_due date (read-only), status text (read-only), last_name text (read-only), first_name text (read-only), middle_initial text (read-only), other_last_names text (read-only), address_line text (read-only), apt_number text (read-only), city text (read-only), state_code text (read-only), postal_code text (read-only), date_of_birth date (read-only), ssn_last4 text (read-only), email text (read-only), phone text (read-only), citizenship_status text (read-only), a_number_cipher bytea (read-only), a_number_last4 text (read-only), uscis_number_cipher bytea (read-only), uscis_number_last4 text (read-only), i94_number_cipher bytea (read-only), i94_number_last4 text (read-only), passport_number_cipher bytea (read-only), passport_number_last4 text (read-only), passport_country text (read-only), work_auth_expires date (read-only), preparer_used boolean (read-only), preparers jsonb (read-only), s1_signed_name text (read-only), s1_signed_at timestamp with time zone (read-only), s1_signed_ip text (read-only), s1_sha256 text (read-only), document_choice text (read-only), s2_first_day date (read-only), s2_signer_id uuid (read-only), s2_signer_name text (read-only), s2_signer_title text (read-only), s2_employer_name text (read-only), s2_employer_address text (read-only), s2_signed_at timestamp with time zone (read-only), s2_sha256 text (read-only), alt_procedure boolean (read-only), additional_info text (read-only), reverification_due date (read-only), late_reason text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
W-4 Submissions (w4-submissions)/api/v1/w4-submissions · /api/hrms/w4-submissions · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), submission_no text (read-only), employee_id uuid (read-only), tax_year integer (read-only), filing_status text (read-only), multiple_jobs boolean (read-only), children_under17 integer (read-only), other_dependents integer (read-only), dependents_amount numeric (read-only), other_income numeric (read-only), deductions numeric (read-only), extra_withholding numeric (read-only), exempt boolean (read-only), effective_from date (read-only), tax_setup_id uuid (read-only), previous_setup_id uuid (read-only), tax_form_id uuid (read-only), document_id uuid (read-only), signed_name text (read-only), signed_at timestamp with time zone (read-only), signed_ip text (read-only), signed_user_agent text (read-only), attestation text (read-only), content_sha256 text (read-only), status text (read-only), acknowledged_by uuid (read-only), acknowledged_at timestamp with time zone (read-only), hr_note text (read-only), submitted_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)