Partager via


Cadeaux RENXT Blackbaud

Blackbaud Raiser’s Edge NXT est une solution logicielle complète de collecte de fonds et de gestion des donateurs basée sur le cloud conçue spécifiquement pour les organisations à but non lucratif et l’ensemble de la bonne communauté sociale. Utilisez le connecteur Cadeaux pour gérer les cadeaux.

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom Prise en charge de Blackbaud
URL https://www.blackbaud.com/support
Messagerie électronique skyapi@blackbaud.com
Métadonnées du connecteur
Éditeur Blackbaud, Inc.
Site internet https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
Politique de confidentialité https://www.blackbaud.com/privacy-shield
Catégories Ventes et CRM ; Productivité

Raiser’s Edge NXT est une solution complète de collecte de fonds et de gestion des donateurs basée sur le cloud conçue spécifiquement pour les organisations à but non lucratif et l’ensemble de la bonne communauté sociale.

Ce connecteur repose sur l’API SKY de Blackbaud et fournit des opérations pour gérer les cadeaux et les entités associées trouvées dans le NXT edge de The Raiser, notamment :

  • Cadeaux et résumés des dons constituants
  • Lots de cadeaux
  • Reçus
  • Remerciements
  • et bien plus encore...

Pour plus d’informations, consultez la documentation.

Prerequisites

Pour utiliser ce connecteur, vous devez disposer d’un compte Blackbaud ID avec accès à un ou plusieurs environnements Blackbaud.

En outre, l’administrateur de votre organisation doit également effectuer une action au niveau de l’administrateur au sein du système pour permettre à ce connecteur d’accéder à votre environnement Blackbaud. Vous trouverez plus d’informations sur ces prérequis dans la documentation de configuration initiale .

Comment obtenir des informations d’identification ?

L’administrateur de votre organisation vous enverra une invitation à l’environnement Edge NXT de l’organisation de l’organisation et configurera les autorisations de votre compte d’utilisateur dans l’environnement. Aucune information d’identification supplémentaire n’est requise pour utiliser ce connecteur.

Problèmes connus et limitations

Le connecteur fonctionne dans le contexte de votre compte d’utilisateur et sera donc soumis à vos autorisations utilisateur dans l’environnement.

Limitations

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

Ajouter un cadeau au lot

Ajoutez un cadeau au lot de cadeaux spécifié.

Créer un cadeau

Crée un cadeau.

Créer un cadeau de stock

Crée un cadeau de stock.

Créer un champ personnalisé cadeau

Crée un champ personnalisé cadeau.

Créer un engagement

Crée un nouvel engagement.

Créer un hommage cadeau

Crée un hommage cadeau.

Créer un lot cadeau

Crée un lot cadeau.

Créer un paiement d’engagement

Crée un paiement d’engagement.

Créer une déclaration fiscale constituante

Crée une déclaration fiscale d’aide aux cadeaux pour un constituant.

Créer une note cadeau

Crée une note cadeau.

Créer une pièce jointe cadeau

Crée une pièce jointe cadeau.

Lister l’hommage aux cadeaux reconnaît

Répertoriez les accusés de réception d’un hommage cadeau.

Mettre à jour les détails de l’accusé de réception du cadeau

Met à jour les détails de l’accusé de réception d’un cadeau.

Mettre à jour les détails des reçus de cadeau

Met à jour les détails du reçu pour un cadeau.

Mettre à jour un champ personnalisé cadeau

Met à jour un champ personnalisé cadeau.

Mettre à jour un hommage cadeau

Met à jour un hommage cadeau.

Mettre à jour un hommage cadeau reconnu

Met à jour un hommage cadeau reconnu.

Mettre à jour une déclaration fiscale constituante

Met à jour une déclaration fiscale constituante.

Mettre à jour une note cadeau

Met à jour une note cadeau.

Mettre à jour une pièce jointe cadeau

Met à jour une pièce jointe cadeau.

Obtenir le dernier cadeau constituant

Retourne le dernier cadeau pour un constituant.

Obtenir le plus grand cadeau constituant

Retourne le plus grand cadeau pour un constituant.

Obtenir un cadeau

Retourne des informations sur un cadeau.

Obtenir un cadeau par ID de recherche

Retourne l’ID d’enregistrement système d’un cadeau à partir de l’ID de recherche spécifié.

Obtenir un don de durée de vie constituante

Retourne le résumé de la durée de vie d’un constituant.

Obtenir un premier cadeau constituant

Retourne le premier cadeau pour un constituant.

Répertorier les cadeaux

Retourne une liste de cadeaux.

Répertorier les champs personnalisés du cadeau

Répertorie les champs personnalisés d’un cadeau.

Répertorier les déclarations fiscales constituantes

Répertorie les déclarations fiscales d’aide aux cadeaux pour un constituant (applicable uniquement aux versions britanniques).

Répertorier les hommages aux cadeaux

Répertorie les hommages pour un cadeau.

Répertorier les lots de cadeaux

Répertoriez les lots de cadeaux.

Répertorier les notes de cadeau

Répertorie les notes d’un cadeau.

Répertorier les paiements d’engagement

Répertorie les paiements d’un engagement.

Répertorier les pièces jointes de cadeau

Répertorie les pièces jointes pour un cadeau.

Répertorier les versements d’engagement

Répertorie les versements pour un engagement.

Vendre un cadeau boursier

Met à jour un cadeau boursier à vendre.

Ajouter un cadeau au lot

Ajoutez un cadeau au lot de cadeaux spécifié.

Paramètres

Nom Clé Obligatoire Type Description
Batch
batch_id True string

Lot auquel le cadeau sera ajouté.

ID constituant
constituent_id True string

ID d’enregistrement système de la constituante associée au cadeau.

Montant
value True double

Le montant du cadeau.

Date
date True date

Date de cadeau (par exemple : '2020-09-18').

Type
type True string

Le type de cadeau.

ID de campagne
campaign_id string

ID d’enregistrement système de la campagne associée au fractionnement du cadeau.

ID de fonds
fund_id True string

ID d’enregistrement système du fonds associé au fractionnement du cadeau.

ID d’appel
appeal_id string

ID d’enregistrement système de l’appel associé au fractionnement du cadeau.

ID de package
package_id string

ID d’enregistrement système du package associé au fractionnement cadeau.

montant
value True double

Le montant du cadeau fractionné.

Mode de paiement
payment_method True string

Mode de paiement.

Vérifier le numéro
check_number string

Numéro de vérification (applicable uniquement lorsque le mode de paiement est « PersonalCheck »).

jour
d integer

Jour de la date floue.

month
m integer

Mois à la date approximative.

année
y integer

L’année dans la date approximative.

Reference
reference string

Référence de paiement (applicable uniquement lorsque le mode de paiement est « Autre »).

jour
d integer

Jour de la date floue.

month
m integer

Mois à la date approximative.

année
y integer

L’année dans la date approximative.

Est-ce anonyme ?
is_anonymous boolean

Le cadeau est-il anonyme ? Si aucune valeur n’est fournie, l’anonymat par défaut du donneur sera utilisé.

Sous-type
subtype string

Sous-type du cadeau.

Commentaire
reference string

Remarques pour suivre des détails spéciaux sur un cadeau, comme la motivation derrière elle ou une description détaillée d’un cadeau en nature.

ID de recherche
lookup_id string

Identificateur défini par l’utilisateur pour le cadeau.

Utilisez des crédits de collecte de fonds ?
default_fundraiser_credits boolean

Utilisez les crédits de collecte de fonds par défaut ?

Utilisez des crédits souples ?
default_soft_credits boolean

Utilisez les crédits soft par défaut ?

Circonscription
constituency string

La circonscription du cadeau.

Publier l’état
post_status string

L’état post du cadeau.

Date de publication
post_date date

Date à laquelle le cadeau a été publié (par exemple : '2020-09-18').

État du reçu
status True string

État de réception du cadeau.

Montant du reçu
value True double

Montant du reçu pour le cadeau.

Date de réception
date date

Date à laquelle le cadeau a été reçu (par exemple : « 2020-09-18 »).

Retours

Contient une collection d’enregistrements d’erreurs de cadeau par lots et les cadeaux par lots ajoutés par l’opération

Créer un cadeau

Crée un cadeau.

Paramètres

Nom Clé Obligatoire Type Description
ID constituant
constituent_id True string

ID d’enregistrement système de la constituante associée au cadeau.

Montant
value True double

Le montant du cadeau.

Date
date True date

