All API resources
Chart of accounts
Chart of accounts templates, each entity's own accounts, and the global account library templates are built from.
Base URL https://app.prosaic.works/api/public/v1. Every request needs an API key or access token; see the overview.
List all chart of accounts templates
/api/public/v1/chartsSDK: prosaic.charts.list()
Returns all chart of accounts templates in the workspace. Requires API key authentication.
Responses
200 Successful response
dataarray of objectsrequiredShow 4 child attributesHide child attributes
idstringrequirednamestringrequireddescriptionstringrequirednullableaccountCountnumberrequired
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
401Unauthorized - Invalid or missing API key
const { data } = await prosaic.charts.list();curl https://app.prosaic.works/api/public/v1/charts \
-H "Authorization: Bearer $PROSAIC_API_KEY"Get chart of accounts template accounts
/api/public/v1/charts/{chartId}SDK: prosaic.charts.listAccounts(chartId, params)
Returns paginated accounts from a chart-of-accounts template (the read-only blueprint entities are provisioned from). When includeHidden=true, also returns global accounts not in the template with isIncluded=false. Requires API key authentication.
Each included account also exposes its nullable confirmed systemRole and saved reportGroup/reportCategory summaries. subtype remains the legacy compatibility value, independent of report placement. Hidden global suggestions have systemRole=null and no saved report assignment.
Important: The id values returned by this endpoint are template account IDs (TemplateAccount.id). They are not the IDs of an entity's actual GL accounts — do not use them to post journals or look up reconciliation activity.
To fetch the chart of accounts for a specific entity (including bank-account-linked accounts and any custom accounts), use GET /api/public/v1/entities/{entityId}/charts. The bank-account-to-GL linkage is also embedded on each entity's bank account at bankAccounts[].entityAccount in the GET /api/public/v1/entities response.
Tax codes: The taxCode field is returned as the human-readable tax name (e.g. "15% GST on Income", or "No GST" when unset), not the machine code. When creating or updating a template you must pass the machine code instead (NZ_GST_15_INC, NZ_GST_15_EXP, NZ_GST_0_NONE, NZ_GST_0_ZERO), so convert the name back to its code before writing.
Path parameters
chartIdstringrequired
Query parameters
includeHiddenbooleanWhen true, includes global accounts not in the template (with isIncluded=false). Disables pagination.
Default:
falsepageintegerPage number (starts at 1). Ignored when includeHidden=true.
Default:
1pageSizeintegerNumber of items per page. Ignored when includeHidden=true.
Default:
20
Responses
200 Successful response
dataarray of objectsrequiredShow 16 child attributesHide child attributes
idstringrequiredcodestringrequirednamestringrequiredtypestringrequiredsubtypestringrequiredreportGroupobjectrequirednullableShow 5 child attributesHide child attributes
idstringrequiredkeystringrequirednamestringrequiredstatusstringrequiredaccountTypestringrequired
reportCategoryobjectrequirednullableShow 4 child attributesHide child attributes
idstringrequiredkeystringrequirednamestringrequiredstatusstringrequired
taxCodestringrequireddescriptionstringrequirednullablemappedCodestringrequirednullableisSystembooleanrequiredsystemRolestringnullableparentIdstringnullableisExcludedbooleanisIncludedbooleansourcestringOne of:
template,overridden,custom
paginationobjectrequiredShow 6 child attributesHide child attributes
currentPagenumberrequiredpageSizenumberrequiredtotalCountnumberrequiredtotalPagesnumberrequiredhasNextPagebooleanrequiredhasPreviousPagebooleanrequired
400Bad request - missing or invalid parameters401Unauthorized - Invalid or missing API key403Forbidden - No access to the specified chart404Chart not found
const page = await prosaic.charts.listAccounts(chartId);curl https://app.prosaic.works/api/public/v1/charts/$CHART_ID \
-H "Authorization: Bearer $PROSAIC_API_KEY"Create a chart of accounts template
/api/public/v1/chartsSDK: prosaic.charts.create(params)
Creates a new chart of accounts template in the workspace. Every system global
account (see GET /api/public/v1/global-accounts, isSystem: true) must be present
in accounts with isIncluded: true — otherwise the request fails with
SYSTEM_ACCOUNT_VALIDATION listing all missing accounts. Set
includeSystemAccounts: true to have any omitted system accounts added
automatically from their global definitions. Requires API key authentication.
Tax codes: The taxCode field expects the machine code, not the human-readable tax name.
Passing a name (e.g. "15% GST on Income") is stored verbatim and resolves to null wherever the
code is looked up. Valid codes are NZ_GST_15_INC (15% GST on Income), NZ_GST_15_EXP
(15% GST on Expenses), NZ_GST_0_NONE (No GST), and NZ_GST_0_ZERO (Zero-rated GST). Omit
taxCode or set it to null to default to NZ_GST_0_NONE (No GST).
Description defaults: description is optional per account; omitting it (or null) leaves
the account description empty.
Request body
application/json
namestringrequiredaccountsarray of objectsrequiredShow 9 child attributesHide child attributes
codestringrequirednamestringrequiredtypestringrequiredisIncludedbooleanrequiredsubtypestringnullabletaxCodestringnullableOne of:
NZ_GST_15_INC,NZ_GST_15_EXP,NZ_GST_0_NONE,NZ_GST_0_ZERO,AU_GST_10_INC,AU_GST_10_EXP,AU_GST_0_NONE,AU_GST_0_INPUT,AU_GST_0_EXPORTdescriptionstringnullablemappedCodestringnullableparentCodestringnullable
descriptionstringincludeSystemAccountsboolean
Responses
201 Successful response
dataobjectrequiredShow 3 child attributesHide child attributes
idstringrequirednamestringrequireddescriptionstringrequirednullable
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
400Validation error. `SYSTEM_ACCOUNT_VALIDATION` includes `details.missingAccounts` listing every required system account absent from the payload.401Unauthorized
const { data } = await prosaic.charts.create({
name: 'Example Ltd',
accounts: [
{
code: '200',
name: 'Example Ltd',
type: 'string',
isIncluded: true,
},
],
});curl -X POST https://app.prosaic.works/api/public/v1/charts \
-H "Authorization: Bearer $PROSAIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Example Ltd",
"accounts": [
{
"code": "200",
"name": "Example Ltd",
"type": "string",
"isIncluded": true
}
]
}'Add a single account to a chart of accounts template
/api/public/v1/charts/{chartId}/accountsSDK: prosaic.charts.createAccount(chartId, params)
Adds one account to a chart of accounts template without resending the full account list. To
add a top-level (parent) account, provide its global account code; to add a custom child
account, provide code, name, and parentCode (the child code must be {parentCode}.{digits}).
The addition propagates to every entity using the template. Requires API key authentication.
Path parameters
chartIdstringrequired
Request body
application/json
codestringrequirednamestringnullableparentCodestringnullabletaxCodestringnullableOne of:
NZ_GST_15_INC,NZ_GST_15_EXP,NZ_GST_0_NONE,NZ_GST_0_ZERO,AU_GST_10_INC,AU_GST_10_EXP,AU_GST_0_NONE,AU_GST_0_INPUT,AU_GST_0_EXPORTdescriptionstringnullablemappedCodestringnullable
Responses
200 Successful response
dataobjectrequiredShow 3 child attributesHide child attributes
idstringrequirednullablecodestringrequiredentitiesUpdatednumberrequired
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
400Validation error or business rule violation401Unauthorized404Chart not found409An account with this code already exists, or the code conflicts with a custom entity account
const { data } = await prosaic.charts.createAccount(chartId, {
code: '200',
});curl -X POST https://app.prosaic.works/api/public/v1/charts/$CHART_ID/accounts \
-H "Authorization: Bearer $PROSAIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"code": "200"
}'Update a chart of accounts template
/api/public/v1/charts/{chartId}/updateSDK: prosaic.charts.update(chartId, params)
Updates a chart of accounts template. When accounts is provided it fully replaces the
template's account list (delegates to updateAccountTemplateAccounts and propagates to all
entities). When accounts is omitted, only the provided template metadata (name,
description) is updated and accounts are left untouched. Omit a metadata field to preserve
its existing value, or send description: null to clear the description. A full replacement
list must still contain every
system account (GET /api/public/v1/global-accounts, isSystem: true) with
isIncluded: true — otherwise the request fails with SYSTEM_ACCOUNT_VALIDATION listing
all missing accounts. Set includeSystemAccounts: true to carry over any omitted system
accounts automatically. For surgical single-account changes use the
/charts/{chartId}/accounts endpoints instead. Requires API key authentication.
Tax codes: The taxCode field expects the machine code, not the human-readable tax name.
Passing a name (e.g. "15% GST on Income") is stored verbatim and resolves to null wherever the
code is looked up. Valid codes are NZ_GST_15_INC (15% GST on Income), NZ_GST_15_EXP
(15% GST on Expenses), NZ_GST_0_NONE (No GST), and NZ_GST_0_ZERO (Zero-rated GST). Note that
GET /api/public/v1/charts/{chartId} returns the human-readable name on read — convert it back to
the machine code before writing.
Field preserve/clear semantics: For each account, omitting a field (description, taxCode,
mappedCode) preserves its existing value, while an explicit null clears it (taxCode clears to
NZ_GST_0_NONE).
Path parameters
chartIdstringrequired
Request body
application/json
namestringdescriptionstringnullableincludeSystemAccountsbooleanaccountsarray of objectsShow 7 child attributesHide child attributes
codestringrequiredisIncludedbooleanrequirednamestringdescriptionstringnullabletaxCodestringnullableOne of:
NZ_GST_15_INC,NZ_GST_15_EXP,NZ_GST_0_NONE,NZ_GST_0_ZERO,AU_GST_10_INC,AU_GST_10_EXP,AU_GST_0_NONE,AU_GST_0_INPUT,AU_GST_0_EXPORTmappedCodestringnullableparentCodestringnullable
Responses
200 Successful response
dataobjectrequiredShow 4 child attributesHide child attributes
idstringrequirednamestringrequireddescriptionstringrequirednullableentitiesUpdatednumberrequired
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
400Validation error or business rule violation. `SYSTEM_ACCOUNT_VALIDATION` includes `details.missingAccounts` listing every required system account absent from the payload.401Unauthorized404Chart not found409Account code conflict - new template account codes conflict with custom accounts in entities using this template
const { data } = await prosaic.charts.update(chartId, {
name: 'Example Ltd',
description: 'Office supplies',
includeSystemAccounts: true,
accounts: [
{
code: '200',
isIncluded: true,
},
],
});curl -X POST https://app.prosaic.works/api/public/v1/charts/$CHART_ID/update \
-H "Authorization: Bearer $PROSAIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Example Ltd",
"description": "Office supplies",
"includeSystemAccounts": true,
"accounts": [
{
"code": "200",
"isIncluded": true
}
]
}'Update a single account in a chart of accounts template
/api/public/v1/charts/{chartId}/accounts/{accountId}/updateSDK: prosaic.charts.updateAccount(chartId, accountId, params)
Updates one account in a chart of accounts template without resending the full account list.
Supports name, description, taxCode, mappedCode and code (rename, kept under the same
parent). A code rename cascades non-destructively to every entity account derived from this
template account (balances and customizations are preserved). Changes propagate to all entities
using the template. Omitted fields preserve their existing values; send description: null to
clear the description. accountId is the TemplateAccount ID from GET /charts/{chartId}.
Requires API key authentication.
Path parameters
chartIdstringrequiredaccountIdstringrequired
Request body
application/json
namestringdescriptionstringnullabletaxCodestringnullableOne of:
NZ_GST_15_INC,NZ_GST_15_EXP,NZ_GST_0_NONE,NZ_GST_0_ZERO,AU_GST_10_INC,AU_GST_10_EXP,AU_GST_0_NONE,AU_GST_0_INPUT,AU_GST_0_EXPORTmappedCodestringnullablecodestring
Responses
200 Successful response
dataobjectrequiredShow 2 child attributesHide child attributes
idstringrequiredentitiesUpdatednumberrequired
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
400Validation error or business rule violation401Unauthorized404Chart or account not found409The new code conflicts with an existing template or entity account
const { data } = await prosaic.charts.updateAccount(chartId, accountId, {
name: 'Example Ltd',
description: 'Office supplies',
taxCode: 'NZ_GST_15_INC',
mappedCode: 'MAPPED_CODE',
code: '200',
});curl -X POST https://app.prosaic.works/api/public/v1/charts/$CHART_ID/accounts/$ACCOUNT_ID/update \
-H "Authorization: Bearer $PROSAIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Example Ltd",
"description": "Office supplies",
"taxCode": "NZ_GST_15_INC",
"mappedCode": "MAPPED_CODE",
"code": "200"
}'Delete a chart of accounts template
/api/public/v1/charts/{chartId}/deleteSDK: prosaic.charts.del(chartId)
Deletes a chart of accounts template. Cannot delete templates with assigned entities. Requires API key authentication.
Path parameters
chartIdstringrequired
Responses
200 Successful response
dataobjectrequiredShow 1 child attributeHide child attributes
successbooleanrequired
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
401Unauthorized404Chart not found409Cannot delete template with assigned entities
const { data } = await prosaic.charts.del(chartId);curl -X POST https://app.prosaic.works/api/public/v1/charts/$CHART_ID/delete \
-H "Authorization: Bearer $PROSAIC_API_KEY"Delete a single account from a chart of accounts template
/api/public/v1/charts/{chartId}/accounts/{accountId}/deleteSDK: prosaic.charts.deleteAccount(chartId, accountId)
Removes one account from a chart of accounts template without resending the full account list.
The removal propagates to every entity using the template. Accounts that have journal entries,
child accounts, or are system accounts cannot be removed. accountId is the TemplateAccount ID
from GET /charts/{chartId}. Requires API key authentication.
Path parameters
chartIdstringrequiredaccountIdstringrequired
Responses
200 Successful response
dataobjectrequiredShow 2 child attributesHide child attributes
successbooleanrequiredentitiesUpdatednumberrequired
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
400Account has journal entries, has children, or is a system account401Unauthorized404Chart or account not found
const { data } = await prosaic.charts.deleteAccount(chartId, accountId);curl -X POST https://app.prosaic.works/api/public/v1/charts/$CHART_ID/accounts/$ACCOUNT_ID/delete \
-H "Authorization: Bearer $PROSAIC_API_KEY"List chart of accounts for an entity
/api/public/v1/entities/{entityId}/chartsSDK: prosaic.entityAccounts.list(entityId, params)
Returns chart account codes configured for the specified entity. Supports filtering by system accounts and excluded accounts. Requires API key authentication and entity access. reportGroup and reportCategory expose the saved reporting classification; subtype remains the legacy compatibility value and may differ from current report placement. Null category with a saved group is valid.
Path parameters
entityIdstringrequired
Query parameters
includeSystemstringInclude system-generated accounts (GST, Rounding, Retained Earnings, etc.) in the response. Defaults to true so all account codes are available for mapping (e.g. importing a trial balance or journals). Pass includeSystem=false to exclude system accounts.
includeExcludedstringInclude accounts that have been excluded from the entity's chart. When true, excluded accounts are returned with isExcluded=true flag, and their data comes from the template account.
Responses
200 Successful response
dataarray of objectsrequiredShow 16 child attributesHide child attributes
idstringrequiredcodestringrequirednamestringrequiredtypestringrequiredsubtypestringrequiredreportGroupobjectrequirednullableShow 5 child attributesHide child attributes
idstringrequiredkeystringrequirednamestringrequiredstatusstringrequiredaccountTypestringrequired
reportCategoryobjectrequirednullableShow 4 child attributesHide child attributes
idstringrequiredkeystringrequirednamestringrequiredstatusstringrequired
taxCodestringrequireddescriptionstringrequirednullablemappedCodestringrequirednullableisSystembooleanrequiredsystemRolestringnullableparentIdstringnullableisExcludedbooleanisIncludedbooleansourcestringOne of:
template,overridden,custom
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
400Bad request - missing or invalid parameters401Unauthorized - Invalid or missing API key403Forbidden - No access to the specified entity500Internal server error
const { data } = await prosaic.entityAccounts.list(entityId);curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/charts \
-H "Authorization: Bearer $PROSAIC_API_KEY"Create a child account in the chart of accounts
/api/public/v1/entities/{entityId}/chartsSDK: prosaic.entityAccounts.create(entityId, params)
Creates a new child (sub) account under an existing parent account. Only 2-level hierarchy is supported (parent → child, no grandchildren). Parent account can be referenced by ID, code, or mappedCode to support external system integrations.
Path parameters
entityIdstringrequired
Request body
application/json
codestringrequirednamestringrequiredtaxCodestringrequiredparentAccountIdstringparentAccountCodestringparentMappedCodestringdescriptionstringnullablemappedCodestringnullable
Responses
201 Successful response
dataobjectrequiredShow 16 child attributesHide child attributes
idstringrequiredcodestringrequirednamestringrequiredtypestringrequiredsubtypestringrequiredreportGroupobjectrequirednullableShow 5 child attributesHide child attributes
idstringrequiredkeystringrequirednamestringrequiredstatusstringrequiredaccountTypestringrequired
reportCategoryobjectrequirednullableShow 4 child attributesHide child attributes
idstringrequiredkeystringrequirednamestringrequiredstatusstringrequired
taxCodestringrequireddescriptionstringrequirednullablemappedCodestringrequirednullableisSystembooleanrequiredsystemRolestringnullableparentIdstringnullableisExcludedbooleanisIncludedbooleansourcestringOne of:
template,overridden,custom
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
400Bad request - validation error or business rule violation403Forbidden - No access to the specified entity404Parent account not found409Conflict - account code already exists500Internal server error
const { data } = await prosaic.entityAccounts.create(entityId, {
code: '200',
name: 'Example Ltd',
taxCode: 'TAX_CODE',
});curl -X POST https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/charts \
-H "Authorization: Bearer $PROSAIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"code": "200",
"name": "Example Ltd",
"taxCode": "TAX_CODE"
}'Update an entity account
/api/public/v1/entities/{entityId}/charts/{accountId}/updateSDK: prosaic.entityAccounts.update(entityId, accountId, params)
Updates an entity account's editable fields. Parent accounts can only update taxCode and mappedCode. Bank account-linked accounts have additional restrictions.
Path parameters
entityIdstringrequiredaccountIdstringrequired
Request body
application/json
namestringdescriptionstringnullabletaxCodestringmappedCodestringnullablecodestring
Responses
200 Successful response
dataobjectrequiredShow 16 child attributesHide child attributes
idstringrequiredcodestringrequirednamestringrequiredtypestringrequiredsubtypestringrequiredreportGroupobjectrequirednullableShow 5 child attributesHide child attributes
idstringrequiredkeystringrequirednamestringrequiredstatusstringrequiredaccountTypestringrequired
reportCategoryobjectrequirednullableShow 4 child attributesHide child attributes
idstringrequiredkeystringrequirednamestringrequiredstatusstringrequired
taxCodestringrequireddescriptionstringrequirednullablemappedCodestringrequirednullableisSystembooleanrequiredsystemRolestringnullableparentIdstringnullableisExcludedbooleanisIncludedbooleansourcestringOne of:
template,overridden,custom
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
400Validation error or business rule violation404Account not found
const { data } = await prosaic.entityAccounts.update(entityId, accountId, {
name: 'Example Ltd',
description: 'Office supplies',
taxCode: 'TAX_CODE',
mappedCode: 'MAPPED_CODE',
code: '200',
});curl -X POST https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/charts/$ACCOUNT_ID/update \
-H "Authorization: Bearer $PROSAIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Example Ltd",
"description": "Office supplies",
"taxCode": "TAX_CODE",
"mappedCode": "MAPPED_CODE",
"code": "200"
}'Restore a hidden/excluded template account
/api/public/v1/entities/{entityId}/charts/excluded/{templateAccountId}/restoreSDK: prosaic.entityAccounts.restore(entityId, templateAccountId)
Restores an excluded template account by removing the exclusion and recreating the entity account from the template. No request body required.
Path parameters
entityIdstringrequiredtemplateAccountIdstringrequired
Responses
200 Successful response
dataobjectrequiredShow 1 child attributeHide child attributes
successbooleanrequired
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
400Parent account must be restored first, or restoring would conflict with an assigned system role (SYSTEM_ACCOUNT_CONFLICT).404Template account no longer exists (chart template may have been updated)500Internal server error
const { data } = await prosaic.entityAccounts.restore(entityId, templateAccountId);curl -X POST https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/charts/excluded/$TEMPLATE_ACCOUNT_ID/restore \
-H "Authorization: Bearer $PROSAIC_API_KEY"Reset an entity account to template defaults
/api/public/v1/entities/{entityId}/charts/{accountId}/resetSDK: prosaic.entityAccounts.reset(entityId, accountId)
Resets all customized fields on a template-based entity account back to the template values and clears customization flags. No request body required.
Path parameters
entityIdstringrequiredaccountIdstringrequired
Responses
200 Successful response
dataobjectrequiredShow 1 child attributeHide child attributes
successbooleanrequired
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
404Account not found500Internal server error
const { data } = await prosaic.entityAccounts.reset(entityId, accountId);curl -X POST https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/charts/$ACCOUNT_ID/reset \
-H "Authorization: Bearer $PROSAIC_API_KEY"Delete or hide an entity account
/api/public/v1/entities/{entityId}/charts/{accountId}/deleteSDK: prosaic.entityAccounts.del(entityId, accountId)
Deletes a custom child account or hides a template-based child account by creating an exclusion. Parent accounts cannot be deleted. Accounts assigned a system role or linked to bank accounts, fixed assets or inter-entity transfers cannot be deleted.
Path parameters
entityIdstringrequiredaccountIdstringrequired
Responses
200 Successful response
dataobjectrequiredShow 1 child attributeHide child attributes
successbooleanrequired
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
400The account is a parent, has children or journal entries, or has an operational link that prevents deletion (DELETE_RESTRICTED).404Account not found
const { data } = await prosaic.entityAccounts.del(entityId, accountId);curl -X POST https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/charts/$ACCOUNT_ID/delete \
-H "Authorization: Bearer $PROSAIC_API_KEY"List report groups and categories for an entity
/api/public/v1/entities/{entityId}/report-categoriesSDK: prosaic.reportCategories.list(entityId)
Returns the complete stored taxonomy for the authorised entity's country. Parent IDs and sort order describe the group tree. Headings are structure only; isAssignable=false prevents their selection. An ordinary group may allow a null category, but bank and asset-account functions can still require one. Category placements are exact, not inherited. Examples: Operating expenses (exp.operating) is assignable with no category; Retained earnings (equ.retainedearnings) also permits a null category. Expenses (exp) is a heading and cannot be assigned. This endpoint does not change accounts. No country parameter or pagination is required.
Path parameters
entityIdstringrequired
Responses
200 Successful response
dataobjectrequiredShow 3 child attributesHide child attributes
countrystringrequiredgroupsarray of objectsrequiredShow 11 child attributesHide child attributes
idstringrequiredkeystringrequirednamestringrequiredstatusstringrequiredaccountTypestringrequireddescriptionstringrequirednullableparentIdstringrequirednullablesortOrdernumberrequiredisHeadingbooleanrequiredisAssignablebooleanrequiredallowGroupOnlybooleanrequired
categoriesarray of objectsrequiredShow 8 child attributesHide child attributes
idstringrequiredkeystringrequirednamestringrequiredstatusstringrequireddescriptionstringrequiredcodingGuidancestringrequirednullabledefaultGroupIdstringrequiredallowedGroupIdsarray of stringsrequired
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
400Invalid entity ID401Missing or invalid bearer authentication403Bearer token is pinned to another entity404Entity not found or access denied500Unexpected failure loading the taxonomy503Permission service temporarily unavailable
const { data } = await prosaic.reportCategories.list(entityId);curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/report-categories \
-H "Authorization: Bearer $PROSAIC_API_KEY"List all global accounts
/api/public/v1/global-accountsSDK: prosaic.globalAccounts.list()
Returns the full system account library (global accounts). These are the master accounts from which templates are built. Requires API key authentication.
Responses
200 Successful response
dataarray of objectsrequiredShow 9 child attributesHide child attributes
idstringrequiredcodestringrequirednamestringrequireddescriptionstringrequirednullabletypestringrequiredsubtypestringrequiredisSystembooleanrequiredtaxCodestringrequirednullablemetadataanyrequired
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
401Unauthorized - Invalid or missing API key
const { data } = await prosaic.globalAccounts.list();curl https://app.prosaic.works/api/public/v1/global-accounts \
-H "Authorization: Bearer $PROSAIC_API_KEY"