# Get all statement transactions

**GET /api/v1/statement-transaction**




## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters
### Headers
- **X-PLANNR-ACCOUNT-UUID** (string)



### Query parameters
- **include** (string)
  Comma separated list of relationships to include in the response. Valid relationships are [statement, providerStatement].
- **filter[uuid]** (string)
  Filter by a comma separated list of UUIDs.
- **filter[statement_uuids]** (string)
  Filter provider statement transactions by a statement UUID.
- **filter[provider_statement_uuids]** (string)
  Filter provider statement transactions by an exact provider statement UUID.
- **filter[date_from]** (string)
  Get provider statement transactions from a certain date.
- **filter[date_to]** (string)
  Get provider statement transactions to a certain date.
- **filter[amount_from]** (string)
  Get provider statement transactions greater than or equal to a certain amount in pennies.
- **filter[amount_to]** (string)
  Get provider statement transactions less than or equal to a certain amount in pennies.
- **filter[client]** (string)
  Filter by partial client name given on provider statement.
- **filter[policy_number]** (string)
  Filter by partial policy number given on provider statement.
- **filter[reference]** (string)
  Filter by partial transaction reference.
- **filter[agency_number]** (string)
  Filter by partial agency number.
- **filter[product_reference]** (string)
  Filter by partial product reference.
- **filter[provider_uuids]** (string)
  Filter provider statement transactions by exact provider UUID.
- **filter[payment_origin]** (string)
  Filter provider statement transactions to client or provider paid.  Valid options are [client, provider]
- **filter[category]** (string)
  Comma separated string of categories to filter by.
- **filter[adviser]** (string)
  Filter by partial adviser name given on provider statement.
- **filter[reconciliation]** (string)
  Filter provider statement transactions by their reconciliation status.  Valid statuses are reconciled,unreconciled,reconciled_with_expectations,reconciled_with_bank_transactions,unreconciled_with_expectations,unreconciled_with_bank_transactions,partially_reconciled_with_expectations,partially_reconciled_with_bank_transactions
- **sort** (string)
  Field to sort by. Valid fields are [created_at, updated_at, date, policy_number, client_name, gross_amount]. Negative sign to denote DESC.  Defaults to '-updated_at'.
- **per_page** (integer)
  Number of results to return with pagination (Default 15. Max 500).


## Responses
### 200


#### Body: application/json (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
- **net_amount** (object)
  Net amount
- **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
- **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
- **metadata** (object)
  Any metadata that was saved during a CSV import for statement transactions
- **expectation** (object)
  The expectation that the statement transaction has been reconciled against
- **bank_transactions** (array[object])
  The bank payments used to reconcile this statement transaction
- **statement** (object)
  The statement period this statement transaction belongs to
- **account** (object)
  Account that created this statement transaction
- **firm** (object)
  Firm this statement transaction belongs to
- **reconciliation** (object)
  The reconciliation amount to both expectations and bank transactions
- **bank_transaction_reconciliations** (object)
  The individual reconciliations against the statement transaction for bank transactions


[Powered by Bump.sh](https://bump.sh)