Date de cadeau (par exemple : '2020-09-18').

Type
type True string

Le type de cadeau.

ID de campagne
campaign_id string

ID d’enregistrement système de la campagne associée au fractionnement du cadeau.

ID de fonds
fund_id True string

ID d’enregistrement système du fonds associé au fractionnement du cadeau.

ID d’appel
appeal_id string

ID d’enregistrement système de l’appel associé au fractionnement du cadeau.

ID de package
package_id string

ID d’enregistrement système du package associé au fractionnement cadeau.

montant
value True double

Le montant du cadeau fractionné.

Mode de paiement
payment_method True string

Mode de paiement.

Vérifier le numéro
check_number string

Numéro de vérification (applicable uniquement lorsque le mode de paiement est « PersonalCheck »).

jour
d integer

Jour de la date floue.

month
m integer

Mois à la date approximative.

année
y integer

L’année dans la date approximative.

Reference
reference string

Référence de paiement (applicable uniquement lorsque le mode de paiement est « Autre »).

jour
d integer

Jour de la date floue.

month
m integer

Mois à la date approximative.

année
y integer

L’année dans la date approximative.

Est-ce anonyme ?
is_anonymous boolean

Le cadeau est-il anonyme ? Si aucune valeur n’est fournie, l’anonymat par défaut du donneur sera utilisé.

Sous-type
subtype string

Sous-type du cadeau.

Commentaire
reference string

Remarques pour suivre des détails spéciaux sur un cadeau, comme la motivation derrière elle ou une description détaillée d’un cadeau en nature.

ID de recherche
lookup_id string

Identificateur défini par l’utilisateur pour le cadeau.

Utilisez des crédits de collecte de fonds ?
default_fundraiser_credits boolean

Utilisez les crédits de collecte de fonds par défaut ?

Utilisez des crédits souples ?
default_soft_credits boolean

Utilisez les crédits soft par défaut ?

Circonscription
constituency string

La circonscription du cadeau.

Préfixe de lot
batch_prefix string

Préfixe à utiliser pour les cadeaux par lots. Cela doit inclure au moins une lettre et est obligatoire lorsque le « numéro batch » a une valeur.

Numéro de lot
batch_number string

Numéro de lot. Limite de caractères : 50 (y compris le préfixe de lot).

Publier l’état
post_status string

L’état post du cadeau.

Date de publication
post_date date

Date à laquelle le cadeau a été publié (par exemple : '2020-09-18').

État du reçu
status True string

État de réception du cadeau.

Montant du reçu
value True double

Montant du reçu pour le cadeau.

Date de réception
date date

Date à laquelle le cadeau a été reçu (par exemple : « 2020-09-18 »).

Retours

Cadeau créé

Créer un cadeau de stock

Crée un cadeau de stock.

Paramètres

Nom Clé Obligatoire Type Description
ID constituant
id True string

ID d’enregistrement système de la constituante.

Montant
value True double

Le montant du cadeau.

Date
gift_date True date

Date de cadeau (par exemple : '2020-09-18').

Issuer
issuer string

Émetteur boursier.

Symbole émetteur
symbol string

Symbole de l’émetteur boursier.

Nombre d’unités
units integer

Nombre d’unités de stock.

Prix médian par unité
unit_price double

Prix médian par unité.

montant
value True double

Le montant du cadeau fractionné.

ID de fonds
fund_id True string

ID d’enregistrement système du fonds associé au fractionnement du cadeau.

ID de campagne
campaign_id string

ID d’enregistrement système de la campagne associée au fractionnement du cadeau.

ID d’appel
appeal_id string

ID d’enregistrement système de l’appel associé au fractionnement du cadeau.

ID de package
package_id string

ID d’enregistrement système du package associé au fractionnement cadeau.

Mode de paiement
method True string

Mode de paiement.

Vérifier le numéro
check_number string

Numéro de vérification.

Reference
reference_number string

Référence de paiement (applicable uniquement lorsque le mode de paiement est « Autre »).

Est-ce anonyme ?
anonymous boolean

Le cadeau est-il anonyme ? Si aucune valeur n’est fournie, l’anonymat par défaut du donneur sera utilisé.

Sous-type
name string

Sous-type du cadeau.

Commentaire
comments string

Remarques pour suivre des détails spéciaux sur un cadeau tel que la motivation derrière elle.

ID de recherche
lookup_id string

Identificateur défini par l’utilisateur pour le cadeau.

Code cadeau
value string

Code cadeau associé au cadeau.

Circonscription
value string

La circonscription du cadeau.

Publier l’état
gift_post_status string

L’état post du cadeau.

Date de publication
gift_post_date date

Date à laquelle le cadeau doit être publié (par exemple : « 2020-09-18 »).

État du reçu
receipt_status True string

État de réception du cadeau.

Montant du reçu
value True double

Montant du reçu pour le cadeau.

Date de réception
receipt_date date

Date à laquelle le cadeau a été reçu (par exemple : « 2020-09-18 »).

Numéro de reçu
receipt_number integer

Numéro de reçu.

Pile de reçus
value string

Pile des reçus.

Accuser réception de l’état
status True string

État d’accusé de réception du cadeau.

Date de réception
acknowledgement_date date

Date à laquelle le cadeau a été reconnu (par exemple : '2020-09-18').

Letter
value string

Lettre associée à l’accusé de réception.

type
credit_type True string

Type de crédit de reconnaissance.

ID de destinataire
constituent_id True string

ID d’enregistrement système du destinataire du crédit de reconnaissance.

montant
value True double

Montant crédité au destinataire.

Retours

Cadeau créé

Créer un champ personnalisé cadeau

Crée un champ personnalisé cadeau.

Paramètres

Nom Clé Obligatoire Type Description
body
body True dynamic

Objet qui représente le champ personnalisé à créer.

Retours

Champ personnalisé cadeau créé

Créer un engagement

Crée un nouvel engagement.

Paramètres

Nom Clé Obligatoire Type Description
ID constituant
id True string

ID d’enregistrement système de la constituante.

Montant
value True double

Montant de l’engagement.

Date
gift_date True date

Date de l’engagement (par exemple : '2020-09-18').

Fréquence
frequency True string

Fréquence d’installation de l’engagement.

Nombre d’installations
number_of_installments True integer

Nombre d’versements pour l’engagement.

Date de début
start_date True date

Date à laquelle commence la planification de l’engagement.

montant
value True double

Le montant du cadeau fractionné.

ID de fonds
fund_id True string

ID d’enregistrement système du fonds associé au fractionnement du cadeau.

ID de campagne
campaign_id string

ID d’enregistrement système de la campagne associée au fractionnement du cadeau.

ID d’appel
appeal_id string

ID d’enregistrement système de l’appel associé au fractionnement du cadeau.

ID de package
package_id string

ID d’enregistrement système du package associé au fractionnement cadeau.

Mode de paiement
method True string

Mode de paiement.

Vérifier le numéro
check_number string

Numéro de vérification.

Reference
reference_number string

Référence de paiement (applicable uniquement lorsque le mode de paiement est « Autre »).

Envoyer un rappel ?
send_reminder boolean

Envoyer des rappels d’engagement ?

Est-ce anonyme ?
anonymous boolean

Le cadeau est-il anonyme ? Si aucune valeur n’est fournie, l’anonymat par défaut du donneur sera utilisé.

Sous-type
name string

Sous-type du cadeau.

Commentaire
comments string

Remarques pour suivre des détails spéciaux sur un cadeau tel que la motivation derrière elle.

ID de recherche
lookup_id string

Identificateur défini par l’utilisateur pour le cadeau.

Code cadeau
value string

Code cadeau associé au cadeau.

Circonscription
value string

La circonscription du cadeau.

Publier l’état
gift_post_status string

L’état post du cadeau.

Date de publication
gift_post_date date

Date à laquelle le cadeau doit être publié (par exemple : « 2020-09-18 »).

Statut
gift_status string

État de l’engagement.

jour
d integer

Jour de la date floue.

month
m integer

Mois à la date approximative.

année
y integer

L’année dans la date approximative.

État du reçu
receipt_status True string

État de réception du cadeau.

Montant du reçu
value True double

Montant du reçu pour le cadeau.

Date de réception
receipt_date date

Date à laquelle le cadeau a été reçu (par exemple : « 2020-09-18 »).

Numéro de reçu
receipt_number integer

Numéro de reçu.

Pile de reçus
value string

Pile des reçus.

Accuser réception de l’état
status True string

