Constructor Detail

Method Detail

• id

   final String id()

  The unique id for the payment.

• companyDebit

   final Optional<Money> companyDebit()

• debitDate

   final Optional<String> debitDate()

• employeeTaxes

   final Optional<Money> employeeTaxes()

• employerTaxes

   final Optional<Money> employerTaxes()

• grossPay

   final Optional<Money> grossPay()

• individualIds

   final Optional<List<String>> individualIds()

  Array of every individual on this payment.

• netPay

   final Optional<Money> netPay()

• payDate

   final Optional<String> payDate()

• payFrequencies

   final Optional<List<Payment.PayFrequency>> payFrequencies()

  List of pay frequencies associated with this payment.

• payGroupIds

   final Optional<List<String>> payGroupIds()

  Array of the Finch id (uuidv4) of every pay group associated with this payment.

• payPeriod

   final Optional<Payment.PayPeriod> payPeriod()

  The pay period object.

• _id

   final JsonField<String> _id()

  Returns the raw JSON value of id.

  Unlike id, this method doesn't throw if the JSON field has an unexpected type.

• _companyDebit

   final JsonField<Money> _companyDebit()

  Returns the raw JSON value of companyDebit.

  Unlike companyDebit, this method doesn't throw if the JSON field has an unexpected type.

• _debitDate

   final JsonField<String> _debitDate()

  Returns the raw JSON value of debitDate.

  Unlike debitDate, this method doesn't throw if the JSON field has an unexpected type.

• _employeeTaxes

   final JsonField<Money> _employeeTaxes()

  Returns the raw JSON value of employeeTaxes.

  Unlike employeeTaxes, this method doesn't throw if the JSON field has an unexpected type.

• _employerTaxes

   final JsonField<Money> _employerTaxes()

  Returns the raw JSON value of employerTaxes.

  Unlike employerTaxes, this method doesn't throw if the JSON field has an unexpected type.

• _grossPay

   final JsonField<Money> _grossPay()

  Returns the raw JSON value of grossPay.

  Unlike grossPay, this method doesn't throw if the JSON field has an unexpected type.

• _individualIds

   final JsonField<List<String>> _individualIds()

  Returns the raw JSON value of individualIds.

  Unlike individualIds, this method doesn't throw if the JSON field has an unexpected type.

• _netPay

   final JsonField<Money> _netPay()

  Returns the raw JSON value of netPay.

  Unlike netPay, this method doesn't throw if the JSON field has an unexpected type.

• _payDate

   final JsonField<String> _payDate()

  Returns the raw JSON value of payDate.

  Unlike payDate, this method doesn't throw if the JSON field has an unexpected type.

• _payFrequencies

   final JsonField<List<Payment.PayFrequency>> _payFrequencies()

  Returns the raw JSON value of payFrequencies.

  Unlike payFrequencies, this method doesn't throw if the JSON field has an unexpected type.

• _payGroupIds

   final JsonField<List<String>> _payGroupIds()

  Returns the raw JSON value of payGroupIds.

  Unlike payGroupIds, this method doesn't throw if the JSON field has an unexpected type.

• _payPeriod

   final JsonField<Payment.PayPeriod> _payPeriod()

  Returns the raw JSON value of payPeriod.

  Unlike payPeriod, this method doesn't throw if the JSON field has an unexpected type.

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• toBuilder

   final Payment.Builder toBuilder()

• validate

   final Payment validate()

  Validates that the types of all values in this object match their expected types recursively.

  This method is not forwards compatible with new types from the API for existing fields.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static Payment.Builder builder()

  Returns a mutable builder for constructing an instance of Payment.

  The following fields are required:

  .id()
  .companyDebit()
  .debitDate()
  .employeeTaxes()
  .employerTaxes()
  .grossPay()
  .individualIds()
  .netPay()
  .payDate()
  .payFrequencies()
  .payGroupIds()
  .payPeriod()