CBPF API
Pooled Fund:

CBPF API vo2

Version 1.1.88

Error in Angular Module:{{error}}

Additional APIs

API Name API Description API Code JSON CSV
Project Location Data Get project locations data.
Parameters
- GlobalOrganizationId: Global Organization Id (optional)
For example: 2020
- PoolfundIds: Comma Separated PoolfundIds (optional)
For example: 62,72
- AllocationYear: AllocationYear range for which project data will be fetched. For single allocation pass single year value else provide year1_year2 (optional)
For example: 2022_2023
 PROJ_LOC_MAP Go Go
All Poolfunds Master Data API to get all poolfund master list for both CERF and CBPF
Parameters
- ShowAllPooledFunds: Show All PooledFunds including inactive poolfunds also (optional)
For example: 1
 ALL_POOLFUND Go Go
OneGMS - Project Emergency Full Dump Full dump extract of Project Emergency data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 OR CERF=2
 PROJECT_EMERGENCY_OneGMS Go Go
PF Marker - GBV API to return Gender-based violence (GBV) Markers
Parameters
- FundTypeId: Fund Type (optional)
For example: 1 or 2. 1 for CBPF and 2 for CERF
 PF_MARKER_GBV Go Go
PF Marker - Gender Equality API to return Gender equality (GBV) Markers
Parameters
- FundTypeId: Fund Type (optional)
For example: 1 or 2. 1 for CBPF and 2 for CERF
 PF_MARKER_GEQ Go Go
PF Marker - Disability API to return Disability (GBV) Markers
Parameters
- FundTypeId: Fund Type (optional)
For example: 1 or 2. 1 for CBPF and 2 for CERF
 PF_MARKER_DISABL Go Go
PF Marker - Cash Voucher API to return Cash Voucher (CVA) Markers
Parameters
- FundTypeId: Fund Type (optional)
For example: 1 or 2. 1 for CBPF and 2 for CERF
 PF_MARKER_CVA Go Go
PF Project Summary Pooled Fund Project Summary API
Parameters
- ShowAllPooledFunds: Show All Pooled Funds (optional)
For example: 0 for No. 1 for Yes
- AllocationYears: Allocation Years (range) in <Start Year>_<End Year> format (optional)
For example: 2020_2024
- FundTypeId: Fund Type (optional)
For example: 1 or 2. 1 for CBPF and 2 for CERF
 PF_PROJ_SUMMARY Go Go
PF Project Detail Pooled Fund Project Detail API
Parameters
- ShowAllPooledFunds: Show All Pooled Funds (optional)
For example: 0 for No. 1 for Yes
- AllocationYears: Allocation Years (range) in <Start Year>_<End Year> format (optional)
For example: 2020_2024
- FundTypeId: Fund Type (optional)
For example: 1 or 2. 1 for CBPF and 2 for CERF
 PF_PROJ_DETAIL Go Go
PF Narrative Report Cluster Beneficiary Narrative Report Cluster-wise Beneficiary details
Parameters
- ShowAllPooledFunds: Show All Pooled Funds (optional)
For example: 0 for No. 1 for Yes
- AllocationYears: Allocation Years (range) in <Start Year>_<End Year> format (optional)
For example: 2020_2024
- FundTypeId: Fund Type (optional)
For example: 1 or 2. 1 for CBPF and 2 for CERF
 PF_RPT_CLST_BENEF Go Go
PF Organization Master - Summary API to return summary of Organizations
Parameters
- FundTypeId: Fund Type Id (optional)
For example: 1 or 2. 1 for CBPF and 2 for CERF
 PF_ORG_SUMMARY Go Go
PF Global Organization Master API to return list of Global Organizations PF_GLOBAL_ORG Go Go
PF Global Status Master API to return Statuses in OneGMS
Parameters
- InstanceTypeId: Instance Type Id (optional)
For example: 1
- FundTypeId: Fund Type Id (required)
For example: 1 or 2. 1 for CBPF and 2 for CERF
 PF_GLB_STATUS Go Go
Emergency Group Master API for master data for Emergency Groups EMERG_GRP_MST Go Go
Emergency Type Master API for master data for Emergency Type EMERG_TYPE_MST Go Go
Common Cluster Master API to return Common Clusters COMM_CLST_MST Go Go
Global Cluster Indicator Master API to return Global Cluster Indicator
Parameters
- GlobalIndicatorType: Indicator Type (optional)
For example: 1 or 2. 1 for Output Indicator and 2 for Outcome Indicator
 GLB_INDIC_MST Go Go
