Skip to content
Open appBook a five-day pilot

Backfill customer AR sub-ledgers

POST/api/v1/ar/subledgers/backfill

Move historical invoice, payment and credit-memo journal lines from Accounts Receivable onto each customer's 'AR - <name>' sub-ledger by updating the original line. Dry run by default.

Operation ID: ar_subledgers_backfill·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: ArSubledgerBackfillRequest

dry_runboolean

Preview only (default). Reports which lines would move, which 'AR - X' ledgers would be adopted or created, and what is skipped — nothing is written.

include_closed_periodsboolean

Also rewrite lines dated in a closed or locked accounting period. The move stays inside Accounts Receivable, so the AR total for the period is unchanged, but per-ledger balances change.

create_missingboolean

Create an 'AR - <Customer Name>' sub-ledger for customers that have none yet. When false, only customers with an existing (or adoptable) sub-ledger are moved.

Responses

200Successful Response

Schema: SuccessEnvelope_ArSubledgerBackfillResponse_

successboolean
messagestring
codestring
dataArSubledgerBackfillResponse

400Bad Request - Invalid input

Schema: ErrorResponse

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

401Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business

Schema: ErrorResponse

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

403Forbidden - Insufficient permissions

Schema: ErrorResponse

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

422Validation Error

Schema: ErrorResponse

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.