다음을 통해 공유


Blackbaud Raisers Edge NXT(미리 보기)

Blackbaud Raiser's Edge NXT는 비영리 단체와 전체 사회적 선의의 커뮤니티를 위해 특별히 구축된 포괄적인 클라우드 기반 모금 및 기부자 관리 소프트웨어 솔루션입니다.

이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.

서비스 클래스 Regions
Copilot Studio Premium 다음을 제외한 모든 Power Automate 지역 :
     - 미국 정부(GCC)
     - 미국 정부(GCC High)
     - 21Vianet에서 운영하는 중국 클라우드
     - 미국 국방부(DoD)
논리 앱 스탠다드 다음을 제외한 모든 Logic Apps 지역 :
     - Azure Government 지역
     - Azure 중국 지역
     - 미국 국방부(DoD)
Power Apps Premium 다음을 제외한 모든 Power Apps 지역 :
     - 미국 정부(GCC)
     - 미국 정부(GCC High)
     - 21Vianet에서 운영하는 중국 클라우드
     - 미국 국방부(DoD)
Power Automate Premium 다음을 제외한 모든 Power Automate 지역 :
     - 미국 정부(GCC)
     - 미국 정부(GCC High)
     - 21Vianet에서 운영하는 중국 클라우드
     - 미국 국방부(DoD)
연락처
이름 Blackbaud 지원
URL https://www.blackbaud.com/support
전자 메일 skyapi@blackbaud.com
커넥터 메타데이터
게시자 Blackbaud, Inc.
웹 사이트 https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
개인 정보 보호 정책 https://www.blackbaud.com/privacy-shield
카테고리 판매 및 CRM; 생산력

Raiser's Edge NXT 는 비영리 단체와 전체 사회적 선의의 커뮤니티를 위해 특별히 구축된 포괄적인 클라우드 기반 모금 및 기부자 관리 소프트웨어 솔루션입니다.

이 커넥터는 Blackbaud의 SKY API를 기반으로 하며 다음을 포함하여 Raiser의 Edge NXT 내에 있는 엔터티를 관리하는 데 도움이 되는 작업을 제공합니다.

  • 성분
  • 선물
  • 활동
  • 비고
  • 사용자 지정 필드
  • 캠페인
  • 자금
  • 이의 제기
  • 그 외의 여러 작업...

자세한 내용은 설명서를 참조하세요.

필수 조건

이 커넥터를 사용하려면 하나 이상의 Blackbaud 환경에 액세스할 수 있는 Blackbaud ID 계정이 있어야 합니다.

또한 조직의 관리자는 시스템 내에서 관리자 수준 작업을 수행하여 이 커넥터가 Raiser의 Edge NXT에 액세스할 수 있도록 해야 합니다. 이러한 필수 구성 요소에 대한 자세한 내용은 초기 설치 설명서에서 확인할 수 있습니다.

자격 증명을 가져오는 방법

조직의 관리자는 조직의 Raiser Edge NXT 환경에 초대를 보내고 환경 내에서 사용자 계정 권한을 구성합니다. 이 커넥터를 사용하려면 추가 자격 증명이 필요하지 않습니다.

알려진 문제 및 제한 사항

커넥터는 사용자 계정의 컨텍스트에서 작동하므로 환경 내에서 사용자 권한이 적용됩니다.

제한 한도

Name 호출 갱신 기간
연결당 API 호출 500 60초

동작

가장 큰 선물을 얻습니다.

구성 요소에 대한 가장 큰 선물을 반환합니다.

개별 관계 만들기

새 개별 관계를 만듭니다. 관계가 다른 구성 요소와 인 경우 해당 구성 요소에 대한 상호 관계가 만들어집니다.

개별 구성 요소 만들기

새 개별 구성 요소를 만듭니다.

구성 교육 만들기

새 구성 교육을 만듭니다.

구성 교육 목록

구성 요소에 대한 교육 레코드를 나열합니다.

구성 교육 업데이트

구성 교육을 업데이트합니다.

구성 요소 가져오기

구성 요소에 대한 정보를 반환합니다.

구성 요소 검색

제공된 검색 텍스트를 기반으로 구성 요소 검색을 수행합니다. 이름, 성, 기본 설정 이름, 이전 이름, 별칭, 전자 메일 주소, 전화 번호, 주소 또는 조회 ID를 지원합니다. 이름, 성, 기본 이름 및 성 등의 이름 조합은 유효하지만, 그렇지 않으면 검색에서 한 번에 하나의 매개 변수만 지원합니다. 기본적으로 검색에는 조건과 비슷한 결과가 포함됩니다. 예를 들어 "Smith"에 대한 검색에는 "Smyth" 및 기타 대체 맞춤법의 일치 항목이 포함됩니다. 이 검색은 * 또는 ?와 같은 와일드카드 문자를 지원하지 않습니다. 검색 결과는 500개 레코드로 제한됩니다.

구성 요소 관계 나열

구성 요소의 관계를 나열합니다.

구성 요소 관계 업데이트

구성 요소에 대한 관계를 업데이트합니다. 상호 관계가 있는 경우 변경 내용을 반영하도록 수정됩니다. 여기에는 각 레코드와 관련이 있으며 각 레코드에서 독립적으로 수정할 수 있는 "comments" 속성에 대한 변경 내용은 포함되지 않습니다.

구성 요소 기금 모금 행사 나열

구성 요소에 대한 모금 행사 할당을 나열합니다.

구성 요소 나열

구성 요소 목록을 반환합니다.

구성 요소 노트 나열

구성 요소의 노트를 나열합니다.

구성 요소 노트 만들기

새 구성 요소를 만듭니다.

구성 요소 노트 업데이트

구성 요소를 업데이트합니다.

구성 요소 동의 레코드 나열

구성 요소에 대한 동의 레코드를 나열합니다.

구성 요소 동의 레코드 만들기

새 구성 요소 동의 레코드를 만듭니다.

구성 요소 등급 나열

구성 요소에 대한 등급 목록을 반환합니다.

구성 요소 등급 만들기

새 구성 요소 등급을 만듭니다.

구성 요소 별칭 나열

구성 요소의 별칭을 나열합니다.

구성 요소 별칭 만들기

새 구성 요소 별칭을 만듭니다.

구성 요소 별칭 업데이트

구성 요소 별칭을 업데이트합니다.

구성 요소 사용자 정의 필드 나열

구성 요소에 대한 사용자 지정 필드를 나열합니다.

구성 요소 사용자 정의 필드 만들기

새 구성 요소 사용자 정의 필드를 만듭니다.

구성 요소 사용자 정의 필드 업데이트

구성 요소 사용자 정의 필드를 업데이트합니다.

구성 요소 수명 제공 받기

구성 요소에 대한 수명 제공 요약을 반환합니다.

구성 요소 업데이트

구성 요소를 업데이트합니다.

구성 요소 온라인 프레즌스 만들기

새 구성 요소 온라인 현재 상태를 만듭니다.

구성 요소 온라인 현재 상태 나열

구성 요소의 온라인 현재 상태를 나열합니다.

구성 요소 온라인 현재 상태 업데이트

구성 요소 온라인 현재 상태를 업데이트합니다.

구성 요소 요청 코드 나열

구성 요소에 대한 요청 코드를 나열합니다.

구성 요소 요청 코드 만들기

새 구성 요소 요청 코드를 만듭니다.

구성 요소 요청 코드 업데이트

구성 요소 요청 코드를 업데이트합니다.

구성 요소 작업 가져오기

구성 요소 작업에 대한 정보를 반환합니다.

구성 요소 작업 나열

구성 요소에 대한 작업을 나열합니다.

구성 요소 작업 만들기

새 구성 요소를 만듭니다.

구성 요소 작업 업데이트

구성 요소를 업데이트합니다.

구성 요소 전자 메일 주소 나열

구성 요소의 전자 메일 주소를 나열합니다.

구성 요소 전자 메일 주소 만들기

새 구성 전자 메일 주소를 만듭니다.

구성 요소 전자 메일 주소 업데이트

구성 요소 전자 메일 주소를 업데이트합니다.

구성 요소 주소 나열

구성 요소의 주소를 나열합니다.

구성 요소 주소 만들기

새 구성 요소를 만듭니다.

구성 요소 주소 업데이트

구성 요소를 업데이트합니다.

구성 요소 첨부 파일 나열

구성 요소에 대한 첨부 파일을 나열합니다.

구성 요소 첨부 파일 만들기

새 구성 요소 첨부 파일을 만듭니다.

구성 요소 첨부 파일 업데이트

구성 요소 첨부 파일을 업데이트합니다.

구성 요소 첫 번째 선물 받기

구성 요소의 첫 번째 선물을 반환합니다.

구성 요소 최신 선물 받기

구성 요소에 대한 최신 선물을 반환합니다.

구성 요소 코드 나열

구성 요소의 구성 요소를 나열합니다.

구성 요소 코드 만들기

새 구성 요소를 만듭니다.

구성 요소 코드 삭제

구성 요소를 삭제합니다.

구성 요소 코드 업데이트

구성 요소를 업데이트합니다.

구성 요소 프로필 사진 가져오기

구성 요소의 현재 프로필 그림을 반환합니다.

구성 요소 프로필 사진 업데이트

구성 요소의 현재 프로필 사진을 업데이트합니다.

구성 전망 상태 가져오기

구성 요소의 현재 전망 상태를 반환합니다.

구성 전화 나열

구성 요소의 휴대폰을 나열합니다.

구성 전화 만들기

새 구성 전화기를 만듭니다.

구성 전화 업데이트

구성 전화기를 업데이트합니다.

기금 모금 과제 나열

기금 모금 행사의 과제를 나열합니다.

기금 받기

펀드에 대한 정보를 반환합니다.

기금 첨부 파일 나열

펀드에 대한 첨부 파일을 나열합니다.

기금 첨부 파일 만들기

새 펀드 첨부 파일을 만듭니다.

기금 첨부 파일 업데이트

기금 첨부 파일을 업데이트합니다.

기회 나열

기회 목록을 반환합니다.

기회 사용자 정의 필드 나열

기회의 사용자 지정 필드를 나열합니다.

기회 사용자 정의 필드 만들기

새 기회 사용자 정의 필드를 만듭니다.

기회 사용자 정의 필드 업데이트

기회 사용자 정의 필드를 업데이트합니다.

기회 얻기

영업 기회에 대한 정보를 반환합니다. 참고: 이 엔드포인트는 대기 시간이 약 10분인 상태 속성을 반환합니다.

기회 업데이트

기회를 업데이트합니다.

기회 첨부 파일 나열

기회의 첨부 파일을 나열합니다.

기회 첨부 파일 만들기

새 기회 첨부 파일을 만듭니다.

기회 첨부 파일 업데이트

기회 첨부 파일을 업데이트합니다.

레코드 집합에서 목록 만들기

지정된 레코드 집합으로 필터링된 새 목록을 만듭니다.

모금 행사 할당 만들기

새 모금 행사 할당을 만듭니다.

목록 어필 사용자 지정 필드

항소에 대한 사용자 지정 필드를 나열합니다.

목록에 레코드 추가

기존 목록에 레코드 집합을 추가합니다.

문서 위치 만들기

새 고유한 문서 식별자를 만들고 물리적 첨부 파일에 사용할 위치를 업로드합니다. 응답에는 문서 내용을 업로드하는 위치 및 방법에 대한 지침이 포함됩니다.

선물 나열

선물 목록을 반환합니다.

선물 만들기

새 선물을 만듭니다.

선물 받기

선물에 대한 정보를 반환합니다.

선물 사용자 정의 필드 만들기

새 선물 사용자 정의 필드를 만듭니다.

선물 사용자 정의 필드 업데이트

선물 사용자 정의 필드를 업데이트합니다.

선물 사용자 지정 필드 나열

선물에 대한 사용자 지정 필드를 나열합니다.

선물 승인 세부 정보 업데이트

선물에 대한 승인 세부 정보를 업데이트합니다.

선물 영수증 세부 정보 업데이트

선물의 영수증 세부 정보를 업데이트합니다.

선물 일괄 처리 나열

선물 일괄 처리를 나열합니다.

선물 일괄 처리 만들기

새 선물 일괄 처리를 만듭니다.

선물 첨부 파일 나열

선물에 대한 첨부 파일을 나열합니다.

선물 첨부 파일 만들기

새 선물 첨부 파일을 만듭니다.

선물 첨부 파일 업데이트

선물 첨부 파일을 업데이트합니다.

영업 기회 만들기

새 기회를 만듭니다.

이벤트 가져오기

이벤트에 대한 정보를 반환합니다.

이벤트 나열

이벤트 목록을 반환합니다.

이벤트 만들기

새 이벤트를 만듭니다.

이벤트 업데이트

이벤트에 대한 세부 정보를 업데이트합니다.

이벤트 요금 나열

이벤트에 대한 수수료를 나열합니다.

이벤트 요금 만들기

이벤트에 대한 새 요금을 만듭니다.

이벤트 참가자 나열

이벤트에 대한 참가자를 나열합니다.

이벤트 참가자 옵션 나열

이벤트에 대한 참가자 옵션을 나열합니다.

이벤트 참가자 옵션 만들기

이벤트에 대한 새 참가자 옵션을 만듭니다.

일괄 처리에 선물 추가

지정된 선물 일괄 처리에 선물을 추가합니다.

자금 나열

자금 목록을 반환합니다.

작업 나열

작업 목록을 반환합니다.

작업 사용자 정의 필드 나열

작업에 대한 사용자 지정 필드를 나열합니다.

작업 사용자 정의 필드 만들기

새 작업 사용자 정의 필드를 만듭니다.

작업 사용자 정의 필드 업데이트

작업 사용자 정의 필드를 업데이트합니다.

작업 첨부 파일 나열

작업에 대한 첨부 파일을 나열합니다.

작업 첨부 파일 만들기

새 작업 첨부 파일을 만듭니다.

작업 첨부 파일 업데이트

작업 첨부 파일을 업데이트합니다.

조직 관계 만들기

새 조직 관계를 만듭니다. 관계가 다른 구성 요소와 인 경우 해당 구성 요소에 대한 상호 관계가 만들어집니다.

조직 구성 요소 만들기

새 조직 구성 요소를 만듭니다.

참가자 가져오기

특정 이벤트 참가자에 대한 정보를 반환합니다.

참가자 기부 만들기

참가자를 위한 새 기부를 만듭니다.

참가자 기부금 나열

참가자의 기부금을 나열합니다.

참가자 만들기

이벤트에 대한 새 참가자를 만듭니다.

참가자 수수료 결제 나열

참가자의 수수료 지급액을 나열합니다.

참가자 업데이트

참가자에 대한 세부 정보를 업데이트합니다.

참가자 옵션 나열

참가자의 참가자 옵션을 나열합니다.

참가자 옵션 만들기

참가자에 대한 새 참가자 옵션을 만듭니다.

참가자 옵션 업데이트

참가자 옵션에 대한 세부 정보를 업데이트합니다.

참가자 요금 나열

참가자에 대한 수수료를 나열합니다.

참가자 요금 만들기

참가자에 대한 새 요금을 만듭니다.

참가자 요금 지불 만들기

참가자에 대한 새 수수료 지불을 만듭니다.

캠페인 가져오기

캠페인에 대한 정보를 반환합니다.

캠페인 나열

캠페인 목록을 반환합니다.

캠페인 사용자 정의 필드 만들기

새 캠페인 사용자 정의 필드를 만듭니다.

캠페인 사용자 정의 필드 업데이트

캠페인 사용자 정의 필드를 업데이트합니다.

캠페인 사용자 지정 필드 나열

캠페인의 사용자 지정 필드를 나열합니다.

캠페인 첨부 파일 나열

캠페인의 첨부 파일을 나열합니다.

캠페인 첨부 파일 만들기

새 캠페인 첨부 파일을 만듭니다.

캠페인 첨부 파일 업데이트

캠페인 첨부 파일을 업데이트합니다.

패키지 가져오기

패키지에 대한 정보를 반환합니다.

패키지 나열

패키지 목록을 반환합니다.

펀드 사용자 정의 필드 만들기

새 펀드 사용자 정의 필드를 만듭니다.

펀드 사용자 정의 필드 업데이트

펀드 사용자 정의 필드를 업데이트합니다.

펀드 사용자 지정 필드 나열

펀드의 사용자 지정 필드를 나열합니다.

항소 목록

항소 목록을 반환합니다.

항소 받기

항소에 대한 정보를 반환합니다.

항소 첨부 파일 나열

항소에 대한 첨부 파일을 나열합니다.

항소 첨부 파일 만들기

새 호소 첨부 파일을 만듭니다.

항소 첨부 파일 업데이트

항소 첨부 파일을 업데이트합니다.

호소 사용자 정의 필드 만들기

새 호소 사용자 정의 필드를 만듭니다.

호소 사용자 정의 필드 업데이트

호소 사용자 정의 필드를 업데이트합니다.

가장 큰 선물을 얻습니다.

구성 요소에 대한 가장 큰 선물을 반환합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

반환

요약 제공

개별 관계 만들기

새 개별 관계를 만듭니다. 관계가 다른 구성 요소와 인 경우 해당 구성 요소에 대한 상호 관계가 만들어집니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

관계와 연결된 구성 요소의 시스템 레코드 ID입니다.

관계 ID
relation_id True string

관련 개인의 시스템 레코드 ID입니다.

유형
type string

관계가 나타내는 관계의 형식입니다.

상호 형식
reciprocal_type string

관련 구성 요소와 구성 요소의 관계를 설명합니다. 예를 들어, 남성 구성 요소와 여성 형제 간의 관계에서 상호 관계 유형은 형제가 됩니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

배우자인가요?
is_spouse boolean

관련 개인이 구성 요소의 배우자인가요?

가구의 구성 머리인가요?
is_constituent_head_of_household boolean

구성 요소는 가정의 머리인가?

배우자는 가정의 머리인가요?
is_spouse_head_of_household boolean

배우자가 가정의 머리인가요?

비고
comment string

관계에 대한 추가 정보입니다.

반환

개별 관계 만들기

개별 구성 요소 만들기

새 개별 구성 요소를 만듭니다.

매개 변수

Name 필수 형식 Description
제목
title string

구성 요소의 기본 제목입니다.

이름 (이름의 첫 부분)
first string

구성 요소의 이름입니다. 문자 제한: 50.

성(姓)
last True string

구성 요소의 성입니다. 문자 제한: 100.

접미사
suffix string

구성 요소의 기본 접미사입니다.

조회 ID
lookup_id string

구성 요소에 대한 사용자 정의 식별자입니다.

type
type True string

주소 유형입니다.

country
country string

주소의 국가(ID, 이름 또는 약어일 수 있습니다).

라인
address_lines string

주소 줄입니다. 문자 제한: 150.

city
city string

주소의 도시입니다(교외 필드와 함께 사용하지 마세요).

state string

주소의 상태입니다.

우편번호
postal_code string

주소의 우편 번호입니다. 문자 제한: 12.

교외
suburb string

주소의 교외(도시 필드와 함께 사용하지 마세요).

county string

주소의 카운티입니다.

start
start date

구성 요소가 이 주소에 거주하기 시작한 날짜입니다(예: '2005-09-18').

end date

구성 요소가 이 주소(예: '2005-09-18')에 거주하지 않는 날짜입니다.

type
type True string

전화 유형입니다.

숫자
number True string

전화 번호입니다.

기본인가요?
primary boolean

이 번호가 구성 요소의 기본 전화 번호인가요?

type
type True string

전자 메일 주소의 유형입니다.

address
address True string

전자 메일 주소입니다.

기본인가요?
primary boolean

이 주소가 구성 요소의 기본 이메일 주소인가요?

type
type True string

온라인 현재 상태 유형입니다.

address
address True string

온라인 상태의 웹 주소입니다.

기본인가요?
primary boolean

이것은 구성 요소의 주요 온라인 존재인가요?

기본 설정 이름
preferred_name string

구성 요소의 기본 설정 이름입니다. 문자 제한: 50.

중간 이름
middle string

구성 요소의 중간 이름입니다. 문자 제한: 50.

이전 이름
former_name string

구성 요소의 이전 이름입니다. 문자 제한: 100.

제목 2
title_2 string

구성 요소의 보조 제목입니다.

접미사 2
suffix_2 string

구성 요소의 보조 접미사입니다.

성별
gender string

구성 요소의 성별입니다.

결혼 상태
marital_status string

구성 요소의 결혼 상태.

익명으로 제공?
gives_anonymously boolean

구성 요소는 익명으로 제공합니까?

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

출생지
birthplace string

구성 요소의 발상지입니다.

민족성
ethnicity string

구성 요소의 민족성입니다.

소득
income string

구성 요소의 소득입니다.

종교
religion string

구성 요소의 종교.

사용자 지정 주소
custom_format boolean

주 주소가 사용자 지정 형식인가요?

주소 형식
configuration_id string

기본 주소 구성(사용자 지정 형식을 사용하지 않는 한 필요).

주소 지정 이름
formatted_name string

기본 주소 형식 이름(사용자 지정 형식을 사용하는 경우 필요)입니다. 문자 제한: 255.

사용자 지정 인사말?
custom_format boolean

기본 인사말이 사용자 지정 형식인가요?

인사말 형식
configuration_id string

기본 인사말 구성(사용자 지정 형식을 사용하지 않는 한 필요).

인사말 사용자 지정 이름
formatted_name string

기본 인사말 서식이 지정된 이름(사용자 지정 형식을 사용하는 경우 필요)입니다. 문자 제한: 255.

반환

개별 구성 요소 만들기

구성 교육 만들기

새 구성 교육을 만듭니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

교육과 관련된 구성 요소의 시스템 레코드 ID입니다.

학교
school True string

학교/설립 이름입니다.

유형
type string

교육 유형입니다.

의 클래스
class_of string

구성 요소가 졸업한 해입니다.

상태
status string

교육의 상태입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

정도
degree string

받은 학위입니다.

GPA
gpa double

성적 포인트 평균입니다.

연구 대상
subject_of_study string

연구의 주제입니다.

본래의?
primary boolean

이것이 선거구의 초등학교 협회인가요?

전공
majors array of string

연구의 주요 과정.

미성년자
minors array of string

연구의 사소한 과정.

Campus
campus string

캠퍼스. 문자 제한: 50.

소셜 조직
social_organization string

사회 조직. 문자 제한: 50.

알려진 이름
known_name string

알려진 이름입니다. 문자 제한: 50.

학위의 클래스
class_of_degree string

학위 클래스(영국 버전에만 해당)입니다.

부서
department string

교육 부서의 이름입니다(영국 버전에만 적용됨).

학부
faculty string

교직원의 이름입니다(영국 버전에만 적용됨).

등록 번호
registration_number string

등록 번호(영국 버전에만 해당)입니다. 문자 제한: 50.

반환

구성 교육 만들기

구성 교육 목록

구성 요소에 대한 교육 레코드를 나열합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

반환

교육

구성 교육 업데이트

구성 교육을 업데이트합니다.

매개 변수

Name 필수 형식 Description
교육 ID
education_id True string

업데이트할 교육 레코드의 시스템 레코드 ID입니다.

학교
school string

학교/설립 이름입니다.

유형
type string

교육 유형입니다.

의 클래스
class_of string

구성 요소가 졸업한 해입니다.

상태
status string

교육의 상태입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

정도
degree string

받은 학위입니다.

GPA
gpa double

성적 포인트 평균입니다.

연구 대상
subject_of_study string

연구의 주제입니다.

본래의?
primary boolean

이것이 선거구의 초등학교 협회인가요?

전공
majors array of string

연구의 주요 과정.

미성년자
minors array of string

연구의 사소한 과정.

Campus
campus string

캠퍼스. 문자 제한: 50.

소셜 조직
social_organization string

사회 조직. 문자 제한: 50.

알려진 이름
known_name string

알려진 이름입니다. 문자 제한: 50.

학위의 클래스
class_of_degree string

학위의 클래스입니다.

부서
department string

교육 부서의 이름입니다.

학부
faculty string

교직원의 이름입니다.

등록 번호
registration_number string

등록 번호입니다. 문자 제한: 50.

구성 요소 가져오기

구성 요소에 대한 정보를 반환합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

가져올 구성 요소의 시스템 레코드 ID입니다.

반환

성분

구성 요소 검색

제공된 검색 텍스트를 기반으로 구성 요소 검색을 수행합니다. 이름, 성, 기본 설정 이름, 이전 이름, 별칭, 전자 메일 주소, 전화 번호, 주소 또는 조회 ID를 지원합니다. 이름, 성, 기본 이름 및 성 등의 이름 조합은 유효하지만, 그렇지 않으면 검색에서 한 번에 하나의 매개 변수만 지원합니다. 기본적으로 검색에는 조건과 비슷한 결과가 포함됩니다. 예를 들어 "Smith"에 대한 검색에는 "Smyth" 및 기타 대체 맞춤법의 일치 항목이 포함됩니다. 이 검색은 * 또는 ?와 같은 와일드카드 문자를 지원하지 않습니다. 검색 결과는 500개 레코드로 제한됩니다.

매개 변수

Name 필수 형식 Description
텍스트 검색
search_text True string

