VRPlatformVRPlatform
Accounts

/accounts/{id}/connections

Attach an external account connection to a bank account

Required scope: bank-connections:manage

POST
/accounts/{id}/connections

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

Request Body

application/json

accountConnectionId*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
startDate*string
onConflict?string
Default"error"
Value in"error" | "replace" | "replace-and-detach-history"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://staging.api.vrplatform.app/accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/connections" \  -H "Content-Type: application/json" \  -d '{    "accountConnectionId": "abe5aadc-e445-4e9f-922d-9e3bf6f5b6e0",    "startDate": "string"  }'
{
  "name": "string",
  "status": "active",
  "type": "ledger",
  "uniqueRef": "string",
  "id": "string",
  "offsetAccount": {
    "id": "string",
    "name": "string",
    "uniqueRef": "string",
    "status": "active"
  },
  "assignments": [
    "accountsPayable"
  ],
  "category": {
    "id": "string",
    "name": "string",
    "classification": "asset"
  },
  "categoryLock": {
    "status": "locked",
    "reason": "immutable"
  },
  "issues": [
    {
      "code": "accountConnectionLast4OutOfSync",
      "severity": "warning",
      "context": {
        "accountLast4": "stri",
        "accountConnectionLast4": "stri",
        "accountConnectionIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ]
      }
    }
  ],
  "capabilities": {
    "achPayments": {
      "enabled": true,
      "disabledReasons": [
        "unsupportedProvider"
      ]
    }
  },
  "banking": {
    "category": "trust",
    "type": "deposit",
    "last4": "stri",
    "currency": "string",
    "connections": [
      {
        "id": "string",
        "name": "string",
        "startDate": "string",
        "capabilities": {
          "achPayments": {
            "enabled": true,
            "disabledReasons": [
              "unsupportedProvider"
            ]
          }
        },
        "connection": {
          "id": "string",
          "appId": "string",
          "name": "string",
          "status": "active",
          "isErrorState": true,
          "icon": "string",
          "type": "string"
        },
        "status": "active",
        "currentSync": {
          "status": "queued",
          "createdAt": "2024-01-15T12:30:00.000+00:00",
          "updatedAt": "2024-01-15T12:30:00.000+00:00",
          "message": "string"
        },
        "source": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "type": "string",
          "status": "active",
          "appId": "string",
          "appIcon": "string"
        }
      }
    ],
    "bankRecords": {
      "reconciled": 0,
      "unreconciled": 0,
      "total": 0,
      "latestCreatedAt": "2024-01-15T12:30:00.000+00:00"
    },
    "balance": {
      "openingDate": "string",
      "opening": 0,
      "ending": 0
    }
  }
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

/accounts/{id}/banking-init POST

Previous Page

/accounts/{id}/recalculate-balances POST

Next Page