Skip to content
/Recurring Gifts

Fundraising (v1-2025-04-18)

Service providing access to Fundraising resources and features

Download OpenAPI description
fundraising-v1.json
fundraising-v1.yaml
Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1
https://fundraising.api.rhythmsoftware.com

Appeals

Appeals

Operations

Billing Templates

Billing Templates

Operations

Campaigns

Campaigns

Operations

Donor Clubs

Donor Clubs

Operations

Donor Levels

Donor Levels

Operations

Donor Statement Templates

Donor Statement Templates

Operations

Donor Statements

Donor Statements

Operations

Donors

Donors

Operations

Fund Categories

Fund Categories

Operations

Funds

Funds

Operations

Gift Notices

Gift Notices

Operations

Gifts

Gifts

Operations

Giving Processes

Giving Processes

Operations

Pledge Levels

Pledge Levels

Operations

Pledge Notices

Pledge Notices

Operations

Pledges

Pledges

Operations

Premiums

Premiums

Operations

Products

Products

Operations

Query Definitions

Query Definitions

Operations

Recurring Gifts

Recurring Gifts

Operations

Gets all of the recurring gifts in the system.

Request

This method will scan all recurring gifts and and return them to the caller.

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

exclusiveStartKeystring

The start key, if you're making a subsequent request

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/recurringGifts/{tenantId}?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The recurring giftswere retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/jsonArray [
amountnumber(float)(Amount)required

The total amount of the gift

appeal_idstring(Appeal)

The appeal

campaign_idstring(Campaign)

The campaign

contact_idstring(Contact)required

The rolodex contact id for the gift giver

currency_codestring(Currency Code)

The currency code of the gift

currency_symbolstring(Currency Symbol)

Currency

datestring(Date)required

The initial date of the recurring gift

donor_idstring(Donor)required

The donor ID

donor_typestring(Donor Type)required

The donor type for the gift

Enum"contact""organization"
end_atstring(End At)

The date at which this recurring gift should end

frequencystring(Frequency)required
Enum"annually""monthly""quarterly"
fund_idstring(Fund)required

The fund ID for this recurring gift

idstring(ID)^[\w:|-]+$required

The ID of the target gift

last_gift_idstring(Last Gift)

The last gift created by this recurring gift

last_processing_datestring(date-time)(Last Processing Date)

The last time this recurring gift was processed

next_gift_datestring(Next Gift Date)required

The next date that this should be gift should be processed

notesstring(Notes)

Notes for the recurring gift

numbernumber(float)(Number)

The recurring gift #

order_idstring(Order)required

The originating gift order

organization_idstring(Organization)required

The organization id associated with this gift

payment_infoobject(Payment Info)

Payment information for the recurring gift

statusstring(Status)
Enum"active""cancelled""completed""payment error""suspended"
suspended_untilstring(Suspended Until)

If suspended, the date at which the suspension should be lifted

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_amount_givennumber(float)(Total Amount Given)

The total amount given in this recurring gift

total_number_of_giftsnumber(float)(Total Number Of Gifts)

The total amount number of gifts given in this recurring gift

]
Response
application/json
[
  {
    "amount": 0.1,
    "appeal_id": "string",
    "campaign_id": "string",
    "contact_id": "string",
    "currency_code": "string",
    "currency_symbol": "string",
    "date": "string",
    "donor_id": "string",
    "donor_type": "contact",
    "end_at": "string",
    "frequency": "annually",
    "fund_id": "string",
    "id": "string",
    "last_gift_id": "string",
    "last_processing_date": "2019-08-24T14:15:22Z",
    "next_gift_date": "string",
    "notes": "string",
    "number": 0.1,
    "order_id": "string",
    "organization_id": "string",
    "payment_info": { … },
    "status": "active",
    "suspended_until": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [ … ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total_amount_given": 0.1,
    "total_number_of_gifts": 0.1
  }
]

Creates a new recurring gift record that does not already exist.

Request

This method will auto-generate an ID and create a new recurring gift. If an ID is specified for the recurring gift, an error will be thrown.

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The recurring gift that you would like to be saved.

amountnumber(float)(Amount)required

The total amount of the gift

appeal_idstring(Appeal)

The appeal

campaign_idstring(Campaign)

The campaign

contact_idstring(Contact)required

The rolodex contact id for the gift giver

currency_codestring(Currency Code)

The currency code of the gift

currency_symbolstring(Currency Symbol)

Currency

datestring(Date)required

The initial date of the recurring gift

donor_idstring(Donor)required

The donor ID

donor_typestring(Donor Type)required

The donor type for the gift

Enum"contact""organization"
end_atstring(End At)

The date at which this recurring gift should end

frequencystring(Frequency)required
Enum"annually""monthly""quarterly"
fund_idstring(Fund)required

The fund ID for this recurring gift

idstring(ID)^[\w:|-]+$required

The ID of the target gift

last_gift_idstring(Last Gift)

The last gift created by this recurring gift

last_processing_datestring(date-time)(Last Processing Date)

The last time this recurring gift was processed

next_gift_datestring(Next Gift Date)required

The next date that this should be gift should be processed

notesstring(Notes)

Notes for the recurring gift

numbernumber(float)(Number)

The recurring gift #

order_idstring(Order)required

The originating gift order

organization_idstring(Organization)required

The organization id associated with this gift

payment_infoobject(Payment Info)

Payment information for the recurring gift

statusstring(Status)
Enum"active""cancelled""completed""payment error""suspended"
suspended_untilstring(Suspended Until)

If suspended, the date at which the suspension should be lifted

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_amount_givennumber(float)(Total Amount Given)

The total amount given in this recurring gift

total_number_of_giftsnumber(float)(Total Number Of Gifts)

The total amount number of gifts given in this recurring gift

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/recurringGifts/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 0.1,
    "appeal_id": "string",
    "campaign_id": "string",
    "contact_id": "string",
    "currency_code": "string",
    "currency_symbol": "string",
    "date": "string",
    "donor_id": "string",
    "donor_type": "contact",
    "end_at": "string",
    "frequency": "annually",
    "fund_id": "string",
    "id": "string",
    "last_gift_id": "string",
    "last_processing_date": "2019-08-24T14:15:22Z",
    "next_gift_date": "string",
    "notes": "string",
    "number": 0.1,
    "order_id": "string",
    "organization_id": "string",
    "payment_info": {
      "card_expiration": "string",
      "card_type": "american express",
      "merchant_account_tokens": [
        {
          "merchant_account_id": "string",
          "token": "string"
        }
      ],
      "payment_account": "string",
      "payment_origin": "ad hoc",
      "token": "string",
      "type": "credit card"
    },
    "status": "active",
    "suspended_until": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total_amount_given": 0.1,
    "total_number_of_gifts": 0.1
  }'

