Donations

Donations Documentation

Donation [LIST]

Donation [LIST]

Request

Endpoint

GET /api/v2/account_lists/ed1e27ca-148d-4fbe-b3d2-8f7cbfecd96f/donations
Content-Type: application/vnd.api+json

Body

Parameters

Sorts

donation_date

Type Unknown

Description Sort by donation_date date

Required No

Filters

designation_account_id

Type ID string

Description Filter where donation designation_account_id is in the collection; accepts ids separated by comma

Required No

donation_date

Type date

Description Filter where donation_date is within provided date range

Required No

donor_account_id

Type ID string

Description Filter where donation donor_account_id is in the collection; accepts ids separated by comma

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "a7939ace-658c-4517-bd59-bccb9626d653",
      "type": "donations",
      "attributes": {
        "amount": "10.0",
        "appeal_amount": "0.0",
        "channel": "MyString",
        "converted_amount": 10.0,
        "converted_appeal_amount": 0.0,
        "converted_currency": "USD",
        "created_at": "2022-01-12T17:18:34Z",
        "currency": "ZAR",
        "donation_date": "2022-01-12",
        "legacy_remote_id": null,
        "memo": "MyText",
        "motivation": "MyString",
        "payment_method": "MyString",
        "payment_type": "MyString",
        "remote_id": "15",
        "tendered_amount": "9.99",
        "tendered_currency": "ZAR",
        "updated_at": "2022-01-12T17:18:34Z",
        "updated_in_db_at": "2022-01-12T17:18:34Z"
      },
      "relationships": {
        "appeal": {
          "data": null
        },
        "contact": {
          "data": {
            "id": "9bf035a8-407e-48a1-8128-450c37b814be",
            "type": "contacts"
          }
        },
        "designation_account": {
          "data": {
            "id": "99530240-4c81-4e55-8585-3bece854e0ae",
            "type": "designation_accounts"
          }
        },
        "donor_account": {
          "data": {
            "id": "fa77eff6-15bf-4299-8e4d-085b6642b17d",
            "type": "donor_accounts"
          }
        },
        "pledge": {
          "data": null
        }
      }
    },
    {
      "id": "2a74114f-8cbf-4fa7-bb88-c314f484cea1",
      "type": "donations",
      "attributes": {
        "amount": "10.0",
        "appeal_amount": "0.0",
        "channel": "MyString",
        "converted_amount": 10.0,
        "converted_appeal_amount": 0.0,
        "converted_currency": "USD",
        "created_at": "2022-01-12T17:18:34Z",
        "currency": "ZAR",
        "donation_date": "2022-01-12",
        "legacy_remote_id": null,
        "memo": "MyText",
        "motivation": "MyString",
        "payment_method": "MyString",
        "payment_type": "MyString",
        "remote_id": "16",
        "tendered_amount": "9.99",
        "tendered_currency": "ZAR",
        "updated_at": "2022-01-12T17:18:34Z",
        "updated_in_db_at": "2022-01-12T17:18:34Z"
      },
      "relationships": {
        "appeal": {
          "data": null
        },
        "contact": {
          "data": {
            "id": "9bf035a8-407e-48a1-8128-450c37b814be",
            "type": "contacts"
          }
        },
        "designation_account": {
          "data": {
            "id": "99530240-4c81-4e55-8585-3bece854e0ae",
            "type": "designation_accounts"
          }
        },
        "donor_account": {
          "data": {
            "id": "fa77eff6-15bf-4299-8e4d-085b6642b17d",
            "type": "donor_accounts"
          }
        },
        "pledge": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 2,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    },
    "totals": [
      {
        "amount": "20.0",
        "converted": 20.0,
        "currency": "ZAR"
      }
    ]
  }
}

Fields

data

Type [Donation]

Description An array of Donations

Donation [POST]

Donation [POST]

Request

Endpoint

POST /api/v2/account_lists/72b58424-583e-4967-bb36-c668cec3699c/donations
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "donations",
    "attributes": {
      "amount": 10.0,
      "appeal_amount": "0.00",
      "channel": "MyString",
      "currency": "ZAR",
      "donation_date": "2022-01-12",
      "memo": "MyText",
      "motivation": "MyString",
      "payment_method": "MyString",
      "payment_type": "MyString",
      "remote_id": "19",
      "tendered_amount": "9.99",
      "tendered_currency": "ZAR",
      "updated_in_db_at": "2022-01-12 17:18:35 UTC"
    },
    "relationships": {
      "donor_account": {
        "data": {
          "type": "donor_accounts",
          "id": "025dd352-6b35-4229-a119-760da9eb8d9b"
        }
      },
      "designation_account": {
        "data": {
          "type": "designation_accounts",
          "id": "d2a58115-491e-4b79-9b15-0a15ee87a0a3"
        }
      }
    }
  }
}