État d’accusé de réception du cadeau.

Date de réception
acknowledgement_date date

Date à laquelle le cadeau a été reconnu (par exemple : '2020-09-18').

Letter
value string

Lettre associée à l’accusé de réception.

type
credit_type True string

Type de crédit de reconnaissance.

ID de destinataire
constituent_id True string

ID d’enregistrement système du destinataire du crédit de reconnaissance.

montant
value True double

Montant crédité au destinataire.

date
date date

Date de l’installation (par exemple : '2020-09-18').

montant
amount double

Montant de l’installation.

Retours

Cadeau créé

Créer un hommage cadeau

Crée un hommage cadeau.

Paramètres

Nom Clé Obligatoire Type Description
ID cadeau
gift_id True integer

ID d’enregistrement système du cadeau associé à l’hommage cadeau.

ID d’hommage
tribute_id True integer

ID d’enregistrement système de l’hommage associé à l’hommage cadeau.

Retours

Hommage cadeau créé

Créer un lot cadeau

Crée un lot cadeau.

Paramètres

Nom Clé Obligatoire Type Description
Descriptif
batch_description string

Description du lot.

Nombre attendu
expected_number integer

Nombre de cadeaux attendus dans le lot.

Total attendu
expected_batch_total double

Valeur totale des cadeaux dans le lot.

Numéro de lot
batch_number string

Identificateur unique spécifique au lot.

Retours

Lot cadeau créé

Créer un paiement d’engagement

Crée un paiement d’engagement.

Paramètres

Nom Clé Obligatoire Type Description
ID constituant
id True string

ID d’enregistrement système de la constituante.

Montant
value True double

Montant du paiement de l’engagement.

Date
gift_date True date

Date de paiement de l’engagement (par exemple : '2020-09-18').

montant
value True double

Le montant du cadeau fractionné.

ID de fonds
fund_id True string

ID d’enregistrement système du fonds associé au fractionnement du cadeau.

ID de campagne
campaign_id string

ID d’enregistrement système de la campagne associée au fractionnement du cadeau.

ID d’appel
appeal_id string

ID d’enregistrement système de l’appel associé au fractionnement du cadeau.

ID de package
package_id string

ID d’enregistrement système du package associé au fractionnement cadeau.

Mode de paiement
method True string

Mode de paiement.

Vérifier le numéro
check_number string

Numéro de vérification.

Reference
reference_number string

Référence de paiement (applicable uniquement lorsque le mode de paiement est « Autre »).

Est-ce anonyme ?
anonymous boolean

Le cadeau est-il anonyme ? Si aucune valeur n’est fournie, l’anonymat par défaut du donneur sera utilisé.

nantissement
pledge_id string

ID d’enregistrement système de l’engagement payé.

installation
installment_id string

ID d’enregistrement système de l’installation en cours de paiement.

montant
amount_applied double

Montant appliqué à l’installation.

Sous-type
name string

Sous-type du cadeau.

Commentaire
comments string

Remarques pour suivre des détails spéciaux sur un cadeau tel que la motivation derrière elle.

ID de recherche
lookup_id string

Identificateur défini par l’utilisateur pour le cadeau.

Code cadeau
value string

Code cadeau associé au cadeau.

Circonscription
value string

La circonscription du cadeau.

Publier l’état
gift_post_status string

L’état post du cadeau.

Date de publication
gift_post_date date

Date à laquelle le cadeau doit être publié (par exemple : « 2020-09-18 »).

État du reçu
receipt_status True string

État de réception du cadeau.

Montant du reçu
value True double

Montant du reçu pour le cadeau.

Date de réception
receipt_date date

Date à laquelle le cadeau a été reçu (par exemple : « 2020-09-18 »).

Numéro de reçu
receipt_number integer

Numéro de reçu.

Pile de reçus
value string

Pile des reçus.

Accuser réception de l’état
status True string

État d’accusé de réception du cadeau.

Date de réception
acknowledgement_date date

Date à laquelle le cadeau a été reconnu (par exemple : '2020-09-18').

Letter
value string

Lettre associée à l’accusé de réception.

type
credit_type True string

Type de crédit de reconnaissance.

ID de destinataire
constituent_id True string

ID d’enregistrement système du destinataire du crédit de reconnaissance.

montant
value True double

Montant crédité au destinataire.

Retours

Cadeau créé

Créer une déclaration fiscale constituante

Crée une déclaration fiscale d’aide aux cadeaux pour un constituant.

Paramètres

Nom Clé Obligatoire Type Description
ID constituant
constituent_id True integer

ID d’enregistrement système de la constituante.

La déclaration démarre
declaration_starts True date-time

Date de début de la déclaration fiscale (par exemple : '2020-09-18T04:13:56Z').

Fin de la déclaration
declaration_ends date-time

Date de fin de la déclaration fiscale (par exemple : '2020-09-18T04:13:56Z').

Déclaration faite
declaration_made date-time

Date à laquelle la déclaration fiscale a été faite (par exemple : '2020-09-18T04:13:56Z').

Indicator
declaration_indicator string

Indicateur de déclaration.

Origine
declaration_source string

Source de déclaration.

Confirmation envoyée
confirmation_sent date-time

Date à laquelle la confirmation a été envoyée (par exemple : '2020-09-18T04:13:56Z').

Confirmation retournée
confirmation_returned date-time

Date à laquelle la confirmation a été retournée (par exemple : '2020-09-18T04:13:56Z').

Payer l’impôt
constituent_pays_tax string

Indique si la constituante paie l’impôt.

Statut
tax_payer_status string

Statut du contribuable.

Commentaires
tax_notes string

Commentaires pour la déclaration fiscale.

Sequence
sequence integer

Séquence numérique associée à la déclaration fiscale.

Retours

Déclaration fiscale créée

Créer une note cadeau

Crée une note cadeau.

Paramètres

Nom Clé Obligatoire Type Description
ID cadeau
gift_id True integer

ID d’enregistrement système du cadeau associé à la note.

Type
note_type_id True integer

Type de note.

jour
d integer

Jour de la date floue.

month
m integer

Mois à la date approximative.

année
y integer

L’année dans la date approximative.

Résumé
summary string

Résumé de la note. Limite de caractères : 255.

Note
text string

Texte de la note.

Auteur
author string

Auteur de la note. Limite de caractères : 50.

Retours

Note créée

Créer une pièce jointe cadeau

Crée une pièce jointe cadeau.

Paramètres

Nom Clé Obligatoire Type Description
ID cadeau
parent_id True string

ID d’enregistrement système du cadeau associé à la pièce jointe.

Type
type True string

Type de pièce jointe. Les pièces jointes physiques sont des fichiers chargés tels que des images, des fichiers PDF ou des documents Word enregistrés localement ou sur le réseau. Ils sont stockés et gérés dans le système. Les pièces jointes de liens sont des liens vers des fichiers tels que des images, des billets de blog ou des vidéos YouTube en ligne ou dans un compte de stockage cloud. Ils sont stockés et gérés en externe.

Nom
name string

Nom de fichier de la pièce jointe Limite de caractères : 150.

Date
date date-time

Date de la pièce jointe (par exemple : '2020-09-18T04:13:56Z'). Ce champ est défini par défaut sur la date et l’heure actuelles s’il n’est pas fourni.

URL
url string

URL de la pièce jointe. Cela est requis pour les pièces jointes de lien et non applicables aux pièces jointes physiques.

Nom de fichier
file_name string

Le nom du fichier. Limite de caractères : 36. Pour les pièces jointes physiques uniquement.

ID de fichier
file_id string

L’identificateur du fichier. Limite de caractères : 36. Pour les pièces jointes physiques uniquement.

ID de miniature
thumbnail_id string

Identificateur de la miniature. Limite de caractères : 36. Pour les pièces jointes physiques uniquement.

Étiquettes
tags array of string

Balises associées à la pièce jointe.

Retours

Pièce jointe cadeau créée

Lister l’hommage aux cadeaux reconnaît

Répertoriez les accusés de réception d’un hommage cadeau.

Paramètres

Nom Clé Obligatoire Type Description
ID d’hommage cadeau
gift_tribute_id True integer

ID d’enregistrement système de l’hommage cadeau.

Retours

Hommage cadeau reconnu

Mettre à jour les détails de l’accusé de réception du cadeau

Met à jour les détails de l’accusé de réception d’un cadeau.

Paramètres

Nom Clé Obligatoire Type Description
ID d’accusé de réception
acknowledgement_id True string

