Preview Vendor Deposit Import
POST/api/vendor-deposits/import/preview
Preview a CSV import of vendor deposits before running it. References a previously uploaded CSV file by its stored name and returns the parsed records, the detected file headers, the list of importable fields, and any unmapped (difference) or missing required (required_difference) fields so the column mapping can be corrected before importing.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body fields: original_name and stored_name are required; mapping (array of {file_field, expected_field} pairs), separator, escape, meta, and task_id are optional.
Request
Responses
- 200
- 400
- 401
- 403
- 422
- 429
OK
Response Headers
Bad Request
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.