Fundraising

Fundraising (v1-2025-04-18)

Service providing access to Fundraising resources and features

Download OpenAPI description

fundraising-v1.json

fundraising-v1.yaml

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/

https://fundraising.api.rhythmsoftware.com/

Appeals

Operations

Billing Templates

Operations

Gets all of the billing templates in the system.

Request

This method will scan all billing templates and and return them to the caller.

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/billingTemplates/{tenantId}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The billing templateswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

advance_phasesboolean(Advance Phases)

When true, training providers should be sent invoices for training registrations

descriptionstring(Description)

A description of the template

fundraising_notice_optionsobject(Fundraising Notice Options)required

fundraising_notice_options.expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

fundraising_notice_options.expiration_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

fundraising_notice_options.expiration_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

fundraising_notice_options.expiration_date_range_end.relative_tostring(Relative To)required

Enum"the beginning of the month""the beginning of the quarter""the beginning of the week""the beginning of the year""the end of the month""the end of the quarter""the end of the week""the end of the year""the reference date"

fundraising_notice_options.expiration_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

fundraising_notice_options.expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

fundraising_notice_options.expiration_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

fundraising_notice_options.expiration_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

fundraising_notice_options.expiration_date_range_start.relative_tostring(Relative To)required

fundraising_notice_options.expiration_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

fundraising_notice_options.notice_idstring(Notice)

The notice to send the school

fundraising_notice_options.phase_idsArray of strings(Phases)non-emptyrequired

fundraising_notice_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

fundraising_notice_options.program_idsArray of strings(Programs)non-emptyrequired

fundraising_notice_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

fundraising_notice_options.school_idsArray of strings(Schools)non-emptyrequired

fundraising_notice_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

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

The unique, string identifier of this billing template

is_activeboolean(Is Active)

Whether or not this billing template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

phase_advancement_optionsobject(Phase Advancement Options)required

phase_advancement_options.expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

phase_advancement_options.expiration_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

phase_advancement_options.expiration_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

phase_advancement_options.expiration_date_range_end.relative_tostring(Relative To)required

phase_advancement_options.expiration_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

phase_advancement_options.expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

phase_advancement_options.expiration_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

phase_advancement_options.expiration_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

phase_advancement_options.expiration_date_range_start.relative_tostring(Relative To)required

phase_advancement_options.expiration_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

phase_advancement_options.notice_idstring(Notice)

The notice to send the school when advancing

phase_advancement_options.phase_idsArray of strings(Phases)non-emptyrequired

phase_advancement_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

phase_advancement_options.program_idsArray of strings(Programs)non-emptyrequired

phase_advancement_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

phase_advancement_options.school_idsArray of strings(Schools)non-emptyrequired

phase_advancement_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

send_fundraising_noticesboolean(Send Fundraising Notices)

If set, this billing run will perform phase advancements

send_team_noticesboolean(Send Team Notices)

If set, this billing run will perform phase advancements

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_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

team_notice_optionsobject(Team Notice Options)required

team_notice_options.phase_idsArray of strings(Phases)non-emptyrequired

team_notice_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.program_idsArray of strings(Programs)non-emptyrequired

team_notice_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.school_idsArray of strings(Schools)non-emptyrequired

team_notice_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.team_notice_idstring(Team Notice)

The notice to send the school

team_notice_options.visit_start_date_range_endobject(date)(Visit Start Date Range End)required

The date to use to filter out which visits to use

team_notice_options.visit_start_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

team_notice_options.visit_start_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

team_notice_options.visit_start_date_range_end.relative_tostring(Relative To)required

team_notice_options.visit_start_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

team_notice_options.visit_start_date_range_startobject(date)(Visit Start Date Range Start)required

The date to use to filter out which visits to use

team_notice_options.visit_start_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

team_notice_options.visit_start_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

team_notice_options.visit_start_date_range_start.relative_tostring(Relative To)required

team_notice_options.visit_start_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

team_notice_options.visit_type_idsArray of strings(Visit Types)non-emptyrequired

team_notice_options.visit_type_restrictionstring(Visit Type Restriction)

Determines if/how to restrict the visit_types in this run

Enum"exclude""include""none"

]

Response

application/json

[
  {
    "advance_phases": true,
    "description": "string",
    "fundraising_notice_options": { … },
    "id": "string",
    "is_active": true,
    "name": "string",
    "notification_email": "string",
    "phase_advancement_options": { … },
    "send_fundraising_notices": true,
    "send_team_notices": true,
    "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_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,
    "team_notice_options": { … }
  }
]

Creates a new billing template record that does not already exist.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The billing template that you would like to be saved.

advance_phasesboolean(Advance Phases)

