@tryfinch/finch-api 6.30.0 → 7.0.0

package/resources/hris/pay-statements.d.mts

@@ -0,0 +1,268 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as HRISAPI from "./hris.mjs";
+import * as BenefitsAPI from "./benefits/benefits.mjs";
+import { PagePromise, ResponsesPage } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class PayStatements extends APIResource {
+    /**
+     * Read detailed pay statements for each individual.
+     *
+     * Deduction and contribution types are supported by the payroll systems that
+     * supports Benefits.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const payStatementResponse of client.hris.payStatements.retrieveMany(
+     *   {
+     *     requests: [
+     *       {
+     *         payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *       },
+     *     ],
+     *   },
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    retrieveMany(params: PayStatementRetrieveManyParams, options?: RequestOptions): PagePromise<PayStatementResponsesPage, PayStatementResponse>;
+}
+export type PayStatementResponsesPage = ResponsesPage<PayStatementResponse>;
+export interface PayStatement {
+    /**
+     * The array of earnings objects associated with this pay statement
+     */
+    earnings: Array<PayStatement.Earning | null> | null;
+    /**
+     * The array of deductions objects associated with this pay statement.
+     */
+    employee_deductions: Array<PayStatement.EmployeeDeduction> | null;
+    employer_contributions: Array<PayStatement.EmployerContribution> | null;
+    gross_pay: HRISAPI.Money | null;
+    /**
+     * A stable Finch `id` (UUID v4) for an individual in the company
+     */
+    individual_id: string;
+    net_pay: HRISAPI.Money | null;
+    /**
+     * The payment method.
+     */
+    payment_method: 'check' | 'direct_deposit' | 'other' | null;
+    /**
+     * The array of taxes objects associated with this pay statement.
+     */
+    taxes: Array<PayStatement.Tax> | null;
+    /**
+     * The number of hours worked for this pay period
+     */
+    total_hours: number | null;
+    /**
+     * The type of the payment associated with the pay statement.
+     */
+    type: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll' | null;
+}
+export declare namespace PayStatement {
+    interface Earning {
+        /**
+         * The earnings amount in cents.
+         */
+        amount: number | null;
+        /**
+         * The earnings currency code.
+         */
+        currency: string | null;
+        /**
+         * The number of hours associated with this earning. (For salaried employees, this
+         * could be hours per pay period, `0` or `null`, depending on the provider).
+         */
+        hours: number | null;
+        /**
+         * The exact name of the deduction from the pay statement.
+         */
+        name: string | null;
+        /**
+         * The type of earning.
+         */
+        type: 'salary' | 'wage' | 'reimbursement' | 'overtime' | 'severance' | 'double_overtime' | 'pto' | 'sick' | 'bonus' | 'commission' | 'tips' | '1099' | 'other' | null;
+        attributes?: Earning.Attributes | null;
+    }
+    namespace Earning {
+        interface Attributes {
+            /**
+             * The metadata to be attached to the entity by existing rules. It is a key-value
+             * pairs where the values can be of any type (string, number, boolean, object,
+             * array, etc.).
+             */
+            metadata: {
+                [key: string]: unknown;
+            };
+        }
+    }
+    interface EmployeeDeduction {
+        /**
+         * The deduction amount in cents.
+         */
+        amount: number | null;
+        /**
+         * The deduction currency.
+         */
+        currency: string | null;
+        /**
+         * The deduction name from the pay statement.
+         */
+        name: string | null;
+        /**
+         * Boolean indicating if the deduction is pre-tax.
+         */
+        pre_tax: boolean | null;
+        /**
+         * Type of benefit.
+         */
+        type: BenefitsAPI.BenefitType | null;
+        attributes?: EmployeeDeduction.Attributes | null;
+    }
+    namespace EmployeeDeduction {
+        interface Attributes {
+            /**
+             * The metadata to be attached to the entity by existing rules. It is a key-value
+             * pairs where the values can be of any type (string, number, boolean, object,
+             * array, etc.).
+             */
+            metadata: {
+                [key: string]: unknown;
+            };
+        }
+    }
+    interface EmployerContribution {
+        /**
+         * The contribution currency.
+         */
+        currency: string | null;
+        /**
+         * The contribution name from the pay statement.
+         */
+        name: string | null;
+        /**
+         * Type of benefit.
+         */
+        type: BenefitsAPI.BenefitType | null;
+        /**
+         * The contribution amount in cents.
+         */
+        amount?: number | null;
+        attributes?: EmployerContribution.Attributes | null;
+    }
+    namespace EmployerContribution {
+        interface Attributes {
+            /**
+             * The metadata to be attached to the entity by existing rules. It is a key-value
+             * pairs where the values can be of any type (string, number, boolean, object,
+             * array, etc.).
+             */
+            metadata: {
+                [key: string]: unknown;
+            };
+        }
+    }
+    interface Tax {
+        /**
+         * The currency code.
+         */
+        currency: string | null;
+        /**
+         * `true` if the amount is paid by the employers.
+         */
+        employer: boolean | null;
+        /**
+         * The exact name of tax from the pay statement.
+         */
+        name: string | null;
+        /**
+         * The type of taxes.
+         */
+        type: 'state' | 'federal' | 'local' | 'fica' | null;
+        /**
+         * The tax amount in cents.
+         */
+        amount?: number | null;
+        attributes?: Tax.Attributes | null;
+    }
+    namespace Tax {
+        interface Attributes {
+            /**
+             * The metadata to be attached to the entity by existing rules. It is a key-value
+             * pairs where the values can be of any type (string, number, boolean, object,
+             * array, etc.).
+             */
+            metadata: {
+                [key: string]: unknown;
+            };
+        }
+    }
+}
+export interface PayStatementDataSyncInProgress {
+    code: 202;
+    finch_code: 'data_sync_in_progress';
+    message: 'The pay statements for this payment are being fetched. Please check back later.';
+    name: 'accepted';
+}
+export interface PayStatementResponse {
+    body: PayStatementResponseBody | PayStatementResponse.BatchError | PayStatementDataSyncInProgress;
+    code: number;
+    payment_id: string;
+}
+export declare namespace PayStatementResponse {
+    interface BatchError {
+        code: number;
+        message: string;
+        name: string;
+        finch_code?: string;
+    }
+}
+export interface PayStatementResponseBody {
+    paging: PayStatementResponseBody.Paging;
+    pay_statements: Array<PayStatement>;
+}
+export declare namespace PayStatementResponseBody {
+    interface Paging {
+        /**
+         * The current start index of the returned list of elements
+         */
+        offset: number;
+        /**
+         * The total number of elements for the entire query (not just the given page)
+         */
+        count?: number;
+    }
+}
+export interface PayStatementRetrieveManyParams {
+    /**
+     * Body param: The array of batch requests.
+     */
+    requests: Array<PayStatementRetrieveManyParams.Request>;
+    /**
+     * Query param: The entity IDs to specify which entities' data to access.
+     */
+    entity_ids?: Array<string>;
+}
+export declare namespace PayStatementRetrieveManyParams {
+    interface Request {
+        /**
+         * A stable Finch `id` (UUID v4) for a payment.
+         */
+        payment_id: string;
+        /**
+         * Number of pay statements to return (defaults to all).
+         */
+        limit?: number;
+        /**
+         * Index to start from.
+         */
+        offset?: number;
+    }
+}
+export declare namespace PayStatements {
+    export { type PayStatement as PayStatement, type PayStatementDataSyncInProgress as PayStatementDataSyncInProgress, type PayStatementResponse as PayStatementResponse, type PayStatementResponseBody as PayStatementResponseBody, type PayStatementResponsesPage as PayStatementResponsesPage, type PayStatementRetrieveManyParams as PayStatementRetrieveManyParams, };
+}
+//# sourceMappingURL=pay-statements.d.mts.map

