account-codes

Get Account Codes

Account Code Types

Account Code Type Type
ASSETS 0
LIABILITY 1
EXPENSE 2
INCOME 3
EQUITY 4
OTHER 5
SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
active
boolean
code
string
format
string
Enum: "csv" "json"
is_parent
boolean
order_by
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

search
string

A search term.

Responses
200
Response Schema:
object
Array of objects (AccountCodeRead)
get/api/v3/account-codes/
Response samples
{
  • "metadata": {
    },
  • "data": [
    ]
}

Create Account Codes

Account Code Types

Account Code Type Type
ASSETS 0
LIABILITY 1
EXPENSE 2
INCOME 3
EQUITY 4
OTHER 5
SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
format
string
Enum: "csv" "json"
Request Body schema:
required
code
required
string [ 1 .. 50 ] characters
description
required
string [ 1 .. 200 ] characters
parent
integer or null
account_type
integer [ -2147483648 .. 2147483647 ]
  • 0 - Assets
  • 1 - Liability
  • 2 - Expense
  • 3 - Income
  • 4 - Equity
  • 5 - Other
Enum: 0 1 2 3 4 5
departments
Array of integers
Responses
201
Response Schema:
object
Default: {}
required
object (AccountCodeRead)
post/api/v3/account-codes/
Request samples
{
  • "code": "string",
  • "description": "string",
  • "parent": 0,
  • "account_type": 0,
  • "departments": [
    ]
}
Response samples
{
  • "metadata": { },
  • "data": {
    }
}

Update Account Code

Account Code Types

Account Code Type Type
ASSETS 0
LIABILITY 1
EXPENSE 2
INCOME 3
EQUITY 4
OTHER 5
SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
path Parameters
id
required
integer

A unique integer value identifying this account code.

query Parameters
format
string
Enum: "csv" "json"
Request Body schema:
required
code
required
string [ 1 .. 50 ] characters
description
required
string [ 1 .. 200 ] characters
account_type
integer [ -2147483648 .. 2147483647 ]
  • 0 - Assets
  • 1 - Liability
  • 2 - Expense
  • 3 - Income
  • 4 - Equity
  • 5 - Other
Enum: 0 1 2 3 4 5
parent
integer or null
Responses
200
Response Schema:
object
Default: {}
required
object (AccountCodeRead)
put/api/v3/account-codes/{id}/
Request samples
{
  • "code": "string",
  • "description": "string",
  • "account_type": 0,
  • "parent": 0
}
Response samples
{
  • "metadata": { },
  • "data": {
    }
}
➔ Next to accounts