When true, training providers should be sent invoices for training registrations

descriptionstring(Description)

A description of the template

fundraising_notice_optionsobject(Fundraising Notice Options)required

fundraising_notice_options.expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

fundraising_notice_options.expiration_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

fundraising_notice_options.expiration_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

fundraising_notice_options.expiration_date_range_end.relative_tostring(Relative To)required

fundraising_notice_options.expiration_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

fundraising_notice_options.expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

fundraising_notice_options.expiration_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

fundraising_notice_options.expiration_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

fundraising_notice_options.expiration_date_range_start.relative_tostring(Relative To)required

fundraising_notice_options.expiration_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

fundraising_notice_options.notice_idstring(Notice)

The notice to send the school

fundraising_notice_options.phase_idsArray of strings(Phases)non-emptyrequired

fundraising_notice_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

fundraising_notice_options.program_idsArray of strings(Programs)non-emptyrequired

fundraising_notice_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

fundraising_notice_options.school_idsArray of strings(Schools)non-emptyrequired

fundraising_notice_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

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

The unique, string identifier of this billing template

is_activeboolean(Is Active)

Whether or not this billing template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

phase_advancement_optionsobject(Phase Advancement Options)required

phase_advancement_options.expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

phase_advancement_options.expiration_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

phase_advancement_options.expiration_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

phase_advancement_options.expiration_date_range_end.relative_tostring(Relative To)required

phase_advancement_options.expiration_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

phase_advancement_options.expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

phase_advancement_options.expiration_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

phase_advancement_options.expiration_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

phase_advancement_options.expiration_date_range_start.relative_tostring(Relative To)required

phase_advancement_options.expiration_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

phase_advancement_options.notice_idstring(Notice)

The notice to send the school when advancing

phase_advancement_options.phase_idsArray of strings(Phases)non-emptyrequired

phase_advancement_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

phase_advancement_options.program_idsArray of strings(Programs)non-emptyrequired

phase_advancement_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

phase_advancement_options.school_idsArray of strings(Schools)non-emptyrequired

phase_advancement_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

send_fundraising_noticesboolean(Send Fundraising Notices)

If set, this billing run will perform phase advancements

send_team_noticesboolean(Send Team Notices)

If set, this billing run will perform phase advancements

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_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

team_notice_optionsobject(Team Notice Options)required

team_notice_options.phase_idsArray of strings(Phases)non-emptyrequired

team_notice_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.program_idsArray of strings(Programs)non-emptyrequired

team_notice_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.school_idsArray of strings(Schools)non-emptyrequired

team_notice_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.team_notice_idstring(Team Notice)

The notice to send the school

team_notice_options.visit_start_date_range_endobject(date)(Visit Start Date Range End)required

The date to use to filter out which visits to use

team_notice_options.visit_start_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

team_notice_options.visit_start_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

team_notice_options.visit_start_date_range_end.relative_tostring(Relative To)required

team_notice_options.visit_start_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

team_notice_options.visit_start_date_range_startobject(date)(Visit Start Date Range Start)required

The date to use to filter out which visits to use

team_notice_options.visit_start_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

team_notice_options.visit_start_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

team_notice_options.visit_start_date_range_start.relative_tostring(Relative To)required

team_notice_options.visit_start_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

team_notice_options.visit_type_idsArray of strings(Visit Types)non-emptyrequired

team_notice_options.visit_type_restrictionstring(Visit Type Restriction)

Determines if/how to restrict the visit_types in this run

