← Back to schema index

PatchBeneficiaryImportRowRequest

Body for `PATCH /v1/beneficiaries/imports/{id}/rows/{row_id}`. Accepts the JSON:API envelope `{ data: { attributes: {...} } }` or a flat object. All attributes are optional — only those present are overwritten. Five editable fields: `parsed_account`, `parsed_label`, `parsed_account_type`, `parsed_bank_code`, `parsed_bank_name`. Any other key is ignored. If no recognized editable field is present → `422 no_valid_fields`. If the job is not in `preview_ready` state → `422 job_not_editable`. After persisting the override, the server re-processes the row (re-derives bank from the new CLABE prefix / BIN) so that job counters and the preview's Bank column stay in sync without waiting for commit.

Properties

FieldTypeDescription
parsed_accountstringUser-corrected account number. Accepts up to 32 characters of digits. It is re-normalized on re-processing.
parsed_labelstringCorrected row label. If it starts with `=`, `+`, `-` or `@`, it is stored with a leading apostrophe so a spreadsheet does not read it as a formula.
parsed_account_typestringCorrected account type. `clabe`: CLABE (18 digits); `card`: card (16 digits); `phone`: phone/DiMo (10 digits).
parsed_bank_codestringCorrected SPEI code (5 digits). Useful for `phone` rows that need bank reassignment. For CLABE/card it is overridden on re-derivation.
parsed_bank_namestringCorrected bank name. May be overridden during re-derivation.

Used in operations

  • PATCH /v1/beneficiaries/imports/{id}/rows/{row_id}