package/resources/hris/pay-statements.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pay-statements.d.mts","sourceRoot":"","sources":["../../src/resources/hris/pay-statements.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,WAAW;OAChB,EAAE,WAAW,EAAE,aAAa,EAAE;OAC9B,EAAE,cAAc,EAAE;AAEzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,CACV,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;CAShE;AAED,MAAM,MAAM,yBAAyB,GAAG,aAAa,CAAC,oBAAoB,CAAC,CAAC;AAE5E,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAEpD;;OAEG;IACH,mBAAmB,EAAE,KAAK,CAAC,YAAY,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAElE,sBAAsB,EAAE,KAAK,CAAC,YAAY,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC;IAExE,SAAS,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,OAAO,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,EAAE,OAAO,GAAG,gBAAgB,GAAG,OAAO,GAAG,IAAI,CAAC;IAE5D;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,mBAAmB,GAAG,kBAAkB,GAAG,iBAAiB,GAAG,IAAI,CAAC;CAC3E;AAED,yBAAiB,YAAY,CAAC;IAC5B,UAAiB,OAAO;QACtB;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,IAAI,EACA,QAAQ,GACR,MAAM,GACN,eAAe,GACf,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,KAAK,GACL,MAAM,GACN,OAAO,GACP,YAAY,GACZ,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,CAAC;QAET,UAAU,CAAC,EAAE,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;KACxC;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,UAAU;YACzB;;;;eAIG;YACH,QAAQ,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;SACtC;KACF;IAED,UAAiB,iBAAiB;QAChC;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,IAAI,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;QAErC,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,GAAG,IAAI,CAAC;KAClD;IAED,UAAiB,iBAAiB,CAAC;QACjC,UAAiB,UAAU;YACzB;;;;eAIG;YACH,QAAQ,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;SACtC;KACF;IAED,UAAiB,oBAAoB;QACnC;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;QAErC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,oBAAoB,CAAC,UAAU,GAAG,IAAI,CAAC;KACrD;IAED,UAAiB,oBAAoB,CAAC;QACpC,UAAiB,UAAU;YACzB;;;;eAIG;YACH,QAAQ,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;SACtC;KACF;IAED,UAAiB,GAAG;QAClB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;QAEpD;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;KACpC;IAED,UAAiB,GAAG,CAAC;QACnB,UAAiB,UAAU;YACzB;;;;eAIG;YACH,QAAQ,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;SACtC;KACF;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C,IAAI,EAAE,GAAG,CAAC;IAEV,UAAU,EAAE,uBAAuB,CAAC;IAEpC,OAAO,EAAE,iFAAiF,CAAC;IAE3F,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,wBAAwB,GAAG,oBAAoB,CAAC,UAAU,GAAG,8BAA8B,CAAC;IAElG,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,UAAU;QACzB,IAAI,EAAE,MAAM,CAAC;QAEb,OAAO,EAAE,MAAM,CAAC;QAEhB,IAAI,EAAE,MAAM,CAAC;QAEb,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,wBAAwB,CAAC,MAAM,CAAC;IAExC,cAAc,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;CACrC;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,MAAM;QACrB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC;IAExD;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,OAAO;QACtB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}

