All API resources
API reference

Clients

An accounting practice's clients, their bank accounts and transactions, and onboarding links.

Base URL https://app.prosaic.works/api/public/v1. Every request needs an API key or access token; see the overview.

List clients

GET/api/public/v1/clients

SDK: prosaic.clients.list(params)

Returns client users (client and standard_user roles) in the workspace tied to the token. Callers authenticated as client or standard_user only ever receive their own client record, even within a shared workspace. Accountant-style roles receive the full list (subject to filters).

Query parameters

  • clientIdstring

    Filter by specific client ID

  • emailstring

    Filter by client email address

Responses

200 Successful response

  • dataarray of objectsrequired
    Show 6 child attributes
    • idstringrequired
    • emailstringrequired
    • namestringrequirednullable
    • tradingNamestringrequirednullable
    • createdAtstring (date-time)required
    • bankAccountsarray of objectsrequired
      Show 2 child attributes
      • idstringrequired
      • namestringrequired
  • metaobject
    Show 1 child attribute
    • countnumberrequired
  • 401 Unauthorized - Invalid or missing API key
  • 404 Workspace not found or access denied
  • 500 Internal server error
Node SDK
const { data } = await prosaic.clients.list();
curl
curl https://app.prosaic.works/api/public/v1/clients \
  -H "Authorization: Bearer $PROSAIC_API_KEY"

List client's bank transactions

GET/api/public/v1/clients/{clientId}/transactions

SDK: prosaic.clients.listTransactions(clientId, params)

Returns paginated bank transactions for the specified client.

Access control:

  • Authenticated user must be the client themselves, OR
  • Authenticated user must be in the same workspace as the client (accountant/advisor)

Supports filtering by:

  • Bank account IDs (comma-separated)
  • Date range (dateFrom, dateTo)
  • Reconciliation status (reconciled | unreconciled)

Path parameters

  • clientIdstringrequired

Query parameters

  • bankAccountIdsarray of strings

    Comma-separated list of bank account IDs to filter by

  • dateFromstring (date)

    Start date for filtering transactions (ISO 8601 format)

  • dateTostring (date)

    End date for filtering transactions (ISO 8601 format)

  • reconciliationStatusstring

    Filter by reconciliation status

    One of: reconciled, unreconciled

  • pageinteger

    Page number (starts at 1)

    Default: 1

  • pageSizeinteger

    Number of items per page

    Default: 20

Responses

200 Successful response

  • dataarray of objectsrequired
    Show 16 child attributes
    • entityIdstringrequirednullable
    • reconciliationStatusstringrequired

      One of: reconciled, unreconciled

    • journalIdstringrequirednullable
    • bankAccountobjectrequired
      Show 11 child attributes
      • idstringrequired
      • entityIdstringrequirednullable
      • externalIdstringrequired
      • namestringrequired
      • aliasstringrequirednullable
      • institutionstringrequirednullable
      • accountNumberstringrequirednullable
      • logoUrlstringrequirednullable
      • typestringrequired
      • sourceTypestringrequirednullable
      • entityAccountobjectrequirednullable
        Show 16 child attributes
        • idstringrequired
        • 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

    • merchantobjectrequirednullable
      Show 4 child attributes
      • idstringrequired
      • namestringrequired
      • providerstringrequirednullable
      • identifierstringrequired
    • categoryobjectrequirednullable
      Show 3 child attributes
      • idstringrequired
      • namestringrequired
      • identifierstringrequired
    • userobjectrequired
      Show 5 child attributes
      • idstringrequired
      • emailstringrequired
      • namestringrequirednullable
      • tradingNamestringrequirednullable
      • createdAtstring (date-time)required
    • suggestionsarray of objects
      Show 7 child attributes
      • idstringrequired
      • sourceTypestringrequired
      • confidencestringrequired

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

      • statusstringrequired
      • ruleIdstringrequirednullable
      • ruleNamestringrequirednullable
      • linesarray of objectsrequired
        Show 8 child attributes
        • idstringrequired
        • proportionstringrequirednullable

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

        • creditstringrequired

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

        • debitstringrequired

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

        • entityAccountIdstringrequired
        • entityAccountobjectrequired
          Show 3 child attributes
          • idstringrequired
          • codestringrequired
          • namestringrequired
        • taxRateIdstringrequirednullable
        • taxRateobjectrequirednullable
          Show 5 child attributes
          • idstringrequired
          • codestringrequired
          • namestringrequired
          • descriptionstringrequirednullable
          • ratestringrequired

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

    • idstringrequired
    • datestring (date-time)required
    • amountstringrequired

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

    • descriptionstringrequired
    • typestringrequired
    • particularsstringrequirednullable
    • codestringrequirednullable
    • referencestringrequirednullable
  • paginationobjectrequired
    Show 6 child attributes
    • currentPagenumberrequired
    • pageSizenumberrequired
    • totalCountnumberrequired
    • totalPagesnumberrequired
    • hasNextPagebooleanrequired
    • hasPreviousPagebooleanrequired
  • 400 Bad request - invalid parameters
  • 401 Unauthorized - Invalid or missing API key/token
  • 403 Forbidden - User does not have access to this client
  • 404 Client not found
  • 500 Internal server error