Enum"exclude""include""none"

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/billingTemplates/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "advance_phases": true,
    "description": "string",
    "fundraising_notice_options": {
      "expiration_date_range_end": {
        "number": 0.1,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "expiration_date_range_start": {
        "number": 0.1,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "notice_id": "string",
      "phase_ids": [
        "string"
      ],
      "phase_restriction": "exclude",
      "program_ids": [
        "string"
      ],
      "program_restriction": "exclude",
      "school_ids": [
        "string"
      ],
      "school_restriction": "exclude"
    },
    "id": "string",
    "is_active": true,
    "name": "string",
    "notification_email": "string",
    "phase_advancement_options": {
      "expiration_date_range_end": {
        "number": 0.1,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "expiration_date_range_start": {
        "number": 0.1,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "notice_id": "string",
      "phase_ids": [
        "string"
      ],
      "phase_restriction": "exclude",
      "program_ids": [
        "string"
      ],
      "program_restriction": "exclude",
      "school_ids": [
        "string"
      ],
      "school_restriction": "exclude"
    },
    "send_fundraising_notices": true,
    "send_team_notices": true,
    "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_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,
    "team_notice_options": {
      "phase_ids": [
        "string"
      ],
      "phase_restriction": "exclude",
      "program_ids": [
        "string"
      ],
      "program_restriction": "exclude",
      "school_ids": [
        "string"
      ],
      "school_restriction": "exclude",
      "team_notice_id": "string",
      "visit_start_date_range_end": {
        "number": 0.1,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "visit_start_date_range_start": {
        "number": 0.1,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "visit_type_ids": [
        "string"
      ],
      "visit_type_restriction": "exclude"
    }
  }'

Responses

The billing template was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

advance_phasesboolean(Advance Phases)

When true, training providers should be sent invoices for training registrations

descriptionstring(Description)

A description of the template

fundraising_notice_optionsobject(Fundraising Notice Options)required

fundraising_notice_options.expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

fundraising_notice_options.expiration_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

fundraising_notice_options.expiration_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

fundraising_notice_options.expiration_date_range_end.relative_tostring(Relative To)required

fundraising_notice_options.expiration_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

fundraising_notice_options.expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

fundraising_notice_options.expiration_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

fundraising_notice_options.expiration_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

fundraising_notice_options.expiration_date_range_start.relative_tostring(Relative To)required

fundraising_notice_options.expiration_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

fundraising_notice_options.notice_idstring(Notice)

The notice to send the school

fundraising_notice_options.phase_idsArray of strings(Phases)non-emptyrequired

fundraising_notice_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

fundraising_notice_options.program_idsArray of strings(Programs)non-emptyrequired

fundraising_notice_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

fundraising_notice_options.school_idsArray of strings(Schools)non-emptyrequired

fundraising_notice_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

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

The unique, string identifier of this billing template

is_activeboolean(Is Active)

Whether or not this billing template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

phase_advancement_optionsobject(Phase Advancement Options)required

phase_advancement_options.expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

phase_advancement_options.expiration_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

phase_advancement_options.expiration_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

phase_advancement_options.expiration_date_range_end.relative_tostring(Relative To)required

phase_advancement_options.expiration_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

phase_advancement_options.expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

phase_advancement_options.expiration_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

phase_advancement_options.expiration_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

phase_advancement_options.expiration_date_range_start.relative_tostring(Relative To)required

phase_advancement_options.expiration_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

phase_advancement_options.notice_idstring(Notice)

The notice to send the school when advancing

phase_advancement_options.phase_idsArray of strings(Phases)non-emptyrequired

phase_advancement_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

phase_advancement_options.program_idsArray of strings(Programs)non-emptyrequired

phase_advancement_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

phase_advancement_options.school_idsArray of strings(Schools)non-emptyrequired

phase_advancement_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

send_fundraising_noticesboolean(Send Fundraising Notices)

If set, this billing run will perform phase advancements

send_team_noticesboolean(Send Team Notices)

If set, this billing run will perform phase advancements

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_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

team_notice_optionsobject(Team Notice Options)required

team_notice_options.phase_idsArray of strings(Phases)non-emptyrequired

team_notice_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.program_idsArray of strings(Programs)non-emptyrequired

team_notice_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.school_idsArray of strings(Schools)non-emptyrequired

team_notice_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.team_notice_idstring(Team Notice)

The notice to send the school

team_notice_options.visit_start_date_range_endobject(date)(Visit Start Date Range End)required

The date to use to filter out which visits to use

team_notice_options.visit_start_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

team_notice_options.visit_start_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

team_notice_options.visit_start_date_range_end.relative_tostring(Relative To)required

team_notice_options.visit_start_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

team_notice_options.visit_start_date_range_startobject(date)(Visit Start Date Range Start)required

The date to use to filter out which visits to use

team_notice_options.visit_start_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

team_notice_options.visit_start_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

team_notice_options.visit_start_date_range_start.relative_tostring(Relative To)required

team_notice_options.visit_start_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

team_notice_options.visit_type_idsArray of strings(Visit Types)non-emptyrequired

team_notice_options.visit_type_restrictionstring(Visit Type Restriction)

Determines if/how to restrict the visit_types in this run

Enum"exclude""include""none"

Response

application/json

{
  "advance_phases": true,
  "description": "string",
  "fundraising_notice_options": {
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "notice_id": "string",
    "phase_ids": [ … ],
    "phase_restriction": "exclude",
    "program_ids": [ … ],
    "program_restriction": "exclude",
    "school_ids": [ … ],
    "school_restriction": "exclude"
  },
  "id": "string",
  "is_active": true,
  "name": "string",
  "notification_email": "string",
  "phase_advancement_options": {
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "notice_id": "string",
    "phase_ids": [ … ],
    "phase_restriction": "exclude",
    "program_ids": [ … ],
    "program_restriction": "exclude",
    "school_ids": [ … ],
    "school_restriction": "exclude"
  },
  "send_fundraising_notices": true,
  "send_team_notices": true,
  "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_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,
  "team_notice_options": {
    "phase_ids": [ … ],
    "phase_restriction": "exclude",
    "program_ids": [ … ],
    "program_restriction": "exclude",
    "school_ids": [ … ],
    "school_restriction": "exclude",
    "team_notice_id": "string",
    "visit_start_date_range_end": { … },
    "visit_start_date_range_start": { … },
    "visit_type_ids": [ … ],
    "visit_type_restriction": "exclude"
  }
}

Generates a billing run from a template

Request

Path

tenantIdstringrequired

The tenant

templateIdstringrequired

The template

referenceDatestringrequired

The reference date

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/billingTemplates/{tenantId}/fromTemplate/{templateId}/{referenceDate}' \
  -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

Returns a billing template from the system by its ID.

Request

This method will delete a billing template with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing template to delete.

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

Responses

The billing template 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 billing template from the system by its ID.

Request

This method will look up a billing template by the specified ID and return it back.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing template 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/billingTemplates/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The billing template was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

advance_phasesboolean(Advance Phases)

When true, training providers should be sent invoices for training registrations

descriptionstring(Description)

A description of the template

fundraising_notice_optionsobject(Fundraising Notice Options)required

fundraising_notice_options.expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

fundraising_notice_options.expiration_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

fundraising_notice_options.expiration_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

fundraising_notice_options.expiration_date_range_end.relative_tostring(Relative To)required

fundraising_notice_options.expiration_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

fundraising_notice_options.expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

fundraising_notice_options.expiration_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

fundraising_notice_options.expiration_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

fundraising_notice_options.expiration_date_range_start.relative_tostring(Relative To)required

fundraising_notice_options.expiration_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

fundraising_notice_options.notice_idstring(Notice)

The notice to send the school

fundraising_notice_options.phase_idsArray of strings(Phases)non-emptyrequired

fundraising_notice_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

fundraising_notice_options.program_idsArray of strings(Programs)non-emptyrequired

fundraising_notice_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

fundraising_notice_options.school_idsArray of strings(Schools)non-emptyrequired

fundraising_notice_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

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

The unique, string identifier of this billing template

is_activeboolean(Is Active)

Whether or not this billing template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

phase_advancement_optionsobject(Phase Advancement Options)required

phase_advancement_options.expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

phase_advancement_options.expiration_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

phase_advancement_options.expiration_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

phase_advancement_options.expiration_date_range_end.relative_tostring(Relative To)required

phase_advancement_options.expiration_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

phase_advancement_options.expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

phase_advancement_options.expiration_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

phase_advancement_options.expiration_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

phase_advancement_options.expiration_date_range_start.relative_tostring(Relative To)required

phase_advancement_options.expiration_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

phase_advancement_options.notice_idstring(Notice)

The notice to send the school when advancing

phase_advancement_options.phase_idsArray of strings(Phases)non-emptyrequired

phase_advancement_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

phase_advancement_options.program_idsArray of strings(Programs)non-emptyrequired

phase_advancement_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

phase_advancement_options.school_idsArray of strings(Schools)non-emptyrequired

phase_advancement_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

send_fundraising_noticesboolean(Send Fundraising Notices)

If set, this billing run will perform phase advancements

send_team_noticesboolean(Send Team Notices)

If set, this billing run will perform phase advancements

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_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

team_notice_optionsobject(Team Notice Options)required

team_notice_options.phase_idsArray of strings(Phases)non-emptyrequired

team_notice_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.program_idsArray of strings(Programs)non-emptyrequired

team_notice_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.school_idsArray of strings(Schools)non-emptyrequired

team_notice_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.team_notice_idstring(Team Notice)

The notice to send the school

team_notice_options.visit_start_date_range_endobject(date)(Visit Start Date Range End)required

The date to use to filter out which visits to use

team_notice_options.visit_start_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

team_notice_options.visit_start_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

team_notice_options.visit_start_date_range_end.relative_tostring(Relative To)required

team_notice_options.visit_start_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

team_notice_options.visit_start_date_range_startobject(date)(Visit Start Date Range Start)required

The date to use to filter out which visits to use

team_notice_options.visit_start_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

team_notice_options.visit_start_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

team_notice_options.visit_start_date_range_start.relative_tostring(Relative To)required

team_notice_options.visit_start_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

team_notice_options.visit_type_idsArray of strings(Visit Types)non-emptyrequired

team_notice_options.visit_type_restrictionstring(Visit Type Restriction)

Determines if/how to restrict the visit_types in this run

Enum"exclude""include""none"

Response

application/json

{
  "advance_phases": true,
  "description": "string",
  "fundraising_notice_options": {
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "notice_id": "string",
    "phase_ids": [ … ],
    "phase_restriction": "exclude",
    "program_ids": [ … ],
    "program_restriction": "exclude",
    "school_ids": [ … ],
    "school_restriction": "exclude"
  },
  "id": "string",
  "is_active": true,
  "name": "string",
  "notification_email": "string",
  "phase_advancement_options": {
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "notice_id": "string",
    "phase_ids": [ … ],
    "phase_restriction": "exclude",
    "program_ids": [ … ],
    "program_restriction": "exclude",
    "school_ids": [ … ],
    "school_restriction": "exclude"
  },
  "send_fundraising_notices": true,
  "send_team_notices": true,
  "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_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,
  "team_notice_options": {
    "phase_ids": [ … ],
    "phase_restriction": "exclude",
    "program_ids": [ … ],
    "program_restriction": "exclude",
    "school_ids": [ … ],
    "school_restriction": "exclude",
    "team_notice_id": "string",
    "visit_start_date_range_end": { … },
    "visit_start_date_range_start": { … },
    "visit_type_ids": [ … ],
    "visit_type_restriction": "exclude"
  }
}

Partially updates a billing template with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing template 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/billingTemplates/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The billing template was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

advance_phasesboolean(Advance Phases)

When true, training providers should be sent invoices for training registrations

descriptionstring(Description)

A description of the template

fundraising_notice_optionsobject(Fundraising Notice Options)required

fundraising_notice_options.expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

fundraising_notice_options.expiration_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

fundraising_notice_options.expiration_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

fundraising_notice_options.expiration_date_range_end.relative_tostring(Relative To)required

fundraising_notice_options.expiration_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

fundraising_notice_options.expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

fundraising_notice_options.expiration_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

fundraising_notice_options.expiration_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

fundraising_notice_options.expiration_date_range_start.relative_tostring(Relative To)required

fundraising_notice_options.expiration_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

fundraising_notice_options.notice_idstring(Notice)

The notice to send the school

fundraising_notice_options.phase_idsArray of strings(Phases)non-emptyrequired

fundraising_notice_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

fundraising_notice_options.program_idsArray of strings(Programs)non-emptyrequired

fundraising_notice_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

fundraising_notice_options.school_idsArray of strings(Schools)non-emptyrequired

fundraising_notice_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

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

The unique, string identifier of this billing template

is_activeboolean(Is Active)

Whether or not this billing template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

phase_advancement_optionsobject(Phase Advancement Options)required

phase_advancement_options.expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

phase_advancement_options.expiration_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

phase_advancement_options.expiration_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

phase_advancement_options.expiration_date_range_end.relative_tostring(Relative To)required

phase_advancement_options.expiration_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

phase_advancement_options.expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

phase_advancement_options.expiration_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

phase_advancement_options.expiration_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

phase_advancement_options.expiration_date_range_start.relative_tostring(Relative To)required

phase_advancement_options.expiration_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

phase_advancement_options.notice_idstring(Notice)

The notice to send the school when advancing

phase_advancement_options.phase_idsArray of strings(Phases)non-emptyrequired

phase_advancement_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

phase_advancement_options.program_idsArray of strings(Programs)non-emptyrequired

phase_advancement_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

phase_advancement_options.school_idsArray of strings(Schools)non-emptyrequired

phase_advancement_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

send_fundraising_noticesboolean(Send Fundraising Notices)

If set, this billing run will perform phase advancements

send_team_noticesboolean(Send Team Notices)

If set, this billing run will perform phase advancements

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_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

team_notice_optionsobject(Team Notice Options)required

team_notice_options.phase_idsArray of strings(Phases)non-emptyrequired

team_notice_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.program_idsArray of strings(Programs)non-emptyrequired

team_notice_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.school_idsArray of strings(Schools)non-emptyrequired

team_notice_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.team_notice_idstring(Team Notice)

The notice to send the school

team_notice_options.visit_start_date_range_endobject(date)(Visit Start Date Range End)required

The date to use to filter out which visits to use

team_notice_options.visit_start_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

team_notice_options.visit_start_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

team_notice_options.visit_start_date_range_end.relative_tostring(Relative To)required

team_notice_options.visit_start_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

team_notice_options.visit_start_date_range_startobject(date)(Visit Start Date Range Start)required

The date to use to filter out which visits to use

team_notice_options.visit_start_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

team_notice_options.visit_start_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

team_notice_options.visit_start_date_range_start.relative_tostring(Relative To)required

team_notice_options.visit_start_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

team_notice_options.visit_type_idsArray of strings(Visit Types)non-emptyrequired

team_notice_options.visit_type_restrictionstring(Visit Type Restriction)

Determines if/how to restrict the visit_types in this run

Enum"exclude""include""none"

Response

application/json

{
  "advance_phases": true,
  "description": "string",
  "fundraising_notice_options": {
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "notice_id": "string",
    "phase_ids": [ … ],
    "phase_restriction": "exclude",
    "program_ids": [ … ],
    "program_restriction": "exclude",
    "school_ids": [ … ],
    "school_restriction": "exclude"
  },
  "id": "string",
  "is_active": true,
  "name": "string",
  "notification_email": "string",
  "phase_advancement_options": {
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "notice_id": "string",
    "phase_ids": [ … ],
    "phase_restriction": "exclude",
    "program_ids": [ … ],
    "program_restriction": "exclude",
    "school_ids": [ … ],
    "school_restriction": "exclude"
  },
  "send_fundraising_notices": true,
  "send_team_notices": true,
  "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_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,
  "team_notice_options": {
    "phase_ids": [ … ],
    "phase_restriction": "exclude",
    "program_ids": [ … ],
    "program_restriction": "exclude",
    "school_ids": [ … ],
    "school_restriction": "exclude",
    "team_notice_id": "string",
    "visit_start_date_range_end": { … },
    "visit_start_date_range_start": { … },
    "visit_type_ids": [ … ],
    "visit_type_restriction": "exclude"
  }
}

Updates a billing template with the specified ID.

Request

This method will update an existing billing template with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing template to update.

Bodyapplication/jsonrequired

The updated billing template that will be saved.

advance_phasesboolean(Advance Phases)

When true, training providers should be sent invoices for training registrations

descriptionstring(Description)

A description of the template

fundraising_notice_optionsobject(Fundraising Notice Options)required

fundraising_notice_options.expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

fundraising_notice_options.expiration_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

fundraising_notice_options.expiration_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

fundraising_notice_options.expiration_date_range_end.relative_tostring(Relative To)required

fundraising_notice_options.expiration_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

fundraising_notice_options.expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

fundraising_notice_options.expiration_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

fundraising_notice_options.expiration_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

fundraising_notice_options.expiration_date_range_start.relative_tostring(Relative To)required

fundraising_notice_options.expiration_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

fundraising_notice_options.notice_idstring(Notice)

The notice to send the school

fundraising_notice_options.phase_idsArray of strings(Phases)non-emptyrequired

fundraising_notice_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

fundraising_notice_options.program_idsArray of strings(Programs)non-emptyrequired

fundraising_notice_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

fundraising_notice_options.school_idsArray of strings(Schools)non-emptyrequired

fundraising_notice_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

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

The unique, string identifier of this billing template

is_activeboolean(Is Active)

Whether or not this billing template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

phase_advancement_optionsobject(Phase Advancement Options)required

phase_advancement_options.expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

phase_advancement_options.expiration_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

phase_advancement_options.expiration_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

phase_advancement_options.expiration_date_range_end.relative_tostring(Relative To)required

phase_advancement_options.expiration_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

phase_advancement_options.expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

phase_advancement_options.expiration_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

phase_advancement_options.expiration_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

phase_advancement_options.expiration_date_range_start.relative_tostring(Relative To)required

phase_advancement_options.expiration_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

phase_advancement_options.notice_idstring(Notice)

The notice to send the school when advancing

phase_advancement_options.phase_idsArray of strings(Phases)non-emptyrequired

phase_advancement_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

phase_advancement_options.program_idsArray of strings(Programs)non-emptyrequired

phase_advancement_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

phase_advancement_options.school_idsArray of strings(Schools)non-emptyrequired

phase_advancement_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

send_fundraising_noticesboolean(Send Fundraising Notices)

If set, this billing run will perform phase advancements

send_team_noticesboolean(Send Team Notices)

If set, this billing run will perform phase advancements

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_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

team_notice_optionsobject(Team Notice Options)required

team_notice_options.phase_idsArray of strings(Phases)non-emptyrequired

team_notice_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.program_idsArray of strings(Programs)non-emptyrequired

team_notice_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.school_idsArray of strings(Schools)non-emptyrequired

team_notice_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.team_notice_idstring(Team Notice)

The notice to send the school

team_notice_options.visit_start_date_range_endobject(date)(Visit Start Date Range End)required

The date to use to filter out which visits to use

team_notice_options.visit_start_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

team_notice_options.visit_start_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

team_notice_options.visit_start_date_range_end.relative_tostring(Relative To)required

team_notice_options.visit_start_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

team_notice_options.visit_start_date_range_startobject(date)(Visit Start Date Range Start)required

The date to use to filter out which visits to use

team_notice_options.visit_start_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

team_notice_options.visit_start_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

team_notice_options.visit_start_date_range_start.relative_tostring(Relative To)required

team_notice_options.visit_start_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

team_notice_options.visit_type_idsArray of strings(Visit Types)non-emptyrequired

team_notice_options.visit_type_restrictionstring(Visit Type Restriction)

Determines if/how to restrict the visit_types in this run

Enum"exclude""include""none"

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/billingTemplates/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "advance_phases": true,
    "description": "string",
    "fundraising_notice_options": {
      "expiration_date_range_end": {
        "number": 0.1,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "expiration_date_range_start": {
        "number": 0.1,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "notice_id": "string",
      "phase_ids": [
        "string"
      ],
      "phase_restriction": "exclude",
      "program_ids": [
        "string"
      ],
      "program_restriction": "exclude",
      "school_ids": [
        "string"
      ],
      "school_restriction": "exclude"
    },
    "id": "string",
    "is_active": true,
    "name": "string",
    "notification_email": "string",
    "phase_advancement_options": {
      "expiration_date_range_end": {
        "number": 0.1,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "expiration_date_range_start": {
        "number": 0.1,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "notice_id": "string",
      "phase_ids": [
        "string"
      ],
      "phase_restriction": "exclude",
      "program_ids": [
        "string"
      ],
      "program_restriction": "exclude",
      "school_ids": [
        "string"
      ],
      "school_restriction": "exclude"
    },
    "send_fundraising_notices": true,
    "send_team_notices": true,
    "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_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,
    "team_notice_options": {
      "phase_ids": [
        "string"
      ],
      "phase_restriction": "exclude",
      "program_ids": [
        "string"
      ],
      "program_restriction": "exclude",
      "school_ids": [
        "string"
      ],
      "school_restriction": "exclude",
      "team_notice_id": "string",
      "visit_start_date_range_end": {
        "number": 0.1,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "visit_start_date_range_start": {
        "number": 0.1,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "visit_type_ids": [
        "string"
      ],
      "visit_type_restriction": "exclude"
    }
  }'

Responses

The billing template was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

advance_phasesboolean(Advance Phases)

When true, training providers should be sent invoices for training registrations

descriptionstring(Description)

A description of the template

fundraising_notice_optionsobject(Fundraising Notice Options)required

fundraising_notice_options.expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

fundraising_notice_options.expiration_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

fundraising_notice_options.expiration_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

fundraising_notice_options.expiration_date_range_end.relative_tostring(Relative To)required

fundraising_notice_options.expiration_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

fundraising_notice_options.expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

fundraising_notice_options.expiration_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

fundraising_notice_options.expiration_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

fundraising_notice_options.expiration_date_range_start.relative_tostring(Relative To)required

fundraising_notice_options.expiration_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

fundraising_notice_options.notice_idstring(Notice)

The notice to send the school

fundraising_notice_options.phase_idsArray of strings(Phases)non-emptyrequired

fundraising_notice_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

fundraising_notice_options.program_idsArray of strings(Programs)non-emptyrequired

fundraising_notice_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

fundraising_notice_options.school_idsArray of strings(Schools)non-emptyrequired

fundraising_notice_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

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

The unique, string identifier of this billing template

is_activeboolean(Is Active)

Whether or not this billing template is active

namestring(Name)required

The name of the billing template

notification_emailstring(Notification Email)

Te address to send notifications

phase_advancement_optionsobject(Phase Advancement Options)required

phase_advancement_options.expiration_date_range_endobject(Expiration Date Range End)required

The date to use to filter out which memberships are candidate

phase_advancement_options.expiration_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

phase_advancement_options.expiration_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

phase_advancement_options.expiration_date_range_end.relative_tostring(Relative To)required

phase_advancement_options.expiration_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

phase_advancement_options.expiration_date_range_startobject(Expiration Date Range Start)required

The date to use to filter out which memberships are candidate

phase_advancement_options.expiration_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

phase_advancement_options.expiration_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

phase_advancement_options.expiration_date_range_start.relative_tostring(Relative To)required

phase_advancement_options.expiration_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

phase_advancement_options.notice_idstring(Notice)

The notice to send the school when advancing

phase_advancement_options.phase_idsArray of strings(Phases)non-emptyrequired

phase_advancement_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

phase_advancement_options.program_idsArray of strings(Programs)non-emptyrequired

phase_advancement_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

phase_advancement_options.school_idsArray of strings(Schools)non-emptyrequired

phase_advancement_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

send_fundraising_noticesboolean(Send Fundraising Notices)

If set, this billing run will perform phase advancements

send_team_noticesboolean(Send Team Notices)

If set, this billing run will perform phase advancements

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_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

team_notice_optionsobject(Team Notice Options)required

team_notice_options.phase_idsArray of strings(Phases)non-emptyrequired

team_notice_options.phase_restrictionstring(Phase Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.program_idsArray of strings(Programs)non-emptyrequired

team_notice_options.program_restrictionstring(Program Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.school_idsArray of strings(Schools)non-emptyrequired

team_notice_options.school_restrictionstring(School Restriction)

Determines if/how to restrict the programs in this run

Enum"exclude""include""none"

team_notice_options.team_notice_idstring(Team Notice)

The notice to send the school

team_notice_options.visit_start_date_range_endobject(date)(Visit Start Date Range End)required

The date to use to filter out which visits to use

team_notice_options.visit_start_date_range_end.numbernumber(float)(Number)>= 0

The unit of time

team_notice_options.visit_start_date_range_end.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

team_notice_options.visit_start_date_range_end.relative_tostring(Relative To)required

team_notice_options.visit_start_date_range_end.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

team_notice_options.visit_start_date_range_startobject(date)(Visit Start Date Range Start)required

The date to use to filter out which visits to use

team_notice_options.visit_start_date_range_start.numbernumber(float)(Number)>= 0

The unit of time

team_notice_options.visit_start_date_range_start.positionstring(Position)required

How the unit relates to the reference date

Enum"after""before""on"

team_notice_options.visit_start_date_range_start.relative_tostring(Relative To)required

team_notice_options.visit_start_date_range_start.unit_of_timestring(Unit Of Time)

Enum"days""months""weeks""years"

team_notice_options.visit_type_idsArray of strings(Visit Types)non-emptyrequired

team_notice_options.visit_type_restrictionstring(Visit Type Restriction)

Determines if/how to restrict the visit_types in this run

Enum"exclude""include""none"

Response

application/json

{
  "advance_phases": true,
  "description": "string",
  "fundraising_notice_options": {
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "notice_id": "string",
    "phase_ids": [ … ],
    "phase_restriction": "exclude",
    "program_ids": [ … ],
    "program_restriction": "exclude",
    "school_ids": [ … ],
    "school_restriction": "exclude"
  },
  "id": "string",
  "is_active": true,
  "name": "string",
  "notification_email": "string",
  "phase_advancement_options": {
    "expiration_date_range_end": { … },
    "expiration_date_range_start": { … },
    "notice_id": "string",
    "phase_ids": [ … ],
    "phase_restriction": "exclude",
    "program_ids": [ … ],
    "program_restriction": "exclude",
    "school_ids": [ … ],
    "school_restriction": "exclude"
  },
  "send_fundraising_notices": true,
  "send_team_notices": true,
  "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_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,
  "team_notice_options": {
    "phase_ids": [ … ],
    "phase_restriction": "exclude",
    "program_ids": [ … ],
    "program_restriction": "exclude",
    "school_ids": [ … ],
    "school_restriction": "exclude",
    "team_notice_id": "string",
    "visit_start_date_range_end": { … },
    "visit_start_date_range_start": { … },
    "visit_type_ids": [ … ],
    "visit_type_restriction": "exclude"
  }
}

Campaigns

Operations

Donor Clubs

Operations

Donor Levels

Operations

Donor Statement Templates

Operations

Donor Statements

Operations

Donors

Operations

Fund Categories

Operations

Funds

Operations

Gift Notices

Operations

Gifts

Operations

Giving Processes

Operations

Pledge Levels

Operations

Pledge Notices

Operations

Pledges

Operations

Premiums

Operations

Products

Operations

Query Definitions

Operations

Recurring Gifts

Operations

Settings

Operations

Statistics

Operations

Fundraising (v1-2025-04-18)

Appeals

Billing Templates

Gets all of the billing templates in the system.

Request

Responses

Was this helpful?

Creates a new billing template record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Generates a billing run from a template

Request

Responses

Was this helpful?

Returns a billing template from the system by its ID.

Request

Responses

Was this helpful?

Returns a billing template from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a billing template with the specified ID.

Request

Responses

Was this helpful?

Updates a billing template with the specified ID.

RequestExpand all

Responses

Was this helpful?

Campaigns

Donor Clubs

Donor Levels

Donor Statement Templates

Donor Statements

Donors

Fund Categories

Funds

Gift Notices

Gifts

Giving Processes

Pledge Levels

Pledge Notices

Pledges

Premiums

Products

Query Definitions

Recurring Gifts

Settings

Statistics

Request

Request