Get a single direct debit mandate | PlannrCRM API documentation

Get a single direct debit mandate Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

      
          mcp.json

"PlannrCRM MCP server": {
  "url": "https://apidocs.plannrcrm.com/mcp"
}

GET /api/v2/direct-debit-mandates/{uuid}

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

uuid string Required
direct_debit_mandate string Required

The uuid of the direct debit mandate to show.

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- completed_at string
  
  The timestamp of when the direct debit mandate was completed.
- firm object
  
  The firm that the application belongs to.
  
  Hide firm attributes Show firm attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  address_1 string
  
  address_2 string
  
  town_city string
  
  county string
  
  postcode string
  
  country string
  
  regulatory_text string
  
  logo string
  
  logo_icon string
  
  brand_colours object
  
  Hide brand_colours attributes Show brand_colours attributes object
  
  sidebar_background string
  
  sidebar_accent string
  
  sidebar_text string
  
  sidebar_hover string
  
  sidebar_active string
  
  sidebar_title_background string
  
  sidebar_title_primary string
  
  sidebar_title_secondary string
  
  sidebar_title_secondary_hover string
  
  email_background string
  
  email_logo_background_panel string
  
  email_sub_text string
  
  email_button_background string
  
  email_button_text string
  
  portal_sidebar_button_background string
  
  portal_sidebar_button_hover string
  
  portal_sidebar_button_active string
  
  portal_brand_title string
  
  portal_brand_sub_title string
  
  portal_sidebar_title string
  
  portal_sidebar_text string
  
  portal_sidebar_text_hover string
  
  portal_sidebar_text_active string
  
  portal_sidebar_icon string
  
  portal_sidebar_icon_hover string
  
  portal_sidebar_icon_active string
  
  portal_background string
  
  portal_sidebar_account_title string
  
  portal_sidebar_account_email string
  
  portal_sidebar_divider string
  
  portal_dashboard_bg_one string
  
  portal_dashboard_bg_two string
  
  portal_sidebar_collapse_button string
  
  portal_sidebar_collapse_button_hover string
  
  portal_sidebar_user_select_background string
  
  portal_sidebar_user_select_hover string
  
  portal_sidebar_user_select_text string
  
  portal_sidebar_user_select_text_hover string
  
  portal_sidebar_user_select_border string
  
  portal_sidebar_user_select_border_hover string
  
  is_subscribed boolean
  
  addon_subscriptions string
  
  keep_deleted_files_for integer
  
  tax number
  
  month_end integer
  
  statement_frequency string
  
  billing object
  
  Hide billing attributes Show billing attributes object
  
  invoice_address_1 string
  
  invoice_address_2 string
  
  invoice_town_city string
  
  invoice_county string
  
  invoice_postcode string
  
  invoice_country string
  
  invoice_email string
  
  task_board_template string
  
  ip_whitelist array[string]
  
  welcome_paragraph_html string
  
  email_welcome_paragraph_html string
  
  show_fact_find_illustrations boolean
  
  cc_email_addresses array[string]
  
  bcc_email_addresses array[string]
  
  reply_to_email_address string
  
  mobile_app_support_number string
  
  mobile_app_support_email string
- account object
  
  The account the direct debit mandate belongs to.
  
  Hide account attributes Show account attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  external_references string
- supported_platform string
  
  The Platform linked with the direct debit mandate.

GET /api/v2/direct-debit-mandates/{uuid}

