List chart of accounts categories

GET

/api/categories

curl --request GET \
  --url 'https://api.getvespy.com/api/categories?type=asset' \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Query Parameters

type

string

Allowed values: asset liability equity income cost_of_services expense trust

includeInactive

boolean

leafOnly

boolean

Responses

200

Default Response

Media typeapplication/json

object

categories

required

Array<object>

object

code

required

string

description

required

string

nullable

id

required

string format: uuid

isActive

required

boolean

isLeaf

required

boolean

name

required

string

organizationId

required

string format: uuid

nullable

parentCode

required

string

nullable

sortOrder

required

integer

type

required

string

Allowed values: asset liability equity income cost_of_services expense trust

Example

{
  "categories": [
    {
      "type": "asset"
    }
  ]
}

400

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}