Struct gusto_api::types::PutGarnishmentRequest

pub struct PutGarnishmentRequest {
    pub active: Option<bool>,
    pub amount: f64,
    pub annual_maximum: f64,
    pub court_ordered: Option<bool>,
    pub deduct_as_percentage: Option<bool>,
    pub description: String,
    pub pay_period_maximum: f64,
    pub recurring: Option<bool>,
    pub times: i64,
    pub version: String,
}

Fields

active: Option<bool>

Whether or not this garnishment is currently active.

amount: f64

The amount of the garnishment. Either a percentage or a fixed dollar amount. Represented as a float, e.g. “8.00”.

annual_maximum: f64

The maximum deduction per annum. A null value indicates no maximum. Represented as a float, e.g. “200.00”.

court_ordered: Option<bool>

Whether the garnishment is court ordered.

deduct_as_percentage: Option<bool>

Whether the amount should be treated as a percentage to be deducted per pay period.

description: String

The description of the garnishment.

pay_period_maximum: f64

The maximum deduction per pay period. A null value indicates no maximum. Represented as a float, e.g. “16.00”.

recurring: Option<bool>

Whether the garnishment should recur indefinitely.

times: i64

The number of times to apply the garnisment. Ignored if recurring is true.

version: String

The current version of the object. See the versioning guide for information on how to use this field.

Trait Implementations

impl Clone for PutGarnishmentRequest

fn clone(&self) -> PutGarnishmentRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PutGarnishmentRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PutGarnishmentRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PutGarnishmentRequest

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for PutGarnishmentRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.