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 Budget API endpoint.
Insights API Budget Endpoint - Standard Fields
Please see the following table to view the standard fields available for Budget within the Insights API.
Field Name
|
Field Label
|
Field Type
|
Field Description
|
| 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 a budget line is derived from |
| create_date | Create Date | Date | The date the budget was created |
| name | Budget Name | String | The name given to the budget line |
| budget_level | Budget Level | Number | The numerical step name in the budget hierarchy (i.e. parent vs child relationship) |
| order_by | Order By | String | The concatenated budget name hierarchy according to the budget level |
| total_original_budget | Original Budget | Sum | The sum of the original budget amount |
| total_current_budget | Current Budget | Sum | The sum of the current budget amount |
| total_granted_budget | Granted Budget | Sum | The sum of the non-voided payments for requests that are not rejected or canceled |
| total_paid_budget | Paid Budget | Sum | The sum of the paid payments for requests that are not rejected or canceled |
| total_scheduled_budget | Scheduled Budget | Sum | The sum of the scheduled budget amount |
What else do you need help with?
Not what you're looking for? Navigate to Understanding Insights API
