Common models

Financial Batch

Property

Type

Description

financialBatchId

int

Read-only; Unique identifier for a Financial Batch in this context.

financialBatchNumber

long

Required; User-specified identifier for this batch. Must be unique within this context.

designationId

int

Required; Designation to associate this Financial Batch with.

financialBatchName

string

User-specified name for this batch. Must be unique within this context. Must not be Unassigned

expectedContributionCount

int

If set, the number of contributions expected for this batch. The total count of contributions in the batch must match the expected count in order to close the batch.

expectedContributionTotalAmount

decimal

If set, the total monetary amount of contributions expected for this batch. The total amount of contributions in the batch must match the expected amount in order to close the batch.

isOpen

bool

Read-only; A batch may have a status of open or closed. If true, the batch is currently open and can have contributions added to it. If false, the batch is closed and may not have contributions added to it.

dateOpened

date

Read-only; If set, this is the date the batch was opened.

dateClosed

date

Read-only; If set, this is the date the batch was closed.

isAutoGenerated

bool

Read-only; If true, this is a system-generated batch, and contributions cannot be manually associated with it.

bankAccountId

int

Read-only; If set, the bank account associated with the batch.

dateDeposited

date

Read-only; If set, the deposit date recorded on the batch.

depositNumber

int

Read-only; If set, the deposit number recorded on the batch.

checkDate

date

Read-only; If set, the check date recorded on the batch.

checkNumber

int

Read-only; If set, the check number recorded on the batch.