All API resources
API reference

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

POST/api/public/v1/entities/{entityId}/bank-accounts/import

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

  • filenamestringrequired
  • transactionsarray of objectsrequired
    Show 9 child attributes
    • datestringrequired
    • descriptionstringrequired
    • amountnumberrequired
    • transactionTypestring
    • payeestring
    • codestring
    • referencestring
    • particularsstring
    • bankTransactionIdstring
  • namestringrequired
  • institutionstringrequired
  • accountNumberstring

Responses

201 Successful response

  • dataobjectrequired
    Show 7 child attributes
    • bankAccountIdstringrequired
    • bankAccountNamestringrequired
    • institutionstringrequirednullable
    • accountNumberstringrequirednullable
    • importIdstringrequirednullable
    • transactionsImportednumberrequired
    • messagestringrequired
  • metaobject
    Show 1 child attribute
    • countnumberrequired
  • 400 Invalid body (`VALIDATION_ERROR`, `INVALID_ROW_DATE`, `ZERO_AMOUNT_TRANSACTION`)
  • 401 Invalid or missing API key or token
  • 404 Entity not found or not accessible
  • 500 Internal server error
Node SDK
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
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"
  }'

Import transactions into a CSV bank account

POST/api/public/v1/entities/{entityId}/bank-accounts/{bankAccountId}/import

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

  • entityIdstringrequired
  • bankAccountIdstringrequired

Request body

application/json

  • filenamestringrequired
  • transactionsarray of objectsrequired
    Show 9 child attributes
    • datestringrequired
    • descriptionstringrequired
    • amountnumberrequired
    • transactionTypestring
    • payeestring
    • codestring
    • referencestring
    • particularsstring
    • bankTransactionIdstring

Responses

200 Successful response

  • dataobjectrequired
    Show 6 child attributes
    • bankAccountIdstringrequired
    • bankAccountNamestringrequired
    • importIdstringrequirednullable
    • transactionsImportednumberrequired
    • transactionsSkippednumberrequired
    • messagestringrequired
  • metaobject
    Show 1 child attribute
    • countnumberrequired
  • 400 Invalid 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`)
  • 401 Invalid or missing API key or token
  • 404 The entity or bank account wasn't found, or isn't accessible (`BANK_ACCOUNT_NOT_FOUND`)
  • 500 Internal server error
Node SDK
const { data } = await prosaic.bankAccounts.importTransactions(entityId, bankAccountId, {
  filename: 'Example Ltd',
  transactions: [
    {
      date: '2026-04-01',
      description: 'Office supplies',
      amount: 100,
    },
  ],
});
curl
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
      }
    ]
  }'