Pooled Fund:

CBPF API vo3

Version 1.1.38

Error in Angular Module:{{error}}

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
Blanket NCE Report Blanket NCE Report BLNKT_NCE 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