Retrieves the account types.

curl --request GET \
  --url https://api.example.com/api/accounts/types \
  --header 'Authorization: <authorization>' \
  --header 'organization-id: <organization-id>'

import requests

url = "https://api.example.com/api/accounts/types"

headers = {
    "Authorization": "<authorization>",
    "organization-id": "<organization-id>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: '<authorization>', 'organization-id': '<organization-id>'}
};

fetch('https://api.example.com/api/accounts/types', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/accounts/types",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "organization-id: <organization-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/accounts/types"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("organization-id", "<organization-id>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/api/accounts/types")
  .header("Authorization", "<authorization>")
  .header("organization-id", "<organization-id>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/accounts/types")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'

response = http.request(request)
puts response.read_body

[
  {
    "label": "Cash",
    "key": "cash",
    "normal": "debit",
    "parentType": "current-asset",
    "rootType": "asset",
    "multiCurrency": true,
    "balanceSheet": true,
    "incomeSheet": false
  }
]

GET

api

accounts

types

Retrieves the account types.

curl --request GET \
  --url https://api.example.com/api/accounts/types \
  --header 'Authorization: <authorization>' \
  --header 'organization-id: <organization-id>'

import requests

url = "https://api.example.com/api/accounts/types"

headers = {
    "Authorization": "<authorization>",
    "organization-id": "<organization-id>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: '<authorization>', 'organization-id': '<organization-id>'}
};

fetch('https://api.example.com/api/accounts/types', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/accounts/types",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "organization-id: <organization-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/accounts/types"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("organization-id", "<organization-id>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/api/accounts/types")
  .header("Authorization", "<authorization>")
  .header("organization-id", "<organization-id>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/accounts/types")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'

response = http.request(request)
puts response.read_body

[
  {
    "label": "Cash",
    "key": "cash",
    "normal": "debit",
    "parentType": "current-asset",
    "rootType": "asset",
    "multiCurrency": true,
    "balanceSheet": true,
    "incomeSheet": false
  }
]

Headers

Authorization

string

required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

organization-id

string

required

Required if Authorization is a JWT token. The organization ID to operate within.

Response

200 - application/json

The account types have been successfully retrieved.

label

string

required

The display label for the account type

Example:

"Cash"

key

string

required

The unique key for the account type

Example:

"cash"

normal

string

required

The normal balance type for the account

Example:

"debit"

parentType

string

required

The parent type of the account

Example:

"current-asset"

rootType

string

required

The root type of the account

Example:

"asset"

multiCurrency

boolean

required

Whether the account type supports multiple currencies

Example:

true

balanceSheet

boolean

required

Whether the account type appears on the balance sheet

Example:

true

incomeSheet

boolean

required

Whether the account type appears on the income sheet

Example:

false

Inactivate the given account.Retrieves the account transactions.

Get Started

API Reference

Retrieves the account types.

Headers

Response