Blackbaud Raisers Edge NXT (preview)

Blackbaud Raiser's Edge NXT is een uitgebreide cloudoplossing voor fondsenwerving en donorbeheersoftware die speciaal is gebouwd voor non-profitorganisaties en de hele sociale goede gemeenschap.

Deze connector is beschikbaar in de volgende producten en regio's:

Dienst	Class	Regions
Copilot Studio	Premium	Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD)
Logic-apps	Standaard	Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD)
Power Apps	Premium	Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD)
Power Automate	Premium	Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD)

Contactpersoon
Naam	Ondersteuning voor Blackbaud
URL	https://www.blackbaud.com/support
E-mailen	skyapi@blackbaud.com

Connectormetagegevens
Uitgever	Blackbaud, Inc.
Webpagina	https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
Privacybeleid	https://www.blackbaud.com/privacy-shield
Categorieën	Verkoop en CRM; Productiviteit

Raiser's Edge NXT is een uitgebreide cloudoplossing voor fondsenwerving en donorbeheersoftware die speciaal is gebouwd voor non-profitorganisaties en de hele sociale goede community.

Deze connector is gebouwd op de SKY-API van Blackbaud en biedt bewerkingen om entiteiten te beheren die zijn gevonden in The Raiser's Edge NXT, waaronder:

Kiezers
Geschenken
Acties
Opmerkingen
Aangepaste velden
Campagnes
Fondsen
Beroep
en meer...

Raadpleeg de documentatie voor meer informatie.

Vereiste voorwaarden

Als u deze connector wilt gebruiken, moet u een Blackbaud ID-account hebben met toegang tot een of meer Blackbaud-omgevingen.

Daarnaast moet de beheerder van uw organisatie ook een actie op beheerniveau uitvoeren binnen het systeem om deze connector toegang te geven tot De Edge NXT van De Raiser. Meer informatie over deze vereisten vindt u in de eerste installatiedocumentatie .

Hoe kan ik referenties ophalen?

De beheerder van uw organisatie stuurt u een uitnodiging naar de Edge NXT-omgeving van de organisatie en configureert uw gebruikersaccountmachtigingen in de omgeving. Er zijn geen aanvullende referenties vereist voor het gebruik van deze connector.

Bekende problemen en beperkingen

De connector werkt in de context van uw gebruikersaccount en is daarom onderhevig aan uw gebruikersmachtigingen binnen de omgeving.

Beperkingslimieten

Name	Aanroepen	Verlengingsperiode
API-aanroepen per verbinding	500	60 seconden

Acties

Aangepast veld voor een campagne bijwerken	Hiermee werkt u een aangepast veld voor een campagne bij.
Aangepaste velden voor beroep weergeven	Hiermee worden de aangepaste velden voor een beroep weergegeven.
Aangepaste velden voor cadeaus weergeven	Hiermee worden de aangepaste velden voor een cadeau weergegeven.
Aangepaste velden voor fonds weergeven	Hiermee worden de aangepaste velden voor een fonds weergegeven.
Aangepaste velden voor lijstactie	Hiermee worden de aangepaste velden voor een actie weergegeven.
Aangepaste velden voor lijstcampagne	Hiermee worden de aangepaste velden voor een campagne weergegeven.
Aangepaste velden voor verkoopkans weergeven	Hiermee worden de aangepaste velden voor een verkoopkans weergegeven.
Aangepaste velden weergeven	Hiermee worden de aangepaste velden voor een samenstellend element weergegeven.
Beroep op lijst	Retourneert een lijst met beroepsvoorwaarden.
Bijlagen bij beroep weergeven	Geeft een lijst weer van de bijlagen voor een beroep.
Bijlagen bij lijstactie	Hiermee worden de bijlagen voor een actie weergegeven.
Cadeaubatches weergeven	Geef de cadeaubatches weer.
Cadeaubijlagen weergeven	Hiermee worden de bijlagen voor een cadeau weergegeven.
Cadeaus vermelden	Retourneert een lijst met geschenken.
Campagnebijlagen vermelden	Hiermee worden de bijlagen voor een campagne weergegeven.
Campagnes vermelden	Retourneert een lijst met campagnes.
Deelnemers aan een lijst met gebeurtenissen	Geeft een lijst weer van de deelnemers voor een gebeurtenis.
Deelnemerskosten vermelden	Hier worden de kosten voor een deelnemer vermeld.
Details van bevestiging van cadeau bijwerken	Hiermee worden de bevestigingsgegevens voor een cadeau bijgewerkt.
Details van cadeaubon bijwerken	Hiermee worden de ontvangstbewijsgegevens voor een cadeau bijgewerkt.
Donaties van deelnemers vermelden	Vermeldt de donaties voor een deelnemer.
Een aangepast actieveld maken	Hiermee maakt u een nieuw aangepast actieveld.
Een aangepast veld maken	Hiermee maakt u een nieuw aangepast veld voor samenstellen.
Een aangepast veld voor cadeaus bijwerken	Hiermee werkt u een aangepast veld voor cadeaus bij.
Een aangepast veld voor cadeaus maken	Hiermee maakt u een nieuw aangepast veld voor cadeaus.
Een aangepast veld voor een actie bijwerken	Hiermee werkt u een aangepast actieveld bij.
Een aangepast veld voor een beroep bijwerken	Hiermee werkt u een aangepast veld voor beroep bij.
Een aangepast veld voor een beroep maken	Hiermee maakt u een nieuw aangepast veld voor beroep.
Een aangepast veld voor een campagne maken	Hiermee maakt u een nieuw aangepast veld voor de campagne.
Een aangepast veld voor een fonds bijwerken	Hiermee werkt u een aangepast veld voor een fonds bij.
Een aangepast veld voor een fonds maken	Hiermee maakt u een aangepast veld voor een nieuw fonds.
Een aangepast veld voor een verkoopkans bijwerken	Hiermee wordt een aangepast veld voor een verkoopkans bijgewerkt.
Een aangepast veld voor samenstellen bijwerken	Hiermee wordt een aangepast veld bijgewerkt.
Een aangepast veld voor verkoopkansen maken	Hiermee maakt u een aangepast veld voor een nieuwe verkoopkans.
Een actiebijlage bijwerken	Hiermee werkt u een actiebijlage bij.
Een actiebijlage maken	Hiermee maakt u een nieuwe actiebijlage.
Een afzonderlijke relatie maken	Hiermee maakt u een nieuwe afzonderlijke relatie. Als de relatie met een andere component is, wordt er een wederzijdse relatie voor die samenstellende component gemaakt.
Een afzonderlijke samenstellende component maken	Hiermee maakt u een nieuwe afzonderlijke component.
Een beroep krijgen	Retourneert informatie over een beroep.
Een betaling voor deelnemerskosten maken	Hiermee maakt u een nieuwe vergoeding voor een deelnemer.
Een bijlage voor een beroep bijwerken	Hiermee werkt u een bijlage bij met een beroep.
Een bijlage voor een beroep maken	Hiermee maakt u een nieuwe bijlage voor een beroep.
Een cadeau aan batch toevoegen	Voeg een cadeau toe aan de opgegeven cadeaubatch.
Een cadeau krijgen	Retourneert informatie over een cadeau.
Een cadeau maken	Hiermee maakt u een nieuw cadeau.
Een cadeaubatch maken	Hiermee maakt u een nieuwe cadeaubatch.
Een cadeaubijlage bijwerken	Werkt een cadeaubijlage bij.
Een cadeaubijlage maken	Hiermee maakt u een nieuwe cadeaubijlage.
Een campagne ophalen	Retourneert informatie over een campagne.
Een campagnebijlage bijwerken	Hiermee werkt u een bijlage bij bij een campagne.
Een campagnebijlage maken	Hiermee maakt u een nieuwe campagnebijlage.
Een code voor een samenstellend verzoek maken	Hiermee maakt u een nieuwe aanvraagcode voor samenstellende elementen.
Een deelnemer bijwerken	Hiermee worden de details van een deelnemer bijgewerkt.
Een deelnemer maken	Hiermee maakt u een nieuwe deelnemer voor een gebeurtenis.
Een deelnemer ophalen	Retourneert informatie over een specifieke deelnemer aan een gebeurtenis.
Een deelnemerkosten maken	Hiermee maakt u een nieuwe vergoeding voor een deelnemer.
Een deelnemeroptie bijwerken	Hiermee werkt u de details van een deelnemeroptie bij.
Een documentlocatie maken	Hiermee maakt u een nieuwe unieke document-id en uploadlocatie voor gebruik met fysieke bijlagen. Het antwoord bevat instructies voor waar en hoe u de inhoud van het document uploadt.
Een donatie van een deelnemer maken	Hiermee maakt u een nieuwe donatie voor een deelnemer.
Een fonds verkrijgen	Retourneert informatie over een fonds.
Een fondsbijlage bijwerken	Werkt een fondsbijlage bij.
Een fondsbijlage maken	Hiermee maakt u een nieuwe fondsbijlage.
Een gebeurtenis bijwerken	Hiermee worden de details van een gebeurtenis bijgewerkt.
Een gebeurtenis maken	Hiermee maakt u een nieuwe gebeurtenis.
Een gebeurtenis ophalen	Retourneert informatie over een gebeurtenis.
Een gebeurteniskosten maken	Hiermee maakt u een nieuwe vergoeding voor een gebeurtenis.
Een inzamelingstoewijzing maken	Hiermee maakt u een nieuwe inzamelingstoewijzing.
Een lijst maken op basis van een set records	Hiermee maakt u een nieuwe lijst die is gefilterd op de opgegeven set records.
Een organisatie samenstellen	Hiermee maakt u een nieuwe organisatie samenstellen.
Een organisatierelatie maken	Hiermee maakt u een nieuwe organisatierelatie. Als de relatie met een andere component is, wordt er een wederzijdse relatie voor die samenstellende component gemaakt.
Een pakket ophalen	Retourneert informatie over een pakket.
Een samenstellend adres bijwerken	Werkt een samenstellend adres bij.
Een samenstellend adres maken	Hiermee maakt u een nieuw samenstellend adres.
Een samenstellend e-mailadres bijwerken	Hiermee werkt u een samenstellend e-mailadres bij.
Een samenstellend e-mailadres maken	Hiermee maakt u een nieuw samenstellend e-mailadres.
Een samenstellend onderwijs bijwerken	Werkt een samenstellend onderwijs bij.
Een samenstellend onderwijs maken	Hiermee maakt u een nieuw samenstellend onderwijs.
Een samenstellende actie bijwerken	Hiermee wordt een samenstellende actie bijgewerkt.
Een samenstellende actie maken	Hiermee maakt u een nieuwe samenstellende actie.
Een samenstellende actie ophalen	Retourneert informatie over een samenstellende actie.
Een samenstellende advocaatcode bijwerken	Hiermee werkt u een code voor een samenstellend verzoek bij.
Een samenstellende alias bijwerken	Hiermee wordt een samenstellende alias bijgewerkt.
Een samenstellende alias maken	Hiermee maakt u een nieuwe samenstellende alias.
Een samenstellende bijlage bijwerken	Werkt een samenstellende bijlage bij.
Een samenstellende bijlage maken	Hiermee maakt u een nieuwe samenstellende bijlage.
Een samenstellende classificatie maken	Hiermee maakt u een nieuwe classificatie voor samenstellende elementen.
Een samenstellende code bijwerken	Hiermee wordt een samenstellende code bijgewerkt.
Een samenstellende code maken	Hiermee maakt u een nieuwe samenstellende code.
Een samenstellende code verwijderen	Hiermee verwijdert u een samenstellende code.
Een samenstellende component bijwerken	Werkt een samenstellende component bij.
Een samenstellende component ophalen	Retourneert informatie over een samenstellend onderdeel.
Een samenstellende component zoeken	Voert een samenstellende zoekopdracht uit op basis van de opgegeven zoektekst. Ondersteunt voornaam, achternaam, voorkeursnaam, voormalige naam, alias, e-mailadres, telefoonnummer, adres of opzoek-id. Naamcombinaties zoals voornaam en achternaam of voorkeursnaam en achternaam zijn geldig, maar anders ondersteunt zoeken slechts één parameter tegelijk. Standaard bevatten zoekopdrachten resultaten die lijken op uw criteria. Zoekopdrachten naar 'Smith' bevatten bijvoorbeeld overeenkomsten voor 'Smyth' en andere alternatieve spelling. Deze zoekopdracht biedt geen ondersteuning voor jokertekens zoals * of ?. Zoekresultaten zijn beperkt tot 500 records.
Een samenstellende notitie bijwerken	Hiermee wordt een samenstellende notitie bijgewerkt.
Een samenstellende notitie maken	Hiermee maakt u een nieuwe samenstellende notitie.
Een samenstellende online aanwezigheid bijwerken	Hiermee wordt een samenstellende online aanwezigheid bijgewerkt.
Een samenstellende online aanwezigheid maken	Hiermee maakt u een nieuwe samenstellende online aanwezigheid.
Een samenstellende profielafbeelding bijwerken	Hiermee werkt u de huidige profielfoto voor een samenstellende gebruiker bij.
Een samenstellende profielfoto ophalen	Retourneert de huidige profielfoto voor een samenstellend onderdeel.
Een samenstellende relatie bijwerken	Werkt een relatie voor een samenstellende component bij. Als er een wederzijdse relatie bestaat, wordt deze ook gewijzigd om de wijzigingen weer te geven. Dit omvat geen wijzigingen in de eigenschap 'opmerkingen', die specifiek is voor elke record en onafhankelijk van elke record kan worden gewijzigd.
Een samenstellende telefoon bijwerken	Werkt een samenstellende telefoon bij.
Een samenstellende telefoon maken	Hiermee maakt u een nieuwe samenstellende telefoon.
Een samenstellende toestemmingsrecord maken	Hiermee maakt u een nieuwe samenstellende toestemmingsrecord.
Een verkoopkans bijwerken	Hiermee wordt een verkoopkans bijgewerkt.
Een verkoopkans krijgen	Retourneert informatie over een verkoopkans. Opmerking: Dit eindpunt retourneert de statuseigenschap met een latentie van ongeveer 10 minuten.
Een verkoopkans maken	Hiermee maakt u een nieuwe kans.
Een verkoopkansbijlage bijwerken	Hiermee werkt u een verkoopkansbijlage bij.
Een verkoopkansbijlage maken	Hiermee maakt u een nieuwe verkoopkansbijlage.
Eerste cadeau ophalen	Retourneert het eerste geschenk voor een samenstellende waarde.
Fondsbijlagen vermelden	Een lijst met bijlagen voor een fonds.
Fondsen vermelden	Retourneert een lijst met fondsen.
Gebeurteniskosten vermelden	Geeft een overzicht van de kosten voor een gebeurtenis.
Gebeurtenissen vermelden	Retourneert een lijst met gebeurtenissen.
Inzamelingstoewijzingen vermelden	Vermeld de opdrachten voor een inzamelingsactie.
Kostenbetalingen van deelnemers vermelden	Geeft een overzicht van de kostenbetalingen voor een deelnemer.
Krijg het beste cadeau van de kiezer	Retourneert het grootste geschenk voor een kieskerende.
Lijst samenstellende fondsenwervers	Een lijst met de inzamelingsopdrachten voor een samenstellend onderdeel.
Lijstacties	Retourneert een lijst met acties.
Ontvang het meest recente cadeau	Retourneert het laatste cadeau voor een samenstellende waarde.
Optie Een deelnemer maken	Hiermee maakt u een nieuwe deelnemeroptie voor een deelnemer.
Optie Gebeurtenisdeelnemer maken	Hiermee maakt u een nieuwe deelnemeroptie voor een gebeurtenis.
Opties voor deelnemers aan lijst met gebeurtenissen	Geeft een lijst weer van de opties van deelnemers voor een gebeurtenis.
Opties voor deelnemers weergeven	Geeft een lijst weer van de opties van deelnemers voor een deelnemer.
Pakketten weergeven	Retourneert een lijst met pakketten.
Records toevoegen aan een lijst	Voeg een set records toe aan een bestaande lijst.
Samenstellende acties vermelden	Hiermee worden de acties voor een samenstellende component weergegeven.
Samenstellende adressen vermelden	Geeft een lijst van de adressen voor een samenstellende component.
Samenstellende advocaatcodes vermelden	Hiermee worden de aanvraagcodes voor een samenstellend lid vermeld.
Samenstellende aliassen vermelden	Geeft een lijst van de aliassen voor een samenstellende component.
Samenstellende bijlagen vermelden	Geeft een lijst weer van de bijlagen voor een samenstellend onderdeel.
Samenstellende classificaties vermelden	Retourneert de lijst met beoordelingen voor een samenstellende waarde.
Samenstellende codes vermelden	Geeft een lijst weer van de samenstellende codes voor een samenstellend onderdeel.
Samenstellende e-mailadressen vermelden	Een lijst met de e-mailadressen voor een samenstellend onderdeel.
Samenstellende elementen vermelden	Retourneert een lijst met bestanddelen.
Samenstellende levensduur ophalen	Retourneert de levensduur die een samenvatting geeft voor een samenstellende waarde.
Samenstellende notities vermelden	Geeft een lijst weer van de notities voor een samenstellend onderdeel.
Samenstellende onderwijslijsten vermelden	Geeft een lijst weer van de opleidingsrecords voor een samenstellend onderdeel.
Samenstellende online aanwezigheidsstatussen vermelden	Geeft een lijst weer van de online aanwezigheid voor een samenstellende gebruiker.
Samenstellende relaties vermelden	Geeft een lijst weer van de relaties voor een samenstellend onderdeel.
Samenstellende telefoons vermelden	Geeft een lijst weer van de telefoons voor een samenstellend onderdeel.
Samenstellende toestemmingsrecords vermelden	Geeft een lijst weer van de toestemmingsrecords voor een samenstellend onderdeel.
Status van samenstellende prospect ophalen	Retourneert de huidige prospectstatus voor een samenstellend onderdeel.
Verkoopkansbijlagen weergeven	Geeft een lijst weer van de bijlagen voor een verkoopkans.
Verkoopkansen weergeven	Retourneert een lijst met verkoopkansen.

Aangepast veld voor een campagne bijwerken

Bewerkings-id:: EditCampaignCustomField

Hiermee werkt u een aangepast veld voor een campagne bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Aangepaste veld-id	custom_field_id	True	string	De systeemrecord-id van het aangepaste veld dat moet worden bijgewerkt.
body	body	True	dynamic	Een object dat de eigenschappen van het aangepaste veld vertegenwoordigt dat moet worden bijgewerkt.

Aangepaste velden voor beroep weergeven

Bewerkings-id:: ListAppealCustomFields

Hiermee worden de aangepaste velden voor een beroep weergegeven.

Parameters

Name	Sleutel	Vereist	Type	Description
Id van beroep	appeal_id	True	string	De systeemrecord-id van het beroep.

Retouren

Aangepaste velden

Body: FundraisingApi.ApiCollectionOfAppealCustomFieldRead

Aangepaste velden voor cadeaus weergeven

Bewerkings-id:: ListGiftCustomFields

Hiermee worden de aangepaste velden voor een cadeau weergegeven.

Parameters

Name	Sleutel	Vereist	Type	Description
Cadeau-id	gift_id	True	string	De systeemrecord-id van het cadeau.

Retouren

Aangepaste velden

Body: GiftApi.ApiCollectionOfGiftCustomFieldRead

Aangepaste velden voor fonds weergeven

Bewerkings-id:: ListFundCustomFields

Hiermee worden de aangepaste velden voor een fonds weergegeven.

Parameters

Name	Sleutel	Vereist	Type	Description
Fonds-id	fund_id	True	string	De systeemrecord-id van het fonds.

Retouren

Aangepaste velden

Body: FundraisingApi.ApiCollectionOfFundCustomFieldRead

Aangepaste velden voor lijstactie

Bewerkings-id:: ListActionCustomFields

Hiermee worden de aangepaste velden voor een actie weergegeven.

Parameters

Name	Sleutel	Vereist	Type	Description
Actie-ID	action_id	True	string	De systeemrecord-id van de actie.

Retouren

Aangepaste velden

Body: ConstituentApi.ApiCollectionOfActionCustomFieldRead

Aangepaste velden voor lijstcampagne

Bewerkings-id:: ListCampaignCustomFields

Hiermee worden de aangepaste velden voor een campagne weergegeven.

Parameters

Name	Sleutel	Vereist	Type	Description
Campagne-id	campaign_id	True	string	De systeemrecord-id van de campagne.

Retouren

Aangepaste velden

Body: FundraisingApi.ApiCollectionOfCampaignCustomFieldRead

Aangepaste velden voor verkoopkans weergeven

Bewerkings-id:: ListOpportunityCustomFields

Hiermee worden de aangepaste velden voor een verkoopkans weergegeven.

Parameters

Name	Sleutel	Vereist	Type	Description
Verkoopkans-id	opportunity_id	True	string	De systeemrecord-id van de verkoopkans.

Retouren

Aangepaste velden

Body: OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead

Aangepaste velden weergeven

Bewerkings-id:: ListConstituentCustomFields

Hiermee worden de aangepaste velden voor een samenstellend element weergegeven.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Aangepaste velden

Body: ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

Beroep op lijst

Bewerkings-id:: ListAppeals

Retourneert een lijst met beroepsvoorwaarden.

Parameters

Name	Sleutel	Type	Description
Limit	limit	integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 5000.
Offset	offset	integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering.
Inactief opnemen?	include_inactive	boolean	Inactieve beroepen opnemen?
Toegevoegd aan of na	date_added	date-time	Filter de resultaten op aantekeningen die zijn gemaakt op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').
Gewijzigd op of na	last_modified	date-time	Filter de resultaten op aantekeningen die zijn gewijzigd op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').

Retouren

Beroep

Body: FundraisingApi.ApiCollectionOfAppealRead

Bijlagen bij beroep weergeven

Bewerkings-id:: ListAppealAttachments

Geeft een lijst weer van de bijlagen voor een beroep.

Parameters

Name	Sleutel	Vereist	Type	Description
Id van beroep	appeal_id	True	string	De systeemrecord-id van het beroep.

Retouren

Bijlagen

Body: FundraisingApi.ApiCollectionOfAppealAttachmentRead

Bijlagen bij lijstactie

Bewerkings-id:: ListActionAttachments

Hiermee worden de bijlagen voor een actie weergegeven.

Parameters

Name	Sleutel	Vereist	Type	Description
Actie-ID	action_id	True	string	De systeemrecord-id van de actie.

Retouren

Bijlagen

Body: ConstituentApi.ApiCollectionOfActionAttachmentRead

Cadeaubatches weergeven

Bewerkings-id:: ListGiftBatches

Geef de cadeaubatches weer.

Parameters

Name	Sleutel	Type	Description
Batchnummer	batch_number	string	Vertegenwoordigt een filter voor resultaten die overeenkomen met het opgegeven getal.
Goedgekeurd?	approved	boolean	Vertegenwoordigt een filter voor de status van de cadeaubatch.
Zijn er uitzonderingen?	has_exceptions	boolean	Vertegenwoordigt een filter voor of de cadeaubatch uitzonderingen bevat.
Limit	limit	integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 5000.
Offset	offset	integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering.
Zoektekst	search_text	string	Vertegenwoordigt een filter voor tekst die is opgenomen in de velden batchbeschrijving of batchnummer.
Gemaakt door	created_by	string	Vertegenwoordigt een filter voor cadeaubatches die zijn gemaakt door de opgegeven gebruiker.

Retouren

Cadeaubatches

Body: GiftBatchApi.ApiCollectionOfGiftBatch

Cadeaubijlagen weergeven

Bewerkings-id:: ListGiftAttachments

Hiermee worden de bijlagen voor een cadeau weergegeven.

Parameters

Name	Sleutel	Vereist	Type	Description
Cadeau-id	gift_id	True	string	De systeemrecord-id van het cadeau.

Retouren

Bijlagen

Body: GiftApi.ApiCollectionOfGiftAttachmentRead

Cadeaus vermelden

Bewerkings-id:: ListGifts

Retourneert een lijst met geschenken.

Parameters

Name	Sleutel	Type	Description
List	list_id	string	Hiermee definieert u een lijst-id die wordt gebruikt om de set geschenken te filteren op de cadeaus die zijn opgenomen in de opgegeven lijst. Als deze waarde is ingesteld, worden andere opgegeven filters genegeerd.
Typologie	gift_type	string	Vertegenwoordigt een door komma's gescheiden lijst met cadeautypen om de resultaten te filteren. "MatchingGiftPledge,RecurringGift" retourneert bijvoorbeeld alleen geschenken van het type MatchingGiftPledge of RecurringGift.
Samenstellende id	constituent_id	string	Vertegenwoordigt een door komma's gescheiden lijst met samenstellende id's om de resultaten te filteren. "280.1232" retourneert bijvoorbeeld alleen geschenken van samenstellende 280 of samenstellende 1232.
Campagne-id	campaign_id	string	Vertegenwoordigt een door komma's gescheiden lijst met campagne-id's om de resultaten te filteren. '506.918' retourneert bijvoorbeeld alleen geschenken voor campagne 506 of campagne 918.
Fonds-id	fund_id	string	Vertegenwoordigt een door komma's gescheiden lijst met fonds-id's om de resultaten te filteren. "506.918" retourneert bijvoorbeeld alleen geschenken om 506 of fonds 918 te financieren.
Id van beroep	appeal_id	string	Vertegenwoordigt een door komma's gescheiden lijst met aanroep-id's om de resultaten te filteren. "506.918" retourneert bijvoorbeeld alleen geschenken voor beroep 506 of beroep 918.
Limit	limit	integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 5000.
Offset	offset	integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering.
Begindatum cadeau	start_gift_date	date-time	Vertegenwoordigt een filter voor geschenken met een cadeaudatum op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').
Einddatum cadeau	end_gift_date	date-time	Vertegenwoordigt een filter voor geschenken met een cadeaudatum op of vóór de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').
Cadeaubedrag starten	start_gift_amount	double	Vertegenwoordigt een filter voor geschenken met een bedrag dat groter is dan of gelijk is aan het opgegeven bedrag.
Cadeaubedrag beëindigen	end_gift_amount	double	Vertegenwoordigt een filter voor geschenken met een bedrag kleiner dan of gelijk aan het opgegeven bedrag.
Poststatus	post_status	string	Vertegenwoordigt een door komma's gescheiden lijst met statussen van cadeauberichten om de resultaten te filteren. 'DoNotPost', Gepost, retourneert bijvoorbeeld alleen geschenken die zijn gemarkeerd als DoNotPost of Geplaatst.
Ontvangststatus	receipt_status	string	Vertegenwoordigt een door komma's gescheiden lijst met statussen van cadeaubonnen om de resultaten te filteren. "DoNotReceipt,Receipted" retourneert bijvoorbeeld alleen geschenken die zijn gemarkeerd als DoNotReceipt of Ontvangstbewijs.
Bevestigingsstatus	acknowledgement_status	string	Vertegenwoordigt een door komma's gescheiden lijst met statussen van cadeaubevestigingen om de resultaten te filteren. 'DoNotAcknowledge', Bevestigd' retourneert bijvoorbeeld alleen geschenken die zijn gemarkeerd als DoNotAcknowledge of Bevestigd.
Toegevoegd aan of na	date_added	date-time	Filter de resultaten op geschenken die zijn gemaakt op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').
Gewijzigd op of na	last_modified	date-time	Filter de resultaten op cadeaus die zijn gewijzigd op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').

Retouren

Geschenken

Body: GiftApi.ApiCollectionOfGiftRead

Campagnebijlagen vermelden

Bewerkings-id:: ListCampaignAttachments

Hiermee worden de bijlagen voor een campagne weergegeven.

Parameters

Name	Sleutel	Vereist	Type	Description
Campagne-id	campaign_id	True	string	De systeemrecord-id van de campagne.

Retouren

Bijlagen

Body: FundraisingApi.ApiCollectionOfCampaignAttachmentRead

Campagnes vermelden

Bewerkings-id:: ListCampaigns

Retourneert een lijst met campagnes.

Parameters

Name	Sleutel	Type	Description
Limit	limit	integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 5000.
Offset	offset	integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering.
Inactief opnemen?	include_inactive	boolean	Inactieve campagnes opnemen?
Toegevoegd aan of na	date_added	date-time	Filter de resultaten op campagnes die zijn gemaakt op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').
Gewijzigd op of na	last_modified	date-time	Filter de resultaten op campagnes die zijn gewijzigd op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').