ID d’enregistrement système de l’accusé de réception cadeau à mettre à jour. Elle utilise l’ID du cadeau parent comme valeur.

Statut
status string

État de l’accusé de réception. Lorsque l’état est défini sur DoNotAcknowledge, la lettre et la date doivent être null. Lorsque l’état est défini sur NeedsAcknowledgement, la date doit être null.

Date
date date-time

Date associée à l’accusé de réception (par exemple : '2020-09-18T04:13:56Z').

Letter
letter string

Lettre associée à l’accusé de réception.

Mettre à jour les détails des reçus de cadeau

Met à jour les détails du reçu pour un cadeau.

Paramètres

Nom Clé Obligatoire Type Description
ID de reçu
receipt_id True string

ID d’enregistrement système du reçu cadeau à mettre à jour. Elle utilise l’ID du cadeau parent comme valeur.

Statut
status string

État de réception du cadeau. Lorsque l’état est défini sur NeedsReceipt ou DoNotReceipt, la date de réception doit être null.

Montant
value double

Montant du reçu.

Date
date date-time

Date du reçu (par exemple : '2020-09-18T04:13:56Z').

Number
number integer

Numéro du reçu.

Mettre à jour un champ personnalisé cadeau

Met à jour un champ personnalisé cadeau.

Paramètres

Nom Clé Obligatoire Type Description
ID de champ personnalisé
custom_field_id True string

ID d’enregistrement système du champ personnalisé à mettre à jour.

body
body True dynamic

Objet qui représente les propriétés du champ personnalisé à mettre à jour.

Mettre à jour un hommage cadeau

Met à jour un hommage cadeau.

Paramètres

Nom Clé Obligatoire Type Description
ID d’hommage cadeau
gift_tribute_id True integer

ID d’enregistrement système de l’hommage cadeau à mettre à jour.

Type d’hommage
tribute_type integer

Le type d’hommage.

Accuser réception de l’état
acknowledge string

L’hommage cadeau reconnaît le statut.

Mettre à jour un hommage cadeau reconnu

Met à jour un hommage cadeau reconnu.

Paramètres

Nom Clé Obligatoire Type Description
Hommage cadeau accusé de réception ID
gift_tribute_acknowledgee_id True integer

L’ID d’enregistrement système de l’hommage cadeau reconnaît à mettre à jour.

Letter
letter integer

Lettre envoyée au accusé de réception.

Date de lettre
letter_date date-time

Date à laquelle la lettre a été envoyée.

Mettre à jour une déclaration fiscale constituante

Met à jour une déclaration fiscale constituante.

Paramètres

Nom Clé Obligatoire Type Description
ID de déclaration fiscale
tax_declaration_id True integer

ID d’enregistrement système de la déclaration fiscale à mettre à jour.

La déclaration démarre
declaration_starts date-time

Date de début de la déclaration fiscale (par exemple : '2020-09-18T04:13:56Z').

Fin de la déclaration
declaration_ends date-time

Date de fin de la déclaration fiscale (par exemple : '2020-09-18T04:13:56Z').

Déclaration faite
declaration_made date-time

Date à laquelle la déclaration fiscale a été faite (par exemple : '2020-09-18T04:13:56Z').

Indicator
declaration_indicator string

Indicateur de déclaration.

Origine
declaration_source string

Source de déclaration.

Confirmation envoyée
confirmation_sent date-time

Date à laquelle la confirmation a été envoyée (par exemple : '2020-09-18T04:13:56Z').

Confirmation retournée
confirmation_returned date-time

Date à laquelle la confirmation a été retournée (par exemple : '2020-09-18T04:13:56Z').

Payer l’impôt
constituent_pays_tax string

Indique si la constituante paie l’impôt.

Statut
tax_payer_status string

Statut du contribuable.

Commentaires
tax_notes string

Commentaires pour la déclaration fiscale.

Sequence
sequence integer

Séquence numérique associée à la déclaration fiscale.

Mettre à jour une note cadeau

Met à jour une note cadeau.

Paramètres

Nom Clé Obligatoire Type Description
Note ID
id True integer

ID d’enregistrement système de la note à mettre à jour.

Type
note_type_id integer

Type de note.

jour
d integer

Jour de la date floue.

month
m integer

Mois à la date approximative.

année
y integer

L’année dans la date approximative.

Résumé
summary string

Résumé de la note. Limite de caractères : 255.

Note
text string

Texte de la note.

Auteur
author string

Auteur de la note. Limite de caractères : 50.

Mettre à jour une pièce jointe cadeau

Met à jour une pièce jointe cadeau.

Paramètres

Nom Clé Obligatoire Type Description
ID de pièce jointe
attachment_id True string

ID d’enregistrement système de la pièce jointe à mettre à jour.

Nom
name string

Nom de fichier de la pièce jointe Limite de caractères : 150.

Date
date date-time

Date de la pièce jointe (par exemple : '2020-09-18T04:13:56Z').

URL
url string

URL de la pièce jointe. Cela est requis pour les pièces jointes de lien et non applicables aux pièces jointes physiques.

Étiquettes
tags array of string

Balises associées à la pièce jointe.

Obtenir le dernier cadeau constituant

Retourne le dernier cadeau pour un constituant.

Paramètres

Nom Clé Obligatoire Type Description
ID constituant
constituent_id True string

ID d’enregistrement système de la constituante.

Retours

Donner un résumé

Obtenir le plus grand cadeau constituant

Retourne le plus grand cadeau pour un constituant.

Paramètres

Nom Clé Obligatoire Type Description
ID constituant
constituent_id True string

ID d’enregistrement système de la constituante.

Retours

Donner un résumé

Obtenir un cadeau

Retourne des informations sur un cadeau.

Paramètres

Nom Clé Obligatoire Type Description
ID cadeau
gift_id True string

ID d’enregistrement système du cadeau à obtenir.

Retours

Cadeau

Obtenir un cadeau par ID de recherche

Retourne l’ID d’enregistrement système d’un cadeau à partir de l’ID de recherche spécifié.

Paramètres

Nom Clé Obligatoire Type Description
ID de recherche
giftlookupid True string

ID de recherche cadeau.

Retours

Carte d’ID cadeau

Obtenir un don de durée de vie constituante

Retourne le résumé de la durée de vie d’un constituant.

Paramètres

Nom Clé Obligatoire Type Description
ID constituant
constituent_id True string

ID d’enregistrement système de la constituante.

Retours

Don de durée de vie

Obtenir un premier cadeau constituant

Retourne le premier cadeau pour un constituant.

Paramètres

Nom Clé Obligatoire Type Description
ID constituant
constituent_id True string

ID d’enregistrement système de la constituante.

Retours

Donner un résumé

Répertorier les cadeaux

Retourne une liste de cadeaux.

Paramètres

Nom Clé Obligatoire Type Description
Liste
list_id string

Définit un identificateur de liste utilisé pour filtrer l’ensemble de cadeaux sur ceux inclus dans la liste spécifiée. Si cette valeur est définie, d’autres filtres spécifiés sont ignorés.

Type
gift_type string

Représente une liste séparée par des virgules de types cadeaux pour filtrer les résultats. Par exemple, « MatchingGiftPledge, RecurringGift » retourne uniquement des cadeaux de type MatchingGiftPledge ou RecurringGift.

ID constituant
constituent_id string

Représente une liste séparée par des virgules d’ID d’enregistrement système constituants pour filtrer les résultats. Par exemple, « 280 1232 » retourne uniquement les dons de 280 constituants ou 1232.

ID de campagne
campaign_id string

Représente une liste séparée par des virgules d’ID d’enregistrement système de campagne pour filtrer les résultats. Par exemple, « 506 918 » retourne uniquement des cadeaux à la campagne 506 ou campagne 918.

ID du fonds
fund_id string

Représente une liste séparée par des virgules des ID d’enregistrement système de fonds pour filtrer les résultats. Par exemple, « 506 918 » ne retourne que des dons au fonds 506 ou 918.

ID d’appel
appeal_id string

Représente une liste séparée par des virgules d’ID d’enregistrement système d’appel pour filtrer les résultats. Par exemple, « 506 918 » ne retourne que des cadeaux pour appel 506 ou appel 918.

Limit
limit integer

Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. La valeur maximale est de 5 000.

Décalage
offset integer

Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination.

Date de départ du cadeau
start_gift_date date-time

Représente un filtre pour les cadeaux avec une date de cadeau le ou après la date spécifiée (par exemple : '2020-09-18T04:13:56Z').

