Skip to main content

Enums

ActivityCategory

Kind of task recorded on a supporter or a donation, such as a call to make or an email to send.

Values

ValueDescription
PHONE_CALL

A call to make to the supporter.

EMAIL

An email to write to the supporter.

MEETING

A meeting to hold with the supporter.

TODO

A generic task, described in the note.

REMINDER

A reminder for the assignee, with no action expected from the supporter.

LETTER

A letter to send by post.

WHATSAPP

A message to send on WhatsApp.

ActivitySubject

Kind of record an activity is attached to.

Values

ValueDescription
SUPPORTER

The task is attached to a supporter.

DONATION

The task is attached to a donation.

ApplicationType

Kind of OAuth2 application: a private app of one organization, a public app published by a partner, or one of the applications of Riseact itself.

Values

ValueDescription
ADMIN

The Riseact back-office.

POD

A donation box or another unattended device.

KIOSK

The kiosk application running on a totem.

CLI

The Riseact command line tool.

PARTNERS

The portal agencies manage their organizations from.

SITEFRONT

The public site of the organization.

INTERNAL

An application of Riseact itself.

PUBLIC

An application published by an agency and installable by any organization.

PRIVATE

An application belonging to a single organization.

BillingPlanType

Subscription plan the organization is on.

Values

ValueDescription
DEVELOPMENT

Plan of the organizations used for development and testing, not billed.

HERO

Hero plan, from the previous pricing.

TEAM

Team plan, from the previous pricing.

GROW

Grow plan, from the previous pricing.

PAY_AS_YOU_GO

No subscription: the organization is billed on the payments it collects.

PLATFORM

Subscription to the platform, with the transaction fees billed quarterly on top.

MASTER

Plan of the organizations managed by Riseact itself.

CampaignCommentStatus

Moderation state of a comment left by a donor on a campaign.

Values

ValueDescription
PENDING

The comment is waiting to be moderated and is not shown publicly.

APPROVED

The comment was approved and is shown on the public page.

REJECTED

The comment was refused and stays hidden.

CampaignType

Kind of campaign, which decides how it is presented and collected.

Values

ValueDescription
LEAD

A campaign that collects contacts rather than money.

DONATION

A campaign that collects donations.

CheckoutState

State of a checkout session: open while the donor is filling it in, closed once it produced a donation or was given up.

Values

ValueDescription
OPEN

The session is still being filled in and can be resumed.

CLOSED

The session is over, whether it produced a donation or was given up.

Currencies

Currency an organization can collect donations in, as an ISO 4217 code.

Values

ValueDescription
EUR

Euro.

USD

United States dollar.

GBP

Pound sterling.

CustomFieldEntity

Kind of record a custom field can be defined on.

Values

ValueDescription
SUPPORTER

Fields defined on supporters.

DONATION

Fields defined on donations.

CAMPAIGN

Fields defined on campaigns.

CustomFieldType

Type of value a custom field holds, which decides how it is shown and validated.

Values

ValueDescription
TEXT

Free text.

BOOLEAN

Yes or no.

SELECT

One value chosen among the options of the definition.

DATE

A date, written as YYYY-MM-DD.

DonationState

Lifecycle state of a donation pledge, from draft to completed or revoked.

Values

ValueDescription
DRAFT

The pledge was started but not confirmed yet.

PENDING

The pledge is confirmed and waiting for its first payment.

ACTIVE

The pledge is being collected. Recurring donations stay here between renewals.

PAST_DUE

A renewal failed and the pledge is waiting to be recovered.

DONE

The pledge was honoured in full and nothing more will be collected.

REVOKED

The pledge was revoked and no further collection will be attempted.

ErrorCode

Machine-readable classification of a user error returned by a mutation.

Values

ValueDescription
BAD_INPUT

The value sent is not acceptable for the field it was sent for.

NOT_FOUND

The record the operation refers to does not exist.

NOT_UNIQUE

The value sent is already taken by another record.

PROTECTED

The record cannot be deleted because other records depend on it.

ExportFormat

File format produced by an export.

Values

ValueDescription
XLSX

Excel workbook.

CSV

Comma-separated text file.

Frequency

Billing frequency of a donation: one-off, or the number of instalments expected in a year for a recurring pledge.

Values

ValueDescription
ONEOFF

A single gift.

MONTHLY

Collected every month, twelve times a year.

ANNUALLY

Collected once a year.

ImportKind

What a file import creates: supporters, donations or payments.

Values

ValueDescription
SUPPORTERS

The file creates supporters.

DONATIONS

The file creates donations and their payments.

ImportRowErrorCode

Why a single row of the file could not be imported.

Values

ValueDescription
ROW_MALFORMED

The row has a different number of columns than the header.

DONOR_TYPE_INVALID

The nature of the supporter is outside the allowed values.

COUNTRY_CODE_INVALID

The country is not a two-letter ISO 3166-1 code.

SSN_INVALID

The national tax identifier is too long or not alphanumeric.

VAT_INVALID

The VAT number is too long or not alphanumeric.

