@rippling/rippling-sdk 0.2.0-alpha.35 → 0.2.0-alpha.37

package/src/resources/earnings-inputs.ts

@@ -14,7 +14,7 @@ export class EarningsInputs extends APIResource {
   /**
    * A list of earnings-inputs.
    *
-   * - Requires: `Payroll API`
+   * - Requires: `Global Payroll`
    */
   list(
     options?: RequestOptions,

package/src/resources/index.ts

@@ -33,6 +33,20 @@ export {
   type CandidateListResponsesPageCursorURL,
 } from './candidates';
 export { Companies, type Company, type CompanyListParams, type CompaniesPageCursorURL } from './companies';
+export {
+  CompanyLegalEntities,
+  type CompanyLegalEntityListResponse,
+  type CompanyLegalEntityRetrieveResponse,
+  type CompanyLegalEntityListParams,
+  type CompanyLegalEntityListResponsesPageCursorURL,
+} from './company-legal-entities';
+export {
+  CompanyLegalEntityWorkers,
+  type CompanyLegalEntityWorkerListResponse,
+  type CompanyLegalEntityWorkerRetrieveResponse,
+  type CompanyLegalEntityWorkerListParams,
+  type CompanyLegalEntityWorkerListResponsesPageCursorURL,
+} from './company-legal-entity-workers';
 export {
   CompensationBandsDetails,
   type CompensationBandsDetailListResponse,
@@ -308,7 +322,7 @@ export {
   type PayrollRunRetrieveResponse,
   type PayrollRunListParams,
   type PayrollRunListResponsesPageCursorURL,
-} from './payroll-runs';
+} from './payroll-runs/payroll-runs';
 export {
   PlatformCapabilities,
   type PlatformCapabilityListResponse,

package/src/resources/legal-entities.ts

@@ -98,7 +98,7 @@ export interface LegalEntity {
    * considered a Professional Employment Organization (PEO). _ `EOR`: The legal
    * entity is considered an Employer of Record (EOR).
    */
-  management_type?: 'PEO' | 'EOR';
+  management_type?: 'PEO' | 'EOR' | 'COR';
 
   parent?: unknown;
 

package/src/resources/payroll-runs/index.ts

@@ -0,0 +1,15 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  PayrollRuns,
+  type PayrollRunListResponse,
+  type PayrollRunRetrieveResponse,
+  type PayrollRunListParams,
+  type PayrollRunListResponsesPageCursorURL,
+} from './payroll-runs';
+export {
+  WorkerPayrollRecords,
+  type WorkerPayrollRecordListResponse,
+  type WorkerPayrollRecordListParams,
+  type WorkerPayrollRecordListResponsesPageCursorURL,
+} from './worker-payroll-records';

package/src/resources/payroll-runs/payroll-runs.ts

@@ -0,0 +1,270 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as BusinessPartnersAPI from '../business-partners';
+import * as WorkerPayrollRecordsAPI from './worker-payroll-records';
+import {
+  WorkerPayrollRecordListParams,
+  WorkerPayrollRecordListResponse,
+  WorkerPayrollRecordListResponsesPageCursorURL,
+  WorkerPayrollRecords,
+} from './worker-payroll-records';
+import { APIPromise } from '../../core/api-promise';
+import { PageCursorURL, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Payroll runs for the company
+ */
+export class PayrollRuns extends APIResource {
+  workerPayrollRecords: WorkerPayrollRecordsAPI.WorkerPayrollRecords =
+    new WorkerPayrollRecordsAPI.WorkerPayrollRecords(this._client);
+
+  /**
+   * A list of payroll-runs.
+   *
+   * - Requires: `Global Payroll`
+   * - Sortable fields: `check_date`
+   */
+  list(
+    query: PayrollRunListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PayrollRunListResponsesPageCursorURL, PayrollRunListResponse> {
+    return this._client.getAPIList('/payroll-runs/', PageCursorURL<PayrollRunListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Retrieve a specific payroll-run
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<PayrollRunRetrieveResponse> {
+    return this._client.get(path`/payroll-runs/${id}/`, options);
+  }
+}
+
+export type PayrollRunListResponsesPageCursorURL = PageCursorURL<PayrollRunListResponse>;
+
+/**
+ * V2 DTO representing a single payroll run.
+ *
+ *     Used by:
+ *       - GET /payroll-runs/      (list)
+ *       - GET /payroll-runs/{id}  (retrieve)
+ */
+export interface PayrollRunListResponse {
+  /**
+   * Unique identifier for the payroll run.
+   */
+  id?: string;
+
+  /**
+   * Deadline for approving the payroll run.
+   */
+  approval_deadline?: string;
+
+  /**
+   * Timestamp when the run was approved.
+   */
+  approved_at?: string;
+
+  /**
+   * Date the paycheck is issued.
+   */
+  check_date?: string;
+
+  /**
+   * Identifier linking this payroll run to the company's legal entity in the HRIS
+   * system.
+   */
+  company_entity_id?: string;
+
+  /**
+   * ISO country code where the payroll run applies.
+   */
+  country_code?: string;
+
+  /**
+   * Date funds are debited from the company's account.
+   */
+  debit_date?: string;
+
+  /**
+   * Deadline after which the run is locked for changes.
+   */
+  lock_deadline?: string;
+
+  /**
+   * Timestamp when the run was marked as paid.
+   */
+  paid_at?: string;
+
+  /**
+   * Pay period details for this run.
+   */
+  pay_period?: PayrollRunListResponse.PayPeriod;
+
+  /**
+   * Payment method used (e.g. WIRE, ACH).
+   */
+  payment_type?: string;
+
+  /**
+   * Current state of the run (e.g. DRAFT, PAID, APPROVED).
+   */
+  run_state?: string;
+
+  /**
+   * Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
+   */
+  run_type?: string;
+
+  /**
+   * Human-readable title of the payroll run.
+   */
+  title?: string;
+}
+
+export namespace PayrollRunListResponse {
+  /**
+   * Pay period details for this run.
+   */
+  export interface PayPeriod {
+    /**
+     * End date of the pay period.
+     */
+    end_date?: string;
+
+    /**
+     * Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
+     */
+    pay_frequency?: string;
+
+    /**
+     * Start date of the pay period.
+     */
+    start_date?: string;
+  }
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface PayrollRunRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Unique identifier for the payroll run.
+   */
+  id?: string;
+
+  /**
+   * Deadline for approving the payroll run.
+   */
+  approval_deadline?: string;
+
+  /**
+   * Timestamp when the run was approved.
+   */
+  approved_at?: string;
+
+  /**
+   * Date the paycheck is issued.
+   */
+  check_date?: string;
+
+  /**
+   * Identifier linking this payroll run to the company's legal entity in the HRIS
+   * system.
+   */
+  company_entity_id?: string;
+
+  /**
+   * ISO country code where the payroll run applies.
+   */
+  country_code?: string;
+
+  /**
+   * Date funds are debited from the company's account.
+   */
+  debit_date?: string;
+
+  /**
+   * Deadline after which the run is locked for changes.
+   */
+  lock_deadline?: string;
+
+  /**
+   * Timestamp when the run was marked as paid.
+   */
+  paid_at?: string;
+
+  /**
+   * Pay period details for this run.
+   */
+  pay_period?: PayrollRunRetrieveResponse.PayPeriod;
+
+  /**
+   * Payment method used (e.g. WIRE, ACH).
+   */
+  payment_type?: string;
+
+  /**
+   * Current state of the run (e.g. DRAFT, PAID, APPROVED).
+   */
+  run_state?: string;
+
+  /**
+   * Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
+   */
+  run_type?: string;
+
+  /**
+   * Human-readable title of the payroll run.
+   */
+  title?: string;
+}
+
+export namespace PayrollRunRetrieveResponse {
+  /**
+   * Pay period details for this run.
+   */
+  export interface PayPeriod {
+    /**
+     * End date of the pay period.
+     */
+    end_date?: string;
+
+    /**
+     * Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
+     */
+    pay_frequency?: string;
+
+    /**
+     * Start date of the pay period.
+     */
+    start_date?: string;
+  }
+}
+
+export interface PayrollRunListParams {
+  order_by?: string;
+}
+
+PayrollRuns.WorkerPayrollRecords = WorkerPayrollRecords;
+
+export declare namespace PayrollRuns {
+  export {
+    type PayrollRunListResponse as PayrollRunListResponse,
+    type PayrollRunRetrieveResponse as PayrollRunRetrieveResponse,
+    type PayrollRunListResponsesPageCursorURL as PayrollRunListResponsesPageCursorURL,
+    type PayrollRunListParams as PayrollRunListParams,
+  };
+
+  export {
+    WorkerPayrollRecords as WorkerPayrollRecords,
+    type WorkerPayrollRecordListResponse as WorkerPayrollRecordListResponse,
+    type WorkerPayrollRecordListResponsesPageCursorURL as WorkerPayrollRecordListResponsesPageCursorURL,
+    type WorkerPayrollRecordListParams as WorkerPayrollRecordListParams,
+  };
+}

package/src/resources/payroll-runs/worker-payroll-records.ts

@@ -0,0 +1,255 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { PageCursorURL, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Payroll runs for the company
+ */
+export class WorkerPayrollRecords extends APIResource {
+  /**
+   * A list of worker-payroll-records for a payroll run. Supports filtering by worker
+   * via `filter=worker_id in ('<id1>', '<id2>')`.
+   *
+   * - Requires: `Global Payroll`
+   */
+  list(
+    runID: string,
+    query: WorkerPayrollRecordListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<WorkerPayrollRecordListResponsesPageCursorURL, WorkerPayrollRecordListResponse> {
+    return this._client.getAPIList(
+      path`/payroll-runs/${runID}/worker-payroll-records/`,
+      PageCursorURL<WorkerPayrollRecordListResponse>,
+      { query, ...options },
+    );
+  }
+}
+
+export type WorkerPayrollRecordListResponsesPageCursorURL = PageCursorURL<WorkerPayrollRecordListResponse>;
+
+/**
+ * V2 DTO representing earnings, deductions, taxes, and garnishments
+ *     for a single worker in a payroll run.
+ *
+ *     Used by:
+ *       - GET /payroll-runs/{run_id}/worker-payroll-records/      (list)
+ *       - GET /payroll-runs/{run_id}/worker-payroll-records/{id}   (retrieve)
+ */
+export interface WorkerPayrollRecordListResponse {
+  /**
+   * Unique identifier for this payroll record (PRE version ID).
+   */
+  id?: string;
+
+  /**
+   * ISO country code where this payroll record applies.
+   */
+  country_code?: string;
+
+  /**
+   * ISO currency code for monetary amounts in this record.
+   */
+  currency?: string;
+
+  /**
+   * List of deduction line items.
+   */
+  deductions?: Array<WorkerPayrollRecordListResponse.Deduction>;
+
+  /**
+   * List of earning line items.
+   */
+  earnings?: Array<WorkerPayrollRecordListResponse.Earning>;
+
+  /**
+   * List of garnishment line items.
+   */
+  garnishments?: Array<WorkerPayrollRecordListResponse.Garnishment>;
+
+  /**
+   * Gross pay amount for the current period.
+   */
+  gross_pay?: string;
+
+  /**
+   * Net pay amount for the current period.
+   */
+  net_pay?: string;
+
+  /**
+   * Identifier of the payroll run this record belongs to.
+   */
+  run_id?: string;
+
+  /**
+   * Aggregate totals for taxes, deductions, and garnishments.
+   */
+  summary?: WorkerPayrollRecordListResponse.Summary;
+
+  /**
+   * List of tax line items.
+   */
+  taxes?: Array<WorkerPayrollRecordListResponse.Tax>;
+
+  /**
+   * Identifier of the worker (role ID).
+   */
+  worker_id?: string;
+}
+
+export namespace WorkerPayrollRecordListResponse {
+  /**
+   * A single deduction line item on a worker's payroll record.
+   */
+  export interface Deduction {
+    /**
+     * Code identifying the deduction type.
+     */
+    deduction_code?: string;
+
+    /**
+     * Human-readable name of the deduction.
+     */
+    display_name?: string;
+
+    /**
+     * Employee contribution amount for the current period.
+     */
+    employee_amount?: string;
+
+    /**
+     * Employer contribution amount for the current period.
+     */
+    employer_amount?: string;
+  }
+
+  /**
+   * A single earning line item on a worker's payroll record.
+   */
+  export interface Earning {
+    /**
+     * Earning amount for the current period.
+     */
+    amount?: string;
+
+    /**
+     * Human-readable name of the earning.
+     */
+    display_name?: string;
+
+    /**
+     * Category of the earning (e.g. SALARY, HOURLY).
+     */
+    earning_category?: string;
+
+    /**
+     * Code identifying the earning type (e.g. regular_salary).
+     */
+    earning_code?: string;
+
+    /**
+     * Hours worked for this earning in the current period.
+     */
+    hours?: string;
+
+    /**
+     * Hourly rate applied to this earning.
+     */
+    rate?: string;
+
+    /**
+     * Time tracking labels associated with this earning.
+     */
+    time_labels?: Array<string>;
+  }
+
+  /**
+   * A single garnishment line item on a worker's payroll record.
+   */
+  export interface Garnishment {
+    /**
+     * Garnishment amount for the current period.
+     */
+    amount?: string;
+
+    /**
+     * Code identifying the garnishment.
+     */
+    garnishment_code?: string;
+  }
+
+  /**
+   * Aggregate totals for taxes, deductions, and garnishments.
+   */
+  export interface Summary {
+    /**
+     * Total employee deductions.
+     */
+    employee_deductions?: string;
+
+    /**
+     * Total employee-paid taxes.
+     */
+    employee_taxes?: string;
+
+    /**
+     * Total employer contributions (e.g. retirement matching).
+     */
+    employer_contributions?: string;
+
+    /**
+     * Total employer-paid taxes.
+     */
+    employer_taxes?: string;
+
+    /**
+     * Total garnishments withheld.
+     */
+    total_garnishments?: string;
+  }
+
+  /**
+   * A single tax line item on a worker's payroll record.
+   */
+  export interface Tax {
+    /**
+     * Tax amount for the current period.
+     */
+    amount?: string;
+
+    /**
+     * Human-readable name of the tax.
+     */
+    display_name?: string;
+
+    /**
+     * Who pays this tax: EMPLOYER or EMPLOYEE.
+     */
+    paid_by?: string;
+
+    /**
+     * Unique code identifying the tax.
+     */
+    tax_code?: string;
+  }
+}
+
+export interface WorkerPayrollRecordListParams {
+  cursor?: string;
+
+  /**
+   * OData-style filter. Only `worker_id in ('<id1>', '<id2>', ...)` is supported.
+   */
+  filter?: string;
+}
+
+export declare namespace WorkerPayrollRecords {
+  export {
+    type WorkerPayrollRecordListResponse as WorkerPayrollRecordListResponse,
+    type WorkerPayrollRecordListResponsesPageCursorURL as WorkerPayrollRecordListResponsesPageCursorURL,
+    type WorkerPayrollRecordListParams as WorkerPayrollRecordListParams,
+  };
+}