Get all reconciliations on a bank transaction

GET /api/v1/bank-transaction/{bankTransaction_uuid}/reconciliations

Headers

Path parameters

bankTransaction_uuid string Required

Query parameters

filter[uuid] string

Filter by a comma separated list of UUIDs.
sort string

Field to sort by. Valid fields are [created_at, updated_at, type, 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 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.
- amount object
  
  The amount that has been reconciled.
- statement_transaction object
  
  The statement transaction the reconciliation has been made against.
- bank_transaction object
  
  The bank transaction this reconciliation is for.
- account object
  
  The account that created the reconciliation.

GET /api/v1/bank-transaction/{bankTransaction_uuid}/reconciliations

curl \
 -X GET https://api.plannrcrm.com/api/v1/bank-transaction/bankTransaction_uuid/reconciliations \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "uuid": "1ca5431d-09af-4107-81ee-a943026cabde",
  "amount": {
    "amount": {
      "example": "4000",
      "description": "Money amount at their lowest denominator (for example: pennies)"
    },
    "currency": {
      "example": "GBP",
      "description": "Currency of the money"
    },
    "formatted": {
      "example": "£40.00",
      "description": "Money amount formatted with currency"
    }
  },
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "692035ff-830b-4565-b691-8bff74407cd0",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:17+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:17+01:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2024-10-16T11:10:17+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:17+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:17+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:17+01:00"
  },
  "created_at": "2024-10-16T11:10:17+01:00",
  "updated_at": "2024-10-16T11:10:17+01:00",
  "bank_transaction": {
    "date": "2022-07-15",
    "firm": "App\\Http\\Resources\\FirmResource",
    "uuid": "7af6ba27-cd76-47bf-902f-f95b3389f11f",
    "amount": {
      "amount": "12399",
      "currency": "GBP",
      "formatted": "£123.99"
    },
    "account": "App\\Http\\Resources\\AccountResource",
    "filename": "Natwest June 2022 Statement.xlsx",
    "metadata": {
      "client_name": "Gareth Thompson"
    },
    "reference": "VitalityLtd",
    "statement": "App\\Http\\Resources\\StatementResource",
    "created_at": "2024-10-16T11:10:17+01:00",
    "updated_at": "2024-10-16T11:10:17+01:00",
    "bank_statement": "App\\Http\\Resources\\BankStatementResource"
  },
  "statement_transaction": {
    "date": "2024-10-16",
    "firm": "App\\Http\\Resources\\FirmResource",
    "uuid": "9538e221-8231-4db5-820b-af83c9debd3f",
    "reason": "Reason",
    "account": "App\\Http\\Resources\\AccountResource",
    "category": "initial_fee",
    "metadata": {
      "client_name": "Gareth Thompson"
    },
    "provider": "Aviva",
    "statement": "App\\Http\\Resources\\StatementResource",
    "created_at": "2024-10-16T11:10:17+01:00",
    "net_amount": {
      "amount": {
        "example": "4000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£40.00",
        "description": "Money amount formatted with currency"
      }
    },
    "updated_at": "2024-10-16T11:10:17+01:00",
    "client_name": "Gareth Thompson",
    "expectation": "App\\Http\\Resources\\ExpectationResource",
    "scheme_name": "Scheme name",
    "adviser_name": "Adviser name",
    "gross_amount": {
      "amount": {
        "example": "4000",
        "description": "Money amount at their lowest denominator (for example: pennies)"
      },
      "currency": {
        "example": "GBP",
        "description": "Currency of the money"
      },
      "formatted": {
        "example": "£40.00",
        "description": "Money amount formatted with currency"
      }
    },
    "agency_number": "Agency number",
    "policy_number": "AVIVA_00001",
    "scheme_number": "Scheme number",
    "payment_origin": "provider",
    "customer_number": "Customer number",
    "bank_transactions": "App\\Http\\Resources\\BankTransactionResource",
    "product_reference": "Product reference",
    "provider_statement": "App\\Http\\Resources\\ProviderStatementResource",
    "policy_market_value": "Policy market value",
    "sender_id_sib_number": "Sender id sib number",
    "transaction_reference": "pBJfjHAVQl"
  }
}