Uploading PDF Bank Statements and Accessing Extracted Transactions via the API

Uploading PDF Bank Statements and Accessing Extracted Transactions via the API

You can get the transactions from a bank statement PDF through the LedgerSync API by sending the PDF to the API and getting the extracted transactions back.

Conversions you run with the PDF Converter (Tools > PDF Converter) are not available through the API. The PDF Converter gives you a file to download instead: XLS, XLSX, CSV, QBO or OFX.

Send the PDF to the API

  1. Upload the statement PDF to the API's statement extraction endpoint (POST /v3/statements/extract). The file must be a PDF of 30 MB or less, and your API key needs the write:statements permission.
  2. LedgerSync reads the statement with the same engine the PDF Converter uses. The API replies straight away with an operation ID while the statement is read.
  3. Check the operation (GET /v3/operations/{operation_id}). When it has succeeded, its result lists the extracted transactions, each with its date, description and amount, plus the running balance when the statement prints one.

Transactions extracted this way are returned only to you. They are not added to any client or account in LedgerSync.

PDF requirements

  • Text-based and scanned PDFs can both be read.
  • Password-protected PDFs cannot be read. Remove the password and upload a new copy.
  • The file must be a bank statement.

Before you rely on the results, compare the transactions with the statement, especially for scanned statements.

API access

Sandbox and live API access is requested through the LedgerSync developer portal. See the LedgerSync API documentation for the full details of each request and response.

Related articles

  • How to Convert Bank PDF Statements to Excel, CSV, QBO, or OFX

Have questions? Contact us at support@ledgersync.com.