Gift Commitment Field Mapping
Recurring donations sync to NPC’s GiftCommitment object, with one or more GiftCommitmentSchedule child rows that define the actual cadence.
Core fields
| WeGive field | NPC GiftCommitment field | Sync | Notes |
|---|---|---|---|
amount | Amount | ↔ | Base recurring amount, dollars |
status | Status | ↔ | See status mapping below |
Status mapping
NPC Status | WeGive status |
|---|---|
Active | active |
Paused | paused |
Closed | cancelled or ended (depending on close reason) |
Failing | failing or in_arrears |
Draft | active |
Linkage (create-only)
| WeGive field | NPC field | Notes |
|---|---|---|
source.npc_id | DonorId | The Account ID for the donor |
campaign.npc_id | CampaignId |
Schedule
Frequency on a WeGive scheduled donation translates to NPC’s GiftCommitmentSchedule rows. Each schedule row has a TransactionPeriod and TransactionInterval.
WeGive frequency | TransactionPeriod | TransactionInterval |
|---|---|---|
daily | Daily | 1 |
weekly | Weekly | 1 |
biweekly | Weekly | 2 |
monthly | Monthly | 1 |
quarterly | Monthly | 3 |
semi_annual | Monthly | 6 |
annual | Yearly | 1 |
On pull, WeGive reads the first active GiftCommitmentSchedule and inverts the table above to determine the WeGive frequency.
Generated gifts
One-time gifts that are generated by a recurring commitment carry GiftCommitmentId on the GiftTransaction. WeGive uses this to link generated transactions to the parent scheduled donation.