@dsptch-work/api-client 0.12.0 → 0.13.0

package/dist/gen/types.gen.d.ts

@@ -5924,6 +5924,59 @@ export type ComplianceCheckParameters = {
      */
     time_due?: string | null;
 };
+/**
+ * One compliance requirement from the catalog. Requirements ship with the application, so the catalog reads the same for every company.
+ */
+export type ComplianceRequirementResponseObject = {
+    /**
+     * Unique identifier.
+     */
+    id: string;
+    /**
+     * Stable identifier for the requirement, as a class name. Unlike id, it is the same value in every environment, so hard-code this rather than a UUID when you need to address one requirement.
+     */
+    type: string;
+    /**
+     * Human-readable name of the requirement.
+     */
+    title: string;
+    /**
+     * Long-form explanation of what the requirement asks for and why it exists.
+     */
+    description: string;
+    /**
+     * The kind of record this requirement is checked against: a company, job, project, time card, pay period, user, or user employment. Only company, job, and project checks reach the company todos page.
+     */
+    target: 'Company' | 'Job' | 'Project' | 'Timekeeping::TimeCard' | 'Timekeeping::PayPeriod' | 'User' | 'UserCompany';
+    /**
+     * Grouping used for display and filtering.
+     */
+    category: 'apprenticeship' | 'certified_payroll' | 'company' | 'job' | 'payroll' | 'project' | 'regional' | 'tax_credit' | 'timekeeping' | 'worker';
+    /**
+     * Point in the compliance lifecycle at which the requirement applies.
+     */
+    phase: 'after_pay_date' | 'before_approval_deadline' | 'close_out' | 'maintenance' | 'onboarding' | 'setup';
+    /**
+     * How urgent a failure is; null when the requirement declares none.
+     */
+    priority: 'critical' | 'high' | 'medium' | 'low' | null;
+    /**
+     * The regulation or program the requirement derives from; null when it declares none.
+     */
+    requisite: 'apprenticeship' | 'best_practice' | 'dsptch' | 'federal_pwa' | 'ira' | 'ira_tax_credit' | 'payroll' | 'pwa' | 'regional_pwa' | 'timekeeping' | 'wh347' | null;
+    /**
+     * Display order within the requirement's phase; ties are common and broken by the caller.
+     */
+    sort_order: number;
+    /**
+     * When the record was created (ISO 8601).
+     */
+    created_at: string;
+    /**
+     * When the record was last updated (ISO 8601).
+     */
+    updated_at: string;
+};
 /**
  * A page of paystubs, with pagination metadata and navigation links.
  */
@@ -6009,7 +6062,7 @@ export type PaystubLineItemsResponseObject = {
     data: Array<PaystubLineItemResponseObject>;
 };
 /**
- * An adjustment applied in the current pay period to correct a prior one, tied to the paystub line item it corrects. Read-only.
+ * An adjustment applied in the current pay period to correct a prior one, tied to the paystub line item it corrects.
  */
 export type PriorPeriodAdjustmentResponseObject = {
     /**
@@ -6065,6 +6118,141 @@ export type PriorPeriodAdjustmentResponseObject = {
      */
     updated_at: string;
 };
