Split a transaction across categories

PATCH/api/v1/transactions/{transaction_id}/split

Rebuild a transaction's journal entry so its single category leg becomes multiple category legs (e.g. 70% COGS / 30% Sales Tax). Allocations may be percentages, fixed amounts, or a remainder line; the resulting legs always balance against the bank leg.

Operation ID: split_transaction·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.

Parameters

Path

transaction_idstringrequired

Request body

Schema: TransactionSplitRequest

splitarray · SplitAllocationrequiredSplitAllocation

Category allocations (at least 2 lines).

7 fields

ledger_idstringrequired: Category ledger for this leg
allocation_typeSplitAllocationTyperequiredSplitAllocationType: percent | amount | remainder
valueinteger: Basis points for 'percent' (70% == 7000), cents for 'amount', ignored/None for 'remainder'.
descriptionstring: Optional per-line memo
class_idstring: Optional Class dimension
location_idstring: Optional Location dimension
project_idstring: Optional Project for job costing

Responses

200Successful Response

Schema: SuccessEnvelope_TransactionListResponse_

successboolean
messagestring
codestring
dataTransactionListResponse

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/invalid token 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.

404Not Found - Resource does not exist

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.

Code samples

PATCH/api/v1/transactions/{transaction_id}/split

bash

curl -X PATCH 'https://api.ondayzero.com/api/v1/transactions/{transaction_id}/split' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "split": [
    {
      "allocation_type": "percent",
      "ledger_id": "019ab37c-1ed6-7000-8000-000000000001",
      "value": 7000
    },
    {
      "allocation_type": "remainder",
      "ledger_id": "019ab37c-1ed6-7000-8000-000000000002"
    }
  ]
}'