Date de fin du cadeau
end_gift_date date-time

Représente un filtre pour les cadeaux avec une date de cadeau le ou avant la date spécifiée (par exemple : '2020-09-18T04:13:56Z').

Démarrer le montant du cadeau
start_gift_amount double

Représente un filtre pour les cadeaux dont le montant est supérieur ou égal au montant spécifié.

Fin du montant du cadeau
end_gift_amount double

Représente un filtre pour les cadeaux dont le montant est inférieur ou égal au montant spécifié.

Publier l’état
post_status string

Représente une liste séparée par des virgules d’états de publication cadeau pour filtrer les résultats. Par exemple, « DoNotPost, Post » renvoie uniquement les cadeaux marqués comme DoNotPost ou Post.

État du reçu
receipt_status string

Représente une liste séparée par des virgules d’états de reçu cadeau pour filtrer les résultats. Par exemple, « DoNotReceipt, Reçu » retourne uniquement les cadeaux marqués comme DoNotReceipt ou Reçus.

État de l’accusé de réception
acknowledgement_status string

Représente une liste séparée par des virgules des états d’accusé de réception cadeau pour filtrer les résultats. Par exemple, « DoNotAcknowledge,Knowledge », retourne uniquement les cadeaux marqués comme DoNotAcknowledge ou Reconnu.

Trié par
sort string

Représente une liste de champs pour trier les résultats. Les résultats sont dans l’ordre croissant par défaut, et un signe « - » indique l’ordre décroissant. Par exemple, « date_added,date » trie les cadeaux par le champ « date_added » dans l’ordre croissant, puis par le champ « date du cadeau » dans l’ordre décroissant. Si seul le champ date_modified ou uniquement le champ date_added est fourni, cela ajoute le paramètre sort_token à l’URL de next_link pour vous assurer que les cadeaux sont triés de manière stable.

Ajouté ou après
date_added date-time

Filtrez les résultats en cadeaux créés ou après la date spécifiée (par exemple : « 2020-09-18T04:13:56Z »).

Modifié sur ou après
last_modified date-time

Filtrez les résultats sur les cadeaux modifiés ou après la date spécifiée (par exemple : « 2020-09-18T04:13:56Z »).

Retours

Cadeaux

Répertorier les champs personnalisés du cadeau

Répertorie les champs personnalisés d’un cadeau.

Paramètres

Nom Clé Obligatoire Type Description
ID cadeau
gift_id True string

ID d’enregistrement système du cadeau.

Retours

Champs personnalisés

Répertorier les déclarations fiscales constituantes

Répertorie les déclarations fiscales d’aide aux cadeaux pour un constituant (applicable uniquement aux versions britanniques).

Paramètres

Nom Clé Obligatoire Type Description
ID constituant
constituent_id True integer

ID d’enregistrement système de la constituante.

Limit
limit integer

Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. Il n’y a pas de maximum.

Décalage
offset integer

Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination.

Retours

Déclarations fiscales

Répertorier les hommages aux cadeaux

Répertorie les hommages pour un cadeau.

Paramètres

Nom Clé Obligatoire Type Description
ID cadeau
gift_id True integer

ID d’enregistrement système du cadeau.

Retours

Hommages aux cadeaux

Répertorier les lots de cadeaux

Répertoriez les lots de cadeaux.

Paramètres

Nom Clé Obligatoire Type Description
Numéro de lot
batch_number string

Représente un filtre pour les résultats qui correspondent au nombre spécifié.

Approuvé?
approved boolean

Représente un filtre pour l’état du lot cadeau.

Y a-t-il des exceptions ?
has_exceptions boolean

Représente un filtre pour déterminer si le lot cadeau contient des exceptions.

Limit
limit integer

Représente le nombre d’enregistrements à retourner. La valeur par défaut est 500. La valeur maximale est de 5 000.

Décalage
offset integer

Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination.

Texte de recherche
search_text string

Représente un filtre pour le texte inclus dans les champs de description de lot ou de numéro de lot.

Créé par
created_by string

Représente un filtre pour les lots de cadeaux créés par l’utilisateur spécifié.

Retours

Lots de cadeaux

Répertorier les notes de cadeau

Répertorie les notes d’un cadeau.

Paramètres

Nom Clé Obligatoire Type Description
ID cadeau
gift_id True integer

ID d’enregistrement système du dont.

Limit
limit integer

Représente le nombre d’enregistrements à retourner.

Décalage
offset integer

Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination.

Retours

Notes de cadeau

Répertorier les paiements d’engagement

Répertorie les paiements d’un engagement.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’engagement
gift_id True string

ID d’enregistrement système de l’engagement.

Retours

Paiements

Répertorier les pièces jointes de cadeau

Répertorie les pièces jointes pour un cadeau.

Paramètres

Nom Clé Obligatoire Type Description
ID cadeau
gift_id True string

ID d’enregistrement système du cadeau.

Retours

Attachments

Répertorier les versements d’engagement

Répertorie les versements pour un engagement.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’engagement
gift_id True string

ID d’enregistrement système de l’engagement.

Retours

Versements

Vendre un cadeau boursier

Met à jour un cadeau boursier à vendre.

Paramètres

Nom Clé Obligatoire Type Description
ID cadeau
gift_id True string

ID d’enregistrement système du cadeau boursier à vendre.

Date de vente
stock_sale_date True date

Date à laquelle le stock a été vendu (ex : '2005-09-18').

Valeur de vente
stock_sale_value True double

Valeur de la vente d’actions.

Frais de répartiteur
broker_fee double

Les frais du courtier boursier vendu.

Publier l’état
post_status string

L’état post du cadeau vendu.

Date de publication
post_date date

Date publiée du stock vendu (ex : '2020-09-18').

Remarques
notes string

Notes du stock vendu. Limite de caractères : 255.

Issuer
issuer string

Émetteur boursier.

Symbole émetteur
symbol string

Symbole de l’émetteur boursier.

Nombre d’unités
units integer

Nombre d’unités vendues.

Prix médian par unité
unit_price double

Prix médian par unité vendue.

Définitions

ConstituentApi.AppealRead

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système de l’appel.

descriptif
description string

Description de l’appel.

ConstituentApi.CampaignRead

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système de la campagne.

descriptif
description string

Description de la campagne.

ConstituantApi.FundRead

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système du fonds.

descriptif
description string

Description du fonds.

ConstituentApi.GivingSummaryRead

Donner un résumé

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système du cadeau.

Type
type string

Le type de cadeau.

Date
date date-time

Date du cadeau.

value
amount.value double

Le montant du cadeau.

Appeal
appeals array of ConstituentApi.AppealRead

Ensemble d’appels associés au cadeau.

Campagne
campaigns array of ConstituentApi.CampaignRead

Ensemble de campagnes associées au cadeau.

Fonds
funds array of ConstituentApi.FundRead

Ensemble de fonds associés au cadeau.

ConstituentApi.LifetimeGivingRead

Don de durée de vie

Nom Chemin d’accès Type Description
Années consécutives données
consecutive_years_given integer

Nombre d’années consécutives que la constituante a donnée.

Nombre total d’années données
total_years_given integer

Nombre total d’années que la constituante a données.

value
total_giving.value double

Montant total donné par la constituante.

value
total_pledge_balance.value double

Solde total des engagements non payés pour la constituante.

value
total_received_giving.value double

Montant total reçu par la constituante.

value
total_committed_matching_gifts.value double

Ce champ calculé calcule le montant total des engagements de cadeaux correspondants attribués à la constituante.

value
total_received_matching_gifts.value double

Montant total des paiements pour les dons correspondants attribués à la constituante.

value
total_soft_credits.value double

Montant total des crédits souples appliqués à la constituante.

GiftApi.AcknowledgementRead

Reconnaissance

Nom Chemin d’accès Type Description
date
date date-time

Date associée à l’accusé de réception.

lettre
letter string

Lettre associée à l’accusé de réception.

status
status string

État de l’accusé de réception. Les valeurs disponibles sont : ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT et DONOTACKNOWLEDGE.

GiftApi.ApiCollectionOfGiftAttachmentRead

Attachments

Nom Chemin d’accès Type Description
Nombre
count integer

Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. Les paramètres de limite et de décalage n’affectent pas le nombre, mais pour faciliter la pagination, ils peuvent affecter le nombre d’éléments dans le jeu de résultats de valeur.

value
value array of GiftApi.GiftAttachmentRead

Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection.

GiftApi.ApiCollectionOfGiftCustomFieldRead