Parameters

Attributes

amount

Type number

Description The original amount

Required No

appeal_amount

Type number

Description The portion of the donation committed to an appeal

Required No

channel

Type string

Description The location where the donation took place

Required No

converted_amount

Type number

Description The amount converted to the receiving organization currency

Required No

converted_appeal_amount

Type number

Description The portion of the converted amount committed to an appeal

Required No

converted_currency

Type string

Description The receiving organization currency

Required No

created_at

Type date

Description The timestamp of when this resource was created

Required No

currency

Type string

Description The currency of the original amount

Required No

donation_date

Type date

Description The date the donation was received

Required No

legacy_remote_id

Type ID string

Description The remote system id given by the legacy orgin system

Required No

memo

Type string

Description Additional notes in relation to this donation

Required No

motivation

Type string

Description The reason why the donor gave the donation

Required No

payment_method

Type string

Description The method the donor used to give their donation

Required No

payment_type

Type string

Description If the donation is recurring in nature

Required No

remote_id

Type ID string

Description The remote system id given by the origin system

Required No

tendered_amount

Type number

Description The actual amount received after applicable fees

Required No

tendered_currency

Type string

Description The currency the donation now resides in

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

Relationships

appeal.data

Type Appeal

Description The appeal that the appeal amount contributes to

Required No

contact.data

Type Contact

Description The contact that this donation is connected with within the account list

Required No

designation_account.data

Type Designation Account

Description The designation account the donation belongs to

Required No

donor_account.data

Type Donor Account

Description The donor account the donation belongs to

Required No

pledge.data

Type Pledge

Description The pledge that this appeal amount contributes to

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

Body

{
  "data": {
    "id": "61427a4b-d51f-4799-adc4-8bf1b6b1243b",
    "type": "donations",
    "attributes": {
      "amount": "10.0",
      "appeal_amount": "0.0",
      "channel": "MyString",
      "converted_amount": 10.0,
      "converted_appeal_amount": 0.0,
      "converted_currency": "USD",
      "created_at": "2022-01-12T17:18:35Z",
      "currency": "ZAR",
      "donation_date": "2022-01-12",
      "legacy_remote_id": null,
      "memo": "MyText",
      "motivation": "MyString",
      "payment_method": "MyString",
      "payment_type": "MyString",
      "remote_id": "19",
      "tendered_amount": "9.99",
      "tendered_currency": "ZAR",
      "updated_at": "2022-01-12T17:18:35Z",
      "updated_in_db_at": "2022-01-12T17:18:35Z"
    },
    "relationships": {
      "appeal": {
        "data": null
      },
      "contact": {
        "data": {
          "id": "a18274c5-60e3-4f9e-be24-15ce6127242f",
          "type": "contacts"
        }
      },
      "designation_account": {
        "data": {
          "id": "d2a58115-491e-4b79-9b15-0a15ee87a0a3",
          "type": "designation_accounts"
        }
      },
      "donor_account": {
        "data": {
          "id": "025dd352-6b35-4229-a119-760da9eb8d9b",
          "type": "donor_accounts"
        }
      },
      "pledge": {
        "data": null
      }
    }
  }
}

Fields

Attributes

amount

Type number

Description The original amount

appeal_amount

Type number

Description The portion of the donation committed to an appeal

channel

Type string

Description The location where the donation took place

converted_amount

Type number

Description The amount converted to the receiving organization currency

converted_appeal_amount

Type number

Description The portion of the converted amount committed to an appeal

converted_currency

Type string

Description The receiving organization currency

created_at

Type date

Description The timestamp of when this resource was created

currency

Type string

Description The currency of the original amount

donation_date

Type date

Description The date the donation was received

legacy_remote_id

Type ID string

Description The remote system id given by the legacy orgin system

memo

Type string

Description Additional notes in relation to this donation

motivation

Type string

Description The reason why the donor gave the donation

payment_method

Type string

Description The method the donor used to give their donation

payment_type

Type string

Description If the donation is recurring in nature

remote_id

Type ID string

Description The remote system id given by the origin system

tendered_amount

Type number

Description The actual amount received after applicable fees

tendered_currency

Type string

Description The currency the donation now resides in

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

appeal.data

Type Appeal

Description The appeal that the appeal amount contributes to

contact.data

Type Contact

Description The contact that this donation is connected with within the account list

designation_account.data

Type Designation Account

Description The designation account the donation belongs to

donor_account.data

Type Donor Account

Description The donor account the donation belongs to

