Skip to content
AcrivaDocs

ListGlAccounts

GET
/api/v1/t/{tenant}/finance/gl-accounts
curl --request GET \
  --url 'https://example.com/api/v1/t/example/finance/gl-accounts?status=Active'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

Query Parameters

Section titled “Query Parameters”
q
string
status
Allowed values: Active Inactive All
accountClass
string
taxKeyId
string format: uuid
usedOnly
boolean
cursor
string
limit
integer format: int32

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
number
required
string
name
required
string
accountClass
required
null | string
defaultTaxKeyId
required
null | string format: uuid
isAutomatic
required
boolean
active
required
boolean
usageCount
required
integer format: int32
version
required
integer format: uint32
nextCursor
required
null | string
total
required
integer format: int32
totalAll
required
integer format: int32
accountClasses
required
Array<string>
Examplegenerated
{
  "items": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "number": "example",
      "name": "example",
      "accountClass": "example",
      "defaultTaxKeyId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "isAutomatic": true,
      "active": true,
      "usageCount": 1,
      "version": 1
    }
  ],
  "nextCursor": "example",
  "total": 1,
  "totalAll": 1,
  "accountClasses": [
    "example"
  ]
}

400

Section titled “400”

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Section titled “429”

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}