+/**
+ * Request body for allocating part of a retroactive-pay line item to an earlier time card. The time card comes from the path; the adjustment is always a retroactive increase.
+ */
+export type PriorPeriodAdjustmentParameters = {
+    /**
+     * ID of the retroactive-pay line item funding this adjustment — one of the line items listed by the time card's adjustable line items endpoint. Required.
+     */
+    payrolls_paystub_line_item_id: string;
+    /**
+     * ID of the user recording the adjustment; must belong to the authenticated company. Required.
+     */
+    created_by_user_id: string;
+    /**
+     * Adjustment amount, in cents as a decimal string (e.g. "20000.0" is $200.00). Must be positive and may not exceed the line item's remaining adjustable_amount_cents. Required.
+     */
+    amount_cents: string;
+    /**
+     * Why the adjustment is being made: one of hours_correction, rate_correction, pwa_compliance, or other. Required.
+     */
+    rationale: 'hours_correction' | 'other' | 'pwa_compliance' | 'rate_correction';
+    /**
+     * ID of the job on the time card whose obligation this adjustment credits. Required whenever pwa_compliance_eligible is true, since compliance matches adjustments to obligations per job.
+     */
+    job_id?: string | null;
+    /**
+     * Free-text notes on the adjustment.
+     */
+    notes?: string | null;
+    /**
+     * Whether the adjustment counts toward prevailing-wage / apprenticeship (PWA) compliance. Defaults to true.
+     */
+    pwa_compliance_eligible?: boolean;
+};
+/**
+ * What one PWA-tracked job on a time card still owes the worker, from the materialized prevailing-wage compliance view. Read-only.
+ */
+export type PwaComplianceResponseObject = {
+    /**
+     * ID of the time card these figures cover.
+     */
+    timekeeping_time_card_id: string;
+    /**
+     * ID of the pay period the time card belongs to.
+     */
+    timekeeping_pay_period_id: string;
+    /**
+     * ID of the job whose obligation these figures cover.
+     */
+    job_id: string;
+    /**
+     * ID of the worker the obligation is owed to.
+     */
+    user_id: string;
+    /**
+     * Minutes worked on this job that count toward prevailing-wage obligations.
+     */
+    pwa_minutes_worked: number;
+    /**
+     * Federal obligation still outstanding including accrued interest, in cents as a decimal string, before crediting back pay.
+     */
+    federal_post_interest_outstanding_cents: string;
+    /**
+     * Regional (state) obligation still outstanding including accrued interest, in cents as a decimal string, before crediting back pay.
+     */
+    regional_post_interest_outstanding_cents: string;
+    /**
+     * Back pay already allocated to this job on this time card, in cents as a decimal string.
+     */
+    pwa_adjustments_cents: string;
+    /**
+     * Federal balance still due after crediting back pay, in cents as a decimal string.
+     */
+    federal_balance_due_cents: string;
+    /**
+     * Regional balance still due after crediting back pay, in cents as a decimal string.
+     */
+    regional_balance_due_cents: string;
+    /**
+     * The amount that settles every jurisdiction at once, in cents as a decimal string — corrections credit the federal and regional balances equally, so paying the larger clears both. Interest keeps accruing until the correcting payroll run's date, so a later payment has to clear more than this.
+     */
+    balance_due_cents: string;
+    /**
+     * Whether every payroll actual behind these figures has landed. When false, the balances read zero because the data is incomplete, not because the job is compliant.
+     */
+    all_actuals_exist: boolean;
+    /**
+     * Whether the job is settled — true only when actuals are complete and no balance is due.
+     */
+    compliant: boolean;
+};
+/**
+ * A retroactive-pay line item that can fund a prior period adjustment on the time card it was requested for. Read-only.
+ */
+export type AdjustableLineItemResponseObject = {
+    /**
+     * Unique identifier.
+     */
+    id: string;
+    /**
+     * ID of the paystub carrying this line item.
+     */
+    payrolls_paystub_id: string | null;
+    /**
+     * ID of the payroll run the paystub was produced by. Its run date is the correction date for compliance timeliness.
+     */
+    payrolls_payroll_run_id: string | null;
+    /**
+     * ID of the external map defining which compensation element this line item represents.
+     */
+    payrolls_external_map_id: string;
+    /**
+     * ID of the worker paid this line item.
+     */
+    user_id: string | null;
+    /**
+     * Full amount of the line item, in cents as a decimal string (e.g. "50000.0" is $500.00).
+     */
+    amount_cents: string;
+    /**
+     * Who contributes this amount: employee or employer.
+     */
+    contributor: 'employee' | 'employer';
+    /**
+     * What is left to allocate, in cents as a decimal string — the line item's amount less every adjustment already funded by it. A new adjustment may not exceed this.
+     */
+    adjustable_amount_cents: string;
+    /**
+     * When the record was created (ISO 8601).
+     */
+    created_at: string;
+    /**
+     * When the record was last updated (ISO 8601).
+     */
+    updated_at: string;
+};
 /**
  * What a worker was actually paid for a pay period, derived from imported paystub line items — gross and net pay, employee deductions (taxes, insurance, savings, garnishments), and employer contributions. Read-only. Every amount is a decimal string of cents.
  */