pledge.data

Type Pledge

Description The pledge that this appeal amount contributes to

Donation [GET]

Donation [GET]

Request

Endpoint

GET /api/v2/account_lists/ab3f8517-0bd7-4c08-8572-b9161e737d3c/donations/39e696a1-8e91-41b0-b731-28b57c813888
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "39e696a1-8e91-41b0-b731-28b57c813888",
    "type": "donations",
    "attributes": {
      "amount": "10.0",
      "appeal_amount": "0.0",
      "channel": "MyString",
      "converted_amount": 10.0,
      "converted_appeal_amount": 0.0,
      "converted_currency": "USD",
      "created_at": "2022-01-12T17:18:34Z",
      "currency": "ZAR",
      "donation_date": "2022-01-12",
      "legacy_remote_id": null,
      "memo": "MyText",
      "motivation": "MyString",
      "payment_method": "MyString",
      "payment_type": "MyString",
      "remote_id": "12",
      "tendered_amount": "9.99",
      "tendered_currency": "ZAR",
      "updated_at": "2022-01-12T17:18:34Z",
      "updated_in_db_at": "2022-01-12T17:18:34Z"
    },
    "relationships": {
      "appeal": {
        "data": null
      },
      "contact": {
        "data": {
          "id": "11009ce3-6f4e-483d-94e8-c788e4679621",
          "type": "contacts"
        }
      },
      "designation_account": {
        "data": {
          "id": "8cb45c3c-80bb-47aa-bf23-3a63060c4566",
          "type": "designation_accounts"
        }
      },
      "donor_account": {
        "data": {
          "id": "eb3e9764-9353-40e3-b1c7-635578bbe9f4",
          "type": "donor_accounts"
        }
      },
      "pledge": {
        "data": null
      }
    }
  }
}

Fields

Attributes

amount

Type number

Description The original amount

appeal_amount

Type number

Description The portion of the donation committed to an appeal

channel

Type string

Description The location where the donation took place

converted_amount

Type number

Description The amount converted to the receiving organization currency

converted_appeal_amount

Type number

Description The portion of the converted amount committed to an appeal

converted_currency

Type string

Description The receiving organization currency

created_at

Type date

Description The timestamp of when this resource was created

currency

Type string

Description The currency of the original amount

donation_date

Type date

Description The date the donation was received

legacy_remote_id

Type ID string

Description The remote system id given by the legacy orgin system

memo

Type string

Description Additional notes in relation to this donation

motivation

Type string

Description The reason why the donor gave the donation

payment_method

Type string

Description The method the donor used to give their donation

payment_type

Type string

Description If the donation is recurring in nature

remote_id

Type ID string

Description The remote system id given by the origin system

tendered_amount

Type number

Description The actual amount received after applicable fees

tendered_currency

Type string

Description The currency the donation now resides in

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

appeal.data

Type Appeal

Description The appeal that the appeal amount contributes to

contact.data

Type Contact

Description The contact that this donation is connected with within the account list

designation_account.data

Type Designation Account

Description The designation account the donation belongs to

donor_account.data

Type Donor Account

Description The donor account the donation belongs to

pledge.data

Type Pledge

Description The pledge that this appeal amount contributes to

Donation [PUT]

Donation [PUT]

Request

Endpoint

PUT /api/v2/account_lists/4179d358-3a22-4f0d-a627-d5dd0d4be90a/donations/3184e052-54ad-4f8b-bccb-7bac59c73c41
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "donations",
    "attributes": {
      "amount": 10.0,
      "appeal_amount": "0.00",
      "channel": "MyString",
      "currency": "ZAR",
      "donation_date": "2022-01-12",
      "memo": "MyText",
      "motivation": "MyString",
      "payment_method": "MyString",
      "payment_type": "MyString",
      "remote_id": "9",
      "tendered_amount": "9.99",
      "tendered_currency": "ZAR",
      "updated_in_db_at": "2022-01-12 17:18:34 UTC"
    },
    "relationships": {
      "donor_account": {
        "data": {
          "type": "donor_accounts",
          "id": "b3d59414-c9fb-4633-85f4-625c789adf4a"
        }
      },
      "designation_account": {
        "data": {
          "type": "designation_accounts",
          "id": "279aacc3-b7cb-4e10-9b70-c61adeab8a0d"
        }
      }
    }
  }
}

Parameters

Attributes

amount

Type number

Description The original amount

Required No

appeal_amount

Type number

Description The portion of the donation committed to an appeal

Required No

channel

Type string

Description The location where the donation took place

Required No

converted_amount

Type number

Description The amount converted to the receiving organization currency

Required No

converted_appeal_amount

