Skip to content

Change the QuickBooks sync mode or settings

PATCH/api/v1/quickbooks/sync/settings

Partial update. mode off -> mirror needs a completed import (400 INTEGRATION_130); -> two_way also sets cutover_date (default today, not in the future) and queues DayZero records dated on/after it for QuickBooks; -> off stops the sync and deletes nothing. bank_feed_owner keys must be bank/card ledgers of the business. Returns the new status.

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

modestring

off stops the sync (nothing is deleted); mirror pulls QuickBooks changes into DayZero; two_way also pushes DayZero changes back.

cutover_datestring · date

two_way only: DayZero records dated on or after this day are pushed to QuickBooks. Defaults to today when two_way is turned on.

pushobject

Object families to push, e.g. {'invoices': true}.

bank_feed_ownerobject

Bank/card ledger id -> dayzero or quickbooks. null returns the ledger to its default owner.

require_approvalboolean
auto_create_accountsboolean
pull_attachmentsboolean
replicate_imported_entriesboolean

Imported journal entries and the opening balance are pushed to a QuickBooks company other than the one they came from without this. It also pushes the ones imported before DayZero recorded their company: turn it on only when the connected company is not the one the books were imported from. Entries already linked to the connected company are not queued again.

auto_repairboolean

Let the sync fix itself: close leftover queue rows, clear conflicts that were DayZero's own changes coming back and remove exact second entries the sync posted in open periods. Default on.

Responses

200Successful Response

successboolean
messagestring
codestring
dataQuickBooksSyncStatusResponse

400Bad Request - Invalid input

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

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

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

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.

409Conflict - Resource already exists or is in an incompatible state

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

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.