VRPlatformVRPlatform
Bank records

/bank-records/{id}

Get a bank record with optional reconciliation suggestions and bank-rule previews.

Required scope: bank-records:read

GET
/bank-records/{id}

Authorization

apiKey
X-API-Key<token>

API key provided in dashboard

In: header

Path Parameters

id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Query Parameters

includeMatchingRules?boolean

Include bank-rule suggestions

includeMatchingTransaction?boolean

Include ordered exact matching transaction sets

matchingTransactionDaysOffset?integer

Maximum date offset for exact transaction suggestions; defaults to seven days. Multi-transaction sets remain limited to seven days.

Default7
Range0 <= value <= 9007199254740991

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vrplatform.app/bank-records/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "uniqueRef": "string",
  "date": "string",
  "status": "active",
  "description": "string",
  "accountConnectionId": "string",
  "accountConnection": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d"
  },
  "accountId": "string",
  "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
  "appId": "string",
  "type": "transaction",
  "lock": {
    "status": "locked",
    "delete": {
      "status": "locked",
      "reasons": [
        "notCsvSource"
      ]
    }
  },
  "amount": -9007199254740991,
  "balance": {
    "current": 0,
    "correction": 0
  },
  "reconciliation": {
    "status": "unpaid",
    "transactions": [
      {
        "id": "string",
        "date": "string",
        "description": "string",
        "type": "string",
        "amount": 0
      }
    ]
  },
  "matchedByBankRule": true,
  "matchingTransactionSets": [
    {
      "transactions": [
        {
          "id": "string",
          "status": "active",
          "amount": -9007199254740991,
          "account": {
            "id": "string",
            "name": "string",
            "uniqueRef": "string",
            "status": "active"
          },
          "date": "string",
          "description": "string",
          "currency": "string",
          "type": "deposit",
          "isOpeningBalance": true,
          "contact": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "firstName": "string",
            "uniqueRef": "string",
            "shortRef": "string",
            "email": "user@example.com",
            "type": "owner"
          },
          "connection": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "status": "active",
            "uniqueRef": "string",
            "appId": "string"
          },
          "uniqueRef": "string",
          "shortRef": "string",
          "recurringTemplate": {
            "id": "string"
          },
          "dateOffset": 9007199254740991,
          "matchDetails": {
            "ambiguous": true,
            "amountDifference": -9007199254740991,
            "matchingDate": "string",
            "maxDateOffset": 9007199254740991,
            "reasons": [
              "exactAmount"
            ]
          },
          "listings": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "name": "string",
              "uniqueRef": "string",
              "shortRef": "string"
            }
          ],
          "reservations": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "confirmationCode": "string",
              "uniqueRef": "string",
              "shortRef": "string"
            }
          ]
        }
      ],
      "combinedAmount": -9007199254740991,
      "currency": "string",
      "dateEvidence": {
        "totalDateOffset": 9007199254740991,
        "maxDateOffset": 9007199254740991
      },
      "matchDetails": {
        "ambiguous": true,
        "amountDifference": -9007199254740991,
        "reasons": [
          "exactAmount"
        ]
      }
    }
  ],
  "matchingRules": [
    {
      "rule": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "priority": -9007199254740991,
        "transactionType": "deposit",
        "mode": "suggest",
        "status": "active"
      },
      "preview": {
        "matches": true,
        "isAutoApplicable": true,
        "bankRecord": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "date": "string",
          "description": "string",
          "amount": -9007199254740991,
          "accountConnectionId": "abe5aadc-e445-4e9f-922d-9e3bf6f5b6e0",
          "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9"
        },
        "transaction": {
          "description": "string",
          "status": "active",
          "accountId": "string",
          "contactId": "string",
          "uniqueRef": "string",
          "isOpeningBalance": true,
          "type": "deposit",
          "date": "string",
          "currency": "string",
          "lines": [
            {
              "recurringTemplateId": "string",
              "uniqueRef": "string",
              "description": "string",
              "accountId": "string",
              "assignment": "accountsPayable",
              "amount": -9007199254740991,
              "appliedAmount": {
                "taxRateId": "88399542-51a6-40f6-9447-2208069d3c34"
              },
              "markup": {
                "amount": -9007199254740991,
                "taxRateId": "88399542-51a6-40f6-9447-2208069d3c34",
                "taxBehavior": "excluded"
              },
              "listingId": "string",
              "reservationId": "string",
              "ownerStatementId": "eccddabd-554b-48ab-a66d-28a57ff66fa9",
              "party": "owners",
              "contactId": "string",
              "matchReservationConfirmationCode": "string",
              "matchReservationStripeGuestRef": "string",
              "matchReservationProcessorBookingRef": "string",
              "matchLineTypeClassification": "string"
            }
          ],
          "attachmentIds": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "payment": {
            "bankRecordIds": [
              "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            ],
            "status": "unpaid",
            "date": "string",
            "lock": null
          },
          "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
          "sourceId": "797f5a94-3689-4ac8-82fd-d749511ea2b2",
          "recurringTemplateId": "d73afa31-bf14-4baf-aede-be5f4b4ff489",
          "recreatedFromTransactionId": "000264af-6c3a-4ff1-8534-ade50aa8d7fb",
          "matchBankAccountLast4": "string"
        }
      },
      "matchDetails": {
        "ambiguous": true,
        "hasAccountScope": true,
        "accountMatches": true,
        "directionMatches": true,
        "matchMode": "all",
        "conditions": [
          {
            "condition": {
              "type": "description",
              "operator": "contains",
              "value": "string"
            },
            "matches": true
          }
        ]
      }
    }
  ],
  "currency": "string"
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "MISDIRECTED_REQUEST",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": {
    "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
    "dataRegion": "ap",
    "apiBaseUrl": "http://example.com"
  }
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

/bank-records/{id} DELETE

Previous Page

/bank-records/csv GET

Next Page