Champs personnalisés

Nom Chemin d’accès Type Description
Nombre
count integer

Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. Les paramètres de limite et de décalage n’affectent pas le nombre, mais pour faciliter la pagination, ils peuvent affecter le nombre d’éléments dans le jeu de résultats de valeur.

value
value array of GiftApi.GiftCustomFieldRead

Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection.

GiftApi.ApiCollectionOfGiftRead

Cadeaux

Nom Chemin d’accès Type Description
Nombre
count integer

Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. Les paramètres de limite et de décalage n’affectent pas le nombre, mais pour faciliter la pagination, ils peuvent affecter le nombre d’éléments dans le jeu de résultats de valeur.

value
value array of GiftApi.GiftRead

Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection.

GiftApi.BatchGiftAddResults

Contient une collection d’enregistrements d’erreurs de cadeau par lots et les cadeaux par lots ajoutés par l’opération

Nom Chemin d’accès Type Description
Erreurs
errors array of GiftApi.GiftBatchGiftError

Erreurs de cadeau de lot associées à l’opération d’ajout de cadeau par lot

Cadeaux
gifts array of GiftApi.BatchGiftRead

Collection de cadeaux par lots qui ont été ajoutés par l’opération d’ajout de cadeaux par lot

GiftApi.GiftBatchGiftError

Représente des exceptions empêchant l’ajout d’éléments au lot.

Nom Chemin d’accès Type Description
champ affecté
affected_field string

Champ affecté par l’erreur

ID de lot
batch_id string

ID d’enregistrement système du lot

code d’erreur d’exception
exception_error_code integer

Code d’erreur d’exception

Message d’erreur d’exception
exception_error_message string

Message d’erreur d’exception

nom d’erreur d’exception
exception_error_name string

Nom de l’erreur d’exception

ID cadeau
gift_id string

ID d’enregistrement système du cadeau

ID de recherche
lookup_id string

Identificateur défini par l’utilisateur pour le cadeau.

GiftApi.BatchGiftRead

Cadeau batch

Nom Chemin d’accès Type Description
ID de lot
batch_id string

ID du lot auquel le cadeau a été ajouté.

Erreurs
errors array of GiftApi.GiftBatchGiftError

Erreurs associées au cadeau de lot.

ID
id string

ID d’enregistrement système du cadeau de lot.

ID de constituant
constituent_id string

ID d’enregistrement système de la constituante associée au cadeau.

type
type string

Le type de cadeau.

Sous-type
subtype string

Sous-type du cadeau.

date
date date-time

Date du cadeau.

value
amount.value double

Le montant du cadeau.

value
balance.value double

Le solde restant sur le cadeau.

numéro de lot
batch_number string

Numéro de lot associé à ce cadeau.

status
gift_status string

Le statut du cadeau.

anonyme?
is_anonymous boolean

Le cadeau est-il anonyme ?

circonscription
constituency string

La circonscription du cadeau.

ID de recherche
lookup_id string

Identificateur défini par l’utilisateur pour le cadeau.

origin
origin string

L’origine du cadeau.

publier l’état
post_status string

État du registre général du cadeau. Les valeurs disponibles sont Publiées, NotPosted et DoNotPost. Lorsque post_status est défini sur DoNotPost>, post_date doit être null. Lorsqu’elle est définie sur NotPosted, post_date est nécessaire, mais reste modifiable. Lorsqu’il est défini sur Publié, post_date est requis et n’est plus modifiable.

date de publication
post_date date-time

Date à laquelle le cadeau a été publié dans le registre général.

référence
reference string

Remarques pour suivre des détails spéciaux sur un cadeau, comme la motivation derrière elle ou une description détaillée d’un cadeau en nature.

jour
recurring_gift_status_date.d integer

Jour de la date floue.

month
recurring_gift_status_date.m integer

Mois à la date approximative.

année
recurring_gift_status_date.y integer

L’année dans la date approximative.

frequency
recurring_gift_schedule.frequency string

Fréquence d’installation du cadeau périodique à afficher. Les valeurs disponibles sont HEBDOMADAIRES, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MENSUELLES, TRIMESTRIELLES, ANNUELLES.

start
recurring_gift_schedule.start_date date-time

Date de début du cadeau périodique.

end
recurring_gift_schedule.end_date date-time

Date de fin du cadeau périodique.

value
gift_aid_amount.value double

Ce champ calculé calcule le montant total qualifié de la taxe récupérée à partir de l’aide-cadeau dans toutes les gift_splits pour ce cadeau. Pour le Royaume-Uni uniquement.

statut de qualification d’aide-cadeau
gift_aid_qualification_status string

Ce champ calculé détermine l’état de qualification de l’Aide cadeau en fonction des informations de déclaration fiscale et du format de base de données. Les valeurs disponibles sont les suivantes : Qualifié, NotQualified et PartiellementQualified. Pour le Royaume-Uni uniquement.

code cadeau
gift_code string

Valeur du code cadeau associée au cadeau.

fractionnements de cadeaux
gift_splits array of GiftApi.GiftSplitRead

Ensemble de fractionnements de cadeaux associés au cadeau.

collectes de fonds
fundraisers array of GiftApi.GiftFundraiserRead

Ensemble de collectes de fonds qui reçoivent un crédit pour le cadeau.

Crédits souples
soft_credits array of GiftApi.SoftCreditRead

Ensemble de crédits souples associés au cadeau.

Reçus
receipts array of GiftApi.ReceiptRead

Ensemble de reçus associés au cadeau.

Remerciements
acknowledgements array of GiftApi.AcknowledgementRead

Ensemble d’accusés de réception associés au cadeau.

Paiements
payments array of GiftApi.PaymentRead

Les paiements sur le cadeau.

Cadeaux liés
linked_gifts array of string

Identificateurs d’autres cadeaux liés à ce cadeau.

Date d’ajout
date_added date-time

Date de création du cadeau.

Date de modification
date_modified date-time

Date de la dernière modification du cadeau.

GiftApi.CreatedGift

Cadeau créé

Nom Chemin d’accès Type Description
ID
id string

ID du cadeau nouvellement créé.

GiftApi.CreatedGiftAttachment

Pièce jointe cadeau créée

Nom Chemin d’accès Type Description
ID
id string

ID de la pièce jointe cadeau nouvellement créée.

GiftApi.CreatedGiftCustomField

Champ personnalisé cadeau créé

Nom Chemin d’accès Type Description
ID
id string

ID du champ personnalisé cadeau nouvellement créé.

GiftApi.GiftAttachmentRead

Pièce jointe

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système de la pièce jointe.

ID cadeau
parent_id string

ID d’enregistrement système du cadeau associé à la pièce jointe.

Type
type string

Type de pièce jointe. Les pièces jointes physiques sont des fichiers chargés tels que des images, des fichiers PDF ou des documents Word enregistrés localement ou sur le réseau. Ils sont stockés et gérés dans le système. Les pièces jointes de liens sont des liens vers des fichiers tels que des images, des billets de blog ou des vidéos YouTube en ligne ou dans un compte de stockage cloud. Ils sont stockés et gérés en externe.

Nom
name string

Nom de fichier de la pièce jointe Limite de caractères : 150.

Date
date date-time

Date de la pièce jointe.

URL
url string

URL de la pièce jointe. Cela est requis pour les pièces jointes de lien et non applicables aux pièces jointes physiques.

Nom de fichier
file_name string

Le nom du fichier. Limite de caractères : 36. Pour les pièces jointes physiques uniquement.

ID de fichier
file_id string

L’identificateur du fichier. Limite de caractères : 36. Pour les pièces jointes physiques uniquement.

ID de miniature
thumbnail_id string

Identificateur de la miniature. Limite de caractères : 36. Pour les pièces jointes physiques uniquement.

URL de miniature
thumbnail_url string

URL d’une miniature. Pour les pièces jointes physiques qui sont uniquement des images. Contient une signature limitée dans le temps qui limite l’accès à 60 minutes.

Type de contenu
content_type string

Type de contenu. Pour les pièces jointes physiques uniquement.

Taille du fichier
file_size integer

Taille du fichier en octets. Pour les pièces jointes physiques uniquement.

Étiquettes
tags array of string

Balises associées à la pièce jointe.

GiftApi.GiftCustomFieldRead

Champ personnalisé

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système du champ personnalisé.

ID cadeau
parent_id string

ID d’enregistrement système du cadeau associé au champ personnalisé.

Catégorie
category string

Catégorie de champ personnalisé.