@@ -13552,6 +13740,90 @@ export type UpdateCheckResponses = {
     200: ComplianceCheckResponseObject;
 };
 export type UpdateCheckResponse = UpdateCheckResponses[keyof UpdateCheckResponses];
+export type ListRequirementsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Fuzzy match against the requirement title
+         */
+        'filter[search]'?: string;
+        /**
+         * Filter by requirement type (its STI class name)
+         */
+        'filter[type]'?: string;
+        /**
+         * Filter by requirement category:
+         * * `apprenticeship`
+         * * `certified_payroll`
+         * * `company`
+         * * `job`
+         * * `payroll`
+         * * `project`
+         * * `regional`
+         * * `tax_credit`
+         * * `timekeeping`
+         * * `worker`
+         *
+         */
+        'filter[category]'?: string;
+        /**
+         * Filter by the compliance phase the requirement belongs to
+         */
+        'filter[phase]'?: string;
+        /**
+         * Filter by requirement priority
+         */
+        'filter[priority]'?: string;
+        /**
+         * Filter by the regulation the requirement derives from
+         */
+        'filter[requisite]'?: string;
+        /**
+         * Filter by the record type the requirement is checked against
+         */
+        'filter[target]'?: string;
+        filter?: string;
+        'filter[unexpected]'?: string;
+        /**
+         * This pagination cursor corresponds to the cursor value found in the response in
+         * `meta.page.next_cursor`.
+         */
+        'page[cursor]'?: string;
+        /**
+         * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
+         */
+        'page[limit]'?: number;
+        page?: string;
+    };
+    url: '/api/v1/compliance/requirements';
+};
+export type ListRequirementsErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type ListRequirementsError = ListRequirementsErrors[keyof ListRequirementsErrors];
+export type ListRequirementsResponses = {
+    /**
+     * Success
+     */
+    200: {
+        meta: Meta;
+        links: Links;
+        data: Array<ComplianceRequirementResponseObject>;
+    };
+};
+export type ListRequirementsResponse = ListRequirementsResponses[keyof ListRequirementsResponses];
 export type ListCustomFieldConfigsData = {
     body?: never;
     path?: never;
@@ -17121,6 +17393,57 @@ export type ListTemplatesResponses = {
     };
 };
 export type ListTemplatesResponse = ListTemplatesResponses[keyof ListTemplatesResponses];