package/resources/hris/pay-statements.d.ts

@@ -1,9 +1,8 @@
-import { APIResource } from "../../resource.js";
-import * as Core from "../../core.js";
-import * as Shared from "../shared.js";
+import { APIResource } from "../../core/resource.js";
 import * as HRISAPI from "./hris.js";
 import * as BenefitsAPI from "./benefits/benefits.js";
-import { ResponsesPage } from "../../pagination.js";
+import { PagePromise, ResponsesPage } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
 export declare class PayStatements extends APIResource {
     /**
      * Read detailed pay statements for each individual.
@@ -27,211 +26,225 @@ export declare class PayStatements extends APIResource {
      * }
      * ```
      */
-    retrieveMany(body: PayStatementRetrieveManyParams, options?: Core.RequestOptions): Core.PagePromise<PayStatementResponsesPage, PayStatementResponse>;
-}
-export declare class PayStatementResponsesPage extends ResponsesPage<PayStatementResponse> {
+    retrieveMany(params: PayStatementRetrieveManyParams, options?: RequestOptions): PagePromise<PayStatementResponsesPage, PayStatementResponse>;
 }
+export type PayStatementResponsesPage = ResponsesPage<PayStatementResponse>;
 export interface PayStatement {
     /**
      * The array of earnings objects associated with this pay statement
      */
-    earnings?: Array<PayStatement.Earning | null> | null;
+    earnings: Array<PayStatement.Earning | null> | null;
     /**
      * The array of deductions objects associated with this pay statement.
      */
-    employee_deductions?: Array<PayStatement.EmployeeDeduction | null> | null;
-    employer_contributions?: Array<PayStatement.EmployerContribution | null> | null;
-    gross_pay?: HRISAPI.Money | null;
+    employee_deductions: Array<PayStatement.EmployeeDeduction> | null;
+    employer_contributions: Array<PayStatement.EmployerContribution> | null;
+    gross_pay: HRISAPI.Money | null;
     /**
      * A stable Finch `id` (UUID v4) for an individual in the company
      */
-    individual_id?: string;
-    net_pay?: HRISAPI.Money | null;
+    individual_id: string;
+    net_pay: HRISAPI.Money | null;
     /**
      * The payment method.
      */
-    payment_method?: 'check' | 'direct_deposit' | 'other' | null;
+    payment_method: 'check' | 'direct_deposit' | 'other' | null;
     /**
      * The array of taxes objects associated with this pay statement.
      */
-    taxes?: Array<PayStatement.Tax | null> | null;
+    taxes: Array<PayStatement.Tax> | null;
     /**
      * The number of hours worked for this pay period
      */
-    total_hours?: number | null;
+    total_hours: number | null;
     /**
      * The type of the payment associated with the pay statement.
      */
-    type?: 'regular_payroll' | 'off_cycle_payroll' | 'one_time_payment' | null;
+    type: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll' | null;
 }
 export declare namespace PayStatement {
     interface Earning {
         /**
          * The earnings amount in cents.
          */
-        amount?: number | null;
-        attributes?: Earning.Attributes | null;
+        amount: number | null;
         /**
          * The earnings currency code.
          */
-        currency?: string | null;
+        currency: string | null;
         /**
          * The number of hours associated with this earning. (For salaried employees, this
          * could be hours per pay period, `0` or `null`, depending on the provider).
          */
-        hours?: number | null;
+        hours: number | null;
         /**
          * The exact name of the deduction from the pay statement.
          */
-        name?: string | null;
+        name: string | null;
         /**
          * The type of earning.
          */
-        type?: 'salary' | 'wage' | 'reimbursement' | 'overtime' | 'severance' | 'double_overtime' | 'pto' | 'sick' | 'bonus' | 'commission' | 'tips' | '1099' | 'other' | null;
+        type: 'salary' | 'wage' | 'reimbursement' | 'overtime' | 'severance' | 'double_overtime' | 'pto' | 'sick' | 'bonus' | 'commission' | 'tips' | '1099' | 'other' | null;
+        attributes?: Earning.Attributes | null;
     }
     namespace Earning {
         interface Attributes {
-            metadata?: Attributes.Metadata;
-        }
-        namespace Attributes {
-            interface Metadata {
-                /**
-                 * The metadata to be attached to the entity by existing rules. It is a key-value
-                 * pairs where the values can be of any type (string, number, boolean, object,
-                 * array, etc.).
-                 */
-                metadata?: Record<string, unknown>;
-            }
+            /**
+             * The metadata to be attached to the entity by existing rules. It is a key-value
+             * pairs where the values can be of any type (string, number, boolean, object,
+             * array, etc.).
+             */
+            metadata: {
+                [key: string]: unknown;
+            };
         }
     }
     interface EmployeeDeduction {
         /**
          * The deduction amount in cents.
          */
-        amount?: number | null;
-        attributes?: EmployeeDeduction.Attributes | null;
+        amount: number | null;
         /**
          * The deduction currency.
          */
-        currency?: string | null;
+        currency: string | null;
         /**
          * The deduction name from the pay statement.
          */
-        name?: string | null;
+        name: string | null;
         /**
          * Boolean indicating if the deduction is pre-tax.
          */
-        pre_tax?: boolean | null;
+        pre_tax: boolean | null;
         /**
          * Type of benefit.
          */
-        type?: BenefitsAPI.BenefitType | null;
+        type: BenefitsAPI.BenefitType | null;
+        attributes?: EmployeeDeduction.Attributes | null;
     }
     namespace EmployeeDeduction {
         interface Attributes {
-            metadata?: Attributes.Metadata;
-        }
-        namespace Attributes {
-            interface Metadata {
-                /**
-                 * The metadata to be attached to the entity by existing rules. It is a key-value
-                 * pairs where the values can be of any type (string, number, boolean, object,
-                 * array, etc.).
-                 */
-                metadata?: Record<string, unknown>;
-            }
+            /**
+             * The metadata to be attached to the entity by existing rules. It is a key-value
+             * pairs where the values can be of any type (string, number, boolean, object,
+             * array, etc.).
+             */
+            metadata: {
+                [key: string]: unknown;
+            };
         }
     }
     interface EmployerContribution {
-        /**
-         * The contribution amount in cents.
-         */
-        amount?: number | null;
-        attributes?: EmployerContribution.Attributes | null;
         /**
          * The contribution currency.
          */
-        currency?: string | null;
+        currency: string | null;
         /**
          * The contribution name from the pay statement.
          */
-        name?: string | null;
+        name: string | null;
         /**
          * Type of benefit.
          */
-        type?: BenefitsAPI.BenefitType | null;
+        type: BenefitsAPI.BenefitType | null;
+        /**
+         * The contribution amount in cents.
+         */
+        amount?: number | null;
+        attributes?: EmployerContribution.Attributes | null;
     }
     namespace EmployerContribution {
         interface Attributes {
-            metadata?: Attributes.Metadata;
-        }
-        namespace Attributes {
-            interface Metadata {
-                /**
-                 * The metadata to be attached to the entity by existing rules. It is a key-value
-                 * pairs where the values can be of any type (string, number, boolean, object,
-                 * array, etc.).
-                 */
-                metadata?: Record<string, unknown>;
-            }
+            /**
+             * The metadata to be attached to the entity by existing rules. It is a key-value
+             * pairs where the values can be of any type (string, number, boolean, object,
+             * array, etc.).
+             */
+            metadata: {
+                [key: string]: unknown;
+            };
         }
     }
     interface Tax {
-        /**
-         * The tax amount in cents.
-         */
-        amount?: number | null;
-        attributes?: Tax.Attributes | null;
         /**
          * The currency code.
          */
-        currency?: string | null;
+        currency: string | null;
         /**
          * `true` if the amount is paid by the employers.
          */
-        employer?: boolean | null;
+        employer: boolean | null;
         /**
          * The exact name of tax from the pay statement.
          */
-        name?: string | null;
+        name: string | null;
         /**
          * The type of taxes.
          */
-        type?: 'state' | 'federal' | 'local' | 'fica' | null;
+        type: 'state' | 'federal' | 'local' | 'fica' | null;
+        /**
+         * The tax amount in cents.
+         */
+        amount?: number | null;
+        attributes?: Tax.Attributes | null;
     }
     namespace Tax {
         interface Attributes {
-            metadata?: Attributes.Metadata;
-        }
-        namespace Attributes {
-            interface Metadata {
-                /**
-                 * The metadata to be attached to the entity by existing rules. It is a key-value
-                 * pairs where the values can be of any type (string, number, boolean, object,
-                 * array, etc.).
-                 */
-                metadata?: Record<string, unknown>;
-            }
+            /**
+             * The metadata to be attached to the entity by existing rules. It is a key-value
+             * pairs where the values can be of any type (string, number, boolean, object,
+             * array, etc.).
+             */
+            metadata: {
+                [key: string]: unknown;
+            };
         }
     }
 }
