Regalos RENXT blackbaud
Blackbaud Raiser's Edge EDITION es una completa solución de software de recaudación de fondos y administración de donantes basada en la nube creada específicamente para organizaciones sin ánimo de lucro y toda la comunidad de buena comunidad social. Use el conector Regalos para administrar regalos.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Compatibilidad con Blackbaud |
| URL | https://www.blackbaud.com/support |
| Correo Electrónico | skyapi@blackbaud.com |
| Metadatos del conector | |
|---|---|
| Publicador | Blackbaud, Inc. |
| Sitio web | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| Directiva de privacidad | https://www.blackbaud.com/privacy-shield |
| Categorías | Ventas y CRM; Productividad |
Raiser's Edge EDITION es una solución completa de software de gestión de donantes y recaudación de fondos basada en la nube creada específicamente para organizaciones sin ánimo de lucro y toda la comunidad social.
Este conector se basa en la API SKY de Blackbaud y proporciona operaciones para ayudar a administrar regalos y entidades relacionadas que se encuentran en The Raiser's Edge WIN, entre las que se incluyen:
- Regalos y resúmenes constituyentes
- Lotes de regalo
- Ingresos
- Reconocimientos
- Y mucho más...
Para obtener más información, consulte la documentación.
Prerrequisitos
Para usar este conector, debe tener una cuenta de identificador de Blackbaud con acceso a uno o varios entornos de Blackbaud.
Además, el administrador de la organización también debe realizar una acción de nivel de administrador dentro del sistema para permitir que este conector acceda al entorno de Blackbaud. Puede encontrar más información sobre estos requisitos previos en la documentación de configuración inicial .
¿Cómo obtener credenciales?
El administrador de la organización le enviará una invitación al entorno edge DE RAISER de raiser y configurará los permisos de la cuenta de usuario dentro del entorno. No se requieren credenciales adicionales para usar este conector.
Problemas y limitaciones conocidos
El conector funcionará en el contexto de la cuenta de usuario y, por tanto, estará sujeto a los permisos de usuario dentro del entorno.
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualización de un homenaje de regalo |
Actualiza un homenaje regalo. |
| Actualización de un reconocimiento de homenaje de regalo |
Actualiza un reconocimiento de regalo. |
| Actualizar datos adjuntos de regalo |
Actualiza los datos adjuntos de un regalo. |
| Actualizar detalles de confirmación de regalo |
Actualiza los detalles de confirmación de un regalo. |
| Actualizar los detalles del recibo de regalo |
Actualiza los detalles del recibo de un regalo. |
| Actualizar un campo personalizado de regalo |
Actualiza un campo personalizado de regalo. |
| Actualizar una declaración fiscal constituyente |
Actualiza una declaración tributaria constituyente. |
| Actualizar una nota de regalo |
Actualiza una nota de regalo. |
| Agregar un regalo al lote |
Agregue un regalo al lote de regalo especificado. |
| Creación de un compromiso |
Crea un nuevo compromiso. |
| Creación de un lote de regalo |
Crea un nuevo lote de regalo. |
| Creación de una declaración de impuestos constituyente |
Crea una nueva declaración de impuestos de La Ayuda de Regalo para un constituyente. |
| Crear datos adjuntos de regalo |
Crea un nuevo archivo adjunto de regalo. |
| Crear un campo personalizado de regalo |
Crea un nuevo campo personalizado de regalo. |
| Crear un homenaje de regalo |
Crea un nuevo homenaje de regalo. |
| Crear un pago de compromiso |
Crea un nuevo pago de compromiso. |
| Crear un regalo |
Crea un nuevo regalo. |
| Crear un regalo de stock |
Crea un nuevo regalo de stock. |
| Crear una nota de regalo |
Crea una nueva nota de regalo. |
| Enumerar campos personalizados de regalo |
Enumera los campos personalizados de un regalo. |
| Enumerar cuotas de compromiso |
Enumera las cuotas de un compromiso. |
| Enumerar datos adjuntos de regalo |
Enumera los datos adjuntos de un regalo. |
| Enumerar declaraciones fiscales constituyentes |
Enumera las declaraciones fiscales de Gift Aid para un constituyente (solo aplicable para las versiones del Reino Unido). |
| Enumerar homenajes de regalo |
Enumera los homenajes por un regalo. |
| Enumerar los pagos de compromiso |
Enumera los pagos de un compromiso. |
| Enumerar lotes de regalo |
Enumerar los lotes de regalo. |
| Enumerar notas de regalo |
Enumera las notas de un regalo. |
| Enumerar reconocimientos de regalo |
Enumere los reconocimientos para un homenaje de regalo. |
| Enumerar regalos |
Devuelve una lista de regalos. |
| Obtención de la vigencia constituyente |
Devuelve el resumen de la duración de un componente. |
| Obtener el mejor regalo constituyente |
Devuelve el mayor don para un constituyente. |
| Obtener el primer regalo constituyente |
Devuelve el primer regalo para un constituyente. |
| Obtener el último regalo constituyente |
Devuelve el último regalo para un constituyente. |
| Obtener un regalo |
Devuelve información sobre un regalo. |
| Obtener un regalo por identificador de búsqueda |
Devuelve el identificador de registro del sistema de un regalo del identificador de búsqueda especificado. |
| Vender un regalo de stock |
Actualiza un regalo de stock para vender. |
Actualización de un homenaje de regalo
Actualiza un homenaje regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de homenaje de regalo
|
gift_tribute_id | True | integer |
Identificador de registro del sistema del homenaje de regalo que se va a actualizar. |
|
Tipo de tributo
|
tribute_type | integer |
El tipo de tributo. |
|
|
Estado de confirmación
|
acknowledge | string |
El tributo de regalo reconoce el estado. |
Actualización de un reconocimiento de homenaje de regalo
Actualiza un reconocimiento de regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de reconocimiento de homenaje de regalo
|
gift_tribute_acknowledgee_id | True | integer |
El identificador de registro del sistema del homenaje de regalo reconoce que se va a actualizar. |
|
Carta
|
letter | integer |
La carta enviada al reconocimiento. |
|
|
Fecha de letra
|
letter_date | date-time |
Fecha en la que se envió la carta. |
Actualizar datos adjuntos de regalo
Actualiza los datos adjuntos de un regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de datos adjuntos
|
attachment_id | True | string |
Identificador de registro del sistema de los datos adjuntos que se van a actualizar. |
|
Nombre
|
name | string |
El nombre de los datos adjuntos. Límite de caracteres: 150. |
|
|
Fecha
|
date | date-time |
La fecha de los datos adjuntos (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
Dirección URL de los datos adjuntos. Esto es necesario para los datos adjuntos de vínculo y no para los datos adjuntos físicos. |
|
|
Etiquetas
|
tags | array of string |
Etiquetas asociadas a los datos adjuntos. |
Actualizar detalles de confirmación de regalo
Actualiza los detalles de confirmación de un regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de confirmación
|
acknowledgement_id | True | string |
Identificador de registro del sistema de la confirmación de regalo que se va a actualizar. Usa el identificador del regalo primario como su valor. |
|
Estado
|
status | string |
Estado de la confirmación. Cuando el estado se establece en DoNotAcknowledge, la letra y la fecha deben ser null. Cuando el estado se establece en NeedsAcknowledgement, date debe ser NULL. |
|
|
Fecha
|
date | date-time |
Fecha asociada a la confirmación (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
Carta
|
letter | string |
Letra asociada a la confirmación. |
Actualizar los detalles del recibo de regalo
Actualiza los detalles del recibo de un regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de recepción
|
receipt_id | True | string |
Identificador de registro del sistema del recibo de regalo que se va a actualizar. Usa el identificador del regalo primario como su valor. |
|
Estado
|
status | string |
Estado de recepción del regalo. Cuando el estado se establece en NeedsReceipt o DoNotReceipt, la fecha de recepción debe ser null. |
|
|
Importe
|
value | double |
Importe del recibo. |
|
|
Fecha
|
date | date-time |
Fecha en el recibo (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
Number
|
number | integer |
Número del recibo. |
Actualizar un campo personalizado de regalo
Actualiza un campo personalizado de regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campo personalizado
|
custom_field_id | True | string |
Identificador de registro del sistema del campo personalizado que se va a actualizar. |
|
body
|
body | True | dynamic |
Objeto que representa las propiedades del campo personalizado que se va a actualizar. |
Actualizar una declaración fiscal constituyente
Actualiza una declaración tributaria constituyente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de declaración fiscal
|
tax_declaration_id | True | integer |
Identificador de registro del sistema de la declaración fiscal que se va a actualizar. |
|
Se inicia la declaración
|
declaration_starts | date-time |
Fecha en que se inicia la declaración fiscal (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
Finaliza la declaración
|
declaration_ends | date-time |
La fecha en que finaliza la declaración fiscal (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
Declaración realizada
|
declaration_made | date-time |
Fecha en que se realizó la declaración fiscal (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
Indicator
|
declaration_indicator | string |
Indicador de declaración. |
|
|
Fuente
|
declaration_source | string |
Origen de la declaración. |
|
|
Confirmación enviada
|
confirmation_sent | date-time |
Fecha en que se envió la confirmación (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
Confirmación devuelta
|
confirmation_returned | date-time |
Fecha en que se devolvió la confirmación (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
Paga impuestos
|
constituent_pays_tax | string |
Indica si el constituyente paga impuestos. |
|
|
Estado
|
tax_payer_status | string |
Estado del pagador fiscal. |
|
|
Comentarios
|
tax_notes | string |
Comentarios para la declaración fiscal. |
|
|
Sequence
|
sequence | integer |
Secuencia numérica asociada a la declaración fiscal. |
Actualizar una nota de regalo
Actualiza una nota de regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de nota
|
id | True | integer |
Identificador de registro del sistema de la nota que se va a actualizar. |
|
Tipo
|
note_type_id | integer |
Tipo de nota. |
|
|
Día
|
d | integer |
El día en la fecha aproximada. |
|
|
month
|
m | integer |
Mes en la fecha aproximada. |
|
|
año
|
y | integer |
Año en la fecha aproximada. |
|
|
Resumen
|
summary | string |
Resumen de la nota. Límite de caracteres: 255. |
|
|
Nota:
|
text | string |
Texto de la nota. |
|
|
Autor
|
author | string |
Autor de la nota. Límite de caracteres: 50. |
Agregar un regalo al lote
Agregue un regalo al lote de regalo especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Batch
|
batch_id | True | string |
Lote al que se agregará el regalo. |
|
Identificador constituyente
|
constituent_id | True | string |
Identificador de registro del sistema del componente asociado al regalo. |
|
Importe
|
value | True | double |
Cantidad del regalo. |
|
Fecha
|
date | True | date |
La fecha del regalo (por ejemplo: '2020-09-18'). |
|
Tipo
|
type | True | string |
Tipo de regalo. |
|
id. de campaña
|
campaign_id | string |
Identificador de registro del sistema de la campaña asociada a la división de regalos. |
|
|
id. de fondo
|
fund_id | True | string |
Identificador de registro del sistema del fondo asociado a la división de regalos. |
|
id. de apelación
|
appeal_id | string |
El identificador de registro del sistema del recurso asociado a la división de regalo. |
|
|
id. de paquete
|
package_id | string |
Identificador de registro del sistema del paquete asociado a la división de regalo. |
|
|
importe
|
value | True | double |
Cantidad de la división del regalo. |
|
Método de pago
|
payment_method | True | string |
Método de pago. |
|
Número de comprobación
|
check_number | string |
Número de cheque (solo aplicable cuando el método de pago es "PersonalCheck"). |
|
|
Día
|
d | integer |
El día en la fecha aproximada. |
|
|
month
|
m | integer |
Mes en la fecha aproximada. |
|
|
año
|
y | integer |
Año en la fecha aproximada. |
|
|
Referencia
|
reference | string |
Referencia de pago (solo aplicable cuando el método de pago es "Otro"). |
|
|
Día
|
d | integer |
El día en la fecha aproximada. |
|
|
month
|
m | integer |
Mes en la fecha aproximada. |
|
|
año
|
y | integer |
Año en la fecha aproximada. |
|
|
¿Es anónimo?
|
is_anonymous | boolean |
¿Es el regalo anónimo? Si no se proporciona ningún valor, se usará el anonimato predeterminado del donante. |
|
|
Subtipo
|
subtype | string |
Subtipo del regalo. |
|
|
Comentario
|
reference | string |
Notas para realizar un seguimiento de detalles especiales sobre un regalo, como la motivación subyacente o una descripción detallada de un regalo en especie. |
|
|
Identificador de búsqueda
|
lookup_id | string |
Identificador definido por el usuario para el regalo. |
|
|
¿Usa créditos de recaudación de fondos?
|
default_fundraiser_credits | boolean |
¿Usa los créditos predeterminados de recaudación de fondos? |
|
|
¿Usa créditos blandos?
|
default_soft_credits | boolean |
¿Usa los créditos blandos predeterminados? |
|
|
Distrito electoral
|
constituency | string |
La circunscripción del don. |
|
|
Estado posterior
|
post_status | string |
El estado del envío del regalo. |
|
|
Fecha de publicación
|
post_date | date |
La fecha en que se publicó el regalo (por ejemplo: '2020-09-18'). |
|
|
Estado de recepción
|
status | True | string |
Estado de recepción del regalo. |
|
Importe de recibo
|
value | True | double |
El importe del recibo del regalo. |
|
Fecha de recepción
|
date | date |
Fecha en que se recibió el regalo (por ejemplo: '2020-09-18'). |
Devoluciones
Contiene una colección de registros de errores de regalo por lotes y los regalos por lotes que agregó la operación.
- Results
- GiftApi.BatchGiftAddResults
Creación de un compromiso
Crea un nuevo compromiso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador constituyente
|
id | True | string |
Identificador de registro del sistema del constituyente. |
|
Importe
|
value | True | double |
Cantidad de la promesa. |
|
Fecha
|
gift_date | True | date |
Fecha de la promesa (por ejemplo: "2020-09-18"). |
|
Frecuencia
|
frequency | True | string |
La frecuencia de entrega del compromiso. |
|
Número de cuotas
|
number_of_installments | True | integer |
Número de cuotas para el compromiso. |
|
Fecha de inicio
|
start_date | True | date |
Fecha en que se inicia la programación del compromiso. |
|
importe
|
value | True | double |
Cantidad de la división del regalo. |
|
id. de fondo
|
fund_id | True | string |
Identificador de registro del sistema del fondo asociado a la división de regalos. |
|
id. de campaña
|
campaign_id | string |
Identificador de registro del sistema de la campaña asociada a la división de regalos. |
|
|
id. de apelación
|
appeal_id | string |
El identificador de registro del sistema del recurso asociado a la división de regalo. |
|
|
id. de paquete
|
package_id | string |
Identificador de registro del sistema del paquete asociado a la división de regalo. |
|
|
Método de pago
|
method | True | string |
Método de pago. |
|
Número de comprobación
|
check_number | string |
Número de comprobación. |
|
|
Referencia
|
reference_number | string |
Referencia de pago (solo aplicable cuando el método de pago es "Otro"). |
|
|
¿Envía un aviso?
|
send_reminder | boolean |
¿Envía recordatorios de promesas? |
|
|
¿Es anónimo?
|
anonymous | boolean |
¿Es el regalo anónimo? Si no se proporciona ningún valor, se usará el anonimato predeterminado del donante. |
|
|
Subtipo
|
name | string |
Subtipo del regalo. |
|
|
Comentario
|
comments | string |
Notas para realizar un seguimiento de detalles especiales sobre un regalo, como la motivación detrás de él. |
|
|
Identificador de búsqueda
|
lookup_id | string |
Identificador definido por el usuario para el regalo. |
|
|
Código de regalo
|
value | string |
Código de regalo asociado al regalo. |
|
|
Distrito electoral
|
value | string |
La circunscripción del don. |
|
|
Estado posterior
|
gift_post_status | string |
El estado del envío del regalo. |
|
|
Fecha de publicación
|
gift_post_date | date |
La fecha en que se publicará el regalo (por ejemplo: '2020-09-18'). |
|
|
Estado
|
gift_status | string |
El estado de la promesa. |
|
|
Día
|
d | integer |
El día en la fecha aproximada. |
|
|
month
|
m | integer |
Mes en la fecha aproximada. |
|
|
año
|
y | integer |
Año en la fecha aproximada. |
|
|
Estado de recepción
|
receipt_status | True | string |
Estado de recepción del regalo. |
|
Importe de recibo
|
value | True | double |
El importe del recibo del regalo. |
|
Fecha de recepción
|
receipt_date | date |
Fecha en que se recibió el regalo (por ejemplo: '2020-09-18'). |
|
|
Número de recibo
|
receipt_number | integer |
Número de recibo. |
|
|
Pila de recibos
|
value | string |
Pila de recibos. |
|
|
Estado de confirmación
|
status | True | string |
Estado de confirmación del regalo. |
|
Fecha de confirmación
|
acknowledgement_date | date |
Fecha en que se reconoció el regalo (por ejemplo: '2020-09-18'). |
|
|
Carta
|
value | string |
Letra asociada a la confirmación. |
|
|
type
|
credit_type | True | string |
Tipo de crédito de reconocimiento. |
|
id. de destinatario
|
constituent_id | True | string |
Identificador de registro del sistema del destinatario del crédito de reconocimiento. |
|
importe
|
value | True | double |
Cantidad que se ha acreditado al destinatario. |
|
date
|
date | date |
La fecha de la entrega (por ejemplo: '2020-09-18'). |
|
|
importe
|
amount | double |
Cantidad de la cuota. |
Devoluciones
Regalo creado
- Body
- GiftApi.CreatedGift
Creación de un lote de regalo
Crea un nuevo lote de regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Description
|
batch_description | string |
Descripción del lote. |
|
|
Número esperado
|
expected_number | integer |
Número de regalos esperados en el lote. |
|
|
Total esperado
|
expected_batch_total | double |
Valor total de regalos en el lote. |
|
|
Número de lote
|
batch_number | string |
Identificador único específico del lote. |
Devoluciones
Lote de regalo creado
Creación de una declaración de impuestos constituyente
Crea una nueva declaración de impuestos de La Ayuda de Regalo para un constituyente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador constituyente
|
constituent_id | True | integer |
Identificador de registro del sistema del constituyente. |
|
Se inicia la declaración
|
declaration_starts | True | date-time |
Fecha en que se inicia la declaración fiscal (por ejemplo: '2020-09-18T04:13:56Z'). |
|
Finaliza la declaración
|
declaration_ends | date-time |
La fecha en que finaliza la declaración fiscal (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
Declaración realizada
|
declaration_made | date-time |
Fecha en que se realizó la declaración fiscal (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
Indicator
|
declaration_indicator | string |
Indicador de declaración. |
|
|
Fuente
|
declaration_source | string |
Origen de la declaración. |
|
|
Confirmación enviada
|
confirmation_sent | date-time |
Fecha en que se envió la confirmación (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
Confirmación devuelta
|
confirmation_returned | date-time |
Fecha en que se devolvió la confirmación (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
Paga impuestos
|
constituent_pays_tax | string |
Indica si el constituyente paga impuestos. |
|
|
Estado
|
tax_payer_status | string |
Estado del pagador fiscal. |
|
|
Comentarios
|
tax_notes | string |
Comentarios para la declaración fiscal. |
|
|
Sequence
|
sequence | integer |
Secuencia numérica asociada a la declaración fiscal. |
Devoluciones
Declaración fiscal creada
Crear datos adjuntos de regalo
Crea un nuevo archivo adjunto de regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de regalo
|
parent_id | True | string |
Identificador de registro del sistema del regalo asociado a los datos adjuntos. |
|
Tipo
|
type | True | string |
Tipo de datos adjuntos. Los datos adjuntos físicos se cargan archivos como imágenes, ARCHIVOS PDF o documentos de Word que se guardan localmente o en la red. Se almacenan y administran en el sistema. Los datos adjuntos de vínculo son vínculos a archivos como imágenes, entradas de blog o vídeos de YouTube que están en línea o en una cuenta de almacenamiento en la nube. Se almacenan y administran externamente. |
|
Nombre
|
name | string |
El nombre de los datos adjuntos. Límite de caracteres: 150. |
|
|
Fecha
|
date | date-time |
La fecha de los datos adjuntos (por ejemplo: '2020-09-18T04:13:56Z'). Este campo tiene como valor predeterminado la fecha y hora actuales si no se proporciona. |
|
|
URL
|
url | string |
Dirección URL de los datos adjuntos. Esto es necesario para los datos adjuntos de vínculo y no para los datos adjuntos físicos. |
|
|
Nombre del archivo
|
file_name | string |
El nombre del archivo. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
|
Id. de archivo
|
file_id | string |
Identificador del archivo. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
|
Id. de miniatura
|
thumbnail_id | string |
Identificador de la miniatura. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
|
Etiquetas
|
tags | array of string |
Etiquetas asociadas a los datos adjuntos. |
Devoluciones
Datos adjuntos de regalo creados
Crear un campo personalizado de regalo
Crea un nuevo campo personalizado de regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Objeto que representa el campo personalizado que se va a crear. |
Devoluciones
Campo personalizado de regalo creado
Crear un homenaje de regalo
Crea un nuevo homenaje de regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de regalo
|
gift_id | True | integer |
El identificador de registro del sistema del regalo asociado al homenaje de regalo. |
|
Id. de tributo
|
tribute_id | True | integer |
El identificador de registro del sistema del tributo asociado con el homenaje de regalo. |
Devoluciones
Homenaje de regalo creado
Crear un pago de compromiso
Crea un nuevo pago de compromiso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador constituyente
|
id | True | string |
Identificador de registro del sistema del constituyente. |
|
Importe
|
value | True | double |
Importe del pago de la promesa. |
|
Fecha
|
gift_date | True | date |
Fecha de pago del compromiso (por ejemplo: '2020-09-18'). |
|
importe
|
value | True | double |
Cantidad de la división del regalo. |
|
id. de fondo
|
fund_id | True | string |
Identificador de registro del sistema del fondo asociado a la división de regalos. |
|
id. de campaña
|
campaign_id | string |
Identificador de registro del sistema de la campaña asociada a la división de regalos. |
|
|
id. de apelación
|
appeal_id | string |
El identificador de registro del sistema del recurso asociado a la división de regalo. |
|
|
id. de paquete
|
package_id | string |
Identificador de registro del sistema del paquete asociado a la división de regalo. |
|
|
Método de pago
|
method | True | string |
Método de pago. |
|
Número de comprobación
|
check_number | string |
Número de comprobación. |
|
|
Referencia
|
reference_number | string |
Referencia de pago (solo aplicable cuando el método de pago es "Otro"). |
|
|
¿Es anónimo?
|
anonymous | boolean |
¿Es el regalo anónimo? Si no se proporciona ningún valor, se usará el anonimato predeterminado del donante. |
|
|
prenda
|
pledge_id | string |
Identificador de registro del sistema del compromiso que se va a pagar. |
|
|
plazo
|
installment_id | string |
El identificador de registro del sistema de la cuota que se paga. |
|
|
importe
|
amount_applied | double |
Importe aplicado a la cuota. |
|
|
Subtipo
|
name | string |
Subtipo del regalo. |
|
|
Comentario
|
comments | string |
Notas para realizar un seguimiento de detalles especiales sobre un regalo, como la motivación detrás de él. |
|
|
Identificador de búsqueda
|
lookup_id | string |
Identificador definido por el usuario para el regalo. |
|
|
Código de regalo
|
value | string |
Código de regalo asociado al regalo. |
|
|
Distrito electoral
|
value | string |
La circunscripción del don. |
|
|
Estado posterior
|
gift_post_status | string |
El estado del envío del regalo. |
|
|
Fecha de publicación
|
gift_post_date | date |
La fecha en que se publicará el regalo (por ejemplo: '2020-09-18'). |
|
|
Estado de recepción
|
receipt_status | True | string |
Estado de recepción del regalo. |
|
Importe de recibo
|
value | True | double |
El importe del recibo del regalo. |
|
Fecha de recepción
|
receipt_date | date |
Fecha en que se recibió el regalo (por ejemplo: '2020-09-18'). |
|
|
Número de recibo
|
receipt_number | integer |
Número de recibo. |
|
|
Pila de recibos
|
value | string |
Pila de recibos. |
|
|
Estado de confirmación
|
status | True | string |
Estado de confirmación del regalo. |
|
Fecha de confirmación
|
acknowledgement_date | date |
Fecha en que se reconoció el regalo (por ejemplo: '2020-09-18'). |
|
|
Carta
|
value | string |
Letra asociada a la confirmación. |
|
|
type
|
credit_type | True | string |
Tipo de crédito de reconocimiento. |
|
id. de destinatario
|
constituent_id | True | string |
Identificador de registro del sistema del destinatario del crédito de reconocimiento. |
|
importe
|
value | True | double |
Cantidad que se ha acreditado al destinatario. |
Devoluciones
Regalo creado
- Body
- GiftApi.CreatedGift
Crear un regalo
Crea un nuevo regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador constituyente
|
constituent_id | True | string |
Identificador de registro del sistema del componente asociado al regalo. |
|
Importe
|
value | True | double |
Cantidad del regalo. |
|
Fecha
|
date | True | date |
La fecha del regalo (por ejemplo: '2020-09-18'). |
|
Tipo
|
type | True | string |
Tipo de regalo. |
|
id. de campaña
|
campaign_id | string |
Identificador de registro del sistema de la campaña asociada a la división de regalos. |
|
|
id. de fondo
|
fund_id | True | string |
Identificador de registro del sistema del fondo asociado a la división de regalos. |
|
id. de apelación
|
appeal_id | string |
El identificador de registro del sistema del recurso asociado a la división de regalo. |
|
|
id. de paquete
|
package_id | string |
Identificador de registro del sistema del paquete asociado a la división de regalo. |
|
|
importe
|
value | True | double |
Cantidad de la división del regalo. |
|
Método de pago
|
payment_method | True | string |
Método de pago. |
|
Número de comprobación
|
check_number | string |
Número de cheque (solo aplicable cuando el método de pago es "PersonalCheck"). |
|
|
Día
|
d | integer |
El día en la fecha aproximada. |
|
|
month
|
m | integer |
Mes en la fecha aproximada. |
|
|
año
|
y | integer |
Año en la fecha aproximada. |
|
|
Referencia
|
reference | string |
Referencia de pago (solo aplicable cuando el método de pago es "Otro"). |
|
|
Día
|
d | integer |
El día en la fecha aproximada. |
|
|
month
|
m | integer |
Mes en la fecha aproximada. |
|
|
año
|
y | integer |
Año en la fecha aproximada. |
|
|
¿Es anónimo?
|
is_anonymous | boolean |
¿Es el regalo anónimo? Si no se proporciona ningún valor, se usará el anonimato predeterminado del donante. |
|
|
Subtipo
|
subtype | string |
Subtipo del regalo. |
|
|
Comentario
|
reference | string |
Notas para realizar un seguimiento de detalles especiales sobre un regalo, como la motivación subyacente o una descripción detallada de un regalo en especie. |
|
|
Identificador de búsqueda
|
lookup_id | string |
Identificador definido por el usuario para el regalo. |
|
|
¿Usa créditos de recaudación de fondos?
|
default_fundraiser_credits | boolean |
¿Usa los créditos predeterminados de recaudación de fondos? |
|
|
¿Usa créditos blandos?
|
default_soft_credits | boolean |
¿Usa los créditos blandos predeterminados? |
|
|
Distrito electoral
|
constituency | string |
La circunscripción del don. |
|
|
Prefijo por lotes
|
batch_prefix | string |
Prefijo que se va a usar para regalos por lotes. Esto debe incluir al menos una letra y es necesaria cuando "Número de lote" tiene un valor. |
|
|
Número de lote
|
batch_number | string |
Número de lote. Límite de caracteres: 50 (incluido el prefijo por lotes). |
|
|
Estado posterior
|
post_status | string |
El estado del envío del regalo. |
|
|
Fecha de publicación
|
post_date | date |
La fecha en que se publicó el regalo (por ejemplo: '2020-09-18'). |
|
|
Estado de recepción
|
status | True | string |
Estado de recepción del regalo. |
|
Importe de recibo
|
value | True | double |
El importe del recibo del regalo. |
|
Fecha de recepción
|
date | date |
Fecha en que se recibió el regalo (por ejemplo: '2020-09-18'). |
Devoluciones
Regalo creado
- Body
- GiftApi.CreatedGift
Crear un regalo de stock
Crea un nuevo regalo de stock.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador constituyente
|
id | True | string |
Identificador de registro del sistema del constituyente. |
|
Importe
|
value | True | double |
Cantidad del regalo. |
|
Fecha
|
gift_date | True | date |
La fecha del regalo (por ejemplo: '2020-09-18'). |
|
Emisor
|
issuer | string |
Emisor de acciones. |
|
|
Símbolo del emisor
|
symbol | string |
Símbolo del emisor de existencias. |
|
|
Número de unidades
|
units | integer |
Número de unidades de stock. |
|
|
Precio medio por unidad
|
unit_price | double |
Precio medio por unidad. |
|
|
importe
|
value | True | double |
Cantidad de la división del regalo. |
|
id. de fondo
|
fund_id | True | string |
Identificador de registro del sistema del fondo asociado a la división de regalos. |
|
id. de campaña
|
campaign_id | string |
Identificador de registro del sistema de la campaña asociada a la división de regalos. |
|
|
id. de apelación
|
appeal_id | string |
El identificador de registro del sistema del recurso asociado a la división de regalo. |
|
|
id. de paquete
|
package_id | string |
Identificador de registro del sistema del paquete asociado a la división de regalo. |
|
|
Método de pago
|
method | True | string |
Método de pago. |
|
Número de comprobación
|
check_number | string |
Número de comprobación. |
|
|
Referencia
|
reference_number | string |
Referencia de pago (solo aplicable cuando el método de pago es "Otro"). |
|
|
¿Es anónimo?
|
anonymous | boolean |
¿Es el regalo anónimo? Si no se proporciona ningún valor, se usará el anonimato predeterminado del donante. |
|
|
Subtipo
|
name | string |
Subtipo del regalo. |
|
|
Comentario
|
comments | string |
Notas para realizar un seguimiento de detalles especiales sobre un regalo, como la motivación detrás de él. |
|
|
Identificador de búsqueda
|
lookup_id | string |
Identificador definido por el usuario para el regalo. |
|
|
Código de regalo
|
value | string |
Código de regalo asociado al regalo. |
|
|
Distrito electoral
|
value | string |
La circunscripción del don. |
|
|
Estado posterior
|
gift_post_status | string |
El estado del envío del regalo. |
|
|
Fecha de publicación
|
gift_post_date | date |
La fecha en que se publicará el regalo (por ejemplo: '2020-09-18'). |
|
|
Estado de recepción
|
receipt_status | True | string |
Estado de recepción del regalo. |
|
Importe de recibo
|
value | True | double |
El importe del recibo del regalo. |
|
Fecha de recepción
|
receipt_date | date |
Fecha en que se recibió el regalo (por ejemplo: '2020-09-18'). |
|
|
Número de recibo
|
receipt_number | integer |
Número de recibo. |
|
|
Pila de recibos
|
value | string |
Pila de recibos. |
|
|
Estado de confirmación
|
status | True | string |
Estado de confirmación del regalo. |
|
Fecha de confirmación
|
acknowledgement_date | date |
Fecha en que se reconoció el regalo (por ejemplo: '2020-09-18'). |
|
|
Carta
|
value | string |
Letra asociada a la confirmación. |
|
|
type
|
credit_type | True | string |
Tipo de crédito de reconocimiento. |
|
id. de destinatario
|
constituent_id | True | string |
Identificador de registro del sistema del destinatario del crédito de reconocimiento. |
|
importe
|
value | True | double |
Cantidad que se ha acreditado al destinatario. |
Devoluciones
Regalo creado
- Body
- GiftApi.CreatedGift
Crear una nota de regalo
Crea una nueva nota de regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de regalo
|
gift_id | True | integer |
Identificador de registro del sistema del regalo asociado a la nota. |
|
Tipo
|
note_type_id | True | integer |
Tipo de nota. |
|
Día
|
d | integer |
El día en la fecha aproximada. |
|
|
month
|
m | integer |
Mes en la fecha aproximada. |
|
|
año
|
y | integer |
Año en la fecha aproximada. |
|
|
Resumen
|
summary | string |
Resumen de la nota. Límite de caracteres: 255. |
|
|
Nota:
|
text | string |
Texto de la nota. |
|
|
Autor
|
author | string |
Autor de la nota. Límite de caracteres: 50. |
Devoluciones
Nota creada
Enumerar campos personalizados de regalo
Enumera los campos personalizados de un regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de regalo
|
gift_id | True | string |
Identificador de registro del sistema del regalo. |
Devoluciones
Campos personalizados
Enumerar cuotas de compromiso
Enumera las cuotas de un compromiso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de compromiso
|
gift_id | True | string |
Identificador de registro del sistema del compromiso. |
Devoluciones
Cuotas
Enumerar datos adjuntos de regalo
Enumera los datos adjuntos de un regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de regalo
|
gift_id | True | string |
Identificador de registro del sistema del regalo. |
Devoluciones
Attachments
Enumerar declaraciones fiscales constituyentes
Enumera las declaraciones fiscales de Gift Aid para un constituyente (solo aplicable para las versiones del Reino Unido).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador constituyente
|
constituent_id | True | integer |
Identificador de registro del sistema del constituyente. |
|
Limit
|
limit | integer |
Representa el número de registros que se van a devolver. El valor predeterminado es 500. No hay ningún máximo. |
|
|
Desplazar
|
offset | integer |
Representa el número de registros que se van a omitir. Para su uso con paginación. |
Devoluciones
Declaraciones fiscales
Enumerar homenajes de regalo
Enumera los homenajes por un regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de regalo
|
gift_id | True | integer |
Identificador de registro del sistema del regalo. |
Devoluciones
Homenajes de regalo
Enumerar los pagos de compromiso
Enumera los pagos de un compromiso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de compromiso
|
gift_id | True | string |
Identificador de registro del sistema del compromiso. |
Devoluciones
Payments
Enumerar lotes de regalo
Enumerar los lotes de regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Número de lote
|
batch_number | string |
Representa un filtro para los resultados que coinciden con el número especificado. |
|
|
¿Aprobado?
|
approved | boolean |
Representa un filtro para el estado del lote de regalo. |
|
|
¿Tiene excepciones?
|
has_exceptions | boolean |
Representa un filtro para si el lote de regalo contiene excepciones. |
|
|
Limit
|
limit | integer |
Representa el número de registros que se van a devolver. El valor predeterminado es 500. El máximo es 5000. |
|
|
Desplazar
|
offset | integer |
Representa el número de registros que se van a omitir. Para su uso con paginación. |
|
|
Buscar texto
|
search_text | string |
Representa un filtro para el texto incluido en los campos de descripción del lote o número de lote. |
|
|
Creado por
|
created_by | string |
Representa un filtro para lotes de regalo creados por el usuario especificado. |
Devoluciones
Lotes de regalo
Enumerar notas de regalo
Enumera las notas de un regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de regalo
|
gift_id | True | integer |
Identificador de registro del sistema del regalo. |
|
Limit
|
limit | integer |
Representa el número de registros que se van a devolver. |
|
|
Desplazar
|
offset | integer |
Representa el número de registros que se van a omitir. Para su uso con paginación. |
Devoluciones
Notas de regalo
Enumerar reconocimientos de regalo
Enumere los reconocimientos para un homenaje de regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de homenaje de regalo
|
gift_tribute_id | True | integer |
El identificador de registro del sistema del homenaje de regalo. |
Devoluciones
Reconocimientos de homenaje de regalo
Enumerar regalos
Devuelve una lista de regalos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
List
|
list_id | string |
Define un identificador de lista usado para filtrar el conjunto de regalos a los incluidos en la lista especificada. Si se establece este valor, se omitirán otros filtros especificados. |
|
|
Tipo
|
gift_type | string |
Representa una lista separada por comas de tipos de regalo para filtrar los resultados. Por ejemplo, "MatchingGiftPledge,RecurringGift" devuelve solo regalos de tipo MatchingGiftPledge o RecurringGift. |
|
|
Identificador constituyente
|
constituent_id | string |
Representa una lista separada por comas de identificadores de registro del sistema constituyentes para filtrar los resultados. Por ejemplo, "280.1232" devuelve solo regalos de los 280 constituyentes o constituyentes 1232. |
|
|
Identificador de campaña
|
campaign_id | string |
Representa una lista separada por comas de identificadores de registro del sistema de campañas para filtrar los resultados. Por ejemplo, "506,918" devuelve solo regalos a campaña 506 o campaña 918. |
|
|
Id. del fondo
|
fund_id | string |
Representa una lista separada por comas de identificadores de registro del sistema de fondos para filtrar los resultados. Por ejemplo, "506,918" devuelve solo regalos para financiar 506 o fondo 918. |
|
|
Id. de apelación
|
appeal_id | string |
Representa una lista separada por comas de identificadores de registro del sistema de apelación para filtrar los resultados. Por ejemplo, "506,918" devuelve solo regalos para apelación 506 o apelación 918. |
|
|
Limit
|
limit | integer |
Representa el número de registros que se van a devolver. El valor predeterminado es 500. El máximo es 5000. |
|
|
Desplazar
|
offset | integer |
Representa el número de registros que se van a omitir. Para su uso con paginación. |
|
|
Fecha de inicio del regalo
|
start_gift_date | date-time |
Representa un filtro para regalos con una fecha de regalo en o después de la fecha especificada (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
Fecha de fin del regalo
|
end_gift_date | date-time |
Representa un filtro para regalos con una fecha de regalo en o antes de la fecha especificada (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
Importe del regalo de inicio
|
start_gift_amount | double |
Representa un filtro para regalos con una cantidad mayor o igual que la cantidad especificada. |
|
|
Importe final del regalo
|
end_gift_amount | double |
Representa un filtro para regalos con una cantidad menor o igual que la cantidad especificada. |
|
|
Estado posterior
|
post_status | string |
Representa una lista separada por comas de estados de envío de regalo para filtrar los resultados. Por ejemplo, "DoNotPost, Posted" devuelve solo los regalos marcados como DoNotPost o Posted. |
|
|
Estado de recepción
|
receipt_status | string |
Representa una lista separada por comas de estados de recibo de regalo para filtrar los resultados. Por ejemplo, "DoNotReceipt, Receipted" devuelve solo los regalos marcados como DoNotReceipt o Receipted. |
|
|
Estado de confirmación
|
acknowledgement_status | string |
Representa una lista separada por comas de estados de confirmación de regalo para filtrar los resultados. Por ejemplo, "DoNotAcknowledge, Acknowledged" devuelve solo los regalos marcados como DoNotAcknowledge o Acknowledged. |
|
|
Ordenado por
|
sort | string |
Representa una lista de campos por los que ordenar los resultados. Los resultados están en orden ascendente de forma predeterminada y un signo "-" indica el orden descendente. Por ejemplo, "date_added,-date" ordena los regalos por el campo "date_added" en orden ascendente y, a continuación, por el campo "fecha de regalo" en orden descendente. Si solo se proporciona el campo date_modified o solo el campo date_added, esto agrega el parámetro sort_token a la dirección URL de next_link para asegurarse de que los regalos están ordenados de forma estable. |
|
|
Agregado en o después
|
date_added | date-time |
Filtre los resultados a los regalos creados en o después de la fecha especificada (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
Modificado en o después
|
last_modified | date-time |
Filtre los resultados a regalos modificados en o después de la fecha especificada (por ejemplo: '2020-09-18T04:13:56Z'). |
Devoluciones
Regalos
Obtención de la vigencia constituyente
Devuelve el resumen de la duración de un componente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador constituyente
|
constituent_id | True | string |
Identificador de registro del sistema del constituyente. |
Devoluciones
Concesión de duración
Obtener el mejor regalo constituyente
Devuelve el mayor don para un constituyente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador constituyente
|
constituent_id | True | string |
Identificador de registro del sistema del constituyente. |
Devoluciones
Dar resumen
Obtener el primer regalo constituyente
Devuelve el primer regalo para un constituyente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador constituyente
|
constituent_id | True | string |
Identificador de registro del sistema del constituyente. |
Devoluciones
Dar resumen
Obtener el último regalo constituyente
Devuelve el último regalo para un constituyente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador constituyente
|
constituent_id | True | string |
Identificador de registro del sistema del constituyente. |
Devoluciones
Dar resumen
Obtener un regalo
Devuelve información sobre un regalo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de regalo
|
gift_id | True | string |
Identificador de registro del sistema del regalo que se va a obtener. |
Devoluciones
Regalo
- Body
- GiftApi.GiftRead
Obtener un regalo por identificador de búsqueda
Devuelve el identificador de registro del sistema de un regalo del identificador de búsqueda especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de búsqueda
|
giftlookupid | True | string |
Identificador de búsqueda de regalo. |
Devoluciones
Mapa de id. de regalo
Vender un regalo de stock
Actualiza un regalo de stock para vender.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de regalo
|
gift_id | True | string |
Identificador de registro del sistema del regalo de stock que se va a vender. |
|
Fecha de venta
|
stock_sale_date | True | date |
La fecha en que se vendió el stock (por ejemplo: '2005-09-18'). |
|
Valor de venta
|
stock_sale_value | True | double |
Valor de la venta de acciones. |
|
Cuota de agente
|
broker_fee | double |
Cuota de agente de bolsa vendida. |
|
|
Estado posterior
|
post_status | string |
El estado del envío del regalo vendido. |
|
|
Fecha de publicación
|
post_date | date |
Fecha de publicación de la acción vendida (por ejemplo: '2020-09-18'). |
|
|
Notas
|
notes | string |
Las notas de las existencias vendidas. Límite de caracteres: 255. |
|
|
Emisor
|
issuer | string |
Emisor de acciones. |
|
|
Símbolo del emisor
|
symbol | string |
Símbolo del emisor de existencias. |
|
|
Número de unidades
|
units | integer |
Número de unidades vendidas. |
|
|
Precio medio por unidad
|
unit_price | double |
Precio medio por unidad vendida. |
Definiciones
ConstituentApi.AppealRead
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
El identificador de registro del sistema del recurso. |
|
descripción
|
description | string |
Descripción del recurso. |
ConstituentApi.CampaignRead
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de registro del sistema de la campaña. |
|
descripción
|
description | string |
Descripción de la campaña. |
ConstituentApi.FundRead
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de registro del sistema del fondo. |
|
descripción
|
description | string |
Descripción del fondo. |
ConstituentApi.GivingSummaryRead
Dar resumen
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de registro del sistema del regalo. |
|
Tipo
|
type | string |
Tipo de regalo. |
|
Fecha
|
date | date-time |
La fecha del regalo. |
|
value
|
amount.value | double |
Cantidad del regalo. |
|
Appeal
|
appeals | array of ConstituentApi.AppealRead |
Conjunto de apelaciones asociadas al regalo. |
|
Campaña
|
campaigns | array of ConstituentApi.CampaignRead |
Conjunto de campañas asociadas al regalo. |
|
Fondo
|
funds | array of ConstituentApi.FundRead |
Conjunto de fondos asociados al regalo. |
ConstituentApi.LifetimeGivingRead
Concesión de duración
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Años consecutivos dados
|
consecutive_years_given | integer |
Número de años consecutivos que ha dado el constituyente. |
|
Total de años dados
|
total_years_given | integer |
Número total de años que ha dado el constituyente. |
|
value
|
total_giving.value | double |
Importe total proporcionado por el constituyente. |
|
value
|
total_pledge_balance.value | double |
Saldo total del compromiso no pagado para el constituyente. |
|
value
|
total_received_giving.value | double |
Importe total recibido proporcionado por el constituyente. |
|
value
|
total_committed_matching_gifts.value | double |
Este campo calculado calcula la cantidad total de compromisos de regalo coincidentes que se atribuyen al constituyente. |
|
value
|
total_received_matching_gifts.value | double |
El importe total de los pagos para las promesas de regalo correspondientes que se atribuyen al constituyente. |
|
value
|
total_soft_credits.value | double |
Importe total de créditos blandos aplicados al constituyente. |
GiftApi.AcknowledgementRead
Reconocimiento
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
date
|
date | date-time |
Fecha asociada a la confirmación. |
|
letra
|
letter | string |
Letra asociada a la confirmación. |
|
estado
|
status | string |
Estado de la confirmación. Los valores disponibles son: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT y DONOTACKNOWLEDGE. |
GiftApi.ApiCollectionOfGiftAttachmentRead
Attachments
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of GiftApi.GiftAttachmentRead |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
GiftApi.ApiCollectionOfGiftCustomFieldRead
Campos personalizados
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of GiftApi.GiftCustomFieldRead |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
GiftApi.ApiCollectionOfGiftRead
Regalos
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of GiftApi.GiftRead |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
GiftApi.BatchGiftAddResults
Contiene una colección de registros de errores de regalo por lotes y los regalos por lotes que agregó la operación.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Errores
|
errors | array of GiftApi.GiftBatchGiftError |
Errores de regalo por lotes asociados a la operación de adición de regalo por lotes |
|
Regalos
|
gifts | array of GiftApi.BatchGiftRead |
La colección de regalos por lotes que agregó la operación de adición de regalos por lotes |
GiftApi.GiftBatchGiftError
Representa excepciones que impiden que se agreguen elementos al lote.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
campo afectado
|
affected_field | string |
Campo afectado por el error |
|
identificador de lote
|
batch_id | string |
Identificador de registro del sistema del lote |
|
código de error de excepción
|
exception_error_code | integer |
El código de error de excepción |
|
mensaje de error de excepción
|
exception_error_message | string |
Mensaje de error de excepción |
|
nombre del error de excepción
|
exception_error_name | string |
Nombre del error de excepción |
|
id. de regalo
|
gift_id | string |
Identificador de registro del sistema del regalo |
|
identificador de búsqueda
|
lookup_id | string |
Identificador definido por el usuario para el regalo. |
GiftApi.BatchGiftRead
Regalo por lotes
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificador de lote
|
batch_id | string |
Identificador del lote al que se agregó el regalo. |
|
Errores
|
errors | array of GiftApi.GiftBatchGiftError |
Errores asociados al regalo por lotes. |
|
identificación
|
id | string |
Identificador de registro del sistema del regalo por lotes. |
|
identificador constituyente
|
constituent_id | string |
Identificador de registro del sistema del componente asociado al regalo. |
|
type
|
type | string |
Tipo de regalo. |
|
subtipo
|
subtype | string |
Subtipo del regalo. |
|
date
|
date | date-time |
La fecha del regalo. |
|
value
|
amount.value | double |
Cantidad del regalo. |
|
value
|
balance.value | double |
El saldo restante en el regalo. |
|
número de lote
|
batch_number | string |
Número de lote asociado a este regalo. |
|
estado
|
gift_status | string |
El estado del regalo. |
|
¿anónimo?
|
is_anonymous | boolean |
¿Es el regalo anónimo? |
|
distrito electoral
|
constituency | string |
La circunscripción del don. |
|
identificador de búsqueda
|
lookup_id | string |
Identificador definido por el usuario para el regalo. |
|
origin
|
origin | string |
El origen del regalo. |
|
estado posterior
|
post_status | string |
Estado del libro de contabilidad general del regalo. Los valores disponibles son Posted, NotPosted y DoNotPost. Cuando post_status se establece en DoNotPost>, post_date debe ser null. Cuando se establece en NotPosted, se requiere post_date, pero permanece editable. Cuando se establece en Publicado, se requiere post_date y ya no se puede editar. |
|
fecha de publicación
|
post_date | date-time |
Fecha en que el regalo fue enviado al libro de contabilidad general. |
|
referencia
|
reference | string |
Notas para realizar un seguimiento de detalles especiales sobre un regalo, como la motivación subyacente o una descripción detallada de un regalo en especie. |
|
Día
|
recurring_gift_status_date.d | integer |
El día en la fecha aproximada. |
|
month
|
recurring_gift_status_date.m | integer |
Mes en la fecha aproximada. |
|
año
|
recurring_gift_status_date.y | integer |
Año en la fecha aproximada. |
|
frequency
|
recurring_gift_schedule.frequency | string |
Frecuencia de entrega del regalo recurrente que se va a ver. Los valores disponibles son WEEKLY, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONTHLY, QUARTERLY, ANUALMENTE. |
|
start
|
recurring_gift_schedule.start_date | date-time |
Fecha de inicio del regalo periódico. |
|
end
|
recurring_gift_schedule.end_date | date-time |
Fecha en que el regalo recurrente debe terminar. |
|
value
|
gift_aid_amount.value | double |
Este campo calculado calcula la cantidad total de impuestos reclamados de la ayuda de regalo en todos los gift_splits para este regalo. Sólo para el Reino Unido. |
|
estado de calificación de la ayuda de regalo
|
gift_aid_qualification_status | string |
Este campo calculado determina el estado de calificación de la ayuda de regalo en función de la información de declaración fiscal y el formato de la base de datos. Los valores disponibles son: Qualified, NotQualified y ParcialmenteQualified. Sólo para el Reino Unido. |
|
código de regalo
|
gift_code | string |
Valor del código de regalo asociado al regalo. |
|
divisiones de regalo
|
gift_splits | array of GiftApi.GiftSplitRead |
Conjunto de divisiones de regalo asociadas al regalo. |
|
recaudación de fondos
|
fundraisers | array of GiftApi.GiftFundraiserRead |
El conjunto de recaudadores de fondos que reciben crédito por el regalo. |
|
Créditos blandos
|
soft_credits | array of GiftApi.SoftCreditRead |
Conjunto de créditos blandos asociados al regalo. |
|
Ingresos
|
receipts | array of GiftApi.ReceiptRead |
Conjunto de recibos asociados al regalo. |
|
Reconocimientos
|
acknowledgements | array of GiftApi.AcknowledgementRead |
Conjunto de confirmaciones asociadas al regalo. |
|
Payments
|
payments | array of GiftApi.PaymentRead |
Los pagos del regalo. |
|
Regalos vinculados
|
linked_gifts | array of string |
Identificadores de otros regalos que están vinculados a este regalo. |
|
Fecha de adición
|
date_added | date-time |
Fecha en que se creó el regalo. |
|
Fecha de modificación
|
date_modified | date-time |
Fecha en la que se modificó por última vez el regalo. |
GiftApi.CreatedGift
Regalo creado
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador del regalo recién creado. |
GiftApi.CreatedGiftAttachment
Datos adjuntos de regalo creados
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de los datos adjuntos de regalo recién creados. |
GiftApi.CreatedGiftCustomField
Campo personalizado de regalo creado
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador del campo personalizado de regalo recién creado. |
GiftApi.GiftAttachmentRead
Archivo adjunto
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de registro del sistema de los datos adjuntos. |
|
Id. de regalo
|
parent_id | string |
Identificador de registro del sistema del regalo asociado a los datos adjuntos. |
|
Tipo
|
type | string |
Tipo de datos adjuntos. Los datos adjuntos físicos se cargan archivos como imágenes, ARCHIVOS PDF o documentos de Word que se guardan localmente o en la red. Se almacenan y administran en el sistema. Los datos adjuntos de vínculo son vínculos a archivos como imágenes, entradas de blog o vídeos de YouTube que están en línea o en una cuenta de almacenamiento en la nube. Se almacenan y administran externamente. |
|
Nombre
|
name | string |
El nombre de los datos adjuntos. Límite de caracteres: 150. |
|
Fecha
|
date | date-time |
Fecha de los datos adjuntos. |
|
URL
|
url | string |
Dirección URL de los datos adjuntos. Esto es necesario para los datos adjuntos de vínculo y no para los datos adjuntos físicos. |
|
Nombre del archivo
|
file_name | string |
El nombre del archivo. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
Id. de archivo
|
file_id | string |
Identificador del archivo. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
Id. de miniatura
|
thumbnail_id | string |
Identificador de la miniatura. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
Url de miniatura
|
thumbnail_url | string |
Dirección URL de una miniatura. Solo para los datos adjuntos físicos que son imágenes. Contiene una firma enlazada a tiempo que limita el acceso a 60 minutos. |
|
Tipo de contenido
|
content_type | string |
Tipo de contenido. Solo para datos adjuntos físicos. |
|
Tamaño de archivo
|
file_size | integer |
Tamaño del archivo en bytes. Solo para datos adjuntos físicos. |
|
Etiquetas
|
tags | array of string |
Etiquetas asociadas a los datos adjuntos. |
GiftApi.GiftCustomFieldRead
Campo personalizado
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de registro del sistema del campo personalizado. |
|
Id. de regalo
|
parent_id | string |
Identificador de registro del sistema del regalo asociado al campo personalizado. |
|
Categoría
|
category | string |
Categoría de campo personalizado. |
|
Tipo
|
type | string |
Tipo de datos que representa el campo personalizado. |
|
Importancia
|
value |
Valor del campo personalizado. |
|
|
Valor de texto
|
text_value | string |
Valor de texto del campo personalizado. |
|
Valor de número
|
number_value | integer |
Valor numérico del campo personalizado. |
|
Valor de fecha
|
date_value | date |
Valor de fecha del campo personalizado. |
|
Valor de moneda
|
currency_value | double |
Valor de moneda del campo personalizado. |
|
Valor booleano
|
boolean_value | boolean |
Valor booleano del campo personalizado. |
|
Valor de entrada de tabla
|
codetableentry_value | string |
Valor de entrada de tabla del campo personalizado. |
|
Valor de id. constituyente
|
constituentid_value | string |
Valor de identificador constituyente del campo personalizado. |
|
Día
|
fuzzydate_value.d | integer |
El día en la fecha aproximada. |
|
month
|
fuzzydate_value.m | integer |
Mes en la fecha aproximada. |
|
año
|
fuzzydate_value.y | integer |
Año en la fecha aproximada. |
|
Fecha
|
date | date |
Fecha en el campo personalizado. |
|
Comentario
|
comment | string |
Comentario en el campo personalizado. Límite de caracteres: 50. |
|
Fecha de adición
|
date_added | date-time |
Fecha en que se creó el campo personalizado. |
|
Fecha de modificación
|
date_modified | date-time |
Fecha en que se modificó por última vez el campo personalizado. |
GiftApi.GiftFundraiserRead
Recaudación de fondos de regalo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
amount.value | double |
El importe acreditado para la recaudación de fondos para el regalo. |
|
id. de recaudación de fondos
|
constituent_id | string |
El identificador de registro del sistema constituyente para el recaudador de fondos asociado al regalo. |
GiftApi.GiftRead
Regalo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de registro del sistema del regalo. |
|
Identificador constituyente
|
constituent_id | string |
Identificador de registro del sistema del componente asociado al regalo. |
|
Tipo
|
type | string |
Tipo de regalo. |
|
Subtipo
|
subtype | string |
Subtipo del regalo. |
|
Fecha
|
date | date-time |
La fecha del regalo. |
|
value
|
amount.value | double |
Cantidad del regalo. |
|
value
|
balance.value | double |
El saldo restante en el regalo. |
|
Número de lote
|
batch_number | string |
Número de lote asociado a este regalo. |
|
Estado
|
gift_status | string |
El estado del regalo. |
|
¿Anónimo?
|
is_anonymous | boolean |
¿Es el regalo anónimo? |
|
Distrito electoral
|
constituency | string |
La circunscripción del don. |
|
Identificador de búsqueda
|
lookup_id | string |
Identificador definido por el usuario para el regalo. |
|
Origen
|
origin | string |
El origen del regalo. |
|
Estado posterior
|
post_status | string |
Estado del libro de contabilidad general del regalo. Los valores disponibles son Posted, NotPosted y DoNotPost. Cuando post_status se establece en DoNotPost>, post_date debe ser null. Cuando se establece en NotPosted, se requiere post_date, pero permanece editable. Cuando se establece en Publicado, se requiere post_date y ya no se puede editar. |
|
Fecha de publicación
|
post_date | date-time |
Fecha en que el regalo fue enviado al libro de contabilidad general. |
|
Referencia
|
reference | string |
Notas para realizar un seguimiento de detalles especiales sobre un regalo, como la motivación subyacente o una descripción detallada de un regalo en especie. |
|
Día
|
recurring_gift_status_date.d | integer |
El día en la fecha aproximada. |
|
month
|
recurring_gift_status_date.m | integer |
Mes en la fecha aproximada. |
|
año
|
recurring_gift_status_date.y | integer |
Año en la fecha aproximada. |
|
frequency
|
recurring_gift_schedule.frequency | string |
Frecuencia de entrega del regalo recurrente que se va a ver. Los valores disponibles son WEEKLY, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONTHLY, QUARTERLY, ANUALMENTE. |
|
start
|
recurring_gift_schedule.start_date | date-time |
Fecha de inicio del regalo periódico. |
|
end
|
recurring_gift_schedule.end_date | date-time |
Fecha en que el regalo recurrente debe terminar. |
|
value
|
gift_aid_amount.value | double |
Este campo calculado calcula la cantidad total de impuestos reclamados de la ayuda de regalo en todos los gift_splits para este regalo. Sólo para el Reino Unido. |
|
Estado de calificación de ayuda de regalo
|
gift_aid_qualification_status | string |
Este campo calculado determina el estado de calificación de la ayuda de regalo en función de la información de declaración fiscal y el formato de la base de datos. Los valores disponibles son: Qualified, NotQualified y ParcialmenteQualified. Sólo para el Reino Unido. |
|
Código de regalo
|
gift_code | string |
Valor del código de regalo asociado al regalo. |
|
Divisiones de regalo
|
gift_splits | array of GiftApi.GiftSplitRead |
Conjunto de divisiones de regalo asociadas al regalo. |
|
Recaudadores de fondos
|
fundraisers | array of GiftApi.GiftFundraiserRead |
El conjunto de recaudadores de fondos que reciben crédito por el regalo. |
|
Créditos blandos
|
soft_credits | array of GiftApi.SoftCreditRead |
Conjunto de créditos blandos asociados al regalo. |
|
Ingresos
|
receipts | array of GiftApi.ReceiptRead |
Conjunto de recibos asociados al regalo. |
|
Reconocimientos
|
acknowledgements | array of GiftApi.AcknowledgementRead |
Conjunto de confirmaciones asociadas al regalo. |
|
Payments
|
payments | array of GiftApi.PaymentRead |
Los pagos del regalo. |
|
Regalos vinculados
|
linked_gifts | array of string |
Identificadores de otros regalos que están vinculados a este regalo. |
|
Fecha de adición
|
date_added | date-time |
Fecha en que se creó el regalo. |
|
Fecha de modificación
|
date_modified | date-time |
Fecha en la que se modificó por última vez el regalo. |
GiftApi.GiftSplitRead
División de regalo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de registro del sistema de la división de regalo. |
|
value
|
amount.value | double |
Cantidad de la división del regalo. |
|
id. de apelación
|
appeal_id | string |
El identificador de registro del sistema del recurso asociado a la división de regalo. |
|
id. de campaña
|
campaign_id | string |
Identificador de registro del sistema de la campaña asociada a la división de regalos. |
|
id. de fondo
|
fund_id | string |
Identificador de registro del sistema del fondo asociado a la división de regalos. |
|
value
|
gift_aid_amount.value | double |
La cantidad de impuestos reclamados de la ayuda de regalo para esta división de regalo. Sólo para el Reino Unido. |
|
estado de calificación de la ayuda de regalo
|
gift_aid_qualification_status | string |
El estado de calificación de la ayuda de regalo de la división del regalo. Los valores disponibles son: Qualified y NotQualified. Sólo para el Reino Unido. |
|
id. de paquete
|
package_id | string |
Identificador de registro del sistema del paquete asociado a la división de regalo. |
GiftApi.ReceiptRead
Recibo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
amount.value | double |
Cantidad del recibo. |
|
date
|
date | date-time |
Fecha en el recibo. |
|
number
|
number | integer |
Número del recibo. |
|
estado
|
status | string |
Estado del recibo. Los valores disponibles son: RECEIPTED, NEEDSRECEIPT y DONOTRECEIPT. |
GiftApi.PaymentRead
Pago
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
token de cuenta
|
account_token | string |
La información de la cuenta con token (por ejemplo: tarjeta de crédito) del proveedor de pagos externo. Solo se aplica a los métodos de pago de "CreditCard" y "DirectDebit". |
|
Identificador de configuración de BBPS
|
bbps_configuration_id | string |
Identificador de configuración de BBPS. Solo se aplica a los métodos de pago de "CreditCard" y "DirectDebit". |
|
Identificador de transacción de BBPS
|
bbps_transaction_id | string |
Identificador de transacción bbps. Solo se aplica a los métodos de pago de "CreditCard" y "DirectDebit". |
|
Día
|
check_date.d | integer |
El día en la fecha aproximada. |
|
month
|
check_date.m | integer |
Mes en la fecha aproximada. |
|
año
|
check_date.y | integer |
Año en la fecha aproximada. |
|
check number
|
check_number | string |
Número de comprobación. Solo se aplica al método de pago de "PersonalCheck". |
|
checkout transaction ID
|
checkout_transaction_id | string |
Identificador de transacción de desprotección. Solo se aplica a los métodos de pago de "CreditCard" y "DirectDebit". |
|
método de pago
|
payment_method | string |
Método de pago. Los valores disponibles se enumeran a continuación. |
|
referencia
|
reference | string |
Referencia. Solo se aplica al método de pago de "Otros". |
|
Día
|
reference_date.d | integer |
El día en la fecha aproximada. |
|
month
|
reference_date.m | integer |
Mes en la fecha aproximada. |
|
año
|
reference_date.y | integer |
Año en la fecha aproximada. |
GiftApi.SoftCreditRead
Crédito temporal
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de registro del sistema del crédito temporal. |
|
value
|
amount.value | double |
Cantidad del crédito blando. |
|
identificador constituyente
|
constituent_id | string |
Identificador de registro del sistema del componente asociado al crédito temporal. |
|
id. de regalo
|
gift_id | string |
Identificador de registro del sistema del regalo asociado al crédito blando. |
Gift2Api.PledgeInstallment
Representa el objeto de entrega.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
El identificador de registro del sistema de la entrega. |
|
date
|
date | date-time |
Fecha de la entrega. |
|
año
|
year | integer |
El año de la fecha de entrega. |
|
value
|
amount.value | double |
Cantidad de la cuota. |
|
equilibrar
|
balance | double |
Saldo de la cuota. |
|
saldo restante del compromiso
|
remaining_pledge_balance | double |
El saldo restante de la promesa. |
|
secuencia
|
sequence | integer |
Secuencia de orden de presentación de entregas. |
Gift2Api.PledgeInstallmentCollection
Cuotas
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Fecha de inicio
|
start_date | date-time |
Fecha en que comienza la programación del regalo. |
|
Frecuencia
|
frequency | string |
Frecuencia de la programación del regalo. |
|
Token de simultaneidad
|
concurrency_token | string |
Token de simultaneidad. |
|
Cuotas
|
installments | array of Gift2Api.PledgeInstallment |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
Gift2Api.PledgePayment
Representa el objeto de pago de promesa.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id. de cuota
|
installment_id | string |
El identificador de registro del sistema de la cuota que se paga. |
|
id. de regalo
|
payment_gift_id | string |
Identificador de registro del sistema del regalo de pago. |
|
value
|
amount_applied.value | double |
Importe aplicado a la cuota. |
Gift2Api.PledgePaymentCollection
Payments
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
pledge_payments
|
pledge_payments | array of Gift2Api.PledgePayment |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
GiftBatchApi.ApiCollectionOfGiftBatch
Lotes de regalo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número total de lotes de regalo en la respuesta. |
|
value
|
value | array of GiftBatchApi.GiftBatch |
Conjunto de elementos incluidos en la respuesta. |
GiftBatchApi.CreatedBatch
Lote de regalo creado
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
batch_id | string |
Identificador de registro del sistema del lote de regalo recién creado. |
GiftBatchApi.GiftBatch
Representa el objeto por lotes de regalo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de registro del sistema del lote. |
|
descripción
|
batch_description | string |
Descripción del lote. |
|
número de lote
|
batch_number | string |
Número de lote |
|
número proyectado
|
projected_number_of_gifts | integer |
Número proyectado de regalos en el lote. |
|
número real
|
number_of_gifts | integer |
Número real de regalos en el lote. |
|
cantidad proyectada
|
projected_amount | double |
Valor proyectado de regalos en el lote. |
|
cantidad real
|
actual_amount | double |
Valor real de los regalos del lote. |
|
¿tiene excepciones?
|
has_exceptions | boolean |
¿El lote tiene excepciones? |
|
¿aprobado?
|
is_approved | boolean |
¿Se aprueba el lote? |
|
Creado por
|
created_by | string |
Nombre del usuario que creó el lote. |
|
Fecha de creación
|
created_on | date-time |
Fecha en que se creó el lote. |
AUTOMATICDataIntegrationApi.CreatedGiftNote
Nota creada
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de la nota recién creada. |
AUTOMATICDataIntegrationApi.CreatedGiftTribute
Homenaje de regalo creado
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
El id. del homenaje de regalo recién creado. |
AUTOMATICDataIntegrationApi.CreatedTaxDeclaration
Declaración fiscal creada
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
El identificador de la declaración de impuestos recién creada. |
SSHDataIntegrationApi.GiftIdMap
Mapa de id. de regalo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
system_record_id | integer |
Identificador de registro del sistema de regalos. |
AUTOMATICDataIntegrationApi.GiftNote
Nota:
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de regalo
|
gift_id | integer |
Identificador de registro del sistema del regalo asociado a la nota. |
|
Tipo
|
type | string |
Tipo de nota. |
|
Día
|
date.d | integer |
El día en la fecha aproximada. |
|
month
|
date.m | integer |
Mes en la fecha aproximada. |
|
año
|
date.y | integer |
Año en la fecha aproximada. |
|
Resumen
|
summary | string |
Resumen de la nota. |
|
Nota:
|
text | string |
Texto de la nota. |
|
Autor
|
author | string |
Autor de la nota. |
AUTOMATICDataIntegrationApi.GiftNoteCollection
Notas de regalo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of NXTDataIntegrationApi.GiftNote |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
AUTOMATICDataIntegrationApi.GiftTribute
Homenaje de regalo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | integer |
El identificador de registro del sistema del homenaje de regalo. |
|
Id. de regalo
|
gift_id | integer |
Identificador de registro del sistema del regalo. |
|
Id. de tributo
|
tribute_id | integer |
Identificador de registro del sistema del homenaje. |
|
Tipo de tributo
|
tribute_type | integer |
El tipo de tributo. |
|
Estado de confirmación
|
acknowledge | string |
El tributo de regalo reconoce el estado. |
|
Sequence
|
sequence | integer |
La secuencia de homenaje de regalo. |
GALILEDataIntegrationApi.GiftTributeAcknowledgee
Un homenaje de regalo reconoce el registro en Raiser's Edge.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | integer |
El identificador de registro del sistema del reconocimiento del homenaje de regalo. |
|
Id. de homenaje de regalo
|
gift_tribute_id | integer |
El identificador de registro del sistema del homenaje de regalo. |
|
¿Es autoconsocuerdo?
|
self_acknowledge | boolean |
¿Esto reconoce a sí mismo? |
|
Id. de relaciones
|
relationships_id | integer |
Identificador de registro del sistema de la relación para el reconocimiento. |
|
Carta
|
letter | integer |
La carta enviada al reconocimiento. |
|
Fecha de letra
|
letter_date | date-time |
Fecha en la que se envió la carta. |
GALILEDataIntegrationApi.GiftTributeAcknowledgeeCollection
Reconocimientos de homenaje de regalo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of NXTDataIntegrationApi.GiftTributeAcknowledgee |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
GABADataIntegrationApi.GiftTributeCollection
Homenajes de regalo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of NXTDataIntegrationApi.GiftTribute |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
AUTOMATICDataIntegrationApi.TaxDeclaration
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
declaration_id | integer | |
|
Se inicia la declaración
|
declaration_starts | date-time |
Fecha en que se inicia la declaración fiscal. |
|
Finaliza la declaración
|
declaration_ends | date-time |
Fecha en que finaliza la declaración fiscal. |
|
Declaración realizada
|
declaration_made | date-time |
Fecha en que se realizó la declaración fiscal. |
|
Id. de indicador
|
declaration_indicator_id | integer |
Identificador del indicador de declaración. |
|
Indicator
|
declaration_indicator | string |
Indicador de declaración. |
|
Id. de origen
|
declaration_source_id | integer |
Identificador de origen de la declaración. |
|
Fuente
|
declaration_source | string |
Origen de la declaración. |
|
Confirmación enviada
|
confirmation_sent | date-time |
Fecha en que se envió la confirmación. |
|
Confirmación devuelta
|
confirmation_returned | date-time |
Fecha en que se devolvió la confirmación. |
|
Paga impuestos
|
constituent_pays_tax | string |
Indica si el constituyente paga impuestos. |
|
Id. de estado
|
tax_payer_status_id | integer |
Identificador de estado del pagador fiscal. |
|
Estado
|
tax_payer_status | string |
Estado del pagador fiscal. |
|
Comentarios
|
tax_notes | string |
Comentarios para la declaración fiscal. |
|
Sequence
|
sequence | integer |
Secuencia numérica asociada a la declaración fiscal. |
AUTOMATICDataIntegrationApi.TaxDeclarationCollection
Declaraciones fiscales
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of NXTDataIntegrationApi.TaxDeclaration |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |