Create a contribution [DEPRECATED: Use transaction routes]

POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions

Headers

Path parameters

application/json

Body Required

  • type string Required

    The type of contribution. Available options: recurring and adhoc

  • contributor_type string

    The type of contributor. Available options: self, employer, family, government, salary_sacrifice and other

  • frequency string

    The frequency of the contribution. Required if the contribution type is "recurring". Available options: daily, weekly, fortnightly, four_weekly, monthly, bimonthly, quarterly, biannually, annually, adhoc and one_off

  • started_at date

    The start date of a recurring contribution. Required if the contribution type is "recurring".

  • ended_at date

    The end date of a recurring contribution. Required if the contribution type is "recurring".

  • paid_at date

    The date the adhoc contribution was paid. Required if the contribution type is "adhoc".

  • value integer

    The value of the contribution in pennies. For example, £40.00 would be 4000.

  • notes string

    Optional notes to add to the contribution.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      uuid of the contribution

    • created_at string

      datetime the contribution was created

    • updated_at string

      datetime the contribution was updated

    • paid_at string

      datetime the money was paid

    • value object

      contribution value

      Additional properties are allowed.
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions 
curl \
 -X POST https://api.plannrcrm.com/api/v1/plans/plan_uuid/sub-accounts/subAccount_uuid/contributions \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"type":"recurring","contributor_type":"self","frequency":"monthly","started_at":"2024-10-20","ended_at":"2024-11-20","paid_at":"2024-11-20","value":4000,"notes":"Example Notes"}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "type": "recurring",
  "contributor_type": "self",
  "frequency": "monthly",
  "started_at": "2024-10-20",
  "ended_at": "2024-11-20",
  "paid_at": "2024-11-20",
  "value": 4000,
  "notes": "Example Notes"
}
Response examples (200) 
{
  "uuid": "958feb42-5117-42ae-b07b-b5ff5c3f031e",
  "value": {
    "amount": {
      "example": "4000",
      "description": "Money amount at their lowest denominator (for example: pennies)"
    },
    "currency": {
      "example": "GBP",
      "description": "Currency of the money"
    },
    "formatted": {
      "example": "£40.00",
      "description": "Money amount formatted with currency"
    }
  },
  "paid_at": "2024-11-20T13:24:03+00:00",
  "created_at": "2024-11-20T13:24:03+00:00",
  "updated_at": "2024-11-20T13:24:03+00:00"
}