Darowizny Blackbaud RENXT
Blackbaud Raiser's Edge NXT to kompleksowe oparte na chmurze rozwiązanie do zbierania funduszy i zarządzania darczyńcami opracowane specjalnie dla organizacji non-profit i całej dobrej społeczności społecznej. Użyj łącznika Prezenty, aby zarządzać prezentami.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Obsługa rozwiązania Blackbaud |
| adres URL | https://www.blackbaud.com/support |
| skyapi@blackbaud.com |
| Metadane łącznika | |
|---|---|
| Publisher | Blackbaud, Inc. |
| Witryna internetowa | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| Zasady ochrony prywatności | https://www.blackbaud.com/privacy-shield |
| Kategorie | Sprzedaż i CRM; Produktywność |
Raiser's Edge NXT to kompleksowe oparte na chmurze rozwiązanie do zbierania funduszy i zarządzania darczyńcami opracowane specjalnie dla organizacji non-profit i całej społeczności dobra społecznego.
Ten łącznik jest oparty na interfejsie API SKY Blackbaud i zapewnia operacje ułatwiające zarządzanie prezentami i powiązanymi jednostkami znajdującymi się w narzędziu NXT aplikacji Raiser Edge, w tym:
- Prezenty i składowe dające podsumowania
- Partie prezentów
- Rachunki
- Potwierdzenia
- i nie tylko...
Aby uzyskać więcej informacji, zapoznaj się z dokumentacją.
Wymagania wstępne
Aby korzystać z tego łącznika, musisz mieć konto identyfikatora Blackbaud z dostępem do co najmniej jednego środowiska Blackbaud.
Ponadto administrator organizacji musi również wykonać akcję na poziomie administratora w systemie, aby umożliwić temu łącznikowi dostęp do środowiska Blackbaud. Więcej informacji na temat tych wymagań wstępnych można znaleźć w dokumentacji początkowej konfiguracji .
Jak uzyskać poświadczenia?
Administrator organizacji wyśle Ci zaproszenie do środowiska NXT aplikacji Raiser's Edge i skonfiguruje uprawnienia konta użytkownika w środowisku. Do korzystania z tego łącznika nie są wymagane żadne dodatkowe poświadczenia.
Znane problemy i ograniczenia
Łącznik będzie działać w kontekście konta użytkownika i w związku z tym będzie podlegać uprawnieniam użytkownika w środowisku.
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie deklaracji podatkowej składowej |
Aktualizuje deklarację podatkową składową. |
| Aktualizowanie hołdu prezentowego potwierdza |
Aktualizuje hołd prezentu przyznać. |
| Aktualizowanie hołdu prezentu |
Aktualizuje hołd prezentu. |
| Aktualizowanie notatki z prezentu |
Aktualizuje notatkę z prezentem. |
| Aktualizowanie pola niestandardowego prezentu |
Aktualizuje pole niestandardowe prezentu. |
| Aktualizowanie szczegółów paragonu upominkowego |
Aktualizuje szczegóły paragonu dla prezentu. |
| Aktualizowanie szczegółów potwierdzenia prezentu |
Aktualizuje szczegóły potwierdzenia dla prezentu. |
| Aktualizowanie załącznika prezentu |
Aktualizuje załącznik prezentu. |
| Dodawanie prezentu do partii |
Dodaj prezent do określonej partii prezentów. |
| List pledge raty |
Zawiera listę rat dla zobowiązania. |
| Lista deklaracji podatkowych składowych |
Zawiera listę deklaracji podatkowych pomocy prezentowej dla wyborców (dotyczy tylko wersji brytyjskich). |
| Lista hołd prezentów przyznaje |
Wymienić uznanie za hołd prezentu. |
| Lista hołdów prezentów |
Wymienia hołdy dla prezentu. |
| Lista notatek upominkowych |
Wyświetla listę notatek dla prezentu. |
| Lista partii prezentów |
Wyświetl listę partii prezentów. |
| Lista prezentów |
Zwraca listę prezentów. |
| Lista załączników prezentów |
Wyświetla listę załączników dla prezentu. |
| Otrzymasz prezent |
Zwraca informacje o prezentie. |
| Pobierz najnowszy prezent dla wyborców |
Zwraca najnowszy prezent dla składnika. |
| Sprzedaż prezentu giełdowego |
Aktualizuje prezent giełdowy do sprzedaży. |
| Tworzenie deklaracji podatkowej składowej |
Tworzy nową deklarację podatku od pomocy prezentowej dla składnika. |
| Tworzenie hołdu prezentowego |
Tworzy nowy hołd prezentowy. |
| Tworzenie notatki z prezentu |
Tworzy nową notatkę prezentową. |
| Tworzenie partii prezentów |
Tworzy nową partię prezentów. |
| Tworzenie pola niestandardowego prezentu |
Tworzy nowe pole niestandardowe prezentu. |
| Tworzenie prezentu |
Tworzy nowy prezent. |
| Tworzenie prezentu stockowego |
Tworzy nowy prezent na czas. |
| Tworzenie płatności zastaw |
Tworzy nową płatność zastaw. |
| Tworzenie załącznika prezentu |
Tworzy nowy załącznik prezentu. |
| Tworzenie zobowiązania |
Tworzy nowe zobowiązanie. |
| Uzyskaj pierwszy prezent składników |
Zwraca pierwszy prezent dla składnika. |
| Uzyskiwanie prezentu według identyfikatora odnośnika |
Zwraca identyfikator rekordu systemowego prezentu z określonego identyfikatora odnośnika. |
| Uzyskiwanie składowego okresu istnienia dającego |
Zwraca okres istnienia dając podsumowanie dla składnika. |
| Uzyskuj prezent najwspanialszy |
Zwraca największy prezent dla składnika. |
| Wyświetlanie listy pól niestandardowych prezentów |
Wyświetla listę pól niestandardowych dla prezentu. |
| Wyświetlanie listy płatności zastawnych |
Wyświetla listę płatności za zobowiązanie. |
Aktualizowanie deklaracji podatkowej składowej
Aktualizuje deklarację podatkową składową.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator deklaracji podatkowej
|
tax_declaration_id | True | integer |
Identyfikator rejestru systemowego deklaracji podatkowej do aktualizacji. |
|
Rozpoczyna się deklaracja
|
declaration_starts | date-time |
Data rozpoczęcia deklaracji podatkowej (np. "2020-09-18T04:13:56Z"). |
|
|
Końce deklaracji
|
declaration_ends | date-time |
Data zakończenia deklaracji podatkowej (np. "2020-09-18T04:13:56Z"). |
|
|
Deklaracja dokonana
|
declaration_made | date-time |
Data złożenia deklaracji podatkowej (np. "2020-09-18T04:13:56Z"). |
|
|
Indicator
|
declaration_indicator | string |
Wskaźnik deklaracji. |
|
|
Źródło
|
declaration_source | string |
Źródło deklaracji. |
|
|
Wysłane potwierdzenie
|
confirmation_sent | date-time |
Data wysłania potwierdzenia (np. "2020-09-18T04:13:56Z"). |
|
|
Zwrócone potwierdzenie
|
confirmation_returned | date-time |
Data zwrócenia potwierdzenia (np. "2020-09-18T04:13:56Z"). |
|
|
Płaci podatek
|
constituent_pays_tax | string |
Wskazuje, czy składnik płaci podatek. |
|
|
Status
|
tax_payer_status | string |
Status płatnika podatku. |
|
|
Comments
|
tax_notes | string |
Uwagi dotyczące deklaracji podatkowej. |
|
|
Kolejność
|
sequence | integer |
Sekwencja liczbowa skojarzona z deklaracją podatkową. |
Aktualizowanie hołdu prezentowego potwierdza
Aktualizuje hołd prezentu przyznać.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Hołd prezentu potwierdza identyfikator
|
gift_tribute_acknowledgee_id | True | integer |
Identyfikator rekordu systemu hołdu prezentowego przyznaje się do aktualizacji. |
|
List
|
letter | integer |
List wysłany do potwierdzenia. |
|
|
Data litery
|
letter_date | date-time |
Data wysłania listu. |
Aktualizowanie hołdu prezentu
Aktualizuje hołd prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator hołdu prezentu
|
gift_tribute_id | True | integer |
Identyfikator rekordu systemu hołdu prezentowego do aktualizacji. |
|
Typ hołdu
|
tribute_type | integer |
Typ hołdu. |
|
|
Stan potwierdzenia
|
acknowledge | string |
Hołd prezentu przyznaje status. |
Aktualizowanie notatki z prezentu
Aktualizuje notatkę z prezentem.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator notatki
|
id | True | integer |
Identyfikator rekordu systemu notatki do zaktualizowania. |
|
Typ
|
note_type_id | integer |
Typ notatki. |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Podsumowanie
|
summary | string |
Podsumowanie notatki. Limit znaków: 255. |
|
|
Uwaga / Notatka
|
text | string |
Tekst notatki. |
|
|
Author
|
author | string |
Autor notatki. Limit znaków: 50. |
Aktualizowanie pola niestandardowego prezentu
Aktualizuje pole niestandardowe prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator pola niestandardowego
|
custom_field_id | True | string |
Identyfikator rekordu systemowego pola niestandardowego do zaktualizowania. |
|
body
|
body | True | dynamic |
Obiekt reprezentujący właściwości pola niestandardowego do zaktualizowania. |
Aktualizowanie szczegółów paragonu upominkowego
Aktualizuje szczegóły paragonu dla prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator potwierdzenia
|
receipt_id | True | string |
Identyfikator rekordu systemowego potwierdzenia prezentu do aktualizacji. Używa identyfikatora prezentu nadrzędnego jako jego wartości. |
|
Status
|
status | string |
Status odbioru prezentu. Jeśli stan ma wartość NeedsReceipt lub DoNotReceipt, data potwierdzenia powinna mieć wartość null. |
|
|
Kwota
|
value | double |
Kwota paragonu. |
|
|
Date
|
date | date-time |
Data odbioru (np. "2020-09-18T04:13:56Z"). |
|
|
Number
|
number | integer |
Liczba paragonów. |
Aktualizowanie szczegółów potwierdzenia prezentu
Aktualizuje szczegóły potwierdzenia dla prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator potwierdzenia
|
acknowledgement_id | True | string |
Identyfikator rekordu systemowego potwierdzenia prezentu do aktualizacji. Używa identyfikatora prezentu nadrzędnego jako jego wartości. |
|
Status
|
status | string |
Stan potwierdzenia. Gdy stan jest ustawiony na DoNotAcknowledge, litera i data powinny mieć wartość null. Jeśli stan ma wartość NeedsAcknowledgement, data powinna mieć wartość null. |
|
|
Date
|
date | date-time |
Data skojarzona z potwierdzeniem (np. "2020-09-18T04:13:56Z"). |
|
|
List
|
letter | string |
List skojarzony z potwierdzeniem. |
Aktualizowanie załącznika prezentu
Aktualizuje załącznik prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator załącznika
|
attachment_id | True | string |
Identyfikator rekordu systemu załącznika do aktualizacji. |
|
Name
|
name | string |
Nazwa załącznika. Limit znaków: 150. |
|
|
Date
|
date | date-time |
Data załącznika (np. "2020-09-18T04:13:56Z"). |
|
|
adres URL
|
url | string |
Adres URL załącznika. Jest to wymagane w przypadku załączników linków i nie dotyczy załączników fizycznych. |
|
|
Etykiety
|
tags | array of string |
Tagi skojarzone z załącznikiem. |
Dodawanie prezentu do partii
Dodaj prezent do określonej partii prezentów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Batch
|
batch_id | True | string |
Partia, do której zostanie dodany prezent. |
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemowego składnika skojarzonego z prezentem. |
|
Kwota
|
value | True | double |
Ilość prezentu. |
|
Date
|
date | True | date |
Data prezentu (np. "2020-09-18"). |
|
Typ
|
type | True | string |
Typ prezentu. |
|
identyfikator kampanii
|
campaign_id | string |
Identyfikator rekordu systemowego kampanii skojarzonej z podziałem prezentu. |
|
|
identyfikator funduszu
|
fund_id | True | string |
Identyfikator rejestru systemu funduszu skojarzonego z podziałem prezentu. |
|
identyfikator odwołania
|
appeal_id | string |
Identyfikator rekordu systemowego odwołania skojarzonego z podziałem prezentu. |
|
|
identyfikator pakietu
|
package_id | string |
Identyfikator rekordu systemowego pakietu skojarzonego z podziałem prezentu. |
|
|
kwota
|
value | True | double |
Kwota podziału prezentu. |
|
Forma płatności
|
payment_method | True | string |
Forma płatności. |
|
Numer kontrolny
|
check_number | string |
Numer kontrolny (dotyczy tylko wtedy, gdy forma płatności to "PersonalCheck"). |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Reference
|
reference | string |
Odwołanie do płatności (dotyczy tylko wtedy, gdy forma płatności to "Inne"). |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Czy jest anonimowy?
|
is_anonymous | boolean |
Czy prezent jest anonimowy? Jeśli nie zostanie podana żadna wartość, zostanie użyta domyślna anonimowość dawcy. |
|
|
Podtyp
|
subtype | string |
Podtyp daru. |
|
|
Comment
|
reference | string |
Uwagi do śledzenia specjalnych szczegółów dotyczących prezentu, takich jak motywacja za nim lub szczegółowy opis prezentu. |
|
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla prezentu. |
|
|
Czy używać środków pozyskiwania funduszy?
|
default_fundraiser_credits | boolean |
Czy użyć domyślnych środków pozyskiwania funduszy? |
|
|
Czy używać środków nietrwałych?
|
default_soft_credits | boolean |
Czy używać domyślnych środków nietrwałych? |
|
|
Okręg wyborczy
|
constituency | string |
Okręg wyborczy daru. |
|
|
Stan wpisu
|
post_status | string |
Status post prezentu. |
|
|
Data pośmiertna
|
post_date | date |
Data opublikowania prezentu (np. "2020-09-18"). |
|
|
Stan potwierdzenia
|
status | True | string |
Status odbioru prezentu. |
|
Kwota paragonu
|
value | True | double |
Kwota otrzymania prezentu. |
|
Data przyjęcia
|
date | date |
Data otrzymania prezentu (np. "2020-09-18"). |
Zwraca
Zawiera kolekcję rekordów błędów prezentów wsadowych i prezentów wsadowych dodanych przez operację
- Results
- GiftApi.BatchGiftAddResults
List pledge raty
Zawiera listę rat dla zobowiązania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zastawu
|
gift_id | True | string |
Identyfikator rekordu systemu zobowiązania. |
Zwraca
Ratach
Lista deklaracji podatkowych składowych
Zawiera listę deklaracji podatkowych pomocy prezentowej dla wyborców (dotyczy tylko wersji brytyjskich).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | integer |
Identyfikator rekordu systemu składnika. |
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Nie ma maksymalnej wartości. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
Zwraca
Deklaracje podatkowe
Lista hołd prezentów przyznaje
Wymienić uznanie za hołd prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator hołdu prezentu
|
gift_tribute_id | True | integer |
Identyfikator rekordu systemu hołdu prezentowego. |
Zwraca
Hołd prezentowy przyznaje
Lista hołdów prezentów
Wymienia hołdy dla prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator prezentu
|
gift_id | True | integer |
Identyfikator rekordu systemowego prezentu. |
Zwraca
Hołdy prezentowe
Lista notatek upominkowych
Wyświetla listę notatek dla prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator prezentu
|
gift_id | True | integer |
Identyfikator rekordu systemowego prezentu. |
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
Zwraca
Notatki z prezentów
Lista partii prezentów
Wyświetl listę partii prezentów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer partii
|
batch_number | string |
Reprezentuje filtr wyników pasujących do określonej liczby. |
|
|
Zatwierdzony?
|
approved | boolean |
Reprezentuje filtr stanu partii prezentów. |
|
|
Czy wyjątki?
|
has_exceptions | boolean |
Reprezentuje filtr, czy partia prezentów zawiera wyjątki. |
|
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 5000. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
|
|
Tekst wyszukiwania
|
search_text | string |
Reprezentuje filtr tekstu zawartego w polach opisu wsadowego lub numeru partii. |
|
|
Utworzone przez
|
created_by | string |
Reprezentuje filtr dla partii prezentów utworzonych przez określonego użytkownika. |
Zwraca
Partie prezentów
Lista prezentów
Zwraca listę prezentów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
List
|
list_id | string |
Definiuje identyfikator listy używany do filtrowania zestawu prezentów na te uwzględnione na określonej liście. Jeśli ta wartość zostanie ustawiona, inne określone filtry zostaną zignorowane. |
|
|
Typ
|
gift_type | string |
Reprezentuje rozdzielaną przecinkami listę typów prezentów do filtrowania wyników. Na przykład wyrażenie "MatchingGiftPledge,RecurringGift" zwraca tylko prezenty typu MatchingGiftPledge lub RecurringGift. |
|
|
Identyfikator składowy
|
constituent_id | string |
Reprezentuje rozdzielaną przecinkami listę identyfikatorów rekordów systemu składowego w celu filtrowania wyników. Na przykład "280,1232" zwraca tylko prezenty od wyborców 280 lub składowych 1232. |
|
|
Identyfikator kampanii
|
campaign_id | string |
Reprezentuje rozdzielaną przecinkami listę identyfikatorów rekordów systemu kampanii w celu filtrowania wyników. Na przykład "506 918" zwraca tylko prezenty do kampanii 506 lub kampanii 918. |
|
|
Identyfikator funduszu
|
fund_id | string |
Reprezentuje rozdzielaną przecinkami listę identyfikatorów rekordów systemu funduszu w celu filtrowania wyników. Na przykład "506 918" zwraca tylko prezenty do finansowania 506 lub funduszu 918. |
|
|
Identyfikator odwołania
|
appeal_id | string |
Reprezentuje rozdzielaną przecinkami listę identyfikatorów rekordów systemu odwołania w celu filtrowania wyników. Na przykład "506,918" zwraca tylko prezenty odwołania 506 lub odwołania 918. |
|
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 5000. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
|
|
Data rozpoczęcia prezentu
|
start_gift_date | date-time |
Reprezentuje filtr prezentów z datą prezentu w dniu lub po określonej dacie (np. "2020-09-18T04:13:56Z"). |
|
|
Data prezentu końcowego
|
end_gift_date | date-time |
Reprezentuje filtr prezentów z datą prezentu lub przed określoną datą (np. "2020-09-18T04:13:56Z"). |
|
|
Kwota prezentu startowego
|
start_gift_amount | double |
Reprezentuje filtr prezentów o wartości większej lub równej określonej wartości. |
|
|
Kwota prezentu końcowego
|
end_gift_amount | double |
Reprezentuje filtr prezentów o wartości mniejszej lub równej określonej wartości. |
|
|
Stan wpisu
|
post_status | string |
Reprezentuje rozdzielaną przecinkami listę stanów postów prezentowych w celu filtrowania wyników. Na przykład "DoNotPost", "Wysłana" zwraca tylko prezenty oznaczone jako DoNotPost lub Wysłana. |
|
|
Stan potwierdzenia
|
receipt_status | string |
Reprezentuje rozdzielaną przecinkami listę stanów paragonów prezentowych w celu filtrowania wyników. Na przykład "DoNotReceipt,Receipted" zwraca tylko prezenty oznaczone jako DoNotReceipt lub Receipted. |
|
|
Stan potwierdzenia
|
acknowledgement_status | string |
Reprezentuje rozdzielaną przecinkami listę stanów potwierdzenia prezentu w celu filtrowania wyników. Na przykład "DoNotAcknowledge", Potwierdzenie" zwraca tylko prezenty oznaczone jako DoNotAcknowledge lub Potwierdzone. |
|
|
Sortowane według
|
sort | string |
Reprezentuje listę pól do sortowania wyników według. Wyniki są domyślnie w kolejności rosnącej, a znak "-" oznacza kolejność malejącą. Na przykład "date_added", data sortuje prezenty według pola "date_added" w kolejności rosnącej, a następnie według pola "data prezentu" w kolejności malejącej. Jeśli zostanie podane tylko pole date_modified lub tylko pole date_added, spowoduje to dodanie parametru sort_token do adresu URL next_link w celu zapewnienia, że prezenty są odpowiednio posortowane. |
|
|
Dodano polecenie lub po
|
date_added | date-time |
Przefiltruj wyniki do prezentów utworzonych w określonym dniu lub po określonej dacie (np. "2020-09-18T04:13:56Z"). |
|
|
Zmodyfikowano w dniu lub po
|
last_modified | date-time |
Przefiltruj wyniki do prezentów zmodyfikowanych w określonym dniu lub po określonej dacie (np. "2020-09-18T04:13:56Z"). |
Zwraca
Prezenty
Lista załączników prezentów
Wyświetla listę załączników dla prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator prezentu
|
gift_id | True | string |
Identyfikator rekordu systemowego prezentu. |
Zwraca
Załączniki
Otrzymasz prezent
Zwraca informacje o prezentie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator prezentu
|
gift_id | True | string |
Identyfikator rekordu systemu prezentu, aby uzyskać. |
Zwraca
Prezent
- Body
- GiftApi.GiftRead
Pobierz najnowszy prezent dla wyborców
Zwraca najnowszy prezent dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
Zwraca
Podawanie podsumowania
Sprzedaż prezentu giełdowego
Aktualizuje prezent giełdowy do sprzedaży.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator prezentu
|
gift_id | True | string |
Identyfikator rekordu systemu prezentu giełdowego do sprzedaży. |
|
Data sprzedaży
|
stock_sale_date | True | date |
Data sprzedaży akcji (np. "2005-09-18"). |
|
Wartość sprzedaży
|
stock_sale_value | True | double |
Wartość sprzedaży akcji. |
|
Opłata za brokera
|
broker_fee | double |
Sprzedana opłata brokera giełdowego. |
|
|
Stan wpisu
|
post_status | string |
Status post sprzedanego prezentu. |
|
|
Data pośmiertna
|
post_date | date |
Data wysłana sprzedanej akcji (np. "2020-09-18"). |
|
|
Notatki
|
notes | string |
Noty dla sprzedanej akcji. Limit znaków: 255. |
|
|
Wystawca
|
issuer | string |
Wystawca akcji. |
|
|
Symbol wystawcy
|
symbol | string |
Symbol wystawcy akcji. |
|
|
Liczba jednostek
|
units | integer |
Liczba sprzedanych jednostek. |
|
|
Mediana ceny za jednostkę
|
unit_price | double |
Mediana ceny za jednostkę sprzedana. |
Tworzenie deklaracji podatkowej składowej
Tworzy nową deklarację podatku od pomocy prezentowej dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | integer |
Identyfikator rekordu systemu składnika. |
|
Rozpoczyna się deklaracja
|
declaration_starts | True | date-time |
Data rozpoczęcia deklaracji podatkowej (np. "2020-09-18T04:13:56Z"). |
|
Końce deklaracji
|
declaration_ends | date-time |
Data zakończenia deklaracji podatkowej (np. "2020-09-18T04:13:56Z"). |
|
|
Deklaracja dokonana
|
declaration_made | date-time |
Data złożenia deklaracji podatkowej (np. "2020-09-18T04:13:56Z"). |
|
|
Indicator
|
declaration_indicator | string |
Wskaźnik deklaracji. |
|
|
Źródło
|
declaration_source | string |
Źródło deklaracji. |
|
|
Wysłane potwierdzenie
|
confirmation_sent | date-time |
Data wysłania potwierdzenia (np. "2020-09-18T04:13:56Z"). |
|
|
Zwrócone potwierdzenie
|
confirmation_returned | date-time |
Data zwrócenia potwierdzenia (np. "2020-09-18T04:13:56Z"). |
|
|
Płaci podatek
|
constituent_pays_tax | string |
Wskazuje, czy składnik płaci podatek. |
|
|
Status
|
tax_payer_status | string |
Status płatnika podatku. |
|
|
Comments
|
tax_notes | string |
Uwagi dotyczące deklaracji podatkowej. |
|
|
Kolejność
|
sequence | integer |
Sekwencja liczbowa skojarzona z deklaracją podatkową. |
Zwraca
Utworzono deklarację podatkową
Tworzenie hołdu prezentowego
Tworzy nowy hołd prezentowy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator prezentu
|
gift_id | True | integer |
Identyfikator rekordu systemowego prezentu skojarzonego z hołdem prezentu. |
|
Identyfikator hołdu
|
tribute_id | True | integer |
Identyfikator rekordu systemu hołdu związanego z hołdem prezentu. |
Zwraca
Utworzony hołd prezentu
Tworzenie notatki z prezentu
Tworzy nową notatkę prezentową.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator prezentu
|
gift_id | True | integer |
Identyfikator rekordu systemowego prezentu skojarzonego z notatką. |
|
Typ
|
note_type_id | True | integer |
Typ notatki. |
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Podsumowanie
|
summary | string |
Podsumowanie notatki. Limit znaków: 255. |
|
|
Uwaga / Notatka
|
text | string |
Tekst notatki. |
|
|
Author
|
author | string |
Autor notatki. Limit znaków: 50. |
Zwraca
Utworzono notatkę
Tworzenie partii prezentów
Tworzy nową partię prezentów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Description
|
batch_description | string |
Opis partii. |
|
|
Oczekiwana liczba
|
expected_number | integer |
Liczba prezentów oczekiwana w partii. |
|
|
Oczekiwana suma
|
expected_batch_total | double |
Łączna wartość prezentów w partii. |
|
|
Numer partii
|
batch_number | string |
Unikatowy identyfikator specyficzny dla partii. |
Zwraca
Utworzono partię prezentów
Tworzenie pola niestandardowego prezentu
Tworzy nowe pole niestandardowe prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Obiekt reprezentujący pole niestandardowe do utworzenia. |
Zwraca
Utworzone pole niestandardowe prezentu
Tworzenie prezentu
Tworzy nowy prezent.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemowego składnika skojarzonego z prezentem. |
|
Kwota
|
value | True | double |
Ilość prezentu. |
|
Date
|
date | True | date |
Data prezentu (np. "2020-09-18"). |
|
Typ
|
type | True | string |
Typ prezentu. |
|
identyfikator kampanii
|
campaign_id | string |
Identyfikator rekordu systemowego kampanii skojarzonej z podziałem prezentu. |
|
|
identyfikator funduszu
|
fund_id | True | string |
Identyfikator rejestru systemu funduszu skojarzonego z podziałem prezentu. |
|
identyfikator odwołania
|
appeal_id | string |
Identyfikator rekordu systemowego odwołania skojarzonego z podziałem prezentu. |
|
|
identyfikator pakietu
|
package_id | string |
Identyfikator rekordu systemowego pakietu skojarzonego z podziałem prezentu. |
|
|
kwota
|
value | True | double |
Kwota podziału prezentu. |
|
Forma płatności
|
payment_method | True | string |
Forma płatności. |
|
Numer kontrolny
|
check_number | string |
Numer kontrolny (dotyczy tylko wtedy, gdy forma płatności to "PersonalCheck"). |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Reference
|
reference | string |
Odwołanie do płatności (dotyczy tylko wtedy, gdy forma płatności to "Inne"). |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Czy jest anonimowy?
|
is_anonymous | boolean |
Czy prezent jest anonimowy? Jeśli nie zostanie podana żadna wartość, zostanie użyta domyślna anonimowość dawcy. |
|
|
Podtyp
|
subtype | string |
Podtyp daru. |
|
|
Comment
|
reference | string |
Uwagi do śledzenia specjalnych szczegółów dotyczących prezentu, takich jak motywacja za nim lub szczegółowy opis prezentu. |
|
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla prezentu. |
|
|
Czy używać środków pozyskiwania funduszy?
|
default_fundraiser_credits | boolean |
Czy użyć domyślnych środków pozyskiwania funduszy? |
|
|
Czy używać środków nietrwałych?
|
default_soft_credits | boolean |
Czy używać domyślnych środków nietrwałych? |
|
|
Okręg wyborczy
|
constituency | string |
Okręg wyborczy daru. |
|
|
Prefiks usługi Batch
|
batch_prefix | string |
Prefiks do użycia dla prezentów wsadowych. Musi ona zawierać co najmniej jedną literę i jest wymagana, gdy wartość ma wartość "Numer partii". |
|
|
Numer partii
|
batch_number | string |
Numer partii. Limit znaków: 50 (w tym prefiks partii). |
|
|
Stan wpisu
|
post_status | string |
Status post prezentu. |
|
|
Data pośmiertna
|
post_date | date |
Data opublikowania prezentu (np. "2020-09-18"). |
|
|
Stan potwierdzenia
|
status | True | string |
Status odbioru prezentu. |
|
Kwota paragonu
|
value | True | double |
Kwota otrzymania prezentu. |
|
Data przyjęcia
|
date | date |
Data otrzymania prezentu (np. "2020-09-18"). |
Zwraca
Utworzony prezent
- Body
- GiftApi.CreatedGift
Tworzenie prezentu stockowego
Tworzy nowy prezent na czas.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
id | True | string |
Identyfikator rekordu systemu składnika. |
|
Kwota
|
value | True | double |
Ilość prezentu. |
|
Date
|
gift_date | True | date |
Data prezentu (np. "2020-09-18"). |
|
Wystawca
|
issuer | string |
Wystawca akcji. |
|
|
Symbol wystawcy
|
symbol | string |
Symbol wystawcy akcji. |
|
|
Liczba jednostek
|
units | integer |
Liczba jednostek zapasów. |
|
|
Mediana ceny za jednostkę
|
unit_price | double |
Mediana ceny za jednostkę. |
|
|
kwota
|
value | True | double |
Kwota podziału prezentu. |
|
identyfikator funduszu
|
fund_id | True | string |
Identyfikator rejestru systemu funduszu skojarzonego z podziałem prezentu. |
|
identyfikator kampanii
|
campaign_id | string |
Identyfikator rekordu systemowego kampanii skojarzonej z podziałem prezentu. |
|
|
identyfikator odwołania
|
appeal_id | string |
Identyfikator rekordu systemowego odwołania skojarzonego z podziałem prezentu. |
|
|
identyfikator pakietu
|
package_id | string |
Identyfikator rekordu systemowego pakietu skojarzonego z podziałem prezentu. |
|
|
Forma płatności
|
method | True | string |
Forma płatności. |
|
Numer kontrolny
|
check_number | string |
Numer kontrolny. |
|
|
Reference
|
reference_number | string |
Odwołanie do płatności (dotyczy tylko wtedy, gdy forma płatności to "Inne"). |
|
|
Czy jest anonimowy?
|
anonymous | boolean |
Czy prezent jest anonimowy? Jeśli nie zostanie podana żadna wartość, zostanie użyta domyślna anonimowość dawcy. |
|
|
Podtyp
|
name | string |
Podtyp daru. |
|
|
Comment
|
comments | string |
Uwagi do śledzenia specjalnych szczegółów dotyczących prezentu, takich jak motywacja za nim. |
|
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla prezentu. |
|
|
Kod prezentu
|
value | string |
Kod prezentu związany z darem. |
|
|
Okręg wyborczy
|
value | string |
Okręg wyborczy daru. |
|
|
Stan wpisu
|
gift_post_status | string |
Status post prezentu. |
|
|
Data pośmiertna
|
gift_post_date | date |
Data opublikowania prezentu (np. "2020-09-18"). |
|
|
Stan potwierdzenia
|
receipt_status | True | string |
Status odbioru prezentu. |
|
Kwota paragonu
|
value | True | double |
Kwota otrzymania prezentu. |
|
Data przyjęcia
|
receipt_date | date |
Data otrzymania prezentu (np. "2020-09-18"). |
|
|
Numer paragonu
|
receipt_number | integer |
Numer paragonu. |
|
|
Stos paragonów
|
value | string |
Stos paragonu. |
|
|
Stan potwierdzenia
|
status | True | string |
Status potwierdzenia prezentu. |
|
Data potwierdzenia
|
acknowledgement_date | date |
Data uznania prezentu (np. "2020-09-18"). |
|
|
List
|
value | string |
List skojarzony z potwierdzeniem. |
|
|
typ
|
credit_type | True | string |
Typ środków rozpoznawania. |
|
identyfikator adresata
|
constituent_id | True | string |
Identyfikator rekordu systemowego odbiorcy środków rozpoznawania. |
|
kwota
|
value | True | double |
Kwota środków na odbiorcę. |
Zwraca
Utworzony prezent
- Body
- GiftApi.CreatedGift
Tworzenie płatności zastaw
Tworzy nową płatność zastaw.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
id | True | string |
Identyfikator rekordu systemu składnika. |
|
Kwota
|
value | True | double |
Kwota płatności zastawu. |
|
Date
|
gift_date | True | date |
Data płatności zastawu (np. "2020-09-18"). |
|
kwota
|
value | True | double |
Kwota podziału prezentu. |
|
identyfikator funduszu
|
fund_id | True | string |
Identyfikator rejestru systemu funduszu skojarzonego z podziałem prezentu. |
|
identyfikator kampanii
|
campaign_id | string |
Identyfikator rekordu systemowego kampanii skojarzonej z podziałem prezentu. |
|
|
identyfikator odwołania
|
appeal_id | string |
Identyfikator rekordu systemowego odwołania skojarzonego z podziałem prezentu. |
|
|
identyfikator pakietu
|
package_id | string |
Identyfikator rekordu systemowego pakietu skojarzonego z podziałem prezentu. |
|
|
Forma płatności
|
method | True | string |
Forma płatności. |
|
Numer kontrolny
|
check_number | string |
Numer kontrolny. |
|
|
Reference
|
reference_number | string |
Odwołanie do płatności (dotyczy tylko wtedy, gdy forma płatności to "Inne"). |
|
|
Czy jest anonimowy?
|
anonymous | boolean |
Czy prezent jest anonimowy? Jeśli nie zostanie podana żadna wartość, zostanie użyta domyślna anonimowość dawcy. |
|
|
zastaw
|
pledge_id | string |
Identyfikator rekordu systemu zapłaconego zobowiązania. |
|
|
rata
|
installment_id | string |
Identyfikator rekordu systemu płatnej raty. |
|
|
kwota
|
amount_applied | double |
Kwota zastosowana do raty. |
|
|
Podtyp
|
name | string |
Podtyp daru. |
|
|
Comment
|
comments | string |
Uwagi do śledzenia specjalnych szczegółów dotyczących prezentu, takich jak motywacja za nim. |
|
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla prezentu. |
|
|
Kod prezentu
|
value | string |
Kod prezentu związany z darem. |
|
|
Okręg wyborczy
|
value | string |
Okręg wyborczy daru. |
|
|
Stan wpisu
|
gift_post_status | string |
Status post prezentu. |
|
|
Data pośmiertna
|
gift_post_date | date |
Data opublikowania prezentu (np. "2020-09-18"). |
|
|
Stan potwierdzenia
|
receipt_status | True | string |
Status odbioru prezentu. |
|
Kwota paragonu
|
value | True | double |
Kwota otrzymania prezentu. |
|
Data przyjęcia
|
receipt_date | date |
Data otrzymania prezentu (np. "2020-09-18"). |
|
|
Numer paragonu
|
receipt_number | integer |
Numer paragonu. |
|
|
Stos paragonów
|
value | string |
Stos paragonu. |
|
|
Stan potwierdzenia
|
status | True | string |
Status potwierdzenia prezentu. |
|
Data potwierdzenia
|
acknowledgement_date | date |
Data uznania prezentu (np. "2020-09-18"). |
|
|
List
|
value | string |
List skojarzony z potwierdzeniem. |
|
|
typ
|
credit_type | True | string |
Typ środków rozpoznawania. |
|
identyfikator adresata
|
constituent_id | True | string |
Identyfikator rekordu systemowego odbiorcy środków rozpoznawania. |
|
kwota
|
value | True | double |
Kwota środków na odbiorcę. |
Zwraca
Utworzony prezent
- Body
- GiftApi.CreatedGift
Tworzenie załącznika prezentu
Tworzy nowy załącznik prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator prezentu
|
parent_id | True | string |
Identyfikator rekordu systemowego prezentu skojarzonego z załącznikiem. |
|
Typ
|
type | True | string |
Typ załącznika. Fizyczne załączniki są przekazywane, takie jak obrazy, pliki PDF lub dokumenty programu Word zapisywane lokalnie lub w sieci. Są one przechowywane i zarządzane w systemie. Załączniki linków to linki do plików, takich jak obrazy, wpisy w blogu lub filmy wideo w serwisie YouTube, które są w trybie online lub na koncie magazynu w chmurze. Są one przechowywane i zarządzane zewnętrznie. |
|
Name
|
name | string |
Nazwa załącznika. Limit znaków: 150. |
|
|
Date
|
date | date-time |
Data załącznika (np. "2020-09-18T04:13:56Z"). To pole domyślnie jest domyślnie ustawiona na bieżącą datę i godzinę, jeśli nie zostanie podana. |
|
|
adres URL
|
url | string |
Adres URL załącznika. Jest to wymagane w przypadku załączników linków i nie dotyczy załączników fizycznych. |
|
|
Nazwa pliku
|
file_name | string |
Nazwa pliku. Limit znaków: 36. Tylko w przypadku załączników fizycznych. |
|
|
Identyfikator pliku
|
file_id | string |
Identyfikator pliku. Limit znaków: 36. Tylko w przypadku załączników fizycznych. |
|
|
Identyfikator miniatury
|
thumbnail_id | string |
Identyfikator miniatury. Limit znaków: 36. Tylko w przypadku załączników fizycznych. |
|
|
Etykiety
|
tags | array of string |
Tagi skojarzone z załącznikiem. |
Zwraca
Utworzono załącznik prezentu
Tworzenie zobowiązania
Tworzy nowe zobowiązanie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
id | True | string |
Identyfikator rekordu systemu składnika. |
|
Kwota
|
value | True | double |
Kwota zobowiązania. |
|
Date
|
gift_date | True | date |
Data zobowiązania (np. "2020-09-18"). |
|
Częstotliwość
|
frequency | True | string |
Częstotliwość rat dla zobowiązania. |
|
Liczba rat
|
number_of_installments | True | integer |
Liczba rat dla zobowiązania. |
|
Data rozpoczęcia
|
start_date | True | date |
Data rozpoczęcia harmonogramu zastawu. |
|
kwota
|
value | True | double |
Kwota podziału prezentu. |
|
identyfikator funduszu
|
fund_id | True | string |
Identyfikator rejestru systemu funduszu skojarzonego z podziałem prezentu. |
|
identyfikator kampanii
|
campaign_id | string |
Identyfikator rekordu systemowego kampanii skojarzonej z podziałem prezentu. |
|
|
identyfikator odwołania
|
appeal_id | string |
Identyfikator rekordu systemowego odwołania skojarzonego z podziałem prezentu. |
|
|
identyfikator pakietu
|
package_id | string |
Identyfikator rekordu systemowego pakietu skojarzonego z podziałem prezentu. |
|
|
Forma płatności
|
method | True | string |
Forma płatności. |
|
Numer kontrolny
|
check_number | string |
Numer kontrolny. |
|
|
Reference
|
reference_number | string |
Odwołanie do płatności (dotyczy tylko wtedy, gdy forma płatności to "Inne"). |
|
|
Wyślij przypomnienie?
|
send_reminder | boolean |
Wysyłaj przypomnienia dotyczące zastawu? |
|
|
Czy jest anonimowy?
|
anonymous | boolean |
Czy prezent jest anonimowy? Jeśli nie zostanie podana żadna wartość, zostanie użyta domyślna anonimowość dawcy. |
|
|
Podtyp
|
name | string |
Podtyp daru. |
|
|
Comment
|
comments | string |
Uwagi do śledzenia specjalnych szczegółów dotyczących prezentu, takich jak motywacja za nim. |
|
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla prezentu. |
|
|
Kod prezentu
|
value | string |
Kod prezentu związany z darem. |
|
|
Okręg wyborczy
|
value | string |
Okręg wyborczy daru. |
|
|
Stan wpisu
|
gift_post_status | string |
Status post prezentu. |
|
|
Data pośmiertna
|
gift_post_date | date |
Data opublikowania prezentu (np. "2020-09-18"). |
|
|
Status
|
gift_status | string |
Stan zobowiązania. |
|
|
day
|
d | integer |
Dzień w dacie rozmytej. |
|
|
miesiąca
|
m | integer |
Miesiąc w dacie rozmytej. |
|
|
rok
|
y | integer |
Rok w dacie rozmytej. |
|
|
Stan potwierdzenia
|
receipt_status | True | string |
Status odbioru prezentu. |
|
Kwota paragonu
|
value | True | double |
Kwota otrzymania prezentu. |
|
Data przyjęcia
|
receipt_date | date |
Data otrzymania prezentu (np. "2020-09-18"). |
|
|
Numer paragonu
|
receipt_number | integer |
Numer paragonu. |
|
|
Stos paragonów
|
value | string |
Stos paragonu. |
|
|
Stan potwierdzenia
|
status | True | string |
Status potwierdzenia prezentu. |
|
Data potwierdzenia
|
acknowledgement_date | date |
Data uznania prezentu (np. "2020-09-18"). |
|
|
List
|
value | string |
List skojarzony z potwierdzeniem. |
|
|
typ
|
credit_type | True | string |
Typ środków rozpoznawania. |
|
identyfikator adresata
|
constituent_id | True | string |
Identyfikator rekordu systemowego odbiorcy środków rozpoznawania. |
|
kwota
|
value | True | double |
Kwota środków na odbiorcę. |
|
date
|
date | date |
Data raty (np. "2020-09-18"). |
|
|
kwota
|
amount | double |
Kwota raty. |
Zwraca
Utworzony prezent
- Body
- GiftApi.CreatedGift
Uzyskaj pierwszy prezent składników
Zwraca pierwszy prezent dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
Zwraca
Podawanie podsumowania
Uzyskiwanie prezentu według identyfikatora odnośnika
Zwraca identyfikator rekordu systemowego prezentu z określonego identyfikatora odnośnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator odnośnika
|
giftlookupid | True | string |
Identyfikator odnośnika prezentu. |
Zwraca
Mapa identyfikatora prezentu
Uzyskiwanie składowego okresu istnienia dającego
Zwraca okres istnienia dając podsumowanie dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
Zwraca
Okres istnienia dający
Uzyskuj prezent najwspanialszy
Zwraca największy prezent dla składnika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator składowy
|
constituent_id | True | string |
Identyfikator rekordu systemu składnika. |
Zwraca
Podawanie podsumowania
Wyświetlanie listy pól niestandardowych prezentów
Wyświetla listę pól niestandardowych dla prezentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator prezentu
|
gift_id | True | string |
Identyfikator rekordu systemowego prezentu. |
Zwraca
Pola niestandardowe
Wyświetlanie listy płatności zastawnych
Wyświetla listę płatności za zobowiązanie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zastawu
|
gift_id | True | string |
Identyfikator rekordu systemu zobowiązania. |
Zwraca
Payments
Definicje
ConstituentApi.AppealRead
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rejestru systemowego odwołania. |
|
opis
|
description | string |
Opis odwołania. |
ConstituentApi.CampaignRead
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu kampanii. |
|
opis
|
description | string |
Opis kampanii. |
SkładnikApi.FundRead
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rejestru systemu funduszu. |
|
opis
|
description | string |
Opis funduszu. |
ConstituentApi.GivingSummaryRead
Podawanie podsumowania
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego prezentu. |
|
Typ
|
type | string |
Typ prezentu. |
|
Date
|
date | date-time |
Data prezentu. |
|
value
|
amount.value | double |
Ilość prezentu. |
|
Appeal
|
appeals | array of ConstituentApi.AppealRead |
Zestaw odwołań związanych z darem. |
|
Campaign
|
campaigns | array of ConstituentApi.CampaignRead |
Zestaw kampanii związanych z prezentem. |
|
Fundusz
|
funds | array of ConstituentApi.FundRead |
Zestaw funduszy związanych z prezentem. |
ConstituentApi.LifetimeGivingRead
Okres istnienia dający
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kolejne lata podane
|
consecutive_years_given | integer |
Liczba kolejnych lat, które podał składnik. |
|
Łączna liczba lat
|
total_years_given | integer |
Całkowita liczba lat, na które podaje się składnik. |
|
value
|
total_giving.value | double |
Łączna kwota podana przez składnik. |
|
value
|
total_pledge_balance.value | double |
Łączne niezapłacone saldo zobowiązania dla składnika. |
|
value
|
total_received_giving.value | double |
Całkowita otrzymana kwota podana przez składnik. |
|
value
|
total_committed_matching_gifts.value | double |
To obliczone pole oblicza łączną kwotę zgodnych zobowiązań prezentowych przypisanych składnikowi. |
|
value
|
total_received_matching_gifts.value | double |
Łączna kwota płatności w stosunku do zgodnych zobowiązań prezentowych przypisanych składnikowi. |
|
value
|
total_soft_credits.value | double |
Łączna kwota środków miękkich zastosowanych do składnika. |
GiftApi.AcknowledgementRead
Uznanie
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
date
|
date | date-time |
Data skojarzona z potwierdzeniem. |
|
litera
|
letter | string |
List skojarzony z potwierdzeniem. |
|
stan
|
status | string |
Stan potwierdzenia. Dostępne wartości to: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT i DONOTACKNOWLEDGE. |
GiftApi.ApiCollectionOfGiftAttachmentRead
Załączniki
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości. |
|
value
|
value | array of GiftApi.GiftAttachmentRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
GiftApi.ApiCollectionOfGiftCustomFieldRead
Pola niestandardowe
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości. |
|
value
|
value | array of GiftApi.GiftCustomFieldRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
GiftApi.ApiCollectionOfGiftRead
Prezenty
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości. |
|
value
|
value | array of GiftApi.GiftRead |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
GiftApi.BatchGiftAddResults
Zawiera kolekcję rekordów błędów prezentów wsadowych i prezentów wsadowych dodanych przez operację
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Błędy
|
errors | array of GiftApi.GiftBatchGiftError |
Błędy prezentu wsadowego skojarzone z operacją dodawania prezentu wsadowego |
|
Prezenty
|
gifts | array of GiftApi.BatchGiftRead |
Kolekcja prezentów wsadowych, które zostały dodane przez operację dodawania prezentu wsadowego |
GiftApi.GiftBatchGiftError
Reprezentuje wyjątki uniemożliwiające dodawanie elementów do partii.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
pole, którego dotyczy problem
|
affected_field | string |
Pole, którego dotyczy błąd |
|
identyfikator partii
|
batch_id | string |
Identyfikator rekordu systemu partii |
|
kod błędu wyjątku
|
exception_error_code | integer |
Kod błędu wyjątku |
|
komunikat o błędzie wyjątku
|
exception_error_message | string |
Komunikat o błędzie wyjątku |
|
nazwa błędu wyjątku
|
exception_error_name | string |
Nazwa błędu wyjątku |
|
identyfikator prezentu
|
gift_id | string |
Identyfikator rekordu systemowego prezentu |
|
identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla prezentu. |
GiftApi.BatchGiftRead
Prezent wsadowy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator partii
|
batch_id | string |
Identyfikator partii, do której dodano prezent. |
|
Błędy
|
errors | array of GiftApi.GiftBatchGiftError |
Błędy związane z prezentem wsadowym. |
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego prezentu wsadowego. |
|
identyfikator składnika
|
constituent_id | string |
Identyfikator rekordu systemowego składnika skojarzonego z prezentem. |
|
typ
|
type | string |
Typ prezentu. |
|
Podtypu
|
subtype | string |
Podtyp daru. |
|
date
|
date | date-time |
Data prezentu. |
|
value
|
amount.value | double |
Ilość prezentu. |
|
value
|
balance.value | double |
Równowaga pozostała na darze. |
|
numer partii
|
batch_number | string |
Numer partii skojarzony z tym prezentem. |
|
stan
|
gift_status | string |
Status prezentu. |
|
anonimowy?
|
is_anonymous | boolean |
Czy prezent jest anonimowy? |
|
grupa
|
constituency | string |
Okręg wyborczy daru. |
|
identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla prezentu. |
|
źródło
|
origin | string |
Początek daru. |
|
stan wpisu
|
post_status | string |
Ogólny rejestr po statusie prezentu. Dostępne wartości to Wysłana, NotPosted i DoNotPost. Jeśli post_status jest ustawiona na DoNotPost>, post_date powinna mieć wartość null. Gdy jest ustawiona wartość NotPosted, post_date jest wymagana, ale pozostaje edytowalna. Po ustawieniu opcji Wysłana post_date jest wymagana i nie jest już edytowalna. |
|
data zakończenia
|
post_date | date-time |
Data opublikowania prezentu w rejestrze ogólnym. |
|
odwołanie
|
reference | string |
Uwagi do śledzenia specjalnych szczegółów dotyczących prezentu, takich jak motywacja za nim lub szczegółowy opis prezentu. |
|
day
|
recurring_gift_status_date.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
recurring_gift_status_date.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
recurring_gift_status_date.y | integer |
Rok w dacie rozmytej. |
|
częstotliwość
|
recurring_gift_schedule.frequency | string |
Częstotliwość raty cyklicznego prezentu do wyświetlenia. Dostępne wartości to COTYGODNIOWE, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MIESIĘCZNE, KWARTALNE, ROCZNIE. |
|
start
|
recurring_gift_schedule.start_date | date-time |
Data rozpoczęcia prezentu cyklicznego. |
|
koniec
|
recurring_gift_schedule.end_date | date-time |
Data zakończenia prezentu cyklicznego. |
|
value
|
gift_aid_amount.value | double |
To obliczone pole oblicza łączną kwalifikowaną kwotę podatku odzyskanego od pomocy prezentowej na wszystkich gift_splits dla tego prezentu. Tylko dla Wielkiej Brytanii. |
|
status kwalifikacji pomocy prezentowej
|
gift_aid_qualification_status | string |
To obliczone pole określa stan kwalifikacji pomocy prezentowej na podstawie informacji podatkowych i formatu bazy danych. Dostępne wartości to: Kwalifikowana, NotQualified i CzęściowoKwalifikowana. Tylko dla Wielkiej Brytanii. |
|
kod prezentu
|
gift_code | string |
Wartość kodu prezentu skojarzona z prezentem. |
|
podziały prezentów
|
gift_splits | array of GiftApi.GiftSplitRead |
Zestaw prezentów dzieli się z darem. |
|
zbiórki pieniędzy
|
fundraisers | array of GiftApi.GiftFundraiserRead |
Zestaw fundraisers, którzy otrzymują kredyt na prezent. |
|
Środki nietrwałe
|
soft_credits | array of GiftApi.SoftCreditRead |
Zestaw kredytów miękkich związanych z prezentem. |
|
Rachunki
|
receipts | array of GiftApi.ReceiptRead |
Zestaw wpływów związanych z prezentem. |
|
Potwierdzenia
|
acknowledgements | array of GiftApi.AcknowledgementRead |
Zestaw potwierdzeń związanych z darem. |
|
Payments
|
payments | array of GiftApi.PaymentRead |
Płatności na prezent. |
|
Połączone prezenty
|
linked_gifts | array of string |
Identyfikatory innych prezentów, które są związane z tym darem. |
|
Data dodania
|
date_added | date-time |
Data utworzenia prezentu. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji prezentu. |
GiftApi.CreatedGift
Utworzony prezent
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego prezentu. |
GiftApi.CreatedGiftAttachment
Utworzono załącznik prezentu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego załącznika prezentu. |
GiftApi.CreatedGiftCustomField
Utworzone pole niestandardowe prezentu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego pola niestandardowego prezentu. |
GiftApi.GiftAttachmentRead
Załącznik
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu załącznika. |
|
Identyfikator prezentu
|
parent_id | string |
Identyfikator rekordu systemowego prezentu skojarzonego z załącznikiem. |
|
Typ
|
type | string |
Typ załącznika. Fizyczne załączniki są przekazywane, takie jak obrazy, pliki PDF lub dokumenty programu Word zapisywane lokalnie lub w sieci. Są one przechowywane i zarządzane w systemie. Załączniki linków to linki do plików, takich jak obrazy, wpisy w blogu lub filmy wideo w serwisie YouTube, które są w trybie online lub na koncie magazynu w chmurze. Są one przechowywane i zarządzane zewnętrznie. |
|
Name
|
name | string |
Nazwa załącznika. Limit znaków: 150. |
|
Date
|
date | date-time |
Data załącznika. |
|
adres URL
|
url | string |
Adres URL załącznika. Jest to wymagane w przypadku załączników linków i nie dotyczy załączników fizycznych. |
|
Nazwa pliku
|
file_name | string |
Nazwa pliku. Limit znaków: 36. Tylko w przypadku załączników fizycznych. |
|
Identyfikator pliku
|
file_id | string |
Identyfikator pliku. Limit znaków: 36. Tylko w przypadku załączników fizycznych. |
|
Identyfikator miniatury
|
thumbnail_id | string |
Identyfikator miniatury. Limit znaków: 36. Tylko w przypadku załączników fizycznych. |
|
Adres URL miniatury
|
thumbnail_url | string |
Adres URL miniatury. W przypadku załączników fizycznych, które są tylko obrazami. Zawiera sygnaturę związaną z czasem, która ogranicza dostęp do 60 minut. |
|
Typ zawartości
|
content_type | string |
Typ zawartości. Tylko w przypadku załączników fizycznych. |
|
Rozmiar pliku
|
file_size | integer |
Rozmiar pliku w bajtach. Tylko w przypadku załączników fizycznych. |
|
Etykiety
|
tags | array of string |
Tagi skojarzone z załącznikiem. |
GiftApi.GiftCustomFieldRead
Pole niestandardowe
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego pola niestandardowego. |
|
Identyfikator prezentu
|
parent_id | string |
Identyfikator rekordu systemowego prezentu skojarzonego z polem niestandardowym. |
|
Kategoria
|
category | string |
Kategoria pola niestandardowego. |
|
Typ
|
type | string |
Typ danych reprezentowanych przez pole niestandardowe. |
|
Wartość
|
value |
Wartość pola niestandardowego. |
|
|
Wartość tekstowa
|
text_value | string |
Wartość tekstowa pola niestandardowego. |
|
Wartość liczbowa
|
number_value | integer |
Wartość liczbowa pola niestandardowego. |
|
Wartość daty
|
date_value | date |
Wartość daty pola niestandardowego. |
|
Wartość waluty
|
currency_value | double |
Wartość waluty pola niestandardowego. |
|
Wartość logiczna
|
boolean_value | boolean |
Wartość logiczna pola niestandardowego. |
|
Wartość wpisu tabeli
|
codetableentry_value | string |
Wartość wpisu tabeli pola niestandardowego. |
|
Wartość identyfikatora składnika
|
constituentid_value | string |
Wartość identyfikatora składowego pola niestandardowego. |
|
day
|
fuzzydate_value.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
fuzzydate_value.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
fuzzydate_value.y | integer |
Rok w dacie rozmytej. |
|
Date
|
date | date |
Data w polu niestandardowym. |
|
Comment
|
comment | string |
Komentarz do pola niestandardowego. Limit znaków: 50. |
|
Data dodania
|
date_added | date-time |
Data utworzenia pola niestandardowego. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji pola niestandardowego. |
GiftApi.GiftFundraiserRead
Fundraiser prezentów
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
value
|
amount.value | double |
Kwota kredytowa na zbiórkę pieniędzy na prezent. |
|
identyfikator zbiórki pieniędzy
|
constituent_id | string |
Identyfikator rekordu systemu składowego dla zbiórki pieniędzy skojarzonej z prezentem. |
GiftApi.GiftRead
Prezent
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego prezentu. |
|
Identyfikator składowy
|
constituent_id | string |
Identyfikator rekordu systemowego składnika skojarzonego z prezentem. |
|
Typ
|
type | string |
Typ prezentu. |
|
Podtyp
|
subtype | string |
Podtyp daru. |
|
Date
|
date | date-time |
Data prezentu. |
|
value
|
amount.value | double |
Ilość prezentu. |
|
value
|
balance.value | double |
Równowaga pozostała na darze. |
|
Numer partii
|
batch_number | string |
Numer partii skojarzony z tym prezentem. |
|
Status
|
gift_status | string |
Status prezentu. |
|
Anonimowy?
|
is_anonymous | boolean |
Czy prezent jest anonimowy? |
|
Okręg wyborczy
|
constituency | string |
Okręg wyborczy daru. |
|
Identyfikator odnośnika
|
lookup_id | string |
Identyfikator zdefiniowany przez użytkownika dla prezentu. |
|
Pochodzenie
|
origin | string |
Początek daru. |
|
Stan wpisu
|
post_status | string |
Ogólny rejestr po statusie prezentu. Dostępne wartości to Wysłana, NotPosted i DoNotPost. Jeśli post_status jest ustawiona na DoNotPost>, post_date powinna mieć wartość null. Gdy jest ustawiona wartość NotPosted, post_date jest wymagana, ale pozostaje edytowalna. Po ustawieniu opcji Wysłana post_date jest wymagana i nie jest już edytowalna. |
|
Data pośmiertna
|
post_date | date-time |
Data opublikowania prezentu w rejestrze ogólnym. |
|
Reference
|
reference | string |
Uwagi do śledzenia specjalnych szczegółów dotyczących prezentu, takich jak motywacja za nim lub szczegółowy opis prezentu. |
|
day
|
recurring_gift_status_date.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
recurring_gift_status_date.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
recurring_gift_status_date.y | integer |
Rok w dacie rozmytej. |
|
częstotliwość
|
recurring_gift_schedule.frequency | string |
Częstotliwość raty cyklicznego prezentu do wyświetlenia. Dostępne wartości to COTYGODNIOWE, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MIESIĘCZNE, KWARTALNE, ROCZNIE. |
|
start
|
recurring_gift_schedule.start_date | date-time |
Data rozpoczęcia prezentu cyklicznego. |
|
koniec
|
recurring_gift_schedule.end_date | date-time |
Data zakończenia prezentu cyklicznego. |
|
value
|
gift_aid_amount.value | double |
To obliczone pole oblicza łączną kwalifikowaną kwotę podatku odzyskanego od pomocy prezentowej na wszystkich gift_splits dla tego prezentu. Tylko dla Wielkiej Brytanii. |
|
Status kwalifikacji pomocy prezentowej
|
gift_aid_qualification_status | string |
To obliczone pole określa stan kwalifikacji pomocy prezentowej na podstawie informacji podatkowych i formatu bazy danych. Dostępne wartości to: Kwalifikowana, NotQualified i CzęściowoKwalifikowana. Tylko dla Wielkiej Brytanii. |
|
Kod prezentu
|
gift_code | string |
Wartość kodu prezentu skojarzona z prezentem. |
|
Podziały prezentów
|
gift_splits | array of GiftApi.GiftSplitRead |
Zestaw prezentów dzieli się z darem. |
|
Zbiórki pieniędzy
|
fundraisers | array of GiftApi.GiftFundraiserRead |
Zestaw fundraisers, którzy otrzymują kredyt na prezent. |
|
Środki nietrwałe
|
soft_credits | array of GiftApi.SoftCreditRead |
Zestaw kredytów miękkich związanych z prezentem. |
|
Rachunki
|
receipts | array of GiftApi.ReceiptRead |
Zestaw wpływów związanych z prezentem. |
|
Potwierdzenia
|
acknowledgements | array of GiftApi.AcknowledgementRead |
Zestaw potwierdzeń związanych z darem. |
|
Payments
|
payments | array of GiftApi.PaymentRead |
Płatności na prezent. |
|
Połączone prezenty
|
linked_gifts | array of string |
Identyfikatory innych prezentów, które są związane z tym darem. |
|
Data dodania
|
date_added | date-time |
Data utworzenia prezentu. |
|
Data modyfikacji
|
date_modified | date-time |
Data ostatniej modyfikacji prezentu. |
GiftApi.GiftSplitRead
Podział prezentu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemowego podzielonego prezentu. |
|
value
|
amount.value | double |
Kwota podziału prezentu. |
|
identyfikator odwołania
|
appeal_id | string |
Identyfikator rekordu systemowego odwołania skojarzonego z podziałem prezentu. |
|
identyfikator kampanii
|
campaign_id | string |
Identyfikator rekordu systemowego kampanii skojarzonej z podziałem prezentu. |
|
identyfikator funduszu
|
fund_id | string |
Identyfikator rejestru systemu funduszu skojarzonego z podziałem prezentu. |
|
value
|
gift_aid_amount.value | double |
Kwota podatku odzyskanego od pomocy prezentowej dla tego podziału prezentu. Tylko dla Wielkiej Brytanii. |
|
status kwalifikacji pomocy prezentowej
|
gift_aid_qualification_status | string |
Status kwalifikacji pomocy prezentowej podziału. Dostępne wartości to: Kwalifikowane i NotQualified. Tylko dla Wielkiej Brytanii. |
|
identyfikator pakietu
|
package_id | string |
Identyfikator rekordu systemowego pakietu skojarzonego z podziałem prezentu. |
GiftApi.ReceiptRead
Receipt
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
value
|
amount.value | double |
Kwota paragonu. |
|
date
|
date | date-time |
Data odbioru. |
|
Liczba
|
number | integer |
Liczba paragonów. |
|
stan
|
status | string |
Stan paragonu. Dostępne wartości to: RECEIPTED, NEEDSRECEIPT i DONOTRECEIPT. |
GiftApi.PaymentRead
Płatność
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
token konta
|
account_token | string |
Tokenizowane informacje o koncie (np. karta kredytowa) od zewnętrznego dostawcy płatności. Dotyczy tylko form płatności "CreditCard" i "DirectDebit". |
|
Identyfikator konfiguracji programu BBPS
|
bbps_configuration_id | string |
Identyfikator konfiguracji programu BBPS. Dotyczy tylko form płatności "CreditCard" i "DirectDebit". |
|
Identyfikator transakcji BBPS
|
bbps_transaction_id | string |
Identyfikator transakcji BBPS. Dotyczy tylko form płatności "CreditCard" i "DirectDebit". |
|
day
|
check_date.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
check_date.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
check_date.y | integer |
Rok w dacie rozmytej. |
|
numer kontrolny
|
check_number | string |
Numer kontrolny. Dotyczy tylko formy płatności "PersonalCheck". |
|
identyfikator transakcji wyewidencjonowania
|
checkout_transaction_id | string |
Identyfikator transakcji wyewidencjonowania. Dotyczy tylko form płatności "CreditCard" i "DirectDebit". |
|
forma płatności
|
payment_method | string |
Forma płatności. Dostępne wartości są wymienione poniżej. |
|
odwołanie
|
reference | string |
Odwołanie. Dotyczy tylko formy płatności "Inne". |
|
day
|
reference_date.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
reference_date.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
reference_date.y | integer |
Rok w dacie rozmytej. |
GiftApi.SoftCreditRead
Środki nietrwałe
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu środków nietrwałych. |
|
value
|
amount.value | double |
Kwota środków miękkich. |
|
identyfikator składnika
|
constituent_id | string |
Identyfikator rekordu systemu składnika skojarzonego z kredytem miękkim. |
|
identyfikator prezentu
|
gift_id | string |
Identyfikator rekordu systemowego prezentu skojarzonego z kredytem miękkim. |
Gift2Api.PledgeInstallment
Reprezentuje obiekt raty.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu raty. |
|
date
|
date | date-time |
Data raty. |
|
rok
|
year | integer |
Rok daty raty. |
|
value
|
amount.value | double |
Kwota raty. |
|
saldo
|
balance | double |
Równowaga raty. |
|
pozostałe saldo zobowiązania
|
remaining_pledge_balance | double |
Pozostała równowaga zobowiązania. |
|
sekwencja
|
sequence | integer |
Sekwencja kolejności wyświetlania rat. |
Gift2Api.PledgeInstallmentCollection
Ratach
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Data rozpoczęcia
|
start_date | date-time |
Data rozpoczęcia harmonogramu prezentów. |
|
Częstotliwość
|
frequency | string |
Częstotliwość harmonogramu prezentów. |
|
Token współbieżności
|
concurrency_token | string |
Token współbieżności. |
|
Ratach
|
installments | array of Gift2Api.PledgeInstallment |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
Gift2Api.PledgePayment
Reprezentuje obiekt płatności zastawu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator raty
|
installment_id | string |
Identyfikator rekordu systemu płatnej raty. |
|
identyfikator prezentu
|
payment_gift_id | string |
Identyfikator rekordu systemu prezentu płatniczego. |
|
value
|
amount_applied.value | double |
Kwota zastosowana do raty. |
Gift2Api.PledgePaymentCollection
Payments
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
pledge_payments
|
pledge_payments | array of Gift2Api.PledgePayment |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
GiftBatchApi.ApiCollectionOfGiftBatch
Partie prezentów
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Całkowita liczba partii prezentów w odpowiedzi. |
|
value
|
value | array of GiftBatchApi.GiftBatch |
Zestaw elementów uwzględnionych w odpowiedzi. |
GiftBatchApi.CreatedBatch
Utworzono partię prezentów
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
batch_id | string |
Identyfikator rekordu systemowego nowo utworzonej partii prezentów. |
GiftBatchApi.GiftBatch
Reprezentuje obiekt wsadowy prezentu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator rekordu systemu partii. |
|
opis
|
batch_description | string |
Opis partii. |
|
numer partii
|
batch_number | string |
Numer partii |
|
przewidywany numer
|
projected_number_of_gifts | integer |
Przewidywana liczba prezentów w partii. |
|
rzeczywista liczba
|
number_of_gifts | integer |
Rzeczywista liczba prezentów w partii. |
|
przewidywanych kwot
|
projected_amount | double |
Przewidywana wartość prezentów w partii. |
|
rzeczywista kwota
|
actual_amount | double |
Rzeczywista wartość prezentów w partii. |
|
ma wyjątki?
|
has_exceptions | boolean |
Czy partia ma wyjątki? |
|
zatwierdzony?
|
is_approved | boolean |
Czy partia jest zatwierdzona? |
|
Utworzone przez
|
created_by | string |
Nazwa użytkownika, który utworzył partię. |
|
Utworzono:
|
created_on | date-time |
Data utworzenia partii. |
NXTDataIntegrationApi.CreatedGiftNote
Utworzono notatkę
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonej notatki. |
NXTDataIntegrationApi.CreatedGiftTribute
Utworzony hołd prezentu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonego hołdu prezentowego. |
NXTDataIntegrationApi.CreatedTaxDeclaration
Utworzono deklarację podatkową
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator nowo utworzonej deklaracji podatkowej. |
NXTDataIntegrationApi.GiftIdMap
Mapa identyfikatora prezentu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
system_record_id | integer |
Identyfikator rekordu systemu prezentów. |
NXTDataIntegrationApi.GiftNote
Uwaga / Notatka
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator prezentu
|
gift_id | integer |
Identyfikator rekordu systemowego prezentu skojarzonego z notatką. |
|
Typ
|
type | string |
Typ notatki. |
|
day
|
date.d | integer |
Dzień w dacie rozmytej. |
|
miesiąca
|
date.m | integer |
Miesiąc w dacie rozmytej. |
|
rok
|
date.y | integer |
Rok w dacie rozmytej. |
|
Podsumowanie
|
summary | string |
Podsumowanie notatki. |
|
Uwaga / Notatka
|
text | string |
Tekst notatki. |
|
Author
|
author | string |
Autor notatki. |
NXTDataIntegrationApi.GiftNoteCollection
Notatki z prezentów
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości. |
|
value
|
value | array of NXTDataIntegrationApi.GiftNote |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
NXTDataIntegrationApi.GiftTribute
Hołd prezentu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator rekordu systemu hołdu prezentowego. |
|
Identyfikator prezentu
|
gift_id | integer |
Identyfikator rekordu systemowego prezentu. |
|
Identyfikator hołdu
|
tribute_id | integer |
Identyfikator rekordu systemu hołdu. |
|
Typ hołdu
|
tribute_type | integer |
Typ hołdu. |
|
Stan potwierdzenia
|
acknowledge | string |
Hołd prezentu przyznaje status. |
|
Kolejność
|
sequence | integer |
Sekwencja hołdu prezentu. |
NXTDataIntegrationApi.GiftTributeAcknowledgee
Hołd prezentu przyznaje rekord w Raiser's Edge.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Systemowy identyfikator hołdu prezentowego przyznaje. |
|
Identyfikator hołdu prezentu
|
gift_tribute_id | integer |
Identyfikator rekordu systemu hołdu prezentowego. |
|
Czy samozwań jest potwierdzana?
|
self_acknowledge | boolean |
Czy potwierdza to samozwańcze potwierdzenie? |
|
Identyfikator relacji
|
relationships_id | integer |
Identyfikator rekordu systemu relacji dla potwierdzenia. |
|
List
|
letter | integer |
List wysłany do potwierdzenia. |
|
Data litery
|
letter_date | date-time |
Data wysłania listu. |
NXTDataIntegrationApi.GiftTributeAcknowledgeeCollection
Hołd prezentowy przyznaje
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości. |
|
value
|
value | array of NXTDataIntegrationApi.GiftTributeAcknowledgee |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
NXTDataIntegrationApi.GiftTributeCollection
Hołdy prezentowe
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości. |
|
value
|
value | array of NXTDataIntegrationApi.GiftTribute |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |
NXTDataIntegrationApi.TaxDeclaration
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
declaration_id | integer | |
|
Rozpoczyna się deklaracja
|
declaration_starts | date-time |
Data rozpoczęcia deklaracji podatkowej. |
|
Końce deklaracji
|
declaration_ends | date-time |
Data zakończenia deklaracji podatkowej. |
|
Deklaracja dokonana
|
declaration_made | date-time |
Data złożenia deklaracji podatkowej. |
|
Identyfikator wskaźnika
|
declaration_indicator_id | integer |
Identyfikator wskaźnika deklaracji. |
|
Indicator
|
declaration_indicator | string |
Wskaźnik deklaracji. |
|
Identyfikator źródła
|
declaration_source_id | integer |
Identyfikator źródła deklaracji. |
|
Źródło
|
declaration_source | string |
Źródło deklaracji. |
|
Wysłane potwierdzenie
|
confirmation_sent | date-time |
Data wysłania potwierdzenia. |
|
Zwrócone potwierdzenie
|
confirmation_returned | date-time |
Data zwrócenia potwierdzenia. |
|
Płaci podatek
|
constituent_pays_tax | string |
Wskazuje, czy składnik płaci podatek. |
|
Identyfikator stanu
|
tax_payer_status_id | integer |
Identyfikator stanu płatnika podatku. |
|
Status
|
tax_payer_status | string |
Status płatnika podatku. |
|
Comments
|
tax_notes | string |
Uwagi dotyczące deklaracji podatkowej. |
|
Kolejność
|
sequence | integer |
Sekwencja liczbowa skojarzona z deklaracją podatkową. |
NXTDataIntegrationApi.TaxDeclarationCollection
Deklaracje podatkowe
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości. |
|
value
|
value | array of NXTDataIntegrationApi.TaxDeclaration |
Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji. |