Account codes
Update Account Code
Updates a custom account code. System default accounts cannot be updated.
PUT
/
finance
/
accounts
/
{code}
Update Account Code
curl --request PUT \
--url https://api.sandbox.flowpayroll.ai/v1/billing/finance/accounts/{code} \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"code": "<string>",
"name": "<string>",
"taxType": "<string>",
"description": "<string>",
"organisationId": "<string>",
"isInUse": true,
"providerId": "<string>",
"externalProvider": "<string>",
"lastSyncedAt": "<string>",
"syncErrorMessage": "<string>",
"createdDate": "<string>",
"createdBy": "<string>",
"updatedDate": "<string>",
"updatedBy": "<string>"
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/billing/finance/accounts/{code}"
payload = {
"code": "<string>",
"name": "<string>",
"taxType": "<string>",
"description": "<string>",
"organisationId": "<string>",
"isInUse": True,
"providerId": "<string>",
"externalProvider": "<string>",
"lastSyncedAt": "<string>",
"syncErrorMessage": "<string>",
"createdDate": "<string>",
"createdBy": "<string>",
"updatedDate": "<string>",
"updatedBy": "<string>"
}
headers = {
"X-Auth-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
code: '<string>',
name: '<string>',
taxType: '<string>',
description: '<string>',
organisationId: '<string>',
isInUse: true,
providerId: '<string>',
externalProvider: '<string>',
lastSyncedAt: '<string>',
syncErrorMessage: '<string>',
createdDate: '<string>',
createdBy: '<string>',
updatedDate: '<string>',
updatedBy: '<string>'
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/billing/finance/accounts/{code}', 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.sandbox.flowpayroll.ai/v1/billing/finance/accounts/{code}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'code' => '<string>',
'name' => '<string>',
'taxType' => '<string>',
'description' => '<string>',
'organisationId' => '<string>',
'isInUse' => true,
'providerId' => '<string>',
'externalProvider' => '<string>',
'lastSyncedAt' => '<string>',
'syncErrorMessage' => '<string>',
'createdDate' => '<string>',
'createdBy' => '<string>',
'updatedDate' => '<string>',
'updatedBy' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Auth-Token: <api-key>"
],
]);
$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.sandbox.flowpayroll.ai/v1/billing/finance/accounts/{code}"
payload := strings.NewReader("{\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"taxType\": \"<string>\",\n \"description\": \"<string>\",\n \"organisationId\": \"<string>\",\n \"isInUse\": true,\n \"providerId\": \"<string>\",\n \"externalProvider\": \"<string>\",\n \"lastSyncedAt\": \"<string>\",\n \"syncErrorMessage\": \"<string>\",\n \"createdDate\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"updatedDate\": \"<string>\",\n \"updatedBy\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
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.put("https://api.sandbox.flowpayroll.ai/v1/billing/finance/accounts/{code}")
.header("X-Auth-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"taxType\": \"<string>\",\n \"description\": \"<string>\",\n \"organisationId\": \"<string>\",\n \"isInUse\": true,\n \"providerId\": \"<string>\",\n \"externalProvider\": \"<string>\",\n \"lastSyncedAt\": \"<string>\",\n \"syncErrorMessage\": \"<string>\",\n \"createdDate\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"updatedDate\": \"<string>\",\n \"updatedBy\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/billing/finance/accounts/{code}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Auth-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"taxType\": \"<string>\",\n \"description\": \"<string>\",\n \"organisationId\": \"<string>\",\n \"isInUse\": true,\n \"providerId\": \"<string>\",\n \"externalProvider\": \"<string>\",\n \"lastSyncedAt\": \"<string>\",\n \"syncErrorMessage\": \"<string>\",\n \"createdDate\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"updatedDate\": \"<string>\",\n \"updatedBy\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {
"code": "<string>",
"name": "<string>",
"type": "Revenue",
"status": "Active",
"taxType": "<string>",
"description": "<string>",
"organisationId": "<string>",
"isInUse": true,
"providerId": "<string>",
"externalProvider": "<string>",
"syncStatus": "NotSynced",
"lastSyncedAt": "<string>",
"syncErrorMessage": "<string>",
"createdDate": "<string>",
"createdBy": "<string>",
"updatedDate": "<string>",
"updatedBy": "<string>"
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": "<string>",
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": "<string>",
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": "<string>",
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}Authorizations
Authentication token for API access
Path Parameters
Body
application/json
One line of this organisation's chart of accounts.
Account code (e.g., "200", "SALES").
Which side of the ledger an account sits on.
Available options:
Revenue, Expense, Asset, Liability, Equity Status of an account code.
Available options:
Active, Archived Default tax type for this account.
True when this account code is referenced by credit notes or client finance settings; delete is not allowed (use archive instead).
The accounting system's own id for this account. Without it a later edit asks for the code to be created again.
Which accounting system holds it, as the integrations hub named it.
Sync status with external provider.
Available options:
NotSynced, Synced, SyncFailed, Syncing, NeedsAttention When the accounting system last synced this (UTC, ISO 8601).
The provider's own moment, not when this service recorded the answer, so it is safe to reconcile against the provider's records and does not move with our internal queue timings. Null until a send has succeeded.
Last sync error message when sync failed.
Response
OK
Billing's response envelope: the platform's (message.text + message.token,
content.data + content.metadata, validationIssues) plus the fields billing
sent before it (PRODLAUNCH-416). Those are deprecated, removed on 31 December 2026, and are
projections of their replacements so the two cannot disagree.
What happened, as English text and a stable snake_case token to translate from.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Deprecated: the same issues as validationIssues (reasonText is reason, reasonId is reasonToken, reasonParameters is reasonTokenArguments). Read validationIssues; this will be removed.
Show child attributes
Show child attributes
Deprecated: the same values as content.metadata. Read that; this will be removed.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Update Account Code
curl --request PUT \
--url https://api.sandbox.flowpayroll.ai/v1/billing/finance/accounts/{code} \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"code": "<string>",
"name": "<string>",
"taxType": "<string>",
"description": "<string>",
"organisationId": "<string>",
"isInUse": true,
"providerId": "<string>",
"externalProvider": "<string>",
"lastSyncedAt": "<string>",
"syncErrorMessage": "<string>",
"createdDate": "<string>",
"createdBy": "<string>",
"updatedDate": "<string>",
"updatedBy": "<string>"
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/billing/finance/accounts/{code}"
payload = {
"code": "<string>",
"name": "<string>",
"taxType": "<string>",
"description": "<string>",
"organisationId": "<string>",
"isInUse": True,
"providerId": "<string>",
"externalProvider": "<string>",
"lastSyncedAt": "<string>",
"syncErrorMessage": "<string>",
"createdDate": "<string>",
"createdBy": "<string>",
"updatedDate": "<string>",
"updatedBy": "<string>"
}
headers = {
"X-Auth-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
code: '<string>',
name: '<string>',
taxType: '<string>',
description: '<string>',
organisationId: '<string>',
isInUse: true,
providerId: '<string>',
externalProvider: '<string>',
lastSyncedAt: '<string>',
syncErrorMessage: '<string>',
createdDate: '<string>',
createdBy: '<string>',
updatedDate: '<string>',
updatedBy: '<string>'
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/billing/finance/accounts/{code}', 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.sandbox.flowpayroll.ai/v1/billing/finance/accounts/{code}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'code' => '<string>',
'name' => '<string>',
'taxType' => '<string>',
'description' => '<string>',
'organisationId' => '<string>',
'isInUse' => true,
'providerId' => '<string>',
'externalProvider' => '<string>',
'lastSyncedAt' => '<string>',
'syncErrorMessage' => '<string>',
'createdDate' => '<string>',
'createdBy' => '<string>',
'updatedDate' => '<string>',
'updatedBy' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Auth-Token: <api-key>"
],
]);
$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.sandbox.flowpayroll.ai/v1/billing/finance/accounts/{code}"
payload := strings.NewReader("{\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"taxType\": \"<string>\",\n \"description\": \"<string>\",\n \"organisationId\": \"<string>\",\n \"isInUse\": true,\n \"providerId\": \"<string>\",\n \"externalProvider\": \"<string>\",\n \"lastSyncedAt\": \"<string>\",\n \"syncErrorMessage\": \"<string>\",\n \"createdDate\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"updatedDate\": \"<string>\",\n \"updatedBy\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
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.put("https://api.sandbox.flowpayroll.ai/v1/billing/finance/accounts/{code}")
.header("X-Auth-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"taxType\": \"<string>\",\n \"description\": \"<string>\",\n \"organisationId\": \"<string>\",\n \"isInUse\": true,\n \"providerId\": \"<string>\",\n \"externalProvider\": \"<string>\",\n \"lastSyncedAt\": \"<string>\",\n \"syncErrorMessage\": \"<string>\",\n \"createdDate\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"updatedDate\": \"<string>\",\n \"updatedBy\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/billing/finance/accounts/{code}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Auth-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"taxType\": \"<string>\",\n \"description\": \"<string>\",\n \"organisationId\": \"<string>\",\n \"isInUse\": true,\n \"providerId\": \"<string>\",\n \"externalProvider\": \"<string>\",\n \"lastSyncedAt\": \"<string>\",\n \"syncErrorMessage\": \"<string>\",\n \"createdDate\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"updatedDate\": \"<string>\",\n \"updatedBy\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {
"code": "<string>",
"name": "<string>",
"type": "Revenue",
"status": "Active",
"taxType": "<string>",
"description": "<string>",
"organisationId": "<string>",
"isInUse": true,
"providerId": "<string>",
"externalProvider": "<string>",
"syncStatus": "NotSynced",
"lastSyncedAt": "<string>",
"syncErrorMessage": "<string>",
"createdDate": "<string>",
"createdBy": "<string>",
"updatedDate": "<string>",
"updatedBy": "<string>"
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": "<string>",
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": "<string>",
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": "<string>",
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}