Retouren

Campagnes

Body: FundraisingApi.ApiCollectionOfCampaignRead

Deelnemers aan een lijst met gebeurtenissen

Bewerkings-id:: ListEventParticipants

Geeft een lijst weer van de deelnemers voor een gebeurtenis.

Parameters

Name	Sleutel	Vereist	Type	Description
Gebeurtenis-id	event_id	True	string	De systeemrecord-id van de gebeurtenis.
RSVP-status	rsvp_status		string	Filter deelnemers op basis van de RSVP-status.
Uitnodigingsstatus	invitation_status		string	Filter deelnemers op basis van de uitnodigingsstatus.
Deelnameniveau	participation_level		string	Filter deelnemers op basis van betrokkenheidsniveau.
Bijgewoond?	attended_filter		boolean	Filter voor het opnemen of uitsluiten van deelnemers die zijn gemarkeerd als deelgenomen.
Betaalde kosten?	fees_paid_filter		boolean	Filter op het opnemen of uitsluiten van deelnemers die hun kosten hebben betaald.
Limit	limit		integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 10000.
Offset	offset		integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering.
Is een kieskerende?	is_constituent_filter		boolean	Filter op het opnemen of uitsluiten van deelnemers die samenstellende personen zijn.
Heeft een in aanmerking komend e-mailbericht?	email_eligible_filter		boolean	Filteren op het opnemen of uitsluiten van deelnemers op basis van of ze een primair e-mailadres hebben dat niet is gemarkeerd als Geen e-mail?
Heeft een in aanmerking komende telefoon?	phone_call_eligible_filter		boolean	Filter op het opnemen of uitsluiten van deelnemers op basis van of ze een primair telefoonnummer hebben dat niet is gemarkeerd als Niet bellen.
Naam	name		string	Filter op deelnemers die overeenkomen met de opgegeven naam.
Toegevoegd aan of na	date_added		date-time	Filter de resultaten op deelnemers die zijn gemaakt op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').
Gewijzigd op of na	last_modified		date-time	Filter de resultaten op deelnemers die zijn gewijzigd op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').

Retouren

Deelnemers

Body: EventApi.ApiCollectionOfParticipantListEntry

Deelnemerskosten vermelden

Bewerkings-id:: ListParticipantFees

Hier worden de kosten voor een deelnemer vermeld.

Parameters

Name	Sleutel	Vereist	Type	Description
Deelnemers-ID	participant_id	True	string	De systeemrecord-id van de deelnemer.
Limit	limit		integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 10000.
Offset	offset		integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering. De standaardwaarde is 0.

Retouren

Kosten

Body: EventApi.ApiCollectionOfParticipantFee

Details van bevestiging van cadeau bijwerken

Bewerkings-id:: EditGiftAcknowledgement

Hiermee worden de bevestigingsgegevens voor een cadeau bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Bevestigings-id	acknowledgement_id	True	string	De systeemrecord-id van de cadeaubevestiging die moet worden bijgewerkt. Het gebruikt de id van het bovenliggende cadeau als waarde.
Toestand	status		string	De status van de bevestiging. Wanneer de status is ingesteld op DoNotAcknowledge, moeten letter en datum null zijn. Wanneer de status is ingesteld op NeedsAcknowledgement, moet de datum null zijn.
Datum	date		date-time	De datum die is gekoppeld aan de bevestiging (bijvoorbeeld: '2020-09-18T04:13:56Z').
Brief	letter		string	De brief die aan de bevestiging is gekoppeld.

Details van cadeaubon bijwerken

Bewerkings-id:: EditGiftReceipt

Hiermee worden de ontvangstbewijsgegevens voor een cadeau bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Ontvangstbewijs-id	receipt_id	True	string	De systeemrecord-id van het ontvangstbewijs dat moet worden bijgewerkt. Het gebruikt de id van het bovenliggende cadeau als waarde.
Toestand	status		string	De ontvangststatus van het cadeau. Wanneer de status is ingesteld op NeedsReceipt of DoNotReceipt, moet de ontvangstdatum null zijn.
waarde	value		double	De monetaire waarde.
Datum	date		date-time	De datum op het ontvangstbewijs (bijvoorbeeld: '2020-09-18T04:13:56Z').
Number	number		integer	Het nummer van het ontvangstbewijs.

Donaties van deelnemers vermelden

Bewerkings-id:: ListParticipantDonations

Vermeldt de donaties voor een deelnemer.

Parameters

Name	Sleutel	Vereist	Type	Description
Deelnemers-ID	participant_id	True	string	De systeemrecord-id van de deelnemer.
Limit	limit		integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 10000.
Offset	offset		integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering. De standaardwaarde is 0.

Retouren

Donaties

Body: EventApi.ApiCollectionOfParticipantDonation

Een aangepast actieveld maken

Bewerkings-id:: CreateActionCustomField

Hiermee maakt u een nieuw aangepast actieveld.

Parameters

Name	Sleutel	Vereist	Type	Description
body	body	True	dynamic	Een object dat het aangepaste veld vertegenwoordigt dat moet worden gemaakt.

Retouren

Aangepast veld voor actie gemaakt

Body: ConstituentApi.CreatedActionCustomField

Een aangepast veld maken

Bewerkings-id:: CreateConstituentCustomField

Hiermee maakt u een nieuw aangepast veld voor samenstellen.

Parameters

Name	Sleutel	Vereist	Type	Description
body	body	True	dynamic	Een object dat het aangepaste veld vertegenwoordigt dat moet worden gemaakt.

Retouren

Aangepast veld gemaakt

Body: ConstituentApi.CreatedConstituentCustomField

Een aangepast veld voor cadeaus bijwerken

Bewerkings-id:: EditGiftCustomField

Hiermee werkt u een aangepast veld voor cadeaus bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Aangepaste veld-id	custom_field_id	True	string	De systeemrecord-id van het aangepaste veld dat moet worden bijgewerkt.
body	body	True	dynamic	Een object dat de eigenschappen van het aangepaste veld vertegenwoordigt dat moet worden bijgewerkt.

Een aangepast veld voor cadeaus maken

Bewerkings-id:: CreateGiftCustomField

Hiermee maakt u een nieuw aangepast veld voor cadeaus.

Parameters

Name	Sleutel	Vereist	Type	Description
body	body	True	dynamic	Een object dat het aangepaste veld vertegenwoordigt dat moet worden gemaakt.

Retouren

Aangepast veld voor cadeau gemaakt

Body: GiftApi.CreatedGiftCustomField

Een aangepast veld voor een actie bijwerken

Bewerkings-id:: EditActionCustomField

Hiermee werkt u een aangepast actieveld bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Aangepaste veld-id	custom_field_id	True	string	De systeemrecord-id van het aangepaste veld dat moet worden bijgewerkt.
body	body	True	dynamic	Een object dat de eigenschappen van het aangepaste veld vertegenwoordigt dat moet worden bijgewerkt.

Een aangepast veld voor een beroep bijwerken

Bewerkings-id:: EditAppealCustomField

Hiermee werkt u een aangepast veld voor beroep bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Aangepaste veld-id	custom_field_id	True	string	De systeemrecord-id van het aangepaste veld dat moet worden bijgewerkt.
body	body	True	dynamic	Een object dat de eigenschappen van het aangepaste veld vertegenwoordigt dat moet worden bijgewerkt.

Een aangepast veld voor een beroep maken

Bewerkings-id:: CreateAppealCustomField

Hiermee maakt u een nieuw aangepast veld voor beroep.

Parameters

Name	Sleutel	Vereist	Type	Description
body	body	True	dynamic	Een object dat het aangepaste veld vertegenwoordigt dat moet worden gemaakt.

Retouren

Aangepast veld voor beroep gemaakt

Body: FundraisingApi.CreatedAppealCustomField

Een aangepast veld voor een campagne maken

Bewerkings-id:: CreateCampaignCustomField

Hiermee maakt u een nieuw aangepast veld voor de campagne.

Parameters

Name	Sleutel	Vereist	Type	Description
body	body	True	dynamic	Een object dat het aangepaste veld vertegenwoordigt dat moet worden gemaakt.

Retouren

Aangepast veld voor campagne gemaakt

Body: FundraisingApi.CreatedCampaignCustomField

Een aangepast veld voor een fonds bijwerken

Bewerkings-id:: EditFundCustomField

Hiermee werkt u een aangepast veld voor een fonds bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Aangepaste veld-id	custom_field_id	True	string	De systeemrecord-id van het aangepaste veld dat moet worden bijgewerkt.
body	body	True	dynamic	Een object dat de eigenschappen van het aangepaste veld vertegenwoordigt dat moet worden bijgewerkt.

Een aangepast veld voor een fonds maken

Bewerkings-id:: CreateFundCustomField

Hiermee maakt u een aangepast veld voor een nieuw fonds.

Parameters

Name	Sleutel	Vereist	Type	Description
body	body	True	dynamic	Een object dat het aangepaste veld vertegenwoordigt dat moet worden gemaakt.

Retouren

Aangepast veld voor fonds gemaakt

Body: FundraisingApi.CreatedFundCustomField

Een aangepast veld voor een verkoopkans bijwerken

Bewerkings-id:: EditOpportunityCustomField

Hiermee wordt een aangepast veld voor een verkoopkans bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Aangepaste veld-id	custom_field_id	True	string	De systeemrecord-id van het aangepaste veld dat moet worden bijgewerkt.
body	body	True	dynamic	Een object dat de eigenschappen van het aangepaste veld vertegenwoordigt dat moet worden bijgewerkt.

Een aangepast veld voor samenstellen bijwerken

Bewerkings-id:: EditConstituentCustomField

Hiermee wordt een aangepast veld bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Aangepaste veld-id	custom_field_id	True	string	De systeemrecord-id van het aangepaste veld dat moet worden bijgewerkt.
body	body	True	dynamic	Een object dat de eigenschappen van het aangepaste veld vertegenwoordigt dat moet worden bijgewerkt.

Een aangepast veld voor verkoopkansen maken

Bewerkings-id:: CreateOpportunityCustomField

Hiermee maakt u een aangepast veld voor een nieuwe verkoopkans.

Parameters

Name	Sleutel	Vereist	Type	Description
body	body	True	dynamic	Een object dat het aangepaste veld vertegenwoordigt dat moet worden gemaakt.

Retouren

Een verkoopkansbijlage gemaakt

Body: OpportunityApi.CreatedOpportunityCustomField

Een actiebijlage bijwerken

Bewerkings-id:: EditActionAttachment

Hiermee werkt u een actiebijlage bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Bijlage-ID	attachment_id	True	string	De systeemrecord-id van de bijlage die moet worden bijgewerkt.
Naam	name		string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date		date-time	De datum van de bijlage (bijvoorbeeld: '2020-09-18T04:13:56Z').
URL	url		string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.

Een actiebijlage maken

Bewerkings-id:: CreateActionAttachment

Hiermee maakt u een nieuwe actiebijlage.

Parameters

Name	Sleutel	Vereist	Type	Description
Actie-ID	parent_id	True	string	De systeemrecord-id van de actie die aan de bijlage is gekoppeld.
Typologie	type	True	string	Het bijlagetype. Fysieke bijlagen zijn geüploade bestanden, zoals afbeeldingen, PDF-bestanden of Word-documenten die lokaal of op het netwerk worden opgeslagen. Ze worden opgeslagen en beheerd in het systeem. Koppelingsbijlagen zijn koppelingen naar bestanden zoals afbeeldingen, blogberichten of YouTube-video's die online of in een cloudopslagaccount zijn. Ze worden extern opgeslagen en beheerd.
Naam	name		string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date		date-time	De datum van de bijlage (bijvoorbeeld: '2020-09-18T04:13:56Z'). Dit veld wordt standaard ingesteld op de huidige datum en tijd, indien niet opgegeven.
URL	url		string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.
Bestandsnaam	file_name		string	De naam van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Bestands-id	file_id		string	De id van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-id	thumbnail_id		string	De id van de miniatuur. Tekenlimiet: 36. Alleen voor fysieke bijlagen.

Retouren

Actiebijlage gemaakt

Body: ConstituentApi.CreatedActionAttachment

Een afzonderlijke relatie maken

Bewerkings-id:: CreateIndividualRelationship

Hiermee maakt u een nieuwe afzonderlijke relatie. Als de relatie met een andere component is, wordt er een wederzijdse relatie voor die samenstellende component gemaakt.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die aan de relatie is gekoppeld.
Relatie-id	relation_id	True	string	De systeemrecord-id van de gerelateerde persoon.
Typologie	type		string	Het type relatie dat de relatie vertegenwoordigt.
Wederkerig type	reciprocal_type		string	Beschrijft de relatie van de samenstellende component met de gerelateerde component. Bijvoorbeeld, in een relatie tussen een mannelijke samenstellende en een vrouwelijke zus, zou het wederzijdse relatietype broer zijn.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Is echtgenoot?	is_spouse		boolean	Is de gerelateerde persoon de echtgenoot van het kiesdistrict?
Is het hoofd van het huishouden?	is_constituent_head_of_household		boolean	Is het hoofd van het huishouden?
Is het hoofd van de echtgenoot van het huishouden?	is_spouse_head_of_household		boolean	Is de echtgenoot het hoofd van het huishouden?
Opmerkingen	comment		string	Aanvullende opmerkingen over de relatie.

Retouren

Afzonderlijke relatie gemaakt

Body: ConstituentApi.CreatedIndividualRelationship

Een afzonderlijke samenstellende component maken

Bewerkings-id:: CreateIndividualConstituent

Hiermee maakt u een nieuwe afzonderlijke component.

Parameters

Name	Sleutel	Vereist	Type	Description
Title	title		string	De primaire titel van de samenstellende persoon.
Voornaam	first		string	De voornaam van de samenstellende persoon. Tekenlimiet: 50.
Achternaam	last	True	string	De achternaam van de kiezer. Tekenlimiet: 100.
Achtervoegsel	suffix		string	Het primaire achtervoegsel van het samenstellende onderdeel.
Opzoek-id	lookup_id		string	De door de gebruiker gedefinieerde id voor de samenstellende gebruiker.
type	type	True	string	Het adrestype.
country	country		string	Het land van het adres (kan de id, naam of afkorting zijn).
lijnen	address_lines		string	De adresregels. Tekenlimiet: 150.
city	city		string	De plaats van het adres (gebruik niet in combinatie met het veld Buitenwijk).
state	state		string	De status van het adres.
postcode	postal_code		string	De postcode van het adres. Tekenlimiet: 12.
voorstad	suburb		string	De buitenwijk van het adres (gebruik niet in combinatie met het veld Plaats).
graafschap	county		string	De provincie van het adres.
start	start		date	De datum waarop de samenstelling op dit adres begon te wonen (bijvoorbeeld: 2005-09-18).
einde	end		date	De datum waarop de samenstelling niet meer op dit adres is gevestigd (bijvoorbeeld: 2005-09-18).
type	type	True	string	Het telefoontype.
nummer	number	True	string	Het telefoonnummer.
is primair?	primary		boolean	Is dit het primaire telefoonnummer van de kiezer?
type	type	True	string	Het type e-mailadres.
address	address	True	string	Het e-mailadres.
is primair?	primary		boolean	Is dit het primaire e-mailadres van de samenstellende gebruiker?
type	type	True	string	Het online aanwezigheidstype.
address	address	True	string	Het webadres voor de online aanwezigheid.
is primair?	primary		boolean	Is dit de primaire online aanwezigheid van de samenstellende gebruiker?
Voorkeursnaam	preferred_name		string	De voorkeursnaam van de samenstellende persoon. Tekenlimiet: 50.
Middelste naam	middle		string	De middelste naam van de samenstellende persoon. Tekenlimiet: 50.
Voormalige naam	former_name		string	De vroegere naam van de kiezer. Tekenlimiet: 100.
Titel 2	title_2		string	De secundaire titel van het kiesdistrict.
Achtervoegsel 2	suffix_2		string	Het secundaire achtervoegsel van het samenstellende onderdeel.
Geslacht	gender		string	Het geslacht van de kiezer.
Burgerlijke staat	marital_status		string	De burgerlijke staat van het kiesdistrict.
Geeft anoniem?	gives_anonymously		boolean	Geeft de kiezer anoniem?
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Geboorteplaats	birthplace		string	De geboorteplaats van het kiesdistrict.
Etniciteit	ethnicity		string	De etniciteit van het kiesdistrict.
Inkomsten	income		string	Het inkomen voor de kiezers.
Godsdienst	religion		string	De religie van het kiesdistrict.
Aangepaste geadresseerde?	custom_format		boolean	Is de primaire geadresseerde een aangepaste indeling?
Adresee-indeling	configuration_id		string	Primaire adreslijstconfiguratie (vereist tenzij een aangepaste indeling wordt gebruikt).
Aangepaste naam van geadresseerde	formatted_name		string	De naam van de primaire geadresseerde die is opgemaakt (vereist wanneer een aangepaste indeling wordt gebruikt). Tekenlimiet: 255.
Aangepaste aanhef?	custom_format		boolean	Is de primaire aanhef een aangepaste indeling?
Aanhefindeling	configuration_id		string	Primaire aanhefconfiguratie (vereist tenzij een aangepaste indeling wordt gebruikt).
Aangepaste naam van aanhef	formatted_name		string	Primaire aanhefnotatie opgemaakte naam (vereist wanneer een aangepaste indeling wordt gebruikt). Tekenlimiet: 255.

Retouren

Afzonderlijke samenstellende elementen gemaakt

Body: ConstituentApi.CreatedIndividualConstituent

Een beroep krijgen

Bewerkings-id:: GetAppeal

Retourneert informatie over een beroep.

Parameters

Name	Sleutel	Vereist	Type	Description
Id van beroep	appeal_id	True	string	De systeemrecord-id van het beroep om te krijgen.

Retouren

Appeal

Body: FundraisingApi.AppealRead

Een betaling voor deelnemerskosten maken

Bewerkings-id:: CreateParticipantFeePayment

Hiermee maakt u een nieuwe vergoeding voor een deelnemer.

Parameters

Name	Sleutel	Vereist	Type	Description
Deelnemers-ID	participant_id	True	string	De systeemrecord-id van de deelnemer.
Cadeau-id	gift_id	True	string	De systetm record-id van het cadeau waaraan de deelnemer vergoeding is gekoppeld.
Toegepast bedrag	applied_amount	True	double	Het bedrag van de betaling die van toepassing is op de kosten van de deelnemer.

Retouren

Betaling voor gemaakte deelnemerkosten

Body: EventApi.CreatedParticipantFeePayment

Een bijlage voor een beroep bijwerken

Bewerkings-id:: EditAppealAttachment

Hiermee werkt u een bijlage bij met een beroep.

Parameters

Name	Sleutel	Vereist	Type	Description
Bijlage-ID	attachment_id	True	string	De systeemrecord-id van de bijlage die moet worden bijgewerkt.
Naam	name		string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date		date-time	De datum van de bijlage (bijvoorbeeld: '2020-09-18T04:13:56Z').
URL	url		string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.

Een bijlage voor een beroep maken

Bewerkings-id:: CreateAppealAttachment

Hiermee maakt u een nieuwe bijlage voor een beroep.

Parameters

Name	Sleutel	Vereist	Type	Description
Id van beroep	parent_id	True	string	De systeemrecord-id van het beroep dat aan de bijlage is gekoppeld.
Typologie	type	True	string	Het bijlagetype. Fysieke bijlagen zijn geüploade bestanden, zoals afbeeldingen, PDF-bestanden of Word-documenten die lokaal of op het netwerk worden opgeslagen. Ze worden opgeslagen en beheerd in het systeem. Koppelingsbijlagen zijn koppelingen naar bestanden zoals afbeeldingen, blogberichten of YouTube-video's die online of in een cloudopslagaccount zijn. Ze worden extern opgeslagen en beheerd.
Naam	name		string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date		date-time	De datum van de bijlage (bijvoorbeeld: '2020-09-18T04:13:56Z'). Dit veld wordt standaard ingesteld op de huidige datum en tijd, indien niet opgegeven.
URL	url		string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.
Bestandsnaam	file_name		string	De naam van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Bestands-id	file_id		string	De id van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-id	thumbnail_id		string	De id van de miniatuur. Tekenlimiet: 36. Alleen voor fysieke bijlagen.

Retouren

Aanroepbijlage gemaakt

Body: FundraisingApi.CreatedAppealAttachment

Een cadeau aan batch toevoegen

Bewerkings-id:: AddGiftToBatch

Voeg een cadeau toe aan de opgegeven cadeaubatch.

Parameters

Name	Sleutel	Vereist	Type	Description
Lot	batch_id	True	string	De partij waaraan het cadeau wordt toegevoegd.
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel dat aan het cadeau is gekoppeld.
Aantal	value	True	double	Het geldbedrag van het cadeau.
Datum	date	True	date	De cadeaudatum (bijvoorbeeld: '2020-09-18').
Typologie	type	True	string	Het cadeautype.
campagne-id	campaign_id		string	De systeemrecord-id van de campagne die is gekoppeld aan de cadeausplitsing.
fonds-id	fund_id	True	string	De systeemrecord-id van het fonds dat is gekoppeld aan de cadeausplitsing.
beroeps-id	appeal_id		string	De systeemrecord-id van het beroep dat is gekoppeld aan de cadeausplitsing.
pakket-id	package_id		string	De systeemrecord-id van het pakket dat is gekoppeld aan de cadeausplitsing.
aantal	value	True	double	Het geldbedrag van de cadeausplitsing.
Betalingsmethode	payment_method	True	string	De betalingswijze.
Controlenummer	check_number		string	Het controlenummer (alleen van toepassing wanneer de betalingswijze 'PersonalCheck' is).
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Reference	reference		string	De betalingsreferentie (alleen van toepassing wanneer de betalingswijze 'Overig' is).
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Is anoniem?	is_anonymous		boolean	Is het cadeau anoniem? Als er geen waarde wordt opgegeven, wordt de standaard anoniemheid van de donor gebruikt.
Onderdeeltype	subtype		string	Het subtype van het cadeau.
Comment	reference		string	Notities voor het bijhouden van speciale details over een cadeau, zoals de motivatie erachter of een gedetailleerde beschrijving van een cadeau-in-kind.
Opzoek-id	lookup_id		string	De door de gebruiker gedefinieerde id voor het cadeau.
Geldinzamelingstegoeden gebruiken?	default_fundraiser_credits		boolean	Gebruikt u de standaardinzamelingstegoeden?
Voorlopig tegoed gebruiken?	default_soft_credits		boolean	De standaard soft credits gebruiken?
Kiesdistrict	constituency		string	De kiesdistrict van het geschenk.
Poststatus	post_status		string	De poststatus van het cadeau.
Postdatum	post_date		date	De datum waarop het cadeau is geplaatst (bijvoorbeeld: '2020-09-18').
Ontvangststatus	status	True	string	De ontvangststatus van het cadeau.
Ontvangstbedrag	value	True	double	Het geldbedrag van het ontvangstbewijs voor het cadeau.
Ontvangstdatum	date		date	De datum waarop het cadeau is ontvangen (bijvoorbeeld: '2020-09-18').

Retouren

Bevat een verzameling foutrecords voor batchgeschenken en de batchcadeaus die door de bewerking zijn toegevoegd

Results: GiftApi.BatchGiftAddResults

Een cadeau krijgen

Bewerkings-id:: GetGift

Retourneert informatie over een cadeau.

Parameters

Name	Sleutel	Vereist	Type	Description
Cadeau-id	gift_id	True	string	De systeemrecord-id van het cadeau om te krijgen.

Retouren

Geschenk

Body: GiftApi.GiftRead

Een cadeau maken

Bewerkings-id:: CreateGift

Hiermee maakt u een nieuw cadeau.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel dat aan het cadeau is gekoppeld.
Aantal	value	True	double	Het geldbedrag van het cadeau.
Datum	date	True	date	De cadeaudatum (bijvoorbeeld: '2020-09-18').
Typologie	type	True	string	Het cadeautype.
campagne-id	campaign_id		string	De systeemrecord-id van de campagne die is gekoppeld aan de cadeausplitsing.
fonds-id	fund_id	True	string	De systeemrecord-id van het fonds dat is gekoppeld aan de cadeausplitsing.
beroeps-id	appeal_id		string	De systeemrecord-id van het beroep dat is gekoppeld aan de cadeausplitsing.
pakket-id	package_id		string	De systeemrecord-id van het pakket dat is gekoppeld aan de cadeausplitsing.
aantal	value	True	double	Het geldbedrag van de cadeausplitsing.
Betalingsmethode	payment_method	True	string	De betalingswijze.
Controlenummer	check_number		string	Het controlenummer (alleen van toepassing wanneer de betalingswijze 'PersonalCheck' is).
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Reference	reference		string	De betalingsreferentie (alleen van toepassing wanneer de betalingswijze 'Overig' is).
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Is anoniem?	is_anonymous		boolean	Is het cadeau anoniem? Als er geen waarde wordt opgegeven, wordt de standaard anoniemheid van de donor gebruikt.
Onderdeeltype	subtype		string	Het subtype van het cadeau.
Comment	reference		string	Notities voor het bijhouden van speciale details over een cadeau, zoals de motivatie erachter of een gedetailleerde beschrijving van een cadeau-in-kind.
Opzoek-id	lookup_id		string	De door de gebruiker gedefinieerde id voor het cadeau.
Geldinzamelingstegoeden gebruiken?	default_fundraiser_credits		boolean	Gebruikt u de standaardinzamelingstegoeden?
Voorlopig tegoed gebruiken?	default_soft_credits		boolean	De standaard soft credits gebruiken?
Kiesdistrict	constituency		string	De kiesdistrict van het geschenk.
Batch-voorvoegsel	batch_prefix		string	Het voorvoegsel dat moet worden gebruikt voor batchcadeaus. Dit moet ten minste één letter bevatten en is vereist wanneer 'Batchnummer' een waarde heeft.
Batchnummer	batch_number		string	Het batchnummer. Tekenlimiet: 50 (inclusief het batchvoorvoegsel).
Poststatus	post_status		string	De poststatus van het cadeau.
Postdatum	post_date		date	De datum waarop het cadeau is geplaatst (bijvoorbeeld: '2020-09-18').
Ontvangststatus	status	True	string	De ontvangststatus van het cadeau.
Ontvangstbedrag	value	True	double	Het geldbedrag van het ontvangstbewijs voor het cadeau.
Ontvangstdatum	date		date	De datum waarop het cadeau is ontvangen (bijvoorbeeld: '2020-09-18').

Retouren

Cadeau gemaakt

Body: GiftApi.CreatedGift

Een cadeaubatch maken

Bewerkings-id:: CreateGiftBatch

Hiermee maakt u een nieuwe cadeaubatch.

Parameters

Name	Sleutel	Type	Description
Description	batch_description	string	De beschrijving van de batch.
Verwacht getal	expected_number	integer	Het aantal geschenken dat in de batch wordt verwacht.
Verwacht totaal	expected_batch_total	double	De totale waarde van geschenken in de partij.
Batchnummer	batch_number	string	De unieke id die specifiek is voor de batch.

Retouren

Cadeaubatch gemaakt

Body: GiftBatchApi.CreatedBatch

Een cadeaubijlage bijwerken

Bewerkings-id:: EditGiftAttachment

Werkt een cadeaubijlage bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Bijlage-ID	attachment_id	True	string	De systeemrecord-id van de bijlage die moet worden bijgewerkt.
Naam	name		string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date		date-time	De datum van de bijlage (bijvoorbeeld: '2020-09-18T04:13:56Z').
URL	url		string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.

Een cadeaubijlage maken

Bewerkings-id:: CreateGiftAttachment

Hiermee maakt u een nieuwe cadeaubijlage.

Parameters