Type
type string

Type de données que le champ personnalisé représente.

Valeur
value

Valeur du champ personnalisé.

Valeur de texte
text_value string

Valeur de texte du champ personnalisé.

Valeur numérique
number_value integer

Valeur numérique du champ personnalisé.

Valeur de date
date_value date

Valeur de date du champ personnalisé.

Valeur monétaire
currency_value double

Valeur monétaire du champ personnalisé.

Valeur booléenne
boolean_value boolean

Valeur booléenne du champ personnalisé.

Valeur d’entrée de table
codetableentry_value string

Valeur d’entrée de table du champ personnalisé.

Valeur d’ID constituante
constituentid_value string

Valeur d’ID constituante du champ personnalisé.

jour
fuzzydate_value.d integer

Jour de la date floue.

month
fuzzydate_value.m integer

Mois à la date approximative.

année
fuzzydate_value.y integer

L’année dans la date approximative.

Date
date date

Date du champ personnalisé.

Commentaire
comment string

Commentaire sur le champ personnalisé. Limite de caractères : 50.

Date d’ajout
date_added date-time

Date de création du champ personnalisé.

Date de modification
date_modified date-time

Date de dernière modification du champ personnalisé.

GiftApi.GiftFundraiserRead

Collecte de fonds sur les cadeaux

Nom Chemin d’accès Type Description
value
amount.value double

Montant crédité à la collecte de fonds pour le cadeau.

ID de collecte de fonds
constituent_id string

ID d’enregistrement système constituant pour la collecte de fonds associée au cadeau.

GiftApi.GiftRead

Cadeau

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système du cadeau.

ID constituant
constituent_id string

ID d’enregistrement système de la constituante associée au cadeau.

Type
type string

Le type de cadeau.

Sous-type
subtype string

Sous-type du cadeau.

Date
date date-time

Date du cadeau.

value
amount.value double

Le montant du cadeau.

value
balance.value double

Le solde restant sur le cadeau.

Numéro de lot
batch_number string

Numéro de lot associé à ce cadeau.

Statut
gift_status string

Le statut du cadeau.

Anonyme?
is_anonymous boolean

Le cadeau est-il anonyme ?

Circonscription
constituency string

La circonscription du cadeau.

ID de recherche
lookup_id string

Identificateur défini par l’utilisateur pour le cadeau.

Origin
origin string

L’origine du cadeau.

Publier l’état
post_status string

État du registre général du cadeau. Les valeurs disponibles sont Publiées, NotPosted et DoNotPost. Lorsque post_status est défini sur DoNotPost>, post_date doit être null. Lorsqu’elle est définie sur NotPosted, post_date est nécessaire, mais reste modifiable. Lorsqu’il est défini sur Publié, post_date est requis et n’est plus modifiable.

Date de publication
post_date date-time

Date à laquelle le cadeau a été publié dans le registre général.

Reference
reference string

Remarques pour suivre des détails spéciaux sur un cadeau, comme la motivation derrière elle ou une description détaillée d’un cadeau en nature.

jour
recurring_gift_status_date.d integer

Jour de la date floue.

month
recurring_gift_status_date.m integer

Mois à la date approximative.

année
recurring_gift_status_date.y integer

L’année dans la date approximative.

frequency
recurring_gift_schedule.frequency string

Fréquence d’installation du cadeau périodique à afficher. Les valeurs disponibles sont HEBDOMADAIRES, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MENSUELLES, TRIMESTRIELLES, ANNUELLES.

start
recurring_gift_schedule.start_date date-time

Date de début du cadeau périodique.

end
recurring_gift_schedule.end_date date-time

Date de fin du cadeau périodique.

value
gift_aid_amount.value double

Ce champ calculé calcule le montant total qualifié de la taxe récupérée à partir de l’aide-cadeau dans toutes les gift_splits pour ce cadeau. Pour le Royaume-Uni uniquement.

Statut de qualification de l’aide cadeau
gift_aid_qualification_status string

Ce champ calculé détermine l’état de qualification de l’Aide cadeau en fonction des informations de déclaration fiscale et du format de base de données. Les valeurs disponibles sont les suivantes : Qualifié, NotQualified et PartiellementQualified. Pour le Royaume-Uni uniquement.

Code cadeau
gift_code string

Valeur du code cadeau associée au cadeau.

Fractionnements de cadeaux
gift_splits array of GiftApi.GiftSplitRead

Ensemble de fractionnements de cadeaux associés au cadeau.

Collectes de fonds
fundraisers array of GiftApi.GiftFundraiserRead

Ensemble de collectes de fonds qui reçoivent un crédit pour le cadeau.

Crédits souples
soft_credits array of GiftApi.SoftCreditRead

Ensemble de crédits souples associés au cadeau.

Reçus
receipts array of GiftApi.ReceiptRead

Ensemble de reçus associés au cadeau.

Remerciements
acknowledgements array of GiftApi.AcknowledgementRead

Ensemble d’accusés de réception associés au cadeau.

Paiements
payments array of GiftApi.PaymentRead

Les paiements sur le cadeau.

Cadeaux liés
linked_gifts array of string

Identificateurs d’autres cadeaux liés à ce cadeau.

Date d’ajout
date_added date-time

Date de création du cadeau.

Date de modification
date_modified date-time

Date de la dernière modification du cadeau.

GiftApi.GiftSplitRead

Fractionnement du cadeau

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système du fractionnement du cadeau.

value
amount.value double

Le montant du cadeau fractionné.

ID d’appel
appeal_id string

ID d’enregistrement système de l’appel associé au fractionnement du cadeau.

ID de campagne
campaign_id string

ID d’enregistrement système de la campagne associée au fractionnement du cadeau.

ID de fonds
fund_id string

ID d’enregistrement système du fonds associé au fractionnement du cadeau.

value
gift_aid_amount.value double

Montant de l’impôt récupéré de l’aide aux cadeaux pour ce fractionnement de cadeaux. Pour le Royaume-Uni uniquement.

statut de qualification d’aide-cadeau
gift_aid_qualification_status string

Le statut de qualification de l’aide cadeau du fractionnement du cadeau. Les valeurs disponibles sont les suivantes : Qualifié et NotQualified. Pour le Royaume-Uni uniquement.

ID de package
package_id string

ID d’enregistrement système du package associé au fractionnement cadeau.

GiftApi.ReceiptRead

Reçu

Nom Chemin d’accès Type Description
value
amount.value double

Montant du reçu.

date
date date-time

Date du reçu.

nombre
number integer

Numéro du reçu.

status
status string

État du reçu. Les valeurs disponibles sont les suivantes : RECEIPTED, NEEDSRECEIPT et DONOTRECEIPT.

GiftApi.PaymentRead

Paiement

Nom Chemin d’accès Type Description
jeton de compte
account_token string

Informations sur le compte jeton (par exemple, carte de crédit) du fournisseur de paiement externe. S’applique uniquement aux modes de paiement de « CreditCard » et « DirectDebit ».

BBPS configuration ID
bbps_configuration_id string

ID de configuration BBPS. S’applique uniquement aux modes de paiement de « CreditCard » et « DirectDebit ».

BBPS transaction ID
bbps_transaction_id string

ID de transaction BBPS. S’applique uniquement aux modes de paiement de « CreditCard » et « DirectDebit ».

jour
check_date.d integer

Jour de la date floue.

month
check_date.m integer

Mois à la date approximative.

année
check_date.y integer

L’année dans la date approximative.

vérifier le numéro
check_number string

Numéro de vérification. S’applique uniquement au mode de paiement de « PersonalCheck ».

extraction de l’ID de transaction
checkout_transaction_id string

ID de transaction d’extraction. S’applique uniquement aux modes de paiement de « CreditCard » et « DirectDebit ».

mode de paiement
payment_method string

Mode de paiement. Les valeurs disponibles sont répertoriées ci-dessous.

référence
reference string

Référence. S’applique uniquement au mode de paiement « Autre ».

jour
reference_date.d integer

Jour de la date floue.

month
reference_date.m integer

Mois à la date approximative.

année
reference_date.y integer

L’année dans la date approximative.

GiftApi.SoftCreditRead

Crédit logiciel

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système du crédit logiciel.

value
amount.value double

Montant du crédit souple.

ID de constituant
constituent_id string

ID d’enregistrement système de la constituante associée au crédit logiciel.

ID cadeau
gift_id string

ID d’enregistrement système du cadeau associé au crédit logiciel.

Gift2Api.PledgeInstallment

