Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Tinvio Com Account Classifications API
version: '1.0'
contact:
email: build.with@jaz.ai
name: API Support
url: https://jaz.ai
description: 'Operations tagged Account Classifications across 2 of this provider''s published API definitions: tinvio-com-openapi-original.yaml, tinvio-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.getjaz.com
tags:
- description: List the available account classifications.
name: Account Classifications
paths:
/api/v1/account-classifications:
get:
description: List the available account classifications.
operationId: list-account-classifications
parameters:
- description: Maximum number of results per page (max 1000).
in: query
name: limit
schema:
type: integer
default: 100
- description: Zero-indexed row offset into the result set.
in: query
name: offset
schema:
type: integer
default: 0
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AccountClassificationPageableResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'402':
description: Payment Required
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- ApiKeyAuth: []
summary: List Account Classifications
tags:
- Account Classifications
servers:
- url: https://api.getjaz.com
components:
schemas:
ErrorResponse:
properties:
error:
allOf:
- $ref: '#/components/schemas/ErrorResponseData'
description: Error details.
type: object
AccountClass:
enum:
- Asset
- Equity
- Expense
- Liability
- Revenue
type: string
x-enum-varnames:
- AccountClassAsset
- AccountClassEquity
- AccountClassExpense
- AccountClassLiability
- AccountClassRevenue
AccountClassification:
properties:
accountClass:
allOf:
- $ref: '#/components/schemas/AccountClass'
description: Broad ledger class the type belongs to.
accountType:
description: 'Exact display label used by `accountType` on chart-of-accounts entries and
by `classificationType` when creating one. Case- and number-sensitive: a
near miss such as a pluralized "Current Assets" is not rejected, it simply
matches nothing.'
type: string
resourceId:
description: Resource ID of the classification. Stable and shared across organizations.
type: string
type: object
AccountClassificationPageableResponse:
properties:
data:
description: 'Result rows for the requested page. Note the default page size is smaller
than the number of classifications, so a caller enumerating the full set
must pass an explicit limit rather than read the first page.'
items:
$ref: '#/components/schemas/AccountClassification'
type: array
totalElements:
description: Total number of records matching the query.
type: integer
totalPages:
description: Total number of pages.
type: integer
type: object
ErrorResponseData:
properties:
error_type:
description: Error category, for example validation_error, invalid_request_body, or internal_server_error.
example: validation_error
type: string
errors:
description: Error messages describing what went wrong.
items:
type: string
type: array
type: object
securitySchemes:
ApiKeyAuth:
description: Organization API key. Pass it in the x-jk-api-key header on every request.
in: header
name: x-jk-api-key
type: apiKey
x-refined-from:
- tinvio-com-openapi-original.yaml
- tinvio-com-openapi.yml