검색 텍스트입니다. 이름, 성, 기본 설정 이름, 이전 이름, 별칭, 전자 메일 주소, 전화 번호, 주소 또는 조회 ID를 지원합니다. 이름, 성, 기본 이름 및 성 등의 이름 조합은 유효하지만, 그렇지 않으면 검색에서 한 번에 하나의 매개 변수만 지원합니다. 기본적으로 검색에는 조건과 비슷한 결과가 포함됩니다. 예를 들어 "Smith"에 대한 검색에는 "Smyth" 및 기타 대체 맞춤법의 일치 항목이 포함됩니다. 이 검색은 * 또는 ?와 같은 와일드카드 문자를 지원하지 않습니다. 검색 결과는 500개 레코드로 제한됩니다.

모금 행사 상태
fundraiser_status string

결과를 필터링하기 위해 쉼표로 구분된 기금 모금 상태 목록을 나타냅니다. 예를 들어 "Active,None"은 기금 모금 상태가 활성 또는 없음인 구성 요소만 반환합니다. 이 필터의 유효한 값은 활성, 비활성 및 없음입니다.

비활성 상태 포함
include_inactive boolean

응답에 비활성 구성 요소를 포함하시겠습니까?

검색 필드
search_field string

검색할 필드를 나타냅니다. 현재는 lookup_id 지원합니다. search_text 제공된 경우 search_text 일치하는 lookup_id 있는 구성 요소가 반환됩니다.

엄격한 검색을 사용하시겠습니까?
strict_search boolean

이름이 검색 텍스트처럼 들리지만 철자가 다른 구성 요소를 제외하시겠습니까?

한계
limit integer

반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 5000입니다.

상쇄
offset integer

건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다.

반환

검색 결과

구성 요소 관계 나열

구성 요소의 관계를 나열합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

한계
limit integer

반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 없습니다.

상쇄
offset integer

건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다.

반환

관계

구성 요소 관계 업데이트

구성 요소에 대한 관계를 업데이트합니다. 상호 관계가 있는 경우 변경 내용을 반영하도록 수정됩니다. 여기에는 각 레코드와 관련이 있으며 각 레코드에서 독립적으로 수정할 수 있는 "comments" 속성에 대한 변경 내용은 포함되지 않습니다.

매개 변수

Name 필수 형식 Description
관계 ID
relationship_id True string

업데이트할 관계의 시스템 레코드 ID입니다.

유형
type string

관계가 나타내는 관계의 형식입니다.

상호 형식
reciprocal_type string

관련 구성 요소와 구성 요소의 관계를 설명합니다. 예를 들어, 남성 구성 요소와 여성 형제 간의 관계에서 상호 관계 유형은 형제가 됩니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

배우자인가요?
is_spouse boolean

관련 개인이 구성 요소의 배우자인가요(개인 간의 관계에만 적용됨)?

가구의 구성 머리인가요?
is_constituent_head_of_household boolean

구성 요소는 가정의 머리인가?

배우자는 가정의 머리인가요?
is_spouse_head_of_household boolean

배우자가 가정의 머리인가요?

비고
comment string

관계에 대한 추가 정보입니다.

연락처인가요?
is_organization_contact boolean

구성 요소가 이 조직을 연락처로 나타내나요(조직과 개인 간의 관계에만 적용됨)?

기본 비즈니스인가요?
is_primary_business boolean

구성 요소의 기본 비즈니스인가요(조직과 개인 간의 관계에만 적용됨)?

연락처 유형
organization_contact_type string

조직을 연락처로 나타내는 관련 개인과의 상호 작용에 대한 컨텍스트를 제공합니다. 조직과 개인 간의 관계에만 적용됩니다.

Position
position string

조직에서 개인의 위치입니다. 조직과 개인 간의 관계에만 적용됩니다. 문자 제한: 50.

구성 요소 기금 모금 행사 나열

구성 요소에 대한 모금 행사 할당을 나열합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

비활성 상태 포함
include_inactive boolean

비활성 기금 모금 행사를 포함하시겠습니까?

반환

기금 모금 과제

구성 요소 나열

구성 요소 목록을 반환합니다.

매개 변수

Name 필수 형식 Description
List
list_id string

지정된 목록에 포함된 구성 요소 집합을 필터링하는 데 사용되는 목록 식별자를 정의합니다. 이 값을 설정하면 지정된 다른 필터가 무시됩니다.

한계
limit integer

반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 5000입니다.

상쇄
offset integer

건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다.

구성 코드
constituent_code string

목록을 필터링할 구성 요소를 나타냅니다. 예를 들어 "이사회 구성원"은 이사회 구성원 구성 코드가 있는 구성 요소만 반환합니다.

구성 요소 ID
constituent_id string

결과를 필터링할 구성 요소 식별자의 쉼표로 구분된 목록을 나타냅니다. 예를 들어 "280,1232"는 구성 요소 280 또는 구성 요소 1232만 반환합니다.

사용자 지정 필드 범주
custom_field_category string

결과를 필터링할 사용자 지정 필드 범주를 나타냅니다. 예를 들어 "Anniversary"는 활성 1주년 사용자 정의 필드가 있는 구성 요소만 반환합니다.

모금 행사 상태
fundraiser_status string

결과를 필터링하기 위해 쉼표로 구분된 기금 모금 상태 목록을 나타냅니다. 예를 들어 "Active,None"은 기금 모금 상태가 활성 또는 없음인 구성 요소만 반환합니다. 이 필터의 유효한 값은 활성, 비활성 및 없음입니다.

고인을 포함하시겠습니까?
include_deceased boolean

응답에 사망 한 성분을 포함?

비활성 상태 포함
include_inactive boolean

응답에 비활성 구성 요소를 포함하시겠습니까?

우편번호
postal_code string

결과를 필터링할 우편 번호의 쉼표로 구분된 목록을 나타냅니다. 예를 들어 "29466,29492"는 기본 주소에 29466 또는 29492로 시작하는 우편 번호(예: 29466, 29492 또는 29492-0727)가 있는 구성 요소만 반환합니다.

추가된 이후
date_added date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에서 만든 구성 요소로 결과를 필터링합니다.

수정된 날짜 또는 이후
last_modified date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에서 수정된 구성 요소로 결과를 필터링합니다.

정렬 기준
sort string

결과를 정렬할 필드 목록을 나타냅니다. 결과는 기본적으로 오름차순이며 '-' 기호는 내림차순을 표시합니다. 예를 들어 "date_added,-last"는 "date_added" 필드를 기준으로 구성 요소를 오름차순으로 정렬한 다음 " 마지막" 필드를 내림차순으로 정렬합니다.

반환

성분

구성 요소 노트 나열

구성 요소의 노트를 나열합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

반환

비고

구성 요소 노트 만들기

새 구성 요소를 만듭니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

메모와 연결된 구성 요소의 시스템 레코드 ID입니다.

유형
type True string

메모 유형입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

요약
summary string

메모 요약입니다. 문자 제한: 50.

비고
text string

메모 텍스트입니다.

반환

만든 구성 요소 노트

구성 요소 노트 업데이트

구성 요소를 업데이트합니다.

매개 변수

Name 필수 형식 Description
참고 ID
note_id True string

업데이트할 메모의 시스템 레코드 ID입니다.

유형
type string

메모 유형입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

요약
summary string

메모 요약입니다. 문자 제한: 50.

비고
text string

메모 텍스트입니다.

구성 요소 동의 레코드 나열

구성 요소에 대한 동의 레코드를 나열합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

가장 최근만?
most_recent_only boolean

응답에 각 채널 범주 조합에 대한 최신 동의 레코드만 포함하시겠습니까?

반환

동의 레코드

구성 요소 동의 레코드 만들기

새 구성 요소 동의 레코드를 만듭니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

동의 레코드와 연결된 구성 요소의 시스템 레코드 ID입니다.

채널
channel True string

동의 응답이 적용되는 채널입니다.

카테고리
category string

동의 응답이 적용되는 범주입니다.

출처
source string

구성 요소의 동의 응답 원본입니다.

응답
constituent_consent_response True string

구성 요소가 지정된 채널/범주에 대한 동의에 응답하는 방식입니다.

날짜
consent_date True date-time

동의 응답을 받은 날짜(예: '2020-09-18T04:13:56Z').

동의 문
consent_statement string

동의를 제공할 때 구성 요소가 응답한 진술입니다.

개인정보 처리방침
privacy_notice string

구성 요소에 제공된 개인 정보 보호 알림입니다.

반환

구성 요소 동의 생성

구성 요소 등급 나열

구성 요소에 대한 등급 목록을 반환합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID

비활성 상태 포함
include_inactive boolean

비활성 등급을 포함하시겠습니까?

가장 최근?
most_recent_only boolean

최신 등급만 포함하시겠습니까?

반환

등급

구성 요소 등급 만들기

새 구성 요소 등급을 만듭니다.

매개 변수

Name 필수 형식 Description
body
body True dynamic

만들려는 등급을 나타내는 개체입니다.

반환

구성 요소 등급 만들기

구성 요소 별칭 나열

구성 요소의 별칭을 나열합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

반환

Aliases

구성 요소 별칭 만들기

새 구성 요소 별칭을 만듭니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

별칭과 연결된 구성 요소의 시스템 레코드 ID입니다.

Alias
name True string

구성 요소의 별칭으로 사용할 이름입니다. 문자 제한: 100.

유형
type string

별칭 형식입니다.

반환

만든 구성 별칭

구성 요소 별칭 업데이트

구성 요소 별칭을 업데이트합니다.

매개 변수

Name 필수 형식 Description
별칭 ID
alias_id True string

업데이트할 별칭의 시스템 레코드 ID입니다.

Alias
name string

구성 요소의 별칭으로 사용할 이름입니다. 문자 제한: 100.

유형
type string

별칭 형식입니다.

구성 요소 사용자 정의 필드 나열

구성 요소에 대한 사용자 지정 필드를 나열합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

반환

사용자 지정 필드

구성 요소 사용자 정의 필드 만들기

새 구성 요소 사용자 정의 필드를 만듭니다.

매개 변수

Name 필수 형식 Description
body
body True dynamic

만들 사용자 지정 필드를 나타내는 개체입니다.

반환

만든 구성 요소 사용자 정의 필드

구성 요소 사용자 정의 필드 업데이트

구성 요소 사용자 정의 필드를 업데이트합니다.

매개 변수

Name 필수 형식 Description
사용자 지정 필드 ID
custom_field_id True string

업데이트할 사용자 지정 필드의 시스템 레코드 ID입니다.

body
body True dynamic

업데이트할 사용자 지정 필드의 속성을 나타내는 개체입니다.

구성 요소 수명 제공 받기

구성 요소에 대한 수명 제공 요약을 반환합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

반환

평생 기부

구성 요소 업데이트

구성 요소를 업데이트합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

업데이트할 구성 요소의 시스템 레코드 ID입니다.

제목
title string

구성 요소의 기본 제목입니다(개인만 해당).

이름 (이름의 첫 부분)
first string

구성 요소의 이름입니다(개인만 해당). 문자 제한: 50.

성(姓)
last string

구성 요소의 성(개인만 해당)입니다. 문자 제한: 100.

조직 이름
name string

개인의 경우 편집 작업에는 적용되지 않는 계산 필드입니다. 조직의 경우 이 필드는 필수이며 조직의 이름을 나타냅니다. 문자 제한: 100.

접미사
suffix string

구성 요소의 기본 접미사입니다(개인만 해당).

기본 설정 이름
preferred_name string

구성 요소의 기본 설정 이름입니다(개인만 해당). 문자 제한: 50.

조회 ID
lookup_id string

구성 요소에 대한 사용자 정의 식별자입니다.

성별
gender string

구성 요소의 성별(개인만 해당).

중간 이름
middle string

구성 요소의 중간 이름입니다(개인만 해당). 문자 제한: 50.

이전 이름
former_name string

구성 요소의 이전 이름입니다(개인만 해당). 문자 제한: 100.

제목 2
title_2 string

구성 요소의 보조 제목입니다(개인만 해당).

접미사 2
suffix_2 string

구성 요소의 보조 접미사입니다(개인만 해당).

결혼 상태
marital_status string

구성 요소의 결혼 상태(개인만 해당).

익명으로 제공?
gives_anonymously boolean

구성 요소는 익명으로 제공합니까?

게으른?
inactive boolean

구성 요소가 비활성 상태인가요?

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

출생지
birthplace string

구성 요소의 발상지입니다(개인만 해당).

민족성
ethnicity string

구성 요소의 민족성(개인만 해당).

소득
income string

구성 요소의 소득입니다(개인만 해당).

종교
religion string

구성 요소의 종교(개인만 해당).

산업
industry string

구성 요소의 산업(조직에만 해당).

직원 수
num_employees integer

조직의 직원 수입니다.

선물과 일치하시겠습니까?
matches_gifts boolean

조직이 선물과 일치하나요?

일치하는 기프트 팩터
matching_gift_factor double

일치하는 기프트 팩터(조직에만 해당)입니다.

선물당 최소 일치
value double

구성 요소에 대한 선물당 최소 일치 금액입니다(조직에만 해당).

선물당 최대 일치 항목
value double

구성 요소에 대한 선물당 최대 일치 금액입니다(조직에만 해당).

constit당 최소 일치 항목
value double

구성 요소의 최소 일치 합계입니다(조직에만 해당).

constit당 최대 일치 항목
value double

구성 요소의 최대 일치 합계입니다(조직에만 해당).

일치하는 기프트 노트
matching_gift_notes string

구성 요소에 대한 일치하는 기프트 노트입니다(조직에만 해당).

고?
deceased boolean

구성 요소가 사망합니까 (개인만 해당)?

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

구성 요소 온라인 프레즌스 만들기

새 구성 요소 온라인 현재 상태를 만듭니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

온라인 상태와 연결된 구성 요소의 시스템 레코드 ID입니다.

유형
type True string

온라인 현재 상태 유형입니다.

Link
address True string

온라인 상태의 웹 주소입니다.

본래의?
primary boolean

이것은 구성 요소의 주요 온라인 존재인가요?

게으른?
inactive boolean

이 온라인 프레즌스는 비활성 상태인가요?

반환

구성 요소 온라인 프레즌스 만들기

구성 요소 온라인 현재 상태 나열

구성 요소의 온라인 현재 상태를 나열합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

비활성 상태 포함
include_inactive boolean

비활성 온라인 프레즌스를 포함하시겠습니까?

반환

온라인 상태

구성 요소 온라인 현재 상태 업데이트

구성 요소 온라인 현재 상태를 업데이트합니다.

매개 변수

Name 필수 형식 Description
온라인 현재 상태 ID
online_presence_id True string

업데이트할 온라인 상태의 시스템 레코드 ID입니다.

유형
type string

온라인 현재 상태 유형입니다.

Link
address string

온라인 상태의 웹 주소입니다.

본래의?
primary boolean

이것은 구성 요소의 주요 온라인 존재인가요?

게으른?
inactive boolean

이 온라인 프레즌스는 비활성 상태인가요?

구성 요소 요청 코드 나열

구성 요소에 대한 요청 코드를 나열합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

반환

코드 요청

구성 요소 요청 코드 만들기

새 구성 요소 요청 코드를 만듭니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

요청 코드와 연결된 구성 요소의 시스템 레코드 ID입니다.

코드 요청
solicit_code True string

구성 요소에 대한 통신 지침 및/또는 제한 사항입니다.

시작 날짜
start_date date

요청 코드의 시작 날짜입니다(예: '2005-09-18').

끝 날짜
end_date date

요청 코드의 종료 날짜입니다(예: '2005-09-18').

반환

구성 요소 요청 코드 만들기

구성 요소 요청 코드 업데이트

구성 요소 요청 코드를 업데이트합니다.

매개 변수

Name 필수 형식 Description
코드 ID 요청
constituent_solicit_code_id True string

업데이트할 요청 코드의 시스템 레코드 ID입니다.

코드 요청
solicit_code string

구성 요소에 대한 통신 지침 및/또는 제한 사항입니다.

시작 날짜
start_date date

요청 코드의 시작 날짜입니다(예: '2005-09-18').

끝 날짜
end_date date

요청 코드의 종료 날짜입니다(예: '2005-09-18').

구성 요소 작업 가져오기

구성 요소 작업에 대한 정보를 반환합니다.

매개 변수

Name 필수 형식 Description
작업 ID
action_id True string

가져올 작업의 시스템 레코드 ID입니다.

반환

조치

구성 요소 작업 나열

구성 요소에 대한 작업을 나열합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

반환

활동

구성 요소 작업 만들기

새 구성 요소를 만듭니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

작업과 연결된 구성 요소의 시스템 레코드 ID입니다.

카테고리
category True string

구성 요소 상호 작용의 채널 또는 의도입니다.

완료?
completed boolean

작업이 완료되었는지 여부 시스템이 사용자 지정 작업 상태를 사용하도록 구성된 경우 이 값은 작업 상태 값을 기반으로 합니다.

완료됨
completed_date date-time

작업이 완료된 날짜(예: '2020-09-18T04:13:56Z')

날짜
date True date-time

작업 날짜(예: '2020-09-18T04:13:56Z')

비고
description string

작업 요약을 자세히 설명하는 자세한 설명입니다.

방향
direction string

동작의 방향입니다.

모금 행사
fundraisers array of string

작업과 관련된 모금 행사의 시스템 레코드 ID 집합입니다.

위치
location string

작업의 위치입니다.

기회 ID
opportunity_id string

작업과 연결된 기회의 시스템 레코드 ID입니다.

결과
outcome string

작업의 결과입니다.

Priority
priority string

작업의 우선 순위입니다.

시작 시간
start_time string

작업의 시작 시간입니다. HH:mm 형식으로 24시간을 사용합니다.

종료 시간
end_time string

작업의 종료 시간입니다. HH:mm 형식으로 24시간을 사용합니다.

상태
status string

작업 상태입니다.

요약
summary string

레코드의 맨 위에 표시되는 작업에 대한 간단한 설명입니다. 문자 제한: 255.

유형
type string

범주를 보완하기 위한 작업에 대한 추가 설명입니다.

반환

만든 작업

구성 요소 작업 업데이트

구성 요소를 업데이트합니다.

매개 변수

Name 필수 형식 Description
작업 ID
action_id True string

업데이트할 작업의 시스템 레코드 ID입니다.

카테고리
category string

구성 요소 상호 작용의 채널 또는 의도입니다.

완료?
completed boolean

작업이 완료되었는지 여부 시스템이 사용자 지정 작업 상태를 사용하도록 구성된 경우 이 값은 작업 상태 값을 기반으로 합니다.

완료됨
completed_date date-time

작업이 완료된 날짜(예: '2020-09-18T04:13:56Z')

날짜
date date-time

작업 날짜(예: '2020-09-18T04:13:56Z')

비고
description string

작업 요약을 자세히 설명하는 자세한 설명입니다.

방향
direction string

동작의 방향입니다.

모금 행사
fundraisers array of string

작업과 관련된 모금 행사의 시스템 레코드 ID 집합입니다.

위치
location string

작업의 위치입니다.

기회 ID
opportunity_id string

작업과 연결된 기회의 시스템 레코드 ID입니다.

결과
outcome string

작업의 결과입니다.

Priority
priority string

작업의 우선 순위입니다.

시작 시간
start_time string

작업의 시작 시간입니다. HH:mm 형식으로 24시간을 사용합니다.

종료 시간
end_time string

작업의 종료 시간입니다. HH:mm 형식으로 24시간을 사용합니다.

상태
status string

작업 상태입니다.

요약
summary string

레코드의 맨 위에 표시되는 작업에 대한 간단한 설명입니다. 문자 제한: 255.

유형
type string

범주를 보완하기 위한 작업에 대한 추가 설명입니다.

구성 요소 전자 메일 주소 나열

구성 요소의 전자 메일 주소를 나열합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

비활성 상태 포함
include_inactive boolean

비활성 전자 메일 주소를 포함하시겠습니까?

반환

이메일 주소

구성 요소 전자 메일 주소 만들기

새 구성 전자 메일 주소를 만듭니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

전자 메일 주소와 연결된 구성 요소의 시스템 레코드 ID입니다.

전자 메일 유형
type True string

전자 메일 주소의 유형입니다.

전자 메일 주소
address True string

전자 메일 주소입니다.

본래의?
primary boolean

이 주소가 구성 요소의 기본 이메일 주소인가요?

전자 메일을 보내지 않나요?
do_not_email boolean

이 전자 메일 주소에서 구성 요소에 연락할 수 있나요?

게으른?
inactive boolean

이 전자 메일 주소가 비활성 상태인가요?

반환

만든 구성 전자 메일 주소

구성 요소 전자 메일 주소 업데이트

구성 요소 전자 메일 주소를 업데이트합니다.

매개 변수

Name 필수 형식 Description
전자 메일 주소 ID
email_address_id True string

업데이트할 전자 메일 주소의 시스템 레코드 ID입니다.

전자 메일 유형
type string

전자 메일 주소의 유형입니다.

전자 메일 주소
address string

전자 메일 주소입니다.

본래의?
primary boolean

이 주소가 구성 요소의 기본 이메일 주소인가요?

전자 메일을 보내지 않나요?
do_not_email boolean

이 전자 메일 주소에서 구성 요소에 연락할 수 있나요?

게으른?
inactive boolean

이 전자 메일 주소가 비활성 상태인가요?

구성 요소 주소 나열

구성 요소의 주소를 나열합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

비활성 상태 포함
include_inactive boolean

비활성 주소를 포함하시겠습니까?

반환

Addresses

구성 요소 주소 만들기

새 구성 요소를 만듭니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

주소와 연결된 구성 요소의 시스템 레코드 ID입니다.

주소 형식
type True string

주소 유형입니다.

국가
country string

주소의 국가(ID, 이름 또는 약어일 수 있습니다).

주소 줄
address_lines string

주소 줄입니다.

도시
city string

주소의 도시입니다(교외 필드와 함께 사용하지 마세요).

state string

주소의 상태입니다.

우편번호
postal_code string

주소의 우편 번호입니다.

교외
suburb string

주소의 교외(도시 필드와 함께 사용하지 마세요).

county string

주소의 카운티입니다.

정보 원본
information_source string

주소의 정보 원본입니다.

지역
region string

주소의 지역입니다.

카트
cart string

주소에 대한 CART(이동 통신 사업자 경로)입니다.

많이
lot string

주소의 이동 줄(LOT)입니다.

DPC
dpc string

주소의 DPC(배달 지점 코드)입니다.

다음에서 유효합니다.
start date

구성 요소가 이 주소에 거주하기 시작한 날짜입니다(예: '2005-09-18').

유효한 경우
end date

구성 요소가 이 주소(예: '2005-09-18')에 거주하지 않는 날짜입니다.

본래의?
preferred boolean

이 주소가 구성 요소의 기본 주소인가요?

메일을 사용하지 않나요?
do_not_mail boolean

이 주소에서 구성 요소에 연락할 수 있나요?

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

반환

만든 구성 요소 주소

구성 요소 주소 업데이트

구성 요소를 업데이트합니다.

매개 변수

Name 필수 형식 Description
주소 ID
address_id True string

업데이트할 주소의 시스템 레코드 ID입니다.

주소 형식
type string

주소 유형입니다.

국가
country string

주소의 국가(ID, 이름 또는 약어일 수 있습니다).

주소 줄
address_lines string

주소 줄입니다.

도시
city string

주소의 도시입니다(교외 필드와 함께 사용하지 마세요).

state string

주소의 상태입니다.

우편번호
postal_code string

주소의 우편 번호입니다.

교외
suburb string

주소의 교외(도시 필드와 함께 사용하지 마세요).

county string

주소의 카운티입니다.

정보 원본
information_source string

주소의 정보 원본입니다.

지역
region string

주소의 지역입니다.

카트
cart string

주소에 대한 CART(이동 통신 사업자 경로)입니다.

많이
lot string

주소의 이동 줄(LOT)입니다.

DPC
dpc string

주소의 DPC(배달 지점 코드)입니다.

다음에서 유효합니다.
start date

구성 요소가 이 주소에 거주하기 시작한 날짜입니다(예: '2005-09-18').

유효한 경우
end date

구성 요소가 이 주소(예: '2005-09-18')에 거주하지 않는 날짜입니다.

본래의?
preferred boolean

이 주소가 구성 요소의 기본 주소인가요?

메일을 사용하지 않나요?
do_not_mail boolean

이 주소에서 구성 요소에 연락할 수 있나요?

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

구성 요소 첨부 파일 나열

구성 요소에 대한 첨부 파일을 나열합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

반환

Attachments

구성 요소 첨부 파일 만들기

새 구성 요소 첨부 파일을 만듭니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
parent_id True string

첨부 파일과 연결된 구성 요소의 시스템 레코드 ID입니다.

유형
type True string

첨부 파일 형식입니다. 실제 첨부 파일은 로컬 또는 네트워크에 저장된 이미지, PDF 또는 Word 문서와 같은 업로드된 파일입니다. 시스템에 저장되고 관리됩니다. 링크 첨부 파일은 온라인 또는 클라우드 스토리지 계정에 있는 이미지, 블로그 게시물 또는 YouTube 비디오와 같은 파일에 대한 링크입니다. 외부에 저장되고 관리됩니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜(예: '2020-09-18T04:13:56Z') 이 필드는 기본적으로 현재 날짜 및 시간(제공되지 않은 경우)으로 설정됩니다.

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

