Blackbaud Raisers Edge PREVIEW (versión preliminar)

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.

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 las entidades que se encuentran en The Raiser's Edge STORAGE, entre las que se incluyen:

Componentes
Regalos
Acciones
Notas
Campos personalizados
Campañas
Fondos
Apelaciones
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 a The Raiser's Edge STORAGE. 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	500	60 segundos

Acciones

Actualización de datos adjuntos de apelación	Actualiza los datos adjuntos de una apelación.
Actualización de un alias constituyente	Actualiza un alias constituyente.
Actualización de un campo personalizado constituyente	Actualiza un campo personalizado constituyente.
Actualización de un campo personalizado de apelación	Actualiza un campo personalizado de apelación.
Actualización de un código constituyente	Actualiza un código constituyente.
Actualización de un código de solicitud constituyente	Actualiza un código de solicitud constituyente.
Actualización de una educación constituyente	Actualiza una educación constituyente.
Actualización de una oportunidad	Actualiza una oportunidad.
Actualización de una relación constituyente	Actualiza una relación para un constituyente. Si existe una relación recíproca, también se modifica para reflejar los cambios. Esto no incluye cambios en la propiedad "comments", que es específica de cada registro y se puede modificar independientemente en cada registro.
Actualizar datos adjuntos constituyentes	Actualiza los datos adjuntos constituyentes.
Actualizar datos adjuntos de oportunidades	Actualiza los datos adjuntos de una oportunidad.
Actualizar datos adjuntos de regalo	Actualiza los datos adjuntos de un regalo.
Actualizar datos adjuntos de un fondo	Actualiza un fondo adjunto.
Actualizar datos adjuntos de una acción	Actualiza los datos adjuntos de una acción.
Actualizar datos adjuntos de una campaña	Actualiza los datos adjuntos de una campaña.
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 acción	Actualiza un campo personalizado de acción.
Actualizar un campo personalizado de campaña	Actualiza un campo personalizado de campaña.
Actualizar un campo personalizado de fondo	Actualiza un campo personalizado de fondo.
Actualizar un campo personalizado de oportunidades	Actualiza un campo personalizado de oportunidades.
Actualizar un campo personalizado de regalo	Actualiza un campo personalizado de regalo.
Actualizar un componente	Actualiza un componente.
Actualizar un evento	Actualiza los detalles sobre un evento.
Actualizar un participante	Actualiza los detalles sobre un participante.
Actualizar un teléfono constituyente	Actualiza un teléfono constituyente.
Actualizar una acción constituyente	Actualiza una acción constituyente.
Actualizar una dirección constituyente	Actualiza una dirección constituyente.
Actualizar una dirección de correo electrónico constituyente	Actualiza una dirección de correo electrónico constituyente.
Actualizar una imagen de perfil constituyente	Actualiza la imagen de perfil actual de un constituyente.
Actualizar una nota constituyente	Actualiza una nota constituyente.
Actualizar una opción de participante	Actualiza los detalles sobre una opción de participante.
Actualizar una presencia en línea constituyente	Actualiza una presencia en línea constituyente.
Agregar registros a una lista	Agregue un conjunto de registros a una lista existente.
Agregar un regalo al lote	Agregue un regalo al lote de regalo especificado.
Buscar un constituyente	Realiza una búsqueda constituyente basada en el texto de búsqueda proporcionado. Admite el nombre, el apellido, el nombre preferido, el nombre anterior, el alias, la dirección de correo electrónico, el número de teléfono, la dirección o el identificador de búsqueda. Las combinaciones de nombres como nombre y apellidos o apellidos y apellidos son válidas, pero, de lo contrario, la búsqueda solo admite un parámetro a la vez. De forma predeterminada, las búsquedas incluyen resultados que son similares a los criterios. Por ejemplo, las búsquedas de "Smith" incluyen coincidencias para "Smyth" y otras ortografías alternativas. Esta búsqueda no admite caracteres comodín como * o ?. Los resultados de la búsqueda están limitados a 500 registros.
Creación de datos adjuntos de apelación	Crea un nuevo archivo adjunto de apelación.
Creación de datos adjuntos de oportunidades	Crea un nuevo archivo adjunto de oportunidad.
Creación de un alias constituyente	Crea un nuevo alias constituyente.
Creación de un campo personalizado constituyente	Crea un nuevo campo personalizado constituyente.
Creación de un campo personalizado de acción	Crea un nuevo campo personalizado de acción.
Creación de un campo personalizado de apelación	Crea un nuevo campo personalizado de atractivo.
Creación de un campo personalizado de fondo	Crea un nuevo campo personalizado de fondo.
Creación de un campo personalizado de oportunidades	Crea un nuevo campo personalizado de oportunidad.
Creación de un componente de una organización	Crea una nueva organización constituyente.
Creación de un código constituyente	Crea un nuevo código constituyente.
Creación de un código de solicitud constituyente	Crea un nuevo código de solicitud constituyente.
Creación de un lote de regalo	Crea un nuevo lote de regalo.
Creación de un pago de cuota de participante	Crea un nuevo pago de cuota para un participante.
Creación de una acción constituyente	Crea una nueva acción constituyente.
Creación de una asignación de recaudación de fondos	Crea una nueva asignación de recaudación de fondos.
Creación de una clasificación constituyente	Crea una nueva clasificación constituyente.
Creación de una cuota de eventos	Crea una nueva tarifa para un evento.
Creación de una cuota de participante	Crea una nueva tarifa para un participante.
Creación de una dirección constituyente	Crea una nueva dirección constituyente.
Creación de una educación constituyente	Crea una nueva educación constituyente.
Creación de una presencia en línea constituyente	Crea una nueva presencia en línea constituyente.
Creación de una ubicación de documento	Crea un nuevo identificador de documento único y una ubicación de carga para su uso con datos adjuntos físicos. La respuesta incluirá instrucciones para dónde y cómo cargar el contenido del documento.
Crear datos adjuntos constituyentes	Crea un nuevo archivo adjunto constituyente.
Crear datos adjuntos de acción	Crea un nuevo archivo adjunto de acción.
Crear datos adjuntos de campaña	Crea datos adjuntos de campaña.
Crear datos adjuntos de regalo	Crea un nuevo archivo adjunto de regalo.
Crear un campo personalizado de campaña	Crea un nuevo campo personalizado de campaña.
Crear un campo personalizado de regalo	Crea un nuevo campo personalizado de regalo.
Crear un componente individual	Crea un nuevo constituyente individual.
Crear un evento	Crea un nuevo evento.
Crear un fondo adjunto	Crea un nuevo fondo adjunto.
Crear un participante	Crea un nuevo participante para un evento.
Crear un regalo	Crea un nuevo regalo.
Crear un registro de consentimiento constituyente	Crea un nuevo registro de consentimiento constituyente.
Crear un teléfono constituyente	Crea un nuevo teléfono constituyente.
Crear una dirección de correo electrónico constituyente	Crea una nueva dirección de correo electrónico constituyente.
Crear una donación de participantes	Crea una nueva donación para un participante.
Crear una lista a partir de un conjunto de registros	Crea una nueva lista filtrada al conjunto de registros especificado.
Crear una nota constituyente	Crea una nueva nota constituyente.
Crear una opción de participante	Crea una nueva opción de participante para un participante.
Crear una opción de participante del evento	Crea una nueva opción de participante para un evento.
Crear una oportunidad	Crea una nueva oportunidad.
Crear una relación de organización	Crea una nueva relación de organización. Si la relación es con otro constituyente, se crea una relación recíproca para ese constituyente.
Crear una relación individual	Crea una nueva relación individual. Si la relación es con otro constituyente, se crea una relación recíproca para ese constituyente.
Eliminación de un código constituyente	Elimina un código constituyente.
Enumerar acciones	Devuelve una lista de acciones.
Enumerar acciones constituyentes	Enumera las acciones de un constituyente.
Enumerar alias constituyentes	Enumera los alias de un constituyente.
Enumerar asignaciones de recaudación de fondos	Enumera las asignaciones de un recaudador de fondos.
Enumerar campañas	Devuelve una lista de campañas.
Enumerar campos personalizados constituyentes	Enumera los campos personalizados de un constituyente.
Enumerar campos personalizados de acción	Enumera los campos personalizados de una acción.
Enumerar campos personalizados de atractivo	Enumera los campos personalizados de una apelación.
Enumerar campos personalizados de campaña	Enumera los campos personalizados de una campaña.
Enumerar campos personalizados de oportunidades	Enumera los campos personalizados para obtener una oportunidad.
Enumerar campos personalizados de regalo	Enumera los campos personalizados de un regalo.
Enumerar campos personalizados del fondo	Enumera los campos personalizados de un fondo.
Enumerar clasificaciones constituyentes	Devuelve la lista de clasificaciones de un constituyente.
Enumerar componentes	Devuelve una lista de componentes.
Enumerar códigos constituyentes	Enumera los códigos constituyentes para un constituyente.
Enumerar códigos de solicitud constituyentes	Enumera los códigos de solicitud para un constituyente.
Enumerar datos adjuntos constituyentes	Enumera los datos adjuntos de un constituyente.
Enumerar datos adjuntos de acción	Enumera los datos adjuntos de una acción.
Enumerar datos adjuntos de campaña	Enumera los datos adjuntos de una campaña.
Enumerar datos adjuntos de fondos	Enumera los datos adjuntos de un fondo.
Enumerar datos adjuntos de oportunidades	Enumera los datos adjuntos para una oportunidad.
Enumerar datos adjuntos de regalo	Enumera los datos adjuntos de un regalo.
Enumerar direcciones constituyentes	Enumera las direcciones de un constituyente.
Enumerar direcciones de correo electrónico constituyentes	Enumera las direcciones de correo electrónico de un constituyente.
Enumerar donaciones de participantes	Enumera las donaciones para un participante.
Enumerar educación constituyente	Enumera los registros educativos de un constituyente.
Enumerar eventos	Devuelve una lista de eventos.
Enumerar fondos	Devuelve una lista de fondos.
Enumerar las apelaciones	Devuelve una lista de apelaciones.
Enumerar las opciones de los participantes	Enumera las opciones del participante para un participante.
Enumerar las opciones del participante del evento	Enumera las opciones del participante de un evento.
Enumerar las presencias en línea constituyentes	Enumera las presencias en línea para un constituyente.
Enumerar las tarifas de eventos	Enumera las tarifas de un evento.
Enumerar las tarifas de los participantes	Enumera las tarifas de un participante.
Enumerar los datos adjuntos de la apelación	Enumera los datos adjuntos de una apelación.
Enumerar lotes de regalo	Enumerar los lotes de regalo.
Enumerar notas constituyentes	Enumera las notas de un constituyente.
Enumerar oportunidades	Devuelve una lista de oportunidades.
Enumerar pagos de cuotas de participantes	Enumera los pagos de cuota para un participante.
Enumerar paquetes	Devuelve una lista de paquetes.
Enumerar participantes de eventos	Enumera los participantes de un evento.
Enumerar recaudadores de fondos constituyentes	Enumera las asignaciones de recaudación de fondos para un constituyente.
Enumerar regalos	Devuelve una lista de regalos.
Enumerar registros de consentimiento constituyente	Enumera los registros de consentimiento de un constituyente.
Enumerar relaciones constituyentes	Enumera las relaciones de un constituyente.
Enumerar teléfonos constituyentes	Enumera los teléfonos para un constituyente.
Obtención de la vigencia constituyente	Devuelve el resumen de la duración de un componente.
Obtener el estado de la perspectiva constituyente	Devuelve el estado de perspectiva actual para un constituyente.
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 constituyente	Devuelve información sobre un constituyente.
Obtener un evento	Devuelve información sobre un evento.
Obtener un fondo	Devuelve información sobre un fondo.
Obtener un paquete	Devuelve información sobre un paquete.
Obtener un participante	Devuelve información sobre un participante de eventos específico.
Obtener un regalo	Devuelve información sobre un regalo.
Obtener una acción constituyente	Devuelve información sobre una acción constituyente.
Obtener una apelación	Devuelve información sobre una apelación.
Obtener una campaña	Devuelve información sobre una campaña.
Obtener una imagen de perfil constituyente	Devuelve la imagen de perfil actual de un constituyente.
Obtener una oportunidad	Devuelve información sobre una oportunidad. Nota: Este punto de conexión devuelve la propiedad status con una latencia de aproximadamente 10 minutos.

Actualización de datos adjuntos de apelación

Id. de la operación:: EditAppealAttachment

Actualiza los datos adjuntos de una apelación.

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.

Actualización de un alias constituyente

Id. de la operación:: EditConstituentAlias

Actualiza un alias constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de alias	alias_id	True	string	Identificador de registro del sistema del alias que se va a actualizar.
Alias	name		string	Nombre que se va a usar como alias del constituyente. Límite de caracteres: 100.
Tipo	type		string	Tipo de alias.

Actualización de un campo personalizado constituyente

Id. de la operación:: EditConstituentCustomField

Actualiza un campo personalizado constituyente.

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.

Actualización de un campo personalizado de apelación

Id. de la operación:: EditAppealCustomField

Actualiza un campo personalizado de apelación.

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.

Actualización de un código constituyente

Id. de la operación:: EditConstituentCode

Actualiza un código constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de código constituyente	constituent_code_id	True	string	Identificador de registro del sistema del código constituyente que se va a actualizar.
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.
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.
Sequence	sequence		integer	Secuencia numérica asociada al código constituyente.

Actualización de un código de solicitud constituyente

Id. de la operación:: EditConstituentSolicitCode

Actualiza un código de solicitud constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Solicitar el identificador de código	constituent_solicit_code_id	True	string	Identificador de registro del sistema del código de solicitud que se va a actualizar.
Solicitar código	solicit_code		string	Instrucciones de comunicación y/o restricciones para un constituyente.
Fecha de inicio	start_date		date	Fecha de inicio del código de solicitud (por ejemplo: "2005-09-18").
Fecha de finalización	end_date		date	Fecha de finalización del código de solicitud (por ejemplo: "2005-09-18").

Actualización de una educación constituyente

Id. de la operación:: EditConstituentEducation

Actualiza una educación constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de educación	education_id	True	string	Identificador de registro del sistema del registro educativo que se va a actualizar.
Escuela	school		string	El nombre de la escuela o el establecimiento.
Tipo	type		string	Tipo de educación.
Clase de	class_of		string	El año que el constituyente se graduó.
Estado	status		string	El estado de la educación.
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.
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.
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.
Grado	degree		string	El grado recibido.
GPA	gpa		double	Promedio de puntos de grado.
Asunto de estudio	subject_of_study		string	El tema de estudio.
¿Primario?	primary		boolean	¿Esta es la asociación de la escuela primaria del constituyente?
Mayores	majors		array of string	Los cursos de estudio principales.
Menores	minors		array of string	Los cursos de estudio menores.
Campus	campus		string	El campus. Límite de caracteres: 50.
Organización social	social_organization		string	La organización social. Límite de caracteres: 50.
Nombre conocido	known_name		string	Nombre conocido. Límite de caracteres: 50.
Clase de grado	class_of_degree		string	Clase de grado.
Departamento	department		string	Nombre del departamento de educación.
Facultad	faculty		string	Nombre de la facultad.
Número de registro	registration_number		string	Número de registro. Límite de caracteres: 50.

Actualización de una oportunidad

Id. de la operación:: EditOpportunity

Actualiza una oportunidad.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de oportunidad	opportunity_id	True	string	Identificador de registro del sistema de la oportunidad de actualizar.
Propósito	purpose		string	El uso previsto para cualquier dinero generado como resultado de la oportunidad.
Nombre	name		string	Nombre que identifica la oportunidad en todo el programa, como en listas o en registros constituyentes. Límite de caracteres: 255.
Estado	status		string	Estado que indica dónde se encuentra la oportunidad en el proceso de solicitud.
Fecha límite	deadline		date-time	La fecha de objetivo de la oportunidad de dar lugar a un regalo (por ejemplo: '2020-09-18T04:13:56Z').
Preguntar fecha	ask_date		date-time	Fecha en que se realizó la solicitud (por ejemplo: '2020-09-18T04:13:56Z').
value	value		double	Valor monetario.
Fecha prevista	expected_date		date-time	Fecha en que se espera que la perspectiva dé respuesta a la oportunidad (por ejemplo: '2020-09-18T04:13:56Z').
value	value		double	Valor monetario.
Fecha de financiación	funded_date		date-time	Fecha en que la perspectiva dio respuesta a la oportunidad (por ejemplo: '2020-09-18T04:13:56Z').
value	value		double	Valor monetario.
Identificador de campaña	campaign_id		string	Identificador de registro del sistema de la campaña asociada a la oportunidad. La campaña establece los objetivos generales para aumentar el dinero.
Id. del fondo	fund_id		string	Identificador de registro del sistema del fondo asociado a la oportunidad. El fondo designa el propósito financiero específico de un regalo e identifica la cuenta financiera de ese regalo.
Identificador constituyente	constituent_id		string	El identificador de registro del sistema del constituyente asociado a la recaudación de fondos.
value	value		double	Valor monetario.
¿Inactivo?	inactive		boolean	¿La oportunidad está inactiva?

Actualización de una relación constituyente

Id. de la operación:: EditConstituentRelationship

Actualiza una relación para un constituyente. Si existe una relación recíproca, también se modifica para reflejar los cambios. Esto no incluye cambios en la propiedad "comments", que es específica de cada registro y se puede modificar independientemente en cada registro.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de relación	relationship_id	True	string	Identificador de registro del sistema de la relación que se va a actualizar.
Tipo	type		string	Tipo de relación que representa la relación.
Tipo mutuo	reciprocal_type		string	Describe la relación del constituyente con el constituyente relacionado. Por ejemplo, en una relación entre un constituyente masculino y un hermano femenino, el tipo de relación recíproca sería hermano.
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.
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 cónyuge?	is_spouse		boolean	¿Es el individuo relacionado el cónyuge del constituyente (solo se aplica a las relaciones entre individuos)?
¿Es el jefe constituyente del hogar?	is_constituent_head_of_household		boolean	¿Es el constituyente el jefe del hogar?
¿Es el cónyuge jefe del hogar?	is_spouse_head_of_household		boolean	¿Es el cónyuge el jefe del hogar?
Notas	comment		string	Notas adicionales sobre la relación.
¿Está el contacto?	is_organization_contact		boolean	¿El constituyente representa a esta organización como contacto (solo se aplica a las relaciones entre las organizaciones y las personas)?
¿Es el negocio principal?	is_primary_business		boolean	¿Es el negocio principal del constituyente (solo se aplica a las relaciones entre las organizaciones y las personas)?
Tipo de contacto	organization_contact_type		string	Proporciona contexto para las interacciones con la persona relacionada que representa la organización como contacto. Solo se aplica a las relaciones entre las organizaciones y las personas.
Position	position		string	Posición del individuo en la organización. Solo se aplica a las relaciones entre las organizaciones y las personas. Límite de caracteres: 50.

Actualizar datos adjuntos constituyentes

