Accounts
/accounts
Create account
Required scope: accounts:write
Authorization
apiKey X-API-Key<token>
API key provided in dashboard
In: header
Query Parameters
dryRun?boolean
Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode.
Request Body
application/json
name*string
status?string
Value in
"active" | "inactive"type*string
Value in
"ledger" | "bank" | "recurringFee" | "nonPosting"assignments?|null
offsetAccountId?string|null
categoryId?string
banking?|null
uniqueRef?string|null
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" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "type": "ledger" }'{
"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
}