파일 이름
file_name string

파일 이름입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

파일 ID
file_id string

파일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 ID
thumbnail_id string

썸네일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

반환

구성 요소 첨부 파일 만들기

구성 요소 첨부 파일 업데이트

구성 요소 첨부 파일을 업데이트합니다.

매개 변수

Name 필수 형식 Description
첨부 파일 ID
attachment_id True string

업데이트할 첨부 파일의 시스템 레코드 ID입니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜(예: '2020-09-18T04:13:56Z')

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

구성 요소 첫 번째 선물 받기

구성 요소의 첫 번째 선물을 반환합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

반환

요약 제공

구성 요소 최신 선물 받기

구성 요소에 대한 최신 선물을 반환합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

반환

요약 제공

구성 요소 코드 나열

구성 요소의 구성 요소를 나열합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

반환

구성 요소 코드

구성 요소 코드 만들기

새 구성 요소를 만듭니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소 코드와 연결된 구성 요소의 시스템 레코드 ID입니다.

구성 코드
description True string

구성 요소 코드입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

순서
sequence integer

구성 요소 코드와 연결된 숫자 시퀀스입니다.

반환

구성 요소 코드 만들기

구성 요소 코드 삭제

구성 요소를 삭제합니다.

매개 변수

Name 필수 형식 Description
구성 코드 ID
constituent_code_id True string

삭제할 구성 요소 코드의 시스템 레코드 ID입니다.

구성 요소 코드 업데이트

구성 요소를 업데이트합니다.

매개 변수

Name 필수 형식 Description
구성 코드 ID
constituent_code_id True string

업데이트할 구성 요소 코드의 시스템 레코드 ID입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

순서
sequence integer

구성 요소 코드와 연결된 숫자 시퀀스입니다.

구성 요소 프로필 사진 가져오기

구성 요소의 현재 프로필 그림을 반환합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

프로필 사진을 검색할 구성 요소의 시스템 레코드 ID입니다.

반환

프로필 사진

구성 요소 프로필 사진 업데이트

구성 요소의 현재 프로필 사진을 업데이트합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

프로필 사진을 업데이트할 구성 요소의 시스템 레코드 ID입니다.

파일 이름
file_name True string

파일 이름입니다.

문서 ID
document_id True uuid

문서 식별자입니다.

썸네일 ID
thumbnail_id True uuid

썸네일 문서 식별자입니다.

구성 전망 상태 가져오기

구성 요소의 현재 전망 상태를 반환합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

잠재 고객 상태를 검색할 구성 요소의 시스템 레코드 ID입니다.

반환

전망 상태

구성 전화 나열

구성 요소의 휴대폰을 나열합니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

구성 요소의 시스템 레코드 ID입니다.

비활성 상태 포함
include_inactive boolean

비활성 휴대폰을 포함하시겠습니까?

반환

전화

구성 전화 만들기

새 구성 전화기를 만듭니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

휴대폰과 연결된 구성 요소의 시스템 레코드 ID입니다.

유형
type True string

전화 유형입니다.

Number
number True string

전화 번호입니다.

본래의?
primary boolean

이것은 구성 요소의 기본 전화인가요?

호출하지 않나요?
do_not_call boolean

이 번호로 구성 요소에 연락할 수 있나요?

게으른?
inactive boolean

이 전화 번호가 비활성 상태인가요?

반환

만든 구성 전화

구성 전화 업데이트

구성 전화기를 업데이트합니다.

매개 변수

Name 필수 형식 Description
전화 ID
phone_id True string

업데이트할 휴대폰의 시스템 레코드 ID입니다.

유형
type string

전화 유형입니다.

Number
number string

전화 번호입니다.

본래의?
primary boolean

이것은 구성 요소의 기본 전화인가요?

호출하지 않나요?
do_not_call boolean

이 번호로 구성 요소에 연락할 수 있나요?

게으른?
inactive boolean

이 전화 번호가 비활성 상태인가요?

기금 모금 과제 나열

기금 모금 행사의 과제를 나열합니다.

매개 변수

Name 필수 형식 Description
모금 행사 ID
fundraiser_id True string

할당을 반환할 기금 모금 행사의 시스템 레코드 ID입니다.

한계
limit integer

반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 5000입니다.

상쇄
offset integer

건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다.

반환

Assignments

기금 받기

펀드에 대한 정보를 반환합니다.

매개 변수

Name 필수 형식 Description
펀드 ID
fund_id True string

가져올 펀드의 시스템 레코드 ID입니다.

반환

기금

기금 첨부 파일 나열

펀드에 대한 첨부 파일을 나열합니다.

매개 변수

Name 필수 형식 Description
펀드 ID
fund_id True string

펀드의 시스템 레코드 ID입니다.

반환

Attachments

기금 첨부 파일 만들기

새 펀드 첨부 파일을 만듭니다.

매개 변수

Name 필수 형식 Description
펀드 ID
parent_id True string

첨부 파일과 연결된 펀드의 시스템 레코드 ID입니다.

유형
type True string

첨부 파일 형식입니다. 실제 첨부 파일은 로컬 또는 네트워크에 저장된 이미지, PDF 또는 Word 문서와 같은 업로드된 파일입니다. 시스템에 저장되고 관리됩니다. 링크 첨부 파일은 온라인 또는 클라우드 스토리지 계정에 있는 이미지, 블로그 게시물 또는 YouTube 비디오와 같은 파일에 대한 링크입니다. 외부에 저장되고 관리됩니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜(예: '2020-09-18T04:13:56Z') 이 필드는 기본적으로 현재 날짜 및 시간(제공되지 않은 경우)으로 설정됩니다.

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

파일 이름
file_name string

파일 이름입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

파일 ID
file_id string

파일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 ID
thumbnail_id string

썸네일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

반환

기금 첨부 파일 만들기

기금 첨부 파일 업데이트

기금 첨부 파일을 업데이트합니다.

매개 변수

Name 필수 형식 Description
첨부 파일 ID
attachment_id True string

업데이트할 첨부 파일의 시스템 레코드 ID입니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜(예: '2020-09-18T04:13:56Z')

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

기회 나열

기회 목록을 반환합니다.

매개 변수

Name 필수 형식 Description
List
list_id string

지정된 목록에 포함된 기회 집합을 필터링하는 데 사용되는 목록 식별자를 정의합니다. 이 값을 설정하면 지정된 다른 필터가 무시됩니다.

구성 요소 ID
constituent_id string

결과를 필터링할 구성 요소 식별자의 쉼표로 구분된 목록을 나타냅니다. 예를 들어 "280,1232"는 구성 요소 280 또는 구성 요소 1232의 기회만 반환합니다.

한계
limit integer

반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 5000입니다.

상쇄
offset integer

건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다.

비활성 상태 포함
include_inactive boolean

비활성 기회를 포함하시겠습니까?

추가된 이후
date_added date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에 대해 생성된 기회로 결과를 필터링합니다.

수정된 날짜 또는 이후
last_modified date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에서 수정된 기회로 결과를 필터링합니다.

반환

영업 기회

기회 사용자 정의 필드 나열

기회의 사용자 지정 필드를 나열합니다.

매개 변수

Name 필수 형식 Description
기회 ID
opportunity_id True string

기회의 시스템 레코드 ID입니다.

반환

사용자 지정 필드

기회 사용자 정의 필드 만들기

새 기회 사용자 정의 필드를 만듭니다.

매개 변수

Name 필수 형식 Description
body
body True dynamic

만들 사용자 지정 필드를 나타내는 개체입니다.

반환

기회 첨부 파일 만들기

기회 사용자 정의 필드 업데이트

기회 사용자 정의 필드를 업데이트합니다.

매개 변수

Name 필수 형식 Description
사용자 지정 필드 ID
custom_field_id True string

업데이트할 사용자 지정 필드의 시스템 레코드 ID입니다.

body
body True dynamic

업데이트할 사용자 지정 필드의 속성을 나타내는 개체입니다.

기회 얻기

영업 기회에 대한 정보를 반환합니다. 참고: 이 엔드포인트는 대기 시간이 약 10분인 상태 속성을 반환합니다.

매개 변수

Name 필수 형식 Description
기회 ID
opportunity_id True string

가져올 기회의 시스템 레코드 ID입니다.

반환

기회

기회 업데이트

기회를 업데이트합니다.

매개 변수

Name 필수 형식 Description
기회 ID
opportunity_id True string

업데이트할 기회의 시스템 레코드 ID입니다.

목적
purpose string

기회의 결과로 모금 된 모든 돈에 대한 의도 된 사용.

이름
name string

목록 또는 구성 레코드와 같이 프로그램 전체에서 기회를 식별하는 이름입니다. 문자 제한: 255.

상태
status string

요청 프로세스에서 기회가 있는 위치를 나타내는 상태입니다.

Deadline
deadline date-time

선물(예: '2020-09-18T04:13:56Z')을 생성할 수 있는 기회의 목표 날짜입니다.

질문 날짜
ask_date date-time

요청이 만들어진 날짜(예: '2020-09-18T04:13:56Z').

value
value double

통화 값입니다.

예상 날짜
expected_date date-time

잠재고객이 기회에 대한 응답으로 제공할 것으로 예상되는 날짜(예: '2020-09-18T04:13:56Z').

value
value double

통화 값입니다.

자금 지원 날짜
funded_date date-time

잠재고객이 기회에 대한 응답으로 준 날짜(예: '2020-09-18T04:13:56Z')

value
value double

통화 값입니다.

캠페인 ID
campaign_id string

기회와 관련된 캠페인의 시스템 레코드 ID입니다. 이 캠페인은 기금 모금을 위한 전반적인 목표를 설정합니다.

펀드 ID
fund_id string

기회와 관련된 펀드의 시스템 레코드 ID입니다. 기금은 선물의 특정 재무 목적을 지정하고 그 선물에 대한 금융 계좌를 식별합니다.

구성 요소 ID
constituent_id string

모금 행사와 관련된 구성 요소의 시스템 레코드 ID입니다.

value
value double

통화 값입니다.

게으른?
inactive boolean

기회가 비활성 상태인가요?

기회 첨부 파일 나열

기회의 첨부 파일을 나열합니다.

매개 변수

Name 필수 형식 Description
기회 ID
opportunity_id True string

기회의 시스템 레코드 ID입니다.

반환

Attachments

기회 첨부 파일 만들기

새 기회 첨부 파일을 만듭니다.

매개 변수

Name 필수 형식 Description
기회 ID
parent_id True string

첨부 파일과 연결된 기회의 시스템 레코드 ID입니다.

유형
type True string

첨부 파일 형식입니다. 실제 첨부 파일은 로컬 또는 네트워크에 저장된 이미지, PDF 또는 Word 문서와 같은 업로드된 파일입니다. 시스템에 저장되고 관리됩니다. 링크 첨부 파일은 온라인 또는 클라우드 스토리지 계정에 있는 이미지, 블로그 게시물 또는 YouTube 비디오와 같은 파일에 대한 링크입니다. 외부에 저장되고 관리됩니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜(예: '2020-09-18T04:13:56Z') 이 필드는 기본적으로 현재 날짜 및 시간(제공되지 않은 경우)으로 설정됩니다.

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

파일 이름
file_name string

파일 이름입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

파일 ID
file_id string

파일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 ID
thumbnail_id string

썸네일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

반환

기회 첨부 파일 만들기

기회 첨부 파일 업데이트

기회 첨부 파일을 업데이트합니다.

매개 변수

Name 필수 형식 Description
첨부 파일 ID
attachment_id True string

업데이트할 첨부 파일의 시스템 레코드 ID입니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜(예: '2020-09-18T04:13:56Z')

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

레코드 집합에서 목록 만들기

지정된 레코드 집합으로 필터링된 새 목록을 만듭니다.

매개 변수

Name 필수 형식 Description
이름
name True string

목록의 이름입니다. 문자 제한: 50.

Description
description True string

목록에 대한 설명입니다.

목록 유형
list_type True string

만들 목록의 형식을 결정합니다.

Permissions
list_permissions True string

다른 사용자가 목록에 액세스할 수 있는지 여부를 결정합니다.

ID
ids True array of string

목록에 포함된 레코드의 고유 식별자입니다(최대값은 100,000개).

반환

목록이 만들어짐

모금 행사 할당 만들기

새 모금 행사 할당을 만듭니다.

매개 변수

Name 필수 형식 Description
모금 행사 ID
fundraiser_id True string

모금 행사의 시스템 레코드 ID입니다.

구성 요소 ID
constituent_id True string

할당된 구성 요소의 시스템 레코드 ID입니다.

유형
type string

모금 행사의 유형입니다.

할당 시작
start date-time

배정의 시작 날짜입니다.

할당 종료
end date-time

배정의 종료 날짜입니다.

금액
value True double

기금 모금이 할당된 구성원에게 요청할 목표 금액입니다.

캠페인 ID
campaign_id string

결과 선물을 적용할 캠페인의 시스템 레코드 ID입니다.

펀드 ID
fund_id string

결과 선물을 적용할 펀드의 시스템 레코드 ID입니다.

항소 ID
appeal_id string

결과 선물을 적용할 항소의 시스템 레코드 ID입니다.

반환

모금 행사 할당 만들기

목록 어필 사용자 지정 필드

항소에 대한 사용자 지정 필드를 나열합니다.

매개 변수

Name 필수 형식 Description
항소 ID
appeal_id True string

항소의 시스템 레코드 ID입니다.

반환

사용자 지정 필드

목록에 레코드 추가

기존 목록에 레코드 집합을 추가합니다.

매개 변수

Name 필수 형식 Description
목록 유형
list_type True string

목록의 형식입니다.

List
list_id True string

목록의 시스템 레코드 ID입니다.

ID
ids True array of string

목록에 추가할 레코드의 고유 식별자입니다(최대값은 100,000개).

문서 위치 만들기

새 고유한 문서 식별자를 만들고 물리적 첨부 파일에 사용할 위치를 업로드합니다. 응답에는 문서 내용을 업로드하는 위치 및 방법에 대한 지침이 포함됩니다.

매개 변수

Name 필수 형식 Description
파일 이름
file_name string

업로드할 문서의 파일 이름입니다.

썸네일을 포함하시겠습니까?
upload_thumbnail boolean

썸네일 문서 위치를 포함하시겠습니까?

반환

파일 정의

선물 나열

선물 목록을 반환합니다.

매개 변수

Name 필수 형식 Description
List
list_id string

지정된 목록에 포함된 선물 집합을 필터링하는 데 사용되는 목록 식별자를 정의합니다. 이 값을 설정하면 지정된 다른 필터가 무시됩니다.

유형
gift_type string

결과를 필터링하기 위해 쉼표로 구분된 선물 유형의 목록을 나타냅니다. 예를 들어 "MatchingGiftPledge,RecurringGift"는 MatchingGiftPledge 또는 RecurringGift 형식의 선물만 반환합니다.

구성 요소 ID
constituent_id string

결과를 필터링할 구성 요소 식별자의 쉼표로 구분된 목록을 나타냅니다. 예를 들어 "280,1232"는 구성 요소 280 또는 구성 요소 1232의 선물만 반환합니다.

캠페인 ID
campaign_id string

결과를 필터링할 캠페인 식별자의 쉼표로 구분된 목록을 나타냅니다. 예를 들어 "506,918"은 캠페인 506 또는 캠페인 918에 선물만 반환합니다.

펀드 ID
fund_id string

결과를 필터링하기 위해 쉼표로 구분된 펀드 식별자 목록을 나타냅니다. 예를 들어 "506,918"은 506 또는 기금 918에 대한 선물만 반환합니다.

항소 ID
appeal_id string

결과를 필터링할 쉼표로 구분된 호소 식별자 목록을 나타냅니다. 예를 들어 "506,918"은 506 또는 항소 918에 호소하는 선물만 반환합니다.

한계
limit integer

반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 5000입니다.

상쇄
offset integer

건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다.

선물 시작 날짜
start_gift_date date-time

지정한 날짜(예: '2020-09-18T04:13:56Z') 이후의 선물 날짜가 있는 선물 필터를 나타냅니다.

선물 종료 날짜
end_gift_date date-time

지정한 날짜(예: '2020-09-18T04:13:56Z') 이전의 선물 날짜가 있는 선물 필터를 나타냅니다.

시작 선물 금액
start_gift_amount double

지정된 금액보다 크거나 같은 선물의 필터를 나타냅니다.

최종 선물 금액
end_gift_amount double

지정된 금액보다 작거나 같은 선물의 필터를 나타냅니다.

게시 상태
post_status string

결과를 필터링하기 위해 쉼표로 구분된 선물 게시 상태 목록을 나타냅니다. 예를 들어 "DoNotPost,Posted"는 DoNotPost 또는 Posted로 표시된 선물만 반환합니다.

영수증 상태
receipt_status string

결과를 필터링하기 위해 쉼표로 구분된 선물 영수증 상태 목록을 나타냅니다. 예를 들어 "DoNotReceipt,Receipted"는 DoNotReceipt 또는 Receipted로 표시된 선물만 반환합니다.

승인 상태
acknowledgement_status string

결과를 필터링하기 위해 쉼표로 구분된 선물 승인 상태 목록을 나타냅니다. 예를 들어 "DoNotAcknowledge,승인됨"은 DoNotAcknowledge 또는 승인됨으로 표시된 선물만 반환합니다.

추가된 이후
date_added date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에 생성된 선물로 결과를 필터링합니다.

수정된 날짜 또는 이후
last_modified date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에 수정된 선물로 결과를 필터링합니다.

반환

선물

선물 만들기

새 선물을 만듭니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

기프트와 연결된 구성 요소의 시스템 레코드 ID입니다.

금액
value True double

선물의 금액입니다.

날짜
date True date

선물 날짜(예: '2020-09-18').

유형
type True string

선물 종류입니다.

캠페인 ID
campaign_id string

기프트 분할과 관련된 캠페인의 시스템 레코드 ID입니다.

fund ID
fund_id True string

선물 분할과 관련된 펀드의 시스템 레코드 ID입니다.

항소 ID
appeal_id string

기프트 분할과 관련된 항소의 시스템 레코드 ID입니다.

패키지 ID
package_id string

기프트 분할과 연결된 패키지의 시스템 레코드 ID입니다.

분량
value True double

선물 분할의 금액입니다.

결제 방법
payment_method True string

결제 방법입니다.

번호 확인
check_number string

수표 번호입니다(결제 방법이 "PersonalCheck"인 경우에만 적용 가능).

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

Reference
reference string

결제 참조(결제 방법이 "기타"인 경우에만 적용됨).

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

익명인가요?
is_anonymous boolean

선물은 익명인가요? 값이 제공되지 않으면 기증자의 기본 익명성이 사용됩니다.

서브타입
subtype string

선물의 하위 형식입니다.

주석
reference string

그 뒤에 동기 부여 또는 선물 종류에 대한 자세한 설명과 같은 선물에 대한 특별한 세부 사항을 추적하는 노트.

조회 ID
lookup_id string

선물에 대한 사용자 정의 식별자입니다.

기금 모금 크레딧을 사용하시겠습니까?
default_fundraiser_credits boolean

기본 기금 모금 크레딧을 사용하시겠습니까?

소프트 크레딧을 사용하시겠습니까?
default_soft_credits boolean

기본 소프트 크레딧을 사용하시겠습니까?

선거 구민
constituency string

선물의 선거구입니다.

일괄 처리 접두사
batch_prefix string

일괄 처리 선물에 사용할 접두사입니다. 이 값은 하나 이상의 문자를 포함해야 하며 'Batch 번호'에 값이 있는 경우 필요합니다.

일괄 처리 번호
batch_number string

일괄 처리 번호입니다. 문자 제한: 50(일괄 처리 접두사 포함)

게시 상태
post_status string

선물의 게시물 상태입니다.

게시 날짜
post_date date

선물이 게시된 날짜(예: '2020-09-18').

영수증 상태
status True string

선물의 영수증 상태입니다.

영수증 금액
value True double

선물에 대한 영수증의 금액입니다.

수령 날짜
date date

선물이 수신된 날짜입니다(예: '2020-09-18').

반환

만든 선물

선물 받기

선물에 대한 정보를 반환합니다.

매개 변수

Name 필수 형식 Description
기프트 ID
gift_id True string

가져올 선물의 시스템 레코드 ID입니다.

반환

선물

선물 사용자 정의 필드 만들기

새 선물 사용자 정의 필드를 만듭니다.

매개 변수

Name 필수 형식 Description
body
body True dynamic

만들 사용자 지정 필드를 나타내는 개체입니다.

반환

선물 사용자 정의 필드 만들기

선물 사용자 정의 필드 업데이트

선물 사용자 정의 필드를 업데이트합니다.

매개 변수

Name 필수 형식 Description
사용자 지정 필드 ID
custom_field_id True string

업데이트할 사용자 지정 필드의 시스템 레코드 ID입니다.

body
body True dynamic

업데이트할 사용자 지정 필드의 속성을 나타내는 개체입니다.

선물 사용자 지정 필드 나열

선물에 대한 사용자 지정 필드를 나열합니다.

매개 변수

Name 필수 형식 Description
기프트 ID
gift_id True string

선물의 시스템 레코드 ID입니다.

반환

사용자 지정 필드

선물 승인 세부 정보 업데이트

선물에 대한 승인 세부 정보를 업데이트합니다.

매개 변수

Name 필수 형식 Description
승인 ID
acknowledgement_id True string

업데이트할 선물 승인의 시스템 레코드 ID입니다. 부모 선물의 ID를 해당 값으로 사용합니다.

상태
status string

승인의 상태입니다. 상태가 DoNotAcknowledge로 설정된 경우 문자와 날짜는 null이어야 합니다. 상태가 NeedsAcknowledgement로 설정된 경우 날짜는 null이어야 합니다.

날짜
date date-time

승인과 관련된 날짜입니다(예: '2020-09-18T04:13:56Z').

편지
letter string

승인과 관련된 편지입니다.

선물 영수증 세부 정보 업데이트

선물의 영수증 세부 정보를 업데이트합니다.

매개 변수

Name 필수 형식 Description
영수증 ID
receipt_id True string

업데이트할 선물 영수증의 시스템 레코드 ID입니다. 부모 선물의 ID를 해당 값으로 사용합니다.

상태
status string

선물의 영수증 상태입니다. 상태가 NeedsReceipt 또는 DoNotReceipt로 설정된 경우 영수증 날짜는 null이어야 합니다.

value
value double

통화 값입니다.

날짜
date date-time

영수증 날짜(예: '2020-09-18T04:13:56Z')

Number
number integer

영수증의 수입니다.

선물 일괄 처리 나열

선물 일괄 처리를 나열합니다.

매개 변수

Name 필수 형식 Description
일괄 처리 번호
batch_number string

지정된 숫자와 일치하는 결과에 대한 필터를 나타냅니다.

승인?
approved boolean

선물 일괄 처리의 상태에 대한 필터를 나타냅니다.

예외가 있나요?
has_exceptions boolean

선물 일괄 처리에 예외가 포함되어 있는지 여부에 대한 필터를 나타냅니다.

한계
limit integer

반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 5000입니다.

상쇄
offset integer

건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다.

텍스트 검색
search_text string

일괄 처리 설명 또는 일괄 처리 번호 필드에 포함된 텍스트에 대한 필터를 나타냅니다.

만든 사람:
created_by string

지정된 사용자가 만든 선물 일괄 처리에 대한 필터를 나타냅니다.

반환

선물 일괄 처리

선물 일괄 처리 만들기

새 선물 일괄 처리를 만듭니다.

매개 변수

Name 필수 형식 Description
Description
batch_description string

일괄 처리에 대한 설명입니다.

예상 숫자
expected_number integer

일괄 처리에 필요한 선물의 수입니다.

예상 총계
expected_batch_total double

일괄 처리에 있는 선물의 총 값입니다.

일괄 처리 번호
batch_number string

일괄 처리와 관련된 고유 식별자입니다.

반환

선물 일괄 처리 만들기

선물 첨부 파일 나열

선물에 대한 첨부 파일을 나열합니다.

매개 변수

Name 필수 형식 Description
기프트 ID
gift_id True string

선물의 시스템 레코드 ID입니다.

반환

Attachments

선물 첨부 파일 만들기

새 선물 첨부 파일을 만듭니다.

매개 변수

Name 필수 형식 Description
기프트 ID
parent_id True string

첨부 파일과 연결된 선물의 시스템 레코드 ID입니다.

유형
type True string

첨부 파일 형식입니다. 실제 첨부 파일은 로컬 또는 네트워크에 저장된 이미지, PDF 또는 Word 문서와 같은 업로드된 파일입니다. 시스템에 저장되고 관리됩니다. 링크 첨부 파일은 온라인 또는 클라우드 스토리지 계정에 있는 이미지, 블로그 게시물 또는 YouTube 비디오와 같은 파일에 대한 링크입니다. 외부에 저장되고 관리됩니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜(예: '2020-09-18T04:13:56Z') 이 필드는 기본적으로 현재 날짜 및 시간(제공되지 않은 경우)으로 설정됩니다.

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

