# Upload a provider statement CSV.

**POST /api/v1/provider-statement/upload**




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


## Authentication methods
- Personal access token & O auth2


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




### Body: application/json (object)

- **statement_uuid** (string(uuid))
  Payment period statement UUID, must be unlocked.
- **provider_uuid** (string(uuid))
  Provider UUID
- **date** (string(date))
  Provider statement date
- **reference** (string)
  Statement reference given by provider
- **statement_transactions** (array)
  An array of statement_transactions. Required data are policy_number, gross_amount, and category. If expected payments date is not provided it will use the provider statement date. All amounts must be in pennies. Valid category values are: adhoc, administration, adjustment, bond_renewal, clawback, dss_rebate, fund, indemnity, initial_fee, level, non_indemnity, one_off, ongoing_fee, other_fee, procuration_fee, protected_rights, renewal, switch and unknown. Can also provide extra metadata which can be the rest of the columns of the provider statement.
- **category_mapper** (array)
  Array to convert statement transactions category in to a valid category for Plannr. Array key is original category value and array element is valid category. Valid categories are: adhoc, administration, adjustment, bond_renewal, clawback, dss_rebate, fund, indemnity, initial_fee, level, non_indemnity, one_off, ongoing_fee, other_fee, procuration_fee, protected_rights, renewal, switch and unknown
- **filename** (string)
  Filename of the CSV import statement_transactions.


## 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


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