Query parameters

• include string

  Comma separated list of relationships to include in the response. Valid relationships are [initiatedBy].

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[types] string

  Filter by a comma separated list of import types.

• filter[exclude_types] string

  Exclude a comma separated list of import types.

• filter[modes] string

  Filter by a comma separated list of import modes.

• filter[statuses] string

  Filter by a comma separated list of import statuses.

• filter[date_from] string

  Filter imports created on or after this date (Y-m-d).

• filter[date_to] string

  Filter imports created on or before this date (Y-m-d).

• filter[initiated_by] string

  Filter by the UUID of the employee who ran the import.

• sort string

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

• per_page integer

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

Responses

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

  • data array[object]
    Hide data attributes Show data 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.

    • type string

      The type of model the importer is importing

    • mode string

      The mode this import was run on

    • headers array[string]

      Headers taken from uploaded csv, not visible on index route

    • mapping object

      Mapped headers, not visible on index route

      Hide mapping attributes Show mapping attributes object

      • fname string
      • lname string
      • email string
    • importable_uuid string

      The uuid of the model this importer is importing. For example, for a provider statement import, this would be the uuid of the provider statement being imported

    • parameters object

      additional parameters for the import

      Hide parameters attribute Show parameters attribute object

      • revenue_type_mapping object
        Hide revenue_type_mapping attributes Show revenue_type_mapping attributes object

        • IF string
        • ADJ string
    • status string

      The status of the importer

    • total_jobs integer

      Total amount of imports in the importer

    • progress integer

      The current progress of the importer

    • jobs_remaining integer

      Number of pending imports

    • failed_jobs integer

      Number of failed imports

    • error_report object

      Error report file

      Hide error_report attributes Show error_report attributes object

      • uuid string
      • created_at string
      • original_created_at string
      • updated_at string
      • uploaded_at string
      • status string
      • filename string
      • name string
      • extension string
      • type string
      • size string
      • path string
      • last_modified string
      • progress string
      • download_url string
      • folder_name string
      • folder string
      • documentable_type string
      • documentable string
      • navigator object
        Hide navigator attributes Show navigator attributes object

        • model_type string
        • model_uuid string
      • firm string
      • account string
      • tags string
    • errors object

      Array of failed imports, limited to 25 rows

      Hide errors attributes Show errors attributes object

      • client object
        Hide client attributes Show client attributes object

        • example array
        • description string
      • errors object
        Hide errors attributes Show errors attributes object

        • example object
          Hide example attribute Show example attribute object

          • send_welcome_email array[string]
        • description string
    • account object

      Account that initiated the import

      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 string
      • primary_phone_number string
      • primary_email string
      • current_time_entry string
      • assigned_adviser string
      • assigned_administrator string
      • assigned_paraplanner string
      • introduced_by string
      • business_unit string
      • groups string
      • tags string
      • owners string
      • 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 string
      • circles string
      • 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 string
      • external_references string