The Insights API provides access to several system endpoints, each containing a set of standard data fields.
- In addition to the standard fields listed below, Administrators have the ability to select up to 10 Custom Fields of their choice to be included in the Payments API endpoint.
Insights API Payments Endpoint - Standard Fields
Please see the following table to view the standard fields available for Payments within the Insights API.
Field Name
|
Field Label
|
Field Type
|
Field Description
|
| payee_id | Payee ID | Number | The unique CyberGrantsID of the organization to which payment is applicable |
| payment_id | Payment ID | Number | The unique CyberGrants identification number for a particular payment. Each payment in CyberGrants will have a distinct payment ID |
| check_cashed_date | Check Cashed Date | Date | The date a check was cashed for a payment |
| check_date | Payment Date | Date | The date that the check was sent or the payment was processed |
| due_date | Due Date | Date | The date that a payment is due to the nonprofit |
| request_check_date | Requested Check Date | Date | The date that the payment should be processed or a check should be cut |
| stop_date | Stop Date | Date | The date the payment was stopped |
| transmitted_to_ap_date | Transmitted to AP Date | Date | The date the payment was transmitted to accounts payable |
| void_date | Void Date | Date | The date the payment was voided |
| check_number | Check Number | String | The unique identifier used to track physical payments. This number is generated outside of CyberGrants, typically by an accounts payable system |
| deductible_amount | Deductible Amount | Number | The deductible portion of a payment. For product/service payments, this amount often corresponds to the cost price |
| payment_number | Payment Number | Number | The count of the number of payments applicable to the grant (i.e. multiple-payment grants) |
| payment_status | Payment Status | String | The status of a particular payment |
| payment_type | Payment Type | String | The classification of a payment |
| total_amount | Total Amount | Sum | The payment's total amount |
| proposal_type | Program | String | The proposal type or program name |
| budget_id | Budget ID | Number | The ID that is assigned to each unique budget line within a client’s budget structure. Each payment within CyberGrants is tied to a budget line ID |
| budget_year | Budget Year | Number | The year from which a budget line is derived |
What else do you need help with?
Not what you're looking for? Navigate to Understanding Insights API
