@rippling/rippling-sdk 0.2.0-alpha.97 → 0.2.0-alpha.99

package/src/resources/variable-compensation-payout-writes.ts

@@ -9,7 +9,8 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class VariableCompensationPayoutWrites extends APIResource {
   /**
-   * Create a new variable compensation payout write
+   * Create and submit a payout into payroll. For ledger create-or-update of a payout
+   * row, use POST /variable-compensation-payouts/.
    */
   create(
     body: VariableCompensationPayoutWriteCreateParams,
@@ -20,28 +21,18 @@ export class VariableCompensationPayoutWrites extends APIResource {
 }
 
 export interface VariableCompensationPayoutWriteCreateResponse {
-  /**
-   * Identifier field
-   */
-  id: string;
-
   /**
    * Payout amount.
    */
   amount_base: VariableCompensationPayoutWriteCreateResponse.AmountBase;
 
   /**
-   * Record creation date
-   */
-  created_at: string;
-
-  /**
-   * RoleWithCompany ID for the payout recipient.
+   * ID of the worker who receives this payout.
    */
   payee_id: string;
 
   /**
-   * Company payout type key.
+   * Key of the company payment type used for this payout.
    */
   payment_type: string;
 
@@ -50,11 +41,6 @@ export interface VariableCompensationPayoutWriteCreateResponse {
    */
   scheduled_date: string;
 
-  /**
-   * Record update date
-   */
-  updated_at: string;
-
   /**
    * Optional markdown summary of the eligibility conditions.
    */
@@ -105,12 +91,12 @@ export interface VariableCompensationPayoutWriteCreateParams {
   amount_base: VariableCompensationPayoutWriteCreateParams.AmountBase;
 
   /**
-   * RoleWithCompany ID for the payout recipient.
+   * ID of the worker who receives this payout.
    */
   payee_id: string;
 
   /**
-   * Company payout type key.
+   * Key of the company payment type used for this payout.
    */
   payment_type: string;