Blackbaud RENXT Geschenke
Blackbaud Raiser es Edge NXT ist eine umfassende cloudbasierte Spenden- und Spendermanagement-Softwarelösung, die speziell für gemeinnützige Organisationen und die gesamte soziale Gute Community entwickelt wurde. Verwenden Sie den Connector "Geschenke", um Geschenke zu verwalten.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Blackbaud Support |
| URL | https://www.blackbaud.com/support |
| skyapi@blackbaud.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Blackbaud, Inc. |
| Webseite | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| Datenschutzrichtlinie | https://www.blackbaud.com/privacy-shield |
| Kategorien | Vertrieb und CRM; Produktivität |
Raisers Edge NXT ist eine umfassende cloudbasierte Spenden- und Spendermanagement-Softwarelösung, die speziell für gemeinnützige Organisationen und die gesamte soziale Gute Community entwickelt wurde.
Dieser Connector basiert auf der SKY-API von Blackbaud und bietet Vorgänge zur Verwaltung von Geschenken und verwandten Entitäten, die in The Raiser es Edge NXT gefunden wurden, einschließlich:
- Geschenke und Bestandteile, die Zusammenfassungen geben
- Geschenkbatches
- Einnahmen
- Danksagung
- und vieles mehr...
Weitere Informationen finden Sie in der Dokumentation.
Voraussetzungen
Um diesen Connector zu verwenden, müssen Sie über ein Blackbaud ID-Konto mit Zugriff auf eine oder mehrere Blackbaud-Umgebungen verfügen.
Darüber hinaus muss der Administrator Ihrer Organisation auch eine Aktion auf Administratorebene innerhalb des Systems ausführen, damit dieser Connector auf Ihre Blackbaud-Umgebung zugreifen kann. Weitere Informationen zu diesen Voraussetzungen finden Sie in der Ersteinrichtungsdokumentation .
Wie erhalten Sie Anmeldeinformationen?
Der Administrator Ihrer Organisation sendet Ihnen eine Einladung zur Edge NXT-Umgebung der Organisation und konfiguriert Ihre Benutzerkontoberechtigungen innerhalb der Umgebung. Für die Verwendung dieses Connectors sind keine zusätzlichen Anmeldeinformationen erforderlich.
Bekannte Probleme und Einschränkungen
Der Connector wird im Kontext Ihres Benutzerkontos ausgeführt und unterliegt daher Ihren Benutzerberechtigungen innerhalb der Umgebung.
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen der Lebenszeit des Bestandteils |
Gibt die Lebensdauer zurück, die eine Zusammenfassung für einen Bestandteil angibt. |
| Abrufen eines Geschenks durch Nachschlage-ID |
Gibt die Systemdatensatz-ID eines Geschenks aus der angegebenen Nachschlage-ID zurück. |
| Aktualisieren der Details zur Geschenkbestätigung |
Aktualisiert die Bestätigungsdetails für ein Geschenk. |
| Aktualisieren einer Geschenkanlage |
Aktualisiert eine Geschenkanlage. |
| Aktualisieren einer Geschenknotiz |
Aktualisiert eine Geschenknotiz. |
| Aktualisieren einer Geschenkwürdigung |
Aktualisiert eine Geschenkwürdigung. |
| Aktualisieren einer Teilsteuererklärung |
Aktualisiert eine konstituierende Steuererklärung. |
| Aktualisieren eines Anerkennungsbeehrungsgeschenks |
Aktualisiert eine Anerkennung des Geschenks. |
| Aktualisieren eines benutzerdefinierten Geschenkfelds |
Aktualisiert ein benutzerdefiniertes Geschenkfeld. |
| Aktualisieren von Geschenkbestätigungsdetails |
Aktualisiert die Belegdetails für ein Geschenk. |
| Auflisten von Geschenkbatches |
Listen Sie die Geschenkbatches auf. |
| Auflisten von Steuererklärungen |
Listet die Steuererklärungen für Geschenkbeihilfen für einen Bestandteil auf (gilt nur für britische Versionen). |
| Benutzerdefinierte Felder für Geschenk auflisten |
Listet die benutzerdefinierten Felder für ein Geschenk auf. |
| Ehrengeschenke auflisten |
Listet die Ehren für ein Geschenk auf. |
| Ehrengutscheine auflisten |
Listet die Anerkennungen für eine Geschenkwürdigung auf. |
| Erstellen einer Geschenkanlage |
Erstellt eine neue Geschenkanlage. |
| Erstellen einer Geschenknotiz |
Erstellt eine neue Geschenknotiz. |
| Erstellen einer Konstituierenden Steuererklärung |
Erstellt eine neue Steuererklärung für Geschenkbeihilfen für einen Bestandteil. |
| Erstellen einer Verpfändungszahlung |
Erstellt eine neue Verpfändungszahlung. |
| Erstellen einer Zusage |
Erstellt eine neue Zusage. |
| Erstellen eines Aktiengeschenks |
Erstellt ein neues Aktiengeschenk. |
| Erstellen eines benutzerdefinierten Geschenkfelds |
Erstellt ein neues benutzerdefiniertes Geschenkfeld. |
| Erstellen eines Geschenkbatches |
Erstellt einen neuen Geschenkbatch. |
| Erstellen eines Geschenks |
Erstellt ein neues Geschenk. |
| Erstellen sie eine Geschenkwürdigung |
Erstellt eine neue Geschenkwürdigung. |
| Erstes Geschenk erhalten |
Gibt das erste Geschenk für einen Bestandteil zurück. |
| Geschenk erhalten |
Gibt Informationen zu einem Geschenk zurück. |
| Geschenke auflisten |
Gibt eine Liste von Geschenken zurück. |
| Geschenkgutschriften auflisten |
Listet die Anlagen für ein Geschenk auf. |
| Geschenknotizen auflisten |
Listet die Notizen für ein Geschenk auf. |
| Hinzufügen eines Geschenks zum Batch |
Fügen Sie dem angegebenen Geschenkbatch ein Geschenk hinzu. |
| Holen Sie sich das beste Geschenk |
Gibt das größte Geschenk für einen Bestandteil zurück. |
| Holen Sie sich das neueste Geschenk |
Gibt das neueste Geschenk für einen Bestandteil zurück. |
| Verkaufen eines Aktiengeschenks |
Aktualisiert ein Aktiengeschenk, das verkauft werden soll. |
| Verpfändungsraten auflisten |
Listet die Raten für eine Zusage auf. |
| Verpfändungszahlungen auflisten |
Listet die Zahlungen für eine Verpfändung auf. |
Abrufen der Lebenszeit des Bestandteils
Gibt die Lebensdauer zurück, die eine Zusammenfassung für einen Bestandteil angibt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bestandteil-ID
|
constituent_id | True | string |
Die Systemdatensatz-ID des Bestandteils. |
Gibt zurück
Lebenslanges Geben
Abrufen eines Geschenks durch Nachschlage-ID
Gibt die Systemdatensatz-ID eines Geschenks aus der angegebenen Nachschlage-ID zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Nachschlage-ID
|
giftlookupid | True | string |
Die Nachschlage-ID des Geschenks. |
Gibt zurück
Geschenk-ID-Karte
Aktualisieren der Details zur Geschenkbestätigung
Aktualisiert die Bestätigungsdetails für ein Geschenk.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bestätigungs-ID
|
acknowledgement_id | True | string |
Die Systemdatensatz-ID der zu aktualisierenden Geschenkbestätigung. Sie verwendet die ID des Übergeordneten Geschenks als Wert. |
|
Der Status
|
status | string |
Der Status der Bestätigung. Wenn der Status auf "DoNotAcknowledge" festgelegt ist, sollte der Buchstabe und das Datum null sein. Wenn der Status auf "NeedsAcknowledgement" festgelegt ist, sollte das Datum null sein. |
|
|
Datum
|
date | date-time |
Das Datum, das der Bestätigung zugeordnet ist (z. B. '2020-09-18T04:13:56Z'). |
|
|
Letter
|
letter | string |
Der Brief, der der Bestätigung zugeordnet ist. |
Aktualisieren einer Geschenkanlage
Aktualisiert eine Geschenkanlage.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anlagen-ID
|
attachment_id | True | string |
Die Systemdatensatz-ID der zu aktualisierenden Anlage. |
|
Name
|
name | string |
Der Name der Anlage. Zeichenlimit: 150. |
|
|
Datum
|
date | date-time |
Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen. |
|
|
Stichwörter
|
tags | array of string |
Die tags, die der Anlage zugeordnet sind. |
Aktualisieren einer Geschenknotiz
Aktualisiert eine Geschenknotiz.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Notiz-ID
|
id | True | integer |
Die Systemdatensatz-ID der zu aktualisierenden Notiz. |
|
Typ
|
note_type_id | integer |
Der Notiztyp. |
|
|
Tag
|
d | integer |
Der Tag im Fuzzydatum. |
|
|
Monat
|
m | integer |
Der Monat im Fuzzydatum. |
|
|
Jahr
|
y | integer |
Das Jahr im Fuzzydatum. |
|
|
Zusammenfassung
|
summary | string |
Die Notizzusammenfassung. Zeichenlimit: 255. |
|
|
Hinweis
|
text | string |
Der Notiztext. |
|
|
Autor
|
author | string |
Der Notizautor. Zeichenlimit: 50. |
Aktualisieren einer Geschenkwürdigung
Aktualisiert eine Geschenkwürdigung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Geschenk-Ehren-ID
|
gift_tribute_id | True | integer |
Die Systemdatensatz-ID des zu aktualisierenden Geschenks. |
|
Tribute-Typ
|
tribute_type | integer |
Der Hommagestyp. |
|
|
Status bestätigen
|
acknowledge | string |
Der Anerkennungsstatus des Geschenks. |
Aktualisieren einer Teilsteuererklärung
Aktualisiert eine konstituierende Steuererklärung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Steuererklärungs-ID
|
tax_declaration_id | True | integer |
Die Systemdatensatz-ID der zu aktualisierenden Steuererklärung. |
|
Deklaration beginnt
|
declaration_starts | date-time |
Das Datum der Steuererklärung beginnt (z. B. "2020-09-18T04:13:56Z"). |
|
|
Deklaration endet
|
declaration_ends | date-time |
Das Datum der Steuererklärung endet (z. B. '2020-09-18T04:13:56Z'). |
|
|
Erklärung gemacht
|
declaration_made | date-time |
Das Datum der Steuererklärung (z. B. "2020-09-18T04:13:56Z"). |
|
|
Indicator
|
declaration_indicator | string |
Der Deklarationsindikator. |
|
|
Quelle
|
declaration_source | string |
Die Deklarationsquelle. |
|
|
Bestätigung gesendet
|
confirmation_sent | date-time |
Das Datum, an dem die Bestätigung gesendet wurde (z. B. '2020-09-18T04:13:56Z'). |
|
|
Zurückgegebene Bestätigung
|
confirmation_returned | date-time |
Das Datum, an dem die Bestätigung zurückgegeben wurde (z. B. '2020-09-18T04:13:56Z'). |
|
|
Lohnsteuer
|
constituent_pays_tax | string |
Gibt an, ob der Bestandteil Steuern zahlt. |
|
|
Der Status
|
tax_payer_status | string |
Der Status des Steuerpflichtigen. |
|
|
Kommentare
|
tax_notes | string |
Kommentare zur Steuererklärung. |
|
|
Sequence
|
sequence | integer |
Die numerische Sequenz, die der Steuererklärung zugeordnet ist. |
Aktualisieren eines Anerkennungsbeehrungsgeschenks
Aktualisiert eine Anerkennung des Geschenks.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anerkennungs-ID des Geschenks
|
gift_tribute_acknowledgee_id | True | integer |
Die Systemdatensatz-ID der Geschenkwürdigung bestätigt, dass sie aktualisiert wird. |
|
Letter
|
letter | integer |
Der an die Bestätigung gesendete Brief. |
|
|
Briefdatum
|
letter_date | date-time |
Das Datum, an dem der Brief gesendet wurde. |
Aktualisieren eines benutzerdefinierten Geschenkfelds
Aktualisiert ein benutzerdefiniertes Geschenkfeld.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des benutzerdefinierten Felds
|
custom_field_id | True | string |
Die Systemdatensatz-ID des zu aktualisierenden benutzerdefinierten Felds. |
|
body
|
body | True | dynamic |
Ein Objekt, das die Eigenschaften des zu aktualisierenden benutzerdefinierten Felds darstellt. |
Aktualisieren von Geschenkbestätigungsdetails
Aktualisiert die Belegdetails für ein Geschenk.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Eingangskennung
|
receipt_id | True | string |
Die Systemdatensatz-ID des zu aktualisierenden Geschenkbelegs. Sie verwendet die ID des Übergeordneten Geschenks als Wert. |
|
Der Status
|
status | string |
Der Belegstatus des Geschenks. Wenn der Status auf "NeedsReceipt" oder "DoNotReceipt" festgelegt ist, sollte das Belegdatum null sein. |
|
|
Betrag
|
value | double |
Der Belegbetrag. |
|
|
Datum
|
date | date-time |
Das Datum am Beleg (z. B. '2020-09-18T04:13:56Z'). |
|
|
Number
|
number | integer |
Die Nummer des Belegs. |
Auflisten von Geschenkbatches
Listen Sie die Geschenkbatches auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Batchnummer
|
batch_number | string |
Stellt einen Filter für Ergebnisse dar, die der angegebenen Zahl entsprechen. |
|
|
Gebilligt?
|
approved | boolean |
Stellt einen Filter für den Status des Geschenkbatches dar. |
|
|
Hat Ausnahmen?
|
has_exceptions | boolean |
Stellt einen Filter dar, nach dem der Geschenkbatch Ausnahmen enthält. |
|
|
Limit
|
limit | integer |
Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 5000. |
|
|
Offset
|
offset | integer |
Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung. |
|
|
Suchtext
|
search_text | string |
Stellt einen Filter für Text dar, der in den Batchbeschreibungs- oder Batchzahlenfeldern enthalten ist. |
|
|
Erstellt von
|
created_by | string |
Stellt einen Filter für Geschenkbatches dar, die vom angegebenen Benutzer erstellt wurden. |
Gibt zurück
Geschenkbatches
Auflisten von Steuererklärungen
Listet die Steuererklärungen für Geschenkbeihilfen für einen Bestandteil auf (gilt nur für britische Versionen).
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bestandteil-ID
|
constituent_id | True | integer |
Die Systemdatensatz-ID des Bestandteils. |
|
Limit
|
limit | integer |
Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Es gibt kein Maximum. |
|
|
Offset
|
offset | integer |
Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung. |
Gibt zurück
Steuererklärungen
Benutzerdefinierte Felder für Geschenk auflisten
Listet die benutzerdefinierten Felder für ein Geschenk auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Geschenk-ID
|
gift_id | True | string |
Die Systemdatensatz-ID des Geschenks. |
Gibt zurück
Benutzerdefinierte Felder
Ehrengeschenke auflisten
Listet die Ehren für ein Geschenk auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Geschenk-ID
|
gift_id | True | integer |
Die Systemdatensatz-ID des Geschenks. |
Gibt zurück
Ehrengeschenke
Ehrengutscheine auflisten
Listet die Anerkennungen für eine Geschenkwürdigung auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Geschenk-Ehren-ID
|
gift_tribute_id | True | integer |
Die Systemdatensatz-ID des Geschenkgutscheins. |
Gibt zurück
Ehrengeschenke
Erstellen einer Geschenkanlage
Erstellt eine neue Geschenkanlage.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Geschenk-ID
|
parent_id | True | string |
Die Systemdatensatz-ID des Geschenks, das der Anlage zugeordnet ist. |
|
Typ
|
type | True | string |
Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet. |
|
Name
|
name | string |
Der Name der Anlage. Zeichenlimit: 150. |
|
|
Datum
|
date | date-time |
Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z'). Dieses Feld wird standardmäßig auf das aktuelle Datum und die aktuelle Uhrzeit festgelegt, wenn nicht angegeben. |
|
|
URL
|
url | string |
Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen. |
|
|
Dateiname
|
file_name | string |
Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen. |
|
|
Datei-ID
|
file_id | string |
Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen. |
|
|
Miniaturansichts-ID
|
thumbnail_id | string |
Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen. |
|
|
Stichwörter
|
tags | array of string |
Die tags, die der Anlage zugeordnet sind. |
Gibt zurück
Geschenkanlage erstellt
Erstellen einer Geschenknotiz
Erstellt eine neue Geschenknotiz.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Geschenk-ID
|
gift_id | True | integer |
Die Systemdatensatz-ID des Geschenks, das der Notiz zugeordnet ist. |
|
Typ
|
note_type_id | True | integer |
Der Notiztyp. |
|
Tag
|
d | integer |
Der Tag im Fuzzydatum. |
|
|
Monat
|
m | integer |
Der Monat im Fuzzydatum. |
|
|
Jahr
|
y | integer |
Das Jahr im Fuzzydatum. |
|
|
Zusammenfassung
|
summary | string |
Die Notizzusammenfassung. Zeichenlimit: 255. |
|
|
Hinweis
|
text | string |
Der Notiztext. |
|
|
Autor
|
author | string |
Der Notizautor. Zeichenlimit: 50. |
Gibt zurück
Notiz erstellt
Erstellen einer Konstituierenden Steuererklärung
Erstellt eine neue Steuererklärung für Geschenkbeihilfen für einen Bestandteil.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bestandteil-ID
|
constituent_id | True | integer |
Die Systemdatensatz-ID des Bestandteils. |
|
Deklaration beginnt
|
declaration_starts | True | date-time |
Das Datum der Steuererklärung beginnt (z. B. "2020-09-18T04:13:56Z"). |
|
Deklaration endet
|
declaration_ends | date-time |
Das Datum der Steuererklärung endet (z. B. '2020-09-18T04:13:56Z'). |
|
|
Erklärung gemacht
|
declaration_made | date-time |
Das Datum der Steuererklärung (z. B. "2020-09-18T04:13:56Z"). |
|
|
Indicator
|
declaration_indicator | string |
Der Deklarationsindikator. |
|
|
Quelle
|
declaration_source | string |
Die Deklarationsquelle. |
|
|
Bestätigung gesendet
|
confirmation_sent | date-time |
Das Datum, an dem die Bestätigung gesendet wurde (z. B. '2020-09-18T04:13:56Z'). |
|
|
Zurückgegebene Bestätigung
|
confirmation_returned | date-time |
Das Datum, an dem die Bestätigung zurückgegeben wurde (z. B. '2020-09-18T04:13:56Z'). |
|
|
Lohnsteuer
|
constituent_pays_tax | string |
Gibt an, ob der Bestandteil Steuern zahlt. |
|
|
Der Status
|
tax_payer_status | string |
Der Status des Steuerpflichtigen. |
|
|
Kommentare
|
tax_notes | string |
Kommentare zur Steuererklärung. |
|
|
Sequence
|
sequence | integer |
Die numerische Sequenz, die der Steuererklärung zugeordnet ist. |
Gibt zurück
Steuererklärung erstellt
Erstellen einer Verpfändungszahlung
Erstellt eine neue Verpfändungszahlung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bestandteil-ID
|
id | True | string |
Die Systemdatensatz-ID des Bestandteils. |
|
Betrag
|
value | True | double |
Der Betrag der Zusagezahlung. |
|
Datum
|
gift_date | True | date |
Das Zusagenzahlungsdatum (z. B. "2020-09-18"). |
|
Menge
|
value | True | double |
Der Betrag des Geschenks, der geteilt wird. |
|
Fonds-ID
|
fund_id | True | string |
Die Systemdatensatz-ID des Fonds, der mit der Geschenkteilung verknüpft ist. |
|
Kampagnen-ID
|
campaign_id | string |
Die Systemdatensatz-ID der Kampagne, die mit der Teilung des Geschenks verknüpft ist. |
|
|
Berufungs-ID
|
appeal_id | string |
Die Systemdatensatz-ID des Aufrufs, der dem Geschenkteil zugeordnet ist. |
|
|
Paket-ID
|
package_id | string |
Die Systemdatensatz-ID des Pakets, das dem Geschenkteil zugeordnet ist. |
|
|
Zahlungsmethode
|
method | True | string |
Die Zahlungsmethode. |
|
Nummer überprüfen
|
check_number | string |
Die Prüfnummer. |
|
|
Reference
|
reference_number | string |
Der Zahlungsverweis (gilt nur, wenn die Zahlungsmethode "Sonstige" lautet). |
|
|
Ist anonym?
|
anonymous | boolean |
Ist das Geschenk anonym? Wenn kein Wert angegeben wird, wird die Standardmäßige Anonymität des Spenders verwendet. |
|
|
Versprechen
|
pledge_id | string |
Die Systemdatensatz-ID der Zusage, die bezahlt wird. |
|
|
Rate
|
installment_id | string |
Die Systemdatensatz-ID der Zahlung. |
|
|
Menge
|
amount_applied | double |
Der Betrag, der auf die Installation angewendet wurde. |
|
|
Subtyp
|
name | string |
Der Untertyp des Geschenks. |
|
|
Kommentar
|
comments | string |
Notizen, um besondere Details zu einem Geschenk wie der Motivation dahinter nachzuverfolgen. |
|
|
Nachschlage-ID
|
lookup_id | string |
Der benutzerdefinierte Bezeichner für das Geschenk. |
|
|
Geschenkcode
|
value | string |
Der Geschenkcode, der dem Geschenk zugeordnet ist. |
|
|
Wahlkreis
|
value | string |
Der Wahlkreis des Geschenks. |
|
|
Beitragsstatus
|
gift_post_status | string |
Der Beitragsstatus des Geschenks. |
|
|
Postdatum
|
gift_post_date | date |
Das Datum, an dem das Geschenk gepostet werden soll (z. B. '2020-09-18'). |
|
|
Bestätigungsstatus
|
receipt_status | True | string |
Der Belegstatus des Geschenks. |
|
Belegsbetrag
|
value | True | double |
Der Betrag des Belegs für das Geschenk. |
|
Wareneingangsdatum
|
receipt_date | date |
Das Datum, an dem das Geschenk erhalten wurde (z. B. "2020-09-18"). |
|
|
Belegsnummer
|
receipt_number | integer |
Die Belegnummer. |
|
|
Belegstapel
|
value | string |
Der Belegstapel. |
|
|
Status bestätigen
|
status | True | string |
Der Anerkennungsstatus des Geschenks. |
|
Datum der Bestätigung
|
acknowledgement_date | date |
Das Datum, an dem das Geschenk anerkannt wurde (z. B. "2020-09-18"). |
|
|
Letter
|
value | string |
Der Brief, der der Bestätigung zugeordnet ist. |
|
|
type
|
credit_type | True | string |
Der Typ des Anerkennungsguthabens. |
|
Empfänger-ID
|
constituent_id | True | string |
Die Systemdatensatz-ID des Empfängers der Erkennungsgutschrift. |
|
Menge
|
value | True | double |
Der Betrag, der dem Empfänger gutgeschrieben wurde. |
Gibt zurück
Geschenk erstellt
- Body
- GiftApi.CreatedGift
Erstellen einer Zusage
Erstellt eine neue Zusage.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bestandteil-ID
|
id | True | string |
Die Systemdatensatz-ID des Bestandteils. |
|
Betrag
|
value | True | double |
Der Betrag der Zusage. |
|
Datum
|
gift_date | True | date |
Das Zusagendatum (z. B. "2020-09-18"). |
|
Frequenz
|
frequency | True | string |
Die Ratenhäufigkeit für die Zusage. |
|
Anzahl der Installationen
|
number_of_installments | True | integer |
Die Anzahl der Raten für die Verpfändung. |
|
Startdatum
|
start_date | True | date |
Das Datum, an dem der Zusageplan beginnt. |
|
Menge
|
value | True | double |
Der Betrag des Geschenks, der geteilt wird. |
|
Fonds-ID
|
fund_id | True | string |
Die Systemdatensatz-ID des Fonds, der mit der Geschenkteilung verknüpft ist. |
|
Kampagnen-ID
|
campaign_id | string |
Die Systemdatensatz-ID der Kampagne, die mit der Teilung des Geschenks verknüpft ist. |
|
|
Berufungs-ID
|
appeal_id | string |
Die Systemdatensatz-ID des Aufrufs, der dem Geschenkteil zugeordnet ist. |
|
|
Paket-ID
|
package_id | string |
Die Systemdatensatz-ID des Pakets, das dem Geschenkteil zugeordnet ist. |
|
|
Zahlungsmethode
|
method | True | string |
Die Zahlungsmethode. |
|
Nummer überprüfen
|
check_number | string |
Die Prüfnummer. |
|
|
Reference
|
reference_number | string |
Der Zahlungsverweis (gilt nur, wenn die Zahlungsmethode "Sonstige" lautet). |
|
|
Erinnerung senden?
|
send_reminder | boolean |
Zusagenerinnerungen senden? |
|
|
Ist anonym?
|
anonymous | boolean |
Ist das Geschenk anonym? Wenn kein Wert angegeben wird, wird die Standardmäßige Anonymität des Spenders verwendet. |
|
|
Subtyp
|
name | string |
Der Untertyp des Geschenks. |
|
|
Kommentar
|
comments | string |
Notizen, um besondere Details zu einem Geschenk wie der Motivation dahinter nachzuverfolgen. |
|
|
Nachschlage-ID
|
lookup_id | string |
Der benutzerdefinierte Bezeichner für das Geschenk. |
|
|
Geschenkcode
|
value | string |
Der Geschenkcode, der dem Geschenk zugeordnet ist. |
|
|
Wahlkreis
|
value | string |
Der Wahlkreis des Geschenks. |
|
|
Beitragsstatus
|
gift_post_status | string |
Der Beitragsstatus des Geschenks. |
|
|
Postdatum
|
gift_post_date | date |
Das Datum, an dem das Geschenk gepostet werden soll (z. B. '2020-09-18'). |
|
|
Der Status
|
gift_status | string |
Der Status der Zusage. |
|
|
Tag
|
d | integer |
Der Tag im Fuzzydatum. |
|
|
Monat
|
m | integer |
Der Monat im Fuzzydatum. |
|
|
Jahr
|
y | integer |
Das Jahr im Fuzzydatum. |
|
|
Bestätigungsstatus
|
receipt_status | True | string |
Der Belegstatus des Geschenks. |
|
Belegsbetrag
|
value | True | double |
Der Betrag des Belegs für das Geschenk. |
|
Wareneingangsdatum
|
receipt_date | date |
Das Datum, an dem das Geschenk erhalten wurde (z. B. "2020-09-18"). |
|
|
Belegsnummer
|
receipt_number | integer |
Die Belegnummer. |
|
|
Belegstapel
|
value | string |
Der Belegstapel. |
|
|
Status bestätigen
|
status | True | string |
Der Anerkennungsstatus des Geschenks. |
|
Datum der Bestätigung
|
acknowledgement_date | date |
Das Datum, an dem das Geschenk anerkannt wurde (z. B. "2020-09-18"). |
|
|
Letter
|
value | string |
Der Brief, der der Bestätigung zugeordnet ist. |
|
|
type
|
credit_type | True | string |
Der Typ des Anerkennungsguthabens. |
|
Empfänger-ID
|
constituent_id | True | string |
Die Systemdatensatz-ID des Empfängers der Erkennungsgutschrift. |
|
Menge
|
value | True | double |
Der Betrag, der dem Empfänger gutgeschrieben wurde. |
|
date
|
date | date |
Das Datum der Installation (z. B. '2020-09-18'). |
|
|
Menge
|
amount | double |
Der Betrag der Installation. |
Gibt zurück
Geschenk erstellt
- Body
- GiftApi.CreatedGift
Erstellen eines Aktiengeschenks
Erstellt ein neues Aktiengeschenk.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bestandteil-ID
|
id | True | string |
Die Systemdatensatz-ID des Bestandteils. |
|
Betrag
|
value | True | double |
Der Betrag des Geschenks. |
|
Datum
|
gift_date | True | date |
Das Geschenkdatum (z. B. '2020-09-18'). |
|
Emittent
|
issuer | string |
Der Aktienherausgeber. |
|
|
Ausstellersymbol
|
symbol | string |
Das Aktienherausgebersymbol. |
|
|
Anzahl der Einheiten
|
units | integer |
Die Anzahl der Lagereinheiten. |
|
|
Medianpreis pro Einheit
|
unit_price | double |
Der Medianpreis pro Einheit. |
|
|
Menge
|
value | True | double |
Der Betrag des Geschenks, der geteilt wird. |
|
Fonds-ID
|
fund_id | True | string |
Die Systemdatensatz-ID des Fonds, der mit der Geschenkteilung verknüpft ist. |
|
Kampagnen-ID
|
campaign_id | string |
Die Systemdatensatz-ID der Kampagne, die mit der Teilung des Geschenks verknüpft ist. |
|
|
Berufungs-ID
|
appeal_id | string |
Die Systemdatensatz-ID des Aufrufs, der dem Geschenkteil zugeordnet ist. |
|
|
Paket-ID
|
package_id | string |
Die Systemdatensatz-ID des Pakets, das dem Geschenkteil zugeordnet ist. |
|
|
Zahlungsmethode
|
method | True | string |
Die Zahlungsmethode. |
|
Nummer überprüfen
|
check_number | string |
Die Prüfnummer. |
|
|
Reference
|
reference_number | string |
Der Zahlungsverweis (gilt nur, wenn die Zahlungsmethode "Sonstige" lautet). |
|
|
Ist anonym?
|
anonymous | boolean |
Ist das Geschenk anonym? Wenn kein Wert angegeben wird, wird die Standardmäßige Anonymität des Spenders verwendet. |
|
|
Subtyp
|
name | string |
Der Untertyp des Geschenks. |
|
|
Kommentar
|
comments | string |
Notizen, um besondere Details zu einem Geschenk wie der Motivation dahinter nachzuverfolgen. |
|
|
Nachschlage-ID
|
lookup_id | string |
Der benutzerdefinierte Bezeichner für das Geschenk. |
|
|
Geschenkcode
|
value | string |
Der Geschenkcode, der dem Geschenk zugeordnet ist. |
|
|
Wahlkreis
|
value | string |
Der Wahlkreis des Geschenks. |
|
|
Beitragsstatus
|
gift_post_status | string |
Der Beitragsstatus des Geschenks. |
|
|
Postdatum
|
gift_post_date | date |
Das Datum, an dem das Geschenk gepostet werden soll (z. B. '2020-09-18'). |
|
|
Bestätigungsstatus
|
receipt_status | True | string |
Der Belegstatus des Geschenks. |
|
Belegsbetrag
|
value | True | double |
Der Betrag des Belegs für das Geschenk. |
|
Wareneingangsdatum
|
receipt_date | date |
Das Datum, an dem das Geschenk erhalten wurde (z. B. "2020-09-18"). |
|
|
Belegsnummer
|
receipt_number | integer |
Die Belegnummer. |
|
|
Belegstapel
|
value | string |
Der Belegstapel. |
|
|
Status bestätigen
|
status | True | string |
Der Anerkennungsstatus des Geschenks. |
|
Datum der Bestätigung
|
acknowledgement_date | date |
Das Datum, an dem das Geschenk anerkannt wurde (z. B. "2020-09-18"). |
|
|
Letter
|
value | string |
Der Brief, der der Bestätigung zugeordnet ist. |
|
|
type
|
credit_type | True | string |
Der Typ des Anerkennungsguthabens. |
|
Empfänger-ID
|
constituent_id | True | string |
Die Systemdatensatz-ID des Empfängers der Erkennungsgutschrift. |
|
Menge
|
value | True | double |
Der Betrag, der dem Empfänger gutgeschrieben wurde. |
Gibt zurück
Geschenk erstellt
- Body
- GiftApi.CreatedGift
Erstellen eines benutzerdefinierten Geschenkfelds
Erstellt ein neues benutzerdefiniertes Geschenkfeld.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Ein Objekt, das das zu erstellende benutzerdefinierte Feld darstellt. |
Gibt zurück
Benutzerdefiniertes Geschenkfeld erstellt
Erstellen eines Geschenkbatches
Erstellt einen neuen Geschenkbatch.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Description
|
batch_description | string |
Die Beschreibung des Batches. |
|
|
Erwartete Zahl
|
expected_number | integer |
Die Anzahl der geschenke, die in der Batchmenge erwartet werden. |
|
|
Erwartete Gesamtsumme
|
expected_batch_total | double |
Der Gesamtwert der Geschenke in der Charge. |
|
|
Batchnummer
|
batch_number | string |
Der eindeutige Bezeichner, der für den Batch spezifisch ist. |
Gibt zurück
Erstellter Geschenkbatch
Erstellen eines Geschenks
Erstellt ein neues Geschenk.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bestandteil-ID
|
constituent_id | True | string |
Die Systemdatensatz-ID des Bestandteils, der dem Geschenk zugeordnet ist. |
|
Betrag
|
value | True | double |
Der Betrag des Geschenks. |
|
Datum
|
date | True | date |
Das Geschenkdatum (z. B. '2020-09-18'). |
|
Typ
|
type | True | string |
Der Geschenktyp. |
|
Kampagnen-ID
|
campaign_id | string |
Die Systemdatensatz-ID der Kampagne, die mit der Teilung des Geschenks verknüpft ist. |
|
|
Fonds-ID
|
fund_id | True | string |
Die Systemdatensatz-ID des Fonds, der mit der Geschenkteilung verknüpft ist. |
|
Berufungs-ID
|
appeal_id | string |
Die Systemdatensatz-ID des Aufrufs, der dem Geschenkteil zugeordnet ist. |
|
|
Paket-ID
|
package_id | string |
Die Systemdatensatz-ID des Pakets, das dem Geschenkteil zugeordnet ist. |
|
|
Menge
|
value | True | double |
Der Betrag des Geschenks, der geteilt wird. |
|
Zahlungsmethode
|
payment_method | True | string |
Die Zahlungsmethode. |
|
Nummer überprüfen
|
check_number | string |
Die Prüfnummer (gilt nur, wenn die Zahlungsmethode "PersonalCheck" lautet). |
|
|
Tag
|
d | integer |
Der Tag im Fuzzydatum. |
|
|
Monat
|
m | integer |
Der Monat im Fuzzydatum. |
|
|
Jahr
|
y | integer |
Das Jahr im Fuzzydatum. |
|
|
Reference
|
reference | string |
Der Zahlungsverweis (gilt nur, wenn die Zahlungsmethode "Sonstige" lautet). |
|
|
Tag
|
d | integer |
Der Tag im Fuzzydatum. |
|
|
Monat
|
m | integer |
Der Monat im Fuzzydatum. |
|
|
Jahr
|
y | integer |
Das Jahr im Fuzzydatum. |
|
|
Ist anonym?
|
is_anonymous | boolean |
Ist das Geschenk anonym? Wenn kein Wert angegeben wird, wird die Standardmäßige Anonymität des Spenders verwendet. |
|
|
Subtyp
|
subtype | string |
Der Untertyp des Geschenks. |
|
|
Kommentar
|
reference | string |
Hinweise zum Nachverfolgen spezieller Details zu einem Geschenk wie der Motivation dahinter oder einer detaillierten Beschreibung eines Geschenks. |
|
|
Nachschlage-ID
|
lookup_id | string |
Der benutzerdefinierte Bezeichner für das Geschenk. |
|
|
Verwenden Sie Fundraiser-Gutschriften?
|
default_fundraiser_credits | boolean |
Verwenden Sie das Standardmäßige Fundraiserguthaben? |
|
|
Verwenden Sie Soft Credits?
|
default_soft_credits | boolean |
Verwenden Sie die standardmäßigen Soft Credits? |
|
|
Wahlkreis
|
constituency | string |
Der Wahlkreis des Geschenks. |
|
|
Batchpräfix
|
batch_prefix | string |
Das Präfix, das für Batchgeschenke verwendet werden soll. Dies muss mindestens einen Buchstaben enthalten und ist erforderlich, wenn "Batchnummer" einen Wert aufweist. |
|
|
Batchnummer
|
batch_number | string |
Die Batchnummer. Zeichenlimit: 50 (einschließlich des Batchpräfixes). |
|
|
Beitragsstatus
|
post_status | string |
Der Beitragsstatus des Geschenks. |
|
|
Postdatum
|
post_date | date |
Das Datum, an dem das Geschenk gepostet wurde (z. B. '2020-09-18'). |
|
|
Bestätigungsstatus
|
status | True | string |
Der Belegstatus des Geschenks. |
|
Belegsbetrag
|
value | True | double |
Der Betrag des Belegs für das Geschenk. |
|
Wareneingangsdatum
|
date | date |
Das Datum, an dem das Geschenk erhalten wurde (z. B. "2020-09-18"). |
Gibt zurück
Geschenk erstellt
- Body
- GiftApi.CreatedGift
Erstellen sie eine Geschenkwürdigung
Erstellt eine neue Geschenkwürdigung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Geschenk-ID
|
gift_id | True | integer |
Die Systemdatensatz-ID des Geschenks, das dem Geschenkgutschein zugeordnet ist. |
|
Tribute ID
|
tribute_id | True | integer |
Die Systemdatensatz-ID der Mit dem Geschenk-Tribut verbundenen Anerkennung. |
Gibt zurück
Gabe-Anerkennung geschaffen
Erstes Geschenk erhalten
Gibt das erste Geschenk für einen Bestandteil zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bestandteil-ID
|
constituent_id | True | string |
Die Systemdatensatz-ID des Bestandteils. |
Gibt zurück
Zusammenfassung
Geschenk erhalten
Gibt Informationen zu einem Geschenk zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Geschenk-ID
|
gift_id | True | string |
Die Systemdatensatz-ID des zu erhaltenden Geschenks. |
Gibt zurück
Geschenk
- Body
- GiftApi.GiftRead
Geschenke auflisten
Gibt eine Liste von Geschenken zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
List
|
list_id | string |
Definiert einen Listenbezeichner, mit dem die Gruppe von Geschenken auf die in der angegebenen Liste enthaltenen Geschenke gefiltert wird. Wenn dieser Wert festgelegt ist, werden andere angegebene Filter ignoriert. |
|
|
Typ
|
gift_type | string |
Stellt eine durch Trennzeichen getrennte Liste von Geschenktypen dar, um die Ergebnisse zu filtern. Beispielsweise gibt "MatchingGiftPledge", RecurringGift" nur Geschenke vom Typ MatchingGiftPledge oder RecurringGift zurück. |
|
|
Bestandteil-ID
|
constituent_id | string |
Stellt eine durch Trennzeichen getrennte Liste der Komponentendatensatz-IDs dar, um die Ergebnisse zu filtern. Beispielsweise gibt "280.1232" nur Geschenke aus den Bestandteilen 280 oder Bestandteil 1232 zurück. |
|
|
Kampagnen-ID
|
campaign_id | string |
Stellt eine durch Trennzeichen getrennte Liste der Kampagnensystemdatensätze-IDs dar, um die Ergebnisse zu filtern. Beispielsweise gibt "506.918" nur Geschenke für kampagne 506 oder Kampagne 918 zurück. |
|
|
Fund-ID
|
fund_id | string |
Stellt eine durch Trennzeichen getrennte Liste der Fondssystemdatensatz-IDs dar, um die Ergebnisse zu filtern. Beispielsweise gibt "506.918" nur Geschenke zurück, um 506 oder Fonds 918 zu finanzieren. |
|
|
Berufungs-ID
|
appeal_id | string |
Stellt eine durch Trennzeichen getrennte Liste der Aufrufsystemdatensätze-IDs dar, um die Ergebnisse zu filtern. Beispielsweise gibt "506.918" nur Geschenke zurück, um 506 oder Rechtsmittel 918 anzulegen. |
|
|
Limit
|
limit | integer |
Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 5000. |
|
|
Offset
|
offset | integer |
Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung. |
|
|
Startgeschenkdatum
|
start_gift_date | date-time |
Stellt einen Filter für Geschenke mit einem Geschenkdatum am oder nach dem angegebenen Datum dar (z. B. '2020-09-18T04:13:56Z'). |
|
|
Endgeschenkdatum
|
end_gift_date | date-time |
Stellt einen Filter für Geschenke mit einem Geschenkdatum am oder vor dem angegebenen Datum dar (z. B. '2020-09-18T04:13:56Z'). |
|
|
Geschenkbetrag starten
|
start_gift_amount | double |
Stellt einen Filter für Geschenke dar, deren Betrag größer oder gleich dem angegebenen Betrag ist. |
|
|
Geschenkbetrag beenden
|
end_gift_amount | double |
Stellt einen Filter für Geschenke dar, deren Betrag kleiner oder gleich dem angegebenen Betrag ist. |
|
|
Beitragsstatus
|
post_status | string |
Stellt eine durch Trennzeichen getrennte Liste von Geschenkbeitragsstatus dar, um die Ergebnisse zu filtern. Beispielsweise gibt "DoNotPost", "Posted" nur Geschenke zurück, die als DoNotPost oder Posted gekennzeichnet sind. |
|
|
Bestätigungsstatus
|
receipt_status | string |
Stellt eine durch Trennzeichen getrennte Liste der Status des Geschenkbelegs dar, um die Ergebnisse zu filtern. Beispielsweise gibt "DoNotReceipt", "Receipted" nur Geschenke zurück, die als "DoNotReceipt" oder "Receipted" gekennzeichnet sind. |
|
|
Bestätigungsstatus
|
acknowledgement_status | string |
Stellt eine durch Trennzeichen getrennte Liste der Status der Geschenkbestätigung dar, um die Ergebnisse zu filtern. Beispielsweise gibt "DoNotAcknowledge" nur Geschenke zurück, die als "DoNotAcknowledge" oder "Bestätigt" gekennzeichnet sind. |
|
|
Sortiert nach
|
sort | string |
Stellt eine Liste von Feldern dar, nach denen die Ergebnisse sortiert werden sollen. Die Ergebnisse sind standardmäßig in aufsteigender Reihenfolge und ein "-"-Zeichen zeigt absteigende Reihenfolge an. Beispielsweise sortiert "date_added,-date" Geschenke nach dem Feld "date_added" in aufsteigender Reihenfolge und dann nach dem Feld "Geschenkdatum" in absteigender Reihenfolge. Wenn nur das feld date_modified oder nur das feld date_added angegeben wird, fügt dies den sort_token Parameter zur URL next_link hinzu, um sicherzustellen, dass Geschenke stab sortiert werden. |
|
|
Hinzugefügt am oder nach
|
date_added | date-time |
Filtern Sie die Ergebnisse auf Geschenke, die am oder nach dem angegebenen Datum erstellt wurden (z. B. "2020-09-18T04:13:56Z"). |
|
|
Geändert am oder nach
|
last_modified | date-time |
Filtern Sie die Ergebnisse nach Geschenken, die am oder nach dem angegebenen Datum geändert wurden (z. B. '2020-09-18T04:13:56Z'). |
Gibt zurück
Geschenke
Geschenkgutschriften auflisten
Listet die Anlagen für ein Geschenk auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Geschenk-ID
|
gift_id | True | string |
Die Systemdatensatz-ID des Geschenks. |
Gibt zurück
Attachments
Geschenknotizen auflisten
Listet die Notizen für ein Geschenk auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Geschenk-ID
|
gift_id | True | integer |
Die Systemdatensatz-ID des Geschenks. |
|
Limit
|
limit | integer |
Stellt die Anzahl der zurückzugebenden Datensätze dar. |
|
|
Offset
|
offset | integer |
Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung. |
Gibt zurück
Geschenknotizen
Hinzufügen eines Geschenks zum Batch
Fügen Sie dem angegebenen Geschenkbatch ein Geschenk hinzu.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Batch
|
batch_id | True | string |
Der Stapel, dem das Geschenk hinzugefügt wird. |
|
Bestandteil-ID
|
constituent_id | True | string |
Die Systemdatensatz-ID des Bestandteils, der dem Geschenk zugeordnet ist. |
|
Betrag
|
value | True | double |
Der Betrag des Geschenks. |
|
Datum
|
date | True | date |
Das Geschenkdatum (z. B. '2020-09-18'). |
|
Typ
|
type | True | string |
Der Geschenktyp. |
|
Kampagnen-ID
|
campaign_id | string |
Die Systemdatensatz-ID der Kampagne, die mit der Teilung des Geschenks verknüpft ist. |
|
|
Fonds-ID
|
fund_id | True | string |
Die Systemdatensatz-ID des Fonds, der mit der Geschenkteilung verknüpft ist. |
|
Berufungs-ID
|
appeal_id | string |
Die Systemdatensatz-ID des Aufrufs, der dem Geschenkteil zugeordnet ist. |
|
|
Paket-ID
|
package_id | string |
Die Systemdatensatz-ID des Pakets, das dem Geschenkteil zugeordnet ist. |
|
|
Menge
|
value | True | double |
Der Betrag des Geschenks, der geteilt wird. |
|
Zahlungsmethode
|
payment_method | True | string |
Die Zahlungsmethode. |
|
Nummer überprüfen
|
check_number | string |
Die Prüfnummer (gilt nur, wenn die Zahlungsmethode "PersonalCheck" lautet). |
|
|
Tag
|
d | integer |
Der Tag im Fuzzydatum. |
|
|
Monat
|
m | integer |
Der Monat im Fuzzydatum. |
|
|
Jahr
|
y | integer |
Das Jahr im Fuzzydatum. |
|
|
Reference
|
reference | string |
Der Zahlungsverweis (gilt nur, wenn die Zahlungsmethode "Sonstige" lautet). |
|
|
Tag
|
d | integer |
Der Tag im Fuzzydatum. |
|
|
Monat
|
m | integer |
Der Monat im Fuzzydatum. |
|
|
Jahr
|
y | integer |
Das Jahr im Fuzzydatum. |
|
|
Ist anonym?
|
is_anonymous | boolean |
Ist das Geschenk anonym? Wenn kein Wert angegeben wird, wird die Standardmäßige Anonymität des Spenders verwendet. |
|
|
Subtyp
|
subtype | string |
Der Untertyp des Geschenks. |
|
|
Kommentar
|
reference | string |
Hinweise zum Nachverfolgen spezieller Details zu einem Geschenk wie der Motivation dahinter oder einer detaillierten Beschreibung eines Geschenks. |
|
|
Nachschlage-ID
|
lookup_id | string |
Der benutzerdefinierte Bezeichner für das Geschenk. |
|
|
Verwenden Sie Fundraiser-Gutschriften?
|
default_fundraiser_credits | boolean |
Verwenden Sie das Standardmäßige Fundraiserguthaben? |
|
|
Verwenden Sie Soft Credits?
|
default_soft_credits | boolean |
Verwenden Sie die standardmäßigen Soft Credits? |
|
|
Wahlkreis
|
constituency | string |
Der Wahlkreis des Geschenks. |
|
|
Beitragsstatus
|
post_status | string |
Der Beitragsstatus des Geschenks. |
|
|
Postdatum
|
post_date | date |
Das Datum, an dem das Geschenk gepostet wurde (z. B. '2020-09-18'). |
|
|
Bestätigungsstatus
|
status | True | string |
Der Belegstatus des Geschenks. |
|
Belegsbetrag
|
value | True | double |
Der Betrag des Belegs für das Geschenk. |
|
Wareneingangsdatum
|
date | date |
Das Datum, an dem das Geschenk erhalten wurde (z. B. "2020-09-18"). |
Gibt zurück
Enthält eine Sammlung von Batch-Geschenkfehlerdatensätzen und die Batchgeschenke, die der Vorgang hinzugefügt hat.
- Ergebnisse
- GiftApi.BatchGiftAddResults
Holen Sie sich das beste Geschenk
Gibt das größte Geschenk für einen Bestandteil zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bestandteil-ID
|
constituent_id | True | string |
Die Systemdatensatz-ID des Bestandteils. |
Gibt zurück
Zusammenfassung
Holen Sie sich das neueste Geschenk
Gibt das neueste Geschenk für einen Bestandteil zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bestandteil-ID
|
constituent_id | True | string |
Die Systemdatensatz-ID des Bestandteils. |
Gibt zurück
Zusammenfassung
Verkaufen eines Aktiengeschenks
Aktualisiert ein Aktiengeschenk, das verkauft werden soll.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Geschenk-ID
|
gift_id | True | string |
Die Systemdatensatz-ID des zu verkaufenden Aktiengeschenks. |
|
Verkaufsdatum
|
stock_sale_date | True | date |
Das Datum, an dem die Aktie verkauft wurde (z. B. '2005-09-18'). |
|
Verkaufswert
|
stock_sale_value | True | double |
Der Wert des Aktienverkaufs. |
|
Maklergebühr
|
broker_fee | double |
Die verkaufte Aktienbrokergebühr. |
|
|
Beitragsstatus
|
post_status | string |
Der Poststatus des verkauften Geschenks. |
|
|
Postdatum
|
post_date | date |
Das gebuchte Datum der verkauften Aktie (z. B. '2020-09-18'). |
|
|
Hinweise
|
notes | string |
Die Noten für die verkaufte Aktie. Zeichenlimit: 255. |
|
|
Emittent
|
issuer | string |
Der Aktienherausgeber. |
|
|
Ausstellersymbol
|
symbol | string |
Das Aktienherausgebersymbol. |
|
|
Anzahl der Einheiten
|
units | integer |
Die Anzahl der verkauften Einheiten. |
|
|
Medianpreis pro Einheit
|
unit_price | double |
Der Medianpreis pro verkaufter Einheit. |
Verpfändungsraten auflisten
Listet die Raten für eine Zusage auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Verpfändungs-ID
|
gift_id | True | string |
Die Systemdatensatz-ID der Zusage. |
Gibt zurück
Raten
Verpfändungszahlungen auflisten
Listet die Zahlungen für eine Verpfändung auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Verpfändungs-ID
|
gift_id | True | string |
Die Systemdatensatz-ID der Zusage. |
Gibt zurück
Zahlungen
Definitionen
ConstituentApi.AppealRead
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID des Rechtsmittels. |
|
Beschreibung
|
description | string |
Die Beschwerdebeschreibung. |
ConstituentApi.CampaignRead
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID der Kampagne. |
|
Beschreibung
|
description | string |
Die Kampagnenbeschreibung. |
ConstituentApi.FundRead
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID des Fonds. |
|
Beschreibung
|
description | string |
Die Fondsbeschreibung. |
ConstituentApi.GivingSummaryRead
Zusammenfassung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID des Geschenks. |
|
Typ
|
type | string |
Der Geschenktyp. |
|
Datum
|
date | date-time |
Das Geschenkdatum. |
|
value
|
amount.value | double |
Der Betrag des Geschenks. |
|
Appeal
|
appeals | array of ConstituentApi.AppealRead |
Der Satz von Rechtsmitteln, die mit dem Geschenk verbunden sind. |
|
Kampagne
|
campaigns | array of ConstituentApi.CampaignRead |
Die Gruppe der Kampagnen, die dem Geschenk zugeordnet sind. |
|
Fonds
|
funds | array of ConstituentApi.FundRead |
Die Gruppe der Mittel, die mit dem Geschenk verbunden sind. |
ConstituentApi.LifetimeGivingRead
Lebenslanges Geben
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Aufeinander folgende Jahre angegeben
|
consecutive_years_given | integer |
Die Anzahl der aufeinander folgenden Jahre, die der Bestandteil angegeben hat. |
|
Gesamtanzahl der angegebenen Jahre
|
total_years_given | integer |
Die Gesamtzahl der Jahre, die der Bestandteil gegeben hat. |
|
value
|
total_giving.value | double |
Der Vom Bestandteil angegebene Gesamtbetrag. |
|
value
|
total_pledge_balance.value | double |
Der Gesamtbetrag der unbezahlten Verpfändungsbilanz für den Bestandteil. |
|
value
|
total_received_giving.value | double |
Der vom Bestandteil erhaltene Gesamtbetrag. |
|
value
|
total_committed_matching_gifts.value | double |
In diesem berechneten Feld wird die Gesamtmenge der übereinstimmenden Geschenkverpflichtungen berechnet, die dem Bestandteil zugeordnet sind. |
|
value
|
total_received_matching_gifts.value | double |
Der Gesamtbetrag der Zahlungen an übereinstimmende Geschenkzusagen, die dem Bestandteil zugeordnet sind. |
|
value
|
total_soft_credits.value | double |
Der Gesamtbetrag der Aufrechnungen, die auf den Bestandteil angewendet wurden. |
GiftApi.AcknowledgementRead
Anerkennung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
date
|
date | date-time |
Das Datum, das der Bestätigung zugeordnet ist. |
|
Buchstabe
|
letter | string |
Der Brief, der der Bestätigung zugeordnet ist. |
|
status
|
status | string |
Der Status der Bestätigung. Verfügbare Werte sind: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT und DONOTACKNOWLEDGE. |
GiftApi.ApiCollectionOfGiftAttachmentRead
Attachments
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
count | integer |
Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken. |
|
value
|
value | array of GiftApi.GiftAttachmentRead |
Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein. |
GiftApi.ApiCollectionOfGiftCustomFieldRead
Benutzerdefinierte Felder
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
count | integer |
Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken. |
|
value
|
value | array of GiftApi.GiftCustomFieldRead |
Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein. |
GiftApi.ApiCollectionOfGiftRead
Geschenke
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
count | integer |
Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken. |
|
value
|
value | array of GiftApi.GiftRead |
Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein. |
GiftApi.BatchGiftAddResults
Enthält eine Sammlung von Batch-Geschenkfehlerdatensätzen und die Batchgeschenke, die der Vorgang hinzugefügt hat.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of GiftApi.GiftBatchGiftError |
Die Batch-Geschenkfehler im Zusammenhang mit dem Batch-Geschenk-Add-Vorgang |
|
Geschenke
|
gifts | array of GiftApi.BatchGiftRead |
Die Sammlung von Batchgeschenken, die vom Stapelgeschenk-Add-Vorgang hinzugefügt wurden |
GiftApi.GiftBatchGiftError
Stellt Ausnahmen dar, die verhindern, dass elemente dem Batch hinzugefügt werden.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Betroffenes Feld
|
affected_field | string |
Das vom Fehler betroffene Feld |
|
Batch-ID
|
batch_id | string |
Die Systemdatensatz-ID des Batches |
|
Ausnahmefehlercode
|
exception_error_code | integer |
Der Ausnahmefehlercode |
|
Ausnahmefehlermeldung
|
exception_error_message | string |
Ausnahmefehlermeldung |
|
Ausnahmefehlername
|
exception_error_name | string |
Der Name des Ausnahmefehlers |
|
Geschenk-ID
|
gift_id | string |
Die Systemdatensatz-ID des Geschenks |
|
Nachschlage-ID
|
lookup_id | string |
Der benutzerdefinierte Bezeichner für das Geschenk. |
GiftApi.BatchGiftRead
Batchgeschenk
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Batch-ID
|
batch_id | string |
Die ID des Batches, dem das Geschenk hinzugefügt wurde. |
|
Irrtümer
|
errors | array of GiftApi.GiftBatchGiftError |
Die Fehler im Zusammenhang mit dem Batchgeschenk. |
|
ID
|
id | string |
Die Systemdatensatz-ID des Batchgeschenks. |
|
Bestandteil-ID
|
constituent_id | string |
Die Systemdatensatz-ID des Bestandteils, der dem Geschenk zugeordnet ist. |
|
type
|
type | string |
Der Geschenktyp. |
|
subtyp
|
subtype | string |
Der Untertyp des Geschenks. |
|
date
|
date | date-time |
Das Geschenkdatum. |
|
value
|
amount.value | double |
Der Betrag des Geschenks. |
|
value
|
balance.value | double |
Der Restbetrag auf dem Geschenk. |
|
Batchnummer
|
batch_number | string |
Die Batchnummer, die diesem Geschenk zugeordnet ist. |
|
status
|
gift_status | string |
Der Status des Geschenks. |
|
anonym?
|
is_anonymous | boolean |
Ist das Geschenk anonym? |
|
Wahlkreis
|
constituency | string |
Der Wahlkreis des Geschenks. |
|
Nachschlage-ID
|
lookup_id | string |
Der benutzerdefinierte Bezeichner für das Geschenk. |
|
origin
|
origin | string |
Der Ursprung des Geschenks. |
|
Beitragsstatus
|
post_status | string |
Das Hauptbuch nach dem Status des Geschenks. Verfügbare Werte sind "Posted", "NotPosted" und "DoNotPost". Wenn post_status auf DoNotPost> festgelegt ist, sollte post_date null sein. Wenn sie auf "NotPosted" festgelegt ist, ist post_date erforderlich, bleibt aber bearbeitbar. Wenn sie auf "Bereitgestellt" festgelegt ist, ist post_date erforderlich und kann nicht mehr bearbeitet werden. |
|
Postdatum
|
post_date | date-time |
Das Datum, an dem das Geschenk in das Hauptbuch gebucht wurde. |
|
reference
|
reference | string |
Hinweise zum Nachverfolgen spezieller Details zu einem Geschenk wie der Motivation dahinter oder einer detaillierten Beschreibung eines Geschenks. |
|
Tag
|
recurring_gift_status_date.d | integer |
Der Tag im Fuzzydatum. |
|
Monat
|
recurring_gift_status_date.m | integer |
Der Monat im Fuzzydatum. |
|
Jahr
|
recurring_gift_status_date.y | integer |
Das Jahr im Fuzzydatum. |
|
frequency
|
recurring_gift_schedule.frequency | string |
Ratehäufigkeit des wiederkehrenden Geschenks, das angezeigt werden soll. Verfügbare Werte sind WÖCHENTLICH, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONATLICH, VIERTELJÄHRLICH, JÄHRLICH. |
|
start
|
recurring_gift_schedule.start_date | date-time |
Datum, an dem das wiederkehrende Geschenk beginnen soll. |
|
Ende
|
recurring_gift_schedule.end_date | date-time |
Datum, an dem das wiederkehrende Geschenk enden soll. |
|
value
|
gift_aid_amount.value | double |
Dieses berechnete Feld berechnet den gesamtqualifizierten Steuerbetrag, der von Gift Aid für alle gift_splits für dieses Geschenk zurückgefordert wird. Nur für Großbritannien. |
|
Qualifikationsstatus der Geschenkbeihilfe
|
gift_aid_qualification_status | string |
Dieses berechnete Feld bestimmt den Qualifikationsstatus der Geschenkhilfe basierend auf Steuererklärungsinformationen und dem Datenbankformat. Verfügbare Werte sind: "Qualified", "NotQualified" und "PartQualified". Nur für Großbritannien. |
|
Geschenkcode
|
gift_code | string |
Der Geschenkcodewert, der dem Geschenk zugeordnet ist. |
|
Geschenkteilungen
|
gift_splits | array of GiftApi.GiftSplitRead |
Der Satz von Geschenksteilungen, die dem Geschenk zugeordnet sind. |
|
Fundraiser
|
fundraisers | array of GiftApi.GiftFundraiserRead |
Die Gruppe der Fundraiser, die Kredit für das Geschenk erhalten. |
|
Soft Credits
|
soft_credits | array of GiftApi.SoftCreditRead |
Der Satz von Soft Credits, die dem Geschenk zugeordnet sind. |
|
Einnahmen
|
receipts | array of GiftApi.ReceiptRead |
Der Satz von Quittungen, die dem Geschenk zugeordnet sind. |
|
Danksagung
|
acknowledgements | array of GiftApi.AcknowledgementRead |
Der Satz von Bestätigungen, die dem Geschenk zugeordnet sind. |
|
Zahlungen
|
payments | array of GiftApi.PaymentRead |
Die Zahlungen an das Geschenk. |
|
Verknüpfte Geschenke
|
linked_gifts | array of string |
Die Bezeichner anderer Geschenke, die mit diesem Geschenk verknüpft sind. |
|
Datum hinzugefügt
|
date_added | date-time |
Das Datum, an dem das Geschenk erstellt wurde. |
|
Änderungsdatum
|
date_modified | date-time |
Das Datum, an dem das Geschenk zuletzt geändert wurde. |
GiftApi.CreatedGift
Geschenk erstellt
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID des neu erstellten Geschenks. |
GiftApi.CreatedGiftAttachment
Geschenkanlage erstellt
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID der neu erstellten Geschenkanlage. |
GiftApi.CreatedGiftCustomField
Benutzerdefiniertes Geschenkfeld erstellt
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID des neu erstellten benutzerdefinierten Geschenkfelds. |
GiftApi.GiftAttachmentRead
Attachment
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID der Anlage. |
|
Geschenk-ID
|
parent_id | string |
Die Systemdatensatz-ID des Geschenks, das der Anlage zugeordnet ist. |
|
Typ
|
type | string |
Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet. |
|
Name
|
name | string |
Der Name der Anlage. Zeichenlimit: 150. |
|
Datum
|
date | date-time |
Das Datum der Anlage. |
|
URL
|
url | string |
Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen. |
|
Dateiname
|
file_name | string |
Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen. |
|
Datei-ID
|
file_id | string |
Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen. |
|
Miniaturansichts-ID
|
thumbnail_id | string |
Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen. |
|
Miniaturansichts-URL
|
thumbnail_url | string |
Die URL für eine Miniaturansicht. Nur für physische Anlagen, die Bilder sind. Enthält eine zeitgebundene Signatur, die den Zugriff auf 60 Minuten beschränkt. |
|
Inhaltstyp
|
content_type | string |
Der Inhaltstyp. Nur für physische Anlagen. |
|
Dateigröße
|
file_size | integer |
Die Dateigröße in Byte. Nur für physische Anlagen. |
|
Stichwörter
|
tags | array of string |
Die tags, die der Anlage zugeordnet sind. |
GiftApi.GiftCustomFieldRead
Benutzerdefiniertes Feld
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID des benutzerdefinierten Felds. |
|
Geschenk-ID
|
parent_id | string |
Die Systemdatensatz-ID des Geschenks, das dem benutzerdefinierten Feld zugeordnet ist. |
|
Kategorie
|
category | string |
Die Kategorie des benutzerdefinierten Felds. |
|
Typ
|
type | string |
Der Datentyp, den das benutzerdefinierte Feld darstellt. |
|
Wert
|
value |
Der Wert des benutzerdefinierten Felds. |
|
|
Textwert
|
text_value | string |
Der Textwert des benutzerdefinierten Felds. |
|
Zahlenwert
|
number_value | integer |
Der numerische Wert des benutzerdefinierten Felds. |
|
Datumswert
|
date_value | date |
Der Datumswert des benutzerdefinierten Felds. |
|
Währungswert
|
currency_value | double |
Der Währungswert des benutzerdefinierten Felds. |
|
Boolescher Wert
|
boolean_value | boolean |
Der boolesche Wert des benutzerdefinierten Felds. |
|
Tabelleneintragswert
|
codetableentry_value | string |
Der Tabelleneintragswert des benutzerdefinierten Felds. |
|
Bestandteil-ID-Wert
|
constituentid_value | string |
Der Id-Bestandteilwert des benutzerdefinierten Felds. |
|
Tag
|
fuzzydate_value.d | integer |
Der Tag im Fuzzydatum. |
|
Monat
|
fuzzydate_value.m | integer |
Der Monat im Fuzzydatum. |
|
Jahr
|
fuzzydate_value.y | integer |
Das Jahr im Fuzzydatum. |
|
Datum
|
date | date |
Das Datum im benutzerdefinierten Feld. |
|
Kommentar
|
comment | string |
Der Kommentar für das benutzerdefinierte Feld. Zeichenlimit: 50. |
|
Datum hinzugefügt
|
date_added | date-time |
Das Datum, an dem das benutzerdefinierte Feld erstellt wurde. |
|
Änderungsdatum
|
date_modified | date-time |
Das Datum, an dem das benutzerdefinierte Feld zuletzt geändert wurde. |
GiftApi.GiftFundraiserRead
Geschenk-Fundraiser
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
value
|
amount.value | double |
Der Betrag, der dem Spendengeber für das Geschenk gutgeschrieben wurde. |
|
Fundraiser-ID
|
constituent_id | string |
Die Id des bestandteilen Systemdatensatzes für den Fundraiser, der dem Geschenk zugeordnet ist. |
GiftApi.GiftRead
Geschenk
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID des Geschenks. |
|
Bestandteil-ID
|
constituent_id | string |
Die Systemdatensatz-ID des Bestandteils, der dem Geschenk zugeordnet ist. |
|
Typ
|
type | string |
Der Geschenktyp. |
|
Subtyp
|
subtype | string |
Der Untertyp des Geschenks. |
|
Datum
|
date | date-time |
Das Geschenkdatum. |
|
value
|
amount.value | double |
Der Betrag des Geschenks. |
|
value
|
balance.value | double |
Der Restbetrag auf dem Geschenk. |
|
Batchnummer
|
batch_number | string |
Die Batchnummer, die diesem Geschenk zugeordnet ist. |
|
Der Status
|
gift_status | string |
Der Status des Geschenks. |
|
Anonym?
|
is_anonymous | boolean |
Ist das Geschenk anonym? |
|
Wahlkreis
|
constituency | string |
Der Wahlkreis des Geschenks. |
|
Nachschlage-ID
|
lookup_id | string |
Der benutzerdefinierte Bezeichner für das Geschenk. |
|
Ursprung
|
origin | string |
Der Ursprung des Geschenks. |
|
Beitragsstatus
|
post_status | string |
Das Hauptbuch nach dem Status des Geschenks. Verfügbare Werte sind "Posted", "NotPosted" und "DoNotPost". Wenn post_status auf DoNotPost> festgelegt ist, sollte post_date null sein. Wenn sie auf "NotPosted" festgelegt ist, ist post_date erforderlich, bleibt aber bearbeitbar. Wenn sie auf "Bereitgestellt" festgelegt ist, ist post_date erforderlich und kann nicht mehr bearbeitet werden. |
|
Postdatum
|
post_date | date-time |
Das Datum, an dem das Geschenk in das Hauptbuch gebucht wurde. |
|
Reference
|
reference | string |
Hinweise zum Nachverfolgen spezieller Details zu einem Geschenk wie der Motivation dahinter oder einer detaillierten Beschreibung eines Geschenks. |
|
Tag
|
recurring_gift_status_date.d | integer |
Der Tag im Fuzzydatum. |
|
Monat
|
recurring_gift_status_date.m | integer |
Der Monat im Fuzzydatum. |
|
Jahr
|
recurring_gift_status_date.y | integer |
Das Jahr im Fuzzydatum. |
|
frequency
|
recurring_gift_schedule.frequency | string |
Ratehäufigkeit des wiederkehrenden Geschenks, das angezeigt werden soll. Verfügbare Werte sind WÖCHENTLICH, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONATLICH, VIERTELJÄHRLICH, JÄHRLICH. |
|
start
|
recurring_gift_schedule.start_date | date-time |
Datum, an dem das wiederkehrende Geschenk beginnen soll. |
|
Ende
|
recurring_gift_schedule.end_date | date-time |
Datum, an dem das wiederkehrende Geschenk enden soll. |
|
value
|
gift_aid_amount.value | double |
Dieses berechnete Feld berechnet den gesamtqualifizierten Steuerbetrag, der von Gift Aid für alle gift_splits für dieses Geschenk zurückgefordert wird. Nur für Großbritannien. |
|
Qualifikationsstatus der Geschenkbeihilfe
|
gift_aid_qualification_status | string |
Dieses berechnete Feld bestimmt den Qualifikationsstatus der Geschenkhilfe basierend auf Steuererklärungsinformationen und dem Datenbankformat. Verfügbare Werte sind: "Qualified", "NotQualified" und "PartQualified". Nur für Großbritannien. |
|
Geschenkcode
|
gift_code | string |
Der Geschenkcodewert, der dem Geschenk zugeordnet ist. |
|
Geschenkteilungen
|
gift_splits | array of GiftApi.GiftSplitRead |
Der Satz von Geschenksteilungen, die dem Geschenk zugeordnet sind. |
|
Fundraiser
|
fundraisers | array of GiftApi.GiftFundraiserRead |
Die Gruppe der Fundraiser, die Kredit für das Geschenk erhalten. |
|
Soft Credits
|
soft_credits | array of GiftApi.SoftCreditRead |
Der Satz von Soft Credits, die dem Geschenk zugeordnet sind. |
|
Einnahmen
|
receipts | array of GiftApi.ReceiptRead |
Der Satz von Quittungen, die dem Geschenk zugeordnet sind. |
|
Danksagung
|
acknowledgements | array of GiftApi.AcknowledgementRead |
Der Satz von Bestätigungen, die dem Geschenk zugeordnet sind. |
|
Zahlungen
|
payments | array of GiftApi.PaymentRead |
Die Zahlungen an das Geschenk. |
|
Verknüpfte Geschenke
|
linked_gifts | array of string |
Die Bezeichner anderer Geschenke, die mit diesem Geschenk verknüpft sind. |
|
Datum hinzugefügt
|
date_added | date-time |
Das Datum, an dem das Geschenk erstellt wurde. |
|
Änderungsdatum
|
date_modified | date-time |
Das Datum, an dem das Geschenk zuletzt geändert wurde. |
GiftApi.GiftSplitRead
Geschenk geteilt
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID des Geteilten Geschenks. |
|
value
|
amount.value | double |
Der Betrag des Geschenks, der geteilt wird. |
|
Berufungs-ID
|
appeal_id | string |
Die Systemdatensatz-ID des Aufrufs, der dem Geschenkteil zugeordnet ist. |
|
Kampagnen-ID
|
campaign_id | string |
Die Systemdatensatz-ID der Kampagne, die mit der Teilung des Geschenks verknüpft ist. |
|
Fonds-ID
|
fund_id | string |
Die Systemdatensatz-ID des Fonds, der mit der Geschenkteilung verknüpft ist. |
|
value
|
gift_aid_amount.value | double |
Der Steuerbetrag, der von Der Geschenkbeihilfe für dieses Geschenk geteilt wurde. Nur für Großbritannien. |
|
Qualifikationsstatus der Geschenkbeihilfe
|
gift_aid_qualification_status | string |
Der Qualifikationsstatus der Geschenkhilfe für die Geschenkteilung. Verfügbare Werte sind: "Qualified" und "NotQualified". Nur für Großbritannien. |
|
Paket-ID
|
package_id | string |
Die Systemdatensatz-ID des Pakets, das dem Geschenkteil zugeordnet ist. |
GiftApi.ReceiptRead
Rechnung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
value
|
amount.value | double |
Der Betrag des Belegs. |
|
date
|
date | date-time |
Das Datum für den Beleg. |
|
number
|
number | integer |
Die Nummer des Belegs. |
|
status
|
status | string |
Der Status des Belegs. Verfügbare Werte sind: RECEIPTED, NEEDSRECEIPT und DONOTRECEIPT. |
GiftApi.PaymentRead
Zahlung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Kontotoken
|
account_token | string |
Die tokenisierten Kontoinformationen (z. B. Kreditkarte) vom externen Zahlungsanbieter. Gilt nur für Zahlungsmethoden von "CreditCard" und "DirectDebit". |
|
BBPS-Konfigurations-ID
|
bbps_configuration_id | string |
Die BBPS-Konfigurations-ID. Gilt nur für Zahlungsmethoden von "CreditCard" und "DirectDebit". |
|
BBPS-Transaktions-ID
|
bbps_transaction_id | string |
Die BBPS-Transaktions-ID. Gilt nur für Zahlungsmethoden von "CreditCard" und "DirectDebit". |
|
Tag
|
check_date.d | integer |
Der Tag im Fuzzydatum. |
|
Monat
|
check_date.m | integer |
Der Monat im Fuzzydatum. |
|
Jahr
|
check_date.y | integer |
Das Jahr im Fuzzydatum. |
|
Prüfnummer
|
check_number | string |
Die Prüfnummer. Gilt nur für zahlungsmethoden von "PersonalCheck". |
|
Transaktions-ID auschecken
|
checkout_transaction_id | string |
Die Transaktions-ID des Auscheckens. Gilt nur für Zahlungsmethoden von "CreditCard" und "DirectDebit". |
|
Zahlungsmethode
|
payment_method | string |
Die Zahlungsmethode. Die verfügbaren Werte sind unten aufgeführt. |
|
reference
|
reference | string |
Der Verweis. Gilt nur für zahlungsmethoden von "Other". |
|
Tag
|
reference_date.d | integer |
Der Tag im Fuzzydatum. |
|
Monat
|
reference_date.m | integer |
Der Monat im Fuzzydatum. |
|
Jahr
|
reference_date.y | integer |
Das Jahr im Fuzzydatum. |
GiftApi.SoftCreditRead
Soft credit
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID des Soft credit. |
|
value
|
amount.value | double |
Der Betrag des soft credit. |
|
Bestandteil-ID
|
constituent_id | string |
Die Systemdatensatz-ID des Bestandteils, der dem Soft credit zugeordnet ist. |
|
Geschenk-ID
|
gift_id | string |
Die Systemdatensatz-ID des Geschenks, das dem Softguthaben zugeordnet ist. |
Gift2Api.PledgeInstallment
Stellt das Installationsobjekt dar.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID der Installation. |
|
date
|
date | date-time |
Das Datum der Installation. |
|
Jahr
|
year | integer |
Das Jahr des Installationsdatums. |
|
value
|
amount.value | double |
Der Betrag der Installation. |
|
Gleichgewicht
|
balance | double |
Der Saldo der Raten. |
|
Restsaldo der Zusage
|
remaining_pledge_balance | double |
Der verbleibende Saldo der Verpfändung. |
|
Sequenz
|
sequence | integer |
Die Reihenfolge der Installationsreihenfolge. |
Gift2Api.PledgeInstallmentCollection
Raten
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Startdatum
|
start_date | date-time |
Das Datum, an dem der Geschenkzeitplan beginnt. |
|
Frequenz
|
frequency | string |
Die Häufigkeit des Geschenkplans. |
|
Parallelitätstoken
|
concurrency_token | string |
Ein Parallelitätstoken. |
|
Raten
|
installments | array of Gift2Api.PledgeInstallment |
Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein. |
Gift2Api.PledgePayment
Stellt das Pfandzahlungsobjekt dar.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Installations-ID
|
installment_id | string |
Die Systemdatensatz-ID der Zahlung. |
|
Geschenk-ID
|
payment_gift_id | string |
Die Systemdatensatz-ID des Zahlungsgeschenks. |
|
value
|
amount_applied.value | double |
Der Betrag, der auf die Installation angewendet wurde. |
Gift2Api.PledgePaymentCollection
Zahlungen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
pledge_payments
|
pledge_payments | array of Gift2Api.PledgePayment |
Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein. |
GiftBatchApi.ApiCollectionOfGiftBatch
Geschenkbatches
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
count | integer |
Die Gesamtzahl der Geschenkbatches in der Antwort. |
|
value
|
value | array of GiftBatchApi.GiftBatch |
Der Satz von Elementen, die in der Antwort enthalten sind. |
GiftBatchApi.CreatedBatch
Erstellter Geschenkbatch
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
batch_id | string |
Die Systemdatensatz-ID des neu erstellten Geschenkbatches. |
GiftBatchApi.GiftBatch
Stellt das Geschenkbatchobjekt dar.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die Systemdatensatz-ID des Batches. |
|
Beschreibung
|
batch_description | string |
Die Batchbeschreibung. |
|
Batchnummer
|
batch_number | string |
Die Batchnummer |
|
Projizierte Zahl
|
projected_number_of_gifts | integer |
Die projizierte Anzahl von Geschenken im Batch. |
|
Ist-Zahl
|
number_of_gifts | integer |
Die tatsächliche Anzahl der Geschenke in der Charge. |
|
Projizierter Betrag
|
projected_amount | double |
Der projizierte Wert von Geschenken im Batch. |
|
Istbestand
|
actual_amount | double |
Der tatsächliche Wert von Geschenken in der Charge. |
|
hat Ausnahmen?
|
has_exceptions | boolean |
Hat der Batch Ausnahmen? |
|
gebilligt?
|
is_approved | boolean |
Ist der Batch genehmigt? |
|
Erstellt von
|
created_by | string |
Der Name des Benutzers, der den Batch erstellt hat. |
|
Erstellt am
|
created_on | date-time |
Das Datum, an dem der Batch erstellt wurde. |
NXTDataIntegrationApi.CreatedGiftNote
Notiz erstellt
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID der neu erstellten Notiz. |
NXTDataIntegrationApi.CreatedGiftTribute
Gabe-Anerkennung geschaffen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID der neu geschaffenen Geschenkwürdigung. |
NXTDataIntegrationApi.CreatedTaxDeclaration
Steuererklärung erstellt
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Die ID der neu erstellten Steuererklärung. |
NXTDataIntegrationApi.GiftIdMap
Geschenk-ID-Karte
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
system_record_id | integer |
Die Id des Geschenksystems. |
NXTDataIntegrationApi.GiftNote
Hinweis
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Geschenk-ID
|
gift_id | integer |
Die Systemdatensatz-ID des Geschenks, das der Notiz zugeordnet ist. |
|
Typ
|
type | string |
Der Notiztyp. |
|
Tag
|
date.d | integer |
Der Tag im Fuzzydatum. |
|
Monat
|
date.m | integer |
Der Monat im Fuzzydatum. |
|
Jahr
|
date.y | integer |
Das Jahr im Fuzzydatum. |
|
Zusammenfassung
|
summary | string |
Die Notizzusammenfassung. |
|
Hinweis
|
text | string |
Der Notiztext. |
|
Autor
|
author | string |
Der Autor der Notiz. |
NXTDataIntegrationApi.GiftNoteCollection
Geschenknotizen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
count | integer |
Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken. |
|
value
|
value | array of NXTDataIntegrationApi.GiftNote |
Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein. |
NXTDataIntegrationApi.GiftTribute
Geschenkwürdigung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Die Systemdatensatz-ID des Geschenkgutscheins. |
|
Geschenk-ID
|
gift_id | integer |
Die Systemdatensatz-ID des Geschenks. |
|
Tribute ID
|
tribute_id | integer |
Die Systemdatensatz-ID der Hommage. |
|
Tribute-Typ
|
tribute_type | integer |
Der Hommagestyp. |
|
Status bestätigen
|
acknowledge | string |
Der Anerkennungsstatus des Geschenks. |
|
Sequence
|
sequence | integer |
Die Geschenk-Ehrensequenz. |
NXTDataIntegrationApi.GiftTributeAcknowledgee
Ein Geschenk-Ehren-Anerkennungs-Rekord in Raiser es Edge.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Die Systemdatensatz-ID der Anerkennung des Geschenks. |
|
Geschenk-Ehren-ID
|
gift_tribute_id | integer |
Die Systemdatensatz-ID des Geschenkgutscheins. |
|
Ist Selbsterkennung?
|
self_acknowledge | boolean |
Ist dies eine Selbsterkennung? |
|
Beziehungen-ID
|
relationships_id | integer |
Die Systemdatensatz-ID der Beziehung für die Bestätigung. |
|
Letter
|
letter | integer |
Der an die Bestätigung gesendete Brief. |
|
Briefdatum
|
letter_date | date-time |
Das Datum, an dem der Brief gesendet wurde. |
NXTDataIntegrationApi.GiftTributeAcknowledgeeCollection
Ehrengeschenke
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
count | integer |
Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken. |
|
value
|
value | array of NXTDataIntegrationApi.GiftTributeAcknowledgee |
Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein. |
NXTDataIntegrationApi.GiftTributeCollection
Ehrengeschenke
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
count | integer |
Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken. |
|
value
|
value | array of NXTDataIntegrationApi.GiftTribute |
Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein. |
NXTDataIntegrationApi.TaxDeclaration
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
declaration_id | integer | |
|
Deklaration beginnt
|
declaration_starts | date-time |
Das Datum, an dem die Steuererklärung beginnt. |
|
Deklaration endet
|
declaration_ends | date-time |
Das Datum, an dem die Steuererklärung endet. |
|
Erklärung gemacht
|
declaration_made | date-time |
Das Datum der Steuererklärung. |
|
Indikator-ID
|
declaration_indicator_id | integer |
Die Deklarationsindikator-ID. |
|
Indicator
|
declaration_indicator | string |
Der Deklarationsindikator. |
|
Quell-ID
|
declaration_source_id | integer |
Die Deklarationsquell-ID. |
|
Quelle
|
declaration_source | string |
Die Deklarationsquelle. |
|
Bestätigung gesendet
|
confirmation_sent | date-time |
Das Datum, an dem die Bestätigung gesendet wurde. |
|
Zurückgegebene Bestätigung
|
confirmation_returned | date-time |
Das Datum, an dem die Bestätigung zurückgegeben wurde. |
|
Lohnsteuer
|
constituent_pays_tax | string |
Gibt an, ob der Bestandteil Steuern zahlt. |
|
Status-ID
|
tax_payer_status_id | integer |
Die Status-ID des Steuerbezahlers. |
|
Der Status
|
tax_payer_status | string |
Der Status des Steuerpflichtigen. |
|
Kommentare
|
tax_notes | string |
Kommentare zur Steuererklärung. |
|
Sequence
|
sequence | integer |
Die numerische Sequenz, die der Steuererklärung zugeordnet ist. |
NXTDataIntegrationApi.TaxDeclarationCollection
Steuererklärungen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
count | integer |
Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken. |
|
value
|
value | array of NXTDataIntegrationApi.TaxDeclaration |
Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein. |