+export type ListAdjustableLineItemsData = {
+    body?: never;
+    path: {
+        time_card_id: string;
+    };
+    query?: {
+        /**
+         * Filter by paystub
+         */
+        'filter[payrolls_paystub_id]'?: string;
+        /**
+         * This pagination cursor corresponds to the cursor value found in the response in
+         * `meta.page.next_cursor`.
+         */
+        'page[cursor]'?: string;
+        /**
+         * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
+         */
+        'page[limit]'?: number;
+        page?: string;
+        filter?: string;
+        'filter[unexpected]'?: string;
+    };
+    url: '/api/v1/time_cards/{time_card_id}/adjustable_line_items';
+};
+export type ListAdjustableLineItemsErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type ListAdjustableLineItemsError = ListAdjustableLineItemsErrors[keyof ListAdjustableLineItemsErrors];
+export type ListAdjustableLineItemsResponses = {
+    /**
+     * Success
+     */
+    200: {
+        meta: Meta;
+        links: Links;
+        data: Array<AdjustableLineItemResponseObject>;
+    };
+};
+export type ListAdjustableLineItemsResponse = ListAdjustableLineItemsResponses[keyof ListAdjustableLineItemsResponses];
 export type SetTimeCardLockData = {
     body: TimeCardLockParameters;
     path: {
@@ -17366,6 +17689,67 @@ export type ListPriorPeriodAdjustmentsResponses = {
     };
 };
 export type ListPriorPeriodAdjustmentsResponse = ListPriorPeriodAdjustmentsResponses[keyof ListPriorPeriodAdjustmentsResponses];
+export type CreatePriorPeriodAdjustmentData = {
+    body: PriorPeriodAdjustmentParameters;
+    path: {
+        time_card_id: string;
+    };
+    query?: never;
+    url: '/api/v1/time_cards/{time_card_id}/prior_period_adjustments';
+};
+export type CreatePriorPeriodAdjustmentErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type CreatePriorPeriodAdjustmentError = CreatePriorPeriodAdjustmentErrors[keyof CreatePriorPeriodAdjustmentErrors];
+export type CreatePriorPeriodAdjustmentResponses = {
+    /**
+     * Created
+     */
+    201: PriorPeriodAdjustmentResponseObject;
+};
+export type CreatePriorPeriodAdjustmentResponse = CreatePriorPeriodAdjustmentResponses[keyof CreatePriorPeriodAdjustmentResponses];
+export type DeletePriorPeriodAdjustmentData = {
+    body?: never;
+    path: {
+        time_card_id: string;
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/time_cards/{time_card_id}/prior_period_adjustments/{id}';
+};
+export type DeletePriorPeriodAdjustmentErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type DeletePriorPeriodAdjustmentError = DeletePriorPeriodAdjustmentErrors[keyof DeletePriorPeriodAdjustmentErrors];
+export type DeletePriorPeriodAdjustmentResponses = {
+    /**
+     * Success
+     */
+    200: PriorPeriodAdjustmentResponseObject;
+};
+export type DeletePriorPeriodAdjustmentResponse = DeletePriorPeriodAdjustmentResponses[keyof DeletePriorPeriodAdjustmentResponses];
 export type GetPriorPeriodAdjustmentData = {
     body?: never;
     path: {
@@ -17393,6 +17777,57 @@ export type GetPriorPeriodAdjustmentResponses = {
     200: PriorPeriodAdjustmentResponseObject;
 };
 export type GetPriorPeriodAdjustmentResponse = GetPriorPeriodAdjustmentResponses[keyof GetPriorPeriodAdjustmentResponses];
+export type ListPwaCompliancesData = {
+    body?: never;
+    path: {
+        time_card_id: string;
+    };
+    query?: {
+        /**
+         * Filter by job
+         */
+        'filter[job_id]'?: string;
+        /**
+         * This pagination cursor corresponds to the cursor value found in the response in
+         * `meta.page.next_cursor`.
+         */
+        'page[cursor]'?: string;
+        /**
+         * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
+         */
+        'page[limit]'?: number;
+        page?: string;
+        filter?: string;
+        'filter[unexpected]'?: string;
+    };
+    url: '/api/v1/time_cards/{time_card_id}/pwa_compliances';
+};
+export type ListPwaCompliancesErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type ListPwaCompliancesError = ListPwaCompliancesErrors[keyof ListPwaCompliancesErrors];
+export type ListPwaCompliancesResponses = {
+    /**
+     * Success
+     */
+    200: {
+        meta: Meta;
+        links: Links;
+        data: Array<PwaComplianceResponseObject>;
+    };
+};
+export type ListPwaCompliancesResponse = ListPwaCompliancesResponses[keyof ListPwaCompliancesResponses];
 export type CreateWorkerTimeCardApprovalData = {
     body: WorkerTimeCardApprovalParameters;
     path: {