v1

latestOpenAPI 3.0.02026-08-062903562.2 MB

Credit Adjustment

createCampaignCreditAdjustment

Create Credential Adjustment for specified Campaign

post/campaigns/{campaign}/credit-adjustments

Path parameters

campaigninteger required

Example:227362

The specified Campaign ID

Request body

amountinteger

The amount of the Credit Adjustment. Positive values add credit to a Fundraising Entity. Negative values remove credit

metadatastring

Arbitrary JSON metadata

memostring

An arbitrary memo about the Credit Adjustment.

Example request

{
  "amount": -40,
  "metadata": "{'foo':'bar'}",
  "memo": "Credit applied from previous fundraising event."
}

Response

Success

idinteger

Primary identifier of record

amountinteger

The amount of the Credit Adjustment. Positive values add credit to a Fundraising Entity. Negative values remove credit

metadatastring

Arbitrary JSON metadata

memostring

An arbitrary memo about the Credit Adjustment.

organization_idinteger

Primary identifier of associated Organization

creditable_idinteger

Primary identifier of associated Creditable

creditable_type'campaign' | 'fundraising_page' | 'fundraising_team'

Type of associated Creditable

amount_receivedinteger

The amount of the Credit Adjustment received

created_atstring date-time

Date/time of initial record creation

updated_atstring date-time

Date/time of last record update

campaign_idinteger

Primary identifier of associated Campaign

Example response

{
  "id": 6743,
  "amount": -40,
  "metadata": "{'foo':'bar'}",
  "memo": "Credit applied from previous fundraising event.",
  "organization_id": 82364,
  "creditable_id": 227362,
  "creditable_type": "campaign",
  "amount_received": -40,
  "created_at": "2021-04-23T08:23:21Z",
  "updated_at": "2021-04-23T10:25:03Z",
  "campaign_id": 227362
}