+export interface PayStatementDataSyncInProgress {
+    code: 202;
+    finch_code: 'data_sync_in_progress';
+    message: 'The pay statements for this payment are being fetched. Please check back later.';
+    name: 'accepted';
+}
 export interface PayStatementResponse {
-    body?: PayStatementResponseBody;
-    code?: number;
-    payment_id?: string;
+    body: PayStatementResponseBody | PayStatementResponse.BatchError | PayStatementDataSyncInProgress;
+    code: number;
+    payment_id: string;
+}
+export declare namespace PayStatementResponse {
+    interface BatchError {
+        code: number;
+        message: string;
+        name: string;
+        finch_code?: string;
+    }
 }
 export interface PayStatementResponseBody {
-    paging?: Shared.Paging;
-    /**
-     * The array of pay statements for the current payment.
-     */
-    pay_statements?: Array<PayStatement>;
+    paging: PayStatementResponseBody.Paging;
+    pay_statements: Array<PayStatement>;
+}
+export declare namespace PayStatementResponseBody {
+    interface Paging {
+        /**
+         * The current start index of the returned list of elements
+         */
+        offset: number;
+        /**
+         * The total number of elements for the entire query (not just the given page)
+         */
+        count?: number;
+    }
 }
 export interface PayStatementRetrieveManyParams {
     /**
-     * The array of batch requests.
+     * Body param: The array of batch requests.
      */
     requests: Array<PayStatementRetrieveManyParams.Request>;
+    /**
+     * Query param: The entity IDs to specify which entities' data to access.
+     */
+    entity_ids?: Array<string>;
 }
 export declare namespace PayStatementRetrieveManyParams {
     interface Request {
@@ -250,6 +263,6 @@ export declare namespace PayStatementRetrieveManyParams {
     }
 }
 export declare namespace PayStatements {
-    export { type PayStatement as PayStatement, type PayStatementResponse as PayStatementResponse, type PayStatementResponseBody as PayStatementResponseBody, PayStatementResponsesPage as PayStatementResponsesPage, type PayStatementRetrieveManyParams as PayStatementRetrieveManyParams, };
+    export { type PayStatement as PayStatement, type PayStatementDataSyncInProgress as PayStatementDataSyncInProgress, type PayStatementResponse as PayStatementResponse, type PayStatementResponseBody as PayStatementResponseBody, type PayStatementResponsesPage as PayStatementResponsesPage, type PayStatementRetrieveManyParams as PayStatementRetrieveManyParams, };
 }
 //# sourceMappingURL=pay-statements.d.ts.map

package/resources/hris/pay-statements.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pay-statements.d.ts","sourceRoot":"","sources":["../../src/resources/hris/pay-statements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,OAAO,MAAM,QAAQ,CAAC;AAClC,OAAO,KAAK,WAAW,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,CACV,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;CAOrE;AAED,qBAAa,yBAA0B,SAAQ,aAAa,CAAC,oBAAoB,CAAC;CAAG;AAErF,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE1E,sBAAsB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAEhF,SAAS,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,gBAAgB,GAAG,OAAO,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,IAAI,CAAC;CAC5E;AAED,yBAAiB,YAAY,CAAC;IAC5B,UAAiB,OAAO;QACtB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EACD,QAAQ,GACR,MAAM,GACN,eAAe,GACf,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,KAAK,GACL,MAAM,GACN,OAAO,GACP,YAAY,GACZ,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,CAAC;KACV;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;IAED,UAAiB,iBAAiB;QAChC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,GAAG,IAAI,CAAC;QAEjD;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;KACvC;IAED,UAAiB,iBAAiB,CAAC;QACjC,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;IAED,UAAiB,oBAAoB;QACnC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,oBAAoB,CAAC,UAAU,GAAG,IAAI,CAAC;QAEpD;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;KACvC;IAED,UAAiB,oBAAoB,CAAC;QACpC,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;IAED,UAAiB,GAAG;QAClB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;KACtD;IAED,UAAiB,GAAG,CAAC;QACnB,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,wBAAwB,CAAC;IAEhC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC;CACzD;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,OAAO;QACtB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAID,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,yBAAyB,IAAI,yBAAyB,EACtD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
+{"version":3,"file":"pay-statements.d.ts","sourceRoot":"","sources":["../../src/resources/hris/pay-statements.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,WAAW;OAChB,EAAE,WAAW,EAAE,aAAa,EAAE;OAC9B,EAAE,cAAc,EAAE;AAEzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,CACV,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;CAShE;AAED,MAAM,MAAM,yBAAyB,GAAG,aAAa,CAAC,oBAAoB,CAAC,CAAC;AAE5E,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAEpD;;OAEG;IACH,mBAAmB,EAAE,KAAK,CAAC,YAAY,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAElE,sBAAsB,EAAE,KAAK,CAAC,YAAY,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC;IAExE,SAAS,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,OAAO,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,EAAE,OAAO,GAAG,gBAAgB,GAAG,OAAO,GAAG,IAAI,CAAC;IAE5D;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,mBAAmB,GAAG,kBAAkB,GAAG,iBAAiB,GAAG,IAAI,CAAC;CAC3E;AAED,yBAAiB,YAAY,CAAC;IAC5B,UAAiB,OAAO;QACtB;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,IAAI,EACA,QAAQ,GACR,MAAM,GACN,eAAe,GACf,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,KAAK,GACL,MAAM,GACN,OAAO,GACP,YAAY,GACZ,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,CAAC;QAET,UAAU,CAAC,EAAE,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;KACxC;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,UAAU;YACzB;;;;eAIG;YACH,QAAQ,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;SACtC;KACF;IAED,UAAiB,iBAAiB;QAChC;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,IAAI,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;QAErC,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,GAAG,IAAI,CAAC;KAClD;IAED,UAAiB,iBAAiB,CAAC;QACjC,UAAiB,UAAU;YACzB;;;;eAIG;YACH,QAAQ,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;SACtC;KACF;IAED,UAAiB,oBAAoB;QACnC;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;QAErC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,oBAAoB,CAAC,UAAU,GAAG,IAAI,CAAC;KACrD;IAED,UAAiB,oBAAoB,CAAC;QACpC,UAAiB,UAAU;YACzB;;;;eAIG;YACH,QAAQ,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;SACtC;KACF;IAED,UAAiB,GAAG;QAClB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;QAEpD;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;KACpC;IAED,UAAiB,GAAG,CAAC;QACnB,UAAiB,UAAU;YACzB;;;;eAIG;YACH,QAAQ,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;SACtC;KACF;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C,IAAI,EAAE,GAAG,CAAC;IAEV,UAAU,EAAE,uBAAuB,CAAC;IAEpC,OAAO,EAAE,iFAAiF,CAAC;IAE3F,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,wBAAwB,GAAG,oBAAoB,CAAC,UAAU,GAAG,8BAA8B,CAAC;IAElG,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,UAAU;QACzB,IAAI,EAAE,MAAM,CAAC;QAEb,OAAO,EAAE,MAAM,CAAC;QAEhB,IAAI,EAAE,MAAM,CAAC;QAEb,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,wBAAwB,CAAC,MAAM,CAAC;IAExC,cAAc,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;CACrC;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,MAAM;QACrB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC;IAExD;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,OAAO;QACtB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}