POST /api/v1/provider-statement/import
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string
application/json

Body

  • import_file string(binary) Required

    The provider statement file csv.

  • provider_statement array[object] Required

    An array of provider statement properties.

    Hide provider_statement attributes Show provider_statement attributes object
    • statement_uuid string(uuid)

      The uuid of the statement this refers to.

    • provider_uuid string(uuid)

      The uuid of the provider.

    • date string(date)

      Date of the provider statement.

    • name string | null

      Name of the provider statement.

    • reference string | null

      Reference of the provider statement.

    • origin string | null

      The origin of the provider statement.

      Value Description
      edi Edi
      manual Manual
      upload Upload
      auto Auto

      Values are edi, manual, upload, or auto.

  • mapping object Required

    Array of mappings for the provider statement import. This defines how the columns in the CSV file map to the fields in the system.

    Additional properties are allowed.

  • parameters array[object] Required

    Array of additional data to complete the request.

    Hide parameters attribute Show parameters attribute object
    • revenue_type_mapping object

      Mapping of revenue types for the provider statement import. This defines how the revenue types in the CSV file map to the charge categories in the system.

      Additional properties are allowed.

Responses

  • 201 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.

    • 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
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date 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
POST /api/v1/provider-statement/import 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/provider-statement/import' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"import_file":"file-contents","provider_statement":[{"provider_statement":{"statement_uuid":null,"provider_uuid":null,"date":"2025-07-11","name":"July Statement","reference":"Aviva AV#834","origin":"upload"}}],"mapping":{"adviser_name":"adviser_name","agency_number":"agency_number","client_name":"client_name","customer_number":"customer_number","date":"date","gross_amount":"gross_amount","net_amount":"net_amount","policy_number":"policy_number","product_reference":"product_reference","scheme_name":"scheme_name","scheme_number":"scheme_number","sender_id_sib_number":"sender_id_sib_number","transaction_reference":"transaction_reference","category":"revenue_type"},"parameters":[{"parameters":{"revenue_type_mapping":{"ADJ":"adjustment","IF":"initial_fee"}}}]}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "import_file": "file-contents",
  "provider_statement": [
    {
      "provider_statement": {
        "statement_uuid": null,
        "provider_uuid": null,
        "date": "2025-07-11",
        "name": "July Statement",
        "reference": "Aviva AV#834",
        "origin": "upload"
      }
    }
  ],
  "mapping": {
    "adviser_name": "adviser_name",
    "agency_number": "agency_number",
    "client_name": "client_name",
    "customer_number": "customer_number",
    "date": "date",
    "gross_amount": "gross_amount",
    "net_amount": "net_amount",
    "policy_number": "policy_number",
    "product_reference": "product_reference",
    "scheme_name": "scheme_name",
    "scheme_number": "scheme_number",
    "sender_id_sib_number": "sender_id_sib_number",
    "transaction_reference": "transaction_reference",
    "category": "revenue_type"
  },
  "parameters": [
    {
      "parameters": {
        "revenue_type_mapping": {
          "ADJ": "adjustment",
          "IF": "initial_fee"
        }
      }
    }
  ]
}
Response examples (201) 
{
  "uuid": "11dcb61e-67a0-4592-8fda-c3e90456b1ad",
  "created_at": "2026-04-13T17:23:51+01:00",
  "updated_at": "2026-04-13T17:23:51+01:00",
  "type": "clients",
  "mode": "store",
  "headers": [
    "fname",
    "lname",
    "email"
  ],
  "mapping": {
    "fname": "first_name",
    "lname": "last_name",
    "email": "email"
  },
  "importable_uuid": "5ca4df8c-8092-424c-8c2f-556f622cd375",
  "parameters": {
    "revenue_type_mapping": {
      "IF": "initial_fee",
      "ADJ": "adjustment"
    }
  },
  "status": "processing",
  "total_jobs": 4,
  "progress": 100,
  "jobs_remaining": 1,
  "failed_jobs": 1,
  "error_report": {
    "uuid": "652f97dc-7e37-4c19-bc57-ce73e9accc7a",
    "created_at": "2026-04-13T17:23:51+01:00",
    "original_created_at": "2026-04-13T17:23:51+01:00",
    "updated_at": "2026-04-13T17:23:51+01:00",
    "uploaded_at": "2026-04-13T17:23:51+01:00",
    "status": "uploaded",
    "filename": "Welcome to Plannr.pdf",
    "name": "Welcome to Plannr",
    "extension": "pdf",
    "type": "type",
    "size": "21691783",
    "path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
    "last_modified": "2026-04-13T17:23:51+01:00",
    "progress": "100",
    "download_url": "https://api.plannrcrm.com/file/29c8b900-71c4-4a54-ae6a-03df0f5e284c/download",
    "folder_name": "folder 2",
    "folder": "App\\Http\\Resources\\FolderResource",
    "documentable_type": "account",
    "documentable": "Object",
    "navigator": {
      "model_type": "account",
      "model_uuid": "6234872b-5601-42af-b837-060047776887"
    },
    "firm": "App\\Http\\Resources\\FirmResource",
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "tags": "App\\Http\\Resources\\TagResource"
  },
  "errors": {
    "client": {
      "example": [],
      "description": "Client that failed importing"
    },
    "errors": {
      "example": {
        "send_welcome_email": [
          "The send welcome email field is required."
        ]
      },
      "description": "The reasons why the client failed importing"
    }
  },
  "account": {
    "uuid": "b7aceb36-1940-4a3f-b72e-a65640f6bb4e",
    "created_at": "2026-04-13T17:23:51+01:00",
    "updated_at": "2026-04-13T17:23:51+01:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "firm": "App\\Http\\Resources\\FirmResource",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "groups": "App\\Http\\Resources\\GroupResource",
    "tags": "App\\Http\\Resources\\TagResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "first_contact_date": "2026-04-13T17:23:51+01:00",
    "next_review_date": "2026-04-13T17:23:51+01:00",
    "previous_review_date": "2026-04-13T17:23:51+01:00",
    "anniversary_review_date": "2026-04-13T17:23:51+01:00",
    "with_login": true,
    "has_joint_account": true,
    "can_be_deleted": "false",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "inactive_at": "2026-04-13",
    "last_interaction_at": "2026-04-13 17:23:51",
    "referral_code": "ABC12345",
    "permissions": {
      "firm:read": [
        "firm"
      ],
      "network:read": [
        "network:uuid"
      ]
    },
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  }
}