Merge ledgers

POST /api/v1/ledgers/merge

Merge one or more source ledgers into a target ledger, reassigning all transactions and journal entries.

Operation ID: merge_ledgers_api_v1_ledgers_merge_post · 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: LedgerMergeRequest

source_ledger_ids array · string required: One or more ledger UUIDs to merge FROM (will be archived after merge).
target_ledger_id string required: The ledger UUID to merge INTO (receives all reassigned data).
new_name string: Optional new name for the target ledger after merge.

Responses

201 Successful Response

Schema: LedgerMergeResponse

task_id string: Temporal workflow / task ID for async Teal merges. Poll GET /tasks/{task_id} for status.
message string required: Human-readable status message.
merged_ledger LedgerResponse: The updated target ledger (present for synchronous local-engine merges).

400 Bad Request - Invalid input

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

409 Conflict - Resource already exists

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

POST /api/v1/ledgers/merge

bash

curl -X POST 'https://api.ondayzero.com/api/v1/ledgers/merge' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "source_ledger_ids": [],
  "target_ledger_id": "string"
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/ledgers/merge', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "source_ledger_ids": [],
  "target_ledger_id": "string"
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "source_ledger_ids": [],
  "target_ledger_id": "string"
}

response = httpx.post("https://api.ondayzero.com/api/v1/ledgers/merge", headers=headers, json=payload)
data = response.json()