DonationSnapshot
- amountType: integer | null
_minor min:0requiredActual donation deposit in USD cents, before bank fees. Never an expected amount.
- churchType: string
_id requiredRoster identifier of the church this record belongs to.
- currencyconst:USDrequired
Currency of the amount; USD means US dollars.
- donorType: nullablerequiredProperties: 7
Authorized donor profile, or null when no profile can be supplied. In a supplied profile, an unknown email, phone or update time is null, and an unknown name or address line is an empty string. Government identifiers, birth date and documents are not exported.
- donorType: "available" or "unavailable"enum
_data _status requiredWhether authorized donor profile data is available in this update.
- donorType: string | null
_id requiredRoster identifier of the donor.
- enrollmentType: string | null
_id requiredIdentifier of the recurring giving arrangement; links its individual donations over time.
- idType: stringrequired
Identifier of this individual donation, not the recurring arrangement.
- methodconst:paycheckrequired
Donation method; paycheck means giving from payroll.
- receivedType: string | null
_at requiredWhen the donation deposit was received, in UTC; null means unknown.
- refundedType: integer
_minor min:0requiredTotal refunded to the donor from this donation, in USD cents, counting only refunds that
succeeded; a refund still on its way is not counted. Equal toamount_minorwhen the status isreversed;0when nothing was refunded. - residualType: integer | null
_minor min:0requiredRecorded residual remaining for the donor, in USD cents; null means unknown.
- returnType: objectnullable
_details requiredProperties: 5Details of a returned transfer, or null when no return is recorded.
- revisionType: stringrequired
Compare lexicographically within this donation; ignore older snapshots.
- statusType: stringenumrequired
Current recorded stage of this donation. transfer_submitted means sent to the bank; transfer_accepted means accepted by the bank, not proof of final credit at the destination. confirmed is reserved until a bank-confirmation producer is connected. Returns can still occur. reversed means the whole donation was refunded to the donor, in one refund or several; a partial refund does not change the status. While a refund of a donation the church was not paid yet waits for Roster's review, the donation reads in_review.
valuesreceivedin_reviewpending_transfertransfer_submittedtransfer_acceptedconfirmedreturnedfailedreversed - transfersType: array of objectrequiredProperties: 4
Every recorded part of the payment across all attempts, including the church amount, fees and any refund recovery, with their recorded statuses. A returned part stays listed as returned; if it is sent again, the new transfer appears as another entry.
- updatedType: stringFormat: date-time
_at requiredDate and time this information last changed, in UTC.
- fundsType: array of objectProperties: 6
The amount of this donation for each fund of the gift's split, in US cents. Each amount is the donation in proportion to the fund's percent or amount, rounded so the amounts add up exactly to amount_minor: the cents left by rounding go to the funds with the largest remainders, and a tie goes to the fund listed first. A split in dollars reports exactly those dollars when the donation equals the gift. Absent when the gift has no split. Every fund is paid to the same church bank account.