Service providing access to Fundraising resources and features
Service providing access to Fundraising resources and features
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/pledges/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"appeal_id": [
"string"
],
"campaign_id": [
"string"
],
"contact_id": [
"string"
],
"date": [
"2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
],
"fund_id": [
"string"
],
"ids": [
"string"
],
"order_id": [
"string"
],
"organization_id": [
"string"
],
"status": [
"string"
],
"type": [
"string"
]
}'{ "Items": [ { … } ], "LastEvaluatedKey": "string" }
curl -i -X DELETE \
'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/pledges/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'"string"
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/pledges/{tenantId}/{id}?consistentRead=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The pledge was retrieved successfully.
When gift is split, this is the amount that is allocated to the primary fund
When gift is split, this is the amount that is allocated to splits
If selected, the donor covers the transaction fees
The amount of any premiums associated with the gift
The number of payments remaining on the pledge
The amount of soft credit that the person should receive
The percentage to attribute gifts
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The amount of the gift less any premiums
{ "amount": 0.1, "amount_allocated_to_primary_fund": 0.1, "amount_allocated_to_splits": 0.1, "amount_fulfilled": 0.1, "amount_outstanding": 0.1, "anonymous": true, "appeal_id": "string", "campaign_id": "string", "contact_id": "string", "cover_transaction_costs": true, "currency_code": "string", "currency_symbol": "string", "custom_field_values": [ { … } ], "date": "string", "donor_id": "string", "donor_type": "contact", "fund_id": "string", "giving_process_id": "string", "has_soft_credits": true, "has_splits": true, "id": "string", "installment_plan_id": "string", "next_payment_date": "string", "notes": "string", "number": 0.1, "order_id": "string", "order_line_item_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" }, "premium_assignment": "assigned", "premium_fair_market_value": 0.1, "premium_id": "string", "remaining_payments": 0.1, "shipping_address": { "city": "string", "country": "string", "country_name": "string", "county": "string", "latitude": 0.1, "line1": "string", "line2": "string", "line3": "string", "longitude": 0.1, "postal_code": "string", "state": "string", "time_zone_id": "string" }, "soft_credits": [ { … } ], "splits": [ { … } ], "status": "cancelled", "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, "tax_deductible_amount": 0.1, "tribute_gift": true, "tribute_gift_info": { "address": { … }, "contact_id": "string", "details": "string", "email_address": null, "inform_honoree": true, "inform_honoree_by": "email", "message": null, "name": "string", "type": "in honor of" } }