All API resources
Bank accounts
Link a client's bank accounts to an entity, or create CSV accounts and fill them with transactions from your own systems.
Base URL https://app.prosaic.works/api/public/v1. Every request needs an API key or access token; see the overview.
Create a CSV bank account and import transactions into it
/api/public/v1/entities/{entityId}/bank-accounts/importSDK: prosaic.bankAccounts.createWithTransactions(entityId, params)
Creates a CSV bank account for the entity — one fed by imported files — with its account in the entity's chart so its lines can be reconciled, then imports the transactions into it. All or nothing.
Use this when the entity has no account for the statement, or when its
matching account is a bank feed, which can't take imported
transactions. The new account sits beside the feed account, so both
will need reconciling; prefer importing into an existing CSV account
with POST /entities/{entityId}/bank-accounts/{bankAccountId}/import.
The account belongs to the caller. Amounts are from the account holder's side: money in positive, money out negative; never 0.
Path parameters
entityIdstringrequired
Request body
application/json
filenamestringrequiredtransactionsarray of objectsrequiredShow 9 child attributesHide child attributes
datestringrequireddescriptionstringrequiredamountnumberrequiredtransactionTypestringpayeestringcodestringreferencestringparticularsstringbankTransactionIdstring
namestringrequiredinstitutionstringrequiredaccountNumberstring
Responses
201 Successful response
dataobjectrequiredShow 7 child attributesHide child attributes
bankAccountIdstringrequiredbankAccountNamestringrequiredinstitutionstringrequirednullableaccountNumberstringrequirednullableimportIdstringrequirednullabletransactionsImportednumberrequiredmessagestringrequired
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
400Invalid body (`VALIDATION_ERROR`, `INVALID_ROW_DATE`, `ZERO_AMOUNT_TRANSACTION`)401Invalid or missing API key or token404Entity not found or not accessible500Internal server error
const { data } = await prosaic.bankAccounts.createWithTransactions(entityId, {
filename: 'Example Ltd',
transactions: [
{
date: '2026-04-01',
description: 'Office supplies',
amount: 100,
},
],
name: 'Example Ltd',
institution: 'string',
});curl -X POST https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/bank-accounts/import \
-H "Authorization: Bearer $PROSAIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"filename": "Example Ltd",
"transactions": [
{
"date": "2026-04-01",
"description": "Office supplies",
"amount": 100
}
],
"name": "Example Ltd",
"institution": "string"
}'Link bank accounts to an entity
/api/public/v1/entities/{entityId}/bank-accountsSDK: prosaic.bankAccounts.link(entityId, params)
Links existing bank accounts to the entity, creating each one's general ledger account in the entity's chart of accounts. Linking only ever adds: accounts already on the entity are left as they are, and no account is unlinked.
Each account must belong to a client of the entity — find them with
GET /api/public/v1/clients/{clientId}/bank-accounts — and must not be
linked to a different entity.
Path parameters
entityIdstringrequired
Request body
application/json
bankAccountIdsarray of stringsrequired
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
400Validation failed (`VALIDATION_ERROR`), an ID does not exist (`INVALID_BANK_ACCOUNT_IDS`), or an account does not belong to a client of the entity (`BANK_ACCOUNTS_CLIENT_MISMATCH`)401Unauthorized - Invalid or missing API key/token404Entity not found or not accessible409An account is already linked to a different entity (`BANK_ACCOUNT_ASSIGNED_TO_DIFFERENT_ENTITY`)500Internal server error
const { data } = await prosaic.bankAccounts.link(entityId, {
bankAccountIds: ['BANK_ACCOUNT_ID'],
});curl -X POST https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/bank-accounts \
-H "Authorization: Bearer $PROSAIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"bankAccountIds": [
"BANK_ACCOUNT_ID"
]
}'Import transactions into a CSV bank account
/api/public/v1/entities/{entityId}/bank-accounts/{bankAccountId}/importSDK: prosaic.bankAccounts.importTransactions(entityId, bankAccountId, params)
Adds transactions to one of the entity's CSV bank accounts — the kind
fed by imported files (sourceType: csv on the bank account). Bank
feeds (akahu, siss) can't take imported transactions; create a
separate CSV account with POST /entities/{entityId}/bank-accounts/import
instead.
Rows the account already holds (same date, amount and description) are skipped, so importing an overlapping statement is safe. Amounts are from the account holder's side: money in positive, money out negative. Zero amounts are rejected.
Path parameters
entityIdstringrequiredbankAccountIdstringrequired
Request body
application/json
filenamestringrequiredtransactionsarray of objectsrequiredShow 9 child attributesHide child attributes
datestringrequireddescriptionstringrequiredamountnumberrequiredtransactionTypestringpayeestringcodestringreferencestringparticularsstringbankTransactionIdstring
Responses
200 Successful response
dataobjectrequiredShow 6 child attributesHide child attributes
bankAccountIdstringrequiredbankAccountNamestringrequiredimportIdstringrequirednullabletransactionsImportednumberrequiredtransactionsSkippednumberrequiredmessagestringrequired
metaobjectShow 1 child attributeHide child attributes
countnumberrequired
400Invalid body (`VALIDATION_ERROR`, `INVALID_ROW_DATE`, `ZERO_AMOUNT_TRANSACTION`), a bank feed account (`BANK_ACCOUNT_NOT_CSV`), or an account missing its owner or bank (`BANK_ACCOUNT_NOT_IMPORTABLE`)401Invalid or missing API key or token404The entity or bank account wasn't found, or isn't accessible (`BANK_ACCOUNT_NOT_FOUND`)500Internal server error
const { data } = await prosaic.bankAccounts.importTransactions(entityId, bankAccountId, {
filename: 'Example Ltd',
transactions: [
{
date: '2026-04-01',
description: 'Office supplies',
amount: 100,
},
],
});curl -X POST https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/bank-accounts/$BANK_ACCOUNT_ID/import \
-H "Authorization: Bearer $PROSAIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"filename": "Example Ltd",
"transactions": [
{
"date": "2026-04-01",
"description": "Office supplies",
"amount": 100
}
]
}'