Create an account
curl --request POST \
--url https://api.example.com/api/accounts \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'organization-id: <organization-id>' \
--data '
{
"name": "Cash Account",
"accountType": "asset",
"code": "CA001",
"currencyCode": "USD",
"description": "Main cash account for daily operations",
"parentAccountId": 1,
"active": true,
"plaidAccountId": "plaid_account_123456",
"plaidItemId": "plaid_item_123456"
}
'import requests
url = "https://api.example.com/api/accounts"
payload = {
"name": "Cash Account",
"accountType": "asset",
"code": "CA001",
"currencyCode": "USD",
"description": "Main cash account for daily operations",
"parentAccountId": 1,
"active": True,
"plaidAccountId": "plaid_account_123456",
"plaidItemId": "plaid_item_123456"
}
headers = {
"Authorization": "<authorization>",
"organization-id": "<organization-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'organization-id': '<organization-id>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Cash Account',
accountType: 'asset',
code: 'CA001',
currencyCode: 'USD',
description: 'Main cash account for daily operations',
parentAccountId: 1,
active: true,
plaidAccountId: 'plaid_account_123456',
plaidItemId: 'plaid_item_123456'
})
};
fetch('https://api.example.com/api/accounts', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Cash Account',
'accountType' => 'asset',
'code' => 'CA001',
'currencyCode' => 'USD',
'description' => 'Main cash account for daily operations',
'parentAccountId' => 1,
'active' => true,
'plaidAccountId' => 'plaid_account_123456',
'plaidItemId' => 'plaid_item_123456'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/accounts"
payload := strings.NewReader("{\n \"name\": \"Cash Account\",\n \"accountType\": \"asset\",\n \"code\": \"CA001\",\n \"currencyCode\": \"USD\",\n \"description\": \"Main cash account for daily operations\",\n \"parentAccountId\": 1,\n \"active\": true,\n \"plaidAccountId\": \"plaid_account_123456\",\n \"plaidItemId\": \"plaid_item_123456\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("organization-id", "<organization-id>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/accounts")
.header("Authorization", "<authorization>")
.header("organization-id", "<organization-id>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Cash Account\",\n \"accountType\": \"asset\",\n \"code\": \"CA001\",\n \"currencyCode\": \"USD\",\n \"description\": \"Main cash account for daily operations\",\n \"parentAccountId\": 1,\n \"active\": true,\n \"plaidAccountId\": \"plaid_account_123456\",\n \"plaidItemId\": \"plaid_item_123456\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Cash Account\",\n \"accountType\": \"asset\",\n \"code\": \"CA001\",\n \"currencyCode\": \"USD\",\n \"description\": \"Main cash account for daily operations\",\n \"parentAccountId\": 1,\n \"active\": true,\n \"plaidAccountId\": \"plaid_account_123456\",\n \"plaidItemId\": \"plaid_item_123456\"\n}"
response = http.request(request)
puts response.read_bodyAccounts
Create an account
POST
/
api
/
accounts
Create an account
curl --request POST \
--url https://api.example.com/api/accounts \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'organization-id: <organization-id>' \
--data '
{
"name": "Cash Account",
"accountType": "asset",
"code": "CA001",
"currencyCode": "USD",
"description": "Main cash account for daily operations",
"parentAccountId": 1,
"active": true,
"plaidAccountId": "plaid_account_123456",
"plaidItemId": "plaid_item_123456"
}
'import requests
url = "https://api.example.com/api/accounts"
payload = {
"name": "Cash Account",
"accountType": "asset",
"code": "CA001",
"currencyCode": "USD",
"description": "Main cash account for daily operations",
"parentAccountId": 1,
"active": True,
"plaidAccountId": "plaid_account_123456",
"plaidItemId": "plaid_item_123456"
}
headers = {
"Authorization": "<authorization>",
"organization-id": "<organization-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'organization-id': '<organization-id>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Cash Account',
accountType: 'asset',
code: 'CA001',
currencyCode: 'USD',
description: 'Main cash account for daily operations',
parentAccountId: 1,
active: true,
plaidAccountId: 'plaid_account_123456',
plaidItemId: 'plaid_item_123456'
})
};
fetch('https://api.example.com/api/accounts', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Cash Account',
'accountType' => 'asset',
'code' => 'CA001',
'currencyCode' => 'USD',
'description' => 'Main cash account for daily operations',
'parentAccountId' => 1,
'active' => true,
'plaidAccountId' => 'plaid_account_123456',
'plaidItemId' => 'plaid_item_123456'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/accounts"
payload := strings.NewReader("{\n \"name\": \"Cash Account\",\n \"accountType\": \"asset\",\n \"code\": \"CA001\",\n \"currencyCode\": \"USD\",\n \"description\": \"Main cash account for daily operations\",\n \"parentAccountId\": 1,\n \"active\": true,\n \"plaidAccountId\": \"plaid_account_123456\",\n \"plaidItemId\": \"plaid_item_123456\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("organization-id", "<organization-id>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/accounts")
.header("Authorization", "<authorization>")
.header("organization-id", "<organization-id>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Cash Account\",\n \"accountType\": \"asset\",\n \"code\": \"CA001\",\n \"currencyCode\": \"USD\",\n \"description\": \"Main cash account for daily operations\",\n \"parentAccountId\": 1,\n \"active\": true,\n \"plaidAccountId\": \"plaid_account_123456\",\n \"plaidItemId\": \"plaid_item_123456\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Cash Account\",\n \"accountType\": \"asset\",\n \"code\": \"CA001\",\n \"currencyCode\": \"USD\",\n \"description\": \"Main cash account for daily operations\",\n \"parentAccountId\": 1,\n \"active\": true,\n \"plaidAccountId\": \"plaid_account_123456\",\n \"plaidItemId\": \"plaid_item_123456\"\n}"
response = http.request(request)
puts response.read_bodyHeaders
Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.
Example:
"Bearer bc_1234567890abcdef"
Required if Authorization is a JWT token. The organization ID to operate within.
Body
application/json
Account name
Required string length:
3 - 255Example:
"Cash Account"
Type of account
Required string length:
3 - 255Example:
"asset"
Account code
Required string length:
3 - 6Example:
"CA001"
Currency code for the account
Example:
"USD"
Account description
Maximum string length:
65535Example:
"Main cash account for daily operations"
ID of the parent account
Example:
1
Whether the account is active
Example:
true
Plaid account ID for syncing
Example:
"plaid_account_123456"
Plaid item ID for syncing
Example:
"plaid_item_123456"
Response
200
The account has been successfully created.
⌘I