All API resources
API reference

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

GET/api/public/v1/entities

SDK: 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. Use taxRates[].code when reconciling transactions or creating chart accounts.
  • bankAccounts[] — Linked bank accounts for each entity. Each bank account includes its linked GL account at bankAccounts[].entityAccount (use entityAccount.id when 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

  • entityIdstring

    Filter entities by specific entity ID

  • clientIdstring

    Filter entities by client user ID (returns entities where the user is a member)

Responses

200 Successful response

  • dataarray of objectsrequired
    Show 14 child attributes
    • idstringrequired
    • namestringrequired
    • typestringrequired
    • currentTemplateIdstringrequirednullable
    • defaultTaxAccountIdstringrequirednullable
    • createdAtstring (date-time)required
    • isGstRegisteredbooleanrequirednullable
    • gstPeriodMonthsnumberrequirednullable
    • gstBasisstringrequirednullable
    • financialYearStartMonthnumberrequired
    • currencystringrequired
    • bankAccountsarray of objectsrequired
      Show 11 child attributes
      • idstringrequired
      • entityIdstringrequirednullable
      • externalIdstringrequired
      • namestringrequired
      • aliasstringrequirednullable
      • institutionstringrequirednullable
      • accountNumberstringrequirednullable
      • logoUrlstringrequirednullable
      • typestringrequired
      • sourceTypestringrequirednullable
      • entityAccountobjectrequirednullable
        Show 19 child attributes
        • idstringrequired
        • updatedAtstring
        • reportCategoryReviewedAtstringnullable
        • reportCategoryReviewVersionnumber
        • codestringrequired
        • namestringrequired
        • typestringrequired
        • subtypestringrequired
        • reportGroupobjectrequirednullable
          Show 5 child attributes
          • idstringrequired
          • keystringrequired
          • namestringrequired
          • statusstringrequired
          • accountTypestringrequired
        • reportCategoryobjectrequirednullable
          Show 4 child attributes
          • idstringrequired
          • keystringrequired
          • namestringrequired
          • statusstringrequired
        • taxCodestringrequired
        • descriptionstringrequirednullable
        • mappedCodestringrequirednullable
        • isSystembooleanrequired
        • systemRolestringnullable
        • parentIdstringnullable
        • isExcludedboolean
        • isIncludedboolean
        • sourcestring

          One of: template, overridden, custom

    • clientsarray of objectsrequired
      Show 5 child attributes
      • idstringrequired
      • emailstringrequired
      • namestringrequirednullable
      • tradingNamestringrequirednullable
      • createdAtstring (date-time)required
    • taxRatesarray of objectsrequired
      Show 5 child attributes
      • idstringrequired
      • codestringrequired
      • namestringrequired
      • descriptionstringrequirednullable
      • ratestringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

  • metaobject
    Show 1 child attribute
    • countnumberrequired
  • 401 Unauthorized - Invalid or missing API key
  • 500 Internal server error
Node SDK
const { data } = await prosaic.entities.list();
curl
curl https://app.prosaic.works/api/public/v1/entities \
  -H "Authorization: Bearer $PROSAIC_API_KEY"

Create an entity

POST/api/public/v1/entities

SDK: 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

  • accountTemplateIdstringrequired
  • typestringrequired

    One of: individual, company, trust, partnership, rental, other

  • namestringrequired
  • workspaceDimensionIdsarray of strings
  • isGstRegisteredboolean
  • areGstReportsAutomatedboolean
  • gstNumberstring
  • irdNumberstring
  • gstPeriodstring

    One of: 2, 1, 3, 6, 12

  • gstFilingStartDatestring
  • nzbnstring
  • industryCodestring
  • conversionDatestringnullable
  • clientIdsarray of strings
  • bankAccountIdsarray of strings
  • isDemoboolean
  • demoTypestring
  • partiesarray of objects
    Show 8 child attributes
    • namestringrequired
    • rolesarray of stringsrequired
    • idstring
    • isOrganisationboolean
    • nzbnstring
    • sharesnumber
    • sourcestring

      One of: manual, nzbn

    • sourceReferencesarray of objects
      Show 3 child attributes
      • sourcestringrequired

        One of: nzbn-role

      • sourceEntityNzbnstringrequired
      • uniqueIdentifierstringrequired
  • registeredAddressstring
  • postalAddressstring
  • emailstring
  • phonestring
  • websitestring
  • tradingNamesarray of strings
  • registrationDatestring
  • entityStatusstring
  • entityTypeDescriptionstring
  • companyNumberstring

Responses

201 Successful response

  • dataobjectrequired
    Show 14 child attributes
    • idstringrequired
    • namestringrequired
    • typestringrequired
    • currentTemplateIdstringrequirednullable
    • defaultTaxAccountIdstringrequirednullable
    • createdAtstring (date-time)required
    • isGstRegisteredbooleanrequirednullable
    • gstPeriodMonthsnumberrequirednullable
    • gstBasisstringrequirednullable
    • financialYearStartMonthnumberrequired
    • currencystringrequired
    • bankAccountsarray of objectsrequired
      Show 11 child attributes
      • idstringrequired
      • entityIdstringrequirednullable
      • externalIdstringrequired
      • namestringrequired
      • aliasstringrequirednullable
      • institutionstringrequirednullable
      • accountNumberstringrequirednullable
      • logoUrlstringrequirednullable
      • typestringrequired
      • sourceTypestringrequirednullable
      • entityAccountobjectrequirednullable
        Show 19 child attributes
        • idstringrequired
        • updatedAtstring
        • reportCategoryReviewedAtstringnullable
        • reportCategoryReviewVersionnumber
        • codestringrequired
        • namestringrequired
        • typestringrequired
        • subtypestringrequired
        • reportGroupobjectrequirednullable
          Show 5 child attributes
          • idstringrequired
          • keystringrequired
          • namestringrequired
          • statusstringrequired
          • accountTypestringrequired
        • reportCategoryobjectrequirednullable
          Show 4 child attributes
          • idstringrequired
          • keystringrequired
          • namestringrequired
          • statusstringrequired
        • taxCodestringrequired
        • descriptionstringrequirednullable
        • mappedCodestringrequirednullable
        • isSystembooleanrequired
        • systemRolestringnullable
        • parentIdstringnullable
        • isExcludedboolean
        • isIncludedboolean
        • sourcestring

          One of: template, overridden, custom

    • clientsarray of objectsrequired
      Show 5 child attributes
      • idstringrequired
      • emailstringrequired
      • namestringrequirednullable
      • tradingNamestringrequirednullable
      • createdAtstring (date-time)required
    • taxRatesarray of objectsrequired
      Show 5 child attributes
      • idstringrequired
      • codestringrequired
      • namestringrequired
      • descriptionstringrequirednullable
      • ratestringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

  • metaobject
    Show 1 child attribute
    • countnumberrequired
  • 400 Validation failed, or system account setup is missing or invalid (SYSTEM_ACCOUNT_VALIDATION).
  • 401 Unauthorized - Invalid or missing API key
  • 403 Forbidden. 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`).
  • 404 Workspace not found or access denied
  • 409 One 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.
  • 500 Internal server error
Node SDK
const { data } = await prosaic.entities.create({
  accountTemplateId: 'ACCOUNT_TEMPLATE_ID',
  type: 'individual',
  name: 'Example Ltd',
});
curl
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"
  }'