API Documentation

This document is a work in progress and your opinion helps us to improve. Please let us know what we can do better. Thanks! support@procurios.com

Fundraising exports

Export large sets of broad data from mod_fundraising

Accept header for requests to Fundraising exports

application/vnd.procurios.fundraising+json; version=1

Pledges GET

URL: /l/fundraising_api/pledge/export

Scope:

fundraising/pledge/export
Last used: Never

Get a lot of information on pledges, ordered by last modification

Parameters

Parameter Type Description
amount int

Number of results to return per page. (Default value: 25, maximum value: 1000)
page int

The api will provide 25 results per page by default
since datetime

Only get results created or updated since yyyy-mm-ddThh:mm:ss
until datetime

Only get results created or updated before yyyy-mm-ddThh:mm:ss
relationIds int[]

Limit the results to the given relationIds, as a single integer, comma-separated list of integers, or array of integers
Live testing disabled

Pledges

Request

json

Response

jsonStatus: 200
[
    {
        "id": 1,
        "creation_date": "2025-01-22 14:50:17",
        "first_date": "2025-01-01",
        "end_date": null,
        "one_off_instruction_date": null,
        "frequency": "Monthly",
        "amount": 10,
        "year_amount": 120,
        "currency": "EUR",
        "is_collectible": "No",
        "fund": "Algemeen fonds",
        "campaign": null,
        "action_code": null,
        "action": null,
        "channel": null,
        "left_via_action_code": null,
        "left_via_action": null,
        "left_via_channel": null,
        "reason_of_cancellation": null,
        "mandate_id": "",
        "payee_name": "",
        "creditor_id": "",
        "signing_date": "",
        "account_holder": "",
        "iban": "",
        "bic": "",
        "recent_direct_debit_date": "",
        "return_reason": "",
        "relation_id": 992,
        "first_name": "Bert",
        "insertion": null,
        "last_name": "Kamsteeg",
        "full_name": "Kamsteeg, B (Bert)",
        "email": "Bert.Kamsteeg@example.com",
        "aanhefformeel": "Dr. Kamsteeg",
        "aanhefinformeel": "Bert Kamsteeg",
        "aanhefvoornaam": "Bert",
        "ff_523_iban": "",
        "ff_523_bic": "",
        "address_0_adressee": "",
        "address_0_free_text": "",
        "address_0_street": "",
        "address_0_number": "",
        "address_0_number_add": "",
        "address_0_postcode": "",
        "address_0_town": "",
        "address_0_town_uppercase": "",
        "address_0_province": "",
        "address_0_country_code": "",
        "address_0_country": "",
        "address_2_adressee": "",
        "address_2_free_text": "",
        "address_2_street": "",
        "address_2_number": "",
        "address_2_number_add": "",
        "address_2_postcode": "",
        "address_2_town": "",
        "address_2_town_uppercase": "",
        "address_2_province": "",
        "address_2_country_code": "",
        "address_2_country": "",
        "address_1_adressee": "",
        "address_1_free_text": "",
        "address_1_street": "",
        "address_1_number": "",
        "address_1_number_add": "",
        "address_1_postcode": "",
        "address_1_town": "",
        "address_1_town_uppercase": "",
        "address_1_province": "",
        "address_1_country_code": "",
        "address_1_country": ""
    }
]

Donations GET

URL: /l/fundraising_api/donation/export

Scope:

fundraising/donation/export
Last used: Never

Get a lot of information on donations, ordered by creation date

Parameters

Parameter Type Description
amount int

Number of results to return per page. (Default value: 25, maximum value: 1000)
page int

The api will provide 25 results per page by default
since datetime

Only get results created or updated since yyyy-mm-ddThh:mm:ss
until datetime

Only get results created or updated before yyyy-mm-ddThh:mm:ss
relationIds int[]

Limit the results to the given relationIds, as a single integer, comma-separated list of integers, or array of integers
Live testing disabled

Donations

Request

json

Response

jsonStatus: 200
[
    {
        "id": 1,
        "date": "2025-01-03",
        "amount": "100.00",
        "anonymous": "No",
        "periodic": "No",
        "type": "Cash",
        "fund": "Algemeen fonds",
        "campaign": null,
        "action_code": null,
        "action": null,
        "channel": null,
        "payment_id": null,
        "donor_type": "",
        "creation_date": "2025-01-22T16:11:38+01:00",
        "relation_id": 992,
        "first_name": "Bert",
        "insertion": null,
        "last_name": "Kamsteeg",
        "full_name": "Kamsteeg, B (Bert)",
        "email": "Bert.Kamsteeg@example.com",
        "aanhefformeel": "Dr. Kamsteeg",
        "aanhefinformeel": "Bert Kamsteeg",
        "aanhefvoornaam": "Bert",
        "ff_523_iban": "",
        "ff_523_bic": "",
        "address_0_adressee": "",
        "address_0_free_text": "",
        "address_0_street": "",
        "address_0_number": "",
        "address_0_number_add": "",
        "address_0_postcode": "",
        "address_0_town": "",
        "address_0_town_uppercase": "",
        "address_0_province": "",
        "address_0_country_code": "",
        "address_0_country": "",
        "address_2_adressee": "",
        "address_2_free_text": "",
        "address_2_street": "",
        "address_2_number": "",
        "address_2_number_add": "",
        "address_2_postcode": "",
        "address_2_town": "",
        "address_2_town_uppercase": "",
        "address_2_province": "",
        "address_2_country_code": "",
        "address_2_country": "",
        "address_1_adressee": "",
        "address_1_free_text": "",
        "address_1_street": "",
        "address_1_number": "",
        "address_1_number_add": "",
        "address_1_postcode": "",
        "address_1_town": "",
        "address_1_town_uppercase": "",
        "address_1_province": "",
        "address_1_country_code": "",
        "address_1_country": ""
    }
]

Totals GET

URL: /l/fundraising_api/totals

Scope:

fundraising/totals
Last used: Never

Collect a summary of donation information (in cents) for a fund and/or campaign and/or period

Parameters

Parameter Type Description
from string

The api will provide results from this date (given as yyyy-mm-dd)
until string

The api will provide results before this date (given as yyyy-mm-dd)
campaign int[]

Limit the results to the given values, as a single integer, comma-separated list of integers, or array of integers
fund int[]

Limit the results to the given values, as a single integer, comma-separated list of integers, or array of integers
Live testing disabled

Totals

Request

json

Response

jsonStatus: 200
{
    "donations": 15,
    "donors": 12,
    "total_amount": {
        "currency": "EUR",
        "amount": 255000
    },
    "average_amount": {
        "currency": "EUR",
        "amount": 3000
    },
    "average_per_donor": {
        "currency": "EUR",
        "amount": 2500
    }
}