All API resources
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
/api/public/v1/clientsSDK: 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
clientIdstringFilter by specific client ID
emailstringFilter by client email address
Responses
200 Successful response
dataarray of objectsrequiredShow 6 child attributesHide child attributes
idstringrequiredemailstringrequirednamestringrequirednullabletradingNamestringrequirednullablecreatedAtstring (date-time)requiredbankAccountsarray of objectsrequiredShow 2 child attributesHide child attributes
idstringrequirednamestringrequired
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
401Unauthorized - Invalid or missing API key404Workspace not found or access denied500Internal server error
const { data } = await prosaic.clients.list();curl https://app.prosaic.works/api/public/v1/clients \
-H "Authorization: Bearer $PROSAIC_API_KEY"List client's bank transactions
/api/public/v1/clients/{clientId}/transactionsSDK: 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 stringsComma-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)
reconciliationStatusstringFilter by reconciliation status
One of:
reconciled,unreconciledpageintegerPage number (starts at 1)
Default:
1pageSizeintegerNumber of items per page
Default:
20
Responses
200 Successful response
dataarray of objectsrequiredShow 16 child attributesHide child attributes
entityIdstringrequirednullablereconciliationStatusstringrequiredOne of:
reconciled,unreconciledjournalIdstringrequirednullablebankAccountobjectrequiredShow 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
merchantobjectrequirednullableShow 4 child attributesHide child attributes
idstringrequirednamestringrequiredproviderstringrequirednullableidentifierstringrequired
categoryobjectrequirednullableShow 3 child attributesHide child attributes
idstringrequirednamestringrequiredidentifierstringrequired
userobjectrequiredShow 5 child attributesHide child attributes
idstringrequiredemailstringrequirednamestringrequirednullabletradingNamestringrequirednullablecreatedAtstring (date-time)required
suggestionsarray of objectsShow 7 child attributesHide child attributes
idstringrequiredsourceTypestringrequiredconfidencestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
statusstringrequiredruleIdstringrequirednullableruleNamestringrequirednullablelinesarray of objectsrequiredShow 8 child attributesHide child attributes
idstringrequiredproportionstringrequirednullableExact decimal serialized as a string. Use Decimal.js for arithmetic.
creditstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
debitstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
entityAccountIdstringrequiredentityAccountobjectrequiredShow 3 child attributesHide child attributes
idstringrequiredcodestringrequirednamestringrequired
taxRateIdstringrequirednullabletaxRateobjectrequirednullableShow 5 child attributesHide child attributes
idstringrequiredcodestringrequirednamestringrequireddescriptionstringrequirednullableratestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
idstringrequireddatestring (date-time)requiredamountstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
descriptionstringrequiredtypestringrequiredparticularsstringrequirednullablecodestringrequirednullablereferencestringrequirednullable
paginationobjectrequiredShow 6 child attributesHide child attributes
currentPagenumberrequiredpageSizenumberrequiredtotalCountnumberrequiredtotalPagesnumberrequiredhasNextPagebooleanrequiredhasPreviousPagebooleanrequired
400Bad request - invalid parameters401Unauthorized - Invalid or missing API key/token403Forbidden - User does not have access to this client404Client not found500Internal server error
const page = await prosaic.clients.listTransactions(clientId);curl https://app.prosaic.works/api/public/v1/clients/$CLIENT_ID/transactions \
-H "Authorization: Bearer $PROSAIC_API_KEY"List client's bank accounts
/api/public/v1/clients/{clientId}/bank-accountsSDK: 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 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
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
401Unauthorized - Invalid or missing API key/token403Forbidden - User does not have access to this client404Client not found500Internal server error
const { data } = await prosaic.clients.listBankAccounts(clientId);curl https://app.prosaic.works/api/public/v1/clients/$CLIENT_ID/bank-accounts \
-H "Authorization: Bearer $PROSAIC_API_KEY"Create a client
/api/public/v1/clientsSDK: 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
namestringrequiredemailstringrequiredtradingNamestringsendInvitebooleanmessagestring
Responses
200 Successful response
dataobjectrequiredShow 6 child attributesHide child attributes
idstringrequiredemailstringrequirednamestringrequirednullabletradingNamestringrequirednullablecreatedAtstring (date-time)requiredbankAccountsarray of objectsrequiredShow 2 child attributesHide child attributes
idstringrequirednamestringrequired
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
400Validation failed401Unauthorized - Invalid or missing API key404Workspace not found or access denied429Invitation email rate limit exceeded500Internal server error
const { data } = await prosaic.clients.create({
name: 'Example Ltd',
email: 'accounts@example.com',
});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"
}'Create onboarding link
/api/public/v1/clients/{clientId}/onboardingSDK: prosaic.clients.createOnboardingLink(clientId, params)
Path parameters
clientIdstringrequired
Request body
application/json
integrationIdstringcallbackURLstringstatestring
Responses
200 Successful response
dataobjectrequiredShow 1 child attributeHide child attributes
magicLinkstringrequired
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
const { data } = await prosaic.clients.createOnboardingLink(clientId, {
integrationId: 'INTEGRATION_ID',
callbackURL: 'https://example.com/callback',
state: 'string',
});curl -X POST https://app.prosaic.works/api/public/v1/clients/$CLIENT_ID/onboarding \
-H "Authorization: Bearer $PROSAIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"integrationId": "INTEGRATION_ID",
"callbackURL": "https://example.com/callback",
"state": "string"
}'