Id. de la operación:: EditConstituentAttachment

Actualiza los datos adjuntos constituyentes.

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.

Actualizar datos adjuntos de oportunidades

Id. de la operación:: EditOpportunityAttachment

Actualiza los datos adjuntos de una oportunidad.

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.

Actualizar datos adjuntos de regalo

Id. de la operación:: EditGiftAttachment

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.

Actualizar datos adjuntos de un fondo

Id. de la operación:: EditFundAttachment

Actualiza un fondo adjunto.

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.

Actualizar datos adjuntos de una acción

Id. de la operación:: EditActionAttachment

Actualiza los datos adjuntos de una acción.

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.

Actualizar datos adjuntos de una campaña

Id. de la operación:: EditCampaignAttachment

Actualiza los datos adjuntos de una campaña.

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.

Actualizar detalles de confirmación de regalo

Id. de la operación:: EditGiftAcknowledgement

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

Id. de la operación:: EditGiftReceipt

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.
value	value		double	Valor monetario.
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 acción

Id. de la operación:: EditActionCustomField

Actualiza un campo personalizado de acción.

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 un campo personalizado de campaña

Id. de la operación:: EditCampaignCustomField

Actualiza un campo personalizado de campaña.

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 un campo personalizado de fondo

Id. de la operación:: EditFundCustomField

Actualiza un campo personalizado de fondo.

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 un campo personalizado de oportunidades

Id. de la operación:: EditOpportunityCustomField

Actualiza un campo personalizado de oportunidades.

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 un campo personalizado de regalo

Id. de la operación:: EditGiftCustomField

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 un componente

Id. de la operación:: EditConstituent

Actualiza un componente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente que se va a actualizar.
Title	title		string	Título principal del constituyente (solo para individuos).
Nombre	first		string	Nombre del constituyente (solo para individuos). Límite de caracteres: 50.
Apellido	last		string	Apellidos del constituyente (solo para individuos). Límite de caracteres: 100.
Nombre de la organización	name		string	En el caso de las personas, se trata de un campo calculado que no es aplicable a las operaciones de edición. Para la organización, este campo es obligatorio y representa el nombre de la organización. Límite de caracteres: 100.
Sufijo	suffix		string	Sufijo principal del constituyente (solo para individuos).
Nombre preferido	preferred_name		string	Nombre preferido del constituyente (solo para individuos). Límite de caracteres: 50.
Identificador de búsqueda	lookup_id		string	Identificador definido por el usuario para el constituyente.
Gender	gender		string	El sexo del constituyente (solo para individuos).
Segundo nombre	middle		string	Nombre intermedio del constituyente (solo para individuos). Límite de caracteres: 50.
Nombre anterior	former_name		string	El nombre anterior del constituyente (solo para individuos). Límite de caracteres: 100.
Título 2	title_2		string	Título secundario del constituyente (solo para individuos).
Sufijo 2	suffix_2		string	Sufijo secundario del constituyente (solo para individuos).
Estado civil	marital_status		string	El estado civil del constituyente (solo para individuos).
¿Da de forma anónima?	gives_anonymously		boolean	¿El constituyente da de forma anónima?
¿Inactivo?	inactive		boolean	¿Está inactivo el constituyente?
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.
Lugar de nacimiento	birthplace		string	El lugar de nacimiento del constituyente (solo para individuos).
Origen étnico	ethnicity		string	La etnicidad de los constituyentes (solo para individuos).
Ingresos	income		string	Ingresos para el constituyente (solo para individuos).
Religión	religion		string	La religión del constituyente (solo para individuos).
Industry	industry		string	La industria del constituyente (solo para organizaciones).
Número de empleados	num_employees		integer	Número de empleados de la organización.
¿Coincide con regalos?	matches_gifts		boolean	¿La organización coincide con regalos?
Factor de regalo coincidente	matching_gift_factor		double	Factor de regalo coincidente (solo para organizaciones).
Coincidencia mínima por regalo	value		double	Cantidad mínima de coincidencia por regalo para el constituyente (solo para organizaciones).
Coincidencia máxima por regalo	value		double	Cantidad máxima de coincidencia por regalo para el constituyente (solo para organizaciones).
Coincidencia mínima por constit	value		double	El total mínimo de coincidencias para el constituyente (solo para organizaciones).
Coincidencia máxima por constit	value		double	El total máximo de coincidencias para el constituyente (solo para organizaciones).
Notas de regalo coincidentes	matching_gift_notes		string	Notas de regalo coincidentes para el constituyente (solo para organizaciones).
¿Difunto?	deceased		boolean	¿Es el constituyente fallecido (solo para individuos)?
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.

Actualizar un evento

Id. de la operación:: EditEvent

Actualiza los detalles sobre un evento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. del evento	event_id	True	string	Identificador de registro del sistema del evento que se va a actualizar.
Nombre de evento	name		string	Nombre del evento.
Description	description		string	Descripción del evento.
Categoría	name	True	string	Nombre de categoría.
Fecha de inicio	start_date		date	Fecha de inicio del evento (por ejemplo: "2020-09-18").
Hora de inicio	start_time		string	Hora de inicio del evento (por ejemplo: '07:30').
Fecha de finalización	end_date		date	Fecha de finalización del evento (por ejemplo: "2020-09-18").
Hora de finalización	end_time		string	Hora de finalización del evento (por ejemplo: '07:30').
Identificador de búsqueda	lookup_id		string	Identificador de búsqueda del evento.
Capacidad	capacity		integer	Número de personas que pueden asistir al evento.
Objetivo	goal		double	Objetivo monetario del evento.
Identificador de campaña	campaign_id		string	Identificador de registro del sistema de la campaña asociada al evento.
Id. del fondo	fund_id		string	Identificador de registro del sistema del fondo asociado al evento.
¿Inactivo?	inactive		boolean	¿Está activo el evento?

Actualizar un participante

Id. de la operación:: EditParticipant

Actualiza los detalles sobre un participante.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
ID del participante	participant_id	True	string	Identificador de registro del sistema del participante que se va a actualizar.
Identificador constituyente	constituent_id		string	Identificador constituyente del participante.
Id. de host	host_id		string	Identificador del registro de participante del host.
Estado de RSVP	rsvp_status		string	Estado de la interacción del participante con el evento.
¿Asistieron?	attended		boolean	¿El participante asistió al evento?
Estado de la invitación	invitation_status		string	Estado de la invitación al participante.
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.
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.
Nivel de participación	name	True	string	Nombre del nivel de participación.

Actualizar un teléfono constituyente

Id. de la operación:: EditConstituentPhone

Actualiza un teléfono constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de teléfono	phone_id	True	string	Identificador de registro del sistema del teléfono que se va a actualizar.
Tipo	type		string	Tipo de teléfono.
Number	number		string	Número de teléfono.
¿Primario?	primary		boolean	¿Es el teléfono principal del constituyente?
¿No llamas?	do_not_call		boolean	¿Se puede contactar con el constituyente en este número?
¿Inactivo?	inactive		boolean	¿Este número de teléfono está inactivo?

Actualizar una acción constituyente

Id. de la operación:: EditAction

Actualiza una acción constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de la acción	action_id	True	string	Identificador de registro del sistema de la acción que se va a actualizar.
Categoría	category		string	Canal o intención de la interacción constituyente.
¿Completado?	completed		boolean	¿Se ha completado la acción? Si el sistema está configurado para usar estados de acción personalizados, este valor se basa en el valor de estado de la acción.
Completado en	completed_date		date-time	Fecha en que se completó la acción (por ejemplo: '2020-09-18T04:13:56Z').
Fecha	date		date-time	Fecha de acción (por ejemplo: '2020-09-18T04:13:56Z').
Nota:	description		string	Explicación detallada que elabora el resumen de acciones.
Dirección	direction		string	Dirección de la acción.
Recaudación de fondos	fundraisers		array of string	Conjunto de identificadores de registro del sistema para los recaudadores de fondos asociados a la acción.
Ubicación	location		string	Ubicación de la acción.
Id. de oportunidad	opportunity_id		string	Identificador de registro del sistema de la oportunidad asociada a la acción.
Resultado	outcome		string	Resultado de la acción.
Priority	priority		string	Prioridad de la acción.
Hora de inicio	start_time		string	Hora de inicio de la acción. Usa la hora de 24 horas en el formato HH:mm.
Hora de finalización	end_time		string	Hora de finalización de la acción. Usa la hora de 24 horas en el formato HH:mm.
Estado	status		string	Estado de la acción.
Resumen	summary		string	Descripción breve de la acción que aparece en la parte superior del registro. Límite de caracteres: 255.
Tipo	type		string	Descripción adicional de la acción para complementar la categoría.

Actualizar una dirección constituyente

Id. de la operación:: EditConstituentAddress

Actualiza una dirección constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de dirección	address_id	True	string	Identificador de registro del sistema de la dirección que se va a actualizar.
Tipo de dirección	type		string	Tipo de dirección.
País	country		string	País de la dirección (puede ser el identificador, el nombre o la abreviatura).
Líneas de direcciones	address_lines		string	Líneas de dirección.
City	city		string	La ciudad de la dirección (no se usa en combinación con el campo Suburbio).
Estado	state		string	Estado de la dirección.
Código postal	postal_code		string	Código postal de la dirección.
Suburbio	suburb		string	El suburbio de la dirección (no se usa en combinación con el campo Ciudad).
Provincia	county		string	Provincia de la dirección.
Origen de información	information_source		string	Origen de información de la dirección.
Región	region		string	Región de la dirección.
CARRO	cart		string	Ruta del transportista (CART) para la dirección.
LOTE	lot		string	Línea de viaje (LOT) para la dirección.
DPC	dpc		string	Código de punto de entrega (DPC) para la dirección.
Válido desde	start		date	Fecha en la que el constituyente comenzó a residir en esta dirección (por ejemplo: '2005-09-18').
Válido hasta	end		date	Fecha en que el constituyente dejó de residir en esta dirección (por ejemplo: "2005-09-18").
¿Primario?	preferred		boolean	¿Es la dirección preferida del constituyente?
¿No te envíes correo?	do_not_mail		boolean	¿Se puede contactar con el constituyente en esta dirección?
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.
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.

Actualizar una dirección de correo electrónico constituyente

Id. de la operación:: EditConstituentEmailAddress

Actualiza una dirección de correo electrónico constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de dirección de correo electrónico	email_address_id	True	string	Identificador de registro del sistema de la dirección de correo electrónico que se va a actualizar.
Tipo de correo electrónico	type		string	Tipo de dirección de correo electrónico.
Dirección de correo electrónico	address		string	Dirección de correo electrónico.
¿Primario?	primary		boolean	¿Es la dirección de correo electrónico principal del constituyente?
¿No se envía un correo electrónico?	do_not_email		boolean	¿Se puede contactar con el constituyente en esta dirección de correo electrónico?
¿Inactivo?	inactive		boolean	¿Esta dirección de correo electrónico está inactiva?

Actualizar una imagen de perfil constituyente

Id. de la operación:: EditConstituentProfilePicture

Actualiza la imagen de perfil actual de un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente cuya imagen de perfil se va a actualizar.
Nombre del archivo	file_name	True	string	El nombre del archivo.
Id. de documento	document_id	True	uuid	Identificador del documento.
Id. de miniatura	thumbnail_id	True	uuid	Identificador del documento en miniatura.

Actualizar una nota constituyente

Id. de la operación:: EditConstituentNote

Actualiza una nota constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de nota	note_id	True	string	Identificador de registro del sistema de la nota que se va a actualizar.
Tipo	type		string	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: 50.
Nota:	text		string	Texto de la nota.

Actualizar una opción de participante

Id. de la operación:: EditParticipantOption

Actualiza los detalles sobre una opción de participante.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de opción de participante	option_id	True	string	Identificador de registro del sistema de la opción participante que se va a actualizar.
Importancia	option_value	True	string	Respuesta del participante a la opción.

Actualizar una presencia en línea constituyente

Id. de la operación:: EditConstituentOnlinePresence

Actualiza una presencia en línea constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de presencia en línea	online_presence_id	True	string	Identificador de registro del sistema de la presencia en línea que se va a actualizar.
Tipo	type		string	Tipo de presencia en línea.
Link	address		string	Dirección web de la presencia en línea.
¿Primario?	primary		boolean	¿Es la presencia en línea principal del constituyente?
¿Inactivo?	inactive		boolean	¿Esta presencia en línea está inactiva?

Agregar registros a una lista

Id. de la operación:: AppendIDsToList

Agregue un conjunto de registros a una lista existente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Tipo de lista	list_type	True	string	Tipo de lista.
List	list_id	True	string	Identificador de registro del sistema de la lista.
Identificadores	ids	True	array of string	Identificadores únicos de los registros que se van a agregar a la lista (la suma máxima de 100 000 valores).

Agregar un regalo al lote

Id. de la operación:: AddGiftToBatch

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 monetaria 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 monetaria 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	Cantidad monetaria 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

Buscar un constituyente

Id. de la operación:: SearchConstituent

Realiza una búsqueda constituyente basada en el texto de búsqueda proporcionado. Admite el nombre, el apellido, el nombre preferido, el nombre anterior, el alias, la dirección de correo electrónico, el número de teléfono, la dirección o el identificador de búsqueda. Las combinaciones de nombres como nombre y apellidos o apellidos y apellidos son válidas, pero, de lo contrario, la búsqueda solo admite un parámetro a la vez. De forma predeterminada, las búsquedas incluyen resultados que son similares a los criterios. Por ejemplo, las búsquedas de "Smith" incluyen coincidencias para "Smyth" y otras ortografías alternativas. Esta búsqueda no admite caracteres comodín como * o ?. Los resultados de la búsqueda están limitados a 500 registros.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Buscar texto	search_text	True	string	Texto de búsqueda. Admite el nombre, el apellido, el nombre preferido, el nombre anterior, el alias, la dirección de correo electrónico, el número de teléfono, la dirección o el identificador de búsqueda. Las combinaciones de nombres como nombre y apellidos o apellidos y apellidos son válidas, pero, de lo contrario, la búsqueda solo admite un parámetro a la vez. De forma predeterminada, las búsquedas incluyen resultados que son similares a los criterios. Por ejemplo, las búsquedas de "Smith" incluyen coincidencias para "Smyth" y otras ortografías alternativas. Esta búsqueda no admite caracteres comodín como * o ?. Los resultados de la búsqueda están limitados a 500 registros.
Estados de recaudación de fondos	fundraiser_status		string	Representa una lista separada por comas de estados de recaudación de fondos para filtrar los resultados. Por ejemplo, "Active,None" devuelve solo los componentes cuyo estado de recaudación de fondos es Activo o Ninguno. Los valores válidos para este filtro son Activo, Inactivo y Ninguno.
¿Incluir inactivo?	include_inactive		boolean	¿Incluir componentes inactivos en la respuesta?
Campo de búsqueda	search_field		string	Representa un campo en el que buscar. Actualmente, solo admite lookup_id. Si se proporciona con search_text, se devolverá un componente con lookup_id que coincida con el search_text.
¿Usa la búsqueda estricta?	strict_search		boolean	¿Excluye los componentes cuyos nombres suenan como el texto de búsqueda, pero se escriben de forma diferente?
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.

Devoluciones

Resultados de búsqueda

Body: ConstituentApi.ApiCollectionOfSearchResultRead

Creación de datos adjuntos de apelación

Id. de la operación:: CreateAppealAttachment

Crea un nuevo archivo adjunto de apelación.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de apelación	parent_id	True	string	Identificador de registro del sistema del recurso 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.

Devoluciones

Datos adjuntos de apelación creados

Body: FundraisingApi.CreatedAppealAttachment

Creación de datos adjuntos de oportunidades

Id. de la operación:: CreateOpportunityAttachment

Crea un nuevo archivo adjunto de oportunidad.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de oportunidad	parent_id	True	string	Identificador de registro del sistema de la oportunidad asociada 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.

Devoluciones

Datos adjuntos de oportunidades creados

Body: OpportunityApi.CreatedOpportunityAttachment

Creación de un alias constituyente

Id. de la operación:: CreateConstituentAlias

Crea un nuevo alias constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente asociado al alias.
Alias	name	True	string	Nombre que se va a usar como alias del constituyente. Límite de caracteres: 100.
Tipo	type		string	Tipo de alias.

Devoluciones

Alias constituyente creado

Body: ConstituentApi.CreatedConstituentAlias

Creación de un campo personalizado constituyente

Id. de la operación:: CreateConstituentCustomField

Crea un nuevo campo personalizado constituyente.

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 constituyente creado

Body: ConstituentApi.CreatedConstituentCustomField

Creación de un campo personalizado de acción

Id. de la operación:: CreateActionCustomField

Crea un nuevo campo personalizado de acción.

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 acción creado

Body: ConstituentApi.CreatedActionCustomField

Creación de un campo personalizado de apelación

Id. de la operación:: CreateAppealCustomField

Crea un nuevo campo personalizado de atractivo.

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 apelación creado

Body: FundraisingApi.CreatedAppealCustomField

Creación de un campo personalizado de fondo

Id. de la operación:: CreateFundCustomField

Crea un nuevo campo personalizado de fondo.

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 fondo creado

Body: FundraisingApi.CreatedFundCustomField

Creación de un campo personalizado de oportunidades

Id. de la operación:: CreateOpportunityCustomField

Crea un nuevo campo personalizado de oportunidad.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
body	body	True	dynamic	Objeto que representa el campo personalizado que se va a crear.

Devoluciones

Datos adjuntos de oportunidades creados

Body: OpportunityApi.CreatedOpportunityCustomField

Creación de un componente de una organización

Id. de la operación:: CreateOrganizationConstituent

Crea una nueva organización constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre	name	True	string	El nombre de la organización. Límite de caracteres: 100.
Identificador de búsqueda	lookup_id		string	Identificador definido por el usuario para el constituyente.
type	type	True	string	Tipo de dirección.
country	country		string	País de la dirección (puede ser el identificador, el nombre o la abreviatura).
lineas	address_lines		string	Líneas de dirección. Límite de caracteres: 150.
city	city		string	La ciudad de la dirección (no se usa en combinación con el campo Suburbio).
estado	state		string	Estado de la dirección.
código postal	postal_code		string	Código postal de la dirección. Límite de caracteres: 12.
suburbio	suburb		string	El suburbio de la dirección (no se usa en combinación con el campo Ciudad).
condado	county		string	Provincia de la dirección.
start	start		date	Fecha en la que el constituyente comenzó a residir en esta dirección (por ejemplo: '2005-09-18').
end	end		date	Fecha en que el constituyente dejó de residir en esta dirección (por ejemplo: "2005-09-18").
type	type	True	string	Tipo de teléfono.
number	number	True	string	Número de teléfono.
¿es principal?	primary		boolean	¿Es el número de teléfono principal del constituyente?
type	type	True	string	Tipo de dirección de correo electrónico.
address	address	True	string	Dirección de correo electrónico.
¿es principal?	primary		boolean	¿Es la dirección de correo electrónico principal del constituyente?
type	type	True	string	Tipo de presencia en línea.
address	address	True	string	Dirección web de la presencia en línea.
¿es principal?	primary		boolean	¿Es la presencia en línea principal del constituyente?
¿Da de forma anónima?	gives_anonymously		boolean	¿El constituyente da de forma anónima?
Industry	industry		string	La industria del constituyente.
Número de empleados	num_employees		integer	Número de empleados de la organización.
¿Coincide con regalos?	matches_gifts		boolean	¿La organización coincide con regalos?
Factor de regalo coincidente	matching_gift_factor		double	Factor de regalo coincidente.
Coincidencia mínima por regalo	value		double	Cantidad mínima de coincidencia por regalo para el constituyente.
Coincidencia máxima por regalo	value		double	Cantidad máxima de coincidencias por regalo para el constituyente.
Coincidencia mínima por constit	value		double	El total de coincidencias mínimas para el constituyente.
Coincidencia máxima por constit	value		double	El total máximo de coincidencias para el constituyente.
Notas de regalo coincidentes	matching_gift_notes		string	Notas de regalo coincidentes para el constituyente.

