Get a specific pledge date

GET /pledgedate/{id}
OAuth2

Return a specific pledge date that the user is able to see.

Path parameters

  • id integer Required

    Which item to be processed

    Minimum value is 0.

Responses

  • 200 application/json

    List returned OK

    Hide response attributes Show response attributes object
    • id integer

      Minimum value is 1.

    • pledge_id integer

      Required. Must link to a Pledge that the user can see

      Minimum value is 1.

    • status string

      Required. The status of this specific pledge date P = Planned SC = Scheduled PR = For payment methods that do not require infoodle to take payments e.g. Bank transfers, this has been Processed PD = Paid X = Deleted

      Values are P, X, SC, PD, or PR.

    • payment_date_local string

      The local date that this pledge is to be processed

    • amount number

      The amount of this specific pledge. This can be different to other dates in this pledge

    • form_entry_id integer

      Matches the other form_entry_id values in this pledge. Optional and links to an form entry

    • user_id integer

      CORE user_id that this pledge is for

    • paid_date_local string

      If this specific pledge date is paid (status PD) then this is the date it was paid

    • transaction_id integer

      If this is paid then the transaction that has the payment information

    • matched_status string

      Whether this has been matched up with a transaction

    • gateway_fees number

      If this is paid with a payment gateway that has fees identified, this is the amount of fees applicable to this transaction

    • bank_response string

      If this is paid by a method that infoodle processes e.g. stripe, and the payment for this failed. This is the message

    • datetime_created_utc string

      The date/time in UTC that this pledge was created

    • datetime_modified_utc string

      The date/time in UTC that this pledge was modified
  • 401 application/json

    Authentication unauthorised

    Hide response attribute Show response attribute object
  • 403 application/json

    Invalid permission

    Hide response attribute Show response attribute object
  • 404 application/json

    Not Found

    Hide response attribute Show response attribute object
GET /pledgedate/{id} 
curl \
 -X GET https://YOURSITE.infoodle.com/apiv2/pledgedate/99 \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "id": 123,
  "pledge_id": 544,
  "status": "P",
  "payment_date_local": "2017-07-18",
  "amount": 30,
  "form_entry_id": 76,
  "user_id": 569,
  "paid_date_local": "2024-12-31",
  "transaction_id": 435123,
  "matched_status": "M",
  "gateway_fees": 3.45,
  "bank_response": "Card declined",
  "datetime_created_utc": "2017-07-18 23:15:10",
  "datetime_modified_utc": "2017-09-18 12:12:10"
}
Response examples (401) 
{
  "error": "Unauthorised"
}
Response examples (403) 
{
  "error": "Invalid Permission"
}
Response examples (404) 
{
  "error": "Not Found"
}