Headers

• X-PLANNR-ACCOUNT-UUID string

Query parameters

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[statement_uuids] string

  Comma separated list of payment period statement UUIDs. e.g. fb8ca37d-6c5b-4688-bb69-1aacfffb8bea

• filter[name] string

  Comma separated list of partial bank statement names. e.g. Natwest

• filter[reference] string

  Comma separated list of partial bank statement references. e.g. SW#324

• filter[date_from] string

  Statement date from in format YYYY-MM-DD e.g. 2022-10-15

• filter[date_to] string

  Statement date from in format YYYY-MM-DD e.g. 2022-12-30

• filter[amount_from] integer

  Total amount of transactions within bank statement to, in pennies e.g. 5000

• sort string

  Field to sort by. Valid fields are [created_at, updated_at, name, reference, date, total_amount]. 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.

    • number integer

      Bank statement number

    • reference string

      Bank statement reference given by bank statement

    • date string

      Bank statement date

    • name string

      Bank statement name

    • statement object

      Statement

      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 string
      • 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 string
    • bank_transactions_count integer

      Total number of bank transactions within bank statement

    • bank_transactions array[object]

      Bank transactions within bank statement

      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 string
      • statement string
      • account string
      • firm string
    • total_amount object

      Total amount of all bank transactions within this bank statement

      Hide total_amount attributes Show total_amount attributes object

      • amount string
      • currency string
      • formatted string
    • reconciled_amount object

      Total amount reconciled

      Hide reconciled_amount attributes Show reconciled_amount attributes object

      • amount string
      • currency string
      • formatted string
    • reconciled_percentage number

      Total percentage reconciled