파일 이름
file_name string

파일 이름입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

파일 ID
file_id string

파일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 ID
thumbnail_id string

썸네일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

반환

선물 첨부 파일 만들기

선물 첨부 파일 업데이트

선물 첨부 파일을 업데이트합니다.

매개 변수

Name 필수 형식 Description
첨부 파일 ID
attachment_id True string

업데이트할 첨부 파일의 시스템 레코드 ID입니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜(예: '2020-09-18T04:13:56Z')

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

영업 기회 만들기

새 기회를 만듭니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

기회와 연결된 구성 요소의 시스템 레코드 ID입니다.

목적
purpose True string

기회의 결과로 모금 된 모든 돈에 대한 의도 된 사용.

이름
name True string

목록 또는 구성 레코드와 같이 프로그램 전체에서 기회를 식별하는 이름입니다. 문자 제한: 255.

상태
status string

요청 프로세스에서 기회가 있는 위치를 나타내는 상태입니다.

Deadline
deadline date-time

선물(예: '2020-09-18T04:13:56Z')을 생성할 수 있는 기회의 목표 날짜입니다.

질문 날짜
ask_date date-time

요청이 만들어진 날짜(예: '2020-09-18T04:13:56Z').

value
value double

통화 값입니다.

예상 날짜
expected_date date-time

잠재고객이 기회에 대한 응답으로 제공할 것으로 예상되는 날짜(예: '2020-09-18T04:13:56Z').

value
value double

통화 값입니다.

자금 지원 날짜
funded_date date-time

잠재고객이 기회에 대한 응답으로 준 날짜(예: '2020-09-18T04:13:56Z')

value
value double

통화 값입니다.

캠페인 ID
campaign_id string

기회와 관련된 캠페인의 시스템 레코드 ID입니다. 이 캠페인은 기금 모금을 위한 전반적인 목표를 설정합니다.

펀드 ID
fund_id string

기회와 관련된 펀드의 시스템 레코드 ID입니다. 기금은 선물의 특정 재무 목적을 지정하고 그 선물에 대한 금융 계좌를 식별합니다.

구성 요소 ID
constituent_id string

모금 행사와 관련된 구성 요소의 시스템 레코드 ID입니다.

value
value double

통화 값입니다.

게으른?
inactive boolean

기회가 비활성 상태인가요?

반환

만든 기회

이벤트 가져오기

이벤트에 대한 정보를 반환합니다.

매개 변수

Name 필수 형식 Description
이벤트 ID
event_id True string

가져올 이벤트의 시스템 레코드 ID입니다.

반환

Event

이벤트 나열

이벤트 목록을 반환합니다.

매개 변수

Name 필수 형식 Description
카테고리
category string

이벤트 범주를 기준으로 필터링합니다.

시작 날짜
start_date_from date

지정된 날짜(예: '2020-09-18')의 시작 날짜 또는 이후의 이벤트로 결과를 필터링합니다.

시작 날짜
start_date_to date

지정된 날짜(예: '2020-09-18')의 시작 날짜 또는 이전의 이벤트로 결과를 필터링합니다.

비활성 상태 포함
include_inactive boolean

비활성 이벤트를 포함하시겠습니까?

한계
limit integer

반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 10000입니다.

상쇄
offset integer

건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다.

이벤트 ID
event_id string

지정된 시스템 레코드 ID와 일치하는 이벤트를 필터링합니다.

이름
name string

지정된 이름과 일치하는 이벤트를 필터링합니다.

추가된 이후
date_added date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에 생성된 이벤트로 결과를 필터링합니다.

수정된 날짜 또는 이후
last_modified date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에 수정된 이벤트로 결과를 필터링합니다.

반환

Events

이벤트 만들기

새 이벤트를 만듭니다.

매개 변수

Name 필수 형식 Description
이벤트 이름
name True string

이벤트의 이름입니다.

Description
description string

이벤트에 대한 설명입니다.

카테고리
name True string

범주 이름입니다.

시작 날짜
start_date True date

이벤트의 시작 날짜입니다(예: '2020-09-18').

시작 시간
start_time string

이벤트의 시작 시간(예: '07:30')입니다.

끝 날짜
end_date date

이벤트의 종료 날짜입니다(예: '2020-09-18').

종료 시간
end_time string