Responses

The recurring gift was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
amountnumber(float)(Amount)required

The total amount of the gift

appeal_idstring(Appeal)

The appeal

campaign_idstring(Campaign)

The campaign

contact_idstring(Contact)required

The rolodex contact id for the gift giver

currency_codestring(Currency Code)

The currency code of the gift

currency_symbolstring(Currency Symbol)

Currency

datestring(Date)required

The initial date of the recurring gift

donor_idstring(Donor)required

The donor ID

donor_typestring(Donor Type)required

The donor type for the gift

Enum"contact""organization"
end_atstring(End At)

The date at which this recurring gift should end

frequencystring(Frequency)required
Enum"annually""monthly""quarterly"
fund_idstring(Fund)required

The fund ID for this recurring gift

idstring(ID)^[\w:|-]+$required

The ID of the target gift

last_gift_idstring(Last Gift)

The last gift created by this recurring gift

last_processing_datestring(date-time)(Last Processing Date)

The last time this recurring gift was processed

next_gift_datestring(Next Gift Date)required

The next date that this should be gift should be processed

notesstring(Notes)

Notes for the recurring gift

numbernumber(float)(Number)

The recurring gift #

order_idstring(Order)required

The originating gift order

organization_idstring(Organization)required

The organization id associated with this gift