Type number

Description The portion of the converted amount committed to an appeal

Required No

converted_currency

Type string

Description The receiving organization currency

Required No

created_at

Type date

Description The timestamp of when this resource was created

Required No

currency

Type string

Description The currency of the original amount

Required No

donation_date

Type date

Description The date the donation was received

Required No

legacy_remote_id

Type ID string

Description The remote system id given by the legacy orgin system

Required No

memo

Type string

Description Additional notes in relation to this donation

Required No

motivation

Type string

Description The reason why the donor gave the donation

Required No

overwrite

Type boolean

Description Only used for updating a record where you want to ignore the server's ' 'updated_in_db_at value and force overwrite the values for the record. ' 'Must be true to work.

Required No

payment_method

Type string

Description The method the donor used to give their donation

Required No

payment_type

Type string

Description If the donation is recurring in nature

Required No

remote_id

Type ID string

Description The remote system id given by the origin system

Required No

tendered_amount

Type number

Description The actual amount received after applicable fees

Required No

tendered_currency

Type string

Description The currency the donation now resides in

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

Relationships

appeal.data

Type Appeal

Description The appeal that the appeal amount contributes to

Required No

contact.data

Type Contact

Description The contact that this donation is connected with within the account list

Required No

designation_account.data

Type Designation Account

Description The designation account the donation belongs to

Required No

donor_account.data

Type Donor Account

Description The donor account the donation belongs to

Required No

pledge.data

Type Pledge

Description The pledge that this appeal amount contributes to

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "3184e052-54ad-4f8b-bccb-7bac59c73c41",
    "type": "donations",
    "attributes": {
      "amount": "10.0",
      "appeal_amount": "0.0",
      "channel": "MyString",
      "converted_amount": 10.0,
      "converted_appeal_amount": 0.0,
      "converted_currency": "USD",
      "created_at": "2022-01-12T17:18:34Z",
      "currency": "ZAR",
      "donation_date": "2022-01-12",
      "legacy_remote_id": null,
      "memo": "MyText",
      "motivation": "MyString",
      "payment_method": "MyString",
      "payment_type": "MyString",
      "remote_id": "9",
      "tendered_amount": "9.99",
      "tendered_currency": "ZAR",
      "updated_at": "2022-01-12T17:18:34Z",
      "updated_in_db_at": "2022-01-12T17:18:34Z"
    },
    "relationships": {
      "appeal": {
        "data": null
      },
      "contact": {
        "data": {
          "id": "6a135c3a-84dd-41cb-ab00-b9fa81d9bd14",
          "type": "contacts"
        }
      },
      "designation_account": {
        "data": {
          "id": "279aacc3-b7cb-4e10-9b70-c61adeab8a0d",
          "type": "designation_accounts"
        }
      },
      "donor_account": {
        "data": {
          "id": "b3d59414-c9fb-4633-85f4-625c789adf4a",
          "type": "donor_accounts"
        }
      },
      "pledge": {
        "data": null
      }
    }
  }
}

Fields

Attributes

amount

Type number

Description The original amount

appeal_amount

Type number

Description The portion of the donation committed to an appeal

channel

Type string

Description The location where the donation took place

converted_amount

Type number

Description The amount converted to the receiving organization currency

converted_appeal_amount

Type number

Description The portion of the converted amount committed to an appeal

converted_currency

Type string

Description The receiving organization currency

created_at

Type date

Description The timestamp of when this resource was created

currency

Type string

Description The currency of the original amount

donation_date

Type date

Description The date the donation was received

legacy_remote_id

Type ID string

Description The remote system id given by the legacy orgin system

memo

Type string

Description Additional notes in relation to this donation

motivation

Type string

Description The reason why the donor gave the donation

payment_method

Type string

Description The method the donor used to give their donation

payment_type

Type string

Description If the donation is recurring in nature

remote_id

Type ID string

Description The remote system id given by the origin system

tendered_amount

Type number

Description The actual amount received after applicable fees

tendered_currency

Type string

Description The currency the donation now resides in

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

appeal.data

Type Appeal

Description The appeal that the appeal amount contributes to

contact.data

Type Contact

Description The contact that this donation is connected with within the account list

designation_account.data

Type Designation Account

Description The designation account the donation belongs to

donor_account.data

Type Donor Account

Description The donor account the donation belongs to

pledge.data

Type Pledge

Description The pledge that this appeal amount contributes to

Donation [DELETE]

Donation [DELETE]

Request

Endpoint

DELETE /api/v2/account_lists/fe30bf94-c21e-4214-acb0-dd44c87b9013/donations/730c9915-be29-47d6-b4c0-a03693134be5
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body