DOB_INVALID

The date of birth is not written as YYYY-MM-DD.

BOOLEAN_INVALID

A yes/no column holds a value outside the accepted pairs.

CUSTOM_VALUE_INVALID

The value of a custom field does not match the type of its definition.

CAMPAIGN_MISSING

The row names no campaign and no fallback campaign was given.

PAYMENT_METHOD_MISSING

The row names no payment method.

AMOUNT_INVALID

The amount is missing, badly written or not positive.

DATE_INVALID

The payment date is missing or not written in ISO 8601.

ImportRunError

Why an import run failed as a whole, as opposed to the errors of single rows.

Values

ValueDescription
FILE_INVALID

The file could not be read, for example because of its encoding.

HEADERS_INVALID

The header row has missing, duplicate or unknown columns.

EMPTY_FILE

The file has no data row beyond the header.

TOO_MANY_ROWS

The file has more rows than an import allows.

FILE_TOO_LARGE

The file is heavier than an import allows.

FALLBACK_CAMPAIGN_INVALID

The campaign given as fallback does not exist.

PREFLIGHT_FAILED

Too many of the rows checked before starting were invalid, so the run was stopped.

WORKER_ERROR

The background task processing the run failed or ran out of time.

ImportRunState

State of an import run, from the upload to the outcome.

Values

ValueDescription
PENDING

The file was uploaded and the run is waiting to be processed.

PROCESSING

The run is being processed.

COMPLETED

The run went through. Single rows may still have failed: see rowsFailed.

FAILED

The run failed as a whole and imported nothing. The reason is in errorCode.

ImportStage

Step of the import a row failed at.

Values

ValueDescription
PARSING

The row failed while being read from the file.

SUPPORTER

The row failed while creating or matching its supporter.

CAMPAIGN

The row failed while matching its campaign.

PAYMENT_METHOD

The row failed while matching its payment method.

DONATION

The row failed while creating its donation.

PAYMENT

The row failed while creating its payment.

What a menu entry points at: an external address or one of the pages of the site.

Values

ValueDescription
EXTERNAL

The entry points at an address outside the site.

HOMEPAGE

The entry points at the home page of the site.

PAGE

The entry points at a static page.

ARTICLE

The entry points at a blog post.

BLOG

The entry points at a blog.

CAMPAIGN

The entry points at a campaign.

PROJECT

The entry points at a project.

NotificationMethods

Channel a notification is delivered through.

Values

ValueDescription
EMAIL

Deliver the message by email.

SMS

Deliver the message by SMS.

OnboardingStatus

How far the organization got in setting up its account before it can collect donations.

Values

ValueDescription
MISSING_DATA

The organization still has to fill in the data needed to collect donations.

FREE_PLAN

The setup is complete and the organization is on the free plan.

ACTIVE

The setup is complete and the subscription is in force.

EXPIRED

The subscription lapsed and the organization has to renew it.

PaymentProcessor

Gateway that processes a payment. MANUAL covers the methods collected outside Riseact, such as bank transfers and cash.

Values

ValueDescription
MANUAL

Collected outside Riseact and registered by hand, such as a bank transfer or a cash gift.

STRIPE

Collected through Stripe.

PAYPAL

Collected through PayPal.

SATISPAY

Collected through Satispay.

SUMUP

Collected through SumUp.

PaymentState

State of a single payment, from creation to settlement, failure or refund.

Values

ValueDescription
PENDING

The payment was opened and the money has not arrived yet.

PAID

The money was collected.

REFUNDED

The money was given back to the donor.

FAILED

The collection failed and no money was taken.

ProcessorTransactionIdType

Nature of the identifier carried by ProcessorTransaction.transactionId, which depends on the processor and on how the payment was collected.

Values

ValueDescription
STRIPE_PAYMENT_INTENT

Identifier of the Stripe payment intent.

PAYPAL_ORDER

Identifier of the PayPal order, used for one-off donations.

PAYPAL_CAPTURE

Identifier of the PayPal capture, i.e. the single collection of an order.

PAYPAL_SUBSCRIPTION

Identifier of the PayPal subscription. Every renewal of the same donation reports it, so it does not identify the single charge.

SATISPAY_PAYMENT

Identifier of the Satispay payment.

SUMUP_TRANSACTION_CODE

Transaction code of SumUp.

ProjectCampaignsOrder

Order the campaigns of a project are listed in.

Values

ValueDescription
NEWER

Newest campaigns first.

OLDER

Oldest campaigns first.

ALPHA_AZ

By title, from A to Z.

ALPHA_ZA

By title, from Z to A.

MANUAL

In the order set by hand on the project.

ProjectRuleField

Field of a campaign a project rule matches on.

Values

ValueDescription
TAGS

The rule looks at the labels of the campaign.

TITLE

The rule looks at the title of the campaign.

ProjectRuleMatchType

Whether a campaign must satisfy every rule of the project or just one of them.

Values

ValueDescription
ANY

A campaign joins the project when it satisfies at least one rule.

ALL

