Start free trial

Preview bulk transaction upload

POST/api/v1/transactions/bulk-upload/preview

Preview and validate a CSV/Excel file before uploading transactions.

This endpoint allows you to:

  • Validate the file format and structure
  • See how many transactions will be uploaded
  • Preview sample transactions
  • Check for duplicate transactions (optional)
  • Apply date range filtering

Supported File Formats: .csv, .xlsx, .xls

Returns: Validation results, statistics, and sample transactions without actually uploading.

Operation ID: preview_bulk_transaction_upload_api_v1_transactions_bulk_upload_preview_post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: BulkTransactionUploadPreviewRequest

s3_keystringrequired

S3 key of the CSV file containing transactions

start_datestring · date

Optional: Only preview transactions on or after this date (YYYY-MM-DD).

end_datestring · date

Optional: Only preview transactions on or before this date (YYYY-MM-DD).

check_duplicatesboolean

If true, checks for duplicate transactions against existing database records.

ledger_idstring

Optional: Ledger ID to check duplicates against. If not provided, checks all ledgers for the business.

financial_account_typestring

Financial account type selected for a new ledger. Used by preview to show the same signed amount DayZero will store after import.

column_mappingobject

User-supplied mapping from DayZero field names to CSV column names. Keys: 'date', 'amount', 'description', and optional 'category' (aliases: ledger, ledger_name, account, account_name, category_name). Values: the CSV header to use. When provided, auto-detection is skipped.

Responses

201Successful Response

Schema: SuccessEnvelope_BulkTransactionUploadPreviewResponse_

successboolean
messagestring
codestring
dataBulkTransactionUploadPreviewResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject