Headers

• X-PLANNR-ACCOUNT-UUID string

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.

  • client_name string

    Client name

  • transaction_reference string

    Unique statement transactions reference assigned by the provider

  • policy_number string

    Provider reference of the plan the statement transactions belongs to

  • date string

    Date of when the provider received the statement transactions

  • gross_amount object

    Gross amount

    Hide gross_amount attributes Show gross_amount attributes object

    • amount object
      Hide amount attributes Show amount attributes object

      • example string
      • description string
    • formatted object
      Hide formatted attributes Show formatted attributes object

      • example string
      • description string
    • currency object
      Hide currency attributes Show currency attributes object

      • example string
      • description string
  • net_amount object

    Net amount

    Hide net_amount attributes Show net_amount attributes object

    • amount object
      Hide amount attributes Show amount attributes object

      • example string
      • description string
    • formatted object
      Hide formatted attributes Show formatted attributes object

      • example string
      • description string
    • currency object
      Hide currency attributes Show currency attributes object

      • example string
      • description string
  • category string

    Expected payment category for accurate reporting

  • payment_origin string

    Who is expected to pay this statement transactions

  • agency_number string

    Agency number

  • product_reference string

    Product reference

  • adviser_name string

    Adviser name

  • sender_id_sib_number string

    Sender id sib number

  • reason string

    Reason

  • auto_reconciliation_message string

    Reason why this statement transaction could not be auto reconciled against an expectation. Cleared once it is reconciled.

  • scheme_name string

    Scheme name

  • scheme_number string

    Scheme number

  • customer_number string

    Customer number

  • policy_market_value string

    Policy market value

  • provider string

    Provider this statement transaction belongs to if provided

  • provider_statement object

    Provider statement this statement transaction belongs to

    Hide provider_statement attributes Show provider_statement attributes object

    • uuid string
    • created_at string
    • updated_at string
    • number integer
    • name string
    • date string
    • reference string
    • filename string
    • origin string
    • provider object
      Hide provider attributes Show provider attributes object

      • uuid

        UUID of the provider

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        Provider name

      • slug

        Provider name slug

    • statement object
      Hide statement attributes Show statement attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        Statement description

      • start_date

        End date of the statement

      • end_date

        Start date of the statement

      • locked

        Denotes whether the statement is locked or not

      • locked_at

        The time that the statement was locked at

      • total_expectations

        Total amount of expectations for the statement period

      • total_statement_transactions

        Total amount of statement transactions received for the statement period

      • total_bank_transactions

        Total amount of bank transactions received for the statement period

      • total_expectation_amount_reconciled_to_bank

        Total amount of expectations that have been reconciled to the bank received for the statement period

      • total_expectation_percentage_reconciled_to_bank

        Total percentage of expectations that have been reconciled to the bank received for the statement period

      • expectations_count

        Total number of expectations for the statement period

      • statement_transactions_count

        Total number of statement transactions received for the statement period

    • statement_transactions_count integer
    • statement_transactions object
      Hide statement_transactions attributes Show statement_transactions attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • client_name

        Client name

      • transaction_reference

        Unique statement transactions reference assigned by the provider

      • policy_number

        Provider reference of the plan the statement transactions belongs to

      • date

        Date of when the provider received the statement transactions

      • gross_amount

        Gross amount

      • net_amount

        Net amount

      • category

        Expected payment category for accurate reporting

      • payment_origin

        Who is expected to pay this statement transactions

      • agency_number

        Agency number

      • product_reference

        Product reference

      • adviser_name

        Adviser name

      • sender_id_sib_number

        Sender id sib number

      • reason

        Reason

      • auto_reconciliation_message

        Reason why this statement transaction could not be auto reconciled against an expectation. Cleared once it is reconciled.

      • scheme_name

        Scheme name

      • scheme_number

        Scheme number

      • customer_number

        Customer number

      • policy_market_value

        Policy market value

      • provider

        Provider this statement transaction belongs to if provided

      • metadata

        Any metadata that was saved during a CSV import for statement transactions

    • total_amount object
      Hide total_amount attributes Show total_amount attributes object

      • amount string
      • currency string
      • formatted string
    • reconciled_expectations_amount object
      Hide reconciled_expectations_amount attributes Show reconciled_expectations_amount attributes object

      • amount string
      • currency string
      • formatted string
    • reconciled_expectations_percentage number
    • reconciled_bank_transactions_amount object
      Hide reconciled_bank_transactions_amount attributes Show reconciled_bank_transactions_amount attributes object

      • amount string
      • currency string
      • formatted string
    • reconciled_bank_transactions_percentage number
    • is_fully_reconciled_to_expectations boolean
  • metadata object

    Any metadata that was saved during a CSV import for statement transactions

    Hide metadata attribute Show metadata attribute object

    • client_name string
  • expectation object

    The expectation that the statement transaction has been reconciled against

    Hide expectation attributes Show expectation attributes object

    • uuid string
    • created_at string
    • updated_at string
    • payment_origin string
    • type string
    • category string
    • expected_payment_date string
    • tax_exempt boolean
    • tax integer
    • recurring boolean
    • is_balanced boolean
    • unbalanced_expected_amount object
      Hide unbalanced_expected_amount attributes Show unbalanced_expected_amount attributes object

      • amount object
        Hide amount attributes Show amount attributes object

        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object

        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object

        • example string
        • description string
    • expected_amount object
      Hide expected_amount attributes Show expected_amount attributes object

      • amount object
        Hide amount attributes Show amount attributes object

        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object

        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object

        • example string
        • description string
    • gross_amount object
      Hide gross_amount attributes Show gross_amount attributes object

      • amount object
        Hide amount attributes Show amount attributes object

        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object

        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object

        • example string
        • description string
    • net_amount object
      Hide net_amount attributes Show net_amount attributes object

      • amount object
        Hide amount attributes Show amount attributes object

        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object

        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object

        • example string
        • description string
    • amount object
      Hide amount attributes Show amount attributes object

      • amount object
        Hide amount attributes Show amount attributes object

        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object

        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object

        • example string
        • description string
    • percentage number
    • exclude_from_rmar boolean
    • rmar_type string
    • advice_type string
    • service_type string
    • advice_area_gross object
      Hide advice_area_gross attributes Show advice_area_gross attributes object

      • deposit integer
      • non_regulated integer
      • non_rmar integer
      • non_investment_insurance integer
      • regulated_mortgage integer
      • retail_investment integer
      • other_fca_regulated integer
      • unknown integer
    • advice_area_net object
      Hide advice_area_net attributes Show advice_area_net attributes object

      • deposit integer
      • non_regulated integer
      • non_rmar integer
      • non_investment_insurance integer
      • regulated_mortgage integer
      • retail_investment integer
      • other_fca_regulated integer
      • unknown integer
    • account object
      Hide account attributes Show account attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • seller object
      Hide seller attributes Show seller attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • author object
      Hide author attributes Show author attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • charge_schedule object
      Hide charge_schedule attributes Show charge_schedule attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • payment_origin

        Who you expect to be paying this charge

      • type

        Expectation type, fee or commission

      • category

        Expectation category, used for accurate reporting

      • recurring

        Whether the charge should be recurring at a frequency

      • frequency

        Frequency of the recurring charge

      • start_date

        Date of one off charge, or when the recurring charge should start from

      • end_date

        Date recurring charge should stop, blank for indefinitely

      • next_expectation_date

        Date when the next expectation will be available

      • tax_exempt

        Denotes whether tax will be applied to the charge or not

      • tax

        Custom tax to be applied to the charge net amount if not tax exempt. Will use the firms default tax rate if not provided

      • amount

        Amount of recurring charge

      • percentage

        Percentage of plans value the recurring charge is expecting to take

      • percentage_frequency

        Frequency which the percentage is describing/calculated from

      • charge_identifier

        Invoice Number / Charge Identifier

      • exclude_from_rmar

        Whether or not this charge and its expectations will be excluded from RMAR or not

      • rmar_type

        RMAR type

      • advice_type

        Advice type

      • service_type

        Service type

      • advice_area

        RMAR advice area values.

      • plan_value

        The model type this charge belongs to

      • chargeable_type

        The plan value at the charges start date

      • notes_count

        Notes count

    • chargeable_type string
    • chargeable object
      Hide chargeable attributes Show chargeable attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • opened_at

        Timestamp of when the plan was originally opened

      • name

        Name of the plan

      • type

        Type of plan, this will indicate what to expect from the fields attribute

      • sub_type

        Plan sub type

      • abstract_type

        describes if the plan is an asset, protection or liability

      • policy_number

        The policy number on the main sub account of the plan

      • proposal_reference

        The proposal reference on the main sub account of the plan

      • status

        Plan status

      • inactive_at

        Timestamp of when the plan became inactive

      • inactive_reason

        Reason for inactivity

      • agency_in_your_name

        Denotes if plan has agency in your name

      • agency_in_your_name_from

        Date the agency was in your name from

      • originally_sold_by_firm

        Denotes if the plan was originally sold by your firm

      • under_advice

        Denotes if plan is under advice

      • visible_on_client_portal

        Denotes if this plan is visible to clients on the client portal

      • include_in_client_valuation

        Denotes if this plan should be included in the client valuation

      • show_on_joint

        Denotes if this individual account can be seen when viewing joint plans on any joint accounts the individual client is a part of

      • shown_on_circles

        Determines if plan should be shown on a circle

      • review_date

        Review date

      • on_panel

        On panel

      • is_group_scheme

        Denotes if the plan is a group scheme plan. When a plan is a group scheme plan you will be able to manage group scheme members and sub schemes.

      • is_sub_group_scheme

        Denotes if the plan is a sub-scheme of a group scheme.

      • is_group_scheme_member

        Denotes if the plan is group scheme member plan. Each group scheme member is their own plan for maximum customisation.

      • advice_area

        The advice area of the plan based on the plan's sub type.

      • total_benefit_amount

        Total amount benefit of all covers

      • total_benefits

        Total benefits broken down in to cover types

      • value

        Total value of the plan

      • valued_at

        When the plan was last valued - Please note this is likely going to be the current date. If you would like to see the last real date it was valued by a provider or created manually, use original_valued_at

      • original_valued_at

        When the plan was originally valued - Please note our plans is valued daily but this is the date the valuation was originally added to the system.

      • statistics

        The statistics on a plan. Only displayed when you retrieve an individual plan

      • is_wrap_product

        Determines if the plan is a wrap plan

      • is_wrap_child

        Determines if the plan is a wrap child

      • can_be_deleted

        Denotes if the plan can be deleted

    • statement_transactions object
      Hide statement_transactions attributes Show statement_transactions attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • client_name

        Client name

      • transaction_reference

        Unique statement transactions reference assigned by the provider

      • policy_number

        Provider reference of the plan the statement transactions belongs to

      • date

        Date of when the provider received the statement transactions

      • gross_amount

        Gross amount

      • net_amount

        Net amount

      • category

        Expected payment category for accurate reporting

      • payment_origin

        Who is expected to pay this statement transactions

      • agency_number

        Agency number

      • product_reference

        Product reference

      • adviser_name

        Adviser name

      • sender_id_sib_number

        Sender id sib number

      • reason

        Reason

      • auto_reconciliation_message

        Reason why this statement transaction could not be auto reconciled against an expectation. Cleared once it is reconciled.

      • scheme_name

        Scheme name

      • scheme_number

        Scheme number

      • customer_number

        Customer number

      • policy_market_value

        Policy market value

      • provider

        Provider this statement transaction belongs to if provided

      • metadata

        Any metadata that was saved during a CSV import for statement transactions

    • statement object
      Hide statement attributes Show statement attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        Statement description

      • start_date

        End date of the statement

      • end_date

        Start date of the statement

      • locked

        Denotes whether the statement is locked or not

      • locked_at

        The time that the statement was locked at

      • total_expectations

        Total amount of expectations for the statement period

      • total_statement_transactions

        Total amount of statement transactions received for the statement period

      • total_bank_transactions

        Total amount of bank transactions received for the statement period

      • total_expectation_amount_reconciled_to_bank

        Total amount of expectations that have been reconciled to the bank received for the statement period

      • total_expectation_percentage_reconciled_to_bank

        Total percentage of expectations that have been reconciled to the bank received for the statement period

      • expectations_count

        Total number of expectations for the statement period

      • statement_transactions_count

        Total number of statement transactions received for the statement period

    • income_splits object
      Hide income_splits attributes Show income_splits attributes object

      • splitable_type

        The income split entity type.

      • splitable_uuid

        The income split entity UUID.

      • type

        The role of the income split entity on this income split.

      • name

        The name of the income split entity.

      • requested_percentage

        Percentage of the expected amount this entity requested. Will differ from final results depending on an extra charge splits.

      • percentage

        Percentage of the expected amount this income split entity is entitled to.

      • expected_amount

        Expected amount this income split entity is entitled to.

      • expected_gross_amount

        Expected gross amount this income split entity is entitled to.

      • expected_net_amount

        Expected net amount this income split entity is entitled to.

      • expected_fci_recognition

        Expected amount this entity will be recognised for FCI.

      • reconciled_gross_amount

        Reconciled gross amount this income split entity is entitled to.

      • reconciled_net_amount

        Reconciled net amount this income split entity is entitled to.

      • reconciled_fci_recognition

        Reconciled amount this entity will be recognised for FCI.

      • bank_receipt_date

        Date of the bank transaction that is linked to this expectation.

    • firm object
      Hide firm attributes Show firm attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        Name of the firm

      • slug

        Slug of the firm

      • address_1

        First line of the address

      • address_2

        Second line of the address

      • town_city

        Town/City

      • county

        County

      • postcode

        Postcode

      • country

        Country

      • regulatory_text

        Regulatory text of the firm.

      • logo

        URL of your firm logo.

      • logo_icon

        URL of your firm logo icon.

      • brand_colours

        Firm branding colours.

      • is_subscribed

        Subscription status.

      • keep_deleted_files_for

        Number of days to keep deleted files for

      • tax

        Tax percent

      • month_end

        Date of the month for the monthly income reconciliation statements to end

      • statement_frequency

        The frequency of the income reconciliation statements

      • billing

        Firm invoice details for billing

      • ip_whitelist

        A list of IP Addresses a firm is allowed to log in from.

      • welcome_paragraph_html

        Custom welcome paragraph html for the branded auth welcome page

      • email_welcome_paragraph_html

        Custom welcome paragraph for the welcome/new user email

      • show_fact_find_illustrations

        Determines if the illustrations/graphics are displayed on the fact find.

      • cc_email_addresses

        Array of email cc addresses.

      • bcc_email_addresses

        Array of email bcc addresses.

      • reply_to_email_address

        Firm reply to email address.

      • mobile_app_support_number

        Firm mobile app support number.

      • mobile_app_support_email

        Firm mobile app support email address.

    • notes_count integer
  • bank_transactions array[object]

    The bank payments used to reconcile this statement transaction

    Hide bank_transactions attributes Show bank_transactions attributes object

    • uuid string
    • created_at string
    • updated_at string
    • date string
    • amount object
      Hide amount attributes Show amount attributes object

      • amount string
      • currency string
      • formatted string
    • reference string
    • metadata object
      Hide metadata attribute Show metadata attribute object

      • client_name string
    • filename string
    • bank_statement object
      Hide bank_statement attributes Show bank_statement attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • number

        Bank statement number

      • reference

        Bank statement reference given by bank statement

      • date

        Bank statement date

      • name

        Bank statement name

      • bank_transactions_count

        Total number of bank transactions within bank statement

      • total_amount

        Total amount of all bank transactions within this bank statement

      • reconciled_amount

        Total amount reconciled

      • reconciled_percentage

        Total percentage reconciled

    • statement object
      Hide statement attributes Show statement attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        Statement description

      • start_date

        End date of the statement

      • end_date

        Start date of the statement

      • locked

        Denotes whether the statement is locked or not

      • locked_at

        The time that the statement was locked at

      • total_expectations

        Total amount of expectations for the statement period

      • total_statement_transactions

        Total amount of statement transactions received for the statement period

      • total_bank_transactions

        Total amount of bank transactions received for the statement period

      • total_expectation_amount_reconciled_to_bank

        Total amount of expectations that have been reconciled to the bank received for the statement period

      • total_expectation_percentage_reconciled_to_bank

        Total percentage of expectations that have been reconciled to the bank received for the statement period

      • expectations_count

        Total number of expectations for the statement period

      • statement_transactions_count

        Total number of statement transactions received for the statement period

    • account object
      Hide account attributes Show account attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • firm object
      Hide firm attributes Show firm attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        Name of the firm

      • slug

        Slug of the firm

      • address_1

        First line of the address

      • address_2

        Second line of the address

      • town_city

        Town/City

      • county

        County

      • postcode

        Postcode

      • country

        Country

      • regulatory_text

        Regulatory text of the firm.

      • logo

        URL of your firm logo.

      • logo_icon

        URL of your firm logo icon.

      • brand_colours

        Firm branding colours.

      • is_subscribed

        Subscription status.

      • keep_deleted_files_for

        Number of days to keep deleted files for

      • tax

        Tax percent

      • month_end

        Date of the month for the monthly income reconciliation statements to end

      • statement_frequency

        The frequency of the income reconciliation statements

      • billing

        Firm invoice details for billing

      • ip_whitelist

        A list of IP Addresses a firm is allowed to log in from.

      • welcome_paragraph_html

        Custom welcome paragraph html for the branded auth welcome page

      • email_welcome_paragraph_html

        Custom welcome paragraph for the welcome/new user email

      • show_fact_find_illustrations

        Determines if the illustrations/graphics are displayed on the fact find.

      • cc_email_addresses

        Array of email cc addresses.

      • bcc_email_addresses

        Array of email bcc addresses.

      • reply_to_email_address

        Firm reply to email address.

      • mobile_app_support_number

        Firm mobile app support number.

      • mobile_app_support_email

        Firm mobile app support email address.

  • statement object

    The statement period this statement transaction belongs to

    Hide statement attributes Show statement attributes object

    • uuid string
    • created_at string
    • updated_at string
    • name string
    • start_date string
    • end_date string
    • locked boolean
    • locked_at string
    • locked_by object
      Hide locked_by attributes Show locked_by attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • total_expectations object
      Hide total_expectations attributes Show total_expectations attributes object

      • amount string
      • currency string
      • formatted string
    • total_statement_transactions object
      Hide total_statement_transactions attributes Show total_statement_transactions attributes object

      • amount string
      • currency string
      • formatted string
    • total_bank_transactions object
      Hide total_bank_transactions attributes Show total_bank_transactions attributes object

      • amount string
      • currency string
      • formatted string
    • total_expectation_amount_reconciled_to_bank object
      Hide total_expectation_amount_reconciled_to_bank attributes Show total_expectation_amount_reconciled_to_bank attributes object

      • amount string
      • currency string
      • formatted string
    • total_expectation_percentage_reconciled_to_bank object
      Hide total_expectation_percentage_reconciled_to_bank attributes Show total_expectation_percentage_reconciled_to_bank attributes object

      • amount string
      • currency string
      • formatted string
    • expectations_count integer
    • statement_transactions_count integer
    • statement_transactions object
      Hide statement_transactions attributes Show statement_transactions attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • client_name

        Client name

      • transaction_reference

        Unique statement transactions reference assigned by the provider

      • policy_number

        Provider reference of the plan the statement transactions belongs to

      • date

        Date of when the provider received the statement transactions

      • gross_amount

        Gross amount

      • net_amount

        Net amount

      • category

        Expected payment category for accurate reporting

      • payment_origin

        Who is expected to pay this statement transactions

      • agency_number

        Agency number

      • product_reference

        Product reference

      • adviser_name

        Adviser name

      • sender_id_sib_number

        Sender id sib number

      • reason

        Reason

      • auto_reconciliation_message

        Reason why this statement transaction could not be auto reconciled against an expectation. Cleared once it is reconciled.

      • scheme_name

        Scheme name

      • scheme_number

        Scheme number

      • customer_number

        Customer number

      • policy_market_value

        Policy market value

      • provider

        Provider this statement transaction belongs to if provided

      • metadata

        Any metadata that was saved during a CSV import for statement transactions

  • account object

    Account that created this statement transaction

    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
    • firm object
      Hide firm attributes Show firm attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        Name of the firm

      • slug

        Slug of the firm

      • address_1

        First line of the address

      • address_2

        Second line of the address

      • town_city

        Town/City

      • county

        County

      • postcode

        Postcode

      • country

        Country

      • regulatory_text

        Regulatory text of the firm.

      • logo

        URL of your firm logo.

      • logo_icon

        URL of your firm logo icon.

      • brand_colours

        Firm branding colours.

      • is_subscribed

        Subscription status.

      • keep_deleted_files_for

        Number of days to keep deleted files for

      • tax

        Tax percent

      • month_end

        Date of the month for the monthly income reconciliation statements to end

      • statement_frequency

        The frequency of the income reconciliation statements

      • billing

        Firm invoice details for billing

      • ip_whitelist

        A list of IP Addresses a firm is allowed to log in from.

      • welcome_paragraph_html

        Custom welcome paragraph html for the branded auth welcome page

      • email_welcome_paragraph_html

        Custom welcome paragraph for the welcome/new user email

      • show_fact_find_illustrations

        Determines if the illustrations/graphics are displayed on the fact find.

      • cc_email_addresses

        Array of email cc addresses.

      • bcc_email_addresses

        Array of email bcc addresses.

      • reply_to_email_address

        Firm reply to email address.

      • mobile_app_support_number

        Firm mobile app support number.

      • mobile_app_support_email

        Firm mobile app support email address.

    • primary_phone_number object
      Hide primary_phone_number attributes Show primary_phone_number attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Contact detail type

      • name

        Contact detail description

      • value

        Contact detail value

      • phone_number_meta

        If the type is a phone number, this additional field will be displayed giving you information about the phone number.

    • primary_email object
      Hide primary_email attributes Show primary_email attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Contact detail type

      • name

        Contact detail description

      • value

        Contact detail value

      • phone_number_meta

        If the type is a phone number, this additional field will be displayed giving you information about the phone number.

    • current_time_entry object
      Hide current_time_entry attributes Show current_time_entry attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        The name of the time entry.

      • description

        The description of the time entry.

      • trackable_type

        The model type that is being tracked. The example given is a client, but it can be a case, firm, circle or task.

      • start_date

        The start time of the time entry.

      • end_date

        The end time of the time entry.

      • is_active

        Determines if the time entry is currently ongoing.

      • total_time_in_minutes

        Total time in minutes.

      • computed_time_elapsed_in_seconds

        Computed time elapsed in seconds.

    • assigned_adviser object
      Hide assigned_adviser attributes Show assigned_adviser attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • assigned_administrator object
      Hide assigned_administrator attributes Show assigned_administrator attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • assigned_paraplanner object
      Hide assigned_paraplanner attributes Show assigned_paraplanner attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • introduced_by object
      Hide introduced_by attributes Show introduced_by attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • business_unit object
      Hide business_unit attributes Show business_unit attributes object

      • uuid

        The UUID of the resource.

      • name

        Name of the business unit.

      • has_alternative_branding

        Whether alternative branding is enabled for this business unit.

      • brand_colours

        Brand colours for this business unit, merged with firm defaults.

      • members_count

        Number of accounts assigned to this business unit

      • groups_count

        Number of groups assigned to this business unit

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

    • groups object
      Hide groups attributes Show groups attributes object

      • uuid

        UUID of the group

      • name

        Name of the group

      • slug

        Slug of the group

      • participants_count

        Number of participants in the group

      • participants

        Participants in this group

      • created_at

        Timestamp of when the group was created

      • updated_at

        Timestamp of when the group was updated

    • tags object
      Hide tags attributes Show tags attributes object

      • uuid

        UUID of the tag

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        The name of the tag

      • slug

        The slug of the tag

      • colour

        The colour of the tag

    • owners object
      Hide owners attributes Show owners attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • first_contact_date string
    • next_review_date string
    • previous_review_date string
    • anniversary_review_date string
    • terms_of_business_at string
    • client_agreement_at string
    • with_login boolean
    • has_joint_account boolean
    • can_be_deleted string
    • joint_account_circle object
      Hide joint_account_circle attributes Show joint_account_circle attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        The Circle name

      • photo_url

        URL for initial avatar image

      • bg_colour

        Hex colour background for avatar

      • has_portal_access

        Whether any member of the circle has portal access

      • portal_access_status

        Aggregated portal access status: active, never_logged_in, or no_portal_access

      • engagement_rating

        Aggregated engagement rating: green, amber, red, or none

      • last_login

        Most recent portal login across all circle members, including who logged in

      • portal_login_count_30d

        Total portal login count across all members in last 30 days

      • portal_login_count_90d

        Total portal login count across all members in last 90 days

      • portal_login_count_365d

        Total portal login count across all members in last 365 days

      • joint_account_uuid

        uuid of joint account where circle created from joint account

      • login_access_level

        The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write

      • current_life_stage_uuid

        UUID of the circle's current life stage for expenditure

    • circles object
      Hide circles attributes Show circles attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        The Circle name

      • photo_url

        URL for initial avatar image

      • bg_colour

        Hex colour background for avatar

      • has_portal_access

        Whether any member of the circle has portal access

      • portal_access_status

        Aggregated portal access status: active, never_logged_in, or no_portal_access

      • engagement_rating

        Aggregated engagement rating: green, amber, red, or none

      • last_login

        Most recent portal login across all circle members, including who logged in

      • portal_login_count_30d

        Total portal login count across all members in last 30 days

      • portal_login_count_90d

        Total portal login count across all members in last 90 days

      • portal_login_count_365d

        Total portal login count across all members in last 365 days

      • joint_account_uuid

        uuid of joint account where circle created from joint account

      • login_access_level

        The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write

      • current_life_stage_uuid

        UUID of the circle's current life stage for expenditure

    • ownership_percentage integer
    • inactive_at string
    • last_interaction_at string
    • referral_code string
    • permissions object
      Hide permissions attributes Show permissions attributes object

      • firm:read array[string]
      • network:read array[string]
    • custom_fields object
      Hide custom_fields attributes Show custom_fields attributes object

      • uuid

        The UUID of the custom field

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        The type of custom field

      • name

        The name of the custom field

      • reference

        The reference of the custom field, used when updating the custom field on the model.

      • is_required

        Denotes if the custom field is required

      • value

        The value of the custom field

      • selection_options

        This is the array of available options for the selection box. If the type is "selection" this array will be provided.

      • help_text

        Optional help text to aide the custom field. Will be displayed on Plannr.

    • external_references object
      Hide external_references attributes Show external_references attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • third_party

        The third party provider with the reference.

      • reference

        The third party reference.

  • firm object

    Firm this statement transaction 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 object
      Hide addon_subscriptions attributes Show addon_subscriptions attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • enabled

        Determines if the addon is enabled

      • trial_ends_at

        If the addon is a paid addon, this is the date the free trial will end for the addon subscription.

      • trial_ends_in_days

        If the addon is a paid addon, this is the number of days left in the free trial for the addon subscription.

      • payment_confirmed_at

        If the addon is a paid addon, this is the date the payment was confirmed for the addon subscription.

    • 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 object
      Hide task_board_template attributes Show task_board_template attributes object

      • uuid

        uuid of the board

      • created_at

        timestamp of when the board was created

      • updated_at

        timestamp of when the board was updated

      • is_template

        returns true if the board is a template

      • name

        the name of the board

      • default_list_uuid

        the default list uuid

      • is_editable

        determines if the user can edit the board (e.g update the board, lists and move tasks around)

      • priorities

        returns the array of priorities that can be set within a task

    • 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
  • reconciliation object

    The reconciliation amount to both expectations and bank transactions

    Hide reconciliation attributes Show reconciliation attributes object

    • bank_transaction_reconciliation_amount object
      Hide bank_transaction_reconciliation_amount attributes Show bank_transaction_reconciliation_amount attributes object

      • amount object
        Hide amount attributes Show amount attributes object

        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object

        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object

        • example string
        • description string
    • bank_transaction_reconciliation_percentage integer
    • is_fully_reconciled_with_bank_transactions boolean
    • expectation_reconciliation_amount object
      Hide expectation_reconciliation_amount attributes Show expectation_reconciliation_amount attributes object

      • amount object
        Hide amount attributes Show amount attributes object

        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object

        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object

        • example string
        • description string
    • expectation_reconciliation_percentage integer
    • is_reconciled_with_expectation boolean
    • is_fully_reconciled_with_expectations boolean
  • bank_transaction_reconciliations object

    The individual reconciliations against the statement transaction for bank transactions

    Hide bank_transaction_reconciliations attributes Show bank_transaction_reconciliations attributes object

    • uuid string
    • created_at string
    • updated_at string
    • amount object
      Hide amount attributes Show amount attributes object

      • amount object
        Hide amount attributes Show amount attributes object

        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object

        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object

        • example string
        • description string
    • statement_transaction object
      Hide statement_transaction attributes Show statement_transaction attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • client_name

        Client name

      • transaction_reference

        Unique statement transactions reference assigned by the provider

      • policy_number

        Provider reference of the plan the statement transactions belongs to

      • date

        Date of when the provider received the statement transactions

      • gross_amount

        Gross amount

      • net_amount

        Net amount

      • category

        Expected payment category for accurate reporting

      • payment_origin

        Who is expected to pay this statement transactions

      • agency_number

        Agency number

      • product_reference

        Product reference

      • adviser_name

        Adviser name

      • sender_id_sib_number

        Sender id sib number

      • reason

        Reason

      • auto_reconciliation_message

        Reason why this statement transaction could not be auto reconciled against an expectation. Cleared once it is reconciled.

      • scheme_name

        Scheme name

      • scheme_number

        Scheme number

      • customer_number

        Customer number

      • policy_market_value

        Policy market value

      • provider

        Provider this statement transaction belongs to if provided

      • metadata

        Any metadata that was saved during a CSV import for statement transactions

    • bank_transaction object
      Hide bank_transaction attributes Show bank_transaction attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • date

        Transaction date on bank statement

      • amount

        Transaction amount

      • reference

        Transaction reference on bank statement

      • metadata

        Any metadata that was saved during a CSV import for transactions

      • filename

        Filename of the CSV import transactions

    • account object
      Hide account attributes Show account attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

        (Deprecated - Please use primary_email instead). The email of the account.

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

        Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • permissions

        Permission map where keys are permission names and values are target arrays