Name	Sleutel	Vereist	Type	Description
Cadeau-id	parent_id	True	string	De systeemrecord-id van het cadeau dat aan de bijlage is gekoppeld.
Typologie	type	True	string	Het bijlagetype. Fysieke bijlagen zijn geüploade bestanden, zoals afbeeldingen, PDF-bestanden of Word-documenten die lokaal of op het netwerk worden opgeslagen. Ze worden opgeslagen en beheerd in het systeem. Koppelingsbijlagen zijn koppelingen naar bestanden zoals afbeeldingen, blogberichten of YouTube-video's die online of in een cloudopslagaccount zijn. Ze worden extern opgeslagen en beheerd.
Naam	name		string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date		date-time	De datum van de bijlage (bijvoorbeeld: '2020-09-18T04:13:56Z'). Dit veld wordt standaard ingesteld op de huidige datum en tijd, indien niet opgegeven.
URL	url		string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.
Bestandsnaam	file_name		string	De naam van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Bestands-id	file_id		string	De id van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-id	thumbnail_id		string	De id van de miniatuur. Tekenlimiet: 36. Alleen voor fysieke bijlagen.

Retouren

Cadeaubijlage gemaakt

Body: GiftApi.CreatedGiftAttachment

Een campagne ophalen

Bewerkings-id:: GetCampaign

Retourneert informatie over een campagne.

Parameters

Name	Sleutel	Vereist	Type	Description
Campagne-id	campaign_id	True	string	De systeemrecord-id van de campagne die moet worden get.

Retouren

Campagne

Body: FundraisingApi.CampaignRead

Een campagnebijlage bijwerken

Bewerkings-id:: EditCampaignAttachment

Hiermee werkt u een bijlage bij bij een campagne.

Parameters

Name	Sleutel	Vereist	Type	Description
Bijlage-ID	attachment_id	True	string	De systeemrecord-id van de bijlage die moet worden bijgewerkt.
Naam	name		string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date		date-time	De datum van de bijlage (bijvoorbeeld: '2020-09-18T04:13:56Z').
URL	url		string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.

Een campagnebijlage maken

Bewerkings-id:: CreateCampaignAttachment

Hiermee maakt u een nieuwe campagnebijlage.

Parameters

Name	Sleutel	Vereist	Type	Description
Campagne-id	parent_id	True	string	De systeemrecord-id van de campagne die aan de bijlage is gekoppeld.
Typologie	type	True	string	Het bijlagetype. Fysieke bijlagen zijn geüploade bestanden, zoals afbeeldingen, PDF-bestanden of Word-documenten die lokaal of op het netwerk worden opgeslagen. Ze worden opgeslagen en beheerd in het systeem. Koppelingsbijlagen zijn koppelingen naar bestanden zoals afbeeldingen, blogberichten of YouTube-video's die online of in een cloudopslagaccount zijn. Ze worden extern opgeslagen en beheerd.
Naam	name		string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date		date-time	De datum van de bijlage (bijvoorbeeld: '2020-09-18T04:13:56Z'). Dit veld wordt standaard ingesteld op de huidige datum en tijd, indien niet opgegeven.
URL	url		string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.
Bestandsnaam	file_name		string	De naam van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Bestands-id	file_id		string	De id van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-id	thumbnail_id		string	De id van de miniatuur. Tekenlimiet: 36. Alleen voor fysieke bijlagen.

Retouren

Campagnebijlage gemaakt

Body: FundraisingApi.CreatedCampaignAttachment

Een code voor een samenstellend verzoek maken

Bewerkings-id:: CreateConstituentSolicitCode

Hiermee maakt u een nieuwe aanvraagcode voor samenstellende elementen.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstelling die is gekoppeld aan de advocaatcode.
Code aanvragen	solicit_code	True	string	Communicatie-instructies en/of beperkingen voor een samenstellend onderdeel.
Begindatum	start_date		date	De begindatum van de aanvraagcode (bijvoorbeeld: '2005-09-18').
Einddatum	end_date		date	De einddatum van de aanvraagcode (bijvoorbeeld: '2005-09-18').

Retouren

Samengestelde advocaatcode gemaakt

Body: CommPrefApi.CreatedConstituentSolicitCode

Een deelnemer bijwerken

Bewerkings-id:: EditParticipant

Hiermee worden de details van een deelnemer bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Deelnemers-ID	participant_id	True	string	De systeemrecord-id van de deelnemer die moet worden bijgewerkt.
Samenstellende id	constituent_id		string	De samenstellende id van de deelnemer.
Host-id	host_id		string	De id van de deelnemersrecord van de host.
RSVP-status	rsvp_status		string	De status van de betrokkenheid van de deelnemer bij de gebeurtenis.
Bijgewoond?	attended		boolean	Heeft de deelnemer het evenement bijwonen?
Uitnodigingsstatus	invitation_status		string	De status van de uitnodiging aan de deelnemer.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Deelnameniveau	name	True	string	De naam van het deelnameniveau.

Een deelnemer maken

Bewerkings-id:: CreateParticipant

Hiermee maakt u een nieuwe deelnemer voor een gebeurtenis.

Parameters

Name	Sleutel	Vereist	Type	Description
Gebeurtenis-id	event_id	True	string	De systeemrecord-id van de gebeurtenis.
Samenstellende id	constituent_id	True	string	De samenstellende id van de deelnemer.
Host-id	host_id		string	De id van de deelnemersrecord van de host.
RSVP-status	rsvp_status		string	De status van de betrokkenheid van de deelnemer bij de gebeurtenis.
Bijgewoond?	attended		boolean	Heeft de deelnemer het evenement bijwonen?
Uitnodigingsstatus	invitation_status		string	De status van de uitnodiging aan de deelnemer.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Deelnameniveau	name	True	string	De naam van het deelnameniveau.

Retouren

Deelnemer gemaakt

Body: EventApi.CreatedParticipant

Een deelnemer ophalen

Bewerkings-id:: GetParticipant

Retourneert informatie over een specifieke deelnemer aan een gebeurtenis.

Parameters

Name	Sleutel	Vereist	Type	Description
Deelnemers-ID	participant_id	True	string	De systeemrecord-id van de deelnemer.

Retouren

Deelnemer

Body: EventApi.Participant

Een deelnemerkosten maken

Bewerkings-id:: CreateParticipantFee

Hiermee maakt u een nieuwe vergoeding voor een deelnemer.

Parameters

Name	Sleutel	Vereist	Type	Description
Deelnemers-ID	participant_id	True	string	De systeemrecord-id van de deelnemer.
Gebeurtenis-id	event_id	True	string	De systeemrecord-id van de gebeurtenis.
Tarief	event_fee_id	True	string	De gebeurteniskosten.
Hoeveelheid	quantity	True	integer	De gekochte hoeveelheid.
Vergoedingsbedrag	fee_amount	True	double	Het bedrag van het geld dat is gekoppeld aan de vergoeding.
Bijdragebedrag	contribution_amount	True	double	Het bedrag van de vergoeding die een donatie is boven de kosten van het evenement. Dit is het bedrag dat doorgaans op ontvangstbewijzen wordt weergegeven.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.

Retouren

Gemaakte deelnemerkosten

Body: EventApi.CreatedParticipantFee

Een deelnemeroptie bijwerken

Bewerkings-id:: EditParticipantOption

Hiermee werkt u de details van een deelnemeroptie bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Optie-id van deelnemer	option_id	True	string	De systeemrecord-id van de optie van de deelnemer die moet worden bijgewerkt.
Waarde	option_value	True	string	Het antwoord van de deelnemer op de optie.

Een documentlocatie maken

Bewerkings-id:: CreateDocument

Hiermee maakt u een nieuwe unieke document-id en uploadlocatie voor gebruik met fysieke bijlagen. Het antwoord bevat instructies voor waar en hoe u de inhoud van het document uploadt.

Parameters

Name	Sleutel	Vereist	Type	Description
Bestandsnaam	file_name		string	De bestandsnaam van het document dat moet worden geüpload.
Miniatuur opnemen?	upload_thumbnail		boolean	Een locatie van een miniatuurdocument opnemen?

Retouren

Bestandsdefinitie

Body: ConstituentApi.FileDefinition

Een donatie van een deelnemer maken

Bewerkings-id:: CreateParticipantDonation

Hiermee maakt u een nieuwe donatie voor een deelnemer.

Parameters

Name	Sleutel	Vereist	Type	Description
Deelnemers-ID	participant_id	True	string	De systeemrecord-id van de deelnemer.
Cadeau-id	gift_id	True	string	De systetm record-id van het cadeau waaraan de donatie van de deelnemer is gekoppeld.

Retouren

Gemaakte donatie van deelnemers

Body: EventApi.CreatedParticipantDonation

Een fonds verkrijgen

Bewerkings-id:: GetFund

Retourneert informatie over een fonds.

Parameters

Name	Sleutel	Vereist	Type	Description
Fonds-id	fund_id	True	string	De systeemrecord-id van het fonds om te krijgen.

Retouren

Fonds

Body: FundraisingApi.FundRead

Een fondsbijlage bijwerken

Bewerkings-id:: EditFundAttachment

Werkt een fondsbijlage bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Bijlage-ID	attachment_id	True	string	De systeemrecord-id van de bijlage die moet worden bijgewerkt.
Naam	name		string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date		date-time	De datum van de bijlage (bijvoorbeeld: '2020-09-18T04:13:56Z').
URL	url		string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.

Een fondsbijlage maken

Bewerkings-id:: CreateFundAttachment

Hiermee maakt u een nieuwe fondsbijlage.

Parameters

Name	Sleutel	Vereist	Type	Description
Fonds-id	parent_id	True	string	De systeemrecord-id van het fonds dat aan de bijlage is gekoppeld.
Typologie	type	True	string	Het bijlagetype. Fysieke bijlagen zijn geüploade bestanden, zoals afbeeldingen, PDF-bestanden of Word-documenten die lokaal of op het netwerk worden opgeslagen. Ze worden opgeslagen en beheerd in het systeem. Koppelingsbijlagen zijn koppelingen naar bestanden zoals afbeeldingen, blogberichten of YouTube-video's die online of in een cloudopslagaccount zijn. Ze worden extern opgeslagen en beheerd.
Naam	name		string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date		date-time	De datum van de bijlage (bijvoorbeeld: '2020-09-18T04:13:56Z'). Dit veld wordt standaard ingesteld op de huidige datum en tijd, indien niet opgegeven.
URL	url		string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.
Bestandsnaam	file_name		string	De naam van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Bestands-id	file_id		string	De id van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-id	thumbnail_id		string	De id van de miniatuur. Tekenlimiet: 36. Alleen voor fysieke bijlagen.

Retouren

Fondsbijlage gemaakt

Body: FundraisingApi.CreatedFundAttachment

Een gebeurtenis bijwerken

Bewerkings-id:: EditEvent

Hiermee worden de details van een gebeurtenis bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Gebeurtenis-id	event_id	True	string	De systeemrecord-id van de gebeurtenis die moet worden bijgewerkt.
Gebeurtenisnaam	name		string	De naam van de gebeurtenis.
Description	description		string	De beschrijving van de gebeurtenis.
Categorie	name	True	string	De categorienaam.
Begindatum	start_date		date	De begindatum van de gebeurtenis (bijvoorbeeld: '2020-09-18').
Begintijd	start_time		string	De begintijd van de gebeurtenis (bijvoorbeeld 07:30).
Einddatum	end_date		date	De einddatum van de gebeurtenis (bijvoorbeeld: '2020-09-18').
Eindtijd	end_time		string	De eindtijd van de gebeurtenis (bijvoorbeeld 07:30).
Opzoek-id	lookup_id		string	De opzoek-id van de gebeurtenis.
Capaciteit	capacity		integer	Het aantal personen dat aan het evenement kan deelnemen.
Goal	goal		double	Het monetaire doel van de gebeurtenis.
Campagne-id	campaign_id		string	De systeemrecord-id van de campagne die aan de gebeurtenis is gekoppeld.
Fonds-id	fund_id		string	De systeemrecord-id van het fonds dat aan de gebeurtenis is gekoppeld.
Inactief?	inactive		boolean	Is de gebeurtenis actief?

Een gebeurtenis maken

Bewerkings-id:: CreateEvent

Hiermee maakt u een nieuwe gebeurtenis.

Parameters