PF Project Global Indicator API for PF Project Global Cluster Indicator
Parameters
- ShowAllPooledFunds: Show All Pooled Funds (optional)
For example: 0 for No. 1 for Yes
- AllocationYears: Allocation Years (range) in <Start Year>_<End Year> format (optional)
For example: 2020_2024
- IndicatorTypeId: Indicator Type (optional)
For example: 1 or 2. 1 for Global Output Indicator and 2 for Global Outcome Indicator
- FundTypeId: Fund Type (optional)
For example: 1 or 2. 1 for CBPF and 2 for CERF
 PF_GLB_INDIC Go Go
CVA Details API to return CVA Details.
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 / CERF=2
 APIDAT_CVA Go Go

Secured APIs

The following APIs can be called only with access credentials. Please send a request to gms-support@un.org to register.
Click on Copy link for an API to copy its URL to your clipboard. You can only call these APIs using the access credentials provided by GMS. Secured APIs cannot be called without access credentials.
API Name API Description API Code JSON CSV
Project Participation Affected Persons data for Tagged Project in COVID App TAG_PRJ Copy Copy
Project Participation - Affected Persons Affected Persons data for Tagged Project in COVID App TAG_PRJ_PER Copy Copy
Project Participation - Sub-Implementing Partners Sub Implementing Partners data for Tagged Project in COVID App TAG_PRJ_SUBIP Copy Copy
MPTF Data Extract MPTF Data Extract with FTR Atlas MPTFExtract Copy Copy
Annual Report - Contributions Annual Report Query for Contributions. Used to generate report for Query #1, 20 and 27. AR_QUERY_1 Copy Copy
Annual Report - Contributions for Fiscal Year by Donor ($ and %) Annual Report Query for Contributions for Fiscal Year by Donor ($ and %). Used to generate report for Query #2.
Parameters
- FiscalYear: Contribution Fiscal Year (optional)
For example: 2020
 AR_QUERY_2 Copy Copy
Annual Report - Allocations by Year Annual Report Query for Allocation by Year. Data can be used to generate report for Query #3, 16, 18
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2020
- LastApprovalDate: Last Approval Date (in MM/DD/YYYY format) (optional)
For example: 12/31/2020
 AR_QUERY_3 Copy Copy
