Update journal entry

PUT/api/v1/journal-entries/{journal_entry_id}

Update an existing journal entry's description, date, or line entries.

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

journal_entry_idstringrequired

Request body

Schema: JournalEntryUpdateRequest

descriptionstring: Updated description for the journal entry.
datestring: Updated date in ISO 8601 format (e.g., '2024-01-15').
line_entry_changesobject: Object containing arrays of line entry changes. Supports 'create' (new entries), 'update' (modify existing by ID), and 'delete' (remove by ID) operations.
invoice_idstring: Send null to unlink this entry from its invoice. Links are created by the invoice lifecycle and cannot be repointed here.
inventory_order_idstring: Send null to unlink this entry from its inventory order.
credit_memo_idstring: Send null to unlink this entry from its credit memo.
vendor_credit_idstring: Send null to unlink this entry from its vendor credit.
production_run_idstring: Send null to unlink this entry from its production run.

Responses

200Successful Response

Schema: SuccessEnvelope_JournalEntryResponse_

successboolean
messagestring
codestring
dataJournalEntryResponse

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.

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

PUT/api/v1/journal-entries/{journal_entry_id}

bash

curl -X PUT 'https://api.ondayzero.com/api/v1/journal-entries/{journal_entry_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "date": "2024-01-16",
  "description": "Updated: Record sale to customer - Invoice #1234 (corrected)",
  "line_entry_changes": {
    "create": [
      {
        "amount": 5000,
        "debit_credit": "debit",
        "description": "Shipping charges",
        "ledger_id": "019ab37c-f6c4-7d5a-a7f2-8d4c5e0f1a3c"
      },
      {
        "amount": 5000,
        "debit_credit": "credit",
        "description": "Shipping revenue",
        "ledger_id": "019ab37c-d4a2-7b38-85f0-6b2a3c8e9f1a"
      }
    ],
    "delete": [
      "019ab37c-b2c3-7d4e-f5a6-7b8c9d0e1f2a"
    ],
    "update": [
      {
        "description": "Updated line entry description",
        "id": "019ab37c-a1b2-7c3d-e4f5-6a7b8c9d0e1f"
      }
    ]
  }
}'