201Successful Response
Schema: SuccessEnvelope_EnrichFromExportResponse_
successbooleanmessagestringcodestringdataEnrichFromExportResponse
/api/v1/transactions/enrich-from-exportMatch the rows of a bank "account activity" export to transactions already in a
ledger (same amount, date within date_tolerance_days, count-aware, exact
description preferred) and add what the export knows: wire originators,
mobile-deposit payers and other detail columns are appended to the description
and set as the counterparty.
Columns are auto-detected (originator, payer, beneficiary, additional details,
memo, ...) and echoed back as column_mapping; override them with
column_mapping. dry_run (default true) returns the proposals without
writing. A description or counterparty a person set by hand is left alone unless
overwrite_user_edits is true; a counterparty derived from invoices/bills is
never replaced.
Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.
Schema: EnrichFromExportRequest
s3_keystringrequiredS3 key of the bank activity export (CSV or Excel).
ledger_idstringrequiredBank ledger whose existing transactions are enriched.
dry_runbooleanPreview the proposed changes without writing (default true).
overwrite_user_editsbooleanAlso change descriptions and counterparties a person set by hand. A counterparty derived from invoices/bills is never replaced.
column_mappingobjectOptional {role: header} overrides: date, amount, debit, credit, description, party (name used as counterparty), detail (text appended to the description). Detected columns are echoed back.
date_tolerance_daysintegerMax days between export row and transaction.
set_counterpartybooleanSet the counterparty to the extracted payer/originator.
append_descriptionbooleanAppend the extracted detail to the description.
Schema: SuccessEnvelope_EnrichFromExportResponse_
successbooleanmessagestringcodestringdataEnrichFromExportResponseSchema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.