Name	Sleutel	Vereist	Type	Description
Gebeurtenisnaam	name	True	string	De naam van de gebeurtenis.
Description	description		string	De beschrijving van de gebeurtenis.
Categorie	name	True	string	De categorienaam.
Begindatum	start_date	True	date	De begindatum van de gebeurtenis (bijvoorbeeld: '2020-09-18').
Begintijd	start_time		string	De begintijd van de gebeurtenis (bijvoorbeeld 07:30).
Einddatum	end_date		date	De einddatum van de gebeurtenis (bijvoorbeeld: '2020-09-18').
Eindtijd	end_time		string	De eindtijd van de gebeurtenis (bijvoorbeeld '07:30)'.
Opzoek-id	lookup_id		string	De opzoek-id van de gebeurtenis.
Capaciteit	capacity		integer	Het aantal personen dat aan het evenement kan deelnemen.
Goal	goal		double	Het monetaire doel van de gebeurtenis.
Campagne-id	campaign_id		string	De systeemrecord-id van de campagne die aan de gebeurtenis is gekoppeld.
Fonds-id	fund_id		string	De systeemrecord-id van het fonds dat aan de gebeurtenis is gekoppeld.
Inactief?	inactive		boolean	Is de gebeurtenis actief?

Retouren

Gebeurtenis gemaakt

Body: EventApi.CreatedEvent

Een gebeurtenis ophalen

Bewerkings-id:: GetEvent

Retourneert informatie over een gebeurtenis.

Parameters

Name	Sleutel	Vereist	Type	Description
Gebeurtenis-id	event_id	True	string	De systeemrecord-id van de gebeurtenis die moet worden get.

Retouren

Event

Body: EventApi.Event

Een gebeurteniskosten maken

Bewerkings-id:: CreateEventFee

Hiermee maakt u een nieuwe vergoeding voor een gebeurtenis.

Parameters

Name	Sleutel	Vereist	Type	Description
Gebeurtenis-id	event_id	True	string	De systeemrecord-id van de gebeurtenis.
Naam	name	True	string	De naam van de vergoeding.
Vergoedingsbedrag	cost	True	double	Het bedrag van het geld dat is gekoppeld aan de vergoeding.
Bijdragebedrag	contribution_amount	True	double	Het bedrag van de vergoeding die een donatie is boven de kosten van het evenement.

Retouren

Kosten voor gemaakte gebeurtenissen

Body: EventApi.CreatedEventFee

Een inzamelingstoewijzing maken

Bewerkings-id:: CreateFundraiserAssignment

Hiermee maakt u een nieuwe inzamelingstoewijzing.

Parameters

Name	Sleutel	Vereist	Type	Description
Inzamelings-id	fundraiser_id	True	string	De systeemrecord-id van de inzamelingsactie.
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de toegewezen samenstellende component.
Typologie	type		string	Het type inzamelingsactie.
Opdracht wordt gestart	start		date-time	De begindatum van de opdracht.
Toewijzing eindigt	end		date-time	De einddatum van de opdracht.
Aantal	value	True	double	Het doelbedrag voor de inzamelingsactie om te vragen van de toegewezen kiezer.
Campagne-id	campaign_id		string	De systeemrecord-id van de campagne waarop resulterende geschenken worden toegepast.
Fonds-id	fund_id		string	De systeemrecord-id van het fonds waarop resulterende geschenken zullen worden toegepast.
Id van beroep	appeal_id		string	De systeemrecord-id van het beroep waarop resulterende geschenken zullen worden toegepast.

Retouren

Inzamelingstoewijzing gemaakt

Body: FundraisingApi.CreatedFundraiserAssignment

Een lijst maken op basis van een set records

Bewerkings-id:: CreateListFromIDs

Hiermee maakt u een nieuwe lijst die is gefilterd op de opgegeven set records.

Parameters

Name	Sleutel	Vereist	Type	Description
Naam	name	True	string	De naam van de lijst. Tekenlimiet: 50.
Description	description	True	string	De beschrijving van de lijst.
Lijsttype	list_type	True	string	Bepaalt het type lijst dat moet worden gemaakt.
Permissions	list_permissions	True	string	Bepaalt of andere gebruikers toegang hebben tot de lijst.
Id('s)	ids	True	array of string	De unieke id's voor de records in de lijst (maximum van 100.000 waarden).

Retouren

Lijst gemaakt

Body: ListApi.CreatedList

Een organisatie samenstellen

Bewerkings-id:: CreateOrganizationConstituent

Hiermee maakt u een nieuwe organisatie samenstellen.

Parameters

Name	Sleutel	Vereist	Type	Description
Naam	name	True	string	De naam van de organisatie. Tekenlimiet: 100.
Opzoek-id	lookup_id		string	De door de gebruiker gedefinieerde id voor de samenstellende gebruiker.
type	type	True	string	Het adrestype.
country	country		string	Het land van het adres (kan de id, naam of afkorting zijn).
lijnen	address_lines		string	De adresregels. Tekenlimiet: 150.
city	city		string	De plaats van het adres (gebruik niet in combinatie met het veld Buitenwijk).
state	state		string	De status van het adres.
postcode	postal_code		string	De postcode van het adres. Tekenlimiet: 12.
voorstad	suburb		string	De buitenwijk van het adres (gebruik niet in combinatie met het veld Plaats).
graafschap	county		string	De provincie van het adres.
start	start		date	De datum waarop de samenstelling op dit adres begon te wonen (bijvoorbeeld: 2005-09-18).
einde	end		date	De datum waarop de samenstelling niet meer op dit adres is gevestigd (bijvoorbeeld: 2005-09-18).
type	type	True	string	Het telefoontype.
nummer	number	True	string	Het telefoonnummer.
is primair?	primary		boolean	Is dit het primaire telefoonnummer van de kiezer?
type	type	True	string	Het type e-mailadres.
address	address	True	string	Het e-mailadres.
is primair?	primary		boolean	Is dit het primaire e-mailadres van de samenstellende gebruiker?
type	type	True	string	Het online aanwezigheidstype.
address	address	True	string	Het webadres voor de online aanwezigheid.
is primair?	primary		boolean	Is dit de primaire online aanwezigheid van de samenstellende gebruiker?
Geeft anoniem?	gives_anonymously		boolean	Geeft de kiezer anoniem?
Industrie	industry		string	De bedrijfstak van de samenstelling.
Aantal werknemers	num_employees		integer	Het aantal werknemers in de organisatie.
Komt overeen met cadeaus?	matches_gifts		boolean	Komt de organisatie overeen met cadeaus?
Overeenkomende cadeaufactor	matching_gift_factor		double	De overeenkomende cadeaufactor.
Minimale overeenkomst per cadeau	value		double	Het minimum matchbedrag per cadeau voor het samenstellende deel.
Maximale overeenkomst per cadeau	value		double	Het maximale matchbedrag per cadeau voor het samenstellende deel.
Minimale overeenkomst per constit	value		double	Het minimum matchtotaal voor de samenstellende waarde.
Maximale overeenkomst per constit	value		double	Het maximum matchtotaal voor de samenstellende waarde.
Overeenkomende cadeaunotities	matching_gift_notes		string	De overeenkomende cadeaunotities voor het samenstellende onderdeel.

Retouren

Samenstellende organisatie

Body: ConstituentApi.CreatedOrganizationConstituent

Een organisatierelatie maken

Bewerkings-id:: CreateOrganizationRelationship

Hiermee maakt u een nieuwe organisatierelatie. Als de relatie met een andere component is, wordt er een wederzijdse relatie voor die samenstellende component gemaakt.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die aan de relatie is gekoppeld.
Relatie-id	relation_id	True	string	De systeemrecord-id van de gerelateerde organisatie.
Typologie	type		string	Het type relatie dat de relatie vertegenwoordigt.
Wederkerig type	reciprocal_type		string	Beschrijft de relatie van het samenstellende onderdeel met de gerelateerde organisatie.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Is het contact?	is_organization_contact		boolean	Vertegenwoordigt de samenstellende persoon deze organisatie als contactpersoon?
Type contact	organization_contact_type		string	Biedt context voor interacties met de gerelateerde persoon die de organisatie vertegenwoordigt als contactpersoon.
Position	position		string	De positie van de persoon in de organisatie. Tekenlimiet: 50.
Is primair bedrijf?	is_primary_business		boolean	Is dit het primaire bedrijf van de samenstellende onderneming?
Opmerkingen	comment		string	Aanvullende opmerkingen over de relatie.

Retouren

Organisatierelatie gemaakt

Body: ConstituentApi.CreatedOrganizationRelationship

Een pakket ophalen

Bewerkings-id:: GetPackage

Retourneert informatie over een pakket.

Parameters

Name	Sleutel	Vereist	Type	Description
Pakket-ID	package_id	True	string	De systeemrecord-id van het pakket dat moet worden get.

Retouren

Package

Body: FundraisingApi.PackageRead

Een samenstellend adres bijwerken

Bewerkings-id:: EditConstituentAddress

Werkt een samenstellend adres bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Adres-id	address_id	True	string	De systeemrecord-id van het adres dat moet worden bijgewerkt.
Adrestype	type		string	Het adrestype.
Country	country		string	Het land van het adres (kan de id, naam of afkorting zijn).
Adresregels	address_lines		string	De adresregels.
City	city		string	De plaats van het adres (gebruik niet in combinatie met het veld Buitenwijk).
Staat	state		string	De status van het adres.
Postcode	postal_code		string	De postcode van het adres.
Voorstad	suburb		string	De buitenwijk van het adres (gebruik niet in combinatie met het veld Plaats).
Regio	county		string	De provincie van het adres.
Informatiebron	information_source		string	De informatiebron voor het adres.
Regio	region		string	De regio voor het adres.
KAR	cart		string	De vervoerdersroute (CART) voor het adres.
LOT	lot		string	De reisregel (LOT) voor het adres.
DPC	dpc		string	De afleverpuntcode (DPC) voor het adres.
Geldig vanaf	start		date	De datum waarop de samenstelling op dit adres begon te wonen (bijvoorbeeld: 2005-09-18).
Geldig voor	end		date	De datum waarop de samenstelling niet meer op dit adres is gevestigd (bijvoorbeeld: 2005-09-18).
Primair?	preferred		boolean	Is dit het voorkeursadres van de kiezers?
Geen e-mail?	do_not_mail		boolean	Kan de samenstellende persoon op dit adres contact opnemen?
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.

Een samenstellend adres maken

Bewerkings-id:: CreateConstituentAddress

Hiermee maakt u een nieuw samenstellend adres.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die aan het adres is gekoppeld.
Adrestype	type	True	string	Het adrestype.
Country	country		string	Het land van het adres (kan de id, naam of afkorting zijn).
Adresregels	address_lines		string	De adresregels.
City	city		string	De plaats van het adres (gebruik niet in combinatie met het veld Buitenwijk).
Staat	state		string	De status van het adres.
Postcode	postal_code		string	De postcode van het adres.
Voorstad	suburb		string	De buitenwijk van het adres (gebruik niet in combinatie met het veld Plaats).
Regio	county		string	De provincie van het adres.
Informatiebron	information_source		string	De informatiebron voor het adres.
Regio	region		string	De regio voor het adres.
KAR	cart		string	De vervoerdersroute (CART) voor het adres.
LOT	lot		string	De reisregel (LOT) voor het adres.
DPC	dpc		string	De afleverpuntcode (DPC) voor het adres.
Geldig vanaf	start		date	De datum waarop de samenstelling op dit adres begon te wonen (bijvoorbeeld: 2005-09-18).
Geldig voor	end		date	De datum waarop de samenstelling niet meer op dit adres is gevestigd (bijvoorbeeld: 2005-09-18).
Primair?	preferred		boolean	Is dit het voorkeursadres van de kiezers?
Geen e-mail?	do_not_mail		boolean	Kan de samenstellende persoon op dit adres contact opnemen?
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.

Retouren

Samengesteld adres gemaakt

Body: ConstituentApi.CreatedConstituentAddress

Een samenstellend e-mailadres bijwerken

Bewerkings-id:: EditConstituentEmailAddress

Hiermee werkt u een samenstellend e-mailadres bij.

Parameters

Name	Sleutel	Vereist	Type	Description
E-mailadres-id	email_address_id	True	string	De systeemrecord-id van het e-mailadres dat moet worden bijgewerkt.
E-mailtype	type		string	Het type e-mailadres.
E-mailadres	address		string	Het e-mailadres.
Primair?	primary		boolean	Is dit het primaire e-mailadres van de samenstellende gebruiker?
Wilt u geen e-mail verzenden?	do_not_email		boolean	Kan de samenstellende persoon contact opnemen via dit e-mailadres?
Inactief?	inactive		boolean	Is dit e-mailadres inactief?

Een samenstellend e-mailadres maken

Bewerkings-id:: CreateConstituentEmailAddress

Hiermee maakt u een nieuw samenstellend e-mailadres.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die aan het e-mailadres is gekoppeld.
E-mailtype	type	True	string	Het type e-mailadres.
E-mailadres	address	True	string	Het e-mailadres.
Primair?	primary		boolean	Is dit het primaire e-mailadres van de samenstellende gebruiker?
Wilt u geen e-mail verzenden?	do_not_email		boolean	Kan de samenstellende persoon contact opnemen via dit e-mailadres?
Inactief?	inactive		boolean	Is dit e-mailadres inactief?

Retouren

Gemaakt e-mailadres

Body: ConstituentApi.CreatedConstituentEmailAddress

Een samenstellend onderwijs bijwerken

Bewerkings-id:: EditConstituentEducation

Werkt een samenstellend onderwijs bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Onderwijs-id	education_id	True	string	De systeemrecord-id van het onderwijsrecord dat moet worden bijgewerkt.
School	school		string	De naam van de school/vestiging.
Typologie	type		string	Het type onderwijs.
Klasse van	class_of		string	Het jaar dat de kiezer afstudeerde.
Toestand	status		string	De status van het onderwijs.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Graad	degree		string	De graad ontvangen.
GPA	gpa		double	Het cijferpuntgemiddelde.
Onderwerp van studie	subject_of_study		string	Het onderwerp van de studie.
Primair?	primary		boolean	Is dit de basisschoolvereniging van het kiesdistrict?
Majors	majors		array of string	De hoofdvakken van studie.
Minderjarigen	minors		array of string	De secundaire studiecursussen.
Campus	campus		string	De campus. Tekenlimiet: 50.
Sociale organisatie	social_organization		string	De sociale organisatie. Tekenlimiet: 50.
Bekende naam	known_name		string	De bekende naam. Tekenlimiet: 50.
Graadklasse	class_of_degree		string	De graadklasse.
Afdeling	department		string	De naam van de onderwijsafdeling.
Faculteit	faculty		string	De naam van de faculteit.
Registratienummer	registration_number		string	Het registratienummer. Tekenlimiet: 50.

Een samenstellend onderwijs maken

Bewerkings-id:: CreateConstituentEducation

Hiermee maakt u een nieuw samenstellend onderwijs.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende elementen die aan het onderwijs zijn gekoppeld.
School	school	True	string	De naam van de school/vestiging.
Typologie	type		string	Het type onderwijs.
Klasse van	class_of		string	Het jaar dat de kiezer afstudeerde.
Toestand	status		string	De status van het onderwijs.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Graad	degree		string	De graad ontvangen.
GPA	gpa		double	Het cijferpuntgemiddelde.
Onderwerp van studie	subject_of_study		string	Het onderwerp van de studie.
Primair?	primary		boolean	Is dit de basisschoolvereniging van het kiesdistrict?
Majors	majors		array of string	De hoofdvakken van studie.
Minderjarigen	minors		array of string	De secundaire studiecursussen.
Campus	campus		string	De campus. Tekenlimiet: 50.
Sociale organisatie	social_organization		string	De sociale organisatie. Tekenlimiet: 50.
Bekende naam	known_name		string	De bekende naam. Tekenlimiet: 50.
Graadklasse	class_of_degree		string	De graadklasse (alleen van toepassing op Britse versies).
Afdeling	department		string	De naam van de onderwijsafdeling (alleen van toepassing op britse versies).
Faculteit	faculty		string	De naam van de faculteit (alleen van toepassing op britse versies).
Registratienummer	registration_number		string	Het registratienummer (alleen van toepassing op britse versies). Tekenlimiet: 50.

Retouren

Samengesteld onderwijs

Body: ConstituentApi.CreatedConstituentEducation

Een samenstellende actie bijwerken

Bewerkings-id:: EditAction

Hiermee wordt een samenstellende actie bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Actie-ID	action_id	True	string	De systeemrecord-id van de actie die moet worden bijgewerkt.
Categorie	category		string	Het kanaal of de intentie van de samenstellende interactie.
Volbracht?	completed		boolean	Is de actie voltooid? Als het systeem is geconfigureerd voor het gebruik van aangepaste actiestatussen, is deze waarde gebaseerd op de actiestatuswaarde.
Voltooid op	completed_date		date-time	De datum waarop de actie is voltooid (bijvoorbeeld: '2020-09-18T04:13:56Z').
Datum	date		date-time	De actiedatum (bijvoorbeeld: '2020-09-18T04:13:56Z').
Opmerking	description		string	De gedetailleerde uitleg die de actiesamenvatting verder uitwerkt.
Richting	direction		string	De richting van de actie.
Inzamelingsactie(s)	fundraisers		array of string	De set systeemrecord-id's voor de fondsenwervers die aan de actie zijn gekoppeld.
Locatie	location		string	De locatie van de actie.
Verkoopkans-id	opportunity_id		string	De systeemrecord-id van de verkoopkans die aan de actie is gekoppeld.
Outcome	outcome		string	Het resultaat van de actie.
Priority	priority		string	De prioriteit van de actie.
Begintijd	start_time		string	De begintijd van de actie. Gebruikt 24-uurs tijd in de HH:mm-indeling.
Eindtijd	end_time		string	De eindtijd van de actie. Gebruikt 24-uurs tijd in de HH:mm-indeling.
Toestand	status		string	De actiestatus.
Samenvatting	summary		string	De korte beschrijving van de actie die boven aan de record wordt weergegeven. Tekenlimiet: 255.
Typologie	type		string	Aanvullende beschrijving van de actie om de categorie aan te vullen.

Een samenstellende actie maken

Bewerkings-id:: CreateAction

Hiermee maakt u een nieuwe samenstellende actie.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die aan de actie is gekoppeld.
Categorie	category	True	string	Het kanaal of de intentie van de samenstellende interactie.
Volbracht?	completed		boolean	Is de actie voltooid? Als het systeem is geconfigureerd voor het gebruik van aangepaste actiestatussen, is deze waarde gebaseerd op de actiestatuswaarde.
Voltooid op	completed_date		date-time	De datum waarop de actie is voltooid (bijvoorbeeld: '2020-09-18T04:13:56Z').
Datum	date	True	date-time	De actiedatum (bijvoorbeeld: '2020-09-18T04:13:56Z').
Opmerking	description		string	De gedetailleerde uitleg die de actiesamenvatting verder uitwerkt.
Richting	direction		string	De richting van de actie.
Inzamelingsactie(s)	fundraisers		array of string	De set systeemrecord-id's voor de fondsenwervers die aan de actie zijn gekoppeld.
Locatie	location		string	De locatie van de actie.
Verkoopkans-id	opportunity_id		string	De systeemrecord-id van de verkoopkans die aan de actie is gekoppeld.
Outcome	outcome		string	Het resultaat van de actie.
Priority	priority		string	De prioriteit van de actie.
Begintijd	start_time		string	De begintijd van de actie. Gebruikt 24-uurs tijd in de HH:mm-indeling.
Eindtijd	end_time		string	De eindtijd van de actie. Gebruikt 24-uurs tijd in de HH:mm-indeling.
Toestand	status		string	De actiestatus.
Samenvatting	summary		string	De korte beschrijving van de actie die boven aan de record wordt weergegeven. Tekenlimiet: 255.
Typologie	type		string	Aanvullende beschrijving van de actie om de categorie aan te vullen.

Retouren

Actie gemaakt

Body: ConstituentApi.CreatedAction

Een samenstellende actie ophalen

Bewerkings-id:: GetAction

Retourneert informatie over een samenstellende actie.

Parameters

Name	Sleutel	Vereist	Type	Description
Actie-ID	action_id	True	string	De systeemrecord-id van de actie die moet worden get.

Retouren

Handeling

Body: ConstituentApi.ActionRead

Een samenstellende advocaatcode bijwerken

Bewerkings-id:: EditConstituentSolicitCode

Hiermee werkt u een code voor een samenstellend verzoek bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Code-id aanvragen	constituent_solicit_code_id	True	string	De systeemrecord-id van de verzoekcode die moet worden bijgewerkt.
Code aanvragen	solicit_code		string	Communicatie-instructies en/of beperkingen voor een samenstellend onderdeel.
Begindatum	start_date		date	De begindatum van de aanvraagcode (bijvoorbeeld: '2005-09-18').
Einddatum	end_date		date	De einddatum van de aanvraagcode (bijvoorbeeld: '2005-09-18').

Een samenstellende alias bijwerken

Bewerkings-id:: EditConstituentAlias

Hiermee wordt een samenstellende alias bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Alias-id	alias_id	True	string	De systeemrecord-id van de alias die moet worden bijgewerkt.
Alias	name		string	De naam die moet worden gebruikt als de alias van het samenstellende onderdeel. Tekenlimiet: 100.
Typologie	type		string	Het aliastype.

Een samenstellende alias maken

Bewerkings-id:: CreateConstituentAlias

Hiermee maakt u een nieuwe samenstellende alias.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die aan de alias is gekoppeld.
Alias	name	True	string	De naam die moet worden gebruikt als de alias van het samenstellende onderdeel. Tekenlimiet: 100.
Typologie	type		string	Het aliastype.

Retouren

Samengestelde alias

Body: ConstituentApi.CreatedConstituentAlias

Een samenstellende bijlage bijwerken

Bewerkings-id:: EditConstituentAttachment

Werkt een samenstellende bijlage bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Bijlage-ID	attachment_id	True	string	De systeemrecord-id van de bijlage die moet worden bijgewerkt.
Naam	name		string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date		date-time	De datum van de bijlage (bijvoorbeeld: '2020-09-18T04:13:56Z').
URL	url		string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.

Een samenstellende bijlage maken

Bewerkings-id:: CreateConstituentAttachment

Hiermee maakt u een nieuwe samenstellende bijlage.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	parent_id	True	string	De systeemrecord-id van het samenstellende onderdeel dat aan de bijlage is gekoppeld.
Typologie	type	True	string	Het bijlagetype. Fysieke bijlagen zijn geüploade bestanden, zoals afbeeldingen, PDF-bestanden of Word-documenten die lokaal of op het netwerk worden opgeslagen. Ze worden opgeslagen en beheerd in het systeem. Koppelingsbijlagen zijn koppelingen naar bestanden zoals afbeeldingen, blogberichten of YouTube-video's die online of in een cloudopslagaccount zijn. Ze worden extern opgeslagen en beheerd.
Naam	name		string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date		date-time	De datum van de bijlage (bijvoorbeeld: '2020-09-18T04:13:56Z'). Dit veld wordt standaard ingesteld op de huidige datum en tijd, indien niet opgegeven.
URL	url		string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.
Bestandsnaam	file_name		string	De naam van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Bestands-id	file_id		string	De id van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-id	thumbnail_id		string	De id van de miniatuur. Tekenlimiet: 36. Alleen voor fysieke bijlagen.

Retouren

Samengestelde bijlage gemaakt

Body: ConstituentApi.CreatedConstituentAttachment

Een samenstellende classificatie maken

Bewerkings-id:: CreateConstituentRating

Hiermee maakt u een nieuwe classificatie voor samenstellende elementen.

Parameters

Name	Sleutel	Vereist	Type	Description
body	body	True	dynamic	Een object dat de classificatie vertegenwoordigt die moet worden gemaakt.

Retouren

Samengestelde classificatie

Body: ConstituentApi.CreatedConstituentRating

Een samenstellende code bijwerken

Bewerkings-id:: EditConstituentCode

Hiermee wordt een samenstellende code bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Id van samenstellende code	constituent_code_id	True	string	De systeemrecord-id van de samenstellende code die moet worden bijgewerkt.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Sequentie	sequence		integer	De numerieke reeks die is gekoppeld aan de samenstellende code.

Een samenstellende code maken

Bewerkings-id:: CreateConstituentCode

Hiermee maakt u een nieuwe samenstellende code.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die is gekoppeld aan de samenstellende code.
Samenstellende code	description	True	string	De samenstellende code.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Sequentie	sequence		integer	De numerieke reeks die is gekoppeld aan de samenstellende code.

Retouren

Samengestelde code

Body: ConstituentApi.CreatedConstituentCode

Een samenstellende code verwijderen

Bewerkings-id:: DeleteConstituentCode

Hiermee verwijdert u een samenstellende code.

Parameters

Name	Sleutel	Vereist	Type	Description
Id van samenstellende code	constituent_code_id	True	string	De systeemrecord-id van de samenstellende code die moet worden verwijderd.

Een samenstellende component bijwerken

Bewerkings-id:: EditConstituent

Werkt een samenstellende component bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende onderdelen die moeten worden bijgewerkt.
Title	title		string	De primaire titel van de samenstellende persoon (alleen voor personen).
Voornaam	first		string	De voornaam van de samenstellende persoon (alleen voor personen). Tekenlimiet: 50.
Achternaam	last		string	De achternaam van de samenstellende persoon (alleen voor personen). Tekenlimiet: 100.
Organisatienaam	name		string	Voor personen is dit een berekend veld dat niet van toepassing is op bewerkingen. Dit veld is vereist voor de organisatie en vertegenwoordigt de naam van de organisatie. Tekenlimiet: 100.
Achtervoegsel	suffix		string	Het primaire achtervoegsel van het samenstellende onderdeel (alleen voor personen).
Voorkeursnaam	preferred_name		string	De voorkeursnaam van de samenstellende persoon (alleen voor personen). Tekenlimiet: 50.
Opzoek-id	lookup_id		string	De door de gebruiker gedefinieerde id voor de samenstellende gebruiker.
Geslacht	gender		string	Het geslacht van de kiezer (alleen voor individuen).
Middelste naam	middle		string	De middelste naam van de samenstellende persoon (alleen voor personen). Tekenlimiet: 50.
Voormalige naam	former_name		string	De vroegere naam van de samenstellende persoon (alleen voor personen). Tekenlimiet: 100.
Titel 2	title_2		string	De secundaire titel van het samenstellende onderdeel (alleen voor personen).
Achtervoegsel 2	suffix_2		string	Het secundaire achtervoegsel van het samenstellende onderdeel (alleen voor personen).
Burgerlijke staat	marital_status		string	De burgerlijke staat van het kiesdistrict (alleen voor individuen).
Geeft anoniem?	gives_anonymously		boolean	Geeft de kiezer anoniem?
Inactief?	inactive		boolean	Is de samenstellende component inactief?
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Geboorteplaats	birthplace		string	De geboorteplaats van het kiesdistrict (alleen voor individuen).
Etniciteit	ethnicity		string	De etniciteit van de kiezers (alleen voor individuen).
Inkomsten	income		string	Het inkomen voor de samenstellende persoon (alleen voor individuen).
Godsdienst	religion		string	De godsdienst van het kiesdistrict (alleen voor individuen).
Industrie	industry		string	De bedrijfstak van het samenstellende onderdeel (alleen voor organisaties).
Aantal werknemers	num_employees		integer	Het aantal werknemers in de organisatie.
Komt overeen met cadeaus?	matches_gifts		boolean	Komt de organisatie overeen met cadeaus?
Overeenkomende cadeaufactor	matching_gift_factor		double	De overeenkomende cadeaufactor (alleen voor organisaties).
Minimale overeenkomst per cadeau	value		double	Het minimale matchbedrag per cadeau voor de samenstellende partij (alleen voor organisaties).
Maximale overeenkomst per cadeau	value		double	Het maximum aantal overeenkomsten per cadeau voor de samenstellende partij (alleen voor organisaties).
Minimale overeenkomst per constit	value		double	Het minimumovereenkomsttotaal voor de samenstellende partij (alleen voor organisaties).
Maximale overeenkomst per constit	value		double	Het maximum matchtotaal voor de samenstellende partij (alleen voor organisaties).
Overeenkomende cadeaunotities	matching_gift_notes		string	De overeenkomende cadeaunotities voor de samenstellende waarde (alleen voor organisaties).
Overleden?	deceased		boolean	Is de kiezer overleden (alleen voor individuen)?
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.

Een samenstellende component ophalen

Bewerkings-id:: GetConstituent

Retourneert informatie over een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die moet worden get.

Retouren

Bestanddeel

Body: ConstituentApi.ConstituentRead

Een samenstellende component zoeken

Bewerkings-id:: SearchConstituent

Voert een samenstellende zoekopdracht uit op basis van de opgegeven zoektekst. Ondersteunt voornaam, achternaam, voorkeursnaam, voormalige naam, alias, e-mailadres, telefoonnummer, adres of opzoek-id. Naamcombinaties zoals voornaam en achternaam of voorkeursnaam en achternaam zijn geldig, maar anders ondersteunt zoeken slechts één parameter tegelijk. Standaard bevatten zoekopdrachten resultaten die lijken op uw criteria. Zoekopdrachten naar 'Smith' bevatten bijvoorbeeld overeenkomsten voor 'Smyth' en andere alternatieve spelling. Deze zoekopdracht biedt geen ondersteuning voor jokertekens zoals * of ?. Zoekresultaten zijn beperkt tot 500 records.

Parameters

Name	Sleutel	Vereist	Type	Description
Zoektekst	search_text	True	string	De zoektekst. Ondersteunt voornaam, achternaam, voorkeursnaam, voormalige naam, alias, e-mailadres, telefoonnummer, adres of opzoek-id. Naamcombinaties zoals voornaam en achternaam of voorkeursnaam en achternaam zijn geldig, maar anders ondersteunt zoeken slechts één parameter tegelijk. Standaard bevatten zoekopdrachten resultaten die lijken op uw criteria. Zoekopdrachten naar 'Smith' bevatten bijvoorbeeld overeenkomsten voor 'Smyth' en andere alternatieve spelling. Deze zoekopdracht biedt geen ondersteuning voor jokertekens zoals * of ?. Zoekresultaten zijn beperkt tot 500 records.
Inzamelingsstatussen	fundraiser_status		string	Vertegenwoordigt een door komma's gescheiden lijst met inzamelingsstatussen om de resultaten te filteren. Bijvoorbeeld: 'Actief,Geen' retourneert alleen samenstellende elementen waarvan de inzamelingsstatus Actief of Geen is. Geldige waarden voor dit filter zijn Actief, Inactief en Geen.
Inactief opnemen?	include_inactive		boolean	Inactieve componenten opnemen in het antwoord?
Zoekveld	search_field		string	Vertegenwoordigt een veld waarop moet worden gezocht. Op dit moment wordt alleen lookup_id ondersteund. Als het wordt geleverd met search_text, wordt een samenstelling met lookup_id die overeenkomt met de search_text geretourneerd.
Strikt zoeken gebruiken?	strict_search		boolean	Sluit samenstellen waarvan de namen lijken op de zoektekst, uit, maar anders zijn gespeld?
Limit	limit		integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 5000.
Offset	offset		integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering.

Retouren

Zoekresultaten

Body: ConstituentApi.ApiCollectionOfSearchResultRead

Een samenstellende notitie bijwerken

Bewerkings-id:: EditConstituentNote

Hiermee wordt een samenstellende notitie bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Notitie-id	note_id	True	string	De systeemrecord-id van de notitie die moet worden bijgewerkt.
Typologie	type		string	Het type notitie.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Samenvatting	summary		string	De samenvatting van de notitie. Tekenlimiet: 50.
Opmerking	text		string	De notitietekst.

Een samenstellende notitie maken

Bewerkings-id:: CreateConstituentNote

Hiermee maakt u een nieuwe samenstellende notitie.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die aan de notitie is gekoppeld.
Typologie	type	True	string	Het type notitie.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Samenvatting	summary		string	De samenvatting van de notitie. Tekenlimiet: 50.
Opmerking	text		string	De notitietekst.

Retouren

Samengestelde notitie

Body: ConstituentApi.CreatedConstituentNote

Een samenstellende online aanwezigheid bijwerken

Bewerkings-id:: EditConstituentOnlinePresence

Hiermee wordt een samenstellende online aanwezigheid bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Online aanwezigheids-id	online_presence_id	True	string	De systeemrecord-id van de online aanwezigheid die moet worden bijgewerkt.
Typologie	type		string	Het online aanwezigheidstype.
Link	address		string	Het webadres voor de online aanwezigheid.
Primair?	primary		boolean	Is dit de primaire online aanwezigheid van de samenstellende gebruiker?
Inactief?	inactive		boolean	Is deze online aanwezigheid inactief?

Een samenstellende online aanwezigheid maken

Bewerkings-id:: CreateConstituentOnlinePresence

Hiermee maakt u een nieuwe samenstellende online aanwezigheid.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die is gekoppeld aan de online aanwezigheid.
Typologie	type	True	string	Het online aanwezigheidstype.
Link	address	True	string	Het webadres voor de online aanwezigheid.
Primair?	primary		boolean	Is dit de primaire online aanwezigheid van de samenstellende gebruiker?
Inactief?	inactive		boolean	Is deze online aanwezigheid inactief?

Retouren

Samengestelde online aanwezigheid

Body: ConstituentApi.CreatedConstituentOnlinePresence

Een samenstellende profielafbeelding bijwerken

Bewerkings-id:: EditConstituentProfilePicture

Hiermee werkt u de huidige profielfoto voor een samenstellende gebruiker bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel waarvan de profielfoto moet worden bijgewerkt.
Bestandsnaam	file_name	True	string	De naam van het bestand.
Document-id	document_id	True	uuid	De document-id.
Miniatuur-id	thumbnail_id	True	uuid	De miniatuurdocument-id.

Een samenstellende profielfoto ophalen

Bewerkings-id:: GetConstituentProfilePicture

Retourneert de huidige profielfoto voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende gebruiker voor wie de profielfoto moet worden opgehaald.

Retouren

Profielafbeelding

Body: ConstituentApi.ProfilePictureRead

Een samenstellende relatie bijwerken

Bewerkings-id:: EditConstituentRelationship

Werkt een relatie voor een samenstellende component bij. Als er een wederzijdse relatie bestaat, wordt deze ook gewijzigd om de wijzigingen weer te geven. Dit omvat geen wijzigingen in de eigenschap 'opmerkingen', die specifiek is voor elke record en onafhankelijk van elke record kan worden gewijzigd.

Parameters

Name	Sleutel	Vereist	Type	Description
Relatie-id	relationship_id	True	string	De systeemrecord-id van de relatie die moet worden bijgewerkt.
Typologie	type		string	Het type relatie dat de relatie vertegenwoordigt.
Wederkerig type	reciprocal_type		string	Beschrijft de relatie van de samenstellende component met de gerelateerde component. Bijvoorbeeld, in een relatie tussen een mannelijke samenstellende en een vrouwelijke zus, zou het wederzijdse relatietype broer zijn.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
day	d		integer	De dag in de fuzzy datum.
maand	m		integer	De maand op de fuzzy datum.
jaar	y		integer	Het jaar op de fuzzy datum.
Is echtgenoot?	is_spouse		boolean	Is de gerelateerde persoon de echtgenoot van het kiesdistrict (alleen van toepassing op relaties tussen individuen)?
Is het hoofd van het huishouden?	is_constituent_head_of_household		boolean	Is het hoofd van het huishouden?
Is het hoofd van de echtgenoot van het huishouden?	is_spouse_head_of_household		boolean	Is de echtgenoot het hoofd van het huishouden?
Opmerkingen	comment		string	Aanvullende opmerkingen over de relatie.
Is het contact?	is_organization_contact		boolean	Vertegenwoordigt de samenstellende persoon deze organisatie als contactpersoon (alleen van toepassing op relaties tussen organisaties en personen)?
Is primair bedrijf?	is_primary_business		boolean	Is dit het primaire bedrijf van de samenstellende afdeling (alleen van toepassing op relaties tussen organisaties en individuen)?
Type contact	organization_contact_type		string	Biedt context voor interacties met de gerelateerde persoon die de organisatie vertegenwoordigt als contactpersoon. Alleen van toepassing op relaties tussen organisaties en individuen.
Position	position		string	De positie van de persoon in de organisatie. Alleen van toepassing op relaties tussen organisaties en individuen. Tekenlimiet: 50.

Een samenstellende telefoon bijwerken

Bewerkings-id:: EditConstituentPhone

Werkt een samenstellende telefoon bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Telefoon-id	phone_id	True	string	De systeemrecord-id van de telefoon die moet worden bijgewerkt.
Typologie	type		string	Het telefoontype.
Number	number		string	Het telefoonnummer.
Primair?	primary		boolean	Is dit de primaire telefoon van de samenstellende gebruiker?
Niet bellen?	do_not_call		boolean	Kan de samenstellende persoon contact opnemen met dit nummer?
Inactief?	inactive		boolean	Is dit telefoonnummer inactief?

Een samenstellende telefoon maken

Bewerkings-id:: CreateConstituentPhone

Hiermee maakt u een nieuwe samenstellende telefoon.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel dat aan de telefoon is gekoppeld.
Typologie	type	True	string	Het telefoontype.
Number	number	True	string	Het telefoonnummer.
Primair?	primary		boolean	Is dit de primaire telefoon van de samenstellende gebruiker?
Niet bellen?	do_not_call		boolean	Kan de samenstellende persoon contact opnemen met dit nummer?
Inactief?	inactive		boolean	Is dit telefoonnummer inactief?

Retouren

Samengestelde telefoon

Body: ConstituentApi.CreatedConstituentPhone

Een samenstellende toestemmingsrecord maken

Bewerkings-id:: CreateConstituentConsent

Hiermee maakt u een nieuwe samenstellende toestemmingsrecord.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die is gekoppeld aan de toestemmingsrecord.
Channel	channel	True	string	Het kanaal waarop het toestemmingsantwoord van toepassing is.
Categorie	category		string	De categorie waarop het toestemmingsantwoord van toepassing is.
Bron	source		string	De bron van het toestemmingsantwoord van de samenstellende gebruiker.
Reactie	constituent_consent_response	True	string	Hoe de samenstellende functie heeft gereageerd op toestemming voor het opgegeven kanaal/de opgegeven categorie.
Datum	consent_date	True	date-time	De datum waarop het toestemmingsantwoord is ontvangen (bijvoorbeeld: '2020-09-18T04:13:56Z').
Toestemmingsverklaring	consent_statement		string	De verklaring waarop de samenstellende gebruiker heeft gereageerd bij het verstrekken van toestemming.
Privacyverklaring	privacy_notice		string	De privacyverklaring die aan de samenstellende gebruiker is verstrekt.

Retouren

Samenstellende toestemming gemaakt

Body: CommPrefApi.CreatedConstituentConsent

Een verkoopkans bijwerken

Bewerkings-id:: EditOpportunity

Hiermee wordt een verkoopkans bijgewerkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Verkoopkans-id	opportunity_id	True	string	De systeemrecord-id van de mogelijkheid om bij te werken.
Purpose	purpose		string	Het beoogde gebruik voor geld dat wordt opgehaald als gevolg van de kans.
Naam	name		string	De naam die de verkoopkans in het hele programma identificeert, zoals in lijsten of op samenstellende records. Tekenlimiet: 255.
Toestand	status		string	De status die aangeeft waar de kans zich in het aanvraagproces bevindt.
Deadline	deadline		date-time	De doeldatum voor de kans om een cadeau te geven (bijvoorbeeld: '2020-09-18T04:13:56Z').
Vraagdatum	ask_date		date-time	De datum waarop de aanvraag is ingediend (bijvoorbeeld: '2020-09-18T04:13:56Z').
waarde	value		double	De monetaire waarde.
Verwachte datum	expected_date		date-time	De datum waarop wordt verwacht dat de prospect antwoord geeft op de verkoopkans (bijvoorbeeld: '2020-09-18T04:13:56Z').
waarde	value		double	De monetaire waarde.
Datum van financiering	funded_date		date-time	De datum waarop het prospect antwoord gaf op de verkoopkans (bijvoorbeeld: '2020-09-18T04:13:56Z').
waarde	value		double	De monetaire waarde.
Campagne-id	campaign_id		string	De systeemrecord-id van de campagne die aan de verkoopkans is gekoppeld. De campagne stelt de algemene doelstellingen voor het ophalen van geld vast.
Fonds-id	fund_id		string	De systeemrecord-id van het fonds dat aan de verkoopkans is gekoppeld. Het fonds wijst het specifieke financiële doel van een geschenk aan en identificeert de financiële rekening voor dat cadeau.
Samenstellende id	constituent_id		string	De systeemrecord-id van de samenstellende elementen die aan de inzamelingsactie zijn gekoppeld.
waarde	value		double	De monetaire waarde.
Inactief?	inactive		boolean	Is de kans inactief?

Een verkoopkans krijgen

Bewerkings-id:: GetOpportunity

Retourneert informatie over een verkoopkans. Opmerking: Dit eindpunt retourneert de statuseigenschap met een latentie van ongeveer 10 minuten.

Parameters

Name	Sleutel	Vereist	Type	Description
Verkoopkans-id	opportunity_id	True	string	De systeemrecord-id van de mogelijkheid om te krijgen.

Retouren

Kans

Body: OpportunityApi.OpportunityRead

Een verkoopkans maken

Bewerkings-id:: CreateOpportunity

Hiermee maakt u een nieuwe kans.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende component die aan de verkoopkans is gekoppeld.
Purpose	purpose	True	string	Het beoogde gebruik voor geld dat wordt opgehaald als gevolg van de kans.
Naam	name	True	string	De naam die de verkoopkans in het hele programma identificeert, zoals in lijsten of op samenstellende records. Tekenlimiet: 255.
Toestand	status		string	De status die aangeeft waar de kans zich in het aanvraagproces bevindt.
Deadline	deadline		date-time	De doeldatum voor de kans om een cadeau te geven (bijvoorbeeld: '2020-09-18T04:13:56Z').
Vraagdatum	ask_date		date-time	De datum waarop de aanvraag is ingediend (bijvoorbeeld: '2020-09-18T04:13:56Z').
waarde	value		double	De monetaire waarde.
Verwachte datum	expected_date		date-time	De datum waarop wordt verwacht dat de prospect antwoord geeft op de verkoopkans (bijvoorbeeld: '2020-09-18T04:13:56Z').
waarde	value		double	De monetaire waarde.
Datum van financiering	funded_date		date-time	De datum waarop het prospect antwoord gaf op de verkoopkans (bijvoorbeeld: '2020-09-18T04:13:56Z').
waarde	value		double	De monetaire waarde.
Campagne-id	campaign_id		string	De systeemrecord-id van de campagne die aan de verkoopkans is gekoppeld. De campagne stelt de algemene doelstellingen voor het ophalen van geld vast.
Fonds-id	fund_id		string	De systeemrecord-id van het fonds dat aan de verkoopkans is gekoppeld. Het fonds wijst het specifieke financiële doel van een geschenk aan en identificeert de financiële rekening voor dat cadeau.
Samenstellende id	constituent_id		string	De systeemrecord-id van de samenstellende elementen die aan de inzamelingsactie zijn gekoppeld.
waarde	value		double	De monetaire waarde.
Inactief?	inactive		boolean	Is de kans inactief?

Retouren

Gemaakte verkoopkans

Body: OpportunityApi.CreatedOpportunity

Een verkoopkansbijlage bijwerken

Bewerkings-id:: EditOpportunityAttachment

Hiermee werkt u een verkoopkansbijlage bij.

Parameters

Name	Sleutel	Vereist	Type	Description
Bijlage-ID	attachment_id	True	string	De systeemrecord-id van de bijlage die moet worden bijgewerkt.
Naam	name		string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date		date-time	De datum van de bijlage (bijvoorbeeld: '2020-09-18T04:13:56Z').
URL	url		string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.

Een verkoopkansbijlage maken

Bewerkings-id:: CreateOpportunityAttachment

Hiermee maakt u een nieuwe verkoopkansbijlage.

Parameters

Name	Sleutel	Vereist	Type	Description
Verkoopkans-id	parent_id	True	string	De systeemrecord-id van de verkoopkans die aan de bijlage is gekoppeld.
Typologie	type	True	string	Het bijlagetype. Fysieke bijlagen zijn geüploade bestanden, zoals afbeeldingen, PDF-bestanden of Word-documenten die lokaal of op het netwerk worden opgeslagen. Ze worden opgeslagen en beheerd in het systeem. Koppelingsbijlagen zijn koppelingen naar bestanden zoals afbeeldingen, blogberichten of YouTube-video's die online of in een cloudopslagaccount zijn. Ze worden extern opgeslagen en beheerd.
Naam	name		string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date		date-time	De datum van de bijlage (bijvoorbeeld: '2020-09-18T04:13:56Z'). Dit veld wordt standaard ingesteld op de huidige datum en tijd, indien niet opgegeven.
URL	url		string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.
Bestandsnaam	file_name		string	De naam van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Bestands-id	file_id		string	De id van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-id	thumbnail_id		string	De id van de miniatuur. Tekenlimiet: 36. Alleen voor fysieke bijlagen.

Retouren

Een verkoopkansbijlage gemaakt

Body: OpportunityApi.CreatedOpportunityAttachment

Eerste cadeau ophalen

Bewerkings-id:: GetConstituentFirstGift

Retourneert het eerste geschenk voor een samenstellende waarde.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Samenvatting geven

Body: ConstituentApi.GivingSummaryRead

Fondsbijlagen vermelden

Bewerkings-id:: ListFundAttachments

Een lijst met bijlagen voor een fonds.

Parameters

Name	Sleutel	Vereist	Type	Description
Fonds-id	fund_id	True	string	De systeemrecord-id van het fonds.

Retouren

Bijlagen

Body: FundraisingApi.ApiCollectionOfFundAttachmentRead

Fondsen vermelden

Bewerkings-id:: ListFunds

Retourneert een lijst met fondsen.

Parameters

Name	Sleutel	Type	Description
Limit	limit	integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 5000.
Offset	offset	integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering.
Inactief opnemen?	include_inactive	boolean	Inactieve fondsen opnemen?
Toegevoegd aan of na	date_added	date-time	Filter de resultaten op fondsen die zijn gemaakt op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').
Gewijzigd op of na	last_modified	date-time	Filter de resultaten op fondsen die zijn gewijzigd op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').

Retouren

Fondsen

Body: FundraisingApi.ApiCollectionOfFundRead

Gebeurteniskosten vermelden

Bewerkings-id:: ListEventFees

Geeft een overzicht van de kosten voor een gebeurtenis.

Parameters

Name	Sleutel	Vereist	Type	Description
Gebeurtenis-id	event_id	True	string	De systeemrecord-id van de gebeurtenis.

Retouren

Kosten

Body: EventApi.ApiCollectionOfEventFee

Gebeurtenissen vermelden

Bewerkings-id:: ListEvents

Retourneert een lijst met gebeurtenissen.

Parameters

Name	Sleutel	Type	Description
Categorie	category	string	Filteren op basis van gebeurteniscategorie.
Begindatum vanaf	start_date_from	date	Filter de resultaten op gebeurtenissen met de begindatum op of na de opgegeven datum (bijvoorbeeld: '2020-09-18').
Begindatum tot	start_date_to	date	Filter de resultaten op gebeurtenissen met de begindatum op of vóór de opgegeven datum (bijvoorbeeld: '2020-09-18').
Inactief opnemen?	include_inactive	boolean	Inactieve gebeurtenissen opnemen?
Limit	limit	integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 10000.
Offset	offset	integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering.
Gebeurtenis-id	event_id	string	Filter de gebeurtenissen die overeenkomen met de opgegeven systeemrecord-id.
Naam	name	string	Filter op gebeurtenissen die overeenkomen met de opgegeven naam.
Toegevoegd aan of na	date_added	date-time	Filter de resultaten op gebeurtenissen die zijn gemaakt op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').
Gewijzigd op of na	last_modified	date-time	Filter de resultaten op gebeurtenissen die zijn gewijzigd op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').

Retouren

Evenementen

Body: EventApi.ApiCollectionOfEventListEntry

Inzamelingstoewijzingen vermelden

Bewerkings-id:: ListFundraiserAssignments

Vermeld de opdrachten voor een inzamelingsactie.

Parameters

Name	Sleutel	Vereist	Type	Description
Inzamelings-id	fundraiser_id	True	string	De systeemrecord-id van de inzamelingsactie voor wie opdrachten moeten worden geretourneerd.
Limit	limit		integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 5000.
Offset	offset		integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering.

Retouren

Assignments

Body: FundraisingApi.ApiCollectionOfFundraiserAssignmentRead

Kostenbetalingen van deelnemers vermelden

Bewerkings-id:: ListParticipantFeePayments

Geeft een overzicht van de kostenbetalingen voor een deelnemer.

Parameters

Name	Sleutel	Vereist	Type	Description
Deelnemers-ID	participant_id	True	string	De systeemrecord-id van de deelnemer.
Limit	limit		integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 10000.
Offset	offset		integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering. De standaardwaarde is 0.

Retouren

Kostenbetalingen

Body: EventApi.ApiCollectionOfParticipantFeePayment

Krijg het beste cadeau van de kiezer

Bewerkings-id:: GetConstituentGreatestGift

Retourneert het grootste geschenk voor een kieskerende.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Samenvatting geven

Body: ConstituentApi.GivingSummaryRead

Lijst samenstellende fondsenwervers

Bewerkings-id:: ListConstituentFundraiserAssignments

Een lijst met de inzamelingsopdrachten voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.
Inactief opnemen?	include_inactive		boolean	Inactieve inzamelingsopdrachten opnemen?

Retouren

Inzamelingsopdrachten

Body: ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

Lijstacties

Bewerkings-id:: ListActions

Retourneert een lijst met acties.

Parameters

Name	Sleutel	Type	Description
List	list_id	string	Hiermee definieert u een lijst-id die wordt gebruikt om de set acties te filteren op de acties die zijn opgenomen in de opgegeven lijst. Als deze waarde is ingesteld, worden andere opgegeven filters genegeerd.
Berekende status	computed_status	string	Vertegenwoordigt een filter voor resultaten op basis van de berekende actiestatus. Beschikbare waarden zijn Open, Completed of PastDue.
Toestand	status_code	string	Vertegenwoordigt een actiestatuscode om de resultaten te filteren (alleen van toepassing wanneer het systeem is geconfigureerd voor het gebruik van actiestatuscodes). Met 'In behandeling' worden bijvoorbeeld acties geretourneerd met de status 'In behandeling'.
Limit	limit	integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 5000.
Offset	offset	integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering.
Toegevoegd aan of na	date_added	date-time	Filter de resultaten op acties die zijn gemaakt op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').
Gewijzigd op of na	last_modified	date-time	Filter de resultaten op acties die zijn gewijzigd op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').

Retouren

Acties

Body: ConstituentApi.ApiCollectionOfActionRead

Ontvang het meest recente cadeau

Bewerkings-id:: GetConstituentLatestGift

Retourneert het laatste cadeau voor een samenstellende waarde.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Samenvatting geven

Body: ConstituentApi.GivingSummaryRead

Optie Een deelnemer maken

Bewerkings-id:: CreateParticipantOption

Hiermee maakt u een nieuwe deelnemeroptie voor een deelnemer.

Parameters

Name	Sleutel	Vereist	Type	Description
Deelnemers-ID	participant_id	True	string	De id van de deelnemer.
body	body	True	dynamic	Een object dat de deelnemeroptie vertegenwoordigt die moet worden gemaakt.

Retouren

Optie Deelnemer gemaakt

Body: EventApi.CreatedParticipantOption

Optie Gebeurtenisdeelnemer maken

Bewerkings-id:: CreateEventParticipantOption

Hiermee maakt u een nieuwe deelnemeroptie voor een gebeurtenis.

Parameters

Name	Sleutel	Vereist	Type	Description
Gebeurtenis-id	event_id	True	string	De ID van de gebeurtenis.
Naam	name	True	string	De naam van de optie deelnemer aan het evenement.
Invoertype	input_type	True	string	De typen waarden die deelnemers kunnen gebruiken om antwoorden te geven.
Meervoudige selectie toestaan?	multi_select		boolean	Meerdere waarden voor lijsten toestaan?
naam	name		string	De naam van de lijstoptie.
volgorde	sequence		integer	De op 0 gebaseerde volgorde die wordt gebruikt voor het ordenen.

Retouren

Optie gebeurtenisdeelnemer gemaakt

Body: EventApi.CreatedEventParticipantOption

Opties voor deelnemers aan lijst met gebeurtenissen

Bewerkings-id:: ListEventParticipantOptions

Geeft een lijst weer van de opties van deelnemers voor een gebeurtenis.

Parameters

Name	Sleutel	Vereist	Type	Description
Gebeurtenis-id	event_id	True	string	De ID van de gebeurtenis.

Retouren

Opties voor gebeurtenisdeelnemers

Body: EventApi.ApiCollectionOfEventParticipantOption

Opties voor deelnemers weergeven

Bewerkings-id:: ListParticipantOptions

Geeft een lijst weer van de opties van deelnemers voor een deelnemer.

Parameters

Name	Sleutel	Vereist	Type	Description
Deelnemers-ID	participant_id	True	string	De systeemrecord-id van de deelnemer.

Retouren

Opties voor deelnemers

Body: EventApi.ApiCollectionOfParticipantOption

Pakketten weergeven

Bewerkings-id:: ListPackages

Retourneert een lijst met pakketten.

Parameters

Name	Sleutel	Type	Description
Id van beroep	appeal_id	string	Vertegenwoordigt een door komma's gescheiden lijst met aanroep-id's om de resultaten te filteren. "506.918" retourneert bijvoorbeeld alleen pakketten voor beroep 506 of beroep 918.
Limit	limit	integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 5000.
Offset	offset	integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering.
Inactief opnemen?	include_inactive	boolean	Inactieve pakketten opnemen?
Toegevoegd aan of na	date_added	date-time	Filter de resultaten op pakketten die zijn gemaakt op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').
Gewijzigd op of na	last_modified	date-time	Filter de resultaten op pakketten die zijn gewijzigd op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').

Retouren

Pakketten

Body: FundraisingApi.ApiCollectionOfPackageRead

Records toevoegen aan een lijst

Bewerkings-id:: AppendIDsToList

Voeg een set records toe aan een bestaande lijst.

Parameters

Name	Sleutel	Vereist	Type	Description
Lijsttype	list_type	True	string	Het type lijst.
List	list_id	True	string	De systeemrecord-id van de lijst.
Id('s)	ids	True	array of string	De unieke id's voor de records die aan de lijst moeten worden toegevoegd (maximum van 100.000 waarden).

Samenstellende acties vermelden

Bewerkings-id:: ListConstituentActions

Hiermee worden de acties voor een samenstellende component weergegeven.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Acties

Body: ConstituentApi.ApiCollectionOfActionRead

Samenstellende adressen vermelden

Bewerkings-id:: ListConstituentAddresses

Geeft een lijst van de adressen voor een samenstellende component.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.
Inactief opnemen?	include_inactive		boolean	Inactieve adressen opnemen?

Retouren

Addresses

Body: ConstituentApi.ApiCollectionOfAddressRead

Samenstellende advocaatcodes vermelden

Bewerkings-id:: ListConstituentSolicitCodes

Hiermee worden de aanvraagcodes voor een samenstellend lid vermeld.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Vraagcodes

Body: CommPrefApi.ConstituentSolicitCodeReadCollection

Samenstellende aliassen vermelden

Bewerkings-id:: ListConstituentAliases

Geeft een lijst van de aliassen voor een samenstellende component.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Aliases

Body: ConstituentApi.ApiCollectionOfAliasRead

Samenstellende bijlagen vermelden

Bewerkings-id:: ListConstituentAttachments

Geeft een lijst weer van de bijlagen voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Bijlagen

Body: ConstituentApi.ApiCollectionOfConstituentAttachmentRead

Samenstellende classificaties vermelden

Bewerkings-id:: ListConstituentRatings

Retourneert de lijst met beoordelingen voor een samenstellende waarde.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende
Inactief opnemen?	include_inactive		boolean	Inactieve beoordelingen opnemen?
Alleen meest recent?	most_recent_only		boolean	Alleen de meest recente beoordelingen opnemen?

Retouren

Beoordelingen

Body: ConstituentApi.ApiCollectionOfRatingRead

Samenstellende codes vermelden

Bewerkings-id:: ListConstituentCodes

Geeft een lijst weer van de samenstellende codes voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Samenstellende codes

Body: ConstituentApi.ApiCollectionOfConstituentCodeRead

Samenstellende e-mailadressen vermelden

Bewerkings-id:: ListConstituentEmailAddresses

Een lijst met de e-mailadressen voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.
Inactief opnemen?	include_inactive		boolean	Niet-actieve e-mailadressen opnemen?

Retouren

E-mailadressen

Body: ConstituentApi.ApiCollectionOfEmailAddressRead

Samenstellende elementen vermelden

Bewerkings-id:: ListConstituents

Retourneert een lijst met bestanddelen.

Parameters

Name	Sleutel	Type	Description
List	list_id	string	Hiermee definieert u een lijst-id die wordt gebruikt om de set samenstellende elementen te filteren op die in de opgegeven lijst zijn opgenomen. Als deze waarde is ingesteld, worden andere opgegeven filters genegeerd.
Limit	limit	integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 5000.
Offset	offset	integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering.
Samenstellende code	constituent_code	string	Vertegenwoordigt een samenstellende code om de lijst te filteren. 'Board Member' retourneert bijvoorbeeld alleen samenstellende elementen met een code van een lid van de raad van bestuur.
Samenstellende id	constituent_id	string	Vertegenwoordigt een door komma's gescheiden lijst met samenstellende id's om de resultaten te filteren. '280.1232' retourneert bijvoorbeeld alleen samenstellend 280 of samenstellend 1232.
Categorie aangepast veld	custom_field_category	string	Vertegenwoordigt een aangepaste veldcategorie om de resultaten te filteren. 'Jubileum' retourneert bijvoorbeeld alleen samenstellende elementen met een actief aangepast veld voor jubileum.
Inzamelingsstatus	fundraiser_status	string	Vertegenwoordigt een door komma's gescheiden lijst met inzamelingsstatussen om de resultaten te filteren. Bijvoorbeeld: 'Actief,Geen' retourneert alleen samenstellende elementen waarvan de inzamelingsstatus Actief of Geen is. Geldige waarden voor dit filter zijn Actief, Inactief en Geen.
Inclusief overledene?	include_deceased	boolean	Voeg overleden kiezers toe aan het antwoord?
Inactief opnemen?	include_inactive	boolean	Inactieve componenten opnemen in het antwoord?
Postcode	postal_code	string	Vertegenwoordigt een door komma's gescheiden lijst met postcodes om de resultaten te filteren. "29466.29492" retourneert bijvoorbeeld alleen samenstellende elementen waarvan het voorkeursadres een postcode heeft die begint met 29466 of 29492, zoals 29466, 29492 of 29492-0727.
Toegevoegd aan of na	date_added	date-time	Filter de resultaten op samenstellende elementen die zijn gemaakt op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').
Gewijzigd op of na	last_modified	date-time	Filter de resultaten op onderdelen die zijn gewijzigd op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').
Gesorteerd op	sort	string	Vertegenwoordigt een lijst met velden om de resultaten te sorteren. De resultaten zijn standaard in oplopende volgorde en een teken '-' geeft aflopende volgorde aan. Met 'date_added,-last' worden bijvoorbeeld samenstellen gesorteerd op het veld 'date_added' in oplopende volgorde en vervolgens op het veld 'laatste' in aflopende volgorde.

Retouren

Kiezers

Body: ConstituentApi.ApiCollectionOfConstituentRead

Samenstellende levensduur ophalen

Bewerkings-id:: GetConstituentLifetimeGiving

Retourneert de levensduur die een samenvatting geeft voor een samenstellende waarde.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Levensduur geven

Body: ConstituentApi.LifetimeGivingRead

Samenstellende notities vermelden

Bewerkings-id:: ListConstituentNotes

Geeft een lijst weer van de notities voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Opmerkingen

Body: ConstituentApi.ApiCollectionOfNoteRead

Samenstellende onderwijslijsten vermelden

Bewerkings-id:: ListConstituentEducations

Geeft een lijst weer van de opleidingsrecords voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.

Retouren

Opleidingen

Body: ConstituentApi.ApiCollectionOfEducationRead

Samenstellende online aanwezigheidsstatussen vermelden

Bewerkings-id:: ListConstituentOnlinePresences

Geeft een lijst weer van de online aanwezigheid voor een samenstellende gebruiker.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.
Inactief opnemen?	include_inactive		boolean	Inactieve online aanwezigheidsgegevens opnemen?

Retouren

Online aanwezigheidsgegevens

Body: ConstituentApi.ApiCollectionOfOnlinePresenceRead

Samenstellende relaties vermelden

Bewerkings-id:: ListConstituentRelationships

Geeft een lijst weer van de relaties voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.
Limit	limit		integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Er is geen maximum.
Offset	offset		integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering.

Retouren

Relationships

Body: ConstituentApi.ApiCollectionOfRelationshipRead

Samenstellende telefoons vermelden

Bewerkings-id:: ListConstituentPhones

Geeft een lijst weer van de telefoons voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.
Inactief opnemen?	include_inactive		boolean	Inactieve telefoons opnemen?

Retouren

Telefoons

Body: ConstituentApi.ApiCollectionOfPhoneRead

Samenstellende toestemmingsrecords vermelden

Bewerkings-id:: ListConstituentConsents

Geeft een lijst weer van de toestemmingsrecords voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van het samenstellende onderdeel.
Alleen de meest recente?	most_recent_only		boolean	Alleen de meest recente toestemmingsrecords opnemen voor elke combinatie van kanaalcategorie in het antwoord?

Retouren

Toestemmingsrecords

Body: CommPrefApi.ConstituentConsentReadCollection

Status van samenstellende prospect ophalen

Bewerkings-id:: GetConstituentProspectStatus

Retourneert de huidige prospectstatus voor een samenstellend onderdeel.

Parameters

Name	Sleutel	Vereist	Type	Description
Samenstellende id	constituent_id	True	string	De systeemrecord-id van de samenstellende voor wie de prospectstatus moet worden opgehaald.

Retouren

Prospectstatus

Body: ConstituentApi.ProspectStatusRead

Verkoopkansbijlagen weergeven

Bewerkings-id:: ListOpportunityAttachments

Geeft een lijst weer van de bijlagen voor een verkoopkans.

Parameters

Name	Sleutel	Vereist	Type	Description
Verkoopkans-id	opportunity_id	True	string	De systeemrecord-id van de verkoopkans.

Retouren

Bijlagen

Body: OpportunityApi.ApiCollectionOfOpportunityAttachmentRead

Verkoopkansen weergeven

Bewerkings-id:: ListOpportunities

Retourneert een lijst met verkoopkansen.

Parameters

Name	Sleutel	Type	Description
List	list_id	string	Hiermee definieert u een lijst-id die wordt gebruikt om de set verkoopkansen te filteren op de kansen die zijn opgenomen in de opgegeven lijst. Als deze waarde is ingesteld, worden andere opgegeven filters genegeerd.
Samenstellende id	constituent_id	string	Vertegenwoordigt een door komma's gescheiden lijst met samenstellende id's om de resultaten te filteren. '280.1232' retourneert bijvoorbeeld alleen kansen van samenstellende 280 of samenstellende 1232.
Limit	limit	integer	Geeft het aantal records weer dat moet worden geretourneerd. De standaardwaarde is 500. Het maximum is 5000.
Offset	offset	integer	Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering.
Inactief opnemen?	include_inactive	boolean	Inactieve verkoopkansen opnemen?
Toegevoegd aan of na	date_added	date-time	Filter de resultaten op verkoopkansen die zijn gemaakt op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').
Gewijzigd op of na	last_modified	date-time	Filter de resultaten op verkoopkansen die zijn gewijzigd op of na de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z').

Retouren

Verkoopkansen

Body: OpportunityApi.ApiCollectionOfOpportunityRead

Definities

CommPrefApi.ConstituentConsentRead

Vertegenwoordigt een toestemmingsentiteit voor een samenstellende entiteit.

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de toestemmingsrecord.
Channel	channel	string	Het kanaal waarop het toestemmingsantwoord van toepassing is.
Categorie	category	string	De categorie waarop het toestemmingsantwoord van toepassing is.
Bron	source	string	De bron van het toestemmingsantwoord van de samenstellende gebruiker.
Reactie	constituent_consent_response	string	Hoe de samenstellende functie heeft gereageerd op toestemming voor het opgegeven kanaal/de opgegeven categorie.
Datum	consent_date	date-time	De datum waarop het toestemmingsantwoord is ontvangen.
Toestemmingsverklaring	consent_statement	string	De verklaring waarop de samenstellende gebruiker heeft gereageerd bij het verstrekken van toestemming.
Privacyverklaring	privacy_notice	string	De privacyverklaring die aan de samenstellende gebruiker is verstrekt.
Datum toegevoegd	date_added	date-time	De datum waarop het toestemmingsantwoord is toegevoegd.
Toegevoegd door	user_name	string	De gebruiker die het toestemmingsantwoord heeft toegevoegd.

CommPrefApi.ConstituentConsentReadCollection

Toestemmingsrecords

Name	Pad	Type	Description
Aantal	count	integer	Het aantal toestemmingsrecords in de lijst.
waarde	value	array of CommPrefApi.ConstituentConsentRead	De set toestemmingsrecords die zijn opgenomen in het antwoord.

CommPrefApi.ConstituentSolicitCodeRead

Code aanvragen

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de kiescode.
Code aanvragen	solicit_code	string	Communicatie-instructies en/of beperkingen voor een samenstellend onderdeel.
Begindatum	start_date	date	De begindatum van de aanvraagcode (bijvoorbeeld: '2005-09-18').
Einddatum	end_date	date	De einddatum van de aanvraagcode (bijvoorbeeld: '2005-09-18').

CommPrefApi.ConstituentSolicitCodeReadCollection

Vraagcodes

Name	Pad	Type	Description
Aantal	count	integer	Het aantal kiescodes in de lijst.
waarde	value	array of CommPrefApi.ConstituentSolicitCodeRead	De set samenstellende advocaatcodes die in het antwoord zijn opgenomen.

CommPrefApi.CreatedConstituentConsent

Samenstellende toestemming gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte toestemmingsrecord.

CommPrefApi.CreatedConstituentSolicitCode

Samengestelde advocaatcode gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte kiescode.

ConstituentApi.ActionAttachmentRead

Bijlage

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de bijlage.
Actie-ID	parent_id	string	De systeemrecord-id van de actie die aan de bijlage is gekoppeld.
Typologie	type	string	Het bijlagetype. Fysieke bijlagen zijn geüploade bestanden, zoals afbeeldingen, PDF-bestanden of Word-documenten die lokaal of op het netwerk worden opgeslagen. Ze worden opgeslagen en beheerd in het systeem. Koppelingsbijlagen zijn koppelingen naar bestanden zoals afbeeldingen, blogberichten of YouTube-video's die online of in een cloudopslagaccount zijn. Ze worden extern opgeslagen en beheerd.
Naam	name	string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date	date-time	De datum van de bijlage.
URL	url	string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.
Bestandsnaam	file_name	string	De naam van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Bestands-id	file_id	string	De id van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-id	thumbnail_id	string	De id van de miniatuur. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-URL	thumbnail_url	string	De URL voor een miniatuur. Voor fysieke bijlagen die alleen afbeeldingen zijn. Bevat een tijdsgebonden handtekening waarmee de toegang tot 60 minuten wordt beperkt.
Inhoudstype	content_type	string	Het inhoudstype. Alleen voor fysieke bijlagen.
Bestandsgrootte	file_size	integer	De bestandsgrootte in bytes. Alleen voor fysieke bijlagen.

ConstituentApi.ActionCustomFieldRead

Aangepast veld

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het aangepaste veld.
Actie-ID	parent_id	string	De systeemrecord-id van de actie die is gekoppeld aan het aangepaste veld.
Categorie	category	string	De categorie van het aangepaste veld.
Typologie	type	string	Het type gegevens dat het aangepaste veld vertegenwoordigt.
Waarde	value		De waarde van het aangepaste veld.
Datum	date	date	De datum in het aangepaste veld.
Comment	comment	string	De opmerking over het aangepaste veld. Tekenlimiet: 50.
Datum toegevoegd	date_added	date-time	De datum waarop het aangepaste veld is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het aangepaste veld voor het laatst is gewijzigd.

ConstituentApi.ActionRead

Handeling

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de actie.
Samenstellende id	constituent_id	string	De systeemrecord-id van de samenstellende component die aan de actie is gekoppeld.
Categorie	category	string	Het kanaal of de intentie van de samenstellende interactie.
Volbracht?	completed	boolean	Is de actie voltooid? Als het systeem is geconfigureerd voor het gebruik van aangepaste actiestatussen, is deze waarde gebaseerd op de actiestatuswaarde.
Voltooid op	completed_date	date-time	De datum waarop de actie is voltooid.
Datum	date	date-time	De actiedatum.
Opmerking	description	string	De gedetailleerde uitleg die de actiesamenvatting verder uitwerkt.
Richting	direction	string	De richting van de actie.
Inzamelingsactie(s)	fundraisers	array of string	De set systeemrecord-id's voor de fondsenwervers die aan de actie zijn gekoppeld.
Locatie	location	string	De locatie van de actie.
Verkoopkans-id	opportunity_id	string	De systeemrecord-id van de verkoopkans die aan de actie is gekoppeld.
Outcome	outcome	string	Het resultaat van de actie.
Priority	priority	string	De prioriteit van de actie.
Begintijd	start_time	string	De begintijd van de actie. Gebruikt 24-uurs tijd in de HH:mm-indeling.
Eindtijd	end_time	string	De eindtijd van de actie. Gebruikt 24-uurs tijd in de HH:mm-indeling.
Toestand	status	string	De actiestatus.
Statuscode	status_code	string	De actiestatuscode. Deze eigenschap wordt alleen geretourneerd wanneer het systeem is geconfigureerd voor het gebruik van aangepaste actiestatussen.
Berekende status	computed_status	string	De berekende actiestatus. Als het systeem niet is geconfigureerd voor het gebruik van aangepaste actiestatussen, berekent dit veld de status op basis van de voltooide en datumeigenschappen. Zo niet, dan berekent het veld de status op basis van de datumeigenschap van de actie en of de eigenschap Actiestatus is geconfigureerd als voltooid.
Samenvatting	summary	string	De korte beschrijving van de actie die boven aan de record wordt weergegeven. Tekenlimiet: 255.
Typologie	type	string	Aanvullende beschrijving van de actie om de categorie aan te vullen.
Datum toegevoegd	date_added	date-time	De datum waarop de actie is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de actie voor het laatst is gewijzigd.

ConstituentApi.AddressRead

Adres

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het adres.
Typologie	type	string	Het adrestype.
Country	country	string	Het land van het adres (kan de id, naam of afkorting zijn).
Adresregels	address_lines	string	De adresregels.
City	city	string	De plaats van het adres (gebruik niet in combinatie met het veld Buitenwijk).
Staat	state	string	De status van het adres.
Postcode	postal_code	string	De postcode van het adres.
Voorstad	suburb	string	De buitenwijk van het adres (gebruik niet in combinatie met het veld Plaats).
Regio	county	string	De provincie van het adres.
Opgemaakt adres	formatted_address	string	Het opgemaakte adres in de geconfigureerde indeling van het land.
Informatiebron	information_source	string	De informatiebron voor het adres.
Regio	region	string	De regio voor het adres.
KAR	cart	string	De vervoerdersroute (CART) voor het adres.
LOT	lot	string	De reisregel (LOT) voor het adres.
DPC	dpc	string	De afleverpuntcode (DPC) voor het adres.
Geldig vanaf	start	date-time	De datum waarop de samenstelling op dit adres begon te wonen.
Geldig voor	end	date-time	De datum waarop het samenstellende onderdeel niet meer op dit adres is gevestigd.
Primair?	preferred	boolean	Is dit het voorkeursadres van de kiezers?
Inactief?	inactive	boolean	Is het adres inactief (wat betekent dat de huidige datum vóór een einddatum valt)?
Geen e-mail?	do_not_mail	boolean	Kan de samenstellende persoon op dit adres contact opnemen?
day	seasonal_start.d	integer	De dag in de fuzzy datum.
maand	seasonal_start.m	integer	De maand op de fuzzy datum.
jaar	seasonal_start.y	integer	Het jaar op de fuzzy datum.
day	seasonal_end.d	integer	De dag in de fuzzy datum.
maand	seasonal_end.m	integer	De maand op de fuzzy datum.
jaar	seasonal_end.y	integer	Het jaar op de fuzzy datum.
Datum toegevoegd	date_added	date-time	De datum waarop het adres is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het adres voor het laatst is gewijzigd.

ConstituentApi.AliasRead

Alias

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de alias.
Alias	name	string	De naam die moet worden gebruikt als de alias van het samenstellende onderdeel.
Typologie	type	string	Het aliastype.

ConstituentApi.ApiCollectionOfAddressRead

Addresses

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.AddressRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfActionAttachmentRead

Bijlagen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.ActionAttachmentRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfActionCustomFieldRead

Aangepaste velden

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.ActionCustomFieldRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfActionRead

Acties

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.ActionRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfAliasRead

Aliases

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.AliasRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfConstituentAttachmentRead

Bijlagen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.ConstituentAttachmentRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfConstituentCodeRead

Samenstellende codes

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.ConstituentCodeRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

Aangepaste velden

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.ConstituentCustomFieldRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfConstituentRead

Kiezers

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.ConstituentRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfEducationRead

Opleidingen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.EducationRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfEmailAddressRead

E-mailadressen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.EmailAddressRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

Inzamelingsopdrachten

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.FundraiserAssignmentRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfNoteRead

Opmerkingen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.NoteRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfOnlinePresenceRead

Online aanwezigheidsgegevens

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.OnlinePresenceRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfPhoneRead

Telefoons

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.PhoneRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfRatingRead

Beoordelingen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.RatingRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfRelationshipRead

Relationships

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.RelationshipRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.ApiCollectionOfSearchResultRead

Zoekresultaten

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of ConstituentApi.SearchResultRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

ConstituentApi.AppealRead

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het beroep.
beschrijving	description	string	De beschrijving van het beroep.

ConstituentApi.CampaignRead

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de campagne.
beschrijving	description	string	De beschrijving van de campagne.

ConstituentApi.ConstituentAttachmentRead

Bijlage

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de bijlage.
Samenstellende id	parent_id	string	De systeemrecord-id van het samenstellende onderdeel dat aan de bijlage is gekoppeld.
Typologie	type	string	Het bijlagetype. Fysieke bijlagen zijn geüploade bestanden, zoals afbeeldingen, PDF-bestanden of Word-documenten die lokaal of op het netwerk worden opgeslagen. Ze worden opgeslagen en beheerd in het systeem. Koppelingsbijlagen zijn koppelingen naar bestanden zoals afbeeldingen, blogberichten of YouTube-video's die online of in een cloudopslagaccount zijn. Ze worden extern opgeslagen en beheerd.
Naam	name	string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date	date-time	De datum van de bijlage.
URL	url	string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.
Bestandsnaam	file_name	string	De naam van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Bestands-id	file_id	string	De id van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-id	thumbnail_id	string	De id van de miniatuur. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-URL	thumbnail_url	string	De URL voor een miniatuur. Voor fysieke bijlagen die alleen afbeeldingen zijn. Bevat een tijdsgebonden handtekening waarmee de toegang tot 60 minuten wordt beperkt.
Inhoudstype	content_type	string	Het inhoudstype. Alleen voor fysieke bijlagen.
Bestandsgrootte	file_size	integer	De bestandsgrootte in bytes. Alleen voor fysieke bijlagen.

ConstituentApi.ConstituentCodeRead

Samenstellende code

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de samenstellende code.
Samenstellende id	constituent_id	string	De systeemrecord-id van de samenstellende component die is gekoppeld aan de samenstellende code.
Samenstellende code	description	string	De samenstellende code.
day	start.d	integer	De dag in de fuzzy datum.
maand	start.m	integer	De maand op de fuzzy datum.
jaar	start.y	integer	Het jaar op de fuzzy datum.
day	end.d	integer	De dag in de fuzzy datum.
maand	end.m	integer	De maand op de fuzzy datum.
jaar	end.y	integer	Het jaar op de fuzzy datum.
Inactief?	inactive	boolean	Is de samenstellende code inactief?
Sequentie	sequence	integer	De numerieke reeks die is gekoppeld aan de samenstellende code.
Datum toegevoegd	date_added	date-time	De datum waarop de samenstellende code is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de samenstellende code voor het laatst is gewijzigd.

ConstituentApi.ConstituentCustomFieldRead

Aangepast veld

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het aangepaste veld.
Samenstellende id	parent_id	string	De systeemrecord-id van de samenstellende waarde die is gekoppeld aan het aangepaste veld.
Categorie	category	string	De categorie van het aangepaste veld.
Typologie	type	string	Het type gegevens dat het aangepaste veld vertegenwoordigt.
Waarde	value		De waarde van het aangepaste veld.
Datum	date	date	De datum in het aangepaste veld.
Comment	comment	string	De opmerking over het aangepaste veld. Tekenlimiet: 50.
Datum toegevoegd	date_added	date-time	De datum waarop het aangepaste veld is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het aangepaste veld voor het laatst is gewijzigd.

ConstituentApi.ConstituentRead

Bestanddeel

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id voor de samenstellende component. Dit is niet hetzelfde als de door de gebruiker gedefinieerde samenstellende id, die is opgeslagen in de lookup_id.
Typologie	type	string	Het type samenstellen.
Title	title	string	De primaire titel van de samenstellende persoon (alleen voor personen).
Voornaam	first	string	De voornaam van de samenstellende persoon (alleen voor personen).
Achternaam	last	string	De achternaam van de samenstellende persoon (alleen voor personen).
Naam	name	string	Voor personen is dit veld de volledige naam van het onderdeel op basis van de weergavenaaminstellingen van de doelorganisatie. Voor organisaties is dit de naam van de organisatie.
Voorkeursnaam	preferred_name	string	De voorkeursnaam van de samenstellende persoon (alleen voor personen).
Achtervoegsel	suffix	string	Het primaire achtervoegsel van het samenstellende onderdeel (alleen voor personen).
Opzoek-id	lookup_id	string	De door de gebruiker gedefinieerde id voor de samenstellende gebruiker.
ID-kaart	email.id	string	De systeemrecord-id van het e-mailadres.
type	email.type	string	Het type e-mailadres.
address	email.address	string	Het e-mailadres.
geen e-mail verzenden?	email.do_not_email	boolean	Kan de samenstellende persoon contact opnemen via dit e-mailadres?
inactief?	email.inactive	boolean	Is dit e-mailadres inactief?
datum toegevoegd	email.date_added	date-time	De datum waarop het e-mailadres is gemaakt.
datum gewijzigd	email.date_modified	date-time	De datum waarop het e-mailadres voor het laatst is gewijzigd.
ID-kaart	phone.id	string	De systeemrecord-id van de telefoon.
type	phone.type	string	Het telefoontype.
nummer	phone.number	string	Het telefoonnummer.
niet bellen?	phone.do_not_call	boolean	Kan de samenstellende persoon contact opnemen met dit nummer?
inactief?	phone.inactive	boolean	Is dit telefoonnummer inactief?
datum toegevoegd	phone.date_added	date-time	De datum waarop de telefoon is gemaakt.
datum gewijzigd	phone.date_modified	date-time	De datum waarop de telefoon voor het laatst is gewijzigd.
ID-kaart	online_presence.id	string	De systeemrecord-id van de online aanwezigheid.
type	online_presence.type	string	Het online aanwezigheidstype.
verbinden	online_presence.address	string	Het webadres voor de online aanwezigheid.
inactief?	online_presence.inactive	boolean	Is deze online aanwezigheid inactief?
datum toegevoegd	online_presence.date_added	date-time	De datum waarop de online aanwezigheid is gemaakt.
datum gewijzigd	online_presence.date_modified	date-time	De datum waarop de online aanwezigheid voor het laatst is gewijzigd.
ID-kaart	address.id	string	De systeemrecord-id van het adres.
type	address.type	string	Het adrestype.
country	address.country	string	Het land van het adres (kan de id, naam of afkorting zijn).
lijnen	address.address_lines	string	De adresregels.
city	address.city	string	De plaats van het adres (gebruik niet in combinatie met het veld Buitenwijk).
state	address.state	string	De status van het adres.
postcode	address.postal_code	string	De postcode van het adres.
voorstad	address.suburb	string	De buitenwijk van het adres (gebruik niet in combinatie met het veld Plaats).
graafschap	address.county	string	De provincie van het adres.
Geformatteerd	address.formatted_address	string	Het opgemaakte adres in de geconfigureerde indeling van het land.
geldig vanaf	address.start	date-time	De datum waarop de samenstelling op dit adres begon te wonen.
geldig tot	address.end	date-time	De datum waarop het samenstellende onderdeel niet meer op dit adres is gevestigd.
inactief?	address.inactive	boolean	Is het adres inactief (wat betekent dat de huidige datum vóór een einddatum valt)?
niet mailen?	address.do_not_mail	boolean	Kan de samenstellende persoon op dit adres contact opnemen?
day	address.seasonal_start.d	integer	De dag in de fuzzy datum.
maand	address.seasonal_start.m	integer	De maand op de fuzzy datum.
jaar	address.seasonal_start.y	integer	Het jaar op de fuzzy datum.
day	address.seasonal_end.d	integer	De dag in de fuzzy datum.
maand	address.seasonal_end.m	integer	De maand op de fuzzy datum.
jaar	address.seasonal_end.y	integer	Het jaar op de fuzzy datum.
datum toegevoegd	address.date_added	date-time	De datum waarop het adres is gemaakt.
datum gewijzigd	address.date_modified	date-time	De datum waarop het adres voor het laatst is gewijzigd.
Geslacht	gender	string	Het geslacht van de kiezer (alleen voor individuen).
Middelste naam	middle	string	De middelste naam van de samenstellende persoon (alleen voor personen).
Voormalige naam	former_name	string	De vroegere naam van de samenstellende persoon (alleen voor personen).
Titel 2	title_2	string	De secundaire titel van het samenstellende onderdeel (alleen voor personen).
Achtervoegsel 2	suffix_2	string	Het secundaire achtervoegsel van het samenstellende onderdeel (alleen voor personen).
Huwelijkse staus	marital_status	string	De burgerlijke staat van het kiesdistrict (alleen voor individuen).
Geeft anoniem?	gives_anonymously	boolean	Geeft de kiezer anoniem?
Inactief?	inactive	boolean	Is de samenstellende component inactief?
day	birthdate.d	integer	De dag in de fuzzy datum.
maand	birthdate.m	integer	De maand op de fuzzy datum.
jaar	birthdate.y	integer	Het jaar op de fuzzy datum.
Geboorteplaats	birthplace	string	De geboorteplaats van het kiesdistrict (alleen voor individuen).
Etniciteit	ethnicity	string	De etniciteit van de kiezers (alleen voor individuen).
Inkomsten	income	string	Het inkomen voor de samenstellende persoon (alleen voor individuen).
Godsdienst	religion	string	De godsdienst van het kiesdistrict (alleen voor individuen).
Industrie	industry	string	De bedrijfstak van het samenstellende onderdeel (alleen voor organisaties).
Aantal werknemers	num_employees	integer	Het aantal werknemers in de organisatie.
Komt overeen met cadeaus?	matches_gifts	boolean	Komt de organisatie overeen met cadeaus?
Overeenkomende cadeaufactor	matching_gift_factor	double	De overeenkomende cadeaufactor (alleen voor organisaties).
Minimale overeenkomst per cadeau	matching_gift_per_gift_min.value	double	Het minimale matchbedrag per cadeau voor de samenstellende partij (alleen voor organisaties).
Maximale overeenkomst per cadeau	matching_gift_per_gift_max.value	double	Het maximum aantal overeenkomsten per cadeau voor de samenstellende partij (alleen voor organisaties).
Minimale overeenkomst per constit	matching_gift_total_min.value	double	Het minimumovereenkomsttotaal voor de samenstellende partij (alleen voor organisaties).
Maximale overeenkomst per constit	matching_gift_total_max.value	double	Het maximum matchtotaal voor de samenstellende partij (alleen voor organisaties).
Overeenkomende cadeaunotities	matching_gift_notes	string	De overeenkomende cadeaunotities voor de samenstellende waarde (alleen voor organisaties).
Leeftijd	age	integer	De leeftijd van de samenstellende waarde, zoals berekend op basis van de eigenschap geboortedatum (alleen voor personen).
Overleden?	deceased	boolean	Is de kiezer overleden (alleen voor individuen)?
day	deceased_date.d	integer	De dag in de fuzzy datum.
maand	deceased_date.m	integer	De maand op de fuzzy datum.
jaar	deceased_date.y	integer	Het jaar op de fuzzy datum.
Inzamelingsstatus	fundraiser_status	string	Geeft aan of de samenstellende persoon een inzamelingsactie is (alleen voor personen).
ID-kaart	spouse.id	string	De systeemrecord-id van de echtgenoot.
voornaam	spouse.first	string	De voornaam van de echtgenoot.
achternaam	spouse.last	string	De achternaam van de echtgenoot.
Is het hoofd van het huishouden?	spouse.is_head_of_household	boolean	Is de echtgenoot het hoofd van het huishouden?
Datum toegevoegd	date_added	date-time	De datum waarop de samenstellende component is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de samenstelling voor het laatst is gewijzigd.

ConstituentApi.CreatedAction

Actie gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte actie.

ConstituentApi.CreatedActionAttachment

Actiebijlage gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte actiebijlage.

ConstituentApi.CreatedActionCustomField

Aangepast veld voor actie gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van het aangepaste veld voor de zojuist gemaakte actie.

ConstituentApi.CreatedConstituentAddress

Samengesteld adres gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van het zojuist gemaakte samenstellende adres.

ConstituentApi.CreatedConstituentAlias

Samengestelde alias

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte samenstellende alias.

ConstituentApi.CreatedConstituentAttachment

Samengestelde bijlage gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte bijlage.

ConstituentApi.CreatedConstituentCode

Samengestelde code

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte samenstellende code.

ConstituentApi.CreatedConstituentCustomField

Aangepast veld gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van het zojuist gemaakte aangepaste veld.

ConstituentApi.CreatedConstituentEducation

Samengesteld onderwijs

Name	Pad	Type	Description
ID-kaart	id	string	De id van het nieuw gecreëerde samenstellende onderwijs.

ConstituentApi.CreatedConstituentEmailAddress

Gemaakt e-mailadres

Name	Pad	Type	Description
ID-kaart	id	string	De id van het zojuist gemaakte e-mailadres.

ConstituentApi.CreatedConstituentNote

Samengestelde notitie

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte samenstellende notitie.

ConstituentApi.CreatedConstituentOnlinePresence

Samengestelde online aanwezigheid

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte online aanwezigheid.

ConstituentApi.CreatedConstituentPhone

Samengestelde telefoon

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte telefoon.

ConstituentApi.CreatedConstituentRating

Samengestelde classificatie

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte samenstellende classificatie.

ConstituentApi.CreatedIndividualConstituent

Afzonderlijke samenstellende elementen gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte afzonderlijke samenstellende.

ConstituentApi.CreatedIndividualRelationship

Afzonderlijke relatie gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte afzonderlijke relatie.

ConstituentApi.CreatedOrganizationConstituent

Samenstellende organisatie

Name	Pad	Type	Description
ID-kaart	id	string	De id van het zojuist gemaakte organisatieonderdeel.

ConstituentApi.CreatedOrganizationRelationship

Organisatierelatie gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte organisatierelatie.

ConstituentApi.EducationRead

Education

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het onderwijs.
Samenstellende id	constituent_id	string	De systeemrecord-id van de samenstellende elementen die aan het onderwijs zijn gekoppeld.
School	school	string	De naam van de school/vestiging.
Typologie	type	string	Het type onderwijs.
Klasse van	class_of	string	Het jaar dat de kiezer afstudeerde.
Toestand	status	string	De status van het onderwijs.
day	date_entered.d	integer	De dag in de fuzzy datum.
maand	date_entered.m	integer	De maand op de fuzzy datum.
jaar	date_entered.y	integer	Het jaar op de fuzzy datum.
day	date_left.d	integer	De dag in de fuzzy datum.
maand	date_left.m	integer	De maand op de fuzzy datum.
jaar	date_left.y	integer	Het jaar op de fuzzy datum.
day	date_graduated.d	integer	De dag in de fuzzy datum.
maand	date_graduated.m	integer	De maand op de fuzzy datum.
jaar	date_graduated.y	integer	Het jaar op de fuzzy datum.
Graad	degree	string	De graad ontvangen.
GPA	gpa	double	Het cijferpuntgemiddelde.
Majors	majors	array of string	De hoofdvakken van studie.
Minderjarigen	minors	array of string	De secundaire studiecursussen.
Is het basisonderwijs?	primary	boolean	Is dit de basisschoolvereniging van het kiesdistrict?
Campus	campus	string	De campus.
Sociale organisatie	social_organization	string	De sociale organisatie.
Bekende naam	known_name	string	De bekende naam.
Graadklasse	class_of_degree	string	De graadklasse.
Afdeling	department	string	De naam van de onderwijsafdeling.
Faculteit	faculty	string	De naam van de faculteit.
Registratienummer	registration_number	string	Het registratienummer.
Onderwerp van studie	subject_of_study	string	Het onderwerp van de studie.
Datum toegevoegd	date_added	date-time	De datum waarop het onderwijs is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het onderwijs voor het laatst is gewijzigd.

ConstituentApi.EmailAddressRead

E-mailadres

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het e-mailadres.
Samenstellende id	constituent_id	string	De systeemrecord-id van de samenstellende component die aan het e-mailadres is gekoppeld.
E-mailtype	type	string	Het type e-mailadres.
E-mailadres	address	string	Het e-mailadres.
Primair?	primary	boolean	Is dit het primaire e-mailadres van de samenstellende gebruiker?
Wilt u geen e-mail verzenden?	do_not_email	boolean	Kan de samenstellende persoon contact opnemen via dit e-mailadres?
Inactief?	inactive	boolean	Is dit e-mailadres inactief?
Datum toegevoegd	date_added	date-time	De datum waarop het e-mailadres is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het e-mailadres voor het laatst is gewijzigd.

ConstituentApi.FileDefinition

Bestandsdefinitie

Name	Pad	Type	Description
Bestands-id	file_id	string	De id van het bestand.
URL	file_upload_request.url	string	De URL die moet worden gebruikt voor de uploadaanvraag.
method	file_upload_request.method	string	De HTTP-methode die moet worden gebruikt met de uploadaanvraag.
headers	file_upload_request.headers	array of ConstituentApi.Header	De headers die moeten worden opgegeven bij het indienen van de aanvraag.
Miniatuur-id	thumbnail_id	string	De id van de miniatuur.
URL	thumbnail_upload_request.url	string	De URL die moet worden gebruikt voor de uploadaanvraag.
method	thumbnail_upload_request.method	string	De HTTP-methode die moet worden gebruikt met de uploadaanvraag.
headers	thumbnail_upload_request.headers	array of ConstituentApi.Header	De headers die moeten worden opgegeven bij het indienen van de aanvraag.

ConstituentApi.FundraiserAssignmentRead

Inzamelingstoewijzing

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de inzamelingstoewijzing.
Samenstellende id	constituent_id	string	De systeemrecord-id van het onderdeel dat is toegewezen aan de inzamelingsactie.
Inzamelings-id	fundraiser_id	string	De systeemrecord-id van de inzamelingsactie.
Typologie	type	string	Het type inzamelingsactie.
waarde	amount.value	double	De monetaire waarde.
Campagne-id	campaign_id	string	De systeemrecord-id van de campagne om resulterende geschenken toe te passen.
Fonds-id	fund_id	string	De systeemrecord-id van het fonds alle resulterende geschenken moeten worden toegepast. Indien een beperkt fonds is geselecteerd, kunnen alleen campagnes en beroep die aan dat fonds zijn gekoppeld, worden geselecteerd.
Id van beroep	appeal_id	string	De systeemrecord-id van het beroep dat de inzamelingsactie moet gebruiken om geschenken aan te vragen.
Begindatum	start	date-time	De begindatum van de inzamelingsopdracht.
Einddatum	end	date-time	De einddatum van de inzamelingsopdracht.

ConstituentApi.FundRead

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het fonds.
beschrijving	description	string	De beschrijving van het fonds.

ConstituentApi.GivingSummaryRead

Samenvatting geven

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het cadeau.
Typologie	type	string	Het cadeautype.
Datum	date	date-time	De cadeaudatum.
waarde	amount.value	double	De monetaire waarde.
Appeal	appeals	array of ConstituentApi.AppealRead	De reeks beroepen die verband houden met het geschenk.
Campagne	campaigns	array of ConstituentApi.CampaignRead	De reeks campagnes die aan het cadeau zijn gekoppeld.
Fonds	funds	array of ConstituentApi.FundRead	De set fondsen die aan het cadeau zijn gekoppeld.

Aanvraagheader die wordt gebruikt voor het uploaden van de fysieke bijlage.

Name	Pad	Type	Description
naam	name	string	De naam voor de koptekst.
waarde	value	string	De waarde voor de koptekst.

ConstituentApi.LifetimeGivingRead

Levensduur geven

Name	Pad	Type	Description
Opeenvolgende jaren gegeven	consecutive_years_given	integer	Het aantal opeenvolgende jaren dat het kiesdistrict heeft gegeven.
Totaal aantal jaren gegeven	total_years_given	integer	Het totale aantal jaren dat het kiesdistrict heeft gegeven.
waarde	total_giving.value	double	De monetaire waarde.
waarde	total_pledge_balance.value	double	De monetaire waarde.
waarde	total_received_giving.value	double	De monetaire waarde.
waarde	total_committed_matching_gifts.value	double	De monetaire waarde.
waarde	total_received_matching_gifts.value	double	De monetaire waarde.
waarde	total_soft_credits.value	double	De monetaire waarde.

ConstituentApi.NoteRead

Opmerking

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de notitie.
Samenstellende id	constituent_id	string	De systeemrecord-id van de samenstellende component die aan de notitie is gekoppeld.
Typologie	type	string	Het type notitie.
day	date.d	integer	De dag in de fuzzy datum.
maand	date.m	integer	De maand op de fuzzy datum.
jaar	date.y	integer	Het jaar op de fuzzy datum.
Samenvatting	summary	string	De samenvatting van de notitie.
Opmerking	text	string	De notitietekst.
Datum toegevoegd	date_added	date-time	De datum waarop de notitie is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de notitie voor het laatst is gewijzigd.

ConstituentApi.OnlinePresenceRead

Online aanwezigheid

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de online aanwezigheid.
Samenstellende id	constituent_id	string	De systeemrecord-id van de samenstellende component die is gekoppeld aan de online aanwezigheid.
Typologie	type	string	Het online aanwezigheidstype.
Link	address	string	Het webadres voor de online aanwezigheid.
Primair?	primary	boolean	Is dit de primaire online aanwezigheid van de samenstellende gebruiker?
Inactief?	inactive	boolean	Is deze online aanwezigheid inactief?
Datum toegevoegd	date_added	date-time	De datum waarop de online aanwezigheid is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de online aanwezigheid voor het laatst is gewijzigd.

ConstituentApi.PhoneRead

Telefoon

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de telefoon.
Samenstellende id	constituent_id	string	De systeemrecord-id van het samenstellende onderdeel dat aan de telefoon is gekoppeld.
Typologie	type	string	Het telefoontype.
Number	number	string	Het telefoonnummer.
Primair?	primary	boolean	Is dit de primaire telefoon van de samenstellende gebruiker?
Niet bellen?	do_not_call	boolean	Kan de samenstellende persoon contact opnemen met dit nummer?
Inactief?	inactive	boolean	Is dit telefoonnummer inactief?
Datum toegevoegd	date_added	date-time	De datum waarop de telefoon is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de telefoon voor het laatst is gewijzigd.

ConstituentApi.ProfilePictureRead

Profielafbeelding

Name	Pad	Type	Description
Samenstellende id	constituent_id	string	De systeemrecord-id van het samenstellende onderdeel dat is gekoppeld aan de profielfoto.
URL	url	string	De URL voor de profielfoto. De URL bevat een tijdgebonden handtekening die de toegang tot 60 minuten beperkt.
Miniatuur-URL	thumbnail_url	string	De URL voor een miniatuur van de profielafbeelding. Bevat een tijdsgebonden handtekening waarmee de toegang tot 60 minuten wordt beperkt.

ConstituentApi.ProspectStatusRead

Prospectstatus

Name	Pad	Type	Description
Toestand	status	string	De huidige prospectstatus van de samenstellende kiezer.
Verstreken dagen	days_elapsed	integer	Totaal aantal dagen in de huidige prospectstatus op basis van de begindatum.
Begindatum	start	date-time	De begindatum van de prospectstatus.
Comments	comments	string	De opmerkingen over de prospectstatus.

ConstituentApi.RatingRead

Beoordeling

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de classificatie.
Samenstellende id	constituent_id	string	De systeemrecord-id van het samenstellende onderdeel dat aan de classificatie is gekoppeld.
Bron	source	string	De bron van de nieuwe classificatie.
Categorie	category	string	De categorie van de classificatie.
Datum	date	date-time	De datum van de beoordeling.
Description	value		De waarde van de classificatie.
Comments	comment	string	Een opmerking over de beoordeling.
Inactief?	inactive	boolean	Is de classificatie inactief?
Typologie	type	string	Dit berekende veld geeft het type gegevens aan dat door de classificatie wordt aangegeven op basis van de categorieeigenschap.

ConstituentApi.RelationshipRead

Relatie

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de relatie.
Samenstellende id	constituent_id	string	De systeemrecord-id van de samenstellende component die aan de relatie is gekoppeld.
Relatie-id	relation_id	string	De systeemrecord-id van de gerelateerde persoon of organisatie.
Wederzijdse relatie-id	reciprocal_relationship_id	string	De id voor de wederzijdse relatierecord. Deze waarde is alleen-lezen en wordt automatisch gegenereerd wanneer de relatie wordt gemaakt. Wijzigingen die in deze record worden aangebracht, worden ook weerspiegeld in de wederkerigheid, met uitzondering van de eigenschap opmerkingen.
Naam	name	string	De naam van het gerelateerde onderdeel. Als de gerelateerde samenstellende persoon een persoon is, is dit de volledige naam van het onderdeel op basis van de weergavenaaminstellingen van de doelorganisatie.
Typologie	type	string	Het type relatie dat de relatie vertegenwoordigt.
Wederkerig type	reciprocal_type	string	Beschrijft de relatie van de samenstellende component met de gerelateerde component. Bijvoorbeeld, in een relatie tussen een mannelijke samenstellende en een vrouwelijke zus, zou het wederzijdse relatietype broer zijn.
day	start.d	integer	De dag in de fuzzy datum.
maand	start.m	integer	De maand op de fuzzy datum.
jaar	start.y	integer	Het jaar op de fuzzy datum.
day	end.d	integer	De dag in de fuzzy datum.
maand	end.m	integer	De maand op de fuzzy datum.
jaar	end.y	integer	Het jaar op de fuzzy datum.
Is echtgenoot?	is_spouse	boolean	Is de gerelateerde persoon de echtgenoot van het kiesdistrict (alleen van toepassing op relaties tussen individuen)?
Is het hoofd van het huishouden?	is_constituent_head_of_household	boolean	Is het hoofd van het huishouden?
Is het hoofd van de echtgenoot van het huishouden?	is_spouse_head_of_household	boolean	Is de echtgenoot het hoofd van het huishouden?
Opmerkingen	comment	string	De opmerking over de relatie.
Is het contact?	is_organization_contact	boolean	Vertegenwoordigt de samenstellende persoon deze organisatie als contactpersoon (alleen van toepassing op relaties tussen organisaties en personen)?
Is primair bedrijf?	is_primary_business	boolean	Is dit het primaire bedrijf van de samenstellende afdeling (alleen van toepassing op relaties tussen organisaties en individuen)?
Type contact	organization_contact_type	string	Biedt context voor interacties met de gerelateerde persoon die de organisatie vertegenwoordigt als contactpersoon. Alleen van toepassing op relaties tussen organisaties en individuen.
Position	position	string	De positie van de persoon in de organisatie. Alleen van toepassing op relaties tussen organisaties en individuen.
Datum toegevoegd	date_added	date-time	De datum waarop de relatie is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de relatie voor het laatst is gewijzigd.

ConstituentApi.SearchResultRead

Zoekresultaat

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het samenstellende onderdeel.
Naam	name	string	De naam van de samenstellende naam. Voor personen geeft dit berekende veld de volledige naam van het samenstellende onderdeel aan op basis van de weergavenaaminstellingen van de doelorganisatie.
Adres	address	string	Het voorkeursadres van de samenstellende kiezer.
Overleden?	deceased	boolean	Is de kiezer overleden?
E-mailen	email	string	Het e-mailadres van de samenstellende kiezer.
Inzamelingsstatus	fundraiser_status	string	De inzamelingsstatus van de kiezers. Voor personen geeft dit berekende veld aan of het samenstellende onderdeel actief, inactief of geen is. Voor organisaties is deze waarde altijd Geen.
Inactief?	inactive	boolean	Is de samenstellende component inactief?
Opzoek-id	lookup_id	string	De door de gebruiker gedefinieerde id voor de samenstellende gebruiker.

EventApi.AdministrativeArea

Definieert het gegevensmodel dat wordt gebruikt voor het beheergebied van een adres (bijvoorbeeld status in de VS).

Name	Pad	Type	Description
ID-kaart	id	string	De record-id van het beheergebied.
naam	name	string	De naam van het beheergebied.
korte beschrijving	short_description	string	De korte beschrijving van het administratieve gebied.

EventApi.ApiCollectionOfEventFee

Kosten

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of EventApi.EventFee	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

EventApi.ApiCollectionOfEventListEntry

Evenementen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of EventApi.EventListEntry	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

EventApi.ApiCollectionOfEventParticipantOption

Opties voor gebeurtenisdeelnemers

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of EventApi.EventParticipantOption	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

EventApi.ApiCollectionOfParticipantDonation

Donaties

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of EventApi.ParticipantDonation	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

EventApi.ApiCollectionOfParticipantFee

Kosten

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of EventApi.ParticipantFee	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

EventApi.ApiCollectionOfParticipantFeePayment

Kostenbetalingen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of EventApi.ParticipantFeePayment	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

EventApi.ApiCollectionOfParticipantListEntry

Deelnemers

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of EventApi.ParticipantListEntry	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

EventApi.ApiCollectionOfParticipantOption

Opties voor deelnemers

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of EventApi.ParticipantOption	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

EventApi.Country

Hiermee definieert u het gegevensmodel dat wordt gebruikt voor het land van een adres.

Name	Pad	Type	Description
ID-kaart	id	string	De id van het landrecord.
weergavenaam	display_name	string	De weergavenaam van het land.
ISO-code	iso_alpha2_code	string	De ISO 3166-1 alfa-2-code voor het land.

EventApi.CreatedEvent

Gebeurtenis gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte gebeurtenis.

EventApi.CreatedEventFee

Kosten voor gemaakte gebeurtenissen

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte gebeurteniskosten.

EventApi.CreatedEventParticipantOption

Optie gebeurtenisdeelnemer gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte gebeurtenisdeelnemeroptie.

EventApi.CreatedParticipant

Deelnemer gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte deelnemer.

EventApi.CreatedParticipantDonation

Gemaakte donatie van deelnemers

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte deelnemerdonatie.

EventApi.CreatedParticipantFee

Gemaakte deelnemerkosten

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte deelnemerkosten.

EventApi.CreatedParticipantFeePayment

Betaling voor gemaakte deelnemerkosten

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte betaling van de deelnemerkosten.

EventApi.CreatedParticipantOption

Optie Deelnemer gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte deelnemeroptie.

EventApi.Event

Event

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de gebeurtenis. Dit is niet hetzelfde als de door de gebruiker gedefinieerde gebeurtenis-id, die is opgeslagen in de lookup_id.
Naam	name	string	De naam van de gebeurtenis.
Description	description	string	De beschrijving van de gebeurtenis.
Begindatum	start_date	date	De begindatum van de gebeurtenis.
Begintijd	start_time	string	De begintijd van de gebeurtenis.
Einddatum	end_date	date	De einddatum van de gebeurtenis.
Eindtijd	end_time	string	De eindtijd van de gebeurtenis.
Categorie	category	EventApi.EventCategory	Gebeurteniscategorie is de aangepaste categorisatie voor de gebeurtenis.
Opzoek-id	lookup_id	string	De opzoek-id van de gebeurtenis.
Locatie	location	EventApi.Location	Hiermee definieert u het gegevensmodel dat wordt gebruikt voor een locatie.
Capaciteit	capacity	integer	Het aantal personen dat aan het evenement kan deelnemen.
Goal	goal	double	Het monetaire doel van de gebeurtenis.
Campagne-id	campaign_id	string	De systeemrecord-id van de campagne die aan de gebeurtenis is gekoppeld.
Fonds-id	fund_id	string	De systeemrecord-id van het fonds dat aan de gebeurtenis is gekoppeld.
Inactief?	inactive	boolean	Is de gebeurtenis inactief?
Datum toegevoegd	date_added	date-time	De datum waarop de gebeurtenis is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de gebeurtenis voor het laatst is gewijzigd.

EventApi.EventCategory

Gebeurteniscategorie is de aangepaste categorisatie voor de gebeurtenis.

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de gebeurteniscategorie.
naam	name	string	De naam van de gebeurteniscategorie.
inactief?	inactive	boolean	Is deze categorie inactief?

EventApi.EventFee

Gebeurteniskosten zijn hoeveel kosten een organisatie in rekening brengt voor personen of organisaties om deel te nemen aan of deel te nemen aan het evenement.

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de gebeurteniskosten.
naam	name	string	De naam van de gebeurteniskosten.
aantal	cost	double	De kosten van de vergoeding.
bijdragebedrag	contribution_amount	double	Het aftrekbare belastingbedrag voor deze vergoeding.
aantal verkocht	number_sold	integer	Het aantal verkochte kosten.

EventApi.EventListEntry

Event

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de gebeurtenis.
Naam	name	string	De naam van de gebeurtenis.
Begindatum	start_date	date	De begindatum van de gebeurtenis.
Begintijd	start_time	string	De begintijd van de gebeurtenis.
Einddatum	end_date	date	De einddatum van de gebeurtenis.
Eindtijd	end_time	string	De eindtijd van de gebeurtenis.
Categorie	category	EventApi.EventCategory	Gebeurteniscategorie is de aangepaste categorisatie voor de gebeurtenis.
Opzoek-id	lookup_id	string	De opzoek-id van de gebeurtenis.
Capaciteit	capacity	integer	Het aantal personen dat aan het evenement kan deelnemen.
Bijwonen	attending_count	integer	Het aantal deelnemers aan het evenement dat van plan is deel te nemen.
Met toezicht	attended_count	integer	Het aantal deelnemers aan het evenement.
Uitgenodigd	invited_count	integer	Het aantal genodigden voor gebeurtenissen.
Inkomsten	revenue	double	De gerealiseerde omzet van de gebeurtenis.
Goal	goal	double	Het monetaire doel van de gebeurtenis.
Percentage doel	percent_of_goal	integer	De gerealiseerde omzet als percentage van de doelopbrengst.
Inactief?	inactive	boolean	Is de gebeurtenis inactief?
Datum toegevoegd	date_added	date-time	De datum waarop de gebeurtenis is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de gebeurtenis voor het laatst is gewijzigd.

EventApi.EventParticipantOption

Opties voor deelnemers aan het evenement zijn velden die details verzamelen over deelnemers, zoals t-shirtgrootten, maaltijdvoorkeuren of zitplaatsen. Stel opties en de bijbehorende waarden voor een gebeurtenis in en voeg vervolgens antwoorden toe voor elke deelnemer.

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de optie gebeurtenisdeelnemer.
naam	name	string	De naam van de optie deelnemer aan het evenement.
invoertype	input_type	string	Het type van de optie deelnemer aan het evenement.
meervoudige selectie toestaan?	multi_select	boolean	Meerdere waarden voor lijsten toestaan?
list_options	list_options	array of EventApi.EventParticipantOptionListOption	De beschikbare lijstopties.
toegevoegd door gebruiker	added_by_user	string	De id van de gebruiker die de optie heeft toegevoegd.
gewijzigd door gebruiker	updated_by_user	string	De id van de gebruiker die de optie heeft gewijzigd.
toegevoegd door service	added_by_service	string	De naam van de service die deze optie heeft toegevoegd.
gewijzigd door service	updated_by_service	string	De naam van de service die deze optie heeft gewijzigd.
datum toegevoegd	date_added	date-time	De datum waarop de optie is gemaakt.
datum gewijzigd	date_updated	date-time	De datum waarop de optie voor het laatst is gewijzigd.
version	version	integer	Het versienummer van de optie.

EventApi.EventParticipantOptionListOption

Optielijst van gebeurtenisdeelnemer

Name	Pad	Type	Description
ID-kaart	id	string	De id van de lijstoptie
naam	name	string	De naam van de lijstoptie
volgorde	sequence	integer	De volgorde die wordt gebruikt om de lijstopties te orden

EventApi.Locality

Hiermee definieert u het gegevensmodel dat wordt gebruikt voor de locatie van een adres.

Name	Pad	Type	Description
ID-kaart	id	string	De record-id van de lokaliteitsrecord.
naam	name	string	De naam van de plaats.

EventApi.Location

Hiermee definieert u het gegevensmodel dat wordt gebruikt voor een locatie.

Name	Pad	Type	Description
naam	name	string	De naam van de locatie.
adreslijnen	address_lines	string	De adresregels van de locatie.
postcode	postal_code	string	De postcode van de locatie.
plaats	locality	EventApi.Locality	Hiermee definieert u het gegevensmodel dat wordt gebruikt voor de locatie van een adres.
beheergebied	administrative_area	EventApi.AdministrativeArea	Definieert het gegevensmodel dat wordt gebruikt voor het beheergebied van een adres (bijvoorbeeld status in de VS).
subbeheergebied	sub_administrative_area	EventApi.SubAdministrativeArea	Definieert het gegevensmodel dat wordt gebruikt voor het subbeheergebied van een adres (bijvoorbeeld plaats in de VS).
country	country	EventApi.Country	Hiermee definieert u het gegevensmodel dat wordt gebruikt voor het land van een adres.
opgemaakt adres	formatted_address	string	Het opgemaakte adres van de locatie

EventApi.Membership

Lidmaatschapsgegevens voor de deelnemer.

Name	Pad	Type	Description
Lidmaatschapscategorie	category	EventApi.MembershipCategory	De lidmaatschapscategorie van de persoon.

EventApi.MembershipCategory

De lidmaatschapscategorie van de persoon.

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de lidmaatschapscategorie.
naam	name	string	De naam van de lidmaatschapscategorie.

EventApi.Participant

Deelnemer

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de deelnemer.
Samenstellende id	constituent_id	string	De samenstellende id van de deelnemer.
Gebeurtenis-id	event_id	string	De systeemrecord-id van de gebeurtenis die wordt bezocht.
Host-id	host_id	string	De id van de deelnemersrecord van de host.
RSVP-status	rsvp_status	string	De status van de betrokkenheid van de deelnemer bij de gebeurtenis.
Bijgewoond?	attended	boolean	Heeft de deelnemer het evenement bijwonen?
Uitnodigingsstatus	invitation_status	string	De status van de uitnodiging aan de deelnemer.
day	rsvp_date.d	integer	De dag in de fuzzy datum.
maand	rsvp_date.m	integer	De maand op de fuzzy datum.
jaar	rsvp_date.y	integer	Het jaar op de fuzzy datum.
day	invitation_date.d	integer	De dag in de fuzzy datum.
maand	invitation_date.m	integer	De maand op de fuzzy datum.
jaar	invitation_date.y	integer	Het jaar op de fuzzy datum.
Deelnameniveau	participation_level	EventApi.ParticipationLevel	Deelnameniveaus zijn het niveau van betrokkenheidsdeelnemers in een evenement.
Datum toegevoegd	date_added	date-time	De datum waarop de deelnemer is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de deelnemer voor het laatst is gewijzigd.

EventApi.ParticipantDonation

Definieert een gegevensmodel voor een donatie van een deelnemer

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de donatie van de deelnemer.
cadeau-id	gift_id	string	De systeemrecord-id van het cadeau waaraan de donatie van de deelnemer is gekoppeld.

EventApi.ParticipantFee

Definieert een gegevensmodel voor een deelnemerkosten

Name	Pad	Type	Description
ID-kaart	id	string	De id van de deelnemerkosten.
deelnemer-id	participant_id	string	De id van de record waaraan de deelnemerkosten zijn gekoppeld.
hoeveelheid	quantity	integer	De gekochte hoeveelheid.
vergoedingsbedrag	fee_amount	double	Het bedrag van de deelnemerkosten.
bijdragebedrag	tax_receiptable_amount	double	Het aftrekbare belastingbedrag voor deze vergoeding.
day	date.d	integer	De dag in de fuzzy datum.
maand	date.m	integer	De maand op de fuzzy datum.
jaar	date.y	integer	Het jaar op de fuzzy datum.
Gebeurteniskosten	event_fee	EventApi.EventFee	Gebeurteniskosten zijn hoeveel kosten een organisatie in rekening brengt voor personen of organisaties om deel te nemen aan of deel te nemen aan het evenement.

EventApi.ParticipantFeePayment

Definieert een gegevensmodel voor een betaling van de deelnemerkosten

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de betaling van de deelnemerkosten.
deelnemer-id	participant_id	string	De systeemrecord-id van de deelnemer waaraan de vergoeding van de deelnemer is gekoppeld.
cadeau-id	gift_id	string	De systeemrecord-id van het cadeau waaraan de vergoeding van de deelnemer is gekoppeld.
toegepast bedrag	applied_amount	double	Het toegepaste bedrag van de betaling van de deelnemerkosten.

EventApi.ParticipantListEntry

Deelnemer

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de deelnemer.
Contactpersoon-id	contact_id	string	De id van de contactpersoon die deelneemt aan het evenement.
RSVP-status	rsvp_status	string	De status van de betrokkenheid van de deelnemer bij de gebeurtenis.
Bijgewoond?	attended	boolean	Heeft de deelnemer het evenement bijwonen?
Uitnodigingsstatus	invitation_status	string	De status van de uitnodiging aan de deelnemer.
day	rsvp_date.d	integer	De dag in de fuzzy datum.
maand	rsvp_date.m	integer	De maand op de fuzzy datum.
jaar	rsvp_date.y	integer	Het jaar op de fuzzy datum.
Deelnameniveau	participation_level	EventApi.ParticipationLevel	Deelnameniveaus zijn het niveau van betrokkenheidsdeelnemers in een evenement.
Title	title	string	De titel van de deelnemer.
Voornaam	first_name	string	De voornaam van de deelnemer.
Achternaam	last_name	string	De achternaam van de deelnemer.
Naam	name	string	De volledige naam van de deelnemer.
Voorkeursnaam	preferred_name	string	De voorkeursnaam van de deelnemer.
Achtervoegsel	suffix	string	Het achtervoegsel van de deelnemer.
Opzoek-id	lookup_id	string	De LookupId van de deelnemer.
E-mailen	email	string	Het e-mailadres van de deelnemer.
Wilt u geen e-mail verzenden?	do_not_email	boolean	Kan de deelnemer contact opnemen via dit e-mailadres?
Telefoon	phone	string	Het telefoonnummer van de deelnemer.
Niet bellen?	do_not_call	boolean	Kan de deelnemer op dit nummer contact opnemen?
Middelste naam	middle_name	string	De middelste naam van de deelnemer.
Voormalige naam	former_name	string	De voormalige naam van de deelnemer.
Is een kieskerende?	is_constituent	boolean	Is de deelnemer een samenstellende partij?
Klasse van	class_of	string	De afstudeerklasse van de deelnemer.
Totale registratiekosten	total_registration_fees	double	De som van de vergoedingsbedragen van de deelnemer.
Totaal betaald	total_paid	double	De som van de betaalde geschenken van de deelnemer met een type registratiekosten.
Zetel	seat	string	De stoeltoewijzing voor de deelnemer.
Naamtag	name_tag	string	De naamtag voor de deelnemer
Datum toegevoegd	date_added	date-time	De datum waarop de deelnemer is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de deelnemer voor het laatst is gewijzigd.
contactpersoon-id	host.contact_id	string	De id van de contactpersoon die deelneemt aan het evenement.
deelnemer-id	host.participant_id	string	De id van de deelnemer.
naam	host.name	string	De volledige naam van de deelnemer.
Gasten	guests	array of EventApi.ParticipantListParticipantSummary	De gasten van de deelnemer.
Lidmaatschappen	memberships	array of EventApi.Membership	De lidmaatschapsgegevens voor de deelnemer.

EventApi.ParticipantListParticipantSummary

De basissamenvattingsgegevens van de deelnemer.

Name	Pad	Type	Description
contactpersoon-id	contact_id	string	De id van de contactpersoon die deelneemt aan het evenement.
deelnemer-id	participant_id	string	De id van de deelnemer.
naam	name	string	De volledige naam van de deelnemer.

EventApi.ParticipantOption

De optie deelnemer die is gekoppeld aan een bepaalde deelnemer

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de deelnemeroptie.
deelnemer-id	participant_id	string	De systeemrecord-id van de deelnemer.
gebeurtenis-id	event_id	string	De systeemrecord-id van de gebeurtenis.
optie-id van gebeurtenisdeelnemer	event_participant_option_id	string	De systeemrecord-id van de optie gebeurtenisdeelnemer.
waarde	option_value	string	Het antwoord van de deelnemer op de optie.
toegevoegd door gebruiker	added_by_user	string	De id van de gebruiker die de deelnemeroptie heeft toegevoegd.
gewijzigd door gebruiker	updated_by_user	string	De id van de gebruiker die de optie deelnemer heeft gewijzigd.
toegevoegd door service	added_by_service	string	De naam van de service die deze deelnemeroptie heeft toegevoegd.
gewijzigd door service	updated_by_service	string	De naam van de service die deze deelnemeroptie heeft gewijzigd.
datum toegevoegd	date_added	date-time	De datum waarop de deelnemeroptie is gemaakt.
datum gewijzigd	date_updated	date-time	De datum waarop de deelnemeroptie voor het laatst is gewijzigd.

EventApi.ParticipationLevel

Deelnameniveaus zijn het niveau van betrokkenheidsdeelnemers in een evenement.

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het deelnameniveau.
naam	name	string	De naam van het deelnameniveau.
inactief?	is_inactive	boolean	Is het deelnameniveau inactief?

EventApi.SubAdministrativeArea

Definieert het gegevensmodel dat wordt gebruikt voor het subbeheergebied van een adres (bijvoorbeeld plaats in de VS).

Name	Pad	Type	Description
ID-kaart	id	string	De id van het subbeheergebied.
naam	name	string	De naam van het subbeheergebied.

FondsenwervingApi.ApiCollectionOfAppealAttachmentRead

Bijlagen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of FundraisingApi.AppealAttachmentRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

FondsenwervingApi.ApiCollectionOfAppealCustomFieldRead

Aangepaste velden

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of FundraisingApi.AppealCustomFieldRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

FondsenwervingApi.ApiCollectionOfAppealRead

Beroep

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of FundraisingApi.AppealRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

FundraisingApi.ApiCollectionOfCampaignAttachmentRead

Bijlagen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of FundraisingApi.CampaignAttachmentRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

FondsenwervingApi.ApiCollectionOfCampaignCustomFieldRead

Aangepaste velden

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of FundraisingApi.CampaignCustomFieldRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

FondsenwervingApi.ApiCollectionOfCampaignRead

Campagnes

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of FundraisingApi.CampaignRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

FondsenwervingApi.ApiCollectionOfFundAttachmentRead

Bijlagen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of FundraisingApi.FundAttachmentRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

FondsenwervingApi.ApiCollectionOfFundCustomFieldRead

Aangepaste velden

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of FundraisingApi.FundCustomFieldRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

FondsenwervingApi.ApiCollectionOfFundRead

Fondsen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of FundraisingApi.FundRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

FondsenwervingApi.ApiCollectionOfFundraiserAssignmentRead

Assignments

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of FundraisingApi.FundraiserAssignmentRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

FondsenwervingApi.ApiCollectionOfPackageRead

Pakketten

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of FundraisingApi.PackageRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

FondsenwervingApi.AppealAttachmentRead

Bijlage

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de bijlage.
Id van beroep	parent_id	string	De systeemrecord-id van het beroep dat aan de bijlage is gekoppeld.
Typologie	type	string	Het bijlagetype. Fysieke bijlagen zijn geüploade bestanden, zoals afbeeldingen, PDF-bestanden of Word-documenten die lokaal of op het netwerk worden opgeslagen. Ze worden opgeslagen en beheerd in het systeem. Koppelingsbijlagen zijn koppelingen naar bestanden zoals afbeeldingen, blogberichten of YouTube-video's die online of in een cloudopslagaccount zijn. Ze worden extern opgeslagen en beheerd.
Naam	name	string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date	date-time	De datum van de bijlage.
URL	url	string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.
Bestandsnaam	file_name	string	De naam van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Bestands-id	file_id	string	De id van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-id	thumbnail_id	string	De id van de miniatuur. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-URL	thumbnail_url	string	De URL voor een miniatuur. Voor fysieke bijlagen die alleen afbeeldingen zijn. Bevat een tijdsgebonden handtekening waarmee de toegang tot 60 minuten wordt beperkt.
Inhoudstype	content_type	string	Het inhoudstype. Alleen voor fysieke bijlagen.
Bestandsgrootte	file_size	integer	De bestandsgrootte in bytes. Alleen voor fysieke bijlagen.

FondsenwervingApi.AppealCustomFieldRead

Aangepast veld

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het aangepaste veld.
Id van beroep	parent_id	string	De systeemrecord-id van het beroep dat is gekoppeld aan het aangepaste veld.
Categorie	category	string	De categorie van het aangepaste veld.
Typologie	type	string	Het type gegevens dat het aangepaste veld vertegenwoordigt.
Waarde	value		De waarde van het aangepaste veld.
Datum	date	date	De datum in het aangepaste veld.
Comment	comment	string	De opmerking over het aangepaste veld. Tekenlimiet: 50.
Datum toegevoegd	date_added	date-time	De datum waarop het aangepaste veld is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het aangepaste veld voor het laatst is gewijzigd.

FondsenwervingApi.AppealRead

Appeal

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het beroep.
Categorie	category	string	De categorie van het beroep.
Datum toegevoegd	date_added	date-time	De datum waarop het beroep is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het beroep voor het laatst is gewijzigd.
Description	description	string	De weergavenaam van het beroep.
Einddatum	end_date	date-time	De einddatum van het beroep.
waarde	goal.value	double	De monetaire waarde.
Inactief?	inactive	boolean	Is het beroep actief (wat betekent dat de huidige datum na een begindatum en vóór een einddatum valt)?
Opzoek-id	lookup_id	string	De door de gebruiker gedefinieerde id voor het beroep.
Begindatum	start_date	date-time	De begindatum van het beroep.

CampaignApi.CampaignAttachmentRead

Bijlage

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de bijlage.
Campagne-id	parent_id	string	De systeemrecord-id van de campagne die aan de bijlage is gekoppeld.
Typologie	type	string	Het bijlagetype. Fysieke bijlagen zijn geüploade bestanden, zoals afbeeldingen, PDF-bestanden of Word-documenten die lokaal of op het netwerk worden opgeslagen. Ze worden opgeslagen en beheerd in het systeem. Koppelingsbijlagen zijn koppelingen naar bestanden zoals afbeeldingen, blogberichten of YouTube-video's die online of in een cloudopslagaccount zijn. Ze worden extern opgeslagen en beheerd.
Naam	name	string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date	date-time	De datum van de bijlage.
URL	url	string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.
Bestandsnaam	file_name	string	De naam van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Bestands-id	file_id	string	De id van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-id	thumbnail_id	string	De id van de miniatuur. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-URL	thumbnail_url	string	De URL voor een miniatuur. Voor fysieke bijlagen die alleen afbeeldingen zijn. Bevat een tijdsgebonden handtekening waarmee de toegang tot 60 minuten wordt beperkt.
Inhoudstype	content_type	string	Het inhoudstype. Alleen voor fysieke bijlagen.
Bestandsgrootte	file_size	integer	De bestandsgrootte in bytes. Alleen voor fysieke bijlagen.

CampaignApi.CampaignCustomFieldRead

Aangepast veld

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het aangepaste veld.
Campagne-id	parent_id	string	De systeemrecord-id van de campagne die is gekoppeld aan het aangepaste veld.
Categorie	category	string	De categorie van het aangepaste veld.
Typologie	type	string	Het type gegevens dat het aangepaste veld vertegenwoordigt.
Waarde	value		De waarde van het aangepaste veld.
Datum	date	date	De datum in het aangepaste veld.
Comment	comment	string	De opmerking over het aangepaste veld. Tekenlimiet: 50.
Datum toegevoegd	date_added	date-time	De datum waarop het aangepaste veld is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het aangepaste veld voor het laatst is gewijzigd.

FondsenwervingApi.CampaignRead

Campagne

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de campagne.
Categorie	category	string	De categorie van de campagne.
Datum toegevoegd	date_added	date-time	De datum waarop de campagne is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de campagne voor het laatst is gewijzigd.
Description	description	string	De weergavenaam van de campagne.
Einddatum	end_date	date-time	De einddatum van de campagne.
waarde	goal.value	double	De monetaire waarde.
Inactief?	inactive	boolean	Is de campagne inactief (wat betekent dat de huidige datum na een begindatum en vóór een einddatum valt)?
Opzoek-id	lookup_id	string	De door de gebruiker gedefinieerde id voor de campagne.
Begindatum	start_date	date-time	De begindatum van de campagne.

FondsenwervingApi.CreatedAppealAttachment

Aanroepbijlage gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte bijlage voor een beroep.

FondsenwervingApi.CreatedAppealCustomField

Aangepast veld voor beroep gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van het zojuist gemaakte aangepaste veld voor aanroep.

FundatieApi.CreatedCampaignAttachment

Campagnebijlage gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte campagnebijlage.

FundatieApi.CreatedCampaignCustomField

Aangepast veld voor campagne gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van het zojuist gemaakte aangepaste veld voor de campagne.

FondsenwervingApi.CreatedFundraiserAssignment

Inzamelingstoewijzing gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte inzamelingstoewijzing.

FondsenwervingApi.CreatedFundAttachment

Fondsbijlage gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte fondsbijlage.

FondsenwervingApi.CreatedFundCustomField

Aangepast veld voor fonds gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van het aangepaste veld voor het zojuist gemaakte fonds.

FondsenwervingApi.FundraiserAssignmentRead

Assignment

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de inzamelingstoewijzing.
Samenstellende id	constituent_id	string	De systeemrecord-id van de toegewezen samenstellende component.
Typologie	type	string	Het inzamelingstype.
Opdracht wordt gestart	start	date-time	De begindatum van de opdracht.
Toewijzing eindigt	end	date-time	De einddatum van de opdracht.
waarde	amount.value	double	De monetaire waarde.
Campagne-id	campaign_id	string	De systeemrecord-id van de campagne waarop resulterende geschenken worden toegepast.
Fonds-id	fund_id	string	De systeemrecord-id van het fonds waarop resulterende geschenken zullen worden toegepast.
Id van beroep	appeal_id	string	De systeemrecord-id van het beroep waarop resulterende geschenken zullen worden toegepast.

FondsenwervingApi.FundAttachmentRead

Bijlage

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de bijlage.
Fonds-id	parent_id	string	De systeemrecord-id van het fonds dat aan de bijlage is gekoppeld.
Typologie	type	string	Het bijlagetype. Fysieke bijlagen zijn geüploade bestanden, zoals afbeeldingen, PDF-bestanden of Word-documenten die lokaal of op het netwerk worden opgeslagen. Ze worden opgeslagen en beheerd in het systeem. Koppelingsbijlagen zijn koppelingen naar bestanden zoals afbeeldingen, blogberichten of YouTube-video's die online of in een cloudopslagaccount zijn. Ze worden extern opgeslagen en beheerd.
Naam	name	string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date	date-time	De datum van de bijlage.
URL	url	string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.
Bestandsnaam	file_name	string	De naam van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Bestands-id	file_id	string	De id van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-id	thumbnail_id	string	De id van de miniatuur. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-URL	thumbnail_url	string	De URL voor een miniatuur. Voor fysieke bijlagen die alleen afbeeldingen zijn. Bevat een tijdsgebonden handtekening waarmee de toegang tot 60 minuten wordt beperkt.
Inhoudstype	content_type	string	Het inhoudstype. Alleen voor fysieke bijlagen.
Bestandsgrootte	file_size	integer	De bestandsgrootte in bytes. Alleen voor fysieke bijlagen.

FondsenwervingApi.FundCustomFieldRead

Aangepast veld

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het aangepaste veld.
Fonds-id	parent_id	string	De systeemrecord-id van het fonds dat is gekoppeld aan het aangepaste veld.
Categorie	category	string	De categorie van het aangepaste veld.
Typologie	type	string	Het type gegevens dat het aangepaste veld vertegenwoordigt.
Waarde	value		De waarde van het aangepaste veld.
Datum	date	date	De datum in het aangepaste veld.
Comment	comment	string	De opmerking over het aangepaste veld. Tekenlimiet: 50.
Datum toegevoegd	date_added	date-time	De datum waarop het aangepaste veld is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het aangepaste veld voor het laatst is gewijzigd.

FondsenwervingApi.FundRead

Fonds

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het fonds.
Categorie	category	string	De categorie van het fonds.
Datum toegevoegd	date_added	date-time	De datum waarop het fonds is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het fonds voor het laatst is gewijzigd.
Description	description	string	De weergavenaam van het fonds.
Einddatum	end_date	date-time	De einddatum van het fonds.
waarde	goal.value	double	De monetaire waarde.
Inactief?	inactive	boolean	Is het fonds inactief (wat betekent dat de huidige datum na een begindatum en vóór een einddatum valt)?
Opzoek-id	lookup_id	string	De door de gebruiker gedefinieerde id voor het fonds.
Begindatum	start_date	date-time	De begindatum van het fonds.
Typologie	type	string	Het type fonds.

FondsenwervingApi.PackageRead

Package

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het pakket.
Id van beroep	appeal_id	string	De systeemrecord-id van het beroep dat aan dit pakket is gekoppeld.
Categorie	category	string	De categorie van het pakket.
Datum toegevoegd	date_added	date-time	De datum waarop het pakket is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het pakket voor het laatst is gewijzigd.
waarde	default_gift_amount.value	double	De monetaire waarde.
Description	description	string	De weergavenaam van het pakket.
Einddatum	end	date-time	De einddatum van het pakket.
waarde	goal.value	double	De monetaire waarde.
Inactief?	inactive	boolean	Is het pakket inactief (wat betekent dat de huidige datum na een begindatum en vóór een einddatum valt)?
Opzoek-id	lookup_id	string	De door de gebruiker gedefinieerde id voor het pakket.
Opmerkingen	notes	string	De notities in het pakket.
Aantal geadresseerden	recipient_count	integer	Het aantal geadresseerden van het pakket.
Begindatum	start	date-time	De begindatum van het pakket.

GiftApi.AcknowledgementRead

Erkenning

Name	Pad	Type	Description
date	date	date-time	De datum die aan de bevestiging is gekoppeld.
brief	letter	string	De brief die aan de bevestiging is gekoppeld.
status	status	string	De status van de bevestiging. Beschikbare waarden zijn: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT en DONOTACKNOWLEDGE.

GiftApi.ApiCollectionOfGiftAttachmentRead

Bijlagen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of GiftApi.GiftAttachmentRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

GiftApi.ApiCollectionOfGiftCustomFieldRead

Aangepaste velden

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of GiftApi.GiftCustomFieldRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

GiftApi.ApiCollectionOfGiftRead

Geschenken

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of GiftApi.GiftRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

GiftApi.BatchGiftAddResults

Bevat een verzameling foutrecords voor batchgeschenken en de batchcadeaus die door de bewerking zijn toegevoegd

Name	Pad	Type	Description
Fouten	errors	array of GiftApi.GiftBatchGiftError	De batch-cadeaufouten die zijn gekoppeld aan de bewerking voor het toevoegen van batchgeschenken
Geschenken	gifts	array of GiftApi.BatchGiftRead	De verzameling batchcadeaus die zijn toegevoegd door de bewerking voor het toevoegen van batchgeschenken

GiftApi.GiftBatchGiftError

Vertegenwoordigt uitzonderingen waardoor items niet aan de batch kunnen worden toegevoegd.

Name	Pad	Type	Description
betrokken veld	affected_field	string	Het veld dat wordt beïnvloed door de fout
batch-id	batch_id	string	De systeemrecord-id van de batch
uitzonderingsfoutcode	exception_error_code	integer	De uitzonderingsfoutcode
uitzonderingsfoutbericht	exception_error_message	string	Het uitzonderingsfoutbericht
uitzonderingsfoutnaam	exception_error_name	string	De naam van de uitzonderingsfout
cadeau-id	gift_id	string	De systeemrecord-id van het cadeau
opzoek-id	lookup_id	string	De door de gebruiker gedefinieerde id voor het cadeau.

GiftApi.BatchGiftRead

Batch cadeau

Name	Pad	Type	Description
batch-id	batch_id	string	De id van de batch waaraan het cadeau is toegevoegd.
Fouten	errors	array of GiftApi.GiftBatchGiftError	De fouten die zijn gekoppeld aan het batchcadeau.
ID-kaart	id	string	De systeemrecord-id van het batchcadeau.
samenstellende id	constituent_id	string	De systeemrecord-id van het samenstellende onderdeel dat aan het cadeau is gekoppeld.
type	type	string	Het cadeautype.
Subtype	subtype	string	Het subtype van het cadeau.
date	date	date-time	De cadeaudatum.
waarde	amount.value	double	De monetaire waarde.
waarde	balance.value	double	De monetaire waarde.
batchnummer	batch_number	string	Het batchnummer dat aan dit cadeau is gekoppeld.
status	gift_status	string	De status van het cadeau.
anoniem?	is_anonymous	boolean	Is het cadeau anoniem?
kiesdistrict	constituency	string	De kiesdistrict van het geschenk.
opzoek-id	lookup_id	string	De door de gebruiker gedefinieerde id voor het cadeau.
origin	origin	string	De oorsprong van het cadeau.
poststatus	post_status	string	De grootboekpoststatus van het cadeau. Beschikbare waarden zijn Gepost, NotPosted en DoNotPost. Wanneer post_status is ingesteld op DoNotPost>, moet post_date null zijn. Wanneer deze is ingesteld op NotPosted, is post_date vereist, maar blijft deze bewerkbaar. Wanneer deze is ingesteld op Gepost, is post_date vereist en kan deze niet meer worden bewerkt.
postdatum	post_date	date-time	De datum waarop het cadeau is geplaatst in grootboek.
referentie	reference	string	Notities voor het bijhouden van speciale details over een cadeau, zoals de motivatie erachter of een gedetailleerde beschrijving van een cadeau-in-kind.
day	recurring_gift_status_date.d	integer	De dag in de fuzzy datum.
maand	recurring_gift_status_date.m	integer	De maand op de fuzzy datum.
jaar	recurring_gift_status_date.y	integer	Het jaar op de fuzzy datum.
frequency	recurring_gift_schedule.frequency	string	Installatiefrequentie van het terugkerende cadeau om weer te geven. Beschikbare waarden zijn WEKELIJKS, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MAANDELIJKS, KWARTAAL, JAARLIJKS.
start	recurring_gift_schedule.start_date	date-time	De datum waarop het terugkerende cadeau moet beginnen.
einde	recurring_gift_schedule.end_date	date-time	De datum waarop het terugkerende cadeau moet eindigen.
waarde	gift_aid_amount.value	double	De monetaire waarde.
status van gift aid kwalificatie	gift_aid_qualification_status	string	Dit berekende veld bepaalt de kwalificatiestatus gift aid op basis van informatie over belastingaangifte en de database-indeling. Beschikbare waarden zijn: Qualified, NotQualified en PartlyQualified. Alleen voor het Verenigd Koninkrijk.
cadeaucode	gift_code	string	De waarde van de cadeaucode die aan het cadeau is gekoppeld.
cadeausplitsingen	gift_splits	array of GiftApi.GiftSplitRead	De set cadeausplitsingen die aan het cadeau zijn gekoppeld.
inzamelingsacties	fundraisers	array of GiftApi.GiftFundraiserRead	De set fondsenwervers die krediet voor het cadeau ontvangen.
Voorlopig tegoed	soft_credits	array of GiftApi.SoftCreditRead	De set zachte tegoeden die aan het cadeau zijn gekoppeld.
Ontvangsten	receipts	array of GiftApi.ReceiptRead	De set ontvangstbewijzen die aan het cadeau zijn gekoppeld.
Dankbetuigingen	acknowledgements	array of GiftApi.AcknowledgementRead	De reeks bevestigingen die aan het geschenk zijn gekoppeld.
Payments	payments	array of GiftApi.PaymentRead	De betalingen op het cadeau.
Gekoppelde cadeaus	linked_gifts	array of string	De id's van andere geschenken die aan dit cadeau zijn gekoppeld.
Datum toegevoegd	date_added	date-time	De datum waarop het cadeau is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het cadeau voor het laatst is gewijzigd.

GiftApi.CreatedGift

Cadeau gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van het zojuist gemaakte cadeau.

GiftApi.CreatedGiftAttachment

Cadeaubijlage gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte cadeaubijlage.

GiftApi.CreatedGiftCustomField

Aangepast veld voor cadeau gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van het zojuist gemaakte aangepaste veld voor cadeaus.

GiftApi.GiftAttachmentRead

Bijlage

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de bijlage.
Cadeau-id	parent_id	string	De systeemrecord-id van het cadeau dat aan de bijlage is gekoppeld.
Typologie	type	string	Het bijlagetype. Fysieke bijlagen zijn geüploade bestanden, zoals afbeeldingen, PDF-bestanden of Word-documenten die lokaal of op het netwerk worden opgeslagen. Ze worden opgeslagen en beheerd in het systeem. Koppelingsbijlagen zijn koppelingen naar bestanden zoals afbeeldingen, blogberichten of YouTube-video's die online of in een cloudopslagaccount zijn. Ze worden extern opgeslagen en beheerd.
Naam	name	string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date	date-time	De datum van de bijlage.
URL	url	string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.
Bestandsnaam	file_name	string	De naam van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Bestands-id	file_id	string	De id van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-id	thumbnail_id	string	De id van de miniatuur. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-URL	thumbnail_url	string	De URL voor een miniatuur. Voor fysieke bijlagen die alleen afbeeldingen zijn. Bevat een tijdsgebonden handtekening waarmee de toegang tot 60 minuten wordt beperkt.
Inhoudstype	content_type	string	Het inhoudstype. Alleen voor fysieke bijlagen.
Bestandsgrootte	file_size	integer	De bestandsgrootte in bytes. Alleen voor fysieke bijlagen.

GiftApi.GiftCustomFieldRead

Aangepast veld

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het aangepaste veld.
Cadeau-id	parent_id	string	De systeemrecord-id van het cadeau dat is gekoppeld aan het aangepaste veld.
Categorie	category	string	De categorie van het aangepaste veld.
Typologie	type	string	Het type gegevens dat het aangepaste veld vertegenwoordigt.
Waarde	value		De waarde van het aangepaste veld.
Datum	date	date	De datum in het aangepaste veld.
Comment	comment	string	De opmerking over het aangepaste veld. Tekenlimiet: 50.
Datum toegevoegd	date_added	date-time	De datum waarop het aangepaste veld is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het aangepaste veld voor het laatst is gewijzigd.

GiftApi.GiftFundraiserRead

Cadeau-inzamelingsactie

Name	Pad	Type	Description
waarde	amount.value	double	De monetaire waarde.
inzamelings-id	constituent_id	string	De registratie-id van het samenstellende systeem voor de inzamelingsactie die aan het cadeau is gekoppeld.

GiftApi.GiftRead

Geschenk

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het cadeau.
Samenstellende id	constituent_id	string	De systeemrecord-id van het samenstellende onderdeel dat aan het cadeau is gekoppeld.
Typologie	type	string	Het cadeautype.
Onderdeeltype	subtype	string	Het subtype van het cadeau.
Datum	date	date-time	De cadeaudatum.
waarde	amount.value	double	De monetaire waarde.
waarde	balance.value	double	De monetaire waarde.
Batchnummer	batch_number	string	Het batchnummer dat aan dit cadeau is gekoppeld.
Toestand	gift_status	string	De status van het cadeau.
Anoniem?	is_anonymous	boolean	Is het cadeau anoniem?
Kiesdistrict	constituency	string	De kiesdistrict van het geschenk.
Opzoek-id	lookup_id	string	De door de gebruiker gedefinieerde id voor het cadeau.
Oorsprong	origin	string	De oorsprong van het cadeau.
Poststatus	post_status	string	De grootboekpoststatus van het cadeau. Beschikbare waarden zijn Gepost, NotPosted en DoNotPost. Wanneer post_status is ingesteld op DoNotPost>, moet post_date null zijn. Wanneer deze is ingesteld op NotPosted, is post_date vereist, maar blijft deze bewerkbaar. Wanneer deze is ingesteld op Gepost, is post_date vereist en kan deze niet meer worden bewerkt.
Postdatum	post_date	date-time	De datum waarop het cadeau is geplaatst in grootboek.
Reference	reference	string	Notities voor het bijhouden van speciale details over een cadeau, zoals de motivatie erachter of een gedetailleerde beschrijving van een cadeau-in-kind.
day	recurring_gift_status_date.d	integer	De dag in de fuzzy datum.
maand	recurring_gift_status_date.m	integer	De maand op de fuzzy datum.
jaar	recurring_gift_status_date.y	integer	Het jaar op de fuzzy datum.
frequency	recurring_gift_schedule.frequency	string	Installatiefrequentie van het terugkerende cadeau om weer te geven. Beschikbare waarden zijn WEKELIJKS, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MAANDELIJKS, KWARTAAL, JAARLIJKS.
start	recurring_gift_schedule.start_date	date-time	De datum waarop het terugkerende cadeau moet beginnen.
einde	recurring_gift_schedule.end_date	date-time	De datum waarop het terugkerende cadeau moet eindigen.
waarde	gift_aid_amount.value	double	De monetaire waarde.
Status van de kwalificatie van gift aid	gift_aid_qualification_status	string	Dit berekende veld bepaalt de kwalificatiestatus gift aid op basis van informatie over belastingaangifte en de database-indeling. Beschikbare waarden zijn: Qualified, NotQualified en PartlyQualified. Alleen voor het Verenigd Koninkrijk.
Cadeaucode	gift_code	string	De waarde van de cadeaucode die aan het cadeau is gekoppeld.
Cadeausplitsingen	gift_splits	array of GiftApi.GiftSplitRead	De set cadeausplitsingen die aan het cadeau zijn gekoppeld.
Inzamelingsacties	fundraisers	array of GiftApi.GiftFundraiserRead	De set fondsenwervers die krediet voor het cadeau ontvangen.
Voorlopig tegoed	soft_credits	array of GiftApi.SoftCreditRead	De set zachte tegoeden die aan het cadeau zijn gekoppeld.
Ontvangsten	receipts	array of GiftApi.ReceiptRead	De set ontvangstbewijzen die aan het cadeau zijn gekoppeld.
Dankbetuigingen	acknowledgements	array of GiftApi.AcknowledgementRead	De reeks bevestigingen die aan het geschenk zijn gekoppeld.
Payments	payments	array of GiftApi.PaymentRead	De betalingen op het cadeau.
Gekoppelde cadeaus	linked_gifts	array of string	De id's van andere geschenken die aan dit cadeau zijn gekoppeld.
Datum toegevoegd	date_added	date-time	De datum waarop het cadeau is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het cadeau voor het laatst is gewijzigd.

GiftApi.GiftSplitRead

Cadeausplitsing

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de cadeausplit.
waarde	amount.value	double	De monetaire waarde.
beroeps-id	appeal_id	string	De systeemrecord-id van het beroep dat is gekoppeld aan de cadeausplitsing.
campagne-id	campaign_id	string	De systeemrecord-id van de campagne die is gekoppeld aan de cadeausplitsing.
fonds-id	fund_id	string	De systeemrecord-id van het fonds dat is gekoppeld aan de cadeausplitsing.
waarde	gift_aid_amount.value	double	De monetaire waarde.
status van gift aid kwalificatie	gift_aid_qualification_status	string	De kwalificatiestatus van de gift aid van de cadeausplitsing. Beschikbare waarden zijn: Qualified en NotQualified. Alleen voor het Verenigd Koninkrijk.
pakket-id	package_id	string	De systeemrecord-id van het pakket dat is gekoppeld aan de cadeausplitsing.

GiftApi.ReceiptRead

Ontvangstbewijs

Name	Pad	Type	Description
waarde	amount.value	double	De monetaire waarde.
date	date	date-time	De datum op het ontvangstbewijs.
nummer	number	integer	Het nummer van het ontvangstbewijs.
status	status	string	De status van het ontvangstbewijs. Beschikbare waarden zijn: RECEIPTED, NEEDSRECEIPT en DONOTRECEIPT.

GiftApi.PaymentRead

Betaling

Name	Pad	Type	Description
accounttoken	account_token	string	De tokenized accountgegevens (bijvoorbeeld creditcard) van de externe betalingsprovider. Alleen van toepassing op betalingswijzen van 'CreditCard' en 'DirectDebit'.
CONFIGURATIE-id van BBPS	bbps_configuration_id	string	De CONFIGURATIE-id van BBPS. Alleen van toepassing op betalingswijzen van 'CreditCard' en 'DirectDebit'.
BBPS-transactie-id	bbps_transaction_id	string	De BBPS-transactie-id. Alleen van toepassing op betalingswijzen van 'CreditCard' en 'DirectDebit'.
day	check_date.d	integer	De dag in de fuzzy datum.
maand	check_date.m	integer	De maand op de fuzzy datum.
jaar	check_date.y	integer	Het jaar op de fuzzy datum.
controlenummer	check_number	string	Het controlenummer. Alleen van toepassing op de betalingswijze van 'PersonalCheck'.
transactie-id uitchecken	checkout_transaction_id	string	De transactie-id van de betaling. Alleen van toepassing op betalingswijzen van 'CreditCard' en 'DirectDebit'.
Betalingsmethode	payment_method	string	De betalingswijze. De beschikbare waarden worden hieronder weergegeven.
referentie	reference	string	De verwijzing. Alleen van toepassing op de betalingswijze van 'Overige'.
day	reference_date.d	integer	De dag in de fuzzy datum.
maand	reference_date.m	integer	De maand op de fuzzy datum.
jaar	reference_date.y	integer	Het jaar op de fuzzy datum.

GiftApi.SoftCreditRead

Zacht tegoed

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het zachte tegoed.
waarde	amount.value	double	De monetaire waarde.
samenstellende id	constituent_id	string	De systeemrecord-id van de samenstellende elementen die aan het zachte tegoed zijn gekoppeld.
cadeau-id	gift_id	string	De systeemrecord-id van het cadeau dat aan het zachte tegoed is gekoppeld.

GiftBatchApi.ApiCollectionOfGiftBatch

Cadeaubatches

Name	Pad	Type	Description
Aantal	count	integer	Het totale aantal cadeaubatches in het antwoord.
waarde	value	array of GiftBatchApi.GiftBatch	De set items die zijn opgenomen in het antwoord.

GiftBatchApi.CreatedBatch

Cadeaubatch gemaakt

Name	Pad	Type	Description
ID-kaart	batch_id	string	De systeemrecord-id van de zojuist gemaakte cadeaubatch.

GiftBatchApi.GiftBatch

Vertegenwoordigt het cadeaubatchobject

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de batch.
beschrijving	batch_description	string	De batchbeschrijving.
batchnummer	batch_number	string	Het batchnummer
geprojecteerd nummer	projected_number_of_gifts	integer	Het verwachte aantal geschenken in de partij.
werkelijk getal	number_of_gifts	integer	Het werkelijke aantal geschenken in de partij.
verwachte hoeveelheid	projected_amount	double	De verwachte waarde van geschenken in de partij.
werkelijk bedrag	actual_amount	double	De werkelijke waarde van geschenken in de partij.
heeft u uitzonderingen?	has_exceptions	boolean	Heeft de batch uitzonderingen?
Goedgekeurd?	is_approved	boolean	Is de batch goedgekeurd?
Gemaakt door	created_by	string	De naam van de gebruiker die de batch heeft gemaakt.
Gemaakt op	created_on	date-time	De datum waarop de batch is gemaakt.

ListApi.CreatedList

Lijst gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte lijst.

OpportunityApi.ApiCollectionOfOpportunityAttachmentRead

Bijlagen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of OpportunityApi.OpportunityAttachmentRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead

Aangepaste velden

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of OpportunityApi.OpportunityCustomFieldRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

OpportunityApi.ApiCollectionOfOpportunityRead

Verkoopkansen

Name	Pad	Type	Description
Aantal	count	integer	Het aantal items dat beschikbaar is voor het ophalen in de verzameling na het toepassen van eventuele aanvraagparameters. De limiet- en offsetparameters hebben geen invloed op het aantal, maar om paging te vergemakkelijken, kunnen ze van invloed zijn op het aantal items in de waarderesultatenset.
waarde	value	array of OpportunityApi.OpportunityRead	De set items die zijn opgenomen in het antwoord. Dit kan een subset van de items in de verzameling zijn.

OpportunityApi.CreatedOpportunity

Gemaakte verkoopkans

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte verkoopkans.

OpportunityApi.CreatedOpportunityAttachment

Een verkoopkansbijlage gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte verkoopkansbijlage.

OpportunityApi.CreatedOpportunityCustomField

Een verkoopkansbijlage gemaakt

Name	Pad	Type	Description
ID-kaart	id	string	De id van de zojuist gemaakte verkoopkansbijlage.

OpportunityApi.Fundraiser

Inzamelingsactie

Name	Pad	Type	Description
Samenstellende id	constituent_id	string	De systeemrecord-id van de samenstellende elementen die aan de inzamelingsactie zijn gekoppeld.
waarde	credit_amount.value	double	De monetaire waarde.

OpportunityApi.OpportunityAttachmentRead

Bijlage

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de bijlage.
Verkoopkans-id	parent_id	string	De systeemrecord-id van de verkoopkans die aan de bijlage is gekoppeld.
Typologie	type	string	Het bijlagetype. Fysieke bijlagen zijn geüploade bestanden, zoals afbeeldingen, PDF-bestanden of Word-documenten die lokaal of op het netwerk worden opgeslagen. Ze worden opgeslagen en beheerd in het systeem. Koppelingsbijlagen zijn koppelingen naar bestanden zoals afbeeldingen, blogberichten of YouTube-video's die online of in een cloudopslagaccount zijn. Ze worden extern opgeslagen en beheerd.
Naam	name	string	De naam van de bijlage. Tekenlimiet: 150.
Datum	date	date-time	De datum van de bijlage.
URL	url	string	De URL voor de bijlage. Dit is vereist voor koppelingsbijlagen en niet van toepassing op fysieke bijlagen.
Bestandsnaam	file_name	string	De naam van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Bestands-id	file_id	string	De id van het bestand. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-id	thumbnail_id	string	De id van de miniatuur. Tekenlimiet: 36. Alleen voor fysieke bijlagen.
Miniatuur-URL	thumbnail_url	string	De URL voor een miniatuur. Voor fysieke bijlagen die alleen afbeeldingen zijn. Bevat een tijdsgebonden handtekening waarmee de toegang tot 60 minuten wordt beperkt.
Inhoudstype	content_type	string	Het inhoudstype. Alleen voor fysieke bijlagen.
Bestandsgrootte	file_size	integer	De bestandsgrootte in bytes. Alleen voor fysieke bijlagen.

OpportunityApi.OpportunityCustomFieldRead

Aangepast veld

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van het aangepaste veld.
Verkoopkans-id	parent_id	string	De systeemrecord-id van de verkoopkans die is gekoppeld aan het aangepaste veld.
Categorie	category	string	De categorie van het aangepaste veld.
Typologie	type	string	Het type gegevens dat het aangepaste veld vertegenwoordigt.
Waarde	value		De waarde van het aangepaste veld.
Datum	date	date	De datum in het aangepaste veld.
Comment	comment	string	De opmerking over het aangepaste veld. Tekenlimiet: 50.
Datum toegevoegd	date_added	date-time	De datum waarop het aangepaste veld is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop het aangepaste veld voor het laatst is gewijzigd.

OpportunityApi.OpportunityRead

Kans

Name	Pad	Type	Description
ID-kaart	id	string	De systeemrecord-id van de verkoopkans.
Samenstellende id	constituent_id	string	De systeemrecord-id van de samenstellende component die aan de verkoopkans is gekoppeld.
Purpose	purpose	string	Het beoogde gebruik voor geld dat wordt opgehaald als gevolg van de kans.
Naam	name	string	De naam die de verkoopkans in het hele programma identificeert, zoals in lijsten of op samenstellende records. Tekenlimiet: 255.
Toestand	status	string	De status die aangeeft waar de kans zich in het aanvraagproces bevindt.
Deadline	deadline	date-time	De doeldatum voor de kans om een cadeau te geven.
Vraagdatum	ask_date	date-time	De datum waarop het verzoek is ingediend.
waarde	ask_amount.value	double	De monetaire waarde.
Verwachte datum	expected_date	date-time	De datum waarop de prospect naar verwachting zal geven als reactie op de verkoopkans.
waarde	expected_amount.value	double	De monetaire waarde.
Datum van financiering	funded_date	date-time	De datum waarop het prospect antwoord gaf op de verkoopkans.
waarde	funded_amount.value	double	De monetaire waarde.
Campagne-id	campaign_id	string	De systeemrecord-id van de campagne die aan de verkoopkans is gekoppeld. De campagne stelt de algemene doelstellingen voor het ophalen van geld vast.
Fonds-id	fund_id	string	De systeemrecord-id van het fonds dat aan de verkoopkans is gekoppeld. Het fonds wijst het specifieke financiële doel van een geschenk aan en identificeert de financiële rekening voor dat cadeau.
Inzamelingsactie(s)	fundraisers	array of OpportunityApi.Fundraiser	De set systeemrecord-id's voor de inzamelingsacties die aan de verkoopkans zijn toegewezen.
Inactief?	inactive	boolean	Is de kans inactief?
linked_gifts	linked_gifts	array of string	Het systeem registreert id's van de geschenken die betrekking hebben op de verkoopkans.
Datum toegevoegd	date_added	date-time	De datum waarop de verkoopkans is gemaakt.
Datum gewijzigd	date_modified	date-time	De datum waarop de verkoopkans voor het laatst is gewijzigd.

Delen via

Blackbaud Raisers Edge NXT (preview)

Vereiste voorwaarden

Hoe kan ik referenties ophalen?

Bekende problemen en beperkingen

Beperkingslimieten

Acties

Aangepast veld voor een campagne bijwerken

Parameters

Aangepaste velden voor beroep weergeven

Parameters

Retouren

Aangepaste velden voor cadeaus weergeven

Parameters

Retouren

Aangepaste velden voor fonds weergeven

Parameters

Retouren

Aangepaste velden voor lijstactie

Parameters

Retouren

Aangepaste velden voor lijstcampagne

Parameters

Retouren

Aangepaste velden voor verkoopkans weergeven

Parameters

Retouren

Aangepaste velden weergeven

Parameters

Retouren

Beroep op lijst

Parameters

Retouren

Bijlagen bij beroep weergeven

Parameters

Retouren

Bijlagen bij lijstactie

Parameters

Retouren

Cadeaubatches weergeven

Parameters

Retouren

Cadeaubijlagen weergeven

Parameters

Retouren

Cadeaus vermelden

Parameters

Retouren

Campagnebijlagen vermelden

Parameters

Retouren

Campagnes vermelden

Parameters

Retouren

Deelnemers aan een lijst met gebeurtenissen

Parameters

Retouren

Deelnemerskosten vermelden

Parameters

Retouren

Details van bevestiging van cadeau bijwerken

Parameters

Details van cadeaubon bijwerken

Parameters

Donaties van deelnemers vermelden

Parameters

Retouren

Een aangepast actieveld maken

Parameters

Retouren

Een aangepast veld maken

Parameters

Retouren

Een aangepast veld voor cadeaus bijwerken

Parameters

Een aangepast veld voor cadeaus maken

Parameters

Retouren

Een aangepast veld voor een actie bijwerken

Parameters