A campaign joins the project only when it satisfies every rule.

ProjectRuleOperator

How a project rule compares the field with its value.

Values

ValueDescription
EQUALS_TO

The field is exactly the value.

NOT_EQUALS_TO

The field is anything but the value.

CONTAINS

The field contains the value.

NOT_CONTAINS

The field does not contain the value.

STARTS_WITH

The field starts with the value.

ENDS_WITH

The field ends with the value.

ProjectType

How the campaigns of a project are chosen: listed by hand or matched by rules.

Values

ValueDescription
MANUAL

The campaigns of the project are listed by hand, in the chosen order.

DYNAMIC

The campaigns of the project are the ones matching its rules.

SegmentEntity

Kind of record a saved segment searches over.

Values

ValueDescription
SUPPORTER

The segment searches over supporters.

Sex

Gender recorded on a supporter.

Values

ValueDescription
MALE

Male.

FEMALE

Female.

SexFilter

Gender used as a search filter, with the extra option to match supporters whose gender is unknown.

Values

ValueDescription
MALE

Keep only male supporters.

FEMALE

Keep only female supporters.

NOT_SPECIFIED

Keep only the supporters with no gender recorded.

StaffPermission

A single permission on the data of an organization. Granted to staff members and requested by applications.

Values

ValueDescription
SUPPORTER_READ

Read supporters and their history.

SUPPORTER_WRITE

Create, change, merge and delete supporters.

SUPPORTER_EXPORT

Export supporters to a file.

DONATION_READ

Read donations.

DONATION_WRITE

Create, change, revoke and delete donations, and register their payments.

DONATION_EXPORT

Export donations to a file.

PAYMENT_READ

Read payments.

PAYMENT_WRITE

Correct and refund payments.

CAMPAIGN_READ

Read campaigns, peer-to-peer pages and the comments left on them.

CAMPAIGN_WRITE

Create, change and delete campaigns and peer-to-peer pages, and moderate their comments.

PROJECT_READ

Read projects.

PROJECT_WRITE

Create, change and delete projects.

ACTIVITY_READ

Read the tasks recorded on supporters and donations.

ACTIVITY_WRITE

Create, assign, close and delete tasks.

REPORTS_READ

Read the reports and the analytics of the organization.

APPLICATION_READ

Read the applications installed on the organization.

APPLICATION_INSTALL

Install and uninstall applications, and manage private ones.

SITEFRONT_THEMES

Install and configure the themes of the public site.

SITEFRONT_THEMES_CODE

Edit the code of the theme of the public site.

SITEFRONT_CONTENT

Create and change the pages, the blogs and the posts of the public site.

SITEFRONT_NAVIGATION

Manage the menus and the redirects of the public site.

DBOX_READ

Read the donation boxes and the kiosks of the organization.

DBOX_WRITE

Register, configure and remove donation boxes and kiosks.

StaffRole

Role of a staff member, which decides the permissions they get by default.

Values

ValueDescription
ADMIN

Full access to the organization, permissions included.

USER

Access limited to the permissions granted to the member.

StaffStatus

State of the membership of a staff member in the organization.

Values

ValueDescription
ACTIVE

The member can sign in and work on the organization.

SUSPENDED

The membership is on hold: the member keeps their history but cannot sign in.

DELETED

The membership was removed.

StripeCardBrand

Card network of a saved card.

Values

ValueDescription
AMEX

American Express.

DINERS

Diners Club.

DISCOVER

Discover.

JCB

JCB.

MASTERCARD

Mastercard.

UNIONPAY

UnionPay.

VISA

Visa.

UNKNOWN

The network was not reported by Stripe.

StripeCardFunding

Whether a saved card draws on a credit line, a debit account or a prepaid balance.

Values

ValueDescription
CREDIT

The card draws on a credit line.

DEBIT

The card draws on a bank account.

PREPAID

The card draws on a prepaid balance.

UNKNOWN

The funding was not reported by Stripe.

StripePaymentType

A way of paying offered through Stripe, such as card or SEPA direct debit.

Values

ValueDescription
SEPA_DIRECT_DEBIT

SEPA direct debit.

CREDIT_CARD

Card payment.

POS

Payment collected in person on a card reader.

SupporterBulkTagAction

Whether a bulk tag operation adds the given labels to the selected supporters or removes them.

Values

ValueDescription
ADD

Add the given labels to the selected supporters.

REMOVE

Remove the given labels from the selected supporters.

SupporterType

Nature of a supporter: a private person, a company, a family or an informal group.

Values

ValueDescription
INDIVIDUAL

A private person.

COMPANY

A company or another for-profit body.

ORGANIZATION

A non-profit body, a foundation or an institution.

FAMILY

A family giving as one.

GROUP

An informal group giving as one.

WebDocumentVisibility

Whether a page published on the public site is visible to everyone, reachable only by direct link, or hidden.

Values

ValueDescription
UNPUBLISHED

The page exists but is not reachable on the public site.

PUBLISHED

The page is public.

ARCHIVED

The page was withdrawn and is kept only for reference.