Get all firm's direct debit mandates

GET /api/v2/direct-debit-mandates
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[created_date] string

    Filter by created date. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.

  • filter[updated_date] string

    Filter by last updated date. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.

  • filter[completed_date] string

    Filter by completed date. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.

  • filter[is_completed] string

    affects whether to include direct debit mandates based on the completed state. Valid options are "exclude", "include", "only". (default: "include")

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, completed_at]. Negative sign to denote DESC. Defaults to '-created_at'.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

Responses

  • 401 application/json
    Hide response attribute Show response attribute object
    • message string
GET /api/v2/direct-debit-mandates 
curl \
 --request GET 'https://api.plannrcrm.com/api/v2/direct-debit-mandates' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (401) 
{
  "message": "Unauthenticated."
}