Get all charges

GET /api/v1/charge

Headers

Query parameters

include string

Comma separated list of relationships to include in the response. Valid relationships are [statement].
filter[uuid] string

Filter by a comma separated list of UUIDs.
filter[client_uuids] string

Filter by a comma separated list of client UUIDs.
filter[plan_uuids] string

Filter by a comma separated list of plan UUIDs.
filter[provider_uuids] string

Filter by a comma separated list of provider UUIDs.
filter[policy_number] string

Filter by policy numbers.
filter[seller_uuids] string

Filter by a comma separated list of seller account UUIDs.
filter[payment_origin] string

Filter by comma separated list of payment origins.
filter[type] string

Filter by comma separated list of charge types.
filter[category] string

Filter by comma separated list of charge categories.
filter[recurring] boolean

Filter by recurring charges or not.
filter[frequency] string

Filter by comma separated list of frequencies.
filter[start_date_after] string

Filter by charge start dates after.
filter[start_date_before] string

Filter by charge start dates before.
filter[end_date_after] string

Filter by charge end dates after.
filter[end_date_before] string

Filter by charge end dates before.
filter[next_expectation_date_after] string

Filter by charge next expectation dates after.
filter[next_expectation_date_before] string

Filter by charge next expectation dates before.
filter[amount_from] integer

Filter by charge fixed amounts from in pennies.
filter[amount_to] integer

Filter by charge fixed amounts to in pennies.
filter[percentage_from] number

Filter by charge percentages from.
filter[percentage_to] number

Filter by charge percentages to.
filter[tax_exempt] boolean

Filter by tax exempt charges or not.
filter[exclude_from_rmar] boolean

Filter by charges excluded from RMAR or not.
filter[rmar_type] string

Filter by comma separated list of RMAR types.
filter[advice_type] string

Filter by comma separated list of advice types.
filter[service_type] string

Filter by comma separated list of service types.
sort string

Field to sort by. Valid fields are [created_at, updated_at, start_date, end_date, next_expectation_date, amount, percentage]. Negative sign to denote DESC. Defaults to '-start_date'.
per_page integer

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

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]
  
  Additional properties are allowed.

GET /api/v1/charge

curl \
 -X GET https://api.plannrcrm.com/api/v1/charge \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "data": [
    {
      "tax": 17.5,
      "firm": {
        "tax": 17.5,
        "logo": "https://api.plannrcrm.com/images/plannr.jpg",
        "name": "Codepotato",
        "slug": "codepotato",
        "uuid": "3d163b64-0588-4fe3-a0bf-70d18a02ef48",
        "county": "Hampshire",
        "billing": {
          "invoice_email": "gareth@codepotato.co.uk",
          "invoice_county": "Hampshire",
          "invoice_country": "United Kingdom",
          "invoice_postcode": "PO7 7YH",
          "invoice_address_1": "Suite E, 5 The Briars",
          "invoice_address_2": "Waterberry Drive",
          "invoice_town_city": "Waterlooville"
        },
        "country": "United Kingdom",
        "postcode": "PO7 7YH",
        "address_1": "Suite E, 5 The Briars",
        "address_2": "Waterberry Drive",
        "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
        "month_end": 25,
        "town_city": "Waterlooville",
        "created_at": "2024-12-03T16:50:34+00:00",
        "updated_at": "2024-12-03T16:50:34+00:00",
        "ip_whitelist": [
          "192.168.0.1",
          "127.0.0.1"
        ],
        "brand_colours": {
          "sidebar_text": "#ffffff",
          "sidebar_hover": "#0A0A42",
          "email_sub_text": "#ffffff",
          "sidebar_accent": "#36367E",
          "sidebar_active": "#53DBB8",
          "email_background": "#0E0E56",
          "email_button_text": "#ffffff",
          "sidebar_background": "#0E0E56",
          "sidebar_title_primary": "#FFC634",
          "email_button_background": "#36367E",
          "sidebar_title_secondary": "#ffffff",
          "sidebar_title_background": "#36367E",
          "email_logo_background_panel": "#36367E",
          "sidebar_title_secondary_hover": "#ffffff"
        },
        "is_subscribed": true,
        "regulatory_text": "Regulatory text",
        "addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
        "statement_frequency": "monthly",
        "task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
        "keep_deleted_files_for": 30,
        "welcome_paragraph_html": "<h1>Welcome.</h1>",
        "email_welcome_paragraph_html": "Welcome to Plannr!"
      },
      "type": "fee",
      "uuid": "92cf444b-4bcd-468e-a65f-4ea48842696e",
      "amount": {
        "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"
        }
      },
      "author": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "7a1f2adc-fa48-4742-ac86-be3db56e75a1",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2024-12-03T16:50:34+00:00",
        "first_name": "Gareth",
        "updated_at": "2024-12-03T16:50:34+00:00",
        "with_login": true,
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "introduced_by": "App\\Http\\Resources\\AccountResource",
        "primary_email": "App\\Http\\Resources\\ContactDetailResource",
        "can_be_deleted": "false",
        "assigned_adviser": "App\\Http\\Resources\\AccountResource",
        "next_review_date": "2024-12-03T16:50:34+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2024-12-03T16:50:34+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2024-12-03T16:50:34+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2024-12-03T16:50:34+00:00"
      },
      "seller": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "f591ed64-bb36-4430-8264-2460d99b722b",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2024-12-03T16:50:34+00:00",
        "first_name": "Gareth",
        "updated_at": "2024-12-03T16:50:34+00:00",
        "with_login": true,
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "introduced_by": "App\\Http\\Resources\\AccountResource",
        "primary_email": "App\\Http\\Resources\\ContactDetailResource",
        "can_be_deleted": "false",
        "assigned_adviser": "App\\Http\\Resources\\AccountResource",
        "next_review_date": "2024-12-03T16:50:34+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2024-12-03T16:50:34+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2024-12-03T16:50:34+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2024-12-03T16:50:34+00:00"
      },
      "account": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "10455352-9403-4741-9aaa-1ca840964c13",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2024-12-03T16:50:34+00:00",
        "first_name": "Gareth",
        "updated_at": "2024-12-03T16:50:34+00:00",
        "with_login": true,
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "introduced_by": "App\\Http\\Resources\\AccountResource",
        "primary_email": "App\\Http\\Resources\\ContactDetailResource",
        "can_be_deleted": "false",
        "assigned_adviser": "App\\Http\\Resources\\AccountResource",
        "next_review_date": "2024-12-03T16:50:34+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2024-12-03T16:50:34+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2024-12-03T16:50:34+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2024-12-03T16:50:34+00:00"
      },
      "premium": {
        "plan": "App\\Http\\Resources\\Plans\\PlanResource",
        "uuid": "305a2de7-5d9c-448f-ba69-83b696196b42",
        "amount": 74584,
        "source": "employee",
        "details": "Extra premium details",
        "premium": 74584,
        "end_date": "2026-12-03",
        "frequency": "weekly",
        "created_at": "2024-12-03T16:50:34+00:00",
        "created_by": "App\\Http\\Resources\\AccountResource",
        "percentage": 5.5,
        "start_date": "2024-10-19",
        "updated_at": "2024-12-03T16:50:34+00:00",
        "transfer_type": "transfer",
        "payment_method": "direct_debit",
        "premium_monthly": 298336,
        "premium_annually": 3580032,
        "date_advice_given": "2024-06-12",
        "pensionable_salary": 10000000,
        "total_premium_to_date": 74584,
        "transferred_from_plan": "App\\Http\\Resources\\Plans\\PlanResource",
        "date_of_transfer_valuation": "2024-07-17",
        "transferred_from_plan_type": "cash_account",
        "transferred_from_plan_sub_type": "cash_deposit"
      },
      "category": "ongoing_fee",
      "end_date": "2025-01-03",
      "frequency": "monthly",
      "recurring": true,
      "rmar_type": "adviser_charge",
      "chargeable": {
        "name": "Johns ISA",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "cash_account",
        "uuid": "216b547e-8d41-43cf-9037-3d460fc82e29",
        "wrap": "App\\Http\\Resources\\Plans\\PlanResource",
        "cases": "App\\Http\\Resources\\CasesResource",
        "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"
          }
        },
        "claims": "App\\Http\\Resources\\Plans\\ClaimResource",
        "client": "App\\Http\\Resources\\AccountResource",
        "covers": "App\\Http\\Resources\\Plans\\CoverResource",
        "seller": "App\\Http\\Resources\\AccountResource",
        "status": "inactive",
        "on_panel": true,
        "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
        "sub_type": "lifetime isa",
        "opened_at": "2024-12-03T16:50:34+00:00",
        "valued_at": "2024-12-03T16:50:34+00:00",
        "created_at": "2024-12-03T16:50:34+00:00",
        "statistics": {
          "recent_growth": 100
        },
        "updated_at": "2024-12-03T16:50:34+00:00",
        "advice_area": "non_investment_insurance",
        "inactive_at": "2024-12-03T16:50:34+00:00",
        "review_date": "2023-12-03",
        "linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
        "main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
        "sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
        "under_advice": true,
        "abstract_type": "asset",
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "is_wrap_child": false,
        "linked_owners": "App\\Http\\Resources\\AccountResource",
        "policy_number": "AVIVA-123",
        "show_on_joint": true,
        "wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
        "can_be_deleted": "false",
        "total_benefits": {
          "critical_illness": {
            "amount": {
              "example": "15000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£150,000.00",
              "description": "Money amount formatted with currency"
            }
          },
          "family_income_benefit": {
            "amount": {
              "example": "10000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£100,000.00",
              "description": "Money amount formatted with currency"
            }
          }
        },
        "inactive_reason": "claimed",
        "is_group_scheme": false,
        "is_wrap_product": false,
        "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
        "proposal_reference": "AB123456",
        "agency_in_your_name": true,
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "is_sub_group_scheme": false,
        "total_benefit_amount": {
          "amount": {
            "example": "25000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          },
          "formatted": {
            "example": "£250,000.00",
            "description": "Money amount formatted with currency"
          }
        },
        "is_group_scheme_member": false,
        "originally_sold_by_firm": true,
        "agency_in_your_name_from": "2023-12-03",
        "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
        "visible_on_client_portal": true,
        "include_in_client_valuation": true
      },
      "created_at": "2024-12-03T16:50:34+00:00",
      "percentage": 0.75,
      "plan_value": "plan",
      "start_date": "2024-04-03",
      "tax_exempt": false,
      "updated_at": "2024-12-03T16:50:34+00:00",
      "advice_area": {
        "deposit": 7500,
        "unknown": 0,
        "non_rmar": 0,
        "non_regulated": 0,
        "retail_investment": 0,
        "regulated_mortgage": 2500,
        "other_fca_regulated": 0,
        "non_investment_insurance": 0
      },
      "advice_type": "independent",
      "notes_count": 5,
      "service_type": "initial",
      "payment_origin": "provider",
      "chargeable_type": {
        "amount": "12000000",
        "currency": "GBP",
        "formatted": "£120,000.00"
      },
      "charge_identifier": "PLANNR-72484",
      "exclude_from_rmar": true,
      "percentage_frequency": "annually",
      "next_expectation_date": "2024-12-13"
    }
  ]
}