{"openapi":"3.1.0","info":{"title":"POST /api/v1/transactions/bulk-upload/headers","version":"1.0.0","description":"Get CSV/Excel column headers for mapping"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/transactions/bulk-upload/headers":{"post":{"tags":["transactions"],"summary":"Get CSV/Excel column headers for mapping","description":"Return the column headers, sample rows, and a suggested mapping for a previously\nuploaded CSV/Excel file. Use this before preview to let the user map their file's\ncolumns to DayZero fields (date, amount, description).","operationId":"get_bulk_upload_headers_api_v1_transactions_bulk_upload_headers_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUploadHeadersRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUploadHeadersResponse"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"detail":"Invalid request parameters"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"BulkUploadHeadersRequest":{"properties":{"s3_key":{"type":"string","minLength":1,"title":"S3 Key","description":"S3 key of the CSV/Excel file to read headers from"}},"type":"object","required":["s3_key"],"title":"BulkUploadHeadersRequest","description":"Request schema for fetching column headers from an uploaded CSV/Excel file."},"BulkUploadHeadersResponse":{"properties":{"headers":{"items":{"type":"string"},"type":"array","title":"Headers","description":"Column headers found in the file"},"sample_rows":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Sample Rows","description":"First few rows of raw data (up to 5) for the user to see values"},"suggested_mapping":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"object"},{"type":"null"}],"title":"Suggested Mapping","description":"Auto-detected mapping suggestion: {dayzero_field: csv_column_or_null}"}},"type":"object","required":["headers"],"title":"BulkUploadHeadersResponse","description":"Response with detected column headers and sample rows for user mapping."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}