Node SDK
const page = await prosaic.clients.listTransactions(clientId);
curl
curl https://app.prosaic.works/api/public/v1/clients/$CLIENT_ID/transactions \
  -H "Authorization: Bearer $PROSAIC_API_KEY"

List client's bank accounts

GET/api/public/v1/clients/{clientId}/bank-accounts

SDK: prosaic.clients.listBankAccounts(clientId)

Returns all bank accounts belonging to the specified client.

Access control:

  • Authenticated user must be the client themselves, OR
  • Authenticated user must be in the same workspace as the client (accountant/advisor)

Path parameters

  • clientIdstringrequired

Responses

200 Successful response

  • dataarray of objectsrequired
    Show 11 child attributes
    • idstringrequired
    • entityIdstringrequirednullable
    • externalIdstringrequired
    • namestringrequired
    • aliasstringrequirednullable
    • institutionstringrequirednullable
    • accountNumberstringrequirednullable
    • logoUrlstringrequirednullable
    • typestringrequired
    • sourceTypestringrequirednullable
    • entityAccountobjectrequirednullable
      Show 16 child attributes
      • idstringrequired
      • 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

  • metaobject
    Show 1 child attribute
    • countnumberrequired
  • 401 Unauthorized - Invalid or missing API key/token
  • 403 Forbidden - User does not have access to this client
  • 404 Client not found
  • 500 Internal server error
Node SDK
const { data } = await prosaic.clients.listBankAccounts(clientId);
curl
curl https://app.prosaic.works/api/public/v1/clients/$CLIENT_ID/bank-accounts \
  -H "Authorization: Bearer $PROSAIC_API_KEY"

Create a client

POST/api/public/v1/clients

SDK: prosaic.clients.create(params)

Creates a new client in the workspace associated with the API key. If a client with the same email already exists, returns the existing client.

Request body

application/json

  • namestringrequired
  • emailstringrequired
  • tradingNamestring
  • sendInviteboolean
  • messagestring

Responses

200 Successful response

  • dataobjectrequired
    Show 6 child attributes
    • idstringrequired
    • emailstringrequired
    • namestringrequirednullable
    • tradingNamestringrequirednullable
    • createdAtstring (date-time)required
    • bankAccountsarray of objectsrequired
      Show 2 child attributes
      • idstringrequired
      • namestringrequired
  • metaobject
    Show 1 child attribute
    • countnumberrequired
  • 400 Validation failed
  • 401 Unauthorized - Invalid or missing API key
  • 404 Workspace not found or access denied
  • 429 Invitation email rate limit exceeded
  • 500 Internal server error
Node SDK
const { data } = await prosaic.clients.create({
  name: 'Example Ltd',
  email: 'accounts@example.com',
});
curl
curl -X POST https://app.prosaic.works/api/public/v1/clients \
  -H "Authorization: Bearer $PROSAIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example Ltd",
    "email": "accounts@example.com"
  }'