All API resources
Entities
The businesses whose books you keep. Each entity carries its own tax rates and bank accounts.
Base URL https://app.prosaic.works/api/public/v1. Every request needs an API key or access token; see the overview.
List entities
/api/public/v1/entitiesSDK: prosaic.entities.list(params)
Returns all entities that the authenticated user has access to within their workspace. Optionally filter by entity ID or client ID.
Important: This endpoint is the primary source for entity-level reference data including:
taxRates[]— Available tax rates (GST codes) for each entity. UsetaxRates[].codewhen reconciling transactions or creating chart accounts.bankAccounts[]— Linked bank accounts for each entity. Each bank account includes its linked GL account atbankAccounts[].entityAccount(useentityAccount.idwhen posting journals or reconciling against the bank).clients[]— Client users associated with each entity.
Chart of accounts: The currentTemplateId field references the template the entity was provisioned from — it is not the entity's actual chart of accounts. To fetch the entity's GL accounts (including bank-account-linked accounts and any custom accounts), call GET /api/public/v1/entities/{entityId}/charts.
Query parameters
entityIdstringFilter entities by specific entity ID
clientIdstringFilter entities by client user ID (returns entities where the user is a member)
Responses
200 Successful response
dataarray of objectsrequiredShow 14 child attributesHide child attributes
idstringrequirednamestringrequiredtypestringrequiredcurrentTemplateIdstringrequirednullabledefaultTaxAccountIdstringrequirednullablecreatedAtstring (date-time)requiredisGstRegisteredbooleanrequirednullablegstPeriodMonthsnumberrequirednullablegstBasisstringrequirednullablefinancialYearStartMonthnumberrequiredcurrencystringrequiredbankAccountsarray of objectsrequiredShow 11 child attributesHide child attributes
idstringrequiredentityIdstringrequirednullableexternalIdstringrequirednamestringrequiredaliasstringrequirednullableinstitutionstringrequirednullableaccountNumberstringrequirednullablelogoUrlstringrequirednullabletypestringrequiredsourceTypestringrequirednullableentityAccountobjectrequirednullableShow 19 child attributesHide child attributes
idstringrequiredupdatedAtstringreportCategoryReviewedAtstringnullablereportCategoryReviewVersionnumbercodestringrequirednamestringrequiredtypestringrequiredsubtypestringrequiredreportGroupobjectrequirednullableShow 5 child attributesHide child attributes
idstringrequiredkeystringrequirednamestringrequiredstatusstringrequiredaccountTypestringrequired
reportCategoryobjectrequirednullableShow 4 child attributesHide child attributes
idstringrequiredkeystringrequirednamestringrequiredstatusstringrequired
taxCodestringrequireddescriptionstringrequirednullablemappedCodestringrequirednullableisSystembooleanrequiredsystemRolestringnullableparentIdstringnullableisExcludedbooleanisIncludedbooleansourcestringOne of:
template,overridden,custom
clientsarray of objectsrequiredShow 5 child attributesHide child attributes
idstringrequiredemailstringrequirednamestringrequirednullabletradingNamestringrequirednullablecreatedAtstring (date-time)required
taxRatesarray of objectsrequiredShow 5 child attributesHide child attributes
idstringrequiredcodestringrequirednamestringrequireddescriptionstringrequirednullableratestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
401Unauthorized - Invalid or missing API key500Internal server error
const { data } = await prosaic.entities.list();curl https://app.prosaic.works/api/public/v1/entities \
-H "Authorization: Bearer $PROSAIC_API_KEY"Create an entity
/api/public/v1/entitiesSDK: prosaic.entities.create(params)
Creates a new entity in the workspace associated with the API key. Supports full entity configuration including GST settings, client assignment, and bank account linking.
Request body
application/json
accountTemplateIdstringrequiredtypestringrequiredOne of:
individual,company,trust,partnership,rental,othernamestringrequiredworkspaceDimensionIdsarray of stringsisGstRegisteredbooleanareGstReportsAutomatedbooleangstNumberstringirdNumberstringgstPeriodstringOne of:
2,1,3,6,12gstFilingStartDatestringnzbnstringindustryCodestringconversionDatestringnullableclientIdsarray of stringsbankAccountIdsarray of stringsisDemobooleandemoTypestringpartiesarray of objectsShow 8 child attributesHide child attributes
namestringrequiredrolesarray of stringsrequiredidstringisOrganisationbooleannzbnstringsharesnumbersourcestringOne of:
manual,nzbnsourceReferencesarray of objectsShow 3 child attributesHide child attributes
sourcestringrequiredOne of:
nzbn-rolesourceEntityNzbnstringrequireduniqueIdentifierstringrequired
registeredAddressstringpostalAddressstringemailstringphonestringwebsitestringtradingNamesarray of stringsregistrationDatestringentityStatusstringentityTypeDescriptionstringcompanyNumberstring
Responses
201 Successful response
dataobjectrequiredShow 14 child attributesHide child attributes
idstringrequirednamestringrequiredtypestringrequiredcurrentTemplateIdstringrequirednullabledefaultTaxAccountIdstringrequirednullablecreatedAtstring (date-time)requiredisGstRegisteredbooleanrequirednullablegstPeriodMonthsnumberrequirednullablegstBasisstringrequirednullablefinancialYearStartMonthnumberrequiredcurrencystringrequiredbankAccountsarray of objectsrequiredShow 11 child attributesHide child attributes
idstringrequiredentityIdstringrequirednullableexternalIdstringrequirednamestringrequiredaliasstringrequirednullableinstitutionstringrequirednullableaccountNumberstringrequirednullablelogoUrlstringrequirednullabletypestringrequiredsourceTypestringrequirednullableentityAccountobjectrequirednullableShow 19 child attributesHide child attributes
idstringrequiredupdatedAtstringreportCategoryReviewedAtstringnullablereportCategoryReviewVersionnumbercodestringrequirednamestringrequiredtypestringrequiredsubtypestringrequiredreportGroupobjectrequirednullableShow 5 child attributesHide child attributes
idstringrequiredkeystringrequirednamestringrequiredstatusstringrequiredaccountTypestringrequired
reportCategoryobjectrequirednullableShow 4 child attributesHide child attributes
idstringrequiredkeystringrequirednamestringrequiredstatusstringrequired
taxCodestringrequireddescriptionstringrequirednullablemappedCodestringrequirednullableisSystembooleanrequiredsystemRolestringnullableparentIdstringnullableisExcludedbooleanisIncludedbooleansourcestringOne of:
template,overridden,custom
clientsarray of objectsrequiredShow 5 child attributesHide child attributes
idstringrequiredemailstringrequirednamestringrequirednullabletradingNamestringrequirednullablecreatedAtstring (date-time)required
taxRatesarray of objectsrequiredShow 5 child attributesHide child attributes
idstringrequiredcodestringrequirednamestringrequireddescriptionstringrequirednullableratestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
400Validation failed, or system account setup is missing or invalid (SYSTEM_ACCOUNT_VALIDATION).401Unauthorized - Invalid or missing API key403Forbidden. Either the token is scoped to a single entity (`TOKEN_ENTITY_SCOPE`), or the token's workspace role is not a firm staff role — advisor, admin or workspace owner (`INSUFFICIENT_ROLE`).404Workspace not found or access denied409One or more of the supplied `bankAccountIds` is already linked to a different entity (`BANK_ACCOUNT_ASSIGNED_TO_DIFFERENT_ENTITY`). Bank accounts may only be linked while unassigned.500Internal server error
const { data } = await prosaic.entities.create({
accountTemplateId: 'ACCOUNT_TEMPLATE_ID',
type: 'individual',
name: 'Example Ltd',
});curl -X POST https://app.prosaic.works/api/public/v1/entities \
-H "Authorization: Bearer $PROSAIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountTemplateId": "ACCOUNT_TEMPLATE_ID",
"type": "individual",
"name": "Example Ltd"
}'