Devoluciones

Creación de un componente de la organización

Body: ConstituentApi.CreatedOrganizationConstituent

Creación de un código constituyente

Id. de la operación:: CreateConstituentCode

Crea un nuevo código constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente asociado al código constituyente.
Código constituyente	description	True	string	Código constituyente.
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.
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.
Sequence	sequence		integer	Secuencia numérica asociada al código constituyente.

Devoluciones

Código constituyente creado

Body: ConstituentApi.CreatedConstituentCode

Creación de un código de solicitud constituyente

Id. de la operación:: CreateConstituentSolicitCode

Crea un nuevo código de solicitud constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente asociado al código de solicitud.
Solicitar código	solicit_code	True	string	Instrucciones de comunicación y/o restricciones para un constituyente.
Fecha de inicio	start_date		date	Fecha de inicio del código de solicitud (por ejemplo: "2005-09-18").
Fecha de finalización	end_date		date	Fecha de finalización del código de solicitud (por ejemplo: "2005-09-18").

Devoluciones

Código de solicitud constituyente creado

Body: CommPrefApi.CreatedConstituentSolicitCode

Creación de un lote de regalo

Id. de la operación:: CreateGiftBatch

Crea un nuevo lote de regalo.

Parámetros

Nombre	Clave	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

Body: GiftBatchApi.CreatedBatch

Creación de un pago de cuota de participante

Id. de la operación:: CreateParticipantFeePayment

Crea un nuevo pago de cuota para un participante.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
ID del participante	participant_id	True	string	Identificador de registro del sistema del participante.
Id. de regalo	gift_id	True	string	El identificador de registro systetm del regalo al que está vinculada la cuota del participante.
Cantidad aplicada	applied_amount	True	double	El importe del pago que se aplica a los honorarios de los participantes.

Devoluciones

Pago de cuota de participante creado

Body: EventApi.CreatedParticipantFeePayment

Creación de una acción constituyente

Id. de la operación:: CreateAction

Crea una nueva acción constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente asociado a la acción.
Categoría	category	True	string	Canal o intención de la interacción constituyente.
¿Completado?	completed		boolean	¿Se ha completado la acción? Si el sistema está configurado para usar estados de acción personalizados, este valor se basa en el valor de estado de la acción.
Completado en	completed_date		date-time	Fecha en que se completó la acción (por ejemplo: '2020-09-18T04:13:56Z').
Fecha	date	True	date-time	Fecha de acción (por ejemplo: '2020-09-18T04:13:56Z').
Nota:	description		string	Explicación detallada que elabora el resumen de acciones.
Dirección	direction		string	Dirección de la acción.
Recaudación de fondos	fundraisers		array of string	Conjunto de identificadores de registro del sistema para los recaudadores de fondos asociados a la acción.
Ubicación	location		string	Ubicación de la acción.
Id. de oportunidad	opportunity_id		string	Identificador de registro del sistema de la oportunidad asociada a la acción.
Resultado	outcome		string	Resultado de la acción.
Priority	priority		string	Prioridad de la acción.
Hora de inicio	start_time		string	Hora de inicio de la acción. Usa la hora de 24 horas en el formato HH:mm.
Hora de finalización	end_time		string	Hora de finalización de la acción. Usa la hora de 24 horas en el formato HH:mm.
Estado	status		string	Estado de la acción.
Resumen	summary		string	Descripción breve de la acción que aparece en la parte superior del registro. Límite de caracteres: 255.
Tipo	type		string	Descripción adicional de la acción para complementar la categoría.

Devoluciones

Acción creada

Body: ConstituentApi.CreatedAction

Creación de una asignación de recaudación de fondos

Id. de la operación:: CreateFundraiserAssignment

Crea una nueva asignación de recaudación de fondos.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de recaudación de fondos	fundraiser_id	True	string	El identificador de registro del sistema del recaudador de fondos.
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente asignado.
Tipo	type		string	Tipo de recaudación de fondos.
Inicio de la asignación	start		date-time	Fecha de inicio de la asignación.
Finaliza la asignación	end		date-time	Fecha de finalización de la asignación.
Importe	value	True	double	El importe del objetivo del recaudador de fondos para solicitar del constituyente asignado.
Identificador de campaña	campaign_id		string	Identificador de registro del sistema de la campaña a la que se aplicarán los regalos resultantes.
Id. del fondo	fund_id		string	Identificador de registro del sistema del fondo al que se aplicarán los regalos resultantes.
Id. de apelación	appeal_id		string	Identificador de registro del sistema del recurso al que se aplicarán los regalos resultantes.

Devoluciones

Asignación de recaudación de fondos creada

Body: FundraisingApi.CreatedFundraiserAssignment

Creación de una clasificación constituyente

Id. de la operación:: CreateConstituentRating

Crea una nueva clasificación constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
body	body	True	dynamic	Objeto que representa la clasificación que se va a crear.

Devoluciones

Se creó la clasificación constituyente

Body: ConstituentApi.CreatedConstituentRating

Creación de una cuota de eventos

Id. de la operación:: CreateEventFee

Crea una nueva tarifa para un evento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. del evento	event_id	True	string	Identificador de registro del sistema del evento.
Nombre	name	True	string	Nombre de la cuota.
Importe de la tarifa	cost	True	double	Cantidad de dinero asociado a la tarifa.
Importe de contribución	contribution_amount	True	double	Importe de la cuota que es una donación por encima de los costos del evento.

Devoluciones

Cuota de eventos creada

Body: EventApi.CreatedEventFee

Creación de una cuota de participante

Id. de la operación:: CreateParticipantFee

Crea una nueva tarifa para un participante.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
ID del participante	participant_id	True	string	Identificador de registro del sistema del participante.
Id. del evento	event_id	True	string	Identificador de registro del sistema del evento.
Tarifa	event_fee_id	True	string	La tarifa del evento.
Cantidad	quantity	True	integer	La cantidad comprada.
Importe de la tarifa	fee_amount	True	double	Cantidad de dinero asociado a la tarifa.
Importe de contribución	contribution_amount	True	double	Importe de la cuota que es una donación por encima de los costos del evento. Esta es la cantidad que normalmente aparece en los recibos.
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.

Devoluciones

Cuota de participante creada

Body: EventApi.CreatedParticipantFee

Creación de una dirección constituyente

Id. de la operación:: CreateConstituentAddress

Crea una nueva dirección constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente asociado a la dirección.
Tipo de dirección	type	True	string	Tipo de dirección.
País	country		string	País de la dirección (puede ser el identificador, el nombre o la abreviatura).
Líneas de direcciones	address_lines		string	Líneas de dirección.
City	city		string	La ciudad de la dirección (no se usa en combinación con el campo Suburbio).
Estado	state		string	Estado de la dirección.
Código postal	postal_code		string	Código postal de la dirección.
Suburbio	suburb		string	El suburbio de la dirección (no se usa en combinación con el campo Ciudad).
Provincia	county		string	Provincia de la dirección.
Origen de información	information_source		string	Origen de información de la dirección.
Región	region		string	Región de la dirección.
CARRO	cart		string	Ruta del transportista (CART) para la dirección.
LOTE	lot		string	Línea de viaje (LOT) para la dirección.
DPC	dpc		string	Código de punto de entrega (DPC) para la dirección.
Válido desde	start		date	Fecha en la que el constituyente comenzó a residir en esta dirección (por ejemplo: '2005-09-18').
Válido hasta	end		date	Fecha en que el constituyente dejó de residir en esta dirección (por ejemplo: "2005-09-18").
¿Primario?	preferred		boolean	¿Es la dirección preferida del constituyente?
¿No te envíes correo?	do_not_mail		boolean	¿Se puede contactar con el constituyente en esta dirección?
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.
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.

Devoluciones

Dirección constituyente creada

Body: ConstituentApi.CreatedConstituentAddress

Creación de una educación constituyente

Id. de la operación:: CreateConstituentEducation

Crea una nueva educación constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente asociado a la educación.
Escuela	school	True	string	El nombre de la escuela o el establecimiento.
Tipo	type		string	Tipo de educación.
Clase de	class_of		string	El año que el constituyente se graduó.
Estado	status		string	El estado de la educación.
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.
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.
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.
Grado	degree		string	El grado recibido.
GPA	gpa		double	Promedio de puntos de grado.
Asunto de estudio	subject_of_study		string	El tema de estudio.
¿Primario?	primary		boolean	¿Esta es la asociación de la escuela primaria del constituyente?
Mayores	majors		array of string	Los cursos de estudio principales.
Menores	minors		array of string	Los cursos de estudio menores.
Campus	campus		string	El campus. Límite de caracteres: 50.
Organización social	social_organization		string	La organización social. Límite de caracteres: 50.
Nombre conocido	known_name		string	Nombre conocido. Límite de caracteres: 50.
Clase de grado	class_of_degree		string	Clase de grado (solo aplicable a las versiones del Reino Unido).
Departamento	department		string	Nombre del departamento de educación (solo aplicable a las versiones del Reino Unido).
Facultad	faculty		string	Nombre de la facultad (solo aplicable a las versiones del Reino Unido).
Número de registro	registration_number		string	Número de registro (solo aplicable a las versiones del Reino Unido). Límite de caracteres: 50.

Devoluciones

Creación de educación constituyente

Body: ConstituentApi.CreatedConstituentEducation

Creación de una presencia en línea constituyente

Id. de la operación:: CreateConstituentOnlinePresence

Crea una nueva presencia en línea constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente asociado a la presencia en línea.
Tipo	type	True	string	Tipo de presencia en línea.
Link	address	True	string	Dirección web de la presencia en línea.
¿Primario?	primary		boolean	¿Es la presencia en línea principal del constituyente?
¿Inactivo?	inactive		boolean	¿Esta presencia en línea está inactiva?

Devoluciones

Creación de presencia en línea constituyente

Body: ConstituentApi.CreatedConstituentOnlinePresence

Creación de una ubicación de documento

Id. de la operación:: CreateDocument

Crea un nuevo identificador de documento único y una ubicación de carga para su uso con datos adjuntos físicos. La respuesta incluirá instrucciones para dónde y cómo cargar el contenido del documento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre del archivo	file_name		string	Nombre de archivo del documento que se va a cargar.
¿Incluir miniatura?	upload_thumbnail		boolean	¿Incluir una ubicación del documento en miniatura?

Devoluciones

Definición de archivo

Body: ConstituentApi.FileDefinition

Crear datos adjuntos constituyentes

Id. de la operación:: CreateConstituentAttachment

Crea un nuevo archivo adjunto constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	parent_id	True	string	Identificador de registro del sistema del componente 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.

Devoluciones

Datos adjuntos constituyentes creados

Body: ConstituentApi.CreatedConstituentAttachment

Crear datos adjuntos de acción

Id. de la operación:: CreateActionAttachment

Crea un nuevo archivo adjunto de acción.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de la acción	parent_id	True	string	Identificador de registro del sistema de la acción asociada 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.

Devoluciones

Datos adjuntos de acción creados

Body: ConstituentApi.CreatedActionAttachment

Crear datos adjuntos de campaña

Id. de la operación:: CreateCampaignAttachment

Crea datos adjuntos de campaña.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de campaña	parent_id	True	string	Identificador de registro del sistema de la campaña asociada 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.

Devoluciones

Datos adjuntos de campaña creados

Body: FundraisingApi.CreatedCampaignAttachment

Crear datos adjuntos de regalo

Id. de la operación:: CreateGiftAttachment

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.

Devoluciones

Datos adjuntos de regalo creados

Body: GiftApi.CreatedGiftAttachment

Crear un campo personalizado de campaña

Id. de la operación:: CreateCampaignCustomField

Crea un nuevo campo personalizado de campaña.

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 campaña creado

Body: FundraisingApi.CreatedCampaignCustomField

Crear un campo personalizado de regalo

Id. de la operación:: CreateGiftCustomField

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

Body: GiftApi.CreatedGiftCustomField

Crear un componente individual

Id. de la operación:: CreateIndividualConstituent

Crea un nuevo constituyente individual.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Title	title		string	Título principal del constituyente.
Nombre	first		string	Nombre del constituyente. Límite de caracteres: 50.
Apellido	last	True	string	Apellidos del constituyente. Límite de caracteres: 100.
Sufijo	suffix		string	Sufijo principal del constituyente.
Identificador de búsqueda	lookup_id		string	Identificador definido por el usuario para el constituyente.
type	type	True	string	Tipo de dirección.
country	country		string	País de la dirección (puede ser el identificador, el nombre o la abreviatura).
lineas	address_lines		string	Líneas de dirección. Límite de caracteres: 150.
city	city		string	La ciudad de la dirección (no se usa en combinación con el campo Suburbio).
estado	state		string	Estado de la dirección.
código postal	postal_code		string	Código postal de la dirección. Límite de caracteres: 12.
suburbio	suburb		string	El suburbio de la dirección (no se usa en combinación con el campo Ciudad).
condado	county		string	Provincia de la dirección.
start	start		date	Fecha en la que el constituyente comenzó a residir en esta dirección (por ejemplo: '2005-09-18').
end	end		date	Fecha en que el constituyente dejó de residir en esta dirección (por ejemplo: "2005-09-18").
type	type	True	string	Tipo de teléfono.
number	number	True	string	Número de teléfono.
¿es principal?	primary		boolean	¿Es el número de teléfono principal del constituyente?
type	type	True	string	Tipo de dirección de correo electrónico.
address	address	True	string	Dirección de correo electrónico.
¿es principal?	primary		boolean	¿Es la dirección de correo electrónico principal del constituyente?
type	type	True	string	Tipo de presencia en línea.
address	address	True	string	Dirección web de la presencia en línea.
¿es principal?	primary		boolean	¿Es la presencia en línea principal del constituyente?
Nombre preferido	preferred_name		string	Nombre preferido del constituyente. Límite de caracteres: 50.
Segundo nombre	middle		string	Nombre intermedio del constituyente. Límite de caracteres: 50.
Nombre anterior	former_name		string	El nombre del constituyente. Límite de caracteres: 100.
Título 2	title_2		string	Título secundario del constituyente.
Sufijo 2	suffix_2		string	Sufijo secundario del constituyente.
Gender	gender		string	El género del constituyente.
Estado civil	marital_status		string	El estado civil del constituyente.
¿Da de forma anónima?	gives_anonymously		boolean	¿El constituyente da de forma anónima?
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.
Lugar de nacimiento	birthplace		string	El lugar de nacimiento del constituyente.
Origen étnico	ethnicity		string	La etnicidad del constituyente.
Ingresos	income		string	Los ingresos de los constituyentes.
Religión	religion		string	La religión del constituyente.
¿Destinatario personalizado?	custom_format		boolean	¿El destinatario principal es un formato personalizado?
Formato de destinatario	configuration_id		string	Configuración de destinatario principal (necesaria a menos que se use un formato personalizado).
Nombre personalizado del destinatario	formatted_name		string	Nombre con formato de destinatario principal (necesario cuando se usa un formato personalizado). Límite de caracteres: 255.
¿Saludo personalizado?	custom_format		boolean	¿El saludo principal es un formato personalizado?
Formato de saludo	configuration_id		string	Configuración de saludo principal (necesaria a menos que se use un formato personalizado).
Nombre personalizado de saludo	formatted_name		string	Nombre con formato de saludo principal (necesario cuando se usa un formato personalizado). Límite de caracteres: 255.

Devoluciones

Creación de un componente individual

Body: ConstituentApi.CreatedIndividualConstituent

Crear un evento

Id. de la operación:: CreateEvent