이벤트의 종료 시간(예: '07:30)'.

조회 ID
lookup_id string

이벤트의 조회 ID입니다.

Capacity
capacity integer

이벤트에 참석할 수 있는 사용자 수입니다.

목표
goal double

이벤트의 금전적 목표입니다.

캠페인 ID
campaign_id string

이벤트와 연결된 캠페인의 시스템 레코드 ID입니다.

펀드 ID
fund_id string

이벤트와 연결된 펀드의 시스템 레코드 ID입니다.

게으른?
inactive boolean

이벤트가 활성 상태입니까?

반환

만든 이벤트

이벤트 업데이트

이벤트에 대한 세부 정보를 업데이트합니다.

매개 변수

Name 필수 형식 Description
이벤트 ID
event_id True string

업데이트할 이벤트의 시스템 레코드 ID입니다.

이벤트 이름
name string

이벤트의 이름입니다.

Description
description string

이벤트에 대한 설명입니다.

카테고리
name True string

범주 이름입니다.

시작 날짜
start_date date

이벤트의 시작 날짜입니다(예: '2020-09-18').

시작 시간
start_time string

이벤트의 시작 시간(예: '07:30')입니다.

끝 날짜
end_date date

이벤트의 종료 날짜입니다(예: '2020-09-18').

종료 시간
end_time string

이벤트의 종료 시간(예: '07:30')

조회 ID
lookup_id string

이벤트의 조회 ID입니다.

Capacity
capacity integer

이벤트에 참석할 수 있는 사용자 수입니다.

목표
goal double

이벤트의 금전적 목표입니다.

캠페인 ID
campaign_id string

이벤트와 연결된 캠페인의 시스템 레코드 ID입니다.

펀드 ID
fund_id string

이벤트와 연결된 펀드의 시스템 레코드 ID입니다.

게으른?
inactive boolean

이벤트가 활성 상태입니까?

이벤트 요금 나열

이벤트에 대한 수수료를 나열합니다.

매개 변수

Name 필수 형식 Description
이벤트 ID
event_id True string

이벤트의 시스템 레코드 ID입니다.

반환

요금

이벤트 요금 만들기

이벤트에 대한 새 요금을 만듭니다.

매개 변수

Name 필수 형식 Description
이벤트 ID
event_id True string

이벤트의 시스템 레코드 ID입니다.

이름
name True string

수수료의 이름입니다.

수수료 금액
cost True double

수수료와 관련된 금액입니다.

기여 금액
contribution_amount True double

이벤트 비용보다 높은 기부금의 금액입니다.

반환

이벤트 요금 생성

이벤트 참가자 나열

이벤트에 대한 참가자를 나열합니다.

매개 변수

Name 필수 형식 Description
이벤트 ID
event_id True string

이벤트의 시스템 레코드 ID입니다.

RSVP 상태
rsvp_status string

RSVP 상태에 따라 참가자를 필터링합니다.

초대 상태
invitation_status string

초대 상태에 따라 참가자를 필터링합니다.

참여 수준
participation_level string

참여 수준에 따라 참가자를 필터링합니다.

참석?
attended_filter boolean

참석자로 표시된 참가자를 포함하거나 제외하는 필터입니다.

지불 된 수수료?
fees_paid_filter boolean

수수료를 지불한 참가자를 포함하거나 제외하는 경우 필터링합니다.

한계
limit integer

반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 10000입니다.

상쇄
offset integer

건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다.

구성 요소인가요?
is_constituent_filter boolean

구성 요소인 참가자를 포함하거나 제외하는 필터입니다.

적격 전자 메일이 있나요?
email_eligible_filter boolean

참가자에게 전자 메일이 표시되지 않는 기본 전자 메일 주소가 있는지 여부에 따라 참가자를 포함하거나 제외하는 필터

적격 휴대폰이 있나요?
phone_call_eligible_filter boolean

통화 안 함으로 표시되지 않은 기본 전화 번호가 있는지 여부에 따라 참가자를 포함하거나 제외하도록 필터링합니다.

이름
name string

지정된 이름과 일치하는 참가자를 필터링합니다.

추가된 이후
date_added date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에서 만든 참가자로 결과를 필터링합니다.

수정된 날짜 또는 이후
last_modified date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에서 수정된 참가자로 결과를 필터링합니다.

반환

Participants

이벤트 참가자 옵션 나열

이벤트에 대한 참가자 옵션을 나열합니다.

매개 변수

Name 필수 형식 Description
이벤트 ID
event_id True string

이벤트 ID입니다.

반환

이벤트 참가자 옵션

이벤트 참가자 옵션 만들기

이벤트에 대한 새 참가자 옵션을 만듭니다.

매개 변수

Name 필수 형식 Description
이벤트 ID
event_id True string

이벤트 ID입니다.

이름
name True string

이벤트 참가자 옵션의 이름입니다.

입력 형식
input_type True string

참가자가 응답을 제공하는 데 사용할 수 있는 값 유형입니다.

다중 선택을 허용하시겠습니까?
multi_select boolean

목록에 두 개 이상의 값을 허용하시겠습니까?

이름
name string

목록 옵션의 이름입니다.

식별
sequence integer

순서 지정에 사용되는 0부터 시작하는 시퀀스입니다.

반환

이벤트 참가자 옵션 만들기

일괄 처리에 선물 추가

지정된 선물 일괄 처리에 선물을 추가합니다.

매개 변수

Name 필수 형식 Description
묶음
batch_id True string

선물이 추가될 일괄 처리입니다.

구성 요소 ID
constituent_id True string

기프트와 연결된 구성 요소의 시스템 레코드 ID입니다.

금액
value True double

선물의 금액입니다.

날짜
date True date

선물 날짜(예: '2020-09-18').

유형
type True string

선물 종류입니다.

캠페인 ID
campaign_id string

기프트 분할과 관련된 캠페인의 시스템 레코드 ID입니다.

fund ID
fund_id True string

선물 분할과 관련된 펀드의 시스템 레코드 ID입니다.

항소 ID
appeal_id string

기프트 분할과 관련된 항소의 시스템 레코드 ID입니다.

패키지 ID
package_id string

기프트 분할과 연결된 패키지의 시스템 레코드 ID입니다.

분량
value True double

선물 분할의 금액입니다.

결제 방법
payment_method True string

결제 방법입니다.

번호 확인
check_number string

수표 번호입니다(결제 방법이 "PersonalCheck"인 경우에만 적용 가능).

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

Reference
reference string

결제 참조(결제 방법이 "기타"인 경우에만 적용됨).

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

익명인가요?
is_anonymous boolean

선물은 익명인가요? 값이 제공되지 않으면 기증자의 기본 익명성이 사용됩니다.

서브타입
subtype string

선물의 하위 형식입니다.

주석
reference string

그 뒤에 동기 부여 또는 선물 종류에 대한 자세한 설명과 같은 선물에 대한 특별한 세부 사항을 추적하는 노트.

조회 ID
lookup_id string

선물에 대한 사용자 정의 식별자입니다.

기금 모금 크레딧을 사용하시겠습니까?
default_fundraiser_credits boolean

기본 기금 모금 크레딧을 사용하시겠습니까?

소프트 크레딧을 사용하시겠습니까?
default_soft_credits boolean

기본 소프트 크레딧을 사용하시겠습니까?

선거 구민
constituency string

선물의 선거구입니다.

게시 상태
post_status string

선물의 게시물 상태입니다.

게시 날짜
post_date date

선물이 게시된 날짜(예: '2020-09-18').

영수증 상태
status True string

선물의 영수증 상태입니다.

영수증 금액
value True double

선물에 대한 영수증의 금액입니다.

수령 날짜
date date

선물이 수신된 날짜입니다(예: '2020-09-18').

반환

작업에서 추가한 일괄 처리 선물 오류 레코드 및 일괄 처리 선물의 컬렉션을 포함합니다.

자금 나열

자금 목록을 반환합니다.

매개 변수

Name 필수 형식 Description
한계
limit integer

반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 5000입니다.

상쇄
offset integer

건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다.

비활성 상태 포함
include_inactive boolean

비활성 자금을 포함하시겠습니까?

추가된 이후
date_added date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에서 만든 자금으로 결과를 필터링합니다.

수정된 날짜 또는 이후
last_modified date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에 수정된 자금으로 결과를 필터링합니다.

반환

자금

작업 나열

작업 목록을 반환합니다.

매개 변수

Name 필수 형식 Description
List
list_id string

지정된 목록에 포함된 작업 집합을 필터링하는 데 사용되는 목록 식별자를 정의합니다. 이 값을 설정하면 지정된 다른 필터가 무시됩니다.

계산된 상태
computed_status string

계산된 작업 상태에 따라 결과에 대한 필터를 나타냅니다. 사용 가능한 값은 Open, Completed 또는 PastDue입니다.

상태
status_code string

결과를 필터링하는 작업 상태 코드를 나타냅니다(시스템이 작업 상태 코드를 사용하도록 구성된 경우에만 적용 가능). 예를 들어 "Pending"은 상태가 "Pending"인 작업을 반환합니다.

한계
limit integer

반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 5000입니다.

상쇄
offset integer

건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다.

추가된 이후
date_added date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에 생성된 작업으로 결과를 필터링합니다.

수정된 날짜 또는 이후
last_modified date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에 수정된 작업으로 결과를 필터링합니다.

반환

활동

작업 사용자 정의 필드 나열

작업에 대한 사용자 지정 필드를 나열합니다.

매개 변수

Name 필수 형식 Description
작업 ID
action_id True string

작업의 시스템 레코드 ID입니다.

반환

사용자 지정 필드

작업 사용자 정의 필드 만들기

새 작업 사용자 정의 필드를 만듭니다.

매개 변수

Name 필수 형식 Description
body
body True dynamic

만들 사용자 지정 필드를 나타내는 개체입니다.

반환

만든 작업 사용자 정의 필드

작업 사용자 정의 필드 업데이트

작업 사용자 정의 필드를 업데이트합니다.

매개 변수

Name 필수 형식 Description
사용자 지정 필드 ID
custom_field_id True string

업데이트할 사용자 지정 필드의 시스템 레코드 ID입니다.

body
body True dynamic

업데이트할 사용자 지정 필드의 속성을 나타내는 개체입니다.

작업 첨부 파일 나열

작업에 대한 첨부 파일을 나열합니다.

매개 변수

Name 필수 형식 Description
작업 ID
action_id True string

작업의 시스템 레코드 ID입니다.

반환

Attachments

작업 첨부 파일 만들기

새 작업 첨부 파일을 만듭니다.

매개 변수

Name 필수 형식 Description
작업 ID
parent_id True string

첨부 파일과 연결된 작업의 시스템 레코드 ID입니다.

유형
type True string

첨부 파일 형식입니다. 실제 첨부 파일은 로컬 또는 네트워크에 저장된 이미지, PDF 또는 Word 문서와 같은 업로드된 파일입니다. 시스템에 저장되고 관리됩니다. 링크 첨부 파일은 온라인 또는 클라우드 스토리지 계정에 있는 이미지, 블로그 게시물 또는 YouTube 비디오와 같은 파일에 대한 링크입니다. 외부에 저장되고 관리됩니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜(예: '2020-09-18T04:13:56Z') 이 필드는 기본적으로 현재 날짜 및 시간(제공되지 않은 경우)으로 설정됩니다.

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

파일 이름
file_name string

파일 이름입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

파일 ID
file_id string

파일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 ID
thumbnail_id string

썸네일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

반환

작업 첨부 파일 만들기

작업 첨부 파일 업데이트

작업 첨부 파일을 업데이트합니다.

매개 변수

Name 필수 형식 Description
첨부 파일 ID
attachment_id True string

업데이트할 첨부 파일의 시스템 레코드 ID입니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜(예: '2020-09-18T04:13:56Z')

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

조직 관계 만들기

새 조직 관계를 만듭니다. 관계가 다른 구성 요소와 인 경우 해당 구성 요소에 대한 상호 관계가 만들어집니다.

매개 변수

Name 필수 형식 Description
구성 요소 ID
constituent_id True string

관계와 연결된 구성 요소의 시스템 레코드 ID입니다.

관계 ID
relation_id True string

관련 조직의 시스템 레코드 ID입니다.

유형
type string

관계가 나타내는 관계의 형식입니다.

상호 형식
reciprocal_type string

관련 조직과의 관계를 설명합니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

연락처인가요?
is_organization_contact boolean

구성 요소가 이 조직을 연락처로 나타내나요?

연락처 유형
organization_contact_type string

조직을 연락처로 나타내는 관련 개인과의 상호 작용에 대한 컨텍스트를 제공합니다.

Position
position string

조직에서 개인의 위치입니다. 문자 제한: 50.

기본 비즈니스인가요?
is_primary_business boolean

이것이 구성 요소의 주요 사업인가요?

비고
comment string

관계에 대한 추가 정보입니다.

반환

조직 관계 만들기

조직 구성 요소 만들기

새 조직 구성 요소를 만듭니다.

매개 변수

Name 필수 형식 Description
이름
name True string

조직 이름입니다. 문자 제한: 100.

조회 ID
lookup_id string

구성 요소에 대한 사용자 정의 식별자입니다.

type
type True string

주소 유형입니다.

country
country string

주소의 국가(ID, 이름 또는 약어일 수 있습니다).

라인
address_lines string

주소 줄입니다. 문자 제한: 150.

city
city string

주소의 도시입니다(교외 필드와 함께 사용하지 마세요).

state string

주소의 상태입니다.

우편번호
postal_code string

주소의 우편 번호입니다. 문자 제한: 12.

교외
suburb string

주소의 교외(도시 필드와 함께 사용하지 마세요).

county string

주소의 카운티입니다.

start
start date

구성 요소가 이 주소에 거주하기 시작한 날짜입니다(예: '2005-09-18').

end date

구성 요소가 이 주소(예: '2005-09-18')에 거주하지 않는 날짜입니다.

type
type True string

전화 유형입니다.

숫자
number True string

전화 번호입니다.

기본인가요?
primary boolean

이 번호가 구성 요소의 기본 전화 번호인가요?

type
type True string

전자 메일 주소의 유형입니다.

address
address True string

전자 메일 주소입니다.

기본인가요?
primary boolean

이 주소가 구성 요소의 기본 이메일 주소인가요?

type
type True string

온라인 현재 상태 유형입니다.

address
address True string

온라인 상태의 웹 주소입니다.

기본인가요?
primary boolean

이것은 구성 요소의 주요 온라인 존재인가요?

익명으로 제공?
gives_anonymously boolean

구성 요소는 익명으로 제공합니까?

산업
industry string

구성 요소의 산업.

직원 수
num_employees integer

조직의 직원 수입니다.

선물과 일치하시겠습니까?
matches_gifts boolean

조직이 선물과 일치하나요?

일치하는 기프트 팩터
matching_gift_factor double

일치하는 기프트 팩터입니다.

선물당 최소 일치
value double

구성 요소에 대한 선물당 최소 일치 금액입니다.

선물당 최대 일치 항목
value double

구성 요소의 선물당 최대 일치 금액입니다.

constit당 최소 일치 항목
value double

구성 요소의 최소 일치 합계입니다.

constit당 최대 일치 항목
value double

구성 요소의 최대 일치 합계입니다.

일치하는 기프트 노트
matching_gift_notes string

구성 요소에 대한 일치하는 기프트 노트입니다.

반환

조직 구성 요소 만들기

참가자 가져오기

특정 이벤트 참가자에 대한 정보를 반환합니다.

매개 변수

Name 필수 형식 Description
참가자 ID
participant_id True string

참가자의 시스템 레코드 ID입니다.

반환

참가자

참가자 기부 만들기

참가자를 위한 새 기부를 만듭니다.

매개 변수

Name 필수 형식 Description
참가자 ID
participant_id True string

참가자의 시스템 레코드 ID입니다.

기프트 ID
gift_id True string

참가자 기부가 연결된 선물의 systetm 레코드 ID입니다.

반환

참가자 기부 만들기

참가자 기부금 나열

참가자의 기부금을 나열합니다.

매개 변수

Name 필수 형식 Description
참가자 ID
participant_id True string

참가자의 시스템 레코드 ID입니다.

한계
limit integer

반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 10000입니다.

상쇄
offset integer

건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다. 기본값은 0입니다.

반환

기부금

참가자 만들기

이벤트에 대한 새 참가자를 만듭니다.

매개 변수

Name 필수 형식 Description
이벤트 ID
event_id True string

이벤트의 시스템 레코드 ID입니다.

구성 요소 ID
constituent_id True string

참가자의 구성 ID입니다.

호스트 ID
host_id string

호스트 참가자 레코드의 ID입니다.

RSVP 상태
rsvp_status string

참가자의 이벤트 참여 상태입니다.

참석?
attended boolean

참가자가 이벤트에 참석했습니까?

초대 상태
invitation_status string

참가자 초대의 상태입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

참여 수준
name True string

참가 수준의 이름입니다.

반환

만든 참가자

참가자 수수료 결제 나열

참가자의 수수료 지급액을 나열합니다.

매개 변수

Name 필수 형식 Description
참가자 ID
participant_id True string

참가자의 시스템 레코드 ID입니다.

한계
limit integer

반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 10000입니다.

상쇄
offset integer

건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다. 기본값은 0입니다.

반환

수수료 지불

참가자 업데이트

참가자에 대한 세부 정보를 업데이트합니다.

매개 변수

Name 필수 형식 Description
참가자 ID
participant_id True string

업데이트할 참가자의 시스템 레코드 ID입니다.

구성 요소 ID
constituent_id string

참가자의 구성 ID입니다.

호스트 ID
host_id string

호스트 참가자 레코드의 ID입니다.

RSVP 상태
rsvp_status string

참가자의 이벤트 참여 상태입니다.

참석?
attended boolean

참가자가 이벤트에 참석했습니까?

초대 상태
invitation_status string

참가자 초대의 상태입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

참여 수준
name True string

참가 수준의 이름입니다.

참가자 옵션 나열

참가자의 참가자 옵션을 나열합니다.

매개 변수

Name 필수 형식 Description
참가자 ID
participant_id True string

참가자의 시스템 레코드 ID입니다.

반환

참가자 옵션

참가자 옵션 만들기

참가자에 대한 새 참가자 옵션을 만듭니다.

매개 변수

Name 필수 형식 Description
참가자 ID
participant_id True string

참가자의 ID입니다.

body
body True dynamic

만들 참가자 옵션을 나타내는 개체입니다.

반환

만든 참가자 옵션

참가자 옵션 업데이트

참가자 옵션에 대한 세부 정보를 업데이트합니다.

매개 변수

Name 필수 형식 Description
참가자 옵션 ID
option_id True string

업데이트할 참가자 옵션의 시스템 레코드 ID입니다.

가치
option_value True string

옵션에 대한 참가자의 응답입니다.

참가자 요금 나열

참가자에 대한 수수료를 나열합니다.

매개 변수

Name 필수 형식 Description
참가자 ID
participant_id True string

참가자의 시스템 레코드 ID입니다.

한계
limit integer

반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 10000입니다.

상쇄
offset integer

건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다. 기본값은 0입니다.

반환

요금

참가자 요금 만들기

참가자에 대한 새 요금을 만듭니다.

매개 변수

Name 필수 형식 Description
참가자 ID
participant_id True string

참가자의 시스템 레코드 ID입니다.

이벤트 ID
event_id True string

이벤트의 시스템 레코드 ID입니다.

수수료
event_fee_id True string

이벤트 요금입니다.

수량
quantity True integer

구매한 수량입니다.

수수료 금액
fee_amount True double

수수료와 관련된 금액입니다.

기여 금액
contribution_amount True double

이벤트 비용보다 높은 기부금의 금액입니다. 이는 일반적으로 영수증에 표시되는 금액입니다.

d integer

유사 날짜의 날짜입니다.

개월
m integer

유사 항목 날짜의 월입니다.

y integer

유사 날짜의 연도입니다.

반환

만든 참가자 요금

참가자 요금 지불 만들기

참가자에 대한 새 수수료 지불을 만듭니다.

매개 변수

Name 필수 형식 Description
참가자 ID
participant_id True string

참가자의 시스템 레코드 ID입니다.

기프트 ID
gift_id True string

참가자 수수료가 연결된 선물의 systetm 레코드 ID입니다.

적용된 금액
applied_amount True double

참가자 수수료에 적용되는 지불 금액입니다.

반환

참가자 요금 지불 생성

캠페인 가져오기

캠페인에 대한 정보를 반환합니다.

매개 변수

Name 필수 형식 Description
캠페인 ID
campaign_id True string

가져올 캠페인의 시스템 레코드 ID입니다.

반환

캠페인

캠페인 나열

캠페인 목록을 반환합니다.

매개 변수

Name 필수 형식 Description
한계
limit integer

반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 5000입니다.

상쇄
offset integer

건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다.

비활성 상태 포함
include_inactive boolean

비활성 캠페인을 포함하시겠습니까?

추가된 이후
date_added date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에 생성된 캠페인으로 결과를 필터링합니다.

수정된 날짜 또는 이후
last_modified date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에 수정된 캠페인으로 결과를 필터링합니다.

반환

캠페인

캠페인 사용자 정의 필드 만들기

새 캠페인 사용자 정의 필드를 만듭니다.

매개 변수

Name 필수 형식 Description
body
body True dynamic

만들 사용자 지정 필드를 나타내는 개체입니다.

반환

캠페인 사용자 정의 필드 만들기

캠페인 사용자 정의 필드 업데이트

캠페인 사용자 정의 필드를 업데이트합니다.

매개 변수

Name 필수 형식 Description
사용자 지정 필드 ID
custom_field_id True string

업데이트할 사용자 지정 필드의 시스템 레코드 ID입니다.

body
body True dynamic

업데이트할 사용자 지정 필드의 속성을 나타내는 개체입니다.

캠페인 사용자 지정 필드 나열

캠페인의 사용자 지정 필드를 나열합니다.

매개 변수

Name 필수 형식 Description
캠페인 ID
campaign_id True string

캠페인의 시스템 레코드 ID입니다.

반환

사용자 지정 필드

캠페인 첨부 파일 나열

캠페인의 첨부 파일을 나열합니다.

매개 변수

Name 필수 형식 Description
캠페인 ID
campaign_id True string

캠페인의 시스템 레코드 ID입니다.

반환

Attachments

캠페인 첨부 파일 만들기

새 캠페인 첨부 파일을 만듭니다.

매개 변수

Name 필수 형식 Description
캠페인 ID
parent_id True string

첨부 파일과 연결된 캠페인의 시스템 레코드 ID입니다.

유형
type True string

첨부 파일 형식입니다. 실제 첨부 파일은 로컬 또는 네트워크에 저장된 이미지, PDF 또는 Word 문서와 같은 업로드된 파일입니다. 시스템에 저장되고 관리됩니다. 링크 첨부 파일은 온라인 또는 클라우드 스토리지 계정에 있는 이미지, 블로그 게시물 또는 YouTube 비디오와 같은 파일에 대한 링크입니다. 외부에 저장되고 관리됩니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜(예: '2020-09-18T04:13:56Z') 이 필드는 기본적으로 현재 날짜 및 시간(제공되지 않은 경우)으로 설정됩니다.

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

파일 이름
file_name string

파일 이름입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

파일 ID
file_id string

파일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 ID
thumbnail_id string

썸네일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

반환

캠페인 첨부 파일 만들기

캠페인 첨부 파일 업데이트

캠페인 첨부 파일을 업데이트합니다.

매개 변수

Name 필수 형식 Description
첨부 파일 ID
attachment_id True string

업데이트할 첨부 파일의 시스템 레코드 ID입니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜(예: '2020-09-18T04:13:56Z')

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

패키지 가져오기

패키지에 대한 정보를 반환합니다.

매개 변수

Name 필수 형식 Description
패키지 ID
package_id True string

가져올 패키지의 시스템 레코드 ID입니다.

반환

Package

패키지 나열

패키지 목록을 반환합니다.

매개 변수

Name 필수 형식 Description
항소 ID
appeal_id string

결과를 필터링할 쉼표로 구분된 호소 식별자 목록을 나타냅니다. 예를 들어 "506,918"은 항소 506 또는 항소 918에 대한 패키지만 반환합니다.

한계
limit integer

반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 5000입니다.

상쇄
offset integer

건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다.

비활성 상태 포함
include_inactive boolean

비활성 패키지를 포함하시겠습니까?

추가된 이후
date_added date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에서 만든 패키지로 결과를 필터링합니다.

수정된 날짜 또는 이후
last_modified date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에 수정된 패키지로 결과를 필터링합니다.

반환

Packages

펀드 사용자 정의 필드 만들기

새 펀드 사용자 정의 필드를 만듭니다.

매개 변수

Name 필수 형식 Description
body
body True dynamic

만들 사용자 지정 필드를 나타내는 개체입니다.

반환

펀드 사용자 정의 필드 만들기

펀드 사용자 정의 필드 업데이트

펀드 사용자 정의 필드를 업데이트합니다.

매개 변수

Name 필수 형식 Description
사용자 지정 필드 ID
custom_field_id True string

업데이트할 사용자 지정 필드의 시스템 레코드 ID입니다.

body
body True dynamic

업데이트할 사용자 지정 필드의 속성을 나타내는 개체입니다.

펀드 사용자 지정 필드 나열

펀드의 사용자 지정 필드를 나열합니다.

매개 변수

Name 필수 형식 Description
펀드 ID
fund_id True string

펀드의 시스템 레코드 ID입니다.

반환

사용자 지정 필드

항소 목록

항소 목록을 반환합니다.

매개 변수

Name 필수 형식 Description
한계
limit integer

반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 5000입니다.

상쇄
offset integer

건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다.

비활성 상태 포함
include_inactive boolean

비활성 항소를 포함하시겠습니까?

추가된 이후
date_added date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에 대해 생성된 이의 제기에 대한 결과를 필터링합니다.

수정된 날짜 또는 이후
last_modified date-time

지정된 날짜(예: '2020-09-18T04:13:56Z')에 수정된 항소 결과를 필터링합니다.

반환

이의 제기

항소 받기

항소에 대한 정보를 반환합니다.

매개 변수

Name 필수 형식 Description
항소 ID
appeal_id True string

가져올 호소의 시스템 레코드 ID입니다.

반환

Appeal

항소 첨부 파일 나열

항소에 대한 첨부 파일을 나열합니다.

매개 변수

Name 필수 형식 Description
항소 ID
appeal_id True string

항소의 시스템 레코드 ID입니다.

반환

Attachments

항소 첨부 파일 만들기

새 호소 첨부 파일을 만듭니다.

매개 변수

Name 필수 형식 Description
항소 ID
parent_id True string

첨부 파일과 연결된 항소의 시스템 레코드 ID입니다.

유형
type True string

첨부 파일 형식입니다. 실제 첨부 파일은 로컬 또는 네트워크에 저장된 이미지, PDF 또는 Word 문서와 같은 업로드된 파일입니다. 시스템에 저장되고 관리됩니다. 링크 첨부 파일은 온라인 또는 클라우드 스토리지 계정에 있는 이미지, 블로그 게시물 또는 YouTube 비디오와 같은 파일에 대한 링크입니다. 외부에 저장되고 관리됩니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜(예: '2020-09-18T04:13:56Z') 이 필드는 기본적으로 현재 날짜 및 시간(제공되지 않은 경우)으로 설정됩니다.

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

파일 이름
file_name string

파일 이름입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

파일 ID
file_id string

파일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 ID
thumbnail_id string

썸네일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

반환

어필 첨부 파일 만들기

항소 첨부 파일 업데이트

항소 첨부 파일을 업데이트합니다.

매개 변수

Name 필수 형식 Description
첨부 파일 ID
attachment_id True string

업데이트할 첨부 파일의 시스템 레코드 ID입니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜(예: '2020-09-18T04:13:56Z')

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

호소 사용자 정의 필드 만들기

새 호소 사용자 정의 필드를 만듭니다.

매개 변수

Name 필수 형식 Description
body
body True dynamic

만들 사용자 지정 필드를 나타내는 개체입니다.

반환

어필 사용자 정의 필드 만들기

호소 사용자 정의 필드 업데이트

호소 사용자 정의 필드를 업데이트합니다.

매개 변수

Name 필수 형식 Description
사용자 지정 필드 ID
custom_field_id True string

업데이트할 사용자 지정 필드의 시스템 레코드 ID입니다.

body
body True dynamic

업데이트할 사용자 지정 필드의 속성을 나타내는 개체입니다.

정의

CommPrefApi.ConstituentConsentRead

구성 요소에 대한 동의 엔터티를 나타냅니다.

Name 경로 형식 Description
아이디
id string

동의 레코드의 시스템 레코드 ID입니다.

채널
channel string

동의 응답이 적용되는 채널입니다.

카테고리
category string

동의 응답이 적용되는 범주입니다.

출처
source string

구성 요소의 동의 응답 원본입니다.

응답
constituent_consent_response string

구성 요소가 지정된 채널/범주에 대한 동의에 응답하는 방식입니다.

날짜
consent_date date-time

동의 응답을 받은 날짜입니다.

동의 문
consent_statement string

동의를 제공할 때 구성 요소가 응답한 진술입니다.

개인정보 처리방침
privacy_notice string

구성 요소에 제공된 개인 정보 보호 알림입니다.

추가된 날짜
date_added date-time

동의 응답이 추가된 날짜입니다.

추가한 사람
user_name string

동의 응답을 추가한 사용자입니다.

CommPrefApi.ConstituentConsentReadCollection

동의 레코드

Name 경로 형식 Description
수량
count integer

목록의 동의 레코드 수입니다.

value
value array of CommPrefApi.ConstituentConsentRead

응답에 포함된 동의 레코드 집합입니다.

CommPrefApi.ConstituentSolicitCodeRead

코드 요청

Name 경로 형식 Description
아이디
id string

구성 요소 요청 코드의 시스템 레코드 ID입니다.

코드 요청
solicit_code string

구성 요소에 대한 통신 지침 및/또는 제한 사항입니다.

시작 날짜
start_date date

요청 코드의 시작 날짜입니다(예: '2005-09-18').

끝 날짜
end_date date

요청 코드의 종료 날짜입니다(예: '2005-09-18').

CommPrefApi.ConstituentSolicitCodeReadCollection

코드 요청

Name 경로 형식 Description
수량
count integer

목록의 구성 요소 요청 코드 수입니다.

value
value array of CommPrefApi.ConstituentSolicitCodeRead

응답에 포함된 구성 요청 코드 집합입니다.

CommPrefApi.CreatedConstituentConsent

구성 요소 동의 생성

Name 경로 형식 Description
아이디
id string

새로 만든 동의 레코드의 ID입니다.

CommPrefApi.CreatedConstituentSolicitCode

구성 요소 요청 코드 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 구성 요소 요청 코드의 ID입니다.

ConstituentApi.ActionAttachmentRead

첨부 파일

Name 경로 형식 Description
아이디
id string

첨부 파일의 시스템 레코드 ID입니다.

작업 ID
parent_id string

첨부 파일과 연결된 작업의 시스템 레코드 ID입니다.

유형
type string

첨부 파일 형식입니다. 실제 첨부 파일은 로컬 또는 네트워크에 저장된 이미지, PDF 또는 Word 문서와 같은 업로드된 파일입니다. 시스템에 저장되고 관리됩니다. 링크 첨부 파일은 온라인 또는 클라우드 스토리지 계정에 있는 이미지, 블로그 게시물 또는 YouTube 비디오와 같은 파일에 대한 링크입니다. 외부에 저장되고 관리됩니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜입니다.

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

파일 이름
file_name string

파일 이름입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

파일 ID
file_id string

파일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 ID
thumbnail_id string

썸네일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 URL
thumbnail_url string

썸네일의 URL입니다. 이미지만 있는 실제 첨부 파일의 경우 액세스를 60분으로 제한하는 시간 제한 서명을 포함합니다.

콘텐츠 형식
content_type string

콘텐츠 형식입니다. 실제 첨부 파일의 경우에만 해당합니다.

파일 크기
file_size integer

파일 크기(바이트)입니다. 실제 첨부 파일의 경우에만 해당합니다.

ConstituentApi.ActionCustomFieldRead

사용자 지정 필드

Name 경로 형식 Description
아이디
id string

사용자 지정 필드의 시스템 레코드 ID입니다.

작업 ID
parent_id string

사용자 지정 필드와 연결된 작업의 시스템 레코드 ID입니다.

카테고리
category string

사용자 지정 필드 범주입니다.

유형
type string

사용자 지정 필드가 나타내는 데이터의 형식입니다.

가치
value

사용자 지정 필드의 값입니다.

날짜
date date

사용자 지정 필드의 날짜입니다.

주석
comment string

사용자 지정 필드에 대한 주석입니다. 문자 제한: 50.

추가된 날짜
date_added date-time

사용자 지정 필드를 만든 날짜입니다.

수정된 날짜
date_modified date-time

사용자 지정 필드가 마지막으로 수정된 날짜입니다.

ConstituentApi.ActionRead

조치

Name 경로 형식 Description
아이디
id string

작업의 시스템 레코드 ID입니다.

구성 요소 ID
constituent_id string

작업과 연결된 구성 요소의 시스템 레코드 ID입니다.

카테고리
category string

구성 요소 상호 작용의 채널 또는 의도입니다.

완료?
completed boolean

작업이 완료되었는지 여부 시스템이 사용자 지정 작업 상태를 사용하도록 구성된 경우 이 값은 작업 상태 값을 기반으로 합니다.

완료됨
completed_date date-time

작업이 완료된 날짜입니다.

날짜
date date-time

작업 날짜입니다.

비고
description string

작업 요약을 자세히 설명하는 자세한 설명입니다.

방향
direction string

동작의 방향입니다.

모금 행사
fundraisers array of string

작업과 관련된 모금 행사의 시스템 레코드 ID 집합입니다.

위치
location string

작업의 위치입니다.

기회 ID
opportunity_id string

작업과 연결된 기회의 시스템 레코드 ID입니다.

결과
outcome string

작업의 결과입니다.

Priority
priority string

작업의 우선 순위입니다.

시작 시간
start_time string

작업의 시작 시간입니다. HH:mm 형식으로 24시간을 사용합니다.

종료 시간
end_time string

작업의 종료 시간입니다. HH:mm 형식으로 24시간을 사용합니다.

상태
status string

작업 상태입니다.

상태 코드
status_code string

작업 상태 코드입니다. 이 속성은 시스템이 사용자 지정 작업 상태를 사용하도록 구성된 경우에만 반환됩니다.

계산된 상태
computed_status string

계산된 작업 상태입니다. 시스템이 사용자 지정 작업 상태를 사용하도록 구성되지 않은 경우 이 필드는 완료된 날짜 속성과 날짜 속성을 기반으로 상태를 계산합니다. 그렇지 않은 경우 필드는 작업의 날짜 속성 및 작업의 작업 상태 속성이 완료된 것으로 구성되었는지 여부에 따라 상태를 계산합니다.

요약
summary string

레코드의 맨 위에 표시되는 작업에 대한 간단한 설명입니다. 문자 제한: 255.

유형
type string

범주를 보완하기 위한 작업에 대한 추가 설명입니다.

추가된 날짜
date_added date-time

작업이 만들어진 날짜입니다.

수정된 날짜
date_modified date-time

작업이 마지막으로 수정된 날짜입니다.

ConstituentApi.AddressRead

Address

Name 경로 형식 Description
아이디
id string

주소의 시스템 레코드 ID입니다.

유형
type string

주소 유형입니다.

국가
country string

주소의 국가(ID, 이름 또는 약어일 수 있습니다).

주소 줄
address_lines string

주소 줄입니다.

도시
city string

주소의 도시입니다(교외 필드와 함께 사용하지 마세요).

state string

주소의 상태입니다.

우편번호
postal_code string

주소의 우편 번호입니다.

교외
suburb string

주소의 교외(도시 필드와 함께 사용하지 마세요).

county string

주소의 카운티입니다.

서식이 지정된 주소
formatted_address string

구성된 국가 형식의 서식이 지정된 주소입니다.

정보 원본
information_source string

주소의 정보 원본입니다.

지역
region string

주소의 지역입니다.

카트
cart string

주소에 대한 CART(이동 통신 사업자 경로)입니다.

많이
lot string

주소의 이동 줄(LOT)입니다.

DPC
dpc string

주소의 DPC(배달 지점 코드)입니다.

다음에서 유효합니다.
start date-time

구성 요소가 이 주소에 거주하기 시작한 날짜입니다.

유효한 경우
end date-time

구성 요소가 이 주소에 거주하지 않게 된 날짜입니다.

본래의?
preferred boolean

이 주소가 구성 요소의 기본 주소인가요?

게으른?
inactive boolean

주소가 비활성 상태인가요(즉, 현재 날짜가 종료 날짜 이전임)?

메일을 사용하지 않나요?
do_not_mail boolean

이 주소에서 구성 요소에 연락할 수 있나요?

seasonal_start.d integer

유사 날짜의 날짜입니다.

개월
seasonal_start.m integer

유사 항목 날짜의 월입니다.

seasonal_start.y integer

유사 날짜의 연도입니다.

seasonal_end.d integer

유사 날짜의 날짜입니다.

개월
seasonal_end.m integer

유사 항목 날짜의 월입니다.

seasonal_end.y integer

유사 날짜의 연도입니다.

추가된 날짜
date_added date-time

주소를 만든 날짜입니다.

수정된 날짜
date_modified date-time

주소가 마지막으로 수정된 날짜입니다.

ConstituentApi.AliasRead

Alias

Name 경로 형식 Description
아이디
id string

별칭의 시스템 레코드 ID입니다.

Alias
name string

구성 요소의 별칭으로 사용할 이름입니다.

유형
type string

별칭 형식입니다.

ConstituentApi.ApiCollectionOfAddressRead

Addresses

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of ConstituentApi.AddressRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

ConstituentApi.ApiCollectionOfActionAttachmentRead

Attachments

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of ConstituentApi.ActionAttachmentRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

ConstituentApi.ApiCollectionOfActionCustomFieldRead

사용자 지정 필드

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of ConstituentApi.ActionCustomFieldRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

ConstituentApi.ApiCollectionOfActionRead

활동

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of ConstituentApi.ActionRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

ConstituentApi.ApiCollectionOfAliasRead

Aliases

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of ConstituentApi.AliasRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

ConstituentApi.ApiCollectionOfConstituentAttachmentRead

Attachments

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of ConstituentApi.ConstituentAttachmentRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

ConstituentApi.ApiCollectionOfConstituentCodeRead

구성 요소 코드

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of ConstituentApi.ConstituentCodeRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

사용자 지정 필드

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of ConstituentApi.ConstituentCustomFieldRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

ConstituentApi.ApiCollectionOfConstituentRead

성분

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of ConstituentApi.ConstituentRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

ConstituentApi.ApiCollectionOfEducationRead

교육

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of ConstituentApi.EducationRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

ConstituentApi.ApiCollectionOfEmailAddressRead

이메일 주소

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of ConstituentApi.EmailAddressRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

기금 모금 과제

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of ConstituentApi.FundraiserAssignmentRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

ConstituentApi.ApiCollectionOfNoteRead

비고

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of ConstituentApi.NoteRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

ConstituentApi.ApiCollectionOfOnlinePresenceRead

온라인 상태

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of ConstituentApi.OnlinePresenceRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

ConstituentApi.ApiCollectionOfPhoneRead

전화

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of ConstituentApi.PhoneRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

ConstituentApi.ApiCollectionOfRatingRead

등급

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of ConstituentApi.RatingRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

ConstituentApi.ApiCollectionOfRelationshipRead

관계

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of ConstituentApi.RelationshipRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

ConstituentApi.ApiCollectionOfSearchResultRead

검색 결과

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of ConstituentApi.SearchResultRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

ConstituentApi.AppealRead

Name 경로 형식 Description
아이디
id string

항소의 시스템 레코드 ID입니다.

description
description string

항소 설명입니다.

ConstituentApi.CampaignRead

Name 경로 형식 Description
아이디
id string

캠페인의 시스템 레코드 ID입니다.

description
description string

캠페인 설명입니다.

ConstituentApi.ConstituentAttachmentRead

첨부 파일

Name 경로 형식 Description
아이디
id string

첨부 파일의 시스템 레코드 ID입니다.

구성 요소 ID
parent_id string

첨부 파일과 연결된 구성 요소의 시스템 레코드 ID입니다.

유형
type string

첨부 파일 형식입니다. 실제 첨부 파일은 로컬 또는 네트워크에 저장된 이미지, PDF 또는 Word 문서와 같은 업로드된 파일입니다. 시스템에 저장되고 관리됩니다. 링크 첨부 파일은 온라인 또는 클라우드 스토리지 계정에 있는 이미지, 블로그 게시물 또는 YouTube 비디오와 같은 파일에 대한 링크입니다. 외부에 저장되고 관리됩니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜입니다.

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

파일 이름
file_name string

파일 이름입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

파일 ID
file_id string

파일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 ID
thumbnail_id string

썸네일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 URL
thumbnail_url string

썸네일의 URL입니다. 이미지만 있는 실제 첨부 파일의 경우 액세스를 60분으로 제한하는 시간 제한 서명을 포함합니다.

콘텐츠 형식
content_type string

콘텐츠 형식입니다. 실제 첨부 파일의 경우에만 해당합니다.

파일 크기
file_size integer

파일 크기(바이트)입니다. 실제 첨부 파일의 경우에만 해당합니다.

ConstituentApi.ConstituentCodeRead

구성 코드

Name 경로 형식 Description
아이디
id string

구성 코드의 시스템 레코드 ID입니다.

구성 요소 ID
constituent_id string

구성 요소 코드와 연결된 구성 요소의 시스템 레코드 ID입니다.

구성 코드
description string

구성 요소 코드입니다.

start.d integer

유사 날짜의 날짜입니다.

개월
start.m integer

유사 항목 날짜의 월입니다.

start.y integer

유사 날짜의 연도입니다.

end.d integer

유사 날짜의 날짜입니다.

개월
end.m integer

유사 항목 날짜의 월입니다.

end.y integer

유사 날짜의 연도입니다.

게으른?
inactive boolean

구성 코드가 비활성 상태인가요?

순서
sequence integer

구성 요소 코드와 연결된 숫자 시퀀스입니다.

추가된 날짜
date_added date-time

구성 코드가 만들어진 날짜입니다.

수정된 날짜
date_modified date-time

구성 코드가 마지막으로 수정된 날짜입니다.

ConstituentApi.ConstituentCustomFieldRead

사용자 지정 필드

Name 경로 형식 Description
아이디
id string

사용자 지정 필드의 시스템 레코드 ID입니다.

구성 요소 ID
parent_id string

사용자 지정 필드와 연결된 구성 요소의 시스템 레코드 ID입니다.

카테고리
category string

사용자 지정 필드 범주입니다.

유형
type string

사용자 지정 필드가 나타내는 데이터의 형식입니다.

가치
value

사용자 지정 필드의 값입니다.

날짜
date date

사용자 지정 필드의 날짜입니다.

주석
comment string

사용자 지정 필드에 대한 주석입니다. 문자 제한: 50.

추가된 날짜
date_added date-time

사용자 지정 필드를 만든 날짜입니다.

수정된 날짜
date_modified date-time

사용자 지정 필드가 마지막으로 수정된 날짜입니다.

ConstituentApi.ConstituentRead

성분

Name 경로 형식 Description
아이디
id string

구성 요소의 시스템 레코드 ID입니다. 이는 lookup_id 저장된 사용자 정의 구성 요소 식별자와 동일하지 않습니다.

유형
type string

구성 요소의 형식입니다.

제목
title string

구성 요소의 기본 제목입니다(개인만 해당).

이름 (이름의 첫 부분)
first string

구성 요소의 이름입니다(개인만 해당).

성(姓)
last string

구성 요소의 성(개인만 해당)입니다.

이름
name string

개인의 경우 이 필드는 대상 조직의 표시 이름 설정에 따라 구성 요소의 전체 이름입니다. 조직의 경우 조직의 이름입니다.

기본 설정 이름
preferred_name string

구성 요소의 기본 설정 이름입니다(개인만 해당).

접미사
suffix string

구성 요소의 기본 접미사입니다(개인만 해당).

조회 ID
lookup_id string

구성 요소에 대한 사용자 정의 식별자입니다.

아이디
email.id string

전자 메일 주소의 시스템 레코드 ID입니다.

type
email.type string

전자 메일 주소의 유형입니다.

address
email.address string

전자 메일 주소입니다.

전자 메일을 보내지 않나요?
email.do_not_email boolean

이 전자 메일 주소에서 구성 요소에 연락할 수 있나요?

게으른?
email.inactive boolean

이 전자 메일 주소가 비활성 상태인가요?

추가된 날짜
email.date_added date-time

전자 메일 주소를 만든 날짜입니다.

수정된 날짜
email.date_modified date-time

전자 메일 주소를 마지막으로 수정한 날짜입니다.

아이디
phone.id string

휴대폰의 시스템 레코드 ID입니다.

type
phone.type string

전화 유형입니다.

숫자
phone.number string

전화 번호입니다.

호출하지 않나요?
phone.do_not_call boolean

이 번호로 구성 요소에 연락할 수 있나요?

게으른?
phone.inactive boolean

이 전화 번호가 비활성 상태인가요?

추가된 날짜
phone.date_added date-time

휴대폰을 만든 날짜입니다.

수정된 날짜
phone.date_modified date-time

휴대폰이 마지막으로 수정된 날짜입니다.

아이디
online_presence.id string

온라인 상태의 시스템 레코드 ID입니다.

type
online_presence.type string

온라인 현재 상태 유형입니다.

link
online_presence.address string

온라인 상태의 웹 주소입니다.

게으른?
online_presence.inactive boolean

이 온라인 프레즌스는 비활성 상태인가요?

추가된 날짜
online_presence.date_added date-time

온라인 상태가 만들어진 날짜입니다.

수정된 날짜
online_presence.date_modified date-time

온라인 상태가 마지막으로 수정된 날짜입니다.

아이디
address.id string

주소의 시스템 레코드 ID입니다.

type
address.type string

주소 유형입니다.

country
address.country string

주소의 국가(ID, 이름 또는 약어일 수 있습니다).

라인
address.address_lines string

주소 줄입니다.

city
address.city string

주소의 도시입니다(교외 필드와 함께 사용하지 마세요).

address.state string

주소의 상태입니다.

우편번호
address.postal_code string

주소의 우편 번호입니다.

교외
address.suburb string

주소의 교외(도시 필드와 함께 사용하지 마세요).

address.county string

주소의 카운티입니다.

포맷
address.formatted_address string

구성된 국가 형식의 서식이 지정된 주소입니다.

유효한
address.start date-time

구성 요소가 이 주소에 거주하기 시작한 날짜입니다.

유효한 경우
address.end date-time

구성 요소가 이 주소에 거주하지 않게 된 날짜입니다.

게으른?
address.inactive boolean

주소가 비활성 상태인가요(즉, 현재 날짜가 종료 날짜 이전임)?

메일을 사용하지 않나요?
address.do_not_mail boolean

이 주소에서 구성 요소에 연락할 수 있나요?

address.seasonal_start.d integer

유사 날짜의 날짜입니다.

개월
address.seasonal_start.m integer

유사 항목 날짜의 월입니다.

address.seasonal_start.y integer

유사 날짜의 연도입니다.

address.seasonal_end.d integer

유사 날짜의 날짜입니다.

개월
address.seasonal_end.m integer

유사 항목 날짜의 월입니다.

address.seasonal_end.y integer

유사 날짜의 연도입니다.

추가된 날짜
address.date_added date-time

주소를 만든 날짜입니다.

수정된 날짜
address.date_modified date-time

주소가 마지막으로 수정된 날짜입니다.

성별
gender string

구성 요소의 성별(개인만 해당).

중간 이름
middle string

구성 요소의 중간 이름입니다(개인만 해당).

이전 이름
former_name string

구성 요소의 이전 이름입니다(개인만 해당).

제목 2
title_2 string

구성 요소의 보조 제목입니다(개인만 해당).

접미사 2
suffix_2 string

구성 요소의 보조 접미사입니다(개인만 해당).

부부 부실
marital_status string

구성 요소의 결혼 상태(개인만 해당).

익명으로 제공?
gives_anonymously boolean

구성 요소는 익명으로 제공합니까?

게으른?
inactive boolean

구성 요소가 비활성 상태인가요?

birthdate.d integer

유사 날짜의 날짜입니다.

개월
birthdate.m integer

유사 항목 날짜의 월입니다.

birthdate.y integer

유사 날짜의 연도입니다.

출생지
birthplace string

구성 요소의 발상지입니다(개인만 해당).

민족성
ethnicity string

구성 요소의 민족성(개인만 해당).

소득
income string

구성 요소의 소득입니다(개인만 해당).

종교
religion string

구성 요소의 종교(개인만 해당).

산업
industry string

구성 요소의 산업(조직에만 해당).

직원 수
num_employees integer

조직의 직원 수입니다.

선물과 일치하시겠습니까?
matches_gifts boolean

조직이 선물과 일치하나요?

일치하는 기프트 팩터
matching_gift_factor double

일치하는 기프트 팩터(조직에만 해당)입니다.

선물당 최소 일치
matching_gift_per_gift_min.value double

구성 요소에 대한 선물당 최소 일치 금액입니다(조직에만 해당).

선물당 최대 일치 항목
matching_gift_per_gift_max.value double

구성 요소에 대한 선물당 최대 일치 금액입니다(조직에만 해당).

constit당 최소 일치 항목
matching_gift_total_min.value double

구성 요소의 최소 일치 합계입니다(조직에만 해당).

constit당 최대 일치 항목
matching_gift_total_max.value double

구성 요소의 최대 일치 합계입니다(조직에만 해당).

일치하는 기프트 노트
matching_gift_notes string

구성 요소에 대한 일치하는 기프트 노트입니다(조직에만 해당).

나이
age integer

생년월일 속성을 기반으로 계산된 구성 요소의 나이입니다(개인만 해당).

고?
deceased boolean

구성 요소가 사망합니까 (개인만 해당)?

deceased_date.d integer

유사 날짜의 날짜입니다.

개월
deceased_date.m integer

유사 항목 날짜의 월입니다.

deceased_date.y integer

유사 날짜의 연도입니다.

모금 행사 상태
fundraiser_status string

구성 요소가 기금 모금 행사인지 여부를 나타냅니다(개인만 해당).

아이디
spouse.id string

배우자의 시스템 레코드 ID입니다.

이름
spouse.first string

배우자의 이름입니다.

spouse.last string

배우자의 성입니다.

가정의 머리인가요?
spouse.is_head_of_household boolean

배우자가 가정의 머리인가요?

추가된 날짜
date_added date-time

구성 요소가 만들어진 날짜입니다.

수정된 날짜
date_modified date-time

구성 요소가 마지막으로 수정된 날짜입니다.

ConstituentApi.CreatedAction

만든 작업

Name 경로 형식 Description
아이디
id string

새로 만든 작업의 ID입니다.

ConstituentApi.CreatedActionAttachment

작업 첨부 파일 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 작업 첨부 파일의 ID입니다.

ConstituentApi.CreatedActionCustomField

만든 작업 사용자 정의 필드

Name 경로 형식 Description
아이디
id string

새로 만든 작업 사용자 정의 필드의 ID입니다.

ConstituentApi.CreatedConstituentAddress

만든 구성 요소 주소

Name 경로 형식 Description
아이디
id string

새로 만든 구성 요소 주소의 ID입니다.

ConstituentApi.CreatedConstituentAlias

만든 구성 별칭

Name 경로 형식 Description
아이디
id string

새로 만든 구성 별칭의 ID입니다.

ConstituentApi.CreatedConstituentAttachment

구성 요소 첨부 파일 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 구성 요소 첨부 파일의 ID입니다.

ConstituentApi.CreatedConstituentCode

구성 요소 코드 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 구성 요소 코드의 ID입니다.

ConstituentApi.CreatedConstituentCustomField

만든 구성 요소 사용자 정의 필드

Name 경로 형식 Description
아이디
id string

새로 만든 구성 요소 사용자 정의 필드의 ID입니다.

ConstituentApi.CreatedConstituentEducation

구성 교육 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 구성 교육의 ID입니다.

ConstituentApi.CreatedConstituentEmailAddress

만든 구성 전자 메일 주소

Name 경로 형식 Description
아이디
id string

새로 만든 구성 전자 메일 주소의 ID입니다.

ConstituentApi.CreatedConstituentNote

만든 구성 요소 노트

Name 경로 형식 Description
아이디
id string

새로 만든 구성 요소 노트의 ID입니다.

ConstituentApi.CreatedConstituentOnlinePresence

구성 요소 온라인 프레즌스 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 구성 요소 온라인 현재 상태의 ID입니다.

ConstituentApi.CreatedConstituentPhone

만든 구성 전화

Name 경로 형식 Description
아이디
id string

새로 만든 구성 전화의 ID입니다.

ConstituentApi.CreatedConstituentRating

구성 요소 등급 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 구성 등급의 ID입니다.

ConstituentApi.CreatedIndividualConstituent

개별 구성 요소 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 개별 구성 요소의 ID입니다.

ConstituentApi.CreatedIndividualRelationship

개별 관계 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 개별 관계의 ID입니다.

ConstituentApi.CreatedOrganizationConstituent

조직 구성 요소 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 조직 구성 요소의 ID입니다.

ConstituentApi.CreatedOrganizationRelationship

조직 관계 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 조직 관계의 ID입니다.

ConstituentApi.EducationRead

Education

Name 경로 형식 Description
아이디
id string

교육의 시스템 레코드 ID입니다.

구성 요소 ID
constituent_id string

교육과 관련된 구성 요소의 시스템 레코드 ID입니다.

학교
school string

학교/설립 이름입니다.

유형
type string

교육 유형입니다.

의 클래스
class_of string

구성 요소가 졸업한 해입니다.

상태
status string

교육의 상태입니다.

date_entered.d integer

유사 날짜의 날짜입니다.

개월
date_entered.m integer

유사 항목 날짜의 월입니다.

date_entered.y integer

유사 날짜의 연도입니다.

date_left.d integer

유사 날짜의 날짜입니다.

개월
date_left.m integer

유사 항목 날짜의 월입니다.

date_left.y integer

유사 날짜의 연도입니다.

date_graduated.d integer

유사 날짜의 날짜입니다.

개월
date_graduated.m integer

유사 항목 날짜의 월입니다.

date_graduated.y integer

유사 날짜의 연도입니다.

정도
degree string

받은 학위입니다.

GPA
gpa double

성적 포인트 평균입니다.

전공
majors array of string

연구의 주요 과정.

미성년자
minors array of string

연구의 사소한 과정.

초등 교육인가요?
primary boolean

이것이 선거구의 초등학교 협회인가요?

Campus
campus string

캠퍼스.

소셜 조직
social_organization string

사회 조직.

알려진 이름
known_name string

알려진 이름입니다.

학위의 클래스
class_of_degree string

학위의 클래스입니다.

부서
department string

교육 부서의 이름입니다.

학부
faculty string

교직원의 이름입니다.

등록 번호
registration_number string

등록 번호입니다.

연구 대상
subject_of_study string

연구의 주제입니다.

추가된 날짜
date_added date-time

교육이 만들어진 날짜입니다.

수정된 날짜
date_modified date-time

교육이 마지막으로 수정된 날짜입니다.

ConstituentApi.EmailAddressRead

전자 메일 주소

Name 경로 형식 Description
아이디
id string

전자 메일 주소의 시스템 레코드 ID입니다.

구성 요소 ID
constituent_id string

전자 메일 주소와 연결된 구성 요소의 시스템 레코드 ID입니다.

전자 메일 유형
type string

전자 메일 주소의 유형입니다.

전자 메일 주소
address string

전자 메일 주소입니다.

본래의?
primary boolean

이 주소가 구성 요소의 기본 이메일 주소인가요?

전자 메일을 보내지 않나요?
do_not_email boolean

이 전자 메일 주소에서 구성 요소에 연락할 수 있나요?

게으른?
inactive boolean

이 전자 메일 주소가 비활성 상태인가요?

추가된 날짜
date_added date-time

전자 메일 주소를 만든 날짜입니다.

수정된 날짜
date_modified date-time

전자 메일 주소를 마지막으로 수정한 날짜입니다.

ConstituentApi.FileDefinition

파일 정의

Name 경로 형식 Description
파일 ID
file_id string

파일의 식별자입니다.

URL
file_upload_request.url string

업로드 요청에 사용할 URL입니다.

method
file_upload_request.method string

업로드 요청과 함께 사용할 HTTP 메서드입니다.

headers
file_upload_request.headers array of ConstituentApi.Header

요청을 만들 때 제공할 헤더입니다.

썸네일 ID
thumbnail_id string

썸네일의 식별자입니다.

URL
thumbnail_upload_request.url string

업로드 요청에 사용할 URL입니다.

method
thumbnail_upload_request.method string

업로드 요청과 함께 사용할 HTTP 메서드입니다.

headers
thumbnail_upload_request.headers array of ConstituentApi.Header

요청을 만들 때 제공할 헤더입니다.

ConstituentApi.FundraiserAssignmentRead

모금 행사 할당

Name 경로 형식 Description
아이디
id string

모금 행사 할당의 시스템 레코드 ID입니다.

구성 요소 ID
constituent_id string

모금 행사에 할당된 구성 요소의 시스템 레코드 ID입니다.

모금 행사 ID
fundraiser_id string

모금 행사의 시스템 레코드 ID입니다.

유형
type string

모금 행사의 유형입니다.

value
amount.value double

통화 값입니다.

캠페인 ID
campaign_id string

결과 선물을 적용할 캠페인의 시스템 레코드 ID입니다.

펀드 ID
fund_id string

모든 결과 선물을 적용해야 하는 펀드의 시스템 레코드 ID입니다. 제한된 기금이 선택되면 해당 기금과 관련된 캠페인 및 이의 제기만 선택할 수 있습니다.

항소 ID
appeal_id string

기금 모금이 선물을 요청하는 데 사용해야 하는 항소의 시스템 레코드 ID입니다.

시작 날짜
start date-time

모금 행사 배정 시작 날짜입니다.

끝 날짜
end date-time

모금 행사 배정 종료 날짜입니다.

ConstituentApi.FundRead

Name 경로 형식 Description
아이디
id string

펀드의 시스템 레코드 ID입니다.

description
description string

펀드 설명입니다.

ConstituentApi.GivingSummaryRead

요약 제공

Name 경로 형식 Description
아이디
id string

선물의 시스템 레코드 ID입니다.

유형
type string

선물 종류입니다.

날짜
date date-time

선물 날짜입니다.

value
amount.value double

통화 값입니다.

Appeal
appeals array of ConstituentApi.AppealRead

선물과 관련된 항소 세트입니다.

캠페인
campaigns array of ConstituentApi.CampaignRead

선물과 관련된 캠페인 세트입니다.

기금
funds array of ConstituentApi.FundRead

선물과 관련된 자금 세트입니다.

ConstituentApi.Header

실제 첨부 파일을 업로드하는 데 사용되는 요청 헤더입니다.

Name 경로 형식 Description
이름
name string

헤더의 이름입니다.

value
value string

헤더의 값입니다.

ConstituentApi.LifetimeGivingRead

평생 기부

Name 경로 형식 Description
지정된 연속 연도
consecutive_years_given integer

구성 요소가 준 연속 연도의 수입니다.

지정된 총 연도
total_years_given integer

구성 요소가 준 총 연도 수입니다.

value
total_giving.value double

통화 값입니다.

value
total_pledge_balance.value double

통화 값입니다.

value
total_received_giving.value double

통화 값입니다.

value
total_committed_matching_gifts.value double

통화 값입니다.

value
total_received_matching_gifts.value double

통화 값입니다.

value
total_soft_credits.value double

통화 값입니다.

ConstituentApi.NoteRead

비고

Name 경로 형식 Description
아이디
id string

메모의 시스템 레코드 ID입니다.

구성 요소 ID
constituent_id string

메모와 연결된 구성 요소의 시스템 레코드 ID입니다.

유형
type string

메모 유형입니다.

date.d integer

유사 날짜의 날짜입니다.

개월
date.m integer

유사 항목 날짜의 월입니다.

date.y integer

유사 날짜의 연도입니다.

요약
summary string

메모 요약입니다.

비고
text string

메모 텍스트입니다.

추가된 날짜
date_added date-time

메모를 만든 날짜입니다.

수정된 날짜
date_modified date-time

메모가 마지막으로 수정된 날짜입니다.

ConstituentApi.OnlinePresenceRead

온라인 상태

Name 경로 형식 Description
아이디
id string

온라인 상태의 시스템 레코드 ID입니다.

구성 요소 ID
constituent_id string

온라인 상태와 연결된 구성 요소의 시스템 레코드 ID입니다.

유형
type string

온라인 현재 상태 유형입니다.

Link
address string

온라인 상태의 웹 주소입니다.

본래의?
primary boolean

이것은 구성 요소의 주요 온라인 존재인가요?

게으른?
inactive boolean

이 온라인 프레즌스는 비활성 상태인가요?

추가된 날짜
date_added date-time

온라인 상태가 만들어진 날짜입니다.

수정된 날짜
date_modified date-time

온라인 상태가 마지막으로 수정된 날짜입니다.

ConstituentApi.PhoneRead

Phone

Name 경로 형식 Description
아이디
id string

휴대폰의 시스템 레코드 ID입니다.

구성 요소 ID
constituent_id string

휴대폰과 연결된 구성 요소의 시스템 레코드 ID입니다.

유형
type string

전화 유형입니다.

Number
number string

전화 번호입니다.

본래의?
primary boolean

이것은 구성 요소의 기본 전화인가요?

호출하지 않나요?
do_not_call boolean

이 번호로 구성 요소에 연락할 수 있나요?

게으른?
inactive boolean

이 전화 번호가 비활성 상태인가요?

추가된 날짜
date_added date-time

휴대폰을 만든 날짜입니다.

수정된 날짜
date_modified date-time

휴대폰이 마지막으로 수정된 날짜입니다.

ConstituentApi.ProfilePictureRead

프로필 사진

Name 경로 형식 Description
구성 요소 ID
constituent_id string

프로필 사진과 연결된 구성 요소의 시스템 레코드 ID입니다.

URL
url string

프로필 사진의 URL입니다. URL에는 액세스를 60분으로 제한하는 시간 제한 서명이 포함되어 있습니다.

썸네일 URL
thumbnail_url string

프로필 사진의 썸네일 URL입니다. 액세스를 60분으로 제한하는 시간 제한 서명을 포함합니다.

ConstituentApi.ProspectStatusRead

전망 상태

Name 경로 형식 Description
상태
status string

구성 요소의 현재 전망 상태입니다.

경과된 일 수
days_elapsed integer

시작 날짜를 기준으로 현재 전망 상태의 총 일 수입니다.

시작 날짜
start date-time

잠재 고객 상태의 시작 날짜입니다.

코멘트
comments string

전망 상태에 대한 의견입니다.

ConstituentApi.RatingRead

Rating

Name 경로 형식 Description
아이디
id string

등급의 시스템 레코드 ID입니다.

구성 요소 ID
constituent_id string

등급과 연결된 구성 요소의 시스템 레코드 ID입니다.

출처
source string

새 등급의 원본입니다.

카테고리
category string

등급의 범주입니다.

날짜
date date-time

등급의 날짜입니다.

Description
value

등급의 값입니다.

코멘트
comment string

등급에 대한 의견입니다.

게으른?
inactive boolean

등급이 비활성 상태인가요?

유형
type string

이 계산 필드는 등급이 범주 속성을 기반으로 나타내는 데이터 형식을 나타냅니다.

ConstituentApi.RelationshipRead

관계

Name 경로 형식 Description
아이디
id string

관계의 시스템 레코드 ID입니다.

구성 요소 ID
constituent_id string

관계와 연결된 구성 요소의 시스템 레코드 ID입니다.

관계 ID
relation_id string

관련 개인 또는 조직의 시스템 레코드 ID입니다.

상호 관계 ID
reciprocal_relationship_id string

상호 관계 레코드의 식별자입니다. 이 값은 읽기 전용이며 관계가 만들어지면 자동으로 생성됩니다. 이 레코드의 변경 내용도 주석 속성을 제외하고 상호에 반영됩니다.

이름
name string

관련 구성 요소의 이름입니다. 관련 구성 요소가 개인인 경우 대상 조직의 표시 이름 설정에 따라 구성 요소의 전체 이름이 됩니다.

유형
type string

관계가 나타내는 관계의 형식입니다.

상호 형식
reciprocal_type string

관련 구성 요소와 구성 요소의 관계를 설명합니다. 예를 들어, 남성 구성 요소와 여성 형제 간의 관계에서 상호 관계 유형은 형제가 됩니다.

start.d integer

유사 날짜의 날짜입니다.

개월
start.m integer

유사 항목 날짜의 월입니다.

start.y integer

유사 날짜의 연도입니다.

end.d integer

유사 날짜의 날짜입니다.

개월
end.m integer

유사 항목 날짜의 월입니다.

end.y integer

유사 날짜의 연도입니다.

배우자인가요?
is_spouse boolean

관련 개인이 구성 요소의 배우자인가요(개인 간의 관계에만 적용됨)?

가구의 구성 머리인가요?
is_constituent_head_of_household boolean

구성 요소는 가정의 머리인가?

배우자는 가정의 머리인가요?
is_spouse_head_of_household boolean

배우자가 가정의 머리인가요?

비고
comment string

관계에 대한 주석입니다.

연락처인가요?
is_organization_contact boolean

구성 요소가 이 조직을 연락처로 나타내나요(조직과 개인 간의 관계에만 적용됨)?

기본 비즈니스인가요?
is_primary_business boolean

구성 요소의 기본 비즈니스인가요(조직과 개인 간의 관계에만 적용됨)?

연락처 유형
organization_contact_type string

조직을 연락처로 나타내는 관련 개인과의 상호 작용에 대한 컨텍스트를 제공합니다. 조직과 개인 간의 관계에만 적용됩니다.

Position
position string

조직에서 개인의 위치입니다. 조직과 개인 간의 관계에만 적용됩니다.

추가된 날짜
date_added date-time

관계가 만들어진 날짜입니다.

수정된 날짜
date_modified date-time

관계가 마지막으로 수정된 날짜입니다.

ConstituentApi.SearchResultRead

검색 결과

Name 경로 형식 Description
아이디
id string

구성 요소의 시스템 레코드 ID입니다.

이름
name string

구성 요소 이름입니다. 개인의 경우 이 계산 필드는 대상 조직의 표시 이름 설정에 따라 구성 요소의 전체 이름을 나타냅니다.

Address
address string

구성 요소의 기본 주소입니다.

고?
deceased boolean

성분이 죽었습니까?

전자 메일
email string

구성 요소의 이메일 주소입니다.

모금 행사 상태
fundraiser_status string

구성 요소의 기금 모금 상태입니다. 개인의 경우 이 계산 필드는 구성 요소가 활성, 비활성 또는 없음인지 여부를 나타냅니다. 조직의 경우 이 값은 항상 None입니다.

게으른?
inactive boolean

구성 요소가 비활성 상태인가요?

조회 ID
lookup_id string

구성 요소에 대한 사용자 정의 식별자입니다.

EventApi.AdministrativeArea

주소의 관리 영역에 사용되는 데이터 모델을 정의합니다(예: 미국의 상태).

Name 경로 형식 Description
아이디
id string

관리 영역의 레코드 ID입니다.

이름
name string

관리 영역의 이름입니다.

간단한 설명
short_description string

관리 영역에 대한 간단한 설명입니다.

EventApi.ApiCollectionOfEventFee

요금

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of EventApi.EventFee

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

EventApi.ApiCollectionOfEventListEntry

Events

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of EventApi.EventListEntry

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

EventApi.ApiCollectionOfEventParticipantOption

이벤트 참가자 옵션

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of EventApi.EventParticipantOption

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

EventApi.ApiCollectionOfParticipantDonation

기부금

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of EventApi.ParticipantDonation

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

EventApi.ApiCollectionOfParticipantFee

요금

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of EventApi.ParticipantFee

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

EventApi.ApiCollectionOfParticipantFeePayment

수수료 지불

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of EventApi.ParticipantFeePayment

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

EventApi.ApiCollectionOfParticipantListEntry

Participants

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of EventApi.ParticipantListEntry

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

EventApi.ApiCollectionOfParticipantOption

참가자 옵션

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of EventApi.ParticipantOption

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

EventApi.Country

주소의 국가에 사용되는 데이터 모델을 정의합니다.

Name 경로 형식 Description
아이디
id string

국가 레코드의 ID입니다.

display name(표시 이름)
display_name string

국가의 표시 이름입니다.

ISO 코드
iso_alpha2_code string

국가에 대한 ISO 3166-1 alpha-2 코드입니다.

EventApi.CreatedEvent

만든 이벤트

Name 경로 형식 Description
아이디
id string

새로 만든 이벤트의 ID입니다.

EventApi.CreatedEventFee

이벤트 요금 생성

Name 경로 형식 Description
아이디
id string

새로 만든 이벤트 요금의 ID입니다.

EventApi.CreatedEventParticipantOption

이벤트 참가자 옵션 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 이벤트 참가자 옵션의 ID입니다.

EventApi.CreatedParticipant

만든 참가자

Name 경로 형식 Description
아이디
id string

새로 만든 참가자의 ID입니다.

EventApi.CreatedParticipantDonation

참가자 기부 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 참가자 기부의 ID입니다.

EventApi.CreatedParticipantFee

만든 참가자 요금

Name 경로 형식 Description
아이디
id string

새로 만든 참가자 요금의 ID입니다.

EventApi.CreatedParticipantFeePayment

참가자 요금 지불 생성

Name 경로 형식 Description
아이디
id string

새로 만든 참가자 수수료 지불의 ID입니다.

EventApi.CreatedParticipantOption

만든 참가자 옵션

Name 경로 형식 Description
아이디
id string

새로 만든 참가자 옵션의 ID입니다.

EventApi.Event

Event

Name 경로 형식 Description
아이디
id string

이벤트의 시스템 레코드 ID입니다. 이는 lookup_id 저장된 사용자 정의 이벤트 식별자와 동일하지 않습니다.

이름
name string

이벤트의 이름입니다.

Description
description string

이벤트에 대한 설명입니다.

시작 날짜
start_date date

이벤트의 시작 날짜입니다.

시작 시간
start_time string

이벤트의 시작 시간입니다.

끝 날짜
end_date date

이벤트의 종료 날짜입니다.

종료 시간
end_time string

이벤트의 종료 시간입니다.

카테고리
category EventApi.EventCategory

이벤트 범주는 이벤트에 대한 사용자 지정 분류입니다.

조회 ID
lookup_id string

이벤트의 조회 ID입니다.

위치
location EventApi.Location

위치에 사용되는 데이터 모델을 정의합니다.

Capacity
capacity integer

이벤트에 참석할 수 있는 사용자 수입니다.

목표
goal double

이벤트의 금전적 목표입니다.

캠페인 ID
campaign_id string

이벤트와 연결된 캠페인의 시스템 레코드 ID입니다.

펀드 ID
fund_id string

이벤트와 연결된 펀드의 시스템 레코드 ID입니다.

게으른?
inactive boolean

이벤트가 비활성 상태인가요?

추가된 날짜
date_added date-time

이벤트를 만든 날짜입니다.

수정된 날짜
date_modified date-time

이벤트가 마지막으로 수정된 날짜입니다.

EventApi.EventCategory

이벤트 범주는 이벤트에 대한 사용자 지정 분류입니다.

Name 경로 형식 Description
아이디
id string

이벤트 범주의 시스템 레코드 ID입니다.

이름
name string

이벤트 범주의 이름입니다.

게으른?
inactive boolean

이 범주가 비활성 상태인가요?

EventApi.EventFee

이벤트 비용은 개인 또는 조직이 이벤트에 참여하거나 참석하기 위해 조직에서 청구하는 금액입니다.

Name 경로 형식 Description
아이디
id string

이벤트 요금의 시스템 레코드 ID입니다.

이름
name string

이벤트 요금의 이름입니다.

분량
cost double

수수료의 비용입니다.

기여 금액
contribution_amount double

이 수수료에 대한 세금 공제 금액입니다.

판매된 번호
number_sold integer

판매된 수수료 수입니다.

EventApi.EventListEntry

Event

Name 경로 형식 Description
아이디
id string

이벤트의 시스템 레코드 ID입니다.

이름
name string

이벤트의 이름입니다.

시작 날짜
start_date date

이벤트의 시작 날짜입니다.

시작 시간
start_time string

이벤트의 시작 시간입니다.

끝 날짜
end_date date

이벤트의 종료 날짜입니다.

종료 시간
end_time string

이벤트의 종료 시간입니다.

카테고리
category EventApi.EventCategory

이벤트 범주는 이벤트에 대한 사용자 지정 분류입니다.

조회 ID
lookup_id string

이벤트의 조회 ID입니다.

Capacity
capacity integer

이벤트에 참석할 수 있는 사용자 수입니다.

참석
attending_count integer

참석할 이벤트 참가자 수입니다.

유인
attended_count integer

이벤트 참석자 수입니다.

초대
invited_count integer

이벤트 초대자 수입니다.

수익
revenue double

이벤트의 실현 수익입니다.

목표
goal double

이벤트의 금전적 목표입니다.

목표 비율
percent_of_goal integer

목표 수익의 백분율로 실현된 수익입니다.

게으른?
inactive boolean

이벤트가 비활성 상태인가요?

추가된 날짜
date_added date-time

이벤트를 만든 날짜입니다.

수정된 날짜
date_modified date-time

이벤트가 마지막으로 수정된 날짜입니다.

EventApi.EventParticipantOption

이벤트 참가자 옵션은 티셔츠 크기, 식사 기본 설정 또는 좌석 요청과 같은 참가자에 대한 세부 정보를 수집하는 필드입니다. 이벤트에 대한 옵션 및 해당 값을 설정한 다음 각 참가자에 대한 응답을 추가합니다.

Name 경로 형식 Description
아이디
id string

이벤트 참가자 옵션의 시스템 레코드 ID입니다.

이름
name string

이벤트 참가자 옵션의 이름입니다.

입력 형식
input_type string

이벤트 참가자 옵션의 형식입니다.

다중 선택을 허용하시겠습니까?
multi_select boolean

목록에 두 개 이상의 값을 허용하시겠습니까?

list_options
list_options array of EventApi.EventParticipantOptionListOption

사용 가능한 목록 옵션입니다.

사용자에 의해 추가됨
added_by_user string

옵션을 추가한 사용자의 ID입니다.

사용자에 의해 수정됨
updated_by_user string

옵션을 수정한 사용자의 ID입니다.

서비스에 의해 추가됨
added_by_service string

이 옵션을 추가한 서비스의 이름입니다.

서비스에 의해 수정됨
updated_by_service string

이 옵션을 수정한 서비스의 이름입니다.

추가된 날짜
date_added date-time

옵션을 만든 날짜입니다.

수정된 날짜
date_updated date-time

옵션이 마지막으로 수정된 날짜입니다.

version
version integer

옵션의 버전 번호입니다.

EventApi.EventParticipantOptionListOption

이벤트 참가자 옵션 목록 옵션

Name 경로 형식 Description
아이디
id string

목록 옵션의 ID

이름
name string

목록 옵션의 이름

식별
sequence integer

목록 옵션의 순서를 지정하는 데 사용되는 시퀀스입니다.

EventApi.Locality

주소의 지역성에 사용되는 데이터 모델을 정의합니다.

Name 경로 형식 Description
아이디
id string

지역 레코드의 레코드 ID입니다.

이름
name string

지역 이름입니다.

EventApi.Location

위치에 사용되는 데이터 모델을 정의합니다.

Name 경로 형식 Description
이름
name string

위치의 이름입니다.

주소 줄
address_lines string

위치의 주소 줄입니다.

우편번호
postal_code string

위치의 우편 번호입니다.

지역
locality EventApi.Locality

주소의 지역성에 사용되는 데이터 모델을 정의합니다.

관리 영역
administrative_area EventApi.AdministrativeArea

주소의 관리 영역에 사용되는 데이터 모델을 정의합니다(예: 미국의 상태).

하위 관리 영역
sub_administrative_area EventApi.SubAdministrativeArea

주소의 하위 관리 영역(예: 미국의 도시)에 사용되는 데이터 모델을 정의합니다.

country
country EventApi.Country

주소의 국가에 사용되는 데이터 모델을 정의합니다.

서식이 지정된 주소
formatted_address string

위치의 서식이 지정된 주소

EventApi.Membership

참가자의 멤버 자격 정보입니다.

Name 경로 형식 Description
멤버 자격 범주
category EventApi.MembershipCategory

개인의 멤버 자격 범주입니다.

EventApi.MembershipCategory

개인의 멤버 자격 범주입니다.

Name 경로 형식 Description
아이디
id string

멤버 자격 범주의 시스템 레코드 ID입니다.

이름
name string

멤버 자격 범주의 이름입니다.

EventApi.참가자

참가자

Name 경로 형식 Description
아이디
id string

참가자의 시스템 레코드 ID입니다.

구성 요소 ID
constituent_id string

참가자의 구성 ID입니다.

이벤트 ID
event_id string

참석 중인 이벤트의 시스템 레코드 ID입니다.

호스트 ID
host_id string

호스트 참가자 레코드의 ID입니다.

RSVP 상태
rsvp_status string

참가자의 이벤트 참여 상태입니다.

참석?
attended boolean

참가자가 이벤트에 참석했습니까?

초대 상태
invitation_status string

참가자 초대의 상태입니다.

rsvp_date.d integer

유사 날짜의 날짜입니다.

개월
rsvp_date.m integer

유사 항목 날짜의 월입니다.

rsvp_date.y integer

유사 날짜의 연도입니다.

invitation_date.d integer

유사 날짜의 날짜입니다.

개월
invitation_date.m integer

유사 항목 날짜의 월입니다.

invitation_date.y integer

유사 날짜의 연도입니다.

참여 수준
participation_level EventApi.ParticipationLevel

참여 수준은 참가자가 이벤트에 참여하는 수준입니다.

추가된 날짜
date_added date-time

참가자가 만들어진 날짜입니다.

수정된 날짜
date_modified date-time

참가자가 마지막으로 수정된 날짜입니다.

EventApi.ParticipantDonation

참가자 기부에 대한 데이터 모델을 정의합니다.

Name 경로 형식 Description
아이디
id string

참가자 기부의 시스템 레코드 ID입니다.

선물 ID
gift_id string

참가자 기부가 연결된 선물의 시스템 레코드 ID입니다.

EventApi.ParticipantFee

참가자 요금에 대한 데이터 모델을 정의합니다.

Name 경로 형식 Description
아이디
id string

참가자 요금의 ID입니다.

참가자 ID
participant_id string

참가자 요금이 연결된 레코드의 ID입니다.

수량
quantity integer

구매한 수량입니다.

수수료 금액
fee_amount double

참가자 요금의 금액입니다.

기여 금액
tax_receiptable_amount double

이 수수료에 대한 세금 공제 금액입니다.

date.d integer

유사 날짜의 날짜입니다.

개월
date.m integer

유사 항목 날짜의 월입니다.

date.y integer

유사 날짜의 연도입니다.

이벤트 요금
event_fee EventApi.EventFee

이벤트 비용은 개인 또는 조직이 이벤트에 참여하거나 참석하기 위해 조직에서 청구하는 금액입니다.

EventApi.ParticipantFeePayment

참가자 요금 지불에 대한 데이터 모델을 정의합니다.

Name 경로 형식 Description
아이디
id string

참가자 요금 지불의 시스템 레코드 ID입니다.

참가자 ID
participant_id string

참가자 수수료 지불이 연결된 참가자의 시스템 레코드 ID입니다.

선물 ID
gift_id string

참가자 수수료 지불이 연결된 선물의 시스템 레코드 ID입니다.

적용된 금액
applied_amount double

참가자 수수료 지불의 적용된 금액입니다.

EventApi.ParticipantListEntry

참가자

Name 경로 형식 Description
아이디
id string

참가자의 시스템 레코드 ID입니다.

접촉 ID
contact_id string

이벤트에 참석하는 연락처의 ID입니다.

RSVP 상태
rsvp_status string

참가자의 이벤트 참여 상태입니다.

참석?
attended boolean

참가자가 이벤트에 참석했습니까?

초대 상태
invitation_status string

참가자 초대의 상태입니다.

rsvp_date.d integer

유사 날짜의 날짜입니다.

개월
rsvp_date.m integer

유사 항목 날짜의 월입니다.

rsvp_date.y integer

유사 날짜의 연도입니다.

참여 수준
participation_level EventApi.ParticipationLevel

참여 수준은 참가자가 이벤트에 참여하는 수준입니다.

제목
title string

참가자의 제목입니다.

이름 (이름의 첫 부분)
first_name string

참가자의 이름입니다.

성(姓)
last_name string

참가자의 성입니다.

이름
name string

참가자의 전체 이름입니다.

기본 설정 이름
preferred_name string

참가자의 기본 설정 이름입니다.

접미사
suffix string

참가자의 접미사입니다.

조회 ID
lookup_id string

참가자의 LookupId입니다.

전자 메일
email string

참가자의 전자 메일 주소입니다.

전자 메일을 보내지 않나요?
do_not_email boolean

이 전자 메일 주소로 참가자에게 연락할 수 있나요?

Phone
phone string

참가자의 전화 번호입니다.

호출하지 않나요?
do_not_call boolean

이 번호로 참가자에게 연락할 수 있나요?

중간 이름
middle_name string

참가자의 중간 이름입니다.

이전 이름
former_name string

참가자의 이전 이름입니다.

구성 요소인가요?
is_constituent boolean

참가자가 구성 요소인가요?

의 클래스
class_of string

참가자의 졸업 수업입니다.

총 등록 수수료
total_registration_fees double

참가자의 수수료 금액의 합계입니다.

총 지급액
total_paid double

등록 수수료 유형이 포함된 참가자의 유료 선물 합계입니다.

Seat
seat string

참가자의 좌석 배정입니다.

이름 태그
name_tag string

참가자의 이름 태그

추가된 날짜
date_added date-time

참가자가 만들어진 날짜입니다.

수정된 날짜
date_modified date-time

참가자가 마지막으로 수정된 날짜입니다.

연락처 ID
host.contact_id string

이벤트에 참석하는 연락처의 ID입니다.

참가자 ID
host.participant_id string

참가자의 ID입니다.

이름
host.name string

참가자의 전체 이름입니다.

손님
guests array of EventApi.ParticipantListParticipantSummary

참가자의 게스트입니다.

구성원
memberships array of EventApi.Membership

참가자의 멤버 자격 정보입니다.

EventApi.ParticipantListParticipantSummary

참가자의 기본 요약 정보입니다.

Name 경로 형식 Description
연락처 ID
contact_id string

이벤트에 참석하는 연락처의 ID입니다.

참가자 ID
participant_id string

참가자의 ID입니다.

이름
name string

참가자의 전체 이름입니다.

EventApi.ParticipantOption

지정된 참가자와 연결된 참가자 옵션

Name 경로 형식 Description
아이디
id string

참가자 옵션의 시스템 레코드 ID입니다.

참가자 ID
participant_id string

참가자의 시스템 레코드 ID입니다.

이벤트 ID
event_id string

이벤트의 시스템 레코드 ID입니다.

이벤트 참가자 옵션 ID
event_participant_option_id string

이벤트 참가자 옵션의 시스템 레코드 ID입니다.

value
option_value string

옵션에 대한 참가자의 응답입니다.

사용자에 의해 추가됨
added_by_user string

참가자 옵션을 추가한 사용자의 ID입니다.

사용자에 의해 수정됨
updated_by_user string

참가자 옵션을 수정한 사용자의 ID입니다.

서비스에 의해 추가됨
added_by_service string

이 참가자 옵션을 추가한 서비스의 이름입니다.

서비스에 의해 수정됨
updated_by_service string

이 참가자 옵션을 수정한 서비스의 이름입니다.

추가된 날짜
date_added date-time

참가자 옵션이 만들어진 날짜입니다.

수정된 날짜
date_updated date-time

참가자 옵션이 마지막으로 수정된 날짜입니다.

EventApi.ParticipationLevel

참여 수준은 참가자가 이벤트에 참여하는 수준입니다.

Name 경로 형식 Description
아이디
id string

참여 수준의 시스템 레코드 ID입니다.

이름
name string

참가 수준의 이름입니다.

게으른?
is_inactive boolean

참여 수준이 비활성 상태인가요?

EventApi.SubAdministrativeArea

주소의 하위 관리 영역(예: 미국의 도시)에 사용되는 데이터 모델을 정의합니다.

Name 경로 형식 Description
아이디
id string

하위 관리 영역의 ID입니다.

이름
name string

하위 관리 영역의 이름입니다.

FundraisingApi.ApiCollectionOfAppealAttachmentRead

Attachments

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of FundraisingApi.AppealAttachmentRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

FundraisingApi.ApiCollectionOfAppealCustomFieldRead

사용자 지정 필드

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of FundraisingApi.AppealCustomFieldRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

FundraisingApi.ApiCollectionOfAppealRead

이의 제기

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of FundraisingApi.AppealRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

FundraisingApi.ApiCollectionOfCampaignAttachmentRead

Attachments

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of FundraisingApi.CampaignAttachmentRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

FundraisingApi.ApiCollectionOfCampaignCustomFieldRead

사용자 지정 필드

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of FundraisingApi.CampaignCustomFieldRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

FundraisingApi.ApiCollectionOfCampaignRead

캠페인

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of FundraisingApi.CampaignRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

FundraisingApi.ApiCollectionOfFundAttachmentRead

Attachments

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of FundraisingApi.FundAttachmentRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

FundraisingApi.ApiCollectionOfFundCustomFieldRead

사용자 지정 필드

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of FundraisingApi.FundCustomFieldRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

FundraisingApi.ApiCollectionOfFundRead

자금

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of FundraisingApi.FundRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

FundraisingApi.ApiCollectionOfFundraiserAssignmentRead

Assignments

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of FundraisingApi.FundraiserAssignmentRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

FundraisingApi.ApiCollectionOfPackageRead

Packages

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of FundraisingApi.PackageRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

FundraisingApi.AppealAttachmentRead

첨부 파일

Name 경로 형식 Description
아이디
id string

첨부 파일의 시스템 레코드 ID입니다.

항소 ID
parent_id string

첨부 파일과 연결된 항소의 시스템 레코드 ID입니다.

유형
type string

첨부 파일 형식입니다. 실제 첨부 파일은 로컬 또는 네트워크에 저장된 이미지, PDF 또는 Word 문서와 같은 업로드된 파일입니다. 시스템에 저장되고 관리됩니다. 링크 첨부 파일은 온라인 또는 클라우드 스토리지 계정에 있는 이미지, 블로그 게시물 또는 YouTube 비디오와 같은 파일에 대한 링크입니다. 외부에 저장되고 관리됩니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜입니다.

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

파일 이름
file_name string

파일 이름입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

파일 ID
file_id string

파일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 ID
thumbnail_id string

썸네일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 URL
thumbnail_url string

썸네일의 URL입니다. 이미지만 있는 실제 첨부 파일의 경우 액세스를 60분으로 제한하는 시간 제한 서명을 포함합니다.

콘텐츠 형식
content_type string

콘텐츠 형식입니다. 실제 첨부 파일의 경우에만 해당합니다.

파일 크기
file_size integer

파일 크기(바이트)입니다. 실제 첨부 파일의 경우에만 해당합니다.

FundraisingApi.AppealCustomFieldRead

사용자 지정 필드

Name 경로 형식 Description
아이디
id string

사용자 지정 필드의 시스템 레코드 ID입니다.

항소 ID
parent_id string

사용자 지정 필드와 연결된 호소의 시스템 레코드 ID입니다.

카테고리
category string

사용자 지정 필드 범주입니다.

유형
type string

사용자 지정 필드가 나타내는 데이터의 형식입니다.

가치
value

사용자 지정 필드의 값입니다.

날짜
date date

사용자 지정 필드의 날짜입니다.

주석
comment string

사용자 지정 필드에 대한 주석입니다. 문자 제한: 50.

추가된 날짜
date_added date-time

사용자 지정 필드를 만든 날짜입니다.

수정된 날짜
date_modified date-time

사용자 지정 필드가 마지막으로 수정된 날짜입니다.

FundraisingApi.AppealRead

Appeal

Name 경로 형식 Description
아이디
id string

항소의 시스템 레코드 ID입니다.

카테고리
category string

호소의 범주입니다.

추가된 날짜
date_added date-time

항소가 만들어진 날짜입니다.

수정된 날짜
date_modified date-time

항소가 마지막으로 수정된 날짜입니다.

Description
description string

호소의 표시 이름입니다.

끝 날짜
end_date date-time

항소 종료 날짜입니다.

value
goal.value double

통화 값입니다.

게으른?
inactive boolean

항소가 활성화되어 있나요(즉, 현재 날짜는 시작 날짜 이후와 종료 날짜 이전임)?

조회 ID
lookup_id string

항소에 대한 사용자 정의 식별자입니다.

시작 날짜
start_date date-time

항소의 시작 날짜입니다.

FundraisingApi.CampaignAttachmentRead

첨부 파일

Name 경로 형식 Description
아이디
id string

첨부 파일의 시스템 레코드 ID입니다.

캠페인 ID
parent_id string

첨부 파일과 연결된 캠페인의 시스템 레코드 ID입니다.

유형
type string

첨부 파일 형식입니다. 실제 첨부 파일은 로컬 또는 네트워크에 저장된 이미지, PDF 또는 Word 문서와 같은 업로드된 파일입니다. 시스템에 저장되고 관리됩니다. 링크 첨부 파일은 온라인 또는 클라우드 스토리지 계정에 있는 이미지, 블로그 게시물 또는 YouTube 비디오와 같은 파일에 대한 링크입니다. 외부에 저장되고 관리됩니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜입니다.

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

파일 이름
file_name string

파일 이름입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

파일 ID
file_id string

파일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 ID
thumbnail_id string

썸네일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 URL
thumbnail_url string

썸네일의 URL입니다. 이미지만 있는 실제 첨부 파일의 경우 액세스를 60분으로 제한하는 시간 제한 서명을 포함합니다.

콘텐츠 형식
content_type string

콘텐츠 형식입니다. 실제 첨부 파일의 경우에만 해당합니다.

파일 크기
file_size integer

파일 크기(바이트)입니다. 실제 첨부 파일의 경우에만 해당합니다.

FundraisingApi.CampaignCustomFieldRead

사용자 지정 필드

Name 경로 형식 Description
아이디
id string

사용자 지정 필드의 시스템 레코드 ID입니다.

캠페인 ID
parent_id string

사용자 지정 필드와 연결된 캠페인의 시스템 레코드 ID입니다.

카테고리
category string

사용자 지정 필드 범주입니다.

유형
type string

사용자 지정 필드가 나타내는 데이터의 형식입니다.

가치
value

사용자 지정 필드의 값입니다.

날짜
date date

사용자 지정 필드의 날짜입니다.

주석
comment string

사용자 지정 필드에 대한 주석입니다. 문자 제한: 50.

추가된 날짜
date_added date-time

사용자 지정 필드를 만든 날짜입니다.

수정된 날짜
date_modified date-time

사용자 지정 필드가 마지막으로 수정된 날짜입니다.

FundraisingApi.CampaignRead

캠페인

Name 경로 형식 Description
아이디
id string

캠페인의 시스템 레코드 ID입니다.

카테고리
category string

캠페인의 범주입니다.

추가된 날짜
date_added date-time

캠페인을 만든 날짜입니다.

수정된 날짜
date_modified date-time

캠페인이 마지막으로 수정된 날짜입니다.

Description
description string

캠페인의 표시 이름입니다.

끝 날짜
end_date date-time

캠페인의 종료 날짜입니다.

value
goal.value double

통화 값입니다.

게으른?
inactive boolean

캠페인이 비활성 상태인가요(즉, 현재 날짜는 시작 날짜 이후와 종료 날짜 이전임)?

조회 ID
lookup_id string

캠페인에 대한 사용자 정의 식별자입니다.

시작 날짜
start_date date-time

캠페인의 시작 날짜입니다.

FundraisingApi.CreatedAppealAttachment

어필 첨부 파일 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 항소 첨부 파일의 ID입니다.

FundraisingApi.CreatedAppealCustomField

어필 사용자 정의 필드 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 어필 사용자 정의 필드의 ID입니다.

FundraisingApi.CreatedCampaignAttachment

캠페인 첨부 파일 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 캠페인 첨부 파일의 ID입니다.

FundraisingApi.CreatedCampaignCustomField

캠페인 사용자 정의 필드 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 캠페인 사용자 정의 필드의 ID입니다.

FundraisingApi.CreatedFundraiserAssignment

모금 행사 할당 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 모금 행사 할당의 ID입니다.

FundraisingApi.CreatedFundAttachment

기금 첨부 파일 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 펀드 첨부 파일의 ID입니다.

FundraisingApi.CreatedFundCustomField

펀드 사용자 정의 필드 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 펀드 사용자 정의 필드의 ID입니다.

FundraisingApi.FundraiserAssignmentRead

Assignment

Name 경로 형식 Description
아이디
id string

모금 행사 할당의 시스템 레코드 ID입니다.

구성 요소 ID
constituent_id string

할당된 구성 요소의 시스템 레코드 ID입니다.

유형
type string

모금 행사 유형입니다.

할당 시작
start date-time

배정의 시작 날짜입니다.

할당 종료
end date-time

배정의 종료 날짜입니다.

value
amount.value double

통화 값입니다.

캠페인 ID
campaign_id string

결과 선물을 적용할 캠페인의 시스템 레코드 ID입니다.

펀드 ID
fund_id string

결과 선물을 적용할 펀드의 시스템 레코드 ID입니다.

항소 ID
appeal_id string

결과 선물을 적용할 항소의 시스템 레코드 ID입니다.

FundraisingApi.FundAttachmentRead

첨부 파일

Name 경로 형식 Description
아이디
id string

첨부 파일의 시스템 레코드 ID입니다.

펀드 ID
parent_id string

첨부 파일과 연결된 펀드의 시스템 레코드 ID입니다.

유형
type string

첨부 파일 형식입니다. 실제 첨부 파일은 로컬 또는 네트워크에 저장된 이미지, PDF 또는 Word 문서와 같은 업로드된 파일입니다. 시스템에 저장되고 관리됩니다. 링크 첨부 파일은 온라인 또는 클라우드 스토리지 계정에 있는 이미지, 블로그 게시물 또는 YouTube 비디오와 같은 파일에 대한 링크입니다. 외부에 저장되고 관리됩니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜입니다.

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

파일 이름
file_name string

파일 이름입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

파일 ID
file_id string

파일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 ID
thumbnail_id string

썸네일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 URL
thumbnail_url string

썸네일의 URL입니다. 이미지만 있는 실제 첨부 파일의 경우 액세스를 60분으로 제한하는 시간 제한 서명을 포함합니다.

콘텐츠 형식
content_type string

콘텐츠 형식입니다. 실제 첨부 파일의 경우에만 해당합니다.

파일 크기
file_size integer

파일 크기(바이트)입니다. 실제 첨부 파일의 경우에만 해당합니다.

FundraisingApi.FundCustomFieldRead

사용자 지정 필드

Name 경로 형식 Description
아이디
id string

사용자 지정 필드의 시스템 레코드 ID입니다.

펀드 ID
parent_id string

사용자 지정 필드와 연결된 펀드의 시스템 레코드 ID입니다.

카테고리
category string

사용자 지정 필드 범주입니다.

유형
type string

사용자 지정 필드가 나타내는 데이터의 형식입니다.

가치
value

사용자 지정 필드의 값입니다.

날짜
date date

사용자 지정 필드의 날짜입니다.

주석
comment string

사용자 지정 필드에 대한 주석입니다. 문자 제한: 50.

추가된 날짜
date_added date-time

사용자 지정 필드를 만든 날짜입니다.

수정된 날짜
date_modified date-time

사용자 지정 필드가 마지막으로 수정된 날짜입니다.

FundraisingApi.FundRead

기금

Name 경로 형식 Description
아이디
id string

펀드의 시스템 레코드 ID입니다.

카테고리
category string

펀드의 범주입니다.

추가된 날짜
date_added date-time

펀드가 만들어진 날짜입니다.

수정된 날짜
date_modified date-time

펀드가 마지막으로 수정된 날짜입니다.

Description
description string

펀드의 표시 이름입니다.

끝 날짜
end_date date-time

펀드의 종료 날짜입니다.

value
goal.value double

통화 값입니다.

게으른?
inactive boolean

펀드가 비활성 상태인가요(즉, 현재 날짜는 시작 날짜 이후와 종료 날짜 이전임)?

조회 ID
lookup_id string

펀드에 대한 사용자 정의 식별자입니다.

시작 날짜
start_date date-time

펀드의 시작 날짜입니다.

유형
type string

펀드의 유형입니다.

FundraisingApi.PackageRead

Package

Name 경로 형식 Description
아이디
id string

패키지의 시스템 레코드 ID입니다.

항소 ID
appeal_id string

이 패키지와 연결된 항소의 시스템 레코드 ID입니다.

카테고리
category string

패키지의 범주입니다.

추가된 날짜
date_added date-time

패키지를 만든 날짜입니다.

수정된 날짜
date_modified date-time

패키지가 마지막으로 수정된 날짜입니다.

value
default_gift_amount.value double

통화 값입니다.

Description
description string

패키지의 표시 이름입니다.

끝 날짜
end date-time

패키지의 종료 날짜입니다.

value
goal.value double

통화 값입니다.

게으른?
inactive boolean

패키지가 비활성 상태입니까(즉, 현재 날짜는 시작 날짜 이후와 종료 날짜 이전임)?

조회 ID
lookup_id string

패키지에 대한 사용자 정의 식별자입니다.

비고
notes string

패키지에 대한 참고 사항입니다.

받는 사람 수
recipient_count integer

패키지의 받는 사람 수입니다.

시작 날짜
start date-time

패키지의 시작 날짜입니다.

GiftApi.AcknowledgementRead

승인

Name 경로 형식 Description
date
date date-time

승인과 연결된 날짜입니다.

글자
letter string

승인과 관련된 편지입니다.

status
status string

승인의 상태입니다. 사용 가능한 값은 ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT 및 DONOTACKNOWLEDGE입니다.

GiftApi.ApiCollectionOfGiftAttachmentRead

Attachments

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of GiftApi.GiftAttachmentRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

GiftApi.ApiCollectionOfGiftCustomFieldRead

사용자 지정 필드

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of GiftApi.GiftCustomFieldRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

GiftApi.ApiCollectionOfGiftRead

선물

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of GiftApi.GiftRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

GiftApi.BatchGiftAddResults

작업에서 추가한 일괄 처리 선물 오류 레코드 및 일괄 처리 선물의 컬렉션을 포함합니다.

Name 경로 형식 Description
오류
errors array of GiftApi.GiftBatchGiftError

일괄 처리 기프트 추가 작업과 관련된 일괄 처리 선물 오류

선물
gifts array of GiftApi.BatchGiftRead

일괄 처리 기프트 추가 작업에 의해 추가된 일괄 처리 선물 컬렉션

GiftApi.GiftBatchGiftError

항목이 일괄 처리에 추가되지 않도록 하는 예외를 나타냅니다.

Name 경로 형식 Description
영향을 받는 필드
affected_field string

오류의 영향을 받는 필드

일괄 처리 ID
batch_id string

일괄 처리의 시스템 레코드 ID

예외 오류 코드
exception_error_code integer

예외 오류 코드

예외 오류 메시지
exception_error_message string

예외 오류 메시지

예외 오류 이름
exception_error_name string

예외 오류 이름

선물 ID
gift_id string

기프트의 시스템 레코드 ID

조회 ID
lookup_id string

선물에 대한 사용자 정의 식별자입니다.

GiftApi.BatchGiftRead

일괄 처리 선물

Name 경로 형식 Description
일괄 처리 ID
batch_id string

선물이 추가된 일괄 처리의 ID입니다.

오류
errors array of GiftApi.GiftBatchGiftError

일괄 처리 선물과 관련된 오류입니다.

아이디
id string

일괄 처리 선물의 시스템 레코드 ID입니다.

구성 요소 ID
constituent_id string

기프트와 연결된 구성 요소의 시스템 레코드 ID입니다.

type
type string

선물 종류입니다.

하위
subtype string

선물의 하위 형식입니다.

date
date date-time

선물 날짜입니다.

value
amount.value double

통화 값입니다.

value
balance.value double

통화 값입니다.

일괄 처리 번호
batch_number string

이 선물과 연결된 일괄 처리 번호입니다.

status
gift_status string

선물의 상태입니다.

익명의?
is_anonymous boolean

선물은 익명인가요?

선거 구민
constituency string

선물의 선거구입니다.

조회 ID
lookup_id string

선물에 대한 사용자 정의 식별자입니다.

origin
origin string

선물의 기원입니다.

게시 상태
post_status string

선물의 일반 원장 게시 상태입니다. 사용 가능한 값은 Posted, NotPosted 및 DoNotPost입니다. post_status DoNotPost>로 설정되면 post_date null이어야 합니다. NotPosted로 설정되면 post_date 필요하지만 편집 가능한 상태로 유지됩니다. 게시됨으로 설정되면 post_date 필요하며 더 이상 편집할 수 없습니다.

게시 날짜
post_date date-time

선물이 일반 원장에 게시된 날짜입니다.

참조
reference string

그 뒤에 동기 부여 또는 선물 종류에 대한 자세한 설명과 같은 선물에 대한 특별한 세부 사항을 추적하는 노트.

recurring_gift_status_date.d integer

유사 날짜의 날짜입니다.

개월
recurring_gift_status_date.m integer

유사 항목 날짜의 월입니다.

recurring_gift_status_date.y integer

유사 날짜의 연도입니다.

frequency
recurring_gift_schedule.frequency string

볼 되풀이 선물의 할부 빈도입니다. 사용 가능한 값은 매주, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, 매월, 분기별, 매년입니다.

start
recurring_gift_schedule.start_date date-time

되풀이 선물이 시작되는 날짜입니다.

recurring_gift_schedule.end_date date-time

되풀이 선물이 종료되는 날짜입니다.

value
gift_aid_amount.value double

통화 값입니다.

선물 지원 자격 상태
gift_aid_qualification_status string

이 계산 필드는 세금 신고 정보 및 데이터베이스 형식에 따라 Gift Aid 자격 상태를 결정합니다. 사용 가능한 값은 정규화, NotQualified 및 PartlyQualified입니다. 영국에 대해서만.

선물 코드
gift_code string

선물과 관련된 선물 코드 값입니다.

선물 분할
gift_splits array of GiftApi.GiftSplitRead

선물과 관련된 선물 분할 세트입니다.

기금 모금 행사
fundraisers array of GiftApi.GiftFundraiserRead

선물에 대한 크레딧을 받는 기금 모금 행사 세트입니다.

소프트 크레딧
soft_credits array of GiftApi.SoftCreditRead

선물과 관련된 소프트 크레딧 세트입니다.

영수증
receipts array of GiftApi.ReceiptRead

선물과 관련된 영수증 세트입니다.

도움 주신 분
acknowledgements array of GiftApi.AcknowledgementRead

선물과 관련된 승인 집합입니다.

결제
payments array of GiftApi.PaymentRead

선물에 대한 지불입니다.

연결된 선물
linked_gifts array of string

이 선물과 연결된 다른 선물의 식별자입니다.

추가된 날짜
date_added date-time

선물이 만들어진 날짜입니다.

수정된 날짜
date_modified date-time

선물이 마지막으로 수정된 날짜입니다.

GiftApi.CreatedGift

만든 선물

Name 경로 형식 Description
아이디
id string

새로 만든 선물의 ID입니다.

GiftApi.CreatedGiftAttachment

선물 첨부 파일 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 선물 첨부 파일의 ID입니다.

GiftApi.CreatedGiftCustomField

선물 사용자 정의 필드 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 선물 사용자 정의 필드의 ID입니다.

GiftApi.GiftAttachmentRead

첨부 파일

Name 경로 형식 Description
아이디
id string

첨부 파일의 시스템 레코드 ID입니다.

기프트 ID
parent_id string

첨부 파일과 연결된 선물의 시스템 레코드 ID입니다.

유형
type string

첨부 파일 형식입니다. 실제 첨부 파일은 로컬 또는 네트워크에 저장된 이미지, PDF 또는 Word 문서와 같은 업로드된 파일입니다. 시스템에 저장되고 관리됩니다. 링크 첨부 파일은 온라인 또는 클라우드 스토리지 계정에 있는 이미지, 블로그 게시물 또는 YouTube 비디오와 같은 파일에 대한 링크입니다. 외부에 저장되고 관리됩니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜입니다.

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

파일 이름
file_name string

파일 이름입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

파일 ID
file_id string

파일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 ID
thumbnail_id string

썸네일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 URL
thumbnail_url string

썸네일의 URL입니다. 이미지만 있는 실제 첨부 파일의 경우 액세스를 60분으로 제한하는 시간 제한 서명을 포함합니다.

콘텐츠 형식
content_type string

콘텐츠 형식입니다. 실제 첨부 파일의 경우에만 해당합니다.

파일 크기
file_size integer

파일 크기(바이트)입니다. 실제 첨부 파일의 경우에만 해당합니다.

GiftApi.GiftCustomFieldRead

사용자 지정 필드

Name 경로 형식 Description
아이디
id string

사용자 지정 필드의 시스템 레코드 ID입니다.

기프트 ID
parent_id string

사용자 지정 필드와 연결된 선물의 시스템 레코드 ID입니다.

카테고리
category string

사용자 지정 필드 범주입니다.

유형
type string

사용자 지정 필드가 나타내는 데이터의 형식입니다.

가치
value

사용자 지정 필드의 값입니다.

날짜
date date

사용자 지정 필드의 날짜입니다.

주석
comment string

사용자 지정 필드에 대한 주석입니다. 문자 제한: 50.

추가된 날짜
date_added date-time

사용자 지정 필드를 만든 날짜입니다.

수정된 날짜
date_modified date-time

사용자 지정 필드가 마지막으로 수정된 날짜입니다.

GiftApi.GiftFundraiserRead

기프트 모금 행사

Name 경로 형식 Description
value
amount.value double

통화 값입니다.

기금 모금자 ID
constituent_id string

선물과 관련된 기금 모금 행사의 구성 시스템 레코드 ID입니다.

GiftApi.GiftRead

선물

Name 경로 형식 Description
아이디
id string

선물의 시스템 레코드 ID입니다.

구성 요소 ID
constituent_id string

기프트와 연결된 구성 요소의 시스템 레코드 ID입니다.

유형
type string

선물 종류입니다.

서브타입
subtype string

선물의 하위 형식입니다.

날짜
date date-time

선물 날짜입니다.

value
amount.value double

통화 값입니다.

value
balance.value double

통화 값입니다.

일괄 처리 번호
batch_number string

이 선물과 연결된 일괄 처리 번호입니다.

상태
gift_status string

선물의 상태입니다.

익명의?
is_anonymous boolean

선물은 익명인가요?

선거 구민
constituency string

선물의 선거구입니다.

조회 ID
lookup_id string

선물에 대한 사용자 정의 식별자입니다.

기원
origin string

선물의 기원입니다.

게시 상태
post_status string

선물의 일반 원장 게시 상태입니다. 사용 가능한 값은 Posted, NotPosted 및 DoNotPost입니다. post_status DoNotPost>로 설정되면 post_date null이어야 합니다. NotPosted로 설정되면 post_date 필요하지만 편집 가능한 상태로 유지됩니다. 게시됨으로 설정되면 post_date 필요하며 더 이상 편집할 수 없습니다.

게시 날짜
post_date date-time

선물이 일반 원장에 게시된 날짜입니다.

Reference
reference string

그 뒤에 동기 부여 또는 선물 종류에 대한 자세한 설명과 같은 선물에 대한 특별한 세부 사항을 추적하는 노트.

recurring_gift_status_date.d integer

유사 날짜의 날짜입니다.

개월
recurring_gift_status_date.m integer

유사 항목 날짜의 월입니다.

recurring_gift_status_date.y integer

유사 날짜의 연도입니다.

frequency
recurring_gift_schedule.frequency string

볼 되풀이 선물의 할부 빈도입니다. 사용 가능한 값은 매주, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, 매월, 분기별, 매년입니다.

start
recurring_gift_schedule.start_date date-time

되풀이 선물이 시작되는 날짜입니다.

recurring_gift_schedule.end_date date-time

되풀이 선물이 종료되는 날짜입니다.

value
gift_aid_amount.value double

통화 값입니다.

기프트 원조 자격 상태
gift_aid_qualification_status string

이 계산 필드는 세금 신고 정보 및 데이터베이스 형식에 따라 Gift Aid 자격 상태를 결정합니다. 사용 가능한 값은 정규화, NotQualified 및 PartlyQualified입니다. 영국에 대해서만.

선물 코드
gift_code string

선물과 관련된 선물 코드 값입니다.

선물 분할
gift_splits array of GiftApi.GiftSplitRead

선물과 관련된 선물 분할 세트입니다.

모금 행사
fundraisers array of GiftApi.GiftFundraiserRead

선물에 대한 크레딧을 받는 기금 모금 행사 세트입니다.

소프트 크레딧
soft_credits array of GiftApi.SoftCreditRead

선물과 관련된 소프트 크레딧 세트입니다.

영수증
receipts array of GiftApi.ReceiptRead

선물과 관련된 영수증 세트입니다.

도움 주신 분
acknowledgements array of GiftApi.AcknowledgementRead

선물과 관련된 승인 집합입니다.

결제
payments array of GiftApi.PaymentRead

선물에 대한 지불입니다.

연결된 선물
linked_gifts array of string

이 선물과 연결된 다른 선물의 식별자입니다.

추가된 날짜
date_added date-time

선물이 만들어진 날짜입니다.

수정된 날짜
date_modified date-time

선물이 마지막으로 수정된 날짜입니다.

GiftApi.GiftSplitRead

선물 분할

Name 경로 형식 Description
아이디
id string

기프트 분할의 시스템 레코드 ID입니다.

value
amount.value double

통화 값입니다.

항소 ID
appeal_id string

기프트 분할과 관련된 항소의 시스템 레코드 ID입니다.

캠페인 ID
campaign_id string

기프트 분할과 관련된 캠페인의 시스템 레코드 ID입니다.

fund ID
fund_id string

선물 분할과 관련된 펀드의 시스템 레코드 ID입니다.

value
gift_aid_amount.value double

통화 값입니다.

선물 지원 자격 상태
gift_aid_qualification_status string

기프트 분할의 기프트 원조 자격 상태. 사용 가능한 값은 정규화 및 NotQualified입니다. 영국에 대해서만.

패키지 ID
package_id string

기프트 분할과 연결된 패키지의 시스템 레코드 ID입니다.

GiftApi.ReceiptRead

Receipt

Name 경로 형식 Description
value
amount.value double

통화 값입니다.

date
date date-time

영수증의 날짜입니다.

숫자
number integer

영수증의 수입니다.

status
status string

영수증의 상태입니다. 사용 가능한 값은 RECEIPTED, NEEDSRECEIPT 및 DONOTRECEIPT입니다.

GiftApi.PaymentRead

지불

Name 경로 형식 Description
계정 토큰
account_token string

외부 결제 공급자의 토큰화된 계정 정보(예: 신용 카드)입니다. "CreditCard" 및 "DirectDebit"의 결제 방법에만 적용됩니다.

BBPS 구성 ID
bbps_configuration_id string

BBPS 구성 ID입니다. "CreditCard" 및 "DirectDebit"의 결제 방법에만 적용됩니다.

BBPS 트랜잭션 ID
bbps_transaction_id string

BBPS 트랜잭션 ID입니다. "CreditCard" 및 "DirectDebit"의 결제 방법에만 적용됩니다.

check_date.d integer

유사 날짜의 날짜입니다.

개월
check_date.m integer

유사 항목 날짜의 월입니다.

check_date.y integer

유사 날짜의 연도입니다.

확인 번호
check_number string

확인 번호입니다. "PersonalCheck"의 결제 방법에만 적용됩니다.

체크 아웃 트랜잭션 ID
checkout_transaction_id string

체크 아웃 트랜잭션 ID입니다. "CreditCard" 및 "DirectDebit"의 결제 방법에만 적용됩니다.

결제 방법
payment_method string

결제 방법입니다. 사용 가능한 값은 아래에 나열되어 있습니다.

참조
reference string

참조입니다. "기타"의 결제 방법에만 적용됩니다.

reference_date.d integer

유사 날짜의 날짜입니다.

개월
reference_date.m integer

유사 항목 날짜의 월입니다.

reference_date.y integer

유사 날짜의 연도입니다.

GiftApi.SoftCreditRead

소프트 크레딧

Name 경로 형식 Description
아이디
id string

소프트 크레딧의 시스템 레코드 ID입니다.

value
amount.value double

통화 값입니다.

구성 요소 ID
constituent_id string

소프트 크레딧과 연결된 구성 요소의 시스템 레코드 ID입니다.

선물 ID
gift_id string

소프트 크레딧과 관련된 선물의 시스템 레코드 ID입니다.

GiftBatchApi.ApiCollectionOfGiftBatch

선물 일괄 처리

Name 경로 형식 Description
수량
count integer

응답의 총 선물 일괄 처리 수입니다.

value
value array of GiftBatchApi.GiftBatch

응답에 포함된 항목 집합입니다.

GiftBatchApi.CreatedBatch

선물 일괄 처리 만들기

Name 경로 형식 Description
아이디
batch_id string

새로 만든 선물 일괄 처리의 시스템 레코드 ID입니다.

GiftBatchApi.GiftBatch

선물 일괄 처리 개체를 나타냅니다.

Name 경로 형식 Description
아이디
id string

일괄 처리의 시스템 레코드 ID입니다.

description
batch_description string

일괄 처리 설명입니다.

일괄 처리 번호
batch_number string

일괄 처리 번호

프로젝스된 번호
projected_number_of_gifts integer

일괄 처리에 예상된 선물 수입니다.

실제 숫자
number_of_gifts integer

일괄 처리의 실제 선물 수입니다.

예상 금액
projected_amount double

일괄 처리에 있는 선물의 예상 값입니다.

실제 금액
actual_amount double

일괄 처리에 있는 선물의 실제 값입니다.

예외가 있나요?
has_exceptions boolean

일괄 처리에 예외가 있나요?

승인?
is_approved boolean

일괄 처리가 승인되었나요?

만든 사람:
created_by string

일괄 처리를 만든 사용자의 이름입니다.

생성 일자
created_on date-time

일괄 처리가 만들어진 날짜입니다.

ListApi.CreatedList

목록이 만들어짐

Name 경로 형식 Description
아이디
id string

새로 만든 목록의 ID입니다.

OpportunityApi.ApiCollectionOfOpportunityAttachmentRead

Attachments

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of OpportunityApi.OpportunityAttachmentRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead

사용자 지정 필드

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of OpportunityApi.OpportunityCustomFieldRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

OpportunityApi.ApiCollectionOfOpportunityRead

영업 기회

Name 경로 형식 Description
수량
count integer

요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다.

value
value array of OpportunityApi.OpportunityRead

응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다.

OpportunityApi.CreatedOpportunity

만든 기회

Name 경로 형식 Description
아이디
id string

새로 만든 기회의 ID입니다.

OpportunityApi.CreatedOpportunityAttachment

기회 첨부 파일 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 기회 첨부 파일의 ID입니다.

OpportunityApi.CreatedOpportunityCustomField

기회 첨부 파일 만들기

Name 경로 형식 Description
아이디
id string

새로 만든 기회 첨부 파일의 ID입니다.

OpportunityApi.Fundraiser

모금 행사

Name 경로 형식 Description
구성 요소 ID
constituent_id string

모금 행사와 관련된 구성 요소의 시스템 레코드 ID입니다.

value
credit_amount.value double

통화 값입니다.

OpportunityApi.OpportunityAttachmentRead

첨부 파일

Name 경로 형식 Description
아이디
id string

첨부 파일의 시스템 레코드 ID입니다.

기회 ID
parent_id string

첨부 파일과 연결된 기회의 시스템 레코드 ID입니다.

유형
type string

첨부 파일 형식입니다. 실제 첨부 파일은 로컬 또는 네트워크에 저장된 이미지, PDF 또는 Word 문서와 같은 업로드된 파일입니다. 시스템에 저장되고 관리됩니다. 링크 첨부 파일은 온라인 또는 클라우드 스토리지 계정에 있는 이미지, 블로그 게시물 또는 YouTube 비디오와 같은 파일에 대한 링크입니다. 외부에 저장되고 관리됩니다.

이름
name string

첨부 파일의 이름입니다. 문자 제한: 150.

날짜
date date-time

첨부 파일의 날짜입니다.

URL
url string

첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다.

파일 이름
file_name string

파일 이름입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

파일 ID
file_id string

파일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 ID
thumbnail_id string

썸네일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다.

썸네일 URL
thumbnail_url string

썸네일의 URL입니다. 이미지만 있는 실제 첨부 파일의 경우 액세스를 60분으로 제한하는 시간 제한 서명을 포함합니다.

콘텐츠 형식
content_type string

콘텐츠 형식입니다. 실제 첨부 파일의 경우에만 해당합니다.

파일 크기
file_size integer

파일 크기(바이트)입니다. 실제 첨부 파일의 경우에만 해당합니다.

OpportunityApi.OpportunityCustomFieldRead

사용자 지정 필드

Name 경로 형식 Description
아이디
id string

사용자 지정 필드의 시스템 레코드 ID입니다.

기회 ID
parent_id string

사용자 지정 필드와 연결된 기회의 시스템 레코드 ID입니다.

카테고리
category string

사용자 지정 필드 범주입니다.

유형
type string

사용자 지정 필드가 나타내는 데이터의 형식입니다.

가치
value

사용자 지정 필드의 값입니다.

날짜
date date

사용자 지정 필드의 날짜입니다.

주석
comment string

사용자 지정 필드에 대한 주석입니다. 문자 제한: 50.

추가된 날짜
date_added date-time

사용자 지정 필드를 만든 날짜입니다.

수정된 날짜
date_modified date-time

사용자 지정 필드가 마지막으로 수정된 날짜입니다.

OpportunityApi.OpportunityRead

기회

Name 경로 형식 Description
아이디
id string

기회의 시스템 레코드 ID입니다.

구성 요소 ID
constituent_id string

기회와 연결된 구성 요소의 시스템 레코드 ID입니다.

목적
purpose string

기회의 결과로 모금 된 모든 돈에 대한 의도 된 사용.

이름
name string

목록 또는 구성 레코드와 같이 프로그램 전체에서 기회를 식별하는 이름입니다. 문자 제한: 255.

상태
status string

요청 프로세스에서 기회가 있는 위치를 나타내는 상태입니다.

Deadline
deadline date-time

선물을 선물할 수 있는 기회의 목표 날짜입니다.

질문 날짜
ask_date date-time

권유가 이루어진 날짜입니다.

value
ask_amount.value double

통화 값입니다.

예상 날짜
expected_date date-time

기회에 대한 응답으로 잠재고객이 제공할 것으로 예상되는 날짜입니다.

value
expected_amount.value double

통화 값입니다.

자금 지원 날짜
funded_date date-time

잠재고객이 기회에 대한 응답으로 준 날짜입니다.

value
funded_amount.value double

통화 값입니다.

캠페인 ID
campaign_id string

기회와 관련된 캠페인의 시스템 레코드 ID입니다. 이 캠페인은 기금 모금을 위한 전반적인 목표를 설정합니다.

펀드 ID
fund_id string

기회와 관련된 펀드의 시스템 레코드 ID입니다. 기금은 선물의 특정 재무 목적을 지정하고 그 선물에 대한 금융 계좌를 식별합니다.

모금 행사
fundraisers array of OpportunityApi.Fundraiser

기회에 할당된 기금 모금 행사의 시스템 레코드 ID 집합입니다.

게으른?
inactive boolean

기회가 비활성 상태인가요?

linked_gifts
linked_gifts array of string

이 시스템은 기회와 관련된 선물의 ID를 기록합니다.

추가된 날짜
date_added date-time

기회가 만들어진 날짜입니다.

수정된 날짜
date_modified date-time

영업 기회가 마지막으로 수정된 날짜입니다.