Annual Report - Allocations - People Targeted Annual Report Query for Allocation People Targeted disaggregated by sex and age (% and #). Data can be used to generate report for Query #4
Parameters
- AllocationYear: Allocation Year (required)
For example: 2020
- LastApprovalDate: Last Approval Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_4 Copy Copy
Annual Report - Allocations - People with Disabilities Targeted Annual Report Query for allocations people with disabilities targeted; disaggregated by sex and age (% and #). Data can be used to generate report for Query #4.1
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2020
- LastApprovalDate: Last Approval Date (in MM/DD/YYYY format) (optional)
For example: 12/31/2020
 AR_QUERY_5 Copy Copy
Annual Report - Allocations - Cluster split per project Annual Report Query for allocations by cluster ($) based on the cluster split per project. Data can be used to generate report for Query #5, 21
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2020
- LastApprovalDate: Last Approval Date (in MM/DD/YYYY format) (optional)
For example: 12/31/2020
 AR_QUERY_6 Copy Copy
Annual Report - Allocations - Admin Level 1 by Funding and People targeted Annual Report Query for Map of Admin level 1 by funding and people targeted. Data can be used to generate report for Query #6
Parameters
- AllocationYear: Allocation Year (required)
For example: 2020
- LastApprovalDate: Last Approval Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_7 Copy Copy
Annual Report - Allocations - HFU Management Cost Annual Report Query for HFU Management Cost. Data can be used to generate HFU Management Cost data for Query #5, 21
Parameters
- Year: Year (optional)
For example: 2020
 AR_QUERY_8 Copy Copy
Annual Report - Allocations by Partner Type - $ and % Annual Report Query for Allocations by Partner Type - $ and #. Data can be used to generate report for Query #7
Parameters
- AllocationYear: Allocation Year (required)
For example: 2020
- LastApprovalDate: Last Approval Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_9 Copy Copy
Annual Report - Allocations - Monitoring Conducted Annual Report Query for Monitoring conducted and expected rates by risk level (# of conducted and % of conducted rates from OCHA assurance) based on Projects processed. Data can be used to generate report for Query #33
Parameters
- AsOfDate: As of Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
- ProcessedStartDate: Project Processed Start Date (in MM/DD/YYYY format) (required)
For example: 01/01/2020
- ProcessedEndDate: Project Processed End Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_10 Copy Copy
Annual Report - Allocations - Financial Spot Check Conducted Annual Report Query for Financial Spot Check conducted and expected rates by risk level (# of conducted and % of conducted rates from OCHA assurance) based on Projects processed. Data can be used to generate report for Query #34
Parameters
- AsOfDate: As of Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
- ProcessedStartDate: Project Processed Start Date (in MM/DD/YYYY format) (required)
For example: 01/01/2020
- ProcessedEndDate: Project Processed End Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_11 Copy Copy
Annual Report - Allocations - Final Narrative Report Rates Annual Report Query for Final Narrative Reporting rates (# submitted and % compared to due, from OCHA assurance) based on Projects processed. Data can be used to generate report for Query #35
Parameters
- AsOfDate: As of Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
- ProcessedStartDate: Project Processed Start Date (in MM/DD/YYYY format) (required)
For example: 01/01/2020
- ProcessedEndDate: Project Processed End Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_12 Copy Copy
Annual Report - Allocations - Final Financial Report Rates Annual Report Query for Final Financial Reporting rates (# submitted and % compared to due, from OCHA assurance) based on Projects processed. Data can be used to generate report for Query #36
Parameters
- AsOfDate: As of Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
- ProcessedStartDate: Project Processed Start Date (in MM/DD/YYYY format) (required)
For example: 01/01/2020
- ProcessedEndDate: Project Processed End Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_13 Copy Copy
Annual Report - Allocations - Audit Report Rates Annual Report Query for Audit completed, ongoing and required rate (# approved and % compared to due, from OCHA assurance) based on Projects processed. Data can be used to generate report for Query #37
Parameters
- AsOfDate: As of Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
- ProcessedStartDate: Project Processed Start Date (in MM/DD/YYYY format) (required)
For example: 01/01/2020
- ProcessedEndDate: Project Processed End Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_14 Copy Copy
Annual Report - HFU Management Cost - Contribution Annual Report Query for Value and percentage of HFU (direct cost expenditure) in proportion to total value of Contribution (yearly). Data can be used to generate report for Query #31 AR_QUERY_15 Copy Copy
Annual Report - Allocations by Cluster and Sub Cluster Annual Report Query for allocations with Cluster and Sub cluster information. Data can be used for report on 4 strategic priorities of ERC - GBV. Can be used to generate Report for Query #49 AR_QUERY_16 Copy Copy
Annual Report - Funding for Projects that have Final Narrative Reports approved (Dashboard 2) Amount of funding for projects that have Final Narrative Reports approved between the Start and End Date. API can be used to generate Report for Query #8, 9, 10, 14
Parameters
- StartDate: Report Approved Start Date (in MM/DD/YYYY format) (optional)
For example: 01/01/2020
- EndDate: Report Approved End Date (in MM/DD/YYYY format) (optional)
For example: 12/31/2020
 AR_QUERY_17 Copy Copy
Annual Report - People targeted and reached by sex and age (Dashboard 2) People targeted and reached by sex and age for projects that have Final Narrative Reports approved between the Start and End Date. API can be used to generate Report for Query #11, 30
Parameters
- StartDate: Report Approved Start Date (in MM/DD/YYYY format) (optional)
For example: 01/01/2020
- EndDate: Report Approved End Date (in MM/DD/YYYY format) (optional)
For example: 12/31/2020
 AR_QUERY_18 Copy Copy
Annual Report - People with disabilities targeted and reached by sex and age (Dashboard 2) People with disabilities targeted and reached by sex and age for projects that have Final Narrative Reports approved between the Start and End Date.
Parameters
- StartDate: Report Approved Start Date (in MM/DD/YYYY format) (optional)
For example: 01/01/2020
- EndDate: Report Approved End Date (in MM/DD/YYYY format) (optional)
For example: 12/31/2020
 AR_QUERY_19 Copy Copy
Annual Report - Recipient Organizations and Sub-Grantees by Type and Amount for Allocation Year Recipient Organizations and Sub-Grantees by Type and Amount for Allocation Year. API can be used to generate Report for Query #17.
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2020
- LastApprovalDate: Last Project Approval Date (in MM/DD/YYYY format) (optional)
For example: 12/31/2020
 AR_QUERY_20 Copy Copy
Annual Report - Allocations by HRP Strategic Objective (SO) for Allocation Year Allocations by HRP Strategic Objective (SO) for Allocation Year. API can be used to generate Report for Query #19.
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2020
 AR_QUERY_21 Copy Copy
Annual Report - Allocation Amount and Percentage of funding allocated by Allocation type and Admin Location 1 Allocation Amount and percentage of funding allocated through standard and reserve allocations broken down by type of allocation and geographic area (Admin1). API can be used to generate Report for Query #23.
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2020
 AR_QUERY_22 Copy Copy
Annual Report - Percentage of HRP funding channeled through the CBPF Percentage of HRP funding channeled through the CBPF for Allocation Year. API can be used to generate Report for Query #29.
Parameters
- AllocationYear: Allocation Year (required)
For example: 2020
- LastApprovalDate: Last Project Approval Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_23 Copy Copy
Annual Report - CA Details with Evaluation Count and Version Count CA Details with Evaluation Count and Version Count. API can be used to generate Report for Query #32.1. AR_QUERY_24 Copy Copy
Annual Report - Beneficiaries targeted and reached by Cluster Annual Report Query for number of beneficiaries targeted and reached by cluster.
Parameters
- StartDate: Report Approved Start Date (in MM/DD/YYYY format) (optional)
For example: 01/01/2020
- EndDate: Report Approved End Date (in MM/DD/YYYY format) (optional)
For example: 12/31/2020
 AR_QUERY_25 Copy Copy
Annual Report - Beneficiaries targeted and reached by Beneficiary type Annual Report Query for number of beneficiaries targeted and reached by beneficiary type. Data can be used to generate output for Query #13
Parameters
- StartDate: Report Approved Start Date (in MM/DD/YYYY format) (required)
For example: 01/01/2020
- EndDate: Report Approved End Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_26 Copy Copy
Annual Report - Cash Tracking Annual Report Query for Allocation amount and percentage for type of assistance in-kind and cash. Data can be used to generate output for Query #22
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2020
- LastApprovalDate: Last Approval Date (in MM/DD/YYYY format) (optional)
For example: 12/31/2020
 AR_QUERY_27 Copy Copy
Annual Report - Revision Processed Annual Report Query for Number of revisions processed by type of revision in comparison to the overall number of projects under implementation. Data can be used to generate output for Query #25.1
Parameters
- RequestSubmittedYear: Year of Revision Request Submission (required)
For example: 2020
 AR_QUERY_28 Copy Copy
Annual Report - Organizations by Partner Risk Level Annual Report Query for Number and type of implementing partners and amount and percentage of funding allocated by partner risk level. Report can be used to generate output for Query 32
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2020
 AR_QUERY_29 Copy Copy
Annual Report - Output Indicator by Gender and age Annual Report Query for Output Indicator disaggregated by Gender and Age
Parameters
- StartDate: Report Approved Start Date (in MM/DD/YYYY format) (optional)
For example: 01/01/2020
- EndDate: Report Approved End Date (in MM/DD/YYYY format) (optional)
For example: 12/31/2020
 AR_QUERY_30 Copy Copy
Annual Report - Allocations by month of allocation launch date Annual Report query to get Total Allocations by month of allocation launch date
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2020
 AR_QUERY_31 Copy Copy
Annual Report - Project ScoreCard and AAP Project Scorecard and AAP. API can be used to generate output for Query # 32.2 SRC-AAP
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2020
 AR_QUERY_32 Copy Copy
Annual Report - Number Of Risks revised between Start date and End Date Annual Report query to get the number of Partner Risk revised between the Start Date and End Date
Parameters
- StartDate: Start Date of Risk Revision (in MM/DD/YYYY format) (required)
For example: 01/01/2020
- EndDate: End Date of Risk Revision (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_33 Copy Copy
Annual Report - Admin Location 1 Funding and Reached Beneficiaries Annual Report Query to get admin level 1 funding and reached beneficiaries ($ and %). This API can be used to generate output for query #15
Parameters
- StartDate: Report Approved Start Date (in MM/DD/YYYY format) (required)
For example: 01/01/2020
- EndDate: Report Approved End Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_34 Copy Copy
Annual Report - Average Allocation Process Annual Report Query for Average duration of the allocation process from closing date of allocation (submission deadline) to HC signature of selected projects by allocation type. This API can be used to generate output for query #26.1
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2020
 AR_QUERY_35 Copy Copy
Annual Report - Average days from EO Signature to 1st Disbursement date Annual Report Query for Average number of working days from EO signature of a proposal to first payment by type of allocation. This API can be used to generate output for Query #26
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2020
 AR_QUERY_36 Copy Copy
Annual Report - Allocations - Monitoring Conducted - Raw Data Annual Report Query for Monitoring conducted and expected rates by risk level (# of conducted and % of conducted rates from OCHA assurance) based on Projects processed. Data can be used to generate Raw data for Query #33
Parameters
- AsOfDate: As of Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
- ProcessedStartDate: Project Processed Start Date (in MM/DD/YYYY format) (required)
For example: 01/01/2020
- ProcessedEndDate: Project Processed End Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_37 Copy Copy
Annual Report - Allocations - Cost Tracking Annual Report Query for getting Cost Tracking Data as per Dashboard 1 parameters.
Parameters
- AllocationYear: Allocation Year (required)
For example: 2020
- LastApprovalDate: Last Approval Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_38 Copy Copy
Annual Report - Allocations - Financial Spot Check Conducted - Raw Data Annual Report Query for Financial Spot Check conducted and expected rates by risk level (# of conducted and % of conducted rates from OCHA assurance) based on Projects processed. Data can be used to generate Raw data for Query #34
Parameters
- AsOfDate: As of Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
- ProcessedStartDate: Project Processed Start Date (in MM/DD/YYYY format) (required)
For example: 01/01/2020
- ProcessedEndDate: Project Processed End Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_39 Copy Copy
Annual Report - Allocations - Final Narrative Report - Raw Data Annual Report Query for Final Narrative Reporting rates (# submitted and % compared to due, from OCHA assurance) based on Projects processed. Data can be used to generate Raw data for Query #35
Parameters
- AsOfDate: As of Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
- ProcessedStartDate: Project Processed Start Date (in MM/DD/YYYY format) (required)
For example: 01/01/2020
- ProcessedEndDate: Project Processed End Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_40 Copy Copy
Annual Report - Allocations - Final Financial Report - Raw Data Annual Report Query for Final Financial Reporting rates (# submitted and % compared to due, from OCHA assurance) based on Projects processed. Data can be used to generate Raw data for Query #36
Parameters
- AsOfDate: As of Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
- ProcessedStartDate: Project Processed Start Date (in MM/DD/YYYY format) (required)
For example: 01/01/2020
- ProcessedEndDate: Project Processed End Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_41 Copy Copy
Annual Report - Allocations - Admin Level 1 by People targeted with target type Annual Report Query for Admin level 1 by people targeted with people target type
Parameters
- AllocationYears: Allocation Years (comma-separated) (required)
For example: 2020,2021
- LastApprovalDate: Last Approval Date (in MM/DD/YYYY format) (required)
For example: 12/31/2021
 AR_QUERY_42 Copy Copy
BoA Report - Main Query Query will generate the main project report required for BoA
Parameters
- MaxActualEndDate: Maximum Actual End Date (required)
For example: 12/31/2021
- MinAllocationYear: Earliest Allocation Year (required)
For example: 2016
 BOA_1 Copy Copy
BoA Report - Disbursement Query Query will generate the disbursement report required for BoA
Parameters
- MaxActualEndDate: Maximum Actual End Date (required)
For example: 12/31/2021
- MinAllocationYear: Earliest Allocation Year (required)
For example: 2016
 BOA_2 Copy Copy
BoA Report - Refund Query Query will generate the refund report required for BoA
Parameters
- MaxActualEndDate: Maximum Actual End Date (required)
For example: 12/31/2021
- MinAllocationYear: Earliest Allocation Year (required)
For example: 2016
 BOA_3 Copy Copy
Allocation Summary by Admin Location 1 Get Allocation Summary data by Admin Location 1
Parameters
- ShowAllPooledFunds: Show All Funds (optional)
For example: 1 (Yes) and 0 (No)
 ALLOC_SUMMARY_LOCATION1 Copy Copy
Annual Report - Sub Implementing Partners Annual Report Query to get the list of Sub Implementing Partners for approved projects
Parameters
- MinAllocationYear: Earliest Allocation Year (optional)
For example: 2016
 AR_QUERY_43 Copy Copy
Annual Report - Allocations - Admin Level 2 by People targeted with target type Annual Report Query for Admin level 2 by people targeted with people target type
Parameters
- AllocationYears: Allocation Years (comma-separated) (required)
For example: 2020,2021
- LastApprovalDate: Last Approval Date (in MM/DD/YYYY format) (required)
For example: 12/31/2021
 AR_QUERY_44 Copy Copy
Annual Report - Beneficiaries targeted and reached by Beneficiary type and Project Annual Report Query for number of beneficiaries targeted and reached by beneficiary type and project detail. Output is project specific extract of AR_QUERY_26.
Parameters
- StartDate: Report Approved Start Date (in MM/DD/YYYY format) (required)
For example: 01/01/2020
- EndDate: Report Approved End Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_26.1 Copy Copy
Annual Report - Cash Tracking for OneGMS projects Annual Report Query for Allocation amount and percentage for type of assistance in-kind and cash. Data can be used to generate output for Query #22. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2020
- LastApprovalDate: Last Approval Date (in MM/DD/YYYY format) (optional)
For example: 12/31/2020
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 & CERF=2
 AR_QUERY_27_OneGMS Copy Copy
Annual Report - Aggregation of People Assisted by Admin Location Level Annual Report query for finding the number of beneficiaries targeted by admin location level.
Parameters
- AllocationYear: Allocation Year (required)
For example: 2020
- LastApprovalDate: Last Approval Date (in MM/DD/YYYY format) (required)
For example: 12/31/2020
 AR_QUERY_45 Copy Copy
OneGMS - Project Sub Grants Full Dump Full dump extract of Project Sub Grants data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 & CERF=2
 SUB_IP_OneGMS Copy Copy
OneGMS - Project Activity Full Dump Full dump extract of Project Activity data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 & CERF=2
 ACTIVITY_OneGMS Copy Copy
OneGMS - Project Affected People Full Dump Full dump extract of Project Affected People data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 & CERF=2
 AFFECTED_PEOPLE_OneGMS Copy Copy
OneGMS - Project Budget Full Dump Full dump extract of Project Budget data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 & CERF=2
 BUDGET_OneGMS Copy Copy
OneGMS - Project Cluster Affected People Full Dump Full dump extract of Project Cluster Affected People data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 & CERF=2
 CLUSTER_AFFECTED_PEOPLE_OneGMS Copy Copy
OneGMS - Project Cost Effective Analysis Full Dump Full dump extract of Project Cost Effective Analysis data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 & CERF=2
 COST_EFFECTIVE_ANALYSIS_OneGMS Copy Copy
OneGMS - Project HRP Cluster Objective Full Dump Full dump extract of Project HRP Cluster Objective data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 & CERF=2
 HRP_CLUSTEROBJECTIVE_OneGMS Copy Copy
OneGMS - Project Location Activities Full Dump Full dump extract of Project Location Activities data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 & CERF=2
 LOCATION_ACTIVITIES_OneGMS Copy Copy
OneGMS - Project Location Affected People Full Dump Full dump extract of Project Location Affected People data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 & CERF=2
 LOCATION_AFFECTED_PEOPLE_OneGMS Copy Copy
OneGMS - Project Locations Full Dump Full dump extract of Project Locations data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 OR CERF=2
 LOCATIONS_OneGMS Copy Copy
OneGMS - Project Location Types Full Dump Full dump extract of Project Location Types data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- LocationTypeYear: Location Type Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 OR CERF=2
 LOCATION_TYPES_OneGMS Copy Copy
OneGMS - Project Outcome Full Dump Full dump extract of Project Outcome data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 OR CERF=2
 OUTCOME_OneGMS Copy Copy
OneGMS - Project Outcome Indicator Full Dump Full dump extract of Project Outcome Indicator data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 OR CERF=2
 OUTCOME_INDICATOR_OneGMS Copy Copy
OneGMS - Project Output Indicator Full Dump Full dump extract of Project Output Indicator data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 OR CERF=2
 OUTPUT_INDICATOR_OneGMS Copy Copy
OneGMS - Project Outputs Full Dump Full dump extract of Project Outputs data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 OR CERF=2
 OUTPUTS_OneGMS Copy Copy
OneGMS - Project Full Dump Full dump extract of Project data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 OR CERF=2
 PROJECT_OneGMS Copy Copy
OneGMS - Project Cluster Full Dump Full dump extract of Project Cluster data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 OR CERF=2
 PROJECT_CLUSTER_OneGMS Copy Copy
OneGMS - Project Contacts Full Dump Full dump extract of Project Contacts data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 OR CERF=2
 PROJECT_CONTACTS_OneGMS Copy Copy
OneGMS - Project Detail Full Dump Full dump extract of Project Detail data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 OR CERF=2
 PROJECT_DETAIL_OneGMS Copy Copy
OneGMS - Project HRP Full Dump Full dump extract of Project HRP data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 OR CERF=2
 PROJECT_HRP_OneGMS Copy Copy
OneGMS - Project Other Funding Full Dump Full dump extract of Project Other Funding data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 OR CERF=2
 PROJECT_OTHER_FUNDING_OneGMS Copy Copy
OneGMS - Project Revision Full Dump Full dump extract of Revision data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 OR CERF=2
 REVISION_OneGMS Copy Copy
OneGMS - Project Workplan Full Dump Full dump extract of Workplan data for OneGMS projects. Compatible with: OneGMS Projects only
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 OR CERF=2
 WORKPLAN_OneGMS Copy Copy
PF Organization Master - Detail API to return detailed information of Organizations
Parameters
- FundTypeId: Fund Type Id (optional)
For example: 1 or 2. 1 for CBPF and 2 for CERF
 PF_ORG_DETAIL Copy Copy
CERF Allocation People Targeted API to return CERF Allocation details with People targeted APIDAT_CERF_ALLOC_PPL Copy Copy
CERF Project Detail API to return CERF Project detail. API includes detail on sectors, people targeted, programming markers, etc.
Parameters
- ShowOnlyApproved: Show Only Approved (optional)
For example: 0 for No. 1 for Yes (Default)
 APIDAT_CERF_PROJ_DET Copy Copy
CERF Project KPI Timelines API to return CERF Project KPI Timelines details.
Parameters
- ShowOnlyApproved: Show Only Approved (optional)
For example: 0 for No. 1 for Yes (Default)
 APIDAT_CERF_PRJ_KPI Copy Copy
CERF Allocation Cluster Beneficiaries API to return CERF Allocation Cluster Beneficiaries. APIDAT_CERF_ALLOC_CLSTR_BENEF Copy Copy
Project Question API to get all OneGMS Project Question Data for both CERF & CBPF.
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 / CERF=2
- IsApproved: IsApproved (optional)
For example: Not Approved = 0 / Approved = 1
APIDAT_PROJ_QUES Copy Copy
Financial Report API to get all OneGMS Financial Report Data for both CERF and CBPF
Parameters
- AllocationYear: Allocation Year (optional)
For example: 2023
- FundTypeId: Fund Type Id (optional)
For example: CBPF=1 / CERF=2
 APIDAT_FIN_RPT Copy Copy
Case incident overview This API returns case and incident overview data extract for provided pooled fund,incidentTypes,statusCodes,detectionMethods and ongoingMeasures. Copy Copy
Additional assurance measures This API returns Additional Assurance Measures data extract for provided pooled fund and AdditionalAssuranceMeasureTypeId. Copy Copy
Conservative measures This API returns Conservative Measures data extract for provided pooled fund,statusCodes and processStatusCode. Copy Copy
Inquiries This API returns Inquiries data extract for provided pooled fund,inquiryStatus,yearInquiryTriggered and Inquiry Types. Copy Copy
Partner overview This API returns Partner Overview data extract for provided pooled fund and processStatusCode. Copy Copy
Blocked Project Conservative measures This API returns Blocked Project Conservative Measures data extract for provided pooled fund,partners and projectCodes. Copy Copy