Crea un nuevo evento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre de evento	name	True	string	Nombre del evento.
Description	description		string	Descripción del evento.
Categoría	name	True	string	Nombre de categoría.
Fecha de inicio	start_date	True	date	Fecha de inicio del evento (por ejemplo: "2020-09-18").
Hora de inicio	start_time		string	Hora de inicio del evento (por ejemplo: '07:30').
Fecha de finalización	end_date		date	Fecha de finalización del evento (por ejemplo: "2020-09-18").
Hora de finalización	end_time		string	Hora de finalización del evento (por ejemplo: '07:30)'.
Identificador de búsqueda	lookup_id		string	Identificador de búsqueda del evento.
Capacidad	capacity		integer	Número de personas que pueden asistir al evento.
Objetivo	goal		double	Objetivo monetario del evento.
Identificador de campaña	campaign_id		string	Identificador de registro del sistema de la campaña asociada al evento.
Id. del fondo	fund_id		string	Identificador de registro del sistema del fondo asociado al evento.
¿Inactivo?	inactive		boolean	¿Está activo el evento?

Devoluciones

Evento creado

Body: EventApi.CreatedEvent

Crear un fondo adjunto

Id. de la operación:: CreateFundAttachment

Crea un nuevo fondo adjunto.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. del fondo	parent_id	True	string	Identificador de registro del sistema del fondo 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.

Devoluciones

Datos adjuntos de fondos creados

Body: FundraisingApi.CreatedFundAttachment

Crear un participante

Id. de la operación:: CreateParticipant

Crea un nuevo participante para un evento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. del evento	event_id	True	string	Identificador de registro del sistema del evento.
Identificador constituyente	constituent_id	True	string	Identificador constituyente del participante.
Id. de host	host_id		string	Identificador del registro de participante del host.
Estado de RSVP	rsvp_status		string	Estado de la interacción del participante con el evento.
¿Asistieron?	attended		boolean	¿El participante asistió al evento?
Estado de la invitación	invitation_status		string	Estado de la invitación al participante.
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.
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.
Nivel de participación	name	True	string	Nombre del nivel de participación.

Devoluciones

Participante creado

Body: EventApi.CreatedParticipant

Crear un regalo

Id. de la operación:: CreateGift

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 monetaria 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 monetaria 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	Cantidad monetaria 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 registro de consentimiento constituyente

Id. de la operación:: CreateConstituentConsent

Crea un nuevo registro de consentimiento constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente asociado al registro de consentimiento.
Channel	channel	True	string	Canal al que se aplica la respuesta de consentimiento.
Categoría	category		string	Categoría a la que se aplica la respuesta de consentimiento.
Fuente	source		string	Origen de la respuesta de consentimiento del constituyente.
Respuesta	constituent_consent_response	True	string	Cómo respondió el constituyente al consentimiento del canal o la categoría especificados.
Fecha	consent_date	True	date-time	Fecha en que se recibió la respuesta de consentimiento (por ejemplo: "2020-09-18T04:13:56Z").
Instrucción consent	consent_statement		string	La declaración a la que respondió el constituyente al proporcionar consentimiento.
Aviso de privacidad	privacy_notice		string	El aviso de privacidad proporcionado al constituyente.

Devoluciones

Consentimiento constituyente creado

Body: CommPrefApi.CreatedConstituentConsent

Crear un teléfono constituyente

Id. de la operación:: CreateConstituentPhone

Crea un nuevo teléfono constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente asociado al teléfono.
Tipo	type	True	string	Tipo de teléfono.
Number	number	True	string	Número de teléfono.
¿Primario?	primary		boolean	¿Es el teléfono principal del constituyente?
¿No llamas?	do_not_call		boolean	¿Se puede contactar con el constituyente en este número?
¿Inactivo?	inactive		boolean	¿Este número de teléfono está inactivo?

Devoluciones

Teléfono constituyente creado

Body: ConstituentApi.CreatedConstituentPhone

Crear una dirección de correo electrónico constituyente

Id. de la operación:: CreateConstituentEmailAddress

Crea una nueva dirección de correo electrónico constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente asociado a la dirección de correo electrónico.
Tipo de correo electrónico	type	True	string	Tipo de dirección de correo electrónico.
Dirección de correo electrónico	address	True	string	Dirección de correo electrónico.
¿Primario?	primary		boolean	¿Es la dirección de correo electrónico principal del constituyente?
¿No se envía un correo electrónico?	do_not_email		boolean	¿Se puede contactar con el constituyente en esta dirección de correo electrónico?
¿Inactivo?	inactive		boolean	¿Esta dirección de correo electrónico está inactiva?

Devoluciones

Dirección de correo electrónico constituyente creada

Body: ConstituentApi.CreatedConstituentEmailAddress

Crear una donación de participantes

Id. de la operación:: CreateParticipantDonation

Crea una nueva donación para un participante.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
ID del participante	participant_id	True	string	Identificador de registro del sistema del participante.
Id. de regalo	gift_id	True	string	Identificador de registro systetm del regalo al que está vinculado la donación del participante.

Devoluciones

Donación de participantes creada

Body: EventApi.CreatedParticipantDonation

Crear una lista a partir de un conjunto de registros

Id. de la operación:: CreateListFromIDs

Crea una nueva lista filtrada al conjunto de registros especificado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre	name	True	string	Nombre de la lista. Límite de caracteres: 50.
Description	description	True	string	Descripción de la lista.
Tipo de lista	list_type	True	string	Determina el tipo de lista que se va a crear.
Permissions	list_permissions	True	string	Determina si otros usuarios pueden acceder a la lista.
Identificadores	ids	True	array of string	Identificadores únicos de los registros contenidos en la lista (máximo de 100 000 valores).

Devoluciones

Lista creada

Body: ListApi.CreatedList

Crear una nota constituyente

Id. de la operación:: CreateConstituentNote

Crea una nueva nota constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente asociado a la nota.
Tipo	type	True	string	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: 50.
Nota:	text		string	Texto de la nota.

Devoluciones

Nota constituyente creada

Body: ConstituentApi.CreatedConstituentNote

Crear una opción de participante

Id. de la operación:: CreateParticipantOption

Crea una nueva opción de participante para un participante.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
ID del participante	participant_id	True	string	Identificador del participante.
body	body	True	dynamic	Objeto que representa la opción de participante que se va a crear.

Devoluciones

Opción de participante creado

Body: EventApi.CreatedParticipantOption

Crear una opción de participante del evento

Id. de la operación:: CreateEventParticipantOption

Crea una nueva opción de participante para un evento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. del evento	event_id	True	string	Id. del evento.
Nombre	name	True	string	Nombre de la opción participante del evento.
Tipo de entrada	input_type	True	string	Los tipos de valores que los participantes pueden usar para proporcionar respuestas.
¿Permitir selección múltiple?	multi_select		boolean	¿Permite más de un valor para las listas?
nombre	name		string	Nombre de la opción de lista.
secuencia	sequence		integer	Secuencia basada en 0 que se usa para ordenar.

Devoluciones

Opción de participante del evento creado

Body: EventApi.CreatedEventParticipantOption

Crear una oportunidad

Id. de la operación:: CreateOpportunity

Crea una nueva oportunidad.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente asociado a la oportunidad.
Propósito	purpose	True	string	El uso previsto para cualquier dinero generado como resultado de la oportunidad.
Nombre	name	True	string	Nombre que identifica la oportunidad en todo el programa, como en listas o en registros constituyentes. Límite de caracteres: 255.
Estado	status		string	Estado que indica dónde se encuentra la oportunidad en el proceso de solicitud.
Fecha límite	deadline		date-time	La fecha de objetivo de la oportunidad de dar lugar a un regalo (por ejemplo: '2020-09-18T04:13:56Z').
Preguntar fecha	ask_date		date-time	Fecha en que se realizó la solicitud (por ejemplo: '2020-09-18T04:13:56Z').
value	value		double	Valor monetario.
Fecha prevista	expected_date		date-time	Fecha en que se espera que la perspectiva dé respuesta a la oportunidad (por ejemplo: '2020-09-18T04:13:56Z').
value	value		double	Valor monetario.
Fecha de financiación	funded_date		date-time	Fecha en que la perspectiva dio respuesta a la oportunidad (por ejemplo: '2020-09-18T04:13:56Z').
value	value		double	Valor monetario.
Identificador de campaña	campaign_id		string	Identificador de registro del sistema de la campaña asociada a la oportunidad. La campaña establece los objetivos generales para aumentar el dinero.
Id. del fondo	fund_id		string	Identificador de registro del sistema del fondo asociado a la oportunidad. El fondo designa el propósito financiero específico de un regalo e identifica la cuenta financiera de ese regalo.
Identificador constituyente	constituent_id		string	El identificador de registro del sistema del constituyente asociado a la recaudación de fondos.
value	value		double	Valor monetario.
¿Inactivo?	inactive		boolean	¿La oportunidad está inactiva?

Devoluciones

Oportunidad creada

Body: OpportunityApi.CreatedOpportunity

Crear una relación de organización

Id. de la operación:: CreateOrganizationRelationship

Crea una nueva relación de organización. Si la relación es con otro constituyente, se crea una relación recíproca para ese constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente asociado a la relación.
Id. de relación	relation_id	True	string	Identificador de registro del sistema de la organización relacionada.
Tipo	type		string	Tipo de relación que representa la relación.
Tipo mutuo	reciprocal_type		string	Describe la relación del constituyente con la organización relacionada.
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.
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.
¿Está el contacto?	is_organization_contact		boolean	¿El constituyente representa a esta organización como contacto?
Tipo de contacto	organization_contact_type		string	Proporciona contexto para las interacciones con la persona relacionada que representa la organización como contacto.
Position	position		string	Posición del individuo en la organización. Límite de caracteres: 50.
¿Es el negocio principal?	is_primary_business		boolean	¿Es el negocio principal de los constituyentes?
Notas	comment		string	Notas adicionales sobre la relación.

Devoluciones

Relación de organización creada

Body: ConstituentApi.CreatedOrganizationRelationship

Crear una relación individual

Id. de la operación:: CreateIndividualRelationship

Crea una nueva relación individual. Si la relación es con otro constituyente, se crea una relación recíproca para ese constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente asociado a la relación.
Id. de relación	relation_id	True	string	Identificador de registro del sistema del individuo relacionado.
Tipo	type		string	Tipo de relación que representa la relación.
Tipo mutuo	reciprocal_type		string	Describe la relación del constituyente con el constituyente relacionado. Por ejemplo, en una relación entre un constituyente masculino y un hermano femenino, el tipo de relación recíproca sería hermano.
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.
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 cónyuge?	is_spouse		boolean	¿Es el individuo relacionado el cónyuge del constituyente?
¿Es el jefe constituyente del hogar?	is_constituent_head_of_household		boolean	¿Es el constituyente el jefe del hogar?
¿Es el cónyuge jefe del hogar?	is_spouse_head_of_household		boolean	¿Es el cónyuge el jefe del hogar?
Notas	comment		string	Notas adicionales sobre la relación.

Devoluciones

Relación individual creada

Body: ConstituentApi.CreatedIndividualRelationship

Eliminación de un código constituyente

Id. de la operación:: DeleteConstituentCode

Elimina un código constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de código constituyente	constituent_code_id	True	string	Identificador de registro del sistema del código constituyente que se va a eliminar.

Enumerar acciones

Id. de la operación:: ListActions

Devuelve una lista de acciones.

Parámetros

Nombre	Clave	Tipo	Description
List	list_id	string	Define un identificador de lista usado para filtrar el conjunto de acciones a los incluidos en la lista especificada. Si se establece este valor, se omitirán otros filtros especificados.
Estado calculado	computed_status	string	Representa un filtro para los resultados en función del estado de la acción calculada. Los valores disponibles son Open, Completed o PastDue.
Estado	status_code	string	Representa un código de estado de acción para filtrar los resultados (solo es aplicable cuando el sistema está configurado para usar códigos de estado de acción). Por ejemplo, "Pendiente" devuelve acciones con el estado "Pendiente".
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.
Agregado en o después	date_added	date-time	Filtre los resultados de las acciones creadas 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 de las acciones modificadas en o después de la fecha especificada (por ejemplo: "2020-09-18T04:13:56Z").

Devoluciones

Acciones

Body: ConstituentApi.ApiCollectionOfActionRead

Enumerar acciones constituyentes

Id. de la operación:: ListConstituentActions

Enumera las acciones de un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del constituyente.

Devoluciones

Acciones

Body: ConstituentApi.ApiCollectionOfActionRead

Enumerar alias constituyentes

Id. de la operación:: ListConstituentAliases

Enumera los alias de un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del constituyente.

Devoluciones

Alias

Body: ConstituentApi.ApiCollectionOfAliasRead

Enumerar asignaciones de recaudación de fondos

Id. de la operación:: ListFundraiserAssignments

Enumera las asignaciones de un recaudador de fondos.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de recaudación de fondos	fundraiser_id	True	string	Identificador de registro del sistema del recaudador de fondos para el que se devolverán las asignaciones.
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.

Devoluciones

Assignments

Body: FundraisingApi.ApiCollectionOfFundraiserAssignmentRead

Enumerar campañas

Id. de la operación:: ListCampaigns

Devuelve una lista de campañas.

Parámetros

Nombre	Clave	Tipo	Description
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.
¿Incluir inactivo?	include_inactive	boolean	¿Incluye campañas inactivas?
Agregado en o después	date_added	date-time	Filtre los resultados de las campañas creadas 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 de las campañas modificadas en o después de la fecha especificada (por ejemplo: '2020-09-18T04:13:56Z').

Devoluciones

Campañas

Body: FundraisingApi.ApiCollectionOfCampaignRead

Enumerar campos personalizados constituyentes

Id. de la operación:: ListConstituentCustomFields

Enumera los campos personalizados de un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del constituyente.

Devoluciones

Campos personalizados

Body: ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

Enumerar campos personalizados de acción

Id. de la operación:: ListActionCustomFields

Enumera los campos personalizados de una acción.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de la acción	action_id	True	string	Identificador de registro del sistema de la acción.

Devoluciones

Campos personalizados

Body: ConstituentApi.ApiCollectionOfActionCustomFieldRead

Enumerar campos personalizados de atractivo

Id. de la operación:: ListAppealCustomFields

Enumera los campos personalizados de una apelación.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de apelación	appeal_id	True	string	El identificador de registro del sistema del recurso.

Devoluciones

Campos personalizados

Body: FundraisingApi.ApiCollectionOfAppealCustomFieldRead

Enumerar campos personalizados de campaña

Id. de la operación:: ListCampaignCustomFields

Enumera los campos personalizados de una campaña.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de campaña	campaign_id	True	string	Identificador de registro del sistema de la campaña.

Devoluciones

Campos personalizados

Body: FundraisingApi.ApiCollectionOfCampaignCustomFieldRead

Enumerar campos personalizados de oportunidades

Id. de la operación:: ListOpportunityCustomFields

Enumera los campos personalizados para obtener una oportunidad.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de oportunidad	opportunity_id	True	string	Identificador de registro del sistema de la oportunidad.

Devoluciones

Campos personalizados

Body: OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead

Enumerar campos personalizados de regalo

Id. de la operación:: ListGiftCustomFields

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

Body: GiftApi.ApiCollectionOfGiftCustomFieldRead

Enumerar campos personalizados del fondo

Id. de la operación:: ListFundCustomFields

Enumera los campos personalizados de un fondo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. del fondo	fund_id	True	string	Identificador de registro del sistema del fondo.

Devoluciones

Campos personalizados

Body: FundraisingApi.ApiCollectionOfFundCustomFieldRead

Enumerar clasificaciones constituyentes

Id. de la operación:: ListConstituentRatings

Devuelve la lista de clasificaciones de un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del constituyente
¿Incluir inactivo?	include_inactive		boolean	¿Incluye clasificaciones inactivas?
¿Solo la más reciente?	most_recent_only		boolean	¿Incluye solo las clasificaciones más recientes?

Devoluciones

Valoraciones

Body: ConstituentApi.ApiCollectionOfRatingRead

Enumerar componentes

Id. de la operación:: ListConstituents

Devuelve una lista de componentes.

Parámetros

Nombre	Clave	Tipo	Description
List	list_id	string	Define un identificador de lista usado para filtrar el conjunto de componentes a los incluidos en la lista especificada. Si se establece este valor, se omitirán otros filtros especificados.
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.
Código constituyente	constituent_code	string	Representa un código constituyente para filtrar la lista. Por ejemplo, "Miembro de la Junta" devuelve solo los componentes con un código constituyente miembro de la Junta.
Identificador constituyente	constituent_id	string	Representa una lista separada por comas de identificadores constituyentes para filtrar los resultados. Por ejemplo, "280,1232" devuelve solo 280 constituyentes o constituyentes 1232.
Categoría de campo personalizado	custom_field_category	string	Representa una categoría de campo personalizada para filtrar los resultados. Por ejemplo, "Anniversary" devuelve solo los componentes con un campo personalizado de aniversario activo.
Estado de recaudación de fondos	fundraiser_status	string	Representa una lista separada por comas de estados de recaudación de fondos para filtrar los resultados. Por ejemplo, "Active,None" devuelve solo los componentes cuyo estado de recaudación de fondos es Activo o Ninguno. Los valores válidos para este filtro son Activo, Inactivo y Ninguno.
¿Incluir fallecido?	include_deceased	boolean	¿Incluir a los constituyentes fallecidos en la respuesta?
¿Incluir inactivo?	include_inactive	boolean	¿Incluir componentes inactivos en la respuesta?
Código postal	postal_code	string	Representa una lista separada por comas de códigos postales para filtrar los resultados. Por ejemplo, "29466,29492" devuelve solo los constituyentes cuya dirección preferida tiene un código postal que comienza con 29466 o 29492, como 29466, 29492 o 29492-0727.
Agregado en o después	date_added	date-time	Filtre los resultados a los componentes 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 los componentes modificados en o después de la fecha especificada (por ejemplo: '2020-09-18T04:13:56Z').
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,-last" ordena los componentes por el campo "date_added" en orden ascendente y, a continuación, por el campo "último" en orden descendente.

Devoluciones

Componentes

Body: ConstituentApi.ApiCollectionOfConstituentRead

Enumerar códigos constituyentes

Id. de la operación:: ListConstituentCodes

Enumera los códigos constituyentes para un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del constituyente.

Devoluciones

Códigos constituyentes

Body: ConstituentApi.ApiCollectionOfConstituentCodeRead

Enumerar códigos de solicitud constituyentes

Id. de la operación:: ListConstituentSolicitCodes

Enumera los códigos de solicitud para un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del constituyente.

Devoluciones

Solicitar códigos

Body: CommPrefApi.ConstituentSolicitCodeReadCollection

Enumerar datos adjuntos constituyentes

Id. de la operación:: ListConstituentAttachments

Enumera los datos adjuntos de un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del constituyente.

Devoluciones

Attachments

Body: ConstituentApi.ApiCollectionOfConstituentAttachmentRead

Enumerar datos adjuntos de acción

Id. de la operación:: ListActionAttachments

Enumera los datos adjuntos de una acción.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de la acción	action_id	True	string	Identificador de registro del sistema de la acción.

Devoluciones

Attachments

Body: ConstituentApi.ApiCollectionOfActionAttachmentRead

Enumerar datos adjuntos de campaña

Id. de la operación:: ListCampaignAttachments

Enumera los datos adjuntos de una campaña.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de campaña	campaign_id	True	string	Identificador de registro del sistema de la campaña.

Devoluciones

Attachments

Body: FundraisingApi.ApiCollectionOfCampaignAttachmentRead

Enumerar datos adjuntos de fondos

Id. de la operación:: ListFundAttachments

Enumera los datos adjuntos de un fondo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. del fondo	fund_id	True	string	Identificador de registro del sistema del fondo.

Devoluciones

Attachments

Body: FundraisingApi.ApiCollectionOfFundAttachmentRead

Enumerar datos adjuntos de oportunidades

Id. de la operación:: ListOpportunityAttachments

Enumera los datos adjuntos para una oportunidad.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de oportunidad	opportunity_id	True	string	Identificador de registro del sistema de la oportunidad.

Devoluciones

Attachments

Body: OpportunityApi.ApiCollectionOfOpportunityAttachmentRead

Enumerar datos adjuntos de regalo

Id. de la operación:: ListGiftAttachments

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

Body: GiftApi.ApiCollectionOfGiftAttachmentRead

Enumerar direcciones constituyentes

Id. de la operación:: ListConstituentAddresses

Enumera las direcciones de un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del constituyente.
¿Incluir inactivo?	include_inactive		boolean	¿Incluir direcciones inactivas?

Devoluciones

Addresses

Body: ConstituentApi.ApiCollectionOfAddressRead

Enumerar direcciones de correo electrónico constituyentes

Id. de la operación:: ListConstituentEmailAddresses

Enumera las direcciones de correo electrónico de un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del constituyente.
¿Incluir inactivo?	include_inactive		boolean	¿Incluir direcciones de correo electrónico inactivas?

Devoluciones

Direcciones de correo

Body: ConstituentApi.ApiCollectionOfEmailAddressRead

Enumerar donaciones de participantes

Id. de la operación:: ListParticipantDonations

Enumera las donaciones para un participante.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
ID del participante	participant_id	True	string	Identificador de registro del sistema del participante.
Limit	limit		integer	Representa el número de registros que se van a devolver. El valor predeterminado es 500. El máximo es 10000.
Desplazar	offset		integer	Representa el número de registros que se van a omitir. Para su uso con paginación. El valor predeterminado es 0.

Devoluciones

Donaciones

Body: EventApi.ApiCollectionOfParticipantDonation

Enumerar educación constituyente

Id. de la operación:: ListConstituentEducations

Enumera los registros educativos de un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del constituyente.

Devoluciones

Educación

Body: ConstituentApi.ApiCollectionOfEducationRead

Enumerar eventos

Id. de la operación:: ListEvents

Devuelve una lista de eventos.

Parámetros

Nombre	Clave	Tipo	Description
Categoría	category	string	Filtrar en función de la categoría de eventos.
Fecha de inicio desde	start_date_from	date	Filtre los resultados a los eventos con fecha de inicio en o después de la fecha especificada (por ejemplo: "2020-09-18").
Fecha de inicio a	start_date_to	date	Filtre los resultados a eventos con fecha de inicio en o antes de la fecha especificada (por ejemplo: "2020-09-18").
¿Incluir inactivo?	include_inactive	boolean	¿Incluir eventos inactivos?
Limit	limit	integer	Representa el número de registros que se van a devolver. El valor predeterminado es 500. El máximo es 10000.
Desplazar	offset	integer	Representa el número de registros que se van a omitir. Para su uso con paginación.
Id. del evento	event_id	string	Filtre los eventos que coinciden con el identificador de registro del sistema especificado.
Nombre	name	string	Filtre por eventos que coincidan con el nombre especificado.
Agregado en o después	date_added	date-time	Filtre los resultados de los eventos 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 de los eventos modificados en o después de la fecha especificada (por ejemplo: '2020-09-18T04:13:56Z').

Devoluciones

Eventos

Body: EventApi.ApiCollectionOfEventListEntry

Enumerar fondos

Id. de la operación:: ListFunds

Devuelve una lista de fondos.

Parámetros

Nombre	Clave	Tipo	Description
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.
¿Incluir inactivo?	include_inactive	boolean	¿Incluir fondos inactivos?
Agregado en o después	date_added	date-time	Filtre los resultados a los fondos 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 fondos modificados en o después de la fecha especificada (por ejemplo: '2020-09-18T04:13:56Z').

Devoluciones

Fondos

Body: FundraisingApi.ApiCollectionOfFundRead

Enumerar las apelaciones

Id. de la operación:: ListAppeals

Devuelve una lista de apelaciones.

Parámetros

Nombre	Clave	Tipo	Description
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.
¿Incluir inactivo?	include_inactive	boolean	¿Incluir apelaciones inactivas?
Agregado en o después	date_added	date-time	Filtre los resultados de las apelaciones creadas 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 de las apelaciones modificadas en o después de la fecha especificada (por ejemplo: "2020-09-18T04:13:56Z").

Devoluciones

Apelaciones

Body: FundraisingApi.ApiCollectionOfAppealRead

Enumerar las opciones de los participantes

Id. de la operación:: ListParticipantOptions

Enumera las opciones del participante para un participante.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
ID del participante	participant_id	True	string	Identificador de registro del sistema del participante.

Devoluciones

Opciones de participantes

Body: EventApi.ApiCollectionOfParticipantOption

Enumerar las opciones del participante del evento

Id. de la operación:: ListEventParticipantOptions

Enumera las opciones del participante de un evento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. del evento	event_id	True	string	Id. del evento.

Devoluciones

Opciones del participante del evento

Body: EventApi.ApiCollectionOfEventParticipantOption

Enumerar las presencias en línea constituyentes

Id. de la operación:: ListConstituentOnlinePresences

Enumera las presencias en línea para un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del constituyente.
¿Incluir inactivo?	include_inactive		boolean	¿Incluir presencias en línea inactivas?

Devoluciones

Presencias en línea

Body: ConstituentApi.ApiCollectionOfOnlinePresenceRead

Enumerar las tarifas de eventos

Id. de la operación:: ListEventFees

Enumera las tarifas de un evento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. del evento	event_id	True	string	Identificador de registro del sistema del evento.

Devoluciones

Honorarios

Body: EventApi.ApiCollectionOfEventFee

Enumerar las tarifas de los participantes

Id. de la operación:: ListParticipantFees

Enumera las tarifas de un participante.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
ID del participante	participant_id	True	string	Identificador de registro del sistema del participante.
Limit	limit		integer	Representa el número de registros que se van a devolver. El valor predeterminado es 500. El máximo es 10000.
Desplazar	offset		integer	Representa el número de registros que se van a omitir. Para su uso con paginación. El valor predeterminado es 0.

Devoluciones

Honorarios

Body: EventApi.ApiCollectionOfParticipantFee

Enumerar los datos adjuntos de la apelación

Id. de la operación:: ListAppealAttachments

Enumera los datos adjuntos de una apelación.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de apelación	appeal_id	True	string	El identificador de registro del sistema del recurso.

Devoluciones

Attachments

Body: FundraisingApi.ApiCollectionOfAppealAttachmentRead

Enumerar lotes de regalo

Id. de la operación:: ListGiftBatches

Enumerar los lotes de regalo.

Parámetros

Nombre	Clave	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

Body: GiftBatchApi.ApiCollectionOfGiftBatch

Enumerar notas constituyentes

Id. de la operación:: ListConstituentNotes

Enumera las notas de un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del constituyente.

Devoluciones

Notas

Body: ConstituentApi.ApiCollectionOfNoteRead

Enumerar oportunidades

Id. de la operación:: ListOpportunities

Devuelve una lista de oportunidades.

Parámetros

Nombre	Clave	Tipo	Description
List	list_id	string	Define un identificador de lista usado para filtrar el conjunto de oportunidades a los incluidos en la lista especificada. Si se establece este valor, se omitirán otros filtros especificados.
Identificador constituyente	constituent_id	string	Representa una lista separada por comas de identificadores constituyentes para filtrar los resultados. Por ejemplo, "280.1232" devuelve solo oportunidades de 280 constituyentes o constituyentes 1232.
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.
¿Incluir inactivo?	include_inactive	boolean	¿Incluye oportunidades inactivas?
Agregado en o después	date_added	date-time	Filtre los resultados a las oportunidades creadas 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 oportunidades modificadas en o después de la fecha especificada (por ejemplo: "2020-09-18T04:13:56Z").

Devoluciones

Oportunidades

Body: OpportunityApi.ApiCollectionOfOpportunityRead

Enumerar pagos de cuotas de participantes

Id. de la operación:: ListParticipantFeePayments

Enumera los pagos de cuota para un participante.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
ID del participante	participant_id	True	string	Identificador de registro del sistema del participante.
Limit	limit		integer	Representa el número de registros que se van a devolver. El valor predeterminado es 500. El máximo es 10000.
Desplazar	offset		integer	Representa el número de registros que se van a omitir. Para su uso con paginación. El valor predeterminado es 0.

Devoluciones

Pagos por cuotas

Body: EventApi.ApiCollectionOfParticipantFeePayment

Enumerar paquetes

Id. de la operación:: ListPackages

Devuelve una lista de paquetes.

Parámetros

Nombre	Clave	Tipo	Description
Id. de apelación	appeal_id	string	Representa una lista separada por comas de identificadores de apelación para filtrar los resultados. Por ejemplo, "506,918" devuelve solo paquetes de 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.
¿Incluir inactivo?	include_inactive	boolean	¿Incluye paquetes inactivos?
Agregado en o después	date_added	date-time	Filtre los resultados a los paquetes 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 los paquetes modificados en o después de la fecha especificada (por ejemplo: "2020-09-18T04:13:56Z").

Devoluciones

Packages

Body: FundraisingApi.ApiCollectionOfPackageRead

Enumerar participantes de eventos

Id. de la operación:: ListEventParticipants

Enumera los participantes de un evento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. del evento	event_id	True	string	Identificador de registro del sistema del evento.
Estado de RSVP	rsvp_status		string	Filtre los participantes en función del estado de RSVP.
Estado de la invitación	invitation_status		string	Filtre a los participantes en función del estado de la invitación.
Nivel de participación	participation_level		string	Filtre a los participantes en función del nivel de participación.
¿Asistieron?	attended_filter		boolean	Filtre por incluir o excluir a los participantes marcados como asistidos.
¿Se pagaron las cuotas?	fees_paid_filter		boolean	Filtre por incluir o excluir a los participantes que hayan pagado sus tarifas.
Limit	limit		integer	Representa el número de registros que se van a devolver. El valor predeterminado es 500. El máximo es 10000.
Desplazar	offset		integer	Representa el número de registros que se van a omitir. Para su uso con paginación.
¿Es constituyente?	is_constituent_filter		boolean	Filtre por incluir o excluir a los participantes que son constituyentes.
¿Tiene un correo electrónico apto?	email_eligible_filter		boolean	Filtrar por incluir o excluir a los participantes en función de si tienen una dirección de correo electrónico principal que no está marcada como ¿No enviar correo electrónico?
¿Tiene un teléfono apto?	phone_call_eligible_filter		boolean	Filtre por incluir o excluir a los participantes en función de si tienen un número de teléfono principal que no está marcado como No llamar.
Nombre	name		string	Filtre por los participantes que coincidan con el nombre especificado.
Agregado en o después	date_added		date-time	Filtre los resultados a los participantes 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 los participantes modificados en o después de la fecha especificada (por ejemplo: "2020-09-18T04:13:56Z").

Devoluciones

Participants

Body: EventApi.ApiCollectionOfParticipantListEntry

Enumerar recaudadores de fondos constituyentes

Id. de la operación:: ListConstituentFundraiserAssignments

Enumera las asignaciones de recaudación de fondos para un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del constituyente.
¿Incluir inactivo?	include_inactive		boolean	¿Incluir asignaciones de recaudación de fondos inactivas?

Devoluciones

Asignaciones de recaudación de fondos

Body: ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

Enumerar regalos

Id. de la operación:: ListGifts

Devuelve una lista de regalos.

Parámetros

Nombre	Clave	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 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 campaña 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 fondo 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 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.
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

Body: GiftApi.ApiCollectionOfGiftRead

Enumerar registros de consentimiento constituyente

Id. de la operación:: ListConstituentConsents

Enumera los registros de consentimiento de un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del constituyente.
¿Solo más reciente?	most_recent_only		boolean	¿Incluye solo los registros de consentimiento más recientes para cada combinación de categoría de canal en la respuesta?

Devoluciones

Registros de consentimiento

Body: CommPrefApi.ConstituentConsentReadCollection

Enumerar relaciones constituyentes

Id. de la operación:: ListConstituentRelationships

Enumera las relaciones de un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	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

Relationships

Body: ConstituentApi.ApiCollectionOfRelationshipRead

Enumerar teléfonos constituyentes

Id. de la operación:: ListConstituentPhones

Enumera los teléfonos para un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del constituyente.
¿Incluir inactivo?	include_inactive		boolean	¿Incluye teléfonos inactivos?

Devoluciones

Teléfonos

Body: ConstituentApi.ApiCollectionOfPhoneRead

Obtención de la vigencia constituyente

Id. de la operación:: GetConstituentLifetimeGiving

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

Body: ConstituentApi.LifetimeGivingRead

Obtener el estado de la perspectiva constituyente

Id. de la operación:: GetConstituentProspectStatus

Devuelve el estado de perspectiva actual para un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del constituyente para el que se va a recuperar el estado de la perspectiva.

Devoluciones

Estado de la perspectiva

Body: ConstituentApi.ProspectStatusRead

Obtener el mejor regalo constituyente

Id. de la operación:: GetConstituentGreatestGift

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

Body: ConstituentApi.GivingSummaryRead

Obtener el primer regalo constituyente

Id. de la operación:: GetConstituentFirstGift

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

Body: ConstituentApi.GivingSummaryRead

Obtener el último regalo constituyente

Id. de la operación:: GetConstituentLatestGift

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

Body: ConstituentApi.GivingSummaryRead

Obtener un constituyente

Id. de la operación:: GetConstituent

Devuelve información sobre un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente que se va a obtener.

Devoluciones

Constituyente

Body: ConstituentApi.ConstituentRead

Obtener un evento

Id. de la operación:: GetEvent

Devuelve información sobre un evento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. del evento	event_id	True	string	Identificador de registro del sistema del evento que se va a obtener.

Devoluciones

Event

Body: EventApi.Event

Obtener un fondo

Id. de la operación:: GetFund

Devuelve información sobre un fondo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. del fondo	fund_id	True	string	Identificador de registro del sistema del fondo que se va a obtener.

Devoluciones

Fondo

Body: FundraisingApi.FundRead

Obtener un paquete

Id. de la operación:: GetPackage

Devuelve información sobre un paquete.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	package_id	True	string	Identificador de registro del sistema del paquete que se va a obtener.

Devoluciones

Package

Body: FundraisingApi.PackageRead

Obtener un participante

Id. de la operación:: GetParticipant

Devuelve información sobre un participante de eventos específico.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
ID del participante	participant_id	True	string	Identificador de registro del sistema del participante.

Devoluciones

Participante

Body: EventApi.Participant

Obtener un regalo

Id. de la operación:: GetGift

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 una acción constituyente

Id. de la operación:: GetAction

Devuelve información sobre una acción constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de la acción	action_id	True	string	Identificador de registro del sistema de la acción que se va a obtener.

Devoluciones

Acción

Body: ConstituentApi.ActionRead

Obtener una apelación

Id. de la operación:: GetAppeal

Devuelve información sobre una apelación.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de apelación	appeal_id	True	string	Identificador de registro del sistema del recurso que se va a obtener.

Devoluciones

Appeal

Body: FundraisingApi.AppealRead

Obtener una campaña

Id. de la operación:: GetCampaign

Devuelve información sobre una campaña.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de campaña	campaign_id	True	string	Identificador de registro del sistema de la campaña que se va a obtener.

Devoluciones

Campaña

Body: FundraisingApi.CampaignRead

Obtener una imagen de perfil constituyente

Id. de la operación:: GetConstituentProfilePicture

Devuelve la imagen de perfil actual de un constituyente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador constituyente	constituent_id	True	string	Identificador de registro del sistema del componente para el que se va a recuperar la imagen de perfil.

Devoluciones

Imagen de perfil

Body: ConstituentApi.ProfilePictureRead

Obtener una oportunidad

Id. de la operación:: GetOpportunity

Devuelve información sobre una oportunidad. Nota: Este punto de conexión devuelve la propiedad status con una latencia de aproximadamente 10 minutos.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de oportunidad	opportunity_id	True	string	Identificador de registro del sistema de la oportunidad de obtener.

Devoluciones

Oportunidad

Body: OpportunityApi.OpportunityRead

Definiciones

CommPrefApi.ConstituentConsentRead

Representa una entidad de consentimiento para un constituyente.

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del registro de consentimiento.
Channel	channel	string	Canal al que se aplica la respuesta de consentimiento.
Categoría	category	string	Categoría a la que se aplica la respuesta de consentimiento.
Fuente	source	string	Origen de la respuesta de consentimiento del constituyente.
Respuesta	constituent_consent_response	string	Cómo respondió el constituyente al consentimiento del canal o la categoría especificados.
Fecha	consent_date	date-time	Fecha en que se recibió la respuesta de consentimiento.
Instrucción consent	consent_statement	string	La declaración a la que respondió el constituyente al proporcionar consentimiento.
Aviso de privacidad	privacy_notice	string	El aviso de privacidad proporcionado al constituyente.
Fecha de adición	date_added	date-time	Fecha en que se agregó la respuesta de consentimiento.
Agregado por	user_name	string	Usuario que agregó la respuesta de consentimiento.

CommPrefApi.ConstituentConsentReadCollection

Registros de consentimiento

Nombre	Ruta de acceso	Tipo	Description
Contar	count	integer	Número de registros de consentimiento de la lista.
value	value	array of CommPrefApi.ConstituentConsentRead	Conjunto de registros de consentimiento incluidos en la respuesta.

CommPrefApi.ConstituentSolicitCodeRead

Solicitar código

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del código de solicitud constituyente.
Solicitar código	solicit_code	string	Instrucciones de comunicación y/o restricciones para un constituyente.
Fecha de inicio	start_date	date	Fecha de inicio del código de solicitud (por ejemplo: "2005-09-18").
Fecha de finalización	end_date	date	Fecha de finalización del código de solicitud (por ejemplo: "2005-09-18").

CommPrefApi.ConstituentSolicitCodeReadCollection

Solicitar códigos

Nombre	Ruta de acceso	Tipo	Description
Contar	count	integer	Número de códigos de solicitud constituyentes de la lista.
value	value	array of CommPrefApi.ConstituentSolicitCodeRead	Conjunto de códigos de solicitud constituyentes incluidos en la respuesta.

CommPrefApi.CreatedConstituentConsent

Consentimiento constituyente creado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador del registro de consentimiento recién creado.

CommPrefApi.CreatedConstituentSolicitCode

Código de solicitud constituyente creado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador del código de solicitud constituyente recién creado.

ConstituentApi.ActionAttachmentRead

Datos adjuntos

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de los datos adjuntos.
Id. de la acción	parent_id	string	Identificador de registro del sistema de la acción asociada 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.

ConstituentApi.ActionCustomFieldRead

Campo personalizado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del campo personalizado.
Id. de la acción	parent_id	string	Identificador de registro del sistema de la acción asociada 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.
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.

ConstituentApi.ActionRead

Acción

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de la acción.
Identificador constituyente	constituent_id	string	Identificador de registro del sistema del componente asociado a la acción.
Categoría	category	string	Canal o intención de la interacción constituyente.
¿Completado?	completed	boolean	¿Se ha completado la acción? Si el sistema está configurado para usar estados de acción personalizados, este valor se basa en el valor de estado de la acción.
Completado en	completed_date	date-time	Fecha en que se completó la acción.
Fecha	date	date-time	Fecha de acción.
Nota:	description	string	Explicación detallada que elabora el resumen de acciones.
Dirección	direction	string	Dirección de la acción.
Recaudación de fondos	fundraisers	array of string	Conjunto de identificadores de registro del sistema para los recaudadores de fondos asociados a la acción.
Ubicación	location	string	Ubicación de la acción.
Id. de oportunidad	opportunity_id	string	Identificador de registro del sistema de la oportunidad asociada a la acción.
Resultado	outcome	string	Resultado de la acción.
Priority	priority	string	Prioridad de la acción.
Hora de inicio	start_time	string	Hora de inicio de la acción. Usa la hora de 24 horas en el formato HH:mm.
Hora de finalización	end_time	string	Hora de finalización de la acción. Usa la hora de 24 horas en el formato HH:mm.
Estado	status	string	Estado de la acción.
Código de estado	status_code	string	Código de estado de la acción. Esta propiedad solo se devuelve cuando el sistema está configurado para usar estados de acción personalizados.
Estado calculado	computed_status	string	Estado de la acción calculada. Si el sistema no está configurado para usar estados de acción personalizados, este campo calcula el estado en función de las propiedades de fecha y completadas. Si no es así, el campo calcula el estado en función de la propiedad date de la acción y de si la propiedad Action Status está configurada como completada.
Resumen	summary	string	Descripción breve de la acción que aparece en la parte superior del registro. Límite de caracteres: 255.
Tipo	type	string	Descripción adicional de la acción para complementar la categoría.
Fecha de adición	date_added	date-time	Fecha en que se creó la acción.
Fecha de modificación	date_modified	date-time	Fecha en la que se modificó por última vez la acción.

ConstituentApi.AddressRead

Dirección

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de la dirección.
Tipo	type	string	Tipo de dirección.
País	country	string	País de la dirección (puede ser el identificador, el nombre o la abreviatura).
Líneas de direcciones	address_lines	string	Líneas de dirección.
City	city	string	La ciudad de la dirección (no se usa en combinación con el campo Suburbio).
Estado	state	string	Estado de la dirección.
Código postal	postal_code	string	Código postal de la dirección.
Suburbio	suburb	string	El suburbio de la dirección (no se usa en combinación con el campo Ciudad).
Provincia	county	string	Provincia de la dirección.
Dirección con formato	formatted_address	string	Dirección con formato en el formato configurado del país.
Origen de información	information_source	string	Origen de información de la dirección.
Región	region	string	Región de la dirección.
CARRO	cart	string	Ruta del transportista (CART) para la dirección.
LOTE	lot	string	Línea de viaje (LOT) para la dirección.
DPC	dpc	string	Código de punto de entrega (DPC) para la dirección.
Válido desde	start	date-time	Fecha en la que el constituyente comenzó a residir en esta dirección.
Válido hasta	end	date-time	Fecha en la que el constituyente dejó de residir en esta dirección.
¿Primario?	preferred	boolean	¿Es la dirección preferida del constituyente?
¿Inactivo?	inactive	boolean	¿La dirección está inactiva (es decir, la fecha actual es anterior a cualquier fecha de finalización)?
¿No te envíes correo?	do_not_mail	boolean	¿Se puede contactar con el constituyente en esta dirección?
Día	seasonal_start.d	integer	El día en la fecha aproximada.
month	seasonal_start.m	integer	Mes en la fecha aproximada.
año	seasonal_start.y	integer	Año en la fecha aproximada.
Día	seasonal_end.d	integer	El día en la fecha aproximada.
month	seasonal_end.m	integer	Mes en la fecha aproximada.
año	seasonal_end.y	integer	Año en la fecha aproximada.
Fecha de adición	date_added	date-time	Fecha en que se creó la dirección.
Fecha de modificación	date_modified	date-time	Fecha en la que se modificó por última vez la dirección.

ConstituentApi.AliasRead

Alias

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del alias.
Alias	name	string	Nombre que se va a usar como alias del constituyente.
Tipo	type	string	Tipo de alias.

ConstituentApi.ApiCollectionOfAddressRead

Addresses

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 ConstituentApi.AddressRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

ConstituentApi.ApiCollectionOfActionAttachmentRead

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 ConstituentApi.ActionAttachmentRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

ConstituentApi.ApiCollectionOfActionCustomFieldRead

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 ConstituentApi.ActionCustomFieldRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

ConstituentApi.ApiCollectionOfActionRead

Acciones

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 ConstituentApi.ActionRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

ConstituentApi.ApiCollectionOfAliasRead

Alias

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 ConstituentApi.AliasRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

ConstituentApi.ApiCollectionOfConstituentAttachmentRead

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 ConstituentApi.ConstituentAttachmentRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

ConstituentApi.ApiCollectionOfConstituentCodeRead

Códigos constituyentes

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 ConstituentApi.ConstituentCodeRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

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 ConstituentApi.ConstituentCustomFieldRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

ConstituentApi.ApiCollectionOfConstituentRead

Componentes

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 ConstituentApi.ConstituentRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

ConstituentApi.ApiCollectionOfEducationRead

Educación

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 ConstituentApi.EducationRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

ConstituentApi.ApiCollectionOfEmailAddressRead

Direcciones de correo

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 ConstituentApi.EmailAddressRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

Asignaciones de recaudación de fondos

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 ConstituentApi.FundraiserAssignmentRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

ConstituentApi.ApiCollectionOfNoteRead

Notas

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 ConstituentApi.NoteRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

ConstituentApi.ApiCollectionOfOnlinePresenceRead

Presencias en línea

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 ConstituentApi.OnlinePresenceRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

ConstituentApi.ApiCollectionOfPhoneRead

Teléfonos

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 ConstituentApi.PhoneRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

ConstituentApi.ApiCollectionOfRatingRead

Valoraciones

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 ConstituentApi.RatingRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

ConstituentApi.ApiCollectionOfRelationshipRead

Relationships

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 ConstituentApi.RelationshipRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

ConstituentApi.ApiCollectionOfSearchResultRead

Resultados de búsqueda

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 ConstituentApi.SearchResultRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

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.ConstituentAttachmentRead

Datos adjuntos

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de los datos adjuntos.
Identificador constituyente	parent_id	string	Identificador de registro del sistema del componente 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.

ConstituentApi.ConstituentCodeRead

Código constituyente

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del código constituyente.
Identificador constituyente	constituent_id	string	Identificador de registro del sistema del componente asociado al código constituyente.
Código constituyente	description	string	Código constituyente.
Día	start.d	integer	El día en la fecha aproximada.
month	start.m	integer	Mes en la fecha aproximada.
año	start.y	integer	Año en la fecha aproximada.
Día	end.d	integer	El día en la fecha aproximada.
month	end.m	integer	Mes en la fecha aproximada.
año	end.y	integer	Año en la fecha aproximada.
¿Inactivo?	inactive	boolean	¿El código constituyente está inactivo?
Sequence	sequence	integer	Secuencia numérica asociada al código constituyente.
Fecha de adición	date_added	date-time	Fecha en que se creó el código constituyente.
Fecha de modificación	date_modified	date-time	Fecha en la que se modificó por última vez el código constituyente.

ConstituentApi.ConstituentCustomFieldRead

Campo personalizado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del campo personalizado.
Identificador constituyente	parent_id	string	Identificador de registro del sistema del componente 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.
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.

ConstituentApi.ConstituentRead

Constituyente

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema para el constituyente. Esto no es lo mismo que el identificador constituyente definible por el usuario, que se almacena en el lookup_id.
Tipo	type	string	Tipo de constituyente.
Title	title	string	Título principal del constituyente (solo para individuos).
Nombre	first	string	Nombre del constituyente (solo para individuos).
Apellido	last	string	Apellidos del constituyente (solo para individuos).
Nombre	name	string	En el caso de las personas, este campo es el nombre completo del constituyente en función de la configuración del nombre para mostrar de la organización de destino. En el caso de las organizaciones, este es el nombre de la organización.
Nombre preferido	preferred_name	string	Nombre preferido del constituyente (solo para individuos).
Sufijo	suffix	string	Sufijo principal del constituyente (solo para individuos).
Identificador de búsqueda	lookup_id	string	Identificador definido por el usuario para el constituyente.
identificación	email.id	string	Identificador de registro del sistema de la dirección de correo electrónico.
type	email.type	string	Tipo de dirección de correo electrónico.
address	email.address	string	Dirección de correo electrónico.
¿no se envía un correo electrónico?	email.do_not_email	boolean	¿Se puede contactar con el constituyente en esta dirección de correo electrónico?
¿inactivo?	email.inactive	boolean	¿Esta dirección de correo electrónico está inactiva?
fecha agregada	email.date_added	date-time	Fecha en que se creó la dirección de correo electrónico.
fecha de modificación	email.date_modified	date-time	Fecha en la que se modificó por última vez la dirección de correo electrónico.
identificación	phone.id	string	Identificador de registro del sistema del teléfono.
type	phone.type	string	Tipo de teléfono.
number	phone.number	string	Número de teléfono.
¿no llamas?	phone.do_not_call	boolean	¿Se puede contactar con el constituyente en este número?
¿inactivo?	phone.inactive	boolean	¿Este número de teléfono está inactivo?
fecha agregada	phone.date_added	date-time	Fecha en que se creó el teléfono.
fecha de modificación	phone.date_modified	date-time	Fecha en la que se modificó por última vez el teléfono.
identificación	online_presence.id	string	Identificador de registro del sistema de la presencia en línea.
type	online_presence.type	string	Tipo de presencia en línea.
link	online_presence.address	string	Dirección web de la presencia en línea.
¿inactivo?	online_presence.inactive	boolean	¿Esta presencia en línea está inactiva?
fecha agregada	online_presence.date_added	date-time	Fecha en la que se creó la presencia en línea.
fecha de modificación	online_presence.date_modified	date-time	Fecha en la que se modificó por última vez la presencia en línea.
identificación	address.id	string	Identificador de registro del sistema de la dirección.
type	address.type	string	Tipo de dirección.
country	address.country	string	País de la dirección (puede ser el identificador, el nombre o la abreviatura).
lineas	address.address_lines	string	Líneas de dirección.
city	address.city	string	La ciudad de la dirección (no se usa en combinación con el campo Suburbio).
estado	address.state	string	Estado de la dirección.
código postal	address.postal_code	string	Código postal de la dirección.
suburbio	address.suburb	string	El suburbio de la dirección (no se usa en combinación con el campo Ciudad).
condado	address.county	string	Provincia de la dirección.
Formato	address.formatted_address	string	Dirección con formato en el formato configurado del país.
válido desde	address.start	date-time	Fecha en la que el constituyente comenzó a residir en esta dirección.
válido para	address.end	date-time	Fecha en la que el constituyente dejó de residir en esta dirección.
¿inactivo?	address.inactive	boolean	¿La dirección está inactiva (es decir, la fecha actual es anterior a cualquier fecha de finalización)?
¿no correo?	address.do_not_mail	boolean	¿Se puede contactar con el constituyente en esta dirección?
Día	address.seasonal_start.d	integer	El día en la fecha aproximada.
month	address.seasonal_start.m	integer	Mes en la fecha aproximada.
año	address.seasonal_start.y	integer	Año en la fecha aproximada.
Día	address.seasonal_end.d	integer	El día en la fecha aproximada.
month	address.seasonal_end.m	integer	Mes en la fecha aproximada.
año	address.seasonal_end.y	integer	Año en la fecha aproximada.
fecha agregada	address.date_added	date-time	Fecha en que se creó la dirección.
fecha de modificación	address.date_modified	date-time	Fecha en la que se modificó por última vez la dirección.
Gender	gender	string	El sexo del constituyente (solo para individuos).
Segundo nombre	middle	string	Nombre intermedio del constituyente (solo para individuos).
Nombre anterior	former_name	string	El nombre anterior del constituyente (solo para individuos).
Título 2	title_2	string	Título secundario del constituyente (solo para individuos).
Sufijo 2	suffix_2	string	Sufijo secundario del constituyente (solo para individuos).
Staus matrimonial	marital_status	string	El estado civil del constituyente (solo para individuos).
¿Da de forma anónima?	gives_anonymously	boolean	¿El constituyente da de forma anónima?
¿Inactivo?	inactive	boolean	¿Está inactivo el constituyente?
Día	birthdate.d	integer	El día en la fecha aproximada.
month	birthdate.m	integer	Mes en la fecha aproximada.
año	birthdate.y	integer	Año en la fecha aproximada.
Lugar de nacimiento	birthplace	string	El lugar de nacimiento del constituyente (solo para individuos).
Origen étnico	ethnicity	string	La etnicidad de los constituyentes (solo para individuos).
Ingresos	income	string	Ingresos para el constituyente (solo para individuos).
Religión	religion	string	La religión del constituyente (solo para individuos).
Industry	industry	string	La industria del constituyente (solo para organizaciones).
Número de empleados	num_employees	integer	Número de empleados de la organización.
¿Coincide con regalos?	matches_gifts	boolean	¿La organización coincide con regalos?
Factor de regalo coincidente	matching_gift_factor	double	Factor de regalo coincidente (solo para organizaciones).
Coincidencia mínima por regalo	matching_gift_per_gift_min.value	double	Cantidad mínima de coincidencia por regalo para el constituyente (solo para organizaciones).
Coincidencia máxima por regalo	matching_gift_per_gift_max.value	double	Cantidad máxima de coincidencia por regalo para el constituyente (solo para organizaciones).
Coincidencia mínima por constit	matching_gift_total_min.value	double	El total mínimo de coincidencias para el constituyente (solo para organizaciones).
Coincidencia máxima por constit	matching_gift_total_max.value	double	El total máximo de coincidencias para el constituyente (solo para organizaciones).
Notas de regalo coincidentes	matching_gift_notes	string	Notas de regalo coincidentes para el constituyente (solo para organizaciones).
Edad	age	integer	La edad del constituyente, calculada en función de la propiedad birthdate (solo para individuos).
¿Difunto?	deceased	boolean	¿Es el constituyente fallecido (solo para individuos)?
Día	deceased_date.d	integer	El día en la fecha aproximada.
month	deceased_date.m	integer	Mes en la fecha aproximada.
año	deceased_date.y	integer	Año en la fecha aproximada.
Estado de recaudación de fondos	fundraiser_status	string	Indica si el constituyente es un recaudador de fondos (solo para individuos).
identificación	spouse.id	string	El identificador de registro del sistema del cónyuge.
nombre	spouse.first	string	Nombre del cónyuge.
apellido	spouse.last	string	Apellidos del cónyuge.
¿es el jefe del hogar?	spouse.is_head_of_household	boolean	¿Es el cónyuge el jefe del hogar?
Fecha de adición	date_added	date-time	Fecha en que se creó el constituyente.
Fecha de modificación	date_modified	date-time	Fecha en la que se modificó por última vez el constituyente.

ConstituentApi.CreatedAction

Acción creada

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de la acción recién creada.

ConstituentApi.CreatedActionAttachment

Datos adjuntos de acción creados

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de los datos adjuntos de la acción recién creada.

ConstituentApi.CreatedActionCustomField

Campo personalizado de acción creado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador del campo personalizado de acción recién creado.

ConstituentApi.CreatedConstituentAddress

Dirección constituyente creada

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de la dirección constituyente recién creada.

ConstituentApi.CreatedConstituentAlias

Alias constituyente creado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador del alias constituyente recién creado.

ConstituentApi.CreatedConstituentAttachment

Datos adjuntos constituyentes creados

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de los datos adjuntos constituyentes recién creados.

ConstituentApi.CreatedConstituentCode

Código constituyente creado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador del código constituyente recién creado.

ConstituentApi.CreatedConstituentCustomField

Campo personalizado constituyente creado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador del campo personalizado constituyente recién creado.

ConstituentApi.CreatedConstituentEducation

Creación de educación constituyente

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de la educación constituyente recién creada.

ConstituentApi.CreatedConstituentEmailAddress

Dirección de correo electrónico constituyente creada

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de la dirección de correo electrónico constituyente recién creada.

ConstituentApi.CreatedConstituentNote

Nota constituyente creada

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de la nota constituyente recién creada.

ConstituentApi.CreatedConstituentOnlinePresence

Creación de presencia en línea constituyente

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de la presencia en línea constituyente recién creada.

ConstituentApi.CreatedConstituentPhone

Teléfono constituyente creado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador del teléfono constituyente recién creado.

ConstituentApi.CreatedConstituentRating

Se creó la clasificación constituyente

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de la clasificación constituyente recién creada.

ConstituentApi.CreatedIndividualConstituent

Creación de un componente individual

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador del constituyente individual recién creado.

ConstituentApi.CreatedIndividualRelationship

Relación individual creada

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de la relación individual recién creada.

ConstituentApi.CreatedOrganizationConstituent

Creación de un componente de la organización

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	El identificador del componente de la organización recién creada.

ConstituentApi.CreatedOrganizationRelationship

Relación de organización creada

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de la relación de organización recién creada.

ConstituentApi.EducationRead

Education

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del ámbito educativo.
Identificador constituyente	constituent_id	string	Identificador de registro del sistema del componente asociado a la educación.
Escuela	school	string	El nombre de la escuela o el establecimiento.
Tipo	type	string	Tipo de educación.
Clase de	class_of	string	El año que el constituyente se graduó.
Estado	status	string	El estado de la educación.
Día	date_entered.d	integer	El día en la fecha aproximada.
month	date_entered.m	integer	Mes en la fecha aproximada.
año	date_entered.y	integer	Año en la fecha aproximada.
Día	date_left.d	integer	El día en la fecha aproximada.
month	date_left.m	integer	Mes en la fecha aproximada.
año	date_left.y	integer	Año en la fecha aproximada.
Día	date_graduated.d	integer	El día en la fecha aproximada.
month	date_graduated.m	integer	Mes en la fecha aproximada.
año	date_graduated.y	integer	Año en la fecha aproximada.
Grado	degree	string	El grado recibido.
GPA	gpa	double	Promedio de puntos de grado.
Mayores	majors	array of string	Los cursos de estudio principales.
Menores	minors	array of string	Los cursos de estudio menores.
¿La educación primaria es primaria?	primary	boolean	¿Esta es la asociación de la escuela primaria del constituyente?
Campus	campus	string	El campus.
Organización social	social_organization	string	La organización social.
Nombre conocido	known_name	string	Nombre conocido.
Clase de grado	class_of_degree	string	Clase de grado.
Departamento	department	string	Nombre del departamento de educación.
Facultad	faculty	string	Nombre de la facultad.
Número de registro	registration_number	string	Número de registro.
Asunto de estudio	subject_of_study	string	El tema de estudio.
Fecha de adición	date_added	date-time	Fecha en que se creó el ámbito educativo.
Fecha de modificación	date_modified	date-time	Fecha en la que se modificó por última vez la educación.

ConstituentApi.EmailAddressRead

Dirección de correo electrónico

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de la dirección de correo electrónico.
Identificador constituyente	constituent_id	string	Identificador de registro del sistema del componente asociado a la dirección de correo electrónico.
Tipo de correo electrónico	type	string	Tipo de dirección de correo electrónico.
Dirección de correo electrónico	address	string	Dirección de correo electrónico.
¿Primario?	primary	boolean	¿Es la dirección de correo electrónico principal del constituyente?
¿No se envía un correo electrónico?	do_not_email	boolean	¿Se puede contactar con el constituyente en esta dirección de correo electrónico?
¿Inactivo?	inactive	boolean	¿Esta dirección de correo electrónico está inactiva?
Fecha de adición	date_added	date-time	Fecha en que se creó la dirección de correo electrónico.
Fecha de modificación	date_modified	date-time	Fecha en la que se modificó por última vez la dirección de correo electrónico.

ConstituentApi.FileDefinition

Definición de archivo

Nombre	Ruta de acceso	Tipo	Description
Id. de archivo	file_id	string	Identificador del archivo.
URL	file_upload_request.url	string	Dirección URL que se va a usar para la solicitud de carga.
method	file_upload_request.method	string	Método HTTP que se va a usar con la solicitud de carga.
headers	file_upload_request.headers	array of ConstituentApi.Header	Encabezados que se van a proporcionar al realizar la solicitud.
Id. de miniatura	thumbnail_id	string	Identificador de la miniatura.
URL	thumbnail_upload_request.url	string	Dirección URL que se va a usar para la solicitud de carga.
method	thumbnail_upload_request.method	string	Método HTTP que se va a usar con la solicitud de carga.
headers	thumbnail_upload_request.headers	array of ConstituentApi.Header	Encabezados que se van a proporcionar al realizar la solicitud.

ConstituentApi.FundraiserAssignmentRead

Asignación de recaudación de fondos

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de la asignación de recaudación de fondos.
Identificador constituyente	constituent_id	string	El identificador de registro del sistema del constituyente asignado a la recaudación de fondos.
Id. de recaudación de fondos	fundraiser_id	string	El identificador de registro del sistema del recaudador de fondos.
Tipo	type	string	Tipo de recaudación de fondos.
value	amount.value	double	Valor monetario.
Identificador de campaña	campaign_id	string	El identificador de registro del sistema de la campaña a la que se aplicarán los regalos resultantes.
Id. del fondo	fund_id	string	El identificador de registro del sistema del fondo al que deben aplicarse los regalos resultantes. Si se selecciona un fondo restringido, solo se pueden seleccionar campañas y apelaciones asociadas a ese fondo.
Id. de apelación	appeal_id	string	El identificador de registro del sistema del recurso que el recaudador de fondos debe usar para solicitar regalos.
Fecha de inicio	start	date-time	Fecha de inicio de la asignación de recaudación de fondos.
Fecha de finalización	end	date-time	Fecha de finalización de la asignación de recaudación de fondos.

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	Valor monetario.
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.

Encabezado de solicitud usado para cargar los datos adjuntos físicos.

Nombre	Ruta de acceso	Tipo	Description
nombre	name	string	Nombre del encabezado.
value	value	string	Valor del encabezado.

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	Valor monetario.
value	total_pledge_balance.value	double	Valor monetario.
value	total_received_giving.value	double	Valor monetario.
value	total_committed_matching_gifts.value	double	Valor monetario.
value	total_received_matching_gifts.value	double	Valor monetario.
value	total_soft_credits.value	double	Valor monetario.

ConstituentApi.NoteRead

Nota:

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de la nota.
Identificador constituyente	constituent_id	string	Identificador de registro del sistema del componente 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.
Fecha de adición	date_added	date-time	Fecha en que se creó la nota.
Fecha de modificación	date_modified	date-time	Fecha en la que se modificó por última vez la nota.

ConstituentApi.OnlinePresenceRead

Presencia en línea

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de la presencia en línea.
Identificador constituyente	constituent_id	string	Identificador de registro del sistema del componente asociado a la presencia en línea.
Tipo	type	string	Tipo de presencia en línea.
Link	address	string	Dirección web de la presencia en línea.
¿Primario?	primary	boolean	¿Es la presencia en línea principal del constituyente?
¿Inactivo?	inactive	boolean	¿Esta presencia en línea está inactiva?
Fecha de adición	date_added	date-time	Fecha en la que se creó la presencia en línea.
Fecha de modificación	date_modified	date-time	Fecha en la que se modificó por última vez la presencia en línea.

ConstituentApi.PhoneRead

Teléfono

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del teléfono.
Identificador constituyente	constituent_id	string	Identificador de registro del sistema del componente asociado al teléfono.
Tipo	type	string	Tipo de teléfono.
Number	number	string	Número de teléfono.
¿Primario?	primary	boolean	¿Es el teléfono principal del constituyente?
¿No llamas?	do_not_call	boolean	¿Se puede contactar con el constituyente en este número?
¿Inactivo?	inactive	boolean	¿Este número de teléfono está inactivo?
Fecha de adición	date_added	date-time	Fecha en que se creó el teléfono.
Fecha de modificación	date_modified	date-time	Fecha en la que se modificó por última vez el teléfono.

ConstituentApi.ProfilePictureRead

Imagen de perfil

Nombre	Ruta de acceso	Tipo	Description
Identificador constituyente	constituent_id	string	Identificador de registro del sistema del componente asociado a la imagen de perfil.
URL	url	string	Dirección URL de la imagen de perfil. La dirección URL contiene una firma enlazada a tiempo que limita el acceso a 60 minutos.
Url de miniatura	thumbnail_url	string	Dirección URL de una miniatura de la imagen de perfil. Contiene una firma enlazada a tiempo que limita el acceso a 60 minutos.

ConstituentApi.ProspectStatusRead

Estado de la perspectiva

Nombre	Ruta de acceso	Tipo	Description
Estado	status	string	El estado de perspectiva actual del constituyente.
Días transcurridos	days_elapsed	integer	Número total de días en el estado de la perspectiva actual en función de la fecha de inicio.
Fecha de inicio	start	date-time	Fecha de inicio del estado de la perspectiva.
Comentarios	comments	string	Comentarios sobre el estado de la perspectiva.

ConstituentApi.RatingRead

Rating

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de la clasificación.
Identificador constituyente	constituent_id	string	Identificador de registro del sistema del componente asociado a la clasificación.
Fuente	source	string	Origen de la nueva clasificación.
Categoría	category	string	Categoría de la clasificación.
Fecha	date	date-time	Fecha de la clasificación.
Description	value		Valor de la clasificación.
Comentarios	comment	string	Comentario sobre la clasificación.
¿Inactivo?	inactive	boolean	¿La clasificación está inactiva?
Tipo	type	string	Este campo calculado indica el tipo de datos que representa la clasificación en función de la propiedad category.

ConstituentApi.RelationshipRead

Relación

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de la relación.
Identificador constituyente	constituent_id	string	Identificador de registro del sistema del componente asociado a la relación.
Id. de relación	relation_id	string	Identificador de registro del sistema de la persona u organización relacionada.
Id. de relación recíproca	reciprocal_relationship_id	string	Identificador del registro de relación recíproca. Este valor es de solo lectura y se genera automáticamente cuando se crea la relación. Los cambios realizados en este registro también se reflejarán en la recíproca, a excepción de la propiedad de comentarios.
Nombre	name	string	Nombre del constituyente relacionado. Si el constituyente relacionado es un individuo, este será el nombre completo del constituyente en función de la configuración del nombre para mostrar de la organización de destino.
Tipo	type	string	Tipo de relación que representa la relación.
Tipo mutuo	reciprocal_type	string	Describe la relación del constituyente con el constituyente relacionado. Por ejemplo, en una relación entre un constituyente masculino y un hermano femenino, el tipo de relación recíproca sería hermano.
Día	start.d	integer	El día en la fecha aproximada.
month	start.m	integer	Mes en la fecha aproximada.
año	start.y	integer	Año en la fecha aproximada.
Día	end.d	integer	El día en la fecha aproximada.
month	end.m	integer	Mes en la fecha aproximada.
año	end.y	integer	Año en la fecha aproximada.
¿Es cónyuge?	is_spouse	boolean	¿Es el individuo relacionado el cónyuge del constituyente (solo se aplica a las relaciones entre individuos)?
¿Es el jefe constituyente del hogar?	is_constituent_head_of_household	boolean	¿Es el constituyente el jefe del hogar?
¿Es el cónyuge jefe del hogar?	is_spouse_head_of_household	boolean	¿Es el cónyuge el jefe del hogar?
Notas	comment	string	Comentario sobre la relación.
¿Está el contacto?	is_organization_contact	boolean	¿El constituyente representa a esta organización como contacto (solo se aplica a las relaciones entre las organizaciones y las personas)?
¿Es el negocio principal?	is_primary_business	boolean	¿Es el negocio principal del constituyente (solo se aplica a las relaciones entre las organizaciones y las personas)?
Tipo de contacto	organization_contact_type	string	Proporciona contexto para las interacciones con la persona relacionada que representa la organización como contacto. Solo se aplica a las relaciones entre las organizaciones y las personas.
Position	position	string	Posición del individuo en la organización. Solo se aplica a las relaciones entre las organizaciones y las personas.
Fecha de adición	date_added	date-time	Fecha en que se creó la relación.
Fecha de modificación	date_modified	date-time	Fecha en la que se modificó por última vez la relación.

ConstituentApi.SearchResultRead

Resultado de la búsqueda

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del constituyente.
Nombre	name	string	Nombre constituyente. En el caso de las personas, este campo calculado indica el nombre completo del constituyente en función de la configuración del nombre para mostrar de la organización de destino.
Dirección	address	string	Dirección preferida del constituyente.
¿Difunto?	deceased	boolean	¿El constituyente está muerto?
Correo Electrónico	email	string	Dirección de correo electrónico del constituyente.
Estado de recaudación de fondos	fundraiser_status	string	El estado de recaudación de fondos del constituyente. En el caso de las personas, este campo calculado indica si el constituyente es Activo, Inactivo o Ninguno. En el caso de las organizaciones, este valor siempre será Ninguno.
¿Inactivo?	inactive	boolean	¿Está inactivo el constituyente?
Identificador de búsqueda	lookup_id	string	Identificador definido por el usuario para el constituyente.

EventApi.AdministrativeArea

Define el modelo de datos usado para el área administrativa de una dirección (por ejemplo, el estado en EE. UU.).

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del área administrativa.
nombre	name	string	Nombre del área administrativa.
descripción breve	short_description	string	Descripción breve del área administrativa.

EventApi.ApiCollectionOfEventFee

Honorarios

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 EventApi.EventFee	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

EventApi.ApiCollectionOfEventListEntry

Eventos

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 EventApi.EventListEntry	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

EventApi.ApiCollectionOfEventParticipantOption

Opciones del participante del evento

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 EventApi.EventParticipantOption	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

EventApi.ApiCollectionOfParticipantDonation

Donaciones

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 EventApi.ParticipantDonation	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

EventApi.ApiCollectionOfParticipantFee

Honorarios

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 EventApi.ParticipantFee	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

EventApi.ApiCollectionOfParticipantFeePayment

Pagos por cuotas

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 EventApi.ParticipantFeePayment	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

EventApi.ApiCollectionOfParticipantListEntry

Participants

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 EventApi.ParticipantListEntry	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

EventApi.ApiCollectionOfParticipantOption

Opciones de participantes

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 EventApi.ParticipantOption	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

EventApi.Country

Define el modelo de datos usado para el país de una dirección.

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador del registro de país.
nombre para mostrar	display_name	string	Nombre para mostrar del país.
Código ISO	iso_alpha2_code	string	Código alfa-2 ISO 3166-1 para el país.

EventApi.CreatedEvent

Evento creado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador del evento recién creado.

EventApi.CreatedEventFee

Cuota de eventos creada

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de la tarifa del evento recién creado.

EventApi.CreatedEventParticipantOption

Opción de participante del evento creado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de la opción participante del evento recién creado.

EventApi.CreatedParticipant

Participante creado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador del participante recién creado.

EventApi.CreatedParticipantDonation

Donación de participantes creada

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de la donación del participante recién creado.

EventApi.CreatedParticipantFee

Cuota de participante creada

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	El identificador de la cuota de participante recién creada.

EventApi.CreatedParticipantFeePayment

Pago de cuota de participante creado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	El identificador del pago de la cuota del participante recién creado.

EventApi.CreatedParticipantOption

Opción de participante creado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de la opción de participante recién creada.

EventApi.Event

Event

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del evento. Esto no es lo mismo que el identificador de evento definible por el usuario, que se almacena en el lookup_id.
Nombre	name	string	Nombre del evento.
Description	description	string	Descripción del evento.
Fecha de inicio	start_date	date	Fecha de inicio del evento.
Hora de inicio	start_time	string	Hora de inicio del evento.
Fecha de finalización	end_date	date	Fecha de finalización del evento.
Hora de finalización	end_time	string	Hora de finalización del evento.
Categoría	category	EventApi.EventCategory	La categoría de eventos es la categorización personalizada del evento.
Identificador de búsqueda	lookup_id	string	Identificador de búsqueda del evento.
Ubicación	location	EventApi.Location	Define el modelo de datos usado para una ubicación.
Capacidad	capacity	integer	Número de personas que pueden asistir al evento.
Objetivo	goal	double	Objetivo monetario del evento.
Identificador de campaña	campaign_id	string	Identificador de registro del sistema de la campaña asociada al evento.
Id. del fondo	fund_id	string	Identificador de registro del sistema del fondo asociado al evento.
¿Inactivo?	inactive	boolean	¿El evento está inactivo?
Fecha de adición	date_added	date-time	Fecha en que se creó el evento.
Fecha de modificación	date_modified	date-time	Fecha en la que se modificó por última vez el evento.

EventApi.EventCategory

La categoría de eventos es la categorización personalizada del evento.

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de la categoría de eventos.
nombre	name	string	Nombre de la categoría de eventos.
¿inactivo?	inactive	boolean	¿Esta categoría está inactiva?

EventApi.EventFee

Los honorarios de eventos son la cantidad que cobra una organización para que las personas u organizaciones participen o asistan al evento.

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de la tarifa del evento.
nombre	name	string	Nombre de la cuota del evento.
importe	cost	double	El costo de la tarifa.
importe de contribución	contribution_amount	double	El importe del deducible de impuestos para este cargo.
número vendido	number_sold	integer	Número de cuotas vendidas.

EventApi.EventListEntry

Event

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del evento.
Nombre	name	string	Nombre del evento.
Fecha de inicio	start_date	date	Fecha de inicio del evento.
Hora de inicio	start_time	string	Hora de inicio del evento.
Fecha de finalización	end_date	date	Fecha de finalización del evento.
Hora de finalización	end_time	string	Hora de finalización del evento.
Categoría	category	EventApi.EventCategory	La categoría de eventos es la categorización personalizada del evento.
Identificador de búsqueda	lookup_id	string	Identificador de búsqueda del evento.
Capacidad	capacity	integer	Número de personas que pueden asistir al evento.
Concomitante	attending_count	integer	Número de participantes del evento que planean asistir.
Asistido	attended_count	integer	Número de asistentes a eventos.
Invitado	invited_count	integer	Número de invitaciones de eventos.
Ingresos	revenue	double	Los ingresos realizados del evento.
Objetivo	goal	double	Objetivo monetario del evento.
Porcentaje de objetivo	percent_of_goal	integer	Los ingresos obtenidos como porcentaje de los ingresos objetivos.
¿Inactivo?	inactive	boolean	¿El evento está inactivo?
Fecha de adición	date_added	date-time	Fecha en que se creó el evento.
Fecha de modificación	date_modified	date-time	Fecha en la que se modificó por última vez el evento.

EventApi.EventParticipantOption

Las opciones de los participantes del evento son campos que recopilan detalles sobre los participantes, como tamaños de camiseta, preferencias de comida o solicitudes de asiento. Establezca las opciones y sus valores para un evento y agregue respuestas para cada participante.

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de la opción del participante del evento.
nombre	name	string	Nombre de la opción participante del evento.
tipo de entrada	input_type	string	Tipo de la opción participante del evento.
permitir selección múltiple?	multi_select	boolean	¿Permite más de un valor para las listas?
list_options	list_options	array of EventApi.EventParticipantOptionListOption	Las opciones de lista disponibles.
agregado por el usuario	added_by_user	string	Identificador del usuario que agregó la opción.
modificado por el usuario	updated_by_user	string	Identificador del usuario que modificó la opción.
agregado por servicio	added_by_service	string	Nombre del servicio que agregó esta opción.
modificado por servicio	updated_by_service	string	Nombre del servicio que modificó esta opción.
fecha agregada	date_added	date-time	Fecha en que se creó la opción.
fecha de modificación	date_updated	date-time	Fecha en la que se modificó por última vez la opción.
version	version	integer	Número de versión de la opción.

EventApi.EventParticipantOptionListOption

Una opción de lista de opciones de participante de eventos

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de la opción de lista
nombre	name	string	Nombre de la opción de lista
secuencia	sequence	integer	Secuencia usada para ordenar las opciones de lista

EventApi.Locality

Define el modelo de datos usado para la localidad de una dirección.

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del registro de localidad.
nombre	name	string	Nombre de la localidad.

EventApi.Location

Define el modelo de datos usado para una ubicación.

Nombre	Ruta de acceso	Tipo	Description
nombre	name	string	Nombre de la ubicación.
líneas de dirección	address_lines	string	Líneas de direcciones de la ubicación.
código postal	postal_code	string	El código postal de la ubicación.
localidad	locality	EventApi.Locality	Define el modelo de datos usado para la localidad de una dirección.
área administrativa	administrative_area	EventApi.AdministrativeArea	Define el modelo de datos usado para el área administrativa de una dirección (por ejemplo, el estado en EE. UU.).
Área subadministración	sub_administrative_area	EventApi.SubAdministrativeArea	Define el modelo de datos usado para el área subadministración de una dirección (por ejemplo, ciudad de EE. UU.).
country	country	EventApi.Country	Define el modelo de datos usado para el país de una dirección.
dirección con formato	formatted_address	string	Dirección con formato de la ubicación

EventApi.Membership

Información de pertenencia para el participante.

Nombre	Ruta de acceso	Tipo	Description
Categoría de pertenencia	category	EventApi.MembershipCategory	Categoría de pertenencia del individuo.

EventApi.MembershipCategory

Categoría de pertenencia del individuo.

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de la categoría de pertenencia.
nombre	name	string	Nombre de la categoría de pertenencia.

EventApi.Participant

Participante

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del participante.
Identificador constituyente	constituent_id	string	Identificador constituyente del participante.
Id. del evento	event_id	string	Identificador de registro del sistema del evento al que se va a asistir.
Id. de host	host_id	string	Identificador del registro de participante del host.
Estado de RSVP	rsvp_status	string	Estado de la interacción del participante con el evento.
¿Asistieron?	attended	boolean	¿El participante asistió al evento?
Estado de la invitación	invitation_status	string	Estado de la invitación al participante.
Día	rsvp_date.d	integer	El día en la fecha aproximada.
month	rsvp_date.m	integer	Mes en la fecha aproximada.
año	rsvp_date.y	integer	Año en la fecha aproximada.
Día	invitation_date.d	integer	El día en la fecha aproximada.
month	invitation_date.m	integer	Mes en la fecha aproximada.
año	invitation_date.y	integer	Año en la fecha aproximada.
Nivel de participación	participation_level	EventApi.ParticipationLevel	Los niveles de participación son el nivel de participación que tienen los participantes en un evento.
Fecha de adición	date_added	date-time	Fecha en que se creó el participante.
Fecha de modificación	date_modified	date-time	Fecha en que el participante se modificó por última vez.

EventApi.ParticipantDonation

Define un modelo de datos para una donación de participantes

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de la donación del participante.
id. de regalo	gift_id	string	Identificador de registro del sistema del regalo al que está vinculado la donación del participante.

EventApi.ParticipantFee

Define un modelo de datos para una cuota de participante

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	El identificador de la cuota del participante.
id. de participante	participant_id	string	Identificador del registro al que está vinculado la cuota del participante.
quantity	quantity	integer	La cantidad comprada.
importe de la tarifa	fee_amount	double	Importe de la cuota del participante.
importe de contribución	tax_receiptable_amount	double	El importe del deducible de impuestos para este cargo.
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.
Cuota de eventos	event_fee	EventApi.EventFee	Los honorarios de eventos son la cantidad que cobra una organización para que las personas u organizaciones participen o asistan al evento.

EventApi.ParticipantFeePayment

Define un modelo de datos para un pago de cuota de participante

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	El identificador de registro del sistema del pago de la cuota del participante.
id. de participante	participant_id	string	Identificador de registro del sistema del participante al que está vinculado el pago de la cuota del participante.
id. de regalo	gift_id	string	El identificador de registro del sistema del regalo al que está vinculado el pago de la cuota del participante.
importe aplicado	applied_amount	double	Importe aplicado del pago de la cuota de participante.

EventApi.ParticipantListEntry

Participante

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del participante.
ID de contacto	contact_id	string	Identificador del contacto que asiste al evento.
Estado de RSVP	rsvp_status	string	Estado de la interacción del participante con el evento.
¿Asistieron?	attended	boolean	¿El participante asistió al evento?
Estado de la invitación	invitation_status	string	Estado de la invitación al participante.
Día	rsvp_date.d	integer	El día en la fecha aproximada.
month	rsvp_date.m	integer	Mes en la fecha aproximada.
año	rsvp_date.y	integer	Año en la fecha aproximada.
Nivel de participación	participation_level	EventApi.ParticipationLevel	Los niveles de participación son el nivel de participación que tienen los participantes en un evento.
Title	title	string	Título del participante.
Nombre	first_name	string	Nombre del participante.
Apellido	last_name	string	Apellidos del participante.
Nombre	name	string	Nombre completo del participante.
Nombre preferido	preferred_name	string	Nombre preferido del participante.
Sufijo	suffix	string	Sufijo del participante.
Identificador de búsqueda	lookup_id	string	LookupId del participante.
Correo Electrónico	email	string	Dirección de correo electrónico del participante.
¿No se envía un correo electrónico?	do_not_email	boolean	¿Puede ponerse en contacto con el participante en esta dirección de correo electrónico?
Teléfono	phone	string	Número de teléfono del participante.
¿No llamas?	do_not_call	boolean	¿Puede ponerse en contacto con el participante en este número?
Segundo nombre	middle_name	string	Nombre intermedio del participante.
Nombre anterior	former_name	string	Nombre anterior del participante.
¿Es constituyente?	is_constituent	boolean	¿Es el participante un constituyente?
Clase de	class_of	string	La clase de graduación del participante.
Total de tarifas de registro	total_registration_fees	double	La suma de los importes de la cuota del participante.
Total pagado	total_paid	double	La suma de los regalos pagados por el participante con un tipo de cuotas de registro.
Asiento	seat	string	Asignación de asiento para el participante.
Etiqueta de nombre	name_tag	string	Etiqueta de nombre para el participante
Fecha de adición	date_added	date-time	Fecha en que se creó el participante.
Fecha de modificación	date_modified	date-time	Fecha en que el participante se modificó por última vez.
id. de contacto	host.contact_id	string	Identificador del contacto que asiste al evento.
id. de participante	host.participant_id	string	Identificador del participante.
nombre	host.name	string	Nombre completo del participante.
Huéspedes	guests	array of EventApi.ParticipantListParticipantSummary	Los invitados del participante.
Membresías	memberships	array of EventApi.Membership	La información de pertenencia del participante.

EventApi.ParticipantListParticipantSummary

Información de resumen básica del participante.

Nombre	Ruta de acceso	Tipo	Description
id. de contacto	contact_id	string	Identificador del contacto que asiste al evento.
id. de participante	participant_id	string	Identificador del participante.
nombre	name	string	Nombre completo del participante.

EventApi.ParticipantOption

La opción de participante asociada a un participante determinado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de la opción participante.
id. de participante	participant_id	string	Identificador de registro del sistema del participante.
id. de evento	event_id	string	Identificador de registro del sistema del evento.
id. de opción del participante del evento	event_participant_option_id	string	Identificador de registro del sistema de la opción del participante del evento.
value	option_value	string	Respuesta del participante a la opción.
agregado por el usuario	added_by_user	string	Identificador del usuario que agregó la opción participante.
modificado por el usuario	updated_by_user	string	Identificador del usuario que modificó la opción participante.
agregado por servicio	added_by_service	string	Nombre del servicio que agregó esta opción de participante.
modificado por servicio	updated_by_service	string	Nombre del servicio que modificó esta opción de participante.
fecha agregada	date_added	date-time	Fecha en que se creó la opción de participante.
fecha de modificación	date_updated	date-time	Fecha en la que se modificó por última vez la opción participante.

EventApi.ParticipationLevel

Los niveles de participación son el nivel de participación que tienen los participantes en un evento.

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del nivel de participación.
nombre	name	string	Nombre del nivel de participación.
¿inactivo?	is_inactive	boolean	¿El nivel de participación está inactivo?

EventApi.SubAdministrativeArea

Define el modelo de datos usado para el área subadministración de una dirección (por ejemplo, ciudad de EE. UU.).

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador del área subadministración.
nombre	name	string	Nombre del área subadministración.

Recaudación de fondosApi.ApiCollectionOfAppealAttachmentRead

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 FundraisingApi.AppealAttachmentRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

Recaudación de fondosApi.ApiCollectionOfAppealCustomFieldRead

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 FundraisingApi.AppealCustomFieldRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

Recaudación de fondosApi.ApiCollectionOfAppealRead

Apelaciones

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 FundraisingApi.AppealRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

Recaudación de fondosApi.ApiCollectionOfCampaignAttachmentRead

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 FundraisingApi.CampaignAttachmentRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

Recaudación de fondosApi.ApiCollectionOfCampaignCustomFieldRead

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 FundraisingApi.CampaignCustomFieldRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

Recaudación de fondosApi.ApiCollectionOfCampaignRead

Campañas

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 FundraisingApi.CampaignRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

Recaudación de fondosApi.ApiCollectionOfFundAttachmentRead

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 FundraisingApi.FundAttachmentRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

Recaudación de fondosApi.ApiCollectionOfFundCustomFieldRead

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 FundraisingApi.FundCustomFieldRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

Recaudación de fondosApi.ApiCollectionOfFundRead

Fondos

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 FundraisingApi.FundRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

Recaudación de fondosApi.ApiCollectionOfFundraiserAssignmentRead

Assignments

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 FundraisingApi.FundraiserAssignmentRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

Recaudación de fondosApi.ApiCollectionOfPackageRead

Packages

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 FundraisingApi.PackageRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

Recaudación de fondosApi.AppealAttachmentRead

Datos adjuntos

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de los datos adjuntos.
Id. de apelación	parent_id	string	Identificador de registro del sistema del recurso 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.

Recaudación de fondosApi.AppealCustomFieldRead

Campo personalizado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del campo personalizado.
Id. de apelación	parent_id	string	Identificador de registro del sistema del recurso 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.
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.

Recaudación de fondosApi.AppealRead

Appeal

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	El identificador de registro del sistema del recurso.
Categoría	category	string	Categoría del recurso.
Fecha de adición	date_added	date-time	Fecha en que se creó la apelación.
Fecha de modificación	date_modified	date-time	Fecha en que se modificó por última vez la apelación.
Description	description	string	Nombre para mostrar del recurso.
Fecha de finalización	end_date	date-time	Fecha de finalización del recurso.
value	goal.value	double	Valor monetario.
¿Inactivo?	inactive	boolean	¿Está activa la apelación (es decir, la fecha actual es posterior a cualquier fecha de inicio y antes de cualquier fecha de finalización)?
Identificador de búsqueda	lookup_id	string	Identificador definido por el usuario para la apelación.
Fecha de inicio	start_date	date-time	Fecha de inicio del recurso.

Recaudación de fondosApi.CampaignAttachmentRead

Datos adjuntos

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de los datos adjuntos.
Identificador de campaña	parent_id	string	Identificador de registro del sistema de la campaña asociada 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.

Recaudación de fondosApi.CampaignCustomFieldRead

Campo personalizado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del campo personalizado.
Identificador de campaña	parent_id	string	Identificador de registro del sistema de la campaña asociada 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.
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.

Recaudación de fondosApi.CampaignRead

Campaña

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de la campaña.
Categoría	category	string	Categoría de la campaña.
Fecha de adición	date_added	date-time	Fecha en que se creó la campaña.
Fecha de modificación	date_modified	date-time	Fecha en la que se modificó por última vez la campaña.
Description	description	string	Nombre para mostrar de la campaña.
Fecha de finalización	end_date	date-time	Fecha de finalización de la campaña.
value	goal.value	double	Valor monetario.
¿Inactivo?	inactive	boolean	¿La campaña está inactiva (es decir, la fecha actual es posterior a cualquier fecha de inicio y antes de cualquier fecha de finalización)?
Identificador de búsqueda	lookup_id	string	Identificador definido por el usuario para la campaña.
Fecha de inicio	start_date	date-time	Fecha de inicio de la campaña.

Recaudación de fondosApi.CreatedAppealAttachment

Datos adjuntos de apelación creados

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de los datos adjuntos de apelación recién creados.

Recaudación de fondosApi.CreatedAppealCustomField

Campo personalizado de apelación creado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador del campo personalizado de apelación recién creado.

Recaudación de fondosApi.CreatedCampaignAttachment

Datos adjuntos de campaña creados

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de los datos adjuntos de la campaña recién creada.

Recaudación de fondosApi.CreatedCampaignCustomField

Campo personalizado de campaña creado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador del campo personalizado de campaña recién creado.

Recaudación de fondosApi.CreatedFundraiserAssignment

Asignación de recaudación de fondos creada

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de la asignación de recaudación de fondos recién creada.

Recaudación de fondosApi.CreatedFundAttachment

Datos adjuntos de fondos creados

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de los datos adjuntos del fondo recién creado.

Recaudación de fondosApi.CreatedFundCustomField

Campo personalizado de fondo creado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador del campo personalizado del fondo recién creado.

Recaudación de fondosApi.FundraiserAssignmentRead

Asignación

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de la asignación de recaudación de fondos.
Identificador constituyente	constituent_id	string	Identificador de registro del sistema del componente asignado.
Tipo	type	string	Tipo de recaudación de fondos.
Inicio de la asignación	start	date-time	Fecha de inicio de la asignación.
Finaliza la asignación	end	date-time	Fecha de finalización de la asignación.
value	amount.value	double	Valor monetario.
Identificador de campaña	campaign_id	string	Identificador de registro del sistema de la campaña a la que se aplicarán los regalos resultantes.
Id. del fondo	fund_id	string	Identificador de registro del sistema del fondo al que se aplicarán los regalos resultantes.
Id. de apelación	appeal_id	string	Identificador de registro del sistema del recurso al que se aplicarán los regalos resultantes.

Recaudación de fondosApi.FundAttachmentRead

Datos adjuntos

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de los datos adjuntos.
Id. del fondo	parent_id	string	Identificador de registro del sistema del fondo 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.

Recaudación de fondosApi.FundCustomFieldRead

Campo personalizado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del campo personalizado.
Id. del fondo	parent_id	string	Identificador de registro del sistema del fondo 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.
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.

Recaudación de fondosApi.FundRead

Fondo

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del fondo.
Categoría	category	string	Categoría del fondo.
Fecha de adición	date_added	date-time	Fecha en que se creó el fondo.
Fecha de modificación	date_modified	date-time	Fecha en la que se modificó por última vez el fondo.
Description	description	string	Nombre para mostrar del fondo.
Fecha de finalización	end_date	date-time	Fecha de finalización del fondo.
value	goal.value	double	Valor monetario.
¿Inactivo?	inactive	boolean	¿El fondo está inactivo (es decir, la fecha actual es posterior a cualquier fecha de inicio y antes de cualquier fecha de finalización)?
Identificador de búsqueda	lookup_id	string	Identificador definido por el usuario para el fondo.
Fecha de inicio	start_date	date-time	Fecha de inicio del fondo.
Tipo	type	string	Tipo del fondo.

Recaudación de fondosApi.PackageRead

Package

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del paquete.
Id. de apelación	appeal_id	string	Identificador de registro del sistema del recurso asociado a este paquete.
Categoría	category	string	Categoría del paquete.
Fecha de adición	date_added	date-time	Fecha en que se creó el paquete.
Fecha de modificación	date_modified	date-time	Fecha en la que se modificó por última vez el paquete.
value	default_gift_amount.value	double	Valor monetario.
Description	description	string	Nombre para mostrar del paquete.
Fecha de finalización	end	date-time	Fecha de finalización del paquete.
value	goal.value	double	Valor monetario.
¿Inactivo?	inactive	boolean	¿El paquete está inactivo (es decir, la fecha actual es posterior a cualquier fecha de inicio y antes de cualquier fecha de finalización)?
Identificador de búsqueda	lookup_id	string	Identificador definido por el usuario para el paquete.
Notas	notes	string	Notas del paquete.
Recuento de destinatarios	recipient_count	integer	Número de destinatarios del paquete.
Fecha de inicio	start	date-time	Fecha de inicio del paquete.

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	Valor monetario.
value	balance.value	double	Valor monetario.
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	Valor monetario.
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

Datos adjuntos

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.

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.
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	Valor monetario.
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	Valor monetario.
value	balance.value	double	Valor monetario.
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	Valor monetario.
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	Valor monetario.
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	Valor monetario.
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	Valor monetario.
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	Valor monetario.
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.

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.

ListApi.CreatedList

Lista creada

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de la lista recién creada.

OpportunityApi.ApiCollectionOfOpportunityAttachmentRead

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 OpportunityApi.OpportunityAttachmentRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead

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 OpportunityApi.OpportunityCustomFieldRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

OpportunityApi.ApiCollectionOfOpportunityRead

Oportunidades

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 OpportunityApi.OpportunityRead	Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección.

OpportunityApi.CreatedOpportunity

Oportunidad creada

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de la oportunidad recién creada.

OpportunityApi.CreatedOpportunityAttachment

Datos adjuntos de oportunidades creados

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de los datos adjuntos de oportunidad recién creados.

OpportunityApi.CreatedOpportunityCustomField

Datos adjuntos de oportunidades creados

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de los datos adjuntos de oportunidad recién creados.

OpportunityApi.Fundraiser

Recaudación de fondos

Nombre	Ruta de acceso	Tipo	Description
Identificador constituyente	constituent_id	string	El identificador de registro del sistema del constituyente asociado a la recaudación de fondos.
value	credit_amount.value	double	Valor monetario.

OpportunityApi.OpportunityAttachmentRead

Datos adjuntos

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de los datos adjuntos.
Id. de oportunidad	parent_id	string	Identificador de registro del sistema de la oportunidad asociada 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.

OpportunityApi.OpportunityCustomFieldRead

Campo personalizado

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema del campo personalizado.
Id. de oportunidad	parent_id	string	Identificador de registro del sistema de la oportunidad asociada 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.
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.

OpportunityApi.OpportunityRead

Oportunidad

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador de registro del sistema de la oportunidad.
Identificador constituyente	constituent_id	string	Identificador de registro del sistema del componente asociado a la oportunidad.
Propósito	purpose	string	El uso previsto para cualquier dinero generado como resultado de la oportunidad.
Nombre	name	string	Nombre que identifica la oportunidad en todo el programa, como en listas o en registros constituyentes. Límite de caracteres: 255.
Estado	status	string	Estado que indica dónde se encuentra la oportunidad en el proceso de solicitud.
Fecha límite	deadline	date-time	La fecha de meta para la oportunidad de dar lugar a un regalo.
Preguntar fecha	ask_date	date-time	Fecha en que se realizó la solicitud.
value	ask_amount.value	double	Valor monetario.
Fecha prevista	expected_date	date-time	Fecha en la que se espera que la perspectiva dé respuesta a la oportunidad.
value	expected_amount.value	double	Valor monetario.
Fecha de financiación	funded_date	date-time	Fecha en que la perspectiva dio respuesta a la oportunidad.
value	funded_amount.value	double	Valor monetario.
Identificador de campaña	campaign_id	string	Identificador de registro del sistema de la campaña asociada a la oportunidad. La campaña establece los objetivos generales para aumentar el dinero.
Id. del fondo	fund_id	string	Identificador de registro del sistema del fondo asociado a la oportunidad. El fondo designa el propósito financiero específico de un regalo e identifica la cuenta financiera de ese regalo.
Recaudación de fondos	fundraisers	array of OpportunityApi.Fundraiser	Conjunto de identificadores de registro del sistema para los recaudadores de fondos asignados a la oportunidad.
¿Inactivo?	inactive	boolean	¿La oportunidad está inactiva?
linked_gifts	linked_gifts	array of string	Los identificadores de registro del sistema de los regalos relacionados con la oportunidad.
Fecha de adición	date_added	date-time	Fecha en que se creó la oportunidad.
Fecha de modificación	date_modified	date-time	Fecha en la que se modificó por última vez la oportunidad.

Compartir a través de

Blackbaud Raisers Edge PREVIEW (versión preliminar)

Prerrequisitos

¿Cómo obtener credenciales?

Problemas y limitaciones conocidos

Limitaciones

Acciones

Actualización de datos adjuntos de apelación

Parámetros

Actualización de un alias constituyente

Parámetros

Actualización de un campo personalizado constituyente

Parámetros

Actualización de un campo personalizado de apelación

Parámetros

Actualización de un código constituyente

Parámetros

Actualización de un código de solicitud constituyente

Parámetros

Actualización de una educación constituyente

Parámetros

Actualización de una oportunidad

Parámetros

Actualización de una relación constituyente

Parámetros

Actualizar datos adjuntos constituyentes

Parámetros

Actualizar datos adjuntos de oportunidades

Parámetros

Actualizar datos adjuntos de regalo

Parámetros

Actualizar datos adjuntos de un fondo

Parámetros

Actualizar datos adjuntos de una acción

Parámetros

Actualizar datos adjuntos de una campaña

Parámetros

Actualizar detalles de confirmación de regalo

Parámetros

Actualizar los detalles del recibo de regalo

Parámetros

Actualizar un campo personalizado de acción

Parámetros

Actualizar un campo personalizado de campaña

Parámetros

Actualizar un campo personalizado de fondo

Parámetros

Actualizar un campo personalizado de oportunidades

Parámetros

Actualizar un campo personalizado de regalo

Parámetros

Actualizar un componente

Parámetros

Actualizar un evento

Parámetros

Actualizar un participante

Parámetros

Actualizar un teléfono constituyente

Parámetros

Actualizar una acción constituyente

Parámetros

Actualizar una dirección constituyente

Parámetros

Actualizar una dirección de correo electrónico constituyente

Parámetros

Actualizar una imagen de perfil constituyente

Parámetros

Actualizar una nota constituyente

Parámetros

Actualizar una opción de participante

Parámetros

Actualizar una presencia en línea constituyente

Parámetros

Agregar registros a una lista

Parámetros

Agregar un regalo al lote

Parámetros

Devoluciones

Buscar un constituyente

Parámetros