Représente l’objet d’installation.

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système de l’installation.

date
date date-time

Date de l’installation.

année
year integer

Année de la date d’installation.

value
amount.value double

Montant de l’installation.

balance
balance double

Solde de l’installation.

solde restant de l’engagement
remaining_pledge_balance double

Solde restant de l’engagement.

Séquence
sequence integer

Séquence d’ordre d’affichage de l’installation.

Gift2Api.PledgeInstallmentCollection

Versements

Nom Chemin d’accès Type Description
Date de début
start_date date-time

Date à laquelle commence le calendrier cadeau.

Fréquence
frequency string

Fréquence de l’horaire cadeau.

Jeton d’accès concurrentiel
concurrency_token string

Jeton d’accès concurrentiel.

Versements
installments array of Gift2Api.PledgeInstallment

Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection.

Gift2Api.PledgePayment

Représente l’objet de paiement de l’engagement.

Nom Chemin d’accès Type Description
ID d’installation
installment_id string

ID d’enregistrement système de l’installation en cours de paiement.

ID cadeau
payment_gift_id string

ID d’enregistrement système du cadeau de paiement.

value
amount_applied.value double

Montant appliqué à l’installation.

Gift2Api.PledgePaymentCollection

Paiements

Nom Chemin d’accès Type Description
pledge_payments
pledge_payments array of Gift2Api.PledgePayment

Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection.

GiftBatchApi.ApiCollectionOfGiftBatch

Lots de cadeaux

Nom Chemin d’accès Type Description
Nombre
count integer

Nombre total de lots de cadeaux dans la réponse.

value
value array of GiftBatchApi.GiftBatch

Ensemble d’éléments inclus dans la réponse.

GiftBatchApi.CreatedBatch

Lot cadeau créé

Nom Chemin d’accès Type Description
ID
batch_id string

ID d’enregistrement système du lot cadeau nouvellement créé.

GiftBatchApi.GiftBatch

Représente l’objet de lot cadeau

Nom Chemin d’accès Type Description
ID
id string

ID d’enregistrement système du lot.

descriptif
batch_description string

Description du lot.

numéro de lot
batch_number string

Numéro de lot

numéro projeté
projected_number_of_gifts integer

Nombre projeté de cadeaux dans le lot.

nombre réel
number_of_gifts integer

Nombre réel de cadeaux dans le lot.

montant projeté
projected_amount double

Valeur projetée des cadeaux dans le lot.

montant réel
actual_amount double

Valeur réelle des cadeaux dans le lot.

a-t-il des exceptions ?
has_exceptions boolean

Le lot a-t-il des exceptions ?

approuvé?
is_approved boolean

Le lot est-il approuvé ?

Créé par
created_by string

Nom de l’utilisateur qui a créé le lot.

Créé le
created_on date-time

Date de création du lot.

NXTDataIntegrationApi.CreatedGiftNote

Note créée

Nom Chemin d’accès Type Description
ID
id string

ID de la note nouvellement créée.

NXTDataIntegrationApi.CreatedGiftTribute

Hommage cadeau créé

Nom Chemin d’accès Type Description
ID
id string

ID de l’hommage cadeau nouvellement créé.

NXTDataIntegrationApi.CreatedTaxDeclaration

Déclaration fiscale créée

Nom Chemin d’accès Type Description
ID
id string

ID de la déclaration fiscale nouvellement créée.

NXTDataIntegrationApi.GiftIdMap

Carte d’ID cadeau

Nom Chemin d’accès Type Description
ID
system_record_id integer

ID d’enregistrement du système cadeau.

NXTDataIntegrationApi.GiftNote

Note

Nom Chemin d’accès Type Description
ID cadeau
gift_id integer

ID d’enregistrement système du cadeau associé à la note.

Type
type string

Type de note.

jour
date.d integer

Jour de la date floue.

month
date.m integer

Mois à la date approximative.

année
date.y integer

L’année dans la date approximative.

Résumé
summary string

Résumé de la note.

Note
text string

Texte de la note.

Auteur
author string

Auteur de la note.

NXTDataIntegrationApi.GiftNoteCollection

Notes de cadeau

Nom Chemin d’accès Type Description
Nombre
count integer

Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. Les paramètres de limite et de décalage n’affectent pas le nombre, mais pour faciliter la pagination, ils peuvent affecter le nombre d’éléments dans le jeu de résultats de valeur.

value
value array of NXTDataIntegrationApi.GiftNote

Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection.

NXTDataIntegrationApi.GiftTribute

Hommage cadeau

Nom Chemin d’accès Type Description
ID
id integer

ID d’enregistrement système de l’hommage cadeau.

ID cadeau
gift_id integer

ID d’enregistrement système du cadeau.

ID d’hommage
tribute_id integer

ID d’enregistrement système de l’hommage.

Type d’hommage
tribute_type integer

Le type d’hommage.

Accuser réception de l’état
acknowledge string

L’hommage cadeau reconnaît le statut.

Sequence
sequence integer

La séquence d’hommage cadeau.

NXTDataIntegrationApi.GiftTributeAcknowledgee

Un hommage cadeau reconnaît l’enregistrement dans Raiser’s Edge.

Nom Chemin d’accès Type Description
ID
id integer

L’ID d’enregistrement système de l’hommage cadeau reconnaît.

ID d’hommage cadeau
gift_tribute_id integer

ID d’enregistrement système de l’hommage cadeau.

Est-ce qu’on reconnaît soi-même ?
self_acknowledge boolean

Est-ce que cela reconnaît l’auto-accusé de réception ?

ID des relations
relationships_id integer

ID d’enregistrement système de la relation pour l’accusé de réception.

Letter
letter integer

Lettre envoyée au accusé de réception.

Date de lettre
letter_date date-time

Date à laquelle la lettre a été envoyée.

NXTDataIntegrationApi.GiftTributeAcknowledgeeCollection

Hommage cadeau reconnu

Nom Chemin d’accès Type Description
Nombre
count integer

Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. Les paramètres de limite et de décalage n’affectent pas le nombre, mais pour faciliter la pagination, ils peuvent affecter le nombre d’éléments dans le jeu de résultats de valeur.

value
value array of NXTDataIntegrationApi.GiftTributeAcknowledgee

Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection.

NXTDataIntegrationApi.GiftTributeCollection

Hommages aux cadeaux

Nom Chemin d’accès Type Description
Nombre
count integer

Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. Les paramètres de limite et de décalage n’affectent pas le nombre, mais pour faciliter la pagination, ils peuvent affecter le nombre d’éléments dans le jeu de résultats de valeur.

value
value array of NXTDataIntegrationApi.GiftTribute

Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection.

NXTDataIntegrationApi.TaxDeclaration

Nom Chemin d’accès Type Description
ID
declaration_id integer
La déclaration démarre
declaration_starts date-time

Date de début de la déclaration fiscale.

Fin de la déclaration
declaration_ends date-time

Date de fin de la déclaration fiscale.

Déclaration faite
declaration_made date-time

Date à laquelle la déclaration fiscale a été faite.

ID d’indicateur
declaration_indicator_id integer

ID de l’indicateur de déclaration.

Indicator
declaration_indicator string

Indicateur de déclaration.

Source ID
declaration_source_id integer

ID source de la déclaration.

Origine
declaration_source string

Source de déclaration.

Confirmation envoyée
confirmation_sent date-time

Date à laquelle la confirmation a été envoyée.

Confirmation retournée
confirmation_returned date-time

Date à laquelle la confirmation a été retournée.

Payer l’impôt
constituent_pays_tax string

Indique si la constituante paie l’impôt.

ID d’état
tax_payer_status_id integer

ID d’état du contribuable.

Statut
tax_payer_status string

Statut du contribuable.

Commentaires
tax_notes string

Commentaires pour la déclaration fiscale.

Sequence
sequence integer

Séquence numérique associée à la déclaration fiscale.

NXTDataIntegrationApi.TaxDeclarationCollection

Déclarations fiscales

Nom Chemin d’accès Type Description
Nombre
count integer

Nombre d’éléments disponibles pour la récupération dans la collection après l’application de paramètres de requête. Les paramètres de limite et de décalage n’affectent pas le nombre, mais pour faciliter la pagination, ils peuvent affecter le nombre d’éléments dans le jeu de résultats de valeur.

value
value array of NXTDataIntegrationApi.TaxDeclaration

Ensemble d’éléments inclus dans la réponse. Il peut s’agir d’un sous-ensemble des éléments de la collection.