The Insights API provides access to several system endpoints, each containing a set of standard data fields.
- At this time, we do not support any custom field additions to the Pledging API endpoint.
Insights API Pledging Endpoint - Standard Fields
Please see the following table to view the standard fields available for Pledging within the Insights API.
Field Name
|
Field Label
|
Field Type
|
Field Description
|
| eg_deduction_summary_id | Deduction Summary ID | Number | The unique CyberGrants ID applicable to a pledge transaction |
| eg_deduction_detail_id | Deduction Detail ID | Number | The unique CyberGrants ID applicable to the pledge transaction per organization |
| activation_date | Activation Date | Date | The effective date for which pledged deductions will begin |
| start_date | Start Date | Date | The effective date for which pledged deductions will begin |
| end_date | End Date | Date | The effective date for which pledged deductions will conclude |
| cancellation_date | Cancellation Date | Date | The date when a pledge has been canceled, if applicable |
| designation | Designation | String | The designation of a pledge |
| disposition | Disposition | String | The current status of a pledge |
| one_time_flag | One-Time Deduction? | String | A flag that indicates if this pledge is a one-time deduction |
| total_estimated_pay_period_amount | Total Estimated Pay Period Amount | Sum | The deduction amount per pay period of the donor |
| total_deduction_amount | Total Deduction Amount | Sum | The amount deducted or scheduled to be deducted from donor |
| donor_id | Donor ID | String | The unique CyberGrants identification number for a particular donor. Each payment in CyberGrants will have a distinct donor ID |
| organization_id | Organization ID | Number | The unique CyberGrants identification number for a particular organization. Each organization in CyberGrants will have a distinct organization ID |
| eg_request_id | EG Request ID | Number | The unique CyberGrants identification number for a particular eg request. Each payment in CyberGrants will have a distinct EG request ID |
| request_id | Request ID | Number | The unique CyberGrants identification number for a particular payment request. Each request in CyberGrants will have a distinct request ID |
| proposal_type | Program | String | The proposal type or program name |
What else do you need help with?
Not what you're looking for? Navigate to Understanding Insights API
