Class Fund

Namespace

Crews.PlanningCenter.Api.Giving.V2019_10_18

Assembly

Crews.PlanningCenter.Api.dll

Attributes for the Fund resource.

public record Fund : IEquatable<Fund>

Inheritance

object

Fund

Implements

IEquatable<Fund>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

Fund()

public Fund()

Fund(Fund)

protected Fund(Fund original)

Parameters

original Fund

Properties

Color

The hex color code that is used to help differentiate the fund from others in Giving, as determined by color_identifier.

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

Property Value

string

CreatedAt

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

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

Property Value

DateTime?

Default

This attribute is set to true if a fund is the associated organization's default fund, or false if it isn't. More information on default funds can be found in our product documentation: https://pcogiving.zendesk.com/hc/en-us/articles/205197070-Funds

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

Property Value

bool?

Deletable

Boolean that tells if you if the fund can be deleted or not. Read more in our product documentation: https://pcogiving.zendesk.com/hc/en-us/articles/205197070-Managing-Funds#DeleteaFund

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

Property Value

bool?

Description

A short description that describes how the money given to the fund will be used. 255 characters maximum.

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

Property Value

string

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

LedgerCode

If an organization's general ledger software tracks funds by code, this attribute can be used to store the fund's code for reference.

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

Property Value

string

Name

Required. The name for a fund. Must be unique within the associated organization.

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

Property Value

string

Slug

A URL-friendly identifier for a fund, derived from the fund name.

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

Property Value

string

UpdatedAt

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

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

Property Value

DateTime?

Visibility

Required. Controls how a fund is visible on Church Center. everywhere will allow anyone to donate to the fund on Church Center. admin_only will hide the fund on Church Center, allowing only permitted Giving Users to designate donations to it. nowhere will prevent donations from being designated to the fund altogether, while still displaying fund data in historical reports. hidden will hide the fund from the list of funds in the default Church Center donation form, but allow donors to give to it via direct link, or through Text-to-Give.

Possible values: everywhere, admin_only, nowhere, or hidden

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

Property Value

string

Methods

Equals(Fund?)

public virtual bool Equals(Fund? other)

Parameters

other Fund

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 ==(Fund?, Fund?)

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

Parameters

left Fund

right Fund

Returns

bool

operator !=(Fund?, Fund?)

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

Parameters

left Fund

right Fund

Returns

bool