Preview bulk journal entry upload

POST /api/v1/journal-entries/bulk-upload/preview

Parse and validate a CSV/Excel file of journal entries without creating anything. Returns a structured preview with per-entry validation.

Operation ID: preview_bulk_je_upload_api_v1_journal_entries_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: BulkJournalEntryUploadRequest

s3_key string required: S3 key of the uploaded CSV/Excel file (from POST /upload/direct)

Responses

201 Successful Response

400 Bad Request - Invalid input

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

POST /api/v1/journal-entries/bulk-upload/preview

bash

curl -X POST 'https://api.ondayzero.com/api/v1/journal-entries/bulk-upload/preview' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "s3_key": "string"
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/journal-entries/bulk-upload/preview', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "s3_key": "string"
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "s3_key": "string"
}

response = httpx.post("https://api.ondayzero.com/api/v1/journal-entries/bulk-upload/preview", headers=headers, json=payload)
data = response.json()