payment_infoobject(Payment Info)

Payment information for the recurring gift

statusstring(Status)
Enum"active""cancelled""completed""payment error""suspended"
suspended_untilstring(Suspended Until)

If suspended, the date at which the suspension should be lifted

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_amount_givennumber(float)(Total Amount Given)

The total amount given in this recurring gift

total_number_of_giftsnumber(float)(Total Number Of Gifts)

The total amount number of gifts given in this recurring gift

Response
application/json
{
  "amount": 0.1,
  "appeal_id": "string",
  "campaign_id": "string",
  "contact_id": "string",
  "currency_code": "string",
  "currency_symbol": "string",
  "date": "string",
  "donor_id": "string",
  "donor_type": "contact",
  "end_at": "string",
  "frequency": "annually",
  "fund_id": "string",
  "id": "string",
  "last_gift_id": "string",
  "last_processing_date": "2019-08-24T14:15:22Z",
  "next_gift_date": "string",
  "notes": "string",
  "number": 0.1,
  "order_id": "string",
  "organization_id": "string",
  "payment_info": {
    "card_expiration": "string",
    "card_type": "american express",
    "merchant_account_tokens": [ … ],
    "payment_account": "string",
    "payment_origin": "ad hoc",
    "token": "string",
    "type": "credit card"
  },
  "status": "active",
  "suspended_until": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total_amount_given": 0.1,
  "total_number_of_gifts": 0.1
}

Execute Batch Operations

Request

TAllows you to perform up to 100 parallel patch/delete operations

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/recurringGifts/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects
success_countnumber(float)(Success Count)

Number of successful results

Response
application/json
{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Returns a list of records with the specified contact_id

Request

Returns a list of records with the specified contact_id

Security
knox-authorizer
Path
tenantIdstringrequired

The tenant

contact_idstringrequired

The contact_id to use to for record lookup

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/recurringGifts/{tenantId}/contact/{contact_id}?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
Countinteger
ItemsArray of objects(RecurringGift)
LastEvaluatedKeystring
Response
application/json
{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of records with the specified donor_id

Request

Returns a list of records with the specified donor_id

Security
knox-authorizer
Path
tenantIdstringrequired

The tenant

donor_idstringrequired

The donor_id to use to for record lookup

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/recurringGifts/{tenantId}/donor/{donor_id}?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
Countinteger
ItemsArray of objects(RecurringGift)
LastEvaluatedKeystring
Response
application/json
{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of records with the specified organization_id

Request

Returns a list of records with the specified organization_id

Security
knox-authorizer
Path
tenantIdstringrequired

The tenant

organization_idstringrequired

The organization_id to use to for record lookup

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/recurringGifts/{tenantId}/organization/{organization_id}?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
Countinteger
ItemsArray of objects(RecurringGift)
LastEvaluatedKeystring
Response
application/json
{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Searches for recurring gifts using predefined parameters

Request

Searches for recurring gifts using predefined parameters

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

Query
exclusiveStartKeystring

The start key for the search, for paging support

fieldsToReturnstring

The fields that you want to retrieve; if omitted, the entire object is returned

Bodyapplication/jsonrequired

The recurring gift that you would like to be saved.

statusArray of strings(Status)
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/recurringGifts/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": [
      "string"
    ]
  }'

Responses

The recurring gift search was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
ItemsArray of objects(RecurringGiftSearchResults)
LastEvaluatedKeystring
Response
application/json
{
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a recurring gift from the system by its ID.

Request

This method will delete a recurring gift with the specified ID.

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the recurring gift to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/recurringGifts/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The recurring gift was deleted successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
string
Response
application/json
"string"

Returns a recurring gift from the system by its ID.

Request

This method will look up a recurring gift by the specified ID and return it back.

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the recurring gift to return.

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentReadstring

Indicates the API should force a consistent read on the data source.

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/recurringGifts/{tenantId}/{id}?fields=string&consistentRead=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The recurring gift was retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
amountnumber(float)(Amount)required

The total amount of the gift

appeal_idstring(Appeal)

The appeal

campaign_idstring(Campaign)

The campaign

contact_idstring(Contact)required

The rolodex contact id for the gift giver

currency_codestring(Currency Code)

The currency code of the gift

currency_symbolstring(Currency Symbol)

Currency

datestring(Date)required

The initial date of the recurring gift

donor_idstring(Donor)required

The donor ID

donor_typestring(Donor Type)required

The donor type for the gift

Enum"contact""organization"
end_atstring(End At)

The date at which this recurring gift should end

frequencystring(Frequency)required
Enum"annually""monthly""quarterly"
fund_idstring(Fund)required

The fund ID for this recurring gift

idstring(ID)^[\w:|-]+$required

The ID of the target gift

last_gift_idstring(Last Gift)

The last gift created by this recurring gift

last_processing_datestring(date-time)(Last Processing Date)

The last time this recurring gift was processed

next_gift_datestring(Next Gift Date)required

The next date that this should be gift should be processed

notesstring(Notes)

Notes for the recurring gift

numbernumber(float)(Number)

The recurring gift #

order_idstring(Order)required

The originating gift order

organization_idstring(Organization)required

The organization id associated with this gift

payment_infoobject(Payment Info)

Payment information for the recurring gift

statusstring(Status)
Enum"active""cancelled""completed""payment error""suspended"
suspended_untilstring(Suspended Until)

If suspended, the date at which the suspension should be lifted

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_amount_givennumber(float)(Total Amount Given)

The total amount given in this recurring gift

total_number_of_giftsnumber(float)(Total Number Of Gifts)

The total amount number of gifts given in this recurring gift

Response
application/json
{
  "amount": 0.1,
  "appeal_id": "string",
  "campaign_id": "string",
  "contact_id": "string",
  "currency_code": "string",
  "currency_symbol": "string",
  "date": "string",
  "donor_id": "string",
  "donor_type": "contact",
  "end_at": "string",
  "frequency": "annually",
  "fund_id": "string",
  "id": "string",
  "last_gift_id": "string",
  "last_processing_date": "2019-08-24T14:15:22Z",
  "next_gift_date": "string",
  "notes": "string",
  "number": 0.1,
  "order_id": "string",
  "organization_id": "string",
  "payment_info": {
    "card_expiration": "string",
    "card_type": "american express",
    "merchant_account_tokens": [ … ],
    "payment_account": "string",
    "payment_origin": "ad hoc",
    "token": "string",
    "type": "credit card"
  },
  "status": "active",
  "suspended_until": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total_amount_given": 0.1,
  "total_number_of_gifts": 0.1
}

Partially updates a recurring gift with the specified ID.

Request

This method will patch an existing recurring gift with the specified ID, using the HTTP PATCH specification.

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the recurring gift to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [
opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"
pathstring(Path)required

The JSON path

valuestring(Value)

The updated value

]
curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/recurringGifts/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The recurring gift was patched successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
amountnumber(float)(Amount)required

The total amount of the gift

appeal_idstring(Appeal)

The appeal

campaign_idstring(Campaign)

The campaign

contact_idstring(Contact)required

The rolodex contact id for the gift giver

currency_codestring(Currency Code)

The currency code of the gift

currency_symbolstring(Currency Symbol)

Currency

datestring(Date)required

The initial date of the recurring gift

donor_idstring(Donor)required

The donor ID

donor_typestring(Donor Type)required

The donor type for the gift

Enum"contact""organization"
end_atstring(End At)

The date at which this recurring gift should end

frequencystring(Frequency)required
Enum"annually""monthly""quarterly"
fund_idstring(Fund)required

The fund ID for this recurring gift

idstring(ID)^[\w:|-]+$required

The ID of the target gift

last_gift_idstring(Last Gift)

The last gift created by this recurring gift

last_processing_datestring(date-time)(Last Processing Date)

The last time this recurring gift was processed

next_gift_datestring(Next Gift Date)required

The next date that this should be gift should be processed

notesstring(Notes)

Notes for the recurring gift

numbernumber(float)(Number)

The recurring gift #

order_idstring(Order)required

The originating gift order

organization_idstring(Organization)required

The organization id associated with this gift

payment_infoobject(Payment Info)

Payment information for the recurring gift

statusstring(Status)
Enum"active""cancelled""completed""payment error""suspended"
suspended_untilstring(Suspended Until)

If suspended, the date at which the suspension should be lifted

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_amount_givennumber(float)(Total Amount Given)

The total amount given in this recurring gift

total_number_of_giftsnumber(float)(Total Number Of Gifts)

The total amount number of gifts given in this recurring gift

Response
application/json
{
  "amount": 0.1,
  "appeal_id": "string",
  "campaign_id": "string",
  "contact_id": "string",
  "currency_code": "string",
  "currency_symbol": "string",
  "date": "string",
  "donor_id": "string",
  "donor_type": "contact",
  "end_at": "string",
  "frequency": "annually",
  "fund_id": "string",
  "id": "string",
  "last_gift_id": "string",
  "last_processing_date": "2019-08-24T14:15:22Z",
  "next_gift_date": "string",
  "notes": "string",
  "number": 0.1,
  "order_id": "string",
  "organization_id": "string",
  "payment_info": {
    "card_expiration": "string",
    "card_type": "american express",
    "merchant_account_tokens": [ … ],
    "payment_account": "string",
    "payment_origin": "ad hoc",
    "token": "string",
    "type": "credit card"
  },
  "status": "active",
  "suspended_until": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total_amount_given": 0.1,
  "total_number_of_gifts": 0.1
}

Updates a recurring gift with the specified ID.

Request

This method will update an existing recurring gift with the specified ID.

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the recurring gift to update.

Bodyapplication/jsonrequired

The updated recurring gift that will be saved.

amountnumber(float)(Amount)required

The total amount of the gift

appeal_idstring(Appeal)

The appeal

campaign_idstring(Campaign)

The campaign

contact_idstring(Contact)required

The rolodex contact id for the gift giver

currency_codestring(Currency Code)

The currency code of the gift

currency_symbolstring(Currency Symbol)

Currency

datestring(Date)required

The initial date of the recurring gift

donor_idstring(Donor)required

The donor ID

donor_typestring(Donor Type)required

The donor type for the gift

Enum"contact""organization"
end_atstring(End At)

The date at which this recurring gift should end

frequencystring(Frequency)required
Enum"annually""monthly""quarterly"
fund_idstring(Fund)required

The fund ID for this recurring gift

idstring(ID)^[\w:|-]+$required

The ID of the target gift

last_gift_idstring(Last Gift)

The last gift created by this recurring gift

last_processing_datestring(date-time)(Last Processing Date)

The last time this recurring gift was processed

next_gift_datestring(Next Gift Date)required

The next date that this should be gift should be processed

notesstring(Notes)

Notes for the recurring gift

numbernumber(float)(Number)

The recurring gift #

order_idstring(Order)required

The originating gift order

organization_idstring(Organization)required

The organization id associated with this gift

payment_infoobject(Payment Info)

Payment information for the recurring gift

statusstring(Status)
Enum"active""cancelled""completed""payment error""suspended"
suspended_untilstring(Suspended Until)

If suspended, the date at which the suspension should be lifted

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_amount_givennumber(float)(Total Amount Given)

The total amount given in this recurring gift

total_number_of_giftsnumber(float)(Total Number Of Gifts)

The total amount number of gifts given in this recurring gift

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/recurringGifts/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 0.1,
    "appeal_id": "string",
    "campaign_id": "string",
    "contact_id": "string",
    "currency_code": "string",
    "currency_symbol": "string",
    "date": "string",
    "donor_id": "string",
    "donor_type": "contact",
    "end_at": "string",
    "frequency": "annually",
    "fund_id": "string",
    "id": "string",
    "last_gift_id": "string",
    "last_processing_date": "2019-08-24T14:15:22Z",
    "next_gift_date": "string",
    "notes": "string",
    "number": 0.1,
    "order_id": "string",
    "organization_id": "string",
    "payment_info": {
      "card_expiration": "string",
      "card_type": "american express",
      "merchant_account_tokens": [
        {
          "merchant_account_id": "string",
          "token": "string"
        }
      ],
      "payment_account": "string",
      "payment_origin": "ad hoc",
      "token": "string",
      "type": "credit card"
    },
    "status": "active",
    "suspended_until": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total_amount_given": 0.1,
    "total_number_of_gifts": 0.1
  }'

Responses

The recurring gift was updated successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
amountnumber(float)(Amount)required

The total amount of the gift

appeal_idstring(Appeal)

The appeal

campaign_idstring(Campaign)

The campaign

contact_idstring(Contact)required

The rolodex contact id for the gift giver

currency_codestring(Currency Code)

The currency code of the gift

currency_symbolstring(Currency Symbol)

Currency

datestring(Date)required

The initial date of the recurring gift

donor_idstring(Donor)required

The donor ID

donor_typestring(Donor Type)required

The donor type for the gift

Enum"contact""organization"
end_atstring(End At)

The date at which this recurring gift should end

frequencystring(Frequency)required
Enum"annually""monthly""quarterly"
fund_idstring(Fund)required

The fund ID for this recurring gift

idstring(ID)^[\w:|-]+$required

The ID of the target gift

last_gift_idstring(Last Gift)

The last gift created by this recurring gift

last_processing_datestring(date-time)(Last Processing Date)

The last time this recurring gift was processed

next_gift_datestring(Next Gift Date)required

The next date that this should be gift should be processed

notesstring(Notes)

Notes for the recurring gift

numbernumber(float)(Number)

The recurring gift #

order_idstring(Order)required

The originating gift order

organization_idstring(Organization)required

The organization id associated with this gift

payment_infoobject(Payment Info)

Payment information for the recurring gift

statusstring(Status)
Enum"active""cancelled""completed""payment error""suspended"
suspended_untilstring(Suspended Until)

If suspended, the date at which the suspension should be lifted

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_amount_givennumber(float)(Total Amount Given)

The total amount given in this recurring gift

total_number_of_giftsnumber(float)(Total Number Of Gifts)

The total amount number of gifts given in this recurring gift

Response
application/json
{
  "amount": 0.1,
  "appeal_id": "string",
  "campaign_id": "string",
  "contact_id": "string",
  "currency_code": "string",
  "currency_symbol": "string",
  "date": "string",
  "donor_id": "string",
  "donor_type": "contact",
  "end_at": "string",
  "frequency": "annually",
  "fund_id": "string",
  "id": "string",
  "last_gift_id": "string",
  "last_processing_date": "2019-08-24T14:15:22Z",
  "next_gift_date": "string",
  "notes": "string",
  "number": 0.1,
  "order_id": "string",
  "organization_id": "string",
  "payment_info": {
    "card_expiration": "string",
    "card_type": "american express",
    "merchant_account_tokens": [ … ],
    "payment_account": "string",
    "payment_origin": "ad hoc",
    "token": "string",
    "type": "credit card"
  },
  "status": "active",
  "suspended_until": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total_amount_given": 0.1,
  "total_number_of_gifts": 0.1
}

Settings

Settings

Operations

Statistics

Statistics

Operations