Class BatchGroup

Namespace

Crews.PlanningCenter.Api.Giving.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Attributes for the BatchGroup resource.

public record BatchGroup : IEquatable<BatchGroup>

Inheritance

object

BatchGroup

Implements

IEquatable<BatchGroup>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

BatchGroup()

public BatchGroup()

BatchGroup(BatchGroup)

protected BatchGroup(BatchGroup original)

Parameters

original BatchGroup

Properties

Committed

Returns true if a batch group has been committed, and false if it hasn't.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("committed")]
public bool? Committed { get; init; }

Property Value

bool?

CreatedAt

The date and time at which a batch group was created. Example: 2000-01-01T12:00:00Z

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("created_at")]
public DateTime? CreatedAt { get; init; }

Property Value

DateTime?

Description

A brief description of what a batch group is for. This is displayed in Giving to help differentiate different batch groups from one another. If no description is provided for a batch group, it will be referred to as Untitled group within Giving.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("description")]
public string? Description { get; init; }

Property Value

string

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

Status

One of in_progress, updating, or committed. The updating state is temporary and describes a BatchGroup that is currently being changed in some way (e.g. moving from in_progress to committed). Certain changes to BatchGroups in this state (or their Batches or Donations) will be restricted until the BatchGroup has finished updating.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("status")]
public string? Status { get; init; }

Property Value

string

TotalCents

The gross total of cents donated within the batch group. Factors in all donations made to each batch within the group.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("total_cents")]
public int? TotalCents { get; init; }

Property Value

int?

TotalCurrency

The currency used to calculate total_cents.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("total_currency")]
public string? TotalCurrency { get; init; }

Property Value

string

UpdatedAt

The date and time at which a batch group was last updated. Example: 2000-01-01T12:00:00Z

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("updated_at")]
public DateTime? UpdatedAt { get; init; }

Property Value

DateTime?

Methods

Equals(BatchGroup?)

public virtual bool Equals(BatchGroup? other)

Parameters

other BatchGroup

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Operators

operator ==(BatchGroup?, BatchGroup?)

public static bool operator ==(BatchGroup? left, BatchGroup? right)

Parameters

left BatchGroup

right BatchGroup

Returns

bool

operator !=(BatchGroup?, BatchGroup?)

public static bool operator !=(BatchGroup? left, BatchGroup? right)

Parameters

left BatchGroup

right BatchGroup

Returns

bool