curl \
 --request GET 'https://api.plannrcrm.com/api/v2/direct-debit-mandates/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "uuid": "9f404d81-3ae8-4096-bac1-15cddc901105",
  "created_at": "2026-06-08T16:08:04+01:00",
  "updated_at": "2026-06-08T16:08:04+01:00",
  "completed_at": "2026-06-08T16:08:04+01:00",
  "firm": {
    "uuid": "a5c63a46-b5a2-4abd-b6db-9222b6d58e1a",
    "created_at": "2026-06-08T16:08:04+01:00",
    "updated_at": "2026-06-08T16:08:04+01:00",
    "name": "Codepotato",
    "slug": "codepotato",
    "address_1": "Suite E, 5 The Briars",
    "address_2": "Waterberry Drive",
    "town_city": "Waterlooville",
    "county": "Hampshire",
    "postcode": "PO7 7YH",
    "country": "United Kingdom",
    "regulatory_text": "Regulatory text",
    "logo": "https://api.plannrcrm.com/images/plannr.jpg",
    "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
    "brand_colours": {
      "sidebar_background": "#0E0E56",
      "sidebar_accent": "#36367E",
      "sidebar_text": "#FFFFFF",
      "sidebar_hover": "#0A0A42",
      "sidebar_active": "#53DBB8",
      "sidebar_title_background": "#36367E",
      "sidebar_title_primary": "#FFC634",
      "sidebar_title_secondary": "#FFFFFF",
      "sidebar_title_secondary_hover": "#FFFFFF",
      "email_background": "#0E0E56",
      "email_logo_background_panel": "#36367E",
      "email_sub_text": "#FFFFFF",
      "email_button_background": "#36367E",
      "email_button_text": "#FFFFFF",
      "portal_sidebar_button_background": "#F6F6F6",
      "portal_sidebar_button_hover": "#FFFFFF",
      "portal_sidebar_button_active": "#FFFFFF",
      "portal_brand_title": "#323B4B",
      "portal_brand_sub_title": "#828994",
      "portal_sidebar_title": "#11151D",
      "portal_sidebar_text": "#323B4B",
      "portal_sidebar_text_hover": "#323B4B",
      "portal_sidebar_text_active": "#323B4B",
      "portal_sidebar_icon": "#828994",
      "portal_sidebar_icon_hover": "#828994",
      "portal_sidebar_icon_active": "#828994",
      "portal_background": "#F6F6F6",
      "portal_sidebar_account_title": "#11151D",
      "portal_sidebar_account_email": "#828994",
      "portal_sidebar_divider": "#E3E5E9",
      "portal_dashboard_bg_one": "#EF4583",
      "portal_dashboard_bg_two": "#FFC634",
      "portal_sidebar_collapse_button": "#828994",
      "portal_sidebar_collapse_button_hover": "#B3B9C4",
      "portal_sidebar_user_select_background": "#F6F6F6",
      "portal_sidebar_user_select_hover": "#F6F6F6",
      "portal_sidebar_user_select_text": "#323B4B",
      "portal_sidebar_user_select_text_hover": "#323B4B",
      "portal_sidebar_user_select_border": "#EEEEEE",
      "portal_sidebar_user_select_border_hover": "#828994"
    },
    "is_subscribed": true,
    "addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
    "keep_deleted_files_for": 30,
    "tax": 17.5,
    "month_end": 25,
    "statement_frequency": "monthly",
    "billing": {
      "invoice_address_1": "Suite E, 5 The Briars",
      "invoice_address_2": "Waterberry Drive",
      "invoice_town_city": "Waterlooville",
      "invoice_county": "Hampshire",
      "invoice_postcode": "PO7 7YH",
      "invoice_country": "United Kingdom",
      "invoice_email": "gareth@codepotato.co.uk"
    },
    "task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
    "ip_whitelist": [
      "192.168.0.1",
      "127.0.0.1"
    ],
    "welcome_paragraph_html": "<h1>Welcome.</h1>",
    "email_welcome_paragraph_html": "Welcome to Plannr!",
    "show_fact_find_illustrations": true,
    "cc_email_addresses": [
      "jack@example.com",
      "jill@example.com"
    ],
    "bcc_email_addresses": [
      "jack@example.com",
      "jill@example.com"
    ],
    "reply_to_email_address": "jack@example.com",
    "mobile_app_support_number": "01234 567890",
    "mobile_app_support_email": "support@example.com"
  },
  "account": {
    "uuid": "d6ae04fc-4db0-49e7-8418-56fff0d45f81",
    "created_at": "2026-06-08T16:08:04+01:00",
    "updated_at": "2026-06-08T16:08:04+01:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "supported_platform": "seccl"
}