Common models

Financial Batch

PropertyTypeDescription
financialBatchIdintRead-only; Unique identifier for a Financial Batch in this context.
financialBatchNumberlongRequired; User-specified identifier for this batch. Must be unique within this context.
designationIdintRequired; Designation to associate this Financial Batch with.
financialBatchNamestringUser-specified name for this batch. Must be unique within this context. Must not be Unassigned
expectedContributionCountintIf 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.
expectedContributionTotalAmountdecimalIf 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.
isOpenboolRead-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.
dateOpeneddateRead-only; If set, this is the date the batch was opened.
dateCloseddateRead-only; If set, this is the date the batch was closed.
isAutoGeneratedboolRead-only; If true, this is a system-generated batch, and contributions cannot be manually associated with it.
bankAccountIdintRead-only; If set, the bank account associated with the batch.
dateDepositeddateRead-only; If set, the deposit date recorded on the batch.
depositNumberintRead-only; If set, the deposit number recorded on the batch.
checkDatedateRead-only; If set, the check date recorded on the batch.
checkNumberintRead-only; If set, the check number recorded on the batch.